feat(itkConfig): Support dynamic runtime specification for browser

version needs to go into its own module to avoid a circular import.

Author: thewtex

cypress/e2e/pipeline/run_pipeline.cy.ts

@@ -9,6 +9,7 @@ describe('runPipeline', () => {
   it('captures stdout and stderr', () => {
     cy.window().then(async (win) => {
       const itk = win.itk
+      itk.itkConfig.pipelinesUrl = '/pipelines'
 
       const args = []
       const outputs = null
@@ -19,6 +20,21 @@ describe('runPipeline', () => {
   })
 
 
+  it('fetches WASM files from a custom config URL', () => {
+    cy.window().then(async (win) => {
+      const itk = win.itk
+      const configPropertyPipelinesBaseUrl = 'customPipelinesUrl' 
+      itk.itkConfig[configPropertyPipelinesBaseUrl] = '/pipelines'
+
+      const args = []
+      const outputs = null
+      const inputs = null
+      const stdoutStderrPath = 'stdout-stderr-test'
+      const { webWorker, returnValue, stdout, stderr } = await itk.runPipeline(null, stdoutStderrPath, args, outputs, inputs, configPropertyPipelinesBaseUrl)
+    })
+  })
+
+
   it('re-uses a WebWorker', () => {
     cy.window().then(async (win) => {
       const itk = win.itk
@@ -261,7 +277,7 @@ Click. Perfect success.
   })
 
 
-  it('runPipeline writes and reads an itk.Mesh via memory io', async () => {
+  it('runPipeline writes and reads an itk.Mesh via memory io', () => {
     cy.window().then(async (win) => {
       const itk = win.itk
 

src/core/index.ts

@@ -1,5 +1,8 @@
 // Core API interfaces, data structures, and functions
 
+export { default as itkConfig } from '../itkConfig.js'
+export { default as version } from './version.js'
+
 export { default as InterfaceTypes } from './InterfaceTypes.js'
 
 export { default as TextStream } from './TextStream.js'
@@ -36,6 +39,3 @@ export { default as WorkerPool } from './WorkerPool.js'
 export { default as WorkerPoolFunction } from './WorkerPoolFunction.js'
 export { default as WorkerPoolProgressCallback } from './WorkerPoolProgressCallback.js'
 export { default as WorkerPoolRunTasksResult } from './WorkerPoolRunTasksResult.js'
-
-const version = '0.0.0-semantically-released'
-export { version }

src/core/internal/createWebWorkerPromise.ts

@@ -29,6 +29,7 @@ async function createWebWorkerPromise (existingWorker: Worker | null): Promise<c
   }
 
   let worker = null
+  // @ts-ignore: error TS2339: Property 'webWorkersUrl' does not exist on type '{ pipelineWorkerUrl: string; imageIOUrl: string; meshIOUrl: string; pipelinesUrl: string; }
   const webWorkersUrl = config.webWorkersUrl
   if (typeof webWorkersUrl !== 'undefined') {
     console.warn('itkConfig webWorkersUrl is deprecated. Please use pipelineWorkerUrl with the full path to the pipeline worker.')

src/core/version.ts

@@ -0,0 +1,3 @@
+const version = '0.0.0-semantically-released'
+
+export default version

src/itkConfig.ts

@@ -1,7 +1,6 @@
-import { version } from './browser/index.js'
+import version from './core/version.js'
 
 const itkConfig = {
-  webWorkersUrl: undefined,
   pipelineWorkerUrl: `https://cdn.jsdelivr.net/npm/itk-wasm@${version}/dist/web-workers/min-bundles/pipeline.worker.js`,
   imageIOUrl: `https://cdn.jsdelivr.net/npm/itk-image-io@${version}`,
   meshIOUrl: `https://cdn.jsdelivr.net/npm/itk-mesh-io@${version}`,

src/itkConfigDevServer.js

@@ -1,5 +1,4 @@
 const itkConfig = {
-  webWorkersUrl: undefined,
   pipelineWorkerUrl: `/web-workers/bundles/pipeline.worker.js`,
   imageIOUrl: `/image-io`,
   meshIOUrl: `/mesh-io`,

src/pipeline/runPipeline.ts

@@ -36,7 +36,7 @@ async function loadPipelineModule (pipelinePath: string | URL): Promise<Pipeline
   }
 }
 
-async function runPipeline (webWorker: Worker | null | boolean, pipelinePath: string | URL, args: string[], outputs: PipelineOutput[] | null, inputs: PipelineInput[] | null): Promise<RunPipelineResult> {
+async function runPipeline (webWorker: Worker | null | boolean, pipelinePath: string | URL, args: string[], outputs: PipelineOutput[] | null, inputs: PipelineInput[] | null, configPropertyPipelineBaseUrl: string | URL = 'pipelinesUrl'): Promise<RunPipelineResult> {
   if (webWorker === false) {
     const pipelineModule = await loadPipelineModule(pipelinePath.toString())
     const result = runPipelineEmscripten(pipelineModule, args, outputs, inputs)
@@ -137,6 +137,7 @@ async function runPipeline (webWorker: Worker | null | boolean, pipelinePath: st
       operation: 'runPipeline',
       config: config,
       pipelinePath: pipelinePath.toString(),
+      configPropertyPipelineBaseUrl,
       args,
       outputs,
       inputs

src/update-versions.cjs

@@ -22,5 +22,6 @@ function rewriteVersion(filename) {
   fs.writeFileSync(filename, lines.join('\n'))
 }
 
-rewriteVersion('dist/core/index.js')
+rewriteVersion('src/core/version.ts')
+rewriteVersion('dist/core/version.js')
 rewriteVersion('dist/itkConfigDevelopment.js')

src/web-workers/ITKConfig.ts

@@ -4,6 +4,8 @@ interface ITKConfig {
   pipelinesUrl: string
   imageIOUrl: string
   meshIOUrl: string
+
+  [key: string]: string | undefined
 }
 
 export default ITKConfig

src/web-workers/RunPipelineInput.ts

@@ -4,6 +4,7 @@ import WebWorkerInput from './WebWorkerInput.js'
 
 interface RunPipelineInput extends WebWorkerInput {
   pipelinePath: string | object
+  configPropertyPipelineBaseUrl: string,
   args: string[]
   outputs: PipelineOutput[]
   inputs: PipelineInput[]