@slack/bolt 4.0.0-nextGen.9 → 4.0.0-rc.2

package/src/cli/hook-utils/get-check-update-data.js

@@ -1,292 +0,0 @@
-const fs = require('fs');
-const path = require('path');
-const util = require('util');
-const exec = util.promisify(require('child_process').exec);
-
-const SLACK_BOLT_SDK = '@slack/bolt';
-let checkUpdateExports = {};
-
-/**
- * Wraps and parses the output of the exec() function
- * @param command the command being run by the exec() function
- */
-async function execWrapper (command) {
-  const { stdout } = await exec(command);
-  return stdout.trim();
-}
-
-/**
- * Checks for available SDK updates for specified dependencies, creates a version map,
- * and then wraps everything up into a response to be passed to the CLI.
- * @param cwd the current working directory
- */
-async function checkForSDKUpdates(cwd) {
-  const { versionMap, inaccessibleFiles } = await createVersionMap(cwd);
-  const updateResp = createUpdateResp(versionMap, inaccessibleFiles);
-  return updateResp;
-}
-
-/**
- * Create a version map that contains each (Slack) dependency, detailing info about
- * current and latest versions, as well as if breaking changes are present or if there
- * were any errors with getting version retrieval.
- * @param cwd the current working directory of the CLI project
- */
-async function createVersionMap(cwd) {
-  const { versionMap, inaccessibleFiles } = await readProjectDependencies(cwd);
-
-  if (versionMap && versionMap[SLACK_BOLT_SDK]) {
-    const current = versionMap[SLACK_BOLT_SDK].current || '';
-    let latest = '',
-      error = null;
-
-    try {
-      latest = await fetchLatestModuleVersion(SLACK_BOLT_SDK);
-    } catch (err) {
-      error = err;
-    }
-    const update = !!current && !!latest && current !== latest;
-    const breaking = hasBreakingChange(current, latest);
-
-    versionMap[SLACK_BOLT_SDK] = {
-      ...versionMap[SLACK_BOLT_SDK],
-      latest,
-      update,
-      breaking,
-      error,
-    };
-  }
-
-  return { versionMap, inaccessibleFiles };
-}
-
-/**
- * Reads project dependencies - cycles through project dependency files, extracts
- * the listed dependencies, and adds it in to the version map with version info.
- * @param cwd the current working directory of the CLI project
- */
-async function readProjectDependencies(cwd) {
-  const versionMap = {};
-  const { dependencyFile, inaccessibleFiles } = await gatherDependencyFiles(
-    cwd
-  );
-
-  try {
-    const [sdk, value] =
-      await checkUpdateExports.extractDependencies(dependencyFile.body, dependencyFile.name);
-
-    if (sdk !== '' && sdk === SLACK_BOLT_SDK) {
-      versionMap[SLACK_BOLT_SDK] = {
-        name: sdk,
-        current: value.version,
-      };
-    }
-  } catch (err) {
-    inaccessibleFiles.push({ name: dependencyFile.name, error: err });
-  }
-
-  return { versionMap, inaccessibleFiles };
-}
-
-/**
- * Reads and parses JSON file - if it works, returns the file contents.
- * If not, returns an empty object
- * @param filePath the path of the file being read
- */
-async function getJSON(filePath) {
-  let fileContents = {};
-  try {
-    if (fs.existsSync(filePath)) {
-      fileContents = JSON.parse(fs.readFileSync(filePath, 'utf8'));
-    } else {
-      throw new Error('Cannot find a file at path ' + filePath);
-    }
-  } catch (err) {
-    throw new Error(err);
-  }
-  return fileContents;
-}
-
-/**
- * Gathers all related dependency files for the CLI project (package.json).
- * @param cwd the current working directory of the CLI project
- */
-async function gatherDependencyFiles(cwd) {
-  const { jsonDepFile, inaccessibleFiles } = await getJSONFiles(cwd);
-  const dependencyFile = jsonDepFile;
-  return { dependencyFile, inaccessibleFiles };
-}
-
-/**
- * Gets the needed files that contain dependency info (package.json).
- * @param cwd the current working directory of the CLI project
- */
-async function getJSONFiles(cwd) {
-  const packageJSON = 'package.json';
-  const jsonDepFile = {};
-  const inaccessibleFiles = [];
-
-  try {
-    const jsonFile = await getJSON(`${cwd}/${packageJSON}`);
-    const jsonIsParsable =
-      jsonFile &&
-      typeof jsonFile === 'object' &&
-      !Array.isArray(jsonFile) &&
-      jsonFile.dependencies;
-
-    if (jsonIsParsable) {
-      jsonDepFile.name = packageJSON;
-      jsonDepFile.body= jsonFile;
-    }
-  } catch (err) {
-    inaccessibleFiles.push({ name: packageJSON, error: err });
-  }
-
-  return { jsonDepFile, inaccessibleFiles };
-}
-
-/**
- * Pulls dependencies from a given file and JSON structure.
- * @param json JSON information that includes dependencies
- * @param fileName name of the file that the dependency list is coming from
- */
-checkUpdateExports.extractDependencies = async (json, fileName) => {
-  // Determine if the JSON passed is an object
-  const jsonIsParsable =
-    json !== null && typeof json === 'object' && !Array.isArray(json);
-
-  if (jsonIsParsable) {
-    let boltCurrentVersion = '';
-    if (json['dependencies']['@slack/bolt']) {
-      const boltCurrentVersionOutput = JSON.parse(
-        await checkUpdateExports.getBoltCurrentVersion()
-      );
-
-      if (boltCurrentVersionOutput !== '') {
-        boltCurrentVersion =
-          boltCurrentVersionOutput['dependencies']['@slack/bolt']['version'];
-      }
-    }
-
-    return [
-      '@slack/bolt',
-      {
-        version: boltCurrentVersion,
-      },
-    ];
-  }
-
-  return [];
-};
-
-/**
- * Gets the latest module version.
- * @param moduleName the module that the latest version is being queried for
- */
-async function fetchLatestModuleVersion(moduleName) {
-  let command = '';
-  if (moduleName === '@slack/bolt') {
-    command = `npm info ${moduleName} version --tag next-gen`;
-  } else if (moduleName === '@slack/deno-slack-sdk') {
-    command = `npm info ${moduleName} version --tag latest`;
-  }
-  const stdout = await execWrapper(command);
-
-  return stdout;
-}
-
-/**
- * Checks if a dependency's upgrade from a current to the latest version will cause a
- * breaking change.
- * @param current current dependency version in project
- * @param latest most up-to-date dependency version available on NPM
- */
-function hasBreakingChange(current, latest) {
-  return current !== latest;
-}
-
-/**
- * Creates the update response - returns an object in the expected response format.
- * @param versionMap version map of checked dependencies, current versions, and info on upgrade + breaking changes
- * @param inaccessibleFiles array of files that could not be read or accessed
- */
-function createUpdateResp(versionMap, inaccessibleFiles) {
-  const name = 'the Slack SDK';
-  const releases = [];
-  const url = 'https://api.slack.com/future/changelog';
-  const fileErrorMsg = createFileErrorMsg(inaccessibleFiles);
-
-  let error = null;
-  let errorMsg = '';
-  let message = '';
-
-
-  // Output information for each dependency
-  for (const sdk of Object.values(versionMap)) {
-    // Dependency has an update OR the fetch of update failed
-    if (sdk) {
-      releases.push(sdk);
-
-      // Add the dependency that failed to be fetched to the top-level error message
-      if (sdk.error && sdk.error.message) {
-        errorMsg += errorMsg
-          ? `, ${sdk}`
-          : `An error occurred fetching updates for the following packages: ${sdk.name}`;
-      }
-    }
-  }
-
-  // Surface release notes for breaking changes
-  if (releases && releases[0] && releases[0].breaking) {
-    message = `Learn more about the breaking change at https://github.com/slackapi/bolt-js/releases/tag/@slack/bolt@${releases[0].latest}`
-  }
-
-  // If there were issues accessing dependency files, append error message(s)
-  if (inaccessibleFiles.length) {
-    errorMsg += errorMsg ? `\n\n   ${fileErrorMsg}` : fileErrorMsg;
-  }
-
-  if (errorMsg) {
-    error = { message: errorMsg };
-  }
-
-  return {
-    name,
-    message,
-    releases,
-    url,
-    error,
-  };
-}
-
-/**
- * Returns error when dependency files cannot be read.
- * @param inaccessibleFiles array of files that could not be read or accessed
- */
-function createFileErrorMsg(inaccessibleFiles) {
-  let fileErrorMsg = '';
-
-  // There were issues with reading some of the files that were found
-  for (const file of inaccessibleFiles) {
-    fileErrorMsg += fileErrorMsg
-      ? `\n   ${file.name}: ${file.error.message}`
-      : `An error occurred while reading the following files: \n\n   ${file.name}: ${file.error.message}`;
-  }
-
-  return fileErrorMsg;
-}
-
-/**
- * Queries for current Bolt version of the project.
- */
-checkUpdateExports.getBoltCurrentVersion = async () => {
-  const stdout = await execWrapper('npm list @slack/bolt --depth=0 --json');
-  return stdout;
-};
-
-module.exports = {
-  checkForSDKUpdates,
-  getJSON,
-  getJSONFiles,
-  checkUpdateExports,
-};

