@redocly/cli 1.29.0 → 1.31.0

package/src/otel.ts

@@ -0,0 +1,59 @@
+import { trace } from '@opentelemetry/api';
+import { Resource as OtelResource } from '@opentelemetry/resources';
+import { NodeTracerProvider, SimpleSpanProcessor } from '@opentelemetry/sdk-trace-node';
+import { OTLPTraceExporter } from '@opentelemetry/exporter-trace-otlp-http';
+import { ATTR_SERVICE_NAME, ATTR_SERVICE_VERSION } from '@opentelemetry/semantic-conventions';
+import { version } from './utils/update-version-notifier';
+import { DEFAULT_FETCH_TIMEOUT } from './utils/fetch-with-timeout';
+
+import type { Analytics } from './utils/miscellaneous';
+
+type Events = {
+  [key: string]: Analytics;
+};
+
+const OTEL_TRACES_URL = process.env.OTEL_TRACES_URL || 'https://otel.cloud.redocly.com/v1/traces';
+
+export class OtelServerTelemetry {
+  init() {
+    const nodeTracerProvider = new NodeTracerProvider({
+      resource: new OtelResource({
+        [ATTR_SERVICE_NAME]: `redocly-cli`,
+        [ATTR_SERVICE_VERSION]: `@redocly/cli@${version}`,
+      }),
+    });
+
+    nodeTracerProvider.addSpanProcessor(
+      new SimpleSpanProcessor(
+        new OTLPTraceExporter({
+          url: OTEL_TRACES_URL,
+          headers: {},
+          timeoutMillis: DEFAULT_FETCH_TIMEOUT,
+        })
+      )
+    );
+
+    nodeTracerProvider.register();
+  }
+
+  send<K extends keyof Events>(event: K, data: Events[K]): void {
+    const time = new Date();
+    const eventId = crypto.randomUUID();
+    const span = trace.getTracer('CliTelemetry').startSpan(`event.${event}`, {
+      attributes: {
+        'cloudevents.event_client.id': eventId,
+        'cloudevents.event_client.type': event,
+      },
+      startTime: time,
+    });
+    for (const [key, value] of Object.entries(data)) {
+      const keySnakeCase = key.replace(/([A-Z])/g, '_$1').toLowerCase();
+      if (value !== undefined) {
+        span.setAttribute(`cloudevents.event_data.${keySnakeCase}`, value);
+      }
+    }
+    span.end(time);
+  }
+}
+
+export const otelTelemetry = new OtelServerTelemetry();

package/src/reunite/api/__tests__/domains.test.ts

@@ -0,0 +1,41 @@
+import { getDomain } from '../domains';
+import { getReuniteUrl } from '../domains';
+
+import type { Region } from '@redocly/openapi-core';
+
+describe('getDomain()', () => {
+  afterEach(() => {
+    delete process.env.REDOCLY_DOMAIN;
+  });
+
+  it('should return the domain from environment variable', () => {
+    process.env.REDOCLY_DOMAIN = 'test-domain';
+
+    expect(getDomain()).toBe('test-domain');
+  });
+
+  it('should return the default domain if no domain provided', () => {
+    process.env.REDOCLY_DOMAIN = '';
+
+    expect(getDomain()).toBe('https://app.cloud.redocly.com');
+  });
+});
+
+describe('getReuniteUrl()', () => {
+  it('should return US API URL when US region specified', () => {
+    expect(getReuniteUrl('us')).toBe('https://app.cloud.redocly.com/api');
+  });
+
+  it('should return EU API URL when EU region specified', () => {
+    expect(getReuniteUrl('eu')).toBe('https://app.cloud.eu.redocly.com/api');
+  });
+
+  it('should return custom domain API URL when custom domain specified', () => {
+    const customDomain = 'https://custom.domain.com';
+    expect(getReuniteUrl(customDomain as Region)).toBe('https://custom.domain.com/api');
+  });
+
+  it('should return US API URL when no region specified', () => {
+    expect(getReuniteUrl()).toBe('https://app.cloud.redocly.com/api');
+  });
+});

package/src/{cms → reunite}/api/api-client.ts

@@ -26,7 +26,7 @@ export class ReuniteApiError extends Error {
   }
 }
 
