test(mockBrowser): test themer import handling

Author: kbrabrand

packages/sanity/test/cli/util/importErrorHandler.test.ts renamed to packages/sanity/src/_internal/cli/util/__tests__/importErrorHandler.test.ts

@@ -1,15 +1,15 @@
 import Module from 'node:module'
 
-import {describe, expect, it} from 'vitest'
+import {describe, expect, test} from 'vitest'
 
-import {setupImportErrorHandler} from '../../../src/_internal/cli/util/importErrorHandler'
+import {setupImportErrorHandler} from '../importErrorHandler'
 
 interface ModuleConstructor {
   _load(request: string, parent: Module | undefined, isMain: boolean): any
 }
 
 describe('setupImportErrorHandler', () => {
-  it('should handle themer.sanity.build URL imports', () => {
+  test('should handle themer.sanity.build URL imports', () => {
     const handler = setupImportErrorHandler()
 
     const ModuleConstructor = Module as unknown as ModuleConstructor
@@ -29,7 +29,7 @@ describe('setupImportErrorHandler', () => {
     handler.cleanup()
   })
 
-  it('should re-throw errors for non-themer URLs', () => {
+  test('should re-throw errors for non-themer URLs', () => {
     const handler = setupImportErrorHandler()
 
     const ModuleConstructor = Module as unknown as ModuleConstructor
@@ -45,7 +45,7 @@ describe('setupImportErrorHandler', () => {
     handler.cleanup()
   })
 
-  it('should restore original Module._load after cleanup', () => {
+  test('should restore original Module._load after cleanup', () => {
     const ModuleConstructor = Module as unknown as ModuleConstructor
     const originalLoad = ModuleConstructor._load
 

packages/sanity/src/_internal/cli/util/__tests__/mockBrowserEnvironment.test.ts

@@ -0,0 +1,54 @@
+import {Worker} from 'node:worker_threads'
+
+import {describe, expect, test} from 'vitest'
+
+import {type ThemerImportWorkerData} from './themerImportWorker'
+
+function getImportWorker(importName: string) {
+  const workerData: ThemerImportWorkerData = {
+    workDir: process.cwd(),
+    importName,
+  }
+
+  const filepath = new URL('./themerImportWorker.ts', import.meta.url).pathname
+
+  const worker = new Worker(
+    `
+      const { register } = require('esbuild-register/dist/node')
+
+      const { unregister } = register({
+        target: 'node18',
+        format: 'cjs',
+        extensions: ['.ts'],
+      })
+
+      require(${JSON.stringify(filepath)})
+    `,
+    {eval: true, workerData},
+  )
+
+  return new Promise<{success: boolean; error?: string}>((resolve, reject) => {
+    worker.on('message', resolve)
+    worker.on('error', reject)
+    worker.on('exit', (code) => {
+      if (code !== 0) {
+        reject(new Error(`Worker stopped with exit code ${code}`))
+      }
+    })
+  })
+}
+
+describe('mockBrowserEnvironment', () => {
+  test('should handle themer.sanity.build imports in worker thread', async () => {
+    await expect(getImportWorker('https://themer.sanity.build/api/hues')).resolves.toEqual({
+      success: true,
+    })
+  })
+
+  test('should still error on non-themer.sanity.build imports in worker thread', async () => {
+    await expect(getImportWorker('https://foobar.official/package')).resolves.toEqual({
+      success: false,
+      error: expect.stringContaining("Cannot find module 'https://foobar.official/package'"),
+    })
+  })
+})

packages/sanity/src/_internal/cli/util/__tests__/themerImportWorker.ts

@@ -0,0 +1,36 @@
+import {isMainThread, parentPort, workerData as _workerData} from 'node:worker_threads'
+
+import {mockBrowserEnvironment} from '../mockBrowserEnvironment'
+
+export type ThemerImportWorkerData = {
+  workDir: string
+  importName: string
+}
+
+const {workDir, importName} = _workerData satisfies ThemerImportWorkerData
+
+async function main() {
+  if (isMainThread || !parentPort) {
+    throw new Error('This module must be run as a worker thread')
+  }
+
+  const cleanup = mockBrowserEnvironment(workDir)
+
+  try {
+    // eslint-disable-next-line import/no-dynamic-require
+    require(importName)
+
+    // If we get here, the import was handled successfully
+    parentPort?.postMessage({success: true})
+  } catch (error) {
+    // If we catch an error, the import error handler didn't work
+    parentPort?.postMessage({
+      success: false,
+      error: error instanceof Error ? error.message : String(error),
+    })
+  } finally {
+    cleanup()
+  }
+}
+
+void main().then(() => process.exit())