@applicaster/zapplicaster-cli 16.0.0-alpha.9803580571 → 16.0.0-alpha.9953202182

package/package.json

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

package/src/commands/prepareWorkspace/appBootstrapper.js

@@ -1,7 +1,8 @@
 const R = require("ramda");
 const fs = require("fs");
 const semver = require("semver");
-const { resolve } = require("path");
+const { resolve, join } = require("path");
+const { existsSync } = require("fs");
 const packageJSON = require("../../../package.json");
 
 const {
@@ -30,6 +31,36 @@ const {
 
 const { buildMobileApp } = require("./buildMobile");
 
+async function patchPackages() {
+  if (existsSync(join(process.cwd(), "quick_brick", "patch_rn.js"))) {
+    exec(`node ${process.cwd()}/quick_brick/patch_rn.js`);
+  } else if (
+    existsSync(join(process.cwd(), "development-app", "patch_rn.js"))
+  ) {
+    exec(`node ${process.cwd()}/development-app/patch_rn.js`);
+  } else if (
+    existsSync(
+      join(
+        process.cwd(),
+        "packages",
+        "zapp-react-dom-development-app",
+        "patch_rn.js"
+      )
+    )
+  ) {
+    const pathToFile = join(
+      process.cwd(),
+      "packages",
+      "zapp-react-dom-development-app",
+      "patch_rn.js"
+    );
+
+    exec(`node ${pathToFile}`);
+  } else {
+    logger.log("Cannot patch packages, can't find the patch_rn.js file");
+  }
+}
+
 /**
  * fallback to en for missing dayjslocalization
  * converts the locale code to a dayjs compatible locale code
@@ -185,6 +216,8 @@ async function appBootstrapper(configuration) {
   const quickBrickVersion = packageJSON.version;
   checkAllPluginsSatisfiesQuickBrickVersion({ quickBrickVersion, plugins });
 
+  await patchPackages();
+
   if (buildMobile) {
     await buildMobileApp(configuration);
   }

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/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/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/__tests__/__snapshots__/file.test.js.snap

@@ -13,19 +13,6 @@ exports[`copyFiles when destination path has no package.json doesn't skips the c
 ]
 `;
 
-exports[`copyFiles when there is no package.json to copy copies the dir 1`] = `
-[
-  [
-    "some/source/path/files/file1.txt",
-    "some/destination/Path/files/file1.txt",
-  ],
-  [
-    "some/source/path/files/file2.txt",
-    "some/destination/Path/files/file2.txt",
-  ],
-]
-`;
-
 exports[`copyFiles when there is no package.json to copy copies the files 1`] = `
 [
   [

package/src/file/__tests__/file.test.js

@@ -39,7 +39,6 @@ describe("copyFiles", () => {
     fs.writeFile("bar.json", { bar: "baz" }, jest.fn());
     fs.writeFile("qux.json", { qux: 42 }, jest.fn());
     fs.copyFileSync.mockClear();
-    fs.readdir.mockClear();
   });
 
   describe("when there is no package.json to copy", () => {
@@ -48,21 +47,6 @@ describe("copyFiles", () => {
       expect(fs.copyFileSync).toHaveBeenCalledTimes(2);
       expect(fs.copyFileSync.mock.calls).toMatchSnapshot();
     });
-
-    it("copies the dir", async () => {
-      // Mock fs.readdir to return some files when the directory is read
-      fs.readdir.mockImplementationOnce((path, callback) => {
-        callback(null, ["file1.txt", "file2.txt"]);
-      });
-
-      const results = copyFiles(sourcePath, ["files/"], destinationPath);
-
-      // Wait for the promise to resolve (the directory copy operation)
-      await Promise.all(results);
-
-      expect(fs.copyFileSync).toHaveBeenCalledTimes(2);
-      expect(fs.copyFileSync.mock.calls).toMatchSnapshot();
-    });
   });
 
   describe("when destination path has package.json", () => {

package/src/file/index.js

@@ -5,17 +5,7 @@ const R = require("ramda");
  * @module @applicaster/zapplicaster-cli/util/file
  */
 
-const {
-  writeFile,
-  readFile,
-  readdir,
-  copyFile,
-  copyFileSync,
-  lstatSync,
-  mkdirSync,
-  existsSync,
-} = require("fs");
-
+const { writeFile, readFile, readdir, copyFile, copyFileSync } = require("fs");
 const { promisify } = require("util");
 const { join } = require("path");
 
@@ -71,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
  */
@@ -83,25 +78,13 @@ function copyFiles(source, filesOrFilesGetter, destination, config) {
       : filesOrFilesGetter;
 
   return R.map((file) => {
-    let sourcePath, destinationPath;
-
-    if (Array.isArray(file)) {
-      sourcePath = join(source, file[0]);
-      destinationPath = destinationFileNameMapper(join(destination, file[1]));
-    } else {
-      sourcePath = join(source, file);
-      destinationPath = destinationFileNameMapper(join(destination, file));
-    }
-
-    if (lstatSync(sourcePath).isDirectory()) {
-      if (!existsSync(destinationPath)) {
-        mkdirSync(destinationPath, { recursive: true });
-      }
-
-      return copyFolder(sourcePath, destinationPath);
-    }
+    const sourceFile = typeof file === "string" ? file : file.source;
+    const destinationFile = typeof file === "string" ? file : file.destination;
 
-    return copyFileSync(sourcePath, destinationPath);
+    return copyFileSync(
+      join(source, sourceFile),
+      destinationFileNameMapper(join(destination, destinationFile))
+    );
   }, files);
 }
 

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

package/test_helpers/fsMock.js

@@ -2,18 +2,10 @@ const fs = jest.genMockFromModule("fs");
 const _fs = jest.requireActual("fs");
 const R = require("ramda");
 
-function mkdirSync() {
-  return {};
-}
-
 function readdirSync(folder) {
   return _fs.readdirSync(folder);
 }
 
-async function readdirAsync(folder) {
-  return Promise.resolve(_fs.readdirSync(folder));
-}
-
 function readdir(folder, callback) {
   const files = R.map(R.prop("fileName"), fs.__writenFiles);
 
@@ -85,17 +77,10 @@ function __resetFiles() {
   fs.__writenFiles = [];
 }
 
-fs.lstatSync = (_path) => ({
-  isDirectory: () => _path.endsWith("/"),
-  isFile: () => _path.endsWith("/") === false,
-});
-
 fs.__writenFiles = [];
 fs.__resetFiles = __resetFiles;
 fs.__addMockedFiles = __addMockedFiles;
 fs.readdirSync = readdirSync;
-fs.readdirAsync = readdirAsync;
-fs.mkdirSync = mkdirSync;
 fs.readdir = jest.fn(readdir);
 fs.writeFile = jest.fn(writeFile);
 fs.readFile = jest.fn(readFile);