n8n
Version:
n8n Workflow Automation Tool
202 lines • 8.84 kB
JavaScript
;
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || (function () {
var ownKeys = function(o) {
ownKeys = Object.getOwnPropertyNames || function (o) {
var ar = [];
for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
return ar;
};
return ownKeys(o);
};
return function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
__setModuleDefault(result, mod);
return result;
};
})();
Object.defineProperty(exports, "__esModule", { value: true });
exports.createWebhookHandlerFor = createWebhookHandlerFor;
const backend_common_1 = require("@n8n/backend-common");
const di_1 = require("@n8n/di");
const n8n_core_1 = require("n8n-core");
const n8n_workflow_1 = require("n8n-workflow");
const promises_1 = require("stream/promises");
const webhook_service_1 = require("./webhook.service");
const webhook_not_found_error_1 = require("../errors/response-errors/webhook-not-found.error");
const ResponseHelper = __importStar(require("../response-helper"));
const webhook_response_1 = require("../webhooks/webhook-response");
const WEBHOOK_METHODS = ['DELETE', 'GET', 'HEAD', 'PATCH', 'POST', 'PUT'];
class WebhookRequestHandler {
constructor(webhookManager) {
this.webhookManager = webhookManager;
}
async handleRequest(req, res) {
const method = req.method;
if (method !== 'OPTIONS' && !WEBHOOK_METHODS.includes(method)) {
return ResponseHelper.sendErrorResponse(res, new Error(`The method ${method} is not supported.`));
}
if ('origin' in req.headers) {
const corsSetupError = await this.setupCorsHeaders(req, res);
if (corsSetupError) {
return ResponseHelper.sendErrorResponse(res, corsSetupError);
}
}
if (method === 'OPTIONS') {
return ResponseHelper.sendSuccessResponse(res, {}, true, 204);
}
try {
const response = await this.webhookManager.executeWebhook(req, res);
if ((0, webhook_response_1.isWebhookResponse)(response)) {
await this.sendWebhookResponse(res, response);
}
else {
if (response.noWebhookResponse !== true) {
ResponseHelper.sendSuccessResponse(res, response.data, true, response.responseCode, response.headers);
}
}
}
catch (e) {
const error = (0, n8n_workflow_1.ensureError)(e);
const logger = di_1.Container.get(backend_common_1.Logger);
if (e instanceof webhook_not_found_error_1.WebhookNotFoundError) {
const currentlyRegistered = await di_1.Container.get(webhook_service_1.WebhookService).findAll();
logger.error(`Received request for unknown webhook: ${e.message}`, {
currentlyRegistered: currentlyRegistered.map((w) => w.display()),
});
}
else {
logger.error(`Error in handling webhook request ${req.method} ${req.path}: ${error.message}`, { stacktrace: error.stack });
}
return ResponseHelper.sendErrorResponse(res, error);
}
}
async sendWebhookResponse(res, webhookResponse) {
if ((0, webhook_response_1.isWebhookNoResponse)(webhookResponse)) {
return;
}
if ((0, webhook_response_1.isWebhookStaticResponse)(webhookResponse)) {
this.sendStaticResponse(res, webhookResponse);
return;
}
if ((0, webhook_response_1.isWebhookStreamResponse)(webhookResponse)) {
await this.sendStreamResponse(res, webhookResponse);
return;
}
}
async sendStreamResponse(res, webhookResponse) {
const { stream, code, headers } = webhookResponse;
this.setResponseStatus(res, code);
this.setResponseHeaders(res, headers);
const contentType = res.getHeader('content-type');
const needsSandbox = contentType && (0, n8n_core_1.isHtmlRenderedContentType)(contentType);
const streamToSend = needsSandbox ? stream.pipe((0, n8n_core_1.createHtmlSandboxTransformStream)()) : stream;
streamToSend.pipe(res, { end: false });
await (0, promises_1.finished)(streamToSend);
process.nextTick(() => res.end());
}
sendStaticResponse(res, webhookResponse) {
const { body, code, headers } = webhookResponse;
this.setResponseStatus(res, code);
this.setResponseHeaders(res, headers);
const contentType = res.getHeader('content-type');
if (typeof body === 'string') {
const needsSandbox = !contentType || (0, n8n_core_1.isHtmlRenderedContentType)(contentType);
const bodyToSend = needsSandbox ? (0, n8n_core_1.sandboxHtmlResponse)(body) : body;
res.send(bodyToSend);
}
else {
const needsSandbox = contentType && (0, n8n_core_1.isHtmlRenderedContentType)(contentType);
if (needsSandbox) {
res.send((0, n8n_core_1.sandboxHtmlResponse)(body));
}
else {
res.json(body);
}
}
}
setResponseStatus(res, statusCode) {
if (statusCode !== undefined) {
res.status(statusCode);
}
}
setResponseHeaders(res, headers) {
if (headers) {
for (const [name, value] of headers.entries()) {
res.setHeader(name, value);
}
}
}
async setupCorsHeaders(req, res) {
const method = req.method;
const { path } = req.params;
if (this.webhookManager.getWebhookMethods) {
try {
const allowedMethods = await this.webhookManager.getWebhookMethods(path);
res.header('Access-Control-Allow-Methods', ['OPTIONS', ...allowedMethods].join(', '));
}
catch (error) {
return error;
}
}
const requestedMethod = method === 'OPTIONS'
? req.headers['access-control-request-method']
: method;
if (this.webhookManager.findAccessControlOptions && requestedMethod) {
const options = await this.webhookManager.findAccessControlOptions(path, requestedMethod);
const { allowedOrigins } = options ?? {};
if (allowedOrigins && allowedOrigins !== '*' && allowedOrigins !== req.headers.origin) {
const originsList = allowedOrigins.split(',');
const defaultOrigin = originsList[0];
if (originsList.length === 1) {
res.header('Access-Control-Allow-Origin', defaultOrigin);
}
if (originsList.includes(req.headers.origin)) {
res.header('Access-Control-Allow-Origin', req.headers.origin);
}
else {
res.header('Access-Control-Allow-Origin', defaultOrigin);
}
}
else {
res.header('Access-Control-Allow-Origin', req.headers.origin);
}
if (method === 'OPTIONS') {
res.header('Access-Control-Max-Age', '300');
const requestedHeaders = req.headers['access-control-request-headers'];
if (requestedHeaders?.length) {
res.header('Access-Control-Allow-Headers', requestedHeaders);
}
}
}
return null;
}
}
function createWebhookHandlerFor(webhookManager) {
const handler = new WebhookRequestHandler(webhookManager);
return async (req, res) => {
const { params } = req;
if (Array.isArray(params.path)) {
params.path = params.path.join('/');
}
await handler.handleRequest(req, res);
};
}
//# sourceMappingURL=webhook-request-handler.js.map