@noony-serverless/core 0.4.1 → 0.4.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/core/handler.d.ts +1 -1
- package/build/core/handler.js +12 -2
- package/build/middlewares/bodyValidationMiddleware.js +57 -9
- package/build/middlewares/responseWrapperMiddleware.d.ts +3 -1
- package/build/middlewares/responseWrapperMiddleware.js +10 -5
- package/build/utils/fastify-wrapper.d.ts +1 -70
- package/build/utils/fastify-wrapper.js +54 -18
- package/package.json +1 -1
package/build/core/handler.d.ts
CHANGED
|
@@ -46,7 +46,7 @@ export declare class Handler<T = unknown, U = unknown> {
|
|
|
46
46
|
private middlewaresPrecomputed;
|
|
47
47
|
static use<T = unknown, U = unknown>(middleware: BaseMiddleware<T, U>): Handler<T, U>;
|
|
48
48
|
use<NewT = T, NewU = U>(middleware: BaseMiddleware<NewT, NewU>): Handler<NewT, NewU>;
|
|
49
|
-
handle(handler: (context: Context<T, U>) => Promise<void>): Handler<T, U>;
|
|
49
|
+
handle(handler: (context: Context<T, U>) => Promise<void | unknown>): Handler<T, U>;
|
|
50
50
|
/**
|
|
51
51
|
* Performance optimization: Pre-compute middleware arrays to avoid runtime array operations
|
|
52
52
|
*/
|
package/build/core/handler.js
CHANGED
|
@@ -74,7 +74,12 @@ class Handler {
|
|
|
74
74
|
try {
|
|
75
75
|
// Execute before middlewares with performance optimizations
|
|
76
76
|
await this.executeBeforeMiddlewares(context);
|
|
77
|
-
|
|
77
|
+
// Capture return value from handler
|
|
78
|
+
const returnValue = await this.handler(context);
|
|
79
|
+
// If handler returns a value and responseData hasn't been set, use the return value
|
|
80
|
+
if (returnValue !== undefined && !context.responseData) {
|
|
81
|
+
context.responseData = returnValue;
|
|
82
|
+
}
|
|
78
83
|
// Execute after middlewares in reverse order using pre-computed array
|
|
79
84
|
await this.executeAfterMiddlewares(context);
|
|
80
85
|
}
|
|
@@ -129,7 +134,12 @@ class Handler {
|
|
|
129
134
|
try {
|
|
130
135
|
// Execute before middlewares with performance optimizations
|
|
131
136
|
await this.executeBeforeMiddlewares(context);
|
|
132
|
-
|
|
137
|
+
// Capture return value from handler
|
|
138
|
+
const returnValue = await this.handler(context);
|
|
139
|
+
// If handler returns a value and responseData hasn't been set, use the return value
|
|
140
|
+
if (returnValue !== undefined && !context.responseData) {
|
|
141
|
+
context.responseData = returnValue;
|
|
142
|
+
}
|
|
133
143
|
// Execute after middlewares in reverse order using pre-computed array
|
|
134
144
|
await this.executeAfterMiddlewares(context);
|
|
135
145
|
}
|
|
@@ -3,9 +3,26 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
3
3
|
exports.bodyValidatorMiddleware = exports.BodyValidationMiddleware = void 0;
|
|
4
4
|
const zod_1 = require("zod");
|
|
5
5
|
const errors_1 = require("../core/errors");
|
|
6
|
-
const
|
|
6
|
+
const fastify_wrapper_1 = require("../utils/fastify-wrapper");
|
|
7
|
+
// Reusable error objects for common cases (avoid allocations)
|
|
8
|
+
const VALIDATION_ERROR_INVALID_JSON = new errors_1.ValidationError('Invalid JSON in request body', [
|
|
9
|
+
{
|
|
10
|
+
code: 'custom',
|
|
11
|
+
path: [],
|
|
12
|
+
message: 'Request body must be valid JSON',
|
|
13
|
+
},
|
|
14
|
+
]);
|
|
15
|
+
const VALIDATION_ERROR_MISSING_BODY = new errors_1.ValidationError('Request body is required', [
|
|
16
|
+
{
|
|
17
|
+
code: 'custom',
|
|
18
|
+
path: [],
|
|
19
|
+
message: 'Request body is missing or empty',
|
|
20
|
+
},
|
|
21
|
+
]);
|
|
22
|
+
// Use synchronous parse for better performance (Zod's parseAsync adds overhead)
|
|
23
|
+
const validateWithZod = (schema, data) => {
|
|
7
24
|
try {
|
|
8
|
-
return
|
|
25
|
+
return schema.parse(data);
|
|
9
26
|
}
|
|
10
27
|
catch (error) {
|
|
11
28
|
if (error instanceof zod_1.z.ZodError) {
|
|
@@ -14,6 +31,36 @@ const validateBody = async (schema, data) => {
|
|
|
14
31
|
throw error;
|
|
15
32
|
}
|
|
16
33
|
};
|
|
34
|
+
/**
|
|
35
|
+
* Comprehensive body validation function that handles retrieval from multiple sources,
|
|
36
|
+
* JSON parsing, and Zod schema validation.
|
|
37
|
+
* @internal
|
|
38
|
+
*/
|
|
39
|
+
const validateBody = (schema, context) => {
|
|
40
|
+
// Try to get body from the original Fastify request via WeakMap
|
|
41
|
+
// This fixes the issue where req.body becomes undefined after Handler.executeGeneric copies properties
|
|
42
|
+
const originalReq = fastify_wrapper_1.requestBodyMap.get(context.req);
|
|
43
|
+
// Fast path: check most common case first (originalReq.body)
|
|
44
|
+
let bodyData = originalReq?.body;
|
|
45
|
+
if (!bodyData) {
|
|
46
|
+
bodyData =
|
|
47
|
+
context.req.validatedBody ?? context.req.parsedBody ?? context.req.body;
|
|
48
|
+
}
|
|
49
|
+
// If no parsed body found, try the raw body string (from Cloud Functions wrapper) and parse it
|
|
50
|
+
if (!bodyData && originalReq?.__rawBody) {
|
|
51
|
+
try {
|
|
52
|
+
bodyData = JSON.parse(originalReq.__rawBody);
|
|
53
|
+
}
|
|
54
|
+
catch {
|
|
55
|
+
throw VALIDATION_ERROR_INVALID_JSON;
|
|
56
|
+
}
|
|
57
|
+
}
|
|
58
|
+
if (!bodyData) {
|
|
59
|
+
throw VALIDATION_ERROR_MISSING_BODY;
|
|
60
|
+
}
|
|
61
|
+
// Validate with Zod schema
|
|
62
|
+
return validateWithZod(schema, bodyData);
|
|
63
|
+
};
|
|
17
64
|
/**
|
|
18
65
|
* Body validation middleware using Zod schemas for runtime type checking.
|
|
19
66
|
* Validates the parsed request body against a provided Zod schema and sets
|
|
@@ -52,7 +99,7 @@ class BodyValidationMiddleware {
|
|
|
52
99
|
this.schema = schema;
|
|
53
100
|
}
|
|
54
101
|
async before(context) {
|
|
55
|
-
context.req.validatedBody =
|
|
102
|
+
context.req.validatedBody = validateBody(this.schema, context);
|
|
56
103
|
}
|
|
57
104
|
}
|
|
58
105
|
exports.BodyValidationMiddleware = BodyValidationMiddleware;
|
|
@@ -88,11 +135,12 @@ exports.BodyValidationMiddleware = BodyValidationMiddleware;
|
|
|
88
135
|
* .handle(handleLogin);
|
|
89
136
|
* ```
|
|
90
137
|
*/
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
}
|
|
138
|
+
const bodyValidatorMiddleware = (schema) => {
|
|
139
|
+
return {
|
|
140
|
+
before: async (context) => {
|
|
141
|
+
context.req.validatedBody = validateBody(schema, context);
|
|
142
|
+
},
|
|
143
|
+
};
|
|
144
|
+
};
|
|
97
145
|
exports.bodyValidatorMiddleware = bodyValidatorMiddleware;
|
|
98
146
|
//# sourceMappingURL=bodyValidationMiddleware.js.map
|
|
@@ -63,6 +63,8 @@ import { Context } from '../core/core';
|
|
|
63
63
|
* ```
|
|
64
64
|
*/
|
|
65
65
|
export declare class ResponseWrapperMiddleware<T = unknown, TBody = unknown, TUser = unknown> implements BaseMiddleware<TBody, TUser> {
|
|
66
|
+
private defaultStatusCode?;
|
|
67
|
+
constructor(defaultStatusCode?: number | undefined);
|
|
66
68
|
after(context: Context<TBody, TUser>): Promise<void>;
|
|
67
69
|
}
|
|
68
70
|
/**
|
|
@@ -122,7 +124,7 @@ export declare class ResponseWrapperMiddleware<T = unknown, TBody = unknown, TUs
|
|
|
122
124
|
* });
|
|
123
125
|
* ```
|
|
124
126
|
*/
|
|
125
|
-
export declare const responseWrapperMiddleware: <T = unknown, TBody = unknown, TUser = unknown>() => BaseMiddleware<TBody, TUser>;
|
|
127
|
+
export declare const responseWrapperMiddleware: <T = unknown, TBody = unknown, TUser = unknown>(defaultStatusCode?: number) => BaseMiddleware<TBody, TUser>;
|
|
126
128
|
/**
|
|
127
129
|
* Helper function to set response data in context for later wrapping.
|
|
128
130
|
* This function should be used in handlers when using ResponseWrapperMiddleware.
|
|
@@ -2,9 +2,10 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.responseWrapperMiddleware = exports.ResponseWrapperMiddleware = void 0;
|
|
4
4
|
exports.setResponseData = setResponseData;
|
|
5
|
-
const wrapResponse = (context) => {
|
|
5
|
+
const wrapResponse = (context, defaultStatusCode) => {
|
|
6
6
|
if (!context.res.headersSent) {
|
|
7
|
-
|
|
7
|
+
// Use defaultStatusCode if provided, otherwise use context.res.statusCode, finally default to 200
|
|
8
|
+
const statusCode = defaultStatusCode || context.res.statusCode || 200;
|
|
8
9
|
const body = context.responseData;
|
|
9
10
|
context.res.status(statusCode).json({
|
|
10
11
|
success: true,
|
|
@@ -76,8 +77,12 @@ const wrapResponse = (context) => {
|
|
|
76
77
|
* ```
|
|
77
78
|
*/
|
|
78
79
|
class ResponseWrapperMiddleware {
|
|
80
|
+
defaultStatusCode;
|
|
81
|
+
constructor(defaultStatusCode) {
|
|
82
|
+
this.defaultStatusCode = defaultStatusCode;
|
|
83
|
+
}
|
|
79
84
|
async after(context) {
|
|
80
|
-
wrapResponse(context);
|
|
85
|
+
wrapResponse(context, this.defaultStatusCode);
|
|
81
86
|
}
|
|
82
87
|
}
|
|
83
88
|
exports.ResponseWrapperMiddleware = ResponseWrapperMiddleware;
|
|
@@ -138,9 +143,9 @@ exports.ResponseWrapperMiddleware = ResponseWrapperMiddleware;
|
|
|
138
143
|
* });
|
|
139
144
|
* ```
|
|
140
145
|
*/
|
|
141
|
-
const responseWrapperMiddleware = () => ({
|
|
146
|
+
const responseWrapperMiddleware = (defaultStatusCode) => ({
|
|
142
147
|
after: async (context) => {
|
|
143
|
-
wrapResponse(context);
|
|
148
|
+
wrapResponse(context, defaultStatusCode);
|
|
144
149
|
},
|
|
145
150
|
});
|
|
146
151
|
exports.responseWrapperMiddleware = responseWrapperMiddleware;
|
|
@@ -1,74 +1,5 @@
|
|
|
1
1
|
import type { FastifyRequest, FastifyReply } from 'fastify';
|
|
2
2
|
import { Handler } from '../core/handler';
|
|
3
|
-
|
|
4
|
-
* Create a Fastify route handler wrapper for a Noony handler
|
|
5
|
-
*
|
|
6
|
-
* Wraps a Noony handler into a Fastify route handler for use with Fastify server.
|
|
7
|
-
* This pattern enables running Noony handlers with Fastify's high-performance HTTP framework.
|
|
8
|
-
*
|
|
9
|
-
* @param noonyHandler - The Noony handler to wrap (contains middleware chain and controller)
|
|
10
|
-
* @param functionName - Name for error logging purposes
|
|
11
|
-
* @param initializeDependencies - Async function that initializes dependencies (database, services, etc.)
|
|
12
|
-
* Uses singleton pattern to prevent re-initialization across requests
|
|
13
|
-
* @returns Fastify route handler: `(req: FastifyRequest, reply: FastifyReply) => Promise<void>`
|
|
14
|
-
*
|
|
15
|
-
* @remarks
|
|
16
|
-
* This wrapper ensures:
|
|
17
|
-
* - Dependencies are initialized before handler execution (singleton pattern for efficiency)
|
|
18
|
-
* - Noony handlers work seamlessly with Fastify routing
|
|
19
|
-
* - Errors are caught and returned as proper HTTP responses
|
|
20
|
-
* - Response is not sent twice (`reply.sent` check)
|
|
21
|
-
* - `RESPONSE_SENT` errors are ignored (response already sent by middleware)
|
|
22
|
-
* - Real errors return 500 with generic message for security
|
|
23
|
-
*
|
|
24
|
-
* @example
|
|
25
|
-
* Creating Fastify app with multiple routes:
|
|
26
|
-
* ```typescript
|
|
27
|
-
* import Fastify from 'fastify';
|
|
28
|
-
* import { createFastifyHandler } from '@noony-serverless/core';
|
|
29
|
-
* import { loginHandler, getConfigHandler } from './handlers';
|
|
30
|
-
*
|
|
31
|
-
* // Initialize dependencies once per app startup
|
|
32
|
-
* let initialized = false;
|
|
33
|
-
* async function initializeDependencies(): Promise<void> {
|
|
34
|
-
* if (initialized) return;
|
|
35
|
-
* const db = await databaseService.connect();
|
|
36
|
-
* await initializeServices(db);
|
|
37
|
-
* initialized = true;
|
|
38
|
-
* }
|
|
39
|
-
*
|
|
40
|
-
* const server = Fastify({ logger: true });
|
|
41
|
-
*
|
|
42
|
-
* // Helper shorthand
|
|
43
|
-
* const adapt = (handler, name) => createFastifyHandler(handler, name, initializeDependencies);
|
|
44
|
-
*
|
|
45
|
-
* // Auth routes
|
|
46
|
-
* server.post('/api/auth/login', adapt(loginHandler, 'login'));
|
|
47
|
-
*
|
|
48
|
-
* // Config routes
|
|
49
|
-
* server.get('/api/config', adapt(getConfigHandler, 'getConfig'));
|
|
50
|
-
*
|
|
51
|
-
* // Start server
|
|
52
|
-
* server.listen({ port: 3000 }, (err) => {
|
|
53
|
-
* if (err) throw err;
|
|
54
|
-
* console.log('Server running on port 3000');
|
|
55
|
-
* });
|
|
56
|
-
* ```
|
|
57
|
-
*
|
|
58
|
-
* @example
|
|
59
|
-
* Fastify routing with path parameters:
|
|
60
|
-
* ```typescript
|
|
61
|
-
* const server = Fastify();
|
|
62
|
-
*
|
|
63
|
-
* // Routes with path parameters work seamlessly
|
|
64
|
-
* server.get('/api/users/:userId', adapt(getUserHandler, 'getUser'));
|
|
65
|
-
* server.patch('/api/config/sections/:sectionId', adapt(updateSectionHandler, 'updateSection'));
|
|
66
|
-
*
|
|
67
|
-
* // Path parameters available in Noony handler via context.req.params
|
|
68
|
-
* ```
|
|
69
|
-
*
|
|
70
|
-
* @see {@link createHttpFunction} for Cloud Functions Framework integration (production deployment)
|
|
71
|
-
* @see {@link wrapNoonyHandler} for Express integration
|
|
72
|
-
*/
|
|
3
|
+
export declare const requestBodyMap: WeakMap<any, FastifyRequest<import("fastify").RouteGenericInterface, import("fastify").RawServerDefault, import("http").IncomingMessage, import("fastify").FastifySchema, import("fastify").FastifyTypeProviderDefault, unknown, import("fastify").FastifyBaseLogger, import("fastify/types/type-provider").ResolveFastifyRequestType<import("fastify").FastifyTypeProviderDefault, import("fastify").FastifySchema, import("fastify").RouteGenericInterface>>>;
|
|
73
4
|
export declare function createFastifyHandler(noonyHandler: Handler<unknown>, functionName: string, initializeDependencies: () => Promise<void>): (req: FastifyRequest, reply: FastifyReply) => Promise<void>;
|
|
74
5
|
//# sourceMappingURL=fastify-wrapper.d.ts.map
|
|
@@ -1,26 +1,45 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.requestBodyMap = void 0;
|
|
3
4
|
exports.createFastifyHandler = createFastifyHandler;
|
|
4
5
|
const logger_1 = require("../core/logger");
|
|
6
|
+
// Global WeakMap to store the original Fastify request for each GenericRequest
|
|
7
|
+
// This allows middlewares to access the original request and its body
|
|
8
|
+
// even after the GenericRequest properties have been copied by Handler.executeGeneric
|
|
9
|
+
exports.requestBodyMap = new WeakMap();
|
|
10
|
+
// Pre-allocated empty objects to avoid allocations in hot path
|
|
11
|
+
const EMPTY_QUERY = Object.freeze({});
|
|
12
|
+
const EMPTY_PARAMS = Object.freeze({});
|
|
5
13
|
/**
|
|
6
14
|
* Adapt Fastify Request to GenericRequest for Noony handlers
|
|
7
15
|
*
|
|
16
|
+
* IMPORTANT: Stores the original Fastify request in a WeakMap so middlewares
|
|
17
|
+
* can access the body even after properties are copied by Handler.executeGeneric
|
|
18
|
+
*
|
|
8
19
|
* @internal
|
|
9
20
|
*/
|
|
10
21
|
function adaptFastifyRequest(req) {
|
|
11
|
-
|
|
22
|
+
// Fast path: use pre-allocated empty objects when no query/params
|
|
23
|
+
const query = req.query || EMPTY_QUERY;
|
|
24
|
+
const params = req.params || EMPTY_PARAMS;
|
|
25
|
+
// Inline path extraction to avoid optional chaining overhead
|
|
26
|
+
const routeUrl = req.routeOptions?.url;
|
|
27
|
+
const path = routeUrl || req.url;
|
|
28
|
+
const genericReq = {
|
|
12
29
|
method: req.method,
|
|
13
30
|
url: req.url,
|
|
14
|
-
path
|
|
31
|
+
path,
|
|
15
32
|
headers: req.headers,
|
|
16
|
-
query:
|
|
17
|
-
params:
|
|
33
|
+
query: query,
|
|
34
|
+
params: params,
|
|
18
35
|
body: req.body,
|
|
19
|
-
// Fastify already parses the body, so set parsedBody for BodyValidationMiddleware
|
|
20
36
|
parsedBody: req.body,
|
|
21
37
|
ip: req.ip,
|
|
22
38
|
userAgent: req.headers['user-agent'],
|
|
23
39
|
};
|
|
40
|
+
// Store the original Fastify request in the WeakMap for middleware access
|
|
41
|
+
exports.requestBodyMap.set(genericReq, req);
|
|
42
|
+
return genericReq;
|
|
24
43
|
}
|
|
25
44
|
/**
|
|
26
45
|
* Adapt Fastify Reply to GenericResponse for Noony handlers
|
|
@@ -37,11 +56,17 @@ function adaptFastifyResponse(reply) {
|
|
|
37
56
|
return response;
|
|
38
57
|
},
|
|
39
58
|
json(data) {
|
|
59
|
+
// Early return if already sent (avoid duplicate sends)
|
|
60
|
+
if (reply.sent)
|
|
61
|
+
return response;
|
|
40
62
|
headersSent = true;
|
|
41
63
|
reply.send(data);
|
|
42
64
|
return response;
|
|
43
65
|
},
|
|
44
66
|
send(data) {
|
|
67
|
+
// Early return if already sent (avoid duplicate sends)
|
|
68
|
+
if (reply.sent)
|
|
69
|
+
return response;
|
|
45
70
|
headersSent = true;
|
|
46
71
|
reply.send(data);
|
|
47
72
|
return response;
|
|
@@ -51,12 +76,16 @@ function adaptFastifyResponse(reply) {
|
|
|
51
76
|
return response;
|
|
52
77
|
},
|
|
53
78
|
headers(headers) {
|
|
54
|
-
Object.entries
|
|
55
|
-
|
|
56
|
-
|
|
79
|
+
// Optimized header setting - direct iteration instead of Object.entries
|
|
80
|
+
for (const key in headers) {
|
|
81
|
+
reply.header(key, headers[key]);
|
|
82
|
+
}
|
|
57
83
|
return response;
|
|
58
84
|
},
|
|
59
85
|
end() {
|
|
86
|
+
// Early return if already sent (avoid duplicate sends)
|
|
87
|
+
if (reply.sent)
|
|
88
|
+
return;
|
|
60
89
|
headersSent = true;
|
|
61
90
|
reply.send();
|
|
62
91
|
},
|
|
@@ -139,7 +168,19 @@ function adaptFastifyResponse(reply) {
|
|
|
139
168
|
* @see {@link createHttpFunction} for Cloud Functions Framework integration (production deployment)
|
|
140
169
|
* @see {@link wrapNoonyHandler} for Express integration
|
|
141
170
|
*/
|
|
171
|
+
// Pre-allocated error response object to avoid allocations
|
|
172
|
+
const INTERNAL_ERROR_RESPONSE = Object.freeze({
|
|
173
|
+
success: false,
|
|
174
|
+
error: Object.freeze({
|
|
175
|
+
code: 'INTERNAL_SERVER_ERROR',
|
|
176
|
+
message: 'An unexpected error occurred',
|
|
177
|
+
}),
|
|
178
|
+
});
|
|
179
|
+
// Constant for performance-critical string comparison
|
|
180
|
+
const RESPONSE_SENT_MESSAGE = 'RESPONSE_SENT';
|
|
142
181
|
function createFastifyHandler(noonyHandler, functionName, initializeDependencies) {
|
|
182
|
+
// Pre-bind the error log prefix to avoid string concatenation in hot path
|
|
183
|
+
const errorLogPrefix = `${functionName} handler error`;
|
|
143
184
|
return async (req, reply) => {
|
|
144
185
|
try {
|
|
145
186
|
// Ensure dependencies are initialized
|
|
@@ -151,23 +192,18 @@ function createFastifyHandler(noonyHandler, functionName, initializeDependencies
|
|
|
151
192
|
await noonyHandler.executeGeneric(genericReq, genericRes);
|
|
152
193
|
}
|
|
153
194
|
catch (error) {
|
|
154
|
-
//
|
|
155
|
-
if (error instanceof Error && error.message ===
|
|
195
|
+
// Fast path: check RESPONSE_SENT first (most common error to ignore)
|
|
196
|
+
if (error instanceof Error && error.message === RESPONSE_SENT_MESSAGE) {
|
|
156
197
|
return;
|
|
157
198
|
}
|
|
158
|
-
|
|
199
|
+
// Log error with pre-allocated prefix
|
|
200
|
+
logger_1.logger.error(errorLogPrefix, {
|
|
159
201
|
error: error instanceof Error ? error.message : 'Unknown error',
|
|
160
202
|
stack: error instanceof Error ? error.stack : undefined,
|
|
161
203
|
});
|
|
162
204
|
// Graceful error handling - only send if response not already sent
|
|
163
205
|
if (!reply.sent) {
|
|
164
|
-
reply.code(500).send(
|
|
165
|
-
success: false,
|
|
166
|
-
error: {
|
|
167
|
-
code: 'INTERNAL_SERVER_ERROR',
|
|
168
|
-
message: 'An unexpected error occurred',
|
|
169
|
-
},
|
|
170
|
-
});
|
|
206
|
+
reply.code(500).send(INTERNAL_ERROR_RESPONSE);
|
|
171
207
|
}
|
|
172
208
|
}
|
|
173
209
|
};
|
package/package.json
CHANGED