rename analyticsConfigFilePath

Author: mcasimir

config/build.conf.js

@@ -11,22 +11,22 @@ const ROOT = path.join(__dirname, '..');
 /**
  * The mongosh package.
  */
-const MONGOSH = path.join(ROOT, 'packages', 'cli-repl');
+const CLI_REPL_DIR = path.join(ROOT, 'packages', 'cli-repl');
 
 /**
  * The project config.
  */
-const CONFIG = require(path.join(MONGOSH, 'package.json'));
+const CLI_REPL_PACKAGE_JSON = require(path.join(CLI_REPL_DIR, 'package.json'));
 
 /**
  * The input for the build.
  */
-const INPUT = path.join(MONGOSH, 'lib', 'run.js');
+const INPUT = path.join(CLI_REPL_DIR, 'lib', 'run.js');
 
 /**
  * The input for the exec.
  */
-const EXEC_INPUT = path.join(MONGOSH, 'dist', 'mongosh.js');
+const EXEC_INPUT = path.join(CLI_REPL_DIR, 'dist', 'mongosh.js');
 
 /**
  * The output dir for the build.
@@ -36,7 +36,7 @@ const OUTPUT_DIR = path.join(ROOT, 'dist');
 /**
  * Analytics configuration file.
  */
-const ANALYTICS_CONFIG = path.join(MONGOSH, 'lib', 'analytics-config.js');
+const ANALYTICS_CONFIG_FILE_PATH = path.join(CLI_REPL_DIR, 'lib', 'analytics-config.js');
 
 /**
  * The bundle id for MacOs.
@@ -56,12 +56,12 @@ const BUILD_VARIANT = (process.env.BUILD_VARIANT || '').split('_')[0];
  * Export the configuration for the build.
  */
 module.exports = {
-  version: CONFIG.version,
+  version: CLI_REPL_PACKAGE_JSON.version,
   rootDir: ROOT,
   input: INPUT,
   execInput: EXEC_INPUT,
   outputDir: OUTPUT_DIR,
-  analyticsConfig: ANALYTICS_CONFIG,
+  analyticsConfigFilePath: ANALYTICS_CONFIG_FILE_PATH,
   project: process.env.PROJECT,
   revision: REVISION,
   branch: process.env.BRANCH_NAME,

packages/build/README.md

@@ -51,7 +51,7 @@ const config = {
   input: 'input',
   execInput: 'execInput',
   outputDir: 'outputDir',
-  analyticsConfig: 'analyticsConfig',
+  analyticsConfigFilePath: 'analyticsConfigFilePath',
   project: 'project',
   revision: 'revision',
   branch: 'branch',
@@ -123,15 +123,15 @@ const config = {
   input: 'path/to/input',
   execInput: 'path/to/exec/input',
   outputDir: 'path/to/output/directory',
-  analyticsConfig: 'path/to/analytics/config',
+  analyticsConfigFilePath: 'path/to/analytics/config',
   segmentKey: 'SEGMENT_API_KEY_23481k',
 }
 await compileExec(
   config.input,
   config.execInput,
   config.outputDir,
   os.platform(),
-  config.analyticsConfig,
+  config.analyticsConfigFilePath,
   config.segmentKey
 );
 ```

packages/build/src/analytics.ts

@@ -22,14 +22,25 @@ const createAnalyticsConfig = (segmentKey: string): string => {
 /**
  * Write the analytics config.
  *
- * @param {string} file - The filename.
+ * @param {string} analyticsConfigFilePath - The filename.
  * @param {string} segmentKey - The segment key.
  */
-const writeAnalyticsConfig = (file: string, segmentKey: string): Promise<void> => {
+const writeAnalyticsConfig = (
+  analyticsConfigFilePath?: string,
+  segmentKey?: string
+): Promise<void> => {
+  if (!analyticsConfigFilePath) {
+    throw new Error('Analytics config file path is required');
+  }
+
+  if (!segmentKey) {
+    throw new Error('Segment key is required');
+  }
+
   const template = createAnalyticsConfig(segmentKey);
-  console.info('mongosh: writing analytics template:', file);
+  console.info('mongosh: writing analytics template:', analyticsConfigFilePath);
   // Cannot use fs/promises on Cygwin.
-  return util.promisify(fs.writeFile)(file, template);
+  return util.promisify(fs.writeFile)(analyticsConfigFilePath, template);
 };
 
 export default writeAnalyticsConfig;

packages/build/src/barque.spec.ts

@@ -19,7 +19,7 @@ describe('Barque', () => {
       input: 'input',
       execInput: 'execInput',
       outputDir: 'outputDir',
-      analyticsConfig: 'analyticsConfig',
+      analyticsConfigFilePath: 'analyticsConfigFilePath',
       project: 'project',
       revision: 'revision',
       branch: 'branch',

packages/build/src/compile-exec.ts

@@ -52,12 +52,12 @@ const compileExec = async(
   execInput: string,
   outputDir: string,
   execNodeVersion: string,
-  analyticsConfig: string,
+  analyticsConfigFilePath: string,
   segmentKey: string): Promise<string> => {
   // We use Parcel to bundle up everything into a single JS under
   // cli-repl/dist/mongosh.js that the executable generator can use as input.
   // This JS also takes care of the analytics config file being written.
-  await generateInput(input, execInput, analyticsConfig, segmentKey);
+  await generateInput(input, execInput, analyticsConfigFilePath, segmentKey);
 
   const executable = executablePath(outputDir, os.platform());
   console.info('mongosh: creating binary:', executable);

packages/build/src/config.ts

@@ -7,7 +7,7 @@ export default interface Config {
   input: string;
   execInput: string;
   outputDir: string;
-  analyticsConfig?: string;
+  analyticsConfigFilePath?: string;
   rootDir: string;
   project?: string;
   revision?: string;

packages/build/src/do-upload.spec.ts

@@ -32,7 +32,7 @@ describe('buildAndRelease', () => {
       input: 'input',
       execInput: 'execInput',
       outputDir: 'outputDir',
-      analyticsConfig: 'analyticsConfig',
+      analyticsConfigFilePath: 'analyticsConfigFilePath',
       project: 'project',
       revision: 'revision',
       branch: 'branch',

packages/build/src/generate-input.ts

@@ -8,13 +8,13 @@ import writeAnalyticsConfig from './analytics';
  *
  * @param {string} input - The input file to the cli.
  * @param {string} execInput - The input file that the exec will compile from.
- * @param {string} analyticsConfig - The path to the analytics config file.
+ * @param {string} analyticsConfigFilePath - The path to the analytics config file.
  * @param {string} segmentKey - The segment API key.
  */
-async function generateInput(input: string, execInput: string, analyticsConfig: string, segmentKey: string): Promise<void> {
+async function generateInput(input: string, execInput: string, analyticsConfigFilePath: string, segmentKey: string): Promise<void> {
   // This takes the segment api key and writes it to the
   // cli-repl's analytics-config file.
-  await writeAnalyticsConfig(analyticsConfig, segmentKey);
+  await writeAnalyticsConfig(analyticsConfigFilePath, segmentKey);
 
   console.info('mongosh: creating bundle:', execInput);