Add infra for Prepack build option

Summary: This adds a build option for using Prepack (an experimental packager) to
build a bundle. It doesn't actually take on the npm package dependency
because it's not published/open source (yet).

This will be used while we experiment and should be maintained as the
build system changes so that we can continue getting fresh builds.

I found that saveBundleAndMap and processBundle were over abstracted and
got in my way so I inlined it and removed the unit tests because the unit
test was testing trivial code that is likely to change interface.

I went with a separate build phase and a separate Bundle class even though
there are a lot of commonalities. I imagine that the requirements for
Prepack will continue to diverge. Especially for source maps but a larger
refactor could try to unify these a bit more. The fact that modules are
wrapped before the write phase seems to be an unfortunate architecture
that makes this difficult.
Closes https://github.com/facebook/react-native/pull/4226

Reviewed By: amasad

Differential Revision: D2673760

Pulled By: sebmarkbage

fb-gh-sync-id: 299ccc42e4be1d9dee19ade443ea3388db2e39a8
This commit is contained in:
Sebastian Markbage
2015-11-20 20:17:17 -08:00
committed by facebook-github-bot-4
parent aa399f0fd9
commit 43f18ffd08
11 changed files with 372 additions and 147 deletions

View File

@@ -1,63 +0,0 @@
/**
* Copyright (c) 2015-present, Facebook, Inc.
* All rights reserved.
*
* This source code is licensed under the BSD-style license found in the
* LICENSE file in the root directory of this source tree. An additional grant
* of patent rights can be found in the PATENTS file in the same directory.
*/
'use strict';
jest.autoMockOff();
jest.mock('fs');
jest.mock('../sign');
const saveBundleAndMap = require('../saveBundleAndMap');
const fs = require('fs');
const temp = require('temp');
const code = 'const foo = "bar";';
const map = JSON.stringify({
version: 3,
file: 'foo.js.map',
sources: ['foo.js'],
sourceRoot: '/',
names: ['bar'],
mappings: 'AAA0B,kBAAhBA,QAAOC,SACjBD,OAAOC,OAAO'
});
describe('saveBundleAndMap', () => {
beforeEach(() => {
fs.writeFileSync = jest.genMockFn();
});
it('should save bundle', () => {
const codeWithMap = {code: code};
const bundleOutput = temp.path({suffix: '.bundle'});
saveBundleAndMap(
codeWithMap,
'ios',
bundleOutput,
'utf8',
);
expect(fs.writeFileSync.mock.calls[0]).toEqual([bundleOutput, code, 'utf8']);
});
it('should save sourcemaps if required so', () => {
const codeWithMap = {code: code, map: map};
const bundleOutput = temp.path({suffix: '.bundle'});
const sourceMapOutput = temp.path({suffix: '.map'});
saveBundleAndMap(
codeWithMap,
'ios',
bundleOutput,
'utf8',
sourceMapOutput
);
expect(fs.writeFileSync.mock.calls[1]).toEqual([sourceMapOutput, map]);
});
});

View File

