Skip to content

Open-source and local-first Slack and Notion alternative that puts you in control of your data

Add some logs in the server

Hakan Shehu1e97c0fb3b32
diff --git a/apps/server/package.json b/apps/server/package.json
index c5e92f0d..4bdd13bc 100644
--- a/apps/server/package.json
+++ b/apps/server/package.json
@@ -28,6 +28,7 @@
"@types/pg": "^8.11.10",
"@types/ws": "^8.5.12",
"nodemon": "^3.1.7",
+ "pino-pretty": "^13.0.0",
"tsup": "^8.3.0",
"tsx": "^4.19.2"
},
@@ -48,6 +49,7 @@
"multer": "^1.4.5-lts.1",
"nodemailer": "^6.9.16",
"pg": "^8.13.0",
+ "pino": "^9.5.0",
"postgres": "^3.4.4",
"redis": "^4.7.0",
"sharp": "^0.33.5",
diff --git a/apps/server/src/api.ts b/apps/server/src/api.ts
index b3ed4076..fd631524 100644
--- a/apps/server/src/api.ts
+++ b/apps/server/src/api.ts
@@ -10,6 +10,9 @@ import { configRouter } from '@/routes/config';
import { avatarsRouter } from '@/routes/avatars';
import { filesRouter } from '@/routes/files';
import { synapse } from '@/services/synapse';
+import { logService } from '@/services/log';
+
+const logger = logService.createLogger('api');
export const initApi = async () => {
const app = express();
@@ -37,6 +40,6 @@ export const initApi = async () => {
await synapse.init(server);
server.listen(port, () => {
- console.log(`Server is running at http://localhost:${port}`);
+ logger.info(`Server is running at http://localhost:${port}`);
});
};
diff --git a/apps/server/src/queues/events.ts b/apps/server/src/queues/events.ts
index 482d3bb5..7db079ce 100644
--- a/apps/server/src/queues/events.ts
+++ b/apps/server/src/queues/events.ts
@@ -20,7 +20,10 @@ import {
import { DeleteObjectCommand } from '@aws-sdk/client-s3';
import { Job, Queue, Worker } from 'bullmq';
import { difference } from 'lodash-es';
-import { enqueueTask } from './tasks';
+import { enqueueTask } from '@/queues/tasks';
+import { logService } from '@/services/log';
+
+const logger = logService.createLogger('events');
const eventQueue = new Queue('events', {
connection: {
@@ -35,10 +38,14 @@ const eventQueue = new Queue('events', {
});
export const enqueueEvent = async (event: NodeEvent): Promise<void> => {
+ logger.trace(event, 'Enqueuing event');
+
await eventQueue.add('event', event);
};
export const initEventWorker = () => {
+ logger.info('Initializing event worker');
+
return new Worker('events', handleEventJob, {
connection: {
host: redisConfig.host,
@@ -51,6 +58,7 @@ export const initEventWorker = () => {
const handleEventJob = async (job: Job) => {
const event = job.data as NodeEvent;
+ logger.trace(event, 'Handling event');
switch (event.type) {
case 'node_created':
@@ -89,6 +97,8 @@ const handleNodeUpdatedEvent = async (
const handleNodeDeletedEvent = async (
event: NodeDeletedEvent
): Promise<void> => {
+ logger.trace(event, 'Handling node deleted event');
+
if (event.attributes.type === 'file') {
const command = new DeleteObjectCommand({
Bucket: BUCKET_NAMES.FILES,
@@ -106,6 +116,8 @@ const handleNodeDeletedEvent = async (
};
const createUserNodes = async (event: NodeCreatedEvent): Promise<void> => {
+ logger.trace(event, 'Creating user nodes');
+
const userNodesToCreate: CreateUserNode[] = [];
if (event.attributes.type === NodeTypes.User) {
@@ -191,6 +203,8 @@ const createUserNodes = async (event: NodeCreatedEvent): Promise<void> => {
}
if (userNodesToCreate.length > 0) {
+ logger.trace(userNodesToCreate, 'Creating user nodes');
+
await database
.insertInto('user_nodes')
.values(userNodesToCreate)
@@ -202,6 +216,8 @@ const createUserNodes = async (event: NodeCreatedEvent): Promise<void> => {
const checkForCollaboratorsChange = async (
event: NodeUpdatedEvent
): Promise<void> => {
+ logger.trace(event, 'Checking for collaborators change');
+
const beforeCollaborators = Object.keys(
extractNodeCollaborators(event.beforeAttributes)
);
@@ -308,6 +324,8 @@ const checkForCollaboratorsChange = async (
const checkForUserRoleChange = async (
event: NodeUpdatedEvent
): Promise<void> => {
+ logger.trace(event, 'Checking for user role change');
+
if (
event.beforeAttributes.type !== 'user' ||
event.afterAttributes.type !== 'user'
diff --git a/apps/server/src/services/log.ts b/apps/server/src/services/log.ts
new file mode 100644
index 00000000..d2607b15
--- /dev/null
+++ b/apps/server/src/services/log.ts
@@ -0,0 +1,26 @@
+import pino, { Level } from 'pino';
+const isDev = true; //process.env.NODE_ENV === 'development';
+
+const logConfig: Record<string, Level> = {
+ api: 'trace',
+ 'synapse-service': 'trace',
+};
+
+class LogService {
+ public createLogger(name: string) {
+ return pino({
+ name,
+ level: logConfig[name] || 'info',
+ transport: isDev
+ ? {
+ target: 'pino-pretty',
+ options: {
+ colorize: true,
+ },
+ }
+ : undefined,
+ });
+ }
+}
+
+export const logService = new LogService();
diff --git a/apps/server/src/services/synapse.ts b/apps/server/src/services/synapse.ts
index f4b71bef..bf1d47d4 100644
--- a/apps/server/src/services/synapse.ts
+++ b/apps/server/src/services/synapse.ts
@@ -11,7 +11,8 @@ import {
} from '@/types/synapse';
import { getIdType, IdType } from '@colanode/core';
import { Message } from '@colanode/core';
-import { fromUint8Array } from 'js-base64';
+import { logService } from '@/services/log';
+import { encodeState } from '@colanode/crdt';
interface SynapseConnection {
accountId: string;
@@ -26,9 +27,12 @@ interface SynapseConnection {
}
class SynapseService {
+ private readonly logger = logService.createLogger('synapse-service');
private readonly connections: Map<string, SynapseConnection> = new Map();
public async init(server: Server) {
+ this.logger.info('Initializing synapse service');
+
const wss = new WebSocketServer({
server,
path: '/v1/synapse',
@@ -58,6 +62,7 @@ class SynapseService {
}
const account = result.account;
+ this.logger.info(`New synapse connection from ${account.id}`);
socket.on('close', () => {
const connection = this.connections.get(account.deviceId);
@@ -104,6 +109,8 @@ class SynapseService {
connection: SynapseConnection,
message: Message
) {
+ this.logger.trace(message, `Socket message from ${connection.deviceId}`);
+
if (message.type === 'local_node_sync') {
await database
.insertInto('device_nodes')
@@ -200,6 +207,8 @@ class SynapseService {
private async handleSynapseMessage(message: string) {
const data: SynapseMessage = JSON.parse(message);
+ this.logger.trace(data, 'Synapse message');
+
if (
data.type === 'node_create' ||
data.type === 'node_update' ||
@@ -227,6 +236,11 @@ class SynapseService {
return;
}
+ this.logger.trace(
+ userIds,
+ `Broadcasting node change for ${data.nodeId} to ${userIds.length} users`
+ );
+
const userNodes = await database
.selectFrom('user_nodes')
.selectAll()
@@ -303,7 +317,7 @@ class SynapseService {
node: {
id: node.id,
workspaceId: data.workspaceId,
- state: fromUint8Array(node.state),
+ state: encodeState(node.state),
createdAt: node.created_at.toISOString(),
createdBy: node.created_by,
updatedAt: node.updated_at?.toISOString() ?? null,
@@ -376,12 +390,15 @@ class SynapseService {
(workspaceUser) => workspaceUser.userId
);
- console.log('sendPendingChanges', userIds);
-
if (userIds.length === 0) {
return;
}
+ this.logger.trace(
+ userIds,
+ `Sending pending changes for ${connection.deviceId} with ${userIds.length} users`
+ );
+
const unsyncedNodes = await database
.selectFrom('user_nodes as nus')
.leftJoin('nodes as n', 'n.id', 'nus.node_id')
@@ -451,7 +468,7 @@ class SynapseService {
node: {
id: row.id,
workspaceId: row.workspace_id,
- state: fromUint8Array(row.state!),
+ state: encodeState(row.state!),
createdAt: row.created_at!.toISOString(),
createdBy: row.created_by!,
updatedAt: row.updated_at?.toISOString() ?? null,
@@ -483,6 +500,11 @@ class SynapseService {
}
private async addNewWorkspaceUser(userId: string, workspaceId: string) {
+ this.logger.trace(
+ userId,
+ `Adding new workspace user ${userId} to ${workspaceId}`
+ );
+
const workspaceUser = await database
.selectFrom('workspace_users')
.selectAll()
diff --git a/package-lock.json b/package-lock.json
index 6874dc6f..59e73042 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -146,6 +146,7 @@
"multer": "^1.4.5-lts.1",
"nodemailer": "^6.9.16",
"pg": "^8.13.0",
+ "pino": "^9.5.0",
"postgres": "^3.4.4",
"redis": "^4.7.0",
"sharp": "^0.33.5",
@@ -161,6 +162,7 @@
"@types/pg": "^8.11.10",
"@types/ws": "^8.5.12",
"nodemon": "^3.1.7",
+ "pino-pretty": "^13.0.0",
"tsup": "^8.3.0",
"tsx": "^4.19.2"
}