@ogcio/o11y-sdk-node 0.1.0-beta.1 → 0.1.0-beta.11

package/test/url-sampler.test.ts

@@ -0,0 +1,215 @@
+import { Context } from "@opentelemetry/api";
+import {
+  SamplingDecision,
+  SamplingResult,
+} from "@opentelemetry/sdk-trace-base";
+import { describe, expect, test, vi } from "vitest";
+import { UrlSampler } from "../lib/url-sampler";
+
+describe("url sampler", () => {
+  // mock sampler to be sure every trace after UrlSamper has RECORD status
+  const mockSampler = {
+    shouldSample: vi
+      .fn()
+      .mockImplementation(
+        (_context, _traceId, _spanName, _spanKind, attributes, _links) => {
+          return {
+            decision: SamplingDecision.RECORD,
+            attributes: attributes,
+          } as SamplingResult;
+        },
+      ),
+  };
+
+  test("should add custom span attributes to trace", async () => {
+    const sampler: UrlSampler = new UrlSampler(
+      [
+        {
+          type: "endsWith",
+          url: "/health",
+        },
+      ],
+      mockSampler,
+      {
+        "signal.namespace": "unittest",
+        "signal.callback.result": () => "test",
+      },
+    );
+
+    expect(sampler).not.toBeNull();
+
+    const result = sampler.shouldSample(
+      {} as Context,
+      "traceId",
+      "span",
+      0,
+      { "http.target": "/track" },
+      [],
+    );
+
+    expect(sampler.toString()).toBe("UrlSampler");
+    expect(result.decision).toBe(SamplingDecision.RECORD);
+    expect(result.attributes).not.toBeNull();
+  });
+
+  test("should not record trace about /health api", async () => {
+    const sampler: UrlSampler = new UrlSampler(
+      [
+        {
+          type: "endsWith",
+          url: "/health",
+        },
+      ],
+      mockSampler,
+    );
+
+    const result = sampler.shouldSample(
+      {} as Context,
+      "traceId",
+      "span",
+      0,
+      { "http.target": "/health" },
+      [],
+    );
+
+    expect(sampler.toString()).toBe("UrlSampler");
+    expect(result.decision).toBe(SamplingDecision.NOT_RECORD);
+  });
+
+  test("should record every other trace which is not /health api", async () => {
+    const sampler: UrlSampler = new UrlSampler(
+      [
+        {
+          type: "endsWith",
+          url: "/health",
+        },
+      ],
+      mockSampler,
+    );
+
+    let result = sampler.shouldSample(
+      {} as Context,
+      "traceId",
+      "span",
+      0,
+      { "http.target": "/test" },
+      [],
+    );
+
+    expect(result.decision).toBe(SamplingDecision.RECORD);
+
+    result = sampler.shouldSample(
+      {} as Context,
+      "traceId",
+      "span",
+      0,
+      { "http.target": "/another/url" },
+      [],
+    );
+
+    expect(result.decision).toBe(SamplingDecision.RECORD);
+  });
+
+  test("operator 'includes', should not record every trace which include /block in url", async () => {
+    const sampler: UrlSampler = new UrlSampler(
+      [
+        {
+          type: "includes",
+          url: "/block",
+        },
+      ],
+      mockSampler,
+    );
+
+    expect(sampler).not.toBeNull();
+
+    const result = sampler.shouldSample(
+      {} as Context,
+      "traceId",
+      "span",
+      0,
+      { "http.target": "/namespace/block/example/12" },
+      [],
+    );
+
+    expect(sampler.toString()).toBe("UrlSampler");
+    expect(result.decision).toBe(SamplingDecision.NOT_RECORD);
+  });
+
+  test("operator 'endsWith', should not record only trace which ends with /block in url", async () => {
+    const sampler: UrlSampler = new UrlSampler(
+      [
+        {
+          type: "endsWith",
+          url: "/block",
+        },
+      ],
+      mockSampler,
+    );
+
+    expect(sampler).not.toBeNull();
+
+    // expect traced with block in the URL middle
+    let result = sampler.shouldSample(
+      {} as Context,
+      "traceId",
+      "span",
+      0,
+      { "http.target": "/namespace/block/example/12" },
+      [],
+    );
+
+    expect(sampler.toString()).toBe("UrlSampler");
+    expect(result.decision).toBe(SamplingDecision.RECORD);
+
+    // should stop trace with block at the end
+    result = sampler.shouldSample(
+      {} as Context,
+      "traceId",
+      "span",
+      0,
+      { "http.target": "/namespace/example/block" },
+      [],
+    );
+
+    expect(sampler.toString()).toBe("UrlSampler");
+    expect(result.decision).toBe(SamplingDecision.NOT_RECORD);
+  });
+
+  test("operator 'equals', should not record trace which is equal to /block in url", async () => {
+    const sampler: UrlSampler = new UrlSampler(
+      [
+        {
+          type: "equals",
+          url: "/block",
+        },
+      ],
+      mockSampler,
+    );
+
+    expect(sampler).not.toBeNull();
+
+    let result = sampler.shouldSample(
+      {} as Context,
+      "traceId",
+      "span",
+      0,
+      { "http.target": "/namespace/block/example/12" },
+      [],
+    );
+
+    expect(sampler.toString()).toBe("UrlSampler");
+    expect(result.decision).toBe(SamplingDecision.RECORD);
+
+    result = sampler.shouldSample(
+      {} as Context,
+      "traceId",
+      "span",
+      0,
+      { "http.target": "/block" },
+      [],
+    );
+
+    expect(result.decision).toBe(SamplingDecision.NOT_RECORD);
+  });
+});

