@toloka-platform/sdk 0.1.0-preview.3 → 0.1.0-preview.5

package/src/cli/analytics.ts

@@ -1,3 +1,4 @@
+import { assert } from "es-toolkit";
 import { randomUUID } from "node:crypto";
 import { chmod, readFile, writeFile } from "node:fs/promises";
 import { dirname, join } from "node:path";
@@ -28,13 +29,22 @@ export type CliAnalyticsCapture = {
   readonly error?: unknown;
 };
 
+export type IssueReportSubmission = {
+  readonly reportId: string;
+  readonly reportText: string;
+  readonly authoredBy: "human" | "agent";
+  readonly platform: string;
+};
+
 export type CliAnalytics = {
   readonly shouldIdentify: boolean;
+  readonly issueReportingEnabled: boolean;
   readonly identifyCurrentUser: (user: {
     readonly id: string;
     readonly email: string | null;
   }) => void;
   readonly captureCommand: (event: CliAnalyticsCapture) => void;
+  readonly submitIssueReport: (report: IssueReportSubmission) => Promise<void>;
   readonly shutdown: () => Promise<void>;
 };
 
@@ -46,6 +56,8 @@ export type PosthogLike = {
     disableGeoip: boolean;
   }) => void;
   alias: (event: { distinctId: string; alias: string }) => void;
+  flush: () => Promise<void>;
+  on?: (event: "error", listener: (error: Error) => void) => void;
   shutdown: (shutdownTimeoutMs?: number) => Promise<void>;
 };
 
@@ -86,6 +98,7 @@ const COMMAND_GROUPS: Readonly<Record<string, Readonly<Record<string, true>>>> =
   },
   dataset: { list: true, fields: true, load: true, upload: true },
   secret: { set: true },
