@applicaster/zapplicaster-cli 16.0.0-rc.8 → 16.0.0-rc.80

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applicaster/zapplicaster-cli",
-  "version": "16.0.0-rc.8",
+  "version": "16.0.0-rc.80",
   "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.8",
-    "@applicaster/zapp-react-native-android-tv-cli-template": "16.0.0-rc.8",
-    "@applicaster/zapp-react-native-cli-template": "16.0.0-rc.8",
-    "@applicaster/zapp-react-native-tvos-cli-template": "16.0.0-rc.8",
+    "@applicaster/zapp-react-dom-cli-template": "16.0.0-rc.80",
+    "@applicaster/zapp-react-native-android-tv-cli-template": "16.0.0-rc.80",
+    "@applicaster/zapp-react-native-cli-template": "16.0.0-rc.80",
+    "@applicaster/zapp-react-native-tvos-cli-template": "16.0.0-rc.80",
     "axios": "^0.28.0",
     "camelize": "^1.0.0",
     "chalk": "^2.3.2",

package/src/commands/prepareWorkspace/__tests__/__snapshots__/configurator.test.js.snap

@@ -8,6 +8,7 @@ exports[`configurator builds the configuration object 1`] = `
     "appVersionId": "APP_VERSION_ID",
     "assets_url": "https://assets-secure.applicaster.com/zapp/accounts/5ae06cef8fba0f00084bd3c6/apps/com.quickbricktest/apple_store/1.8/styles/assets_styles.json",
     "otherParam": "param",
+    "vidaa_client_partner_id": undefined,
   },
   "destinationPath": "development-app",
   "deviceTarget": undefined,
@@ -32,6 +33,7 @@ exports[`configurator sets a null path if none is provided and the cli doesn't r
     "appVersionId": "APP_VERSION_ID",
     "assets_url": "https://assets-secure.applicaster.com/zapp/accounts/5ae06cef8fba0f00084bd3c6/apps/com.quickbricktest/apple_store/1.8/styles/assets_styles.json",
     "otherParam": "param",
+    "vidaa_client_partner_id": undefined,
   },
   "destinationPath": null,
   "deviceTarget": undefined,

package/src/commands/prepareWorkspace/appBootstrapper.js

