create logger package

Author: msukkari

packages/backend/package.json

@@ -23,15 +23,14 @@
     },
     "dependencies": {
         "@gitbeaker/rest": "^40.5.1",
-        "@logtail/node": "^0.5.2",
-        "@logtail/winston": "^0.5.2",
         "@octokit/rest": "^21.0.2",
         "@sentry/cli": "^2.42.2",
         "@sentry/node": "^9.3.0",
         "@sentry/profiling-node": "^9.3.0",
         "@sourcebot/crypto": "workspace:*",
         "@sourcebot/db": "workspace:*",
         "@sourcebot/error": "workspace:*",
+        "@sourcebot/logger": "workspace:*",
         "@sourcebot/schemas": "workspace:*",
         "@t3-oss/env-core": "^0.12.0",
         "@types/express": "^5.0.0",
@@ -51,7 +50,6 @@
         "prom-client": "^15.1.3",
         "simple-git": "^3.27.0",
         "strip-json-comments": "^5.0.1",
-        "winston": "^3.15.0",
         "zod": "^3.24.3"
     }
 }

packages/backend/src/bitbucket.ts

@@ -2,7 +2,7 @@ import { createBitbucketCloudClient } from "@coderabbitai/bitbucket/cloud";
 import { createBitbucketServerClient } from "@coderabbitai/bitbucket/server";
 import { BitbucketConnectionConfig } from "@sourcebot/schemas/v3/bitbucket.type";
 import type { ClientOptions, ClientPathsWithMethod } from "openapi-fetch";
-import { createLogger } from "./logger.js";
+import { createLogger } from "@sourcebot/logger";
 import { PrismaClient } from "@sourcebot/db";
 import { getTokenFromConfig, measure, fetchWithRetry } from "./utils.js";
 import * as Sentry from "@sentry/node";
@@ -13,7 +13,7 @@ import { SchemaRestRepository as ServerRepository } from "@coderabbitai/bitbucke
 import { processPromiseResults } from "./connectionUtils.js";
 import { throwIfAnyFailed } from "./connectionUtils.js";
 
-const logger = createLogger("Bitbucket");
+const logger = createLogger('bitbucket');
 const BITBUCKET_CLOUD_GIT = 'https://bitbucket.org';
 const BITBUCKET_CLOUD_API = 'https://api.bitbucket.org/2.0';
 const BITBUCKET_CLOUD = "cloud";

packages/backend/src/connectionManager.ts

@@ -2,7 +2,7 @@ import { Connection, ConnectionSyncStatus, PrismaClient, Prisma } from "@sourceb
 import { Job, Queue, Worker } from 'bullmq';
 import { Settings } from "./types.js";
 import { ConnectionConfig } from "@sourcebot/schemas/v3/connection.type";
-import { createLogger } from "./logger.js";
+import { createLogger } from "@sourcebot/logger";
 import { Redis } from 'ioredis';
 import { RepoData, compileGithubConfig, compileGitlabConfig, compileGiteaConfig, compileGerritConfig, compileBitbucketConfig, compileGenericGitHostConfig } from "./repoCompileUtils.js";
 import { BackendError, BackendException } from "@sourcebot/error";
