log-inject 0.0.0

package/session.ts

@@ -0,0 +1,119 @@
+// ─────────────────────────────────────────────
+//  log-inject — session.ts
+//  Generates and persists a unique session-id
+//  via localStorage or a non-tracking cookie.
+// ─────────────────────────────────────────────
+
+import { ConsolePatchConfig } from './types';
+
+/** Simple UUID-v4 that works in ES5+ without crypto.randomUUID() */
+function generateId(): string {
+  var template = 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx';
+  return template.replace(/[xy]/g, function (c) {
+    var r = (Math.random() * 16) | 0;
+    var v = c === 'x' ? r : (r & 0x3) | 0x8;
+    return v.toString(16);
+  });
+}
+
+// ── localStorage helpers ──────────────────────────────────────────────────────
+
+function lsGet(key: string): string | null {
+  try {
+    return typeof localStorage !== 'undefined' ? localStorage.getItem(key) : null;
+  } catch (_) {
+    return null;
+  }
+}
+
+function lsSet(key: string, value: string): void {
+  try {
+    if (typeof localStorage !== 'undefined') {
+      localStorage.setItem(key, value);
+    }
+  } catch (_) {
+    /* quota exceeded or private mode — silently ignore */
+  }
+}
+
+// ── Cookie helpers ────────────────────────────────────────────────────────────
+
+function cookieGet(name: string): string | null {
+  try {
+    if (typeof document === 'undefined') return null;
+    var pairs = document.cookie.split(';');
+    for (var i = 0; i < pairs.length; i++) {
+      var pair = pairs[i].trim().split('=');
+      if (pair[0] === name) {
+        return decodeURIComponent(pair[1] || '');
+      }
+    }
+  } catch (_) {
+    /* no cookie access */
+  }
+  return null;
+}
+
+function cookieSet(
+  name: string,
+  value: string,
+  maxAgeDays: number,
+  sameSite: string,
+  secure: boolean
+): void {
+  try {
+    if (typeof document === 'undefined') return;
+    var maxAge = maxAgeDays * 24 * 60 * 60;
+    var parts = [
+      name + '=' + encodeURIComponent(value),
+      'Max-Age=' + maxAge,
+      'SameSite=' + sameSite,
+      'Path=/',
+    ];
+    if (secure) parts.push('Secure');
+    document.cookie = parts.join('; ');
+  } catch (_) {
+    /* silently ignore */
+  }
+}
+
+// ── Public API ────────────────────────────────────────────────────────────────
+
+/**
+ * Resolves the session-id for this browser session.
+ * Creates a new one and persists it if none is found.
+ */
+export function resolveSessionId(config: ConsolePatchConfig): string {
+  var key = config.sessionKey || '__cpoly_sid';
+  var storageType = config.storageType || 'localStorage';
+
+  var existing: string | null = null;
+
+  if (storageType === 'localStorage') {
+    existing = lsGet(key);
+  } else if (storageType === 'cookie') {
+    existing = cookieGet(key);
+  }
+  // 'none' → always generate ephemeral id (not persisted)
+
+  if (existing && existing.length > 0) {
+    return existing;
+  }
+
+  var id = generateId();
+
+  if (storageType === 'localStorage') {
+    lsSet(key, id);
+  } else if (storageType === 'cookie') {
+    var opts = config.cookieOptions || {};
+    cookieSet(
+      key,
+      id,
+      opts.maxAgeDays !== undefined ? opts.maxAgeDays : 365,
+      opts.sameSite || 'Strict',
+      opts.secure || false
+    );
+  }
+
+  return id;
+}

package/transport.ts