+  skill: { list: true, search: true, install: true },
 };
 
 const ROOT_COMMANDS: Readonly<Record<string, true>> = {
@@ -99,6 +112,8 @@ const ROOT_COMMANDS: Readonly<Record<string, true>> = {
   plan: true,
   status: true,
   validate: true,
+  report: true,
+  version: true,
   whoami: true,
 };
 
@@ -116,6 +131,7 @@ const nameFromTokens = (tokens: readonly string[]): string => {
 };
 
 export function commandNameFromArgv(argv: readonly string[]): string {
+  if (argv.includes("-v") || argv.includes("--version")) return "version";
   const tokens: string[] = [];
   for (let index = 0; index < argv.length; index += 1) {
     const token = argv[index];
@@ -161,8 +177,12 @@ const readAnonymousId = async (environment: CliEnvironment): Promise<string> =>
 
 const noopAnalytics = (): CliAnalytics => ({
   shouldIdentify: false,
+  issueReportingEnabled: false,
   identifyCurrentUser() {},
   captureCommand() {},
+  async submitIssueReport() {
+    assert(false, "Issue reporting is disabled. Re-run with TOLOKA_TELEMETRY=1.");
+  },
   async shutdown() {},
 });
 
@@ -177,6 +197,11 @@ export function createCliAnalytics(options: {
   let client = options.client;
   let distinctId = options.distinctId;
   let identifiedUserId: string | undefined;
+  const deliveryErrors: Error[] = [];
+  const captureDeliveryError = (error: Error) => {
+    deliveryErrors.push(error);
+  };
+  client?.on?.("error", captureDeliveryError);
 
   const ensure = async () => {
     if (client !== undefined && distinctId !== undefined) return;
@@ -186,7 +211,7 @@ export function createCliAnalytics(options: {
         flushAt: 1,
         flushInterval: 0,
       });
-      created.on("error", () => {});
+      created.on("error", captureDeliveryError);
       client = created;
     }
     distinctId ??= await readAnonymousId(environment);
@@ -202,6 +227,7 @@ export function createCliAnalytics(options: {
   let queue: Promise<void> = ensure().catch(() => {});
 
   return {
+    issueReportingEnabled: true,
     shouldIdentify: true,
     identifyCurrentUser(user) {
       queue = queue
@@ -252,6 +278,32 @@ export function createCliAnalytics(options: {
         })
         .catch(() => {});
     },
+    submitIssueReport(report) {
+      const submission = queue.then(async () => {
+        assert(client && distinctId, "PostHog issue reporting could not be initialized.");
+        deliveryErrors.length = 0;
+        client.capture({
+          distinctId,
+          event: "sdk_cli_issue_report_submitted",
+          disableGeoip: true,
+          properties: {
+            ...sharedProperties(),
+            report_id: report.reportId,
+            report_text: report.reportText,
+            report_length_bytes: new TextEncoder().encode(report.reportText).length,
+            authored_by: report.authoredBy,
+            platform: report.platform,
+            $process_person_profile: false,
+          },
+        });
+        await client.flush();
+        const reportError = deliveryErrors[0];
+        deliveryErrors.length = 0;
+        if (reportError !== undefined) throw reportError;
+      });
+      queue = submission.catch(() => {});
+      return submission;
+    },
     async shutdown() {
       try {
         await queue;

package/src/cli/auth.ts

@@ -74,12 +74,12 @@ export type LoginResult = {
 export async function login(options: LoginOptions = {}): Promise<LoginResult> {
   const environment = options.environment ?? process.env;
   const write = options.write ?? (() => undefined);
-  const baseUrl = (
+  const baseUrl = normalizeBaseUrl(
     options.baseUrl ??
-    environment.POTATO_BASE_URL ??
-    resolveInternalBaseUrl(environment) ??
-    PRODUCTION_BASE_URL
-  ).replace(/\/+$/u, "");
+      environment.POTATO_BASE_URL ??
+      resolveInternalBaseUrl(environment) ??
+      PRODUCTION_BASE_URL,
+  );
 
   let apiKey = options.apiKey;
   if (apiKey === undefined) {

package/src/cli/credentials.ts

@@ -52,13 +52,19 @@ export const credentialsPath = (environment: CliEnvironment = process.env): stri
 export const legacyCredentialsPath = (environment: CliEnvironment = process.env): string =>
   join(home(environment), ".toloka", "credentials.json");
 
+const removeTrailingSlashes = (value: string): string => {
+  let end = value.length;
+  while (end > 0 && value.charCodeAt(end - 1) === 47) end -= 1;
+  return end === value.length ? value : value.slice(0, end);
+};
+
 export const normalizeBaseUrl = (baseUrl: string): string => {
-  const trimmed = baseUrl.trim().replace(/\/+$/u, "");
+  const trimmed = removeTrailingSlashes(baseUrl.trim());
   try {
     const url = new URL(trimmed);
     url.hash = "";
     url.search = "";
-    return url.toString().replace(/\/+$/u, "");
+    return removeTrailingSlashes(url.toString());
   } catch {
     return trimmed;
   }

package/src/cli/file-system.ts

@@ -0,0 +1,34 @@
+import { assert } from "es-toolkit";
+import { lstat } from "node:fs/promises";
+import { join } from "node:path";
+
+export const hasErrorCode = (error: unknown, ...codes: readonly string[]) =>
+  error instanceof Error &&
+  "code" in error &&
+  typeof error.code === "string" &&
+  codes.includes(error.code);
+
+export const isMissingFileError = (error: unknown) => hasErrorCode(error, "ENOENT");
+
+export const entryStats = async (path: string) => {
+  try {
+    return await lstat(path);
+  } catch (error) {
+    if (isMissingFileError(error)) return undefined;
+    throw error;
+  }
+};
+
+export const assertSafeDestination = async (
+  targetDirectory: string,
+  relativePath: string,
+  action = "write",
+) => {
+  let currentPath = targetDirectory;
+  for (const segment of relativePath.split("/")) {
+    currentPath = join(currentPath, segment);
+    const entry = await entryStats(currentPath);
+    if (entry === undefined) return;
+    assert(!entry.isSymbolicLink(), `Refusing to ${action} through symbolic link ${currentPath}.`);
+  }
+};

package/src/cli/format-error.ts

@@ -0,0 +1,19 @@
+import { PotatoApiError } from "../errors";
+
+export const apiErrorDetails = (error: PotatoApiError): string | undefined => {
+  const details =
+    typeof error.body === "string"
+      ? error.body
+      : error.body === undefined
+        ? undefined
+        : JSON.stringify(error.body);
+  return details === undefined || details.length === 0 ? undefined : details;
+};
+
+export const formatCliError = (error: unknown): string => {
+  if (error instanceof PotatoApiError) {
+    const details = apiErrorDetails(error);
+    return details === undefined ? error.message : `${error.message}\n${details}`;
+  }
+  return error instanceof Error ? error.message : String(error);
+};