rian 0.0.5 → 0.2.1

package/index.js

@@ -1,132 +1,76 @@
-'use strict';
-
-const package_json = require('rian/package.json');
+// src/index.ts
+const { name:rian_name, version:rian_version } = require('rian/package.json');
 const tctx = require('tctx');
-
-function _interopNamespace(e) {
-	if (e && e.__esModule) return e;
-	const n = Object.create(null);
-	if (e) {
-		for (const k in e) {
-			if (k !== 'default') {
-				const d = Object.getOwnPropertyDescriptor(e, k);
-				Object.defineProperty(n, k, d.get ? d : {
-					enumerable: true,
-					get: function () { return e[k]; }
-				});
-			}
-		}
-	}
-	n["default"] = e;
-	return n;
-}
-
-const tctx__namespace = /*#__PURE__*/_interopNamespace(tctx);
-
-const set_error = (scope, error) => {
-    scope.set_context({
-        error,
-    });
+const { measureFn } = require('rian/utils');
+var PROMISES = /* @__PURE__ */ new WeakMap();
+var ADD_PROMISE = (scope, promise) => {
+  if (PROMISES.has(scope))
+    PROMISES.get(scope).push(promise);
+  else
+    PROMISES.set(scope, [promise]);
 };
-const measure = (fn, // TODO: fn doesnt see scope correctly
-scope, promises, ...args) => {
-    try {
-        var r = fn(...args, scope), is_promise = r instanceof Promise;
-        if (is_promise)
-            promises.push(r
-                .catch((e) => void set_error(scope, e))
-                .finally(() => scope.end()));
-        return r;
-    }
-    catch (e) {
-        set_error(scope, e);
-        throw e;
-    }
-    finally {
-        if (is_promise !== true)
-            scope.end();
-    }
+var defaultSampler = (_name, parentId) => {
+  if (!parentId)
+    return true;
+  return tctx.is_sampled(parentId);
 };
-
-// ==> impl
-/**
- * The default sampler;
- *
- * If no parent
- * ~> sample
- * if parent was off
- * ~> never sample
- * if parent was on
- * ~> always sample
- */
-const defaultSampler = (_name, parentId) => {
-    if (!parentId)
-        return true;
-    return tctx__namespace.is_sampled(parentId);
+var sdk_object = {
+  "telemetry.sdk.name": rian_name,
+  "telemetry.sdk.version": rian_version
 };
-const sdk_object = {
-    'telemetry.sdk.name': package_json.name,
-    'telemetry.sdk.version': package_json.version,
-};
-const create = (name, options) => {
-    const spans = new Set();
-    const promises = [];
-    const sampler = options.sampler || defaultSampler;
-    const sampler_callable = typeof sampler !== 'boolean';
-    const span = (name, parent) => {
-        const should_sample = sampler_callable
-            ? sampler(name, parent, options.context)
-            : sampler;
-        const id = parent
-            ? parent.child(should_sample)
-            : tctx__namespace.make(should_sample);
-        const span_obj = {
-            id,
-            parent,
-            start: Date.now(),
-            name,
-            events: [],
-            context: {},
-        };
-        if (should_sample)
-            spans.add(span_obj);
-        const $ = (cb) => measure(cb, $, promises);
-        $.traceparent = id;
-        $.fork = (name) => span(name, id);
-        $.measure = (name, cb, ...args) => measure(cb, span(name, id), promises, ...args);
-        $.set_context = (ctx) => {
-            if (typeof ctx === 'function')
-                return void (span_obj.context = ctx(span_obj.context));
-            Object.assign(span_obj.context, ctx);
-        };
-        $.add_event = (name, attributes) => {
-            span_obj.events.push({
-                name,
-                timestamp: Date.now(),
-                attributes: attributes || {},
-            });
-        };
-        $.end = () => {
-            if (span_obj.end)
-                return void 0;
-            span_obj.end = Date.now();
-        };
-        return $;
+var create = (name, options) => {
+  const spans = /* @__PURE__ */ new Set();
+  const sampler = options.sampler || defaultSampler;
+  const sampler_callable = typeof sampler !== "boolean";
+  const span = (name2, parent) => {
+    const should_sample = sampler_callable ? sampler(name2, parent, options.context) : sampler;
+    const id = parent ? parent.child(should_sample) : tctx.make(should_sample);
+    const span_obj = {
+      id,
+      parent,
+      start: Date.now(),
+      name: name2,
+      events: [],
+      context: {}
+    };
+    if (should_sample)
+      spans.add(span_obj);
+    const $ = (cb) => measureFn($, cb);
+    $.traceparent = id;
+    $.fork = (name3) => span(name3, id);
+    $.set_context = (ctx) => {
+      if (typeof ctx === "function")
+        return void (span_obj.context = ctx(span_obj.context));
+      Object.assign(span_obj.context, ctx);
+    };
+    $.add_event = (name3, attributes) => {
+      span_obj.events.push({
+        name: name3,
+        timestamp: Date.now(),
+        attributes: attributes || {}
+      });
     };
-    const root = span(name, typeof options.traceparent === 'string'
-        ? tctx__namespace.parse(options.traceparent)
-        : undefined);
-    const endRoot = root.end.bind(root);
-    root.end = async () => {
-        endRoot();
-        if (promises.length)
-            await Promise.all(promises);
-        return options.exporter(spans, {
-            ...(options.context || {}),
-            ...sdk_object,
-        });
+    $.end = () => {
+      if (span_obj.end == null)
+        span_obj.end = Date.now();
     };
-    return root;
+    return $;
+  };
+  const root = span(name, typeof options.traceparent === "string" ? tctx.parse(options.traceparent) : void 0);
+  const endRoot = root.end.bind(root);
+  root.end = async () => {
+    endRoot();
+    if (PROMISES.has(root))
+      await Promise.all(PROMISES.get(root));
+    return options.exporter(spans, {
+      ...options.context || {},
+      ...sdk_object
+    });
+  };
+  return root;
 };
 
-exports.create = create;
+
+exports.ADD_PROMISE = ADD_PROMISE;
+exports.PROMISES = PROMISES;
+exports.create = create;

package/index.mjs

@@ -1,110 +1,76 @@
-import { name, version } from 'rian/package.json';
-import * as tctx from 'tctx';
-
-const set_error = (scope, error) => {
-    scope.set_context({
-        error,
-    });
-};
-const measure = (fn, // TODO: fn doesnt see scope correctly
-scope, promises, ...args) => {
-    try {
-        var r = fn(...args, scope), is_promise = r instanceof Promise;
-        if (is_promise)
-            promises.push(r
-                .catch((e) => void set_error(scope, e))
-                .finally(() => scope.end()));
-        return r;
-    }
-    catch (e) {
-        set_error(scope, e);
-        throw e;
-    }
-    finally {
-        if (is_promise !== true)
-            scope.end();
-    }
+// src/index.ts
+import { name as rian_name, version as rian_version } from "rian/package.json";
+import * as tctx from "tctx";
+import { measureFn } from "rian/utils";
+var PROMISES = /* @__PURE__ */ new WeakMap();
+var ADD_PROMISE = (scope, promise) => {
+  if (PROMISES.has(scope))
+    PROMISES.get(scope).push(promise);
+  else
+    PROMISES.set(scope, [promise]);
 };
-
-// ==> impl
-/**
- * The default sampler;
- *
- * If no parent
- * ~> sample
- * if parent was off
- * ~> never sample
- * if parent was on
- * ~> always sample
- */
-const defaultSampler = (_name, parentId) => {
-    if (!parentId)
-        return true;
-    return tctx.is_sampled(parentId);
+var defaultSampler = (_name, parentId) => {
+  if (!parentId)
+    return true;
+  return tctx.is_sampled(parentId);
 };
-const sdk_object = {
-    'telemetry.sdk.name': name,
-    'telemetry.sdk.version': version,
+var sdk_object = {
+  "telemetry.sdk.name": rian_name,
+  "telemetry.sdk.version": rian_version
 };
-const create = (name, options) => {
-    const spans = new Set();
-    const promises = [];
-    const sampler = options.sampler || defaultSampler;
-    const sampler_callable = typeof sampler !== 'boolean';
-    const span = (name, parent) => {
-        const should_sample = sampler_callable
-            ? sampler(name, parent, options.context)
-            : sampler;
-        const id = parent
-            ? parent.child(should_sample)
-            : tctx.make(should_sample);
-        const span_obj = {
-            id,
-            parent,
-            start: Date.now(),
-            name,
-            events: [],
-            context: {},
-        };
-        if (should_sample)
-            spans.add(span_obj);
-        const $ = (cb) => measure(cb, $, promises);
-        $.traceparent = id;
-        $.fork = (name) => span(name, id);
-        $.measure = (name, cb, ...args) => measure(cb, span(name, id), promises, ...args);
-        $.set_context = (ctx) => {
-            if (typeof ctx === 'function')
-                return void (span_obj.context = ctx(span_obj.context));
-            Object.assign(span_obj.context, ctx);
-        };
-        $.add_event = (name, attributes) => {
-            span_obj.events.push({
-                name,
-                timestamp: Date.now(),
-                attributes: attributes || {},
-            });
-        };
-        $.end = () => {
-            if (span_obj.end)
-                return void 0;
-            span_obj.end = Date.now();
-        };
-        return $;
+var create = (name, options) => {
+  const spans = /* @__PURE__ */ new Set();
+  const sampler = options.sampler || defaultSampler;
+  const sampler_callable = typeof sampler !== "boolean";
+  const span = (name2, parent) => {
+    const should_sample = sampler_callable ? sampler(name2, parent, options.context) : sampler;
+    const id = parent ? parent.child(should_sample) : tctx.make(should_sample);
+    const span_obj = {
+      id,
+      parent,
+      start: Date.now(),
+      name: name2,
+      events: [],
+      context: {}
+    };
+    if (should_sample)
+      spans.add(span_obj);
+    const $ = (cb) => measureFn($, cb);
+    $.traceparent = id;
+    $.fork = (name3) => span(name3, id);
+    $.set_context = (ctx) => {
+      if (typeof ctx === "function")
+        return void (span_obj.context = ctx(span_obj.context));
+      Object.assign(span_obj.context, ctx);
     };
-    const root = span(name, typeof options.traceparent === 'string'
-        ? tctx.parse(options.traceparent)
-        : undefined);
-    const endRoot = root.end.bind(root);
-    root.end = async () => {
-        endRoot();
-        if (promises.length)
-            await Promise.all(promises);
-        return options.exporter(spans, {
-            ...(options.context || {}),
-            ...sdk_object,
-        });
+    $.add_event = (name3, attributes) => {
+      span_obj.events.push({
+        name: name3,
+        timestamp: Date.now(),
+        attributes: attributes || {}
+      });
     };
-    return root;
+    $.end = () => {
+      if (span_obj.end == null)
+        span_obj.end = Date.now();
+    };
+    return $;
+  };
+  const root = span(name, typeof options.traceparent === "string" ? tctx.parse(options.traceparent) : void 0);
+  const endRoot = root.end.bind(root);
+  root.end = async () => {
+    endRoot();
+    if (PROMISES.has(root))
+      await Promise.all(PROMISES.get(root));
+    return options.exporter(spans, {
+      ...options.context || {},
+      ...sdk_object
+    });
+  };
+  return root;
+};
+export {
+  ADD_PROMISE,
+  PROMISES,
+  create
 };
-
-export { create };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "rian",
-	"version": "0.0.5",
+	"version": "0.2.1",
 	"description": "Effective tracing for the edge and origins",
 	"keywords": [
 		"opentelemetry",
@@ -26,16 +26,24 @@
 	"type": "module",
 	"exports": {
 		".": {
+			"types": "./index.d.ts",
 			"import": "./index.mjs",
 			"require": "./index.js"
 		},
 		"./exporter.otel.http": {
-			"import": "./exporter.otel.http.mjs",
-			"require": "./exporter.otel.http.js"
+			"types": "./exporter.otel.http/index.d.ts",
+			"import": "./exporter.otel.http/index.mjs",
+			"require": "./exporter.otel.http/index.js"
 		},
 		"./exporter.zipkin": {
-			"import": "./exporter.zipkin.mjs",
-			"require": "./exporter.zipkin.js"
+			"types": "./exporter.zipkin/index.d.ts",
+			"import": "./exporter.zipkin/index.mjs",
+			"require": "./exporter.zipkin/index.js"
+		},
+		"./utils": {
+			"types": "./utils/index.d.ts",
+			"import": "./utils/index.mjs",
+			"require": "./utils/index.js"
 		},
 		"./package.json": "./package.json"
 	},
@@ -45,10 +53,18 @@
 	"files": [
 		"*.mjs",
 		"*.js",
-		"*.d.ts"
+		"*.d.ts",
+		"exporter.*/*",
+		"utils/*"
 	],
+	"scripts": {
+		"build": "bundt"
+	},
 	"dependencies": {
 		"flattie": "^1.1.0",
 		"tctx": "^0.0.10"
+	},
+	"devDependencies": {
+		"bundt": "2.0.0-next.5"
 	}
 }

package/utils/index.d.ts

@@ -0,0 +1,68 @@
+import type { Scope } from 'rian';
+
+export type MeasureFn =
+	| ((...args: [...args: any[]]) => any)
+	| ((...args: [...args: any[], scope: Scope]) => any);
+
+/**
+ * With a passed function — will start a span, and run the function, when the function finishes
+ * the span finishes.
+ *
+ * The measure method will return whatever the function is, so if it's a promise, it returns a
+ * promise and so on. Any error is caught and re thrown, and automatically tracked in the
+ * context under the `error` property.
+ *
+ * All promises are tracked, and awaited on a `tracer.end`.
+ *
+ * @example
+ *
+ * ```text
+ * const data = await measure(scope, 'name', get_data, 'user_id_123');
+ *        ^                    ^      ^       ^          ^
+ *        |                    |      |       |          |
+ *        |                    |      |       |          the first argument to get_data
+ *        |                    |      |       function to be called
+ *        |                    |      the name of the sub scope
+ *        |                    |
+ *        |                    the parent scope
+ *         return value from get_data
+ * ```
+ */
+export const measure: <Fn extends MeasureFn>(
+	scope: Scope,
+	name: string,
+	fn: Fn, // TODO: fn doesnt see scope correctly
+	...args: RealMeasureFnParams<Parameters<Fn>>
+) => ReturnType<Fn>;
+
+/**
+ * Wraps any function with a measured scoped function. Useful for when defer function execution
+ * till a later time.
+ *
+ * @example
+ *
+ * ```js
+ * const wrapped = wrap(scope, "run something", my_function);
+ *
+ * // ... lots of things, where the access to `scope` is lost.
+ *
+ * wrapped();
+ * ```
+ */
+export const wrap: <Fn extends MeasureFn>(
+	scope: Scope,
+	name: string,
+	fn: Fn, // TODO: fn doesnt see scope correctly
+) => Fn;
+
+// ==> internals
+
+/** @internal */
+export type RealMeasureFnParams<T extends unknown[]> = T extends []
+	? []
+	: T extends [...rest: infer U, scope: Scope]
+	? U
+	: T;
+
+/** @internal */
+export const measureFn: (scope: Scope, fn: any, ...args: any[]) => any;

package/utils/index.js

@@ -0,0 +1,30 @@
+// src/utils.ts
+const { ADD_PROMISE, PROMISES } = require('rian');
+var measureFn = (scope, fn, ...args) => {
+  try {
+    var r = fn(...args, scope), is_promise = r instanceof Promise;
+    if (is_promise && !PROMISES.has(scope))
+      ADD_PROMISE(scope, r.catch((e) => void scope.set_context({
+        error: e
+      })).finally(() => scope.end()));
+    return r;
+  } catch (e) {
+    if (e instanceof Error)
+      scope.set_context({
+        error: e
+      });
+    throw e;
+  } finally {
+    if (is_promise !== true)
+      scope.end();
+  }
+};
+var measure = (scope, name, fn, ...args) => measureFn(scope.fork(name), fn, ...args);
+var wrap = (scope, name, fn) => function() {
+  return measureFn(scope.fork(name), fn, ...arguments);
+};
+
+
+exports.measure = measure;
+exports.measureFn = measureFn;
+exports.wrap = wrap;

package/utils/index.mjs

@@ -0,0 +1,30 @@
+// src/utils.ts
+import { ADD_PROMISE, PROMISES } from "rian";
+var measureFn = (scope, fn, ...args) => {
+  try {
+    var r = fn(...args, scope), is_promise = r instanceof Promise;
+    if (is_promise && !PROMISES.has(scope))
+      ADD_PROMISE(scope, r.catch((e) => void scope.set_context({
+        error: e
+      })).finally(() => scope.end()));
+    return r;
+  } catch (e) {
+    if (e instanceof Error)
+      scope.set_context({
+        error: e
+      });
+    throw e;
+  } finally {
+    if (is_promise !== true)
+      scope.end();
+  }
+};
+var measure = (scope, name, fn, ...args) => measureFn(scope.fork(name), fn, ...args);
+var wrap = (scope, name, fn) => function() {
+  return measureFn(scope.fork(name), fn, ...arguments);
+};
+export {
+  measure,
+  measureFn,
+  wrap
+};

package/exporter.otel.http.d.ts

@@ -1,5 +0,0 @@
-import * as rian from 'rian';
-
-declare const exporter: (request: (payload: any) => any) => rian.Exporter;
-
-export { exporter };