* Webhooks (#3607) * Get the migration and the model setup. Also make the sample env file a bit easier to use. Now just requires setting a SECRET_KEY and besides that will boot up from the sample * WIP: Start getting a Webhook page created. Just the skeleton state right now * WIP: Getting a form created to create webhooks, need to bring in react-hook-forms now * WIP: Get library installed and make TS happy * Get a few checkboxes ready to go * Get creating and destroying working with a decent start to a frontend * Didn't mean to enable this * Remove eslint and fix other random typescript issue * Rename some events to be more realistic * Revert these changes * PR review comments around policies. Also make sure this inherits from IdModel so it actually gets an id * Allow any admin on the team to edit webhooks * Start sending some webhooks for some User events * Make sure the URL is valid * Start recording webhook deliveries * Make sure to verify if the subscription is for the type of event we are looking at * Refactor sending Webhooks and follow better webhook schema This creates a presenter to unify the format of webhooks. We also extract the sending of webhooks and recording their deliveries to a method than can be used by each of the different event type methods We also add a status to WebhookDelivery since we need to save the record before we make the HTTP request to get its id. Then once we make the request and get a response we can update the delivery with the HTTP info * Turn off a subscription that has failed for the last 25 deliveries * Get a first spec passing. Found a bug in my returning of promises so good to patch that up now * This looks nicer * Get some tests added for the processor * Add cron task to delete older webhooks * Add Document Events to the Processor * Revisions, FileOperations and Collections * Get all the server side events added to the processor and make Typescript make sure they are all accounted for * Get all the events added to the Frontend and work on styling them a bit, still needs some love though * Get UI styled up a bit * Get events wired up for webhook subscriptions * Get delete events working and test at least one variant of them * Get deletes working and actually make sure to send the model id in the webhook * Remove webhook secrets from this slice * Add disabled label for subscriptions that are disabled * Make sure to cascade the delete * Reorg this file a bit * Fix association * I removed secret for the moment * Apply Copy changes from PR Review Co-authored-by: Tom Moor <tom.moor@gmail.com> * Actually apply the copy changes TIL that if you Resolve a conversation it _also_ removes the 'staged suggestion' from your list on Github Co-authored-by: Tom Moor <tom.moor@gmail.com> * Update app/scenes/Settings/Webhooks.tsx Missed this copy change before Co-authored-by: Tom Moor <tom.moor@gmail.com> * Add disabled as yellow badge * Resolve frontend comments * Fixup Schema a bit and remove the dependency on the subscription * Add test to make sure we don't disable until there are enough failures, and fix code to actually do that. Also some test fixes from the json response shape changes * Fix WebhookDeliveries to store the responses as Text instead of blobs * Switch to text better for response bodies, this is using the helpers better and makes the code read better * Move the logic to a task but run in through the processor cause the tests expect that right now, moving the tests over next * Split up the tests and actually enqueue the events from the WebhookProcessor instead of doing them inline * Allow any team admin to see any webhook subscription for the team * Add the indexes based on our lookup patterns * Run eslint --fix to fix auto correct issues from when I tried to use Github to merge copy changes * Allow subscriptions to be edited after creation * Types caught that I didn't add the new event to the webhook processor, also added it to the frontend here * I think this will get these into the translations file * Catch a few more translations, use styled components better and remove usage of webhook subscription in the copy Co-authored-by: Tom Moor <tom.moor@gmail.com> * fix: tsc fix: Document model payload empty * fix: Revision webhook payload Add custom UA for hooks * Add webhooks icon, move under Integrations settings Some spacing fixes * Add actorId to webhook payloads * Add View and ApiKey event types * Spacing tweaks, fix team payload * fix: Webhook not disabled after 25 failures * fix: Enable webhook when editing if previously disabled * fix: Correctly store response headers * fix: Error in json/parsing/presentation results in hanging 'pending' webhook delivery * fix: Awkward payload for users.invite webhook * Add BaseEvent, ShareEvent * fix: Add share events to form * fix: Move webhook delivery cleanup to single DB call Remove some unused abstraction * Add user, collection, group context to membership webhook events Some associated refactoring Co-authored-by: Corey Alexander <coreyja@gmail.com>
82 lines
2.5 KiB
TypeScript
82 lines
2.5 KiB
TypeScript
import Koa from "koa";
|
|
import bodyParser from "koa-body";
|
|
import Router from "koa-router";
|
|
import { NotFoundError } from "@server/errors";
|
|
import errorHandling from "@server/middlewares/errorHandling";
|
|
import methodOverride from "@server/middlewares/methodOverride";
|
|
import apiKeys from "./apiKeys";
|
|
import attachments from "./attachments";
|
|
import auth from "./auth";
|
|
import authenticationProviders from "./authenticationProviders";
|
|
import collections from "./collections";
|
|
import utils from "./cron";
|
|
import documents from "./documents";
|
|
import events from "./events";
|
|
import fileOperationsRoute from "./fileOperations";
|
|
import groups from "./groups";
|
|
import hooks from "./hooks";
|
|
import integrations from "./integrations";
|
|
import apiWrapper from "./middlewares/apiWrapper";
|
|
import editor from "./middlewares/editor";
|
|
import notificationSettings from "./notificationSettings";
|
|
import pins from "./pins";
|
|
import revisions from "./revisions";
|
|
import searches from "./searches";
|
|
import shares from "./shares";
|
|
import stars from "./stars";
|
|
import team from "./team";
|
|
import users from "./users";
|
|
import views from "./views";
|
|
import webhookSubscriptions from "./webhookSubscriptions";
|
|
|
|
const api = new Koa();
|
|
const router = new Router();
|
|
|
|
// middlewares
|
|
api.use(errorHandling());
|
|
api.use(
|
|
bodyParser({
|
|
multipart: true,
|
|
formidable: {
|
|
maxFieldsSize: 10 * 1024 * 1024,
|
|
},
|
|
})
|
|
);
|
|
api.use(methodOverride());
|
|
api.use(apiWrapper());
|
|
api.use(editor());
|
|
|
|
// routes
|
|
router.use("/", auth.routes());
|
|
router.use("/", authenticationProviders.routes());
|
|
router.use("/", events.routes());
|
|
router.use("/", users.routes());
|
|
router.use("/", collections.routes());
|
|
router.use("/", documents.routes());
|
|
router.use("/", pins.routes());
|
|
router.use("/", revisions.routes());
|
|
router.use("/", views.routes());
|
|
router.use("/", hooks.routes());
|
|
router.use("/", apiKeys.routes());
|
|
router.use("/", searches.routes());
|
|
router.use("/", shares.routes());
|
|
router.use("/", stars.routes());
|
|
router.use("/", team.routes());
|
|
router.use("/", integrations.routes());
|
|
router.use("/", notificationSettings.routes());
|
|
router.use("/", attachments.routes());
|
|
router.use("/", utils.routes());
|
|
router.use("/", groups.routes());
|
|
router.use("/", fileOperationsRoute.routes());
|
|
router.use("/", webhookSubscriptions.routes());
|
|
|
|
router.post("*", (ctx) => {
|
|
ctx.throw(NotFoundError("Endpoint not found"));
|
|
});
|
|
|
|
// Router is embedded in a Koa application wrapper, because koa-router does not
|
|
// allow middleware to catch any routes which were not explicitly defined.
|
|
api.use(router.routes());
|
|
|
|
export default api;
|