@dagger.io/dagger 0.11.1 → 0.11.3

package/dist/telemetry/init.js

@@ -0,0 +1,66 @@
+import { getEnvWithoutDefaults } from "@opentelemetry/core";
+import { NodeSDK } from "@opentelemetry/sdk-node";
+const SERVICE_NAME = "dagger-typescript-sdk";
+const env = getEnvWithoutDefaults();
+/*
+ * Look for variables prefixed with OTEL to see if OpenTelemetry is configured.
+ */
+function otelConfigured() {
+    return Object.keys(process.env).some((key) => key.startsWith("OTEL_"));
+}
+/**
+ * A wrapper around the OpenTelemetry SDK to configure it for Dagger.
+ */
+export class DaggerOtelConfigurator {
+    is_configured = false;
+    sdk;
+    /**
+     * Initialize the Open Telemetry SDK if enabled or not already configured.
+     */
+    initialize() {
+        if (this.is_configured) {
+            return;
+        }
+        this.configure();
+        this.is_configured = true;
+    }
+    configure() {
+        if (!otelConfigured()) {
+            return;
+        }
+        if (env.OTEL_SDK_DISABLED) {
+            return;
+        }
+        this.setupEnv();
+        // Create the node SDK with the context manager, the resource and the exporter.
+        this.sdk = new NodeSDK({
+            serviceName: SERVICE_NAME,
+        });
+        // Register the SDK to the OpenTelemetry API
+        this.sdk.start();
+    }
+    /**
+     * Shutdown the Open Telemetry SDK to flush traces and metrics and close the connection.
+     */
+    async close() {
+        if (this.sdk) {
+            this.sdk.shutdown();
+        }
+    }
+    /**
+     * Setup environment for auto-configuring the SDK.
+     */
+    setupEnv() {
+        // TODO: The insecure flag should be set by the shim instead of the SDK.
+        Object.entries(process.env).forEach(([key, value]) => {
+            if (key.startsWith("OTEL_") &&
+                key.endsWith("_ENDPOINT") &&
+                value?.startsWith("http://")) {
+                const insecure = key.replace(/_ENDPOINT$/, "_INSECURE");
+                if (process.env[insecure] === undefined) {
+                    process.env[insecure] = "true";
+                }
+            }
+        });
+    }
+}

package/dist/telemetry/telemetry.d.ts

@@ -0,0 +1,16 @@
+import * as opentelemetry from "@opentelemetry/api";
+import { Tracer } from "./tracer.js";
+export declare function initialize(): void;
+export declare function close(): Promise<void>;
+/**
+ * Return a tracer to use with Dagger.
+ *
+ * The tracer is automatically initialized if not already done.
+ * As a conveniance function, you can use `withTracingSpan` that automatically close
+ * the span at the end of the function.
+ *
+ * You can add a custom name to the tracer based on your application.
+ */
+export declare function getTracer(name?: string): Tracer;
+export declare function getContext(): opentelemetry.Context;
+//# sourceMappingURL=telemetry.d.ts.map

package/dist/telemetry/telemetry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"telemetry.d.ts","sourceRoot":"","sources":["../../telemetry/telemetry.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,aAAa,MAAM,oBAAoB,CAAA;AAGnD,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AAMpC,wBAAgB,UAAU,SAEzB;AAED,wBAAsB,KAAK,kBAE1B;AAED;;;;;;;;GAQG;AACH,wBAAgB,SAAS,CAAC,IAAI,SAAqB,GAAG,MAAM,CAG3D;AAED,wBAAgB,UAAU,0BAgBzB"}

package/dist/telemetry/telemetry.js

