Query validation rejects directive on field because of "@inaccessible" usage

[cyrilc-pro]

Component(s)

cli

Component version

0.129.3

wgc version

0.129.3

controlplane version

N/A

router version

N/A

What happened?

Description

Given two schemas:

• One that use the @inaccessible
• One that defines a directive that can be used on fields (e.g. @dateFormat)

The execution config generated with wgc does not include the @dateFormat directive definition in the graphqlClientSchema (it is part of the graphqlSchema though).

The result is that any use of the directive @dateFormat in a query is rejected by the validation by Cosmo Router.

Note: if no schema uses @inaccessible, then the issue cannot be reproduced.

Steps to Reproduce

File inaccessible.graphqls:

extend schema
  @link(
    url: "https://specs.apollo.dev/federation/v2.3"
    import: ["@key", "@inaccessible"]
  )

type Query {
  product(upc: String!): Product
}

type Product @key(fields: "upc") {
  upc: String!
  name: String!
  """
  Private field. Presence of @inaccessible forces Cosmo to emit
  engineConfig.graphqlClientSchema (client-facing schema).
  """
  privateId: ID! @inaccessible
}

File runtime-directive.graphqls:

extend schema
  @link(
    url: "https://specs.apollo.dev/federation/v2.3"
    import: ["@shareable", "@composeDirective"]
  )
  @link(url: "https://example.com/mytool/v1.0", import: ["@dateFormat"])
  @composeDirective(name: "@dateFormat")

"""
Executable directive used in queries to format Date fields.
"""
directive @dateFormat(format: DateFormat! = ISO8601) on FIELD

enum DateFormat {
  ISO8601
  ISO8601_DATE_ONLY
  DD_MMM_YYYY
}

"""
Date type, string value, supports the @dateFormat directive.
"""
scalar Date

type Query {
  createdAt: Date @shareable
}

File: graph.yaml:

version: 1
subgraphs:
  - name: inaccessible
    routing_url: http://localhost:4001/graphql
    schema:
      file: ./inaccessible.graphqls
  - name: runtime-directive
    routing_url: http://localhost:4002/graphql
    schema:
      file: ./runtime-directive.graphqls

Then run:

npx -y wgc@latest router compose -i graph.yaml -o execution-config.json

Then inspect the generated execution-config.json.

Expected Result

I expect the @dateFormat to be accepted by the validation by Cosmo Router.

@dateFormat should be part of .engineConfig.graphqlClientSchema.

Actual Result

Cosmo Router rejects any use of @dateFormat in the query.

@dateFormat is not be part of .engineConfig.graphqlClientSchema.

Environment information

Environment

OS: darwin, linux
Package Manager: npm
Compiler(if manually compiled): node 22

Router configuration

Router execution config

