unit test and fix for null values in rendered JSON in UserProfile

libs/wire-api/package.yaml

@@ -68,6 +68,7 @@ tests:
     - base
     - bytestring-conversion
     - wire-api
+    - uuid
     - aeson-qq
     - lens
     - swagger2

libs/wire-api/src/Wire/API/User.hs

@@ -239,21 +239,21 @@ modelUser = Doc.defineModel "User" $ do
 
 instance ToJSON UserProfile where
   toJSON u =
-    object
-      [ "id" .= qUnqualified (profileQualifiedId u),
-        "qualified_id" .= profileQualifiedId u,
-        "name" .= profileName u,
-        "picture" .= profilePict u,
-        "assets" .= profileAssets u,
-        "accent_id" .= profileAccentId u,
-        "deleted" .= (if profileDeleted u then Just True else Nothing),
-        "service" .= profileService u,
-        "handle" .= profileHandle u,
-        "locale" .= profileLocale u,
-        "expires_at" .= profileExpire u,
-        "team" .= profileTeam u,
-        "email" .= profileEmail u
-      ]
+    object $
+      "id" .= qUnqualified (profileQualifiedId u)
+        # "qualified_id" .= profileQualifiedId u
+        # "name" .= profileName u
+        # "picture" .= profilePict u
+        # "assets" .= profileAssets u
+        # "accent_id" .= profileAccentId u
+        # "deleted" .= (if profileDeleted u then Just True else Nothing)
+        # "service" .= profileService u
+        # "handle" .= profileHandle u
+        # "locale" .= profileLocale u
+        # "expires_at" .= profileExpire u
+        # "team" .= profileTeam u
+        # "email" .= profileEmail u
+        # []
 
 instance FromJSON UserProfile where
   parseJSON = withObject "UserProfile" $ \o ->

libs/wire-api/test/unit/Test/Wire/API/User.hs

@@ -21,18 +21,38 @@
 module Test.Wire.API.User where
 
 import Data.Aeson
+import qualified Data.Aeson as Aeson
 import Data.Aeson.Types as Aeson
+import Data.Domain
+import Data.Id
+import Data.Qualified
+import qualified Data.UUID.V4 as UUID
 import Imports
 import Test.Tasty
 import Test.Tasty.HUnit
-import Wire.API.User (parseIdentity)
-import Wire.API.User.Identity
+import Wire.API.User
 
 tests :: TestTree
 tests = testGroup "User (types vs. aeson)" $ unitTests
 
 unitTests :: [TestTree]
-unitTests =
+unitTests = parseIdentityTests ++ jsonNullTests
+
+jsonNullTests :: [TestTree]
+jsonNullTests = [testGroup "JSON null" [testCase "userProfile" $ testUserProfile]]
+
+testUserProfile :: Assertion
+testUserProfile = do
+  uid <- Id <$> UUID.nextRandom
+  let domain = Domain "example.com"
+  let colour = ColourId 0
+  let userProfile = UserProfile (Qualified uid domain) (Name "name") (Pict []) [] colour False Nothing Nothing Nothing Nothing Nothing Nothing
+  let profileJSONAsText = show $ Aeson.encode userProfile
+  let msg = "toJSON encoding must not convert Nothing to null, but instead omit those json fields for backwards compatibility. UserProfileJSON:" <> profileJSONAsText
+  assertBool msg (not $ "null" `isInfixOf` profileJSONAsText)
+
+parseIdentityTests :: [TestTree]
+parseIdentityTests =
   [ let (=#=) :: Either String (Maybe UserIdentity) -> (Maybe UserSSOId, [Pair]) -> Assertion
         (=#=) uid (mssoid, object -> Object obj) = assertEqual "=#=" uid (parseEither (parseIdentity mssoid) obj)
         (=#=) _ bad = error $ "=#=: impossible: " <> show bad

libs/wire-api/wire-api.cabal

@@ -4,7 +4,7 @@ cabal-version: 1.12
 --
 -- see: https://github.com/sol/hpack
 --
--- hash: 4e9f1f53fb43a39da1366fe060fe0ef8e2b0185847abdc61552ca3262bf25322
+-- hash: 46c27a7dd27a8d410e856a84b3d86983e03db46567976decb2856d18e0d2068f
 
 name:           wire-api
 version:        0.1.0
@@ -153,5 +153,6 @@ test-suite wire-api-tests
     , tasty-quickcheck
     , types-common >=0.16
     , unordered-containers
+    , uuid
     , wire-api
   default-language: Haskell2010