fix: disabled collector init process events (#2517)

Sending 'instana.collector.initialized' event is disabled by default.
- This prevents interference with application-level communication channels.
- The event is primarily used for testing purposes now.

ref https://jsw.ibm.com/browse/INSTA-85329

---------

Co-authored-by: kirrg001 <katharina.irrgang@ibm.com>

Author: aryamohanan

packages/collector/src/agent/opts.js

@@ -17,6 +17,8 @@ exports.agentUuid = undefined;
 // @ts-ignore - Cannot redeclare exported variable
 exports.autoProfile = false;
 
+exports.disableCollectorInitEvent = true;
+
 /** @type {import('@instana/collector/src/types/collector').AgentConfig} config */
 exports.config = {};
 
@@ -34,4 +36,6 @@ exports.init = function init(config) {
   exports.autoProfile = config.autoProfile;
 
   exports.requestTimeout = config.agentRequestTimeout;
+
+  exports.disableCollectorInitEvent = config.disableCollectorInitEvent;
 };

packages/collector/src/announceCycle/agentready.js

@@ -156,8 +156,13 @@ function enter(_ctx) {
   if (!isMainThread) {
     const { parentPort } = require('worker_threads');
 
-    if (parentPort) {
-      // CASE: This is for the worker thread if available.
+    /**
+     * Sending 'instana.collector.initialized' event is disabled by default.
+     * This prevents interference with application-level communication channels.
+     * The event is primarily used for testing purposes now.
+     */
+
+    if (parentPort && agentOpts.disableCollectorInitEvent === false) {
       parentPort.postMessage('instana.collector.initialized');
     }
   }

packages/collector/src/types/collector.d.ts

@@ -33,4 +33,5 @@ export interface CollectorConfig {
   reportUnhandledPromiseRejections?: boolean;
   logger?: GenericLogger;
   level?: string | number;
+  disableCollectorInitEvent?: boolean;
 }

packages/collector/src/util/normalizeConfig.js

@@ -11,7 +11,8 @@ const defaults = {
   agentHost: '127.0.0.1',
   agentPort: 42699,
   agentRequestTimeout: 5000,
-  autoProfile: false
+  autoProfile: false,
+  disableCollectorInitEvent: true
 };
 
 /**
@@ -33,6 +34,11 @@ module.exports = function normalizeConfig(config = {}) {
     config.reportUnhandledPromiseRejections = false;
   }
 
+  if (config.disableCollectorInitEvent == null) {
+    const envValue = process.env.INSTANA_DISABLE_COLLECTOR_INIT_EVENT;
+    config.disableCollectorInitEvent = envValue === 'true' ? true : defaults.disableCollectorInitEvent;
+  }
+
   return config;
 };
 

packages/collector/test/integration/misc/logger_spans/worker.js

@@ -11,7 +11,8 @@ const { workerData } = require('worker_threads');
 console.log('Worker thread: Starting', workerData);
 
 const instana = require('@instana/collector')({
-  agentPort: workerData.agentPort
+  agentPort: workerData.agentPort,
+  disableCollectorInitEvent: false
 });
 
 (async () => {

packages/collector/test/test_util/ProcessControls.js

@@ -164,6 +164,10 @@ class ProcessControls {
       opts.env
     );
 
+    if (!this.env.INSTANA_DISABLE_COLLECTOR_INIT_EVENT) {
+      this.env.INSTANA_DISABLE_COLLECTOR_INIT_EVENT = 'false';
+    }
+
     if (this.usePreInit) {
       this.env.INSTANA_EARLY_INSTRUMENTATION = 'true';
     }