chore: add browser testing to fuel-gauge

.changeset/fast-donkeys-sit.md

@@ -0,0 +1,2 @@
+---
+---

packages/account/src/test-utils/launchNode.ts

@@ -2,7 +2,6 @@ import { UTXO_ID_LEN } from '@fuel-ts/abi-coder';
 import { randomBytes } from '@fuel-ts/crypto';
 import { defaultSnapshotConfigs, defaultConsensusKey, hexlify } from '@fuel-ts/utils';
 import type { ChildProcessWithoutNullStreams } from 'child_process';
-import { spawn } from 'child_process';
 import { randomUUID } from 'crypto';
 import { existsSync, mkdirSync, rmSync, writeFileSync } from 'fs';
 import os from 'os';
@@ -205,76 +204,79 @@ export const launchNode = async ({
       snapshotDirToUse = tempDirPath;
     }
 
-    const child = spawn(
-      command,
-      [
-        'run',
-        ['--ip', ipToUse],
-        ['--port', portToUse],
-        useInMemoryDb ? ['--db-type', 'in-memory'] : ['--db-path', tempDirPath],
-        ['--min-gas-price', '1'],
-        poaInstant ? ['--poa-instant', 'true'] : [],
-        ['--consensus-key', consensusKey],
-        ['--snapshot', snapshotDirToUse as string],
-        '--vm-backtrace',
-        '--utxo-validation',
-        '--debug',
-        ...remainingArgs,
-      ].flat(),
-      {
-        stdio: 'pipe',
+    if (!process.env.TEST || process.env.TEST_ENV === 'node') {
+      const { spawn } = await import('child_process');
+      const child = spawn(
+        command,
+        [
+          'run',
+          ['--ip', ipToUse],
+          ['--port', portToUse],
+          useInMemoryDb ? ['--db-type', 'in-memory'] : ['--db-path', tempDirPath],
+          ['--min-gas-price', '1'],
+          poaInstant ? ['--poa-instant', 'true'] : [],
+          ['--consensus-key', consensusKey],
+          ['--snapshot', snapshotDirToUse as string],
+          '--vm-backtrace',
+          '--utxo-validation',
+          '--debug',
+          ...remainingArgs,
+        ].flat(),
+        {
+          stdio: 'pipe',
+        }
+      );
+
+      if (loggingEnabled) {
+        child.stderr.pipe(process.stderr);
       }
-    );
 
-    if (loggingEnabled) {
-      child.stderr.pipe(process.stderr);
-    }
-
-    if (debugEnabled) {
-      child.stdout.pipe(process.stdout);
-    }
-
-    const cleanupConfig: KillNodeParams = {
-      child,
-      configPath: tempDirPath,
-      killFn: treeKill,
-      state: {
-        isDead: false,
-      },
-    };
-
-    // Look for a specific graphql start point in the output.
-    child.stderr.on('data', (chunk: string) => {
-      // Look for the graphql service start.
-      if (chunk.indexOf(graphQLStartSubstring) !== -1) {
-        // Resolve with the cleanup method.
-        resolve({
-          cleanup: () => killNode(cleanupConfig),
-          ip: ipToUse,
-          port: portToUse,
-          snapshotDir: snapshotDirToUse as string,
-        });
-      }
-      if (/error/i.test(chunk)) {
-        reject(chunk.toString());
+      if (debugEnabled) {
+        child.stdout.pipe(process.stdout);
       }
-    });
 
-    // Process exit.
-    process.on('exit', () => killNode(cleanupConfig));
-
-    // Catches ctrl+c event.
-    process.on('SIGINT', () => killNode(cleanupConfig));
-
-    // Catches "kill pid" (for example: nodemon restart).
-    process.on('SIGUSR1', () => killNode(cleanupConfig));
-    process.on('SIGUSR2', () => killNode(cleanupConfig));
-
-    // Catches uncaught exceptions.
-    process.on('beforeExit', () => killNode(cleanupConfig));
-    process.on('uncaughtException', () => killNode(cleanupConfig));
-
-    child.on('error', reject);
+      const cleanupConfig: KillNodeParams = {
+        child,
+        configPath: tempDirPath,
+        killFn: treeKill,
+        state: {
+          isDead: false,
+        },
+      };
+
+      // Look for a specific graphql start point in the output.
+      child.stderr.on('data', (chunk: string) => {
+        // Look for the graphql service start.
+        if (chunk.indexOf(graphQLStartSubstring) !== -1) {
+          // Resolve with the cleanup method.
+          resolve({
+            cleanup: () => killNode(cleanupConfig),
+            ip: ipToUse,
+            port: portToUse,
+            snapshotDir: snapshotDirToUse as string,
+          });
+        }
+        if (/error/i.test(chunk)) {
+          reject(chunk.toString());
+        }
+      });
+
+      // Process exit.
+      process.on('exit', () => killNode(cleanupConfig));
+
+      // Catches ctrl+c event.
+      process.on('SIGINT', () => killNode(cleanupConfig));
+
+      // Catches "kill pid" (for example: nodemon restart).
+      process.on('SIGUSR1', () => killNode(cleanupConfig));
+      process.on('SIGUSR2', () => killNode(cleanupConfig));
+
+      // Catches uncaught exceptions.
+      process.on('beforeExit', () => killNode(cleanupConfig));
+      process.on('uncaughtException', () => killNode(cleanupConfig));
+
+      child.on('error', reject);
+    }
   });
 
 const generateWallets = async (count: number, provider: Provider) => {

packages/create-fuels/src/cli.ts

@@ -68,15 +68,15 @@ export const runScaffoldCli = async ({
   let projectPath = program.args[0] ?? (await promptForProjectPath());
   const verboseEnabled = program.opts().verbose ?? false;
 
-  if (!process.env.VITEST) {
+  if (!process.env.TEST) {
     await tryInstallFuelUp(verboseEnabled);
   }
 
   while (existsSync(projectPath)) {
     error(`A folder already exists at ${projectPath}. Please choose a different project name.`);
 
     // Exit the program if we are testing to prevent hanging
-    if (process.env.VITEST) {
+    if (process.env.TEST) {
       throw new Error();
     }
 
@@ -87,7 +87,7 @@ export const runScaffoldCli = async ({
     error('Please specify a project directory.');
 
     // Exit the program if we are testing to prevent hanging
-    if (process.env.VITEST) {
+    if (process.env.TEST) {
       throw new Error();
     }
 
@@ -127,7 +127,7 @@ export const runScaffoldCli = async ({
     error('You must include at least one Sway program.');
 
     // Exit the program if we are testing to prevent hanging
-    if (process.env.VITEST) {
+    if (process.env.TEST) {
       throw new Error();
     }
 

packages/fuel-gauge/src/call-test-contract.test.ts

@@ -18,6 +18,7 @@ const U64_MAX = bn(2).pow(64).sub(1);
 
 /**
  * @group node
+ * @group browser
  */
 describe('CallTestContract', () => {
   it.each([0, 1337, U64_MAX.sub(1)])('can call a contract with u64 (%p)', async (num) => {

packages/fuel-gauge/src/coverage-contract.test.ts

@@ -11,7 +11,11 @@
   FUEL_NETWORK_URL,
 } from 'fuels';
 
-import { getSetupContract } from './utils';
+import type { CoverageContractAbi } from '../test/typegen/contracts';
+import { CoverageContractAbi__factory } from '../test/typegen/contracts';
+import binHexlified from '../test/typegen/contracts/CoverageContractAbi.hex';
+
+import { createSetupConfig } from './utils';
 
 const RUST_U8_MAX = 255;
 const RUST_U16_MAX = 65535;
@@ -21,7 +25,11 @@
 const B512 =
   '0x059bc9c43ea1112f3eb2bd30415de72ed24c1c4416a1316f0f48cc6f958073f42a6d8c12e4829826316d8dcf444498717b5a2fbf27defac367271065f6a1d4a5';
 
-const setupContract = getSetupContract('coverage-contract');
+const setupContract = createSetupConfig<CoverageContractAbi>({
+  contractBytecode: binHexlified,
+  abi: CoverageContractAbi__factory.abi,
+  cache: true,
+});
 
 let contractInstance: Contract;
 let baseAssetId: string;
@@ -48,8 +56,11 @@
 
 /**
  * @group node
+ * @group browser
  */
 describe('Coverage Contract', () => {
+  console.log(process.env);
+
   it('can return outputs', async () => {
     // Call contract methods
     expect((await contractInstance.functions.get_id().call()).value).toEqual(

packages/fuels/src/cli/commands/build/buildSwayProgram.ts

@@ -1,4 +1,4 @@
-import { spawn } from 'child_process';
+import type { spawn } from 'child_process';
 
 import type { FuelsConfig } from '../../types';
 import { debug, loggingConfig } from '../../utils/logger';
@@ -8,9 +8,16 @@ import { onForcExit, onForcError } from './forcHandlers';
 export const buildSwayProgram = async (config: FuelsConfig, path: string) => {
   debug('Building Sway program', path);
 
+  let spawnFn: typeof spawn;
+
+  if (!process.env.TEST || process.env.TEST_ENV === 'node') {
+    const { spawn: spawnChildProcess } = await import('child_process');
+    spawnFn = spawnChildProcess;
+  }
+
   return new Promise<void>((resolve, reject) => {
     const args = ['build', '-p', path].concat(config.forcBuildFlags);
-    const forc = spawn(config.forcPath, args, { stdio: 'pipe' });
+    const forc = spawnFn(config.forcPath, args, { stdio: 'pipe' });
 
     if (loggingConfig.isLoggingEnabled) {
       forc.stderr?.pipe(process.stderr);

packages/fuels/src/cli/config/loadConfig.ts

@@ -50,7 +50,7 @@ export async function loadConfig(cwd: string): Promise<FuelsConfig> {
   const releaseFlag = forcBuildFlags.find((f) => f === '--release');
   const buildMode = releaseFlag ? 'release' : 'debug';
 
-  const { forcPath, fuelCorePath } = tryFindBinaries({
+  const { forcPath, fuelCorePath } = await tryFindBinaries({
     forcPath: userConfig.forcPath,
     fuelCorePath: userConfig.fuelCorePath,
   });

packages/utils/src/cli-utils/tryFindBinaries.test.ts

@@ -59,10 +59,10 @@ const mockAllDeps = (
  * @group node
  */
 describe('tryFindBinaries', () => {
-  it(`should use default binaries when not paths supplied`, () => {
+  it(`should use default binaries when not paths supplied`, async () => {
     const { getSystemForc, getSystemFuelCore } = mockAllDeps();
 
-    const binaries = tryFindBinaries();
+    const binaries = await tryFindBinaries();
 
     expect(getSystemForc).toHaveBeenCalledTimes(1);
     expect(getSystemForc).toBeCalledWith(undefined);
@@ -72,13 +72,13 @@ describe('tryFindBinaries', () => {
     expect(binaries.fuelCorePath).toEqual('fuel-core');
   });
 
-  it(`should use custom binaries when paths supplied`, () => {
+  it(`should use custom binaries when paths supplied`, async () => {
     const { getSystemForc, getSystemFuelCore } = mockAllDeps();
 
     const forcPath = '/some/path/to/forc';
     const fuelCorePath = '/some/path/to/fuel-core';
 
-    const binaries = tryFindBinaries({ forcPath, fuelCorePath });
+    const binaries = await tryFindBinaries({ forcPath, fuelCorePath });
 
     expect(getSystemForc).toHaveBeenCalledTimes(1);
     expect(getSystemForc).toBeCalledWith(forcPath);
@@ -88,10 +88,10 @@ describe('tryFindBinaries', () => {
     expect(binaries.fuelCorePath).toEqual(fuelCorePath);
   });
 
-  it('should handle undefined paths', () => {
+  it('should handle undefined paths', async () => {
     const { getSystemForc, getSystemFuelCore } = mockAllDeps();
 
-    const binaries = tryFindBinaries({ forcPath: undefined, fuelCorePath: undefined });
+    const binaries = await tryFindBinaries({ forcPath: undefined, fuelCorePath: undefined });
 
     expect(getSystemForc).toHaveBeenCalledTimes(1);
     expect(getSystemForc).toBeCalledWith(undefined);
@@ -121,7 +121,7 @@ describe('tryFindBinaries', () => {
     );
   });
 
-  it(`should warn the user when binaries are outdated`, () => {
+  it(`should warn the user when binaries are outdated`, async () => {
     const compatibleVersion = '1.0.0';
     const currentVersion = '0.0.1';
     const expectedMessage = [
@@ -135,7 +135,7 @@ describe('tryFindBinaries', () => {
       fuelCoreVersion: currentVersion,
     });
 
-    tryFindBinaries();
+    await tryFindBinaries();
 
     expect(getSystemForc).toHaveBeenCalledTimes(1);
     expect(getSystemFuelCore).toHaveBeenCalledTimes(1);

packages/utils/src/cli-utils/tryFindBinaries.ts

@@ -13,15 +13,19 @@ import {
  * @param paths - paths to the binaries (optional)
  * @returns - paths to the resolved binaries
  */
-export const tryFindBinaries = (paths: { forcPath?: string; fuelCorePath?: string } = {}) => {
+export const tryFindBinaries = async (paths: { forcPath?: string; fuelCorePath?: string } = {}) => {
   // Ensure we can get the binary versions
-  const { error: forcError, systemForcPath, systemForcVersion } = getSystemForc(paths.forcPath);
+  const {
+    error: forcError,
+    systemForcPath,
+    systemForcVersion,
+  } = await getSystemForc(paths.forcPath);
 
   const {
     error: fuelCoreError,
     systemFuelCorePath,
     systemFuelCoreVersion,
-  } = getSystemFuelCore(paths.fuelCorePath);
+  } = await getSystemFuelCore(paths.fuelCorePath);
 
   if (forcError || fuelCoreError) {
     const errors = [

packages/versions/scripts/rewriteVersions.ts

@@ -64,7 +64,7 @@ export const rewriteVersions = () => {
 };
 
 /* istanbul ignore next -- @preserve */
-if (!process.env.VITEST) {
+if (!process.env.TEST) {
   // do not auto-run script when inside vitest
   rewriteVersions();
 }

packages/versions/src/bin.ts

@@ -1,4 +1,11 @@
 #!/usr/bin/env node
+import { error } from 'console';
+
 import { runVersions } from './cli';
 
-runVersions();
+(async () => {
+  await runVersions();
+})().catch((e) => {
+  error(e);
+  process.exit(1);
+});