A working build

Author: arendjr

deno.json

@@ -4,7 +4,7 @@
         "@opentelemetry/core": "./vendor/opentelemetry-core/mod.ts",
         "@opentelemetry/exporter-prometheus": "./vendor/opentelemetry-exporter-prometheus/mod.ts",
         "@opentelemetry/resources": "./vendor/opentelemetry-resources/mod.ts",
-        "@opentelemetry/sdk-metrics": "./vendor/sdk-metrics/mod.ts",
+        "@opentelemetry/sdk-metrics": "./vendor/opentelemetry-sdk-metrics/mod.ts",
         "@opentelemetry/semantic-conventions": "./vendor/opentelemetry-semantic-conventions/mod.ts"
     }
 }

packages/lib/src/buildInfo.ts renamed to packages/lib/buildInfo.ts

@@ -1,8 +1,8 @@
 import type { UpDownCounter } from "@opentelemetry/api";
 
-import { getMeter } from "./instrumentation.ts";
-import { getRuntime, Runtime } from "./utils.ts";
 import { BUILD_INFO_DESCRIPTION, BUILD_INFO_NAME } from "./constants.ts";
+import { getBranch, getCommit, getVersion } from "./platform.deno.ts";
+import { getMeter } from "./instrumentation.ts";
 
 /**
  * BuildInfo is used to create the `build_info` metric that
@@ -73,73 +73,13 @@ export function setBuildInfo() {
     return buildInfo;
   }
 
-  const runtime = getRuntime();
-
   buildInfo = {
-    version: getVersion(runtime),
-    commit: getCommit(runtime),
-    branch: getBranch(runtime),
+    version: getVersion(),
+    commit: getCommit(),
+    branch: getBranch(),
   };
 
   recordBuildInfo(buildInfo);
 
   return buildInfo;
 }
-
-/**
- * Gets the version of the application.
- *
- * @internal
- */
-function getVersion(runtime: Runtime): string | undefined {
-  if (runtime === "node") {
-    // @ts-ignore
-    if (process.env.npm_package_version) {
-      // @ts-ignore
-      return process.env.npm_package_version;
-    }
-    // @ts-ignore
-    return process.env.PACKAGE_VERSION || process.env.AUTOMETRICS_VERSION;
-  }
-
-  if (runtime === "deno") {
-    return (
-      //@ts-ignore
-      Deno.env.get("AUTOMETRICS_VERSION") || Deno.env.get("PACKAGE_VERSION")
-    );
-  }
-}
-
-/**
- * Gets the commit hash of the current state of the application.
- *
- * @internal
- */
-function getCommit(runtime: Runtime) {
-  if (runtime === "node") {
-    // @ts-ignore
-    return process.env.COMMIT_SHA || process.env.AUTOMETRICS_COMMIT;
-  }
-
-  if (runtime === "deno") {
-    //@ts-ignore
-    return Deno.env.get("AUTOMETRICS_COMMIT");
-  }
-}
-
-/**
- * Gets the current branch of the application.
- *
- * @internal
- */
-function getBranch(runtime: Runtime) {
-  if (runtime === "node") {
-    // @ts-ignore
-    return process.env.BRANCH_NAME || process.env.AUTOMETRICS_BRANCH;
-  }
-
-  if (runtime === "deno") {
-    //@ts-ignore
-    return Deno.env.get("AUTOMETRICS_BRANCH");
-  }
-}

packages/lib/src/constants.ts renamed to packages/lib/constants.ts

@@ -1,4 +1,4 @@
-export { init, type InitOptions } from "./src/instrumentation.ts";
-export * from "./src/objectives.ts";
-export * from "./src/wrappers.ts";
-export * from "./src/buildInfo.ts";
+export { init, type InitOptions } from "./instrumentation.ts";
+export * from "./objectives.ts";
+export * from "./wrappers.ts";
+export * from "./buildInfo.ts";

packages/lib/src/instrumentation.ts renamed to packages/lib/instrumentation.ts

