@algolia/wizard 0.93.0 → 0.95.0

package/dist/main.js

@@ -2384,7 +2384,7 @@ async function ensureApplication(resumeAppId) {
 // package.json
 var package_default = {
   name: "@algolia/wizard",
-  version: "0.93.0",
+  version: "0.95.0",
   description: "Magically implement Algolia functionality in your codebase",
   type: "module",
   engines: {
@@ -5315,9 +5315,11 @@ function incompleteCauseOf(stepCount, maxSteps, finishReason) {
 }
 var AgentReportedFailureError = class extends Error {
   reason;
-  constructor(reason) {
+  output;
+  constructor(reason, output) {
     super(`Agent reported failure: ${reason ?? "no reason given"}`);
     this.reason = reason;
+    this.output = output;
   }
 };
 function withCachedHistory(messages) {
@@ -5573,7 +5575,7 @@ async function runAgentAttempt(req, attempt, retryReason) {
       },
       "agent reported failure"
     );
-    throw new AgentReportedFailureError(result.reason);
+    throw new AgentReportedFailureError(result.reason, result.output);
   }
   return result.output;
 }
@@ -6120,8 +6122,22 @@ Output:
 ${JSON.stringify(s.output, null, 2)}`
   ).join("\n\n");
 }
+async function runReviewAgent(request) {
+  try {
+    return await runAgent(request);
+  } catch (err) {
+    if (!(err instanceof AgentReportedFailureError)) throw err;
+    const parsed = reviewSchema.safeParse(err.output);
+    if (!parsed.success) throw err;
+    logger.warn(
+      { reason: err.reason },
+      "review agent reported fail, using its summary"
+    );
+    return parsed.data;
+  }
+}
 var reviewStep = async (ctx, options) => {
-  const result = await runAgent({
+  const result = await runReviewAgent({
     operation: "workflow-review",
     instructions: [
       "Summarize what was accomplished in the workflow, leaving out verbose details.",
@@ -6133,6 +6149,7 @@ var reviewStep = async (ctx, options) => {
       options.nextStepsGuidance,
       `Completed steps:
 ${formatCompletedSteps(ctx.completedSteps)}`,
+      "The reportStatus status is for your summary task, not for the workflow. When a prior step failed, report status=success and describe the failure in summaryPoints.",
       "When done, call reportStatus"
     ],
     tools: [],
@@ -6407,7 +6424,8 @@ function sourceSpecificInstructions(input) {
       "Read each record from its real local source at the confirmed entity paths.",
       "Never fabricate, hardcode, or use placeholder records.",
       "Add env vars for any local source access (DB URL, API base, file paths) that is not a fixed repo path.",
-      "To read a database, use the database client or ORM that the project already declares in its manifest. Never install a database driver or ORM. If the project declares none, report that limitation instead of adding one."
+      "To read a database, use the database client or ORM that the project already declares in its manifest. Never install a database driver or ORM. If the project declares none, report that limitation instead of adding one.",
+      "Prefer a server-side credential (a service-role, secret, or admin key, or a database password) over a client-side or public key (for example an anon or publishable key, or any key the project exposes to its frontend) when the source has both: public keys are subject to the source's access rules and can return zero records without an error. Use a public key only when the source offers nothing else. Check the connection to the source before you check for its credential, and make that connection check work without the credential, so an unreachable service is never reported as a missing credential. If the credential the script needs is not in the environment, the script must print an error that names the variable and where the developer finds it, then exit with an error. Never install a client library or driver to work around a missing credential."
     ],
     fileUpload: [
       `Records come from the developer's file, already copied into the project at "${input.uploadFilePath}". Read and parse that exact file.`,
@@ -6463,7 +6481,7 @@ function ingestionInstructions(input) {
       ] : [],
       `When the script is finished, decide the exact command and cwd you will use to run it. Make sure that the script path in the command resolves from that cwd to the filePath. Then call reviewScript with that filePath, command, cwd, the exact selected entityName, and usesGeneratedRecords set to ${input.ingestionSource === "generated"}. Wait for the developer to review it because running it writes records to a live index. Do not run it before that call returns. If you change the command or cwd after a failed run, call reviewScript again before runShell.`,
       'Then, without changing directories, run the script yourself via runShell using the exact same command and cwd. Report the exact command you ran as "ingestCommand", with no cwd note or other text, so the developer can re-run it. Its explanation must say that running it writes records to Algolia.',
-      "When the script reads from a database or another service, find how the project connects to it locally (env files, README, socket or TCP settings). If that connection needs a local service, such as a database proxy (for example cloud-sql-proxy) or a tunnel, make the script check the connection before it reads. If the check fails, the script must print an error that names the service, then print exactly one last line to stdout in the form `ALGOLIA_WIZARD_START_HINT=<command>`, where <command> is the command from the project docs that starts the service, and exit with an error. Omit that line when the project docs name no start command.",
+      "When the script reads from a database or another service, find how the project connects to it locally (env files, README, the service's own config file for its host and port, socket or TCP settings). Use the host and port that config sets, not a default. If that connection needs a local service, such as a database proxy (for example cloud-sql-proxy), a tunnel, or a service the project starts with its own CLI or scripts (not necessarily Docker Compose), make the script check the connection before it reads. If the check fails, the script must print an error that names the service, then print exactly one last line to stdout in the form `ALGOLIA_WIZARD_START_HINT=<command>`, where <command> is the command from the project docs or scripts (README, package.json scripts, Makefile) that starts the service, and exit with an error. Omit that line when neither names a start command.",
       "Make sure that the start command and the script connect to the same address (the same socket path, or the same host and port). If the project env points at an address that only a deployed environment has, such as a /cloudsql socket, make the script connect to the address of the start command. Set that address in the script before it loads the project database module. Do not edit project env or config files for this.",
       "When the script uses the project database client or ORM, load that client's env file (the project .env the client already reads) so credentials such as DB user, password, and database name are present. Load the wizard Algolia .env first, then the project .env, so Algolia keys win under dotenv versions that ignore `override`. Do not rely on `override: true`.",
       "If external data access fails, do not run authentication commands, change accounts or machine configuration, or start proxies, containers, or services.",
@@ -6701,6 +6719,12 @@ function parseIngestRecordCount(output) {
   const count = Number(match[1]);
   return Number.isFinite(count) ? count : void 0;
 }
+function indexedNothing(execution) {
+  return parseIngestRecordCount(execution.output ?? "") === 0;
+}
+function ranButIndexedNothing(execution) {
+  return execution.approved && execution.exitCode === 0 && !execution.timedOut && indexedNothing(execution);
+}
 var START_HINT_LINE = /^ALGOLIA_WIZARD_START_HINT=(.*)$/gm;
 function parseStartHint(output) {
   const matches = [...(output ?? "").matchAll(START_HINT_LINE)];
@@ -6722,7 +6746,7 @@ function ingestOutcome(executions, repoRoot, ingestCommand) {
     (e) => parseIngestRecordCount(e.output ?? "") != null
   );
   const succeeded = newestFirst.filter(
-    (e) => e.approved && e.exitCode === 0 && !e.timedOut
+    (e) => e.approved && e.exitCode === 0 && !e.timedOut && !indexedNothing(e)
   );
   const run2 = succeeded.find(matchesReportedCommand) ?? succeeded.find((e) => withCount.includes(e));
   const runs = executions.filter(
@@ -6731,7 +6755,9 @@ function ingestOutcome(executions, repoRoot, ingestCommand) {
   return {
     run: run2,
     attempt: ingestCommand ? newestFirst.find(matchesReportedCommand) : void 0,
-    recordCount: parseIngestRecordCount(withCount[0]?.output ?? ""),
+    recordCount: parseIngestRecordCount(
+      withCount.find((e) => !indexedNothing(e))?.output ?? ""
+    ),
     attempts: run2 && !matchesReportedCommand(run2) ? runs + 1 : runs
   };
 }
@@ -6811,9 +6837,13 @@ function noRunReason({
   }
   return "no successful run was recorded";
 }
+var EMPTY_INGEST_DETAIL = "The script read no records. A client-side or public key can return no rows because of access rules, so check that it reads with a server-side credential and that the data source has data.";
 function ingestFailure(attempt, missingRunReason = "no successful run was recorded") {
   if (!attempt) return { reason: missingRunReason };
   if (!attempt.approved) return { reason: "you declined to run it" };
+  if (ranButIndexedNothing(attempt)) {
+    return { reason: "it ran but indexed 0 records", detail: EMPTY_INGEST_DETAIL };
+  }
   const detail = errorLine(attempt.output);
   if (attempt.timedOut) {
     const seconds = Math.round((attempt.durationMs ?? 0) / 1e3);
@@ -6854,8 +6884,8 @@ function briefSummary(summary) {
   if (!firstLine) return "no summary given";
   return firstLine.length > ERROR_SUMMARY_MAX_CHARS ? `${firstLine.slice(0, ERROR_SUMMARY_MAX_CHARS - 1)}\u2026` : firstLine;
 }
-function ingestionRetryInstruction(reason) {
-  return `The previous ingestion attempt ended with no successful run: ${reason}. Look in "${INGEST_DIR}/" for a script from that attempt and finish or fix it instead of starting over. Then call reviewScript and run the script as described above.`;
+function ingestionRetryInstruction(reason, detail) {
+  return `The previous ingestion attempt ended with no successful run: ${reason}.${detail ? ` ${detail}` : ""} Look in "${INGEST_DIR}/" for a script from that attempt and finish or fix it instead of starting over. Then call reviewScript and run the script as described above.`;
 }
 function validationRetryInstructions(validation) {
   return [
@@ -7192,19 +7222,22 @@ async function implement(ctx, useCases = DEFAULT_IMPLEMENT_USE_CASES) {
     await runIngestionAgent();
     let outcome = ingestOutcome(executions, repoRoot, ingestCommand);
     let failureAcknowledged = false;
-    while (!outcome.run && !outcome.attempt) {
-      const reason = await currentNoRunReason();
+    while (!outcome.run && (!outcome.attempt || ranButIndexedNothing(outcome.attempt))) {
+      const { reason, detail } = outcome.attempt ? ingestFailure(outcome.attempt) : { reason: await currentNoRunReason(), detail: void 0 };
       const choice = await ctx.requestUserInput({
         prompt: INGEST_AGENT_RETRY_PROMPT,
         promptType: "multipleChoice",
         options: [INGEST_RETRY.retry, INGEST_RETRY.skip],
-        messages: [`\u26A0\uFE0F Records were not indexed \u2014 ${reason}.`]
+        messages: [
+          `\u26A0\uFE0F Records were not indexed \u2014 ${reason}.`,
+          ...detail ? [detail] : []
+        ]
       });
       if (choice !== INGEST_RETRY.retry) {
         failureAcknowledged = true;
         break;
       }
-      await runIngestionAgent([ingestionRetryInstruction(reason)]);
+      await runIngestionAgent([ingestionRetryInstruction(reason, detail)]);
       outcome = ingestOutcome(executions, repoRoot, ingestCommand);
     }
     while (!failureAcknowledged && !outcome.run && outcome.attempt?.approved) {
@@ -7578,14 +7611,25 @@ var defaultWorkflow = {
           "ingestion"
         );
         return reviewStep(ctx, {
-          // ingestCommand was already shown verbatim as a notice; an
-          // LLM-paraphrased restatement in nextSteps risks being wrong.
-          nextStepsGuidance: ingestion2?.ingestScriptRan ? "The wizard already ran the ingestion script and records are in the index. Do NOT tell the user to run it again; instead point them at the target index to confirm the records. Do not restate the ingestion command \u2014 the wizard already showed it to them." : "Tell the user to run the ingestion script; do not restate the exact command \u2014 the wizard already showed it to them above."
+          nextStepsGuidance: ingestionGuidance(ingestion2)
         });
       }
     })
   ]
 };
+function ingestionGuidance(ingestion2) {
+  if (ingestion2?.ingestScriptRan) {
+    return "The wizard already ran the ingestion script and records are in the index. Do NOT tell the user to run it again; instead point them at the target index to confirm the records. Do not restate the ingestion command \u2014 the wizard already showed it to them.";
+  }
+  const partialCount = ingestion2?.ingestRecordCount ?? 0;
+  if (partialCount > 0) {
+    return `The ingestion script indexed ${partialCount} record(s) and then failed before it finished. Say that plainly. Do not say that ingestion succeeded or that no records were indexed. Tell the user to fix the error shown above and run the ingestion script again. Do not restate the exact command, because the wizard already showed it to them above.`;
+  }
+  if (ingestion2?.ingestCommand) {
+    return "No records were indexed in this run. Say that plainly, and do not say that the wizard created or populated an index. Tell the user to run the ingestion script; do not restate the exact command \u2014 the wizard already showed it to them above.";
+  }
+  return "No ingestion script ran and no records were indexed in this run. Say that plainly. Do not say that the wizard created, selected, or populated an index, and do not tell the user to run an ingestion script, because the wizard has no tested command for one. Tell the user to run the wizard again to create and run the ingestion script.";
+}
 
 // src/actions/playbookSteps/selectPlaybook.ts
 import { z as z33 } from "zod";
@@ -9859,7 +9903,7 @@ async function resetProjectState() {
 // package.json with { type: 'json' }
 var package_default2 = {
   name: "@algolia/wizard",
-  version: "0.93.0",
+  version: "0.95.0",
   description: "Magically implement Algolia functionality in your codebase",
   type: "module",
   engines: {

package/package.json

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