-class ReuniteApiClient implements BaseApiClient {
+export class ReuniteApiClient implements BaseApiClient {
   public sunsetWarnings: SunsetWarningsBuffer = [];
 
   constructor(protected version: string, protected command: string) {}

package/src/reunite/api/domains.ts

@@ -0,0 +1,23 @@
+import type { Region } from '@redocly/openapi-core';
+
+export const REUNITE_URLS: Record<Region, string> = {
+  us: 'https://app.cloud.redocly.com',
+  eu: 'https://app.cloud.eu.redocly.com',
+} as const;
+
+export function getDomain(): string {
+  return process.env.REDOCLY_DOMAIN || REUNITE_URLS.us;
+}
+
+export function getReuniteUrl(residency?: string) {
+  if (!residency) residency = 'us';
+
+  let reuniteUrl: string = REUNITE_URLS[residency as Region];
+
+  if (!reuniteUrl) {
+    reuniteUrl = residency;
+  }
+
+  const url = new URL('/api', reuniteUrl).toString();
+  return url;
+}

package/src/types.ts

@@ -1,16 +1,17 @@
 import type { BundleOutputFormat, Region, Config, RuleSeverity } from '@redocly/openapi-core';
+import type { RespectOptions, GenerateArazzoFileOptions } from '@redocly/respect-core';
 import type { ArgumentsCamelCase } from 'yargs';
 import type { LintOptions } from './commands/lint';
 import type { BundleOptions } from './commands/bundle';
 import type { JoinOptions } from './commands/join';
-import type { LoginOptions } from './commands/login';
+import type { LoginOptions, LogoutOptions } from './commands/auth';
 import type { PushOptions } from './commands/push';
 import type { StatsOptions } from './commands/stats';
 import type { SplitOptions } from './commands/split';
 import type { PreviewDocsOptions } from './commands/preview-docs';
 import type { BuildDocsArgv } from './commands/build-docs/types';
-import type { PushOptions as CMSPushOptions } from './cms/commands/push';
-import type { PushStatusOptions } from './cms/commands/push-status';
+import type { PushOptions as CMSPushOptions } from './reunite/commands/push';
+import type { PushStatusOptions } from './reunite/commands/push-status';
 import type { PreviewProjectOptions } from './commands/preview-project/types';
 import type { TranslationsOptions } from './commands/translations';
 import type { EjectOptions } from './commands/eject';
@@ -37,12 +38,15 @@ export type CommandOptions =
   | LintOptions
   | BundleOptions
   | LoginOptions
+  | LogoutOptions
   | PreviewDocsOptions
   | BuildDocsArgv
   | PushStatusOptions
   | PreviewProjectOptions
   | TranslationsOptions
-  | EjectOptions;
+  | EjectOptions
+  | RespectOptions
+  | GenerateArazzoFileOptions;
 
 export type VerifyConfigOptions = {
   config?: string;

package/src/utils/miscellaneous.ts

@@ -3,6 +3,7 @@ import { blue, gray, green, red, yellow } from 'colorette';
 import { performance } from 'perf_hooks';
 import * as glob from 'glob';
 import * as fs from 'fs';
+import * as os from 'os';
 import * as readline from 'readline';
 import { Writable } from 'stream';
 import { execSync } from 'child_process';
@@ -28,7 +29,7 @@ import { deprecatedRefDocsSchema } from '@redocly/config/lib/reference-docs-conf
 import { outputExtensions } from '../types';
 import { version } from './update-version-notifier';
 import { DESTINATION_REGEX } from '../commands/push';
-import fetch, { DEFAULT_FETCH_TIMEOUT } from './fetch-with-timeout';
+import { getReuniteUrl } from '../reunite/api';
 
 import type { Arguments } from 'yargs';
 import type {
@@ -565,33 +566,32 @@ export async function sendTelemetry(
     } = argv;
     const event_time = new Date().toISOString();
     const redoclyClient = new RedoclyClient();
-    const logged_in = redoclyClient.hasTokens();
+    const { RedoclyOAuthClient } = await import('../auth/oauth-client');
+    const oauthClient = new RedoclyOAuthClient('redocly-cli', version);
+    const reuniteUrl = getReuniteUrl(argv.residency as string | undefined);
+    const logged_in = redoclyClient.hasTokens() || (await oauthClient.isAuthorized(reuniteUrl));
     const data: Analytics = {
       event: 'cli_command',
       event_time,
-      logged_in,
-      command,
-      arguments: cleanArgs(args),
+      logged_in: logged_in ? 'yes' : 'no',
+      command: `${command}`,
+      arguments: JSON.stringify(cleanArgs(args)),
       node_version: process.version,
       npm_version: execSync('npm -v').toString().replace('\n', ''),
+      os_platform: os.platform(),
       version,
       exit_code,
       environment: process.env.REDOCLY_ENVIRONMENT,
       environment_ci: process.env.CI,
       raw_input: cleanRawInput(process.argv.slice(2)),
-      has_config,
+      has_config: has_config ? 'yes' : 'no',
       spec_version,
       spec_keyword,
       spec_full_version,
     };
-    await fetch(`https://api.redocly.com/registry/telemetry/cli`, {
-      timeout: DEFAULT_FETCH_TIMEOUT,
-      method: 'POST',
-      headers: {
-        'content-type': 'application/json',
-      },
-      body: JSON.stringify(data),
-    });
+    const { otelTelemetry } = await import('../otel');
+    otelTelemetry.init();
+    otelTelemetry.send(data.command, data);
   } catch (err) {
     // Do nothing.
   }
@@ -602,17 +602,18 @@ export type ExitCode = 0 | 1 | 2;
 export type Analytics = {
   event: string;
   event_time: string;
-  logged_in: boolean;
-  command: string | number;
-  arguments: Record<string, unknown>;
+  logged_in: 'yes' | 'no';
+  command: string;
+  arguments: string;
   node_version: string;
   npm_version: string;
+  os_platform: string;
   version: string;
   exit_code: ExitCode;
   environment?: string;
   environment_ci?: string;
   raw_input: string;
-  has_config?: boolean;
+  has_config?: 'yes' | 'no';
   spec_version?: string;
   spec_keyword?: string;
   spec_full_version?: string;

package/tsconfig.json

@@ -4,6 +4,6 @@
     "rootDir": "src",
     "outDir": "lib"
   },
-  "references": [{ "path": "../core" }],
+  "references": [{ "path": "../core" }, { "path": "../respect-core" }],
   "exclude": ["lib"]
 }