@logtape/sentry 0.1.0-dev.3

package/LICENSE

@@ -0,0 +1,20 @@
+MIT License
+
+Copyright 2024 Hong Minhee
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,86 @@
+@logtape/sentry: LogTape Sentry Sink
+====================================
+
+[![JSR][JSR badge]][JSR]
+[![npm][npm badge]][npm]
+[![GitHub Actions][GitHub Actions badge]][GitHub Actions]
+
+This package provides an [Sentry] sink for [LogTape]. It allows you to
+capture your LogTape logs and send them to Sentry.
+
+![LogTape messages show up in Sentry](./screenshot.png)
+
+[JSR]: https://jsr.io/@logtape/sentry
+[JSR badge]: https://jsr.io/badges/@logtape/sentry
+[npm]: https://www.npmjs.com/package/@logtape/sentry
+[npm badge]: https://img.shields.io/npm/v/@logtape/sentry?logo=npm
+[GitHub Actions]: https://github.com/dahlia/logtape-sentry/actions/workflows/main.yaml
+[GitHub Actions badge]: https://github.com/dahlia/logtape-sentry/actions/workflows/main.yaml/badge.svg
+[Sentry]: https://sentry.io/
+[LogTape]: https://logtape.org/
+
+
+Installation
+------------
+
+The package is available on [JSR] and [npm].
+
+~~~~ bash
+deno add @logtape/sentry # for Deno
+npm add @logtape/sentry  # for npm
+pnpm add @logtape/sentry # for pnpm
+yarn add @logtape/sentry # for Yarn
+bun add @logtape/sentry  # for Bun
+~~~~
+
+
+Usage
+-----
+
+The quickest way to get started is to use the `getSentrySink()` function
+without any arguments:
+
+~~~~ typescript
+import { configure } from "@logtape/logtape";
+import { getSentrySink } from "@logtape/sentry";
+
+await configure({
+  sinks: {
+    sentry: getSentrySink(),
+  },
+  filters: {},
+  loggers: [
+    { category: [], sinks: ["sentry"], level: "debug" },
+  ],
+});
+~~~~
+
+If you want to explicitly configure the Sentry client, you can pass the
+`Client` instance to the `getSentrySink()` function:
+
+~~~~ typescript
+import { configure } from "@logtape/logtape";
+import { init } from "@sentry/node";
+
+const client = init({
+  dsn: process.env.SENTRY_DSN,
+});
+
+await configure({
+  sinks: {
+    sentry: getSentrySink(client),
+  },
+  filters: {},
+  loggers: [
+    { category: [], sinks: ["sentry"], level: "debug" },
+  ],
+});
+~~~~
+
+
+Changelog
+---------
+
+### Version 0.1.0
+
+To be released.

package/esm/_dnt.shims.js

@@ -0,0 +1,57 @@
+const dntGlobals = {};
+export const dntGlobalThis = createMergeProxy(globalThis, dntGlobals);
+function createMergeProxy(baseObj, extObj) {
+    return new Proxy(baseObj, {
+        get(_target, prop, _receiver) {
+            if (prop in extObj) {
+                return extObj[prop];
+            }
+            else {
+                return baseObj[prop];
+            }
+        },
+        set(_target, prop, value) {
+            if (prop in extObj) {
+                delete extObj[prop];
+            }
+            baseObj[prop] = value;
+            return true;
+        },
+        deleteProperty(_target, prop) {
+            let success = false;
+            if (prop in extObj) {
+                delete extObj[prop];
+                success = true;
+            }
+            if (prop in baseObj) {
+                delete baseObj[prop];
+                success = true;
+            }
+            return success;
+        },
+        ownKeys(_target) {
+            const baseKeys = Reflect.ownKeys(baseObj);
+            const extKeys = Reflect.ownKeys(extObj);
+            const extKeysSet = new Set(extKeys);
+            return [...baseKeys.filter((k) => !extKeysSet.has(k)), ...extKeys];
+        },
+        defineProperty(_target, prop, desc) {
+            if (prop in extObj) {
+                delete extObj[prop];
+            }
+            Reflect.defineProperty(baseObj, prop, desc);
+            return true;
+        },
+        getOwnPropertyDescriptor(_target, prop) {
+            if (prop in extObj) {
+                return Reflect.getOwnPropertyDescriptor(extObj, prop);
+            }
+            else {
+                return Reflect.getOwnPropertyDescriptor(baseObj, prop);
+            }
+        },
+        has(_target, prop) {
+            return prop in extObj || prop in baseObj;
+        },
+    });
+}

package/esm/mod.js

