Added new package "flipper-plugin-lib" which contains re-usable code related to plugin installation

Summary: No functional changes, just refactoring for easier implementation of plugin updates installation Reviewed By: passy Differential Revision: D21902525 fbshipit-source-id: fbfa221a89b879b0d08127676b27df65ef63307d
2020-06-05 06:07:54 -07:00
parent 579172fa39
commit 339b786fb5
21 changed files with 111 additions and 11 deletions
--- a/desktop/plugin-lib/src/getPluginDetails.ts
+++ b/desktop/plugin-lib/src/getPluginDetails.ts
@@ -0,0 +1,84 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @format
+ */
+
+import fs from 'fs-extra';
+import path from 'path';
+import PluginDetails from './PluginDetails';
+
+export default async function (
+  pluginDir: string,
+  packageJson?: any,
+): Promise<PluginDetails> {
+  packageJson =
+    packageJson || (await fs.readJson(path.join(pluginDir, 'package.json')));
+  const specVersion =
+    packageJson.$schema &&
+    packageJson.$schema ===
+      'https://fbflipper.com/schemas/plugin-package/v2.json'
+      ? 2
+      : 1;
+  switch (specVersion) {
+    case 1:
+      return await getPluginDetailsV1(pluginDir, packageJson);
+    case 2:
+      return await getPluginDetailsV2(pluginDir, packageJson);
+    default:
+      throw new Error(`Unknown plugin format version: ${specVersion}`);
+  }
+}
+
+// Plugins packaged using V1 are distributed as sources and compiled in run-time.
+async function getPluginDetailsV1(
+  pluginDir: string,
+  packageJson: any,
+): Promise<PluginDetails> {
+  return {
+    specVersion: 1,
+    dir: pluginDir,
+    name: packageJson.name,
+    version: packageJson.version,
+    main: 'dist/bundle.js',
+    source: packageJson.main,
+    id: packageJson.name,
+    gatekeeper: packageJson.gatekeeper,
+    icon: packageJson.icon,
+    title: packageJson.title || packageJson.name,
+    category: packageJson.category,
+    bugs: packageJson.bugs,
+  };
+}
+
+// Plugins packaged using V2 are pre-bundled, so compilation in run-time is not required for them.
+async function getPluginDetailsV2(
+  pluginDir: string,
+  packageJson: any,
+): Promise<PluginDetails> {
+  return {
+    specVersion: 2,
+    dir: pluginDir,
+    name: packageJson.name,
+    version: packageJson.version,
+    main: packageJson.main,
+    source: packageJson.flipperBundlerEntry,
+    id: packageJson.id || packageJson.name,
+    gatekeeper: packageJson.gatekeeper,
+    icon: packageJson.icon,
+    title:
+      packageJson.title || packageJson.id || getTitleFromName(packageJson.name),
+    category: packageJson.category,
+    bugs: packageJson.bugs,
+  };
+}
+
+function getTitleFromName(name: string) {
+  const prefix = 'flipper-plugin-';
+  if (name.startsWith(prefix)) {
+    return name.substr(prefix.length);
+  }
+}