FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

feat: expose input source map for webpack-like bundlers (#562) · unjs/unplugin@a8975f7 · GitHub

/ unplugin Public

Commit a8975f7

Browse files
sethfowler-datadog
authored
feat: expose input source map for webpack-like bundlers (#562)
1 parent c1cf221 commit a8975f7

9 files changed

Lines changed: 117 additions & 18 deletions

File tree

‎src/rspack/context.ts‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,15 @@ import { Buffer } from 'node:buffer'
44
import { resolve } from 'node:path'
55
import { parse } from '../utils/parse'
66

7-
export function createBuildContext(compiler: Compiler, compilation: Compilation, loaderContext?: LoaderContext): UnpluginBuildContext {
7+
export function createBuildContext(compiler: Compiler, compilation: Compilation, loaderContext?: LoaderContext, inputSourceMap?: any): UnpluginBuildContext {
88
return {
99
getNativeBuildContext() {
1010
return {
1111
framework: 'rspack',
1212
compiler,
1313
compilation,
1414
loaderContext,
15+
inputSourceMap,
1516
}
1617
},
1718
addWatchFile(file) {

‎src/rspack/loaders/transform.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ export default async function transform(
2323
const res = await handler.call(
2424
Object.assign(
2525
{},
26-
this._compilation && createBuildContext(this._compiler, this._compilation, this),
26+
this._compilation && createBuildContext(this._compiler, this._compilation, this, map),
2727
context,
2828
),
2929
source,

‎src/types.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,9 +50,9 @@ export type TransformResult = string | { code: string, map?: SourceMapInput | So
5050
export interface ExternalIdResult { id: string, external?: boolean | undefined }
5151

5252
export type NativeBuildContext
53-
= { framework: 'webpack', compiler: WebpackCompiler, compilation?: WebpackCompilation | undefined, loaderContext?: WebpackLoaderContext<{ unpluginName: string }> | undefined }
53+
= { framework: 'webpack', compiler: WebpackCompiler, compilation?: WebpackCompilation | undefined, loaderContext?: WebpackLoaderContext<{ unpluginName: string }> | undefined, inputSourceMap?: any }
5454
| { framework: 'esbuild', build: PluginBuild }
55-
| { framework: 'rspack', compiler: RspackCompiler, compilation: RspackCompilation, loaderContext?: RspackLoaderContext | undefined }
55+
| { framework: 'rspack', compiler: RspackCompiler, compilation: RspackCompilation, loaderContext?: RspackLoaderContext | undefined, inputSourceMap?: any }
5656
| { framework: 'farm', context: FarmCompilationContext }
5757
| { framework: 'bun', build: BunPluginBuilder }
5858

‎src/webpack/context.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ export function getSource(fileSource: string | Uint8Array): sources.RawSource {
3030
)
3131
}
3232

33-
export function createBuildContext(options: ContextOptions, compiler: Compiler, compilation?: Compilation, loaderContext?: LoaderContext<{ unpluginName: string }>): UnpluginBuildContext {
33+
export function createBuildContext(options: ContextOptions, compiler: Compiler, compilation?: Compilation, loaderContext?: LoaderContext<{ unpluginName: string }>, inputSourceMap?: any): UnpluginBuildContext {
3434
return {
3535
parse,
3636
addWatchFile(id) {
@@ -51,7 +51,7 @@ export function createBuildContext(options: ContextOptions, compiler: Compiler,
5151
return options.getWatchFiles()
5252
},
5353
getNativeBuildContext() {
54-
return { framework: 'webpack', compiler, compilation, loaderContext }
54+
return { framework: 'webpack', compiler, compilation, loaderContext, inputSourceMap }
5555
},
5656
}
5757
}

‎src/webpack/loaders/transform.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ export default async function transform(this: LoaderContext<any>, source: string
2424
getWatchFiles: () => {
2525
return this.getDependencies()
2626
},
27-
}, this._compiler!, this._compilation, this), context),
27+
}, this._compiler!, this._compilation, this, map), context),
2828
source,
2929
this.resource,
3030
)

‎test/unit-tests/rspack/context.test.ts‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,16 @@ describe('createBuildContext', () => {
77
const compiler = { name: 'testCompiler' }
88
const compilation = { name: 'testCompilation' }
99
const loaderContext = { name: 'testLoaderContext' }
10+
const inputSourceMap = { name: 'inputSourceMap' }
1011

11-
const buildContext = createBuildContext(compiler as any, compilation as any, loaderContext as any)
12+
const buildContext = createBuildContext(compiler as any, compilation as any, loaderContext as any, inputSourceMap as any)
1213

1314
expect(buildContext.getNativeBuildContext!()).toEqual({
1415
framework: 'rspack',
1516
compiler,
1617
compilation,
1718
loaderContext,
19+
inputSourceMap,
1820
})
1921
})
2022

‎test/unit-tests/rspack/loaders/transform.test.ts‎

Lines changed: 47 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
import { describe, expect, it, vi } from 'vitest'
1+
import type { NativeBuildContext, UnpluginBuildContext } from '../../../../src/types'
2+
import { assert, describe, expect, it, vi } from 'vitest'
23
import transform from '../../../../src/rspack/loaders/transform'
34

45
describe('transform', () => {
@@ -35,10 +36,6 @@ describe('transform', () => {
3536
const source = 'test source'
3637
const map = 'test map'
3738

38-
vi.mock('../../../../src/utils/filter', () => ({
39-
normalizeObjectHook: vi.fn(() => ({ handler: vi.fn().mockRejectedValue(new Error('Handler error')), filter: vi.fn().mockReturnValue(true) })),
40-
}))
41-
4239
await transform.call(mockLoaderContext, source, map)
4340

4441
expect(mockCallback).toHaveBeenCalledWith(expect.any(Error))
@@ -63,13 +60,54 @@ describe('transform', () => {
6360
const source = 'test source'
6461
const map = 'test map'
6562

66-
vi.mock('../../../../src/utils/filter', () => ({
67-
normalizeObjectHook: vi.fn(() => ({ handler: vi.fn().mockRejectedValue(new Error('Handler error')), filter: vi.fn().mockReturnValue(true) })),
68-
}))
69-
7063
await transform.call(mockLoaderContext, source, map)
7164

7265
expect(mockCallback).toHaveBeenCalledWith(expect.any(Error))
7366
expect(mockCallback.mock.calls[0][0].message).toBe('Handler error')
7467
})
68+
69+
it('should include input source map on native build context', async () => {
70+
const source = 'source code'
71+
const map = 'source map'
72+
const transformedCode = 'transformed code'
73+
const transformedMap = 'transformed map'
74+
75+
let handlerSource: string | undefined
76+
let handlerId: string | undefined
77+
let handlerNativeBuildContext: NativeBuildContext | undefined
78+
const handlerMock = vi.fn().mockImplementation(function (this: UnpluginBuildContext, source: string, id: string) {
79+
handlerSource = source
80+
handlerId = id
81+
handlerNativeBuildContext = this.getNativeBuildContext?.()
82+
return { code: transformedCode, map: transformedMap }
83+
})
84+
85+
const mockCallback = vi.fn()
86+
const mockLoaderContext = {
87+
async: () => mockCallback,
88+
query: {
89+
plugin: {
90+
transform: {
91+
handler: handlerMock,
92+
filter: vi.fn().mockReturnValue(true),
93+
},
94+
},
95+
},
96+
resource: 'test resource',
97+
addDependency: vi.fn(),
98+
getDependencies: vi.fn().mockReturnValue(['/path/to/dependency']),
99+
_compiler: {},
100+
_compilation: {},
101+
} as any
102+
103+
await transform.call(mockLoaderContext as any, source, map)
104+
105+
expect(handlerMock).toHaveBeenCalled()
106+
expect(handlerSource).toBe(source)
107+
expect(handlerId).toBe(mockLoaderContext.resource)
108+
assert(handlerNativeBuildContext?.framework === 'rspack')
109+
expect(handlerNativeBuildContext?.inputSourceMap).toBe(map)
110+
111+
expect(mockCallback).toHaveBeenCalledWith(null, transformedCode, transformedMap)
112+
})
75113
})

‎test/unit-tests/webpack/context.test.ts‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,27 @@ describe('webpack - utils', () => {
4646
expect.anything(),
4747
)
4848
})
49+
50+
it('should add expected values to native build context', () => {
51+
const options = {
52+
addWatchFile: vi.fn(),
53+
getWatchFiles: vi.fn(() => ['file1.js']),
54+
}
55+
const compiler = { name: 'testCompiler' } as Compiler
56+
const compilation = { name: 'testCompilation' } as Compilation
57+
const loaderContext = { name: 'testLoaderContext' } as unknown as LoaderContext<{ unpluginName: string }>
58+
const inputSourceMap = { name: 'inputSourceMap' }
59+
60+
const buildContext = createBuildContext(options, compiler, compilation, loaderContext, inputSourceMap)
61+
62+
expect(buildContext.getNativeBuildContext!()).toEqual({
63+
framework: 'webpack',
64+
compiler,
65+
compilation,
66+
loaderContext,
67+
inputSourceMap,
68+
})
69+
})
4970
})
5071

5172
describe('createContext', () => {

‎test/unit-tests/webpack/loaders/transform.test.ts‎

Lines changed: 38 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
import { describe, expect, it, vi } from 'vitest'
1+
import type { NativeBuildContext, UnpluginBuildContext } from '../../../../src/types'
2+
import { assert, describe, expect, it, vi } from 'vitest'
23
import transform from '../../../../src/webpack/loaders/transform'
34

45
describe('transform loader', () => {
@@ -104,4 +105,40 @@ describe('transform loader', () => {
104105
expect(handlerMock).toHaveBeenCalled()
105106
expect(mockCallback).toHaveBeenCalledWith(error)
106107
})
108+
109+
it('should include input source map on native build context', async () => {
110+
const source = 'source code'
111+
const map = 'source map'
112+
const transformedCode = 'transformed code'
113+
const transformedMap = 'transformed map'
114+
115+
let handlerSource: string | undefined
116+
let handlerId: string | undefined
117+
let handlerNativeBuildContext: NativeBuildContext | undefined
118+
const handlerMock = vi.fn().mockImplementation(function (this: UnpluginBuildContext, source: string, id: string) {
119+
handlerSource = source
120+
handlerId = id
121+
handlerNativeBuildContext = this.getNativeBuildContext?.()
122+
return { code: transformedCode, map: transformedMap }
123+
})
124+
125+
mockLoaderContext.query = {
126+
plugin: {
127+
transform: {
128+
handler: handlerMock,
129+
filter: vi.fn().mockReturnValue(true),
130+
},
131+
},
132+
}
133+
134+
await transform.call(mockLoaderContext as any, source, map)
135+
136+
expect(handlerMock).toHaveBeenCalled()
137+
expect(handlerSource).toBe(source)
138+
expect(handlerId).toBe(mockLoaderContext.resource)
139+
assert(handlerNativeBuildContext?.framework === 'webpack')
140+
expect(handlerNativeBuildContext?.inputSourceMap).toBe(map)
141+
142+
expect(mockCallback).toHaveBeenCalledWith(null, transformedCode, transformedMap)
143+
})
107144
})

0 commit comments

Comments
 (0)
Back | FazBrowse Home | New Git URL