Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(worker): Add sourcemap support for worker bundles #7496

Closed
wants to merge 10 commits into from
@@ -0,0 +1,60 @@
import fs from 'fs'
import path from 'path'
import { untilUpdated, isBuild, testDir } from '../../../testUtils'
import type { Page } from 'playwright-chromium'

if (isBuild) {
// assert correct files
test('sourcemap generation for web workers', async () => {
const assetsDir = path.resolve(testDir, 'dist/es-sourcemap/assets')
const files = fs.readdirSync(assetsDir)
const index = files.find((f) => /^main-module\.\w+\.js$/.test(f))
const content = fs.readFileSync(path.resolve(assetsDir, index), 'utf-8')
const indexSourcemap = getSourceMapUrl(content)

const worker = files.find((f) => /^my-worker\.\w+\.js$/.test(f))
const workerContent = fs.readFileSync(
path.resolve(assetsDir, worker),
'utf-8'
)
const workerSourcemap = getSourceMapUrl(workerContent)

const sharedWorker = files.find((f) =>
/^my-shared-worker\.\w+\.js$/.test(f)
)
const sharedWorkerContent = fs.readFileSync(
path.resolve(assetsDir, sharedWorker),
'utf-8'
)
const sharedWorkerSourcemap = getSourceMapUrl(sharedWorkerContent)

expect(files).toContainEqual(
expect.stringMatching(/^main-module\.\w+\.js\.map$/)
)
expect(files).toContainEqual(
expect.stringMatching(/^my-worker\.\w+\.js\.map$/)
)
expect(files).toContainEqual(
expect.stringMatching(/^my-shared-worker\.\w+\.js\.map$/)
)

// sourcemap should exist and have a data URL
expect(indexSourcemap).toMatch(/^main-module\.\w+\.js\.map$/)
expect(workerSourcemap).toMatch(/^my-worker\.\w+\.js\.map$/)
expect(sharedWorkerSourcemap).toMatch(/^my-shared-worker\.\w+\.js\.map$/)
})
}

test('true', () => {
expect(true).toBe(true)
})

