netlify-cli 17.3.1 → 17.4.0

package/src/lib/functions/synchronous.mjs

@@ -1,85 +1,63 @@
-// @ts-check
-import { Buffer } from 'buffer'
-
-import { isStream } from 'is-stream'
-
-import { chalk, logPadded, NETLIFYDEVERR } from '../../utils/command-helpers.mjs'
-import renderErrorTemplate from '../render-error-template.mjs'
-
-import { detectAwsSdkError } from './utils.mjs'
-
+import { Buffer } from 'buffer';
+import { isStream } from 'is-stream';
+import { chalk, logPadded, NETLIFYDEVERR } from '../../utils/command-helpers.mjs';
+import renderErrorTemplate from '../render-error-template.mjs';
+import { detectAwsSdkError } from './utils.mjs';
 /**
  * @typedef InvocationError
  * @property {string} errorType
  * @property {string} errorMessage
  * @property {Array<string>} stackTrace
  */
-
+// @ts-expect-error TS(7006) FIXME: Parameter 'headers' implicitly has an 'any' type.
 const addHeaders = (headers, response) => {
-  if (!headers) {
-    return
-  }
-
-  Object.entries(headers).forEach(([key, value]) => {
-    response.setHeader(key, value)
-  })
-}
-
-export const handleSynchronousFunction = function ({
-  error: invocationError,
-  functionName,
-  request,
-  response,
-  result,
-}) {
-  if (invocationError) {
-    const error = getNormalizedError(invocationError)
-
-    logPadded(
-      `${NETLIFYDEVERR} Function ${chalk.yellow(functionName)} has returned an error: ${
-        error.errorMessage
-      }\n${chalk.dim(error.stackTrace.join('\n'))}`,
-    )
-
-    return handleErr(invocationError, request, response)
-  }
-
-  const { error } = validateLambdaResponse(result)
-  if (error) {
-    logPadded(`${NETLIFYDEVERR} ${error}`)
-
-    return handleErr(error, request, response)
-  }
-
-  response.statusCode = result.statusCode
-
-  try {
-    addHeaders(result.headers, response)
-    addHeaders(result.multiValueHeaders, response)
-  } catch (headersError) {
-    const normalizedError = getNormalizedError(headersError)
-
-    logPadded(
-      `${NETLIFYDEVERR} Failed to set header in function ${chalk.yellow(functionName)}: ${
-        normalizedError.errorMessage
-      }`,
-    )
-
-    return handleErr(headersError, request, response)
-  }
-
-  if (result.body) {
-    if (isStream(result.body)) {
-      result.body.pipe(response)
-
-      return
+    if (!headers) {
+        return;
     }
-
-    response.write(result.isBase64Encoded ? Buffer.from(result.body, 'base64') : result.body)
-  }
-  response.end()
-}
-
+    Object.entries(headers).forEach(([key, value]) => {
+        response.setHeader(key, value);
+    });
+};
+export const handleSynchronousFunction = function ({ 
+// @ts-expect-error TS(7031) FIXME: Binding element 'invocationError' implicitly has a... Remove this comment to see the full error message
+error: invocationError, 
+// @ts-expect-error TS(7031) FIXME: Binding element 'functionName' implicitly has an '... Remove this comment to see the full error message
+functionName, 
+// @ts-expect-error TS(7031) FIXME: Binding element 'request' implicitly has an 'any' ... Remove this comment to see the full error message
+request, 
+// @ts-expect-error TS(7031) FIXME: Binding element 'response' implicitly has an 'any'... Remove this comment to see the full error message
+response, 
+// @ts-expect-error TS(7031) FIXME: Binding element 'result' implicitly has an 'any' t... Remove this comment to see the full error message
+result, }) {
+    if (invocationError) {
+        const error = getNormalizedError(invocationError);
+        logPadded(`${NETLIFYDEVERR} Function ${chalk.yellow(functionName)} has returned an error: ${error.errorMessage}\n${chalk.dim(error.stackTrace.join('\n'))}`);
+        return handleErr(invocationError, request, response);
+    }
+    const { error } = validateLambdaResponse(result);
+    if (error) {
+        logPadded(`${NETLIFYDEVERR} ${error}`);
+        return handleErr(error, request, response);
+    }
+    response.statusCode = result.statusCode;
+    try {
+        addHeaders(result.headers, response);
+        addHeaders(result.multiValueHeaders, response);
+    }
+    catch (headersError) {
+        const normalizedError = getNormalizedError(headersError);
+        logPadded(`${NETLIFYDEVERR} Failed to set header in function ${chalk.yellow(functionName)}: ${normalizedError.errorMessage}`);
+        return handleErr(headersError, request, response);
+    }
+    if (result.body) {
+        if (isStream(result.body)) {
+            result.body.pipe(response);
+            return;
+        }
+        response.write(result.isBase64Encoded ? Buffer.from(result.body, 'base64') : result.body);
+    }
+    response.end();
+};
 /**
  * Accepts an error generated by `lambda-local` or an instance of `Error` and
  * returns a normalized error that we can treat in the same way.
@@ -87,83 +65,76 @@ export const handleSynchronousFunction = function ({
  * @param {InvocationError|Error} error
  * @returns {InvocationError}
  */
