Files
flipper/scripts/build-release.js
Daniel Büchele 16e913a819 local icons
Summary:
Currently icons were always fetched remotely. We used a service worker to prefetch and cache some icons, that were critical to the UI.

In this diff, we are bundling icons at build time, with the app. In utils/icons.js we still specfify the list of icons which should be bundled. These are downloaded as part of the build step and bundled with the app. We are downloading the icons in 1x and 2x (the two most common pixel densities).

Reviewed By: jknoxville

Differential Revision: D16620764

fbshipit-source-id: 965a7793ad1f08aebb292606add00218429cdaf4
2019-08-02 09:00:00 -07:00

173 lines
5.0 KiB
JavaScript
Executable File

/**
* Copyright 2018-present Facebook.
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
* @format
*/
const path = require('path');
const fs = require('fs-extra');
const builder = require('electron-builder');
const Platform = builder.Platform;
const cp = require('child-process-es6-promise');
const {
buildFolder,
compile,
die,
compileDefaultPlugins,
getVersionNumber,
genMercurialRevision,
} = require('./build-utils.js');
const fetch = require('node-fetch');
const {ICONS, getIconURL} = require('../src/utils/icons.js');
function generateManifest(versionNumber) {
const filePath = path.join(__dirname, '..', 'dist');
if (!fs.existsSync(filePath)) {
fs.mkdirSync(filePath);
}
fs.writeFileSync(
path.join(__dirname, '../dist/manifest.json'),
JSON.stringify({
package: 'com.facebook.sonar',
version_name: versionNumber,
}),
);
}
function modifyPackageManifest(buildFolder, versionNumber, hgRevision) {
// eslint-disable-next-line no-console
console.log('Creating package.json manifest');
const manifest = require('../package.json');
const manifestStatic = require('../static/package.json');
// The manifest's dependencies are bundled with the final app by
// electron-builder. We want to bundle the dependencies from the static-folder
// because all dependencies from the root-folder are already bundled by metro.
manifest.dependencies = manifestStatic.dependencies;
manifest.main = 'index.js';
manifest.version = versionNumber;
if (hgRevision != null) {
manifest.revision = hgRevision;
}
fs.writeFileSync(
path.join(buildFolder, 'package.json'),
JSON.stringify(manifest, null, ' '),
);
}
function buildDist(buildFolder) {
const targetsRaw = [];
const postBuildCallbacks = [];
if (process.argv.indexOf('--mac') > -1) {
targetsRaw.push(Platform.MAC.createTarget(['dir']));
postBuildCallbacks.push(() =>
cp.spawn('zip', ['-yr9', '../Flipper-mac.zip', 'Flipper.app'], {
cwd: path.join(__dirname, '..', 'dist', 'mac'),
}),
);
}
if (process.argv.indexOf('--linux') > -1) {
targetsRaw.push(Platform.LINUX.createTarget(['zip']));
}
if (process.argv.indexOf('--win') > -1) {
targetsRaw.push(Platform.WINDOWS.createTarget(['zip']));
}
if (!targetsRaw.length) {
throw new Error('No targets specified. eg. --mac, --win, or --linux');
}
// merge all target maps into a single map
let targetsMerged = [];
for (const target of targetsRaw) {
targetsMerged = targetsMerged.concat(Array.from(target));
}
const targets = new Map(targetsMerged);
const electronDownload = {};
if (process.env.electron_config_cache) {
electronDownload.cache = process.env.electron_config_cache;
}
return builder
.build({
publish: 'never',
config: {
appId: `com.facebook.sonar`,
directories: {
buildResources: path.join(__dirname, '..', 'static'),
output: path.join(__dirname, '..', 'dist'),
},
electronDownload,
npmRebuild: false,
},
projectDir: buildFolder,
targets,
})
.then(() => Promise.all(postBuildCallbacks.map(p => p())))
.catch(die);
}
function copyStaticFolder(buildFolder) {
fs.copySync(path.join(__dirname, '..', 'static'), buildFolder, {
dereference: true,
});
}
function downloadIcons(buildFolder) {
const iconURLs = Object.entries(ICONS).reduce((acc, [name, sizes]) => {
acc.push(
// get icons in @1x and @2x
...sizes.map(size => ({name, size, density: 1})),
...sizes.map(size => ({name, size, density: 2})),
);
return acc;
}, []);
return Promise.all(
iconURLs.map(({name, size, density}) =>
fetch(getIconURL(name, size, density))
.then(res => {
if (res.status !== 200) {
throw new Error(`Could not download the icon: ${name}`);
}
return res;
})
.then(
res =>
new Promise((resolve, reject) => {
const fileStream = fs.createWriteStream(
path.join(
buildFolder,
'icons',
`${name}-${size}@${density}x.png`,
),
);
res.body.pipe(fileStream);
res.body.on('error', reject);
fileStream.on('finish', resolve);
}),
)
.catch(console.error),
),
);
}
(async () => {
const dir = await buildFolder();
// eslint-disable-next-line no-console
console.log('Created build directory', dir);
copyStaticFolder(dir);
await downloadIcons(dir);
await compileDefaultPlugins(path.join(dir, 'defaultPlugins'));
await compile(dir, path.join(__dirname, '..', 'src', 'init.js'));
const versionNumber = getVersionNumber();
const hgRevision = await genMercurialRevision();
modifyPackageManifest(dir, versionNumber, hgRevision);
generateManifest(versionNumber);
await buildDist(dir);
// eslint-disable-next-line no-console
console.log('✨ Done');
process.exit();
})();