Skip to content

Latest commit

 

History

History
73 lines (50 loc) · 3.71 KB

FETCH_MIGRATION.md

File metadata and controls

73 lines (50 loc) · 3.71 KB

Fetch migration

Request is fully deprecated requiring us to switch libraries (see #414 for more information). There were a few different options for how this swap should be implemented but moving to a new open-api generator option was chosen since this project will acquire the advantages of an up-to-date open-api generator version.

Fetch was selected as the new HTTP request library for this project due to its widespread adoption across the JavaScript ecosystem. Additonally, potential future updates to this project could allow this client to be available with browser JavaScript since fetch is native to the browser (#165).

Node-fetch is our specific fetch package since it is the largest Node.js compatable implementation. Fetch is not implemented by default in Node.

For more details see the initial discussion (#754).

Release cycle

The fetch generator will create breaking changes to this project's API. Consumers will have to make small modifications to their code to upgrade.

We will continue to support the request version of this project for three Kubernetes API versions (~9 months) to give users time to migrate.

Versioning will follow npm semantic versioning.

Old generator (request)

Code will be on the release-0.x branch.

  • 0.17.x == old generator, Kubernetes 1.23 API
  • 0.18.x == old generator, Kubernetes 1.24 API
  • 0.19.x == old generator, Kubernetes 1.25 API

Support for old generator stops after 1.25

New generator (fetch)

Code will be on the master branch.

  • 1.0.x == new generator, Kubernetes 1.23 API
  • 1.1.x == new generator, Kubernetes 1.24 API
  • 1.2.x == new generator, Kubernetes 1.25 API Support for subsequent kubernetes versions continues with the new generator.

Implementation steps

Other repositories

  • Update kubernetes-client/gen's typescript-fetch files to let us pass in the typescriptThreePlus config option 1 2
  • Update openapi-generator's typescript-fetch flavor to mark parameters as optional if all parameters are optional 3

Kubernetes-client repository

  • Increment OPENAPI_GENERATOR_COMMIT to be version 5.3.0 (with the optional parameters addition)
  • npm install node-fetch to install node-fetch
  • Switch generate-client script to use typescript-fetch
  • Import and inject node-fetch in src/api.ts with the following
import fetch from 'node-fetch';

// inject node-fetch
if (!globalThis.fetch) {
    // @ts-ignore
    globalThis.fetch = fetch;
    globalThis.Headers = Headers;
    globalThis.Request = Request;
    globalThis.Response = Response;
}
  • Generate api with npm run generate
  • Match src/gen/api.ts to new generated layout (it changes slightly)
  • Fix errors in /src folder (due to new api)
  • Fix errors in test (due to new api)
  • Test all features
  • Fix examples (due to new api)
  • Update docs
  • Document breaking changes for users
  • Release initial version (1.0.0)