function getSourceMapUrl(code: string): string {
const regex = /\/\/[#@]\s(?:source(?:Mapping)?URL)=\s*(\S+)/g
const results = regex.exec(code)

if (results && results.length >= 2) {
return results[1]
}
return null
}
@@ -0,0 +1 @@
module.exports = require('../../config/vite.config.es.sourcemap')
2 changes: 1 addition & 1 deletion packages/playground/worker/__tests__/es/vite.config.js
@@ -1 +1 @@
module.exports = require('../../vite.config-es')
module.exports = require('../../config/vite.config.es')
1 change: 1 addition & 0 deletions packages/playground/worker/__tests__/iife/vite.config.js
@@ -0,0 +1 @@
module.exports = require('../../config/vite.config.iife')
@@ -1,6 +1,6 @@
import fs from 'fs'
import path from 'path'
import { untilUpdated, isBuild, testDir } from '../../testUtils'
import { untilUpdated, isBuild, testDir } from '../../../testUtils'
import type { Page } from 'playwright-chromium'

test('normal', async () => {
Expand Down
@@ -0,0 +1,65 @@
import fs from 'fs'
import path from 'path'
import { untilUpdated, isBuild, testDir } from '../../../testUtils'
import { Page } from 'playwright-chromium'

// Workaround so that testing serve does not emit
// "Your test suite must contain at least one test"
test('true', () => {
expect(true).toBe(true)
})

if (isBuild) {
// assert correct files
test('hidden sourcemap generation for web workers', async () => {
const assetsDir = path.resolve(testDir, 'dist/iife-sourcemap-hidden/assets')
const files = fs.readdirSync(assetsDir)

const index = files.find((f) => /^main-classic\.\w+\.js$/.test(f))
const content = fs.readFileSync(path.resolve(assetsDir, index), 'utf-8')
const indexSourcemap = getSourceMapUrl(content)

const worker = files.find((f) => /^my-worker\.\w+\.js$/.test(f))
const workerContent = fs.readFileSync(
path.resolve(assetsDir, worker),
'utf-8'
)
const workerSourcemap = getSourceMapUrl(workerContent)

const sharedWorker = files.find((f) =>
/^my-shared-worker\.\w+\.js$/.test(f)
)
const sharedWorkerContent = fs.readFileSync(
path.resolve(assetsDir, sharedWorker),
'utf-8'
)
const sharedWorkerSourcemap = getSourceMapUrl(sharedWorkerContent)

expect(files).toContainEqual(expect.stringMatching(/^index\.\w+\.js\.map$/))
expect(files).toContainEqual(
expect.stringMatching(/^my-worker\.\w+\.js\.map$/)
)
expect(files).toContainEqual(
expect.stringMatching(/^my-shared-worker\.\w+\.js\.map$/)
)

// sourcemap should exist and have a data URL
expect(indexSourcemap).toBe(null)
expect(workerSourcemap).toBe(null)
expect(sharedWorkerSourcemap).toBe(null)
})
}

test('true', () => {
expect(true).toBe(true)
})

function getSourceMapUrl(code: string): string {
const regex = /\/\/[#@]\s(?:source(?:Mapping)?URL)=\s*(\S+)/g
const results = regex.exec(code)

if (results && results.length >= 2) {
return results[1]
}
return null
}
@@ -0,0 +1 @@
module.exports = require('../../config/vite.config.iife.sourcemap-hidden')
@@ -0,0 +1,47 @@
import fs from 'fs'
import path from 'path'
import { untilUpdated, isBuild, testDir } from '../../../testUtils'
import { Page } from 'playwright-chromium'

if (isBuild) {
// assert correct files
test('inlined sourcemap generation for web workers', async () => {
const assetsDir = path.resolve(testDir, 'dist/iife-sourcemap-inline/assets')
const files = fs.readdirSync(assetsDir)
const index = files.find((f) => f.includes('main-classic'))
const content = fs.readFileSync(path.resolve(assetsDir, index), 'utf-8')
const indexSourcemap = getSourceMapUrl(content)

const worker = files.find((f) => f.includes('my-worker'))
const workerContent = fs.readFileSync(
path.resolve(assetsDir, worker),
'utf-8'
)
const workerSourcemap = getSourceMapUrl(workerContent)
const sharedWorker = files.find((f) => f.includes('my-shared-worker'))
const sharedWorkerContent = fs.readFileSync(
path.resolve(assetsDir, sharedWorker),
'utf-8'
)
const sharedWorkerSourcemap = getSourceMapUrl(sharedWorkerContent)

// sourcemap should exist and have a data URL
expect(indexSourcemap).toMatch(/^data:application\/json;/)
expect(workerSourcemap).toMatch(/^data:application\/json;/)
expect(sharedWorkerSourcemap).toMatch(/^data:application\/json;/)
})
}

test('true', () => {
expect(true).toBe(true)
})

function getSourceMapUrl(code: string): string {
const regex = /\/\/[#@]\s(?:source(?:Mapping)?URL)=\s*(\S+)/g
const results = regex.exec(code)

if (results && results.length >= 2) {
return results[1]
}
return null
}
@@ -0,0 +1 @@
module.exports = require('../../config/vite.config.iife.sourcemap-inline')
60 changes: 60 additions & 0 deletions packages/playground/worker/__tests__/sourcemap/sourcemap.spec.ts
@@ -0,0 +1,60 @@
import fs from 'fs'
import path from 'path'
import { untilUpdated, isBuild, testDir } from '../../../testUtils'
import { Page } from 'playwright-chromium'

if (isBuild) {
// assert correct files
test('sourcemap generation for web workers', async () => {
const assetsDir = path.resolve(testDir, 'dist/iife-sourcemap/assets')
const files = fs.readdirSync(assetsDir)
const index = files.find((f) => /^main-classic\.\w+\.js$/.test(f))
const content = fs.readFileSync(path.resolve(assetsDir, index), 'utf-8')
const indexSourcemap = getSourceMapUrl(content)

const worker = files.find((f) => /^my-worker\.\w+\.js$/.test(f))
const workerContent = fs.readFileSync(
path.resolve(assetsDir, worker),
'utf-8'
)
const workerSourcemap = getSourceMapUrl(workerContent)

const sharedWorker = files.find((f) =>
/^my-shared-worker\.\w+\.js$/.test(f)
)
const sharedWorkerContent = fs.readFileSync(
path.resolve(assetsDir, sharedWorker),
'utf-8'
)
const sharedWorkerSourcemap = getSourceMapUrl(sharedWorkerContent)

expect(files).toContainEqual(
expect.stringMatching(/^main-classic\.\w+\.js\.map$/)
)
expect(files).toContainEqual(
expect.stringMatching(/^my-worker\.\w+\.js\.map$/)
)
expect(files).toContainEqual(
expect.stringMatching(/^my-shared-worker\.\w+\.js\.map$/)
)

// sourcemap should exist and have a data URL
expect(indexSourcemap).toMatch(/^main-classic\.\w+\.js\.map$/)
expect(workerSourcemap).toMatch(/^my-worker\.\w+\.js\.map$/)
expect(sharedWorkerSourcemap).toMatch(/^my-shared-worker\.\w+\.js\.map$/)
})
}

test('true', () => {
expect(true).toBe(true)
})

function getSourceMapUrl(code: string): string {
const regex = /\/\/[#@]\s(?:source(?:Mapping)?URL)=\s*(\S+)/g
const results = regex.exec(code)

if (results && results.length >= 2) {
return results[1]
}
return null
}
@@ -0,0 +1 @@
module.exports = require('../../config/vite.config.iife.sourcemap')
14 changes: 14 additions & 0 deletions packages/playground/worker/config/vite.config.es.sourcemap.js
@@ -0,0 +1,14 @@
const vueJsx = require('@vitejs/plugin-vue-jsx')
const vite = require('vite')

module.exports = vite.defineConfig({
base: '/es-sourcemap/',
worker: {
format: 'es',
plugins: [vueJsx()]
},
build: {
outDir: 'dist/es-sourcemap/',
sourcemap: true
}
})
@@ -0,0 +1,14 @@
const vueJsx = require('@vitejs/plugin-vue-jsx')
const vite = require('vite')

module.exports = vite.defineConfig({
base: '/iife-sourcemap-hidden/',
worker: {
format: 'iife',
plugins: [vueJsx()]
},
build: {
outDir: 'dist/iife-sourcemap-hidden',
sourcemap: 'hidden'
}
})
@@ -0,0 +1,14 @@
const vueJsx = require('@vitejs/plugin-vue-jsx')
const vite = require('vite')

module.exports = vite.defineConfig({
base: '/iife-sourcemap-inline/',
worker: {
format: 'iife',
plugins: [vueJsx()]
},
build: {
outDir: 'dist/iife-sourcemap-inline',
sourcemap: 'inline'
}
})
14 changes: 14 additions & 0 deletions packages/playground/worker/config/vite.config.iife.sourcemap.js
@@ -0,0 +1,14 @@
const vueJsx = require('@vitejs/plugin-vue-jsx')
const vite = require('vite')

module.exports = vite.defineConfig({
base: '/iife-sourcemap/',
worker: {
format: 'iife',
plugins: [vueJsx()]
},
build: {
outDir: 'dist/iife-sourcemap/',
sourcemap: true
}
})
2 changes: 2 additions & 0 deletions packages/playground/worker/my-shared-worker.ts
Expand Up @@ -14,3 +14,5 @@ onconnect = (event) => {
}
}
}

console.log('my-shared-worker')
2 changes: 2 additions & 0 deletions packages/playground/worker/my-worker.ts
Expand Up @@ -6,3 +6,5 @@ self.onmessage = (e) => {
self.postMessage({ msg, mode, bundleWithPlugin })
}
}

console.log('my-worker: inline-worker')
26 changes: 19 additions & 7 deletions packages/playground/worker/package.json
Expand Up @@ -3,13 +3,25 @@
"private": true,
"version": "0.0.0",
"scripts": {
"dev": "vite",
"build": "vite build",
"preview": "vite preview",
"dev:es": "vite --config ./vite.config-es.js dev",
"build:es": "vite --config ./vite.config-es.js build",
"preview:es": "vite --config ./vite.config-es.js preview",
"debug": "node --inspect-brk ../../vite/bin/vite"
"debug": "node --inspect-brk ../../vite/bin/vite",
"dev": "vite --config ./config/vite.config.iife.js dev",
"build": "vite --config ./config/vite.config.iife.js build",
"preview": "vite --config ./config/vite.config.iife.js preview",
"dev:sourcemap": "vite --config ./config/vite.config.iife.sourcemap.js dev",
"build:sourcemap": "vite --config ./config/vite.config.iife.sourcemap.js build",
"preview:sourcemap": "vite --config ./config/vite.config.iife.sourcemap.js preview",
"dev:sourcemap-inline": "vite --config ./config/vite.config.iife.sourcemap-inline.js dev",
"build:sourcemap-inline": "vite --config ./config/vite.config.iife.sourcemap-inline.js build",
"preview:sourcemap-inline": "vite --config ./config/vite.config.iife.sourcemap-inline.js preview",
"dev:sourcemap-hidden": "vite --config ./config/vite.config.iife.sourcemap-hidden.js dev",
"build:sourcemap-hidden": "vite --config ./config/vite.config.iife.sourcemap-hidden.js build",
"preview:sourcemap-hidden": "vite --config ./config/vite.config.iife.sourcemap-hidden.js preview",
"dev:es": "vite --config ./config/vite.config.es.js dev",
"build:es": "vite --config ./config/vite.config.es.js build",
"preview:es": "vite --config ./config/vite.config.es.js preview",
"dev:es-sourcemap": "vite --config ./config/vite.config.es.sourcemap.js dev",
"build:es-sourcemap": "vite --config ./config/vite.config.es.sourcemap.js build",
"preview:es-sourcemap": "vite --config ./config/vite.config.es.sourcemap.js preview"
},
"devDependencies": {
"@vitejs/plugin-vue-jsx": "workspace:*"
Expand Down
2 changes: 2 additions & 0 deletions packages/playground/worker/worker/main-classic.js
Expand Up @@ -26,3 +26,5 @@ classicSharedWorker.port.addEventListener('message', (ev) => {
text('.classic-shared-worker', JSON.stringify(ev.data))
})
classicSharedWorker.port.start()

console.log('main-classic')
2 changes: 2 additions & 0 deletions packages/playground/worker/worker/main-module.js
Expand Up @@ -51,6 +51,8 @@ document.querySelector('.ping-ts-output').addEventListener('click', () => {
tsOutputWorker.postMessage('ping')
})

console.log('main-module')

const nestedWorker = new NestedWorker()
nestedWorker.addEventListener('message', (ev) => {
if (typeof ev.data === 'string') {
Expand Down