separate default locale to default user and default template locale

battermann · battermann · commit 1e7bf3a3e8ed · 2022-01-10T11:56:44.000Z
diff --git a/changelog.d/2-features/pr-2028 b/changelog.d/2-features/pr-2028
@@ -0,0 +1 @@
+Specialize `setDefaultLocale` to distinguish between default user locale and default template locale if the user's locale is n/a.
diff --git a/charts/brig/templates/configmap.yaml b/charts/brig/templates/configmap.yaml
@@ -204,7 +204,8 @@ data:
         suspendTimeout: {{ .setSuspendInactiveUsers.suspendTimeout }}
       {{- end }}
       setRichInfoLimit: {{ .setRichInfoLimit }}
-      setDefaultLocale: {{ .setDefaultLocale }}
+      setDefaultTemplateLocale: en
+      setDefaultUserLocale: {{ .setDefaultUserLocale }}
       setMaxTeamSize: {{ .setMaxTeamSize }}
       setMaxConvSize: {{ .setMaxConvSize }}
       setEmailVisibility: {{ .setEmailVisibility }}
diff --git a/charts/brig/values.yaml b/charts/brig/values.yaml
@@ -53,7 +53,6 @@ config:
     legalholdUserTokenTimeout: 4838400
     legalholdAccessTokenTimeout: 900
   optSettings:
-    setDefaultLocale: en
     setActivationTimeout: 1209600
     setTeamInvitationTimeout: 1814400
     setUserMaxConnections: 1000
@@ -64,7 +63,8 @@ config:
       stdDev: 3000
       retryAfter: 86400
     setRichInfoLimit: 5000
-    setDefaultLocale: en
+    setDefaultTemplateLocale: en
+    setDefaultUserLocale: en
     setMaxTeamSize: 500
     setMaxConvSize: 500
     # Allowed values: https://github.com/wireapp/wire-server/blob/0126651a25aabc0c5589edc2b1988bb06550a03a/services/brig/src/Brig/Options.hs#L304-L306
diff --git a/deploy/services-demo/conf/brig.demo-docker.yaml b/deploy/services-demo/conf/brig.demo-docker.yaml
@@ -109,7 +109,8 @@ optSettings:
     stdDev: 3000      # 50 minutes
     retryAfter: 86400 # 1 day
   setRichInfoLimit: 5000  # should be in sync with Spar
-  setDefaultLocale: en
+  setDefaultTemplateLocale: en
+  setDefaultUserLocale: en
   setMaxTeamSize: 128
   setMaxConvSize: 128
   setEmailVisibility: visible_to_self
diff --git a/deploy/services-demo/conf/brig.demo.yaml b/deploy/services-demo/conf/brig.demo.yaml
@@ -109,7 +109,8 @@ optSettings:
     stdDev: 3000      # 50 minutes
     retryAfter: 86400 # 1 day
   setRichInfoLimit: 5000  # should be in sync with Spar
-  setDefaultLocale: en
+  setDefaultTemplateLocale: en
+  setDefaultUserLocale: en
   setMaxTeamSize: 128
   setMaxConvSize: 128
   setEmailVisibility: visible_to_self
diff --git a/hack/helm_vars/wire-server/values.yaml.gotmpl b/hack/helm_vars/wire-server/values.yaml.gotmpl
@@ -69,7 +69,8 @@ brig:
         retryLimit: 5  # how many times can you have a failed login in that timeframe.
       setSuspendInactiveUsers:
         suspendTimeout: 10
-      setDefaultLocale: en
+      setDefaultTemplateLocale: en
+      setDefaultUserLocale: en
       setMaxConvAndTeamSize: 16
       setMaxTeamSize: 32
       setMaxConvSize: 16
diff --git a/services/brig/brig.integration.yaml b/services/brig/brig.integration.yaml
@@ -152,7 +152,8 @@ optSettings:
   setSuspendInactiveUsers:  # if this is omitted: never suspend inactive users.
     suspendTimeout: 10
   setRichInfoLimit: 5000  # should be in sync with Spar
-  setDefaultLocale: en
+  setDefaultTemplateLocale: en
+  setDefaultUserLocale: en
   setMaxTeamSize: 32
   setMaxConvSize: 16
   setEmailVisibility: visible_to_self
diff --git a/services/brig/src/Brig/API/User.hs b/services/brig/src/Brig/API/User.hs
@@ -1062,7 +1062,7 @@ deleteAccount account@(accountUser -> user) = do
   revokeAllCookies uid
   where
     mkTombstone = do