+// @ts-expect-error TS(7006) FIXME: Parameter 'error' implicitly has an 'any' type.
 const getNormalizedError = (error) => {
-  if (error instanceof Error) {
-    const normalizedError = {
-      errorMessage: error.message,
-      errorType: error.name,
-      stackTrace: error.stack ? error.stack.split('\n') : [],
-    }
-
-    if ('code' in error && error.code === 'ERR_REQUIRE_ESM') {
-      return {
-        ...normalizedError,
-        errorMessage:
-          'a CommonJS file cannot import ES modules. Consider switching your function to ES modules. For more information, refer to https://ntl.fyi/functions-runtime.',
-      }
+    if (error instanceof Error) {
+        const normalizedError = {
+            errorMessage: error.message,
+            errorType: error.name,
+            stackTrace: error.stack ? error.stack.split('\n') : [],
+        };
+        if ('code' in error && error.code === 'ERR_REQUIRE_ESM') {
+            return {
+                ...normalizedError,
+                errorMessage: 'a CommonJS file cannot import ES modules. Consider switching your function to ES modules. For more information, refer to https://ntl.fyi/functions-runtime.',
+            };
+        }
+        return normalizedError;
     }
-
-    return normalizedError
-  }
-
-  // Formatting stack trace lines in the same way that Node.js formats native
-  // errors.
-  const stackTrace = error.stackTrace.map((line) => `    at ${line}`)
-
-  return {
-    errorType: error.errorType,
-    errorMessage: error.errorMessage,
-    stackTrace,
-  }
-}
-
+    // Formatting stack trace lines in the same way that Node.js formats native
+    // errors.
+    // @ts-expect-error TS(7006) FIXME: Parameter 'line' implicitly has an 'any' type.
+    const stackTrace = error.stackTrace.map((line) => `    at ${line}`);
+    return {
+        errorType: error.errorType,
+        errorMessage: error.errorMessage,
+        stackTrace,
+    };
+};
+// @ts-expect-error TS(7006) FIXME: Parameter 'rawError' implicitly has an 'any' type.
 const formatLambdaLocalError = (rawError, acceptsHTML) => {
-  const error = getNormalizedError(rawError)
-
-  if (acceptsHTML) {
-    return JSON.stringify({
-      ...error,
-      stackTrace: undefined,
-      trace: error.stackTrace,
-    })
-  }
-
-  return `${error.errorType}: ${error.errorMessage}\n ${error.stackTrace.join('\n')}`
-}
-
+    const error = getNormalizedError(rawError);
+    if (acceptsHTML) {
+        return JSON.stringify({
+            ...error,
+            stackTrace: undefined,
+            trace: error.stackTrace,
+        });
+    }
+    return `${error.errorType}: ${error.errorMessage}\n ${error.stackTrace.join('\n')}`;
+};
+// @ts-expect-error TS(7006) FIXME: Parameter 'err' implicitly has an 'any' type.
 const handleErr = async (err, request, response) => {
-  detectAwsSdkError({ err })
-
-  const acceptsHtml = request.headers && request.headers.accept && request.headers.accept.includes('text/html')
-  const errorString = typeof err === 'string' ? err : formatLambdaLocalError(err, acceptsHtml)
-
-  response.statusCode = 500
-
-  if (acceptsHtml) {
-    response.setHeader('Content-Type', 'text/html')
-    response.end(await renderErrorTemplate(errorString, './templates/function-error.html', 'function'))
-  } else {
-    response.end(errorString)
-  }
-}
-
+    // @ts-expect-error TS(2345) FIXME: Argument of type '{ err: any; }' is not assignable... Remove this comment to see the full error message
+    detectAwsSdkError({ err });
+    const acceptsHtml = request.headers && request.headers.accept && request.headers.accept.includes('text/html');
+    const errorString = typeof err === 'string' ? err : formatLambdaLocalError(err, acceptsHtml);
+    response.statusCode = 500;
+    if (acceptsHtml) {
+        response.setHeader('Content-Type', 'text/html');
+        response.end(await renderErrorTemplate(errorString, './templates/function-error.html', 'function'));
+    }
+    else {
+        response.end(errorString);
+    }
+};
+// @ts-expect-error TS(7006) FIXME: Parameter 'lambdaResponse' implicitly has an 'any'... Remove this comment to see the full error message
 const validateLambdaResponse = (lambdaResponse) => {
-  if (lambdaResponse === undefined) {
-    return { error: 'lambda response was undefined. check your function code again' }
-  }
-  if (lambdaResponse === null) {
-    return {
-      error: 'no lambda response. check your function code again. make sure to return a promise or use the callback.',
+    if (lambdaResponse === undefined) {
+        return { error: 'lambda response was undefined. check your function code again' };
     }
-  }
-  if (!Number(lambdaResponse.statusCode)) {
-    return {
-      error: `Your function response must have a numerical statusCode. You gave: ${lambdaResponse.statusCode}`,
+    if (lambdaResponse === null) {
+        return {
+            error: 'no lambda response. check your function code again. make sure to return a promise or use the callback.',
+        };
+    }
+    if (!Number(lambdaResponse.statusCode)) {
+        return {
+            error: `Your function response must have a numerical statusCode. You gave: ${lambdaResponse.statusCode}`,
+        };
+    }
+    if (lambdaResponse.body && typeof lambdaResponse.body !== 'string' && !isStream(lambdaResponse.body)) {
+        return { error: `Your function response must have a string or a stream body. You gave: ${lambdaResponse.body}` };
     }
-  }
-  if (lambdaResponse.body && typeof lambdaResponse.body !== 'string' && !isStream(lambdaResponse.body)) {
-    return { error: `Your function response must have a string or a stream body. You gave: ${lambdaResponse.body}` }
-  }
-
-  return {}
-}
+    return {};
+};

package/src/lib/functions/utils.mjs

@@ -1,54 +1,46 @@
-// @ts-check
-import { chalk, warn } from '../../utils/command-helpers.mjs'
-import { MISSING_AWS_SDK_WARNING } from '../log.mjs'
-
+import { chalk, warn } from '../../utils/command-helpers.mjs';
+import { MISSING_AWS_SDK_WARNING } from '../log.mjs';
+// @ts-expect-error TS(7031) FIXME: Binding element 'error' implicitly has an 'any' ty... Remove this comment to see the full error message
 export const detectAwsSdkError = ({ error }) => {
-  const isAwsSdkError = error && error.errorMessage && error.errorMessage.includes("Cannot find module 'aws-sdk'")
-
-  if (isAwsSdkError) {
-    warn(MISSING_AWS_SDK_WARNING)
-  }
-}
-
-export const formatLambdaError = (err) => chalk.red(`${err.errorType}: ${err.errorMessage}`)
-
+    const isAwsSdkError = error && error.errorMessage && error.errorMessage.includes("Cannot find module 'aws-sdk'");
+    if (isAwsSdkError) {
+        warn(MISSING_AWS_SDK_WARNING);
+    }
+};
+// @ts-expect-error TS(7006) FIXME: Parameter 'err' implicitly has an 'any' type.
+export const formatLambdaError = (err) => chalk.red(`${err.errorType}: ${err.errorMessage}`);
 // should be equivalent to https://github.com/netlify/proxy/blob/main/pkg/functions/request.go#L105
 const exceptionsList = new Set([
-  'application/csp-report',
-  'application/graphql',
-  'application/json',
-  'application/javascript',
-  'application/x-www-form-urlencoded',
-  'application/x-ndjson',
-  'application/xml',
-])
-
+    'application/csp-report',
+    'application/graphql',
+    'application/json',
+    'application/javascript',
+    'application/x-www-form-urlencoded',
+    'application/x-ndjson',
+    'application/xml',
+]);
 /**
  * @param {string | undefined} contentType
  * @returns {boolean}
  */
