Servantify more of brig internal api

[fisx]

https://wearezeta.atlassian.net/browse/WPB-2188

Checklist

• Add a new entry in an appropriate subdirectory of changelog.d
• Read and follow the PR guidelines

[fisx]

this is getting a little out of hand...

Tests
  User (types vs. aeson)
    [...]
    RichInfo Examples
      Empty rich info:                                                                              FAIL
        Error message: RichInfoMapAndList
        expected: Success (RichInfoMapAndList {richInfoMap = fromList [], richInfoAssocList = []})
         but got: Error "key \"richInfo\" not found"

        CallStack (from HasCallStack):
          assertFailure, called at ./Test/Tasty/HUnit/Orig.hs:86:32 in tasty-hunit-0.10.0.3-5gW5br1avVmDRoG1UA3lIa:Test.Tasty.HUnit.Orig
          assertEqual, called at test/unit/Test/Wire/API/User/RichInfo.hs:74:11 in main:Test.Wire.API.User.RichInfo
        Use -p '/RichInfo/&&/Empty rich info/' to rerun this test only.

i think the problem is that we used to treat object field names as case insensitive in the FromJSON instances, but it's unclear how to do that here. field and friends from schema-profunctor have Text baked in.

also failing:

make ci package=brig TASTY_PATTERN=/de-whitelisting/
make ci package=galley TASTY_PATTERN='/update conversation as member/'
make ci package=galley TASTY_PATTERN='/Teams LegalHold API (with flag whitelist-teams-and-implicit-consent).PUT \/teams\/{tid}\/legalhold\/approve/'
make ci package=galley TASTY_PATTERN='/Teams LegalHold API (with flag whitelist-teams-and-implicit-consent).DELETE \/teams\/{tid}\/legalhold\/{uid}/'

[fisx]

Another puzzle: is there a way to allow for the value of a json field to be either an object or an array, so two completely different parsers? I think that's what <|> is for, but I can't get it to work.

To be more specific, I have this test (reproduce with make c package=wire-api test=1 TASTY_PATTERN='/RichInfoMapAndList as only assoc list/'):

        testCase "RichInfoMapAndList as only assoc list" $ do
          let inputJSON =
                [aesonQQ|{
                                     "urn:wire:scim:schemas:profile:1.0" : {
                                        "richinfo": [{"type": "foo", "value": "bar"}]
                                     }
                                   }|]
          assertEqual "RichInfoMapAndList" (Aeson.Success $ mkRichInfo [RichField "foo" "bar"]) $ fromJSON inputJSON,

... which requires that richinfo can not only contain an object with version and fields, but also the fields without a surrounding object. both are legal and should be parsed successfully, but we don't handle this corner case with the new schema-profunctor instances.

So I tried this:

instance ToSchema RichInfoAssocList where
  schema =
    ciObject "RichInfoAssocList" richInfoAssocListSchema
      <|> richInfoAssocListSchemaLegacy
    where
      richInfoAssocListSchemaLegacy :: ValueSchema NamedSwaggerDoc RichInfoAssocList
      richInfoAssocListSchemaLegacy = array (schema @RichField)

      richInfoAssocListSchema :: CIObjectSchema SwaggerDoc RichInfoAssocList
      [...]

But ghc wasn't convinced:

$ make c package=wire-api test=1 TASTY_PATTERN='/RichInfoMapAndList as only assoc list/'
[...]
src/Wire/API/User/RichInfo.hs:280:39: error:
    • Couldn't match type ‘[RichField]’ with ‘RichInfoAssocList’
      Expected: ValueSchema NamedSwaggerDoc RichInfoAssocList
        Actual: ValueSchema NamedSwaggerDoc [RichField]
    • In the expression: array (schema @RichField)
      In an equation for ‘richInfoAssocListSchemaLegacy’:
          richInfoAssocListSchemaLegacy = array (schema @RichField)
      In an equation for ‘schema’:
          schema
            = ciObject "RichInfoAssocList" richInfoAssocListSchema
                <|> richInfoAssocListSchemaLegacy
            where
                richInfoAssocListSchemaLegacy ::
                  ValueSchema NamedSwaggerDoc RichInfoAssocList
                richInfoAssocListSchemaLegacy = array (schema @RichField)
                richInfoAssocListSchema ::
                  CIObjectSchema SwaggerDoc RichInfoAssocList
                richInfoAssocListSchema
                  = withParser
                      ((,) <$> const (0 :: Int) .= ciField "version" schema
                         <*> unRichInfoAssocList .= ciField "fields" (array schema))
                      $ \ (version, fields)
                          -> mkRichInfoAssocList <$> validateRichInfoAssocList version fields
    |
280 |       richInfoAssocListSchemaLegacy = array (schema @RichField)

When I implemented richInfoAssocListSchemaLegacy as undefined, another error surfaced on the calling side:

src/Wire/API/User/RichInfo.hs:277:7: error:
    • No instance for (Data.Schema.NearSemiRing S.NamedSchema)
        arising from a use of ‘<|>’
    • In the expression:
        ciObject "RichInfoAssocList" richInfoAssocListSchema
          <|> richInfoAssocListSchemaLegacy
      In an equation for ‘schema’:
          schema
            = ciObject "RichInfoAssocList" richInfoAssocListSchema
                <|> richInfoAssocListSchemaLegacy
            where
                richInfoAssocListSchemaLegacy ::
                  ValueSchema NamedSwaggerDoc RichInfoAssocList
                richInfoAssocListSchemaLegacy = undefined
                richInfoAssocListSchema ::
                  CIObjectSchema SwaggerDoc RichInfoAssocList
                richInfoAssocListSchema
                  = withParser
                      ((,) <$> const (0 :: Int) .= ciField "version" schema
                         <*> unRichInfoAssocList .= ciField "fields" (array schema))
                      $ \ (version, fields)
                          -> mkRichInfoAssocList <$> validateRichInfoAssocList version fields
      In the instance declaration for ‘ToSchema RichInfoAssocList’
    |
277 |       <|> richInfoAssocListSchemaLegacy

[fisx]

RichInfoMapAndList doesn't have a Schema instance any more; it's only needed for implementing (de-)serializing RichInfo.

[fisx]

i think this entire module just moved here.

[pcapriotti]

LGTM