package/src/cli/hook-utils/get-manifest-data.js

@@ -1,39 +0,0 @@
-const { 
-  readManifestJSONFile,
-  readImportedManifestFile,
-  hasManifest,
-  unionMerge,
-} = require('./manifest.js');
-const merge = require('deepmerge');
-
-
-/** 
- * Returns any manifest data, if it exists.
- * Otherwise throws an error
- * @param searchDir path to begin searching at
- */
- function getManifestData(searchDir) {
-  const file = 'manifest';
-  let manifest = {};
-  
-  // look for a manifest JSON
-  const manifestJSON = readManifestJSONFile(searchDir, `${file}.json`);
-  // look for manifest.js
-  let manifestJS = readImportedManifestFile(searchDir, `${file}.js`);
-  
-  if (!hasManifest(manifestJS, manifestJSON)) {
-    const msg = 'Unable to find a manifest file in this project';
-    throw new Error(msg);
-  }
-
-  // manage manifest merge
-  if (manifestJSON) {
-    manifest = merge(manifest, manifestJSON, { arrayMerge: unionMerge });
-  }  
-  if (manifestJS) {
-    manifest = merge(manifest, manifestJS, { arrayMerge: unionMerge });
-  }
-  return manifest;
-} 
-
-module.exports = { getManifestData };

