mirror of
https://github.com/outline/outline.git
synced 2026-11-22 05:51:43 +03:00
* Migrate Backlink model to generic Relationship model - Create new Relationship model with type field to support different relationship types - Add database migration to create relationships table and migrate existing backlinks - Update Backlink model to delegate to Relationship model for backward compatibility - Update BacklinksProcessor to use Relationship model with backlink type - Update API routes to use new Relationship model - Update test files to use Relationship model - Maintain backward compatibility through database view and model delegation Fixes #9366 * Update migration to rename table instead of creating new one - Rename existing backlinks table to relationships instead of creating new table - Add type column with default value to existing table - Update existing rows to have type='backlink' - Avoid expensive data migration by keeping existing data in place - Maintain backward compatibility with database view - Update rollback to reverse table rename and column addition This approach is much more efficient for large datasets as it avoids copying millions of rows. * Remove unnecessary UPDATE statement from migration The UPDATE statement is not needed since defaultValue automatically applies to existing rows when adding a column with a default value. Thanks @tommoor for catching this! * Wrap up migration in transaction - Wrap all migration operations in a transaction for atomicity - Add transaction parameter to all queryInterface calls - Follow the same pattern as other migrations in the codebase - Ensures all operations succeed or fail together * Remove Backlink class entirely and use Relationship everywhere - Delete server/models/Backlink.ts - Remove Backlink export from server/models/index.ts - Remove Backlink import and association from Document model - All functionality now uses Relationship model with RelationshipType.Backlink - Maintains same API through Relationship model methods - Cleaner architecture with single relationship model * Update documents.test.ts to use RelationshipType enum instead of string - Import RelationshipType from Relationship model - Replace type: "backlink" with type: RelationshipType.Backlink - Improves type safety and consistency with enum usage * Address code review feedback - Add transaction wrapper to migration down method for safer rollback - Remove unused findByTypeForUser method from Relationship model - Method wasn't used and won't work for all relationship types (e.g., user mentions) - Clean up code structure and improve safety * Restore imports * Add relationships API endpoints - Create relationships API following stars pattern - Add CRUD operations: create, list, delete - Include proper validation, authentication, and authorization - Support filtering by relationship type and document IDs - Add relationship presenter and policies - Register routes in main API router * Remove relationships.create and relationships.delete endpoints - Keep only relationships.list endpoint as requested - Remove create and delete schemas from validation - Update policies to only allow read operations - Relationships will be managed internally, not via external API * Add relationships.info endpoint - Use Document.findByPk for authorization as requested - Find relationship by ID and verify user has access to related document - Return relationship details with accessible documents - Include proper validation schema for UUID parameter * Update 20250601223331-migrate-backlink-to-relationship.js * Update Relationship.ts * wip * test * Final tweaks --------- Co-authored-by: codegen-sh[bot] <131295404+codegen-sh[bot]@users.noreply.github.com> Co-authored-by: Tom Moor <tom@getoutline.com>
131 lines
4.2 KiB
TypeScript
131 lines
4.2 KiB
TypeScript
import Koa, { BaseContext } from "koa";
|
|
import bodyParser from "koa-body";
|
|
import Router from "koa-router";
|
|
import userAgent, { UserAgentContext } from "koa-useragent";
|
|
import env from "@server/env";
|
|
import { NotFoundError } from "@server/errors";
|
|
import coalesceBody from "@server/middlewares/coaleseBody";
|
|
import requestTracer from "@server/middlewares/requestTracer";
|
|
import { AppState, AppContext } from "@server/types";
|
|
import { Hook, PluginManager } from "@server/utils/PluginManager";
|
|
import apiKeys from "./apiKeys";
|
|
import attachments from "./attachments";
|
|
import auth from "./auth";
|
|
import authenticationProviders from "./authenticationProviders";
|
|
import collections from "./collections";
|
|
import comments from "./comments/comments";
|
|
import cron from "./cron";
|
|
import developer from "./developer";
|
|
import documents from "./documents";
|
|
import events from "./events";
|
|
import fileOperationsRoute from "./fileOperations";
|
|
import groupMemberships from "./groupMemberships";
|
|
import groups from "./groups";
|
|
import imports from "./imports";
|
|
import installation from "./installation";
|
|
import integrations from "./integrations";
|
|
import apiErrorHandler from "./middlewares/apiErrorHandler";
|
|
import apiResponse from "./middlewares/apiResponse";
|
|
import editor from "./middlewares/editor";
|
|
import notifications from "./notifications";
|
|
import oauthAuthentications from "./oauthAuthentications";
|
|
import oauthClients from "./oauthClients";
|
|
import pins from "./pins";
|
|
import reactions from "./reactions";
|
|
import relationships from "./relationships";
|
|
import revisions from "./revisions";
|
|
import searches from "./searches";
|
|
import shares from "./shares";
|
|
import stars from "./stars";
|
|
import subscriptions from "./subscriptions";
|
|
import suggestions from "./suggestions";
|
|
import teams from "./teams";
|
|
import urls from "./urls";
|
|
import userMemberships from "./userMemberships";
|
|
import users from "./users";
|
|
import views from "./views";
|
|
|
|
const api = new Koa<AppState, AppContext>();
|
|
const router = new Router();
|
|
|
|
// middlewares
|
|
api.use(
|
|
bodyParser({
|
|
multipart: true,
|
|
formidable: {
|
|
maxFileSize: Math.max(
|
|
env.FILE_STORAGE_UPLOAD_MAX_SIZE,
|
|
env.FILE_STORAGE_IMPORT_MAX_SIZE
|
|
),
|
|
maxFieldsSize: 10 * 1024 * 1024,
|
|
},
|
|
})
|
|
);
|
|
api.use(coalesceBody());
|
|
api.use<BaseContext, UserAgentContext>(userAgent);
|
|
api.use(requestTracer());
|
|
api.use(apiResponse());
|
|
api.use(apiErrorHandler());
|
|
api.use(editor());
|
|
|
|
// Register plugin API routes before others to allow for overrides
|
|
PluginManager.getHooks(Hook.API).forEach((hook) =>
|
|
router.use("/", hook.value.routes())
|
|
);
|
|
|
|
// routes
|
|
router.use("/", auth.routes());
|
|
router.use("/", authenticationProviders.routes());
|
|
router.use("/", events.routes());
|
|
router.use("/", users.routes());
|
|
router.use("/", collections.routes());
|
|
router.use("/", comments.routes());
|
|
router.use("/", documents.routes());
|
|
router.use("/", pins.routes());
|
|
router.use("/", revisions.routes());
|
|
router.use("/", views.routes());
|
|
router.use("/", apiKeys.routes());
|
|
router.use("/", searches.routes());
|
|
router.use("/", shares.routes());
|
|
router.use("/", stars.routes());
|
|
router.use("/", subscriptions.routes());
|
|
router.use("/", suggestions.routes());
|
|
router.use("/", teams.routes());
|
|
router.use("/", integrations.routes());
|
|
router.use("/", notifications.routes());
|
|
router.use("/", oauthAuthentications.routes());
|
|
router.use("/", oauthClients.routes());
|
|
router.use("/", attachments.routes());
|
|
router.use("/", cron.routes());
|
|
router.use("/", groups.routes());
|
|
router.use("/", groupMemberships.routes());
|
|
router.use("/", fileOperationsRoute.routes());
|
|
router.use("/", urls.routes());
|
|
router.use("/", userMemberships.routes());
|
|
router.use("/", reactions.routes());
|
|
router.use("/", relationships.routes());
|
|
router.use("/", imports.routes());
|
|
|
|
if (!env.isCloudHosted) {
|
|
router.use("/", installation.routes());
|
|
}
|
|
|
|
if (env.isDevelopment) {
|
|
router.use("/", developer.routes());
|
|
}
|
|
|
|
router.post("*", (ctx) => {
|
|
ctx.throw(NotFoundError("Endpoint not found"));
|
|
});
|
|
|
|
router.get("*", (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());
|
|
api.use(router.allowedMethods());
|
|
|
|
export default api;
|