Allow customizing unit for calories burnt (#1226)

* feat(migrations): add for new calories burnt unit

* feat(backend): add support for new workout logging unit

* feat(frontend): allow customizing new preference

* chore(frontend): reduce size of input

* feat(frontend): display new unit

* fix(frontend): duplicate the workout calories burnt as well

Author: IgnisDa

apps/frontend/app/lib/state/fitness.ts

@@ -295,6 +295,7 @@ export const useMergingExercise = () => useAtom(mergingExerciseAtom);
 export const duplicateOldWorkout = async (
 	name: string,
 	fitnessEntity: FitnessAction,
+	caloriesBurnt: number | undefined,
 	workoutInformation: WorkoutInformation,
 	coreDetails: ReturnType<typeof useCoreDetails>,
 	userFitnessPreferences: UserFitnessPreferences,
@@ -307,11 +308,12 @@ export const duplicateOldWorkout = async (
 ) => {
 	const inProgress = getDefaultWorkout(fitnessEntity);
 	inProgress.name = name;
-	inProgress.repeatedFrom = params.repeatedFromId;
+	inProgress.caloriesBurnt = caloriesBurnt;
 	inProgress.templateId = params.templateId;
+	inProgress.repeatedFrom = params.repeatedFromId;
 	inProgress.updateWorkoutId = params.updateWorkoutId;
-	inProgress.updateWorkoutTemplateId = params.updateWorkoutTemplateId;
 	inProgress.comment = workoutInformation.comment || undefined;
+	inProgress.updateWorkoutTemplateId = params.updateWorkoutTemplateId;
 	for (const [exerciseIdx, ex] of workoutInformation.exercises.entries()) {
 		const sets = ex.sets.map((v) =>
 			convertHistorySetToCurrentSet(

apps/frontend/app/routes/_dashboard.analytics.tsx

@@ -608,6 +608,7 @@ const StatItem = (props: {
 };
 
 const StatisticsCard = () => {
+	const userPreferences = useUserPreferences();
 	const unitSystem = useUserUnitSystem();
 
 	const displayDuration = (duration: number) => {
@@ -637,7 +638,9 @@ const StatisticsCard = () => {
 						/>
 						<StatItem
 							label={
-								fitness.workoutCaloriesBurnt > 0 ? "Calories Burnt" : "Reps"
+								fitness.workoutCaloriesBurnt > 0
+									? `${userPreferences.fitness.logging.caloriesBurntUnit}`
+									: "Reps"
 							}
 							icon={fitness.workoutCaloriesBurnt > 0 ? IconFlame : IconRepeat}
 							tooltipLabel={

apps/frontend/app/routes/_dashboard.fitness.$action.tsx

@@ -718,6 +718,7 @@ const NameAndOtherInputs = (props: {
 	openAssetsModal: () => void;
 }) => {
 	const loaderData = useLoaderData<typeof loader>();
+	const userPreferences = useUserPreferences();
 	const [currentWorkout, setCurrentWorkout] = useCurrentWorkout();
 	invariant(currentWorkout);
 
@@ -767,8 +768,8 @@ const NameAndOtherInputs = (props: {
 				<Stack gap="xs">
 					<NumberInput
 						size="sm"
-						label="Calories burnt"
 						value={currentWorkout.caloriesBurnt}
+						label={`Energy burnt in ${userPreferences.fitness.logging.caloriesBurntUnit}`}
 						onChange={(e) => setCaloriesBurnt(isNumber(e) ? e : undefined)}
 					/>
 					<Textarea

apps/frontend/app/routes/_dashboard.fitness.$entity.$id._index.tsx

@@ -247,6 +247,7 @@ export default function Page() {
 		const workout = await duplicateOldWorkout(
 			loaderData.entityName,
 			params.action,
+			loaderData.caloriesBurnt ? Number(loaderData.caloriesBurnt) : undefined,
 			loaderData.information,
 			coreDetails,
 			userPreferences.fitness,
@@ -548,7 +549,7 @@ export default function Page() {
 									Number(loaderData.caloriesBurnt) > 0 ? (
 										<DisplayStat
 											icon={<IconFlame size={16} />}
-											data={`${loaderData.caloriesBurnt} calories`}
+											data={`${loaderData.caloriesBurnt} ${userPreferences.fitness.logging.caloriesBurntUnit}`}
 										/>
 									) : null}
 								</>

apps/frontend/app/routes/_dashboard.settings.preferences.tsx

@@ -20,6 +20,7 @@ import {
 	Tabs,
 	TagsInput,
 	Text,
+	TextInput,
 	Title,
 	rem,
 } from "@mantine/core";
@@ -649,6 +650,21 @@ export default function Page() {
 									/>
 								);
 							})}
+							<TextInput
+								size="xs"
+								label="Calories burnt unit"
+								disabled={!!isEditDisabled}
+								description="The unit to use for tracking calories burnt"
+								defaultValue={userPreferences.fitness.logging.caloriesBurntUnit}
+								onChange={(val) => {
+									if (val) {
+										updatePreference((draft) => {
+											draft.fitness.logging.caloriesBurntUnit =
+												val.target.value;
+										});
+									}
+								}}
+							/>
 							<Divider />
 							<Input.Wrapper label="The default measurements you want to keep track of">
 								<SimpleGrid cols={2} mt="xs">

crates/migrations/src/lib.rs

@@ -29,6 +29,7 @@ mod m20241214_create_user_notification;
 mod m20250118_is_v8_migration;
 mod m20250122_changes_for_issue_1188;
 mod m20250126_changes_for_issue_1201;
+mod m20250201_changes_for_issue_1211;
 
 pub use m20230404_create_user::User as AliasedUser;
 pub use m20230410_create_metadata::Metadata as AliasedMetadata;
@@ -79,6 +80,7 @@ impl MigratorTrait for Migrator {
             Box::new(m20250118_is_v8_migration::Migration),
             Box::new(m20250122_changes_for_issue_1188::Migration),
             Box::new(m20250126_changes_for_issue_1201::Migration),
+            Box::new(m20250201_changes_for_issue_1211::Migration),
         ]
     }
 }

crates/migrations/src/m20250201_changes_for_issue_1211.rs

@@ -0,0 +1,22 @@
+use sea_orm_migration::prelude::*;
+
+#[derive(DeriveMigrationName)]
+pub struct Migration;
+
+#[async_trait::async_trait]
+impl MigrationTrait for Migration {
+    async fn up(&self, manager: &SchemaManager) -> Result<(), DbErr> {
+        let db = manager.get_connection();
+        db.execute_unprepared(
+            r#"
+UPDATE "user" SET "preferences" = jsonb_set("preferences", '{fitness,logging,calories_burnt_unit}', '"kcal"');
+"#,
+        )
+        .await?;
+        Ok(())
+    }
+
+    async fn down(&self, _manager: &SchemaManager) -> Result<(), DbErr> {
+        Ok(())
+    }
+}

crates/models/user/src/lib.rs

@@ -129,6 +129,8 @@ pub struct UserFitnessFeaturesEnabledPreferences {
 #[educe(Default)]
 pub struct UserFitnessLoggingPreferences {
     pub mute_sounds: bool,
+    #[educe(Default = "kcal")]
+    pub calories_burnt_unit: String,
     pub prompt_for_rest_timer: bool,
     #[educe(Default = true)]
     pub show_details_while_editing: bool,