@algolia/wizard 0.98.0 → 0.99.0

package/dist/main.js

@@ -1581,28 +1581,38 @@ import { mkdir as mkdir2, readFile as readFile2, writeFile as writeFile2, rm } f
 import { join as join4 } from "node:path";
 var isStepVisible = (s) => s.visible !== false;
 var stateFile = (workflowId) => join4(stateDir(), `state-${workflowId}.json`);
+var pendingWrite = Promise.resolve();
 function runAppId(state) {
   const appId = state.algoliaState.appId;
   return typeof appId === "string" && appId ? appId : void 0;
 }
 async function loadWorkflowState(workflowId) {
+  const file = stateFile(workflowId);
+  await pendingWrite;
   try {
-    const raw = await readFile2(stateFile(workflowId), "utf8");
+    const raw = await readFile2(file, "utf8");
     return JSON.parse(raw);
   } catch {
     return null;
   }
 }
+function enqueueWrite(write) {
+  const next = pendingWrite.then(write, write);
+  pendingWrite = next.catch(() => void 0);
+  return next;
+}
 async function saveWorkflowState(state) {
-  await mkdir2(stateDir(), { recursive: true });
-  await writeFile2(
-    stateFile(state.workflowId),
-    JSON.stringify(state, null, 2),
-    "utf8"
-  );
+  const dir = stateDir();
+  const file = stateFile(state.workflowId);
+  const json = JSON.stringify(state, null, 2);
+  return enqueueWrite(async () => {
+    await mkdir2(dir, { recursive: true });
+    await writeFile2(file, json, "utf8");
+  });
 }
 async function clearWorkflowState(workflowId) {
-  await rm(stateFile(workflowId), { force: true });
+  const file = stateFile(workflowId);
+  return enqueueWrite(() => rm(file, { force: true }));
 }
 
 // src/lib/modelProfiles.ts
@@ -1701,10 +1711,45 @@ var COUNT_METRIC = 1;
 var GAUGE_METRIC = 3;
 var FIRST_ATTEMPT = 1;
 var NO_TOKENS2 = 0;
+var NO_COST = 0;
 var AGENT_TELEMETRY_CONTEXT = {
   appId: void 0,
-  workflowId: void 0
+  workflowId: void 0,
+  agentRunId: void 0,
+  sessionCostUsd: NO_COST
 };
+function resetTelemetryContext() {
+  AGENT_TELEMETRY_CONTEXT.appId = void 0;
+  AGENT_TELEMETRY_CONTEXT.workflowId = void 0;
+  AGENT_TELEMETRY_CONTEXT.agentRunId = void 0;
+  AGENT_TELEMETRY_CONTEXT.sessionCostUsd = NO_COST;
+}
+function sessionCostUsd(agentRunId) {
+  return agentRunId && agentRunId === AGENT_TELEMETRY_CONTEXT.agentRunId ? AGENT_TELEMETRY_CONTEXT.sessionCostUsd : void 0;
+}
+var sessionCostListeners = /* @__PURE__ */ new Set();
+function onSessionCost(listener) {
+  sessionCostListeners.add(listener);
+  return () => {
+    sessionCostListeners.delete(listener);
+  };
+}
+function sessionTags() {
+  const { agentRunId } = AGENT_TELEMETRY_CONTEXT;
+  return agentRunId ? [`agent_run_id:${agentRunId}`] : [];
+}
+var UNKNOWN_STACK = "unknown";
+function sessionSummary(outcome, session) {
+  const completedSteps = session?.completedSteps ?? [];
+  return {
+    outcome,
+    estimated_cost_usd: AGENT_TELEMETRY_CONTEXT.sessionCostUsd,
+    completed_steps: truncate2(completedSteps.join(", ")),
+    completed_step_count: completedSteps.length,
+    language: truncate2(session?.language ?? UNKNOWN_STACK),
+    framework: truncate2(session?.framework ?? UNKNOWN_STACK)
+  };
+}
 function isTelemetryOptedOut() {
   return process.env.WIZARD_TELEMETRY === "false";
 }
