forked from ampproject/amphtml
-
Notifications
You must be signed in to change notification settings - Fork 0
/
compile.js
446 lines (431 loc) · 16.5 KB
/
compile.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
/**
* Copyright 2015 The AMP HTML Authors. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS-IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
'use strict';
const argv = require('minimist')(process.argv.slice(2));
const closureCompiler = require('gulp-closure-compiler');
const colors = require('ansi-colors');
const fs = require('fs-extra');
const gulp = require('gulp');
const {isTravisBuild} = require('../travis');
const {VERSION: internalRuntimeVersion} = require('../internal-version') ;
const rename = require('gulp-rename');
const replace = require('gulp-regexp-sourcemaps');
const rimraf = require('rimraf');
const shortenLicense = require('../shorten-license');
const {highlight} = require('cli-highlight');
const {singlePassCompile} = require('../single-pass');
const isProdBuild = !!argv.type;
const queue = [];
let inProgress = 0;
const MAX_PARALLEL_CLOSURE_INVOCATIONS = 4;
// Compiles AMP with the closure compiler. This is intended only for
// production use. During development we intend to continue using
// babel, as it has much faster incremental compilation.
exports.closureCompile = function(entryModuleFilename, outputDir,
outputFilename, options) {
// Rate limit closure compilation to MAX_PARALLEL_CLOSURE_INVOCATIONS
// concurrent processes.
return new Promise(function(resolve) {
function start() {
inProgress++;
compile(entryModuleFilename, outputDir, outputFilename, options)
.then(function() {
if (isTravisBuild()) {
// Print a progress dot after each task to avoid Travis timeouts.
process.stdout.write('.');
}
inProgress--;
next();
resolve();
}, function(e) {
console./*OK*/error(colors.red('Compilation error:'), e.message);
process.exit(1);
});
}
function next() {
if (!queue.length) {
return;
}
if (inProgress < MAX_PARALLEL_CLOSURE_INVOCATIONS) {
queue.shift()();
}
}
queue.push(start);
next();
});
};
function cleanupBuildDir() {
fs.mkdirsSync('build/cc');
rimraf.sync('build/fake-module');
rimraf.sync('build/patched-module');
fs.mkdirsSync('build/patched-module/document-register-element/build');
fs.mkdirsSync('build/fake-module/third_party/babel');
fs.mkdirsSync('build/fake-module/src/polyfills/');
fs.mkdirsSync('build/fake-polyfills/src/polyfills');
}
exports.cleanupBuildDir = cleanupBuildDir;
// Formats a closure compiler error message into a more readable form by
// dropping the lengthy java invocation line...
// Command failed: java -jar ... --js_output_file="<file>"
// ...and then syntax highlighting the error text.
function formatClosureCompilerError(message) {
const javaInvocationLine = /Command failed:[^]*--js_output_file=\".*?\"\n/;
message = message.replace(javaInvocationLine, '');
message = highlight(message, {ignoreIllegals: true});
message = message.replace(/WARNING/g, colors.yellow('WARNING'));
message = message.replace(/ERROR/g, colors.red('ERROR'));
return message;
}
function compile(entryModuleFilenames, outputDir, outputFilename, options) {
const hideWarningsFor = [
'third_party/caja/',
'third_party/closure-library/sha384-generated.js',
'third_party/subscriptions-project/',
'third_party/d3/',
'third_party/mustache/',
'third_party/vega/',
'third_party/webcomponentsjs/',
'third_party/rrule/',
'third_party/react-dates/',
'third_party/amp-toolbox-cache-url/',
'third_party/inputmask/',
'node_modules/',
'build/patched-module/',
// Can't seem to suppress `(0, win.eval)` suspicious code warning
'3p/environment.js',
// Generated code.
'extensions/amp-access/0.1/access-expr-impl.js',
];
const baseExterns = [
'build-system/amp.extern.js',
'build-system/dompurify.extern.js',
'build-system/event-timing.extern.js',
'third_party/closure-compiler/externs/web_animations.js',
'third_party/moment/moment.extern.js',
'third_party/react-externs/externs.js',
];
const define = [];
if (argv.pseudo_names) {
define.push('PSEUDO_NAMES=true');
}
if (argv.fortesting) {
define.push('FORTESTING=true');
}
if (options.singlePassCompilation) {
const compilationOptions = {
define,
externs: baseExterns,
hideWarningsFor,
};
// Add babel plugin to remove unwanted polyfills in esm build
if (options.esmPassCompilation) {
compilationOptions['dest'] = './dist/esm/';
define.push('ESM_BUILD=true');
}
console/*OK*/.assert(typeof entryModuleFilenames == 'string');
const entryModule = entryModuleFilenames;
// TODO(@cramforce): Run the post processing step
return singlePassCompile(
entryModule,
compilationOptions
).then(() => {
return new Promise((resolve, reject) => {
const stream = gulp.src(outputDir + '/**/*.js');
stream.on('end', resolve);
stream.on('error', reject);
stream.pipe(
replace(/\$internalRuntimeVersion\$/g, internalRuntimeVersion, 'runtime-version'))
.pipe(shortenLicense())
.pipe(gulp.dest(outputDir));
});
});
}
return new Promise(function(resolve) {
let entryModuleFilename;
if (entryModuleFilenames instanceof Array) {
entryModuleFilename = entryModuleFilenames[0];
} else {
entryModuleFilename = entryModuleFilenames;
entryModuleFilenames = [entryModuleFilename];
}
const checkTypes =
options.checkTypes || options.typeCheckOnly || argv.typecheck_only;
const intermediateFilename = 'build/cc/' +
entryModuleFilename.replace(/\//g, '_').replace(/^\./, '');
// If undefined/null or false then we're ok executing the deletions
// and mkdir.
if (!options.preventRemoveAndMakeDir) {
cleanupBuildDir();
}
const unneededFiles = [
'build/fake-module/third_party/babel/custom-babel-helpers.js',
];
let wrapper = '(function(){%output%})();';
if (options.wrapper) {
wrapper = options.wrapper.replace('<%= contents %>', '%output%');
}
wrapper += '\n//# sourceMappingURL=' + outputFilename + '.map\n';
if (fs.existsSync(intermediateFilename)) {
fs.unlinkSync(intermediateFilename);
}
let sourceMapBase = 'http://localhost:8000/';
if (isProdBuild) {
// Point sourcemap to fetch files from correct GitHub tag.
sourceMapBase = 'https://raw.githubusercontent.com/ampproject/amphtml/' +
internalRuntimeVersion + '/';
}
const srcs = [
'3p/3p.js',
// Ads config files.
'ads/_*.js',
'ads/alp/**/*.js',
'ads/google/**/*.js',
'ads/inabox/**/*.js',
// Files under build/. Should be sparse.
'build/css.js',
'build/*.css.js',
'build/fake-module/**/*.js',
'build/patched-module/**/*.js',
'build/experiments/**/*.js',
// A4A has these cross extension deps.
'extensions/amp-ad-network*/**/*-config.js',
'extensions/amp-ad/**/*.js',
'extensions/amp-a4a/**/*.js',
// Currently needed for crypto.js and visibility.js.
// Should consider refactoring.
'extensions/amp-analytics/**/*.js',
// Needed for WebAnimationService
'extensions/amp-animation/**/*.js',
// For amp-bind in the web worker (ww.js).
'extensions/amp-bind/**/*.js',
// Needed to access to Variant interface from other extensions
'extensions/amp-experiment/**/*.js',
// Needed to access form impl from other extensions
'extensions/amp-form/**/*.js',
// Needed to access inputmask impl from other extensions
'extensions/amp-inputmask/**/*.js',
// Needed for AccessService
'extensions/amp-access/**/*.js',
// Needed for AmpStoryVariableService
'extensions/amp-story/**/*.js',
// Needed for SubscriptionsService
'extensions/amp-subscriptions/**/*.js',
// Needed to access UserNotificationManager from other extensions
'extensions/amp-user-notification/**/*.js',
// Needed for VideoService
'extensions/amp-video-service/**/*.js',
// Needed to access ConsentPolicyManager from other extensions
'extensions/amp-consent/**/*.js',
// Needed to access AmpGeo type for service locator
'extensions/amp-geo/**/*.js',
// Needed for AmpViewerAssistanceService
'extensions/amp-viewer-assistance/**/*.js',
// Needed for AmpViewerIntegrationVariableService
'extensions/amp-viewer-integration/**/*.js',
'src/*.js',
'src/**/*.js',
'!third_party/babel/custom-babel-helpers.js',
// Exclude since it's not part of the runtime/extension binaries.
'!extensions/amp-access/0.1/amp-login-done.js',
'builtins/**.js',
'third_party/caja/html-sanitizer.js',
'third_party/closure-library/sha384-generated.js',
'third_party/css-escape/css-escape.js',
'third_party/mustache/**/*.js',
'third_party/timeagojs/**/*.js',
'third_party/vega/**/*.js',
'third_party/d3/**/*.js',
'third_party/subscriptions-project/*.js',
'third_party/webcomponentsjs/ShadowCSS.js',
'third_party/rrule/rrule.js',
'third_party/react-dates/bundle.js',
'third_party/amp-toolbox-cache-url/**/*.js',
'third_party/inputmask/**/*.js',
'node_modules/dompurify/dist/purify.es.js',
'node_modules/promise-pjs/promise.js',
'node_modules/set-dom/src/**/*.js',
'node_modules/web-animations-js/web-animations.install.js',
'node_modules/web-activities/activity-ports.js',
'node_modules/@ampproject/animations/dist/animations.mjs',
'node_modules/@ampproject/worker-dom/dist/' +
'unminified.index.safe.mjs.patched.js',
'node_modules/document-register-element/build/' +
'document-register-element.patched.js',
// 'node_modules/core-js/modules/**.js',
// Not sure what these files are, but they seem to duplicate code
// one level below and confuse the compiler.
'!node_modules/core-js/modules/library/**.js',
// Don't include rollup configs
'!**/rollup.config.js',
// Don't include tests.
'!**_test.js',
'!**/test-*.js',
'!**/*.extern.js',
];
// Add needed path for extensions.
// Instead of globbing all extensions, this will only add the actual
// extension path for much quicker build times.
entryModuleFilenames.forEach(function(filename) {
if (!filename.includes('extensions/')) {
return;
}
const path = filename.replace(/\/[^/]+\.js$/, '/**/*.js');
srcs.push(path);
});
if (options.extraGlobs) {
srcs.push.apply(srcs, options.extraGlobs);
}
if (options.include3pDirectories) {
srcs.push(
'3p/**/*.js',
'ads/**/*.js');
}
// Many files include the polyfills, but we only want to deliver them
// once. Since all files automatically wait for the main binary to load
// this works fine.
if (options.includeOnlyESMLevelPolyfills) {
const polyfills = fs.readdirSync('src/polyfills');
const polyfillsShadowList = polyfills.filter(p => {
// custom-elements polyfill must be included.
return p !== 'custom-elements.js';
});
srcs.push(
'!build/fake-module/src/polyfills.js',
'!build/fake-module/src/polyfills/**/*.js',
'!build/fake-polyfills/src/polyfills.js',
'src/polyfills/custom-elements.js',
'build/fake-polyfills/**/*.js');
polyfillsShadowList.forEach(polyfillFile => {
srcs.push(`!src/polyfills/${polyfillFile}`);
fs.writeFileSync('build/fake-polyfills/src/polyfills/' + polyfillFile,
'export function install() {}');
});
} else if (options.includePolyfills) {
srcs.push(
'!build/fake-module/src/polyfills.js',
'!build/fake-module/src/polyfills/**/*.js',
'!build/fake-polyfills/**/*.js',
);
} else {
srcs.push('!src/polyfills.js', '!build/fake-polyfills/**/*.js',);
unneededFiles.push('build/fake-module/src/polyfills.js');
}
unneededFiles.forEach(function(fake) {
if (!fs.existsSync(fake)) {
fs.writeFileSync(fake,
'// Not needed in closure compiler\n' +
'export function deadCode() {}');
}
});
let externs = baseExterns;
if (options.externs) {
externs = externs.concat(options.externs);
}
externs.push('build-system/amp.multipass.extern.js');
/* eslint "google-camelcase/google-camelcase": 0*/
const compilerOptions = {
// Temporary shipping with our own compiler that has a single patch
// applied
compilerPath: 'build-system/runner/dist/runner.jar',
fileName: intermediateFilename,
continueWithWarnings: false,
tieredCompilation: true, // Magic speed up.
compilerFlags: {
compilation_level: options.compilationLevel || 'SIMPLE_OPTIMIZATIONS',
// Turns on more optimizations.
assume_function_wrapper: true,
// Transpile from ES6 to ES5.
language_in: 'ECMASCRIPT6',
language_out: 'ECMASCRIPT5',
// We do not use the polyfills provided by closure compiler.
// If you need a polyfill. Manually include them in the
// respective top level polyfills.js files.
rewrite_polyfills: false,
externs,
js_module_root: [
// Do _not_ include 'node_modules/' in js_module_root with 'NODE'
// resolution or bad things will happen (#18600).
'build/patched-module/',
'build/fake-module/',
'build/fake-polyfills/',
],
entry_point: entryModuleFilenames,
module_resolution: 'NODE',
process_common_js_modules: true,
// This strips all files from the input set that aren't explicitly
// required.
only_closure_dependencies: true,
output_wrapper: wrapper,
create_source_map: intermediateFilename + '.map',
source_map_location_mapping:
'|' + sourceMapBase,
warning_level: 'DEFAULT',
jscomp_error: [],
// moduleLoad: Demote "module not found" errors to ignore missing files
// in type declarations in the swg.js bundle.
jscomp_warning: ['moduleLoad'],
// Turn off warning for "Unknown @define" since we use define to pass
// args such as FORTESTING to our runner.
jscomp_off: ['unknownDefines'],
define,
hide_warnings_for: hideWarningsFor,
},
};
// For now do type check separately
if (argv.typecheck_only || checkTypes) {
// Don't modify compilation_level to a lower level since
// it won't do strict type checking if its whitespace only.
compilerOptions.compilerFlags.define.push('TYPECHECK_ONLY=true');
compilerOptions.compilerFlags.jscomp_error.push(
'checkTypes',
'accessControls',
'const',
'constantProperty',
'globalThis');
compilerOptions.compilerFlags.conformance_configs =
'build-system/conformance-config.textproto';
}
if (compilerOptions.compilerFlags.define.length == 0) {
delete compilerOptions.compilerFlags.define;
}
let stream = gulp.src(srcs)
.pipe(closureCompiler(compilerOptions))
.on('error', function(err) {
const {message} = err;
console./*OK*/error(colors.red(
'Compiler issues for ' + outputFilename + ':\n') +
formatClosureCompilerError(message));
process.exit(1);
});
// If we're only doing type checking, no need to output the files.
if (!argv.typecheck_only && !options.typeCheckOnly) {
stream = stream
.pipe(rename(outputFilename))
.pipe(replace(/\$internalRuntimeVersion\$/g, internalRuntimeVersion, 'runtime-version'))
.pipe(shortenLicense())
.pipe(gulp.dest(outputDir))
.on('end', function() {
gulp.src(intermediateFilename + '.map')
.pipe(rename(outputFilename + '.map'))
.pipe(gulp.dest(outputDir))
.on('end', resolve);
});
} else {
stream = stream.on('end', resolve);
}
return stream;
});
}