-      defLoc <- setDefaultLocale <$> view settings
+      defLoc <- setDefaultUserLocale <$> view settings
       return $
         account
           { accountStatus = Deleted,
diff --git a/services/brig/src/Brig/Data/User.hs b/services/brig/src/Brig/Data/User.hs
@@ -118,7 +118,7 @@ data ReAuthError
 -- there, it was claimed properly.
 newAccount :: NewUser -> Maybe InvitationId -> Maybe TeamId -> Maybe Handle -> AppIO (UserAccount, Maybe Password)
 newAccount u inv tid mbHandle = do
-  defLoc <- setDefaultLocale <$> view settings
+  defLoc <- setDefaultUserLocale <$> view settings
   domain <- viewFederationDomain
   uid <-
     Id <$> do
@@ -132,7 +132,7 @@ newAccount u inv tid mbHandle = do
       -- Ephemeral users' expiry time is in expires_in (default sessionTokenTimeout) seconds
       e <- view zauthEnv
       let ZAuth.SessionTokenTimeout defTTL = e ^. ZAuth.settings . ZAuth.sessionTokenTimeout
-          ttl = fromMaybe defTTL (fromRange <$> newUserExpiresIn u)
+          ttl = maybe defTTL fromRange (newUserExpiresIn u)
       now <- liftIO =<< view currentTime
       return . Just . toUTCTimeMillis $ addUTCTime (fromIntegral ttl) now
     _ -> return Nothing
@@ -154,7 +154,7 @@ newAccount u inv tid mbHandle = do
 
 newAccountInviteViaScim :: UserId -> TeamId -> Maybe Locale -> Name -> Email -> AppIO UserAccount
 newAccountInviteViaScim uid tid locale name email = do
-  defLoc <- setDefaultLocale <$> view settings
+  defLoc <- setDefaultUserLocale <$> view settings
   domain <- viewFederationDomain
   return (UserAccount (user domain (fromMaybe defLoc locale)) PendingInvitation)
   where
@@ -370,7 +370,7 @@ deactivateUser u =
 
 lookupLocale :: UserId -> AppIO (Maybe Locale)
 lookupLocale u = do
-  defLoc <- setDefaultLocale <$> view settings
+  defLoc <- setDefaultUserLocale <$> view settings
   fmap (toLocale defLoc) <$> retry x1 (query1 localeSelect (params LocalQuorum (Identity u)))
 
 lookupName :: UserId -> AppIO (Maybe Name)
@@ -417,7 +417,7 @@ lookupAuth u = fmap f <$> retry x1 (query1 authSelect (params LocalQuorum (Ident
 -- Skips nonexistent users. /Does not/ skip users who have been deleted.
 lookupUsers :: HavePendingInvitations -> [UserId] -> AppIO [User]
 lookupUsers hpi usrs = do
-  loc <- setDefaultLocale <$> view settings
+  loc <- setDefaultUserLocale <$> view settings
   domain <- viewFederationDomain
   toUsers domain loc hpi <$> retry x1 (query usersSelect (params LocalQuorum (Identity usrs)))
 
@@ -426,7 +426,7 @@ lookupAccount u = listToMaybe <$> lookupAccounts [u]
 
 lookupAccounts :: [UserId] -> AppIO [UserAccount]
 lookupAccounts usrs = do
-  loc <- setDefaultLocale <$> view settings
+  loc <- setDefaultUserLocale <$> view settings
   domain <- viewFederationDomain
   fmap (toUserAccount domain loc) <$> retry x1 (query accountsSelect (params LocalQuorum (Identity usrs)))
 
diff --git a/services/brig/src/Brig/Options.hs b/services/brig/src/Brig/Options.hs
@@ -26,13 +26,15 @@ import Brig.Types
 import Brig.User.Auth.Cookie.Limit
 import Brig.Whitelist (Whitelist (..))
 import qualified Brig.ZAuth as ZAuth
+import Control.Applicative
 import qualified Control.Lens as Lens
-import Data.Aeson (withText)
+import Data.Aeson (defaultOptions, fieldLabelModifier, genericParseJSON, withText)
 import qualified Data.Aeson as Aeson
 import Data.Aeson.Types (typeMismatch)
 import qualified Data.Char as Char
 import Data.Domain (Domain (..))
 import Data.Id
+import Data.LanguageCodes (ISO639_1 (EN))
 import Data.Misc (HttpsUrl)
 import Data.Range
 import Data.Scientific (toBoundedInteger)
@@ -439,9 +441,12 @@ data Settings = Settings
     --   field names and values), should be in sync
     --   with Spar
     setRichInfoLimit :: !Int,
-    -- | Default locale to use
-    --   (e.g. when selecting templates)
-    setDefaultLocale :: !Locale,
+    -- | Default locale to use when selecting templates
+    -- use `setDefaultTemplateLocale` as the getter function which always provides a default value
+    setDefaultTemplateLocaleInternal :: !(Maybe Locale),
+    -- | Default locale to use for users
+    -- use `setDefaultUserLocale` as the getter function which always provides a default value
+    setDefaultUserLocaleInternal :: !(Maybe Locale),
     -- | Max. # of members in a team.
     --   NOTE: This must be in sync with galley
     setMaxTeamSize :: !Word32,
@@ -474,7 +479,7 @@ data Settings = Settings
     --   setFederationAllowedDomains:
     --     - wire.com
     --     - example.com
-    setFederationDomain :: !(Domain),
+    setFederationDomain :: !Domain,
     -- | The amount of time in milliseconds to wait after reading from an SQS queue
     -- returns no message, before asking for messages from SQS again.
     -- defaults to 'defSqsThrottleMillis'.
@@ -499,6 +504,18 @@ data Settings = Settings
   }
   deriving (Show, Generic)
 
+defaultUserLocale :: Locale
+defaultUserLocale = Locale (Language EN) Nothing
+
+defaultTemplateLocale :: Locale
+defaultTemplateLocale = defaultUserLocale
+
+setDefaultUserLocale :: Settings -> Locale
+setDefaultUserLocale = fromMaybe defaultUserLocale . setDefaultUserLocaleInternal
+
+setDefaultTemplateLocale :: Settings -> Locale
+setDefaultTemplateLocale = fromMaybe defaultTemplateLocale . setDefaultTemplateLocaleInternal
+
 -- | The analog to `GT.FeatureFlags`.  This type tracks only the things that we need to
 -- express our current cloud business logic.
 --
@@ -664,7 +681,16 @@ instance FromJSON Timeout where
               maybe defaultV fromIntegral bounded
   parseJSON v = typeMismatch "activationTimeout" v
 
-instance FromJSON Settings
+instance FromJSON Settings where
+  parseJSON = genericParseJSON customOptions
+    where
+      customOptions =
+        defaultOptions
+          { fieldLabelModifier = \case
+              "setDefaultUserLocaleInternal" -> "setDefaultUserLocale"
+              "setDefaultTemplateLocaleInternal" -> "setDefaultTemplateLocale"
+              other -> other
+          }
 
 instance FromJSON Opts
 
diff --git a/services/brig/src/Brig/Provider/API.hs b/services/brig/src/Brig/Provider/API.hs
@@ -846,7 +846,7 @@ addBot zuid zcon cid add = do
   let botReq = Ext.NewBotRequest bid bcl busr bcnv btk bloc
   rs <- RPC.createBot scon botReq !>> StdError . serviceError
   -- Insert the bot user and client
-  locale <- setDefaultLocale <$> view settings
+  locale <- Opt.setDefaultUserLocale <$> view settings
   let name = fromMaybe (serviceProfileName svp) (Ext.rsNewBotName rs)
   let assets = fromMaybe (serviceProfileAssets svp) (Ext.rsNewBotAssets rs)
   let colour = fromMaybe defaultAccentId (Ext.rsNewBotColour rs)
@@ -858,7 +858,7 @@ addBot zuid zcon cid add = do
           { newClientPrekeys = Ext.rsNewBotPrekeys rs
           }
   lift $ User.insertAccount (UserAccount usr Active) (Just (cid, cnvTeam cnv)) Nothing True
-  maxPermClients <- fromMaybe Opt.defUserMaxPermClients <$> Opt.setUserMaxPermClients <$> view settings
+  maxPermClients <- fromMaybe Opt.defUserMaxPermClients . Opt.setUserMaxPermClients <$> view settings
   (clt, _, _) <- do
     _ <- do
       -- if we want to protect bots against lh, 'addClient' cannot just send lh capability
diff --git a/services/brig/src/Brig/Provider/Template.hs b/services/brig/src/Brig/Provider/Template.hs
@@ -137,7 +137,7 @@ loadProviderTemplates o = readLocalesDir defLocale (templateDir gOptions) "provi
     maybeUrl = fromByteString $ encodeUtf8 $ homeUrl pOptions
     gOptions = general $ emailSMS o
     pOptions = provider $ emailSMS o
-    defLocale = setDefaultLocale (optSettings o)
+    defLocale = setDefaultTemplateLocale (optSettings o)
     readTemplate = readTemplateWithDefault (templateDir gOptions) defLocale "provider"
     readText = readTextWithDefault (templateDir gOptions) defLocale "provider"
     -- URL templates
diff --git a/services/brig/src/Brig/Team/Template.hs b/services/brig/src/Brig/Team/Template.hs
@@ -95,6 +95,6 @@ loadTeamTemplates o = readLocalesDir defLocale (templateDir gOptions) "team" $ \
     gOptions = general (emailSMS o)
     tOptions = team (emailSMS o)
     tUrl = template $ tInvitationUrl tOptions
-    defLocale = setDefaultLocale (optSettings o)
+    defLocale = setDefaultTemplateLocale (optSettings o)
     readTemplate = readTemplateWithDefault (templateDir gOptions) defLocale "team"
     readText = readTextWithDefault (templateDir gOptions) defLocale "team"
diff --git a/services/brig/src/Brig/User/Template.hs b/services/brig/src/Brig/User/Template.hs
@@ -228,7 +228,7 @@ loadUserTemplates o = readLocalesDir defLocale templateDir "user" $ \fp ->
     teamActivationUrl = template $ Opt.tActivationUrl tOptions
     passwordResetUrl = template $ Opt.passwordResetUrl uOptions
     deletionUserUrl = template $ Opt.deletionUrl uOptions
-    defLocale = Opt.setDefaultLocale (Opt.optSettings o)
+    defLocale = Opt.setDefaultTemplateLocale (Opt.optSettings o)
     templateDir = Opt.templateDir gOptions
     readTemplate = readTemplateWithDefault templateDir defLocale "user"
     readText = readTextWithDefault templateDir defLocale "user"

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	+Specialize `setDefaultLocale` to distinguish between default user locale and default template locale if the user's locale is n/a.