fix: Instrumentation version contains package.json content (#1310)

losalex · web-flow · commit 01e12860556b · 2022-08-19T17:58:03.000-07:00
* fix: Instrumentation version contains package.json content

* Fix parameter type

* Another type fix
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@google-cloud/logging",
   "version": "10.1.1",
-  "description": "Stackdriver Logging Client Library for Node.js",
+  "description": "Cloud Logging Client Library for Node.js",
   "keywords": [
     "google apis client",
     "google api client",
diff --git a/samples/package.json b/samples/package.json
@@ -27,4 +27,4 @@
     "supertest": "^6.0.0",
     "uuid": "^8.0.0"
   }
-}
+}
diff --git a/src/utils/instrumentation.ts b/src/utils/instrumentation.ts
@@ -149,11 +149,27 @@ function validateAndUpdateInstrumentation(
 /**
  * A helper function to truncate a value (library name or version for example). The value is truncated
  * when it is longer than {maxLen} chars and '*' is added instead of truncated suffix.
- * @param value {string} The value to be truncated.
+ * @param value {object|string} The value to be truncated.
  * @param maxLen {number} The max length to be used for truncation.
  * @returns {string} The truncated value.
  */
-function truncateValue(value: string, maxLen: number) {
+function truncateValue(value: object | string, maxLen: number) {
+  // Currently there are cases when we get here JSON object instead of string
+  // Adding here additional validation to see if version still can be retrieved
+  if (typeof value !== 'string') {
+    try {
+      if (Object.prototype.hasOwnProperty.call(value, 'version')) {
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        value = (value as any).version;
+      }
+    } catch (err) {
+      // Ignore error since flow should continue
+    }
+  }
+  // Return 'unknown' if version cannot be retrieved
+  if (typeof value !== 'string') {
+    return 'unknown';
+  }
   if (value && value.length > maxLen) {
     return value.substring(0, maxLen).concat('*');
   }
diff --git a/test/instrumentation.ts b/test/instrumentation.ts
@@ -51,6 +51,27 @@ describe('instrumentation_info', () => {
     );
   });
 
+  it('should set library version to unknown', () => {
+    const data = {some: 'value'};
+    const entry = instrumentation.createDiagnosticEntry(
+      undefined,
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      data as any
+    ) as Entry;
+    assert.equal(
+      entry.data?.[instrumentation.DIAGNOSTIC_INFO_KEY]?.[
+        instrumentation.INSTRUMENTATION_SOURCE_KEY
+      ]?.[0]?.[NAME],
+      instrumentation.NODEJS_LIBRARY_NAME_PREFIX
+    );
+    assert.equal(
+      entry.data?.[instrumentation.DIAGNOSTIC_INFO_KEY]?.[
+        instrumentation.INSTRUMENTATION_SOURCE_KEY
+      ]?.[0]?.[VERSION],
+      'unknown'
+    );
+  });
+
   it('should add instrumentation log entry to the list', () => {
     const dummyEntry = createEntry(undefined, undefined);
     const entries = instrumentation.populateInstrumentationInfo(dummyEntry);

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@google-cloud/logging",`
`3`	`3`	`"version": "10.1.1",`
`4`		`- "description": "Stackdriver Logging Client Library for Node.js",`
	`4`	`+ "description": "Cloud Logging Client Library for Node.js",`
`5`	`5`	`"keywords": [`
`6`	`6`	`"google apis client",`
`7`	`7`	`"google api client",`
Original file line number	Diff line number	Diff line change
`@@ -27,4 +27,4 @@`
`27`	`27`	`"supertest": "^6.0.0",`
`28`	`28`	`"uuid": "^8.0.0"`
`29`	`29`	`}`
`30`		`-}`
	`30`	`+}`