@applicaster/zapplicaster-cli 16.0.0-rc.25 → 16.0.0-rc.26

package/package.json

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

package/src/commands/prepareWorkspace/configurator.js

@@ -1,5 +1,10 @@
 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");
@@ -11,6 +16,7 @@ const store_map = {
   samsung_app_store: "samsung_tv",
   lg_content_store: "lg_tv",
   vizio_app_store: "vizio",
+  vidaa_app_store: "vidaa",
 };
 
 /**
@@ -21,7 +27,7 @@ const store_map = {
  */
 async function retrievesSpinnerColor(url, platform) {
   try {
-    if (!R.contains(platform, ["samsung_tv", "lg_tv", "vizio"])) {
+    if (!platformIsTV(platform)) {
       return;
     }
 

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/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",