-
Notifications
You must be signed in to change notification settings - Fork 3.6k
fix: live server runtime errors #7314
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
f6d8372
fix: live tsconfig and tsup config
sriramveeraghanta beb2765
Merge branch 'preview' of github.com:makeplane/plane into fix-live-se…
sriramveeraghanta ef04b79
fix: lock file updates
sriramveeraghanta 4fc2473
feat: adding build process to constants and types packages
sriramveeraghanta 609c675
chore: coderabbit suggestions
sriramveeraghanta File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,8 +1,5 @@ | ||
| { | ||
| "root": true, | ||
| "extends": ["@plane/eslint-config/server.js"], | ||
| "parser": "@typescript-eslint/parser", | ||
| "parserOptions": { | ||
| "project": true | ||
| } | ||
| "parser": "@typescript-eslint/parser" | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1 @@ | ||
| export * from "../../ce/lib/update-document.js" | ||
| export * from "../../ce/lib/update-document.js"; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,135 +1,129 @@ | ||
| import compression from "compression"; | ||
| import cors from "cors"; | ||
| import expressWs from "express-ws"; | ||
| import express from "express"; | ||
| import express, { Request, Response } from "express"; | ||
| import helmet from "helmet"; | ||
| // hocuspocus server | ||
| import { getHocusPocusServer } from "@/core/hocuspocus-server.js"; | ||
| // helpers | ||
| import { convertHTMLDocumentToAllFormats } from "@/core/helpers/convert-document.js"; | ||
| import { logger, manualLogger } from "@/core/helpers/logger.js"; | ||
| import { errorHandler } from "@/core/helpers/error-handler.js"; | ||
| // types | ||
| import { TConvertDocumentRequestBody } from "@/core/types/common.js"; | ||
|
|
||
| const app: any = express(); | ||
| expressWs(app); | ||
|
|
||
| app.set("port", process.env.PORT || 3000); | ||
|
|
||
| // Security middleware | ||
| app.use(helmet()); | ||
|
|
||
| // Middleware for response compression | ||
| app.use( | ||
| compression({ | ||
| level: 6, | ||
| threshold: 5 * 1000, | ||
| }) | ||
| ); | ||
|
|
||
| // Logging middleware | ||
| app.use(logger); | ||
|
|
||
| // Body parsing middleware | ||
| app.use(express.json()); | ||
| app.use(express.urlencoded({ extended: true })); | ||
|
|
||
| // cors middleware | ||
| app.use(cors()); | ||
|
|
||
| const router = express.Router(); | ||
|
|
||
| const HocusPocusServer = await getHocusPocusServer().catch((err) => { | ||
| manualLogger.error("Failed to initialize HocusPocusServer:", err); | ||
| process.exit(1); | ||
| }); | ||
|
|
||
| router.get("/health", (_req, res) => { | ||
| res.status(200).json({ status: "OK" }); | ||
| }); | ||
| export class Server { | ||
| private app: any; | ||
| private router: any; | ||
| private hocuspocusServer: any; | ||
| private serverInstance: any; | ||
|
|
||
| constructor() { | ||
| this.app = express(); | ||
| this.router = express.Router(); | ||
| expressWs(this.app); | ||
| this.app.set("port", process.env.PORT || 3000); | ||
| this.setupMiddleware(); | ||
| this.setupHocusPocus(); | ||
| this.setupRoutes(); | ||
| } | ||
sriramveeraghanta marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| router.ws("/collaboration", (ws, req) => { | ||
| try { | ||
| HocusPocusServer.handleConnection(ws, req); | ||
| } catch (err) { | ||
| manualLogger.error("WebSocket connection error:", err); | ||
| ws.close(); | ||
| private setupMiddleware() { | ||
| // Security middleware | ||
| this.app.use(helmet()); | ||
| // Middleware for response compression | ||
| this.app.use(compression({ level: 6, threshold: 5 * 1000 })); | ||
| // Logging middleware | ||
| this.app.use(logger); | ||
| // Body parsing middleware | ||
| this.app.use(express.json()); | ||
| this.app.use(express.urlencoded({ extended: true })); | ||
| // cors middleware | ||
| this.app.use(cors()); | ||
| this.app.use(process.env.LIVE_BASE_PATH || "/live", this.router); | ||
| } | ||
| }); | ||
|
|
||
| router.post("/convert-document", (req, res) => { | ||
| const { description_html, variant } = req.body as TConvertDocumentRequestBody; | ||
| try { | ||
| if (description_html === undefined || variant === undefined) { | ||
| res.status(400).send({ | ||
| message: "Missing required fields", | ||
| }); | ||
| return; | ||
| } | ||
| const { description, description_binary } = convertHTMLDocumentToAllFormats({ | ||
| document_html: description_html, | ||
| variant, | ||
| }); | ||
| res.status(200).json({ | ||
| description, | ||
| description_binary, | ||
| }); | ||
| } catch (error) { | ||
| manualLogger.error("Error in /convert-document endpoint:", error); | ||
| res.status(500).send({ | ||
| message: `Internal server error. ${error}`, | ||
| private async setupHocusPocus() { | ||
| this.hocuspocusServer = await getHocusPocusServer().catch((err) => { | ||
| manualLogger.error("Failed to initialize HocusPocusServer:", err); | ||
| process.exit(1); | ||
| }); | ||
| } | ||
| }); | ||
|
|
||
| app.use(process.env.LIVE_BASE_PATH || "/live", router); | ||
| private setupRoutes() { | ||
| this.router.get("/health", (_req: Request, res: Response) => { | ||
| res.status(200).json({ status: "OK" }); | ||
| }); | ||
|
|
||
| app.use((_req, res) => { | ||
| res.status(404).send("Not Found"); | ||
| }); | ||
| this.router.ws("/collaboration", (ws: any, req: Request) => { | ||
| try { | ||
| this.hocuspocusServer.handleConnection(ws, req); | ||
| } catch (err) { | ||
| manualLogger.error("WebSocket connection error:", err); | ||
| ws.close(); | ||
| } | ||
| }); | ||
|
|
||
| app.use(errorHandler); | ||
| this.router.post("/convert-document", (req: Request, res: Response) => { | ||
| const { description_html, variant } = req.body as TConvertDocumentRequestBody; | ||
| try { | ||
| if (description_html === undefined || variant === undefined) { | ||
| res.status(400).send({ | ||
| message: "Missing required fields", | ||
| }); | ||
| return; | ||
| } | ||
| const { description, description_binary } = convertHTMLDocumentToAllFormats({ | ||
| document_html: description_html, | ||
| variant, | ||
| }); | ||
| res.status(200).json({ | ||
| description, | ||
| description_binary, | ||
| }); | ||
| } catch (error) { | ||
| manualLogger.error("Error in /convert-document endpoint:", error); | ||
| res.status(500).send({ | ||
| message: `Internal server error. ${error}`, | ||
| }); | ||
| } | ||
| }); | ||
|
|
||
| const liveServer = app.listen(app.get("port"), () => { | ||
| manualLogger.info(`Plane Live server has started at port ${app.get("port")}`); | ||
| }); | ||
| this.app.use((_req: Request, res: Response) => { | ||
| res.status(404).send("Not Found"); | ||
| }); | ||
| } | ||
|
|
||
| const gracefulShutdown = async () => { | ||
| manualLogger.info("Starting graceful shutdown..."); | ||
| public listen() { | ||
| this.serverInstance = this.app.listen(this.app.get("port"), () => { | ||
| manualLogger.info(`Plane Live server has started at port ${this.app.get("port")}`); | ||
| }); | ||
| } | ||
|
|
||
| try { | ||
| public async destroy() { | ||
| // Close the HocusPocus server WebSocket connections | ||
| await HocusPocusServer.destroy(); | ||
| await this.hocuspocusServer.destroy(); | ||
| manualLogger.info("HocusPocus server WebSocket connections closed gracefully."); | ||
|
|
||
| // Close the Express server | ||
| liveServer.close(() => { | ||
| this.serverInstance.close(() => { | ||
| manualLogger.info("Express server closed gracefully."); | ||
| process.exit(1); | ||
| }); | ||
| } catch (err) { | ||
| manualLogger.error("Error during shutdown:", err); | ||
| process.exit(1); | ||
| } | ||
| } | ||
|
|
||
| // Forcefully shut down after 10 seconds if not closed | ||
| setTimeout(() => { | ||
| manualLogger.error("Forcing shutdown..."); | ||
| process.exit(1); | ||
| }, 10000); | ||
| }; | ||
| const server = new Server(); | ||
| server.listen(); | ||
sriramveeraghanta marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| // Graceful shutdown on unhandled rejection | ||
| process.on("unhandledRejection", (err: any) => { | ||
| process.on("unhandledRejection", async (err: any) => { | ||
| manualLogger.info("Unhandled Rejection: ", err); | ||
| manualLogger.info(`UNHANDLED REJECTION! 💥 Shutting down...`); | ||
| gracefulShutdown(); | ||
| await server.destroy(); | ||
| }); | ||
|
|
||
| // Graceful shutdown on uncaught exception | ||
| process.on("uncaughtException", (err: any) => { | ||
| process.on("uncaughtException", async (err: any) => { | ||
| manualLogger.info("Uncaught Exception: ", err); | ||
| manualLogger.info(`UNCAUGHT EXCEPTION! 💥 Shutting down...`); | ||
| gracefulShutdown(); | ||
| await server.destroy(); | ||
| }); | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,20 +1,15 @@ | ||
| import { defineConfig, Options } from "tsup"; | ||
| import { defineConfig } from "tsup"; | ||
|
|
||
| export default defineConfig((options: Options) => ({ | ||
| export default defineConfig({ | ||
| entry: ["src/server.ts"], | ||
| format: ["esm"], | ||
| dts: false, | ||
| clean: true, | ||
| target: "node18", | ||
| sourcemap: true, | ||
| format: ["esm", "cjs"], | ||
| dts: true, | ||
| splitting: false, | ||
| bundle: true, | ||
| sourcemap: true, | ||
| minify: false, | ||
| target: "node18", | ||
| outDir: "dist", | ||
| esbuildOptions(options) { | ||
| options.alias = { | ||
| "@/core": "./src/core", | ||
| "@/plane-live": "./src/ce" | ||
| }; | ||
| env: { | ||
| NODE_ENV: process.env.NODE_ENV || "development", | ||
| }, | ||
| ...options, | ||
| })); | ||
| }); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| module.exports = { | ||
| root: true, | ||
| extends: ["@plane/eslint-config/library.js"], | ||
| parser: "@typescript-eslint/parser", | ||
| }; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.