netlify-cli 17.3.1 → 17.4.0

package/src/utils/telemetry/telemetry.mjs

@@ -1,97 +1,86 @@
-// @ts-check
-import { dirname, join } from 'path'
-import process, { version as nodejsVersion } from 'process'
-import { fileURLToPath } from 'url'
-
-import { isCI } from 'ci-info'
-
-import execa from '../execa.mjs'
-import getGlobalConfig from '../get-global-config.mjs'
-
-import { isTelemetryDisabled, cliVersion } from './utils.mjs'
-import isValidEventName from './validation.mjs'
-
-const dirPath = dirname(fileURLToPath(import.meta.url))
-
+import { dirname, join } from 'path';
+import process, { version as nodejsVersion } from 'process';
+import { fileURLToPath } from 'url';
+import { isCI } from 'ci-info';
+// @ts-expect-error TS(7034) FIXME: Variable 'execa' implicitly has type 'any' in some... Remove this comment to see the full error message
+import execa from '../execa.mjs';
+import getGlobalConfig from '../get-global-config.mjs';
+import { isTelemetryDisabled, cliVersion } from './utils.mjs';
+import isValidEventName from './validation.mjs';
+const dirPath = dirname(fileURLToPath(import.meta.url));
 /**
  * @param {'track' | 'identify'} type
  * @param {object} payload
  */
+// @ts-expect-error TS(7006) FIXME: Parameter 'type' implicitly has an 'any' type.
 function send(type, payload) {
-  const requestFile = join(dirPath, 'request.mjs')
-  const options = JSON.stringify({
-    data: payload,
-    type,
-  })
-
-  const args = /** @type {const} */ ([process.execPath, [requestFile, options]])
-  if (process.env.NETLIFY_TEST_TELEMETRY_WAIT === 'true') {
-    return execa(...args, {
-      stdio: 'inherit',
-    })
-  }
-
-  // spawn detached child process to handle send
-  execa(...args, {
-    detached: true,
-    stdio: 'ignore',
-  }).unref()
+    const requestFile = join(dirPath, 'request.mjs');
+    const options = JSON.stringify({
+        data: payload,
+        type,
+    });
+    const args = /** @type {const} */ ([process.execPath, [requestFile, options]]);
+    if (process.env.NETLIFY_TEST_TELEMETRY_WAIT === 'true') {
+        // @ts-expect-error TS(7005) FIXME: Variable 'execa' implicitly has an 'any' type.
+        return execa(...args, {
+            stdio: 'inherit',
+        });
+    }
+    // spawn detached child process to handle send
+    // @ts-expect-error TS(7005) FIXME: Variable 'execa' implicitly has an 'any' type.
+    execa(...args, {
+        detached: true,
+        stdio: 'ignore',
+    }).unref();
 }
-
 const eventConfig = {
-  // Namespace of current application
-  projectName: 'cli',
-  // Allowed objects
-  objects: [
-    // example cli:sites_created
-    'sites',
-    // example cli:user_signup
-    'user',
-  ],
-}
-
+    // Namespace of current application
+    projectName: 'cli',
+    // Allowed objects
+    objects: [
+        // example cli:sites_created
+        'sites',
+        // example cli:user_signup
+        'user',
+    ],
+};
 /**
  * Tracks a custom event with the provided payload
  * @param {string} eventName
  * @param {{status?: string, duration?: number, [key: string]: unknown}} [payload]
  */
+// @ts-expect-error TS(7006) FIXME: Parameter 'eventName' implicitly has an 'any' type... Remove this comment to see the full error message
 export async function track(eventName, payload = {}) {
-  if (isCI) {
-    return
-  }
-
-  const globalConfig = await getGlobalConfig()
-  if (isTelemetryDisabled(globalConfig)) {
-    return
-  }
-
-  const [userId, cliId] = [globalConfig.get('userId'), globalConfig.get('cliId')]
-
-  // automatically add `cli:` prefix if missing
-  if (!eventName.includes('cli:')) {
-    eventName = `cli:${eventName}`
-  }
-
-  // event 'cli:command' bypasses validation
-  const isValid = eventName === 'cli:command' ? () => true : isValidEventName
-  // to ensure clean data, validate event name
-  if (!isValid(eventName, eventConfig)) {
-    return false
-  }
-
-  const { duration, status, ...properties } = payload
-  const defaultData = {
-    event: eventName,
-    userId,
-    anonymousId: cliId,
-    duration,
-    status,
-    properties: { ...properties, nodejsVersion, cliVersion },
-  }
-
-  return send('track', defaultData)
+    if (isCI) {
+        return;
+    }
+    const globalConfig = await getGlobalConfig();
+    if (isTelemetryDisabled(globalConfig)) {
+        return;
+    }
+    const [userId, cliId] = [globalConfig.get('userId'), globalConfig.get('cliId')];
+    // automatically add `cli:` prefix if missing
+    if (!eventName.includes('cli:')) {
+        eventName = `cli:${eventName}`;
+    }
+    // event 'cli:command' bypasses validation
+    const isValid = eventName === 'cli:command' ? () => true : isValidEventName;
+    // to ensure clean data, validate event name
+    if (!isValid(eventName, eventConfig)) {
+        return false;
+    }
+    // @ts-expect-error TS(2339) FIXME: Property 'duration' does not exist on type '{}'.
+    const { duration, status, ...properties } = payload;
+    const defaultData = {
+        event: eventName,
+        userId,
+        anonymousId: cliId,
+        duration,
+        status,
+        properties: { ...properties, nodejsVersion, cliVersion },
+    };
+    return send('track', defaultData);
 }
