Skip to content

armgit / papra

Public Imported from GitHub
0

The minimalistic document archiving platform.

feat(server): refactor server initialization and DI management (#666)

Corentin Thomassetfcd440cbbb26
diff --git a/apps/papra-server/src/index.ts b/apps/papra-server/src/index.ts
index 68839695..e73bb5d5 100644
--- a/apps/papra-server/src/index.ts
+++ b/apps/papra-server/src/index.ts
@@ -1,105 +1,6 @@
/* eslint-disable antfu/no-top-level-await */
-import process, { env } from 'node:process';
-import { serve } from '@hono/node-server';
-import { setupDatabase } from './modules/app/database/database';
-import { ensureLocalDatabaseDirectoryExists } from './modules/app/database/database.services';
-import { registerEventHandlers } from './modules/app/events/events.handlers';
-import { createEventServices } from './modules/app/events/events.services';
-import { createGracefulShutdownService } from './modules/app/graceful-shutdown/graceful-shutdown.services';
-import { createServer } from './modules/app/server';
-import { parseConfig } from './modules/config/config';
-import { createDocumentStorageService } from './modules/documents/storage/documents.storage.services';
-import { createIngestionFolderWatcher } from './modules/ingestion-folders/ingestion-folders.usecases';
-import { addToGlobalLogContext, createLogger } from './modules/shared/logger/logger';
-import { registerTaskDefinitions } from './modules/tasks/tasks.definitions';
-import { createTaskServices } from './modules/tasks/tasks.services';
-import { createTrackingServices } from './modules/tracking/tracking.services';
+import { registerShutdownHooks } from './modules/app/graceful-shutdown/graceful-shutdown.usecases';
+import { startApp } from './start';
-const logger = createLogger({ namespace: 'app-server' });
-
-const { config } = await parseConfig({ env });
-
-addToGlobalLogContext({ processMode: config.processMode });
-
-const isWebMode = config.processMode === 'all' || config.processMode === 'web';
-const isWorkerMode = config.processMode === 'all' || config.processMode === 'worker';
-
-logger.info({ processMode: config.processMode, isWebMode, isWorkerMode }, 'Starting application');
-
-// Shutdown callback collector
-const shutdownService = createGracefulShutdownService({ logger });
-const { registerShutdownHandler } = shutdownService;
-
-await ensureLocalDatabaseDirectoryExists({ config });
-const { db } = setupDatabase({ ...config.database, registerShutdownHandler });
-
-const documentsStorageService = createDocumentStorageService({ documentStorageConfig: config.documentsStorage });
-
-const taskServices = createTaskServices({ config });
-await taskServices.initialize();
-
-const trackingServices = createTrackingServices({ config });
-const eventServices = createEventServices();
-registerEventHandlers({ eventServices, trackingServices });
-
-if (isWebMode) {
- const { app } = await createServer({ config, db, taskServices, documentsStorageService, eventServices, trackingServices });
-
- const server = serve(
- {
- fetch: app.fetch,
- port: config.server.port,
- hostname: config.server.hostname,
- },
- ({ port }) => logger.info({ port }, 'Server started'),
- );
-
- registerShutdownHandler({
- id: 'web-server-close',
- handler: () => {
- server.close();
- },
- });
-}
-
-if (isWorkerMode) {
- if (config.ingestionFolder.isEnabled) {
- const { startWatchingIngestionFolders } = createIngestionFolderWatcher({
- taskServices,
- config,
- db,
- documentsStorageService,
- });
-
- await startWatchingIngestionFolders();
- }
-
- await registerTaskDefinitions({ taskServices, db, config, documentsStorageService });
-
- taskServices.start();
- logger.info('Worker started');
-}
-
-// Global error handlers
-process.on('uncaughtException', (error) => {
- logger.error({ error }, 'Uncaught exception');
- setTimeout(() => process.exit(1), 1000); // Give the logger time to flush before exiting
-});
-
-process.on('unhandledRejection', (error) => {
- logger.error({ error }, 'Unhandled promise rejection');
- setTimeout(() => process.exit(1), 1000); // Give the logger time to flush before exiting
-});
-
-// Graceful shutdown handler
-async function gracefulShutdown(signal: string) {
- logger.info({ signal }, 'Received shutdown signal, shutting down gracefully...');
-
- await shutdownService.executeShutdownHandlers();
-
- logger.info('Shutdown complete, exiting process');
- process.exit(0);
-}
-
-process.on('SIGINT', () => void gracefulShutdown('SIGINT'));
-process.on('SIGTERM', () => void gracefulShutdown('SIGTERM'));
+const { shutdownServices } = await startApp();
+registerShutdownHooks({ shutdownServices });
diff --git a/apps/papra-server/src/modules/api-keys/e2e/create-document-with-api-key.e2e.test.ts b/apps/papra-server/src/modules/api-keys/e2e/create-document-with-api-key.e2e.test.ts
index c73571fe..b4a49745 100644
--- a/apps/papra-server/src/modules/api-keys/e2e/create-document-with-api-key.e2e.test.ts
+++ b/apps/papra-server/src/modules/api-keys/e2e/create-document-with-api-key.e2e.test.ts
@@ -2,6 +2,7 @@ import type { Document } from '../../documents/documents.types';
import { describe, expect, test } from 'vitest';
import { createInMemoryDatabase } from '../../app/database/database.test-utils';
import { createServer } from '../../app/server';
+import { createTestServerDependencies } from '../../app/server.test-utils';
import { overrideConfig } from '../../config/config.test-utils';
import { ORGANIZATION_ROLES } from '../../organizations/organizations.constants';
@@ -13,7 +14,7 @@ describe('api-key e2e', () => {
organizationMembers: [{ organizationId: 'org_222222222222222222222222', userId: 'usr_111111111111111111111111', role: ORGANIZATION_ROLES.OWNER }],
});
- const { app } = await createServer({
+ const { app } = createServer(createTestServerDependencies({
db,
config: overrideConfig({
env: 'test',
@@ -21,7 +22,7 @@ describe('api-key e2e', () => {
driver: 'in-memory',
},
}),
- });
+ }));
const createApiKeyResponse = await app.request(
'/api/api-keys',
diff --git a/apps/papra-server/src/modules/app/auth/e2e/email-verification.e2e.test.ts b/apps/papra-server/src/modules/app/auth/e2e/email-verification.e2e.test.ts
index c92cf548..ed7b24e0 100644
--- a/apps/papra-server/src/modules/app/auth/e2e/email-verification.e2e.test.ts
+++ b/apps/papra-server/src/modules/app/auth/e2e/email-verification.e2e.test.ts
@@ -3,6 +3,7 @@ import { overrideConfig } from '../../../config/config.test-utils';
import { createInMemoryDatabase } from '../../database/database.test-utils';
import { createEventServices } from '../../events/events.services';
import { createServer } from '../../server';
+import { createTestServerDependencies } from '../../server.test-utils';
import { createAuthEmailsServices } from '../auth.emails.services';
import { getAuth } from '../auth.services';
@@ -37,7 +38,7 @@ describe('email verification e2e', () => {
const authEmailsServices = createAuthEmailsServices({ emailsServices: mockEmailsServices });
const { auth } = getAuth({ db, config, authEmailsServices, eventServices: createEventServices() });
- const { app } = await createServer({ db, config, auth });
+ const { app } = createServer(createTestServerDependencies({ db, config, auth }));
const response = await app.request('/api/auth/sign-up/email', {
method: 'POST',
@@ -78,7 +79,7 @@ describe('email verification e2e', () => {
const authEmailsServices = createAuthEmailsServices({ emailsServices: mockEmailsServices });
const { auth } = getAuth({ db, config, authEmailsServices, eventServices: createEventServices() });
- const { app } = await createServer({ db, config, auth });
+ const { app } = createServer(createTestServerDependencies({ db, config, auth }));
// First, sign up
await app.request('/api/auth/sign-up/email', {
@@ -138,7 +139,7 @@ describe('email verification e2e', () => {
const authEmailsServices = createAuthEmailsServices({ emailsServices: mockEmailsServices });
const { auth } = getAuth({ db, config, authEmailsServices, eventServices: createEventServices() });
- const { app } = await createServer({ db, config, auth });
+ const { app } = createServer(createTestServerDependencies({ db, config, auth }));
const response = await app.request('/api/auth/sign-up/email', {
method: 'POST',
@@ -169,7 +170,7 @@ describe('email verification e2e', () => {
const authEmailsServices = createAuthEmailsServices({ emailsServices: mockEmailsServices });
const { auth } = getAuth({ db, config, authEmailsServices, eventServices: createEventServices() });
- const { app } = await createServer({ db, config, auth });
+ const { app } = createServer(createTestServerDependencies({ db, config, auth }));
// Sign up
await app.request('/api/auth/sign-up/email', {
diff --git a/apps/papra-server/src/modules/app/database/database.ts b/apps/papra-server/src/modules/app/database/database.ts
index 66b017d2..49c250b7 100644
--- a/apps/papra-server/src/modules/app/database/database.ts
+++ b/apps/papra-server/src/modules/app/database/database.ts
@@ -1,4 +1,4 @@
-import type { ShutdownHandlerRegistration } from '../graceful-shutdown/graceful-shutdown.services';
+import type { ShutdownServices } from '../graceful-shutdown/graceful-shutdown.services';
import { createClient } from '@libsql/client';
import { drizzle } from 'drizzle-orm/libsql';
@@ -8,18 +8,18 @@ function setupDatabase({
url,
authToken,
encryptionKey,
- registerShutdownHandler,
+ shutdownServices,
}: {
url: string;
authToken?: string;
encryptionKey?: string;
- registerShutdownHandler?: ShutdownHandlerRegistration;
+ shutdownServices?: ShutdownServices;
}) {
const client = createClient({ url, authToken, encryptionKey });
const db = drizzle(client);
- registerShutdownHandler?.({
+ shutdownServices?.registerShutdownHandler({
id: 'database-client-close',
handler: () => client.close(),
});
diff --git a/apps/papra-server/src/modules/app/graceful-shutdown/graceful-shutdown.services.ts b/apps/papra-server/src/modules/app/graceful-shutdown/graceful-shutdown.services.ts
index 1c8e961b..d931ce4d 100644
--- a/apps/papra-server/src/modules/app/graceful-shutdown/graceful-shutdown.services.ts
+++ b/apps/papra-server/src/modules/app/graceful-shutdown/graceful-shutdown.services.ts
@@ -7,6 +7,8 @@ export type ShutdownHandlerConfig = {
};
export type ShutdownHandlerRegistration = (handlerConfig: ShutdownHandlerConfig) => void;
+export type ShutdownServices = ReturnType<typeof createGracefulShutdownService>;
+
export function createGracefulShutdownService({ logger = createLogger({ namespace: 'graceful-shutdown' }) }: { logger?: Logger } = {}) {
const shutdownHandlers: ShutdownHandlerConfig[] = [];
diff --git a/apps/papra-server/src/modules/app/graceful-shutdown/graceful-shutdown.usecases.ts b/apps/papra-server/src/modules/app/graceful-shutdown/graceful-shutdown.usecases.ts
new file mode 100644
index 00000000..3af45cd2
--- /dev/null
+++ b/apps/papra-server/src/modules/app/graceful-shutdown/graceful-shutdown.usecases.ts
@@ -0,0 +1,30 @@
+import type { Logger } from '../../shared/logger/logger';
+import type { ShutdownServices } from './graceful-shutdown.services';
+import process from 'node:process';
+import { createLogger } from '../../shared/logger/logger';
+
+async function gracefulShutdown({ signal, cause, shutdownServices, logger, exitCode = 0 }: { signal?: string; cause: string; shutdownServices: ShutdownServices; logger: Logger; exitCode?: number }) {
+ logger.info({ signal, cause }, 'Shutting down gracefully...');
+
+ await shutdownServices.executeShutdownHandlers();
+
+ logger.info('Shutdown complete, exiting process');
+
+ // Let logs flush
+ setTimeout(() => process.exit(exitCode), 500);
+}
+
+export function registerShutdownHooks({ shutdownServices, logger = createLogger({ namespace: 'graceful-shutdown' }) }: { shutdownServices: ShutdownServices; logger?: Logger }) {
+ process.on('uncaughtException', (error) => {
+ logger.error({ error }, 'Uncaught exception');
+ void gracefulShutdown({ cause: 'uncaughtException', shutdownServices, logger, exitCode: 1 });
+ });
+
+ process.on('unhandledRejection', (error) => {
+ logger.error({ error }, 'Unhandled promise rejection');
+ void gracefulShutdown({ cause: 'unhandledRejection', shutdownServices, logger, exitCode: 1 });
+ });
+
+ process.on('SIGINT', () => void gracefulShutdown({ cause: 'Interrupt signal', signal: 'SIGINT', shutdownServices, logger }));
+ process.on('SIGTERM', () => void gracefulShutdown({ cause: 'Termination signal', signal: 'SIGTERM', shutdownServices, logger }));
+}
diff --git a/apps/papra-server/src/modules/app/health-check/e2e/health-check.e2e.test.ts b/apps/papra-server/src/modules/app/health-check/e2e/health-check.e2e.test.ts
index a0e78842..48678b29 100644
--- a/apps/papra-server/src/modules/app/health-check/e2e/health-check.e2e.test.ts
+++ b/apps/papra-server/src/modules/app/health-check/e2e/health-check.e2e.test.ts
@@ -3,13 +3,14 @@ import { describe, expect, test } from 'vitest';
import { overrideConfig } from '../../../config/config.test-utils';
import { createInMemoryDatabase } from '../../database/database.test-utils';
import { createServer } from '../../server';
+import { createTestServerDependencies } from '../../server.test-utils';
describe('health check routes e2e', () => {
describe('health check', () => {
describe('the /api/health is a publicly accessible route that provides health information about the server', () => {
test('when the database is healthy, the /api/health returns 200', async () => {
const { db } = await createInMemoryDatabase();
- const { app } = await createServer({ db, config: overrideConfig() });
+ const { app } = createServer(createTestServerDependencies({ db, config: overrideConfig() }));
const response = await app.request('/api/health');
@@ -28,7 +29,7 @@ describe('health check routes e2e', () => {
},
} as unknown as Database;
- const { app } = await createServer({ db, config: overrideConfig() });
+ const { app } = createServer(createTestServerDependencies({ db, config: overrideConfig() }));
const response = await app.request('/api/health');
diff --git a/apps/papra-server/src/modules/app/health-check/e2e/ping.e2e.test.ts b/apps/papra-server/src/modules/app/health-check/e2e/ping.e2e.test.ts
index 4e1ca387..b98f5acd 100644
--- a/apps/papra-server/src/modules/app/health-check/e2e/ping.e2e.test.ts
+++ b/apps/papra-server/src/modules/app/health-check/e2e/ping.e2e.test.ts
@@ -2,11 +2,12 @@ import { describe, expect, test } from 'vitest';
import { overrideConfig } from '../../../config/config.test-utils';
import { createInMemoryDatabase } from '../../database/database.test-utils';
import { createServer } from '../../server';
+import { createTestServerDependencies } from '../../server.test-utils';
describe('ping routes e2e', () => {
test('the /api/ping is a publicly accessible route that always returns a 200 with a status ok', async () => {
const { db } = await createInMemoryDatabase();
- const { app } = await createServer({ db, config: overrideConfig() });
+ const { app } = createServer(createTestServerDependencies({ db, config: overrideConfig() }));
const response = await app.request('/api/ping');
diff --git a/apps/papra-server/src/modules/app/process.models.test.ts b/apps/papra-server/src/modules/app/process.models.test.ts
new file mode 100644
index 00000000..6bc0321a
--- /dev/null
+++ b/apps/papra-server/src/modules/app/process.models.test.ts
@@ -0,0 +1,36 @@
+import { describe, expect, test } from 'vitest';
+import { getProcessMode } from './process.models';
+
+describe('process models', () => {
+ describe('getProcessMode', () => {
+ test('when the process mode is set to all, the api server and worker should be enabled', () => {
+ expect(
+ getProcessMode({ config: { processMode: 'all' } }),
+ ).to.eql({
+ isWebMode: true,
+ isWorkerMode: true,
+ processMode: 'all',
+ });
+ });
+
+ test('when the process mode is set to web, only the api server should be enabled', () => {
+ expect(
+ getProcessMode({ config: { processMode: 'web' } }),
+ ).to.eql({
+ isWebMode: true,
+ isWorkerMode: false,
+ processMode: 'web',
+ });
+ });
+
+ test('when the process mode is set to worker, only the worker should be enabled', () => {
+ expect(
+ getProcessMode({ config: { processMode: 'worker' } }),
+ ).to.eql({
+ isWebMode: false,
+ isWorkerMode: true,
+ processMode: 'worker',
+ });
+ });
+ });
+});
diff --git a/apps/papra-server/src/modules/app/process.models.ts b/apps/papra-server/src/modules/app/process.models.ts
new file mode 100644
index 00000000..d148c086
--- /dev/null
+++ b/apps/papra-server/src/modules/app/process.models.ts
@@ -0,0 +1,9 @@
+export function getProcessMode({ config }: { config: { processMode: 'web' | 'worker' | 'all' } }) {
+ const { processMode } = config;
+
+ return {
+ isWebMode: processMode === 'all' || processMode === 'web',
+ isWorkerMode: processMode === 'all' || processMode === 'worker',
+ processMode,
+ };
+}
diff --git a/apps/papra-server/src/modules/app/server.routes.test.ts b/apps/papra-server/src/modules/app/server.routes.test.ts
index cbbfce8d..34098bae 100644
--- a/apps/papra-server/src/modules/app/server.routes.test.ts
+++ b/apps/papra-server/src/modules/app/server.routes.test.ts
@@ -3,6 +3,7 @@ import { describe, expect, test } from 'vitest';
import { overrideConfig } from '../config/config.test-utils';
import { createInMemoryDatabase } from './database/database.test-utils';
import { createServer } from './server';
+import { createTestServerDependencies } from './server.test-utils';
function setValidParams(path: string) {
const newPath = path
@@ -28,7 +29,7 @@ function setValidParams(path: string) {
describe('server routes', () => {
test('all routes should respond with a 401 when non-authenticated, except for public and auth-related routes', async () => {
const { db } = await createInMemoryDatabase();
- const { app } = await createServer({ db, config: overrideConfig() });
+ const { app } = createServer(createTestServerDependencies({ db, config: overrideConfig() }));
const publicRoutes = [
'GET /api/ping',
diff --git a/apps/papra-server/src/modules/app/server.test-utils.ts b/apps/papra-server/src/modules/app/server.test-utils.ts
new file mode 100644
index 00000000..95cd6c5d
--- /dev/null
+++ b/apps/papra-server/src/modules/app/server.test-utils.ts
@@ -0,0 +1,47 @@
+import type { GlobalDependencies } from './server.types';
+
+import { overrideConfig } from '../config/config.test-utils';
+import { createDocumentSearchServices } from '../documents/document-search/document-search.registry';
+import { createDocumentStorageService } from '../documents/storage/documents.storage.services';
+import { createEmailsServices } from '../emails/emails.services';
+import { createSubscriptionsServices } from '../subscriptions/subscriptions.services';
+import { createInMemoryTaskServices } from '../tasks/tasks.test-utils';
+import { createDummyTrackingServices } from '../tracking/tracking.services';
+import { createAuthEmailsServices } from './auth/auth.emails.services';
+import { getAuth } from './auth/auth.services';
+import { setupDatabase } from './database/database';
+import { registerEventHandlers } from './events/events.handlers';
+import { createEventServices } from './events/events.services';
+import { createGracefulShutdownService } from './graceful-shutdown/graceful-shutdown.services';
+
+export function createTestServerDependencies(overrides: Partial<GlobalDependencies> = {}): GlobalDependencies {
+ const config = overrides.config ?? overrideConfig();
+ const shutdownServices = overrides.shutdownServices ?? createGracefulShutdownService();
+ const db = overrides.db ?? setupDatabase({ ...config.database, shutdownServices }).db;
+
+ const documentsStorageService = overrides.documentsStorageService ?? createDocumentStorageService({ documentStorageConfig: config.documentsStorage });
+ const taskServices = overrides.taskServices ?? createInMemoryTaskServices();
+ const trackingServices = overrides.trackingServices ?? createDummyTrackingServices();
+ const eventServices = overrides.eventServices ?? createEventServices();
+ const emailsServices = overrides.emailsServices ?? createEmailsServices({ config });
+ const authEmailsServices = createAuthEmailsServices({ emailsServices });
+ const auth = overrides.auth ?? getAuth({ db, config, authEmailsServices, eventServices }).auth;
+ const subscriptionsServices = overrides.subscriptionsServices ?? createSubscriptionsServices({ config });
+ const documentSearchServices = overrides.documentSearchServices ?? createDocumentSearchServices({ db, config });
+
+ registerEventHandlers({ eventServices, trackingServices });
+
+ return {
+ config,
+ db,
+ shutdownServices,
+ documentsStorageService,
+ taskServices,
+ trackingServices,
+ eventServices,
+ emailsServices,
+ auth,
+ subscriptionsServices,
+ documentSearchServices,
+ };
+}
diff --git a/apps/papra-server/src/modules/app/server.ts b/apps/papra-server/src/modules/app/server.ts
index 9db08a75..858e26b4 100644
--- a/apps/papra-server/src/modules/app/server.ts
+++ b/apps/papra-server/src/modules/app/server.ts
@@ -1,54 +1,17 @@
import type { GlobalDependencies, ServerInstanceGenerics } from './server.types';
+import { serve } from '@hono/node-server';
import { Hono } from 'hono';
import { secureHeaders } from 'hono/secure-headers';
import { createApiKeyMiddleware } from '../api-keys/api-keys.middlewares';
-import { parseConfig } from '../config/config';
-import { createDocumentSearchServices } from '../documents/document-search/document-search.registry';
-import { createDocumentStorageService } from '../documents/storage/documents.storage.services';
-import { createEmailsServices } from '../emails/emails.services';
import { createLoggerMiddleware } from '../shared/logger/logger.middleware';
-import { createSubscriptionsServices } from '../subscriptions/subscriptions.services';
-import { createTaskServices } from '../tasks/tasks.services';
-import { createTrackingServices } from '../tracking/tracking.services';
-import { createAuthEmailsServices } from './auth/auth.emails.services';
-import { getAuth } from './auth/auth.services';
-import { setupDatabase } from './database/database';
-import { createEventServices } from './events/events.services';
import { createCorsMiddleware } from './middlewares/cors.middleware';
import { registerErrorMiddleware } from './middlewares/errors.middleware';
import { createTimeoutMiddleware } from './middlewares/timeout.middleware';
import { registerRoutes } from './server.routes';
import { registerStaticAssetsRoutes } from './static-assets/static-assets.routes';
-async function createGlobalDependencies(partialDeps: Partial<GlobalDependencies>): Promise<GlobalDependencies> {
- const config = partialDeps.config ?? (await parseConfig()).config;
- const db = partialDeps.db ?? setupDatabase(config.database).db;
- const emailsServices = createEmailsServices({ config });
- const trackingServices = partialDeps.trackingServices ?? createTrackingServices({ config });
- const eventServices = partialDeps.eventServices ?? createEventServices();
- const auth = partialDeps.auth ?? getAuth({ db, config, authEmailsServices: createAuthEmailsServices({ emailsServices }), eventServices }).auth;
- const subscriptionsServices = createSubscriptionsServices({ config });
- const taskServices = partialDeps.taskServices ?? createTaskServices({ config });
- const documentsStorageService = partialDeps.documentsStorageService ?? createDocumentStorageService({ documentStorageConfig: config.documentsStorage });
- const documentSearchServices = partialDeps.documentSearchServices ?? createDocumentSearchServices({ db, config });
-
- return {
- documentsStorageService,
- config,
- db,
- auth,
- emailsServices,
- subscriptionsServices,
- trackingServices,
- taskServices,
- documentSearchServices,
- eventServices,
- };
-}
-
-export async function createServer(initialDeps: Partial<GlobalDependencies> = {}) {
- const dependencies = await createGlobalDependencies(initialDeps);
- const { config, trackingServices, db } = dependencies;
+export function createServer(dependencies: GlobalDependencies) {
+ const { config, db, shutdownServices } = dependencies;
const app = new Hono<ServerInstanceGenerics>({ strict: true });
@@ -66,8 +29,22 @@ export async function createServer(initialDeps: Partial<GlobalDependencies> = {}
return {
app,
- shutdown: async () => {
- await trackingServices.shutdown();
+ start: ({ onStarted }: { onStarted?: (args: { port: number }) => void }) => {
+ const server = serve(
+ {
+ fetch: app.fetch,
+ port: config.server.port,
+ hostname: config.server.hostname,
+ },
+ onStarted,
+ );
+
+ shutdownServices.registerShutdownHandler({
+ id: 'web-server-close',
+ handler: () => {
+ server.close();
+ },
+ });
},
};
}
diff --git a/apps/papra-server/src/modules/app/server.types.ts b/apps/papra-server/src/modules/app/server.types.ts
index 5bf48b19..037eaef3 100644
--- a/apps/papra-server/src/modules/app/server.types.ts
+++ b/apps/papra-server/src/modules/app/server.types.ts
@@ -11,6 +11,7 @@ import type { Auth } from './auth/auth.services';
import type { Session } from './auth/auth.types';
import type { Database } from './database/database.types';
import type { EventServices } from './events/events.services';
+import type { ShutdownServices } from './graceful-shutdown/graceful-shutdown.services';
export type ServerInstanceGenerics = {
Variables: {
@@ -36,6 +37,7 @@ export type GlobalDependencies = {
documentsStorageService: DocumentStorageService;
documentSearchServices: DocumentSearchServices;
eventServices: EventServices;
+ shutdownServices: ShutdownServices;
};
export type RouteDefinitionContext = { app: ServerInstance } & GlobalDependencies;
diff --git a/apps/papra-server/src/modules/documents/e2e/upload-documents.e2e.test.ts b/apps/papra-server/src/modules/documents/e2e/upload-documents.e2e.test.ts
index d08667d2..0dc35e74 100644
--- a/apps/papra-server/src/modules/documents/e2e/upload-documents.e2e.test.ts
+++ b/apps/papra-server/src/modules/documents/e2e/upload-documents.e2e.test.ts
@@ -2,6 +2,7 @@ import type { Document } from '../documents.types';
import { describe, expect, test } from 'vitest';
import { createInMemoryDatabase } from '../../app/database/database.test-utils';
import { createServer } from '../../app/server';
+import { createTestServerDependencies } from '../../app/server.test-utils';
import { overrideConfig } from '../../config/config.test-utils';
import { ORGANIZATION_ROLES } from '../../organizations/organizations.constants';
import { documentsTable } from '../documents.table';
@@ -16,7 +17,7 @@ describe('documents e2e', () => {
organizationMembers: [{ organizationId: 'org_222222222222222222222222', userId: 'usr_111111111111111111111111', role: ORGANIZATION_ROLES.OWNER }],
});
- const { app } = await createServer({
+ const { app } = createServer(createTestServerDependencies({
db,
config: overrideConfig({
env: 'test',
@@ -24,7 +25,7 @@ describe('documents e2e', () => {
driver: 'in-memory',
},
}),
- });
+ }));
const formData = new FormData();
formData.append('file', new File(['this is an invoice'], 'invoice.txt', { type: 'text/plain' }));
@@ -85,7 +86,7 @@ describe('documents e2e', () => {
const documentsStorageService = inMemoryStorageDriverFactory();
- const { app } = await createServer({
+ const { app } = createServer(createTestServerDependencies({
db,
documentsStorageService,
config: overrideConfig({
@@ -94,7 +95,7 @@ describe('documents e2e', () => {
maxUploadSize: 100,
},
}),
- });
+ }));
const formData = new FormData();
formData.append('file', new File(['a'.repeat(101)], 'invoice.txt', { type: 'text/plain' }));
@@ -141,7 +142,7 @@ describe('documents e2e', () => {
],
});
- const { app } = await createServer({
+ const { app } = createServer(createTestServerDependencies({
db,
config: overrideConfig({
env: 'test',
@@ -149,7 +150,7 @@ describe('documents e2e', () => {
driver: 'in-memory',
},
}),
- });
+ }));
const formData = new FormData();
formData.append('file', new File(['sensitive document'], 'document.txt', { type: 'text/plain' }));
@@ -189,7 +190,7 @@ describe('documents e2e', () => {
organizationMembers: [{ organizationId: 'org_222222222222222222222222', userId: 'usr_111111111111111111111111', role: ORGANIZATION_ROLES.OWNER }],
});
- const { app } = await createServer({
+ const { app } = createServer(createTestServerDependencies({
db,
config: overrideConfig({
env: 'test',
@@ -197,7 +198,7 @@ describe('documents e2e', () => {
driver: 'in-memory',
},
}),
- });
+ }));
// Various UTF-8 characters that cause encoding issues
const testCases = [
diff --git a/apps/papra-server/src/modules/intake-emails/e2e/ingest-intake-emails.e2e.test.ts b/apps/papra-server/src/modules/intake-emails/e2e/ingest-intake-emails.e2e.test.ts
index ac84cde5..861e7b08 100644
--- a/apps/papra-server/src/modules/intake-emails/e2e/ingest-intake-emails.e2e.test.ts
+++ b/apps/papra-server/src/modules/intake-emails/e2e/ingest-intake-emails.e2e.test.ts
@@ -3,6 +3,7 @@ import { pick } from 'lodash-es';
import { describe, expect, test } from 'vitest';
import { createInMemoryDatabase } from '../../app/database/database.test-utils';
import { createServer } from '../../app/server';
+import { createTestServerDependencies } from '../../app/server.test-utils';
import { overrideConfig } from '../../config/config.test-utils';
import { documentsTable } from '../../documents/documents.table';
import { ORGANIZATION_ROLES } from '../../organizations/organizations.constants';
@@ -11,14 +12,14 @@ describe('intake-emails e2e', () => {
describe('ingest an intake email', () => {
test('when intake email ingestion is disabled, a 403 is returned', async () => {
const { db } = await createInMemoryDatabase();
- const { app } = await createServer({
+ const { app } = createServer(createTestServerDependencies({
db,
config: overrideConfig({
intakeEmails: {
isEnabled: false,
},
}),
- });
+ }));
const { body } = serializeEmailForWebhook({ email: {
from: { address: '[email protected]', name: 'Foo' },
@@ -42,7 +43,7 @@ describe('intake-emails e2e', () => {
describe('when ingesting an email, the request must have an X-Signature header with the hmac signature of the body', async () => {
test('when the header is missing, a 400 is returned', async () => {
const { db } = await createInMemoryDatabase();
- const { app } = await createServer({
+ const { app } = createServer(createTestServerDependencies({
db,
config: overrideConfig({
intakeEmails: {
@@ -50,7 +51,7 @@ describe('intake-emails e2e', () => {
webhookSecret: 'super-secret',
},
}),
- });
+ }));
const { body } = serializeEmailForWebhook({ email: {
from: { address: '[email protected]', name: 'Foo' },
@@ -73,7 +74,7 @@ describe('intake-emails e2e', () => {
test('when the header is invalid, a 401 is returned', async () => {
const { db } = await createInMemoryDatabase();
- const { app } = await createServer({
+ const { app } = createServer(createTestServerDependencies({
db,
config: overrideConfig({
intakeEmails: {
@@ -81,7 +82,7 @@ describe('intake-emails e2e', () => {
webhookSecret: 'super-secret',
},
}),
- });
+ }));
const { body } = serializeEmailForWebhook({ email: {
from: { address: '[email protected]', name: 'Foo' },
@@ -114,12 +115,12 @@ describe('intake-emails e2e', () => {
intakeEmails: [{ id: 'ie_1', organizationId: 'org_1', emailAddress: '[email protected]', allowedOrigins: ['[email protected]'] }],
});
- const { app } = await createServer({
+ const { app } = createServer(createTestServerDependencies({
db,
config: overrideConfig({
intakeEmails: { isEnabled: true, webhookSecret: 'super-secret' },
}),
- });
+ }));
const { body } = serializeEmailForWebhook({ email: {
from: { address: '[email protected]', name: 'Foo' },
diff --git a/apps/papra-server/src/modules/tracking/tracking.services.ts b/apps/papra-server/src/modules/tracking/tracking.services.ts
index 66fe6a78..cd375578 100644
--- a/apps/papra-server/src/modules/tracking/tracking.services.ts
+++ b/apps/papra-server/src/modules/tracking/tracking.services.ts
@@ -1,3 +1,4 @@
+import type { ShutdownServices } from '../app/graceful-shutdown/graceful-shutdown.services';
import type { Config } from '../config/config.types';
import { PostHog } from 'posthog-node';
@@ -7,18 +8,15 @@ export type TrackingServices = {
event: string;
properties?: Record<string, unknown>;
}) => void;
-
- shutdown: () => Promise<void>;
};
export function createDummyTrackingServices(): TrackingServices {
return {
captureUserEvent: () => {},
- shutdown: async () => Promise.resolve(),
};
}
-export function createTrackingServices({ config }: { config: Config }): TrackingServices {
+export function createTrackingServices({ config, shutdownServices }: { config: Config; shutdownServices?: ShutdownServices }): TrackingServices {
const { apiKey, host, isEnabled } = config.tracking.posthog;
if (!isEnabled) {
@@ -33,10 +31,14 @@ export function createTrackingServices({ config }: { config: Config }): Tracking
},
);
+ shutdownServices?.registerShutdownHandler({
+ id: 'tracking-client-shutdown',
+ handler: async () => trackingClient.shutdown(),
+ });
+
return {
captureUserEvent: ({ userId, event, properties }) => {
trackingClient.capture({ distinctId: userId, event, properties });
},
- shutdown: async () => trackingClient.shutdown(),
};
}
diff --git a/apps/papra-server/src/start.ts b/apps/papra-server/src/start.ts
new file mode 100644
index 00000000..7076b4d2
--- /dev/null
+++ b/apps/papra-server/src/start.ts
@@ -0,0 +1,110 @@
+import type { GlobalDependencies } from './modules/app/server.types';
+import type { Config } from './modules/config/config.types';
+import type { Logger } from './modules/shared/logger/logger';
+import { env } from 'node:process';
+import { createAuthEmailsServices } from './modules/app/auth/auth.emails.services';
+import { getAuth } from './modules/app/auth/auth.services';
+import { setupDatabase } from './modules/app/database/database';
+import { ensureLocalDatabaseDirectoryExists } from './modules/app/database/database.services';
+import { registerEventHandlers } from './modules/app/events/events.handlers';
+import { createEventServices } from './modules/app/events/events.services';
+import { createGracefulShutdownService } from './modules/app/graceful-shutdown/graceful-shutdown.services';
+import { getProcessMode } from './modules/app/process.models';
+import { createServer } from './modules/app/server';
+import { parseConfig } from './modules/config/config';
+import { createDocumentSearchServices } from './modules/documents/document-search/document-search.registry';
+import { createDocumentStorageService } from './modules/documents/storage/documents.storage.services';
+import { createEmailsServices } from './modules/emails/emails.services';
+import { createIngestionFolderWatcher } from './modules/ingestion-folders/ingestion-folders.usecases';
+import { addToGlobalLogContext, createLogger } from './modules/shared/logger/logger';
+import { createSubscriptionsServices } from './modules/subscriptions/subscriptions.services';
+import { registerTaskDefinitions } from './modules/tasks/tasks.definitions';
+import { createTaskServices } from './modules/tasks/tasks.services';
+import { createTrackingServices } from './modules/tracking/tracking.services';
+
+async function startWebMode({ logger, ...dependencies }: { logger: Logger } & GlobalDependencies) {
+ const server = createServer(dependencies);
+
+ server.start({
+ onStarted: ({ port }) => logger.info({ port }, 'Server started'),
+ });
+}
+
+async function startWorkerMode({ logger, config, db, taskServices, documentsStorageService }: { logger: Logger } & GlobalDependencies) {
+ if (config.ingestionFolder.isEnabled) {
+ const { startWatchingIngestionFolders } = createIngestionFolderWatcher({
+ taskServices,
+ config,
+ db,
+ documentsStorageService,
+ });
+
+ await startWatchingIngestionFolders();
+ }
+
+ await registerTaskDefinitions({ taskServices, db, config, documentsStorageService });
+
+ taskServices.start();
+ logger.info('Worker started');
+}
+
+async function buildServices({ config }: { config: Config }): Promise<GlobalDependencies> {
+ const shutdownServices = createGracefulShutdownService();
+
+ await ensureLocalDatabaseDirectoryExists({ config });
+ const { db } = setupDatabase({ ...config.database, shutdownServices });
+
+ const documentsStorageService = createDocumentStorageService({ documentStorageConfig: config.documentsStorage });
+ const taskServices = createTaskServices({ config });
+ const trackingServices = createTrackingServices({ config, shutdownServices });
+ const eventServices = createEventServices();
+ const emailsServices = createEmailsServices({ config });
+ const authEmailsServices = createAuthEmailsServices({ emailsServices });
+ const { auth } = getAuth({ db, config, authEmailsServices, eventServices });
+ const subscriptionsServices = createSubscriptionsServices({ config });
+ const documentSearchServices = createDocumentSearchServices({ db, config });
+
+ // --- Services initialization
+ await taskServices.initialize();
+ registerEventHandlers({ eventServices, trackingServices });
+
+ return {
+ config,
+ db,
+ shutdownServices,
+ documentsStorageService,
+ taskServices,
+ trackingServices,
+ eventServices,
+ emailsServices,
+ auth,
+ subscriptionsServices,
+ documentSearchServices,
+ };
+}
+
+export async function startApp() {
+ const logger = createLogger({ namespace: 'app-server' });
+
+ const { config } = await parseConfig({ env });
+
+ const { isWebMode, isWorkerMode, processMode } = getProcessMode({ config });
+
+ addToGlobalLogContext({ processMode });
+
+ logger.info({ isWebMode, isWorkerMode }, 'Starting application');
+
+ const globalDependencies = await buildServices({ config });
+
+ if (isWebMode) {
+ await startWebMode({ logger, ...globalDependencies });
+ }
+
+ if (isWorkerMode) {
+ await startWorkerMode({ logger, ...globalDependencies });
+ }
+
+ return {
+ shutdownServices: globalDependencies.shutdownServices,
+ };
+}