rnxsim 0.1.403 → 0.1.405

package/src/metro-production-bundle.ts

@@ -1,9 +1,22 @@
 const RNXSIM_METRO_MODULE_PATHS_PREFIX = 'globalThis.__sootsimModulePaths='
+export const RNX_METRO_MODULE_IDENTITY_VERSION = 2
 
 export type RNXMetroModulePathMap = Record<string, string>
-export interface RNXMetroModuleIdentity {
-  source: string
+export type RNXMetroLogicalSpecifierMap = Record<string, string[]>
+export type RNXMetroModuleIdentitySource =
+  | 'rnx-plugin'
+  | 'contrast-bundler'
+  | 'metro-source-map'
+
+export interface RNXMetroModuleIdentityMetadata {
+  version: typeof RNX_METRO_MODULE_IDENTITY_VERSION
+  identitySource: RNXMetroModuleIdentitySource
   modulePaths: RNXMetroModulePathMap
+  logicalSpecifiers: RNXMetroLogicalSpecifierMap
+}
+
+export interface RNXMetroModuleIdentity extends RNXMetroModuleIdentityMetadata {
+  source: string
   /**
    * Metro's trailing `//# sourceMappingURL=` comment when the graph carried
    * one, already split off `source`. A production graph has none.
@@ -67,10 +80,10 @@ export function detachRNXMetroSourceMapUrl(
   return { source: trimmedEnd.slice(0, commentStart), sourceMappingUrl: url }
 }
 
-export function createRNXMetroModulePathsFooter(
-  modulePaths: RNXMetroModulePathMap,
+export function createRNXMetroModuleIdentityFooter(
+  identity: RNXMetroModuleIdentityMetadata,
 ): string {
-  const payload = JSON.stringify(modulePaths)
+  const payload = JSON.stringify(identity)
     .replace(/\u2028/g, '\\u2028')
     .replace(/\u2029/g, '\\u2029')
     .replace(/<\//g, '<\\/')
@@ -83,11 +96,11 @@ export function createRNXMetroModulePathsFooter(
  * production graph has no such comment and gets the footer appended, exactly
  * as before.
  */
-export function appendRNXMetroModulePathsFooter(
+export function appendRNXMetroModuleIdentityFooter(
   bundleText: string,
-  modulePaths: RNXMetroModulePathMap,
+  identity: RNXMetroModuleIdentityMetadata,
 ): string {
-  const footer = createRNXMetroModulePathsFooter(modulePaths)
+  const footer = createRNXMetroModuleIdentityFooter(identity)
   const detached = detachRNXMetroSourceMapUrl(bundleText)
   return detached.sourceMappingUrl === null
     ? bundleText + footer
@@ -101,23 +114,77 @@ export function readRNXMetroModuleIdentity(
   const withoutMap = detached.source
   const footerPrefix = `\n${RNXSIM_METRO_MODULE_PATHS_PREFIX}`
   const footerStart = withoutMap.lastIndexOf(footerPrefix)
-  if (footerStart < 0 || !withoutMap.endsWith(';')) return null
+  if (footerStart < 0) return null
+  if (!withoutMap.endsWith(';')) {
+    throw new Error('Metro module identity footer is truncated')
+  }
 
-  const parsed: unknown = JSON.parse(
-    withoutMap.slice(footerStart + footerPrefix.length, -1),
-  )
+  let parsed: unknown
+  try {
+    parsed = JSON.parse(withoutMap.slice(footerStart + footerPrefix.length, -1))
+  } catch {
+    throw new Error('Metro module identity footer is not valid JSON')
+  }
   if (typeof parsed !== 'object' || parsed === null || Array.isArray(parsed)) {
-    return null
+    throw new Error('Metro module identity footer is malformed')
+  }
+
+  const version = Reflect.get(parsed, 'version')
+  // stored artifacts from before the versioned footer carry a bare module-path
+  // map with no version field. they are development bundles whose identity
+  // comes from Metro's verbose names, so treat their footer as absent rather
+  // than failing every stored replay.
+  if (version === undefined) return null
+  const identitySource = Reflect.get(parsed, 'identitySource')
+  const parsedModulePaths = Reflect.get(parsed, 'modulePaths')
+  const parsedLogicalSpecifiers = Reflect.get(parsed, 'logicalSpecifiers')
+  if (
+    version !== RNX_METRO_MODULE_IDENTITY_VERSION ||
+    (identitySource !== 'rnx-plugin' &&
+      identitySource !== 'contrast-bundler' &&
+      identitySource !== 'metro-source-map') ||
+    typeof parsedModulePaths !== 'object' ||
+    parsedModulePaths === null ||
+    Array.isArray(parsedModulePaths) ||
+    typeof parsedLogicalSpecifiers !== 'object' ||
+    parsedLogicalSpecifiers === null ||
+    Array.isArray(parsedLogicalSpecifiers)
+  ) {
+    throw new Error('Metro module identity footer is malformed')
   }
 
   const modulePaths: RNXMetroModulePathMap = {}
-  for (const [moduleId, modulePath] of Object.entries(parsed)) {
-    if (typeof modulePath !== 'string') return null
+  for (const [moduleId, modulePath] of Object.entries(parsedModulePaths)) {
+    if (typeof modulePath !== 'string') {
+      throw new Error(`Metro module identity has an invalid path for ${moduleId}`)
+    }
     modulePaths[moduleId] = modulePath
   }
+  const logicalSpecifiers: RNXMetroLogicalSpecifierMap = {}
+  for (const [moduleId, specifiers] of Object.entries(parsedLogicalSpecifiers)) {
+    if (
+      !Array.isArray(specifiers) ||
+      specifiers.length === 0 ||
+      !specifiers.every(
+        (specifier) => typeof specifier === 'string' && specifier.length > 0,
+      )
+    ) {
+      throw new Error(`Metro module identity has invalid specifiers for ${moduleId}`)
+    }
+    const unique = [...new Set(specifiers)].sort((left, right) =>
+      left.localeCompare(right),
+    )
+    if (unique.length !== specifiers.length) {
+      throw new Error(`Metro module identity repeats a specifier for ${moduleId}`)
+    }
+    logicalSpecifiers[moduleId] = unique
+  }
   return {
     source: withoutMap.slice(0, footerStart),
+    version,
+    identitySource,
     modulePaths,
+    logicalSpecifiers,
     sourceMappingUrl: detached.sourceMappingUrl,
   }
 }
@@ -243,7 +310,7 @@ function readDefineTail(source: string, start: number, end: number): DefineTail
   // whole numeric literal rather than a run of decimal digits. the factory
   // before it always ends in `}` or `)`, which stops this walk immediately.
   let idStart = idEnd
-  while (idStart > start && /[0-9a-fA-FxX.+\-]/.test(source[idStart - 1])) idStart--
+  while (idStart > start && /[0-9a-fA-FxX.+-]/.test(source[idStart - 1])) idStart--
   const literal = source.slice(idStart, idEnd)
   if (!/^-?(?:0[xXbBoO][0-9a-fA-F]+|\d+(?:\.\d*)?(?:[eE][+-]?\d+)?)$/.test(literal)) {
     return null
@@ -366,3 +433,14 @@ export function validateRNXMetroModulePaths(
     }
   }
 }
+
+export function validateRNXMetroModuleIdentity(identity: RNXMetroModuleIdentity): void {
+  validateRNXMetroModulePaths(identity.source, identity.modulePaths)
+  for (const moduleId of Object.keys(identity.logicalSpecifiers)) {
+    if (!Object.prototype.hasOwnProperty.call(identity.modulePaths, moduleId)) {
+      throw new Error(
+        `Metro module identity has logical specifiers for unknown module ${moduleId}`,
+      )
+    }
+  }
+}