{
  "engineConfig": {
    "defaultFlushInterval": "500",
    "datasourceConfigurations": [
      {
        "kind": "GRAPHQL",
        "rootNodes": [
          {
            "typeName": "Query",
            "fieldNames": [
              "product"
            ]
          },
          {
            "typeName": "Product",
            "fieldNames": [
              "upc",
              "name",
              "privateId"
            ]
          }
        ],
        "overrideFieldPathFromAlias": true,
        "customGraphql": {
          "fetch": {
            "url": {
              "staticVariableContent": "http://localhost:4001/graphql"
            },
            "method": "POST",
            "body": {},
            "baseUrl": {},
            "path": {}
          },
          "subscription": {
            "enabled": true,
            "url": {
              "staticVariableContent": "http://localhost:4001/graphql"
            },
            "protocol": "GRAPHQL_SUBSCRIPTION_PROTOCOL_WS",
            "websocketSubprotocol": "GRAPHQL_WEBSOCKET_SUBPROTOCOL_AUTO"
          },
          "federation": {
            "enabled": true,
            "serviceSdl": "extend schema\n  @link(\n    url: \"https://specs.apollo.dev/federation/v2.3\"\n    import: [\"@key\", \"@inaccessible\"]\n  )\n\ntype Query {\n  product(upc: String!): Product\n}\n\ntype Product @key(fields: \"upc\") {\n  upc: String!\n  name: String!\n  \"\"\"\n  Private field. Presence of @inaccessible forces Cosmo to emit\n  engineConfig.graphqlClientSchema (client-facing schema).\n  \"\"\"\n  privateId: ID! @inaccessible\n}\n"
          },
          "upstreamSchema": {
            "key": "2959cab65563e3fc8d74362d3da513b0b80f84bb"
          }
        },
        "requestTimeoutSeconds": "10",
        "id": "0",
        "keys": [
          {
            "typeName": "Product",
            "selectionSet": "upc"
          }
        ]
      },
      {
        "kind": "GRAPHQL",
        "rootNodes": [
          {
            "typeName": "Query",
            "fieldNames": [
              "createdAt"
            ]
          }
        ],
        "overrideFieldPathFromAlias": true,
        "customGraphql": {
          "fetch": {
            "url": {
              "staticVariableContent": "http://localhost:4002/graphql"
            },
            "method": "POST",
            "body": {},
            "baseUrl": {},
            "path": {}
          },
          "subscription": {
            "enabled": true,
            "url": {
              "staticVariableContent": "http://localhost:4002/graphql"
            },
            "protocol": "GRAPHQL_SUBSCRIPTION_PROTOCOL_WS",
            "websocketSubprotocol": "GRAPHQL_WEBSOCKET_SUBPROTOCOL_AUTO"
          },
          "federation": {
            "enabled": true,
            "serviceSdl": "extend schema\n  @link(\n    url: \"https://specs.apollo.dev/federation/v2.3\"\n    import: [\"@shareable\", \"@composeDirective\"]\n  )\n  @link(url: \"https://example.com/mytool/v1.0\", import: [\"@dateFormat\"])\n  @composeDirective(name: \"@dateFormat\")\n\n\"\"\"\nExecutable directive used in queries to format Date fields.\n\"\"\"\ndirective @dateFormat(format: DateFormat! = ISO8601) on FIELD\n\nenum DateFormat {\n  ISO8601\n  ISO8601_DATE_ONLY\n  DD_MMM_YYYY\n}\n\n\"\"\"\nDate type, string value, supports the @dateFormat directive.\n\"\"\"\nscalar Date\n\ntype Query {\n  createdAt: Date @shareable\n}\n"
          },
          "upstreamSchema": {
            "key": "0d18c8697c45acb28c452042e2c7a9c1da88a32a"
          }
        },
        "requestTimeoutSeconds": "10",
        "id": "1"
      }
    ],
    "fieldConfigurations": [
      {
        "typeName": "Query",
        "fieldName": "product",
        "argumentsConfiguration": [
          {
            "name": "upc",
            "sourceType": "FIELD_ARGUMENT"
          }
        ]
      }
    ],
    "graphqlSchema": "schema {\n  query: Query\n}\n\ndirective @inaccessible on ARGUMENT_DEFINITION | ENUM | ENUM_VALUE | FIELD_DEFINITION | INPUT_FIELD_DEFINITION | INPUT_OBJECT | INTERFACE | OBJECT | SCALAR | UNION\n\n\"\"\"Executable directive used in queries to format Date fields.\"\"\"\ndirective @dateFormat(format: DateFormat! = ISO8601) on FIELD\n\ntype Query {\n  product(upc: String!): Product\n  createdAt: Date\n}\n\ntype Product {\n  upc: String!\n  name: String!\n  \"\"\"\n  Private field. Presence of @inaccessible forces Cosmo to emit\n  engineConfig.graphqlClientSchema (client-facing schema).\n  \"\"\"\n  privateId: ID! @inaccessible\n}\n\nenum DateFormat {\n  ISO8601\n  ISO8601_DATE_ONLY\n  DD_MMM_YYYY\n}\n\n\"\"\"Date type, string value, supports the @dateFormat directive.\"\"\"\nscalar Date",
    "stringStorage": {
      "2959cab65563e3fc8d74362d3da513b0b80f84bb": "schema {\n  query: Query\n}\n\ndirective @inaccessible on ARGUMENT_DEFINITION | ENUM | ENUM_VALUE | FIELD_DEFINITION | INPUT_FIELD_DEFINITION | INPUT_OBJECT | INTERFACE | OBJECT | SCALAR | UNION\n\ndirective @key(fields: openfed__FieldSet!, resolvable: Boolean = true) repeatable on INTERFACE | OBJECT\n\ndirective @link(as: String, for: link__Purpose, import: [link__Import], url: String!) repeatable on SCHEMA\n\ntype Product @key(fields: \"upc\") {\n  name: String!\n  \"\"\"\n  Private field. Presence of @inaccessible forces Cosmo to emit\n  engineConfig.graphqlClientSchema (client-facing schema).\n  \"\"\"\n  privateId: ID! @inaccessible\n  upc: String!\n}\n\ntype Query {\n  product(upc: String!): Product\n}\n\nscalar link__Import\n\nenum link__Purpose {\n  EXECUTION\n  SECURITY\n}\n\nscalar openfed__FieldSet",
      "0d18c8697c45acb28c452042e2c7a9c1da88a32a": "schema {\n  query: Query\n}\n\ndirective @composeDirective(name: String!) repeatable on SCHEMA\n\n\"\"\"Executable directive used in queries to format Date fields.\"\"\"\ndirective @dateFormat(format: DateFormat! = ISO8601) on FIELD\n\ndirective @link(as: String, for: link__Purpose, import: [link__Import], url: String!) repeatable on SCHEMA\n\ndirective @shareable repeatable on FIELD_DEFINITION | OBJECT\n\n\"\"\"Date type, string value, supports the @dateFormat directive.\"\"\"\nscalar Date\n\nenum DateFormat {\n  DD_MMM_YYYY\n  ISO8601\n  ISO8601_DATE_ONLY\n}\n\ntype Query {\n  createdAt: Date @shareable\n}\n\nscalar link__Import\n\nenum link__Purpose {\n  EXECUTION\n  SECURITY\n}"
    },
    "graphqlClientSchema": "schema {\n  query: Query\n}\n\ntype Query {\n  product(upc: String!): Product\n  createdAt: Date\n}\n\ntype Product {\n  upc: String!\n  name: String!\n}\n\nenum DateFormat {\n  ISO8601\n  ISO8601_DATE_ONLY\n  DD_MMM_YYYY\n}\n\n\"\"\"Date type, string value, supports the @dateFormat directive.\"\"\"\nscalar Date"
  },
  "version": "00000000-0000-0000-0000-000000000000",
  "subgraphs": [
    {
      "id": "0",
      "name": "inaccessible",
      "routingUrl": "http://localhost:4001/graphql"
    },
    {
      "id": "1",
      "name": "runtime-directive",
      "routingUrl": "http://localhost:4002/graphql"
    }
  ],
  "featureFlagConfigs": {},
  "compatibilityVersion": "1:0.63.1"
}

