ca07da4563
In the Angular Package Format, we always shipped UMD bundles and previously even ES5 module output.
With V10, we removed the ES5 module output but kept the UMD ES5 output.
For this, we were able to remove our second TypeScript transpilation. Instead we started only
building ES2015 output and then downleveled it to ES5 UMD for the NPM packages. This worked
as expected but unveiled an issue in the `@angular/core` reflection capabilities.
In JIT mode, Angular determines constructor parameters (for DI) using the `ReflectionCapabilities`. The
reflection capabilities basically read runtime metadata of classes to determine the DI parameters. Such
metadata can be either stored in static class properties like `ctorParameters` or within TypeScript's `design:params`.
If Angular comes across a class that does not have any parameter metadata, it tries to detect if the
given class is actually delegating to an inherited class. It does this naively in JIT by checking if the
stringified class (function in ES5) matches a certain pattern. e.g.
```js
function MatTable() {
var _this = _super.apply(this, arguments) || this;
```
These patterns are reluctant to changes of the class output. If a class is not recognized properly, the
DI parameters will be assumed empty and the class is **incorrectly** constructed without arguments.
This actually happened as part of v10 now. Since we downlevel ES2015 to ES5 (instead of previously
compiling sources directly to ES5), the class output changed slightly so that Angular no longer detects
it. e.g.
```js
var _this = _super.apply(this, __spread(arguments)) || this;
```
This happens because the ES2015 output will receive an auto-generated constructor if the class
defines class properties. This constructor is then already containing an explicit `super` call.
```js
export class MatTable extends CdkTable {
constructor() {
super(...arguments);
this.disabled = true;
}
}
```
If we then downlevel this file to ES5 with `--downlevelIteration`, TypeScript adjusts the `super` call so that
the spread operator is no longer used (not supported in ES5). The resulting super call is different to the
super call that would have been emitted if we would directly transpile to ES5. Ultimately, Angular no
longer detects such classes as having an delegate constructor -> and DI breaks.
We fix this by expanding the rather naive RegExp patterns used for the reflection capabilities
so that downleveled pass-through/delegate constructors are properly detected. There is a risk
of a false-positive as we cannot detect whether `__spread` is actually the TypeScript spread
helper, but given the reflection patterns already make lots of assumptions (e.g. that `super` is
actually the superclass, we should be fine making this assumption too. The false-positive would
not result in a broken app, but rather in unnecessary providers being injected (as a noop).
Fixes #38453
PR Close #38463
213 lines
7.8 KiB
JavaScript
213 lines
7.8 KiB
JavaScript
/**
|
|
* @license
|
|
* Copyright Google LLC All Rights Reserved.
|
|
*
|
|
* Use of this source code is governed by an MIT-style license that can be
|
|
* found in the LICENSE file at https://angular.io/license
|
|
*/
|
|
|
|
const browserProvidersConf = require('./browser-providers.conf');
|
|
const {generateSeed} = require('./tools/jasmine-seed-generator');
|
|
|
|
// Karma configuration
|
|
// Generated on Thu Sep 25 2014 11:52:02 GMT-0700 (PDT)
|
|
module.exports = function(config) {
|
|
const conf = {
|
|
frameworks: ['jasmine'],
|
|
|
|
client: {
|
|
jasmine: {
|
|
random: true,
|
|
seed: generateSeed('karma-js.conf'),
|
|
},
|
|
},
|
|
|
|
files: [
|
|
// Sources and specs.
|
|
// Loaded through the System loader, in `test-main.js`.
|
|
{pattern: 'dist/all/@angular/**/*.js', included: false, watched: true},
|
|
|
|
// Serve AngularJS for `ngUpgrade` testing.
|
|
{pattern: 'node_modules/angular-1.5/angular?(.min).js', included: false, watched: false},
|
|
{pattern: 'node_modules/angular-mocks-1.5/angular-mocks.js', included: false, watched: false},
|
|
{pattern: 'node_modules/angular-1.6/angular?(.min).js', included: false, watched: false},
|
|
{pattern: 'node_modules/angular-mocks-1.6/angular-mocks.js', included: false, watched: false},
|
|
{pattern: 'node_modules/angular/angular?(.min).js', included: false, watched: false},
|
|
{pattern: 'node_modules/angular-mocks/angular-mocks.js', included: false, watched: false},
|
|
|
|
'node_modules/core-js/client/core.js',
|
|
'node_modules/jasmine-ajax/lib/mock-ajax.js',
|
|
|
|
// Dependencies built by Bazel. See `config.yml` for steps running before
|
|
// the legacy Saucelabs tests run.
|
|
'dist/bin/packages/zone.js/npm_package/bundles/zone.umd.js',
|
|
'dist/bin/packages/zone.js/npm_package/bundles/zone-testing.umd.js',
|
|
'dist/bin/packages/zone.js/npm_package/bundles/task-tracking.umd.js',
|
|
|
|
// Including systemjs because it defines `__eval`, which produces correct stack traces.
|
|
'test-events.js',
|
|
'third_party/shims_for_IE.js',
|
|
'node_modules/systemjs/dist/system.src.js',
|
|
|
|
// Serve polyfills necessary for testing the `elements` package.
|
|
{
|
|
pattern: 'node_modules/@webcomponents/custom-elements/**/*.js',
|
|
included: false,
|
|
watched: false
|
|
},
|
|
{pattern: 'node_modules/mutation-observer/index.js', included: false, watched: false},
|
|
|
|
{pattern: 'node_modules/rxjs/**', included: false, watched: false, served: true},
|
|
'node_modules/reflect-metadata/Reflect.js',
|
|
'tools/build/file2modulename.js',
|
|
'test-main.js',
|
|
{pattern: 'dist/all/@angular/empty.*', included: false, watched: false},
|
|
{pattern: 'packages/platform-browser/test/static_assets/**', included: false, watched: false},
|
|
{
|
|
pattern: 'packages/platform-browser/test/browser/static_assets/**',
|
|
included: false,
|
|
watched: false,
|
|
},
|
|
],
|
|
|
|
exclude: [
|
|
'dist/all/@angular/_testing_init/**',
|
|
'dist/all/@angular/**/e2e_test/**',
|
|
'dist/all/@angular/**/*node_only_spec.js',
|
|
'dist/all/@angular/benchpress/**',
|
|
'dist/all/@angular/compiler-cli/**',
|
|
'dist/all/@angular/compiler-cli/src/ngtsc/**',
|
|
'dist/all/@angular/compiler-cli/test/compliance/**',
|
|
'dist/all/@angular/compiler-cli/test/ngtsc/**',
|
|
'dist/all/@angular/compiler/test/aot/**',
|
|
'dist/all/@angular/compiler/test/render3/**',
|
|
'dist/all/@angular/core/test/bundling/**',
|
|
'dist/all/@angular/core/test/render3/ivy/**',
|
|
'dist/all/@angular/core/test/render3/perf/**',
|
|
'dist/all/@angular/elements/schematics/**',
|
|
'dist/all/@angular/examples/**/e2e_test/*',
|
|
'dist/all/@angular/language-service/**',
|
|
'dist/all/@angular/localize/**/test/**',
|
|
'dist/all/@angular/localize/schematics/**',
|
|
'dist/all/@angular/router/**/test/**',
|
|
'dist/all/@angular/platform-browser/testing/e2e_util.js',
|
|
'dist/examples/**/e2e_test/**',
|
|
],
|
|
|
|
customLaunchers: browserProvidersConf.customLaunchers,
|
|
|
|
plugins: [
|
|
'karma-jasmine',
|
|
'karma-browserstack-launcher',
|
|
'karma-sauce-launcher',
|
|
'karma-chrome-launcher',
|
|
'karma-sourcemap-loader',
|
|
],
|
|
|
|
preprocessors: {
|
|
'**/*.js': ['sourcemap'],
|
|
},
|
|
|
|
// Bazel inter-op: Allow tests to request resources from either
|
|
// /base/node_modules/path/to/thing
|
|
// or
|
|
// /base/angular/node_modules/path/to/thing
|
|
// This can be removed when all karma tests are run under Bazel, then we
|
|
// don't need this entire config file.
|
|
proxies: {
|
|
'/base/angular/': '/base/',
|
|
'/base/npm/': '/base/',
|
|
},
|
|
|
|
sauceLabs: {
|
|
testName: 'Angular2',
|
|
retryLimit: 3,
|
|
startConnect: false,
|
|
recordVideo: false,
|
|
recordScreenshots: false,
|
|
idleTimeout: 600,
|
|
commandTimeout: 600,
|
|
maxDuration: 5400,
|
|
},
|
|
|
|
browserStack: {
|
|
project: 'Angular2',
|
|
startTunnel: false,
|
|
retryLimit: 3,
|
|
timeout: 1800,
|
|
pollingTimeout: 10000,
|
|
},
|
|
|
|
// Try "websocket" for a faster transmission first. Fallback to "polling" if necessary.
|
|
transports: ['websocket', 'polling'],
|
|
|
|
port: 9876,
|
|
captureTimeout: 180000,
|
|
browserDisconnectTimeout: 180000,
|
|
browserDisconnectTolerance: 3,
|
|
browserNoActivityTimeout: 300000,
|
|
};
|
|
|
|
// Workaround for: https://github.com/bazelbuild/rules_nodejs/issues/1431. The idea is
|
|
// that we do no not allow `@bazel/karma` to add the `progress` reporter.
|
|
Object.defineProperty(conf, 'reporters', {
|
|
enumerable: true,
|
|
get: () => ['dots'],
|
|
set: () => {},
|
|
});
|
|
|
|
if (process.env['SAUCE_TUNNEL_IDENTIFIER']) {
|
|
console.log(`SAUCE_TUNNEL_IDENTIFIER: ${process.env.SAUCE_TUNNEL_IDENTIFIER}`);
|
|
|
|
const tunnelIdentifier = process.env['SAUCE_TUNNEL_IDENTIFIER'];
|
|
|
|
// Setup the Saucelabs plugin so that it can launch browsers using the proper tunnel.
|
|
conf.sauceLabs.build = tunnelIdentifier;
|
|
conf.sauceLabs.tunnelIdentifier = tunnelIdentifier;
|
|
|
|
// Setup the Browserstack plugin so that it can launch browsers using the proper tunnel.
|
|
// TODO: This is currently not used because BS doesn't run on the CI. Consider removing.
|
|
conf.browserStack.build = tunnelIdentifier;
|
|
conf.browserStack.tunnelIdentifier = tunnelIdentifier;
|
|
}
|
|
|
|
// For SauceLabs jobs, we set up a domain which resolves to the machine which launched
|
|
// the tunnel. We do this because devices are sometimes not able to properly resolve
|
|
// `localhost` or `127.0.0.1` through the SauceLabs tunnel. Using a domain that does not
|
|
// resolve to anything on SauceLabs VMs ensures that such requests are always resolved through
|
|
// the tunnel, and resolve to the actual tunnel host machine (commonly the CircleCI VMs).
|
|
// More context can be found in: https://github.com/angular/angular/pull/35171.
|
|
if (process.env.SAUCE_LOCALHOST_ALIAS_DOMAIN) {
|
|
conf.hostname = process.env.SAUCE_LOCALHOST_ALIAS_DOMAIN;
|
|
}
|
|
|
|
if (process.env.KARMA_WEB_TEST_MODE) {
|
|
// KARMA_WEB_TEST_MODE is used to setup karma to run in
|
|
// SauceLabs or Browserstack
|
|
console.log(`KARMA_WEB_TEST_MODE: ${process.env.KARMA_WEB_TEST_MODE}`);
|
|
|
|
switch (process.env.KARMA_WEB_TEST_MODE) {
|
|
case 'SL_REQUIRED':
|
|
conf.browsers = browserProvidersConf.sauceAliases.CI_REQUIRED;
|
|
break;
|
|
case 'SL_OPTIONAL':
|
|
conf.browsers = browserProvidersConf.sauceAliases.CI_OPTIONAL;
|
|
break;
|
|
case 'BS_REQUIRED':
|
|
conf.browsers = browserProvidersConf.browserstackAliases.CI_REQUIRED;
|
|
break;
|
|
case 'BS_OPTIONAL':
|
|
conf.browsers = browserProvidersConf.browserstackAliases.CI_OPTIONAL;
|
|
break;
|
|
default:
|
|
throw new Error(
|
|
`Unrecognized process.env.KARMA_WEB_TEST_MODE: ${process.env.KARMA_WEB_TEST_MODE}`);
|
|
}
|
|
} else {
|
|
// Run the test locally
|
|
conf.browsers = [process.env['DISPLAY'] ? 'Chrome' : 'ChromeHeadless'];
|
|
}
|
|
|
|
config.set(conf);
|
|
};
|