package/test/utils/alloy-log-parser.ts

@@ -0,0 +1,46 @@
+export function parseLog(
+  log: string,
+): Record<string, object | string | number> {
+  const logArray = log
+    .split("\\n")
+    .map((line) => line.trim())
+    .filter((line) => line);
+
+  const jsonObject: Record<string, object | string | number> = {};
+  let currentSection: Record<string, object | string | number> = jsonObject;
+  const sectionStack: Record<string, object | string | number>[] = [];
+
+  logArray.forEach((line) => {
+    line = line.trim();
+
+    if (line.startsWith("->")) {
+      const match = line.match(/->\s+([^:]+):\s+(Str|Int)\((.+)\)/);
+      if (match) {
+        const [, key, type, value] = match;
+        const parsedValue = type === "Int" ? parseInt(value, 10) : value;
+
+        if (typeof currentSection === "object") {
+          currentSection[key] = parsedValue;
+        }
+      }
+    } else if (line.endsWith(":")) {
+      // new section
+      const sectionName = line
+        .slice(0, -1)
+        .trim()
+        .toLowerCase()
+        .replace(" ", "_");
+      jsonObject[sectionName] = {};
+      currentSection = jsonObject[sectionName] as Record<
+        string,
+        object | string | number
+      >;
+      sectionStack.push(currentSection);
+    } else if (line.startsWith('"')) {
+      // Additional metadata at the end, store it separately
+      jsonObject["metadata"] = line;
+    }
+  });
+
+  return jsonObject;
+}

package/test/validation.test.ts