Log output

Additional context

No response

[github-actions]

WunderGraph commits fully to Open Source and we want to make sure that we can help you as fast as possible.
The roadmap is driven by our customers and we have to prioritize issues that are important to them.
You can influence the priority by becoming a customer. Please contact us here.

[Aenimus]

Hi @cyrilc-pro,

Please could you add a failing test to cosmo/composition/tests/v1/directives/compose-directive.test.ts?

Thank you,

The WunderGraph Team

[Aenimus]

Hi again @cyrilc-pro,

I took a second look, and you're trying to compose an executable directive. This is not the function of @composeDirective. You should add the directive definition (on its own—not with compose directive) to all subgraphs.

[cyrilc-pro]

I hope I understood well. I just tried with the following:

inaccessible.graphqls:

extend schema
  @link(
    url: "https://specs.apollo.dev/federation/v2.3"
    import: ["@key", "@inaccessible"]
  )

"""
Executable directive used in queries to format Date fields.
"""
directive @dateFormat(format: DateFormat! = ISO8601) on FIELD

enum DateFormat {
  ISO8601
  ISO8601_DATE_ONLY
  DD_MMM_YYYY
}

"""
Date type, string value, supports the @dateFormat directive.
"""
scalar Date

type Query {
  product(upc: String!): Product
}

