@applicaster/zapplicaster-cli 16.0.0-rc.101 → 16.0.0-rc.104

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applicaster/zapplicaster-cli",
-  "version": "16.0.0-rc.101",
+  "version": "16.0.0-rc.104",
   "description": "CLI Tool for the zapp app and Quick Brick project",
   "main": "index.js",
   "publishConfig": {
@@ -28,10 +28,10 @@
   },
   "homepage": "https://github.com/applicaster/quickbrick#readme",
   "dependencies": {
-    "@applicaster/zapp-react-dom-cli-template": "16.0.0-rc.101",
-    "@applicaster/zapp-react-native-android-tv-cli-template": "16.0.0-rc.101",
-    "@applicaster/zapp-react-native-cli-template": "16.0.0-rc.101",
-    "@applicaster/zapp-react-native-tvos-cli-template": "16.0.0-rc.101",
+    "@applicaster/zapp-react-dom-cli-template": "16.0.0-rc.104",
+    "@applicaster/zapp-react-native-android-tv-cli-template": "16.0.0-rc.104",
+    "@applicaster/zapp-react-native-cli-template": "16.0.0-rc.104",
+    "@applicaster/zapp-react-native-tvos-cli-template": "16.0.0-rc.104",
     "axios": "^0.28.0",
     "camelize": "^1.0.0",
     "chalk": "^2.3.2",

package/src/commands/prepareWorkspace/__tests__/buildPluginsCreator.test.js

@@ -0,0 +1,99 @@
+const fs = require("fs");
+const os = require("os");
+const path = require("path");
+
+jest.mock("../../../render", () => ({
+  saveConfigFile: jest.fn(),
+}));
+
+jest.mock("../../../settings/paths", () => ({
+  getFileDestinationPath: jest.fn(),
+}));
+
+jest.mock("../../../logger", () => ({
+  error: jest.fn(),
+}));
+
+const { saveConfigFile } = require("../../../render");
+const { getFileDestinationPath } = require("../../../settings/paths");
+const logger = require("../../../logger");
+
+const {
+  buildPluginsCreator,
+  getBuildPlugins,
+} = require("../buildPluginsCreator");
+
+const pluginConfigurations = [
+  {
+    plugin: {
+      identifier: "zeta",
+      name: "Zeta",
+      manifest_version: "2.0.0",
+      dependency_version: "1.0.0",
+    },
+    configuration_json: { key: "value" },
+  },
+  { plugin: { identifier: "alpha", dependency_version: "3.1.0" } },
+  { plugin: { name: "no identifier, skipped" } },
+  { configuration_json: {} },
+];
+
+const expected = [
+  { id: "alpha", name: null, version: "3.1.0" },
+  { id: "zeta", name: "Zeta", version: "2.0.0" },
+];
+
+const configuration = { destinationPath: "path/to/workspace", platform: "ios" };
+
+describe("getBuildPlugins", () => {
+  it("maps plugins to id, name, version sorted by id, preferring manifest_version", () => {
+    expect(getBuildPlugins(pluginConfigurations)).toEqual(expected);
+  });
+});
+
+describe("buildPluginsCreator", () => {
+  const file = path.join(
+    os.tmpdir(),
+    `plugin_configurations_${process.pid}.json`
+  );
+
+  afterEach(() => {
+    jest.clearAllMocks();
+    fs.rmSync(file, { force: true });
+  });
+
+  it("writes build_plugins.json from the downloaded plugin_configurations.json", async () => {
+    fs.writeFileSync(file, JSON.stringify(pluginConfigurations));
+    getFileDestinationPath.mockReturnValue(file);
+
+    await buildPluginsCreator(configuration);
+
+    expect(getFileDestinationPath).toHaveBeenCalledWith({
+      ...configuration,
+      folder: "config",
+      fileName: "plugin_configurations.json",
+    });
+
+    expect(saveConfigFile).toHaveBeenCalledWith(
+      configuration,
+      "build_plugins.json",
+      expected
+    );
+
+    expect(logger.error).not.toHaveBeenCalled();
+  });
+
+  it("writes an empty list and logs an error when plugin_configurations.json is missing", async () => {
+    getFileDestinationPath.mockReturnValue(file);
+
+    await buildPluginsCreator(configuration);
+
+    expect(saveConfigFile).toHaveBeenCalledWith(
+      configuration,
+      "build_plugins.json",
+      []
+    );
+
+    expect(logger.error).toHaveBeenCalled();
+  });
+});

package/src/commands/prepareWorkspace/buildPluginsCreator.js

@@ -0,0 +1,61 @@
+const fs = require("fs");
+
+const { saveConfigFile } = require("../../render");
+const { getFileDestinationPath } = require("../../settings/paths");
+const logger = require("../../logger");
+
+/**
+ * Plugins the app is built with, as [{ id, name, version }] sorted by id.
+ * version is manifest_version, falling back to dependency_version.
+ * @param {Array} pluginConfigurations content of plugin_configurations.json
+ */
+function getBuildPlugins(pluginConfigurations) {
+  return pluginConfigurations
+    .filter((entry) => typeof entry?.plugin?.identifier === "string")
+    .map(({ plugin }) => ({
+      id: plugin.identifier,
+      name: plugin.name ?? null,
+      version: plugin.manifest_version ?? plugin.dependency_version ?? null,
+    }))
+    .sort((a, b) => (a.id < b.id ? -1 : a.id > b.id ? 1 : 0));
+}
+
+/**
+ * Writes build_plugins.json next to the downloaded plugin_configurations.json.
+ * The app bundles it on every platform (plugin_configurations.json itself is only bundled in __DEV__),
+ * so tools like X-Ray can report what the build contains, not what Zapp serves now.
+ * @param {Object} configuration
+ * @param {String} configuration.destinationPath path of the workspace
+ * @param {String} configuration.platform platform of the app
+ */
+async function buildPluginsCreator(configuration) {
+  const { destinationPath, platform } = configuration;
+
+  let buildPlugins = [];
+
+  try {
+    const pluginConfigurations = JSON.parse(
+      fs.readFileSync(
+        getFileDestinationPath({
+          destinationPath,
+          platform,
+          folder: "config",
+          fileName: "plugin_configurations.json",
+        }),
+        "utf8"
+      )
+    );
+
+    buildPlugins = getBuildPlugins(pluginConfigurations);
+  } catch (e) {
+    logger.error(
+      `Could not read plugin_configurations.json, build_plugins.json will be empty: ${e.message}`
+    );
+  }
+
+  await saveConfigFile(configuration, "build_plugins.json", buildPlugins);
+
+  return true;
+}
+
+module.exports = { buildPluginsCreator, getBuildPlugins };

package/src/commands/prepareWorkspace/configFilesRetriever.js

@@ -7,6 +7,7 @@ const {
 } = require("../../download");
 
 const { renderConfigFile } = require("../../render");
+const { buildPluginsCreator } = require("./buildPluginsCreator");
 
 /**
  * @typedef configuration
@@ -45,6 +46,8 @@ async function configFilesRetriever(configuration) {
     R.map(saveRemoteJsonToFile(configuration), configFilesUrls)
   );
 
+  await buildPluginsCreator(configuration);
+
   const { fonts_url, fonts, assets_url } = buildParams;
   saveFontFiles(configuration, fonts_url, fonts);
   saveAssets(configuration, assets_url);