Commit 08555ed

authored

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

V7: revert top level metadata

2 parents d938f37 + 08022ba commit 08555edCopy full SHA for 08555ed

File tree

+14

-31

lines changed

+14

-31

lines changed

Lines changed: 4 additions & 6 deletions

Original file line number	Diff line number	Diff line change
`@@ -237,15 +237,13 @@ It remains possible to supply initial metadata in configuration:`
`237`	`237`	`})`
`238`	`238`	```
`239`	`239`
`240`		-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:
	`240`	+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'`:
`241`	`241`
`242`		-```js
`243`		`-- bugsnagClient.metaData.assetUrl = config.assetUrl`
`244`		`-+ Bugsnag.addMetadata(null, 'assetUrl', config.assetUrl)`
	`242`	+```diff
	`243`	`+- bugsnagClient.metaData = { processId: 'aa874cbd', role: 'image-resizer' }`
	`244`	`++ Bugsnag.addMetadata('custom', { processId: 'aa874cbd', role: 'image-resizer' })`
`245`	`245`	```
`246`	`246`
`247`		`-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.`
`248`		`-`
`249`	`247`	`#### Context`
`250`	`248`
`251`	`249`	On the client, context is now managed via `get/setContext()`:

Lines changed: 6 additions & 9 deletions

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`const assign = require('./es-utils/assign')`
`2`	`2`
`3`	`3`	`const add = (state, section, keyOrObj, maybeVal) => {`
`4`		`- if (!section&&section!==null) return`
	`4`	`+ if (!section) return`
`5`	`5`	`let updates`
`6`	`6`
`7`	`7`	`// addMetadata("section", null) -> clears section`
`@@ -14,14 +14,11 @@ const add = (state, section, keyOrObj, maybeVal) => {`
`14`	`14`	`// exit if we don't have an updates object at this point`
`15`	`15`	`if (!updates) return`
`16`	`16`
`17`		`- if (section !== null) {`
`18`		`- // ensure a section with this name exists`
`19`		`- if (!state[section] \|\| typeof state[section] !== 'object') state[section] = {}`
`20`		`- // merge the updates with the existing section`
`21`		`- state[section] = assign({}, state[section], updates)`
`22`		`- } else {`
`23`		`- assign(state, updates)`
`24`		`- }`
	`17`	`+ // ensure a section with this name exists`
	`18`	`+ if (!state[section]) state[section] = {}`
	`19`	`+`
	`20`	`+ // merge the updates with the existing section`
	`21`	`+ state[section] = assign({}, state[section], updates)`
`25`	`22`	`}`
`26`	`23`
`27`	`24`	`const get = (state, section, key) => {`

Lines changed: 0 additions & 12 deletions

Original file line number	Diff line number	Diff line change
`@@ -654,18 +654,6 @@ describe('@bugsnag/core/client', () => {`
`654`	`654`	`expect(client.getMetadata('a', 'b')).toBe(undefined)`
`655`	`655`	`client.clearMetadata('a')`
`656`	`656`	`expect(client.getMetadata('a')).toBe(undefined)`
`657`		`-`
`658`		`- // check that top-level metadata can be added with section=null`
`659`		`- client.addMetadata(null, 'top', 'val')`
`660`		`- expect(client._metadata).toEqual({ top: 'val' })`
`661`		`- client.addMetadata('top', 'key', 'val')`
`662`		`- expect(client._metadata).toEqual({ top: { key: 'val' } })`
`663`		`-`
`664`		`- client._metadata = {}`
`665`		`-`
`666`		`- client.addMetadata('replace', 'key', 'origval')`
`667`		`- client.addMetadata(null, 'replace', { diffkey: 'replaceval' })`
`668`		`- expect(client._metadata).toEqual({ replace: { diffkey: 'replaceval' } })`
`669`	`657`	`})`
`670`	`658`
`671`	`659`	`it('can be set in config', () => {`

Lines changed: 2 additions & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -34,8 +34,8 @@ declare class Client {`
`34`	`34`	`): void;`
`35`	`35`
`36`	`36`	`// metadata`
`37`		`- public addMetadata(section: string\|null, values: { [key: string]: any }): void;`
`38`		`- public addMetadata(section: string\|null, key: string, value: any): void;`
	`37`	`+ public addMetadata(section: string, values: { [key: string]: any }): void;`
	`38`	`+ public addMetadata(section: string, key: string, value: any): void;`
`39`	`39`	`public getMetadata(section: string, key?: string): any;`
`40`	`40`	`public clearMetadata(section: string, key?: string): void;`
`41`	`41`

Lines changed: 2 additions & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -38,8 +38,8 @@ declare class Event {`
`38`	`38`	`public setUser(id?: string, email?: string, name?: string): void;`
`39`	`39`
`40`	`40`	`// metadata`
`41`		`- public addMetadata(section: string\|null, values: { [key: string]: any }): void;`
`42`		`- public addMetadata(section: string\|null, key: string, value: any): void;`
	`41`	`+ public addMetadata(section: string, values: { [key: string]: any }): void;`
	`42`	`+ public addMetadata(section: string, key: string, value: any): void;`
`43`	`43`	`public getMetadata(section: string, key?: string): any;`
`44`	`44`	`public clearMetadata(section: string, key?: string): void;`
`45`	`45`	`}`

Comments

(0)