Print debug messages

Author: kraenhansen

.github/workflows/test-installers.yml

@@ -124,6 +124,8 @@ jobs:
             test: time-to-first-query
 
     runs-on: ${{ matrix.runs-on }}
+    env:
+      DEBUG: compass:smoketests:*
     steps:
       - name: Checkout
         uses: actions/checkout@v2

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

@@ -19,6 +19,7 @@ export async function downloadFile({
   targetFilename,
   clearCache,
 }: DownloadFileOptions): Promise<string> {
+  debug('Fetching', { url });
   const response = await fetch(url);
 
   assert(
@@ -40,7 +41,7 @@ export async function downloadFile({
     if (clearCache) {
       fs.rmSync(cacheDirectoryPath, { recursive: true, force: true });
     } else {
-      debug('Skipped downloading', url, '(cache existed)');
+      debug('Skipped downloading (cache existed)', { url });
       return outputPath;
     }
   }
@@ -51,11 +52,11 @@ export async function downloadFile({
 
   // Write the response to file
   assert(response.body, 'Expected a response body');
-  debug('Downloading', url);
+  debug('Downloading', { url, outputPath });
   await stream.promises.pipeline(
     response.body,
     fs.createWriteStream(outputPath)
   );
-
+  debug('Download completed', { url, outputPath });
   return outputPath;
 }

packages/compass-smoke-tests/src/installers/linux-deb.ts

@@ -1,11 +1,14 @@
 import assert from 'node:assert/strict';
 import fs from 'node:fs';
 import path from 'node:path';
+import createDebug from 'debug';
 
 import type { InstalledAppInfo, InstallablePackage } from './types';
 import { execute } from '../execute';
 import * as apt from './apt';
 
+const debug = createDebug('compass:smoketests:linux-deb');
+
 export function installLinuxDeb({
   kind,
   filepath,
@@ -18,6 +21,7 @@ export function installLinuxDeb({
   const appPath = path.resolve(installPath, appName);
 
   function uninstall() {
+    debug('Uninstalling %s', filepath);
     execute('sudo', ['apt', 'remove', '--yes', '--purge', packageName]);
   }
 

packages/compass-smoke-tests/src/installers/linux-rpm.ts

@@ -2,9 +2,13 @@ import assert from 'node:assert/strict';
 import cp from 'node:child_process';
 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:smoketests:linux-rpm');
+
 /**
  * Call dnf to get the package name
  */
@@ -48,6 +52,7 @@ export function installLinuxRpm({
   const appPath = path.resolve(installPath, appName);
 
   function uninstall() {
+    debug('Uninstalling %s', filepath);
     execute('sudo', ['dnf', 'remove', '-y', packageName]);
   }
 

packages/compass-smoke-tests/src/installers/windows-msi.ts

@@ -21,6 +21,7 @@ export function installWindowsMSI({
   const appPath = path.resolve(installDirectory, `${appName}.exe`);
 
   function uninstall() {
+    debug('Uninstalling %s', filepath);
     execute('msiexec', ['/uninstall', filepath, '/passive']);
   }
 

packages/compass-smoke-tests/src/installers/windows-setup.ts

@@ -35,6 +35,7 @@ export function installWindowsSetup({
   }
 
   function uninstall({ expectMissing = false }: UninstallOptions = {}) {
+    debug('Uninstalling %s', filepath);
     const entry = queryRegistry();
     if (entry) {
       const {