@@ -193,6 +193,15 @@ async function appBootstrapper(configuration) {
     .map(toDayJSLocaleMap)
     .filter((v) => v !== "en");
 
+  if (
+    configuration.buildParams.device_target === "vidaa" &&
+    !configuration.buildParams.vidaa_client_partner_id
+  ) {
+    logger.warn(
+      "In order to use the VIDAA SDK you will need to set vidaa_client_partner_id"
+    );
+  }
+
   configuration.excludedNodeModules = getExcludedNodeModules(plugins);
   const { filesToRender } = template.files;
 

package/src/commands/prepareWorkspace/configurator.js

@@ -1,9 +1,30 @@
 const R = require("ramda");
 const axios = require("axios");
+
+const {
+  platformIsTV,
+} = require("@applicaster/zapp-react-native-utils/manifestUtils/platformIsTV");
+
 const { getAppVersionParams } = require("../../zapp");
 const { resolveAppTemplate } = require("../../templates");
 const { isZappReactNativeRepo } = require("../../settings");
 
+function resolveVidaaClientPartnerId(buildParams = {}) {
+  const fromBuildParams = buildParams.vidaa_client_partner_id;
+
+  if (typeof fromBuildParams === "string" && fromBuildParams.trim()) {
+    return fromBuildParams.trim();
+  }
+
+  const fromEnv = process.env.vidaa_client_partner_id;
+
+  if (typeof fromEnv === "string" && fromEnv.trim()) {
+    return fromEnv.trim();
+  }
+
+  return undefined;
+}
+
 const store_map = {
   amazon: "amazon",
   google_play: "android",
@@ -11,6 +32,7 @@ const store_map = {
   samsung_app_store: "samsung_tv",
   lg_content_store: "lg_tv",
   vizio_app_store: "vizio",
+  vidaa_app_store: "vidaa",
 };
 
 /**
@@ -21,7 +43,7 @@ const store_map = {
  */
 async function retrievesSpinnerColor(url, platform) {
   try {
-    if (!R.contains(platform, ["samsung_tv", "lg_tv", "vizio"])) {
+    if (!platformIsTV(platform)) {
       return;
     }
 
@@ -72,6 +94,9 @@ async function configurator({ cliArgs, cliOptions }) {
 
   const buildParams = await getAppVersionParams(appVersionId);
 
+  buildParams.vidaa_client_partner_id =
+    resolveVidaaClientPartnerId(buildParams);
+
   delete buildParams.styles_url; // deprecated
 
   const platform = resolvePlatform(buildParams.assets_url);

package/src/commands/prepareWorkspace/parseFonts.js

@@ -133,6 +133,12 @@ const defaultFonts = {
     "Miso-Bold.ttf",
     ...commonFonts,
   ],
+  vidaa: [
+    "Miso-Light.ttf",
+    "Miso-Regular.ttf",
+    "Miso-Bold.ttf",
+    ...commonFonts,
+  ],
   vizio: [
     "Miso-Light.ttf",
     "Miso-Regular.ttf",

package/src/commands/publishPlugin/generateManifest.js

@@ -49,6 +49,7 @@ function renderManifest({
 
 const validPlatforms = [
   "lg_tv",
+  "vidaa",
   "samsung_tv",
   "vizio",
   "android_tv_for_quickbrick",

package/src/commands/reloadConfig/__tests__/__snapshots__/reloadConfig.test.js.snap

@@ -0,0 +1,58 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`reloadConfig runs the reload config task 1`] = `
+[
+  [
+    "reload configuration",
+    "We're reloading the configuration for your app",
+  ],
+]
+`;
+
+exports[`reloadConfig runs the reload config task 2`] = `[]`;
+
+exports[`reloadConfig runs the reload config task 3`] = `[]`;
+
+exports[`reloadConfig runs the reload config task 4`] = `[]`;
+
+exports[`reloadConfig runs the reload config task 5`] = `
+[
+  [
+    "checking prerequisites...",
+  ],
+  [
+    "Gathering configuration",
+  ],
+  [
+    "Creating workspace",
+  ],
+  [
+    "Creating runtime URLs configuration file",
+  ],
+  [
+    "Retrieving configuration files",
+  ],
+]
+`;
+
+exports[`reloadConfig runs the reload config task 6`] = `
+[
+  [
+    "All good - moving on",
+  ],
+  [
+    "configuration retrieved",
+  ],
+  [
+    "Workspace created !",
+  ],
+  [
+    "Runtime configuration URLs file created",
+  ],
+  [
+    "Configuration files retrieved !",
+  ],
+]
+`;
+
+exports[`reloadConfig runs the reload config task 7`] = `[]`;

package/src/commands/reloadConfig/__tests__/reloadConfig.test.js

@@ -0,0 +1,86 @@
+const { reloadConfig } = require("../index");
+
+const appVersionId = "e7a17c6f-4113-41ac-9450-6281d22153a1";
+
+const options = {
+  appVersionId,
+  openSdk: true,
+  config: "some_file",
+};
+
+jest.mock("../../../logger", () => ({
+  welcome: jest.fn(),
+  log: jest.fn(),
+  error: jest.fn(),
+  warn: jest.fn(),
+  startStep: jest.fn(),
+  endStep: jest.fn(),
+  success: jest.fn(),
+}));
+
+jest.mock("../../prepareWorkspace/prerequisitesChecker.js", () => ({
+  prerequisitesChecker: jest.fn(() => true),
+}));
+
+const mockConfig = { appVersionId, buildParams: {} };
+
+jest.mock("../../prepareWorkspace/configurator.js", () => ({
+  configurator: jest.fn(() => mockConfig),
+}));
+
+jest.mock("../../prepareWorkspace/workspaceCreator.js", () => ({
+  workspaceCreator: jest.fn(),
+}));
+
+jest.mock("../../prepareWorkspace/configFilesRetriever.js", () => ({
+  configFilesRetriever: jest.fn(),
+}));
+
+jest.mock("../../prepareWorkspace/runtimeConfigurationUrlsCreator.js", () => ({
+  runtimeConfigurationUrlsCreator: jest.fn(),
+}));
+
+const {
+  prerequisitesChecker,
+} = require("../../prepareWorkspace/prerequisitesChecker");
+
+const { configurator } = require("../../prepareWorkspace/configurator");
+const { workspaceCreator } = require("../../prepareWorkspace/workspaceCreator");
+
+const {
+  configFilesRetriever,
+} = require("../../prepareWorkspace/configFilesRetriever");
+
+const {
+  runtimeConfigurationUrlsCreator,
+} = require("../../prepareWorkspace/runtimeConfigurationUrlsCreator");
+
+const logger = require("../../../logger");
+
+describe("reloadConfig", () => {
+  it("runs the reload config task", async () => {
+    await reloadConfig(appVersionId, options);
+
+    expect(logger.welcome.mock.calls).toMatchSnapshot();
+    expect(logger.log.mock.calls).toMatchSnapshot();
+    expect(logger.error.mock.calls).toMatchSnapshot();
+    expect(logger.warn.mock.calls).toMatchSnapshot();
+    expect(logger.startStep.mock.calls).toMatchSnapshot();
+    expect(logger.endStep.mock.calls).toMatchSnapshot();
+    expect(logger.success.mock.calls).toMatchSnapshot();
+
+    expect(prerequisitesChecker).toHaveBeenCalledWith({
+      cliArgs: [appVersionId],
+      cliOptions: options,
+    });
+
+    expect(configurator).toHaveBeenCalledWith({
+      cliArgs: [appVersionId],
+      cliOptions: options,
+    });
+
+    expect(workspaceCreator).toHaveBeenCalledWith(mockConfig);
+    expect(runtimeConfigurationUrlsCreator).toHaveBeenCalledWith(mockConfig);
+    expect(configFilesRetriever).toHaveBeenCalledWith(mockConfig);
+  });
+});

package/src/commands/reloadConfig/index.js

@@ -27,18 +27,18 @@ const reloadConfigTask = {
       error: "Could not create workspace",
       completion: "Workspace created !",
     },
-    {
-      start: "Retrieving configuration files",
-      run: configFilesRetriever,
-      error: "Could not retrieve configuration files",
-      completion: "Configuration files retrieved !",
-    },
     {
       start: "Creating runtime URLs configuration file",
       run: runtimeConfigurationUrlsCreator,
       error: "Could not create runtime_configuration_urls.json",
       completion: "Runtime configuration URLs file created",
     },
+    {
+      start: "Retrieving configuration files",
+      run: configFilesRetriever,
+      error: "Could not retrieve configuration files",
+      completion: "Configuration files retrieved !",
+    },
   ],
 };
 

package/src/download/__tests__/download.test.js

@@ -1,6 +1,7 @@
 const { saveRemoteJsonToFile, saveAssets, saveFontFiles } = require("../index");
 const nock = require("nock");
 const R = require("ramda");
+const fs = require("fs");
 const logger = require("../../logger");
 
 const getFileName = R.compose(R.last, R.split("/"));
@@ -109,9 +110,37 @@ describe("saveAssets", () => {
 
   afterEach(() => {
     clearAllMocks();
+
+    ["existsSync", "openSync", "closeSync", "readSync", "readFileSync"].forEach(
+      (method) => {
+        if (fs[method] && fs[method].mockRestore) {
+          fs[method].mockRestore();
+        }
+      }
+    );
   });
 
+  function mockDownloadedFile({ isZip, content } = {}) {
+    jest.spyOn(fs, "existsSync").mockReturnValue(true);
+    jest.spyOn(fs, "openSync").mockReturnValue(1);
+    jest.spyOn(fs, "closeSync").mockImplementation(() => ({}));
+
+    jest.spyOn(fs, "readSync").mockImplementation((fd, buffer) => {
+      const header = isZip
+        ? Buffer.from([0x50, 0x4b, 0x03, 0x04])
+        : Buffer.from("<?xm");
+
+      header.copy(buffer);
+
+      return 4;
+    });
+
+    jest.spyOn(fs, "readFileSync").mockReturnValue(content || "");
+  }
+
   it("downloads the files with cURL, and unzips the assets", () => {
+    mockDownloadedFile({ isZip: true });
+
     saveAssets({ destinationPath, platform }, assetsUrl);
 
     expect(loggerSpy).toHaveBeenCalledWith(`saving assets from ${assetsUrl}`);
@@ -122,6 +151,30 @@ describe("saveAssets", () => {
       filePath
     );
   });
+
+  it("throws a clear error and skips unzip when the bundle is not a zip", () => {
+    mockDownloadedFile({
+      isZip: false,
+      content:
+        '<?xml version="1.0" encoding="UTF-8"?><Error><Code>AccessDenied</Code></Error>',
+    });
+
+    expect(() => saveAssets({ destinationPath, platform }, assetsUrl)).toThrow(
+      /AccessDenied/
+    );
+
+    expect(shell.unzip).not.toHaveBeenCalled();
+  });
+
+  it("throws a clear error when the bundle was not downloaded", () => {
+    jest.spyOn(fs, "existsSync").mockReturnValue(false);
+
+    expect(() => saveAssets({ destinationPath, platform }, assetsUrl)).toThrow(
+      /was not downloaded/
+    );
+
+    expect(shell.unzip).not.toHaveBeenCalled();
+  });
 });
 
 describe("saveFontFiles", () => {

package/src/download/index.js

@@ -1,4 +1,5 @@
 const R = require("ramda");
+const fs = require("fs");
 const axios = require("axios");
 const { resolve } = require("path");
 const { curlFile, curlMultipleFiles, unzip } = require("../shell");
@@ -12,6 +13,64 @@ const getFileName = R.ifElse(
   R.prop("name")
 );
 
+// Local file signature for a zip archive: "PK\x03\x04"
+const ZIP_SIGNATURE = "504b0304";
+
+/**
+ * checks whether a file on disk is a real zip archive by reading its magic bytes.
+ * @param {String} file path to the file to inspect
+ * @returns {Boolean} true if the file starts with the zip local file signature
+ */
+function isZipFile(file) {
+  const fd = fs.openSync(file, "r");
+
+  try {
+    const header = Buffer.alloc(4);
+    const bytesRead = fs.readSync(fd, header, 0, 4, 0);
+
+    return bytesRead === 4 && header.toString("hex") === ZIP_SIGNATURE;
+  } finally {
+    fs.closeSync(fd);
+  }
+}
+
+/**
+ * verifies that the downloaded assets bundle is a real zip archive.
+ * The assets CDN responds with a small XML/HTML body (e.g. S3 "AccessDenied")
+ * when the bundle is missing or not yet published. Because the download uses
+ * `curl -O` without `-f`, that error body is saved as assets.zip and the process
+ * continues, only to crash later in webpack with a confusing parse error. This
+ * check fails fast in the prepare step with an actionable message instead.
+ * @param {String} file path to the downloaded assets bundle
+ * @param {String} assetsUrl original url, surfaced in the error message
+ */
+function assertValidAssetsBundle(file, assetsUrl) {
+  if (!fs.existsSync(file)) {
+    throw new Error(
+      `Assets bundle was not downloaded from ${assetsUrl}. ` +
+        "Verify the app has a published build with generated assets for this platform."
+    );
+  }
+
+  if (isZipFile(file)) {
+    return;
+  }
+
+  const preview = fs
+    .readFileSync(file, "utf8")
+    .replace(/\s+/g, " ")
+    .trim()
+    .slice(0, 300);
+
+  throw new Error(
+    `Invalid assets bundle downloaded from ${assetsUrl} - expected a zip archive ` +
+      `but received non-zip content:\n  "${preview}"\n` +
+      "This usually means the assets bundle has not been generated/published for " +
+      'this platform, or the URL is not accessible (e.g. S3 "AccessDenied"). ' +
+      "Publish a build with assets for this platform before preparing the workspace."
+  );
+}
+
 /**
  * saves a remote json file in the app's configuration folder.
  * curried function of the shape saveRemoteJsonToFile(configuration)(fileUrl)
@@ -65,7 +124,12 @@ function saveAssets({ destinationPath, platform }, assetsUrl) {
   });
 
   curlFile(assetsUrl, filePath);
-  unzip(resolve(filePath, fileName), filePath);
+
+  const downloadedFile = resolve(filePath, fileName);
+
+  assertValidAssetsBundle(downloadedFile, assetsUrl);
+
+  unzip(downloadedFile, filePath);
 }
 
 /**

package/src/file/index.js

@@ -61,8 +61,13 @@ function destinationFileNameMapper(destinationFileName) {
 /**
  * Copies an array of files from a folder to another
  *
+ * Each entry can either be a string (same relative path for source and
+ * destination) or an object `{ source, destination }` when a file should be
+ * read from one relative path and written to another. The latter lets several
+ * platforms reuse a single set of bundled assets without duplicating them.
+ *
  * @param {String} source folder of the files
- * @param {String[]} files list of the files
+ * @param {(String|{source: String, destination: String})[]} files list of the files
  * @param {String} destination path
  * @returns {Promise[]} array of promises with the status of the copied files
  */
@@ -72,14 +77,15 @@ function copyFiles(source, filesOrFilesGetter, destination, config) {
       ? filesOrFilesGetter(config)
       : filesOrFilesGetter;
 
-  return R.map(
-    (file) =>
-      copyFileSync(
-        join(source, file),
-        destinationFileNameMapper(join(destination, file))
-      ),
-    files
-  );
+  return R.map((file) => {
+    const sourceFile = typeof file === "string" ? file : file.source;
+    const destinationFile = typeof file === "string" ? file : file.destination;
+
+    return copyFileSync(
+      join(source, sourceFile),
+      destinationFileNameMapper(join(destination, destinationFile))
+    );
+  }, files);
 }
 
 module.exports = {

package/src/templates/__tests__/__snapshots__/templates.test.js.snap

@@ -32,4 +32,4 @@ exports[`resolveAppTemplate retrieves the template from the provided path if pro
 }
 `;
 
-exports[`resolveAppTemplate throws if resolving a template for an unknown platform 1`] = `"could not find template for foo - available templates: ios,android,samsung_tv,lg_tv,vizio,apple_tv,android_tv,amazon"`;
+exports[`resolveAppTemplate throws if resolving a template for an unknown platform 1`] = `"could not find template for foo - available templates: ios,android,samsung_tv,lg_tv,vidaa,vizio,apple_tv,android_tv,amazon"`;

package/src/templates/index.js

@@ -27,6 +27,7 @@ const templatesMap = {
   android: "@applicaster/zapp-react-native-cli-template",
   samsung_tv: "@applicaster/zapp-react-dom-cli-template",
   lg_tv: "@applicaster/zapp-react-dom-cli-template",
+  vidaa: "@applicaster/zapp-react-dom-cli-template",
   vizio: "@applicaster/zapp-react-dom-cli-template",
   apple_tv: "@applicaster/zapp-react-native-tvos-cli-template",
   android_tv: "@applicaster/zapp-react-native-android-tv-cli-template",