Make schema-profunctor schema names derived and avoid name clashes between scopes. (#5151)

* Script for generating kotlin and typescript code from swagger.json.

* openapi3 aka swagger: Make schema names unique(r).

With this change, schema names contain a hash of the fully qualified
name of the haskell type.  This should avoid collisions in the hash
table keeping track of all the schema references in openapi3.

* Remove now unused name arguemnts from object, enum.

* Keep named variants of object, enum, ... around for corner cases.

* Versioned schemas.

* Drive-by test coverage extension.

Author: fisx

changelog.d/4-docs/swagger-hacking

@@ -0,0 +1 @@
+Make schema-profunctor schema names derived and avoid name clashes between scopes.

hack/bin/generate-clients.sh

@@ -0,0 +1,53 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+# Simple OpenAPI client generator using openapi-generator
+# Usage: ./generate-clients.sh <swagger-url>
+
+SWAGGER_URL="${1:-https://staging-nginz-https.zinfra.io/v16/api/swagger.json}"
+OUTPUT_DIR="$(pwd)/generated"
+
+echo "==> Generating clients from: $SWAGGER_URL"
+echo "==> Output directory: $OUTPUT_DIR"
+
+# Clean up previous runs
+rm -rf "$OUTPUT_DIR"
+mkdir -p "$OUTPUT_DIR"
+
+# Download the spec
+echo "==> Downloading OpenAPI spec..."
+curl -s "$SWAGGER_URL" > "$OUTPUT_DIR/swagger.json"
+
+# Check if docker is available
+if ! command -v docker &> /dev/null; then
+    echo "Error: docker is not installed. Please install docker to use openapi-generator."
+    echo "Alternative: install openapi-generator-cli via npm: npm install -g @openapitools/openapi-generator-cli"
+    exit 1
+fi
+
+# Generate TypeScript client
+echo ""
+echo "==> Generating TypeScript client..."
+docker run --rm \
+    -v "$OUTPUT_DIR:/local" \
+    openapitools/openapi-generator-cli:latest generate \
+    -i /local/swagger.json \
+    -g typescript-axios \
+    -o /local/typescript \
+    --additional-properties=supportsES6=true,npmName=wire-api-client,npmVersion=1.0.0
+
+# Generate Kotlin client
+echo ""
+echo "==> Generating Kotlin client..."
+docker run --rm \
+    -v "$OUTPUT_DIR:/local" \
+    openapitools/openapi-generator-cli:latest generate \
+    -i /local/swagger.json \
+    -g kotlin \
+    -o /local/kotlin \
+    --additional-properties=packageName=com.wire.api.client,serializationLibrary=gson
+
+echo ""
+echo "==> Done! Generated clients:"
+echo "  TypeScript: $OUTPUT_DIR/typescript"
+echo "  Kotlin:     $OUTPUT_DIR/kotlin"

integration/test/Test/AccessUpdate.hs

@@ -29,7 +29,7 @@ import Testlib.Prelude
 import Testlib.ResourcePool
 
 -- These two commented out tests exist to test the Setup.hs code.
--- Both of these tests should not appear in the output.
+-- Neither of these tests should appear in the output.
 
 -- testBar :: HasCallStack => App ()
 -- testBar = pure ()
@@ -89,6 +89,7 @@ testAccessUpdateGuestRemoved proto = do
 
   bindResponse (getConversation alice conv) $ \res -> do
     res.status `shouldMatchInt` 200
+    (length <$> (res.json %. "members.others" & asList)) `shouldMatchInt` 1
     res.json %. "members.others.0.qualified_id" `shouldMatch` objQidObject bob
 
 -- @END

libs/saml2-web-sso/src/SAML2/WebSSO/Config.hs

@@ -88,7 +88,7 @@ data ConfigRaw = ConfigRaw
 
 instance ToSchema ConfigRaw where
   schema =
-    object "ConfigRaw" $
+    object $
       ConfigRaw
         <$> (_cfgRawLogLevel .= field "logLevel" schema)
         <*> (_cfgRawSPHost .= field "spHost" schema)
@@ -100,7 +100,7 @@ instance ToSchema ConfigRaw where
 
 instance ToSchema MultiIngressDomainConfig where
   schema =
-    object "MultiIngressDomainConfig" $
+    object $
       MultiIngressDomainConfig
         <$> (_cfgSPAppURI .= field "spAppUri" schema)
         <*> (_cfgSPSsoURI .= field "spSsoUri" schema)

libs/saml2-web-sso/src/SAML2/WebSSO/Orphans.hs

@@ -66,7 +66,7 @@ instance ToSchema URI where
           $ (parseURI strictURIParserOptions . Text.encodeUtf8) uriText
 
 instance ToSchema Level where
-  schema = assert exhaustive $ enum @Text "Level" $ mconcat $ el <$> [minBound ..]
+  schema = assert exhaustive $ enum @Text $ mconcat $ el <$> [minBound ..]
     where
       el l = element (Text.pack (show l)) l
 

libs/saml2-web-sso/src/SAML2/WebSSO/Types.hs

@@ -166,6 +166,7 @@ import Data.Aeson
 import Data.Aeson.TH
 import Data.Bifunctor (first)
 import Data.CaseInsensitive qualified as CI
+import Data.Data (Typeable)
 import Data.List qualified as L
 import Data.List.NonEmpty (NonEmpty ((:|)))
 import Data.List.NonEmpty qualified as NL
@@ -271,7 +272,7 @@ data ContactPerson = ContactPerson
 -- (We may want to replace old template-haskell'ed ToJSON and FromJSON instances in hsaml2, but how?)
 instance Schema.ToSchema ContactPerson where
   schema =
-    Schema.object "ContactPerson" $
+    Schema.object $
       ContactPerson
         <$> (_cntType Schema..= Schema.field "type" Schema.schema)
         <*> (_cntCompany Schema..= Schema.maybe_ (Schema.optField "company" Schema.schema))
@@ -291,7 +292,7 @@ data ContactType
 -- (We may want to replace old template-haskell'ed ToJSON and FromJSON instances in hsaml2, but how?)
 instance Schema.ToSchema ContactType where
   schema =
-    Schema.enum @ST.Text "ContactType" $
+    Schema.enum @ST.Text $
       mconcat
         [ Schema.element "ContactTechnical" ContactTechnical,
           Schema.element "ContactSupport" ContactSupport,
@@ -312,7 +313,7 @@ data IdPMetadata = IdPMetadata
 
 instance Schema.ToSchema IdPMetadata where
   schema =
-    Schema.object "IdPMetadata" $
+    Schema.object $
       IdPMetadata
         <$> (_edIssuer Schema..= Schema.field "issuer" Schema.schema)
         <*> (_edRequestURI Schema..= Schema.field "requestURI" Schema.schema)
@@ -346,9 +347,9 @@ data IdPConfig extra = IdPConfig
   deriving (Eq, Show, Generic)
   deriving (FromJSON, ToJSON, S.ToSchema) via (Schema.Schema (IdPConfig extra))
 
-instance (Schema.ToSchema extra) => Schema.ToSchema (IdPConfig extra) where
+instance (Typeable (IdPConfig extra), Schema.ToSchema extra) => Schema.ToSchema (IdPConfig extra) where
   schema =
-    Schema.object "IdPConfig" $
+    Schema.object $
       IdPConfig
         <$> (_idpId Schema..= Schema.field "id" Schema.schema)
         <*> (_idpMetadata Schema..= Schema.field "metadata" Schema.schema)

libs/schema-profunctor/default.nix

@@ -6,10 +6,13 @@
 , aeson
 , aeson-qq
 , base
+, base64-bytestring
 , bifunctors
+, bytestring
 , comonad
 , containers
 , gitignoreSource
+, hashable
 , imports
 , insert-ordered-containers
 , lens
@@ -29,9 +32,12 @@ mkDerivation {
   libraryHaskellDepends = [
     aeson
     base
+    base64-bytestring
     bifunctors
+    bytestring
     comonad
     containers
+    hashable
     imports
     lens
     openapi3

libs/schema-profunctor/schema-profunctor.cabal

@@ -62,11 +62,14 @@ library
     -Wredundant-constraints -Wunused-packages
 
   build-depends:
-      aeson         >=2.0.1.0
-    , base          >=4       && <5
+      aeson              >=2.0.1.0
+    , base               >=4       && <5
+    , base64-bytestring
     , bifunctors
+    , bytestring
     , comonad
     , containers
+    , hashable
     , imports
     , lens
     , openapi3
@@ -83,6 +86,7 @@ test-suite schemas-tests
   other-modules:
     Paths_schema_profunctor
     Test.Data.Schema
+    Test.Data.Schema.Names
 
   hs-source-dirs:     test/unit
   default-extensions: