Skip to content

Commit 7f4eac6

Browse files
gingerbenwgingerbenw
authored
Merge pull request #2487 from bugsnag/PLAT-13519/ts-3.8-testing
Validate TypeScript 3.8 support
2 parents 4e50c4e + 8712120 commit 7f4eac6

9 files changed

Lines changed: 172 additions & 0 deletions

File tree

‎dockerfiles/Dockerfile.browser‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,10 @@ RUN npm install --no-package-lock --no-save \
5050
../../../../../../bugsnag-browser-*.tgz \
5151
../../../../../../bugsnag-js-*.tgz
5252

53+
WORKDIR /app/test/browser/features/fixtures/typescript/3_8
54+
RUN npm install --no-package-lock --no-save \
55+
../../../../../../bugsnag-browser-*.tgz
56+
5357
# install the dependencies and build each fixture
5458
WORKDIR /app/test/browser/features/fixtures
5559
RUN find . -name package.json -type f -mindepth 2 -maxdepth 3 ! -path "./node_modules/*" | \

‎test/browser/features/fixtures/typescript/3_8/.gitignore‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
node_modules/
2+
dist/
3+
*.log

‎test/browser/features/fixtures/typescript/3_8/index.html‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!DOCTYPE html>
2+
<html>
3+
<head>
4+
<meta charset="utf-8" />
5+
<title>TypeScript 3.8 Compatibility Test</title>
6+
<script src="/docs/node_modules/@bugsnag/browser/dist/bugsnag.min.js"></script>
7+
</head>
8+
<body>
9+
<h1>TypeScript 3.8 Compatibility Test</h1>
10+
<p>This test verifies that Bugsnag's TypeScript definitions work with TypeScript 3.8.</p>
11+
<script src="dist/bundle.js"></script>
12+
</body>
13+
</html>

‎test/browser/features/fixtures/typescript/3_8/package.json‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
{
2+
"name": "bugsnag-js-fixtures-typescript-3-8",
3+
"private": true,
4+
"scripts": {
5+
"build": "npm run build:iife",
6+
"build:iife": "rollup -c rollup.config.js",
7+
"clean": "rm -rf dist"
8+
},
9+
"devDependencies": {
10+
"typescript": "~3.8.0",
11+
"rollup": "^2.79.1",
12+
"rollup-plugin-commonjs": "^10.1.0",
13+
"rollup-plugin-node-resolve": "^5.2.0",
14+
"@rollup/plugin-typescript": "^8.5.0"
15+
}
16+
}

‎test/browser/features/fixtures/typescript/3_8/rollup.config.js‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
import resolve from 'rollup-plugin-node-resolve'
2+
import commonjs from 'rollup-plugin-commonjs'
3+
import typescript from '@rollup/plugin-typescript'
4+
5+
export default {
6+
input: `src/main.ts`,
7+
output: {
8+
file: `dist/bundle.js`,
9+
format: 'iife',
10+
name: 'BugsnagTS38Test',
11+
globals: {
12+
'@bugsnag/browser': 'Bugsnag'
13+
}
14+
},
15+
external: ['@bugsnag/browser'],
16+
plugins: [
17+
typescript({
18+
tsconfig: './tsconfig.json',
19+
sourceMap: false,
20+
inlineSources: false,
21+
module: 'es2015',
22+
compilerOptions: {
23+
types: []
24+
}
25+
}),
26+
resolve({
27+
browser: true,
28+
preferBuiltins: false,
29+
mainFields: ['browser', 'module', 'main']
30+
}),
31+
commonjs({
32+
include: ['node_modules/**'],
33+
exclude: ['src/**']
34+
})
35+
]
36+
};

‎test/browser/features/fixtures/typescript/3_8/src/lib/config.ts‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
const NOTIFY = decodeURIComponent(window.location.search.match(/NOTIFY=([^&]+)/)![1])
2+
const SESSIONS = decodeURIComponent(window.location.search.match(/SESSIONS=([^&]+)/)![1])
3+
const API_KEY = decodeURIComponent(window.location.search.match(/API_KEY=([^&]+)/)![1])
4+
const config = { endpoints: { notify: NOTIFY, sessions: SESSIONS }, apiKey: API_KEY }
5+
export default config

‎test/browser/features/fixtures/typescript/3_8/src/main.ts‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
import Bugsnag from '@bugsnag/browser'
2+
import config from './lib/config'
3+
4+
// Start Bugsnag
5+
Bugsnag.start(config)
6+
7+
// Leave a breadcrumb to demonstrate breadcrumb functionality
8+
Bugsnag.leaveBreadcrumb('TypeScript 3.8 test fixture loaded', {
9+
timestamp: new Date().toISOString(),
10+
version: 'TypeScript 3.8'
11+
})
12+
13+
// Report an error to demonstrate error reporting
14+
Bugsnag.notify(new Error('TypeScript 3.8 compatibility test error'))