+// @ts-expect-error TS(7006) FIXME: Parameter 'contentType' implicitly has an 'any' ty... Remove this comment to see the full error message
 export const shouldBase64Encode = function (contentType) {
-  if (!contentType) {
-    return true
-  }
-
-  const [contentTypeSegment] = contentType.split(';')
-  contentType = contentTypeSegment
-  contentType = contentType.toLowerCase()
-
-  if (contentType.startsWith('text/')) {
-    return false
-  }
-
-  if (contentType.endsWith('+json') || contentType.endsWith('+xml')) {
-    return false
-  }
-
-  if (exceptionsList.has(contentType)) {
-    return false
-  }
-
-  return true
-}
-
-export const styleFunctionName = (name) => chalk.magenta(name)
+    if (!contentType) {
+        return true;
+    }
+    const [contentTypeSegment] = contentType.split(';');
+    contentType = contentTypeSegment;
+    contentType = contentType.toLowerCase();
+    if (contentType.startsWith('text/')) {
+        return false;
+    }
+    if (contentType.endsWith('+json') || contentType.endsWith('+xml')) {
+        return false;
+    }
+    if (exceptionsList.has(contentType)) {
+        return false;
+    }
+    return true;
+};
+// @ts-expect-error TS(7006) FIXME: Parameter 'name' implicitly has an 'any' type.
+export const styleFunctionName = (name) => chalk.magenta(name);

