tinyusdz/web/tests/test-zero-copy-mock.js

#!/usr/bin/env node

/**
 * Mock test for setAssetFromRawPointer method - Zero-Copy Uint8Array Transfer
 * 
 * This test demonstrates how the new zero-copy method works with raw pointers
 * to avoid copying data when transferring Uint8Array from JavaScript to C++.
 */

console.log('='.repeat(70));
console.log('Mock Test for Zero-Copy setAssetFromRawPointer method');
console.log('='.repeat(70));

// Mock implementation that simulates the expected behavior
class MockEMAssetResolver {
  constructor() {
    this.cache = new Map();
    // Simulate Emscripten heap
    this.simulatedHeap = new ArrayBuffer(1024 * 1024); // 1MB heap
    this.heapView = new Uint8Array(this.simulatedHeap);
  }

  add(assetName, binaryData) {
    this.cache.set(assetName, {
      binary: binaryData,
      sha256_hash: 'mock-hash-' + assetName
    });
    return this.cache.has(assetName);
  }

  // Zero-copy method using raw pointers
  addFromRawPointer(assetName, dataPtr, size) {
    if (size === 0) {
      return false;
    }
    
    // Simulate reading directly from heap without intermediate copying
    console.log(`  📍 Reading ${size} bytes directly from heap address ${dataPtr}`);
    
    // In real WebAssembly, this would be:
    // const uint8_t* data = reinterpret_cast<const uint8_t*>(dataPtr);
    // Here we simulate it by reading from our mock heap
    const startOffset = dataPtr % this.heapView.length;
    const data = this.heapView.subarray(startOffset, startOffset + size);
    
    // Only copy once into storage format (unavoidable for persistence)
    // Store as binary data directly to avoid string conversion issues
    const binaryData = new Uint8Array(data);
    
    const overwritten = this.cache.has(assetName);
    this.cache.set(assetName, {
      binary: binaryData,
      sha256_hash: 'mock-hash-' + assetName
    });
    
    console.log(`  ✓ Asset stored with zero-copy read, single storage copy`);
    return overwritten;
  }

  has(assetName) {
    return this.cache.has(assetName);
  }

  getCacheDataAsMemoryView(assetName) {
    if (!this.cache.has(assetName)) {
      return undefined;
    }
    const entry = this.cache.get(assetName);
    // Return binary data directly if it's already Uint8Array
    if (entry.binary instanceof Uint8Array) {
      return entry.binary;
    }
    // Otherwise encode string to Uint8Array
    const encoder = new TextEncoder();
    return encoder.encode(entry.binary);
  }

  // Simulate placing data in heap and returning pointer
  simulateHeapAllocation(uint8Array) {
    const offset = Math.floor(Math.random() * (this.heapView.length - uint8Array.length));
    this.heapView.set(uint8Array, offset);
    return offset; // Return "pointer" (offset in our mock heap)
  }
}

// Mock TinyUSDZLoaderNative with zero-copy support
class MockTinyUSDZLoaderNative {
  constructor() {
    this.em_resolver_ = new MockEMAssetResolver();
  }

  setAsset(name, binary) {
    this.em_resolver_.add(name, binary);
  }

  // New zero-copy method
  setAssetFromRawPointer(name, dataPtr, size) {
    return this.em_resolver_.addFromRawPointer(name, dataPtr, size);
  }

  hasAsset(name) {
    return this.em_resolver_.has(name);
  }

  getAssetCacheDataAsMemoryView(name) {
    return this.em_resolver_.getCacheDataAsMemoryView(name);
  }

  // Helper method to simulate JavaScript side pointer calculation
  simulateGetPointerFromUint8Array(uint8Array) {
    // In real JavaScript with Emscripten, this would be:
    // const dataPtr = Module.HEAPU8.subarray(uint8Array.byteOffset, 
    //                   uint8Array.byteOffset + uint8Array.byteLength).byteOffset;
    return this.em_resolver_.simulateHeapAllocation(uint8Array);
  }
}