@@ -0,0 +1,46 @@
+// Guard all the calls to the `Deno` global so that the Deno build is usable
+// in browsers too.
+const isDeno =
+  "Deno" in globalThis &&
+  Deno &&
+  "cwd" in Deno &&
+  typeof Deno.cwd === "function";
+
+export function getRootDir(): string {
+  return isDeno ? Deno.cwd() : "";
+}
+
+/**
+ * Returns the version of the application.
+ *
+ * @internal
+ */
+export function getVersion(): string | undefined {
+  if (isDeno) {
+    return (
+      Deno.env.get("AUTOMETRICS_VERSION") || Deno.env.get("PACKAGE_VERSION")
+    );
+  }
+}
+
+/**
+ * Returns the commit hash of the current state of the application.
+ *
+ * @internal
+ */
+export function getCommit(): string | undefined {
+  if (isDeno) {
+    return Deno.env.get("COMMIT_SHA") || Deno.env.get("AUTOMETRICS_COMMIT");
+  }
+}
+
+/**
+ * Returns the current branch of the application.
+ *
+ * @internal
+ */
+export function getBranch(): string | undefined {
+  if (isDeno) {
+    return Deno.env.get("BRANCH_NAME") || Deno.env.get("AUTOMETRICS_BRANCH");
+  }
+}

packages/lib/mod.ts

@@ -0,0 +1,52 @@
+// Guard the call to `process.cwd()` so that the NPM build is usable in browsers
+// too. We *don't* guard the accesses to `process.env` since bundlers commonly
+// allow implementing replacements on that object.
+const isNode =
+  "process" in globalThis &&
+  // @ts-ignore
+  process &&
+  // @ts-ignore
+  "cwd" in process &&
+  // @ts-ignore
+  typeof process.cwd === "function";
+
+export function getRootDir(): string {
+  // @ts-ignore
+  return isNode ? process.cwd() : "";
+}
+
+/**
+ * Returns the version of the application.
+ *
+ * @internal
+ */
+export function getVersion(): string | undefined {
+  return (
+    // @ts-ignore
+    process.env.npm_package_version ||
+    // @ts-ignore
+    process.env.PACKAGE_VERSION ||
+    // @ts-ignore
+    process.env.AUTOMETRICS_VERSION
+  );
+}
+
+/**
+ * Returns the commit hash of the current state of the application.
+ *
+ * @internal
+ */
+export function getCommit(): string | undefined {
+  // @ts-ignore
+  return process.env.COMMIT_SHA || process.env.AUTOMETRICS_COMMIT;
+}
+
+/**
+ * Returns the current branch of the application.
+ *
+ * @internal
+ */
+export function getBranch(): string | undefined {
+  // @ts-ignore
+  return process.env.BRANCH_NAME || process.env.AUTOMETRICS_BRANCH;
+}

packages/lib/src/objectives.ts renamed to packages/lib/objectives.ts

@@ -4,8 +4,8 @@ import {
   AggregationTemporality,
 } from "@opentelemetry/sdk-metrics";
 import { assertMatch } from "./deps.ts";
