Open-source and local-first Slack and Notion alternative that puts you in control of your data
TypeScript chatchat-applicationcrdteditorelectronknowledge-baselocal-firstnotionnotion-alternativerealtime-collaborationself-hostedslacksqliteteam-collaborationwikiyjs
Send client metadata as headers on each request (#19)
Hakan Shehu90c7a22685a6
diff --git a/apps/desktop/src/main/mutations/accounts/email-login.ts b/apps/desktop/src/main/mutations/accounts/email-login.tsindex b180fcc9..aa893d6d 100644--- a/apps/desktop/src/main/mutations/accounts/email-login.ts+++ b/apps/desktop/src/main/mutations/accounts/email-login.ts@@ -43,7 +43,6 @@ export class EmailLoginMutationHandlerreturn data;} catch (error) {- console.error(error);const apiError = parseApiError(error);throw new MutationError(MutationErrorCode.ApiError, apiError.message);}diff --git a/apps/desktop/src/main/mutations/accounts/email-password-reset-complete.ts b/apps/desktop/src/main/mutations/accounts/email-password-reset-complete.tsindex cc121d60..e7d50ef7 100644--- a/apps/desktop/src/main/mutations/accounts/email-password-reset-complete.ts+++ b/apps/desktop/src/main/mutations/accounts/email-password-reset-complete.ts@@ -46,7 +46,6 @@ export class EmailPasswordResetCompleteMutationHandlerreturn data;} catch (error) {- console.error(error);const apiError = parseApiError(error);throw new MutationError(MutationErrorCode.ApiError, apiError.message);}diff --git a/apps/desktop/src/main/mutations/accounts/email-password-reset-init.ts b/apps/desktop/src/main/mutations/accounts/email-password-reset-init.tsindex b3fdbda6..2caba527 100644--- a/apps/desktop/src/main/mutations/accounts/email-password-reset-init.ts+++ b/apps/desktop/src/main/mutations/accounts/email-password-reset-init.ts@@ -44,7 +44,6 @@ export class EmailPasswordResetInitMutationHandlerreturn data;} catch (error) {- console.error(error);const apiError = parseApiError(error);throw new MutationError(MutationErrorCode.ApiError, apiError.message);}diff --git a/apps/desktop/src/main/services/app-service.ts b/apps/desktop/src/main/services/app-service.tsindex f84f5667..54aa7617 100644--- a/apps/desktop/src/main/services/app-service.ts+++ b/apps/desktop/src/main/services/app-service.ts@@ -1,6 +1,6 @@import { Kysely, Migration, Migrator, SqliteDialect } from 'kysely';import SQLite from 'better-sqlite3';-import { ApiErrorCode, createDebugger } from '@colanode/core';+import { ApiErrorCode, ApiHeader, createDebugger } from '@colanode/core';import ms from 'ms';import axios from 'axios';import semver from 'semver';@@ -34,9 +34,11 @@ export class AppService {public readonly metadata: MetadataService;public readonly notifications: NotificationService;public readonly version: string;+ public readonly platform: AppPlatform;constructor() {this.version = app.getVersion();+ this.platform = process.platform as AppPlatform;const database = new SQLite(appDatabasePath);database.pragma('journal_mode = WAL');@@ -47,6 +49,14 @@ export class AppService {}),});+ // register interceptor to add client headers to all requests+ axios.interceptors.request.use((config) => {+ config.headers[ApiHeader.ClientType] = 'desktop';+ config.headers[ApiHeader.ClientPlatform] = this.platform;+ config.headers[ApiHeader.ClientVersion] = this.version;+ return config;+ });+this.metadata = new MetadataService(this);this.notifications = new NotificationService(this);@@ -85,7 +95,7 @@ export class AppService {}await this.metadata.set('version', this.version);- await this.metadata.set('platform', process.platform as AppPlatform);+ await this.metadata.set('platform', this.platform);}public getAccount(id: string): AccountService | null {diff --git a/apps/desktop/src/shared/lib/lowlight.ts b/apps/desktop/src/shared/lib/lowlight.tsindex 728d0041..1674039d 100644--- a/apps/desktop/src/shared/lib/lowlight.ts+++ b/apps/desktop/src/shared/lib/lowlight.ts@@ -1,4 +1,4 @@-import { all,createLowlight } from 'lowlight';+import { all, createLowlight } from 'lowlight';export const lowlight = createLowlight(all);const lowlightLanguages = lowlight.listLanguages();@@ -251,8 +251,7 @@ export const highlightCode = (language: result.data?.language,nodes,};- } catch (error) {- console.error('highlightCode', error, code, language);+ } catch {return null;}};diff --git a/apps/server/src/api/client/plugins/client.ts b/apps/server/src/api/client/plugins/client.tsnew file mode 100644index 00000000..90711461--- /dev/null+++ b/apps/server/src/api/client/plugins/client.ts@@ -0,0 +1,53 @@+import { ApiHeader } from '@colanode/core';+import { FastifyPluginCallback, FastifyRequest } from 'fastify';+import fp from 'fastify-plugin';++export interface ClientContext {+ ip: string;+ platform?: string;+ version?: string;+ type?: string;+}++declare module 'fastify' {+ interface FastifyRequest {+ client: ClientContext;+ }+}++const getHeaderAsString = (+ request: FastifyRequest,+ header: string+): string | undefined => {+ const value = request.headers[header.toLowerCase()];+ return Array.isArray(value) ? value[0] : value;+};++const clientDecoratorCallback: FastifyPluginCallback = (fastify, _, done) => {+ if (!fastify.hasRequestDecorator('client')) {+ fastify.decorateRequest('client');+ }++ fastify.addHook('onRequest', async (request) => {+ const ipValue =+ getHeaderAsString(request, 'cf-connecting-ip') ||+ getHeaderAsString(request, 'x-forwarded-for') ||+ request.ip;++ const ip = ipValue.split(',')[0]!;+ const platform = getHeaderAsString(request, ApiHeader.ClientPlatform);+ const version = getHeaderAsString(request, ApiHeader.ClientVersion);+ const type = getHeaderAsString(request, ApiHeader.ClientType);++ request.client = {+ ip,+ platform,+ version,+ type,+ };+ });++ done();+};++export const clientDecorator = fp(clientDecoratorCallback);diff --git a/apps/server/src/api/client/plugins/ip.ts b/apps/server/src/api/client/plugins/ip.tsdeleted file mode 100644index fa792d4b..00000000--- a/apps/server/src/api/client/plugins/ip.ts+++ /dev/null@@ -1,32 +0,0 @@-import { FastifyPluginCallback } from 'fastify';-import fp from 'fastify-plugin';--declare module 'fastify' {- interface FastifyRequest {- originalIp: string;- }-}--const ipDecoratorCallback: FastifyPluginCallback = (fastify, _, done) => {- if (!fastify.hasRequestDecorator('originalIp')) {- fastify.decorateRequest('originalIp');- }-- fastify.addHook('onRequest', async (request) => {- const ipValue =- request.headers['cf-connecting-ip'] ||- request.headers['x-forwarded-for'] ||- request.ip;-- let ip = Array.isArray(ipValue) ? ipValue[0] : ipValue;- if (ip?.includes(',')) {- ip = ip.split(',')[0];- }-- request.originalIp = ip ?? request.ip;- });-- done();-};--export const ipDecorator = fp(ipDecoratorCallback);diff --git a/apps/server/src/api/client/routes/accounts/account-sync.ts b/apps/server/src/api/client/routes/accounts/account-sync.tsindex ca545ab0..c8e7e3ba 100644--- a/apps/server/src/api/client/routes/accounts/account-sync.ts+++ b/apps/server/src/api/client/routes/accounts/account-sync.ts@@ -4,10 +4,10 @@ import {WorkspaceOutput,WorkspaceRole,ApiErrorCode,- AccountSyncInput,UserStatus,accountSyncOutputSchema,apiErrorOutputSchema,+ accountSyncInputSchema,} from '@colanode/core';import { database } from '@/data/database';@@ -21,6 +21,7 @@ export const accountSyncRoute: FastifyPluginCallbackZod = (method: 'POST',url: '/sync',schema: {+ body: accountSyncInputSchema,response: {200: accountSyncOutputSchema,400: apiErrorOutputSchema,@@ -55,15 +56,14 @@ export const accountSyncRoute: FastifyPluginCallbackZod = (});}- const input = request.body as AccountSyncInput;-+ const input = request.body;await database.updateTable('devices').set({synced_at: new Date(),- ip: request.originalIp,- platform: input.platform,- version: input.version,+ ip: request.client.ip,+ platform: input.platform || request.client.platform,+ version: input.version || request.client.version,}).where('id', '=', device.id).execute();diff --git a/apps/server/src/api/client/routes/accounts/email-login.ts b/apps/server/src/api/client/routes/accounts/email-login.tsindex ec67cd93..3050faae 100644--- a/apps/server/src/api/client/routes/accounts/email-login.ts+++ b/apps/server/src/api/client/routes/accounts/email-login.ts@@ -34,7 +34,7 @@ export const emailLoginRoute: FastifyPluginCallbackZod = (},},handler: async (request, reply) => {- const ip = request.originalIp;+ const ip = request.client.ip;const isIpRateLimited = await rateLimitService.isAuthIpRateLimitted(ip);if (isIpRateLimited) {return reply.code(429).send({diff --git a/apps/server/src/api/client/routes/accounts/email-password-reset-complete.ts b/apps/server/src/api/client/routes/accounts/email-password-reset-complete.tsindex 37449746..490e245c 100644--- a/apps/server/src/api/client/routes/accounts/email-password-reset-complete.ts+++ b/apps/server/src/api/client/routes/accounts/email-password-reset-complete.ts@@ -29,7 +29,7 @@ export const emailPasswordResetCompleteRoute: FastifyPluginCallbackZod = (},},handler: async (request, reply) => {- const ip = request.originalIp;+ const ip = request.client.ip;const isIpRateLimited = await rateLimitService.isAuthIpRateLimitted(ip);if (isIpRateLimited) {return reply.code(429).send({diff --git a/apps/server/src/api/client/routes/accounts/email-password-reset-init.ts b/apps/server/src/api/client/routes/accounts/email-password-reset-init.tsindex ee24d7b3..d7064963 100644--- a/apps/server/src/api/client/routes/accounts/email-password-reset-init.ts+++ b/apps/server/src/api/client/routes/accounts/email-password-reset-init.ts@@ -32,7 +32,7 @@ export const emailPasswordResetInitRoute: FastifyPluginCallbackZod = (},},handler: async (request, reply) => {- const ip = request.originalIp;+ const ip = request.client.ip;const isIpRateLimited = await rateLimitService.isAuthIpRateLimitted(ip);if (isIpRateLimited) {return reply.code(429).send({diff --git a/apps/server/src/api/client/routes/accounts/email-register.ts b/apps/server/src/api/client/routes/accounts/email-register.tsindex d7a1045c..a8a3f6ae 100644--- a/apps/server/src/api/client/routes/accounts/email-register.ts+++ b/apps/server/src/api/client/routes/accounts/email-register.ts@@ -35,7 +35,7 @@ export const emailRegisterRoute: FastifyPluginCallbackZod = (},},handler: async (request, reply) => {- const ip = request.originalIp;+ const ip = request.client.ip;const isIpRateLimited = await rateLimitService.isAuthIpRateLimitted(ip);if (isIpRateLimited) {return reply.code(429).send({@@ -126,9 +126,9 @@ export const emailRegisterRoute: FastifyPluginCallbackZod = (}const output = await buildLoginSuccessOutput(account, {- ip: request.originalIp,- platform: input.platform,- version: input.version,+ ip: request.client.ip,+ platform: input.platform || request.client.platform || '',+ version: input.version || request.client.version || '',});return output;diff --git a/apps/server/src/api/client/routes/accounts/email-verify.ts b/apps/server/src/api/client/routes/accounts/email-verify.tsindex 2b11ad8e..110b4b13 100644--- a/apps/server/src/api/client/routes/accounts/email-verify.ts+++ b/apps/server/src/api/client/routes/accounts/email-verify.ts@@ -54,9 +54,9 @@ export const emailVerifyRoute: FastifyPluginCallbackZod = (}const output = await buildLoginSuccessOutput(account, {- ip: request.originalIp,- platform: input.platform,- version: input.version,+ ip: request.client.ip,+ platform: input.platform || request.client.platform || '',+ version: input.version || request.client.version || '',});return output;diff --git a/apps/server/src/api/client/routes/accounts/login-google.ts b/apps/server/src/api/client/routes/accounts/login-google.tsindex f6992776..f03c86be 100644--- a/apps/server/src/api/client/routes/accounts/login-google.ts+++ b/apps/server/src/api/client/routes/accounts/login-google.ts@@ -41,7 +41,7 @@ export const loginWithGoogleRoute: FastifyPluginCallbackZod = (});}- const ip = request.originalIp;+ const ip = request.client.ip;const isIpRateLimited = await rateLimitService.isAuthIpRateLimitted(ip);if (isIpRateLimited) {return reply.code(429).send({@@ -90,7 +90,7 @@ export const loginWithGoogleRoute: FastifyPluginCallbackZod = (}const output = await buildLoginSuccessOutput(existingAccount, {- ip: request.originalIp,+ ip: request.client.ip,platform: input.platform,version: input.version,});@@ -119,7 +119,7 @@ export const loginWithGoogleRoute: FastifyPluginCallbackZod = (}const output = await buildLoginSuccessOutput(newAccount, {- ip: request.originalIp,+ ip: request.client.ip,platform: input.platform,version: input.version,});diff --git a/apps/server/src/api/client/routes/config.ts b/apps/server/src/api/client/routes/config.tsindex 492a05db..c4a2bff3 100644--- a/apps/server/src/api/client/routes/config.ts+++ b/apps/server/src/api/client/routes/config.ts@@ -18,7 +18,7 @@ export const configGetRoute: FastifyPluginCallbackZod = (instance, _, done) => {avatar: configuration.server.avatar,version: configuration.server.version,sha: configuration.server.sha,- ip: request.originalIp,+ ip: request.client.ip,attributes: {},};diff --git a/apps/server/src/api/client/routes/workspaces/mutations/mutations-sync.ts b/apps/server/src/api/client/routes/workspaces/mutations/mutations-sync.tsindex 1da9b455..f172efe3 100644--- a/apps/server/src/api/client/routes/workspaces/mutations/mutations-sync.ts+++ b/apps/server/src/api/client/routes/workspaces/mutations/mutations-sync.ts@@ -47,8 +47,7 @@ export const mutationsSyncRoute: FastifyPluginCallbackZod = (id: mutation.id,status: status,});- } catch (error) {- console.error('Error handling local mutation', error);+ } catch {results.push({id: mutation.id,status: 'error',diff --git a/apps/server/src/app.ts b/apps/server/src/app.tsindex 900feabe..93e361e8 100644--- a/apps/server/src/app.ts+++ b/apps/server/src/app.ts@@ -8,7 +8,7 @@ import {} from 'fastify-type-provider-zod';import { clientRoutes } from '@/api/client/routes';-import { ipDecorator } from '@/api/client/plugins/ip';+import { clientDecorator } from '@/api/client/plugins/client';import { errorHandler } from '@/api/client/plugins/error-handler';const debug = createDebugger('server:app');@@ -31,7 +31,7 @@ export const initApp = async () => {});await server.register(fastifyWebsocket);- await server.register(ipDecorator);+ await server.register(clientDecorator);await server.register(clientRoutes, { prefix: '/client/v1' });server.get('/', (_, reply) => {diff --git a/packages/core/src/types/api.ts b/packages/core/src/types/api.tsindex dc94e39c..6b063ac7 100644--- a/packages/core/src/types/api.ts+++ b/packages/core/src/types/api.ts@@ -1,5 +1,11 @@import { z } from 'zod';+export enum ApiHeader {+ ClientType = 'colanode-client-type',+ ClientPlatform = 'colanode-client-platform',+ ClientVersion = 'colanode-client-version',+}+export enum ApiErrorCode {AccountNotFound = 'account_not_found',DeviceNotFound = 'device_not_found',