use debug, not console.log

Author: lerouxb

packages/compass-smoke-tests/package.json

@@ -34,6 +34,7 @@
     "@mongodb-js/eslint-config-compass": "^1.2.2",
     "@mongodb-js/prettier-config-compass": "^1.1.2",
     "@mongodb-js/tsconfig-compass": "^1.1.2",
+    "debug": "^4.3.4",
     "depcheck": "^1.4.1",
     "eslint": "^7.25.0",
     "hadron-build": "^25.6.2",

packages/compass-smoke-tests/src/build-info.ts

@@ -2,12 +2,15 @@ import assert from 'node:assert/strict';
 import fs from 'node:fs';
 import path from 'node:path';
 
+import createDebug from 'debug';
 import { handler as writeBuildInfo } from 'hadron-build/commands/info';
 
 import { type PackageKind } from './packages';
 import { type SmokeTestsContext } from './context';
 import { pick } from 'lodash';
 
+const debug = createDebug('compass-smoke-tests:build-info');
+
 const SUPPORTED_CHANNELS = ['dev', 'beta', 'stable'] as const;
 type Channel = typeof SUPPORTED_CHANNELS[number];
 
@@ -242,11 +245,11 @@ export function writeAndReadPackageDetails(
     arch: context.arch,
     out: path.resolve(context.sandboxPath, 'target.json'),
   };
-  console.log({ infoArgs });
+  debug({ infoArgs });
 
   // These are known environment variables that will affect the way
   // writeBuildInfo works. Log them as a reminder and for our own sanity
-  console.log(
+  debug(
     'info env vars',
     pick(process.env, [
       'HADRON_DISTRIBUTION',

packages/compass-smoke-tests/src/cli.ts

@@ -6,6 +6,7 @@ import path from 'node:path';
 import yargs from 'yargs';
 import { hideBin } from 'yargs/helpers';
 import { pick } from 'lodash';
+import createDebug from 'debug';
 import { execute } from './execute';
 import {
   type PackageDetails,
@@ -22,6 +23,8 @@ import { installMacDMG } from './installers/mac-dmg';
 import { installMacZIP } from './installers/mac-zip';
 import { installWindowsZIP } from './installers/windows-zip';
 
+const debug = createDebug('compass-smoke-tests');
+
 const SUPPORTED_PLATFORMS = ['win32', 'darwin', 'linux'] as const;
 const SUPPORTED_ARCHS = ['x64', 'arm64'] as const;
 
@@ -166,9 +169,9 @@ async function run() {
     sandboxPath: createSandbox(),
   };
 
-  console.log(`Running tests in ${context.sandboxPath}`);
+  debug(`Running tests in ${context.sandboxPath}`);
 
-  console.log(
+  debug(
     'context',
     pick(context, [
       'forceDownload',
@@ -196,11 +199,11 @@ async function run() {
       await uninstall();
     }
   } finally {
-    console.log('Cleaning up sandbox');
+    debug('Cleaning up sandbox');
     fs.rmSync(context.sandboxPath, { recursive: true });
   }
 
-  console.log('update from latest release to this package');
+  debug('update from latest release to this package');
   const releasepath = await getLatestRelease(
     buildInfo.channel,
     context.arch,
@@ -223,7 +226,7 @@ async function run() {
       await uninstall();
     }
   } finally {
-    console.log('Cleaning up sandbox');
+    debug('Cleaning up sandbox');
     fs.rmSync(context.sandboxPath, { recursive: true });
   }
 }
@@ -259,7 +262,7 @@ function runTest({ appName, appPath }: RunTestOptions) {
 
 run()
   .then(function () {
-    console.log('done');
+    debug('done');
   })
   .catch(function (err) {
     console.error(err.stack);

packages/compass-smoke-tests/src/downloads.ts

@@ -3,8 +3,12 @@ import fs from 'node:fs';
 import path from 'node:path';
 import stream from 'node:stream';
 
+import createDebug from 'debug';
+
 import { ensureDownloadsDirectory } from './directories';
 
+const debug = createDebug('compass-smoke-tests:downloads');
+
 type DownloadFileOptions = {
   url: string;
   targetFilename: string;
@@ -33,7 +37,7 @@ export async function downloadFile({
     if (clearCache) {
       fs.rmSync(cacheDirectoryPath, { recursive: true, force: true });
     } else {
-      console.log('Skipped downloading', url, '(cache existed)');
+      debug(`Skipped downloading ${url} (cache existed)`);
       return outputPath;
     }
   }
@@ -44,13 +48,11 @@ export async function downloadFile({
 
   // Write the response to file
   assert(response.body, 'Expected a response body');
-  console.log('Downloading', url);
+  debug(`Downloading ${url} to ${outputPath}`);
   await stream.promises.pipeline(
     response.body,
     fs.createWriteStream(outputPath)
   );
 
-  console.log(outputPath);
-
   return outputPath;
 }

packages/compass-smoke-tests/src/installers/mac-dmg.ts

@@ -1,9 +1,13 @@
 import path from 'node:path';
 import fs from 'node:fs';
 
+import createDebug from 'debug';
+
 import type { InstalledAppInfo, InstallablePackage } from './types';
 import { execute } from '../execute';
 
+const debug = createDebug('compass-smoke-tests:installers:mac-dmg');
+
 export function installMacDMG({
   appName,
   filepath,
@@ -35,7 +39,7 @@ export function installMacDMG({
     );
 
     if (fs.existsSync(settingsDir)) {
-      console.log(`${settingsDir} already exists. Removing.`);
+      debug(`${settingsDir} already exists. Removing.`);
       fs.rmSync(settingsDir, { recursive: true });
     }
   }

packages/compass-smoke-tests/src/installers/mac-zip.ts

@@ -1,9 +1,13 @@
 import path from 'node:path';
 import fs from 'node:fs';
 
+import createDebug from 'debug';
+
 import type { InstalledAppInfo, InstallablePackage } from './types';
 import { execute } from '../execute';
 
+const debug = createDebug('compass-smoke-tests:installers:mac-zip');
+
 export function installMacZIP({
   appName,
   filepath,
@@ -25,7 +29,7 @@ export function installMacZIP({
     );
 
     if (fs.existsSync(settingsDir)) {
-      console.log(`${settingsDir} already exists. Removing.`);
+      debug(`${settingsDir} already exists. Removing.`);
       fs.rmSync(settingsDir, { recursive: true });
     }
   }