@@ -0,0 +1,96 @@
+// ─────────────────────────────────────────────
+//  log-inject — transport.ts
+//  Batched HTTP transport with exponential retry.
+//  Uses fetch() with a synchronous XHR fallback.
+// ─────────────────────────────────────────────
+
+import { LogEntry, ConsolePatchConfig } from './types';
+
+/**
+ * Sends a batch of entries to the configured endpoint.
+ * Returns a promise that resolves when the request completes.
+ * Never rejects — failures are surfaced via onFlushError callback.
+ */
+export function sendBatch(
+  entries: LogEntry[],
+  config: ConsolePatchConfig
+): Promise<void> {
+  var endpoint = config.endpoint;
+  if (!endpoint) return Promise.resolve();
+
+  var body = JSON.stringify({ logs: entries });
+  var headers: Record<string, string> = Object.assign(
+    { 'Content-Type': 'application/json' },
+    config.headers || {}
+  );
+
+  // ── Prefer fetch() ────────────────────────────────────────────────────────
+  if (typeof fetch !== 'undefined') {
+    return fetch(endpoint, {
+      method: 'POST',
+      headers: headers,
+      body: body,
+      // keepalive allows the request to outlive the page — useful for
+      // capturing errors that happen just before navigation.
+      keepalive: true,
+    })
+      .then(function (res) {
+        if (!res.ok) {
+          throw new Error('HTTP ' + res.status + ' from ' + endpoint);
+        }
+        if (config.onFlush) config.onFlush(entries);
+      })
+      .catch(function (err: Error) {
+        if (config.onFlushError) config.onFlushError(err, entries);
+      });
+  }
+
+  // ── XHR fallback (IE 11 / very old browsers) ──────────────────────────────
+  return new Promise<void>(function (resolve) {
+    try {
+      var xhr = new XMLHttpRequest();
+      xhr.open('POST', endpoint as string, true);
+      for (var key in headers) {
+        if (Object.prototype.hasOwnProperty.call(headers, key)) {
+          xhr.setRequestHeader(key, headers[key]);
+        }
+      }
+      xhr.onreadystatechange = function () {
+        if (xhr.readyState !== 4) return;
+        if (xhr.status >= 200 && xhr.status < 300) {
+          if (config.onFlush) config.onFlush(entries);
+        } else {
+          var err = new Error('XHR ' + xhr.status + ' from ' + endpoint);
+          if (config.onFlushError) config.onFlushError(err, entries);
+        }
+        resolve();
+      };
+      xhr.send(body);
+    } catch (e) {
+      if (config.onFlushError) {
+        config.onFlushError(e instanceof Error ? e : new Error(String(e)), entries);
+      }
+      resolve();
+    }
+  });
+}
+
+/**
+ * Uses sendBeacon as a last-resort flush during page unload.
+ * sendBeacon doesn't support custom headers, so this is purely
+ * a best-effort delivery with no auth.
+ */
+export function sendBeaconFallback(
+  entries: LogEntry[],
+  endpoint: string
+): boolean {
+  if (typeof navigator === 'undefined' || !navigator.sendBeacon) return false;
+  try {
+    var blob = new Blob([JSON.stringify({ logs: entries })], {
+      type: 'application/json',
+    });
+    return navigator.sendBeacon(endpoint, blob);
+  } catch (_) {
+    return false;
+  }
+}

package/tsconfig.json

@@ -0,0 +1,30 @@
+{
+  "compilerOptions": {
+    "target": "ES5",
+    "lib": [
+      "ES5",
+      "ES6",
+      "DOM"
+    ],
+    "module": "CommonJS",
+    "outDir": "./dist",
+    "rootDir": "./",
+    "strict": true,
+    "noImplicitAny": true,
+    "strictNullChecks": true,
+    "declaration": true,
+    "declarationMap": true,
+    "sourceMap": true,
+    "removeComments": false,
+    "forceConsistentCasingInFileNames": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true
+  },
+  "include": [
+    "**/*.ts"
+  ],
+  "exclude": [
+    "node_modules",
+    "dist"
+  ]
+}

package/types.ts

