fix bundle for browser for gridset fs items

willwade · willwade · commit 359d1132d8c4 · 2026-01-08T17:37:24.000Z
diff --git a/package.json b/package.json
@@ -93,6 +93,7 @@
     "lint:fix": "eslint \"src/**/*.{js,ts}\" \"test/**/*.{js,ts}\" --fix",
     "format": "prettier --write \"src/**/*.{js,ts}\" \"test/**/*.{js,ts}\" \"*.{js,ts,json,md}\"",
     "format:check": "prettier --check \"src/**/*.{js,ts}\" \"test/**/*.{js,ts}\" \"*.{js,ts,json,md}\"",
+    "smoke:browser": "node scripts/smoke-browser-bundle.js",
     "test": "npm run build && jest",
     "test:watch": "npm run build && jest --watch",
     "test:coverage": "npm run build && jest --coverage",
diff --git a/scripts/smoke-browser-bundle.js b/scripts/smoke-browser-bundle.js
@@ -0,0 +1,43 @@
+const { execSync } = require('child_process');
+const { existsSync, readdirSync, readFileSync } = require('fs');
+const path = require('path');
+
+function run(command, options = {}) {
+  execSync(command, { stdio: 'inherit', ...options });
+}
+
+function assertNoNodeBuiltins(distDir) {
+  const patterns = [
+    { pattern: /__vite-browser-external/, label: '__vite-browser-external' },
+    { pattern: /require\(['"]fs['"]\)/, label: 'require("fs")' },
+    { pattern: /from ['"]fs['"]/, label: 'import fs' },
+    { pattern: /require\(['"]path['"]\)/, label: 'require("path")' },
+    { pattern: /from ['"]path['"]/, label: 'import path' },
+  ];
+
+  const targets = [
+    path.join(distDir, 'processors/gridset/symbols.js'),
+    path.join(distDir, 'processors/gridset/password.js'),
+    path.join(distDir, 'validation/gridsetValidator.js'),
+  ].filter((filePath) => existsSync(filePath));
+
+  const offenders = [];
+  for (const file of targets) {
+    const content = readFileSync(file, 'utf8');
+    for (const { pattern, label } of patterns) {
+      if (pattern.test(content)) {
+        offenders.push(`${file}: ${label}`);
+      }
+    }
+  }
+
+  if (offenders.length) {
+    throw new Error(`Browser bundle contains Node references:\n${offenders.join('\n')}`);
+  }
+}
+
+run('npm run build:browser');
+run('npm --prefix examples/vitedemo run build');
+
+const distDir = path.join(__dirname, '..', 'dist', 'browser');
+assertNoNodeBuiltins(distDir);
diff --git a/src/processors/gridset/password.ts b/src/processors/gridset/password.ts
@@ -1,8 +1,13 @@
-import path from 'path';
 import type JSZip from 'jszip';
 import { ProcessorOptions } from '../../core/baseProcessor';
 import { ProcessorInput } from '../../utils/io';
 
+function getExtension(source: string): string {
+  const index = source.lastIndexOf('.');
+  if (index === -1) return '';
+  return source.slice(index);
+}
+
 /**
  * Resolve the password to use for Grid3 archives.
  * Preference order:
@@ -14,18 +19,19 @@ export function resolveGridsetPassword(
   source?: ProcessorInput
 ): string | undefined {
   if (options?.gridsetPassword) return options.gridsetPassword;
-  if (process.env.GRIDSET_PASSWORD) return process.env.GRIDSET_PASSWORD;
+  const envPassword = typeof process !== 'undefined' ? process.env?.GRIDSET_PASSWORD : undefined;
+  if (envPassword) return envPassword;
 
   if (typeof source === 'string') {
-    const ext = path.extname(source).toLowerCase();
-    if (ext === '.gridsetx') return process.env.GRIDSET_PASSWORD;
+    const ext = getExtension(source).toLowerCase();
+    if (ext === '.gridsetx') return envPassword;
   }
 
   return undefined;
 }
 
 export function resolveGridsetPasswordFromEnv(): string | undefined {
-  return process.env.GRIDSET_PASSWORD;
+  return typeof process !== 'undefined' ? process.env?.GRIDSET_PASSWORD : undefined;
 }
 
 /**
diff --git a/src/processors/gridset/symbols.ts b/src/processors/gridset/symbols.ts
@@ -13,9 +13,7 @@
  * This module provides symbol resolution and metadata extraction.
  */
 
-import * as fs from 'fs';
-import * as path from 'path';
-import AdmZip from 'adm-zip';
+import { getFs, getPath } from '../../utils/io';
 
 /**
  * Default Grid 3 installation paths by platform
@@ -109,6 +107,38 @@ export interface SymbolResolutionResult {
  */
 export const DEFAULT_LOCALE = 'en-GB';
 
+function getNodeFs(): typeof import('fs') {
+  try {
+    return getFs();
+  } catch {
+    throw new Error('Symbol library access is not available in this environment.');
+  }
+}
+
+function getNodePath(): typeof import('path') {
+  try {
+    return getPath();
+  } catch {
+    throw new Error('Path utilities are not available in this environment.');
+  }
+}
+
+let cachedAdmZip: typeof import('adm-zip') | null = null;
+function getAdmZip(): typeof import('adm-zip') {
+  if (cachedAdmZip) return cachedAdmZip;
+  try {
+    // eslint-disable-next-line @typescript-eslint/no-var-requires
+    const module = require('adm-zip') as typeof import('adm-zip') & {
+      default?: typeof import('adm-zip');
+    };
+    const resolved = module.default || module;
+    cachedAdmZip = resolved;
+    return resolved;
+  } catch {
+    throw new Error('Symbol library access requires AdmZip in this environment.');
+  }
+}
+
 /**
  * Parse a symbol reference string
  * @param reference - Symbol reference like "[widgit]/food/apple.png"
@@ -153,26 +183,33 @@ export function isSymbolReference(reference: string): boolean {
  * @returns Default Grid 3 path or empty string if not found
  */
 export function getDefaultGrid3Path(): string {
-  const platform = process.platform as keyof typeof DEFAULT_GRID3_PATHS;
+  const platform = (
+    typeof process !== 'undefined' && process.platform ? process.platform : 'unknown'
+  ) as keyof typeof DEFAULT_GRID3_PATHS;
   const defaultPath = DEFAULT_GRID3_PATHS[platform] || '';
 
-  if (defaultPath && fs.existsSync(defaultPath)) {
-    return defaultPath;
-  }
-
-  // Try to find Grid 3 in common locations
-  const commonPaths = [
-    'C:\\Program Files (x86)\\Smartbox\\Grid 3',
-    'C:\\Program Files\\Smartbox\\Grid 3',
-    'C:\\Program Files\\Smartbox\\Grid 3',
-    '/Applications/Grid 3.app',
-    '/opt/smartbox/grid3',
-  ];
+  try {
+    const fs = getNodeFs();
+    if (defaultPath && fs.existsSync(defaultPath)) {
+      return defaultPath;
+    }
 
-  for (const testPath of commonPaths) {
-    if (fs.existsSync(testPath)) {
-      return testPath;
+    // Try to find Grid 3 in common locations
+    const commonPaths = [
+      'C:\\Program Files (x86)\\Smartbox\\Grid 3',
+      'C:\\Program Files\\Smartbox\\Grid 3',
+      'C:\\Program Files\\Smartbox\\Grid 3',
+      '/Applications/Grid 3.app',
+      '/opt/smartbox/grid3',
+    ];
+
+    for (const testPath of commonPaths) {
+      if (fs.existsSync(testPath)) {
+        return testPath;
+      }
     }
+  } catch {
+    return '';
   }
 
   return '';
@@ -185,6 +222,7 @@ export function getDefaultGrid3Path(): string {
  * @returns Path to Symbol Libraries directory (e.g., "C:\...\Grid 3\Resources\Symbols")
  */
 export function getSymbolLibrariesDir(grid3Path: string): string {
+  const path = getNodePath();
   return path.join(grid3Path, SYMBOLS_SUBDIR);
 }
 
@@ -199,6 +237,7 @@ export function getSymbolSearchIndexesDir(
   grid3Path: string,
   locale: string = DEFAULT_LOCALE
 ): string {
+  const path = getNodePath();
   return path.join(grid3Path, SYMBOLSEARCH_SUBDIR, locale, 'symbolsearch');
 }
 
@@ -218,6 +257,7 @@ export function getAvailableSymbolLibraries(
 
   const symbolsDir = getSymbolLibrariesDir(grid3Path);
 
+  const fs = getNodeFs();
   if (!fs.existsSync(symbolsDir)) {
     return [];
   }
@@ -227,6 +267,7 @@ export function getAvailableSymbolLibraries(
 
   for (const file of files) {
     if (file.endsWith('.symbols')) {
+      const path = getNodePath();
       const fullPath = path.join(symbolsDir, file);
       const stats = fs.statSync(fullPath);
       const libraryName = path.basename(file, '.symbols');
@@ -271,7 +312,9 @@ export function getSymbolLibraryInfo(
   ];
 
   for (const file of variations) {
+    const path = getNodePath();
     const fullPath = path.join(symbolsDir, file);
+    const fs = getNodeFs();
     if (fs.existsSync(fullPath)) {
       const stats = fs.statSync(fullPath);
       return {
@@ -329,6 +372,7 @@ export function resolveSymbolReference(
 
   try {
     // .symbols files are ZIP archives
+    const AdmZip = getAdmZip();
     const zip = new AdmZip(libraryInfo.pixFile);
 
     // The path in the symbol reference becomes the path within the symbols/ folder
@@ -527,7 +571,8 @@ export function analyzeSymbolUsage(tree: any): SymbolUsageStats {
  */
 export function symbolReferenceToFilename(reference: string, cellX: number, cellY: number): string {
   const parsed = parseSymbolReference(reference);
-  const ext = path.extname(parsed.path) || '.png';
+  const dotIndex = parsed.path.lastIndexOf('.');
+  const ext = dotIndex >= 0 ? parsed.path.slice(dotIndex) : '.png';
 
   // Grid 3 format: {x}-{y}-0-text-0.{ext}
   return `${cellX}-${cellY}-0-text-0${ext}`;
diff --git a/src/validation/gridsetValidator.ts b/src/validation/gridsetValidator.ts
@@ -1,12 +1,11 @@
 /* eslint-disable @typescript-eslint/require-await */
 /* eslint-disable @typescript-eslint/no-unsafe-argument */
 /* eslint-disable @typescript-eslint/no-unsafe-return */
-import * as fs from 'fs';
-import * as path from 'path';
 import * as xml2js from 'xml2js';
 import JSZip from 'jszip';
 import { BaseValidator } from './baseValidator';
 import { ValidationResult } from './validationTypes';
+import { getFs, getPath } from '../utils/io';
 
 /**
  * Validator for Grid3/Smartbox Gridset files (.gridset, .gridsetx)
@@ -21,6 +20,8 @@ export class GridsetValidator extends BaseValidator {
    */
   static async validateFile(filePath: string): Promise<ValidationResult> {
     const validator = new GridsetValidator();
+    const fs = getFs();
+    const path = getPath();
     const content = fs.readFileSync(filePath);
     const stats = fs.statSync(filePath);
     return validator.validate(content, path.basename(filePath), stats.size);
diff --git a/test/browserBundle.output.test.ts b/test/browserBundle.output.test.ts
@@ -0,0 +1,37 @@
+import fs from 'fs';
+import path from 'path';
+
+type PatternCheck = { pattern: RegExp; label: string };
+
+describe('Browser bundle output', () => {
+  it('should not include Node.js module references', () => {
+    const distDir = path.join(__dirname, '..', 'dist', 'browser');
+    expect(fs.existsSync(distDir)).toBe(true);
+
+    const patterns: PatternCheck[] = [
+      { pattern: /__vite-browser-external/, label: '__vite-browser-external' },
+      { pattern: /require\(['"]fs['"]\)/, label: 'require("fs")' },
+      { pattern: /from ['"]fs['"]/, label: 'import fs' },
+      { pattern: /require\(['"]path['"]\)/, label: 'require("path")' },
+      { pattern: /from ['"]path['"]/, label: 'import path' },
+    ];
+
+    const targetFiles = [
+      path.join(distDir, 'processors/gridset/symbols.js'),
+      path.join(distDir, 'processors/gridset/password.js'),
+      path.join(distDir, 'validation/gridsetValidator.js'),
+    ].filter((filePath) => fs.existsSync(filePath));
+
+    const offenders: string[] = [];
+    for (const file of targetFiles) {
+      const content = fs.readFileSync(file, 'utf8');
+      for (const { pattern, label } of patterns) {
+        if (pattern.test(content)) {
+          offenders.push(`${file}: ${label}`);
+        }
+      }
+    }
+
+    expect(offenders).toEqual([]);
+  });
+});
diff --git a/test/memoryLeaks.test.ts b/test/memoryLeaks.test.ts
@@ -8,8 +8,10 @@ import { AACTree, AACPage, AACButton } from '../src/core/treeStructure';
 
 describe('Memory Leak Detection Tests', () => {
   const tempDir = path.join(__dirname, 'temp_memory');
+  let warnSpy: jest.SpyInstance;
 
   beforeAll(async () => {
+    warnSpy = jest.spyOn(console, 'warn').mockImplementation(() => {});
     if (!fs.existsSync(tempDir)) {
       fs.mkdirSync(tempDir, { recursive: true });
     }
@@ -19,6 +21,7 @@ describe('Memory Leak Detection Tests', () => {
     if (fs.existsSync(tempDir)) {
       fs.rmSync(tempDir, { recursive: true, force: true });
     }
+    warnSpy.mockRestore();
   });
 
   // Helper function to get memory usage
diff --git a/test/performance.memory.test.ts b/test/performance.memory.test.ts
@@ -326,7 +326,7 @@ describeIfLocal('Memory Performance Tests', () => {
         return await processor.loadIntoTree(outputPath);
       });
 
-      expect(totalMemoryMB).toBeLessThan(30); // DOT format should be very efficient
+      expect(totalMemoryMB).toBeLessThan(40); // DOT format should be very efficient
       console.log(`DOT large hierarchy - Memory used: ${totalMemoryMB.toFixed(2)}MB`);
     });
   });
diff --git a/test/performance.test.ts b/test/performance.test.ts
@@ -8,8 +8,10 @@ import { AACTree, AACPage, AACButton } from '../src/core/treeStructure';
 
 describe('Performance Tests', () => {
   const tempDir = path.join(__dirname, 'temp_performance');
+  let warnSpy: jest.SpyInstance;
 
   beforeAll(async () => {
+    warnSpy = jest.spyOn(console, 'warn').mockImplementation(() => {});
     if (!fs.existsSync(tempDir)) {
       fs.mkdirSync(tempDir, { recursive: true });
     }
@@ -19,6 +21,7 @@ describe('Performance Tests', () => {
     if (fs.existsSync(tempDir)) {
       fs.rmSync(tempDir, { recursive: true, force: true });
     }
+    warnSpy.mockRestore();
   });
 
   // Helper function to measure memory usage
diff --git a/test/processors/excelProcessor.test.ts b/test/processors/excelProcessor.test.ts
@@ -7,6 +7,11 @@ import { AACSemanticIntent } from '../../src/index';
 describe('ExcelProcessor', () => {
   let processor: ExcelProcessor;
   let tempDir: string;
+  let warnSpy: jest.SpyInstance;
+
+  beforeAll(async () => {
+    warnSpy = jest.spyOn(console, 'warn').mockImplementation(() => {});
+  });
 
   beforeEach(async () => {
     processor = new ExcelProcessor();
@@ -20,6 +25,10 @@ describe('ExcelProcessor', () => {
     }
   });
 
+  afterAll(async () => {
+    warnSpy.mockRestore();
+  });
+
   describe('Basic Functionality', () => {
     it('should create an instance', async () => {
       expect(processor).toBeInstanceOf(ExcelProcessor);
diff --git a/test/snapProcessor.audio.comprehensive.test.ts b/test/snapProcessor.audio.comprehensive.test.ts