package/src/lib/geo-location.mjs

@@ -1,14 +1,11 @@
-// @ts-check
-import fetch from 'node-fetch'
-
-const API_URL = 'https://netlifind.netlify.app'
-const STATE_GEO_PROPERTY = 'geolocation'
+// @ts-expect-error TS(7016) FIXME: Could not find a declaration file for module 'node... Remove this comment to see the full error message
+import fetch from 'node-fetch';
+const API_URL = 'https://netlifind.netlify.app';
+const STATE_GEO_PROPERTY = 'geolocation';
 // 24 hours
-const CACHE_TTL = 8.64e7
-
+const CACHE_TTL = 8.64e7;
 // 10 seconds
-const REQUEST_TIMEOUT = 1e4
-
+const REQUEST_TIMEOUT = 1e4;
 /**
  * @typedef GeoLocation
  * @type {object}
@@ -23,16 +20,14 @@ const REQUEST_TIMEOUT = 1e4
  * @property {number} latitude
  * @property {string} timezone
  */
-
 export const mockLocation = {
-  city: 'San Francisco',
-  country: { code: 'US', name: 'United States' },
-  subdivision: { code: 'CA', name: 'California' },
-  longitude: 0,
-  latitude: 0,
-  timezone: 'UTC',
-}
-
+    city: 'San Francisco',
+    country: { code: 'US', name: 'United States' },
+    subdivision: { code: 'CA', name: 'California' },
+    longitude: 0,
+    latitude: 0,
+    timezone: 'UTC',
+};
 /**
  * Returns geolocation data from a remote API, the local cache, or a mock
  * location, depending on the mode selected.
@@ -44,76 +39,69 @@ export const mockLocation = {
  * @param {import('../utils/state-config.mjs').default} params.state
  * @returns {Promise<GeoLocation>}
  */
