diff --git a/.gitignore b/.gitignore new file mode 100644 index 000000000..bef6c532f --- /dev/null +++ b/.gitignore @@ -0,0 +1,148 @@ +# Logs +logs +*.log +npm-debug.log* +yarn-debug.log* +yarn-error.log* +lerna-debug.log* + +# Diagnostic reports (https://nodejs.org/api/report.html) +report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json + +# Runtime data +pids +*.pid +*.seed +*.pid.lock + +# Directory for instrumented libs generated by jscoverage/JSCover +lib-cov + +# Coverage directory used by tools like istanbul +coverage +*.lcov + +# nyc test coverage +.nyc_output + +# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files) +.grunt + +# Bower dependency directory (https://bower.io/) +bower_components + +# node-waf configuration +.lock-wscript + +# Compiled binary addons (https://nodejs.org/api/addons.html) +build/Release + +# Dependency directories +node_modules/ +jspm_packages/ + +# Snowpack dependency directory (https://snowpack.dev/) +web_modules/ + +# TypeScript cache +*.tsbuildinfo + +# Optional npm cache directory +.npm + +# Optional eslint cache +.eslintcache + +# Optional stylelint cache +.stylelintcache + +# Optional REPL history +.node_repl_history + +# Output of 'npm pack' +*.tgz + +# Yarn Integrity file +.yarn-integrity + +# dotenv environment variable files +.env +.env.* +!.env.example + +# parcel-bundler cache (https://parceljs.org/) +.cache +.parcel-cache + +# Next.js build output +.next +out + +# Nuxt.js build / generate output +.nuxt +dist +.output + +# Gatsby files +.cache/ +# Comment in the public line in if your project uses Gatsby and not Next.js +# https://nextjs.org/blog/next-9-1#public-directory-support +# public + +# vuepress build output +.vuepress/dist + +# vuepress v2.x temp directory +.temp + +# Sveltekit cache directory +.svelte-kit/ + +# vitepress build output +**/.vitepress/dist + +# vitepress cache directory +**/.vitepress/cache + +# Docusaurus cache and generated files +.docusaurus + +# Serverless directories +.serverless/ + +# FuseBox cache +.fusebox/ + +# DynamoDB Local files +.dynamodb/ + +# Firebase cache directory +.firebase/ + +# TernJS port file +.tern-port + +# Stores Visual Studio Code versions used for testing Visual Studio Code extensions +.vscode-test + +# pnpm +.pnpm-store + +# yarn v3 +.pnp.* +.yarn/* +!.yarn/patches +!.yarn/plugins +!.yarn/releases +!.yarn/sdks +!.yarn/versions + +# Vite files +vite.config.js.timestamp-* +vite.config.ts.timestamp-* +.vite/ + +CORS_ORIGINS + +#VS Code +.vscode \ No newline at end of file diff --git a/chat-app/backend/.dockerignore b/chat-app/backend/.dockerignore new file mode 100644 index 000000000..6718f89d0 --- /dev/null +++ b/chat-app/backend/.dockerignore @@ -0,0 +1,5 @@ +.env +.env.* +.git +node_modules +npm-debug.log \ No newline at end of file diff --git a/chat-app/backend/Dockerfile b/chat-app/backend/Dockerfile new file mode 100644 index 000000000..cf03226b3 --- /dev/null +++ b/chat-app/backend/Dockerfile @@ -0,0 +1,7 @@ +FROM node:26.7.0-alpine +ENV NODE_ENV=production +WORKDIR /app +COPY . . +RUN npm ci --omit=dev +USER node +ENTRYPOINT ["node", "pollingApp.js"] \ No newline at end of file diff --git a/chat-app/backend/EventStream.js b/chat-app/backend/EventStream.js new file mode 100644 index 000000000..4b7012bba --- /dev/null +++ b/chat-app/backend/EventStream.js @@ -0,0 +1,125 @@ +class EventStream { + constructor() { + this.events = []; + this.sequence = 0; + + // waiters are HTTP polling requests + this.waiters = new Set(); + + // subscribers are websocket connections. + this.subscribers = new Set(); + } + + /** + * Adds an event to the event stream. {sequnce, type, timestamp, data}. + * + * @param {"message.liked" | "message.disliked" | "message.created"} type - The type of event (e.g. "like"). + * @param {*} data - The message that was added or changed, and the changed fields. + * @returns The event object, with a sequence number + */ + append(type, data) { + const event = { + sequence: ++this.sequence, + type, + timestamp: Date.now(), + data, + }; + + this.events.push(event); + this.notifyWaiters(); + this.notifySubscribers(); + return event; + } + + /** + * + * @param {number} sequence - returns events with sequence number > given sequence number. + * @returns list of events. + */ + getAfter(sequence) { + return this.events.filter((event) => event.sequence > sequence); + } + + // websocket subscriber + subscribe(callback) { + const subscriber = { + cursor: null, + callback: callback, + }; + this.subscribers.add(subscriber); + return subscriber; + } + + unsubscribe(subscriber) { + this.subscribers.delete(subscriber); + } + + // WebSocket subscribers + notifySubscribers() { + for (const subscriber of this.subscribers) { + if (subscriber.cursor === null) { + continue; + } + + const events = this.getAfter(subscriber.cursor); + + if (events.length === 0) { + continue; + } + + try { + subscriber.callback(events); + } catch (err) { + console.error("subscriber failed", err); + } + } + } + + /** + * Polling (HTTP) connections waiting for new events + * If no new events are available, keeps connection open for specified time. + * @param {number} after - returns events after this sequence number. + * @param {*} timeout - How long to wait for a new event before closing the connection. + * @returns A promise which resolves with a list of new events or empty list + * if timer expires. + */ + waitForEvents(after, timeout = 30_000) { + const existing = this.getAfter(after); + + if (existing.length > 0) { + return Promise.resolve(existing); + } + + return new Promise((resolve) => { + const waiter = { + after, + resolve, + timer: setTimeout(() => { + this.waiters.delete(waiter); + resolve([]); + }, timeout), + }; + + this.waiters.add(waiter); + }); + } + + /** + * Sends new events for waiting HTTP requests, if there are any events to send. + */ + notifyWaiters() { + for (const waiter of this.waiters) { + const events = this.getAfter(waiter.after); + + if (events.length === 0) { + continue; + } + + clearTimeout(waiter.timer); + this.waiters.delete(waiter); + waiter.resolve(events); + } + } +} + +export { EventStream }; diff --git a/chat-app/backend/Message.js b/chat-app/backend/Message.js new file mode 100644 index 000000000..a2f98877d --- /dev/null +++ b/chat-app/backend/Message.js @@ -0,0 +1,17 @@ +export class Message { + static #nextId = 0; + + /** + * + * @param {string} username the message sender + * @param {*} msg_body text content of the message + */ + constructor(username, msg_body, likes = 0, dislikes = 0) { + this.id = Message.#nextId++; + this.username = username; + this.msg_body = msg_body; + this.createdAt = new Date(); + this.likes = likes; + this.dislikes = dislikes; + } +} diff --git a/chat-app/backend/errorClasses.js b/chat-app/backend/errorClasses.js new file mode 100644 index 000000000..4db8e4662 --- /dev/null +++ b/chat-app/backend/errorClasses.js @@ -0,0 +1,15 @@ +class ValidationError extends Error { + constructor(message) { + super(message); + this.name = "ValidationError"; + } +} + +class NotFoundError extends Error { + constructor(message) { + super(message); + this.name = "NotFoundError"; + } +} + +export { ValidationError, NotFoundError }; diff --git a/chat-app/backend/expressApp.js b/chat-app/backend/expressApp.js new file mode 100644 index 000000000..a765f9070 --- /dev/null +++ b/chat-app/backend/expressApp.js @@ -0,0 +1,80 @@ +import express from "express"; +import cors from "cors"; + +import { addMessage, getMessages, addReaction, eventStream } from "./model.js"; +import { NotFoundError, ValidationError } from "./errorClasses.js"; +const app = express(); + +app.use(cors()); +app.use(express.json()); +const PORT = process.env.PORT || 3000; + +app.get("/messages", (req, res) => { + res.json(getMessages()); +}); + +app.post("/messages", (req, res) => { + const message = addMessage(req.body.username, req.body.msg_body); + + res.status(201).json(message); +}); + +app.post("/reactions", (req, res) => { + const id = toInteger(req.body.id); + if (id === null) { + throw new ValidationError("id must be a non-negative integer"); + } + res.json(addReaction(id, req.body.action)); +}); + +/** + * Event streaming endpoint. Sends a list of events (new message, like, dislike) and + * a cursor to the most recently sent event. + * if request contains "after" query, sends events with sequence number higher than this. + * if wait is supplied, does short polling, otherwise long polling that waits for the specified + * amount of time in seconds. + */ +app.get("/events", async (req, res) => { + const after = toInteger(req.query.after) ?? 0; + const wait = toInteger(req.query.wait) ?? 0; + + if (wait === 0) { + const events = eventStream.getAfter(after); + const cursor = + events.length > 0 ? events[events.length - 1].sequence : after; + + return res.json({ cursor, events }); + } + + const events = await eventStream.waitForEvents(after, wait * 1000); + const cursor = + events.length > 0 ? events[events.length - 1].sequence : after; + + res.json({ cursor, events }); +}); + +app.get("/snapshot", (req, res) => { + res.json({ cursor: eventStream.sequence, messages: getMessages() }); +}); + +app.use((err, req, res, next) => { + if (err instanceof ValidationError) { + return res.status(400).json({ error: err.message }); + } + + if (err instanceof NotFoundError) { + return res.status(404).json({ error: err.message }); + } + + return res.status(500).json({ error: "Internal server error" }); +}); + +function toInteger(value) { + if (typeof value !== "string" || !/^\d+$/.test(value)) { + return null; + } + const n = Number(value); + return Number.isSafeInteger(n) ? n : null; +} + +export { app }; diff --git a/chat-app/backend/model.js b/chat-app/backend/model.js new file mode 100644 index 000000000..f8b7d2068 --- /dev/null +++ b/chat-app/backend/model.js @@ -0,0 +1,136 @@ +import { NotFoundError, ValidationError } from "./errorClasses.js"; +import { Message } from "./Message.js"; +import { EventStream } from "./EventStream.js"; + +const messages = []; +const eventStream = new EventStream(); + +const MAX_USERNAME = 100; +const MAX_BODY = 500; + +const dummyData = []; +dummyData.push({ username: "user1", msg_body: "abcd" }); +dummyData.push({ username: "user2", msg_body: "xyz" }); +dummyData.push({ username: "user3", msg_body: "lmno" }); +dummyData.push({ username: "user4", msg_body: "pqrst" }); +dummyData.push({ username: "user4", msg_body: "aaaargh" }); + +dummyData.forEach(({ username, msg_body }) => { + addMessage(username, msg_body); +}); + +/** + * Creates a message, stores it, and returns it. + * The id and timestamp are generated here; callers only supply content. + * + + * @param {string} username - usrname of message creator. 1-100 characters. + * @param {string} input.msg_body - Body of the message. 1-500 characters. + * @returns {Message} The stored message. + * @throws {ValidationError} If username or body is missing, not a string, or out of range. + */ +function addMessage(username, msg_body) { + if (!username) { + throw new ValidationError("username is required"); + } + + if (!msg_body) { + throw new ValidationError("msg_body is required"); + } + + if (typeof username !== "string" || typeof msg_body !== "string") { + throw new ValidationError("username and body must be strings"); + } + + username = username?.trim(); + msg_body = msg_body?.trim(); + + if (!username || username.length > MAX_USERNAME) { + throw new ValidationError( + `username must be 1-${MAX_USERNAME} characters`, + ); + } + if (!msg_body || msg_body.length > MAX_BODY) { + throw new ValidationError(`body must be 1-${MAX_BODY} characters`); + } + + const message = new Message(username, msg_body); + + messages.push(message); + eventStream.append("message.created", message); + return message; +} + +/** + * Returns all messages in system. + * + * @returns {Message[]} An array of Message objects. + */ +function getMessages() { + return messages; +} + +/** + * Return the message with the provided ID. + * + * @param {number} id - ID of message to return. + * @returns {Message} The requested message. + * @throws {ValidationError} If id is invalid. + * @throws {NotFoundError} If no messages exists with given ID. + */ +function getMessage(id) { + validateId(id); + + const message = messages.find((message) => message.id === id); + if (!message) { + throw new NotFoundError("could not find message"); + } + return message; +} + +function validateId(id) { + if (!Number.isInteger(id) || id < 0) { + throw new ValidationError("id must be a non-negative number"); + } +} + +const REACTIONS = { + like: { reactionField: "likes", event: "message.liked" }, + dislike: { reactionField: "dislikes", event: "message.disliked" }, +}; + +/** + * Adds a reaction (like or dislike) to a message. + * + * @param {number} messageId ID of the message to react to. + * @param {"like" | "dislike"} action The reaction to add. + * @returns {{ id: number, likes?: number, dislikes?: number }} + * The message id and its updated count for the given reaction. + * @throws {ValidationError} if `action` is not a known reaction. + * @throws {NotFoundError} if no message exists with the given ID. + */ +function addReaction(messageId, action) { + if (typeof action !== "string" || !Object.hasOwn(REACTIONS, action)) { + throw new ValidationError( + `Unknown reaction type: ${String(action).slice(0, 50)}`, + ); + } + + const { reactionField, event } = REACTIONS[action]; + + const message = getMessage(messageId); + message[reactionField] = (message[reactionField] ?? 0) + 1; + + const data = { id: message.id, [reactionField]: message[reactionField] }; + eventStream.append(event, data); + return data; +} + +export { + addMessage, + getMessage, + getMessages, + addReaction, + eventStream, + REACTIONS, +}; diff --git a/chat-app/backend/package-lock.json b/chat-app/backend/package-lock.json new file mode 100644 index 000000000..b1f818814 --- /dev/null +++ b/chat-app/backend/package-lock.json @@ -0,0 +1,933 @@ +{ + "name": "chat-app", + "version": "1.0.0", + "lockfileVersion": 3, + "requires": true, + "packages": { + "": { + "name": "chat-app", + "version": "1.0.0", + "license": "ISC", + "dependencies": { + "cors": "^2.8.6", + "dotenv": "^18.0.1", + "express": "^5.2.1" + } + }, + "node_modules/accepts": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/accepts/-/accepts-2.0.0.tgz", + "integrity": "sha512-5cvg6CtKwfgdmVqY1WIiXKc3Q1bkRqGLi+2W/6ao+6Y7gu/RCwRuAhGEzh5B4KlszSuTLgZYuqFqo5bImjNKng==", + "license": "MIT", + "dependencies": { + "mime-types": "^3.0.0", + "negotiator": "^1.0.0" + }, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/body-parser": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/body-parser/-/body-parser-2.3.0.tgz", + "integrity": "sha512-2cGmJupaNgg+QUwVLAucDuWuoMZ6EX9iHDRswZ5lsNYEmwPaRknMPCLZz07yTzVq/83p4o/wzbDZbBrTvGGTIw==", + "license": "MIT", + "dependencies": { + "bytes": "^3.1.2", + "content-type": "^2.0.0", + "debug": "^4.4.3", + "http-errors": "^2.0.1", + "iconv-lite": "^0.7.2", + "on-finished": "^2.4.1", + "qs": "^6.15.2", + "raw-body": "^3.0.2", + "type-is": "^2.1.0" + }, + "engines": { + "node": ">=18" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/express" + } + }, + "node_modules/body-parser/node_modules/content-type": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/content-type/-/content-type-2.1.0.tgz", + "integrity": "sha512-mj7UPXE0jaqaOsukNZRUEfEi2AcL7C/vwmwcHV0O97eO1E1pxBZuyjlZrx5seTaNBg1U6+o35wpa35Qfcc+7ag==", + "license": "MIT", + "engines": { + "node": ">=18" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/express" + } + }, + "node_modules/bytes": { + "version": "3.1.2", + "resolved": "https://registry.npmjs.org/bytes/-/bytes-3.1.2.tgz", + "integrity": "sha512-/Nf7TyzTx6S3yRJObOAV7956r8cr2+Oj8AC5dt8wSP3BQAoeX58NoHyCU8P8zGkNXStjTSi6fzO6F0pBdcYbEg==", + "license": "MIT", + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/call-bind-apply-helpers": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/call-bind-apply-helpers/-/call-bind-apply-helpers-1.0.2.tgz", + "integrity": "sha512-Sp1ablJ0ivDkSzjcaJdxEunN5/XvksFJ2sMBFfq6x0ryhQV/2b/KwFe21cMpmHtPOSij8K99/wSfoEuTObmuMQ==", + "license": "MIT", + "dependencies": { + "es-errors": "^1.3.0", + "function-bind": "^1.1.2" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/call-bound": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/call-bound/-/call-bound-1.0.4.tgz", + "integrity": "sha512-+ys997U96po4Kx/ABpBCqhA9EuxJaQWDQg7295H4hBphv3IZg0boBKuwYpt4YXp6MZ5AmZQnU/tyMTlRpaSejg==", + "license": "MIT", + "dependencies": { + "call-bind-apply-helpers": "^1.0.2", + "get-intrinsic": "^1.3.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/content-disposition": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/content-disposition/-/content-disposition-1.1.0.tgz", + "integrity": "sha512-5jRCH9Z/+DRP7rkvY83B+yGIGX96OYdJmzngqnw2SBSxqCFPd0w2km3s5iawpGX8krnwSGmF0FW5Nhr0Hfai3g==", + "license": "MIT", + "engines": { + "node": ">=18" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/express" + } + }, + "node_modules/content-type": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/content-type/-/content-type-1.0.5.tgz", + "integrity": "sha512-nTjqfcBFEipKdXCv4YDQWCfmcLZKm81ldF0pAopTvyrFGVbcR6P/VAAd5G7N+0tTr8QqiU0tFadD6FK4NtJwOA==", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/cookie": { + "version": "0.7.2", + "resolved": "https://registry.npmjs.org/cookie/-/cookie-0.7.2.tgz", + "integrity": "sha512-yki5XnKuf750l50uGTllt6kKILY4nQ1eNIQatoXEByZ5dWgnKqbnqmTrBE5B4N7lrMJKQ2ytWMiTO2o0v6Ew/w==", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/cookie-signature": { + "version": "1.2.2", + "resolved": "https://registry.npmjs.org/cookie-signature/-/cookie-signature-1.2.2.tgz", + "integrity": "sha512-D76uU73ulSXrD1UXF4KE2TMxVVwhsnCgfAyTg9k8P6KGZjlXKrOLe4dJQKI3Bxi5wjesZoFXJWElNWBjPZMbhg==", + "license": "MIT", + "engines": { + "node": ">=6.6.0" + } + }, + "node_modules/cors": { + "version": "2.8.6", + "resolved": "https://registry.npmjs.org/cors/-/cors-2.8.6.tgz", + "integrity": "sha512-tJtZBBHA6vjIAaF6EnIaq6laBBP9aq/Y3ouVJjEfoHbRBcHBAHYcMh/w8LDrk2PvIMMq8gmopa5D4V8RmbrxGw==", + "license": "MIT", + "dependencies": { + "object-assign": "^4", + "vary": "^1" + }, + "engines": { + "node": ">= 0.10" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/express" + } + }, + "node_modules/debug": { + "version": "4.4.3", + "resolved": "https://registry.npmjs.org/debug/-/debug-4.4.3.tgz", + "integrity": "sha512-RGwwWnwQvkVfavKVt22FGLw+xYSdzARwm0ru6DhTVA3umU5hZc28V3kO4stgYryrTlLpuvgI9GiijltAjNbcqA==", + "license": "MIT", + "dependencies": { + "ms": "^2.1.3" + }, + "engines": { + "node": ">=6.0" + }, + "peerDependenciesMeta": { + "supports-color": { + "optional": true + } + } + }, + "node_modules/depd": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/depd/-/depd-2.0.0.tgz", + "integrity": "sha512-g7nH6P6dyDioJogAAGprGpCtVImJhpPk/roCzdb3fIh61/s/nPsfR6onyMwkCAR/OlC3yBC0lESvUoQEAssIrw==", + "license": "MIT", + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/dotenv": { + "version": "18.0.1", + "resolved": "https://registry.npmjs.org/dotenv/-/dotenv-18.0.1.tgz", + "integrity": "sha512-0eR4m4D/jH5eaI3evo2ZqqMii5mrTCR12v12VChdie6O1gPHs7XAjzTep0CWc1Bd+oNx3vVfbi734dK4zghigw==", + "license": "BSD-2-Clause", + "bin": { + "dotenv": "dist/index.cjs" + }, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://dotenvx.com" + } + }, + "node_modules/dunder-proto": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/dunder-proto/-/dunder-proto-1.0.1.tgz", + "integrity": "sha512-KIN/nDJBQRcXw0MLVhZE9iQHmG68qAVIBg9CqmUYjmQIhgij9U5MFvrqkUL5FbtyyzZuOeOt0zdeRe4UY7ct+A==", + "license": "MIT", + "dependencies": { + "call-bind-apply-helpers": "^1.0.1", + "es-errors": "^1.3.0", + "gopd": "^1.2.0" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/ee-first": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/ee-first/-/ee-first-1.1.1.tgz", + "integrity": "sha512-WMwm9LhRUo+WUaRN+vRuETqG89IgZphVSNkdFgeb6sS/E4OrDIN7t48CAewSHXc6C8lefD8KKfr5vY61brQlow==", + "license": "MIT" + }, + "node_modules/encodeurl": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/encodeurl/-/encodeurl-2.0.0.tgz", + "integrity": "sha512-Q0n9HRi4m6JuGIV1eFlmvJB7ZEVxu93IrMyiMsGC0lrMJMWzRgx6WGquyfQgZVb31vhGgXnfmPNNXmxnOkRBrg==", + "license": "MIT", + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/es-define-property": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/es-define-property/-/es-define-property-1.0.1.tgz", + "integrity": "sha512-e3nRfgfUZ4rNGL232gUgX06QNyyez04KdjFrF+LTRoOXmrOgFKDg4BCdsjW8EnT69eqdYGmRpJwiPVYNrCaW3g==", + "license": "MIT", + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/es-errors": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/es-errors/-/es-errors-1.3.0.tgz", + "integrity": "sha512-Zf5H2Kxt2xjTvbJvP2ZWLEICxA6j+hAmMzIlypy4xcBg1vKVnx89Wy0GbS+kf5cwCVFFzdCFh2XSCFNULS6csw==", + "license": "MIT", + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/es-object-atoms": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/es-object-atoms/-/es-object-atoms-1.1.2.tgz", + "integrity": "sha512-HWcBoN6NileqtSydK2FqHbS/LoDd2pqrnQHLyJzBj4kOp/ky2MWMN694xOfkK8/SnUsW2DH7EfyVlydKCsm1Zw==", + "license": "MIT", + "dependencies": { + "es-errors": "^1.3.0" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/escape-html": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/escape-html/-/escape-html-1.0.3.tgz", + "integrity": "sha512-NiSupZ4OeuGwr68lGIeym/ksIZMJodUGOSCZ/FSnTxcrekbvqrgdUxlJOMpijaKZVjAJrWrGs/6Jy8OMuyj9ow==", + "license": "MIT" + }, + "node_modules/etag": { + "version": "1.8.1", + "resolved": "https://registry.npmjs.org/etag/-/etag-1.8.1.tgz", + "integrity": "sha512-aIL5Fx7mawVa300al2BnEE4iNvo1qETxLrPI/o05L7z6go7fCw1J6EQmbK4FmJ2AS7kgVF/KEZWufBfdClMcPg==", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/express": { + "version": "5.2.1", + "resolved": "https://registry.npmjs.org/express/-/express-5.2.1.tgz", + "integrity": "sha512-hIS4idWWai69NezIdRt2xFVofaF4j+6INOpJlVOLDO8zXGpUVEVzIYk12UUi2JzjEzWL3IOAxcTubgz9Po0yXw==", + "license": "MIT", + "dependencies": { + "accepts": "^2.0.0", + "body-parser": "^2.2.1", + "content-disposition": "^1.0.0", + "content-type": "^1.0.5", + "cookie": "^0.7.1", + "cookie-signature": "^1.2.1", + "debug": "^4.4.0", + "depd": "^2.0.0", + "encodeurl": "^2.0.0", + "escape-html": "^1.0.3", + "etag": "^1.8.1", + "finalhandler": "^2.1.0", + "fresh": "^2.0.0", + "http-errors": "^2.0.0", + "merge-descriptors": "^2.0.0", + "mime-types": "^3.0.0", + "on-finished": "^2.4.1", + "once": "^1.4.0", + "parseurl": "^1.3.3", + "proxy-addr": "^2.0.7", + "qs": "^6.14.0", + "range-parser": "^1.2.1", + "router": "^2.2.0", + "send": "^1.1.0", + "serve-static": "^2.2.0", + "statuses": "^2.0.1", + "type-is": "^2.0.1", + "vary": "^1.1.2" + }, + "engines": { + "node": ">= 18" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/express" + } + }, + "node_modules/finalhandler": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/finalhandler/-/finalhandler-2.1.1.tgz", + "integrity": "sha512-S8KoZgRZN+a5rNwqTxlZZePjT/4cnm0ROV70LedRHZ0p8u9fRID0hJUZQpkKLzro8LfmC8sx23bY6tVNxv8pQA==", + "license": "MIT", + "dependencies": { + "debug": "^4.4.0", + "encodeurl": "^2.0.0", + "escape-html": "^1.0.3", + "on-finished": "^2.4.1", + "parseurl": "^1.3.3", + "statuses": "^2.0.1" + }, + "engines": { + "node": ">= 18.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/express" + } + }, + "node_modules/forwarded": { + "version": "0.2.0", + "resolved": "https://registry.npmjs.org/forwarded/-/forwarded-0.2.0.tgz", + "integrity": "sha512-buRG0fpBtRHSTCOASe6hD258tEubFoRLb4ZNA6NxMVHNw2gOcwHo9wyablzMzOA5z9xA9L1KNjk/Nt6MT9aYow==", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/fresh": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/fresh/-/fresh-2.0.0.tgz", + "integrity": "sha512-Rx/WycZ60HOaqLKAi6cHRKKI7zxWbJ31MhntmtwMoaTeF7XFH9hhBp8vITaMidfljRQ6eYWCKkaTK+ykVJHP2A==", + "license": "MIT", + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/function-bind": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/function-bind/-/function-bind-1.1.2.tgz", + "integrity": "sha512-7XHNxH7qX9xG5mIwxkhumTox/MIRNcOgDrxWsMt2pAr23WHp6MrRlN7FBSFpCpr+oVO0F744iUgR82nJMfG2SA==", + "license": "MIT", + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/get-intrinsic": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/get-intrinsic/-/get-intrinsic-1.3.0.tgz", + "integrity": "sha512-9fSjSaos/fRIVIp+xSJlE6lfwhES7LNtKaCBIamHsjr2na1BiABJPo0mOjjz8GJDURarmCPGqaiVg5mfjb98CQ==", + "license": "MIT", + "dependencies": { + "call-bind-apply-helpers": "^1.0.2", + "es-define-property": "^1.0.1", + "es-errors": "^1.3.0", + "es-object-atoms": "^1.1.1", + "function-bind": "^1.1.2", + "get-proto": "^1.0.1", + "gopd": "^1.2.0", + "has-symbols": "^1.1.0", + "hasown": "^2.0.2", + "math-intrinsics": "^1.1.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/get-proto": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/get-proto/-/get-proto-1.0.1.tgz", + "integrity": "sha512-sTSfBjoXBp89JvIKIefqw7U2CCebsc74kiY6awiGogKtoSGbgjYE/G/+l9sF3MWFPNc9IcoOC4ODfKHfxFmp0g==", + "license": "MIT", + "dependencies": { + "dunder-proto": "^1.0.1", + "es-object-atoms": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/gopd": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/gopd/-/gopd-1.2.0.tgz", + "integrity": "sha512-ZUKRh6/kUFoAiTAtTYPZJ3hw9wNxx+BIBOijnlG9PnrJsCcSjs1wyyD6vJpaYtgnzDrKYRSqf3OO6Rfa93xsRg==", + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/has-symbols": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/has-symbols/-/has-symbols-1.1.0.tgz", + "integrity": "sha512-1cDNdwJ2Jaohmb3sg4OmKaMBwuC48sYni5HUw2DvsC8LjGTLK9h+eb1X6RyuOHe4hT0ULCW68iomhjUoKUqlPQ==", + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/hasown": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/hasown/-/hasown-2.0.4.tgz", + "integrity": "sha512-T2UbfbBEF32wiepXIsMlTW9+dDYC6wMh/t/vYA4tuOMKqWz/n3vr1NFSxQiyP+zk2mXsoMA/i/7qV6LKut1t1A==", + "license": "MIT", + "dependencies": { + "function-bind": "^1.1.2" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/http-errors": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/http-errors/-/http-errors-2.0.1.tgz", + "integrity": "sha512-4FbRdAX+bSdmo4AUFuS0WNiPz8NgFt+r8ThgNWmlrjQjt1Q7ZR9+zTlce2859x4KSXrwIsaeTqDoKQmtP8pLmQ==", + "license": "MIT", + "dependencies": { + "depd": "~2.0.0", + "inherits": "~2.0.4", + "setprototypeof": "~1.2.0", + "statuses": "~2.0.2", + "toidentifier": "~1.0.1" + }, + "engines": { + "node": ">= 0.8" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/express" + } + }, + "node_modules/iconv-lite": { + "version": "0.7.3", + "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.7.3.tgz", + "integrity": "sha512-IKXpvIzjnC9XTAUbVBcMfGS0EPaIXtW6v+zr+RRp+hqULEpo0owZax6wyRwPOJbWbzjYspQwusTsfVr0ifh4uQ==", + "license": "MIT", + "dependencies": { + "safer-buffer": ">= 2.1.2 < 3.0.0" + }, + "engines": { + "node": ">=0.10.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/express" + } + }, + "node_modules/inherits": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.4.tgz", + "integrity": "sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ==", + "license": "ISC" + }, + "node_modules/ipaddr.js": { + "version": "1.9.1", + "resolved": "https://registry.npmjs.org/ipaddr.js/-/ipaddr.js-1.9.1.tgz", + "integrity": "sha512-0KI/607xoxSToH7GjN1FfSbLoU0+btTicjsQSWQlh/hZykN8KpmMf7uYwPW3R+akZ6R/w18ZlXSHBYXiYUPO3g==", + "license": "MIT", + "engines": { + "node": ">= 0.10" + } + }, + "node_modules/is-promise": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/is-promise/-/is-promise-4.0.0.tgz", + "integrity": "sha512-hvpoI6korhJMnej285dSg6nu1+e6uxs7zG3BYAm5byqDsgJNWwxzM6z6iZiAgQR4TJ30JmBTOwqZUw3WlyH3AQ==", + "license": "MIT" + }, + "node_modules/math-intrinsics": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/math-intrinsics/-/math-intrinsics-1.1.0.tgz", + "integrity": "sha512-/IXtbwEk5HTPyEwyKX6hGkYXxM9nbj64B+ilVJnC/R6B0pH5G4V3b0pVbL7DBj4tkhBAppbQUlf6F6Xl9LHu1g==", + "license": "MIT", + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/media-typer": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/media-typer/-/media-typer-1.1.1.tgz", + "integrity": "sha512-yz3xRaG20c6/BOzvYoDaGtPmGscs7YivItZEEqe6GbwNfHuxu9YNmvnEkMzKldAGY4/80pRcQRZSEnhquk9XuQ==", + "license": "MIT", + "engines": { + "node": ">= 0.8" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/express" + } + }, + "node_modules/merge-descriptors": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/merge-descriptors/-/merge-descriptors-2.0.0.tgz", + "integrity": "sha512-Snk314V5ayFLhp3fkUREub6WtjBfPdCPY1Ln8/8munuLuiYhsABgBVWsozAG+MWMbVEvcdcpbi9R7ww22l9Q3g==", + "license": "MIT", + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/mime-db": { + "version": "1.54.0", + "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.54.0.tgz", + "integrity": "sha512-aU5EJuIN2WDemCcAp2vFBfp/m4EAhWJnUNSSw0ixs7/kXbd6Pg64EmwJkNdFhB8aWt1sH2CTXrLxo/iAGV3oPQ==", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/mime-types": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-3.0.2.tgz", + "integrity": "sha512-Lbgzdk0h4juoQ9fCKXW4by0UJqj+nOOrI9MJ1sSj4nI8aI2eo1qmvQEie4VD1glsS250n15LsWsYtCugiStS5A==", + "license": "MIT", + "dependencies": { + "mime-db": "^1.54.0" + }, + "engines": { + "node": ">=18" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/express" + } + }, + "node_modules/ms": { + "version": "2.1.3", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz", + "integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==", + "license": "MIT" + }, + "node_modules/negotiator": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/negotiator/-/negotiator-1.1.0.tgz", + "integrity": "sha512-NMPBRMJgiQHjbd8phG3Vebdx4kZ1H121rbl5IkMqeOsahptB9BKo/d7oJ3zTXqTgagn2bWlNSXkh0QUGM31RYg==", + "license": "MIT", + "dependencies": { + "content-type": "^2.1.0" + }, + "engines": { + "node": ">=18" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/express" + } + }, + "node_modules/negotiator/node_modules/content-type": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/content-type/-/content-type-2.1.0.tgz", + "integrity": "sha512-mj7UPXE0jaqaOsukNZRUEfEi2AcL7C/vwmwcHV0O97eO1E1pxBZuyjlZrx5seTaNBg1U6+o35wpa35Qfcc+7ag==", + "license": "MIT", + "engines": { + "node": ">=18" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/express" + } + }, + "node_modules/object-assign": { + "version": "4.1.1", + "resolved": "https://registry.npmjs.org/object-assign/-/object-assign-4.1.1.tgz", + "integrity": "sha512-rJgTQnkUnH1sFw8yT6VSU3zD3sWmu6sZhIseY8VX+GRu3P6F7Fu+JNDoXfklElbLJSnc3FUQHVe4cU5hj+BcUg==", + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/object-inspect": { + "version": "1.13.4", + "resolved": "https://registry.npmjs.org/object-inspect/-/object-inspect-1.13.4.tgz", + "integrity": "sha512-W67iLl4J2EXEGTbfeHCffrjDfitvLANg0UlX3wFUUSTx92KXRFegMHUVgSqE+wvhAbi4WqjGg9czysTV2Epbew==", + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/on-finished": { + "version": "2.4.1", + "resolved": "https://registry.npmjs.org/on-finished/-/on-finished-2.4.1.tgz", + "integrity": "sha512-oVlzkg3ENAhCk2zdv7IJwd/QUD4z2RxRwpkcGY8psCVcCYZNq4wYnVWALHM+brtuJjePWiYF/ClmuDr8Ch5+kg==", + "license": "MIT", + "dependencies": { + "ee-first": "1.1.1" + }, + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/once": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/once/-/once-1.4.0.tgz", + "integrity": "sha512-lNaJgI+2Q5URQBkccEKHTQOPaXdUxnZZElQTZY0MFUAuaEqe1E+Nyvgdz/aIyNi6Z9MzO5dv1H8n58/GELp3+w==", + "license": "ISC", + "dependencies": { + "wrappy": "1" + } + }, + "node_modules/parseurl": { + "version": "1.3.3", + "resolved": "https://registry.npmjs.org/parseurl/-/parseurl-1.3.3.tgz", + "integrity": "sha512-CiyeOxFT/JZyN5m0z9PfXw4SCBJ6Sygz1Dpl0wqjlhDEGGBP1GnsUVEL0p63hoG1fcj3fHynXi9NYO4nWOL+qQ==", + "license": "MIT", + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/path-to-regexp": { + "version": "8.4.2", + "resolved": "https://registry.npmjs.org/path-to-regexp/-/path-to-regexp-8.4.2.tgz", + "integrity": "sha512-qRcuIdP69NPm4qbACK+aDogI5CBDMi1jKe0ry5rSQJz8JVLsC7jV8XpiJjGRLLol3N+R5ihGYcrPLTno6pAdBA==", + "license": "MIT", + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/express" + } + }, + "node_modules/proxy-addr": { + "version": "2.0.8", + "resolved": "https://registry.npmjs.org/proxy-addr/-/proxy-addr-2.0.8.tgz", + "integrity": "sha512-5nnx0yGyVUcY6t9RnWcARWtwT9F1D8O9rt08htPvnd49W1IgZtmLkhu9WfMzQj1cFxjHIO6connUNVW5k7AVyQ==", + "license": "MIT", + "dependencies": { + "forwarded": "0.2.0", + "ipaddr.js": "1.9.1" + }, + "engines": { + "node": ">= 0.10" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/express" + } + }, + "node_modules/qs": { + "version": "6.16.0", + "resolved": "https://registry.npmjs.org/qs/-/qs-6.16.0.tgz", + "integrity": "sha512-h6fhOIaRrID2CbEY2fqs+7t+UXZo+MLAnU5gRIq85uFtdiUPCdsApMlHhXogKVM4HM2DVbIjGNTTYH2OcmP1vA==", + "license": "BSD-3-Clause", + "dependencies": { + "es-define-property": "^1.0.1", + "side-channel": "^1.1.1" + }, + "engines": { + "node": ">=0.6" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/range-parser": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/range-parser/-/range-parser-1.3.0.tgz", + "integrity": "sha512-hek2mFQpPuI4E1BBKrSto+BU3e3x4xuarsbiwr3+lf7p44juvFMV0XFWQAP3xUyqXA4RrXLIoaSUGbSt056ZMw==", + "license": "MIT", + "engines": { + "node": ">= 0.6" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/express" + } + }, + "node_modules/raw-body": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/raw-body/-/raw-body-3.0.2.tgz", + "integrity": "sha512-K5zQjDllxWkf7Z5xJdV0/B0WTNqx6vxG70zJE4N0kBs4LovmEYWJzQGxC9bS9RAKu3bgM40lrd5zoLJ12MQ5BA==", + "license": "MIT", + "dependencies": { + "bytes": "~3.1.2", + "http-errors": "~2.0.1", + "iconv-lite": "~0.7.0", + "unpipe": "~1.0.0" + }, + "engines": { + "node": ">= 0.10" + } + }, + "node_modules/router": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/router/-/router-2.2.0.tgz", + "integrity": "sha512-nLTrUKm2UyiL7rlhapu/Zl45FwNgkZGaCpZbIHajDYgwlJCOzLSk+cIPAnsEqV955GjILJnKbdQC1nVPz+gAYQ==", + "license": "MIT", + "dependencies": { + "debug": "^4.4.0", + "depd": "^2.0.0", + "is-promise": "^4.0.0", + "parseurl": "^1.3.3", + "path-to-regexp": "^8.0.0" + }, + "engines": { + "node": ">= 18" + } + }, + "node_modules/safer-buffer": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/safer-buffer/-/safer-buffer-2.1.2.tgz", + "integrity": "sha512-YZo3K82SD7Riyi0E1EQPojLz7kpepnSQI9IyPbHHg1XXXevb5dJI7tpyN2ADxGcQbHG7vcyRHk0cbwqcQriUtg==", + "license": "MIT" + }, + "node_modules/send": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/send/-/send-1.2.1.tgz", + "integrity": "sha512-1gnZf7DFcoIcajTjTwjwuDjzuz4PPcY2StKPlsGAQ1+YH20IRVrBaXSWmdjowTJ6u8Rc01PoYOGHXfP1mYcZNQ==", + "license": "MIT", + "dependencies": { + "debug": "^4.4.3", + "encodeurl": "^2.0.0", + "escape-html": "^1.0.3", + "etag": "^1.8.1", + "fresh": "^2.0.0", + "http-errors": "^2.0.1", + "mime-types": "^3.0.2", + "ms": "^2.1.3", + "on-finished": "^2.4.1", + "range-parser": "^1.2.1", + "statuses": "^2.0.2" + }, + "engines": { + "node": ">= 18" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/express" + } + }, + "node_modules/serve-static": { + "version": "2.2.1", + "resolved": "https://registry.npmjs.org/serve-static/-/serve-static-2.2.1.tgz", + "integrity": "sha512-xRXBn0pPqQTVQiC8wyQrKs2MOlX24zQ0POGaj0kultvoOCstBQM5yvOhAVSUwOMjQtTvsPWoNCHfPGwaaQJhTw==", + "license": "MIT", + "dependencies": { + "encodeurl": "^2.0.0", + "escape-html": "^1.0.3", + "parseurl": "^1.3.3", + "send": "^1.2.0" + }, + "engines": { + "node": ">= 18" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/express" + } + }, + "node_modules/setprototypeof": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/setprototypeof/-/setprototypeof-1.2.0.tgz", + "integrity": "sha512-E5LDX7Wrp85Kil5bhZv46j8jOeboKq5JMmYM3gVGdGH8xFpPWXUMsNrlODCrkoxMEeNi/XZIwuRvY4XNwYMJpw==", + "license": "ISC" + }, + "node_modules/side-channel": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/side-channel/-/side-channel-1.1.1.tgz", + "integrity": "sha512-6x6dK6zJdpTzF4sQeNYxwtvBzf6Eg4GtlesS94HOvTudUeyK2WXAaIfmDgsyslYrRBeFIlsi54AYsFGUuhmvrQ==", + "license": "MIT", + "dependencies": { + "es-errors": "^1.3.0", + "object-inspect": "^1.13.4", + "side-channel-list": "^1.0.1", + "side-channel-map": "^1.0.1", + "side-channel-weakmap": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/side-channel-list": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/side-channel-list/-/side-channel-list-1.0.1.tgz", + "integrity": "sha512-mjn/0bi/oUURjc5Xl7IaWi/OJJJumuoJFQJfDDyO46+hBWsfaVM65TBHq2eoZBhzl9EchxOijpkbRC8SVBQU0w==", + "license": "MIT", + "dependencies": { + "es-errors": "^1.3.0", + "object-inspect": "^1.13.4" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/side-channel-map": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/side-channel-map/-/side-channel-map-1.0.1.tgz", + "integrity": "sha512-VCjCNfgMsby3tTdo02nbjtM/ewra6jPHmpThenkTYh8pG9ucZ/1P8So4u4FGBek/BjpOVsDCMoLA/iuBKIFXRA==", + "license": "MIT", + "dependencies": { + "call-bound": "^1.0.2", + "es-errors": "^1.3.0", + "get-intrinsic": "^1.2.5", + "object-inspect": "^1.13.3" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/side-channel-weakmap": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/side-channel-weakmap/-/side-channel-weakmap-1.0.2.tgz", + "integrity": "sha512-WPS/HvHQTYnHisLo9McqBHOJk2FkHO/tlpvldyrnem4aeQp4hai3gythswg6p01oSoTl58rcpiFAjF2br2Ak2A==", + "license": "MIT", + "dependencies": { + "call-bound": "^1.0.2", + "es-errors": "^1.3.0", + "get-intrinsic": "^1.2.5", + "object-inspect": "^1.13.3", + "side-channel-map": "^1.0.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/statuses": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/statuses/-/statuses-2.0.2.tgz", + "integrity": "sha512-DvEy55V3DB7uknRo+4iOGT5fP1slR8wQohVdknigZPMpMstaKJQWhwiYBACJE3Ul2pTnATihhBYnRhZQHGBiRw==", + "license": "MIT", + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/toidentifier": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/toidentifier/-/toidentifier-1.0.1.tgz", + "integrity": "sha512-o5sSPKEkg/DIQNmH43V0/uerLrpzVedkUh8tGNvaeXpfpuwjKenlSox/2O/BTlZUtEe+JG7s5YhEz608PlAHRA==", + "license": "MIT", + "engines": { + "node": ">=0.6" + } + }, + "node_modules/type-is": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/type-is/-/type-is-2.1.0.tgz", + "integrity": "sha512-faYHw0anBbc/kWF3zFTEnxSFOAGUX9GFbOBthvDdLsIlEoWOFOtS0zgCiQYwIskL9iGXZL3kAXD8OoZ4GmMATA==", + "license": "MIT", + "dependencies": { + "content-type": "^2.0.0", + "media-typer": "^1.1.0", + "mime-types": "^3.0.0" + }, + "engines": { + "node": ">= 18" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/express" + } + }, + "node_modules/type-is/node_modules/content-type": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/content-type/-/content-type-2.1.0.tgz", + "integrity": "sha512-mj7UPXE0jaqaOsukNZRUEfEi2AcL7C/vwmwcHV0O97eO1E1pxBZuyjlZrx5seTaNBg1U6+o35wpa35Qfcc+7ag==", + "license": "MIT", + "engines": { + "node": ">=18" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/express" + } + }, + "node_modules/unpipe": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/unpipe/-/unpipe-1.0.0.tgz", + "integrity": "sha512-pjy2bYhSsufwWlKwPc+l3cN7+wuJlK6uz0YdJEOlQDbl6jo/YlPi4mb8agUkVC8BF7V8NuzeyPNqRksA3hztKQ==", + "license": "MIT", + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/vary": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/vary/-/vary-1.1.2.tgz", + "integrity": "sha512-BNGbWLfd0eUPabhkXUVm0j8uuvREyTh5ovRa/dyow/BqAbZJyC+5fU+IzQOzmAKzYqYRAISoRhdQr3eIZ/PXqg==", + "license": "MIT", + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/wrappy": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/wrappy/-/wrappy-1.0.2.tgz", + "integrity": "sha512-l4Sp/DRseor9wL6EvV2+TuQn63dMkPjZ/sp9XkghTEbV9KlPS1xUsZ3u7/IQO4wxtcFB4bgpQPRcR3QCvezPcQ==", + "license": "ISC" + } + } +} diff --git a/chat-app/backend/package.json b/chat-app/backend/package.json new file mode 100644 index 000000000..558bbd2e8 --- /dev/null +++ b/chat-app/backend/package.json @@ -0,0 +1,20 @@ +{ + "name": "chat-app", + "version": "1.0.0", + "description": "https://sdc.codeyourfuture.io/decomposition/sprints/2/prep/", + "main": "app.js", + "scripts": { + "dev": "node --watch app.js", + "start": "node pollingApp.js", + "test": "echo \"Error: no test specified\" && exit 1" + }, + "keywords": [], + "author": "", + "license": "ISC", + "type": "module", + "dependencies": { + "cors": "^2.8.6", + "dotenv": "^18.0.1", + "express": "^5.2.1" + } +} diff --git a/chat-app/backend/pollingApp.js b/chat-app/backend/pollingApp.js new file mode 100644 index 000000000..35cbc338e --- /dev/null +++ b/chat-app/backend/pollingApp.js @@ -0,0 +1,10 @@ +import dotenv from "dotenv"; +dotenv.config({ path: `.env.${process.env.NODE_ENV || "development"}` }); + +import { app } from "./expressApp.js"; + +const PORT = process.env.PORT || 3000; + +app.listen(PORT, () => { + console.log(`Polling app listening on port ${PORT}`); +}); diff --git a/chat-app/backend/websocketApp.js b/chat-app/backend/websocketApp.js new file mode 100644 index 000000000..8ff8f9867 --- /dev/null +++ b/chat-app/backend/websocketApp.js @@ -0,0 +1,41 @@ +import dotenv from "dotenv"; +dotenv.config({ path: `.env.${process.env.NODE_ENV || "development"}` }); + +import { server as WebSocketServer } from "websocket"; +import { eventStream } from "./model.js"; +import http from "http"; + +const PORT = process.env.PORT || 3000; + +import { app } from "./expressApp.js"; + +// express app handles http get requests for snapshots +// post requests to create new messages or reactions +// WebSocket used only for event streaming to the client +// and acknowledgement from the client when event received. +const server = http.createServer(app); + +const webSocketServer = new WebSocketServer({ + httpServer: server, +}); + +webSocketServer.on("request", (request) => { + const connection = request.accept(null, request.origin); + + const subscriber = eventStream.subscribe((events) => { + connection.sendUTF(JSON.stringify(events)); + }); + + connection.on("message", (message) => { + const data = JSON.parse(message.utf8Data); + if (data.type === "ack") { + subscriber.cursor = data.cursor; + } + }); + + connection.on("close", () => eventStream.unsubscribe(subscriber)); +}); + +server.listen(PORT, () => { + console.log(`chat app server listening on port ${PORT}`); +}); diff --git a/chat-app/frontend/HttpError.js b/chat-app/frontend/HttpError.js new file mode 100644 index 000000000..f17c9473a --- /dev/null +++ b/chat-app/frontend/HttpError.js @@ -0,0 +1,9 @@ +class HttpError extends Error { + constructor(status, message) { + super(message); + this.name = "HttpError"; + this.status = status; + } +} + +export { HttpError }; diff --git a/chat-app/frontend/common.js b/chat-app/frontend/common.js new file mode 100644 index 000000000..d960d13de --- /dev/null +++ b/chat-app/frontend/common.js @@ -0,0 +1,185 @@ +import { HttpError } from "./HttpError.js"; + +const chatStreamDiv = document.querySelector(".chat-stream"); +const form = document.querySelector(".chat-input"); + +const BACKEND_URL = + "https://z4k2yzxetkpevkwf6zy9ea37.trainees.hosting.cyf.academy"; +// const BACKEND_URL = "http://localhost:3000"; + +const WS_URL = "ws://localhost:3000"; +const state = { + messages: new Map(), + eventCursor: 0, +}; + +form.addEventListener("submit", (event) => { + event.preventDefault(); + sendMessage(); + form.reset(); +}); + +/** + * Send a message and append it to the messages DOM. + * Does not update the messages state or cursor. + * That is done by the event polling. + */ +async function sendMessage() { + const username = document.getElementById("username-input").value; + const msg_body = document.getElementById("message-input").value; + + try { + await chatRequest(`${BACKEND_URL}/messages`, { + method: "POST", + headers: { "Content-Type": "application/json" }, + body: JSON.stringify({ username, msg_body }), + }); + } catch (e) { + alert(e.message); + } +} + +function saveEventData(event) { + const message = event.data; + if (event.type === "message.created") { + state.messages.set(message.id, message); + } + if (event.type === "message.liked") { + if (message) { + const stateMsg = state.messages.get(message.id); + stateMsg.likes = message.likes; + } + } + if (event.type === "message.disliked") { + if (message) { + const stateMsg = state.messages.get(message.id); + stateMsg.dislikes = message.dislikes; + } + } + state.eventCursor = event.sequence; + return state.eventCursor; +} + +// Render all messages. +function render() { + const messages = state.messages.values(); + const messageEntries = messages.map((message) => { + return createChatEntry(message); + }); + chatStreamDiv.replaceChildren(...messageEntries); +} + +/** + * Even listener to handle clicks of like/dislike buttons. + */ +chatStreamDiv.addEventListener("click", async (event) => { + const button = event.target.closest("[data-action]"); + if (!button) return; + const { messageId, action } = button.dataset; + + try { + await reactToMessage(messageId, action); + } catch (e) { + alert(e.message); + } +}); + +/** + * Sends the reaction type and the id of the message reacted to. + * + * @param {string} messageId message to like or dislike + * @param {string} action type of reaction (like or dislike initially) + * @returns {id, likes | dislikes} Returns the id and the value of the reaction field. + */ +async function reactToMessage(messageId, action) { + return await chatRequest(`${BACKEND_URL}/reactions`, { + method: "POST", + headers: { "Content-Type": "application/json" }, + body: JSON.stringify({ id: messageId, action: action }), + }); +} + +async function chatRequest(url, options) { + const response = await fetch(url, options); + + let data; + + try { + data = await response.json(); + } catch { + data = null; + } + + if (!response.ok) { + throw new HttpError( + response.status, + data?.error ?? "Something went wrong", + ); + } + return data; +} + +// Create a message card to display in DOM. +function createChatEntry({ + id, + username, + msg_body, + createdAt, + likes, + dislikes, +}) { + const card = document.createElement("div"); + card.className = "message-card"; + + const usernameElem = document.createElement("p"); + usernameElem.textContent = `from: ${username}`; + + const bodyElem = document.createElement("p"); + bodyElem.textContent = `message: ${msg_body}`; + + const timestampElem = document.createElement("p"); + timestampElem.textContent = `sent: ${createdAt}`; + + const likeBtn = document.createElement("button"); + likeBtn.textContent = `likes: ${likes}`; + likeBtn.dataset.messageId = id; + likeBtn.dataset.action = "like"; + + const dislikeBtn = document.createElement("button"); + dislikeBtn.textContent = `dislikes: ${dislikes}`; + dislikeBtn.dataset.messageId = id; + dislikeBtn.dataset.action = "dislike"; + + const btnContainer = document.createElement("div"); + btnContainer.className = "msg-btn-container"; + btnContainer.append(likeBtn, dislikeBtn); + card.appendChild(usernameElem); + card.appendChild(bodyElem); + card.appendChild(timestampElem); + card.appendChild(btnContainer); + + return card; +} + +/** + * Syncronises local state with server + * @returns the current client cursor + */ +async function geteventSnapshot() { + const response = await chatRequest(`${BACKEND_URL}/snapshot`); + const messages = response.messages; + messages.forEach((msg) => { + state.messages.set(msg.id, msg); + }); + state.eventCursor = response.cursor; + return state.eventCursor; +} + +export { + saveEventData, + sendMessage, + render, + chatRequest, + geteventSnapshot, + state, +}; diff --git a/chat-app/frontend/index.html b/chat-app/frontend/index.html new file mode 100644 index 000000000..6d5419641 --- /dev/null +++ b/chat-app/frontend/index.html @@ -0,0 +1,38 @@ + + +
+ + + + +