@@ -32,7 +32,7 @@ type JobResult = {
 export class ConnectionManager implements IConnectionManager {
     private worker: Worker;
     private queue: Queue<JobPayload>;
-    private logger = createLogger('ConnectionManager');
+    private logger = createLogger('connection-manager');
 
     constructor(
         private db: PrismaClient,

packages/backend/src/gerrit.ts

@@ -1,6 +1,6 @@
 import fetch from 'cross-fetch';
 import { GerritConnectionConfig } from "@sourcebot/schemas/v3/index.type"
-import { createLogger } from './logger.js';
+import { createLogger } from '@sourcebot/logger';
 import micromatch from "micromatch";
 import { measure, fetchWithRetry } from './utils.js';
 import { BackendError } from '@sourcebot/error';
@@ -33,7 +33,7 @@ interface GerritWebLink {
    url: string;
 }
 
-const logger = createLogger('Gerrit');
+const logger = createLogger('gerrit');
 
 export const getGerritReposFromConfig = async (config: GerritConnectionConfig): Promise<GerritProject[]> => {
    const url = config.url.endsWith('/') ? config.url : `${config.url}/`;
@@ -95,7 +95,7 @@ const fetchAllProjects = async (url: string): Promise<GerritProject[]> => {
       try {
          response = await fetch(endpointWithParams);
          if (!response.ok) {
-            console.log(`Failed to fetch projects from Gerrit at ${endpointWithParams} with status ${response.status}`);
+            logger.error(`Failed to fetch projects from Gerrit at ${endpointWithParams} with status ${response.status}`);
             const e = new BackendException(BackendError.CONNECTION_SYNC_FAILED_TO_FETCH_GERRIT_PROJECTS, {
                status: response.status,
             });
@@ -109,7 +109,7 @@ const fetchAllProjects = async (url: string): Promise<GerritProject[]> => {
          }
 
          const status = (err as any).code;
-         console.log(`Failed to fetch projects from Gerrit at ${endpointWithParams} with status ${status}`);
+         logger.error(`Failed to fetch projects from Gerrit at ${endpointWithParams} with status ${status}`);
          throw new BackendException(BackendError.CONNECTION_SYNC_FAILED_TO_FETCH_GERRIT_PROJECTS, {
             status: status,
          });

packages/backend/src/gitea.ts

@@ -2,14 +2,14 @@ import { Api, giteaApi, HttpResponse, Repository as GiteaRepository } from 'gite
 import { GiteaConnectionConfig } from '@sourcebot/schemas/v3/gitea.type';
 import { getTokenFromConfig, measure } from './utils.js';
 import fetch from 'cross-fetch';
-import { createLogger } from './logger.js';
+import { createLogger } from '@sourcebot/logger';
 import micromatch from 'micromatch';
 import { PrismaClient } from '@sourcebot/db';
 import { processPromiseResults, throwIfAnyFailed } from './connectionUtils.js';
 import * as Sentry from "@sentry/node";
 import { env } from './env.js';
 
-const logger = createLogger('Gitea');
+const logger = createLogger('gitea');
 const GITEA_CLOUD_HOSTNAME = "gitea.com";
 
 export const getGiteaReposFromConfig = async (config: GiteaConnectionConfig, orgId: number, db: PrismaClient) => {

packages/backend/src/github.ts

@@ -1,6 +1,6 @@
 import { Octokit } from "@octokit/rest";
 import { GithubConnectionConfig } from "@sourcebot/schemas/v3/github.type";
-import { createLogger } from "./logger.js";
+import { createLogger } from "@sourcebot/logger";
 import { getTokenFromConfig, measure, fetchWithRetry } from "./utils.js";
 import micromatch from "micromatch";
 import { PrismaClient } from "@sourcebot/db";
@@ -9,7 +9,7 @@ import { processPromiseResults, throwIfAnyFailed } from "./connectionUtils.js";
 import * as Sentry from "@sentry/node";
 import { env } from "./env.js";
 
-const logger = createLogger("GitHub");
+const logger = createLogger('github');
 const GITHUB_CLOUD_HOSTNAME = "github.com";
 
 export type OctokitRepository = {

packages/backend/src/gitlab.ts

@@ -1,14 +1,14 @@
 import { Gitlab, ProjectSchema } from "@gitbeaker/rest";
 import micromatch from "micromatch";
-import { createLogger } from "./logger.js";
+import { createLogger } from "@sourcebot/logger";
 import { GitlabConnectionConfig } from "@sourcebot/schemas/v3/gitlab.type"
 import { getTokenFromConfig, measure, fetchWithRetry } from "./utils.js";
 import { PrismaClient } from "@sourcebot/db";
 import { processPromiseResults, throwIfAnyFailed } from "./connectionUtils.js";
 import * as Sentry from "@sentry/node";
 import { env } from "./env.js";
 
-const logger = createLogger("GitLab");
+const logger = createLogger('gitlab');
 export const GITLAB_CLOUD_HOSTNAME = "gitlab.com";
 
 export const getGitLabReposFromConfig = async (config: GitlabConnectionConfig, orgId: number, db: PrismaClient) => {

packages/backend/src/index.ts

@@ -8,31 +8,34 @@ import { AppContext } from "./types.js";
 import { main } from "./main.js"
 import { PrismaClient } from "@sourcebot/db";
 import { env } from "./env.js";
+import { createLogger } from "@sourcebot/logger";
+
+const logger = createLogger('index');
 
 // Register handler for normal exit
 process.on('exit', (code) => {
-    console.log(`Process is exiting with code: ${code}`);
+    logger.info(`Process is exiting with code: ${code}`);
 });
 
 // Register handlers for abnormal terminations
 process.on('SIGINT', () => {
-    console.log('Process interrupted (SIGINT)');
-    process.exit(130);
+    logger.info('Process interrupted (SIGINT)');
+    process.exit(0);
 });
 
 process.on('SIGTERM', () => {
-    console.log('Process terminated (SIGTERM)');
-    process.exit(143);
+    logger.info('Process terminated (SIGTERM)');
+    process.exit(0);
 });
 
 // Register handlers for uncaught exceptions and unhandled rejections
 process.on('uncaughtException', (err) => {
-    console.log(`Uncaught exception: ${err.message}`);
+    logger.error(`Uncaught exception: ${err.message}`);
     process.exit(1);
 });
 
 process.on('unhandledRejection', (reason, promise) => {
-    console.log(`Unhandled rejection at: ${promise}, reason: ${reason}`);
+    logger.error(`Unhandled rejection at: ${promise}, reason: ${reason}`);
     process.exit(1);
 });
 
@@ -60,12 +63,12 @@ main(prisma, context)
         await prisma.$disconnect();
     })
     .catch(async (e) => {
-        console.error(e);
+        logger.error(e);
         Sentry.captureException(e);
 
         await prisma.$disconnect();
         process.exit(1);
     })
     .finally(() => {
-        console.log("Shutting down...");
+        logger.info("Shutting down...");
     });

packages/backend/src/instrument.ts

@@ -1,5 +1,8 @@
 import * as Sentry from "@sentry/node";
 import { env } from "./env.js";
+import { createLogger } from "@sourcebot/logger";
+
+const logger = createLogger('instrument');
 
 if (!!env.NEXT_PUBLIC_SENTRY_BACKEND_DSN && !!env.NEXT_PUBLIC_SENTRY_ENVIRONMENT) {
     Sentry.init({
@@ -8,5 +11,5 @@ if (!!env.NEXT_PUBLIC_SENTRY_BACKEND_DSN && !!env.NEXT_PUBLIC_SENTRY_ENVIRONMENT
         environment: env.NEXT_PUBLIC_SENTRY_ENVIRONMENT,
     });
 } else {
-    console.debug("Sentry was not initialized");
+    logger.debug("Sentry was not initialized");
 }

packages/backend/src/main.ts

@@ -1,5 +1,5 @@
 import { PrismaClient } from '@sourcebot/db';
-import { createLogger } from "./logger.js";
+import { createLogger } from "@sourcebot/logger";
 import { AppContext } from "./types.js";
 import { DEFAULT_SETTINGS } from './constants.js';
 import { Redis } from 'ioredis';
@@ -14,7 +14,7 @@ import { SourcebotConfig } from '@sourcebot/schemas/v3/index.type';
 import { indexSchema } from '@sourcebot/schemas/v3/index.schema';
 import { Ajv } from "ajv";
 
-const logger = createLogger('main');
+const logger = createLogger('backend-main');
 const ajv = new Ajv({
     validateFormats: false,
 });
@@ -56,7 +56,7 @@ export const main = async (db: PrismaClient, context: AppContext) => {
         logger.info('Connected to redis');
     }).catch((err: unknown) => {
         logger.error('Failed to connect to redis');
-        console.error(err);
+        logger.error(err);
         process.exit(1);
     });