eimer 0.1.1 → 0.2.0

package/dist/esm/tracing/EimerTracer.js

@@ -0,0 +1,55 @@
+import { now } from './now';
+import { MemoryTracerBackend } from './MemoryTracerBackend';
+import { EimerIdGenerator } from '../id-generator/EimerIdGenerator';
+/**
+ * A reference `Tracer` implementation.
+ *
+ * Keeps open spans in memory until they are "end"-ed and then
+ * forwards them to its `TracerBackend`
+ */
+export class EimerTracer {
+    constructor(backend, idGenerator) {
+        this.openSpans = new Map();
+        this.backend = backend ?? new MemoryTracerBackend();
+        this.idGenerator = idGenerator ?? new EimerIdGenerator();
+    }
+    setBackend(backend) {
+        this.backend = backend;
+    }
+    startSpan(name, metadata, parent) {
+        const traceId = parent?.traceId ?? this.idGenerator.generateId();
+        const spanId = this.idGenerator.generateId();
+        this.openSpans.set(spanId, {
+            traceId,
+            spanId,
+            ...(parent?.spanId ? { parentSpanId: parent?.spanId } : {}),
+            name,
+            ...(metadata ? { metadata } : {}),
+            startedAt: now(),
+            durationMs: 0,
+        });
+        return { traceId, spanId };
+    }
+    endSpan(spanId, metadata) {
+        const openSpan = this.openSpans.get(spanId);
+        if (!openSpan) {
+            return;
+        }
+        this.openSpans.delete(spanId);
+        const mergedMetadata = (openSpan.metadata || metadata) ? { ...openSpan.metadata, ...metadata } : undefined;
+        const span = {
+            traceId: openSpan.traceId,
+            spanId,
+            ...(openSpan.parentSpanId ? { parentSpanId: openSpan.parentSpanId } : {}),
+            name: openSpan.name,
+            ...(mergedMetadata ? { metadata: mergedMetadata } : {}),
+            startedAt: openSpan.startedAt,
+            durationMs: now() - openSpan.startedAt,
+        };
+        this.backend.handleSpan(span);
+    }
+    shutdown() {
+        this.backend.shutdown?.();
+    }
+}
+//# sourceMappingURL=EimerTracer.js.map

package/dist/esm/tracing/EimerTracer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EimerTracer.js","sourceRoot":"","sources":["../../../src/tracing/EimerTracer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,OAAO,CAAC;AAC5B,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAE5D,OAAO,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAC;AAQpE;;;;;GAKG;AACH,MAAM,OAAO,WAAW;IAKpB,YAAY,OAAuB,EAAE,WAAyB;QAF7C,cAAS,GAA2B,IAAI,GAAG,EAAE,CAAC;QAG3D,IAAI,CAAC,OAAO,GAAG,OAAO,IAAI,IAAI,mBAAmB,EAAE,CAAC;QACpD,IAAI,CAAC,WAAW,GAAG,WAAW,IAAI,IAAI,gBAAgB,EAAE,CAAC;IAC7D,CAAC;IAED,UAAU,CAAC,OAAsB;QAC7B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IAC3B,CAAC;IAED,SAAS,CAAC,IAAY,EAAE,QAAkC,EAAE,MAAqB;QAC7E,MAAM,OAAO,GAAG,MAAM,EAAE,OAAO,IAAI,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,CAAC;QACjE,MAAM,MAAM,GAAG,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,CAAC;QAC7C,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,EAAE;YACvB,OAAO;YACP,MAAM;YACN,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YAC3D,IAAI;YACJ,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACjC,SAAS,EAAE,GAAG,EAAE;YAChB,UAAU,EAAE,CAAC;SAChB,CAAC,CAAC;QACH,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC;IAC/B,CAAC;IAED,OAAO,CAAC,MAAc,EAAE,QAAkC;QACtD,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAC5C,IAAI,CAAC,QAAQ,EAAE,CAAC;YACZ,OAAO;QACX,CAAC;QACD,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAE9B,MAAM,cAAc,GAAG,CAAC,QAAQ,CAAC,QAAQ,IAAI,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,QAAQ,CAAC,QAAQ,EAAE,GAAG,QAAQ,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QAE3G,MAAM,IAAI,GAAc;YACpB,OAAO,EAAE,QAAQ,CAAC,OAAO;YACzB,MAAM;YACN,GAAG,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,YAAY,EAAE,QAAQ,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACzE,IAAI,EAAE,QAAQ,CAAC,IAAI;YACnB,GAAG,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACvD,SAAS,EAAE,QAAQ,CAAC,SAAS;YAC7B,UAAU,EAAE,GAAG,EAAE,GAAG,QAAQ,CAAC,SAAS;SACzC,CAAC;QACF,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IAClC,CAAC;IAED,QAAQ;QACJ,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC;IAC9B,CAAC;CACJ"}