+// @ts-expect-error TS(7031) FIXME: Binding element 'geoCountry' implicitly has an 'an... Remove this comment to see the full error message
 export const getGeoLocation = async ({ geoCountry, mode, offline, state }) => {
-  const cacheObject = state.get(STATE_GEO_PROPERTY)
-
-  // If `--country` was used, we also set `--mode=mock`.
-  if (geoCountry) {
-    mode = 'mock'
-  }
-
-  // If we have cached geolocation data and the `--geo` option is set to
-  // `cache`, let's try to use it.
-  // Or, if the country we're trying to mock is the same one as we have in the
-  // cache, let's use the cache instead of the mock.
-  if (cacheObject !== undefined && (mode === 'cache' || cacheObject.data.country.code === geoCountry)) {
-    const age = Date.now() - cacheObject.timestamp
-
-    // Let's use the cached data if it's not older than the TTL. Also, if the
-    // `--offline` option was used, it's best to use the cached location than
-    // the mock one.
-    if (age < CACHE_TTL || offline) {
-      return cacheObject.data
-    }
-  }
-
-  // If the `--geo` option is set to `mock`, we use the default mock location.
-  // If the `--offline` option was used, we can't talk to the API, so let's
-  // also use the mock location.  Otherwise, use the country code passed in by
-  // the user.
-  if (mode === 'mock' || offline || geoCountry) {
+    const cacheObject = state.get(STATE_GEO_PROPERTY);
+    // If `--country` was used, we also set `--mode=mock`.
     if (geoCountry) {
-      return {
-        city: 'Mock City',
-        country: { code: geoCountry, name: 'Mock Country' },
-        subdivision: { code: 'SD', name: 'Mock Subdivision' },
-        longitude: 0,
-        latitude: 0,
-        timezone: 'UTC',
-      }
+        mode = 'mock';
+    }
+    // If we have cached geolocation data and the `--geo` option is set to
+    // `cache`, let's try to use it.
+    // Or, if the country we're trying to mock is the same one as we have in the
+    // cache, let's use the cache instead of the mock.
+    if (cacheObject !== undefined && (mode === 'cache' || cacheObject.data.country.code === geoCountry)) {
+        const age = Date.now() - cacheObject.timestamp;
+        // Let's use the cached data if it's not older than the TTL. Also, if the
+        // `--offline` option was used, it's best to use the cached location than
+        // the mock one.
+        if (age < CACHE_TTL || offline) {
+            return cacheObject.data;
+        }
+    }
+    // If the `--geo` option is set to `mock`, we use the default mock location.
+    // If the `--offline` option was used, we can't talk to the API, so let's
+    // also use the mock location.  Otherwise, use the country code passed in by
+    // the user.
+    if (mode === 'mock' || offline || geoCountry) {
+        if (geoCountry) {
+            return {
+                city: 'Mock City',
+                country: { code: geoCountry, name: 'Mock Country' },
+                subdivision: { code: 'SD', name: 'Mock Subdivision' },
+                longitude: 0,
+                latitude: 0,
+                timezone: 'UTC',
+            };
+        }
+        return mockLocation;
+    }
+    // Trying to retrieve geolocation data from the API and caching it locally.
+    try {
+        const data = await getGeoLocationFromAPI();
+        const newCacheObject = {
+            data,
+            timestamp: Date.now(),
+        };
+        state.set(STATE_GEO_PROPERTY, newCacheObject);
+        return data;
     }
-    return mockLocation
-  }
-
-  // Trying to retrieve geolocation data from the API and caching it locally.
-  try {
-    const data = await getGeoLocationFromAPI()
-    const newCacheObject = {
-      data,
-      timestamp: Date.now(),
+    catch {
+        // We couldn't get geolocation data from the API, so let's return the
+        // mock location.
+        return mockLocation;
     }
-
-    state.set(STATE_GEO_PROPERTY, newCacheObject)
-
-    return data
-  } catch {
-    // We couldn't get geolocation data from the API, so let's return the
-    // mock location.
-    return mockLocation
-  }
-}
-
+};
 /**
  * Returns geolocation data from a remote API
  *
  * @returns {Promise<GeoLocation>}
  */
 const getGeoLocationFromAPI = async () => {
-  const res = await fetch(API_URL, {
-    method: 'GET',
-    timeout: REQUEST_TIMEOUT,
-  })
-  const { geo } = await res.json()
-
-  return geo
-}
+    const res = await fetch(API_URL, {
+        method: 'GET',
+        timeout: REQUEST_TIMEOUT,
+    });
+    const { geo } = await res.json();
+    return geo;
+};