-
 /**
  * @param {object} payload
  * @param {string} payload.name
@@ -99,30 +88,26 @@ export async function track(eventName, payload = {}) {
  * @param {string} payload.userId
  * @returns
  */
+// @ts-expect-error TS(7006) FIXME: Parameter 'payload' implicitly has an 'any' type.
 export async function identify(payload) {
-  if (isCI) {
-    return
-  }
-
-  const globalConfig = await getGlobalConfig()
-  if (isTelemetryDisabled(globalConfig)) {
-    return
-  }
-
-  const cliId = globalConfig.get('cliId')
-  const { email, name, userId } = payload
-
-  const defaultTraits = {
-    name,
-    email,
-    cliId,
-  }
-
-  const identifyData = {
-    anonymousId: cliId,
-    userId,
-    traits: { ...defaultTraits, ...payload },
-  }
-
-  return send('identify', identifyData)
+    if (isCI) {
+        return;
+    }
+    const globalConfig = await getGlobalConfig();
+    if (isTelemetryDisabled(globalConfig)) {
+        return;
+    }
+    const cliId = globalConfig.get('cliId');
+    const { email, name, userId } = payload;
+    const defaultTraits = {
+        name,
+        email,
+        cliId,
+    };
+    const identifyData = {
+        anonymousId: cliId,
+        userId,
+        traits: { ...defaultTraits, ...payload },
+    };
+    return send('identify', identifyData);
 }

package/src/utils/telemetry/utils.mjs

@@ -1,7 +1,6 @@
-import getPackageJson from '../get-package-json.mjs'
-
-export const { version: cliVersion } = await getPackageJson()
-
+import getPackageJson from '../get-package-json.mjs';
+export const { version: cliVersion } = await getPackageJson();
+// @ts-expect-error TS(7006) FIXME: Parameter 'config' implicitly has an 'any' type.
 export const isTelemetryDisabled = function (config) {
-  return config.get('telemetryDisabled')
-}
+    return config.get('telemetryDisabled');
+};

package/src/utils/telemetry/validation.mjs

@@ -1,60 +1,62 @@
 /**
  * Utility to validating analytic event names for clean data
  */
-import { log } from '../command-helpers.mjs'
-
+import { log } from '../command-helpers.mjs';
+// @ts-expect-error TS(7006) FIXME: Parameter 'eventName' implicitly has an 'any' type... Remove this comment to see the full error message
 export default function isValidEventName(eventName, config) {
-  const validProject = [config.projectName]
-  const validObjects = config.objects || []
-  const matches = eventName.match(/([a-zA-Z]*):([a-zA-Z]*)_([a-zA-Z]*$)/)
-  if (!containsSeparators(eventName) || !matches) {
-    return formattingWarning(eventName)
-  }
-  const [, project, object, action] = matches
-  let error
-  // if missing any parts of event, exit
-  if (!project || !object || !action) {
-    return formattingWarning(eventName)
-  }
-  // validate project name
-  if (!validProject.includes(project)) {
-    error = `> "${project}" is invalid tracking project. Must be one of ${JSON.stringify(validProject)}`
-    return formattingWarning(eventName, error)
-  }
-  // validate object name
-  if (!validObjects.includes(object)) {
-    error = `> "${object}" is invalid tracking object. Must be one of ${JSON.stringify(validObjects)}`
-    return formattingWarning(eventName, error)
-  }
-  return true
+    const validProject = [config.projectName];
+    const validObjects = config.objects || [];
+    const matches = eventName.match(/([a-zA-Z]*):([a-zA-Z]*)_([a-zA-Z]*$)/);
+    if (!containsSeparators(eventName) || !matches) {
+        // @ts-expect-error TS(2554) FIXME: Expected 2 arguments, but got 1.
+        return formattingWarning(eventName);
+    }
+    const [, project, object, action] = matches;
+    let error;
+    // if missing any parts of event, exit
+    if (!project || !object || !action) {
+        // @ts-expect-error TS(2554) FIXME: Expected 2 arguments, but got 1.
+        return formattingWarning(eventName);
+    }
+    // validate project name
+    if (!validProject.includes(project)) {
+        error = `> "${project}" is invalid tracking project. Must be one of ${JSON.stringify(validProject)}`;
+        return formattingWarning(eventName, error);
+    }
+    // validate object name
+    if (!validObjects.includes(object)) {
+        error = `> "${object}" is invalid tracking object. Must be one of ${JSON.stringify(validObjects)}`;
+        return formattingWarning(eventName, error);
+    }
+    return true;
 }
