Skip to content

armgit / papra

Public Imported from GitHub
0

The minimalistic document archiving platform.

refactor(utils): added isString and isNonEmptyString utility functions (#495)

Corentin Thomasset47d8bbd356c0
diff --git a/apps/papra-server/src/modules/app/auth/auth.routes.ts b/apps/papra-server/src/modules/app/auth/auth.routes.ts
index 0698d15a..216d3a0d 100644
--- a/apps/papra-server/src/modules/app/auth/auth.routes.ts
+++ b/apps/papra-server/src/modules/app/auth/auth.routes.ts
@@ -1,7 +1,7 @@
import type { Context, RouteDefinitionContext } from '../server.types';
import type { Session } from './auth.types';
import { get } from 'lodash-es';
-import { isDefined } from '../../shared/utils';
+import { isDefined, isString } from '../../shared/utils';
export function registerAuthRoutes({ app, auth, config }: RouteDefinitionContext) {
app.on(
@@ -26,7 +26,7 @@ export function registerAuthRoutes({ app, auth, config }: RouteDefinitionContext
app.use('*', async (context: Context, next) => {
const overrideUserId: unknown = get(context.env, 'loggedInUserId');
- if (isDefined(overrideUserId) && typeof overrideUserId === 'string') {
+ if (isDefined(overrideUserId) && isString(overrideUserId)) {
context.set('userId', overrideUserId);
context.set('session', {} as Session);
context.set('authType', 'session');
diff --git a/apps/papra-server/src/modules/config/config.ts b/apps/papra-server/src/modules/config/config.ts
index f0a0d327..e6bea748 100644
--- a/apps/papra-server/src/modules/config/config.ts
+++ b/apps/papra-server/src/modules/config/config.ts
@@ -15,6 +15,7 @@ import { intakeEmailsConfig } from '../intake-emails/intake-emails.config';
import { organizationsConfig } from '../organizations/organizations.config';
import { organizationPlansConfig } from '../plans/plans.config';
import { createLogger } from '../shared/logger/logger';
+import { isString } from '../shared/utils';
import { subscriptionsConfig } from '../subscriptions/subscriptions.config';
import { tasksConfig } from '../tasks/tasks.config';
import { trackingConfig } from '../tracking/tracking.config';
@@ -71,7 +72,7 @@ export const configDefinition = {
schema: z.union([
z.string(),
z.array(z.string()),
- ]).transform(value => (typeof value === 'string' ? value.split(',') : value)),
+ ]).transform(value => (isString(value) ? value.split(',') : value)),
default: ['http://localhost:3000'],
env: 'SERVER_CORS_ORIGINS',
},
diff --git a/apps/papra-server/src/modules/documents/storage/drivers/s3/s3.storage-driver.ts b/apps/papra-server/src/modules/documents/storage/drivers/s3/s3.storage-driver.ts
index b3327f95..e03134e4 100644
--- a/apps/papra-server/src/modules/documents/storage/drivers/s3/s3.storage-driver.ts
+++ b/apps/papra-server/src/modules/documents/storage/drivers/s3/s3.storage-driver.ts
@@ -3,6 +3,7 @@ import { DeleteObjectCommand, GetObjectCommand, HeadObjectCommand, S3Client } fr
import { Upload } from '@aws-sdk/lib-storage';
import { safely } from '@corentinth/chisels';
+import { isString } from '../../../../shared/utils';
import { createFileNotFoundError } from '../../document-storage.errors';
import { defineStorageDriver } from '../drivers.models';
@@ -12,7 +13,7 @@ function isS3NotFoundError(error: Error) {
const codes = ['NoSuchKey', 'NotFound'];
return codes.includes(error.name)
- || ('Code' in error && typeof error.Code === 'string' && codes.includes(error.Code));
+ || ('Code' in error && isString(error.Code) && codes.includes(error.Code));
}
export const s3StorageDriverFactory = defineStorageDriver(({ documentStorageConfig }) => {
diff --git a/apps/papra-server/src/modules/ingestion-folders/ingestion-folders.config.ts b/apps/papra-server/src/modules/ingestion-folders/ingestion-folders.config.ts
index 3493a6dd..d2d876d3 100644
--- a/apps/papra-server/src/modules/ingestion-folders/ingestion-folders.config.ts
+++ b/apps/papra-server/src/modules/ingestion-folders/ingestion-folders.config.ts
@@ -1,6 +1,7 @@
import type { ConfigDefinition } from 'figue';
import { z } from 'zod';
import { booleanishSchema } from '../config/config.schemas';
+import { isString } from '../shared/utils';
import { defaultIgnoredPatterns } from './ingestion-folders.constants';
export const ingestionFolderConfig = {
@@ -61,7 +62,7 @@ export const ingestionFolderConfig = {
schema: z.union([
z.string(),
z.array(z.string()),
- ]).transform(value => (typeof value === 'string' ? value.split(',') : value)),
+ ]).transform(value => (isString(value) ? value.split(',') : value)),
default: defaultIgnoredPatterns,
env: 'INGESTION_FOLDER_IGNORED_PATTERNS',
},
diff --git a/apps/papra-server/src/modules/shared/fs/fs.models.ts b/apps/papra-server/src/modules/shared/fs/fs.models.ts
index ce9b9a9c..0208a8d3 100644
--- a/apps/papra-server/src/modules/shared/fs/fs.models.ts
+++ b/apps/papra-server/src/modules/shared/fs/fs.models.ts
@@ -1,7 +1,7 @@
-import { isNil } from '../utils';
+import { isNil, isString } from '../utils';
export function isCrossDeviceError({ error }: { error: Error & { code?: unknown } }) {
- if (isNil(error.code) || typeof error.code !== 'string') {
+ if (isNil(error.code) || !isString(error.code)) {
return false;
}
diff --git a/apps/papra-server/src/modules/shared/utils.test.ts b/apps/papra-server/src/modules/shared/utils.test.ts
index 78c66d7c..12cd2eed 100644
--- a/apps/papra-server/src/modules/shared/utils.test.ts
+++ b/apps/papra-server/src/modules/shared/utils.test.ts
@@ -1,5 +1,5 @@
import { describe, expect, test } from 'vitest';
-import { isDefined, isNil, omitUndefined } from './utils';
+import { isDefined, isNil, isNonEmptyString, isString, omitUndefined } from './utils';
describe('utils', () => {
describe('omitUndefined', () => {
@@ -47,4 +47,38 @@ describe('utils', () => {
expect(isDefined({})).toBe(true);
});
});
+
+ describe('isString', () => {
+ test('returns true if the value is a string', () => {
+ expect(isString('')).toBe(true);
+ expect(isString('foo')).toBe(true);
+ expect(isString(String(1))).toBe(true);
+ });
+
+ test('returns false if the value is not a string', () => {
+ expect(isString(undefined)).toBe(false);
+ expect(isString(null)).toBe(false);
+ expect(isString(0)).toBe(false);
+ expect(isString(false)).toBe(false);
+ expect(isString({})).toBe(false);
+ expect(isString([])).toBe(false);
+ });
+ });
+
+ describe('isNonEmptyString', () => {
+ test('returns true if the value is a non-empty string', () => {
+ expect(isNonEmptyString('')).toBe(false);
+ expect(isNonEmptyString('foo')).toBe(true);
+ expect(isNonEmptyString(String(1))).toBe(true);
+ });
+
+ test('returns false if the value is not a non-empty string', () => {
+ expect(isNonEmptyString(undefined)).toBe(false);
+ expect(isNonEmptyString(null)).toBe(false);
+ expect(isNonEmptyString(0)).toBe(false);
+ expect(isNonEmptyString(false)).toBe(false);
+ expect(isNonEmptyString({})).toBe(false);
+ expect(isNonEmptyString([])).toBe(false);
+ });
+ });
});
diff --git a/apps/papra-server/src/modules/shared/utils.ts b/apps/papra-server/src/modules/shared/utils.ts
index 9af2d509..44bd4326 100644
--- a/apps/papra-server/src/modules/shared/utils.ts
+++ b/apps/papra-server/src/modules/shared/utils.ts
@@ -15,3 +15,11 @@ export function isNil(value: unknown): value is undefined | null {
export function isDefined<T>(value: T): value is Exclude<T, undefined | null> {
return !isNil(value);
}
+
+export function isString(value: unknown): value is string {
+ return typeof value === 'string';
+}
+
+export function isNonEmptyString(value: unknown): value is string {
+ return isString(value) && value.length > 0;
+}
diff --git a/apps/papra-server/src/modules/subscriptions/subscriptions.models.ts b/apps/papra-server/src/modules/subscriptions/subscriptions.models.ts
index 9ef5df2f..c98e8469 100644
--- a/apps/papra-server/src/modules/subscriptions/subscriptions.models.ts
+++ b/apps/papra-server/src/modules/subscriptions/subscriptions.models.ts
@@ -1,4 +1,4 @@
-import { isNil } from '../shared/utils';
+import { isNil, isNonEmptyString } from '../shared/utils';
export function coerceStripeTimestampToDate(timestamp: number) {
return new Date(timestamp * 1000);
@@ -9,5 +9,5 @@ export function isSignatureHeaderFormatValid(signature: string | undefined): sig
return false;
}
- return typeof signature === 'string' && signature.length > 0;
+ return isNonEmptyString(signature);
}