@@ -10,7 +10,7 @@ describe("validation config: should return without breaking the execution", () =
       .spyOn(console, "warn")
       .mockImplementation(vi.fn());
 
-    instrumentNode();
+    await instrumentNode();
 
     expect(consoleWarnSpy).toHaveBeenCalled();
     expect(consoleWarnSpy).toHaveBeenCalledWith(
@@ -26,11 +26,13 @@ describe("validation config: should return without breaking the execution", () =
       .mockImplementation(vi.fn());
     const consoleLogSpy = vi.spyOn(console, "log").mockImplementation(vi.fn());
 
-    assert.doesNotThrow(() => {
-      sdk = buildNodeInstrumentation({
-        collectorUrl: undefined!,
-      });
-    });
+    await expect(
+      buildNodeInstrumentation({
+        collectorUrl: undefined,
+      }).then((result) => {
+        sdk = result;
+      }),
+    ).resolves.not.toThrowError();
 
     assert.equal(sdk, undefined);
 
@@ -41,7 +43,7 @@ describe("validation config: should return without breaking the execution", () =
     expect(consoleLogSpy).not.toHaveBeenCalled();
   });
 
-  test("node instrumentation: invalid url", () => {
+  test("node instrumentation: invalid url", async () => {
     let sdk: NodeSDK | undefined = undefined;
 
     const consoleErrorSpy = vi
@@ -49,11 +51,13 @@ describe("validation config: should return without breaking the execution", () =
       .mockImplementation(vi.fn());
     const consoleLogSpy = vi.spyOn(console, "log").mockImplementation(vi.fn());
 
-    assert.doesNotThrow(() => {
-      sdk = buildNodeInstrumentation({
+    await expect(
+      buildNodeInstrumentation({
         collectorUrl: "notavalidURL",
-      });
-    });
+      }).then((result) => {
+        sdk = result;
+      }),
+    ).resolves.not.toThrowError();
 
     assert.equal(sdk, undefined);
 
@@ -63,4 +67,37 @@ describe("validation config: should return without breaking the execution", () =
     );
     expect(consoleLogSpy).not.toHaveBeenCalled();
   });
+
+  test("node instrumentation: verify no instrumentation if exception occurs", async () => {
+    let sdk: NodeSDK | undefined = undefined;
+
+    const consoleErrorSpy = vi
+      .spyOn(console, "error")
+      .mockImplementation(vi.fn());
+    const consoleLogSpy = vi.spyOn(console, "log").mockImplementation(vi.fn());
+
+    vi.mock("@opentelemetry/auto-instrumentations-node", () => ({
+      getNodeAutoInstrumentations: vi.fn(() => {
+        throw new Error("Wanted error");
+      }),
+    }));
+
+    await expect(
+      buildNodeInstrumentation({
+        collectorUrl: "https://testurl.com",
+        serviceName: "test",
+      }).then((result) => {
+        sdk = result;
+      }),
+    ).resolves.not.toThrowError();
+
+    assert.equal(sdk, undefined);
+
+    expect(consoleErrorSpy).toHaveBeenCalled();
+    expect(consoleErrorSpy).toHaveBeenCalledWith(
+      "Error starting NodeJS OpenTelemetry instrumentation:",
+      new Error("Wanted error"),
+    );
+    expect(consoleLogSpy).not.toHaveBeenCalled();
+  });
 });

package/tsconfig.json

@@ -8,7 +8,8 @@
     "forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */,
     "strict": true /* Enable all strict type-checking options. */,
     "skipLibCheck": true /* Skip type checking all .d.ts files. */,
-    "declaration": true
+    "declaration": true,
+    "resolveJsonModule": true
   },
   "exclude": ["**/test/**"]
 }

package/vitest.config.ts

@@ -4,7 +4,6 @@ export default defineConfig({
   test: {
     globals: true,
     watch: false,
-    include: ["**/test/*.test.ts"],
     exclude: ["**/fixtures/**", "**/dist/**"],
     poolOptions: {
       threads: {
@@ -22,5 +21,20 @@ export default defineConfig({
     },
     reporters: ["default", ["junit", { outputFile: "test-report.xml" }]],
     environment: "node",
+    pool: "threads",
+    workspace: [
+      {
+        test: {
+          include: ["**/test/*.test.ts", "**/test/processor/*.test.ts"],
+          name: "unit",
+        },
+      },
+      {
+        test: {
+          include: ["**/test/integration/*.test.ts"],
+          name: "integration",
+        },
+      },
+    ],
   },
 });

package/coverage/cobertura-coverage.xml

@@ -1,199 +0,0 @@
-<?xml version="1.0" ?>
-<!DOCTYPE coverage SYSTEM "http://cobertura.sourceforge.net/xml/coverage-04.dtd">
-<coverage lines-valid="115" lines-covered="109" line-rate="0.9478" branches-valid="18" branches-covered="16" branch-rate="0.8887999999999999" timestamp="1732613125604" complexity="0" version="0.1">
-  <sources>
-    <source>/Users/andreabozzelli/Projects/o11y/packages/sdk-node</source>
-  </sources>
-  <packages>
-    <package name="sdk-node" line-rate="1" branch-rate="1">
-      <classes>
-        <class name="index.ts" filename="index.ts" line-rate="1" branch-rate="1">
-          <methods>
-          </methods>
-          <lines>
-            <line number="1" hits="1" branch="false"/>
-          </lines>
-        </class>
-      </classes>
-    </package>
-    <package name="sdk-node.lib" line-rate="0.9473" branch-rate="0.8887999999999999">
-      <classes>
-        <class name="grpc.ts" filename="lib/grpc.ts" line-rate="1" branch-rate="1">
-          <methods>
-            <method name="buildGrpcExporters" hits="2" signature="()V">
-              <lines>
-                <line number="10" hits="2"/>
-              </lines>
-            </method>
-          </methods>
-          <lines>
-            <line number="1" hits="1" branch="false"/>
-            <line number="10" hits="2" branch="true" condition-coverage="100% (1/1)"/>
-            <line number="11" hits="2" branch="false"/>
-            <line number="12" hits="2" branch="false"/>
-            <line number="13" hits="2" branch="false"/>
-            <line number="14" hits="2" branch="false"/>
-            <line number="15" hits="2" branch="false"/>
-            <line number="16" hits="2" branch="false"/>
-            <line number="17" hits="2" branch="false"/>
-            <line number="18" hits="2" branch="false"/>
-            <line number="19" hits="2" branch="false"/>
-            <line number="20" hits="2" branch="false"/>
-            <line number="21" hits="2" branch="false"/>
-            <line number="22" hits="2" branch="false"/>
-            <line number="23" hits="2" branch="true" condition-coverage="100% (1/1)"/>
-            <line number="24" hits="2" branch="false"/>
-            <line number="25" hits="2" branch="false"/>
-            <line number="26" hits="2" branch="false"/>
-            <line number="27" hits="2" branch="false"/>
-            <line number="28" hits="2" branch="false"/>
-            <line number="29" hits="2" branch="false"/>
-            <line number="30" hits="2" branch="false"/>
-            <line number="31" hits="2" branch="false"/>
-          </lines>
-        </class>
-        <class name="http.ts" filename="lib/http.ts" line-rate="1" branch-rate="1">
-          <methods>
-            <method name="buildHttpExporters" hits="2" signature="()V">
-              <lines>
-                <line number="10" hits="2"/>
-              </lines>
-            </method>
-          </methods>
-          <lines>
-            <line number="1" hits="1" branch="false"/>
-            <line number="10" hits="2" branch="true" condition-coverage="100% (1/1)"/>
-            <line number="11" hits="2" branch="true" condition-coverage="100% (1/1)"/>
-            <line number="12" hits="1" branch="false"/>
-            <line number="13" hits="1" branch="false"/>
-            <line number="15" hits="2" branch="false"/>
-            <line number="16" hits="2" branch="false"/>
-            <line number="17" hits="2" branch="false"/>
-            <line number="18" hits="2" branch="false"/>
-            <line number="19" hits="2" branch="false"/>
-            <line number="20" hits="2" branch="false"/>
-            <line number="21" hits="2" branch="false"/>
-            <line number="22" hits="2" branch="false"/>
-            <line number="23" hits="2" branch="false"/>
-            <line number="24" hits="2" branch="false"/>
-            <line number="25" hits="2" branch="false"/>
-            <line number="26" hits="2" branch="false"/>
-            <line number="27" hits="2" branch="false"/>
-            <line number="28" hits="2" branch="false"/>
-            <line number="29" hits="2" branch="false"/>
-            <line number="30" hits="2" branch="false"/>
-            <line number="31" hits="2" branch="false"/>
-            <line number="32" hits="2" branch="false"/>
-            <line number="33" hits="2" branch="false"/>
-            <line number="34" hits="2" branch="false"/>
-            <line number="35" hits="2" branch="false"/>
-          </lines>
-        </class>
-        <class name="index.ts" filename="lib/index.ts" line-rate="0" branch-rate="0">
-          <methods>
-            <method name="(empty-report)" hits="1" signature="()V">
-              <lines>
-                <line number="1" hits="1"/>
-              </lines>
-            </method>
-          </methods>
-          <lines>
-          </lines>
-        </class>
-        <class name="instrumentation.node.ts" filename="lib/instrumentation.node.ts" line-rate="0.8983" branch-rate="0.8332999999999999">
-          <methods>
-            <method name="buildNodeInstrumentation" hits="6" signature="()V">
-              <lines>
-                <line number="11" hits="6"/>
-              </lines>
-            </method>
-          </methods>
-          <lines>
-            <line number="1" hits="1" branch="false"/>
-            <line number="11" hits="6" branch="true" condition-coverage="100% (1/1)"/>
-            <line number="12" hits="6" branch="false"/>
-            <line number="13" hits="6" branch="false"/>
-            <line number="14" hits="6" branch="true" condition-coverage="100% (1/1)"/>
-            <line number="15" hits="1" branch="false"/>
-            <line number="16" hits="1" branch="false"/>
-            <line number="17" hits="1" branch="false"/>
-            <line number="18" hits="1" branch="false"/>
-            <line number="19" hits="1" branch="true" condition-coverage="100% (1/1)"/>
-            <line number="21" hits="6" branch="true" condition-coverage="100% (2/2)"/>
-            <line number="22" hits="1" branch="false"/>
-            <line number="23" hits="1" branch="false"/>
-            <line number="24" hits="1" branch="false"/>
-            <line number="25" hits="1" branch="false"/>
-            <line number="26" hits="1" branch="false"/>
-            <line number="28" hits="4" branch="true" condition-coverage="100% (1/1)"/>
-            <line number="29" hits="1" branch="false"/>
-            <line number="30" hits="1" branch="false"/>
-            <line number="31" hits="1" branch="false"/>
-            <line number="32" hits="1" branch="false"/>
-            <line number="33" hits="1" branch="true" condition-coverage="100% (1/1)"/>
-            <line number="35" hits="3" branch="false"/>
-            <line number="37" hits="3" branch="true" condition-coverage="100% (1/1)"/>
-            <line number="38" hits="1" branch="false"/>
-            <line number="39" hits="3" branch="true" condition-coverage="100% (1/1)"/>
-            <line number="40" hits="2" branch="false"/>
-            <line number="41" hits="2" branch="false"/>
-            <line number="43" hits="3" branch="false"/>
-            <line number="44" hits="3" branch="false"/>
-            <line number="45" hits="3" branch="false"/>
-            <line number="46" hits="3" branch="false"/>
-            <line number="47" hits="3" branch="true" condition-coverage="0% (0/1)"/>
-            <line number="48" hits="0" branch="false"/>
-            <line number="49" hits="6" branch="false"/>
-            <line number="51" hits="6" branch="false"/>
-            <line number="52" hits="6" branch="false"/>
-            <line number="53" hits="6" branch="false"/>
-            <line number="54" hits="6" branch="false"/>
-            <line number="55" hits="6" branch="false"/>
-            <line number="56" hits="6" branch="false"/>
-            <line number="57" hits="6" branch="false"/>
-            <line number="58" hits="6" branch="false"/>
-            <line number="59" hits="6" branch="false"/>
-            <line number="60" hits="6" branch="true" condition-coverage="100% (1/1)"/>
-            <line number="61" hits="6" branch="false"/>
-            <line number="62" hits="6" branch="false"/>
-            <line number="63" hits="6" branch="false"/>
-            <line number="64" hits="6" branch="false"/>
-            <line number="66" hits="6" branch="false"/>
-            <line number="67" hits="6" branch="false"/>
-            <line number="68" hits="6" branch="false"/>
-            <line number="69" hits="6" branch="true" condition-coverage="0% (0/1)"/>
-            <line number="70" hits="0" branch="false"/>
-            <line number="71" hits="0" branch="false"/>
-            <line number="72" hits="0" branch="false"/>
-            <line number="73" hits="0" branch="false"/>
-            <line number="74" hits="0" branch="false"/>
-            <line number="75" hits="6" branch="false"/>
-          </lines>
-        </class>
-        <class name="options.ts" filename="lib/options.ts" line-rate="0" branch-rate="0">
-          <methods>
-            <method name="(empty-report)" hits="1" signature="()V">
-              <lines>
-                <line number="1" hits="1"/>
-              </lines>
-            </method>
-          </methods>
-          <lines>
-          </lines>
-        </class>
-        <class name="utils.ts" filename="lib/utils.ts" line-rate="1" branch-rate="1">
-          <methods>
-          </methods>
-          <lines>
-            <line number="1" hits="1" branch="false"/>
-            <line number="4" hits="1" branch="false"/>
-            <line number="7" hits="1" branch="false"/>
-            <line number="8" hits="1" branch="false"/>
-            <line number="9" hits="1" branch="false"/>
-            <line number="10" hits="1" branch="false"/>
-          </lines>
-        </class>
-      </classes>
-    </package>
-  </packages>
-</coverage>