Performance improvements for "build-plugin" task

Summary:
Few improvements for "build-plugin" task which together with Sandcastle command changes (D26872427) helps to build all plugins in CI ~30% faster if most of them has not changed (which is usually the case):
1) compute package checksum in the same script to not call additional yarn scripts for each plugin
2) avoid packaging plugin if it's checksum has not changed since last release

Reviewed By: mweststrate

Differential Revision: D26872253

fbshipit-source-id: 968102d32a1550ea7503f1169f0ef2863296383f

desktop/pkg-lib/package.json

@@ -10,9 +10,11 @@
   "bugs": "https://github.com/facebook/flipper/issues",
   "dependencies": {
     "flipper-babel-transformer": "0.0.0",
+    "flipper-plugin-lib": "0.0.0",
     "fs-extra": "^9.0.1",
     "metro": "^0.65.2",
-    "metro-minify-terser": "^0.65.2"
+    "metro-minify-terser": "^0.65.2",
+    "npm-packlist": "^2.1.4"
   },
   "devDependencies": {
     "@types/fs-extra": "^9.0.1",

desktop/pkg-lib/src/index.ts

@@ -9,3 +9,4 @@
 
 export {default as runBuild} from './runBuild';
 export {default as getWatchFolders} from './getWatchFolders';
+export {default as computePackageChecksum} from './computePackageChecksum';

desktop/pkg-lib/src/runBuild.ts

@@ -11,6 +11,7 @@ import Metro from 'metro';
 import getWatchFolders from './getWatchFolders';
 import path from 'path';
 import fs from 'fs-extra';
+import {getInstalledPluginDetails} from 'flipper-plugin-lib';
 
 let metroDir: string | undefined;
 const metroDirPromise = getMetroDir().then((dir) => (metroDir = dir));
@@ -30,19 +31,29 @@ async function getMetroDir() {
   return __dirname;
 }
 
-export default async function runBuild(
+export default async function bundlePlugin(pluginDir: string, dev: boolean) {
-  inputDirectory: string,
+  const stat = await fs.lstat(pluginDir);
-  entry: string,
+  if (!stat.isDirectory()) {
-  out: string,
+    throw new Error(`Plugin source ${pluginDir} is not a directory.`);
-  dev: boolean,
+  }
-) {
+  const packageJsonPath = path.join(pluginDir, 'package.json');
+  if (!(await fs.pathExists(packageJsonPath))) {
+    throw new Error(
+      `package.json is not found in plugin source directory ${pluginDir}.`,
+    );
+  }
+  const plugin = await getInstalledPluginDetails(pluginDir);
+  const entry = plugin.source;
+  const out = path.resolve(pluginDir, plugin.main);
+  await fs.ensureDir(path.dirname(out));
+
   const sourceMapUrl = null; // inline source map
   const baseConfig = await Metro.loadConfig();
   const config = Object.assign({}, baseConfig, {
     reporter: {update: () => {}},
-    projectRoot: inputDirectory,
+    projectRoot: pluginDir,
     watchFolders: [metroDir || (await metroDirPromise)].concat(
-      await getWatchFolders(inputDirectory),
+      await getWatchFolders(pluginDir),
     ),
     serializer: {
       ...baseConfig.serializer,

desktop/pkg-lib/tsconfig.json

@@ -4,7 +4,19 @@
     "outDir": "lib",
     "rootDir": "src"
   },
-  "references": [{"path": "../babel-transformer"}],
+  "references": [
-  "include": ["src"],
+    {
-  "exclude": ["node_modules", "**/__tests__/*"]
+      "path": "../babel-transformer"
+    },
+    {
+      "path": "../plugin-lib"
+    }
+  ],
+  "include": [
+    "src"
+  ],
+  "exclude": [
+    "node_modules",
+    "**/__tests__/*"
+  ]
 }

desktop/pkg/package.json

@@ -25,7 +25,6 @@
     "fs-extra": "^9.0.1",
     "inquirer": "^7.3.3",
     "lodash": "^4.17.19",
-    "npm-packlist": "^2.1.4",
     "recursive-readdir": "^2.2.2"
   },
   "devDependencies": {

desktop/pkg/src/commands/bundle.ts

@@ -12,7 +12,6 @@ import {args} from '@oclif/parser';
 import fs from 'fs-extra';
 import path from 'path';
 import {runBuild} from 'flipper-pkg-lib';
-import {getInstalledPluginDetails} from 'flipper-plugin-lib';
 
 export default class Bundle extends Command {
   public static description = 'transpiles and bundles plugin';
@@ -45,42 +44,18 @@ export default class Bundle extends Command {
   public async run() {
     const {args, flags} = this.parse(Bundle);
     const inputDirectory: string = path.resolve(process.cwd(), args.directory);
-    const stat = await fs.lstat(inputDirectory);
+    const success = await runBuildOnce(inputDirectory, !flags.production);
-    if (!stat.isDirectory()) {
-      this.error(`Plugin source ${inputDirectory} is not a directory.`);
-    }
-    const packageJsonPath = path.join(inputDirectory, 'package.json');
-    if (!(await fs.pathExists(packageJsonPath))) {
-      this.error(
-        `package.json is not found in plugin source directory ${inputDirectory}.`,
-      );
-    }
-    const plugin = await getInstalledPluginDetails(inputDirectory);
-    const out = path.resolve(inputDirectory, plugin.main);
-    await fs.ensureDir(path.dirname(out));
-
-    const success = await runBuildOnce(
-      inputDirectory,
-      plugin.source,
-      out,
-      !flags.production,
-    );
     if (!flags.watch) {
       process.exit(success ? 0 : 1);
     } else {
-      enterWatchMode(inputDirectory, plugin.source, out, !flags.production);
+      enterWatchMode(inputDirectory, !flags.production);
     }
   }
 }
 
-async function runBuildOnce(
+async function runBuildOnce(inputDirectory: string, dev: boolean) {
-  inputDirectory: string,
-  source: string,
-  out: string,
-  dev: boolean,
-) {
   try {
-    await runBuild(inputDirectory, source, out, dev);
+    await runBuild(inputDirectory, dev);
     console.log('✅  Build succeeded');
     return true;
   } catch (e) {
@@ -90,12 +65,7 @@ async function runBuildOnce(
   }
 }
 
-function enterWatchMode(
+function enterWatchMode(inputDirectory: string, dev: boolean) {
-  inputDirectory: string,
-  source: string,
-  out: string,
-  dev: boolean,
-) {
   console.log(`⏳  Waiting for changes...`);
   let isBuilding = false;
   let pendingChanges = false;
@@ -112,7 +82,7 @@ function enterWatchMode(
       isBuilding = true;
       while (pendingChanges) {
         pendingChanges = false;
-        await runBuildOnce(inputDirectory, source, out, dev);
+        await runBuildOnce(inputDirectory, dev);
       }
       isBuilding = false;
       console.log(`⏳  Waiting for changes...`);

desktop/pkg/src/commands/checksum.ts

@@ -10,7 +10,7 @@
 import {Command} from '@oclif/command';
 import {args} from '@oclif/parser';
 import path from 'path';
-import computePackageChecksum from '../utils/computePackageChecksum';
+import {computePackageChecksum} from 'flipper-pkg-lib';
 
 export default class Lint extends Command {
   public static description =

desktop/pkg/src/commands/pack.ts

@@ -10,13 +10,12 @@
 import {Command, flags} from '@oclif/command';
 import {args} from '@oclif/parser';
 import {promises as fs} from 'fs';
-import {mkdirp, pathExists, readJSON, ensureDir} from 'fs-extra';
+import {mkdirp, pathExists, readJSON} from 'fs-extra';
 import * as inquirer from 'inquirer';
 import * as path from 'path';
 import * as yarn from '../utils/yarn';
 import cli from 'cli-ux';
 import {runBuild} from 'flipper-pkg-lib';
-import {getInstalledPluginDetails} from 'flipper-plugin-lib';
 
 async function deriveOutputFileName(inputDirectory: string): Promise<string> {
   const packageJson = await readJSON(path.join(inputDirectory, 'package.json'));
@@ -115,14 +114,8 @@ export default class Pack extends Command {
     await yarn.install(inputDirectory);
     cli.action.stop();
 
-    cli.action.start('Reading plugin details');
-    const plugin = await getInstalledPluginDetails(inputDirectory);
-    const out = path.resolve(inputDirectory, plugin.main);
-    cli.action.stop(`done. Source: ${plugin.source}. Main: ${plugin.main}.`);
-
     cli.action.start(`Compiling`);
-    await ensureDir(path.dirname(out));
+    await runBuild(inputDirectory, parsedFlags.production);
-    await runBuild(inputDirectory, plugin.source, out, parsedFlags.production);
     cli.action.stop();
 
     cli.action.start(`Packing to ${outputFile}`);

desktop/scripts/build-plugin.ts

@@ -12,27 +12,68 @@ import path from 'path';
 import fs from 'fs-extra';
 import {execSync} from 'child_process';
 import {resolvePluginDir} from './workspaces';
+import {runBuild, computePackageChecksum} from 'flipper-pkg-lib';
+import yargs from 'yargs';
 
-async function buildPlugin(argv: string[]) {
+const argv = yargs
-  const pluginName = argv[2];
+  .usage('yarn build-plugin [args]')
+  .version(false)
+  .options({
+    plugin: {
+      description:
+        'Plugin ID or path relative to "plugins" dir (e.g. "layout")',
+      type: 'string',
+      demandOption: true,
+      alias: 'p',
+    },
+    version: {
+      description: 'New version to set',
+      type: 'string',
+      alias: 'v',
+    },
+    checksum: {
+      description:
+        'Checksum of the previous plugin package which is used to determine whether the plugin is changed or not. If it is not changed, it will not be packaged.',
+      type: 'string',
+      alias: 'c',
+    },
+    output: {
+      description: 'Where to save the plugin package',
+      type: 'string',
+      alias: 'o',
+    },
+  })
+  .help()
+  .strict()
+  .parse(process.argv.slice(1));
+
+async function buildPlugin() {
+  const pluginName = argv.plugin;
+  const previousChecksum = argv.checksum;
   const pluginDir = await resolvePluginDir(pluginName);
-  const outputFileArg = argv.length > 3 ? argv[3] : null;
+  const outputFileArg = argv.output;
-  const outputFile = outputFileArg
+  await runBuild(pluginDir, false);
-    ? path.resolve(outputFileArg)
+  const checksum = await computePackageChecksum(pluginDir);
-    : path.join(
+  if (previousChecksum !== checksum && argv.version) {
-        distDir,
+    console.log(`Plugin changed. Packaging new version ${argv.version}...`);
-        'plugins',
+    const outputFile = outputFileArg
-        path.relative(pluginsDir, pluginDir) + '.tgz',
+      ? path.resolve(outputFileArg)
-      );
+      : path.join(
-  await fs.ensureDir(path.dirname(outputFile));
+          distDir,
-  await fs.remove(outputFile);
+          'plugins',
-  const bundleCmd = `yarn flipper-pkg bundle "${pluginDir}" --production`;
+          path.relative(pluginsDir, pluginDir) + '.tgz',
-  const packCmd = `yarn pack --cwd "${pluginDir}" --filename ${outputFile}`;
+        );
-  execSync(bundleCmd, {cwd: rootDir, stdio: 'inherit'});
+    await fs.ensureDir(path.dirname(outputFile));
-  execSync(packCmd, {cwd: rootDir, stdio: 'inherit'});
+    await fs.remove(outputFile);
+    const versionCmd = `yarn version --cwd "${pluginDir}" --new-version ${argv.version}`;
+    execSync(versionCmd, {cwd: rootDir, stdio: 'inherit'});
+    const packCmd = `yarn pack --cwd "${pluginDir}" --filename ${outputFile}`;
+    execSync(packCmd, {cwd: rootDir, stdio: 'inherit'});
+    await fs.writeFile(outputFile + '.hash', checksum);
+  }
 }
 
-buildPlugin(process.argv)
+buildPlugin()
   .then(() => {
     process.exit(0);
   })