package/src/cli/hook-utils/manifest.js

@@ -1,108 +0,0 @@
-const fs = require('fs');
-const path = require('path');
-
-/** 
- * Union merge of arrays
- */
-function unionMerge(array1, array2) {
-  return [...new Set(array1.concat(array2))];
-}
-
-/** 
- * Returns a manifest.json if it exists, null otherwise
- * @param searchDir typically current working directory
- * @param filename file to search for
- */
-function readManifestJSONFile(searchDir, filename) {
-  let jsonFilePath, manifestJSON;
-  try {
-    jsonFilePath = find(searchDir, filename);
-    if (fs.existsSync(jsonFilePath)) {
-      manifestJSON = JSON.parse(fs.readFileSync(jsonFilePath, 'utf8'));
-    }
-  } catch (error) {
-    return null;
-  }
-  return manifestJSON;
-}
-
-/** 
- * Returns a manifest object if it exists, null otherwise
- * @param searchDir typically current working directory
- * @param filename file to search for
- */
-function readImportedManifestFile(searchDir, filename) {
-  let importedManifestFilePath, manifestImported;
-
-  try {
-    importedManifestFilePath = find(searchDir, filename);
-    if (fs.existsSync(importedManifestFilePath)) {
-      manifestImported = require(`${importedManifestFilePath}`);
-      
-      // if a default key is provided, assumes default export contains manifest
-      if (manifestImported["default"]) {
-        manifestImported = manifestImported["default"]
-      }
-      // stringify and parses the JSON in order to ensure that objects with .toJSON() functions
-      // resolve properly. This is a known behavior for CustomType
-      manifestImported = JSON.parse(JSON.stringify(manifestImported));
-    }
-  } catch (error) {
-    console.log(error);
-    return null;
-  }
-  return manifestImported;
-}
-
-/** 
- * @param entries 
- * @returns true if any non-empty manifest has been supplied 
- * */
-function hasManifest(...entries) {
-  for (let ent of entries) {
-    if (ent && (Object.keys(ent).length > 0)) {
-      return true;
-    }
-  }
-  return false;
-}
-
-/** 
- * Search for provided file path. 
- * Returns full path when filename is found or null if no file found. 
- * @param currentPath string of current path
- * @param targetFilename filename to match
- * @returns full file path string relative to starting path or null
- * */
-function find(currentPath, targetFilename) {
-  //  TODO Cache searched paths and check that they haven't been explored already
-  //  This guards against rare edge case of a subdir in the file tree which is 
-  //  symlinked back to root or in such a way that creates a cycle. Can also implement
-  //  max depth check. 
-  if (currentPath.endsWith(`/${targetFilename}`)) {
-    return currentPath;
-  }
-
-  if (fs.existsSync(currentPath) && fs.lstatSync(currentPath).isDirectory()) {
-    let foundEntry;
-    let dirents = fs.readdirSync(currentPath);
-    for (let entry of dirents) {
-      if (entry !== 'node_modules') {
-        let newPath = path.resolve(currentPath, entry);
-        foundEntry = find(newPath, targetFilename);
-        if (foundEntry) {
-          return foundEntry;
-        }
-      }
-    }
-    return null;
-  }
-}
-
-module.exports = {
-  unionMerge,
-  readManifestJSONFile,
-  readImportedManifestFile,
-  hasManifest,
-  find,
-}

