chore(deps): remove snakecase-keys dependency (#1038)

freelerobot · web-flow · commit 2496d2a192ae · 2021-04-15T01:10:06.000Z
Before: **Total dependencies size: 22.49M** After: **Total dependencies size: 22.46M** improvement: ~30kB Part of #1037
diff --git a/package.json b/package.json
@@ -60,7 +60,6 @@
     "google-gax": "^2.9.2",
     "on-finished": "^2.3.0",
     "pumpify": "^2.0.1",
-    "snakecase-keys": "^3.1.2",
     "stream-events": "^1.0.5"
   },
   "devDependencies": {
diff --git a/src/log.ts b/src/log.ts
@@ -26,9 +26,6 @@ import {Entry, EntryJson, LogEntry} from './entry';
 import {getDefaultResource} from './metadata';
 import {GoogleAuth} from 'google-auth-library/build/src/auth/googleauth';
 
-// eslint-disable-next-line @typescript-eslint/no-var-requires
-const snakeCaseKeys = require('snakecase-keys');
-
 export interface GetEntriesRequest {
   autoPaginate?: boolean;
   filter?: string;
@@ -891,9 +888,7 @@ class Log implements LogSeverityFunctions {
     // eslint-disable-next-line @typescript-eslint/no-this-alias
     const self = this;
     if (options.resource) {
-      if (options.resource.labels) {
-        options.resource.labels = snakeCaseKeys(options.resource.labels);
-      }
+      if (options.resource.labels) snakecaseKeys(options.resource.labels);
       return writeWithResource(options.resource);
     } else if (this.logging.detectedResource) {
       return writeWithResource(this.logging.detectedResource);
@@ -928,6 +923,17 @@ class Log implements LogSeverityFunctions {
         options.gaxOptions
       );
     }
+    // snakecaseKeys turns label keys from camel case to snake case.
+    function snakecaseKeys(labels: {[p: string]: string} | null | undefined) {
+      for (const key in labels) {
+        Object.defineProperty(
+          labels,
+          key.replace(/[A-Z]/g, letter => `_${letter.toLowerCase()}`),
+          Object.getOwnPropertyDescriptor(labels, key) as PropertyDescriptor
+        );
+        delete labels[key];
+      }
+    }
   }
 
   // TODO proper signature of `private decorateEntries` (sans underscore suffix)
diff --git a/test/log.ts b/test/log.ts
@@ -395,7 +395,14 @@ describe('Log', () => {
     });
 
     it('should forward options.resource to request', async () => {
-      const CUSTOM_RESOURCE = 'custom-resource';
+      // Also check it should snakecase resource labels, as many sources & docs
+      // wrongly instruct users to use camelcase.
+      const CUSTOM_RESOURCE = {
+        labels: {
+          projectId: 'fake-project',
+          regionZone: 'us-west-1',
+        },
+      };
       const optionsWithResource = extend({}, OPTIONS, {
         resource: CUSTOM_RESOURCE,
       }) as WriteOptions;
@@ -406,7 +413,12 @@ describe('Log', () => {
           {
             logName: log.formattedName_,
             entries: ENTRIES,
-            resource: CUSTOM_RESOURCE,
+            resource: {
+              labels: {
+                project_id: 'fake-project',
+                region_zone: 'us-west-1',
+              },
+            },
           },
           undefined
         )
