.github/workflows/codeql-analysis.yml

@@ -14,10 +14,10 @@ name: "CodeQL"
 
 on:
   push:
-    branches: [ master ]
+    branches: [ master,release-1.x ]
   pull_request:
     # The branches below must be a subset of the branches above
-    branches: [ master ]
+    branches: [ master,release-1.x ]
   schedule:
     - cron: '35 14 * * 3'
 
@@ -30,39 +30,18 @@ jobs:
       fail-fast: false
       matrix:
         language: [ 'javascript' ]
-        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
-        # Learn more...
-        # https://docs.github.com/en/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#overriding-automatic-language-detection
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@v1
+      uses: github/codeql-action/init@v2
       with:
         languages: ${{ matrix.language }}
-        # If you wish to specify custom queries, you can do so here or in a config file.
-        # By default, queries listed here will override any specified in a config file.
-        # Prefix the list here with "+" to use these queries and those in the config file.
-        # queries: ./path/to/local/query, your-org/your-repo/queries@main
-
-    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
-    # If this step fails, then you should remove it and run the build manually (see below)
+
     - name: Autobuild
-      uses: github/codeql-action/autobuild@v1
-
-    # ℹ️ Command-line programs to run using the OS shell.
-    # 📚 https://git.io/JvXDl
-
-    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
-    #    and modify them (or add more) to build your code if your project
-    #    uses a compiled language
-
-    #- run: |
-    #   make bootstrap
-    #   make release
-
+      uses: github/codeql-action/autobuild@v2
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v1
+      uses: github/codeql-action/analyze@v2

.github/workflows/deploy-docs.yml

@@ -12,7 +12,7 @@ jobs:
       - name: Setup Node.js
         uses: actions/setup-node@v2
         with:
-          node-version: '14.x'
+          node-version: '20'
       # Pre-check to validate that versions match between package.json
       # and package-lock.json. Needs to run before npm install
       - name: Validate package.json and package-lock.json versions

.github/workflows/generate-javascript.yml

@@ -0,0 +1,53 @@
+name: Generate
+
+on:
+  workflow_dispatch:
+    inputs:
+      kubernetesBranch:
+        type: string
+        required: true
+        description: 'The remote kubernetes release branch to fetch openapi spec. .e.g. "release-1.23"'
+      genCommit:
+        type: string
+        required: true
+        default: 'b461333bb57fa2dc2152f939ed70bac3cef2c1f6'
+        description: 'The commit to use for the kubernetes-client/gen repo'
+
+
+jobs:
+  generate:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Javascript
+        uses: actions/checkout@v4
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+      - name: Generate Openapi
+        run: |
+          echo "export KUBERNETES_BRANCH=${{ github.event.inputs.kubernetesBranch }} >> ./settings"
+          echo "export GEN_COMMIT="${{ github.event.inputs.genCommit }}" >> ./settings"
+          ./generate-client.sh
+      - name: Generate Branch Name
+        run: |
+          SUFFIX=$(openssl rand -hex 4)
+          echo "BRANCH=automated-generate-$SUFFIX" >> $GITHUB_ENV
+      - name: Commit and push
+        run: |
+          # Commit and push
+          git config user.email "k8s.ci.robot@gmail.com"
+          git config user.name "Kubernetes Prow Robot"
+          git checkout -b "$BRANCH"
+          git add .
+          # we modify the settings file in "Generate Openapi" but do not want to commit this
+          git reset settings
+          git commit -s -m 'Automated openapi generation from ${{ github.event.inputs.kubernetesBranch }}'
+          git push origin "$BRANCH"
+      - name: Pull Request
+        uses: repo-sync/pull-request@v2
+        with:
+          source_branch: ${{ env.BRANCH }}
+          destination_branch: ${{ github.ref_name }}
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          pr_title: "Automated Generate from openapi ${{ github.event.inputs.kubernetesBranch }}"

.github/workflows/release.yml