type Product @key(fields: "upc") {
  upc: String!
  name: String!
  """
  Private field. Presence of @inaccessible forces Cosmo to emit
  engineConfig.graphqlClientSchema (client-facing schema).
  """
  privateId: ID! @inaccessible
}

runtime-directive.graphqls:

  @link(
    url: "https://specs.apollo.dev/federation/v2.3"
    import: ["@shareable", "@composeDirective"]
  )
  @link(url: "https://example.com/mytool/v1.0", import: ["@dateFormat"])

"""
Executable directive used in queries to format Date fields.
"""
directive @dateFormat(format: DateFormat! = ISO8601) on FIELD

enum DateFormat {
  ISO8601
  ISO8601_DATE_ONLY
  DD_MMM_YYYY
}

"""
Date type, string value, supports the @dateFormat directive.
"""
scalar Date

type Query {
  createdAt: Date @shareable
}

But anyway, the dateFormat directive definition is not included in .engineConfig.graphqlClientSchema

What am I missing?

[Aenimus]

Hi @cyrilc-pro,

It looks like there is a small bug where executable directives are not persisted in the client schema; I've replicated.

Thanks for the report!

[Aenimus]

Hello @cyrilc-pro

We're creating a fix for the executable directive not showing up in the client schema.

However, I'm confused by your original report. @composeDirective directives are never propagated to the client schema. You mentioned that it's propagated as long as @inaccessible is not referenced. But I can't replicate this.

As far as my testing showing, @composeDirective works the same regardless of the presence of @inaccessible. Are you able to create a failing test, or provide some subgraph snippets here that replicate the directive appearing in the client schema without @inaccessible?

[Aenimus]

Hi @cyrilc-pro @RemiBou @yinonavraham

The executable directive fix has been released. But I would still like to replicate the @composeDirective propagating a definition into the client schema. Can you provide some more details/a failing test/some minimal schemas?

Thanks,

The WunderGraph Team

[cyrilc-pro]

@Aenimus I think the issue is not related to @composeDirective. There was a misunderstanding (from me) about the use of this directive: as you pointed out earlier it is not supposed to be used with executable directives.
Let's close the issue with your current fix, thanks for the quick response time.
If you provide me with the Cosmo CLI version that has the fix, I can do a quick check on my side and confirm the fix.

[Aenimus]

Hi @cyrilc-pro please update to the latest wgc (0.129.7).

I understand there may have been some confusion, but you did report at least some behaviour changing due to the addition of @inaccessible, which I'd like to understand and rule out if possible.

If you're still confident this was a mistake and no difference in behaviour occurs, please let me know.

Thanks,

The WunderGraph Team

[cyrilc-pro]

@Aenimus the issue was indeed caused by the use of the @inaccessible directive and had nothing to do with @composeDirective.

Meaning that, when @inacessible directive is not used, everything worked fine (@dateFormat is accepted), but, when @inacessibledirective is used,@dateFormat` was not accepted.

[Aenimus]

Hi @cyrilc-pro,

I really appreciate the explanation. With the exact graphs you supplied, I was not able to replicate this. Could you supply me with some minimal subgraphs for a replication?

The only thing I can think of is that the following worked:

directive @dateFormat on FIELD

type Query {
  a: ID
}

And the following did not:

directive @dateFormat on FIELD

type Query {
  a: ID
  b: ID @inaccessible
}

If that was the case, this is also indeed fixed. Once you can confirm it's working, I'll go ahead and close this issue.

Thanks again,

The WunderGraph Team.