fix: Updated regular expression for creating the tracing channel variable (#45)

Author: bizob2828

lib/transforms.js

@@ -14,6 +14,14 @@ const tracingChannelPredicate = (node) => (
   node.declarations?.[0]?.id?.properties?.[0]?.value?.name === 'tr_ch_apm_tracingChannel'
 )
 
+const CHANNEL_REGEX = /[^\w]/g
+/**
+ * Formats the channel variable name by replacing any non-whitespace characters with `_`
+ *
+ * @param {string} channelName
+ */
+const formatChannelVariable = (channelName) => `tr_ch_apm$${channelName.replace(CHANNEL_REGEX, '_')}`
+
 const transforms = module.exports = {
   /**
    * Injects a `tracingChannel` import/require into the program body if one is not
@@ -55,7 +63,7 @@ const transforms = module.exports = {
    */
   tracingChannelDeclaration (state, node) {
     const { channelName, module: { name } } = state
-    const channelVariable = 'tr_ch_apm$' + channelName.replaceAll(':', '_')
+    const channelVariable = formatChannelVariable(channelName)
 
     if (node.body.some(child => child.declarations?.[0]?.id?.name === channelVariable)) return
 
@@ -313,7 +321,7 @@ function wrapSuper (_state, node) {
  */
 function wrapCallback (state, node) {
   const { channelName, functionQuery: { callbackIndex = -1 } } = state
-  const channelVariable = 'tr_ch_apm$' + channelName.replaceAll(':', '_')
+  const channelVariable = formatChannelVariable(channelName)
 
   return parse(`
     function wrapper () {
@@ -373,7 +381,7 @@ function wrapCallback (state, node) {
  */
 function wrapPromise (state, node) {
   const { channelName } = state
-  const channelVariable = 'tr_ch_apm$' + channelName.replaceAll(':', '_')
+  const channelVariable = formatChannelVariable(channelName)
 
   return parse(`
     function wrapper () {
@@ -426,7 +434,7 @@ function wrapPromise (state, node) {
  */
 function wrapSync (state, node) {
   const { channelName } = state
-  const channelVariable = 'tr_ch_apm$' + channelName.replaceAll(':', '_')
+  const channelVariable = formatChannelVariable(channelName)
 
   return parse(`
     function wrapper () {

tests/arguments_mutation/test.js

@@ -22,7 +22,7 @@ const handler = {
 };
 
 tracingChannel('orchestrion:undici:fetch_simple').subscribe(handler);
-tracingChannel('orchestrion:undici:fetch_complex').subscribe(handler);
+tracingChannel('orchestrion:undici:fetch.complex').subscribe(handler);
 
 assert.strictEqual(fetch_simple.length, 2);
 assert.strictEqual(fetch_complex.length, 2);

tests/callback_cjs/test.js

@@ -1,6 +1,6 @@
 const { fetch } = require('./instrumented.js');
 const { assert, getContext } = require('../common/preamble.js');
-const context = getContext('orchestrion:undici:fetch_cb');
+const context = getContext('orchestrion:undici:fetch.cb');
 (async () => {
   const result = await new Promise((resolve, reject) => {
     fetch('https://example.com', (err, val) => {

tests/decl_cjs/test.js

@@ -4,7 +4,7 @@
  **/
 const { fetch } = require('./instrumented.js');
 const { assert, getContext } = require('../common/preamble.js');
-const context = getContext('orchestrion:undici:fetch_decl');
+const context = getContext('orchestrion:undici:fetch.decl');
 (async () => {
   const result = await fetch('https://example.com');
   assert.strictEqual(result, 42);

tests/tests.test.mjs

@@ -55,7 +55,7 @@ describe('arguments_mutation', () => {
         functionQuery: { functionName: 'fetch_simple', kind: 'Sync' },
       },
       {
-        channelName: 'fetch_complex',
+        channelName: 'fetch.complex',
         module: { name: TEST_MODULE_NAME, versionRange: '>=0.0.1', filePath: TEST_MODULE_PATH },
         functionQuery: { functionName: 'fetch_complex', kind: 'Sync' },
       },
@@ -115,7 +115,7 @@ describe('decl_cjs', () => {
   test('instruments async function declaration (cjs)', () => {
     runTest('decl_cjs', [
       {
-        channelName: 'fetch_decl',
+        channelName: 'fetch.decl',
         module: { name: TEST_MODULE_NAME, versionRange: '>=0.0.1', filePath: TEST_MODULE_PATH },
         functionQuery: { functionName: 'fetch', kind: 'Async' },
       },
@@ -264,7 +264,7 @@ describe('callback_cjs', () => {
   test('instruments callback-style function', () => {
     runTest('callback_cjs', [
       {
-        channelName: 'fetch_cb',
+        channelName: 'fetch.cb',
         module: { name: TEST_MODULE_NAME, versionRange: '>=0.0.1', filePath: TEST_MODULE_PATH },
         functionQuery: { functionName: 'fetch', kind: 'Callback' },
       },