package/dist/esm/tracing/MemoryTracerBackend.js

@@ -0,0 +1,20 @@
+/**
+ * A `TracerBackend` that stores spans in Memory
+ *
+ * You can extract them with `getRecords`
+ */
+export class MemoryTracerBackend {
+    constructor() {
+        this.spans = [];
+    }
+    handleSpan(span) {
+        this.spans.push(span);
+    }
+    getRecords() {
+        return [...this.spans];
+    }
+    clear() {
+        this.spans.length = 0;
+    }
+}
+//# sourceMappingURL=MemoryTracerBackend.js.map

package/dist/esm/tracing/MemoryTracerBackend.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MemoryTracerBackend.js","sourceRoot":"","sources":["../../../src/tracing/MemoryTracerBackend.ts"],"names":[],"mappings":"AAGA;;;;GAIG;AACH,MAAM,OAAO,mBAAmB;IAAhC;QACqB,UAAK,GAAgB,EAAE,CAAC;IAa7C,CAAC;IAXG,UAAU,CAAC,IAAe;QACtB,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC1B,CAAC;IAED,UAAU;QACN,OAAO,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;IAC3B,CAAC;IAED,KAAK;QACD,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC;IAC1B,CAAC;CACJ"}

package/dist/esm/tracing/NoopTracer.js

@@ -0,0 +1,30 @@
+import { EimerIdGenerator } from '../id-generator/EimerIdGenerator';
+/**
+ * `Tracer` that discards everything except id generation. `startSpan()`
+ * still returns a real, unique id - a message carrying
+ * `collectEimerTraces: true` through a node with a `NoopTracer` must not
+ * collide with `spanId`s minted by a real `Tracer` elsewhere on the mesh.
+ * The default whenever no `Tracer` is configured, so instrumented call sites
+ * never need to branch on whether one is.
+ */
+export class NoopTracer {
+    constructor(idGenerator) {
+        this.idGenerator = idGenerator ?? new EimerIdGenerator();
+    }
+    setBackend() {
+        // no-op
+    }
+    startSpan() {
+        return this.idGenerator.generateId();
+    }
+    startTrace() {
+        return { traceId: this.idGenerator.generateId(), spanId: this.idGenerator.generateId() };
+    }
+    endSpan() {
+        // no-op
+    }
+    shutdown() {
+        // no-op
+    }
+}
+//# sourceMappingURL=NoopTracer.js.map

package/dist/esm/tracing/NoopTracer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"NoopTracer.js","sourceRoot":"","sources":["../../../src/tracing/NoopTracer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAC;AAMpE;;;;;;;GAOG;AACH,MAAM,OAAO,UAAU;IAGnB,YAAY,WAAyB;QACjC,IAAI,CAAC,WAAW,GAAG,WAAW,IAAI,IAAI,gBAAgB,EAAE,CAAC;IAC7D,CAAC;IAED,UAAU;QACN,QAAQ;IACZ,CAAC;IAED,SAAS;QACL,OAAO,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,CAAC;IACzC,CAAC;IAED,UAAU;QACN,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,EAAE,CAAC;IAC7F,CAAC;IAED,OAAO;QACH,QAAQ;IACZ,CAAC;IAED,QAAQ;QACJ,QAAQ;IACZ,CAAC;CACJ"}