@@ -0,0 +1,61 @@
+name: Release
+
+on:
+    workflow_dispatch:
+        inputs:
+            releaseVersion:
+                type: string
+                required: true
+                description: The version of this release. Must be a semantic version of the form X.Y.Z.
+            dry_run:
+                type: boolean
+                required: true
+                default: false
+                description: Dry run, will not push branches or upload the artifacts.
+            skip_tag:
+                type: boolean
+                required: true
+                default: false
+                description: If true, don't tag this release, just push it.
+            pre_release:
+                type: boolean
+                required: true
+                default: false
+                description: If true, mark this as a pre-release
+
+jobs:
+    release:
+        runs-on: ubuntu-latest
+        environment: production
+        steps:
+            - name: Checkout Javascript
+              uses: actions/checkout@v4
+            - name: Setup Node
+              uses: actions/setup-node@v4
+              with:
+                  node-version: '20'
+                  registry-url: 'https://registry.npmjs.org'
+            - name: Install dependencies
+              run: npm install
+            - name: Package
+              run: ./build-package.sh
+            - name: Upload release
+              if: ${{ github.event.inputs.dry_run != 'true' && github.event.inputs.pre_release != 'true' }}
+              run: npm publish
+              env:
+                  NODE_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}
+            - name: Upload pre-release
+              if: ${{ github.event.inputs.dry_run != 'true' && github.event.inputs.pre_release == 'true' }}
+              run: npm publish --tag next
+              env:
+                  NODE_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}
+            - name: Tag release
+              if: ${{ github.event.inputs.skip_tag != 'true' }}
+              run: |
+                  git config --global user.name 'Github Bot'
+                  git config --global user.email '<>'
+                  git tag ${{ github.events.inputs.version }}
+            - name: Push tag
+              if: ${{ github.event.inputs.dry_run != 'true' }}
+              run: |
+                  git push ${{ github.events.inputs.version }}

.github/workflows/test.yml

@@ -1,28 +1,27 @@
 name: Kubernetes Javascript Client - Validation
 
 on:
-  push:
-    branches: [ master ]
-  pull_request:
-    branches: [ master ]
+    push:
+        branches: [master, release-1.x]
+    pull_request:
+        branches: [master, release-1.x]
 
 jobs:
-  build:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        node: [ '16', '14', '12' ]
-    name: Node ${{ matrix.node }} validation
-    steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v2
-        with:
-          node-version: ${{ matrix.node }}
-      # Pre-check to validate that versions match between package.json
-      # and package-lock.json. Needs to run before npm install
-      - run: node version-check.js
-      - run: npm ci
-      - run: npm test
-      - run: npm run lint
-      - run: npm audit --audit-level=critical
-
+    build:
+        runs-on: ubuntu-latest
+        strategy:
+            matrix:
+                node: ['23', '22', '20', '18']
+        name: Node ${{ matrix.node }} validation
+        steps:
+            - uses: actions/checkout@v4
+            - uses: actions/setup-node@v4
+              with:
+                  node-version: ${{ matrix.node }}
+            # Pre-check to validate that versions match between package.json
+            # and package-lock.json. Needs to run before npm install
+            - run: node version-check.js
+            - run: npm ci
+            - run: npm test
+            - run: npm run lint
+            - run: npm audit --audit-level=critical

.husky/pre-commit

@@ -0,0 +1 @@
+pretty-quick --staged

.husky/pre-push

@@ -0,0 +1,2 @@
+
+npm test && npm run lint

.mocharc.json

@@ -0,0 +1,10 @@
+{
+  "require": "tsx",
+  "extensions": ["ts"],
+  "spec": [
+    "src/**/*_test.ts"
+  ],
+  "watch-files": [
+    "src"
+  ]
+}

.prettierrc

@@ -0,0 +1,5 @@
+tabWidth: 4
+printWidth: 110
+trailingComma: all
+singleQuote: true
+arrowParens: always

FETCH_MIGRATION.md

