How to use SwaggerClient in web worker

[tmkasun]

I'm getting

browser.js:1 Uncaught ReferenceError: window is not defined

This exception is coming from
swagger-client -> HTTP -> form-data-monkey-patch -> isomorphic-form-data)

Exception when trying to use SwaggerClient in a web worker. I did a little bit of a search and found that there is an issue created in isomorphic-form-data repo asking for a solution.

I tried setting outputglobalobject in webpack output also, But that didn't work.

Q&A (please complete the following information)

• OS: macOS
• Environment: Chrome Version 89.0.4389.90
• Method of installation: npm
• Swagger-Client version: 3.12.0
• Swagger/OpenAPI version: OpenAPI 3.0.1

Content & configuration

Swagger/OpenAPI definition:

Link to definition

Swagger-Client usage:

import SwaggerClient from 'swagger-client';

SwaggerClient.resolve({
    url: '/api/am/publisher/v2/swagger.yaml',
    requestInterceptor: (request) => {
        request.headers.Accept = 'text/yaml';
    },
}).then((spec) => {
    self.postMessage(spec);
});

Screenshots

How can we help?

Can you please help me in using the SwaggerClient in the work environment? Is SwaggerClient support it or am I doing anything wrong here?

[char0n]

swagger-js should work properly in Web Worker environment. The problem is (as you already mentioned correctly in this issue) isomorphic-form-data library that we use. Let's continue the discussion there, becase this problem needs to be fix upstream before it's fixed in swagger-js.

[char0n]

Added a comment in isomorphic-form-data. If it's not going to be resolved there in some reasonable time, we'll have to find an alternative solution to move things forward.

[char0n]

@tmkasun,

Current workaround could be to use resolve alias in your webpack config to get around this problem.

Webpack config

...
resolve: {
  alias: {
    'isomorphic-form-data': path.resolve(__dirname, 'src/isomorphic-form-data.js/')
  }
}   
...

isomorphic-form-data.js

module.exports = globalThis.FormData

This will bypass the ismorphic-form-data library in your worker build fragment and will use src/ismorphic-form-data.js local file with correct global symbol.

Please let me know if this temporary workaround worked for you.

[tmkasun]

Thanks @char0n , I will check and let you know

[char0n]

I've issued a PR against https://github.com/form-data/isomorphic-form-data to fix this issue. Let's see if authors merge it and release a new major release.

[char0n]

It's high time to fix this; isomorphic-form-data library looks completely dead and the fix is not going to come from upstream.

Here is a plan to resolving this issue in SwaggerJS repo:

1. wait for isomorphic support for formdata-node library (Making this library isomorphic octet-stream/form-data#38)
2. replace isomorphic-form-data for https://www.npmjs.com/package/formdata-node
3. Get rid of monkey patching

   swagger-js/src/internal/form-data-monkey-patch.js

   Line 32 in 5de9f6f

   this.entryList.push(createEntry(field, value));

4. release new version of swagger-client

More context here: #1547

After we have this resolved, swagger-client will be natively support in WebWorker env without workarounds provided in comments of this issue.

PR is ready here: #2154

[char0n]

Released in https://www.npmjs.com/package/swagger-client/v/3.14.0