-
+// @ts-expect-error TS(7006) FIXME: Parameter 'eventName' implicitly has an 'any' type... Remove this comment to see the full error message
 const containsSeparators = function (eventName) {
-  const underscores = (eventName.match(/_/g) || []).length
-  if (underscores !== 1) {
-    log(`Event name must have single underscore. "${eventName}" contains ${underscores}`)
-    return false
-  }
-  const colons = (eventName.match(/:/g) || []).length
-  if (colons !== 1) {
-    log(`Event name must have single colon. "${eventName}" contains ${colons}`)
-    return false
-  }
-  return true
-}
-
+    const underscores = (eventName.match(/_/g) || []).length;
+    if (underscores !== 1) {
+        log(`Event name must have single underscore. "${eventName}" contains ${underscores}`);
+        return false;
+    }
+    const colons = (eventName.match(/:/g) || []).length;
+    if (colons !== 1) {
+        log(`Event name must have single colon. "${eventName}" contains ${colons}`);
+        return false;
+    }
+    return true;
+};
+// @ts-expect-error TS(7006) FIXME: Parameter 'eventName' implicitly has an 'any' type... Remove this comment to see the full error message
 const formattingWarning = function (eventName, errorMsg) {
-  log('-----------------------------')
-  log('Tracking Error:')
-  log(`Incorrect tracking event format: "${eventName}"`)
-  if (errorMsg) {
-    log(errorMsg)
-  }
-  log('-----------------------------')
-  log(`Formatting information: `)
-  log(`eventName must match 'cli:objectName_actionName'`)
-  log(`eventName must be camelCased: 'camelCase:camelCase_camelCase'`)
-  log(`Example: cli:sites_deploySucceeded`)
-  log('-----------------------------')
-  return false
-}
+    log('-----------------------------');
+    log('Tracking Error:');
+    log(`Incorrect tracking event format: "${eventName}"`);
+    if (errorMsg) {
+        log(errorMsg);
+    }
+    log('-----------------------------');
+    log(`Formatting information: `);
+    log(`eventName must match 'cli:objectName_actionName'`);
+    log(`eventName must be camelCased: 'camelCase:camelCase_camelCase'`);
+    log(`Example: cli:sites_deploySucceeded`);
+    log('-----------------------------');
+    return false;
+};

package/src/utils/types.d.ts

@@ -0,0 +1,46 @@
+export type FrameworkNames = '#static' | '#auto' | '#custom' | string
+
+export type FrameworkInfo = {
+  build: {
+    directory: string
+  }
+  dev: {
+    commands: string[]
+    port: number
+    pollingStrategies: { name: string }[]
+  }
+  name: FrameworkNames
+  staticAssetsDirectory: string
+  env: NodeJS.ProcessEnv
+  plugins?: string[]
+}
+
+export type BaseServerSettings = {
+  baseDirectory?: string
+  dist?: string
+  /** The command that was provided for the dev config */
+  command?: string
+  /** If it should be served like static files */
+  useStaticServer?: boolean
+
+  /** A port where a proxy can listen to it */
+  frameworkPort?: number
+  /** The host where a proxy can listen to it */
+  frameworkHost?: '127.0.0.1' | '::1'
+  functions?: string
+  /** The framework name ('Create React App') */
+  framework?: string
+  env?: NodeJS.ProcessEnv
+  pollingStrategies?: string[]
+  plugins?: string[]
+}
+
+export type ServerSettings = BaseServerSettings & {
+  /** default 'secret' */
+  jwtSecret: string
+  /** default 'app_metadata.authorization.roles' */
+  jwtRolePath: string
+  /** The port where the functions are running on */
+  port: number
+  https?: { key: string; cert: string; keyFilePath: string; certFilePath: string }
+}

package/src/utils/validation.mjs

@@ -1,19 +1,16 @@
-// @ts-check
-import { BANG, chalk } from './command-helpers.mjs'
-
+import { BANG, chalk } from './command-helpers.mjs';
 /**
  * @param {string} exampleCommand
  * @returns {(value:string, previous: unknown) => unknown}
  */
+// @ts-expect-error TS(7006) FIXME: Parameter 'exampleCommand' implicitly has an 'any'... Remove this comment to see the full error message
 export const getGeoCountryArgParser = (exampleCommand) => (arg) => {
-  // Validate that the arg passed is two letters only for country
-  // See https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes
-  if (!/^[a-z]{2}$/i.test(arg)) {
-    throw new Error(
-      `The geo country code must use a two letter abbreviation.
+    // Validate that the arg passed is two letters only for country
+    // See https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes
+    if (!/^[a-z]{2}$/i.test(arg)) {
+        throw new Error(`The geo country code must use a two letter abbreviation.
       ${chalk.red(BANG)}  Example:
-      ${exampleCommand}`,
-    )
-  }
-  return arg.toUpperCase()
-}
+      ${exampleCommand}`);
+    }
+    return arg.toUpperCase();
+};