Commit fc91338

authored

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

V7: allow top level metadata

2 parents 77ab4de + 23e3a02 commit fc91338Copy full SHA for fc91338

File tree

+34

-10

lines changed

+34

-10

lines changed

Lines changed: 9 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -237,6 +237,15 @@ 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:
	`241`	`+`
	`242`	+```js
	`243`	`+- bugsnagClient.metaData.assetUrl = config.assetUrl`
	`244`	`++ Bugsnag.addMetadata(null, 'assetUrl', config.assetUrl)`
	`245`	+```
	`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`	`+`
`240`	`249`	`#### Context`
`241`	`250`
`242`	`251`	On the client, context is now managed via `get/setContext()`:

Lines changed: 9 additions & 6 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) return`
	`4`	`+ if (!section&&section!==null) return`
`5`	`5`	`let updates`
`6`	`6`
`7`	`7`	`// addMetadata("section", null) -> clears section`
`@@ -14,11 +14,14 @@ 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`		`- // 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)`
	`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`	`+ }`
`22`	`25`	`}`
`23`	`26`
`24`	`27`	`const get = (state, section, key) => {`

Lines changed: 12 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -639,6 +639,18 @@ describe('@bugsnag/core/client', () => {`
`639`	`639`	`expect(client.getMetadata('a', 'b')).toBe(undefined)`
`640`	`640`	`client.clearMetadata('a')`
`641`	`641`	`expect(client.getMetadata('a')).toBe(undefined)`
	`642`	`+`
	`643`	`+ // check that top-level metadata can be added with section=null`
	`644`	`+ client.addMetadata(null, 'top', 'val')`
	`645`	`+ expect(client._metadata).toEqual({ top: 'val' })`
	`646`	`+ client.addMetadata('top', 'key', 'val')`
	`647`	`+ expect(client._metadata).toEqual({ top: { key: 'val' } })`
	`648`	`+`
	`649`	`+ client._metadata = {}`
	`650`	`+`
	`651`	`+ client.addMetadata('replace', 'key', 'origval')`
	`652`	`+ client.addMetadata(null, 'replace', { diffkey: 'replaceval' })`
	`653`	`+ expect(client._metadata).toEqual({ replace: { diffkey: 'replaceval' } })`
`642`	`654`	`})`
`643`	`655`
`644`	`656`	`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, values: { [key: string]: any }): void;`
`38`		`- public addMetadata(section: string, key: string, value: any): void;`
	`37`	`+ public addMetadata(section: string\|null, values: { [key: string]: any }): void;`
	`38`	`+ public addMetadata(section: string\|null, 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, values: { [key: string]: any }): void;`
`42`		`- public addMetadata(section: string, key: string, value: any): void;`
	`41`	`+ public addMetadata(section: string\|null, values: { [key: string]: any }): void;`
	`42`	`+ public addMetadata(section: string\|null, 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)