Remove fs requirement in paima-sdk (#256)

package.json

@@ -13,7 +13,7 @@
     "prebuild": "npx nx run-many --parallel=${NX_PARALLEL:-3} -t prebuild",
     "build": "npm run lint:configs && npx nx run-many --parallel=${NX_PARALLEL:-3} -t build",
     "test": "npm run lint:configs && npx nx run-many --parallel=${NX_PARALLEL:-3} -t test",
-    "release:lib": "./wipe.sh && sh ./tools/scripts/bump-version.sh && npm run build && npm run lint && npm run test && read -p 'Enter OTP: ' otp && export NPM_CONFIG_OTP=$otp && npx nx release publish -g paima-sdk && npx nx release publish -g node-sdk",
+    "release:lib": "./wipe.sh && sh ./tools/scripts/bump-version.sh && npm run build && npm run lint && npm run test && read -p 'Enter OTP: ' otp && export NPM_CONFIG_OTP=$otp && npx nx release publish -g paima-sdk && npx nx release publish -g node-sdk && npx nx release publish -g build-utils",
     "release:bin": "./wipe.sh && npm run lint:configs && npx nx run-many --parallel=${NX_PARALLEL:-3} -t release && mkdir -p ./bin && cp -r ./packages/engine/paima-standalone/packaged/@standalone/* ./bin"
   },
   "devDependencies": {

packages/build-utils/paima-build-utils/src/middleware-esbuildconfig.template.cts

@@ -25,17 +25,6 @@ if (
 )
   throw new Error('Please ensure you have filled out your .env file');
 
-// mock out fs as we can't use it in browser builds
-const fsaReplace: esbuild.Plugin = {
-  name: 'fsa-replace',
-  setup(build) {
-    build.onResolve({ filter: /fsa\.js/ }, args => {
-      const mockFile = args.path.replace('fsa.js', 'fsa_empty.js');
-      return { path: `${args.resolveDir}/${mockFile}`, namespace: args.namespace };
-    });
-  },
-};
-
 export const config: esbuild.BuildOptions = {
   // JS output from previous compilation step used here instead of index.ts to have more control over the TS build process
   // however, that means type definitions will be lost until this is implemented: https://github.com/evanw/esbuild/issues/95#issuecomment-1559710310
@@ -44,6 +33,6 @@ export const config: esbuild.BuildOptions = {
   format: 'esm',
   define,
   outfile: 'packaged/middleware.js',
-  plugins: [polyfillNode({}), fsaReplace],
+  plugins: [polyfillNode({})],
   external: ['pg-native'],
 };

packages/engine/paima-standalone/src/index.ts

@@ -2,6 +2,15 @@
 import { config } from 'dotenv';
 import { argumentRouter } from './utils/input.js';
 
+import * as fs from 'fs';
+import { setLogger } from '@paima/utils';
+
+setLogger(s => {
+  try {
+    fs.appendFileSync('./logs.log', `${s}\n`);
+  } catch (e) {}
+});
+
 // Load environment variables
 config({ path: `${process.cwd()}/.env.${process.env.NODE_ENV || 'development'}` });
 

packages/paima-sdk/paima-mw-core/esbuildconfig.cjs

@@ -29,17 +29,6 @@ if (
   throw new Error('Please ensure you have filled out your .env file');
 }
 
-/** @type esbuild.Plugin */
-const fsaReplace = {
-  name: 'fsa-replace',
-  setup(build) {
-    build.onResolve({ filter: /fsa\.js/ }, (args) => {
-      const mockFile = args.path.replace('fsa.js', 'fsa_empty.js');
-      return { path: `${args.resolveDir}/${mockFile}`, namespace: args.namespace };
-    });
-  }
-};
-
 const config = {
   entryPoints: ['build/index.js'],
   bundle: true,
@@ -50,7 +39,7 @@ const config = {
 
   define,
   outfile: 'web/middleware.js',
-  plugins: [polyfillNode({}), fsaReplace],
+  plugins: [polyfillNode({})],
   external: ['pg-native'],
 };
 

packages/paima-sdk/paima-utils/src/index.ts

@@ -12,7 +12,7 @@ import erc165ContractBuild from './artifacts/ERC165Contract.js';
 import erc6551RegistryContractBuild from './artifacts/ERC6551RegistryContract.js';
 import oldErc6551RegistryContractBuild from './artifacts/OldERC6551RegistryContract.js';
 import type * as Contracts from './contract-types/index.js';
-import { doLog, logError } from './logging.js';
+import { doLog, setLogger, logError } from './logging.js';
 import type { Deployment, ErrorCode, ErrorMessageFxn, ErrorMessageMapping } from './types.js';
 import {
   AddressType,
@@ -37,6 +37,7 @@ export {
   ChainDataExtensionDatumType,
   DEFAULT_FUNNEL_TIMEOUT,
   logError,
+  setLogger,
   doLog,
 };
 

packages/paima-sdk/paima-utils/src/logging.ts

@@ -1,12 +1,22 @@
 import { stringify } from 'flatted';
-import * as fsa from './fs_access/fsa.js';
 
 export function logError(error: unknown): void {
   doLog(`***ERROR***`);
   doLog(error);
   doLog(`***`);
 }
 
+type LoggerFunc = (str: string) => void;
+
+class LoggerHolder {
+  static INSTANCE = new LoggerHolder();
+  log: LoggerFunc = _s => {};
+}
+
+export function setLogger(newLogger: LoggerFunc): void {
+  LoggerHolder.INSTANCE.log = newLogger;
+}
+
 // TODO: probably we want to unify this with pushLog
 export function doLog(...s: unknown[]): void {
   console.log(...s);
@@ -15,12 +25,12 @@ export function doLog(...s: unknown[]): void {
       if (typeof str === 'function') {
         continue;
       }
-      fsa.appendToFile(String(str));
+      LoggerHolder.INSTANCE.log(String(str));
     } else if (str instanceof Error) {
-      fsa.appendToFile(`${str.name}: ${str.message}\nStack: ${str.stack}`);
+      LoggerHolder.INSTANCE.log(`${str.name}: ${str.message}\nStack: ${str.stack}`);
     } else {
       try {
-        fsa.appendToFile(stringify(str));
+        LoggerHolder.INSTANCE.log(stringify(str));
       } catch (e) {
         // should not happen, but maybe there is some type that fails for some reason
       }