fix(neo4j): fixed crash when connecting with aura (#78)

Author: Nir Hadassi

.github/workflows/test.yml

@@ -32,7 +32,7 @@ jobs:
         run: yarn
 
       - name: Build
-        run: yarn build
+        run: yarn build:ci
 
       - name: Test
         run: yarn test:ci

package.json

@@ -5,6 +5,7 @@
         "test": "lerna run test",
         "test:ci": "lerna run test:ci --since origin/master",
         "build": "lerna run build",
+        "build:ci": "lerna run build --since origin/master",
         "postinstall": "lerna bootstrap",
         "prettier": "prettier --config .prettierrc.yml --write \"**/*.{ts,tsx,js,jsx,json}\"",
         "version:update": "lerna run version:update",

packages/instrumentation-neo4j/src/utils.ts

@@ -1,19 +1,27 @@
 import { DatabaseAttribute, GeneralAttribute } from '@opentelemetry/semantic-conventions';
 
 export function getAttributesFromNeo4jSession(session: any) {
-    const connectionHolder = (session._mode === 'WRITE' ? session._writeConnectionHolder : session._readConnectionHolder) ?? session._connectionHolder;
-    const address = connectionHolder._connectionProvider._address;
-    const auth = connectionHolder._connectionProvider._authToken;
+    const connectionHolder =
+        (session._mode === 'WRITE' ? session._writeConnectionHolder : session._readConnectionHolder) ??
+        session._connectionHolder ??
+        {};
+    const connectionProvider = connectionHolder._connectionProvider ?? {};
+
+    // seedRouter is used when connecting to a url that starts with "neo4j", usually aura
+    const address = connectionProvider._address ?? connectionProvider._seedRouter;
+    const auth = connectionProvider._authToken;
 
     const attributes = {
-        [GeneralAttribute.NET_PEER_NAME]: address._host,
-        [GeneralAttribute.NET_PEER_PORT]: address._port,
         [GeneralAttribute.NET_TRANSPORT]: 'IP.TCP',
         // "neo4j" is the default database name. When used, "session._database" is an empty string
-        [DatabaseAttribute.DB_NAME]: session._database ? session._database : 'neo4j'
+        [DatabaseAttribute.DB_NAME]: session._database ? session._database : 'neo4j',
+    };
+    if (address) {
+        attributes[GeneralAttribute.NET_PEER_NAME] = address._host;
+        attributes[GeneralAttribute.NET_PEER_PORT] = address._port;
     }
     if (auth?.principal) {
         attributes[DatabaseAttribute.DB_USER] = auth.principal;
     }
     return attributes;
-}
+}

packages/instrumentation-neo4j/test/neo4j.spec.ts

@@ -44,19 +44,21 @@ describe('neo4j instrumentation', function () {
         driver = neo4j.driver('bolt://localhost:11011', neo4j.auth.basic('neo4j', 'test'), {
             disableLosslessIntegers: true,
         });
-        
+
         let keepChecking = true;
-        const timeoutId = setTimeout(() => { keepChecking = false}, 8000);
+        const timeoutId = setTimeout(() => {
+            keepChecking = false;
+        }, 8000);
         while (keepChecking) {
             try {
                 await driver.verifyConnectivity();
                 clearTimeout(timeoutId);
                 return;
             } catch (err) {
                 await new Promise((res) => setTimeout(res, 1000));
-            } 
+            }
         }
-        throw new Error('Could not connect to neo4j in allowed time frame')
+        throw new Error('Could not connect to neo4j in allowed time frame');
     });
 
     after(async () => {
@@ -147,7 +149,7 @@ describe('neo4j instrumentation', function () {
 
         it('when passing "onKeys" and onCompleted, span is closed in onCompleted, and response hook is called', (done) => {
             instrumentation.disable();
-            instrumentation.setConfig({ responseHook: (span) => span.setAttribute('test', 'cool')});
+            instrumentation.setConfig({ responseHook: (span) => span.setAttribute('test', 'cool') });
             instrumentation.enable();
 
             driver
@@ -163,7 +165,7 @@ describe('neo4j instrumentation', function () {
                         assertSpan(span);
                         expect(span.attributes['test']).toBe('cool');
                         done();
-                    }
+                    },
                 });
         });
 
@@ -465,4 +467,34 @@ describe('neo4j instrumentation', function () {
                 });
         });
     });
+
+    describe('routing mode', () => {
+        // When the connection string starts with "neo4j" routing mode is used
+        let routingDriver: Driver;
+        const version = require('neo4j-driver/package.json').version;
+        const shouldCheck = !['4.0.0', '4.0.1', '4.0.2'].includes(version)
+
+        before(() => {
+            if (shouldCheck) {
+                routingDriver = neo4j.driver('neo4j://localhost:11011', neo4j.auth.basic('neo4j', 'test'));
+            }
+        });
+
+        after(async () => {
+            shouldCheck && await routingDriver.close();
+        });
+
+        it('instruments as expected in routing mode', async () => {
+            if (!shouldCheck) {
+                // Versions 4.0.0, 4.0.1 and 4.0.2 of neo4j-driver don't allow connection to local neo4j in routing mode.
+                console.log(`Skipping unsupported test for version ${version}`)
+                return;
+            }
+
+            await routingDriver.session().run('CREATE (n:MyLabel) RETURN n');
+
+            const span = getSingleSpan();
+            assertSpan(span);
+        });
+    });
 });