@@ -0,0 +1,38 @@
+import * as opentelemetry from "@opentelemetry/api";
+import { DaggerOtelConfigurator } from "./init.js";
+import { Tracer } from "./tracer.js";
+const DAGGER_TRACER_NAME = "dagger.io/sdk.typescript";
+const configurator = new DaggerOtelConfigurator();
+export function initialize() {
+    configurator.initialize();
+}
+export async function close() {
+    await configurator.close();
+}
+/**
+ * Return a tracer to use with Dagger.
+ *
+ * The tracer is automatically initialized if not already done.
+ * As a conveniance function, you can use `withTracingSpan` that automatically close
+ * the span at the end of the function.
+ *
+ * You can add a custom name to the tracer based on your application.
+ */
+export function getTracer(name = DAGGER_TRACER_NAME) {
+    initialize();
+    return new Tracer(name);
+}
+export function getContext() {
+    const ctx = opentelemetry.context.active();
+    const spanCtx = opentelemetry.trace.getSpanContext(ctx);
+    if (spanCtx && opentelemetry.trace.isSpanContextValid(spanCtx)) {
+        return ctx;
+    }
+    const parentID = process.env.TRACEPARENT;
+    if (parentID) {
+        return opentelemetry.propagation.extract(ctx, {
+            traceparent: parentID,
+        });
+    }
+    return ctx;
+}

package/dist/telemetry/tracer.d.ts

@@ -0,0 +1,32 @@
+import * as opentelemetry from "@opentelemetry/api";
+/**
+ * Tracer encapsulates the OpenTelemetry Tracer.
+ */
+export declare class Tracer {
+    private tracer;
+    constructor(name: string);
+    startSpan(name: string, attributes?: opentelemetry.Attributes): opentelemetry.Span;
+    /**
+     * Execute the functions with a custom span with the given name using startActiveSpan.
+     * The function executed will use the parent context of the function (it can be another span
+     * or the main function).
+     *
+     * @param name The name of the span
+     * @param fn The functions to execute
+     *
+     * startActiveSpan returns the result of the executed functions.
+     *
+     * The span is automatically ended when the function is done.
+     * The span is automatically marked as an error if the function throws an error.
+     *
+     *
+     * @example
+     * ```
+     * return getTracer().startActiveSpan(name, async () => {
+     *   return this.containerEcho("test").stdout()
+     * })
+     * ```
+     */
+    startActiveSpan<T>(name: string, fn: (span: opentelemetry.Span) => Promise<T>, attributes?: opentelemetry.Attributes): Promise<T>;
+}
+//# sourceMappingURL=tracer.d.ts.map

package/dist/telemetry/tracer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tracer.d.ts","sourceRoot":"","sources":["../../telemetry/tracer.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,aAAa,MAAM,oBAAoB,CAAA;AAEnD;;GAEG;AACH,qBAAa,MAAM;IACjB,OAAO,CAAC,MAAM,CAAsB;gBAExB,IAAI,EAAE,MAAM;IAIjB,SAAS,CACd,IAAI,EAAE,MAAM,EACZ,UAAU,CAAC,EAAE,aAAa,CAAC,UAAU,GACpC,aAAa,CAAC,IAAI;IAIrB;;;;;;;;;;;;;;;;;;;;OAoBG;IACU,eAAe,CAAC,CAAC,EAC5B,IAAI,EAAE,MAAM,EACZ,EAAE,EAAE,CAAC,IAAI,EAAE,aAAa,CAAC,IAAI,KAAK,OAAO,CAAC,CAAC,CAAC,EAC5C,UAAU,CAAC,EAAE,aAAa,CAAC,UAAU;CAoBxC"}

package/dist/telemetry/tracer.js

