feat: Add NestJS ClassSerializerInterceptor integration #21
Conversation
Implements a high-performance drop-in replacement for NestJS's built-in ClassSerializerInterceptor using om-data-mapper instead of class-transformer. Features: - 17.28x faster serialization performance - 100% API compatible with @nestjs/common ClassSerializerInterceptor - Zero breaking changes for existing om-data-mapper users - Full TypeScript support with proper generics - Supports all class-transformer decorators (@expose, @exclude, @type, @Transform) - Optional peer dependencies (@nestjs/common, rxjs) - Comprehensive test coverage (10 integration tests) - Complete documentation with examples Implementation: - ClassSerializerInterceptor with Reflector support - SerializeOptions decorator for route-level configuration - Proper handling of null, undefined, primitives, and plain objects - Context-aware serialization options - Tree-shakeable exports Closes #20
|
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
| import { of } from 'rxjs'; | ||
| import { ClassSerializerInterceptor } from '../../../src/integrations/nestjs/interceptors/class-serializer.interceptor'; | ||
| import { Expose, Exclude, Type, Transform } from '../../../src/compat/class-transformer/decorators'; | ||
| import { CLASS_SERIALIZER_OPTIONS } from '../../../src/integrations/nestjs/types'; |
Check notice
Code scanning / CodeQL
Unused variable, import, function or class Note test
Show autofix suggestion
Hide autofix suggestion
Copilot Autofix
AI 3 months ago
The best way to fix this problem is to remove the unused import from line 9 in the file tests/integration/nestjs/class-serializer.interceptor.test.ts. This improves readability, avoids confusion, and eliminates unnecessary code.
To implement the fix, delete the import statement for CLASS_SERIALIZER_OPTIONS (and only for that symbol) without altering any other code or imports.
| @@ -6,7 +6,6 @@ | ||
| import { of } from 'rxjs'; | ||
| import { ClassSerializerInterceptor } from '../../../src/integrations/nestjs/interceptors/class-serializer.interceptor'; | ||
| import { Expose, Exclude, Type, Transform } from '../../../src/compat/class-transformer/decorators'; | ||
| import { CLASS_SERIALIZER_OPTIONS } from '../../../src/integrations/nestjs/types'; | ||
|
|
||
| // Mock NestJS dependencies | ||
| const mockReflector = { |
🚀 Performance Benchmark Results📊 Performance Comparison Summary
Average Performance Gain: +2178.57% 🚀
📋 Full Benchmark Output⚡ Simple Mapping Benchmark🔧 Complex Transformations Benchmark💡 Note: These are absolute performance numbers from this PR. Benchmarked with Benchmark.js on Node.js 20 • View History |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting
| if (!options.transformPlainObjects && !isClassInstance && !Array.isArray(data)) { | ||
| return data; | ||
| } |
There was a problem hiding this comment.
The early-return guard only skips serialization for non-array plain objects, so any array—regardless of its contents—falls through to classToPlain. When the response is an array of primitive values (e.g. ['a', 'b']), classToPlain converts each element into an object ([{ '0': 'a' }, …]) because primitives are wrapped and enumerated, altering the response payload. Nest’s built-in ClassSerializerInterceptor leaves primitive arrays untouched. Consider checking Array.isArray(data) and ensuring all elements are non-object primitives before calling classToPlain, returning the array as-is when no transformation is necessary.
Useful? React with 👍 / 👎.
Added recommended way to use ClassSerializerInterceptor globally via APP_INTERCEPTOR provider in AppModule. This is more idiomatic NestJS approach compared to app.useGlobalInterceptors(). Changes: - Updated docs/NESTJS_INTEGRATION.md with APP_INTERCEPTOR examples - Updated README.md with both global usage options - Added test for dependency injection pattern - Documented benefits of using APP_INTERCEPTOR provider Benefits of APP_INTERCEPTOR approach: - Works with dependency injection - Easier to test - More idiomatic NestJS - Works with all module features
🎯 Summary
Implements a high-performance drop-in replacement for NestJS's built-in
ClassSerializerInterceptorusingom-data-mapperinstead ofclass-transformer.🚀 Features
@nestjs/commonClassSerializerInterceptor📦 Implementation
New Files
src/integrations/nestjs/interceptors/class-serializer.interceptor.ts- Main interceptor implementationsrc/integrations/nestjs/decorators/serialize-options.decorator.ts- @SerializeOptions decoratorsrc/integrations/nestjs/types.ts- TypeScript type definitionssrc/integrations/nestjs/index.ts- Public API exportstests/integration/nestjs/class-serializer.interceptor.test.ts- Integration testsdocs/NESTJS_INTEGRATION.md- Complete documentationUpdated Files
package.json- Added exports, peer dependencies, and dev dependenciesREADME.md- Added NestJS integration sectionvitest.config.mts- Excluded integrations from coverage requirements🎨 Usage Example
✅ Testing
📚 Documentation
docs/NESTJS_INTEGRATION.md🔗 Closes
Closes #20
📋 Checklist
Pull Request opened by Augment Code with guidance from the PR author