package/dist/esm/tracing/index.js

@@ -0,0 +1,9 @@
+export * from './ConsoleLoggingTracerBackend';
+export * from './EimerLoggerTracerBackend';
+export * from './EimerPublishingTracerBackend';
+export * from './EimerTracer';
+export * from './EimerTraceSubscriber';
+export * from './MemoryTracerBackend';
+export * from './EimerNoopTracer';
+export * from './now';
+//# sourceMappingURL=index.js.map

package/dist/esm/tracing/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/tracing/index.ts"],"names":[],"mappings":"AAAA,cAAc,+BAA+B,CAAC;AAC9C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,eAAe,CAAC;AAC9B,cAAc,wBAAwB,CAAC;AACvC,cAAc,uBAAuB,CAAC;AACtC,cAAc,mBAAmB,CAAC;AAClC,cAAc,OAAO,CAAC"}

package/dist/esm/tracing/now.js

@@ -0,0 +1,11 @@
+/**
+ * Returns a timestamp (milliseconds since the Unix epoch) accurate enough for trace timing
+ *
+ * `Date.now()` is low-resolution and affected by adjustments of the system clock.
+ *
+ * Therefore we use `performance.now()` and add `performance.timeOrigin` to make it comparable across processes.
+ */
+export function now() {
+    return performance.timeOrigin + performance.now();
+}
+//# sourceMappingURL=now.js.map

package/dist/esm/tracing/now.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"now.js","sourceRoot":"","sources":["../../../src/tracing/now.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,MAAM,UAAU,GAAG;IACf,OAAO,WAAW,CAAC,UAAU,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;AACtD,CAAC"}

package/dist/esm/transports/EimerUtilityProcessTransport.js

@@ -1,4 +1,32 @@
+import { EimerMessage } from '../eimer/EimerMessage';
 import { EimerMessagePortTransport } from './EimerMessagePortTransport';
+/**
+ * Wraps a `UtilityProcessPort` so that `'message'` listeners always receive the
+ * raw eimer message, regardless of whether the underlying port delivers it directly
+ * (`Electron.UtilityProcess`) or wrapped in a `MessageEvent` (`Electron.ParentPort`).
+ */
+class MessageEventUnwrappingPort {
+    constructor(port) {
+        this.port = port;
+    }
+    postMessage(message) {
+        this.port.postMessage(message);
+    }
+    on(event, handler) {
+        this.port.on(event, (received) => {
+            if (!EimerMessage.isEimerMessage(received) && received !== null && typeof received === 'object' && 'data' in received) {
+                handler(received.data);
+                return;
+            }
+            handler(received);
+        });
+        return this;
+    }
+    off(event, handler) {
+        this.port.off?.(event, handler);
+        return this;
+    }
+}
 /**
  * Eimer UtilityProcess Transport
  *
@@ -9,7 +37,7 @@ import { EimerMessagePortTransport } from './EimerMessagePortTransport';
  */
 export class EimerUtilityProcessTransport extends EimerMessagePortTransport {
     constructor(port, options, dependencies) {
-        super(port, { ...options, logModuleName: options?.logModuleName ?? 'EimerUtilityProcessTransport' }, dependencies);
+        super(new MessageEventUnwrappingPort(port), { ...options, logModuleName: options?.logModuleName ?? 'EimerUtilityProcessTransport' }, dependencies);
     }
 }
 //# sourceMappingURL=EimerUtilityProcessTransport.js.map

package/dist/esm/transports/EimerUtilityProcessTransport.js.map

