feat: expose logs of detached instances via ganache instances logs command

src/chains/ethereum/ethereum/src/blockchain.ts

@@ -37,7 +37,8 @@ import {
   BUFFER_32_ZERO,
   BUFFER_256_ZERO,
   KNOWN_CHAINIDS,
-  keccak
+  keccak,
+  Logger
 } from "@ganache/utils";
 import AccountManager from "./data-managers/account-manager";
 import BlockManager from "./data-managers/block-manager";
@@ -105,10 +106,6 @@ type BlockchainTypedEvents = {
   stop: undefined;
 };
 
-interface Logger {
-  log(message?: any, ...optionalParams: any[]): void;
-}
-
 export type BlockchainOptions = {
   db?: string | object;
   db_path?: string;

src/chains/ethereum/ethereum/src/provider.ts

@@ -35,7 +35,7 @@ import {
   MessageEvent,
   VmConsoleLogEvent
 } from "./provider-events";
-
+import { closeSync } from "fs";
 declare type RequestMethods = KnownKeys<EthereumApi>;
 
 function parseCoinbase(
@@ -432,6 +432,12 @@ export class EthereumProvider
     this.#executor.stop();
     await this.#blockchain.stop();
 
+    // only need to do this if it's an `AsyncronousLogger`
+    if ("getCompletionHandle" in this.#options.logging.logger) {
+      await this.#options.logging.logger.getCompletionHandle();
+      closeSync(this.#options.logging.file);
+    }
+
     this.#executor.end();
     this.emit("disconnect");
   };

src/chains/ethereum/ethereum/tests/api/eth/instamine.test.ts

@@ -1,6 +1,6 @@
 import getProvider from "../../helpers/getProvider";
 import assert from "assert";
-import { Logger } from "@ganache/ethereum-options/typings/src/logging-options";
+import { Logger } from "@ganache/utils";
 
 describe("api", () => {
   describe("eth", () => {

src/chains/ethereum/ethereum/tests/provider.test.ts

@@ -8,6 +8,8 @@ import EthereumApi from "../src/api";
 import getProvider from "./helpers/getProvider";
 import compile from "./helpers/compile";
 import Web3 from "web3";
+import { promises, closeSync } from "fs";
+const { stat, unlink } = promises;
 
 describe("provider", () => {
   describe("options", () => {
@@ -644,6 +646,34 @@ describe("provider", () => {
       });
     });
 
+    it("closes the logging fileDescriptor", async () => {
+      const filePath = "./closes-logging-descriptor.log";
+      const provider = await getProvider({ logging: { file: filePath } });
+
+      try {
+        const descriptor = (await provider).getOptions().logging.file;
+        assert.strictEqual(
+          typeof descriptor,
+          "number",
+          `File descriptor has unexepected value ${typeof descriptor}`
+        );
+
+        assert(
+          (await stat(filePath)).isFile(),
+          `log file: ${filePath} was not created`
+        );
+
+        await provider.disconnect();
+
+        assert.throws(
+          () => closeSync(descriptor),
+          "File descriptor is still valid after disconnect() called"
+        );
+      } finally {
+        await unlink(filePath);
+      }
+    });
+
     // todo: Reinstate this test when https://github.com/trufflesuite/ganache/issues/3499 is fixed
     describe.skip("without asyncRequestProcessing", () => {
       // we only test this with asyncRequestProcessing: false, because it's impossible to force requests

src/chains/ethereum/options/src/index.ts

@@ -7,14 +7,12 @@ import { ForkConfig, ForkOptions } from "./fork-options";
 import {
   Base,
   Defaults,
-  Definitions,
   ExternalConfig,
   InternalConfig,
   Legacy,
   LegacyOptions,
   OptionName,
   OptionRawType,
-  Options,
   OptionsConfig
 } from "@ganache/options";
 import { UnionToIntersection } from "./helper-types";
@@ -45,11 +43,9 @@ export type EthereumLegacyProviderOptions = Partial<
     MakeLegacyOptions<ForkConfig>
 >;
 
-export type EthereumProviderOptions = Partial<
-  {
-    [K in keyof EthereumConfig]: ExternalConfig<EthereumConfig[K]>;
-  }
->;
+export type EthereumProviderOptions = Partial<{
+  [K in keyof EthereumConfig]: ExternalConfig<EthereumConfig[K]>;
+}>;
 
 export type EthereumInternalOptions = {
   [K in keyof EthereumConfig]: InternalConfig<EthereumConfig[K]>;

src/chains/ethereum/options/src/logging-options.ts

@@ -1,9 +1,7 @@
 import { normalize } from "./helpers";
 import { Definitions } from "@ganache/options";
-
-export type Logger = {
-  log(message?: any, ...optionalParams: any[]): void;
-};
+import { openSync, PathLike } from "fs";
+import { Logger, createLogger } from "@ganache/utils";
 
 export type LoggingConfig = {
   options: {
@@ -74,6 +72,15 @@ export type LoggingConfig = {
       type: boolean;
       hasDefault: true;
     };
+
+    /**
+     * If you set this option, Ganache will write logs to a file located at the
+     * specified path.
+     */
+    readonly file: {
+      type: number;
+      rawType: PathLike;
+    };
   };
 };
 
@@ -92,23 +99,48 @@ export const LoggingOptions: Definitions<LoggingConfig> = {
     cliAliases: ["q", "quiet"],
     cliType: "boolean"
   },
-  logger: {
-    normalize,
-    cliDescription:
-      "An object, like `console`, that implements a `log` function.",
-    disableInCLI: true,
-    // disable the default logger if `quiet` is `true`
-    default: config => ({
-      log: config.quiet ? () => {} : console.log
-    }),
-    legacyName: "logger"
-  },
   verbose: {
     normalize,
     cliDescription: "Set to `true` to log detailed RPC requests.",
     default: () => false,
     legacyName: "verbose",
     cliAliases: ["v", "verbose"],
     cliType: "boolean"
+  },
+  file: {
+    normalize: (raw: PathLike): number => {
+      let descriptor: number;
+
+      try {
+        descriptor = openSync(raw, "a");
+      } catch (err) {
+        throw new Error(
+          `Failed to open log file ${raw}. Please check if the file path is valid and if the process has write permissions to the directory.`
+        );
+      }
+      return descriptor;
+    },
+    cliDescription:
+      "If set, Ganache will write logs to a file located at the specified path.",
+    cliType: "string"
+  },
+  logger: {
+    normalize: (logger: Logger, config: Readonly<{ file: number }>) => {
+      return createLogger({
+        file: config.file,
+        baseLogger: logger
+      });
+    },
+    cliDescription:
+      "An object, like `console`, that implements a `log` function.",
+    disableInCLI: true,
+    default: config => {
+      const baseLogger = config.quiet ? { log: () => {} } : console;
+      return createLogger({
+        file: config.file,
+        baseLogger
+      });
+    },
+    legacyName: "logger"
   }
 };

src/chains/ethereum/options/src/miner-options.ts

@@ -220,7 +220,7 @@ const toNumberOrString = (str: string) => {
     return parseInt(str);
   }
 };
-
+const normalizeQuantity = value => Quantity.from(value);
 export const MinerOptions: Definitions<MinerConfig> = {
   blockTime: {
     normalize: rawInput => {
@@ -246,7 +246,7 @@ export const MinerOptions: Definitions<MinerConfig> = {
     cliType: "string"
   },
   defaultGasPrice: {
-    normalize: Quantity.from,
+    normalize: normalizeQuantity,
     cliDescription:
       "Sets the default gas price in WEI for transactions if not otherwise specified.",
     default: () => Quantity.from(2_000_000_000),
@@ -256,7 +256,7 @@ export const MinerOptions: Definitions<MinerConfig> = {
     cliCoerce: toBigIntOrString
   },
   blockGasLimit: {
-    normalize: Quantity.from,
+    normalize: normalizeQuantity,
     cliDescription: "Sets the block gas limit in WEI.",
     default: () => Quantity.from(30_000_000),
     legacyName: "gasLimit",
@@ -274,15 +274,15 @@ export const MinerOptions: Definitions<MinerConfig> = {
     cliCoerce: estimateOrToBigIntOrString
   },
   difficulty: {
-    normalize: Quantity.from,
+    normalize: normalizeQuantity,
     cliDescription:
       "Sets the block difficulty. Value is always 0 after the merge hardfork.",
     default: () => Quantity.One,
     cliType: "string",
     cliCoerce: toBigIntOrString
   },
   callGasLimit: {
-    normalize: Quantity.from,
+    normalize: normalizeQuantity,
     cliDescription:
       "Sets the transaction gas limit in WEI for `eth_call` and `eth_estimateGas` calls.",
     default: () => Quantity.from(50_000_000),

src/chains/ethereum/options/tests/index.test.ts

@@ -1,32 +1,7 @@
 import assert from "assert";
 import { EthereumDefaults, EthereumOptionsConfig } from "../src";
-import sinon from "sinon";
 
 describe("EthereumOptionsConfig", () => {
-  describe("options", () => {
-    let spy: any;
-    beforeEach(() => {
-      spy = sinon.spy(console, "log");
-    });
-    afterEach(() => {
-      spy.restore();
-    });
-    it("logs via console.log by default", () => {
-      const message = "message";
-      const options = EthereumOptionsConfig.normalize({});
-      options.logging.logger.log(message);
-      assert.strictEqual(spy.withArgs(message).callCount, 1);
-    });
-
-    it("disables the logger when the quiet flag is used", () => {
-      const message = "message";
-      const options = EthereumOptionsConfig.normalize({
-        logging: { quiet: true }
-      });
-      options.logging.logger.log(message);
-      assert.strictEqual(spy.withArgs(message).callCount, 0);
-    });
-  });
   describe(".normalize", () => {
     it("returns an options object with all default namespaces", () => {
       const options = EthereumOptionsConfig.normalize({});