-import { init } from "../src/instrumentation.ts";
-import { getMetricsProvider } from "../src/instrumentation.ts";
+import { init } from "../instrumentation.ts";
+import { getMetricsProvider } from "../instrumentation.ts";
 import { collectAndSerialize } from "./util.ts";
 
 const buildInfo = {

packages/lib/platform.deno.ts

@@ -4,7 +4,7 @@ import {
 } from "@opentelemetry/sdk-metrics";
 import { assertMatch } from "./deps.ts";
 import { autometrics, init } from "../mod.ts";
-import { getMetricsProvider } from "../src/instrumentation.ts";
+import { getMetricsProvider } from "../instrumentation.ts";
 import { collectAndSerialize } from "./util.ts";
 
 /*Deno.test("Autometrics concurrency tests", async (t) => {

packages/lib/platform.node.ts

@@ -1,5 +1,5 @@
 import { assertEquals } from "./deps.ts";
-import { getMetricsProvider } from "../src/instrumentation.ts";
+import { getMetricsProvider } from "../instrumentation.ts";
 
 Deno.test("Autometrics initializer", async (t) => {
   await t.step("Test if autometrics initializes only once", () => {

packages/lib/tests/buildInfo.test.ts

@@ -5,7 +5,7 @@ import {
   PeriodicExportingMetricReader,
 } from "@opentelemetry/sdk-metrics";
 import { assertMatch, assertRejects } from "./deps.ts";
-import { getMetricsProvider } from "../src/instrumentation.ts";
+import { getMetricsProvider } from "../instrumentation.ts";
 import { collectAndSerialize } from "./util.ts";
 
 /*Deno.test("Autometrics integration test", async (t) => {

packages/lib/tests/concurrency.test.ts

@@ -9,7 +9,7 @@ import {
   ObjectiveLatency,
   ObjectivePercentile,
 } from "../mod.ts";
-import { getMetricsProvider } from "../src/instrumentation.ts";
+import { getMetricsProvider } from "../instrumentation.ts";
 import { collectAndSerialize } from "./util.ts";
 
 /*Deno.test("Autometrics objectives test", async (t) => {

packages/lib/tests/instrumentation.test.ts

@@ -1,5 +1,5 @@
 import { assertEquals } from "./deps.ts";
-import { getModulePath } from "../src/utils.ts";
+import { getModulePath } from "../utils.ts";
 
 // the existing getModulePath function is a hack that parses the stack trace
 // as string and extracts the module path from it. This test is to ensure that

packages/lib/tests/integration.test.ts

@@ -1,22 +1,4 @@
-export type Runtime = "node" | "deno" | "browser" | "unknown";
-
-export function getRuntime(): Runtime {
-  // @ts-ignore
-  if (typeof process === "object" && "cwd" in process) {
-    return "node";
-  }
-
-  // @ts-ignore
-  if (typeof Deno === "object") {
-    return "deno";
-  }
-
-  if (typeof window === "object") {
-    return "browser";
-  }
-
-  return "unknown";
-}
+import { getRootDir } from "./platform.deno.ts";
 
 // HACK: this entire function is a hacky way to acquire the module name for a
 // given function e.g.: dist/index.js
@@ -32,23 +14,6 @@ export function getModulePath(): string | undefined {
     name: callSite.getFunctionName(),
     file: callSite.getFileName(),
   }));
-
-  let rootDir: string;
-  const runtime = getRuntime();
-  if (runtime === "browser") {
-    rootDir = "";
-  } else if (runtime === "deno") {
-    //@ts-ignore
-    rootDir = Deno.cwd();
-  } else if (runtime === "node") {
-    // HACK: this assumes the entire app was run from the root directory of the
-    // project
-    // @ts-ignore
-    rootDir = process.cwd();
-  } else {
-    rootDir = "";
-  }
-
   if (!stack) {
     return;
   }
@@ -74,6 +39,7 @@ export function getModulePath(): string | undefined {
 
   // We split away everything up to the root directory of the project,
   // if the path contains file:// we need to remove it
+  const rootDir = getRootDir();
   return wrappedFunctionPath.replace(
     containsFileProtocol ? `file://${rootDir}` : rootDir,
     "",

packages/lib/tests/objectives.test.ts

@@ -1,4 +1,4 @@
-import { Attributes } from "npm:@opentelemetry/api";
+import { Attributes } from "@opentelemetry/api";
 import { setBuildInfo } from "./buildInfo.ts";
 import {
   COUNTER_DESCRIPTION,

packages/lib/tests/utils.test.ts

@@ -34,19 +34,44 @@ const packageJsonFields = {
   publishConfig: {
     access: "public",
   },
+  devDependencies: {
+    "@opentelemetry/api": "^1.4.0",
+    "@types/node": "^18.6.5",
+  },
 };
 
 for (const [dir, name] of Object.entries(packages)) {
   await build({
     entryPoints: [`packages/${dir}/mod.ts`],
     outDir: `${OUT_DIR}/${dir}`,
-    shims: {
-      deno: true,
-    },
+    shims: { deno: false },
     package: {
       name,
       ...packageJsonFields,
     },
+    importMap: "./deno.json",
+    mappings: {
+      "./packages/lib/platform.deno.ts": "./packages/lib/platform.node.ts",
+      "./vendor/opentelemetry-api/mod.ts": {
+        name: "@opentelemetry/api",
+        peerDependency: true,
+        version: "^1.4.0",
+      },
+      "./vendor/opentelemetry-exporter-prometheus/mod.ts": {
+        name: "@opentelemetry/exporter-prometheus",
+        version: "^0.41.0",
+      },
+      "./vendor/opentelemetry-sdk-metrics/mod.ts": {
+        name: "@opentelemetry/sdk-metrics",
+        version: "^1.15.0",
+      },
+    },
+    packageManager: "yarn",
+    test: false,
+    filterDiagnostic: (diagnostic) =>
+      // Ignore messages about `fetch` in Node.js. It's a TODO to have a better
+      // fallback, but there's already a guard around its usage.
+      !diagnostic.messageText.toString().includes("Cannot find name 'fetch'"),
     postBuild() {
       // steps to run after building and before running the tests
       Deno.copyFileSync("LICENSE", `${OUT_DIR}/${dir}/LICENSE`);