netlify 11.0.3 → 12.0.1

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "netlify",
   "description": "Netlify Node.js API client",
-  "version": "11.0.3",
+  "version": "12.0.1",
   "type": "module",
   "files": [
     "src/**/*.js",
@@ -52,7 +52,7 @@
     "node client"
   ],
   "dependencies": {
-    "@netlify/open-api": "^2.10.0",
+    "@netlify/open-api": "^2.12.0",
     "lodash.camelcase": "^4.3.0",
     "micro-api-client": "^3.3.0",
     "node-fetch": "^3.0.0",
@@ -61,11 +61,11 @@
     "qs": "^6.9.6"
   },
   "devDependencies": {
-    "@netlify/eslint-config-node": "^6.0.0",
+    "@netlify/eslint-config-node": "^7.0.0",
     "ava": "^4.0.0",
     "c8": "^7.11.0",
     "from2-string": "^1.1.0",
-    "husky": "^7.0.4",
+    "husky": "^8.0.0",
     "nock": "^13.0.0",
     "npm-run-all": "^4.1.5",
     "uuid": "^8.3.2"

package/src/methods/index.js

@@ -3,6 +3,7 @@ import fetch from 'node-fetch'
 import { getOperations } from '../operations.js'
 
 import { addBody } from './body.js'
+import { getRequestParams } from './params.js'
 import { parseResponse, getFetchError } from './response.js'
 import { shouldRetry, waitForRetry, MAX_RETRY } from './retry.js'
 import { getUrl } from './url.js'
@@ -32,12 +33,23 @@ const callMethod = async function ({ method, basePath, defaultHeaders, agent, gl
   return parsedResponse
 }
 
-const getOpts = function ({ method: { verb, parameters }, defaultHeaders, agent, requestParams: { body }, opts }) {
+const getOpts = function ({ method: { verb, parameters }, defaultHeaders, agent, requestParams, opts }) {
+  const { body } = requestParams
   const optsA = addHttpMethod(verb, opts)
-  const optsB = addDefaultHeaders(defaultHeaders, optsA)
-  const optsC = addBody(body, parameters, optsB)
-  const optsD = addAgent(agent, optsC)
-  return optsD
+  const optsB = addHeaderParams(parameters, requestParams, optsA)
+  const optsC = addDefaultHeaders(defaultHeaders, optsB)
+  const optsD = addBody(body, parameters, optsC)
+  const optsE = addAgent(agent, optsD)
+  return optsE
+}
+
+// Add header parameters
+const addHeaderParams = function (parameters, requestParams, opts) {
+  if (parameters.header === undefined) {
+    return opts
+  }
+
+  return { ...opts, headers: getRequestParams(parameters.header, requestParams, 'header parameter') }
 }
 
 // Add the HTTP method based on the OpenAPI definition
@@ -64,7 +76,7 @@ const makeRequestOrRetry = async function ({ url, method, defaultHeaders, agent,
     const optsA = getOpts({ method, defaultHeaders, agent, requestParams, opts })
     const { response, error } = await makeRequest(url, optsA)
 
-    if (shouldRetry({ response, error }) && index !== MAX_RETRY) {
+    if (shouldRetry({ response, error, method }) && index !== MAX_RETRY) {
       await waitForRetry(response)
       continue
     }

package/src/methods/params.js

@@ -0,0 +1,18 @@
+import camelCase from 'lodash.camelcase'
+
+export const getRequestParams = function (params, requestParams, name) {
+  const entries = Object.values(params).map((param) => getRequestParam(param, requestParams, name))
+  return Object.assign({}, ...entries)
+}
+
+const getRequestParam = function (param, requestParams, name) {
+  const value = requestParams[param.name] || requestParams[camelCase(param.name)]
+
+  if (value !== undefined) {
+    return { [param.name]: value }
+  }
+
+  if (param.required) {
+    throw new Error(`Missing required ${name} '${param.name}'`)
+  }
+}

package/src/methods/retry.js

@@ -1,12 +1,18 @@
 // We retry:
 //  - when receiving a rate limiting response
 //  - on network failures due to timeouts
-export const shouldRetry = function ({ response = {}, error = {} }) {
-  return isRetryStatus(response) || RETRY_ERROR_CODES.has(error.code)
-}
+export const shouldRetry = function ({ response = {}, error = {}, method = {} }) {
+  if (response.status === RATE_LIMIT_STATUS || RETRY_ERROR_CODES.has(error.code)) {
+    return true
+  }
+
+  // Special case for the `getLatestPluginRuns` endpoint.
+  // See https://github.com/netlify/bitballoon/issues/9616.
+  if (method.operationId === 'getLatestPluginRuns' && response.status === 500) {
+    return true
+  }
 
-const isRetryStatus = function ({ status }) {
-  return typeof status === 'number' && (status === RATE_LIMIT_STATUS || String(status).startsWith('5'))
+  return false
 }
 
 export const waitForRetry = async function (response) {

package/src/methods/url.js

@@ -1,6 +1,7 @@
-import camelCase from 'lodash.camelcase'
 import queryString from 'qs'
 
+import { getRequestParams } from './params.js'
+
 // Replace path parameters and query parameters in the URI, using the OpenAPI
 // definition
 export const getUrl = function ({ path, parameters }, basePath, requestParams) {
@@ -28,20 +29,3 @@ const addQueryParams = function (url, parameters, requestParams) {
 
   return `${url}?${queryString.stringify(queryParams, { arrayFormat: 'brackets' })}`
 }
-
-const getRequestParams = function (params, requestParams, name) {
-  const entries = Object.values(params).map((param) => getRequestParam(param, requestParams, name))
-  return Object.assign({}, ...entries)
-}
-
-const getRequestParam = function (param, requestParams, name) {
-  const value = requestParams[param.name] || requestParams[camelCase(param.name)]
-
-  if (value !== undefined) {
-    return { [param.name]: value }
-  }
-
-  if (param.required) {
-    throw new Error(`Missing required ${name} '${param.name}'`)
-  }
-}