WPB-3798 incorrect json field names (#3518)

* WPB-3798: Updating code and tests after renaming fields

* WPB-3798: More updates to names after finding more JSON prefix mangling

* WPB-3798: Fixing schema instances for SAML data

* WPB-3798: Fixing instances that had errors, found by tests

* WPB-3798: Adding changelogs

* WPB-3798: PR feedback.

* WPB-3798: Fixing an error with a field called `data'`

The trailing ' would end up in the JSON representation. I've changed it
to use a leading `_` like other structures, and wrote a newtype to
handle the minimal prefix stripping.

Also cleaning up the diff in regards to imports.

* WPB-3798: Cleaning up imports to minimise the diff

changelog.d/1-api-changes/WPB-3798

@@ -0,0 +1 @@
+The JSON schema of `NonConnectedBackends` has changed to have its single field now called `non_connected_backends`.

changelog.d/5-internal/WPB-3798

@@ -0,0 +1,3 @@
+JSON derived schemas have been changed to no longer pre-process record fields to drop prefixes that were required to disambiguate fields.
+Prefix processing still exists to drop leading underscores from field names, as we are using prefixed field names with `makeLenses`.
+Code has been updated to use `OverloadedRecordDot` with the changed field names.

libs/types-common/src/Data/Code.hs

@@ -119,8 +119,8 @@ deriving instance Cql Value
 -- (but without a type, using plain fields). This will make it easier to re-use a key/value
 -- pair in the API, keeping "code" in the JSON for backwards compatibility
 data KeyValuePair = KeyValuePair
-  { kcKey :: !Key,
-    kcCode :: !Value
+  { key :: !Key,
+    code :: !Value
   }
   deriving (Eq, Generic, Show)
 

libs/types-common/src/Data/Json/Util.hs

@@ -172,20 +172,16 @@ instance ToSchema A.Object where
 -- toJSONFieldName
 
 -- | Convenient helper to convert field names to use as JSON fields.
--- it removes the prefix (assumed to be anything before an uppercase
--- character) and converts the rest to underscore
+-- it converts the field names to snake_case.
 --
 -- Example:
--- newtype TeamName = TeamName { tnTeamName :: Text }
--- deriveJSON toJSONFieldName ''tnTeamName
+-- newtype TeamName = TeamName { teamName :: Text }
+-- deriveJSON toJSONFieldName ''teamName
 --
 -- would generate {To/From}JSON instances where
 -- the field name is "team_name"
 toJSONFieldName :: A.Options
-toJSONFieldName = A.defaultOptions {A.fieldLabelModifier = A.camelTo2 '_' . dropPrefix}
-  where
-    dropPrefix :: String -> String
-    dropPrefix = dropWhile (not . isUpper)
+toJSONFieldName = A.defaultOptions {A.fieldLabelModifier = A.camelTo2 '_'}
 
 --------------------------------------------------------------------------------
 

libs/types-common/src/Util/Options.hs

@@ -75,8 +75,8 @@ urlPort u = do
 makeLenses ''AWSEndpoint
 
 data Endpoint = Endpoint
-  { _epHost :: !Text,
-    _epPort :: !Word16
+  { _host :: !Text,
+    _port :: !Word16
   }
   deriving (Show, Generic)
 
@@ -85,14 +85,14 @@ deriveFromJSON toOptionFieldName ''Endpoint
 makeLenses ''Endpoint
 
 data CassandraOpts = CassandraOpts
-  { _casEndpoint :: !Endpoint,
-    _casKeyspace :: !Text,
+  { _endpoint :: !Endpoint,
+    _keyspace :: !Text,
     -- | If this option is unset, use all available nodes.
     -- If this option is set, use only cassandra nodes in the given datacentre
     --
     -- This option is most likely only necessary during a cassandra DC migration
     -- FUTUREWORK: remove this option again, or support a datacentre migration feature
-    _casFilterNodesByDatacentre :: !(Maybe Text)
+    _filterNodesByDatacentre :: !(Maybe Text)
   }
   deriving (Show, Generic)
 

libs/types-common/src/Util/Options/Common.hs

@@ -28,12 +28,11 @@ import System.Posix.Env qualified as Posix
 -- NOTE: We typically use this for options in the configuration files!
 -- If you are looking into converting record field name to JSON to be used
 -- over the API, look for toJSONFieldName in the Data.Json.Util module.
--- It removes the prefix (assumed to be anything before an uppercase
--- character) and lowers the first character
+-- It converts field names into snake_case
 --
 -- Example:
--- newtype TeamName = TeamName { tnTeamName :: Text }
--- deriveJSON toJSONFieldName ''tnTeamName
+-- newtype TeamName = TeamName { teamName :: Text }
+-- deriveJSON toJSONFieldName ''teamName
 --
 -- would generate {To/From}JSON instances where
 -- the field name is "teamName"
@@ -44,7 +43,7 @@ toOptionFieldName = defaultOptions {fieldLabelModifier = lowerFirst . dropPrefix
     lowerFirst (x : xs) = toLower x : xs
     lowerFirst [] = ""
     dropPrefix :: String -> String
-    dropPrefix = dropWhile (not . isUpper)
+    dropPrefix = dropWhile ('_' ==)
 
 optOrEnv :: (a -> b) -> Maybe a -> (String -> b) -> String -> IO b
 optOrEnv getter conf reader var = case conf of

libs/wire-api-federation/src/Wire/API/Federation/API/Brig.hs

@@ -75,26 +75,29 @@ type BrigApi =
     :<|> FedEndpoint "get-not-fully-connected-backends" DomainSet NonConnectedBackends
 
 newtype DomainSet = DomainSet
-  { dsDomains :: Set Domain
+  { domains :: Set Domain
   }
   deriving stock (Eq, Show, Generic)
   deriving (ToJSON, FromJSON) via (CustomEncoded DomainSet)
 
 newtype NonConnectedBackends = NonConnectedBackends
+  -- TODO:
+  -- The encoding rules that were in place would make this "connectedBackends" over the wire.
+  -- I do not think that this was intended, so I'm leaving this note as it will be an API break.
   { nonConnectedBackends :: Set Domain
   }
   deriving stock (Eq, Show, Generic)
   deriving (ToJSON, FromJSON) via (CustomEncoded NonConnectedBackends)
 
 newtype GetUserClients = GetUserClients
-  { gucUsers :: [UserId]
+  { users :: [UserId]
   }
   deriving stock (Eq, Show, Generic)
   deriving (ToJSON, FromJSON) via (CustomEncoded GetUserClients)
 
 data MLSClientsRequest = MLSClientsRequest
-  { mcrUserId :: UserId, -- implicitly qualified by the local domain
-    mcrSignatureScheme :: SignatureSchemeTag
+  { userId :: UserId, -- implicitly qualified by the local domain
+    signatureScheme :: SignatureSchemeTag
   }
   deriving stock (Eq, Show, Generic)
   deriving (ToJSON, FromJSON) via (CustomEncoded MLSClientsRequest)
@@ -117,10 +120,10 @@ data MLSClientsRequest = MLSClientsRequest
 
 data NewConnectionRequest = NewConnectionRequest
   { -- | The 'from' userId is understood to always have the domain of the backend making the connection request
-    ncrFrom :: UserId,
+    from :: UserId,
     -- | The 'to' userId is understood to always have the domain of the receiving backend.
-    ncrTo :: UserId,
-    ncrAction :: RemoteConnectionAction
+    to :: UserId,
+    action :: RemoteConnectionAction
   }
   deriving stock (Eq, Show, Generic)
   deriving (Arbitrary) via (GenericUniform NewConnectionRequest)
@@ -144,20 +147,20 @@ type UserDeletedNotificationMaxConnections = 1000
 
 data UserDeletedConnectionsNotification = UserDeletedConnectionsNotification
   { -- | This is qualified implicitly by the origin domain
-    udcnUser :: UserId,
+    user :: UserId,
     -- | These are qualified implicitly by the target domain
-    udcnConnections :: Range 1 UserDeletedNotificationMaxConnections [UserId]
+    connections :: Range 1 UserDeletedNotificationMaxConnections [UserId]
   }
   deriving stock (Eq, Show, Generic)
   deriving (Arbitrary) via (GenericUniform UserDeletedConnectionsNotification)
   deriving (FromJSON, ToJSON) via (CustomEncoded UserDeletedConnectionsNotification)
 
 data ClaimKeyPackageRequest = ClaimKeyPackageRequest
   { -- | The user making the request, implictly qualified by the origin domain.
-    ckprClaimant :: UserId,
+    claimant :: UserId,
     -- | The user whose key packages are being claimed, implictly qualified by
     -- the target domain.
-    ckprTarget :: UserId
+    target :: UserId
   }
   deriving stock (Eq, Show, Generic)
   deriving (Arbitrary) via (GenericUniform ClaimKeyPackageRequest)

libs/wire-api-federation/src/Wire/API/Federation/API/Cargohold.hs

@@ -29,19 +29,19 @@ import Wire.Arbitrary (Arbitrary, GenericUniform (..))
 
 data GetAsset = GetAsset
   { -- | User requesting the asset. Implictly qualified with the source domain.
-    gaUser :: UserId,
+    user :: UserId,
     -- | Asset key for the asset to download. Implictly qualified with the
     -- target domain.
-    gaKey :: AssetKey,
+    key :: AssetKey,
     -- | Optional asset token.
-    gaToken :: Maybe AssetToken
+    token :: Maybe AssetToken
   }
   deriving stock (Eq, Show, Generic)
   deriving (Arbitrary) via (GenericUniform GetAsset)
   deriving (ToJSON, FromJSON) via (CustomEncoded GetAsset)
 
 data GetAssetResponse = GetAssetResponse
-  {gaAvailable :: Bool}
+  {available :: Bool}
   deriving stock (Eq, Show, Generic)
   deriving (Arbitrary) via (GenericUniform GetAssetResponse)
   deriving (ToJSON, FromJSON) via (CustomEncoded GetAssetResponse)