Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

OpenAPI: Browser support without polyfills #49

Closed
tjosepo opened this issue Jul 10, 2024 · 6 comments · Fixed by #51
Closed

OpenAPI: Browser support without polyfills #49

tjosepo opened this issue Jul 10, 2024 · 6 comments · Fixed by #51
Labels
scope:open-api

Comments

@tjosepo
Copy link
Contributor

tjosepo commented Jul 10, 2024 •
edited
Loading

Description

The function fromOpenApi currently doesn't work on the browser without a lot of Node.js polyfills.

Solution

For open-api-utils.ts, inlining the STATUS_CODE variable is easy enough.

For @apidevtools/json-schema-ref-parser, since it is the ubiquitous library used for JSON Schema dereferencing in Node, it may not make sense to replace it in Node. We could create a separate package entrypoint for the browser that prebundles the Node.js modules or replaces the library with web-compatible alternative (that may not support all features of JSON Schema dereferencing, but works for the web.)

Alternatives

  • Ask consumers of the library to bring their own polyfills. Will hurt the ability of teams to adopt this library. (I haven't been able to fully polyfill everything with Webpack, so I don't even know if it's possible.)
  • Make @mswjs/source/open-api a Node.js only feature.
  • Raise this issue to the @apidevtools folks. Make the change there.
@weyert
Copy link
Collaborator

weyert commented Jul 10, 2024 •
edited
Loading

Yeah, I think that's a good idea. I am wondering if we could leverage a package like @stoplight/http-spec. They also have a fork of @apidevtools/json-schema-ref-parser which appears to work in the browser but I am not sure if they use poly fills for it (probably?).

I think we might able to use this http-spec as for some cli-tool to generate HttpHandler stubs from a Postman collection file :)

@kettanaito
Copy link
Member

Thanks for opening this, @tjosepo. I would love to see Source working in the browser for OpenAPI. Our best approach here is to find packages that can provide us with parsing while not relying on Node.js native modules.

@weyert, http-spec looks interesting. Do you have some usage examples of how it parses the OAS documents? I'd love to see those.

@tjosepo tjosepo mentioned this issue Jul 12, 2024
Merged
@VobileLiuZhiwu
Copy link

@kettanaito @tjosepo @weyert I believe a better solution would be to provide an initialization command that generates the JSON string for the specification needed by const specification = await SwaggerParser.dereference(document), which can then be passed as an argument to fromOpenApi. What do you think?

@tjosepo
Copy link
Contributor Author

tjosepo commented Aug 16, 2024 •
edited
Loading

@VobileLiuZhiwu OpenAPI specifications can have circular references, but JSON strings do not support circular references. Because of this, I don't think this approach is suitable. :/

@kettanaito
Copy link
Member

I love the approach @tjosepo has chosen in #51. The changes will be automatically published tomorrow.

@kettanaito
Copy link
Member

Released: v0.3.0 🎉

This has been released in v0.3.0!

Make sure to always update to the latest version (npm i @mswjs/source@latest) to get the newest features and bug fixes.

Predictable release automation by @ossjs/release.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
scope:open-api
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat(fromOpenApi): add browser support tjosepo/source
4 participants
@weyert @kettanaito @tjosepo @VobileLiuZhiwu