refactor(exporter-prometheus): promisify prometheus tests (open-telem…

…etry#4431) * refactor(exporter-prometheus): promisify prometheus tests * fix: lint --------- Co-authored-by: Marc Pichler <[email protected]>
Zirak · Sep 14, 2024 · aec2ed1 · aec2ed1
1 parent 3c64070
commit aec2ed1
Show file tree

Hide file tree

Showing 5 changed files with 154 additions and 254 deletions.
diff --git a/doc/metrics.md b/doc/metrics.md
@@ -59,7 +59,7 @@ const {
   getNodeAutoInstrumentations,
 } = require("@opentelemetry/auto-instrumentations-node");
 
-const prometheusExporter = new PrometheusExporter({ startServer: true });
+const prometheusExporter = new PrometheusExporter();
 
 const sdk = new opentelemetry.NodeSDK({
   // Optional - If omitted, the metrics SDK will not be initialized
@@ -147,7 +147,7 @@ const {
   getNodeAutoInstrumentations,
 } = require("@opentelemetry/auto-instrumentations-node");
 
-const prometheusExporter = new PrometheusExporter({ startServer: true });
+const prometheusExporter = new PrometheusExporter();
 
 const sdk = new opentelemetry.NodeSDK({
   // Optional - If omitted, the metrics SDK will not be initialized
@@ -499,8 +499,8 @@ to use the Prometheus exporter `PrometheusExporter` which is included in the
 const { PrometheusExporter } = require('@opentelemetry/exporter-prometheus');
 const { MeterProvider }  = require('@opentelemetry/sdk-metrics');
 
-// Add your port and startServer to the Prometheus options
-const options = { port: 9464, startServer: true };
+// Add your port to the Prometheus options
+const options = { port: 9464 };
 const exporter = new PrometheusExporter(options);
 
 // Creates MeterProvider and installs the exporter as a MetricReader

diff --git a/experimental/CHANGELOG.md b/experimental/CHANGELOG.md
@@ -16,6 +16,7 @@ All notable changes to experimental packages in this project will be documented
 
 ### :bug: (Bug Fix)
 
+* fix(exporter-prometheus): avoid invoking callback synchronously [#4431](https://github.com/open-telemetry/opentelemetry-js/pull/4431) @legendecas
 * fix(exporter-logs-otlp-grpc): set User-Agent header [#4398](https://github.com/open-telemetry/opentelemetry-js/pull/4398) @Vunovati
 * fix(exporter-logs-otlp-http): set User-Agent header [#4398](https://github.com/open-telemetry/opentelemetry-js/pull/4398) @Vunovati
 * fix(exporter-logs-otlp-proto): set User-Agent header [#4398](https://github.com/open-telemetry/opentelemetry-js/pull/4398) @Vunovati
@@ -24,6 +25,8 @@ All notable changes to experimental packages in this project will be documented
 
 ### :house: (Internal)
 
+* refactor(exporter-prometheus): promisify prometheus tests [#4431](https://github.com/open-telemetry/opentelemetry-js/pull/4431) @legendecas
+
 ## 0.47.0
 
 ### :boom: Breaking Change

diff --git a/experimental/packages/opentelemetry-exporter-prometheus/src/PrometheusExporter.ts b/experimental/packages/opentelemetry-exporter-prometheus/src/PrometheusExporter.ts
@@ -44,6 +44,7 @@ export class PrometheusExporter extends MetricReader {
   private readonly _prefix?: string;
   private readonly _appendTimestamp: boolean;
   private _serializer: PrometheusSerializer;
+  private _startServerPromise: Promise<void> | undefined;
 
   // This will be required when histogram is implemented. Leaving here so it is not forgotten
   // Histogram cannot have a attribute named 'le'
@@ -95,7 +96,8 @@ export class PrometheusExporter extends MetricReader {
         callback(err);
       });
     } else if (callback) {
-      callback();
+      // Do not invoke callback immediately to avoid zalgo problem.
+      queueMicrotask(callback);
     }
   }
 
@@ -142,7 +144,7 @@ export class PrometheusExporter extends MetricReader {
    * Starts the Prometheus export server
    */
   startServer(): Promise<void> {
-    return new Promise((resolve, reject) => {
+    this._startServerPromise ??= new Promise((resolve, reject) => {
       this._server.once('error', reject);
       this._server.listen(
         {
@@ -157,6 +159,8 @@ export class PrometheusExporter extends MetricReader {
         }
       );
     });
+
+    return this._startServerPromise;
   }
 
   /**