feat: add debug support (#94)

Author: malept

package.json

@@ -21,13 +21,15 @@
     "node": ">=8.6"
   },
   "dependencies": {
+    "debug": "^4.1.1",
     "env-paths": "^2.2.0",
     "fs-extra": "^7.0.1",
     "got": "^9.6.0",
     "sumchecker": "^3.0.0"
   },
   "devDependencies": {
     "@continuous-auth/semantic-release-npm": "^1.0.3",
+    "@types/debug": "^4.1.4",
     "@types/fs-extra": "^7.0.0",
     "@types/got": "^9.4.4",
     "@types/jest": "^24.0.13",

src/Cache.ts

@@ -1,7 +1,10 @@
+import debug from 'debug';
 import envPaths from 'env-paths';
 import * as fs from 'fs-extra';
 import * as path from 'path';
 
+const d = debug('@electron/get:cache');
+
 const defaultCacheRoot = envPaths('electron', {
   suffix: '',
 }).cache;
@@ -24,7 +27,9 @@ export class Cache {
 
   public async putFileInCache(currentPath: string, fileName: string): Promise<string> {
     const cachePath = this.getCachePath(fileName);
+    d(`Moving ${currentPath} to ${cachePath}`);
     if (await fs.pathExists(cachePath)) {
+      d('* Replacing existing file');
       await fs.remove(cachePath);
     }
 

src/index.ts

@@ -1,3 +1,4 @@
+import debug from 'debug';
 import * as path from 'path';
 
 import { getArtifactFileName, getArtifactRemoteURL, FileNameUse } from './artifact-utils';
@@ -8,6 +9,7 @@ import { withTempDirectory, normalizeVersion, getHostArch, ensureIsTruthyString
 
 export { getHostArch } from './utils';
 
+const d = debug('@electron/get:index');
 const sumchecker: typeof import('sumchecker').default = require('sumchecker');
 
 /**
@@ -47,9 +49,13 @@ export async function downloadArtifact(_artifactDetails: ElectronArtifactDetails
 
   // Do not check if the file exists in the cache when force === true
   if (!artifactDetails.force) {
+    d(`Checking the cache for ${fileName}`);
     const cachedPath = await cache.getPathForFileInCache(fileName);
 
-    if (cachedPath !== null) {
+    if (cachedPath === null) {
+      d('Cache miss');
+    } else {
+      d('Cache hit');
       return cachedPath;
     }
   }
@@ -61,11 +67,13 @@ export async function downloadArtifact(_artifactDetails: ElectronArtifactDetails
     );
 
     const downloader = artifactDetails.downloader || (await getDownloaderForSystem());
-    await downloader.download(
-      getArtifactRemoteURL(artifactDetails),
-      tempDownloadPath,
-      artifactDetails.downloadOptions,
+    const url = getArtifactRemoteURL(artifactDetails);
+    d(
+      `Downloading ${url} to ${tempDownloadPath} with options: ${JSON.stringify(
+        artifactDetails.downloadOptions,
+      )}`,
     );
+    await downloader.download(url, tempDownloadPath, artifactDetails.downloadOptions);
 
     // Don't try to verify the hash of the hash file itself
     if (

yarn.lock

@@ -504,6 +504,11 @@
   dependencies:
     "@babel/types" "^7.3.0"
 
+"@types/debug@^4.1.4":
+  version "4.1.4"
+  resolved "https://registry.yarnpkg.com/@types/debug/-/debug-4.1.4.tgz#56eec47706f0fd0b7c694eae2f3172e6b0b769da"
+  integrity sha512-D9MyoQFI7iP5VdpEyPZyjjqIJ8Y8EDNQFIFVLOmeg1rI1xiHOChyUPMPRUVfqFCerxfE+yS3vMyj37F6IdtOoQ==
+
 "@types/events@*":
   version "3.0.0"
   resolved "https://registry.yarnpkg.com/@types/events/-/events-3.0.0.tgz#2862f3f58a9a7f7c3e78d79f130dd4d71c25c2a7"