The minimalistic document archiving platform.
refactor(server): add in house omit utility (#1018)
Corentin Thomasset8984179a763e
diff --git a/apps/papra-server/src/modules/api-keys/api-keys.repository.ts b/apps/papra-server/src/modules/api-keys/api-keys.repository.tsindex 33568313..482e9fda 100644--- a/apps/papra-server/src/modules/api-keys/api-keys.repository.ts+++ b/apps/papra-server/src/modules/api-keys/api-keys.repository.ts@@ -3,11 +3,10 @@ import type { Logger } from '../shared/logger/logger';import type { ApiKeyPermissions } from './api-keys.types';import { injectArguments } from '@corentinth/chisels';import { and, eq, getTableColumns, gt, inArray, isNull, or } from 'drizzle-orm';-import { omit } from 'lodash-es';import { organizationMembersTable, organizationsTable } from '../organizations/organizations.table';import { createError } from '../shared/errors/errors';import { createLogger } from '../shared/logger/logger';-import { pick } from '../shared/objects';+import { omit, pick } from '../shared/objects';import { apiKeyOrganizationsTable, apiKeysTable } from './api-keys.tables';export type ApiKeysRepository = ReturnType<typeof createApiKeysRepository>;@@ -104,7 +103,7 @@ async function saveApiKey({async function getUserApiKeys({ userId, db }: { userId: string; db: Database }) {const apiKeys = await db.select({- ...omit(getTableColumns(apiKeysTable), 'keyHash'),+ ...omit(getTableColumns(apiKeysTable), ['keyHash']),}).from(apiKeysTable).where(diff --git a/apps/papra-server/src/modules/documents/document-search/database-fts5/database-fts5.repository.ts b/apps/papra-server/src/modules/documents/document-search/database-fts5/database-fts5.repository.tsindex d3b46185..cf371be5 100644--- a/apps/papra-server/src/modules/documents/document-search/database-fts5/database-fts5.repository.ts+++ b/apps/papra-server/src/modules/documents/document-search/database-fts5/database-fts5.repository.ts@@ -2,9 +2,8 @@ import type { Database } from '../../../app/database/database.types';import type { DocumentSearchableData } from '../document-search.types';import { injectArguments } from '@corentinth/chisels';import { desc, eq, getTableColumns, sql } from 'drizzle-orm';-import { omit } from 'lodash-es';import { customPropertyDefinitionsTable } from '../../../custom-properties/custom-properties.table';-import { omitUndefined } from '../../../shared/objects';+import { omit, omitUndefined } from '../../../shared/objects';import { documentsTable } from '../../documents.table';import { makeSearchWhereClause } from './database-fts5.repository.models';import { documentsFtsTable } from './database-fts5.tables';diff --git a/apps/papra-server/src/modules/documents/documents.models.ts b/apps/papra-server/src/modules/documents/documents.models.tsindex a6459e38..c1199b1a 100644--- a/apps/papra-server/src/modules/documents/documents.models.ts+++ b/apps/papra-server/src/modules/documents/documents.models.ts@@ -1,8 +1,8 @@import type { PartialBy } from '@corentinth/chisels';import type { DbSelectableDocument } from './documents.types';import filenamify from 'filenamify';-import { omit } from 'lodash-es';import { getExtension } from '../shared/files/file-names';+import { omit } from '../shared/objects';import { generateId } from '../shared/random/ids';import { isDefined } from '../shared/utils';import { ORIGINAL_DOCUMENTS_STORAGE_KEY } from './documents.constants';diff --git a/apps/papra-server/src/modules/intake-emails/intake-emails.repository.test.ts b/apps/papra-server/src/modules/intake-emails/intake-emails.repository.test.tsindex 82da1ec9..52821404 100644--- a/apps/papra-server/src/modules/intake-emails/intake-emails.repository.test.ts+++ b/apps/papra-server/src/modules/intake-emails/intake-emails.repository.test.ts@@ -1,6 +1,6 @@-import { omit } from 'lodash-es';import { describe, expect, test } from 'vitest';import { createInMemoryDatabase } from '../app/database/database.test-utils';+import { omit } from '../shared/objects';import { createIntakeEmailsRepository } from './intake-emails.repository';describe('intake-emails repository', () => {@@ -47,6 +47,8 @@ describe('intake-emails repository', () => {organizationId: 'organization-1',});+ expect.assert(retrievedIntakeEmail);+expect(omit(retrievedIntakeEmail, ['id', 'createdAt', 'updatedAt']),).to.eql({diff --git a/apps/papra-server/src/modules/organizations/organizations.repository.ts b/apps/papra-server/src/modules/organizations/organizations.repository.tsindex 2d0c15c8..b35e8c25 100644--- a/apps/papra-server/src/modules/organizations/organizations.repository.ts+++ b/apps/papra-server/src/modules/organizations/organizations.repository.ts@@ -2,7 +2,6 @@ import type { Database } from '../app/database/database.types';import type { DbInsertableOrganization, OrganizationInvitationStatus, OrganizationRole } from './organizations.types';import { injectArguments } from '@corentinth/chisels';import { and, count, desc, eq, getTableColumns, gte, isNotNull, isNull, lte } from 'drizzle-orm';-import { omit } from 'lodash-es';import { addDays, startOfDay } from '../shared/date';import { withPagination } from '../shared/db/pagination';import { omitUndefined } from '../shared/objects';@@ -344,7 +343,7 @@ async function getPendingOrganizationInvitationsForEmail({ email, db, now = new);const invitations = rawInvitations.map(({ organization_invitations, organizations }) => ({- ...omit(organization_invitations, ''),+ ...organization_invitations,organization: organizations,}));diff --git a/apps/papra-server/src/modules/shared/objects.test.ts b/apps/papra-server/src/modules/shared/objects.test.tsindex c7587fe1..34d0d2b3 100644--- a/apps/papra-server/src/modules/shared/objects.test.ts+++ b/apps/papra-server/src/modules/shared/objects.test.ts@@ -1,5 +1,5 @@import { describe, expect, test } from 'vitest';-import { omitUndefined, pick } from './objects';+import { omit, omitUndefined, pick } from './objects';describe('objects', () => {describe('pick', () => {@@ -64,6 +64,62 @@ describe('objects', () => {});});+ describe('omit', () => {+ test('given an object and a list of keys, return a new object without the specified keys', () => {+ expect(omit({ a: 1, b: 2, c: 3 }, ['b'])).toEqual({ a: 1, c: 3 });+ });++ test('multiple keys can be omitted at once', () => {+ expect(omit({ a: 1, b: 2, c: 3 }, ['a', 'c'])).toEqual({ b: 2 });+ });++ test('when a key is not present in the object, it is ignored', () => {+ expect(omit({ a: 1, b: 2 }, ['c'] as unknown as ('a' | 'b')[])).toEqual({ a: 1, b: 2 });+ });++ test('when the object is empty, the result is always an empty object', () => {+ expect(omit({}, [])).toEqual({});+ expect(omit({}, ['a', 'b'] as unknown as never[])).toEqual({});+ });++ test('when the list of keys is empty, the result is a copy of the original object', () => {+ expect(omit({ a: 1, b: 2 }, [])).toEqual({ a: 1, b: 2 });+ });++ test('resulting object is a new object, not a reference to the original one', () => {+ const obj = { a: 1, b: 2 };+ const result = omit(obj, ['a']);+ expect(result).toEqual({ b: 2 });+ expect(result).not.toBe(obj);+ });++ test('properties references are preserved', () => {+ const user = { name: 'Alice' };+ const obj = { user, b: 2 };+ const result = omit(obj, ['b']);++ expect(result).toEqual({ user: { name: 'Alice' } });+ expect(result.user).toBe(user);+ });++ test('when the object has properties in its prototype chain, they are ignored', () => {+ // eslint-disable-next-line ts/no-unsafe-assignment+ const obj = Object.create({ a: 1 });+ // eslint-disable-next-line ts/no-unsafe-member-access+ obj.b = 2;++ expect(omit(obj, ['a'] as unknown as never[])).toEqual({ b: 2 });+ });++ test('when the object has non-enumerable properties, they are ignored', () => {+ const obj = {};+ Object.defineProperty(obj, 'a', { value: 1, enumerable: false });+ Object.defineProperty(obj, 'b', { value: 2, enumerable: true });++ expect(omit(obj, [] as unknown as never[])).toEqual({ b: 2 });+ });+ });+describe('omitUndefined', () => {test('removes root undefined values and keeps the rest', () => {expect(diff --git a/apps/papra-server/src/modules/shared/objects.ts b/apps/papra-server/src/modules/shared/objects.tsindex 2fb0ac93..ce64c795 100644--- a/apps/papra-server/src/modules/shared/objects.ts+++ b/apps/papra-server/src/modules/shared/objects.ts@@ -14,6 +14,22 @@ export function omitUndefined<T extends Record<string, any>>(obj: T): OmitUndefireturn result;}+export function omit<T extends object, K extends keyof T>(obj: T, keys: K[] | readonly K[]): Omit<T, K> {+ const result = {} as Omit<T, K>;++ for (const key in obj) {+ if (+ Object.hasOwn(obj, key)+ && Object.propertyIsEnumerable.call(obj, key)+ && !keys.includes(key)+ ) {+ (result as T)[key] = obj[key];+ }+ }++ return result;+}+export function pick<T extends object, K extends keyof T>(obj: T, keys: K[] | readonly K[]): Pick<T, K> {const result = {} as Pick<T, K>;diff --git a/apps/papra-server/src/modules/webhooks/webhook.repository.ts b/apps/papra-server/src/modules/webhooks/webhook.repository.tsindex af1f327c..26bc00c5 100644--- a/apps/papra-server/src/modules/webhooks/webhook.repository.ts+++ b/apps/papra-server/src/modules/webhooks/webhook.repository.ts@@ -4,6 +4,8 @@ import type { Webhook, WebhookDeliveryInsert, WebhookEvent } from './webhooks.tyimport { injectArguments } from '@corentinth/chisels';import { and, eq, getTableColumns, max } from 'drizzle-orm';import { omitUndefined } from '../shared/objects';+import { isNil } from '../shared/utils';+import { createWebhookNotFoundError } from './webhook.errors';import { webhookDeliveriesTable, webhookEventsTable, webhooksTable } from './webhooks.tables';export type WebhookRepository = ReturnType<typeof createWebhookRepository>;@@ -58,6 +60,11 @@ async function updateOrganizationWebhook({ db, webhookId, events, organizationId).returning();+ if (isNil(updatedWebhook)) {+ // Should not happen, error will be thrown by the query, but it's for type safety+ throw createWebhookNotFoundError();+ }+if (events) {// Delete existing eventsawait dbdiff --git a/apps/papra-server/src/modules/webhooks/webhook.routes.ts b/apps/papra-server/src/modules/webhooks/webhook.routes.tsindex 2acc7f34..26ec7f72 100644--- a/apps/papra-server/src/modules/webhooks/webhook.routes.ts+++ b/apps/papra-server/src/modules/webhooks/webhook.routes.ts@@ -1,11 +1,11 @@import type { RouteDefinitionContext } from '../app/server.types';-import { omit } from 'lodash-es';import { z } from 'zod';import { requireAuthentication } from '../app/auth/auth.middleware';import { getUser } from '../app/auth/auth.models';import { organizationIdSchema } from '../organizations/organization.schemas';import { createOrganizationsRepository } from '../organizations/organizations.repository';import { ensureUserIsInOrganization } from '../organizations/organizations.usecases';+import { omit } from '../shared/objects';import { validateJsonBody, validateParams } from '../shared/validation/validation';import { createWebhookNotFoundError } from './webhook.errors';import { createWebhookRepository } from './webhook.repository';diff --git a/apps/papra-server/src/modules/webhooks/webhook.usecases.test.ts b/apps/papra-server/src/modules/webhooks/webhook.usecases.test.tsindex 0c2796dc..9cf8316b 100644--- a/apps/papra-server/src/modules/webhooks/webhook.usecases.test.ts+++ b/apps/papra-server/src/modules/webhooks/webhook.usecases.test.ts@@ -1,9 +1,9 @@import { eq } from 'drizzle-orm';-import { omit } from 'lodash-es';import { describe, expect, test } from 'vitest';import { createInMemoryDatabase } from '../app/database/database.test-utils';import { ORGANIZATION_ROLES } from '../organizations/organizations.constants';import { createTestLogger } from '../shared/logger/logger.test-utils';+import { omit } from '../shared/objects';import { createWebhookRepository } from './webhook.repository';import { createWebhook, triggerWebhooks, updateWebhook } from './webhook.usecases';import { webhookEventsTable, webhooksTable } from './webhooks.tables';@@ -75,7 +75,7 @@ describe('webhook usecases', () => {// Verify events were createdconst events = await db.select().from(webhookEventsTable).where(eq(webhookEventsTable.webhookId, webhook.id));- expect(events.map(e => omit(e, 'createdAt', 'updatedAt', 'id'))).to.eql([+ expect(events.map(e => omit(e, ['createdAt', 'updatedAt', 'id']))).to.eql([{webhookId: webhook.id,eventName: 'document:created',@@ -154,7 +154,7 @@ describe('webhook usecases', () => {});const events = await db.select().from(webhookEventsTable).where(eq(webhookEventsTable.webhookId, 'wbh_1'));- expect(events.map(e => omit(e, 'createdAt', 'updatedAt', 'id'))).to.eql([+ expect(events.map(e => omit(e, ['createdAt', 'updatedAt', 'id']))).to.eql([{webhookId: 'wbh_1',eventName: 'document:deleted',