@@ -0,0 +1,169 @@
+// ─────────────────────────────────────────────
+//  log-inject — types.ts
+//  All shared type definitions for the polyfill
+// ─────────────────────────────────────────────
+
+/** Every method name that exists on the Console API */
+export type ConsoleMethod =
+  | 'assert'
+  | 'clear'
+  | 'count'
+  | 'countReset'
+  | 'debug'
+  | 'dir'
+  | 'dirxml'
+  | 'error'
+  | 'group'
+  | 'groupCollapsed'
+  | 'groupEnd'
+  | 'info'
+  | 'log'
+  | 'profile'
+  | 'profileEnd'
+  | 'table'
+  | 'time'
+  | 'timeEnd'
+  | 'timeLog'
+  | 'timeStamp'
+  | 'trace'
+  | 'warn';
+
+/** Severity bucket — used for filtering and colouring in the UI */
+export type LogLevel = 'debug' | 'info' | 'warn' | 'error' | 'log';
+
+/** A single captured console call */
+export interface LogEntry {
+  /** Monotonically-increasing id (generated by the polyfill) */
+  id: string;
+  /** Which console method was invoked */
+  method: ConsoleMethod;
+  /** Normalised severity level */
+  level: LogLevel;
+  /** Human-readable timestamp (ISO-8601) */
+  timestamp: string;
+  /** Unix epoch in ms */
+  timestampMs: number;
+  /** Page URL at the time of the call */
+  url: string;
+  /** User-agent string */
+  userAgent: string;
+  /** Unique session identifier (persisted in localStorage or a cookie) */
+  sessionId: string;
+  /**
+   * Serialised arguments.
+   * We intentionally keep these as strings so JSON serialisation is safe.
+   */
+  args: string[];
+  /** Stack-trace, when available */
+  stack?: string;
+  /** For console.group / groupCollapsed — current nesting depth */
+  groupDepth?: number;
+  /** For console.assert — whether the assertion passed */
+  assertionPassed?: boolean;
+  /** For console.count — current counter value */
+  counterValue?: number;
+  /** For console.time / timeEnd / timeLog — timer label */
+  timerLabel?: string;
+  /** For console.timeEnd / timeLog — elapsed ms */
+  timerElapsed?: number;
+}
+
+/** Configuration accepted by ConsolePatch.install() */
+export interface ConsolePatchConfig {
+  /**
+   * Endpoint that receives POST requests with batches of LogEntry objects.
+   * Set to `null` / omit to disable remote shipping entirely.
+   * @default '/api/console-logs'
+   */
+  endpoint?: string | null;
+
+  /**
+   * HTTP headers added to every POST request.
+   * Useful for adding an Authorization header.
+   */
+  headers?: Record<string, string>;
+
+  /**
+   * Methods to intercept. Defaults to ALL known console methods.
+   * Useful to limit noise — e.g. `['error', 'warn']` for production.
+   */
+  methods?: ConsoleMethod[];
+
+  /**
+   * Whether to also forward intercepted calls to the original native
+   * console so they still appear in DevTools.
+   * @default true
+   */
+  passthrough?: boolean;
+
+  /**
+   * Milliseconds to wait before flushing the queue to the backend.
+   * Entries are batched in this window for efficiency.
+   * @default 2000
+   */
+  flushInterval?: number;
+
+  /**
+   * Maximum entries in the in-memory queue before an immediate flush
+   * is triggered (safety valve for burst logging).
+   * @default 50
+   */
+  maxQueueSize?: number;
+
+  /**
+   * Storage key used to persist the session-id.
+   * @default '__cpoly_sid'
+   */
+  sessionKey?: string;
+
+  /**
+   * Storage mechanism for the session-id.
+   * 'localStorage' | 'cookie' | 'none'
+   * @default 'localStorage'
+   */
+  storageType?: 'localStorage' | 'cookie' | 'none';
+
+  /**
+   * Cookie options — only relevant when storageType === 'cookie'.
+   */
+  cookieOptions?: {
+    /** Days until the cookie expires. @default 365 */
+    maxAgeDays?: number;
+    /** SameSite attribute. @default 'Strict' */
+    sameSite?: 'Strict' | 'Lax' | 'None';
+    /** Whether to add the Secure flag. @default false */
+    secure?: boolean;
+    /** Whether to add the HttpOnly flag (not possible via JS — included for docs clarity). */
+    httpOnly?: false;
+  };
+
+  /**
+   * Maximum length (chars) of any single serialised argument.
+   * Longer strings are truncated with a `[truncated]` suffix.
+   * @default 2000
+   */
+  maxArgLength?: number;
+
+  /**
+   * Called after every successful flush to the backend.
+   * Receives the entries that were flushed.
+   */
+  onFlush?: (entries: LogEntry[]) => void;
+
+  /**
+   * Called when a flush fails.
+   */
+  onFlushError?: (error: Error, entries: LogEntry[]) => void;
+}
+
+/** Internal state managed by the patch */
+export interface PatchState {
+  installed: boolean;
+  sessionId: string;
+  queue: LogEntry[];
+  flushTimer: ReturnType<typeof setTimeout> | null;
+  counters: Record<string, number>;
+  timers: Record<string, number>;
+  groupDepth: number;
+  originalMethods: Partial<Record<ConsoleMethod, (...args: unknown[]) => void>>;
+}