Recent versions of swagger-codegen (as used by kubernetes-client) have a typescript-fetch 'language' type which should be portable across NodeJS and browser (using portable-fetch, which is what the generated code uses).

However, things are not as simple. There's a bit of code (config.ts mainly) that's quite tightly coupled to a NodeJS environment (not sure how to read kubeconfig files in a browser from fs...). As such, having a single library entrypoint (index.ts) which exports everything and works cross-environment won't work. In a browser environment, you'll likely want a more simple configuration mechanism, e.g. providing a bearer token you already retrieved using an OIDC implicit flow dance.

Also, some code (watch support) is using request directly.

Anyway.

Since I need browser-based access to the API soon'ish, I took the liberty to fork this repository and 'hack things in'. The resulting branch is published at https://github.com/scality/kubernetes-client-javascript/commits/browser

I don't claim this is the 'right' way to achieve the goal (it's most certainly not), but does the trick (for now).

The way it works: it uses Webpack's alias feature to re-implement what api.ts uses from request, but using fetch instead. Code is in src/browser/request-fetch.js. This is not meant as a drop-in replacement for request, only the bare minimum required.

I also dropped the NodeJS config module for a slightly different one (src/browser/config.js) which for basic usage exposes a similar interface, given a known token.

Finally, because saw no way to implement the request API used by the watch module based on fetch (a request result is a stream.Readable you can pipe, which can't be constructed when a call to fetch returns), I re-implemented that module (src/browser/watch.js), using the same logic and libraries, mostly, now including code to morph a fetch ReadableStream into a stream.Readable for further processing.

I also include a very bare-bones example in example/browser (see README.md on how to run it) which does an OIDC dance, logs you in, performs a getNode call (assuming you have the right RBAC authz) and starts a watch for cluster events which get dumped to the Javascript console.

All of this only got some small amounts of manual testing. No guarantees everything works 'just fine', at all!.

To consume the library, don't import src/browser/index.ts or dist/browser/index.js, because that won't work, unless (maybe?) if you configure your project Webpack config to alias request properly. Instead, I set the browser entry-point in package.json to dist/browser/bundle.js, which is also checked into the repository, and has the request stubs in place.

Finally, if a browser-friendly version of this library would be developed, I believe the API of the watch module should be revisited: let it return a ReadableStream or stream.Readable of watch results instead of working callback-based with a custom 'end' callback.

browser-side support #165

Description

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions