New OpenAPI handler fails to consume valid OAS (DeepL)

[wwerner]

I'm trying to consume the DeepL API through the new OpenAPI handler. I'm using this API spec.

With this .meshrc, I'm seeing the error below.

sources:
  - name: DeepL
    handler:
      newOpenapi:
        oasFilePath: https://raw.githubusercontent.com/DeepLcom/openapi/main/openapi.json

💥 🕸️  Mesh - DeepL Failed to generate the schema TypeError: Cannot read properties of undefined (reading 'trim')
    at Object.sanitizeNameForGraphQL (/private/tmp/x/node_modules/@graphql-mesh/utils/index.js:396:36)
    at getJSONSchemaOptionsFromOpenAPIOptions (/private/tmp/x/node_modules/@omnigraph/openapi/index.js:86:39)
    at async Object.createBundle (/private/tmp/x/node_modules/@omnigraph/openapi/index.js:332:82)
    at async Object.getWithSet (/private/tmp/x/node_modules/@graphql-mesh/store/index.js:155:38)
    at async OpenAPIHandler.getMeshSource (/private/tmp/x/node_modules/@graphql-mesh/new-openapi/index.js:38:24)
    at async /private/tmp/x/node_modules/@graphql-mesh/runtime/index.js:41:28
💥 🕸️  Mesh An error occured while writing the schema file: Error: Schemas couldn't be generated successfully. Check for the logs by running Mesh with DEBUG=1 environmental variable to get more verbose output.
    at Object.getMesh (/private/tmp/x/node_modules/@graphql-mesh/runtime/index.js:71:15)
💥 🕸️  Mesh An error occurred while building the artifacts: Error: Schemas couldn't be generated successfully. Check for the logs by running Mesh with DEBUG=1 environmental variable to get more verbose output.
    at Object.getMesh (/private/tmp/x/node_modules/@graphql-mesh/runtime/index.js:71:15)
💥 🕸️  Mesh - Server Error: Schemas couldn't be generated successfully. Check for the logs by running Mesh with DEBUG=1 environmental variable to get more verbose output.
    at Object.getMesh (/private/tmp/x/node_modules/@graphql-mesh/runtime/index.js:71:15)
error Command failed with exit code 1.
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.

When debugging, it looks like there might be $refs that are not getting resolved properly:

• in getJSONSchemaOptionsFromOpenAPIOptions, sanitizeNameForGraphQL is called with paramObj.name of a paramObj that looks like this: {$ref: '#/components/parameters/DocumentID'}
• sanitizeNameForGraphQL tries to .trim() that name, which is undefined.

The spec validates nicely in swagger editor. It generates some warnings when linted using the redocly CLI (npx @redocly/cli lint https://raw.githubusercontent.com/DeepLcom/openapi/main/openapi.json), but I couldn't make out any connections between the warnings and the exhibited behavior.

Can anyone spot if there's something off with the API? Am I missing something? Or is it a bug in the handler?

Thanks in advance!

[noe-lc]

I got the same error message, logged out one of the definitions at which mesh failed and built a simpler schema with it; and it did not fail; so I am also wondering if this is an issue with library. Happy to open an issue or provide the schema.

[ardatan]

Please create an issue with the schema :) Thanks!

[mtyrrell]

We have also encountered issues with Swagger 2 and Open API 3 specs and have switched over to openapi-to-graphql + Yoga in those scenarios for 800+ API specs.

[Urigo]

@mtyrrell and on top of that we have tests running on DeepL API now, so would be great to get more cases if necessary from your 800+ API specs!

[mtyrrell]

Thank you @Urigo!!! We will follow up on this thread in the next few weeks.

[wwerner]

OMG that sounds awesome! Thanks a ton!

[mtyrrell]

@Urigo - the API specs are published on our public developer portal: https://developers.procore.com/api/v1/resource_groups/full_oas

[mtyrrell]

Let me know if that concatenated JSON works in your test framework. Alternatively I will work with the team to break it down by domain.

[wwerner]

Sorry for the lag, but I can confirm that the DeepL API spec loads nicely now¹! Thanks a ton.
There still is an issue (they have an endpoint not using application/json but form-data), but that's another discussion. Just including it here in case s/o stumbles upon it.

🥳 🙏

Footnotes

1. With @graphql-mesh/[email protected], @graphql-mesh/[email protected], [email protected] ↩