@ah-monica/cloudflare 0.1.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,66 @@
+# @ah-monica/cloudflare
+
+Cloudflare WorkersからMONICAへ、捕捉した例外をbest effortで送るadapter。
+Node.js APIへ依存せず、Module Workerの`ExecutionContext.waitUntil()`へ渡せる
+Promiseを提供する。
+
+```ts
+import { createCloudflareClient } from "@ah-monica/cloudflare";
+
+interface Env {
+  MONICA_DSN: string;
+  MONICA_ENVIRONMENT: string;
+  MONICA_RELEASE?: string;
+}
+
+export default {
+  async fetch(request: Request, env: Env, ctx: ExecutionContext): Promise<Response> {
+    try {
+      return await handleRequest(request, env);
+    } catch (error) {
+      const monica = createCloudflareClient({
+        dsn: env.MONICA_DSN,
+        environment: env.MONICA_ENVIRONMENT,
+        release: env.MONICA_RELEASE,
+        beforeSend(item) {
+          // PIIの定義はアプリケーション固有。送信可能な値だけを残す。
+          delete item.user;
+          if (item.request) delete item.request.headers;
+          return item;
+        },
+      });
+
+      monica.captureExceptionInBackground(ctx, error, {
+        tags: { operation: "handle-request" },
+        // URL pathにもPIIが入り得るため、利用側で安全と判断した値だけを渡す。
+        request: { method: request.method, url: new URL(request.url).origin },
+      });
+      return new Response("Internal Server Error", { status: 500 });
+    }
+  },
+};
+```
+
+`captureException()`はcaptureとflushを完了するPromiseを返す。レスポンスを待たせたく
+ないHTTP handlerでは`captureExceptionInBackground(ctx, ...)`を使う。CronやQueueの
+handlerで送信完了を処理結果に含めたい場合は、直接`await`してよい。
+
+```ts
+await monica.captureException(error, { tags: { trigger: "scheduled" } });
+```
+
+## PII方針
+
+SDKは、例外message、stack、request、contextがPIIかどうかを推測せず、自動除去も
+しない。送信値の選択と`beforeSend`での除去は利用アプリケーションの責任。
+MONICAサーバの既知credentialフィルターは防御層であり、任意のPIIが除去される保証
+ではない。
+
+## API keyと環境
+
+`dsn`にはCloudflare secretへ保存したsecret project key（`msk_...`）を使う。
+stagingとproductionではproject、key、`environment`を分離し、package versionは共通で
+よい。secretを`vars`、ソースコード、ログへ置かない。
+
+未捕捉例外をWorkerの外側から網羅的に収集する用途にはTail Workerも検討する。この
+adapterは、アプリケーションが捕捉し、業務contextを選んで送る例外を対象にする。

package/dist/client.d.ts

@@ -0,0 +1,2 @@
+import type { CloudflareClientOptions, MonicaCloudflareClient } from "./types.js";
+export declare function createCloudflareClient(options: CloudflareClientOptions): MonicaCloudflareClient;

package/dist/client.js

