@workos/oagen-emitters 0.0.1

package/smoke/sdk-ruby.ts

@@ -0,0 +1,723 @@
+/**
+ * Ruby SDK smoke test -- captures wire-level HTTP exchanges from the generated
+ * WorkOS Ruby SDK via a local proxy and outputs SmokeResults JSON for diff comparison.
+ *
+ * Uses a batched approach: generates ONE Ruby script that calls ALL operations
+ * sequentially, eliminating per-operation cold start overhead.
+ *
+ * Usage:
+ *   npx tsx smoke/sdk-ruby.ts --spec ../openapi-spec/spec/open-api-spec.yaml --sdk-path ./sdk-ruby
+ *
+ * Requires API_KEY or WORKOS_API_KEY env var.
+ * Requires `ruby` to be available on $PATH.
+ */
+
+import { readFileSync, writeFileSync, existsSync, mkdtempSync } from 'node:fs';
+import { resolve, join } from 'node:path';
+import { createServer, type IncomingMessage, type ServerResponse } from 'node:http';
+import { request as httpsRequest } from 'node:https';
+import { execFileSync, spawn } from 'node:child_process';
+import { tmpdir } from 'node:os';
+import {
+  parseSpec,
+  planOperations,
+  planWaves,
+  generatePayload,
+  generateQueryParams,
+  IdRegistry,
+  delay,
+  parseCliArgs,
+  loadSmokeConfig,
+  getExpectedStatusCodes,
+  isUnexpectedStatus,
+  toSnakeCase,
+  SERVICE_PROPERTY_MAP,
+} from '@workos/oagen/smoke';
+import type { CapturedExchange, SmokeResults, ExchangeProvenance, OperationWave } from '@workos/oagen/smoke';
+import type { Operation } from '@workos/oagen';
+
+// ---------------------------------------------------------------------------
+// Types
+// ---------------------------------------------------------------------------
+
+interface ManifestEntry {
+  sdkMethod: string;
+  service: string;
+}
+
+interface CapturedRequest {
+  method: string;
+  path: string;
+  queryParams: Record<string, string>;
+  body: unknown | null;
+}
+
+interface CapturedResponse {
+  status: number;
+  body: unknown | null;
+}
+
+interface ProxyCapture {
+  request: CapturedRequest;
+  response: CapturedResponse;
+}
+
+// ---------------------------------------------------------------------------
+// Method resolution
+// ---------------------------------------------------------------------------
+
+interface MethodResolution {
+  service: string;
+  method: string;
+  tier: ExchangeProvenance['resolutionTier'];
+  confidence: number;
+}
+
+// ---------------------------------------------------------------------------
+// Manifest loading
+// ---------------------------------------------------------------------------
+
+function loadManifest(sdkPath: string): Map<string, ManifestEntry> | null {
+  const manifestPath = resolve(sdkPath, 'smoke-manifest.json');
+  if (!existsSync(manifestPath)) {
+    console.warn(`Warning: No smoke-manifest.json found at ${manifestPath}`);
+    console.warn('  Method resolution will rely on heuristic tiers -- most operations may be skipped.');
+    return null;
+  }
+  const raw = JSON.parse(readFileSync(manifestPath, 'utf-8'));
+  const manifest = new Map<string, ManifestEntry>();
+  for (const [httpKey, entry] of Object.entries(raw)) {
+    manifest.set(httpKey, entry as ManifestEntry);
+  }
+  return manifest;
+}
+
+// ---------------------------------------------------------------------------
+// Method resolution
+// ---------------------------------------------------------------------------
+
+function resolveMethod(
+  op: Operation,
+  irService: string,
+  manifest: Map<string, ManifestEntry> | null,
+): MethodResolution | null {
+  const httpKey = `${op.httpMethod.toUpperCase()} ${op.path}`;
+
+  // Tier 0: Manifest match (primary for generated SDKs)
+  if (manifest) {
+    const entry = manifest.get(httpKey);
+    if (entry) {
+      return {
+        service: entry.service,
+        method: entry.sdkMethod,
+        tier: 'manifest',
+        confidence: 1.0,
+      };
+    }
+  }
+
+  // Tier 1: Exact match -- IR operation name in snake_case
+  const sdkProp = SERVICE_PROPERTY_MAP[irService] || toSnakeCase(irService);
+  const exactName = toSnakeCase(op.name);
+  return {
+    service: sdkProp,
+    method: exactName,
+    tier: 'exact',
+    confidence: 0.8,
+  };
+}
+
+// ---------------------------------------------------------------------------
+// Proxy server
+// ---------------------------------------------------------------------------
+
+function startProxy(
+  apiHost: string,
+  apiKey: string,
+  captures: ProxyCapture[],
+): Promise<{ port: number; close: () => Promise<void> }> {
+  return new Promise((resolvePromise) => {
+    const server = createServer((req: IncomingMessage, res: ServerResponse) => {
+      const chunks: Buffer[] = [];
+
+      req.on('data', (chunk: Buffer) => chunks.push(chunk));
+      req.on('end', () => {
+        const rawBody = Buffer.concat(chunks).toString('utf-8');
+        const url = new URL(req.url || '/', `http://localhost`);
+        const method = (req.method || 'GET').toUpperCase();
+        const path = url.pathname;
+        const queryParams: Record<string, string> = {};
+        url.searchParams.forEach((v, k) => {
+          queryParams[k] = v;
+        });
+
+        let reqBody: unknown = null;
+        if (rawBody) {
+          try {
+            reqBody = JSON.parse(rawBody);
+          } catch {
+            reqBody = rawBody;
+          }
+        }
+
+        const capturedReq: CapturedRequest = { method, path, queryParams, body: reqBody };
+
+        // Forward to real API
+        const forwardHeaders: Record<string, string> = {
+          authorization: `Bearer ${apiKey}`,
+          'content-type': req.headers['content-type'] || 'application/json',
+          'user-agent': req.headers['user-agent'] || 'workos-ruby-smoke',
+        };
+
+        if (rawBody) {
+          forwardHeaders['content-length'] = Buffer.byteLength(rawBody).toString();
+        }
+
+        const forwardReq = httpsRequest(
+          {
+            hostname: apiHost,
+            port: 443,
+            path: req.url,
+            method,
+            headers: forwardHeaders,
+          },
+          (forwardRes) => {
+            const respChunks: Buffer[] = [];
+            forwardRes.on('data', (chunk: Buffer) => respChunks.push(chunk));
+            forwardRes.on('end', () => {
+              const respRaw = Buffer.concat(respChunks).toString('utf-8');
+              const status = forwardRes.statusCode || 500;
+
+              let respBody: unknown = null;
+              if (respRaw) {
+                try {
+                  respBody = JSON.parse(respRaw);
+                } catch {
+                  respBody = respRaw;
+                }
+              }
+
+              captures.push({
+                request: capturedReq,
+                response: { status, body: respBody },
+              });
+
+              // Send response back to Ruby SDK
+              res.writeHead(status, {
+                'content-type': forwardRes.headers['content-type'] || 'application/json',
+              });
+              res.end(respRaw);
+            });
+          },
+        );
+
+        forwardReq.on('error', (err) => {
+          console.error(`Proxy forward error: ${err.message}`);
+          captures.push({
+            request: capturedReq,
+            response: { status: 502, body: { error: err.message } },
+          });
+          res.writeHead(502, { 'content-type': 'application/json' });
+          res.end(JSON.stringify({ error: err.message }));
+        });
+
+        if (rawBody) {
+          forwardReq.write(rawBody);
+        }
+        forwardReq.end();
+      });
+    });
+
+    // Listen on a random port
+    server.listen(0, '127.0.0.1', () => {
+      const addr = server.address();
+      const port = typeof addr === 'object' && addr ? addr.port : 0;
+      resolvePromise({
+        port,
+        close: () =>
+          new Promise<void>((r) => {
+            server.close(() => r());
+          }),
+      });
+    });
+  });
+}
+
+// ---------------------------------------------------------------------------
+// Ruby literal helper
+// ---------------------------------------------------------------------------
+
+/** Convert a JS value to a Ruby literal string */
+function rubyLiteral(value: unknown): string {
+  if (value === null || value === undefined) return 'nil';
+  if (typeof value === 'string') return `"${value.replace(/\\/g, '\\\\').replace(/"/g, '\\"')}"`;
+  if (typeof value === 'number') return String(value);
+  if (typeof value === 'boolean') return value ? 'true' : 'false';
+  if (Array.isArray(value)) {
+    return `[${value.map((v) => rubyLiteral(v)).join(', ')}]`;
+  }
+  if (typeof value === 'object') {
+    const entries = Object.entries(value as Record<string, unknown>);
+    const pairs = entries.map(([k, v]) => `${k}: ${rubyLiteral(v)}`);
+    return `{ ${pairs.join(', ')} }`;
+  }
+  return String(value);
+}
+
+// ---------------------------------------------------------------------------
+// Batched Ruby script generation
+// ---------------------------------------------------------------------------
+
+interface PlannedCall {
+  index: number;
+  op: Operation;
+  irService: string;
+  resolution: MethodResolution;
+  pathParams: Record<string, string>;
+}
+
+/**
+ * Build a single Ruby script that calls ALL planned operations sequentially.
+ * Each call is wrapped with JSONL markers on $stderr for correlation.
+ */
+function buildBatchedRubyScript(sdkPath: string, proxyPort: number, calls: PlannedCall[], spec: any): string {
+  const lines: string[] = [];
+
+  // Preamble -- loaded once
+  lines.push(`$LOAD_PATH.unshift(File.join("${sdkPath}", "lib"))`);
+  lines.push(`require "workos"`);
+  lines.push(`require "json"`);
+  lines.push('');
+  lines.push(`client = Workos::Client.new(`);
+  lines.push(`  api_key: ENV["WORKOS_API_KEY"],`);
+  lines.push(`  base_url: "http://127.0.0.1:${proxyPort}"`);
+  lines.push(`)`);
+  lines.push('');
+
+  for (const call of calls) {
+    const { index, op, resolution, pathParams } = call;
+
+    // Marker: start
+    lines.push(`$stderr.puts "OAGEN_CALL_START:${index}"`);
+    lines.push(`$stderr.flush`);
+
+    // Build method call arguments
+    const argParts: string[] = [];
+
+    for (const p of op.pathParams) {
+      const value = pathParams[p.name];
+      argParts.push(rubyLiteral(value));
+    }
+
+    if (op.requestBody) {
+      const payload = generatePayload(op, spec);
+      if (payload) {
+        argParts.push(rubyLiteral(payload));
+      }
+    }
+
+    if (!op.requestBody && op.queryParams.some((p) => p.required)) {
+      const queryOpts = generateQueryParams(op, spec);
+      if (Object.keys(queryOpts).length > 0) {
+        argParts.push(rubyLiteral(queryOpts));
+      }
+    }
+
+    if (op.pagination) {
+      argParts.push(`{ limit: 1 }`);
+    }
+
+    lines.push('begin');
+    lines.push(`  result = client.${resolution.service}.${resolution.method}(${argParts.join(', ')})`);
+    lines.push(`  $stderr.puts "OAGEN_CALL_OK:${index}"`);
+    lines.push('rescue => e');
+    lines.push(`  $stderr.puts "OAGEN_CALL_ERROR:${index}:#{e.class}: #{e.message}"`);
+    lines.push('end');
+
+    // Marker: end
+    lines.push(`$stderr.puts "OAGEN_CALL_END:${index}"`);
+    lines.push(`$stderr.flush`);
+
+    // Small sleep to let proxy settle
+    lines.push('sleep 0.05');
+    lines.push('');
+  }
+
+  return lines.join('\n');
+}
+
+// ---------------------------------------------------------------------------
+// Main
+// ---------------------------------------------------------------------------
+
+async function main(): Promise<void> {
+  const { spec: specPath, sdkPath, smokeConfig } = parseCliArgs();
+
+  if (!sdkPath) {
+    console.error('--sdk-path is required');
+    process.exit(1);
+  }
+
+  const apiKey = process.env.WORKOS_API_KEY || process.env.API_KEY;
+  if (!apiKey) {
+    console.error('API key required. Set WORKOS_API_KEY or API_KEY env var.');
+    process.exit(1);
+  }
+
+  // Verify ruby is available
+  try {
+    execFileSync('ruby', ['--version'], { stdio: 'pipe' });
+  } catch {
+    console.error('Ruby is required but not found on $PATH.');
+    process.exit(1);
+  }
+
+  // Load config
+  loadSmokeConfig(smokeConfig);
+
+  // Parse spec
+  console.log('Parsing spec...');
+  const spec = await parseSpec(specPath);
+  console.log(`Spec: ${spec.name} v${spec.version}`);
+
+  // Load manifest
+  const manifest = loadManifest(sdkPath);
+
+  const baseUrl = process.env.WORKOS_BASE_URL || spec.baseUrl;
+  const apiHost = new URL(baseUrl).hostname;
+
+  // Start proxy
+  const captures: ProxyCapture[] = [];
+  const proxy = await startProxy(apiHost, apiKey, captures);
+  console.log(`Proxy listening on 127.0.0.1:${proxy.port}`);
+
+  // Plan operations
+  const groups = planOperations(spec);
+  const ids = new IdRegistry();
+  const exchanges: CapturedExchange[] = [];
+  const tmpDir = mkdtempSync(join(tmpdir(), 'oagen-ruby-smoke-'));
+
+  let successCount = 0;
+  let errorCount = 0;
+  let skipCount = 0;
+  let unexpectedCount = 0;
+
+  // Use wave-based planning: execute parameterless ops first, extract IDs,
+  // then plan the next wave of ops whose path params are now resolvable.
+  let globalCallIndex = 0;
+
+  const waveIterator = planWaves(groups, ids, (op, irService) => {
+    const resolution = resolveMethod(op, irService, manifest);
+    return resolution !== null;
+  });
+
+  let waveNumber = 0;
+  let waveResult = waveIterator.next();
+
+  while (!waveResult.done) {
+    const wave: OperationWave = waveResult.value;
+    waveNumber++;
+
+    // Build planned calls for this wave, resolving methods
+    const plannedCalls: PlannedCall[] = [];
+    const waveSkipped: Array<{ op: Operation; irService: string; reason: string }> = [];
+
+    for (const { op, irService, pathParams } of wave.calls) {
+      const resolution = resolveMethod(op, irService, manifest);
+      if (!resolution) {
+        waveSkipped.push({ op, irService, reason: 'No matching SDK method' });
+        continue;
+      }
+      plannedCalls.push({
+        index: globalCallIndex++,
+        op,
+        irService,
+        resolution,
+        pathParams,
+      });
+    }
+
+    // Record skipped exchanges for this wave
+    for (const skip of waveSkipped) {
+      exchanges.push(makeSkippedExchange(skip.op, skip.irService, skip.reason));
+      skipCount++;
+    }
+
+    if (plannedCalls.length === 0) {
+      waveResult = waveIterator.next();
+      continue;
+    }
+
+    console.log(`\n=== Wave ${waveNumber} (${plannedCalls.length} operations) ===`);
+
+    // Generate batched Ruby script for this wave
+    const rubyScript = buildBatchedRubyScript(resolve(sdkPath), proxy.port, plannedCalls, spec);
+
+    const scriptPath = join(tmpDir, `smoke_wave_${waveNumber}.rb`);
+    writeFileSync(scriptPath, rubyScript);
+
+    // Execute the batched script
+    const callResults = new Map<
+      number,
+      {
+        captureIndexBefore: number;
+        captureIndexAfter: number;
+        error?: string;
+        startTime: number;
+        endTime: number;
+      }
+    >();
+
+    let currentCallIndex = -1;
+    let currentCallStart = Date.now();
+    let currentCapturesBefore = 0;
+
+    try {
+      await new Promise<void>((resolvePromise, rejectPromise) => {
+        const child = spawn('ruby', [scriptPath], {
+          env: {
+            ...process.env,
+            WORKOS_API_KEY: apiKey,
+            WORKOS_BASE_URL: `http://127.0.0.1:${proxy.port}`,
+          },
+          stdio: ['pipe', 'pipe', 'pipe'],
+        });
+
+        const timeout = setTimeout(() => {
+          child.kill('SIGKILL');
+          rejectPromise(new Error('Batch Ruby script timed out after 300s'));
+        }, 300_000);
+
+        let stderrBuf = '';
+
+        child.stderr.on('data', (data: Buffer) => {
+          stderrBuf += data.toString();
+          const lines = stderrBuf.split('\n');
+          stderrBuf = lines.pop() || '';
+
+          for (const line of lines) {
+            const trimmed = line.trim();
+            if (trimmed.startsWith('OAGEN_CALL_START:')) {
+              const idx = parseInt(trimmed.slice('OAGEN_CALL_START:'.length), 10);
+              currentCallIndex = idx;
+              currentCallStart = Date.now();
+              currentCapturesBefore = captures.length;
+            } else if (trimmed.startsWith('OAGEN_CALL_OK:')) {
+              const idx = parseInt(trimmed.slice('OAGEN_CALL_OK:'.length), 10);
+              if (callResults.has(idx)) continue;
+              callResults.set(idx, {
+                captureIndexBefore: currentCapturesBefore,
+                captureIndexAfter: captures.length,
+                startTime: currentCallStart,
+                endTime: Date.now(),
+              });
+            } else if (trimmed.startsWith('OAGEN_CALL_ERROR:')) {
+              const rest = trimmed.slice('OAGEN_CALL_ERROR:'.length);
+              const colonIdx = rest.indexOf(':');
+              const idx = parseInt(rest.slice(0, colonIdx), 10);
+              const errMsg = rest.slice(colonIdx + 1);
+              if (callResults.has(idx)) continue;
+              callResults.set(idx, {
+                captureIndexBefore: currentCapturesBefore,
+                captureIndexAfter: captures.length,
+                error: errMsg,
+                startTime: currentCallStart,
+                endTime: Date.now(),
+              });
+            } else if (trimmed.startsWith('OAGEN_CALL_END:')) {
+              const idx = parseInt(trimmed.slice('OAGEN_CALL_END:'.length), 10);
+              const existing = callResults.get(idx);
+              if (existing) {
+                existing.captureIndexAfter = captures.length;
+                existing.endTime = Date.now();
+              }
+            }
+          }
+        });
+
+        child.on('close', () => {
+          clearTimeout(timeout);
+          if (stderrBuf.trim()) {
+            const trimmed = stderrBuf.trim();
+            if (trimmed.startsWith('OAGEN_CALL_END:') && currentCallIndex >= 0) {
+              const existing = callResults.get(currentCallIndex);
+              if (existing) {
+                existing.captureIndexAfter = captures.length;
+                existing.endTime = Date.now();
+              }
+            }
+          }
+          resolvePromise();
+        });
+
+        child.on('error', (err) => {
+          clearTimeout(timeout);
+          rejectPromise(err);
+        });
+      });
+    } catch (err) {
+      const message = err instanceof Error ? err.message : String(err);
+      console.error(`Batch execution error: ${message}`);
+    }
+
+    await delay(200);
+
+    // Process results for this wave — extract IDs so the next wave can use them
+    for (const call of plannedCalls) {
+      const { index, op, irService, resolution } = call;
+      const isTopLevel = op.pathParams.length === 0;
+      const result = callResults.get(index);
+
+      if (!result) {
+        exchanges.push({
+          ...makeSkippedExchange(op, irService, 'Call did not execute (batch script may have failed)'),
+          outcome: 'api-error',
+          durationMs: 0,
+        });
+        errorCount++;
+        console.log(`  x ${op.name} -- did not execute`);
+        continue;
+      }
+
+      const elapsed = result.endTime - result.startTime;
+
+      if (result.captureIndexAfter <= result.captureIndexBefore) {
+        if (result.error) {
+          exchanges.push({
+            ...makeSkippedExchange(op, irService, result.error),
+            outcome: 'api-error',
+            durationMs: elapsed,
+          });
+          errorCount++;
+          console.log(`  x ${op.name} -- ${result.error.split('\n')[0]}`);
+        } else {
+          exchanges.push(makeSkippedExchange(op, irService, 'No HTTP capture'));
+          skipCount++;
+          console.log(`  SKIP ${op.name} -- no HTTP capture`);
+        }
+        continue;
+      }
+
+      const capture = captures[result.captureIndexAfter - 1];
+      const exchange = buildExchange(op, irService, capture, elapsed, resolution);
+
+      if (result.error) {
+        exchange.error = result.error;
+      }
+
+      // Extract IDs from response (critical: feeds the next wave)
+      ids.extractAndStore(irService, capture.response.body, isTopLevel);
+
+      if (exchange.unexpectedStatus) {
+        unexpectedCount++;
+        console.log(`  ! ${op.name} -> ${capture.response.status} (unexpected)`);
+      } else if (exchange.outcome === 'api-error') {
+        errorCount++;
+        console.log(`  x ${op.name} -> ${capture.response.status}`);
+      } else {
+        successCount++;
+        console.log(`  ok ${op.name} -> ${capture.response.status} (${elapsed}ms)`);
+      }
+
+      exchanges.push(exchange);
+    }
+
+    // Advance to the next wave (IDs from this wave are now in the registry)
+    waveResult = waveIterator.next();
+  }
+
+  // Record any operations that could never be resolved
+  if (waveResult.done && waveResult.value) {
+    for (const unresolved of waveResult.value) {
+      exchanges.push(makeSkippedExchange(unresolved.operation, unresolved.service, 'Missing path param IDs'));
+      skipCount++;
+    }
+  }
+
+  await proxy.close();
+  console.log('Proxy stopped.');
+
+  // Clean up temp directory
+  try {
+    const { rmSync } = await import('node:fs');
+    rmSync(tmpDir, { recursive: true, force: true });
+  } catch {
+    // Ignore cleanup errors
+  }
+
+  // Write results
+  const results: SmokeResults = {
+    source: 'sdk-ruby',
+    timestamp: new Date().toISOString(),
+    specVersion: spec.version,
+    exchanges,
+  };
+
+  const outputPath = `smoke-results-sdk-ruby.json`;
+  writeFileSync(outputPath, JSON.stringify(results, null, 2));
+  console.log(`\nResults written to ${outputPath}`);
+
+  // Summary
+  const total = exchanges.length;
+  console.log(`\n=== Summary ===`);
+  console.log(`  Total:      ${total}`);
+  console.log(`  Success:    ${successCount}`);
+  console.log(`  API errors: ${errorCount}`);
+  console.log(`  Skipped:    ${skipCount}`);
+  if (unexpectedCount > 0) {
+    console.log(`  Unexpected: ${unexpectedCount}`);
+  }
+}
+
+// ---------------------------------------------------------------------------
+// Helpers
+// ---------------------------------------------------------------------------
+
+function makeSkippedExchange(op: Operation, service: string, reason: string): CapturedExchange {
+  return {
+    operationId: op.name,
+    service,
+    operationName: op.name,
+    request: { method: op.httpMethod.toUpperCase(), path: op.path, queryParams: {}, body: null },
+    response: { status: 0, body: null },
+    outcome: 'skipped',
+    error: reason,
+    durationMs: 0,
+  };
+}
+
+function buildExchange(
+  op: Operation,
+  service: string,
+  capture: ProxyCapture,
+  durationMs: number,
+  resolution: MethodResolution,
+): CapturedExchange {
+  const status = capture.response.status;
+  const expectedCodes = getExpectedStatusCodes(op);
+  const unexpected = isUnexpectedStatus(status, op);
+
+  return {
+    operationId: op.name,
+    service,
+    operationName: op.name,
+    request: capture.request,
+    response: capture.response,
+    outcome: status >= 200 && status < 300 ? 'success' : 'api-error',
+    unexpectedStatus: unexpected || undefined,
+    expectedStatusCodes: expectedCodes,
+    durationMs,
+    provenance: {
+      resolutionTier: resolution.tier,
+      resolutionConfidence: resolution.confidence,
+      sdkMethodName: `${resolution.service}.${resolution.method}`,
+      captureIndex: 0,
+      totalCaptures: 1,
+    },
+  };
+}
+
+main().catch((err) => {
+  console.error('Fatal error:', err);
+  process.exit(1);
+});