package/src/cli/start.js

@@ -1,43 +0,0 @@
-#!/usr/bin/env node
-const { spawn } = require('child_process');
-const path = require('path');
-const fs = require('fs');
-const { main: pkgJSONMain } = JSON.parse(fs.readFileSync('./package.json', 'utf-8'));
-
-// Run script hook verifies that requirements for running an App in
-// in developerMode (via Socket Mode) are met
-(function _(cwd, customPath) {
-  // TODO - Format so that its less miss-able in output
-  console.log('Preparing local run in developer mode (Socket Mode)');
-  // Check required local run tokens
-  validate();
-
-  // tries the provided path, then package.json main, then defaults to index.js in the current 
-  // working directory
-  const pkgJSONDefault = 'index.js';
-  const fullPath = path.resolve(cwd, customPath ? customPath : pkgJSONMain ? pkgJSONMain : pkgJSONDefault);
-  console.log(fullPath);
-
-  // Kick off a subprocess to run the app in development mode
-  const app = spawn('node', [`${fullPath}`]);
-  app.stdout.setEncoding('utf-8');
-  app.stdout.on('data', (data) => {
-    process.stdout.write(data);
-  });
-  app.stderr.on('data', (data) => {
-    process.stderr.write(data);
-  });
-
-  app.on('close', (code) => {
-    console.log(`bolt-app local run exited with code ${code}`);
-  });
-}(process.cwd(), process.env.SLACK_CLI_CUSTOM_FILE_PATH));
-
-function validate() {
-  if (!process.env.SLACK_CLI_XOXB) {
-    throw new Error('Missing local run bot token. Please see slack-cli maintainers to troubleshoot.');
-  }
-  if (!process.env.SLACK_CLI_XAPP) {
-    throw new Error('Missing local run app token. Please see slack-cli maintainers to troubleshoot');
-  }
-}