-
-
Notifications
You must be signed in to change notification settings - Fork 251
Enhance TransformContext typing with conditional types for better type safety #6017
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
Draft
Copilot
wants to merge
4
commits into
main
Choose a base branch
from
copilot/fix-3c5e5cac-aeb5-4423-8dfd-6294da3b4e7d
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,115 @@ | ||
import { createStubRsbuild } from '@scripts/test-helper'; | ||
|
||
describe('transform raw loader', () => { | ||
it('should handle Buffer input correctly for raw transforms', async () => { | ||
// This test verifies the typing works correctly | ||
const rsbuild = await createStubRsbuild({ | ||
plugins: [ | ||
{ | ||
name: 'test-raw-transform', | ||
setup(api) { | ||
api.transform({ test: /\.node$/, raw: true }, ({ code }) => { | ||
// The key test is that TypeScript allows this code to compile | ||
// when TransformContext.code is typed as string | Buffer | ||
const isBuffer = Buffer.isBuffer(code); | ||
const isString = typeof code === 'string'; | ||
|
||
// This should work with both Buffer and string | ||
return `export default "transformed-${isBuffer ? 'buffer' : isString ? 'string' : 'unknown'}";`; | ||
}); | ||
}, | ||
}, | ||
], | ||
rsbuildConfig: { | ||
output: { | ||
target: 'node', | ||
}, | ||
}, | ||
}); | ||
|
||
const config = await rsbuild.unwrapConfig(); | ||
|
||
// Verify that the raw loader is being used | ||
const rules = config.module?.rules || []; | ||
const nodeRule = rules.find((rule: any) => | ||
rule.test?.toString().includes('\\.node'), | ||
); | ||
|
||
expect(nodeRule).toBeDefined(); | ||
expect(nodeRule.use[0].loader).toContain('transformRawLoader'); | ||
}); | ||
|
||
it('should handle string input correctly for non-raw transforms', async () => { | ||
// This test verifies that the typing works for non-raw transforms too | ||
const rsbuild = await createStubRsbuild({ | ||
plugins: [ | ||
{ | ||
name: 'test-string-transform', | ||
setup(api) { | ||
api.transform({ test: /\.test\.js$/ }, ({ code }) => { | ||
// The key test is that TypeScript allows this code to compile | ||
// when TransformContext.code is typed as string | Buffer | ||
const isBuffer = Buffer.isBuffer(code); | ||
const isString = typeof code === 'string'; | ||
|
||
return `export default "transformed-${isString ? 'string' : isBuffer ? 'buffer' : 'unknown'}";`; | ||
}); | ||
}, | ||
}, | ||
], | ||
}); | ||
|
||
const config = await rsbuild.unwrapConfig(); | ||
|
||
// Verify that the regular loader is being used (not raw) | ||
const rules = config.module?.rules || []; | ||
const testRule = rules.find((rule: any) => | ||
rule.test?.toString().includes('\\.test\\.js'), | ||
); | ||
|
||
expect(testRule).toBeDefined(); | ||
expect(testRule.use[0].loader).toContain('transformLoader'); | ||
expect(testRule.use[0].loader).not.toContain('transformRawLoader'); | ||
}); | ||
|
||
it('should allow the nodeAddons plugin pattern to work with Buffer', () => { | ||
// This test specifically validates the use case from the nodeAddons plugin | ||
// where raw transforms expect Buffer input | ||
const mockCode = Buffer.from('test binary data'); | ||
const emitFileCalls: Array<{ name: string; content: Buffer }> = []; | ||
|
||
// Simulate the transform handler from nodeAddons plugin | ||
const transformHandler = ({ | ||
code, | ||
emitFile, | ||
}: { | ||
code: string | Buffer; | ||
emitFile: (name: string, content: Buffer) => void; | ||
}) => { | ||
// This should work without type errors now that code can be Buffer | ||
emitFile('test.node', code as Buffer); | ||
|
||
return ` | ||
try { | ||
const path = require("path"); | ||
process.dlopen(module, path.join(__dirname, "test.node")); | ||
} catch (error) { | ||
throw new Error('Failed to load Node.js addon: "test.node"\\n' + error); | ||
} | ||
`; | ||
}; | ||
|
||
// This should not throw TypeScript errors | ||
const result = transformHandler({ | ||
code: mockCode, | ||
emitFile: (name, content) => { | ||
emitFileCalls.push({ name, content }); | ||
}, | ||
}); | ||
|
||
expect(emitFileCalls).toHaveLength(1); | ||
expect(emitFileCalls[0].name).toBe('test.node'); | ||
expect(emitFileCalls[0].content).toBe(mockCode); | ||
expect(result).toContain('process.dlopen'); | ||
}); | ||
}); |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@copilot can we ensure that
code
isstring
whenraw
option is not used?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
✅ Implemented conditional typing for TransformContext! Now
code
is properly typed asstring
whenraw
is not used andBuffer
whenraw: true
.The typing now provides:
TransformContext<true>
→code: Buffer
(raw transforms)TransformContext<false>
→code: string
(non-raw transforms)TransformContext
(default) →code: string
(backward compatible)This ensures type safety and eliminates the need for runtime type checking in transform handlers. Fixed in commit 79fbde4.