Skip to content

Commit 40354f2

Browse files
bengourleybengourley
authored
Merge branch 'next' into bengourley/expo-sdk38-support
2 parents 9b1488e + 3460273 commit 40354f2

32 files changed

+338
-21
lines changed

‎CHANGELOG.md

+8
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,14 @@
22

33
## TBD
44

5+
### Added
6+
7+
- (browser|node) Record the length of time the app has been running when an error occurs [#881](https://github.com/bugsnag/bugsnag-js/pull/881)
8+
- (plugin-browser-device): Add device orientation to error reports [#881](https://github.com/bugsnag/bugsnag-js/pull/881)
9+
- (plugin-expo-device): Add device manufacturer and model name for non-iOS devices to error reports [#881](https://github.com/bugsnag/bugsnag-js/pull/881)
10+
- (plugin-expo-device): Add total memory to error reports [#881](https://github.com/bugsnag/bugsnag-js/pull/881)
11+
- (plugin-node-device): Add OS name, OS version, total memory and free memory to error reports [#881](https://github.com/bugsnag/bugsnag-js/pull/881)
12+
513
### Fixed
614
- (plugin-express): Ensure `req.body` is always present in metadata by collecting it at the last possible moment [#872](https://github.com/bugsnag/bugsnag-js/pull/872)
715

‎README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Etc. See [packages](/packages) for a full list of contents.
1919
1. [Create a Bugsnag account](https://www.bugsnag.com)
2020
2. Complete the instructions in the [integration guide](https://docs.bugsnag.com/platforms/javascript/)
2121
3. Report handled exceptions using
22-
[`bugsnagClient.notify()`](https://docs.bugsnag.com/platforms/javascript/#reporting-handled-exceptions)
22+
[`Bugsnag.notify()`](https://docs.bugsnag.com/platforms/javascript/#reporting-handled-exceptions)
2323
4. Customize your integration using the
2424
[configuration options](https://docs.bugsnag.com/platforms/javascript/configuration-options/)
2525

‎UPGRADING.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -360,9 +360,9 @@ Here are some examples:
360360
- }
361361
- })
362362
+ Bugsnag.notify(err, event => {
363-
+ event.addMetadata('component, {
363+
+ event.addMetadata('component', {
364364
+ instanceId: component.instanceId
365-
+ }
365+
+ })
366366
+ })
367367

368368
// preventing send

‎bin/local-test-util

+1-1
Original file line numberDiff line numberDiff line change
@@ -247,6 +247,6 @@ async function runTests (args) {
247247
`-v`, `${process.cwd()}/test/browser/:/app/test/browser`,
248248
`-w`, `/app/test/browser`,
249249
`-p`, `9020:9020`,
250-
`855461928731.dkr.ecr.us-west-1.amazonaws.com/maze-runner:v2-cli`
250+
`855461928731.dkr.ecr.us-west-1.amazonaws.com/maze-runner:latest-cli`
251251
].concat(args || []))
252252
}

‎dockerfiles/Dockerfile.browser

+1-1
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ RUN find . -name package.json -type f -mindepth 2 -maxdepth 3 ! -path "./node_mo
4545
RUN rm -fr **/*/node_modules/
4646

4747
# The maze-runner browser tests
48-
FROM 855461928731.dkr.ecr.us-west-1.amazonaws.com/maze-runner:v2.0.0-cli as browser-maze-runner
48+
FROM 855461928731.dkr.ecr.us-west-1.amazonaws.com/maze-runner:latest-cli as browser-maze-runner
4949
RUN apk add --no-cache ruby-dev build-base libffi-dev curl-dev
5050
ENV GLIBC_VERSION 2.23-r3
5151

‎dockerfiles/Dockerfile.expo

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# CI test image for unit/lint/type tests
2-
FROM 855461928731.dkr.ecr.us-west-1.amazonaws.com/maze-runner:v2.0.0-cli as expo-maze-runner
2+
FROM 855461928731.dkr.ecr.us-west-1.amazonaws.com/maze-runner:latest-cli as expo-maze-runner
33
RUN apk add --no-cache ruby-dev build-base libffi-dev curl-dev curl
44
COPY /test/expo /app/test/expo
55
WORKDIR /app/test/expo

‎dockerfiles/Dockerfile.node

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ RUN npm pack --verbose packages/plugin-koa/
2121
RUN npm pack --verbose packages/plugin-restify/
2222

2323
# The maze-runner node tests
24-
FROM 855461928731.dkr.ecr.us-west-1.amazonaws.com/maze-runner:v2.0.0-cli as node-maze-runner
24+
FROM 855461928731.dkr.ecr.us-west-1.amazonaws.com/maze-runner:latest-cli as node-maze-runner
2525
WORKDIR /app/
2626
COPY packages/node/ .
2727
COPY test/node test/node

‎jest.config.js

+6
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,12 @@ module.exports = {
88
testsForPackage('core')
99
]
1010
},
11+
{
12+
displayName: 'shared plugins',
13+
testMatch: [
14+
testsForPackage('plugin-app-duration')
15+
]
16+
},
1117
{
1218
displayName: 'browser plugins',
1319
testMatch: [

‎packages/browser/package.json

+1
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@
3535
"@bugsnag/core": "^7.0.1",
3636
"@bugsnag/delivery-x-domain-request": "^7.1.1",
3737
"@bugsnag/delivery-xml-http-request": "^7.1.1",
38+
"@bugsnag/plugin-app-duration": "^7.1.1",
3839
"@bugsnag/plugin-browser-context": "^7.1.1",
3940
"@bugsnag/plugin-browser-device": "^7.1.1",
4041
"@bugsnag/plugin-browser-request": "^7.1.1",

‎packages/browser/src/notifier.js

+2
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ const schema = assign({}, require('@bugsnag/core/config').schema, require('./con
1616

1717
const pluginWindowOnerror = require('@bugsnag/plugin-window-onerror')
1818
const pluginUnhandledRejection = require('@bugsnag/plugin-window-unhandled-rejection')
19+
const pluginApp = require('@bugsnag/plugin-app-duration')
1920
const pluginDevice = require('@bugsnag/plugin-browser-device')
2021
const pluginContext = require('@bugsnag/plugin-browser-context')
2122
const pluginRequest = require('@bugsnag/plugin-browser-request')
@@ -42,6 +43,7 @@ const Bugsnag = {
4243

4344
const internalPlugins = [
4445
// add browser-specific plugins
46+
pluginApp,
4547
pluginDevice(),
4648
pluginContext(),
4749
pluginRequest(),

‎packages/node/package.json

+1
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@
2626
"license": "MIT",
2727
"devDependencies": {
2828
"@bugsnag/delivery-node": "^7.1.1",
29+
"@bugsnag/plugin-app-duration": "^7.1.1",
2930
"@bugsnag/plugin-contextualize": "^7.1.1",
3031
"@bugsnag/plugin-intercept": "^7.1.1",
3132
"@bugsnag/plugin-node-device": "^7.1.1",

‎packages/node/src/notifier.js

+2
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ const schema = { ...require('@bugsnag/core/config').schema, ...require('./config
1515
// remove enabledBreadcrumbTypes from the config schema
1616
delete schema.enabledBreadcrumbTypes
1717

18+
const pluginApp = require('@bugsnag/plugin-app-duration')
1819
const pluginSurroundingCode = require('@bugsnag/plugin-node-surrounding-code')
1920
const pluginInProject = require('@bugsnag/plugin-node-in-project')
2021
const pluginStripProjectRoot = require('@bugsnag/plugin-strip-project-root')
@@ -26,6 +27,7 @@ const pluginIntercept = require('@bugsnag/plugin-intercept')
2627
const pluginContextualize = require('@bugsnag/plugin-contextualize')
2728

2829
const internalPlugins = [
30+
pluginApp,
2931
pluginSurroundingCode,
3032
pluginInProject,
3133
pluginStripProjectRoot,

‎packages/plugin-app-duration/LICENSE.txt

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
Copyright (c) Bugsnag, https://www.bugsnag.com/
2+
3+
Permission is hereby granted, free of charge, to any person obtaining
4+
a copy of this software and associated documentation files (the "Software"),
5+
to deal in the Software without restriction, including without limitation
6+
the rights to use, copy, modify, merge, publish, distribute, sublicense,
7+
and/or sell copies of the Software, and to permit persons to whom the Software
8+
is furnished to do so, subject to the following conditions:
9+
10+
The above copyright notice and this permission notice shall be included in
11+
all copies or substantial portions of the Software.
12+
13+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
19+
THE SOFTWARE.

‎packages/plugin-app-duration/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# @bugsnag/plugin-app-duration
2+
3+
This plugin adds the duration an application has been running for to the `app` section of each event. It is included in the browser and node notifiers.
4+
5+
## License
6+
MIT

‎packages/plugin-app-duration/app.js

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
const appStart = new Date()
2+
3+
module.exports = {
4+
load: client => {
5+
client.addOnError(event => {
6+
const now = new Date()
7+
8+
event.app.duration = now - appStart
9+
}, true)
10+
}
11+
}

‎packages/plugin-app-duration/package.json

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
{
2+
"name": "@bugsnag/plugin-app-duration",
3+
"version": "7.1.1",
4+
"main": "app.js",
5+
"description": "@bugsnag/js plugin to set app duration in browsers and node",
6+
"homepage": "https://www.bugsnag.com/",
7+
"repository": {
8+
"type": "git",
9+
"url": "[email protected]:bugsnag/bugsnag-js.git"
10+
},
11+
"publishConfig": {
12+
"access": "public"
13+
},
14+
"files": [
15+
"*.js"
16+
],
17+
"author": "Bugsnag",
18+
"license": "MIT",
19+
"devDependencies": {
20+
"@bugsnag/core": "^7.1.1"
21+
}
22+
}

‎packages/plugin-app-duration/test/app.test.ts

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
import plugin from '../app'
2+
import Client from '@bugsnag/core/client'
3+
4+
describe('plugin-app-duration', () => {
5+
it('includes duration in event.app', done => {
6+
const client = new Client({ apiKey: 'api_key', plugins: [plugin] })
7+
8+
client._setDelivery(client => ({
9+
sendEvent: payload => {
10+
// The maximum number of milliseconds 'duration' should be
11+
const maximum = 5000
12+
13+
expect(payload.events[0].app.duration).toBeGreaterThanOrEqual(0)
14+
expect(payload.events[0].app.duration).toBeLessThanOrEqual(maximum)
15+
16+
done()
17+
},
18+
sendSession: () => {}
19+
}))
20+
21+
client.notify(new Error('acbd'))
22+
})
23+
})

‎packages/plugin-browser-device/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# @bugsnag/plugin-browser-device
22

3-
This plugin adds the device time, locale and user agent to the `device` section of each event, and adds the user agent to session payloads. It is included in the browser notifier.
3+
This plugin adds the device time, locale, user agent and screen orientation to the `device` section of each event, and adds the locale, user agent and screen orientation to session payloads. It is included in the browser notifier.
44

55
## License
66
MIT

‎packages/plugin-browser-device/device.js

+10-1
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,22 @@ const assign = require('@bugsnag/core/lib/es-utils/assign')
33
/*
44
* Automatically detects browser device details
55
*/
6-
module.exports = (nav = navigator) => ({
6+
module.exports = (nav = navigator, screen = window.screen) => ({
77
load: (client) => {
88
const device = {
99
locale: nav.browserLanguage || nav.systemLanguage || nav.userLanguage || nav.language,
1010
userAgent: nav.userAgent
1111
}
1212

13+
if (screen && screen.orientation && screen.orientation.type) {
14+
device.orientation = screen.orientation.type
15+
} else {
16+
device.orientation =
17+
document.documentElement.clientWidth > document.documentElement.clientHeight
18+
? 'landscape'
19+
: 'portrait'
20+
}
21+
1322
client.addOnSession(session => {
1423
session.device = assign({}, session.device, device)
1524
})

‎packages/plugin-browser-device/test/device.test.ts

+41
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ import plugin from '../device'
33
import Client, { SessionDeliveryPayload, EventDeliveryPayload } from '@bugsnag/core/client'
44

55
const navigator = { language: 'en-GB', userAgent: 'testing browser 1.2.3' } as unknown as Navigator
6+
const screen = { orientation: { type: 'landscape-primary' } } as unknown as Screen
67

78
describe('plugin: device', () => {
89
it('should add an onError callback which captures device information', () => {
@@ -19,6 +20,24 @@ describe('plugin: device', () => {
1920
expect(payloads[0].events[0].device.time instanceof Date).toBe(true)
2021
expect(payloads[0].events[0].device.locale).toBe(navigator.language)
2122
expect(payloads[0].events[0].device.userAgent).toBe(navigator.userAgent)
23+
expect(payloads[0].events[0].device.orientation).toBe('portrait')
24+
})
25+
26+
it('should capture the screen orientation if possible and add it to the event', () => {
27+
const client = new Client({ apiKey: 'API_KEY_YEAH', plugins: [plugin(navigator, screen)] })
28+
const payloads: EventDeliveryPayload[] = []
29+
30+
expect(client._cbs.e.length).toBe(1)
31+
32+
client._setDelivery(client => ({ sendEvent: (payload) => payloads.push(payload), sendSession: () => {} }))
33+
client.notify(new Error('noooo'))
34+
35+
expect(payloads.length).toEqual(1)
36+
expect(payloads[0].events[0].device).toBeDefined()
37+
expect(payloads[0].events[0].device.time instanceof Date).toBe(true)
38+
expect(payloads[0].events[0].device.locale).toBe(navigator.language)
39+
expect(payloads[0].events[0].device.userAgent).toBe(navigator.userAgent)
40+
expect(payloads[0].events[0].device.orientation).toBe('landscape-primary')
2241
})
2342

2443
it('should add an onSession callback which captures device information', () => {
@@ -39,5 +58,27 @@ describe('plugin: device', () => {
3958
expect(payloads[0].device).toBeDefined()
4059
expect(payloads[0].device && payloads[0].device.locale).toBe(navigator.language)
4160
expect(payloads[0].device && payloads[0].device.userAgent).toBe(navigator.userAgent)
61+
expect(payloads[0].device && payloads[0].device.orientation).toBe('portrait')
62+
})
63+
64+
it('should capture the screen orientation if possible and add it to the session', () => {
65+
const client = new Client({ apiKey: 'API_KEY_YEAH', plugins: [plugin(navigator, screen)] })
66+
const payloads: SessionDeliveryPayload[] = []
67+
client._sessionDelegate = {
68+
startSession: (client, session) => {
69+
client._delivery.sendSession(session, () => {})
70+
}
71+
}
72+
73+
expect(client._cbs.s.length).toBe(1)
74+
75+
client._setDelivery(client => ({ sendEvent: () => {}, sendSession: (payload) => payloads.push(payload) }))
76+
client.startSession()
77+
78+
expect(payloads.length).toEqual(1)
79+
expect(payloads[0].device).toBeDefined()
80+
expect(payloads[0].device && payloads[0].device.locale).toBe(navigator.language)
81+
expect(payloads[0].device && payloads[0].device.userAgent).toBe(navigator.userAgent)
82+
expect(payloads[0].device && payloads[0].device.orientation).toBe('landscape-primary')
4283
})
4384
})

‎packages/plugin-expo-app/app.js

+3
Original file line numberDiff line numberDiff line change
@@ -34,11 +34,14 @@ module.exports = {
3434
client.addOnError(event => {
3535
const now = new Date()
3636
const inForeground = AppState.currentState === 'active'
37+
3738
event.app.inForeground = inForeground
3839
event.app.duration = now - appStart
40+
3941
if (inForeground) {
4042
event.app.durationInForeground = now - lastEnteredForeground
4143
}
44+
4245
event.addMetadata('app', { nativeBundleVersion, nativeVersionCode })
4346

4447
if (Constants.manifest.revisionId) {

‎packages/plugin-expo-app/test/app.test.js

+40
Original file line numberDiff line numberDiff line change
@@ -144,4 +144,44 @@ describe('plugin: expo app', () => {
144144
}, 20)
145145
}, 20)
146146
})
147+
148+
it('includes duration in event.app', done => {
149+
const start = Date.now()
150+
151+
const plugin = proxyquire('../', {
152+
'expo-constants': {
153+
default: {
154+
platform: {},
155+
manifest: {}
156+
}
157+
},
158+
'react-native': {
159+
AppState: {
160+
addEventListener: (name, fn) => {},
161+
currentState: 'active'
162+
}
163+
}
164+
})
165+
166+
const client = new Client({ apiKey: 'api_key', plugins: [plugin] })
167+
168+
// Delay sending the notification by this many milliseconds to ensure
169+
// 'duration' will always have a useful value
170+
const delayMs = 10
171+
172+
client._setDelivery(client => ({
173+
sendEvent: (payload) => {
174+
// The maximum number of milliseconds 'duration' should be
175+
const maximum = Date.now() - start
176+
177+
expect(payload.events[0].app.duration).toBeGreaterThanOrEqual(delayMs)
178+
expect(payload.events[0].app.duration).toBeLessThanOrEqual(maximum)
179+
180+
done()
181+
},
182+
sendSession: () => {}
183+
}))
184+
185+
setTimeout(() => client.notify(new Error('flooopy doo')), delayMs)
186+
})
147187
})

‎packages/plugin-expo-device/device.js

+10-3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
const Device = require('expo-device')
12
const Constants = require('expo-constants').default
23
const { Dimensions, Platform } = require('react-native')
34
const rnVersion = require('react-native/package.json').version
@@ -22,8 +23,13 @@ module.exports = {
2223

2324
const device = {
2425
id: Constants.installationId,
25-
manufacturer: Constants.platform.ios ? 'Apple' : undefined,
26-
model: Constants.platform.ios ? Constants.platform.ios.model : undefined,
26+
manufacturer: Device.manufacturer,
27+
// On a real device these two seem equivalent, however on a simulator
28+
// 'Constants' is a bit more useful as it returns 'Simulator' whereas
29+
// 'Device' just returns 'iPhone'
30+
model: Constants.platform.ios
31+
? Constants.platform.ios.model
32+
: Device.modelName,
2733
modelNumber: Constants.platform.ios ? Constants.platform.ios.platform : undefined,
2834
osName: Platform.OS,
2935
osVersion: Constants.platform.ios ? Constants.platform.ios.systemVersion : Constants.systemVersion,
@@ -32,7 +38,8 @@ module.exports = {
3238
expoApp: Constants.expoVersion,
3339
expoSdk: Constants.manifest.sdkVersion,
3440
androidApiLevel: Constants.platform.android ? String(Platform.Version) : undefined
35-
}
41+
},
42+
totalMemory: Device.totalMemory
3643
}
3744

3845
client.addOnSession(session => {

0 commit comments

Comments
 (0)