@@ -1 +1 @@
-{"version":3,"file":"EimerUtilityProcessTransport.js","sourceRoot":"","sources":["../../../src/transports/EimerUtilityProcessTransport.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,yBAAyB,EAAwF,MAAM,6BAA6B,CAAC;AAoB9J;;;;;;;GAOG;AACH,MAAM,OAAO,4BAA6B,SAAQ,yBAAyB;IACvE,YAAY,IAAwB,EAAE,OAA6C,EAAE,YAAuD;QACxI,KAAK,CAAC,IAAmB,EAAE,EAAE,GAAG,OAAO,EAAE,aAAa,EAAE,OAAO,EAAE,aAAa,IAAI,8BAA8B,EAAE,EAAE,YAAY,CAAC,CAAC;IACtI,CAAC;CACJ"}
+{"version":3,"file":"EimerUtilityProcessTransport.js","sourceRoot":"","sources":["../../../src/transports/EimerUtilityProcessTransport.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAErD,OAAO,EAAE,yBAAyB,EAAwF,MAAM,6BAA6B,CAAC;AAuB9J;;;;GAIG;AACH,MAAM,0BAA0B;IAC5B,YAA6B,IAAwB;QAAxB,SAAI,GAAJ,IAAI,CAAoB;IAAG,CAAC;IAEzD,WAAW,CAAC,OAAY;QACpB,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IACnC,CAAC;IAED,EAAE,CAAC,KAAgB,EAAE,OAA+B;QAChD,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,KAAK,EAAE,CAAC,QAAa,EAAQ,EAAE;YACxC,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,QAAQ,KAAK,IAAI,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,MAAM,IAAI,QAAQ,EAAE,CAAC;gBACpH,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;gBACvB,OAAO;YACX,CAAC;YACD,OAAO,CAAC,QAAQ,CAAC,CAAC;QACtB,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,GAAG,CAAC,KAAgB,EAAE,OAA+B;QACjD,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;QAChC,OAAO,IAAI,CAAC;IAChB,CAAC;CACJ;AAED;;;;;;;GAOG;AACH,MAAM,OAAO,4BAA6B,SAAQ,yBAAyB;IACvE,YAAY,IAAwB,EAAE,OAA6C,EAAE,YAAuD;QACxI,KAAK,CAAC,IAAI,0BAA0B,CAAC,IAAI,CAAgB,EAAE,EAAE,GAAG,OAAO,EAAE,aAAa,EAAE,OAAO,EAAE,aAAa,IAAI,8BAA8B,EAAE,EAAE,YAAY,CAAC,CAAC;IACtK,CAAC;CACJ"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eimer",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "description": "Electron Interprocess MEssage Router - IPC library for Electron.js",
   "author": "Jan Hapke (https://janhapke.com)",
   "license": "MIT",
@@ -24,6 +24,7 @@
     "nodejs",
     "eimerjs"
   ],
+  "sideEffects": false,
   "main": "./dist/cjs/index.js",
   "module": "./dist/esm/index.js",
   "types": "./dist/cjs/index.d.ts",
@@ -32,6 +33,18 @@
       "types": "./dist/cjs/index.d.ts",
       "import": "./dist/esm/index.js",
       "require": "./dist/cjs/index.js"
+    },
+    "./tracing": {
+      "types": "./dist/cjs/tracing/index.d.ts",
+      "import": "./dist/esm/tracing/index.js",
+      "require": "./dist/cjs/tracing/index.js"
+    }
+  },
+  "typesVersions": {
+    "*": {
+      "tracing": [
+        "./dist/cjs/tracing/index.d.ts"
+      ]
     }
   },
   "files": [
@@ -41,6 +54,7 @@
     "build": "npm run build:cjs && npm run build:esm",
     "build:cjs": "tsc -p tsconfig.cjs.json",
     "build:esm": "tsc -p tsconfig.esm.json",
+    "typecheck": "tsc -p tsconfig.cjs.json --noEmit",
     "test": "vitest run",
     "test-coverage": "vitest run --coverage",
     "clean": "rm -rf dist"