bitfab 0.64.6 → 0.64.7

package/dist/index.cjs

@@ -51,7 +51,7 @@ var __version__, __packageName__;
 var init_version_generated = __esm({
   "src/version.generated.ts"() {
     "use strict";
-    __version__ = "0.64.6";
+    __version__ = "0.64.7";
     __packageName__ = "bitfab";
   }
 });
@@ -2904,7 +2904,7 @@ var init_http = __esm({
        * Start a replay session by fetching historical traces.
        * Blocking call - creates an experiment and returns lightweight item references.
        */
-      async startReplay(traceFunctionKey, limit, traceIds, name, codeChangeDescription, codeChangeFiles, includeDbBranchLease, experimentGroupId, datasetIds, graderIds, dbBranchSettings, attempts, includeOriginalMetadata, onlyWithAssertions, skipAssertionJudging, experimentalSelectiveReplay, notes, metadata, dryRun) {
+      async startReplay(traceFunctionKey, limit, traceIds, name, codeChangeDescription, codeChangeFiles, includeDbBranchLease, experimentGroupId, datasetIds, graderIds, dbBranchSettings, attempts, includeOriginalMetadata, onlyWithAssertions, skipAssertionJudging, experimentalSelectiveReplay, notes, metadata, dryRun, invocation) {
         const payload = { traceFunctionKey };
         if (experimentalSelectiveReplay !== void 0) {
           payload.experimentalSelectiveReplay = experimentalSelectiveReplay;
@@ -2965,6 +2965,9 @@ var init_http = __esm({
         if (dryRun) {
           payload.dryRun = true;
         }
+        if (invocation !== void 0) {
+          payload.invocation = invocation;
+        }
         const git = await resolvedGitState();
         if (git && !isEmptyGitState(git)) {
           payload.git = git;
@@ -3760,6 +3763,113 @@ var init_replayInterrupt = __esm({
   }
 });
 
+// src/replayInvocation.ts
+function replayEnvironment() {
+  if (readEnv(REPLAY_EXECUTION_TARGET_ENV) === HOSTED_EXECUTION_TARGET) {
+    return "cloud_replay";
+  }
+  if (CI_TRUE_VALUES.has((readEnv(CI_ENV) ?? "").toLowerCase())) {
+    return "ci";
+  }
+  if (CI_PRESENCE_ENV_VARS.some((name) => (readEnv(name) ?? "") !== "")) {
+    return "ci";
+  }
+  return "local";
+}
+function flagScalar(value) {
+  if (typeof value === "string") {
+    return value.slice(0, MAX_FLAG_STRING_LENGTH);
+  }
+  if (typeof value === "number") {
+    return Number.isFinite(value) ? value : void 0;
+  }
+  if (typeof value === "boolean" || value === null) {
+    return value;
+  }
+  return void 0;
+}
+function flagValue(value) {
+  if (Array.isArray(value)) {
+    const items = value.slice(0, MAX_FLAG_LIST_LENGTH).map(flagScalar);
+    return items.every((item) => item !== void 0) ? items : true;
+  }
+  const scalar = flagScalar(value);
+  return scalar === void 0 ? true : scalar;
+}
+function optionFlagName(option) {
+  return OPTION_FLAG_NAMES[option] ?? option.replace(/[A-Z]/g, (letter) => `-${letter.toLowerCase()}`);
+}
+function metadataKeys(value) {
+  const keys = Array.isArray(value) ? value.map((pair) => String(pair).split("=")[0]) : typeof value === "object" && value !== null ? Object.keys(value) : void 0;
+  return keys === void 0 ? true : [...new Set(keys)].sort();
+}
+function invocationFlags(entries) {
+  const flags = {};
+  const seen = /* @__PURE__ */ new Set();
+  for (const [name, value] of entries) {
+    if (seen.size >= MAX_FLAGS) {
+      break;
+    }
+    if (value === void 0 || seen.has(name) || name.length === 0 || name.length > MAX_FLAG_NAME_LENGTH || SECRET_FLAG_NAME.test(name)) {
+      continue;
+    }
+    flags[name] = flagValue(
+      name === METADATA_FLAG ? metadataKeys(value) : value
+    );
+    seen.add(name);
+  }
+  return flags;
+}
+function buildReplayInvocation(entries = []) {
+  return {
+    flags: invocationFlags(entries),
+    sdk: { language: "typescript", version: __version__ },
+    environment: replayEnvironment()
+  };
+}
+function safeReplayInvocation(build) {
+  try {
+    return build();
+  } catch {
+    return void 0;
+  }
+}
+function cliFlags(options) {
+  return options?.[CLI_FLAGS];
+}
+var REPLAY_EXECUTION_TARGET_ENV, HOSTED_EXECUTION_TARGET, CI_ENV, CI_TRUE_VALUES, CI_PRESENCE_ENV_VARS, MAX_FLAGS, MAX_FLAG_NAME_LENGTH, MAX_FLAG_STRING_LENGTH, MAX_FLAG_LIST_LENGTH, SECRET_FLAG_NAME, CLI_FLAGS, METADATA_FLAG, OPTION_FLAG_NAMES;
+var init_replayInvocation = __esm({
+  "src/replayInvocation.ts"() {
+    "use strict";
+    init_constants();
+    init_readEnv();
+    REPLAY_EXECUTION_TARGET_ENV = "BITFAB_REPLAY_EXECUTION_TARGET";
+    HOSTED_EXECUTION_TARGET = "hosted";
+    CI_ENV = "CI";
+    CI_TRUE_VALUES = /* @__PURE__ */ new Set(["true", "1"]);
+    CI_PRESENCE_ENV_VARS = [
+      "GITHUB_ACTIONS",
+      "GITLAB_CI",
+      "CIRCLECI",
+      "BUILDKITE",
+      "JENKINS_URL",
+      "TF_BUILD"
+    ];
+    MAX_FLAGS = 100;
+    MAX_FLAG_NAME_LENGTH = 100;
+    MAX_FLAG_STRING_LENGTH = 1e3;
+    MAX_FLAG_LIST_LENGTH = 100;
+    SECRET_FLAG_NAME = /key|token|secret|password/i;
+    CLI_FLAGS = /* @__PURE__ */ Symbol("bitfab.replayCliFlags");
+    METADATA_FLAG = "metadata";
+    OPTION_FLAG_NAMES = {
+      maxConcurrency: "concurrency",
+      datasetId: "dataset-ids",
+      datasetIds: "dataset-ids"
+    };
+  }
+});
+
 // src/selectiveReplay.ts
 function replayNodeKey(node) {
   return JSON.stringify([node.traceFunctionKey, node.spanName]);
@@ -4189,6 +4299,16 @@ function resolveDbBranchSettings(dbBranch) {
   };
   return Object.keys(settings).length === 0 ? void 0 : settings;
 }
+function explicitReplayOptions(options) {
+  var _a;
+  const explicit = {};
+  for (const name of REPLAY_OPTION_NAMES) {
+    if (options?.[name] !== void 0) {
+      explicit[_a = optionFlagName(name)] ?? (explicit[_a] = options[name]);
+    }
+  }
+  return explicit;
+}
 function reportReplayProgress(progress) {
   const stderr = typeof process !== "undefined" ? process.stderr : void 0;
   if (!stderr) {
@@ -4700,7 +4820,12 @@ async function replay(httpClient, serviceUrl, traceFunctionKey, fn, options, reg
       options?.experimentalSelectiveReplay,
       options?.notes,
       options?.metadata,
-      options?.dryRun === true
+      options?.dryRun === true,
+      safeReplayInvocation(
+        () => buildReplayInvocation(
+          Object.entries(cliFlags(options) ?? explicitReplayOptions(options))
+        )
+      )
     );
     if (started.items.length === 0) {
       try {
@@ -5092,7 +5217,7 @@ async function writeReplayResultFile(result) {
     }
   }
 }
-var REPLAY_PERSISTENCE_TIMEOUT_MS, MAX_REPLAY_ATTEMPTS, RESUME_CONFLICTING_OPTIONS, CARRIED_OVER_ERROR, BITFAB_PROGRESS_PREFIX, ReplayError, DbBranchReplayError, JUDGE_ASSERTIONS_DEPRECATION_WARNING;
+var REPLAY_PERSISTENCE_TIMEOUT_MS, MAX_REPLAY_ATTEMPTS, RESUME_CONFLICTING_OPTIONS, CARRIED_OVER_ERROR, REPLAY_OPTION_NAMES, BITFAB_PROGRESS_PREFIX, ReplayError, DbBranchReplayError, JUDGE_ASSERTIONS_DEPRECATION_WARNING;
 var init_replay = __esm({
   "src/replay.ts"() {
     "use strict";
@@ -5105,6 +5230,7 @@ var init_replay = __esm({
     init_replayContext();
     init_replayHeartbeat();
     init_replayInterrupt();
+    init_replayInvocation();
     init_selectiveReplayRuntime();
     init_serialize();
     init_warnOnce();
@@ -5122,6 +5248,37 @@ var init_replay = __esm({
       "experimentalSelectiveReplay"
     ];
     CARRIED_OVER_ERROR = "This item errored in an earlier run of this experiment, before it was resumed.";
+    REPLAY_OPTION_NAMES = [
+      "experimentalSelectiveReplay",
+      "limit",
+      "attempts",
+      "traceIds",
+      "name",
+      "notes",
+      "metadata",
+      "maxConcurrency",
+      "codeChangeDescription",
+      "codeChangeFiles",
+      "mock",
+      "mockOverride",
+      "dbBranch",
+      "experimentGroupId",
+      "datasetId",
+      "datasetIds",
+      "graderIds",
+      "onlyWithAssertions",
+      "skipAssertionJudging",
+      "judgeAssertions",
+      "adaptInputs",
+      "dryRun",
+      "onItemFinish",
+      "onProgress",
+      "onItemStart",
+      "onExperimentStart",
+      "onInterrupt",
+      "resume",
+      "force"
+    ];
     BITFAB_PROGRESS_PREFIX = "@@bitfab:progress ";
     ReplayError = class extends BitfabError {
       constructor(message, items, experimentId, experimentUrl, cause) {
@@ -11972,6 +12129,7 @@ init_replay();
 init_errors();
 init_replay();
 init_replayInterrupt();
+init_replayInvocation();
 init_warnOnce();
 function defineReplayRegistry(registry) {
   validateReplayRegistry(registry);