chore: migrate to segment (#874)

Author: vladfrangu

package.json

@@ -60,7 +60,7 @@
     },
     "homepage": "https://github.com/apify/apify-cli#readme",
     "engines": {
-        "node": ">=18"
+        "node": ">=20"
     },
     "dependencies": {
         "@apify/actor-templates": "^0.1.5",
@@ -100,9 +100,7 @@
         "js-levenshtein": "^1.1.6",
         "lodash.clonedeep": "^4.5.0",
         "mime": "~4.0.4",
-        "mixpanel": "~0.18.0",
         "open": "~10.2.0",
-        "ow": "~2.0.0",
         "rimraf": "~6.0.1",
         "semver": "~7.7.0",
         "string-width": "^7.2.0",

scripts/generate-cli-docs.ts

@@ -67,6 +67,9 @@ const categories: Record<string, CommandsInCategory[]> = {
 		//
 		{ command: Commands.help },
 		{ command: Commands.upgrade },
+		{ command: Commands.telemetry },
+		{ command: Commands.telemetryEnable },
+		{ command: Commands.telemetryDisable },
 	],
 	'dataset': [
 		//

src/commands/_register.ts

@@ -28,6 +28,7 @@ import { RunCommand } from './run.js';
 import { RunsIndexCommand } from './runs/_index.js';
 import { SecretsIndexCommand } from './secrets/_index.js';
 import { TasksIndexCommand } from './task/_index.js';
+import { TelemetryIndexCommand } from './telemetry/_index.js';
 import { ValidateInputSchemaCommand } from './validate-schema.js';
 
 export const apifyCommands = [
@@ -41,6 +42,8 @@ export const apifyCommands = [
 	RunsIndexCommand,
 	SecretsIndexCommand,
 	TasksIndexCommand,
+	TelemetryIndexCommand,
+
 	// top-level
 	TopLevelCallCommand,
 	UpgradeCommand,
@@ -70,8 +73,12 @@ export const actorCommands = [
 	ActorGetPublicUrlCommand,
 	ActorGetInputCommand,
 	ActorChargeCommand,
+
 	// top-level
 	HelpCommand,
 	UpgradeCommand,
 	InstallCommand,
+
+	// namespaces
+	TelemetryIndexCommand,
 ] as const satisfies (typeof BuiltApifyCommand)[];

src/commands/init.ts

@@ -4,13 +4,7 @@ import process from 'node:process';
 import { ApifyCommand } from '../lib/command-framework/apify-command.js';
 import { Args } from '../lib/command-framework/args.js';
 import { Flags } from '../lib/command-framework/flags.js';
-import {
-	CommandExitCodes,
-	DEFAULT_LOCAL_STORAGE_DIR,
-	EMPTY_LOCAL_CONFIG,
-	LOCAL_CONFIG_PATH,
-	PROJECT_TYPES,
-} from '../lib/consts.js';
+import { CommandExitCodes, DEFAULT_LOCAL_STORAGE_DIR, EMPTY_LOCAL_CONFIG, LOCAL_CONFIG_PATH } from '../lib/consts.js';
 import { useActorConfig } from '../lib/hooks/useActorConfig.js';
 import { ProjectLanguage, useCwdProject } from '../lib/hooks/useCwdProject.js';
 import { useUserInput } from '../lib/hooks/user-confirmations/useUserInput.js';
@@ -61,7 +55,7 @@ export class InitCommand extends ApifyCommand<typeof InitCommand> {
 
 		if (project.type === ProjectLanguage.Scrapy) {
 			info({ message: 'The current directory looks like a Scrapy project. Using automatic project wrapping.' });
-			this.telemetryData.actorWrapper = PROJECT_TYPES.SCRAPY;
+			this.telemetryData.actorWrapper = 'scrapy';
 
 			return wrapScrapyProject({ projectPath: cwd });
 		}

src/commands/login.ts

@@ -12,10 +12,10 @@ import { cryptoRandomObjectId } from '@apify/utilities';
 import { ApifyCommand } from '../lib/command-framework/apify-command.js';
 import { Flags } from '../lib/command-framework/flags.js';
 import { AUTH_FILE_PATH } from '../lib/consts.js';
+import { updateUserId } from '../lib/hooks/telemetry/useTelemetryState.js';
 import { useMaskedInput } from '../lib/hooks/user-confirmations/useMaskedInput.js';
 import { useSelectFromList } from '../lib/hooks/user-confirmations/useSelectFromList.js';
 import { error, info, success } from '../lib/outputs.js';
-import { useApifyIdentity } from '../lib/telemetry.js';
 import { getLocalUserInfo, getLoggedClient } from '../lib/utils.js';
 
 const CONSOLE_BASE_URL = 'https://console.apify.com/settings/integrations';
@@ -30,8 +30,10 @@ const API_VERSION = 'v1';
 const tryToLogin = async (token: string) => {
 	const isUserLogged = await getLoggedClient(token, API_BASE_URL);
 	const userInfo = await getLocalUserInfo();
+
 	if (isUserLogged) {
-		await useApifyIdentity(userInfo.id!);
+		await updateUserId(userInfo.id!);
+
 		success({
 			message: `You are logged in to Apify as ${userInfo.username || userInfo.id}. ${chalk.gray(`Your token is stored at ${AUTH_FILE_PATH()}.`)}`,
 		});
@@ -67,6 +69,7 @@ export class LoginCommand extends ApifyCommand<typeof LoginCommand> {
 
 	async run() {
 		const { token, method } = this.flags;
+
 		if (token) {
 			await tryToLogin(token);
 			return;

src/commands/logout.ts

@@ -1,8 +1,8 @@
 import { ApifyCommand } from '../lib/command-framework/apify-command.js';
 import { AUTH_FILE_PATH } from '../lib/consts.js';
 import { rimrafPromised } from '../lib/files.js';
+import { updateUserId } from '../lib/hooks/telemetry/useTelemetryState.js';
 import { success } from '../lib/outputs.js';
-import { regenerateLocalDistinctId } from '../lib/telemetry.js';
 
 export class LogoutCommand extends ApifyCommand<typeof LogoutCommand> {
 	static override name = 'logout' as const;
@@ -13,7 +13,9 @@ export class LogoutCommand extends ApifyCommand<typeof LogoutCommand> {
 
 	async run() {
 		await rimrafPromised(AUTH_FILE_PATH());
-		regenerateLocalDistinctId();
+
+		await updateUserId(null);
+
 		success({ message: 'You are logged out from your Apify account.' });
 	}
 }

src/commands/telemetry/_index.ts

@@ -0,0 +1,16 @@
+import { ApifyCommand } from '../../lib/command-framework/apify-command.js';
+import { TelemetryDisableCommand } from './disable.js';
+import { TelemetryEnableCommand } from './enable.js';
+
+export class TelemetryIndexCommand extends ApifyCommand<typeof TelemetryIndexCommand> {
+	static override name = 'telemetry' as const;
+
+	static override description =
+		'Manages telemetry settings. We use this data to improve the CLI and the Apify platform.\nRead more: https://docs.apify.com/cli/docs/telemetry';
+
+	static override subcommands = [TelemetryEnableCommand, TelemetryDisableCommand];
+
+	async run() {
+		this.printHelp();
+	}
+}

src/commands/telemetry/disable.ts

@@ -0,0 +1,21 @@
+import { ApifyCommand } from '../../lib/command-framework/apify-command.js';
+import { updateTelemetryEnabled, useTelemetryState } from '../../lib/hooks/telemetry/useTelemetryState.js';
+import { info, success } from '../../lib/outputs.js';
+
+export class TelemetryDisableCommand extends ApifyCommand<typeof TelemetryDisableCommand> {
+	static override name = 'disable' as const;
+
+	static override description = 'Disables telemetry.';
+
+	async run() {
+		const currentState = await useTelemetryState();
+
+		if (currentState.enabled) {
+			await updateTelemetryEnabled(false);
+
+			success({ message: 'Telemetry disabled.' });
+		} else {
+			info({ message: 'Telemetry is already disabled.' });
+		}
+	}
+}

src/commands/telemetry/enable.ts

@@ -0,0 +1,21 @@
+import { ApifyCommand } from '../../lib/command-framework/apify-command.js';
+import { updateTelemetryEnabled, useTelemetryState } from '../../lib/hooks/telemetry/useTelemetryState.js';
+import { info, success } from '../../lib/outputs.js';
+
+export class TelemetryEnableCommand extends ApifyCommand<typeof TelemetryEnableCommand> {
+	static override name = 'enable' as const;
+
+	static override description = 'Enables telemetry.';
+
+	async run() {
+		const currentState = await useTelemetryState();
+
+		if (currentState.enabled) {
+			info({ message: 'Telemetry is already enabled.' });
+		} else {
+			await updateTelemetryEnabled(true);
+
+			success({ message: 'Telemetry enabled.' });
+		}
+	}
+}

src/entrypoints/_shared.ts

@@ -190,7 +190,10 @@ export async function runCLI(entrypoint: string) {
 	cliDebugPrint('RebuiltArgs', rebuiltArgs);
 	cliDebugPrint('CommandToRun', FinalCommand);
 
-	const instance = new FinalCommand(entrypoint);
+	const instance = new FinalCommand(
+		entrypoint,
+		hasSubcommand ? `${baseCommand.name} ${maybeSubcommandName}` : baseCommand.name,
+	);
 
 	// eslint-disable-next-line dot-notation
 	const parserOptions = instance['_buildParseArgsOption']();