zapier-platform-cli 17.1.0 → 17.3.0

package/src/utils/files.js

@@ -1,10 +1,11 @@
-const _ = require('lodash');
-const crypto = require('crypto');
-const os = require('os');
-const path = require('path');
+const crypto = require('node:crypto');
+const fs = require('node:fs');
+const os = require('node:os');
+const path = require('node:path');
 
-const fse = require('fs-extra');
+const _ = require('lodash');
 const colors = require('colors/safe');
+const fse = require('fs-extra');
 
 const fixHome = (dir) => {
   const home = process.env.HOME || process.env.USERPROFILE;
@@ -200,19 +201,52 @@ const makeTempDir = () => {
   return workdir;
 };
 
+// Iterates files and symlinks in a directory recursively.
+// Yields fs.Dirent objects.
+function* walkDir(dir) {
+  const entries = fs.readdirSync(dir, { withFileTypes: true });
+  for (const entry of entries) {
+    if (entry.isDirectory()) {
+      const subDir = path.join(entry.parentPath, entry.name);
+      yield* walkDir(subDir);
+    } else if (entry.isFile() || entry.isSymbolicLink()) {
+      yield entry;
+    }
+  }
+}
+
+// Iterates files and symlinks in a directory recursively, up to a specified
+// number of levels deep (maxLevels). The minimum value for maxLevels is 1.
+// Yields fs.Dirent objects.
+function* walkDirLimitedLevels(dir, maxLevels, currentLevel = 1) {
+  const entries = fs.readdirSync(dir, { withFileTypes: true });
+  for (const entry of entries) {
+    if (entry.isDirectory()) {
+      if (currentLevel < maxLevels) {
+        const subDir = path.join(entry.parentPath, entry.name);
+        yield* walkDirLimitedLevels(subDir, maxLevels, currentLevel + 1);
+      }
+    } else if (entry.isFile() || entry.isSymbolicLink()) {
+      yield entry;
+    }
+  }
+}
+
 module.exports = {
   copyDir,
+  copyFile,
   deleteFile,
   ensureDir,
   fileExistsSync,
   isEmptyDir,
   isExistingEmptyDir,
+  makeTempDir,
   readFile,
   readFileStr,
   removeDir,
   removeDirSync,
   validateFileExists,
+  walkDir,
+  walkDirLimitedLevels,
   writeFile,
-  copyFile,
-  makeTempDir,
 };

package/src/utils/ignore.js

@@ -1,20 +1,40 @@
-const fs = require('fs');
+const fs = require('node:fs');
+const path = require('node:path');
+
 const colors = require('colors/safe');
-const ignore = require('ignore');
 const gitIgnore = require('parse-gitignore');
-const path = require('path');
+const ignore = require('ignore');
+
+const { IS_TESTING } = require('../constants');
+
+const BLOCKLISTED_PREFIXES = [
+  '.DS_Store',
+  `.git${path.sep}`,
+  `build${path.sep}`,
+];
+const BLOCKLISTED_SUFFIXES = ['.gitkeep', '.env', '.environment', '.zip'];
 
-const constants = require('../constants');
-const isBlocklisted = (filePath) => {
-  return constants.BLOCKLISTED_PATHS.find((excluded) => {
-    return filePath.search(excluded) === 0;
-  });
+// Tells if we should exclude a file from build.zip or source.zip
+const isBlocklisted = (relPath) => {
+  // Will be excluded from build.zip and source.zip
+  for (const prefix of BLOCKLISTED_PREFIXES) {
+    if (relPath.startsWith(prefix)) {
+      return true;
+    }
+  }
+  for (const suffix of BLOCKLISTED_SUFFIXES) {
+    if (relPath.endsWith(suffix)) {
+      return true;
+    }
+  }
+  return false;
 };
+
 // Exclude file paths in .gitignore
 const respectGitIgnore = (dir, paths) => {
   const gitIgnorePath = path.join(dir, '.gitignore');
   if (!fs.existsSync(gitIgnorePath)) {
-    if (!constants.IS_TESTING) {
+    if (!IS_TESTING) {
       console.warn(
         `\n\n\t${colors.yellow(
           '!! Warning !!',

package/src/utils/itertools.js

@@ -0,0 +1,39 @@
+// This module provides convenience functions for working with Generators:
+// https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Generator
+
+// Filters an iterable using a predicate function. Example:
+//
+// const isEven = (x) => x % 2 === 0;
+// function* generateNumbers() {
+//   for (let i = 0; i < 100; i++) {
+//     yield i;
+//   }
+// }
+// const generateEvenNumbers = iterfilter(isEven, generateNumbers());
+function* iterfilter(predicate, iterable) {
+  for (const item of iterable) {
+    if (predicate(item)) {
+      yield item;
+    }
+  }
+}
+
+// Maps an iterable using a function, like Array.prototype.map. Example:
+//
+//  const double = (x) => x * 2;
+//  function* generateNumbers() {
+//    for (let i = 0; i < 100; i++) {
+//      yield i;
+//    }
+//  }
+//  const generateDoubledNumbers = itermap(double, generateNumbers());
+function* itermap(fn, iterable) {
+  for (const item of iterable) {
+    yield fn(item);
+  }
+}
+
+module.exports = {
+  iterfilter,
+  itermap,
+};

package/src/utils/misc.js

@@ -69,10 +69,11 @@ const runCommand = (command, args, options) => {
     result.on('error', reject);
 
     result.on('close', (code) => {
-      if (code !== 0) {
+      if (code === 0) {
+        resolve({ stdout, stderr });
+      } else {
         reject(new Error(stderr));
       }
-      resolve({ stdout, stderr });
     });
   });
 };
@@ -80,8 +81,8 @@ const runCommand = (command, args, options) => {
 const isValidNodeVersion = (version = process.version) =>
   semver.satisfies(version, NODE_VERSION_CLI_REQUIRES);
 
-const findCorePackageDir = () => {
-  let baseDir = process.cwd();
+const findCorePackageDir = (workingDir) => {
+  let baseDir = workingDir || process.cwd();
   // 500 is just an arbitrary number to prevent infinite loops
   for (let i = 0; i < 500; i++) {
     const dir = path.join(baseDir, 'node_modules', PLATFORM_PACKAGE);