@depup/kubernetes-client 9.0.0-depup.0

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 GoDaddy Operating Company, LLC.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,39 @@
+# @depup/kubernetes-client
+
+> Dependency-bumped version of [kubernetes-client](https://www.npmjs.com/package/kubernetes-client)
+
+Generated by [DepUp](https://github.com/depup/npm) -- all production
+dependencies bumped to latest versions.
+
+## Installation
+
+```bash
+npm install @depup/kubernetes-client
+```
+
+| Field | Value |
+|-------|-------|
+| Original | [kubernetes-client](https://www.npmjs.com/package/kubernetes-client) @ 9.0.0 |
+| Processed | 2026-03-17 |
+| Smoke test | passed |
+| Deps updated | 9 |
+
+## Dependency Changes
+
+| Dependency | From | To |
+|------------|------|-----|
+| @kubernetes/client-node | 0.10.2 | ^1.4.0 |
+| camelcase | ^6.0.0 | ^9.0.0 |
+| deepmerge | ^4.2.2 | ^4.3.1 |
+| js-yaml | ^3.13.1 | ^4.1.1 |
+| openid-client | ^3.14.0 | ^6.8.2 |
+| pump | ^3.0.0 | ^3.0.4 |
+| qs | ^6.9.0 | ^6.15.0 |
+| url-join | ^4.0.1 | ^5.0.0 |
+| ws | ^7.2.3 | ^8.19.0 |
+
+---
+
+Source: https://github.com/depup/npm | Original: https://www.npmjs.com/package/kubernetes-client
+
+License inherited from the original package.

package/backends/kubernetes-client-node.js

@@ -0,0 +1,153 @@
+'use strict'
+
+const camelCase = require('camelcase')
+const k8s = require('@kubernetes/client-node')
+const { PassThrough, Readable } = require('stream')
+
+//
+// https://github.com/kubernetes-client/javascript
+//
+class ClientNodeBackend {
+  constructor (options) {
+    this.client = options.client || k8s
+    this.kubeconfig = options.kubeconfig
+    this.apiClients = { }
+  }
+
+  _getApiClient (tag) {
+    const apiType = camelCase(tag, { pascalCase: true }) + 'Api'
+    if (!(apiType in this.apiClients)) {
+      this.apiClients[apiType] = this.kubeconfig.makeApiClient(this.client[apiType])
+    }
+    return this.apiClients[apiType]
+  }
+
+  getLogByteStream (options) {
+    const log = new this.client.Log(this.kubeconfig)
+    const qs = options.qs || options.parameters || {}
+    const containerName = qs.container
+    const stream = new PassThrough()
+
+    //
+    // node-client pipes to the log stream iff the apiserver returns 200. Assume
+    // that if the stream is readable, then node-client has attached the pipe
+    // and the call was successful.
+    //
+    // Otherwise, node-client calls the callback with an err.
+    //
+    // node-client also calls the callback when the connection terminates. We
+    // ignore that.
+    //
+    return new Promise((resolve, reject) => {
+      stream.once('readable', () => {
+        resolve(stream)
+      })
+      log.log(options.pathnameParameters.namespace,
+        options.pathnameParameters.name,
+        containerName,
+        stream,
+        err => { if (err) return reject(err) },
+        qs)
+    })
+  }
+
+  async getWatchObjectStream (options) {
+    const watch = new this.client.Watch(this.kubeconfig)
+
+    const stream = new Readable({
+      objectMode: true,
+      read: () => { /* .watch callback pushes to stream below */ },
+      destroy: (err, cb) => {
+        req.destroy(err)
+        req.abort()
+        cb(err)
+      }
+    })
+
+    const req = watch.watch(
+      options.pathname,
+      Object.assign({}, options.qs, options.parameters),
+      (type, object) => stream.push({ type, object }),
+      err => stream.destroy(err)
+    )
+
+    return stream
+  }
+
+  http (options) {
+    const pathItemObject = options.pathItemObject
+    const operationObject = pathItemObject[options.method.toLowerCase()]
+    const tag = operationObject.tags[0]
+
+    const apiClient = this._getApiClient(tag)
+
+    //
+    // In older Kubernetes API OpenAPI specifications the Operation IDs include
+    // the tag, but in newer versions (including the ones used to generate
+    // @kubernetes/client-node), the tag is absent.
+    //
+    // Support older versions of the Swagger specifications by removing the tag
+    // part.
+    //
+    const method = operationObject.operationId.replace(camelCase(tag, { pascalCase: true }), '')
+
+    //
+    // @kubernetes/client-node methods take parameters in the order the OpenAPI
+    // specification declares them.
+    //
+    const parameterObjects = (pathItemObject.parameters || []).concat(operationObject.parameters || [])
+    const orderedParameterObjects = parameterObjects
+      .filter(parameterObject => parameterObject.required)
+      .concat(parameterObjects
+        .filter(parameterObject => !parameterObject.required))
+
+    //
+    // Older versions of the Kubernetes API OpenAPI specifications requires body
+    // for _some_ delete operations (e.g., deleteNamespacedDeployment). The API
+    // does not actually require it and newer specifications remove the
+    // requirement. Try to Workaround this issue by adding an empty body to
+    // @kubernetes/client-node calls.
+    //
+    let body = options.body
+    if (options.method.toLowerCase() === 'delete' && !body) {
+      body = {}
+    }
+
+    const parameters = Object.assign(
+      { body },
+      options.pathnameParameters,
+      options.qs,
+      options.parameters)
+    const args = orderedParameterObjects.reduce((acc, operationParameter) => {
+      const name = operationParameter.name
+      if (name in parameters) {
+        acc.push(parameters[name])
+      } else {
+        acc.push(undefined)
+      }
+      return acc
+    }, [])
+
+    const extraOptions = {}
+    if (options.headers) {
+      extraOptions.headers = options.headers
+    }
+    args.push(extraOptions)
+
+    return apiClient[method].apply(apiClient, args)
+      .then(res => {
+        res.statusCode = res.response.statusCode
+        return res
+      })
+      .catch(err => {
+        if (!err.body) throw err
+        const error = new Error(err.body.message)
+        // .code is backwards compatible with pre-5.0.0 code.
+        error.code = err.response.statusCode
+        error.statusCode = err.response.statusCode
+        throw error
+      })
+  }
+}
+
+module.exports = ClientNodeBackend

package/backends/request/auth-providers/cmd.js

@@ -0,0 +1,62 @@
+/**
+ * Fetches a bearer token via comamnd
+ */
+
+'use strict'
+
+// for API compatability
+/* eslint no-sync: 0 */
+const spawnSync = require('child_process').spawnSync
+
+function getProperty (propertyName, object) {
+  // remove leading .
+  if (propertyName.match(/^\./)) {
+    propertyName = propertyName.replace(/^\./, '')
+  }
+
+  const parts = propertyName.split('.')
+  const length = parts.length
+
+  let property = object || this
+  for (let i = 0; i < length; i++) {
+    property = property[parts[i]]
+  }
+
+  return property
+}
+
+module.exports = {
+  refresh: function (config) {
+    return new Promise((resolve, reject) => {
+      const cmd = config['cmd-path']
+      const args = config['cmd-args'].split(' ')
+      const cmdEnv = config['cmd-env']
+
+      let output
+
+      if (process.platform === 'win32') {
+        output = spawnSync(cmd, args, {
+          env: Object.assign({}, process.env, cmdEnv),
+          windowsHide: true,
+          shell: true
+        })
+      } else {
+        output = spawnSync(cmd, args, {
+          env: Object.assign({}, process.env, cmdEnv),
+          windowsHide: true
+        })
+      }
+
+      let result
+      try {
+        result = JSON.parse(output.stdout.toString('utf8'))
+      } catch (err) {
+        return reject(new Error('Failed to run cmd.'))
+      }
+
+      const token = getProperty(config['token-key'].replace(/[{}]+/g, ''), result)
+
+      return resolve(token)
+    })
+  }
+}

package/backends/request/auth-providers/openid.js

@@ -0,0 +1,27 @@
+/**
+ * Refreshes a OpenID token.
+ */
+
+'use strict'
+
+const Issuer = require('openid-client').Issuer
+
+module.exports = {
+  refresh: function (config) {
+    return new Promise((resolve, reject) => {
+      Issuer.discover(config['idp-issuer-url'])
+        .then(function (ourIssuer) {
+          const client = new ourIssuer.Client({
+            client_id: config['client-id'],
+            client_secret: config['client-secret']
+          })
+
+          return client.refresh(config['refresh-token'])
+        })
+        .then(tokenSet => {
+          return resolve(tokenSet.id_token)
+        })
+        .catch(reject)
+    })
+  }
+}

package/backends/request/client.js

@@ -0,0 +1,243 @@
+'use strict'
+
+const { convertKubeconfig } = require('./config')
+const deprecate = require('depd')('kubernetes-client')
+const JSONStream = require('json-stream')
+const pump = require('pump')
+const qs = require('qs')
+const request = require('request')
+const urljoin = require('url-join')
+const WebSocket = require('ws')
+
+/**
+ * Refresh whatever authentication {type} is.
+ * @param {String} type - type of authentication
+ * @param {Object} config - auth provider config
+ * @returns {Promise} with request friendly auth object
+ */
+function refreshAuth (type, config) {
+  return new Promise((resolve, reject) => {
+    const provider = require(`./auth-providers/${type}.js`)
+    provider.refresh(config)
+      .then(result => {
+        const auth = {
+          bearer: result
+        }
+
+        return resolve(auth)
+      })
+      .catch(err => reject(err))
+  })
+}
+
+const execChannels = [
+  'stdin',
+  'stdout',
+  'stderr',
+  'error',
+  'resize'
+]
+
+/**
+ * Determine whether a failed Kubernetes API response is asking for an upgrade
+ * @param {object} body - response body object from Kubernetes
+ * @property {string} status - request status
+ * @property {number} code - previous request's response code
+ * @property {message} message - previous request response message
+ * @returns {boolean} Upgrade the request
+ */
+
+function isUpgradeRequired (body) {
+  return body.status === 'Failure' &&
+    body.code === 400 &&
+    body.message === 'Upgrade request required'
+}
+
+/**
+ * Upgrade a request into a Websocket transaction & process the result
+ * @param {ApiRequestOptions} options - Options object
+ * @param {callback} cb - The callback that handles the response
+ */
+
+function upgradeRequest (options, cb) {
+  const queryParams = qs.stringify(options.qs, { indices: false })
+  const wsUrl = urljoin(options.baseUrl, options.uri, `?${queryParams}`)
+  const protocol = 'base64.channel.k8s.io'
+
+  // Passing authorization header
+  options.headers = {
+    ...options.headers,
+    authorization: `Bearer ${options.auth.bearer}`
+  }
+  const ws = new WebSocket(wsUrl, protocol, options)
+
+  const messages = []
+  ws.on('message', (msg) => {
+    const channel = execChannels[msg.slice(0, 1)]
+    const message = Buffer.from(msg.slice(1), 'base64').toString('ascii')
+    messages.push({ channel, message })
+  })
+
+  ws.on('error', (err) => {
+    err.messages = messages
+    cb(err, messages)
+  })
+
+  ws.on('close', (code, reason) => cb(null, {
+    messages,
+    body: messages.map(({ message }) => message).join(''),
+    code,
+    reason
+  }))
+
+  return ws
+}
+
+class Request {
+  /**
+   * Internal representation of HTTP request object.
+   *
+   * @param {object} options - Options object
+   * @param {string} options.url - Kubernetes API URL
+   * @param {object} options.auth - request library auth object
+   * @param {string} options.ca - Certificate authority
+   * @param {string} options.cert - Client certificate
+   * @param {string} options.key - Client key
+   * @param {boolean} options.insecureSkipTlsVerify - Skip the validity check
+   *   on the server's certificate.
+   */
+  constructor (options) {
+    this.requestOptions = options.request || {}
+
+    let convertedOptions
+    if (!options.kubeconfig) {
+      deprecate('Request() without a .kubeconfig option, see ' +
+                'https://github.com/godaddy/kubernetes-client/blob/master/merging-with-kubernetes.md')
+      convertedOptions = options
+    } else {
+      convertedOptions = convertKubeconfig(options.kubeconfig)
+    }
+
+    this.requestOptions.qsStringifyOptions = { indices: false }
+    this.requestOptions.baseUrl = convertedOptions.url
+    this.requestOptions.ca = convertedOptions.ca
+    this.requestOptions.cert = convertedOptions.cert
+    this.requestOptions.key = convertedOptions.key
+    if ('insecureSkipTlsVerify' in convertedOptions) {
+      this.requestOptions.strictSSL = !convertedOptions.insecureSkipTlsVerify
+    }
+    if ('timeout' in convertedOptions) {
+      this.requestOptions.timeout = convertedOptions.timeout
+    }
+
+    this.authProvider = {
+      type: null
+    }
+    if (convertedOptions.auth) {
+      this.requestOptions.auth = convertedOptions.auth
+      if (convertedOptions.auth.provider) {
+        this.requestOptions.auth = convertedOptions.auth.request
+        this.authProvider = convertedOptions.auth.provider
+      }
+    }
+  }
+
+  _request (options, cb) {
+    const auth = this.authProvider
+    return request(options, (err, res, body) => {
+      if (err) return cb(err)
+
+      if (body && isUpgradeRequired(body)) {
+        return upgradeRequest(options, cb)
+      }
+
+      // Refresh auth if 401 or 403
+      if ((res.statusCode === 401 || res.statusCode === 403) && auth.type) {
+        return refreshAuth(auth.type, auth.config)
+          .then(newAuth => {
+            this.requestOptions.auth = newAuth
+            options.auth = newAuth
+            return request(options, (err, res, body) => {
+              if (err) return cb(err)
+              return cb(null, { statusCode: res.statusCode, body })
+            })
+          })
+          .catch(err => cb(err))
+      }
+
+      return cb(null, { statusCode: res.statusCode, body: body })
+    })
+  }
+
+  async getLogByteStream (options) {
+    return this.http(Object.assign({ stream: true }, options))
+  }
+
+  async getWatchObjectStream (options) {
+    const jsonStream = new JSONStream()
+    const stream = this.http(Object.assign({ stream: true }, options))
+    pump(stream, jsonStream)
+    return jsonStream
+  }
+
+  /**
+   * @param {object} options - Options object
+   * @param {Stream} options.stdin - optional stdin Readable stream
+   * @param {Stream} options.stdout - optional stdout Writeable stream
+   * @param {Stream} options.stderr - optional stdout Writeable stream
+   * @returns {Promise} Promise resolving to a Kubernetes V1 Status object and a WebSocket
+   */
+  async getWebSocket (options) {
+    throw new Error('Request.getWebSocket not implemented')
+  }
+
+  /**
+   * @typedef {object} ApiRequestOptions
+   * @property {object} body - Request body
+   * @property {object} headers - Headers object
+   * @property {string} path - version-less path
+   * @property {object} qs - {@link https://www.npmjs.com/package/request#requestoptions-callback|
+   *                          request query parameter}
+   */
+
+  /**
+   * Invoke a REST request against the Kubernetes API server
+   * @param {string} method - HTTP method, passed directly to `request`
+   * @param {ApiRequestOptions} options - Options object
+   * @param {callback} cb - The callback that handles the response
+   * @returns {Stream} If cb is falsy, return a stream
+   */
+  http (options) {
+    const uri = options.pathname
+    const requestOptions = Object.assign({
+      method: options.method,
+      uri,
+      body: options.body,
+      json: 'json' in options ? Boolean(options.json) : true,
+      qs: options.parameters || options.qs,
+      headers: options.headers
+    }, this.requestOptions)
+
+    if (options.noAuth) {
+      delete requestOptions.auth
+    }
+
+    if (options.stream) return request(requestOptions)
+
+    return new Promise((resolve, reject) => {
+      this._request(requestOptions, (err, res) => {
+        if (err) return reject(err)
+        if (res.statusCode < 200 || res.statusCode > 299) {
+          const error = new Error(res.body.message || res.body)
+          // .code is backwards compatible with pre-5.0.0 code.
+          error.code = res.statusCode
+          error.statusCode = res.statusCode
+          return reject(error)
+        }
+        resolve(res)
+      })
+    })
+  }
+}
+
+module.exports = Request