@@ -0,0 +1,54 @@
+import * as opentelemetry from "@opentelemetry/api";
+/**
+ * Tracer encapsulates the OpenTelemetry Tracer.
+ */
+export class Tracer {
+    tracer;
+    constructor(name) {
+        this.tracer = opentelemetry.trace.getTracer(name);
+    }
+    startSpan(name, attributes) {
+        return this.tracer.startSpan(name, { attributes });
+    }
+    /**
+     * Execute the functions with a custom span with the given name using startActiveSpan.
+     * The function executed will use the parent context of the function (it can be another span
+     * or the main function).
+     *
+     * @param name The name of the span
+     * @param fn The functions to execute
+     *
+     * startActiveSpan returns the result of the executed functions.
+     *
+     * The span is automatically ended when the function is done.
+     * The span is automatically marked as an error if the function throws an error.
+     *
+     *
+     * @example
+     * ```
+     * return getTracer().startActiveSpan(name, async () => {
+     *   return this.containerEcho("test").stdout()
+     * })
+     * ```
+     */
+    async startActiveSpan(name, fn, attributes) {
+        return this.tracer.startActiveSpan(name, { attributes }, async (span) => {
+            try {
+                return await fn(span);
+            }
+            catch (e) {
+                if (e instanceof Error) {
+                    span.recordException(e);
+                    span.setStatus({
+                        code: opentelemetry.SpanStatusCode.ERROR,
+                        message: e.message,
+                    });
+                }
+                throw e;
+            }
+            finally {
+                span.end();
+            }
+        });
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dagger.io/dagger",
-  "version": "0.11.1",
+  "version": "0.11.3",
   "author": "hello@dagger.io",
   "license": "Apache-2.0",
   "types": "./dist/index.d.ts",
@@ -9,25 +9,32 @@
     "dist/"
   ],
   "exports": {
-    ".": "./dist/index.js"
+    ".": "./dist/index.js",
+    "./telemetry": "./dist/telemetry/index.js"
   },
   "engines": {
     "node": ">=18"
   },
   "main": "dist/index.js",
   "dependencies": {
+    "@grpc/grpc-js": "^1.10.6",
     "@lifeomic/axios-fetch": "^3.0.1",
+    "@opentelemetry/api": "^1.8.0",
+    "@opentelemetry/exporter-trace-otlp-grpc": "^0.51.0",
+    "@opentelemetry/sdk-metrics": "^1.24.0",
+    "@opentelemetry/sdk-node": "^0.51.0",
+    "@opentelemetry/semantic-conventions": "^1.24.0",
     "adm-zip": "^0.5.10",
     "env-paths": "^3.0.0",
     "execa": "^8.0.1",
     "graphql": "^16.8.0",
     "graphql-request": "^6.1.0",
     "graphql-tag": "^2.12.6",
-    "node-color-log": "^11.0.0",
+    "node-color-log": "^12.0.0",
     "node-fetch": "^3.3.1",
     "reflect-metadata": "^0.2.1",
-    "tar": "^6.1.13",
-    "typescript": "^5.3.3"
+    "tar": "^7.1.0",
+    "typescript": "^5.4.5"
   },
   "scripts": {
     "build": "tsc",
@@ -37,23 +44,25 @@
     "test:node": "mocha",
     "test:generate-scan": "tsx ./introspector/test/testdata/generate_expected_scan.ts",
     "lint": "yarn eslint --max-warnings=0 .",
-    "fmt": "yarn eslint --fix .",
-    "docs:lint": "yarn eslint -c .eslintrc-docs.cjs --max-warnings=0 --resolve-plugins-relative-to=./ --ext=.js,.ts,.mjs,.mts ../../docs/current_docs",
-    "docs:fmt": "yarn eslint -c .eslintrc-docs.cjs --fix --resolve-plugins-relative-to=./ --ext=.js,.ts,.mjs,.mts ../../docs/current_docs ."
+    "fmt": "yarn eslint --max-warnings=0 --fix .",
+    "docs:lint": "cd ../../docs/current_docs && eslint -c ../../sdk/typescript/eslint-docs.config.js --max-warnings=0 ./**/*.ts",
+    "docs:fmt": "cd ../../docs/current_docs && eslint --fix -c ../../sdk/typescript/eslint-docs.config.js --max-warnings=0 ./**/*.ts"
   },
   "devDependencies": {
+    "@eslint/js": "^9.2.0",
     "@trivago/prettier-plugin-sort-imports": "^4.2.0",
     "@types/adm-zip": "^0.5.0",
     "@types/mocha": "latest",
     "@types/node": "~20",
     "@types/tar": "^6.1.4",
-    "@typescript-eslint/eslint-plugin": "^5.62.0",
-    "@typescript-eslint/parser": "^5.62.0",
-    "eslint": "^8.57.0",
+    "@typescript-eslint/eslint-plugin": "^7.8.0",
+    "@typescript-eslint/parser": "^7.8.0",
+    "eslint": "^9.2.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-prettier": "^5.1.3",
     "mocha": "^10.2.0",
     "prettier": "^3.2.5",
-    "ts-node": "^10.9.1"
+    "ts-node": "^10.9.1",
+    "typescript-eslint": "^7.8.0"
   }
 }