API & Client - display user preferences depending on elevation service

Author: SamR1

fittrackee/application/app_config.py

@@ -48,6 +48,9 @@ def get_application_config() -> Union[Dict, HttpResponse]:
         "data": {
           "about": null,
           "admin_contact": "[email protected]",
+          "elevation_services":	{
+            "open_elevation": false
+          },
           "file_sync_limit_import": 10,
           "file_limit_import": 10,
           "global_map_workouts_limit": 10000,
@@ -107,6 +110,9 @@ def update_application_config(auth_user: User) -> Union[Dict, HttpResponse]:
         "data": {
           "about": null,
           "admin_contact": "[email protected]",
+          "elevation_services":	{
+            "open_elevation": false
+          },
           "file_sync_limit_import": 10,
           "file_limit_import": 10,
           "global_map_workouts_limit": 10000,

fittrackee/application/models.py

@@ -56,11 +56,19 @@ def is_registration_enabled(self) -> bool:
     def map_attribution(self) -> str:
         return current_app.config["TILE_SERVER"]["ATTRIBUTION"]
 
+    @property
+    def elevation_services(self) -> Dict:
+        return {
+            "open_elevation": current_app.config["OPEN_ELEVATION_API_URL"]
+            is not None
+        }
+
     def serialize(self) -> Dict:
         weather_provider = os.getenv("WEATHER_API_PROVIDER", "").lower()
         return {
             "about": self.about,
             "admin_contact": self.admin_contact,
+            "elevation_services": self.elevation_services,
             "file_limit_import": self.file_limit_import,
             "file_sync_limit_import": self.file_sync_limit_import,
             "is_email_sending_enabled": current_app.config["CAN_SEND_EMAILS"],

fittrackee/tests/application/test_app_config_api.py

@@ -153,6 +153,7 @@ def test_it_updates_all_config(
         data = json.loads(response.data.decode())
         assert "success" in data["status"]
         assert data["data"]["admin_contact"] == admin_email
+        assert data["data"]["elevation_services"] == {"open_elevation": False}
         assert data["data"]["file_limit_import"] == 200
         assert data["data"]["file_sync_limit_import"] == 20
         assert data["data"]["global_map_workouts_limit"] == 7000

fittrackee/tests/application/test_app_config_model.py

@@ -25,6 +25,10 @@ def test_application_config(
 
         serialized_app_config = config.serialize()
         assert serialized_app_config["admin_contact"] == config.admin_contact
+        assert (
+            serialized_app_config["elevation_services"]
+            == config.elevation_services
+        )
         assert (
             serialized_app_config["file_limit_import"]
             == config.file_limit_import
@@ -152,3 +156,25 @@ def test_it_returns_global_map_workouts_limit(self, app: Flask) -> None:
             serialized_app_config["global_map_workouts_limit"]
             == global_map_workouts_limit
         )
+
+    def test_it_returns_elevation_services_when_open_elevation_is_disabled(
+        self, app: "Flask"
+    ) -> None:
+        config = AppConfig.query.one()
+
+        serialized_app_config = config.serialize()
+
+        assert serialized_app_config["elevation_services"] == {
+            "open_elevation": False
+        }
+
+    def test_it_returns_elevation_services_when_open_elevation_is_enabled(
+        self, app_with_open_elevation_url: "Flask"
+    ) -> None:
+        config = AppConfig.query.one()
+
+        serialized_app_config = config.serialize()
+
+        assert serialized_app_config["elevation_services"] == {
+            "open_elevation": True
+        }

fittrackee/tests/users/test_auth_api.py

@@ -1495,13 +1495,13 @@ def test_it_returns_error_if_fields_are_missing(
     )
     def test_it_updates_user_preferences(
         self,
-        app: Flask,
+        app_with_open_elevation_url: Flask,
         user_1: User,
         input_language: Optional[str],
         expected_language: str,
     ) -> None:
         client, auth_token = self.get_test_client_and_auth_token(
-            app, user_1.email
+            app_with_open_elevation_url, user_1.email
         )
 
         response = client.post(

fittrackee/tests/users/test_users_model.py

@@ -12,6 +12,7 @@
 from time_machine import travel
 
 from fittrackee import db
+from fittrackee.constants import MissingElevationsProcessing
 from fittrackee.equipments.models import Equipment
 from fittrackee.files import get_absolute_file_path
 from fittrackee.reports.models import ReportAction
@@ -311,6 +312,32 @@ def test_it_does_return_reports_info_when_user_has_admin_rights(
         assert serialized_user["reported_count"] == 0
         assert serialized_user["sanctions_count"] == 0
 
+    def test_it_returns_missing_elevations_processing_when_no_elevation_service_set(  # noqa
+        self, app: Flask, user_1: User
+    ) -> None:
+        user_1.missing_elevations_processing = (
+            MissingElevationsProcessing.OPEN_ELEVATION
+        )
+        serialized_user = user_1.serialize(current_user=user_1, light=False)
+
+        assert (
+            serialized_user["missing_elevations_processing"]
+            == MissingElevationsProcessing.NONE
+        )
+
+    def test_it_returns_missing_elevations_processing_when_elevation_service_set(  # noqa
+        self, app_with_open_elevation_url: Flask, user_1: User
+    ) -> None:
+        user_1.missing_elevations_processing = (
+            MissingElevationsProcessing.OPEN_ELEVATION_SMOOTH
+        )
+        serialized_user = user_1.serialize(current_user=user_1, light=False)
+
+        assert (
+            serialized_user["missing_elevations_processing"]
+            == user_1.missing_elevations_processing
+        )
+
 
 class TestUserSerializeAsAdmin(UserModelAssertMixin, ReportMixin):
     def test_it_returns_user_account_infos(

fittrackee/users/models.py

@@ -950,7 +950,9 @@ def serialize(
                     else {}
                 ),
                 "missing_elevations_processing": (
-                    self.missing_elevations_processing
+                    MissingElevationsProcessing.NONE
+                    if current_app.config["OPEN_ELEVATION_API_URL"] is None
+                    else self.missing_elevations_processing
                 ),
             }
 

fittrackee_client/src/components/About.vue

@@ -46,6 +46,9 @@
           {{ weatherProvider.name }}
         </a>
       </div>
+      <div v-if="appConfig.elevation_services.open_elevation">
+        {{ $t('about.ELEVATION_DATA_FROM') }} OpenElevation
+      </div>
       <template v-if="appConfig.about">
         <p class="about-instance">{{ $t('about.ABOUT_THIS_INSTANCE') }}</p>
         <div v-html="convertToMarkdown(appConfig.about)" />
@@ -72,7 +75,7 @@
 
   function get_weather_provider() {
     const weatherProvider: Record<string, string> = {}
-    if (appConfig.value.weatherProvider === 'visualcrossing') {
+    if (appConfig.value.weather_provider === 'visualcrossing') {
       weatherProvider['name'] = 'Visual Crossing'
       weatherProvider['url'] = 'https://www.visualcrossing.com'
     }

fittrackee_client/src/components/User/ProfileDisplay/UserPreferences.vue

@@ -96,6 +96,15 @@
           )
         }}
       </dd>
+      <div
+        v-if="!appConfig.elevation_services.open_elevation"
+        class="info-box missing-elevations-help"
+      >
+        <span>
+          <i class="fa fa-info-circle" aria-hidden="true" />
+          {{ $t('user.PROFILE.NO_ELEVATION_SERVICE_AVAILABLE') }}
+        </span>
+      </div>
       <dt>{{ $t('visibility_levels.WORKOUTS_VISIBILITY') }}:</dt>
       <dd>
         {{ $t(`visibility_levels.LEVELS.${user.workouts_visibility}`) }}
@@ -134,6 +143,7 @@
   import { computed, toRefs } from 'vue'
   import type { ComputedRef } from 'vue'
 
+  import useApp from '@/composables/useApp.ts'
   import useAuthUser from '@/composables/useAuthUser'
   import type { IAuthUserProfile } from '@/types/user'
   import { languageLabels } from '@/utils/locales'
@@ -144,6 +154,7 @@
   const props = defineProps<Props>()
   const { user } = toRefs(props)
 
+  const { appConfig } = useApp()
   const { dateFormat, timezone } = useAuthUser()
 
   const userLanguage: ComputedRef<string> = computed(() =>
@@ -173,8 +184,12 @@
       text-transform: uppercase;
       border-bottom: 1px solid var(--card-border-color);
     }
-    .raw-speed-help {
+    .raw-speed-help,
+    .missing-elevations-help {
       margin-top: -$default-margin * 0.5;
     }
+    .missing-elevations-help {
+      margin-bottom: $default-margin;
+    }
   }
 </style>

fittrackee_client/src/components/User/ProfileEdition/UserPreferencesEdition.vue

@@ -256,7 +256,9 @@
           <select
             id="missing_elevations_processing"
             v-model="userForm.missing_elevations_processing"
-            :disabled="authUserLoading"
+            :disabled="
+              !appConfig.elevation_services.open_elevation || authUserLoading
+            "
           >
             <option
               v-for="item in missingElevationsProcessing"
@@ -267,6 +269,15 @@
             </option>
           </select>
         </label>
+        <div
+          v-if="!appConfig.elevation_services.open_elevation"
+          class="info-box missing-elevations-help"
+        >
+          <span>
+            <i class="fa fa-info-circle" aria-hidden="true" />
+            {{ $t('user.PROFILE.NO_ELEVATION_SERVICE_AVAILABLE') }}
+          </span>
+        </div>
         <label class="form-items">
           {{ $t('visibility_levels.WORKOUTS_VISIBILITY') }}
           <select
@@ -395,7 +406,7 @@
 
   const store = useStore()
 
-  const { errorMessages } = useApp()
+  const { appConfig, errorMessages } = useApp()
   const { authUserLoading } = useAuthUser()
 
   const weekStart = [
@@ -562,6 +573,7 @@
     userForm.segments_creation_event =
       user.segments_creation_event ?? 'only_manual'
     userForm.split_workout_charts = user.split_workout_charts
+    userForm.missing_elevations_processing = user.missing_elevations_processing
   }
   function updateProfile() {
     store.dispatch(AUTH_USER_STORE.ACTIONS.UPDATE_USER_PREFERENCES, userForm)
@@ -638,5 +650,9 @@
     #missing_elevations_processing {
       padding: $default-padding * 0.5;
     }
+
+    .missing-elevations-help {
+      margin-top: $default-margin * 0.5;
+    }
   }
 </style>