@@ -0,0 +1,58 @@
+import * as dntShim from "./_dnt.shims.js";
+import { getClient } from "@sentry/core";
+function getParameterizedString(record) {
+    let result = "";
+    let tplString = "";
+    const tplValues = [];
+    for (let i = 0; i < record.message.length; i++) {
+        if (i % 2 === 0) {
+            result += record.message[i];
+            tplString += String(record.message[i]).replaceAll("%", "%%");
+        }
+        else {
+            const value = inspect(record.message[i]);
+            result += value;
+            tplString += `%s`;
+            tplValues.push(value);
+        }
+    }
+    const paramStr = new String(result);
+    paramStr.__sentry_template_string__ = tplString;
+    paramStr.__sentry_template_values__ = tplValues;
+    return result;
+}
+/**
+ * A platform-specific inspect function.  In Deno, this is {@link Deno.inspect},
+ * and in Node.js/Bun it is {@link util.inspect}.  If neither is available, it
+ * falls back to {@link JSON.stringify}.
+ *
+ * @param value The value to inspect.
+ * @returns The string representation of the value.
+ */
+const inspect = 
+// @ts-ignore: Deno global
+"Deno" in dntShim.dntGlobalThis && "inspect" in globalThis.Deno &&
+    // @ts-ignore: Deno global
+    typeof globalThis.Deno.inspect === "function"
+    // @ts-ignore: Deno global
+    ? globalThis.Deno.inspect
+    // @ts-ignore: Node.js global
+    : "util" in dntShim.dntGlobalThis && "inspect" in globalThis.util &&
+        // @ts-ignore: Node.js global
+        globalThis.util.inspect === "function"
+        // @ts-ignore: Node.js global
+        ? globalThis.util.inspect
+        : JSON.stringify;
+/**
+ * Gets a LogTape sink that sends logs to Sentry.
+ * @param client The Sentry client.  If omitted, the global default client is
+ *               used.
+ * @returns A LogTape sink that sends logs to Sentry.
+ */
+export function getSentrySink(client) {
+    return (record) => {
+        if (client == null)
+            client = getClient();
+        client?.captureMessage(getParameterizedString(record), record.level, { data: record.properties });
+    };
+}

package/esm/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@logtape/sentry",
+  "version": "0.1.0-dev.3+ff41ddb4",
+  "description": "LogTape Sentry Sink",
+  "keywords": [
+    "LogTape",
+    "Sentry"
+  ],
+  "author": {
+    "name": "Hong Minhee",
+    "email": "hong@minhee.org",
+    "url": "https://hongminhee.org/"
+  },
+  "homepage": "https://github.com/dahlia/logtape-sentry",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/dahlia/logtape-sentry.git"
+  },
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/dahlia/logtape-sentry/issues"
+  },
+  "main": "./script/mod.js",
+  "module": "./esm/mod.js",
+  "types": "./types/mod.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./types/mod.d.ts",
+        "default": "./esm/mod.js"
+      },
+      "require": {
+        "types": "./types/mod.d.ts",
+        "default": "./script/mod.js"
+      }
+    }
+  },
+  "scripts": {
+    "test": "node test_runner.js"
+  },
+  "funding": [
+    "https://github.com/sponsors/dahlia"
+  ],
+  "dependencies": {
+    "@logtape/logtape": "^0.8.0",
+    "@sentry/core": "^8.40.0",
+    "@sentry/types": "^8.40.0"
+  },
+  "devDependencies": {
+    "@types/node": "^20.9.0",
+    "picocolors": "^1.0.0"
+  },
+  "_generatedBy": "dnt@dev"
+}

package/script/_dnt.shims.js

@@ -0,0 +1,60 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.dntGlobalThis = void 0;
+const dntGlobals = {};
+exports.dntGlobalThis = createMergeProxy(globalThis, dntGlobals);
+function createMergeProxy(baseObj, extObj) {
+    return new Proxy(baseObj, {
+        get(_target, prop, _receiver) {
+            if (prop in extObj) {
+                return extObj[prop];
+            }
+            else {
+                return baseObj[prop];
+            }
+        },
+        set(_target, prop, value) {
+            if (prop in extObj) {
+                delete extObj[prop];
+            }
+            baseObj[prop] = value;
+            return true;
+        },
+        deleteProperty(_target, prop) {
+            let success = false;
+            if (prop in extObj) {
+                delete extObj[prop];
+                success = true;
+            }
+            if (prop in baseObj) {
+                delete baseObj[prop];
+                success = true;
+            }
+            return success;
+        },
+        ownKeys(_target) {
+            const baseKeys = Reflect.ownKeys(baseObj);
+            const extKeys = Reflect.ownKeys(extObj);
+            const extKeysSet = new Set(extKeys);
+            return [...baseKeys.filter((k) => !extKeysSet.has(k)), ...extKeys];
+        },
+        defineProperty(_target, prop, desc) {
+            if (prop in extObj) {
+                delete extObj[prop];
+            }
+            Reflect.defineProperty(baseObj, prop, desc);
+            return true;
+        },
+        getOwnPropertyDescriptor(_target, prop) {
+            if (prop in extObj) {
+                return Reflect.getOwnPropertyDescriptor(extObj, prop);
+            }
+            else {
+                return Reflect.getOwnPropertyDescriptor(baseObj, prop);
+            }
+        },
+        has(_target, prop) {
+            return prop in extObj || prop in baseObj;
+        },
+    });
+}