‎test/browser/features/fixtures/typescript/3_8/tsconfig.json‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
{
2+
"compilerOptions": {
3+
/* Visit https://aka.ms/tsconfig.json to read more about this file */
4+
5+
/* Basic Options */
6+
// "incremental": true, /* Enable incremental compilation */
7+
"target": "es5", /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */
8+
"module": "commonjs", /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */
9+
// "lib": [], /* Specify library files to be included in the compilation. */
10+
// "allowJs": true, /* Allow javascript files to be compiled. */
11+
// "checkJs": true, /* Report errors in .js files. */
12+
// "jsx": "preserve", /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
13+
// "declaration": true, /* Generates corresponding '.d.ts' file. */
14+
// "declarationMap": true, /* Generates a sourcemap for each corresponding '.d.ts' file. */
15+
// "sourceMap": true, /* Generates corresponding '.map' file. */
16+
// "outFile": "./dist/bundle.js", /* Concatenate and emit output to single file. */
17+
// "outDir": "./", /* Redirect output structure to the directory. */
18+
// "rootDir": "./src", /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
19+
// "composite": true, /* Enable project compilation */
20+
// "tsBuildInfoFile": "./", /* Specify file to store incremental compilation information */
21+
// "removeComments": true, /* Do not emit comments to output. */
22+
// "noEmit": true, /* Do not emit outputs. */
23+
// "importHelpers": true, /* Import emit helpers from 'tslib'. */
24+
// "downlevelIteration": true, /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
25+
// "isolatedModules": true, /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
26+
27+
/* Strict Type-Checking Options */
28+
"strict": true, /* Enable all strict type-checking options. */
29+
// "noImplicitAny": true, /* Raise error on expressions and declarations with an implied 'any' type. */
30+
// "strictNullChecks": true, /* Enable strict null checks. */
31+
// "strictFunctionTypes": true, /* Enable strict checking of function types. */
32+
// "strictBindCallApply": true, /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
33+
// "strictPropertyInitialization": true, /* Enable strict checking of property initialization in classes. */
34+
// "noImplicitThis": true, /* Raise error on 'this' expressions with an implied 'any' type. */
35+
// "alwaysStrict": true, /* Parse in strict mode and emit "use strict" for each source file. */
36+
37+
/* Additional Checks */
38+
// "noUnusedLocals": true, /* Report errors on unused locals. */
39+
// "noUnusedParameters": true, /* Report errors on unused parameters. */
40+
// "noImplicitReturns": true, /* Report error when not all code paths in function return a value. */
41+
// "noFallthroughCasesInSwitch": true, /* Report errors for fallthrough cases in switch statement. */
42+
// "noUncheckedIndexedAccess": true, /* Include 'undefined' in index signature results */
43+
44+
/* Module Resolution Options */
45+
"moduleResolution": "node", /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
46+
// "baseUrl": "./", /* Base directory to resolve non-absolute module names. */
47+
// "paths": {}, /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
48+
// "rootDirs": [], /* List of root folders whose combined content represents the structure of the project at runtime. */
49+
// "typeRoots": [], /* List of folders to include type definitions from. */
50+
// "types": [], /* Type declaration files to be included in compilation. */
51+
// "allowSyntheticDefaultImports": true, /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
52+
"esModuleInterop": true, /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
53+
// "preserveSymlinks": true, /* Do not resolve the real path of symlinks. */
54+
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
55+
56+
/* Source Map Options */
57+
// "sourceRoot": "", /* Specify the location where debugger should locate TypeScript files instead of source locations. */
58+
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
59+
// "inlineSourceMap": true, /* Emit a single file with source maps instead of having a separate file. */
60+
// "inlineSources": true, /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
61+
62+
/* Experimental Options */
63+
// "experimentalDecorators": true, /* Enables experimental support for ES7 decorators. */
64+
// "emitDecoratorMetadata": true, /* Enables experimental support for emitting type metadata for decorators. */
65+
66+
/* Advanced Options */
67+
"skipLibCheck": true, /* Skip type checking of declaration files. */
68+
"forceConsistentCasingInFileNames": true /* Disallow inconsistently-cased references to the same file. */
69+
}
70+
}

‎test/browser/features/typescript.feature‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
Feature: Compatibility with TypeScript
2+
3+
Scenario Outline: TypeScript <version> does not error
4+
When I navigate to the test URL "/typescript/<directory>/index.html"
5+
And I wait to receive an error
6+
Then the error is a valid browser payload for the error reporting API
7+
And the error payload field "events.0.exceptions.0.message" equals "TypeScript 3.8 compatibility test error"
8+
9+
Examples:
10+
| version | directory |
11+
| 3.8 | 3_8 |

0 commit comments

Comments
 (0)