@kenkaiiii/gg-pixel 4.3.90 → 4.3.91

package/dist/index.d.cts

@@ -1,3 +1,5 @@
+import { spawn } from 'node:child_process';
+
 type Level = "error" | "warning" | "fatal";
 interface StackFrame {
     file: string;
@@ -82,6 +84,10 @@ interface InstallResult {
     projectSecret: string;
     projectName: string;
     projectKind: ProjectKind;
+    /** Resolved root of the user's project (the dir containing package.json /
+     *  pyproject.toml / go.mod / Gemfile, depending on kind). Needed by the
+     *  verifier so it can spawn a probe child from the right cwd. */
+    projectRoot: string;
     initFilePath: string;
     envFilePath: string;
     projectsJsonPath: string;
@@ -115,9 +121,58 @@ type ProjectKind = "node" | "browser" | "python" | "nextjs" | "sveltekit" | "nux
 type PythonPackageManager = "uv" | "poetry" | "pipenv" | "pip";
 declare function install(opts?: InstallOptions): Promise<InstallResult>;
 
+/**
+ * Post-install verification.
+ *
+ * Mature SDKs (Sentry, PostHog, Datadog) all skip this — the wizard ends with
+ * "looks good!" if file writes succeeded, even when the wired code never ran
+ * a single byte. That's how every silent-failure bug we've debugged this
+ * session got past the installer (stale project keys, orphaned init files,
+ * sandboxed Electron renderers, missing dotenv, broken bundler copy steps).
+ *
+ * verifyInstall fires a synthetic event end-to-end after wiring completes:
+ * spawn a Node child in the user's project, import the SDK, report a probe,
+ * then poll the project's error list with the bearer secret. If the probe
+ * doesn't round-trip, we know the install is broken NOW instead of weeks
+ * later when an end-user finally hits a real error.
+ */
+
+interface VerifyOptions {
+    projectId: string;
+    projectKey: string;
+    /** Per-project bearer secret used to query the error list. */
+    projectSecret: string;
+    /** Backend root, e.g. "https://gg-pixel-server.buzzbeamaustralia.workers.dev" (no trailing /ingest). */
+    ingestUrl: string;
+    /** User's project root — the cwd we spawn the probe from for `node_modules` resolution. */
+    projectRoot: string;
+    fetchFn?: typeof fetch;
+    spawnFn?: typeof spawn;
+    /** Skip the spawned child probe entirely; useful for non-Node kinds (browser, RN). */
+    skipChildProbe?: boolean;
+    /** Max time to wait for the probe to appear in the error list. Default 5s. */
+    timeoutMs?: number;
+}
+type VerifyOutcome = {
+    kind: "ok";
+    /** Which path delivered the probe successfully. */
+    method: "child_process" | "direct_ingest";
+    latencyMs: number;
+} | {
+    kind: "failed";
+    reason: string;
+    hint?: string;
+};
+/**
+ * Returns true if the fingerprint string was produced by an install probe.
+ * Used by the overlay/listing code to hide probes if cleanup ever fails.
+ */
+declare function isInstallProbeFingerprint(fingerprint: string | null | undefined): boolean;
+declare function verifyInstall(opts: VerifyOptions): Promise<VerifyOutcome>;
+
 declare function initPixel(options: PixelOptions): NodeAdapter;
 declare function reportPixel(input: ReportInput): void;
 declare function flushPixel(): Promise<void>;
 declare function closePixel(): Promise<void>;
 
-export { type CodeContext, DEFAULT_INGEST_URL, type InstallOptions, type InstallResult, type Level, type PackageManager, type PixelOptions, type ReportInput, type Sink, type SinkConfig, type StackFrame, type WireEvent, closePixel, flushPixel, initPixel, install, reportPixel };
+export { type CodeContext, DEFAULT_INGEST_URL, type InstallOptions, type InstallResult, type Level, type PackageManager, type PixelOptions, type ReportInput, type Sink, type SinkConfig, type StackFrame, type VerifyOptions, type VerifyOutcome, type WireEvent, closePixel, flushPixel, initPixel, install, isInstallProbeFingerprint, reportPixel, verifyInstall };

package/dist/index.d.ts

@@ -1,3 +1,5 @@
+import { spawn } from 'node:child_process';
+
 type Level = "error" | "warning" | "fatal";
 interface StackFrame {
     file: string;
@@ -82,6 +84,10 @@ interface InstallResult {
     projectSecret: string;
     projectName: string;
     projectKind: ProjectKind;
+    /** Resolved root of the user's project (the dir containing package.json /
+     *  pyproject.toml / go.mod / Gemfile, depending on kind). Needed by the
+     *  verifier so it can spawn a probe child from the right cwd. */
+    projectRoot: string;
     initFilePath: string;
     envFilePath: string;
     projectsJsonPath: string;
@@ -115,9 +121,58 @@ type ProjectKind = "node" | "browser" | "python" | "nextjs" | "sveltekit" | "nux
 type PythonPackageManager = "uv" | "poetry" | "pipenv" | "pip";
 declare function install(opts?: InstallOptions): Promise<InstallResult>;
 
+/**
+ * Post-install verification.
+ *
+ * Mature SDKs (Sentry, PostHog, Datadog) all skip this — the wizard ends with
+ * "looks good!" if file writes succeeded, even when the wired code never ran
+ * a single byte. That's how every silent-failure bug we've debugged this
+ * session got past the installer (stale project keys, orphaned init files,
+ * sandboxed Electron renderers, missing dotenv, broken bundler copy steps).
+ *
+ * verifyInstall fires a synthetic event end-to-end after wiring completes:
+ * spawn a Node child in the user's project, import the SDK, report a probe,
+ * then poll the project's error list with the bearer secret. If the probe
+ * doesn't round-trip, we know the install is broken NOW instead of weeks
+ * later when an end-user finally hits a real error.
+ */
+
+interface VerifyOptions {
+    projectId: string;
+    projectKey: string;
+    /** Per-project bearer secret used to query the error list. */
+    projectSecret: string;
+    /** Backend root, e.g. "https://gg-pixel-server.buzzbeamaustralia.workers.dev" (no trailing /ingest). */
+    ingestUrl: string;
+    /** User's project root — the cwd we spawn the probe from for `node_modules` resolution. */
+    projectRoot: string;
+    fetchFn?: typeof fetch;
+    spawnFn?: typeof spawn;
+    /** Skip the spawned child probe entirely; useful for non-Node kinds (browser, RN). */
+    skipChildProbe?: boolean;
+    /** Max time to wait for the probe to appear in the error list. Default 5s. */
+    timeoutMs?: number;
+}
+type VerifyOutcome = {
+    kind: "ok";
+    /** Which path delivered the probe successfully. */
+    method: "child_process" | "direct_ingest";
+    latencyMs: number;
+} | {
+    kind: "failed";
+    reason: string;
+    hint?: string;
+};
+/**
+ * Returns true if the fingerprint string was produced by an install probe.
+ * Used by the overlay/listing code to hide probes if cleanup ever fails.
+ */
+declare function isInstallProbeFingerprint(fingerprint: string | null | undefined): boolean;
+declare function verifyInstall(opts: VerifyOptions): Promise<VerifyOutcome>;
+
 declare function initPixel(options: PixelOptions): NodeAdapter;
 declare function reportPixel(input: ReportInput): void;
 declare function flushPixel(): Promise<void>;
 declare function closePixel(): Promise<void>;
 
-export { type CodeContext, DEFAULT_INGEST_URL, type InstallOptions, type InstallResult, type Level, type PackageManager, type PixelOptions, type ReportInput, type Sink, type SinkConfig, type StackFrame, type WireEvent, closePixel, flushPixel, initPixel, install, reportPixel };
+export { type CodeContext, DEFAULT_INGEST_URL, type InstallOptions, type InstallResult, type Level, type PackageManager, type PixelOptions, type ReportInput, type Sink, type SinkConfig, type StackFrame, type VerifyOptions, type VerifyOutcome, type WireEvent, closePixel, flushPixel, initPixel, install, isInstallProbeFingerprint, reportPixel, verifyInstall };

package/dist/index.js

@@ -495,6 +495,7 @@ async function install(opts = {}) {
     projectSecret: created.secret,
     projectName,
     projectKind: kind,
+    projectRoot: nodeRoot,
     initFilePath: wired.primaryInitPath,
     envFilePath,
     projectsJsonPath,
@@ -1574,6 +1575,7 @@ func init() {
     projectSecret: created.secret,
     projectName,
     projectKind: "go",
+    projectRoot,
     initFilePath,
     envFilePath,
     projectsJsonPath,
@@ -1639,6 +1641,7 @@ GGPixel.init(
     projectSecret: created.secret,
     projectName,
     projectKind: "ruby",
+    projectRoot,
     initFilePath,
     envFilePath,
     projectsJsonPath,
@@ -1708,6 +1711,7 @@ async function installPython(ctx) {
     projectSecret: created.secret,
     projectName,
     projectKind: "python",
+    projectRoot,
     initFilePath,
     envFilePath,
     projectsJsonPath,
@@ -1839,6 +1843,203 @@ function writeProjectsMapping(projectsJsonPath, projectId, name, path, secret) {
 `, "utf8");
 }
 
+// src/verify.ts
+import { spawn as nodeSpawn } from "child_process";
+import { writeFileSync as writeFileSync2, unlinkSync, mkdirSync as mkdirSync3, existsSync as existsSync3 } from "fs";
+import { join as join3 } from "path";
+import { randomBytes } from "crypto";
+var PROBE_FINGERPRINT_PREFIX = "__pixel_install_probe__";
+function isInstallProbeFingerprint(fingerprint2) {
+  return typeof fingerprint2 === "string" && fingerprint2.startsWith(PROBE_FINGERPRINT_PREFIX);
+}
+async function verifyInstall(opts) {
+  const fetchFn = opts.fetchFn ?? fetch;
+  const spawnFn = opts.spawnFn ?? nodeSpawn;
+  const timeoutMs = opts.timeoutMs ?? 5e3;
+  const ingest = opts.ingestUrl.replace(/\/+$/, "");
+  const fingerprint2 = `${PROBE_FINGERPRINT_PREFIX}${randomBytes(6).toString("hex")}`;
+  const start = Date.now();
+  let method;
+  let probeError = null;
+  if (opts.skipChildProbe) {
+    try {
+      await postDirectIngest({
+        ingestUrl: ingest,
+        projectKey: opts.projectKey,
+        fingerprint: fingerprint2,
+        fetchFn
+      });
+      method = "direct_ingest";
+    } catch (err) {
+      return {
+        kind: "failed",
+        reason: "Direct ingest failed",
+        hint: err.message
+      };
+    }
+  } else {
+    try {
+      await runChildProbe({
+        projectRoot: opts.projectRoot,
+        ingestUrl: ingest,
+        projectKey: opts.projectKey,
+        fingerprint: fingerprint2,
+        spawnFn
+      });
+      method = "child_process";
+    } catch (err) {
+      probeError = err.message;
+      try {
+        await postDirectIngest({
+          ingestUrl: ingest,
+          projectKey: opts.projectKey,
+          fingerprint: fingerprint2,
+          fetchFn
+        });
+        method = "direct_ingest";
+      } catch (err2) {
+        return {
+          kind: "failed",
+          reason: "Could not deliver probe event",
+          hint: `child-process: ${probeError}; direct ingest: ${err2.message}`
+        };
+      }
+    }
+  }
+  const probeRow = await pollForFingerprint({
+    ingestUrl: ingest,
+    projectId: opts.projectId,
+    projectSecret: opts.projectSecret,
+    fingerprint: fingerprint2,
+    timeoutMs,
+    fetchFn
+  });
+  if (!probeRow) {
+    return {
+      kind: "failed",
+      reason: `Probe sent (${method}) but didn't appear in /api/projects/${opts.projectId}/errors within ${timeoutMs}ms`,
+      hint: probeError ?? void 0
+    };
+  }
+  try {
+    await fetchFn(`${ingest}/api/errors/${probeRow.id}`, {
+      method: "DELETE",
+      headers: { authorization: `Bearer ${opts.projectSecret}` }
+    });
+  } catch {
+  }
+  return {
+    kind: "ok",
+    method,
+    latencyMs: Date.now() - start
+  };
+}
+async function runChildProbe(args) {
+  const ggDir = join3(args.projectRoot, ".gg");
+  if (!existsSync3(ggDir)) mkdirSync3(ggDir, { recursive: true });
+  const probePath = join3(ggDir, `pixel-probe-${randomBytes(4).toString("hex")}.mjs`);
+  const script = `import "@kenkaiiii/gg-pixel";
+const body = ${JSON.stringify({
+    project_key: args.projectKey,
+    fingerprint: args.fingerprint,
+    type: "InstallProbe",
+    message: "Install verification probe \u2014 auto-generated, safe to delete",
+    stack: [],
+    code_context: null,
+    runtime: "",
+    manual_report: true,
+    level: "error"
+  })};
+body.event_id = "evt_probe_" + crypto.randomUUID();
+body.runtime = "installer-node-" + process.versions.node;
+body.occurred_at = new Date().toISOString();
+const res = await fetch(${JSON.stringify(args.ingestUrl + "/ingest")}, {
+  method: "POST",
+  headers: { "content-type": "application/json" },
+  body: JSON.stringify(body),
+});
+if (!res.ok) {
+  const txt = await res.text().catch(() => "");
+  console.error("probe ingest failed: status=" + res.status + " body=" + txt.slice(0, 200));
+  process.exit(1);
+}
+`;
+  writeFileSync2(probePath, script, "utf8");
+  try {
+    await new Promise((resolve2, reject) => {
+      const opts = { cwd: args.projectRoot, stdio: "pipe" };
+      const child = args.spawnFn("node", [probePath], opts);
+      let stderr = "";
+      child.stderr?.on("data", (b) => {
+        stderr += b.toString();
+      });
+      const timer = setTimeout(() => {
+        child.kill("SIGKILL");
+        reject(new Error("Probe child timed out after 10s"));
+      }, 1e4);
+      child.on("error", (err) => {
+        clearTimeout(timer);
+        reject(err);
+      });
+      child.on("exit", (code) => {
+        clearTimeout(timer);
+        if (code === 0) resolve2();
+        else reject(new Error(`Probe exited code=${code}; stderr: ${stderr.trim().slice(0, 400)}`));
+      });
+    });
+  } finally {
+    try {
+      unlinkSync(probePath);
+    } catch {
+    }
+  }
+}
+async function postDirectIngest(args) {
+  const res = await args.fetchFn(`${args.ingestUrl}/ingest`, {
+    method: "POST",
+    headers: { "content-type": "application/json" },
+    body: JSON.stringify({
+      event_id: `evt_probe_${randomBytes(8).toString("hex")}`,
+      project_key: args.projectKey,
+      fingerprint: args.fingerprint,
+      type: "InstallProbe",
+      message: "Install verification probe",
+      stack: [],
+      code_context: null,
+      runtime: `installer-node-${process.versions.node}`,
+      manual_report: true,
+      level: "error",
+      occurred_at: (/* @__PURE__ */ new Date()).toISOString()
+    })
+  });
+  if (!res.ok) {
+    let body = "";
+    try {
+      body = await res.text();
+    } catch {
+    }
+    throw new Error(`POST /ingest \u2192 ${res.status} ${body.slice(0, 200)}`);
+  }
+}
+async function pollForFingerprint(args) {
+  const deadline = Date.now() + args.timeoutMs;
+  while (Date.now() < deadline) {
+    try {
+      const res = await args.fetchFn(`${args.ingestUrl}/api/projects/${args.projectId}/errors`, {
+        headers: { authorization: `Bearer ${args.projectSecret}` }
+      });
+      if (res.ok) {
+        const body = await res.json();
+        const match = body.errors.find((e) => e.fingerprint === args.fingerprint);
+        if (match) return { id: match.id };
+      }
+    } catch {
+    }
+    await new Promise((r) => setTimeout(r, 250));
+  }
+  return null;
+}
+
 // src/index.ts
 var active = null;
 function initPixel(options) {
@@ -1890,6 +2091,8 @@ export {
   flushPixel,
   initPixel,
   install,
-  reportPixel
+  isInstallProbeFingerprint,
+  reportPixel,
+  verifyInstall
 };
 //# sourceMappingURL=index.js.map