@@ -8,11 +8,57 @@
*/
'use strict';
const fs = require('fs');
const log = require('../util/log').out('bundle');
const processBundle = require('./processBundle');
const Promise = require('promise');
const ReactPackager = require('../../packager/react-packager');
const saveBundleAndMap = require('./saveBundleAndMap');
const saveAssets = require('./saveAssets');
const sign = require('./sign');
function saveBundleAndMap(
bundle,
bundleOutput,
encoding,
sourcemapOutput,
dev
) {
log('start');
let codeWithMap;
if (!dev) {
codeWithMap = bundle.getMinifiedSourceAndMap(dev);
} else {
codeWithMap = {
code: bundle.getSource({ dev }),
map: JSON.stringify(bundle.getSourceMap({ dev })),
};
}
log('finish');
log('Writing bundle output to:', bundleOutput);
fs.writeFileSync(bundleOutput, sign(codeWithMap.code), encoding);
log('Done writing bundle output');
if (sourcemapOutput) {
log('Writing sourcemap output to:', sourcemapOutput);
fs.writeFileSync(sourcemapOutput, codeWithMap.map);
log('Done writing sourcemap output');
}
}
function savePrepackBundleAndMap(
bundle,
bundleOutput,
sourcemapOutput,
bridgeConfig
) {
log('Writing prepack bundle output to:', bundleOutput);
const result = bundle.build({
batchedBridgeConfig: bridgeConfig
});
fs.writeFileSync(bundleOutput, result, 'ucs-2');
log('Done writing prepack bundle output');
}
function buildBundle(args, config) {
return new Promise((resolve, reject) => {
@@ -36,24 +82,56 @@ function buildBundle(args, config) {
platform: args.platform,
};
resolve(ReactPackager.createClientFor(options).then(client => {
log('Created ReactPackager');
return client.buildBundle(requestOpts)
const prepack = args.prepack;
const client = ReactPackager.createClientFor(options);
client.then(() => log('Created ReactPackager'));
// Build and save the bundle
let bundle;
if (prepack) {
bundle = client.then(c => c.buildPrepackBundle(requestOpts))
.then(outputBundle => {
log('Closing client');
client.close();
savePrepackBundleAndMap(
outputBundle,
args['bundle-output'],
args['sourcemap-output'],
args['bridge-config']
);
return outputBundle;
})
.then(outputBundle => processBundle(outputBundle, args.dev))
.then(outputBundle => saveBundleAndMap(
outputBundle,
});
} else {
bundle = client.then(c => c.buildBundle(requestOpts))
.then(outputBundle => {
saveBundleAndMap(
outputBundle,
args['bundle-output'],
args['bundle-encoding'],
args['sourcemap-output'],
args.dev
);
return outputBundle;
});
}
// When we're done bundling, close the client
bundle.then(() => client.then(c => {
log('Closing client');
c.close();
}));
// Save the assets of the bundle
const assets = bundle
.then(outputBundle => outputBundle.getAssets())
.then(outputAssets => saveAssets(
outputAssets,
args.platform,
args['bundle-output'],
args['bundle-encoding'],
args['sourcemap-output'],
args['assets-dest']
));
}));
// When we're done saving the assets, we're done.
resolve(assets);
});
}

View File

@@ -27,6 +27,14 @@ module.exports = [
command: 'dev',
description: 'If false, warnings are disabled and the bundle is minified',
default: true,
}, {
command: 'prepack',
description: 'If true, the output bundle will use the Prepack format.',
default: false
}, {
command: 'bridge-config',
description: 'File name of a a JSON export of __fbBatchedBridgeConfig. Used by Prepack. Ex. ./bridgeconfig.json',
type: 'string'
}, {
command: 'bundle-output',
description: 'File name where to store the resulting bundle, ex. /tmp/groups.bundle',

View File

@@ -1,29 +0,0 @@
/**
* Copyright (c) 2015-present, Facebook, Inc.
* All rights reserved.
*
* This source code is licensed under the BSD-style license found in the
* LICENSE file in the root directory of this source tree. An additional grant
* of patent rights can be found in the PATENTS file in the same directory.
*/
'use strict';
const log = require('../util/log').out('bundle');
function processBundle(input, dev) {
log('start');
let bundle;
if (!dev) {
bundle = input.getMinifiedSourceAndMap(dev);
} else {
bundle = {
code: input.getSource({ dev }),
map: JSON.stringify(input.getSourceMap({ dev })),
};
}
bundle.assets = input.getAssets();
log('finish');
return bundle;
}
module.exports = processBundle;

View File

@@ -14,26 +14,12 @@ const getAssetDestPathAndroid = require('./getAssetDestPathAndroid');
const getAssetDestPathIOS = require('./getAssetDestPathIOS');
const log = require('../util/log').out('bundle');
const path = require('path');
const sign = require('./sign');
function saveBundleAndMap(
codeWithMap,
function saveAssets(
assets,
platform,
bundleOutput,
encoding,
sourcemapOutput,
assetsDest
) {
log('Writing bundle output to:', bundleOutput);
fs.writeFileSync(bundleOutput, sign(codeWithMap.code), encoding);
log('Done writing bundle output');
if (sourcemapOutput) {
log('Writing sourcemap output to:', sourcemapOutput);
fs.writeFileSync(sourcemapOutput, codeWithMap.map);
log('Done writing sourcemap output');
}
if (!assetsDest) {
console.warn('Assets destination folder is not set, skipping...');
return Promise.resolve();
@@ -44,7 +30,7 @@ function saveBundleAndMap(
: getAssetDestPathIOS;
const filesToCopy = Object.create(null); // Map src -> dest
codeWithMap.assets
assets
.filter(asset => !asset.deprecated)
.forEach(asset =>
asset.scales.forEach((scale, idx) => {
@@ -94,4 +80,4 @@ function copy(src, dest, callback) {
});
}
module.exports = saveBundleAndMap;
module.exports = saveAssets;