@@ -0,0 +1,187 @@
+import { createCoreClient, createFetchTransport, } from "@ah-monica/core";
+const DEFAULT_FLUSH_TIMEOUT_MS = 2_000;
+const DEFAULT_MAX_CAUSE_DEPTH = 10;
+const DEFAULT_MAX_STACK_FRAMES = 200;
+export function createCloudflareClient(options) {
+    assertPositiveInteger("flushTimeoutMs", options.flushTimeoutMs);
+    assertPositiveInteger("maxCauseDepth", options.maxCauseDepth);
+    assertPositiveInteger("maxStackFrames", options.maxStackFrames);
+    const flushTimeoutMs = options.flushTimeoutMs ?? DEFAULT_FLUSH_TIMEOUT_MS;
+    const maxCauseDepth = options.maxCauseDepth ?? DEFAULT_MAX_CAUSE_DEPTH;
+    const maxStackFrames = options.maxStackFrames ?? DEFAULT_MAX_STACK_FRAMES;
+    const core = createCoreClient({
+        transport: createFetchTransport({
+            dsn: options.dsn,
+            auth: "secret",
+            fetch: options.fetch,
+            maxRetries: options.maxRetries ?? 0,
+            requestTimeoutMs: options.requestTimeoutMs,
+        }),
+        environment: options.environment,
+        release: options.release,
+        sampleRate: options.sampleRate,
+        beforeSend: options.beforeSend,
+        sdk: { name: "@ah-monica/cloudflare", version: "0.1.0" },
+    });
+    async function captureAndFlush(input, hint) {
+        try {
+            const eventId = await core.capture(input, hint);
+            if (eventId === null)
+                return null;
+            await core.flush(flushTimeoutMs);
+            return eventId;
+        }
+        catch {
+            // Observability must never make the Worker request fail.
+            return null;
+        }
+    }
+    async function captureException(error, context = {}) {
+        try {
+            const exception = normalizeException(error, maxCauseDepth, maxStackFrames);
+            return await captureAndFlush({
+                type: "error",
+                platform: "javascript",
+                level: context.level ?? "error",
+                message: exception.values[0]?.value,
+                exception,
+                ...contextValues(context),
+            }, { originalException: error });
+        }
+        catch {
+            return null;
+        }
+    }
+    async function captureMessage(message, level = "info", context = {}) {
+        try {
+            return await captureAndFlush({
+                type: "error",
+                platform: "javascript",
+                level,
+                message,
+                ...contextValues(context),
+            });
+        }
+        catch {
+            return null;
+        }
+    }
+    function captureExceptionInBackground(executionContext, error, context) {
+        executionContext.waitUntil(captureException(error, context));
+    }
+    return {
+        captureException,
+        captureMessage,
+        captureExceptionInBackground,
+        flush: core.flush,
+        close: core.close,
+    };
+}
+function contextValues(context) {
+    return {
+        ...(context.user ? { user: { ...context.user } } : {}),
+        ...(context.tags ? { tags: { ...context.tags } } : {}),
+        ...(context.contexts ? { contexts: { ...context.contexts } } : {}),
+        ...(context.breadcrumbs
+            ? { breadcrumbs: context.breadcrumbs.map((breadcrumb) => ({ ...breadcrumb })) }
+            : {}),
+        ...(context.request ? { request: cloneRequest(context.request) } : {}),
+        ...(context.fingerprint ? { fingerprint: [...context.fingerprint] } : {}),
+    };
+}
+function cloneRequest(request) {
+    return {
+        ...request,
+        ...(request.headers ? { headers: { ...request.headers } } : {}),
+    };
+}
+function normalizeException(error, maxCauseDepth, maxStackFrames) {
+    const values = [];
+    const seen = new Set();
+    let current = error;
+    const mechanism = { type: "generic", handled: true };
+    while (current !== undefined &&
+        current !== null &&
+        values.length < maxCauseDepth &&
+        !seen.has(current)) {
+        seen.add(current);
+        if (current instanceof Error) {
+            const frames = parseStack(readErrorString(current, "stack"), maxStackFrames);
+            values.push({
+                type: readErrorString(current, "name") || "Error",
+                value: readErrorString(current, "message") || "Unknown error",
+                ...(frames.length ? { stacktrace: { frames } } : {}),
+                mechanism,
+            });
+            current = readErrorCause(current);
+        }
+        else {
+            values.push({
+                type: typeof current,
+                value: safeString(current),
+                mechanism,
+            });
+            current = undefined;
+        }
+    }
+    if (values.length === 0) {
+        values.push({ type: "Error", value: "Unknown error", mechanism });
+    }
+    return { values };
+}
+function readErrorString(error, key) {
+    try {
+        const value = error[key];
+        return typeof value === "string" ? value : undefined;
+    }
+    catch {
+        return undefined;
+    }
+}
+function readErrorCause(error) {
+    try {
+        return error.cause;
+    }
+    catch {
+        return undefined;
+    }
+}
+function parseStack(stack, maxStackFrames) {
+    if (!stack)
+        return [];
+    const frames = [];
+    for (const line of stack.split("\n").slice(1, maxStackFrames + 1)) {
+        const match = /^\s*at\s+(?:(.*?)\s+\()?(.+?):(\d+):(\d+)\)?$/.exec(line);
+        if (!match?.[2] || !match[3] || !match[4])
+            continue;
+        const filename = match[2];
+        frames.push({
+            filename,
+            in_app: !filename.startsWith("node:") && !/[\\/]node_modules[\\/]/.test(filename),
+            ...(match[1] ? { function: match[1] } : {}),
+            lineno: Number(match[3]),
+            colno: Number(match[4]),
+        });
+    }
+    return frames.reverse();
+}
+function safeString(value) {
+    if (typeof value === "string")
+        return value;
+    try {
+        return JSON.stringify(value) ?? String(value);
+    }
+    catch {
+        try {
+            return String(value);
+        }
+        catch {
+            return "[Unserializable exception]";
+        }
+    }
+}
+function assertPositiveInteger(name, value) {
+    if (value !== undefined && (!Number.isSafeInteger(value) || value <= 0)) {
+        throw new RangeError(`${name} must be a positive integer`);
+    }
+}

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export { createCloudflareClient } from "./client.js";
+export type { CloudflareCaptureContext, CloudflareClientOptions, MonicaCloudflareClient, WaitUntilContext, } from "./types.js";
+export type { BeforeSend, FlushResult, MonicaBreadcrumb, MonicaErrorItem, MonicaItem, MonicaLevel, MonicaRequest, MonicaUser, } from "@ah-monica/core";