package/script/mod.js

@@ -0,0 +1,84 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getSentrySink = getSentrySink;
+const dntShim = __importStar(require("./_dnt.shims.js"));
+const core_1 = require("@sentry/core");
+function getParameterizedString(record) {
+    let result = "";
+    let tplString = "";
+    const tplValues = [];
+    for (let i = 0; i < record.message.length; i++) {
+        if (i % 2 === 0) {
+            result += record.message[i];
+            tplString += String(record.message[i]).replaceAll("%", "%%");
+        }
+        else {
+            const value = inspect(record.message[i]);
+            result += value;
+            tplString += `%s`;
+            tplValues.push(value);
+        }
+    }
+    const paramStr = new String(result);
+    paramStr.__sentry_template_string__ = tplString;
+    paramStr.__sentry_template_values__ = tplValues;
+    return result;
+}
+/**
+ * A platform-specific inspect function.  In Deno, this is {@link Deno.inspect},
+ * and in Node.js/Bun it is {@link util.inspect}.  If neither is available, it
+ * falls back to {@link JSON.stringify}.
+ *
+ * @param value The value to inspect.
+ * @returns The string representation of the value.
+ */
+const inspect = 
+// @ts-ignore: Deno global
+"Deno" in dntShim.dntGlobalThis && "inspect" in globalThis.Deno &&
+    // @ts-ignore: Deno global
+    typeof globalThis.Deno.inspect === "function"
+    // @ts-ignore: Deno global
+    ? globalThis.Deno.inspect
+    // @ts-ignore: Node.js global
+    : "util" in dntShim.dntGlobalThis && "inspect" in globalThis.util &&
+        // @ts-ignore: Node.js global
+        globalThis.util.inspect === "function"
+        // @ts-ignore: Node.js global
+        ? globalThis.util.inspect
+        : JSON.stringify;
+/**
+ * Gets a LogTape sink that sends logs to Sentry.
+ * @param client The Sentry client.  If omitted, the global default client is
+ *               used.
+ * @returns A LogTape sink that sends logs to Sentry.
+ */
+function getSentrySink(client) {
+    return (record) => {
+        if (client == null)
+            client = (0, core_1.getClient)();
+        client?.captureMessage(getParameterizedString(record), record.level, { data: record.properties });
+    };
+}

package/script/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "commonjs"
+}

package/types/_dnt.shims.d.ts

@@ -0,0 +1,2 @@
+export declare const dntGlobalThis: Omit<typeof globalThis, never>;
+//# sourceMappingURL=_dnt.shims.d.ts.map

package/types/_dnt.shims.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"_dnt.shims.d.ts","sourceRoot":"","sources":["../src/_dnt.shims.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,aAAa,gCAA2C,CAAC"}

package/types/mod.d.ts

@@ -0,0 +1,11 @@
+import type { Sink } from "@logtape/logtape";
+import { type BaseClient } from "@sentry/core";
+import type { ClientOptions } from "@sentry/types";
+/**
+ * Gets a LogTape sink that sends logs to Sentry.
+ * @param client The Sentry client.  If omitted, the global default client is
+ *               used.
+ * @returns A LogTape sink that sends logs to Sentry.
+ */
+export declare function getSentrySink(client?: BaseClient<ClientOptions>): Sink;
+//# sourceMappingURL=mod.d.ts.map

package/types/mod.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../src/mod.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAa,IAAI,EAAE,MAAM,kBAAkB,CAAC;AACxD,OAAO,EAAE,KAAK,UAAU,EAAa,MAAM,cAAc,CAAC;AAC1D,OAAO,KAAK,EAAE,aAAa,EAAuB,MAAM,eAAe,CAAC;AAgDxE;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC,aAAa,CAAC,GAAG,IAAI,CAStE"}