@@ -1837,13 +1882,15 @@ function agentRunMetrics(event, values, tags) {
 function trackAgentRun(event) {
   const profile = getModelProfile(event.profile);
   const values = agentRunValues(event);
+  AGENT_TELEMETRY_CONTEXT.sessionCostUsd += values.estimatedCostUsd;
   const tagsForMetrics = agentMetricTags(
     event,
     AGENT_TELEMETRY_CONTEXT.workflowId
   );
   const tags = [
     ...tagsForMetrics,
-    ...AGENT_TELEMETRY_CONTEXT.appId ? [`app_id:${AGENT_TELEMETRY_CONTEXT.appId}`] : []
+    ...AGENT_TELEMETRY_CONTEXT.appId ? [`app_id:${AGENT_TELEMETRY_CONTEXT.appId}`] : [],
+    ...sessionTags()
   ];
   sendTelemetry({
     logs: [
@@ -1864,6 +1911,7 @@ function trackAgentRun(event) {
           finishReason: event.finishReason,
           workflow_id: AGENT_TELEMETRY_CONTEXT.workflowId,
           app_id: AGENT_TELEMETRY_CONTEXT.appId,
+          agent_run_id: AGENT_TELEMETRY_CONTEXT.agentRunId,
           ...values
         },
         tags
@@ -1871,14 +1919,26 @@ function trackAgentRun(event) {
     ],
     metrics: agentRunMetrics(event, values, tagsForMetrics)
   });
+  for (const listener of sessionCostListeners) {
+    try {
+      listener();
+    } catch (err) {
+      logger.warn({ err }, "session cost listener failed");
+    }
+  }
 }
 function logTags(workflowId, actionId, appId) {
   return [
     ...metricTags(workflowId, actionId),
-    ...appId ? [`app_id:${appId}`] : []
+    ...appId ? [`app_id:${appId}`] : [],
+    ...sessionTags()
   ];
 }
-function emitTelemetryLog(level, message, attributes, tags) {
+function emitTelemetryLog(level, message, fields, tags) {
+  const attributes = {
+    ...fields,
+    agent_run_id: AGENT_TELEMETRY_CONTEXT.agentRunId
+  };
   if (level === "info") {
     logger.info(attributes, message);
   } else {
@@ -1889,6 +1949,8 @@ function emitTelemetryLog(level, message, attributes, tags) {
 function trackWorkflowStart(ctx) {
   AGENT_TELEMETRY_CONTEXT.appId = ctx.appId;
   AGENT_TELEMETRY_CONTEXT.workflowId = ctx.workflowId;
+  AGENT_TELEMETRY_CONTEXT.agentRunId = ctx.agentRunId;
+  AGENT_TELEMETRY_CONTEXT.sessionCostUsd = ctx.estimatedCostUsd ?? NO_COST;
   const attributes = {
     event: "wizard.workflow.start",
     workflow_id: ctx.workflowId,
@@ -1907,7 +1969,8 @@ function trackWorkflowAbandoned(ctx) {
     event: "wizard.workflow.abandoned",
     workflow_id: ctx.workflowId,
     app_id: ctx.appId,
-    reason: ctx.reason
+    reason: ctx.reason,
+    ...sessionSummary("abandoned", ctx.session)
   };
   emitTelemetryLog(
     "info",
@@ -2037,7 +2100,8 @@ function trackWizardComplete(event) {
     workflow_id: event.workflowId,
     app_id: event.appId,
     total_duration: event.total_duration,
-    total_steps: event.total_steps
+    total_steps: event.total_steps,
+    ...sessionSummary("success", event)
   };
   emitTelemetryLog(
     "info",
@@ -2045,8 +2109,7 @@ function trackWizardComplete(event) {
     attributes,
     logTags(event.workflowId, void 0, event.appId)
   );
-  AGENT_TELEMETRY_CONTEXT.appId = void 0;
-  AGENT_TELEMETRY_CONTEXT.workflowId = void 0;
+  resetTelemetryContext();
 }
 function trackWorkflowError(ctx) {
   const attributes = {
@@ -2055,7 +2118,8 @@ function trackWorkflowError(ctx) {
     action_id: ctx.actionId,
     error: ctx.error,
     app_id: ctx.appId,
-    ...errorAttributes(ctx.cause)
+    ...errorAttributes(ctx.cause),
+    ...sessionSummary("failed", ctx.session)
   };
   emitTelemetryLog(
     "error",
@@ -2063,8 +2127,7 @@ function trackWorkflowError(ctx) {
     attributes,
     logTags(ctx.workflowId, ctx.actionId, ctx.appId)
   );
-  AGENT_TELEMETRY_CONTEXT.appId = void 0;
-  AGENT_TELEMETRY_CONTEXT.workflowId = void 0;
+  resetTelemetryContext();
 }
 
 // src/lib/events.ts
@@ -2384,7 +2447,7 @@ async function ensureApplication(resumeAppId) {
 // package.json
 var package_default = {
   name: "@algolia/wizard",
-  version: "0.98.0",
+  version: "0.99.0",
   description: "Magically implement Algolia functionality in your codebase",
   type: "module",
   engines: {
@@ -2528,6 +2591,36 @@ function initWorkflowState(workflow, now, appId) {
 function ensureAgentRunId(state) {
   if (!state.agentRunId) state.agentRunId = crypto.randomUUID();
 }
+async function persistState(state) {
+  state.estimatedCostUsd = sessionCostUsd(state.agentRunId) ?? state.estimatedCostUsd;
+  await saveWorkflowState(state);
+}
+function saveCostDuringStep(state) {
+  const snapshot = JSON.parse(JSON.stringify(state));
+  return onSessionCost(() => {
+    const cost = sessionCostUsd(state.agentRunId);
+    if (cost === void 0) return;
+    snapshot.estimatedCostUsd = cost;
+    saveWorkflowState(snapshot).catch((err) => {
+      logger.warn({ err }, "failed to save the session cost");
+    });
+  });
+}
+function stepOutput(state, stepId) {
+  const record = state.steps.find((s) => s.id === stepId);
+  return record?.status === "done" ? record.output : void 0;
+}
+function stackName(state, confirmStepId, key) {
+  const name = stepOutput(state, confirmStepId)?.[key]?.[0]?.name ?? stepOutput(state, "project-scan")?.[key]?.[0]?.name;
+  return name ? name.toLowerCase() : "unknown";
+}
+function sessionReport(state) {
+  return {
+    completedSteps: state.steps.filter((s) => s.status === "done").map((s) => s.id),
+    language: stackName(state, "confirm-language", "languages"),
+    framework: stackName(state, "confirm-framework", "frameworks")
+  };
+}
 function completeEventProperties(state, totalDurationMs, stepCount) {
   const indexName = state.steps.find((s) => s.id === "select-index")?.output?.selection;
   const framework = state.steps.find((s) => s.id === "confirm-framework")?.output?.frameworks?.[0]?.name;
@@ -2632,7 +2725,7 @@ async function rewindTo(state, targetIndex, fromIndex) {
   const store = useWizard.getState();
   store.setActiveStep(targetIndex);
   store.syncSteps([...state.steps], targetIndex);
-  await saveWorkflowState(state);
+  await persistState(state);
 }
 async function runStep(state, index, step) {
   const store = useWizard.getState();
@@ -2653,9 +2746,10 @@ async function runStep(state, index, step) {
   state.updatedAt = nowIso();
   store.setActiveStep(index);
   store.syncSteps([...state.steps], index);
-  await saveWorkflowState(state);
+  await persistState(state);
   await markInteraction();
   const ctx = await makeContext(state);
+  const stopSavingCost = saveCostDuringStep(state);
   let output;
   try {
     const raw = await step.run(ctx);
@@ -2663,6 +2757,7 @@ async function runStep(state, index, step) {
     await step.onStepComplete?.(output, ctx);
   } catch (err) {
     if (err instanceof ReturnToStepSignal) {
+      stopSavingCost();
       await rewindTo(state, err.targetIndex, index);
       return err.targetIndex;
     }
@@ -2677,12 +2772,14 @@ async function runStep(state, index, step) {
       });
     }
     throw err;
+  } finally {
+    stopSavingCost();
   }
   record.status = "done";
   record.output = output;
   state.updatedAt = nowIso();
   store.syncSteps([...state.steps], index);
-  await saveWorkflowState(state);
+  await persistState(state);
   trackActionEnd({
     workflowId: state.workflowId,
     appId,
@@ -2740,13 +2837,19 @@ async function beginRun(workflow, state) {
     [...state.steps]
   );
   await ensureConsent();
-  trackWorkflowStart({ workflowId: workflow.id, appId: runAppId(state) });
+  trackWorkflowStart({
+    workflowId: workflow.id,
+    appId: runAppId(state),
+    agentRunId: state.agentRunId,
+    estimatedCostUsd: state.estimatedCostUsd
+  });
 }
 async function handleRestartWorkflow(workflow, previous, newAppId) {
   trackWorkflowAbandoned({
     workflowId: workflow.id,
     appId: runAppId(previous),
-    reason: "application_changed"
+    reason: "application_changed",
+    session: sessionReport(previous)
   });
   await clearWorkflowState(workflow.id);
   const next = initWorkflowState(workflow, nowIso(), newAppId);
@@ -2795,7 +2898,8 @@ async function runWorkflow(workflow, startWorkflowAppId, options) {
       workflowId: workflow.id,
       appId: runAppId(state),
       total_duration: Math.round(totalDurationMs / 1e3),
-      total_steps: stepCount
+      total_steps: stepCount,
+      ...sessionReport(state)
     });
     track(
       "AI Wizard Completed",
@@ -2819,12 +2923,12 @@ async function runWorkflow(workflow, startWorkflowAppId, options) {
         if (record.status === "running") {
           record.status = "error";
           record.error = message;
-          await saveWorkflowState(failed);
           store.syncSteps([...failed.steps], failed.currentStepIndex);
         }
         failedActionId = record.id;
         failedActionTitle = record.title;
       }
+      await persistState(failed);
     }
     if (failedActionId && failedActionTitle) {
       trackActionError({
@@ -2841,7 +2945,8 @@ async function runWorkflow(workflow, startWorkflowAppId, options) {
       appId: failedAppId,
       error: message,
       actionId: failedActionId,
-      cause: err
+      cause: err,
+      session: failed ? sessionReport(failed) : void 0
     });
     const errorType = wizardErrorType(failedActionId, step, message);
     const errorCode2 = errorCodeFrom(err);
@@ -9911,7 +10016,7 @@ async function resetProjectState() {
 // package.json with { type: 'json' }
 var package_default2 = {
   name: "@algolia/wizard",
-  version: "0.98.0",
+  version: "0.99.0",
   description: "Magically implement Algolia functionality in your codebase",
   type: "module",
   engines: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@algolia/wizard",
-  "version": "0.98.0",
+  "version": "0.99.0",
   "description": "Magically implement Algolia functionality in your codebase",
   "type": "module",
   "engines": {