function runZeroCopyTest() {
  console.log('Running zero-copy mock test...\n');
  
  try {
    // Create mock loader
    const loader = new MockTinyUSDZLoaderNative();
    console.log('✓ Mock loader with zero-copy support created');

    // Create test data
    const testAssetName = 'large-texture.bin';
    const largeData = new Uint8Array(1024); // 1KB test data
    for (let i = 0; i < largeData.length; i++) {
      largeData[i] = i % 256;
    }
    console.log(`✓ Created test data: ${largeData.length} bytes`);

    // Traditional method (for comparison)
    console.log('\n📊 Comparison: Traditional vs Zero-Copy');
    console.log('─'.repeat(50));
    
    const traditionalAssetName = 'traditional-asset.bin';
    console.log('🔄 Traditional method (setAsset):');
    console.log('  1. JavaScript Uint8Array → String conversion (copy #1)');
    const traditionalString = String.fromCharCode(...largeData);
    console.log('  2. String passed to C++ (copy #2)');
    loader.setAsset(traditionalAssetName, traditionalString);
    console.log('  3. String copied into cache storage (copy #3)');
    console.log('  📈 Total copies: 3');

    // Zero-copy method
    console.log('\n⚡ Zero-copy method (setAssetFromRawPointer):');
    console.log('  1. Uint8Array already in heap - no conversion needed');
    const dataPtr = loader.simulateGetPointerFromUint8Array(largeData);
    console.log(`  2. Pass pointer (${dataPtr}) and size (${largeData.length}) to C++`);
    const wasOverwritten = loader.setAssetFromRawPointer(testAssetName, dataPtr, largeData.length);
    console.log('  3. C++ reads directly from heap pointer (zero-copy read)');
    console.log('  4. Single copy into cache storage (unavoidable for persistence)');
    console.log('  📈 Total copies: 1 (67% reduction!)');
    console.log(`  ✓ Asset was ${wasOverwritten ? 'overwritten' : 'newly created'}`);

    // Verify the asset exists
    const hasAsset = loader.hasAsset(testAssetName);
    if (!hasAsset) {
      throw new Error('Asset should exist after zero-copy operation');
    }
    console.log('  ✓ Asset exists in cache');

    // Verify data integrity
    console.log('\n🔍 Data Integrity Verification:');
    const retrievedView = loader.getAssetCacheDataAsMemoryView(testAssetName);
    if (!retrievedView) {
      throw new Error('Should be able to retrieve stored data');
    }
    
    if (retrievedView.length !== largeData.length) {
      throw new Error(`Size mismatch: expected ${largeData.length}, got ${retrievedView.length}`);
    }
    console.log(`  ✓ Size matches: ${retrievedView.length} bytes`);

    // Check a few sample bytes
    const sampleIndices = [0, 100, 500, 1023];
    for (const i of sampleIndices) {
      if (retrievedView[i] !== largeData[i]) {
        throw new Error(`Data mismatch at index ${i}: expected ${largeData[i]}, got ${retrievedView[i]}`);
      }
    }
    console.log('  ✓ Sample data verification passed');

    // Performance implications
    console.log('\n⚡ Performance Benefits:');
    console.log('  ✓ No JavaScript ↔ C++ string conversion overhead');
    console.log('  ✓ Direct memory access in C++');
    console.log('  ✓ Reduced memory usage during transfer');
    console.log('  ✓ Better performance for large assets (textures, meshes, etc.)');

    // Use cases
    console.log('\n🎯 Ideal Use Cases:');
    console.log('  • Large texture files (PNG, JPG, EXR)');
    console.log('  • Binary USD files (USDC)');
    console.log('  • Geometry data (meshes, point clouds)');
    console.log('  • Any binary asset > 1KB');

    console.log('\n🎉 All zero-copy tests passed!');
    console.log('\nZero-copy method benefits:');
    console.log('✓ Eliminates intermediate copying during data transfer');
    console.log('✓ Direct pointer access in C++ code');
    console.log('✓ Significant performance improvement for large assets');
    console.log('✓ Maintains data integrity');

  } catch (error) {
    console.error('\n❌ Zero-copy test failed:', error.message);
    process.exit(1);
  }
}

// Show the actual JavaScript usage pattern
console.log('Expected JavaScript Usage Pattern:');
console.log('─'.repeat(40));
console.log(`
// Load binary asset (e.g., from fetch, file input, etc.)
const response = await fetch('large-texture.jpg');
const arrayBuffer = await response.arrayBuffer();
const uint8Array = new Uint8Array(arrayBuffer);

// Zero-copy transfer to C++
// Method 1: Direct heap access (most efficient)
const dataPtr = Module.HEAPU8.subarray(
  uint8Array.byteOffset, 
  uint8Array.byteOffset + uint8Array.byteLength
).byteOffset;
const success = loader.setAssetFromRawPointer('texture.jpg', dataPtr, uint8Array.length);

// Method 2: Helper function (if provided)
const success2 = loader.setAssetFromUint8Array('texture.jpg', uint8Array);
`);
console.log('─'.repeat(40));
console.log();

runZeroCopyTest();