Merge pull request bugsnag#799 from bugsnag/v7-revert-top-level-metadata

bengourley · web-flow · commit 08555ed8d6ab · 2020-04-09T17:00:40.000+01:00
V7: revert top level metadata
diff --git a/UPGRADING.md b/UPGRADING.md
@@ -237,15 +237,13 @@ It remains possible to supply initial metadata in configuration:
   })
 ```
 
-All metadata is now required to have a section. If you were previously supplying metadata without a section name (this would display on your dashboard under the "Custom" tab), we have enabled passing `null` as the section name for continuity:
+Previously, it was possible to add "top-level" metadata, i.e. data that you did not provide a specific `section` name for. In the dashboard, this would display under a tab with the heading "Custom". Since a section name is now required, for continuity both visually and for any custom filters you may have set up based on such data, you should set the section name to `'custom'`:
 
-```js
-- bugsnagClient.metaData.assetUrl = config.assetUrl
-+ Bugsnag.addMetadata(null, 'assetUrl', config.assetUrl)
+```diff
+- bugsnagClient.metaData = { processId: 'aa874cbd', role: 'image-resizer' }
++ Bugsnag.addMetadata('custom', { processId: 'aa874cbd', role: 'image-resizer' })
 ```
 
-You should only use this method if you have a custom filter based on some top-level metadata, otherwise you should supply a section name for your metadata.
-
 #### Context
 
 On the client, context is now managed via `get/setContext()`:
diff --git a/packages/core/lib/metadata-delegate.js b/packages/core/lib/metadata-delegate.js
@@ -1,7 +1,7 @@
 const assign = require('./es-utils/assign')
 
 const add = (state, section, keyOrObj, maybeVal) => {
-  if (!section && section !== null) return
+  if (!section) return
   let updates
 
   // addMetadata("section", null) -> clears section
@@ -14,14 +14,11 @@ const add = (state, section, keyOrObj, maybeVal) => {
   // exit if we don't have an updates object at this point
   if (!updates) return
 
-  if (section !== null) {
-    // ensure a section with this name exists
-    if (!state[section] || typeof state[section] !== 'object') state[section] = {}
-    // merge the updates with the existing section
-    state[section] = assign({}, state[section], updates)
-  } else {
-    assign(state, updates)
-  }
+  // ensure a section with this name exists
+  if (!state[section]) state[section] = {}
+
+  // merge the updates with the existing section
+  state[section] = assign({}, state[section], updates)
 }
 
 const get = (state, section, key) => {
diff --git a/packages/core/test/client.test.ts b/packages/core/test/client.test.ts
@@ -654,18 +654,6 @@ describe('@bugsnag/core/client', () => {
       expect(client.getMetadata('a', 'b')).toBe(undefined)
       client.clearMetadata('a')
       expect(client.getMetadata('a')).toBe(undefined)
-
-      // check that top-level metadata can be added with section=null
-      client.addMetadata(null, 'top', 'val')
-      expect(client._metadata).toEqual({ top: 'val' })
-      client.addMetadata('top', 'key', 'val')
-      expect(client._metadata).toEqual({ top: { key: 'val' } })
-
-      client._metadata = {}
-
-      client.addMetadata('replace', 'key', 'origval')
-      client.addMetadata(null, 'replace', { diffkey: 'replaceval' })
-      expect(client._metadata).toEqual({ replace: { diffkey: 'replaceval' } })
     })
 
     it('can be set in config', () => {
diff --git a/packages/core/types/client.d.ts b/packages/core/types/client.d.ts
@@ -34,8 +34,8 @@ declare class Client {
   ): void;
 
   // metadata
-  public addMetadata(section: string | null, values: { [key: string]: any }): void;
-  public addMetadata(section: string | null, key: string, value: any): void;
+  public addMetadata(section: string, values: { [key: string]: any }): void;
+  public addMetadata(section: string, key: string, value: any): void;
   public getMetadata(section: string, key?: string): any;
   public clearMetadata(section: string, key?: string): void;
 
diff --git a/packages/core/types/event.d.ts b/packages/core/types/event.d.ts
@@ -38,8 +38,8 @@ declare class Event {
   public setUser(id?: string, email?: string, name?: string): void;
 
   // metadata
-  public addMetadata(section: string | null, values: { [key: string]: any }): void;
-  public addMetadata(section: string | null, key: string, value: any): void;
+  public addMetadata(section: string, values: { [key: string]: any }): void;
+  public addMetadata(section: string, key: string, value: any): void;
   public getMetadata(section: string, key?: string): any;
   public clearMetadata(section: string, key?: string): void;
 }