@@ -40,34 +40,54 @@ Code will be on the `master` branch.
 ### Other repositories
 
 -   [x] Update [kubernetes-client/gen](https://github.com/kubernetes-client/gen)'s typescript-fetch files to let us pass in the `typescriptThreePlus` config option <sup>[1](https://github.com/OpenAPITools/openapi-generator/issues/9973) [2](https://github.com/OpenAPITools/openapi-generator/issues/3869#issuecomment-584152932)</sub>
--   [ ] Update [openapi-generator](https://github.com/OpenAPITools/openapi-generator)'s typescript-fetch flavor to mark parameters as optional if all parameters are optional <sup>[3](https://github.com/OpenAPITools/openapi-generator/issues/6440)</sup>
+-   [x] Update [openapi-generator](https://github.com/OpenAPITools/openapi-generator)'s typescript-fetch flavor to mark parameters as optional if all parameters are optional <sup>[3](https://github.com/OpenAPITools/openapi-generator/issues/6440)</sup>
 
 ### Kubernetes-client repository
 
--   [ ] Increment `OPENAPI_GENERATOR_COMMIT` to be [version 5.3.0](https://github.com/OpenAPITools/openapi-generator/releases/tag/v5.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
-
-```typescript
-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)
+-   [x] Increment `OPENAPI_GENERATOR_COMMIT` to be [version 5.3.0](https://github.com/OpenAPITools/openapi-generator/releases/tag/v5.3.0) (with the optional parameters addition)
+-   [x] `npm install node-fetch` to install node-fetch
+-   [x] Switch generate-client script to use typescript-fetch
+-   [x] Generate api with `npm run generate`
+-   [x] Match src/gen/api.ts to new generated layout (it changes slightly)
+-   [x] Fix errors in /src folder (due to new api)
+    -   [x] migrate src/auth.ts, the dependent implementations (ex: azure_auth, gcp_auth etc) and tests to fetch api from request
+    -   [x] migrate src/log.ts and its tests to fetch api from request
+        -   [x] major remaining work is fixing up async signatures and return piping
+    -   [x] migrate src/watch.ts and its tests to fetch api from request
+        -   [x] remove decprecated requestImpl and RequestInterface
+        -   [x] implement queryParams parameter in watch method by injecting them into the fetch call
+        -   [x] update tests in src/watch_test.ts
+-   [x] Fix errors in test (due to new api)
 -   [ ] Test all features
--   [ ] Fix examples (due to new api)
+-   [ ] Fix JavaScript examples and validate their param signatures (due to new api)
+
+    -   [x] cache-example
+    -   [x] example
+    -   [x] follow-logs
+    -   [ ] in-cluster-create-job-from-cronjob // done but unable to test with media type problems
+    -   [x] in-cluster
+    -   [x] ingress
+    -   [x] namespace
+    -   [ ] patch-example // throws an error `TypeError: Cannot read properties of undefined (reading 'makeRequestContext')`
+    -   [x] raw-example (note: uses request lib directly, will require full fetch migration not just client param swap)
+    -   [x] scale-deployment
+    -   [x] top_pods
+    -   [x] top
+    -   [ ] yaml-example // create works but deletion throws an error `TypeError: Cannot read properties of undefined (reading 'makeRequestContext')`
+
+-   [ ] Fix TypeScript examples and validate their param signatures (due to new api)
+
+    -   [ ] apply-example // KubernetesObjectApi is missing
+    -   [x] attach-example
+    -   [x] cp-example
+    -   [x] exec-example
+    -   [x] informer-with-label-selector
+    -   [x] informer
+    -   [x] port-forward
+    -   [x] example
+    -   [x] watch-example
+
 -   [ ] Update docs
+    -   [ ] Update README examples
 -   [ ] Document breaking changes for users
--   [ ] Release initial version (1.0.0)
+        [ ] Release initial version (1.0.0)

OWNERS

@@ -1,10 +1,13 @@
 # See the OWNERS docs at https://go.k8s.io/owners
 approvers:
 - brendandburns
-- drubin
+- mstruebing
+- davidgamero
 reviewers:
 - brendandburns
-- drubin
-- itowlson 
+- mstruebing
+- davidgamero
 emeritus_approvers:
 - mbohlool # 10/22/2020
+- drubin # 11/23/2023
+- itowlson # 11/23/2023

build-package.sh

@@ -6,6 +6,9 @@ set -e
 # validate branches
 . ./pre-check.sh
 
+npm run clean
+npm install
+
 # pre-requisites
 npm run lint
 npm test

examples/cache-example.js

@@ -1,19 +1,21 @@
-const k8s = require('@kubernetes/client-node');
+import * as k8s from '@kubernetes/client-node';
 
 const kc = new k8s.KubeConfig();
 kc.loadFromDefault();
 
 const k8sApi = kc.makeApiClient(k8s.CoreV1Api);
 
+const namespace = 'default';
+
 const path = '/api/v1/pods';
 const watch = new k8s.Watch(kc);
 
-const listFn = () => k8sApi.listPodForAllNamespaces()
+const listFn = () => k8sApi.listPodForAllNamespaces();
 
 const cache = new k8s.ListWatch(path, watch, listFn);
 
 const looper = () => {
-    const list = cache.list('default');
+    const list = cache.list(namespace);
     if (list) {
         let names = [];
         for (let i = 0; i < list.length; i++) {
@@ -22,6 +24,6 @@ const looper = () => {
         console.log(names.join(','));
     }
     setTimeout(looper, 2000);
-}
+};
 
 looper();