package/dist/index.js

@@ -0,0 +1 @@
+export { createCloudflareClient } from "./client.js";

package/dist/types.d.ts

@@ -0,0 +1,40 @@
+import type { BeforeSend, FetchLike, FlushResult, MonicaBreadcrumb, MonicaLevel, MonicaRequest, MonicaUser } from "@ah-monica/core";
+export interface CloudflareClientOptions {
+    dsn: string;
+    environment: string;
+    release?: string;
+    sampleRate?: number;
+    requestTimeoutMs?: number;
+    flushTimeoutMs?: number;
+    maxRetries?: number;
+    maxCauseDepth?: number;
+    maxStackFrames?: number;
+    /**
+     * The application owns PII removal. MONICA does not infer which values are PII.
+     * Return null to discard an event or return a sanitized event to send it.
+     */
+    beforeSend?: BeforeSend;
+    fetch?: FetchLike;
+}
+export interface CloudflareCaptureContext {
+    level?: MonicaLevel;
+    user?: MonicaUser;
+    tags?: Record<string, string>;
+    contexts?: Record<string, unknown>;
+    breadcrumbs?: MonicaBreadcrumb[];
+    request?: MonicaRequest;
+    fingerprint?: string[];
+}
+/** The part of Cloudflare's ExecutionContext used by this adapter. */
+export interface WaitUntilContext {
+    waitUntil(promise: Promise<unknown>): void;
+}
+export interface MonicaCloudflareClient {
+    /** Captures and flushes one exception. Pass this Promise to ctx.waitUntil(). */
+    captureException(error: unknown, context?: CloudflareCaptureContext): Promise<string | null>;
+    captureMessage(message: string, level?: MonicaLevel, context?: Omit<CloudflareCaptureContext, "level">): Promise<string | null>;
+    /** Registers captureException with ctx.waitUntil() without losing its binding. */
+    captureExceptionInBackground(executionContext: WaitUntilContext, error: unknown, context?: CloudflareCaptureContext): void;
+    flush(timeoutMs?: number): Promise<FlushResult>;
+    close(timeoutMs?: number): Promise<FlushResult>;
+}

package/dist/types.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@ah-monica/cloudflare",
+  "version": "0.1.0",
+  "description": "Cloudflare Workers adapter for sending application errors to MONICA",
+  "license": "Apache-2.0",
+  "type": "module",
+  "sideEffects": false,
+  "files": ["dist", "README.md"],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "scripts": {
+    "build": "bun run build:core && tsc -p tsconfig.build.json",
+    "build:core": "bun run --filter @ah-monica/core build",
+    "pack:check": "bun run build && bun pm pack --dry-run",
+    "test": "bun run build:core && bun test",
+    "test:runtime": "bun run build && bun run test/runtime-smoke.ts",
+    "typecheck": "bun run build:core && tsc --noEmit"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Accel-Hack/monica.git",
+    "directory": "sdk/typescript/cloudflare"
+  },
+  "dependencies": {
+    "@ah-monica/core": "0.1.0"
+  },
+  "devDependencies": {
+    "@types/bun": "^1.2.21",
+    "typescript": "^5.9.2",
+    "wrangler": "4.127.0"
+  }
+}