Drop default translation and use exception to enforce type safety

Signed-off-by: Gavin <gavinfreeborn@gmail.com>
bcgov · Jun 20, 2023 · e7cbb7e · e7cbb7e
1 parent df985a8
commit e7cbb7e
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 13 deletions.
diff --git a/services/tenant-ui/frontend/src/components/common/LocaleSwitcher.vue b/services/tenant-ui/frontend/src/components/common/LocaleSwitcher.vue
@@ -5,11 +5,11 @@
 <script setup lang="ts">
 import Dropdown from 'primevue/dropdown';
 import { useI18n } from 'vue-i18n';
-import { i18nLocale } from '@/helpers';
+import { I18nLocale } from '@/helpers';
 
 const { locale } = useI18n({ useScope: 'global' });
 
-const localeList: Array<i18nLocale> = ['en', 'fr', 'jp'];
+const localeList: Array<I18nLocale> = ['en', 'fr', 'jp'];
 </script>
 
 <style lang="scss" scoped>

diff --git a/services/tenant-ui/frontend/src/helpers/index.ts b/services/tenant-ui/frontend/src/helpers/index.ts
@@ -2,32 +2,40 @@ import { format, fromUnixTime, parseJSON } from 'date-fns';
 import { enCA, fr, ja } from 'date-fns/locale';
 import { useI18n } from 'vue-i18n';
 
-export type i18nLocale = 'en' | 'fr' | 'jp';
+export type I18nLocale = 'en' | 'fr' | 'jp';
 
-function i18n2DateLocale(i18nLocal: i18nLocale) {
-  switch (i18nLocal) {
+function i18n2DateLocale(i18nLocale: I18nLocale): Locale {
+  switch (i18nLocale) {
     case 'en':
       return enCA;
     case 'fr':
       return fr;
     case 'jp':
       return ja;
-    default:
-      console.log(
-        `No valid translation found for ${i18nLocal} defaulting to enCA`
-      );
-      return enCA;
   }
+  // This way we can fall back to a default while using typescript to
+  // enforce that all instances of i18nLocale have a corresponding case in the
+  // switch statement
+  /* eslint no-unreachable: "error" */
+  throw new Error('No valid date-fn');
 }
 
 function _dateFnsFormat(value: string, formatter: string) {
   const { locale } = useI18n();
   const formatted = '';
   try {
     if (value) {
-      return format(parseJSON(value), formatter, {
-        locale: i18n2DateLocale(locale.value as i18nLocale),
-      });
+      try {
+        return format(parseJSON(value), formatter, {
+          locale: i18n2DateLocale(locale.value as I18nLocale),
+        });
+      } catch {
+        // Incase the locale was never set (used outside of a vue component)
+        console.log(
+          `No valid translation found for ${locale.value} defaulting to enCA`
+        );
+        return format(parseJSON(value), formatter, { locale: enCA });
+      }
     }
   } catch (error) {
     console.error(`_dateFnsFormat: Error parsing ${value} to ${error}`);