Skip to content

armgit / papra

Public Imported from GitHub
0

The minimalistic document archiving platform.

refactor(mobile): localize custom header errors (#1479)

Corentin Thomasset22ca98a31ea6
diff --git a/apps/mobile/src/modules/config/config.models.test.ts b/apps/mobile/src/modules/config/config.models.test.ts
index c5366586..f6f64b8f 100644
--- a/apps/mobile/src/modules/config/config.models.test.ts
+++ b/apps/mobile/src/modules/config/config.models.test.ts
@@ -55,8 +55,11 @@ describe('config models', () => {
],
}),
).to.eql({
- 'X-Api-Key': 'secret',
- 'Authorization': 'Basic dXNlcjpwYXNz',
+ success: true,
+ headers: {
+ 'X-Api-Key': 'secret',
+ 'Authorization': 'Basic dXNlcjpwYXNz',
+ },
});
});
@@ -69,63 +72,57 @@ describe('config models', () => {
{ name: 'X-Foo', value: 'bar' },
],
}),
- ).to.eql({ 'X-Foo': 'bar' });
+ ).to.eql({ success: true, headers: { 'X-Foo': 'bar' } });
- expect(validateCustomHeaders({ headers: [] })).to.eql({});
+ expect(validateCustomHeaders({ headers: [] })).to.eql({ success: true, headers: {} });
});
- test('a header with a value but no name is rejected', () => {
- expect(() => validateCustomHeaders({ headers: [{ name: '', value: 'foo' }] })).toThrow(
- 'Header names cannot be empty.',
- );
+ test.each(['', ' '])('a header with a value but an empty name %j is rejected', (name) => {
+ expect(validateCustomHeaders({ headers: [{ name, value: 'foo' }] })).to.eql({
+ success: false,
+ issue: { code: 'empty-name', headerName: '' },
+ });
});
- test('header names with invalid characters are rejected', () => {
- expect(() => validateCustomHeaders({ headers: [{ name: 'X Foo', value: 'bar' }] })).toThrow(
- 'The header name "X Foo" is invalid.',
- );
- expect(() =>
- validateCustomHeaders({ headers: [{ name: 'X-Foo:', value: 'bar' }] }),
- ).toThrow();
- expect(() => validateCustomHeaders({ headers: [{ name: 'X-Fôo', value: 'bar' }] })).toThrow();
- });
+ test.each(['X Foo', 'X-Foo:', 'X-Fôo', ' X Foo '])(
+ 'the invalid header name %j is rejected',
+ (name) => {
+ expect(validateCustomHeaders({ headers: [{ name, value: 'bar' }] })).to.eql({
+ success: false,
+ issue: { code: 'invalid-name', headerName: name.trim() },
+ });
+ },
+ );
- test('headers managed by the app are denied, regardless of casing', () => {
- expect(() => validateCustomHeaders({ headers: [{ name: 'Cookie', value: 'a=b' }] })).toThrow(
- 'The header "Cookie" is managed by the app and cannot be overridden.',
- );
- expect(() =>
- validateCustomHeaders({ headers: [{ name: 'cookie', value: 'a=b' }] }),
- ).toThrow();
- expect(() =>
- validateCustomHeaders({ headers: [{ name: 'HOST', value: 'evil.com' }] }),
- ).toThrow();
- expect(() =>
- validateCustomHeaders({ headers: [{ name: 'Content-Type', value: 'text/plain' }] }),
- ).toThrow();
- expect(() => validateCustomHeaders({ headers: [{ name: 'Origin', value: 'x' }] })).toThrow();
- expect(() => validateCustomHeaders({ headers: [{ name: 'Referer', value: 'x' }] })).toThrow();
- });
+ test.each(['Cookie', 'cookie', 'HOST', 'Content-Type', 'Origin', 'Referer'])(
+ 'the managed header %j is denied, regardless of casing',
+ (name) => {
+ expect(validateCustomHeaders({ headers: [{ name, value: 'foo' }] })).to.eql({
+ success: false,
+ issue: { code: 'forbidden-name', headerName: name },
+ });
+ },
+ );
- test('headers with denied prefixes are rejected', () => {
- expect(() =>
- validateCustomHeaders({ headers: [{ name: 'Proxy-Authorization', value: 'x' }] }),
- ).toThrow();
- expect(() =>
- validateCustomHeaders({ headers: [{ name: 'Sec-Fetch-Mode', value: 'cors' }] }),
- ).toThrow();
- expect(() =>
- validateCustomHeaders({
- headers: [{ name: 'Access-Control-Request-Method', value: 'GET' }],
- }),
- ).toThrow();
- });
+ test.each(['Proxy-Authorization', 'Sec-Fetch-Mode', 'Access-Control-Request-Method'])(
+ 'the header %j with a denied prefix is rejected',
+ (name) => {
+ expect(validateCustomHeaders({ headers: [{ name, value: 'foo' }] })).to.eql({
+ success: false,
+ issue: { code: 'forbidden-name', headerName: name },
+ });
+ },
+ );
- test('values containing newlines are rejected', () => {
- expect(() =>
- validateCustomHeaders({ headers: [{ name: 'X-Foo', value: 'bar\r\nbaz' }] }),
- ).toThrow('The value of the header "X-Foo" is invalid.');
- });
+ test.each(['bar\r\nbaz', 'bar\rbaz', 'bar\nbaz'])(
+ 'the header value %j containing newlines is rejected',
+ (value) => {
+ expect(validateCustomHeaders({ headers: [{ name: ' X-Foo ', value }] })).to.eql({
+ success: false,
+ issue: { code: 'invalid-value', headerName: 'X-Foo' },
+ });
+ },
+ );
test('common reverse-proxy auth headers are allowed', () => {
expect(
@@ -138,10 +135,13 @@ describe('config models', () => {
],
}),
).to.eql({
- 'Authorization': 'Bearer token',
- 'CF-Access-Client-Id': 'id',
- 'CF-Access-Client-Secret': 'secret',
- 'X-Forwarded-User': 'corentin',
+ success: true,
+ headers: {
+ 'Authorization': 'Bearer token',
+ 'CF-Access-Client-Id': 'id',
+ 'CF-Access-Client-Secret': 'secret',
+ 'X-Forwarded-User': 'corentin',
+ },
});
});
});
diff --git a/apps/mobile/src/modules/config/config.models.ts b/apps/mobile/src/modules/config/config.models.ts
index 725a96c8..32a9794c 100644
--- a/apps/mobile/src/modules/config/config.models.ts
+++ b/apps/mobile/src/modules/config/config.models.ts
@@ -66,11 +66,26 @@ export function isForbiddenHeaderName({ name }: { name: string }) {
);
}
-export function validateCustomHeaders({
- headers,
-}: {
- headers: CustomHeader[];
-}): Record<string, string> {
+export type CustomHeaderIssueCode =
+ | 'empty-name'
+ | 'invalid-name'
+ | 'forbidden-name'
+ | 'invalid-value';
+
+type CustomHeaderIssue = {
+ code: CustomHeaderIssueCode;
+ headerName: string;
+};
+
+export function validateCustomHeaders({ headers }: { headers: CustomHeader[] }):
+ | {
+ success: true;
+ headers: Record<string, string>;
+ }
+ | {
+ success: false;
+ issue: CustomHeaderIssue;
+ } {
const validatedHeaders: Record<string, string> = {};
for (const header of headers) {
@@ -82,22 +97,51 @@ export function validateCustomHeaders({
continue;
}
+ if (name === '') {
+ return {
+ success: false,
+ issue: {
+ code: 'empty-name',
+ headerName: name,
+ },
+ };
+ }
+
if (!HEADER_NAME_REGEX.test(name)) {
- throw new Error(
- name === '' ? 'Header names cannot be empty.' : `The header name "${name}" is invalid.`,
- );
+ return {
+ success: false,
+ issue: {
+ code: 'invalid-name',
+ headerName: name,
+ },
+ };
}
if (isForbiddenHeaderName({ name })) {
- throw new Error(`The header "${name}" is managed by the app and cannot be overridden.`);
+ return {
+ success: false,
+ issue: {
+ code: 'forbidden-name',
+ headerName: name,
+ },
+ };
}
if (/[\r\n]/.test(value)) {
- throw new Error(`The value of the header "${name}" is invalid.`);
+ return {
+ success: false,
+ issue: {
+ code: 'invalid-value',
+ headerName: name,
+ },
+ };
}
validatedHeaders[name] = value;
}
- return validatedHeaders;
+ return {
+ success: true,
+ headers: validatedHeaders,
+ };
}
diff --git a/apps/mobile/src/modules/config/screens/server-selection.screen.tsx b/apps/mobile/src/modules/config/screens/server-selection.screen.tsx
index 8887b72d..d047652d 100644
--- a/apps/mobile/src/modules/config/screens/server-selection.screen.tsx
+++ b/apps/mobile/src/modules/config/screens/server-selection.screen.tsx
@@ -85,19 +85,23 @@ export function ServerSelectionScreen() {
return;
}
- const [customHeaders, headersValidationError] = safelySync(() =>
- validateCustomHeaders({ headers: isSelfHosted ? customHeaderRows : [] }),
- );
+ const headerParsingResult = validateCustomHeaders({
+ headers: isSelfHosted ? customHeaderRows : [],
+ });
+
+ if (!headerParsingResult.success) {
+ const { code, headerName } = headerParsingResult.issue;
- if (headersValidationError) {
showAlert({
title: t.serverSelection.errors.invalidCustomHeader.title,
- message: headersValidationError.message,
+ message: t.serverSelection.customHeaders.parsingErrors[code]({ headerName }),
});
setIsValidating(false);
return;
}
+ const { headers: customHeaders } = headerParsingResult;
+
try {
await pingServer({ url, headers: customHeaders });
} catch {
diff --git a/apps/mobile/src/modules/i18n/translations/en.ts b/apps/mobile/src/modules/i18n/translations/en.ts
index 68a91d61..38906f4e 100644
--- a/apps/mobile/src/modules/i18n/translations/en.ts
+++ b/apps/mobile/src/modules/i18n/translations/en.ts
@@ -1,3 +1,5 @@
+import type { CustomHeaderIssueCode } from '@/modules/config/config.models';
+
export const en = {
papra: 'Papra',
common: {
@@ -57,6 +59,14 @@ export const en = {
valuePlaceholder: 'Value',
deleteLabel: ({ name }: { name: string }) => `Delete header ${name}`,
add: 'Add header',
+ parsingErrors: {
+ 'empty-name': () => `Header names cannot be empty.`,
+ 'invalid-name': ({ headerName }) => `The header name "${headerName}" is invalid.`,
+ 'forbidden-name': ({ headerName }) =>
+ `The header name "${headerName}" is managed by the app or by the protocol and cannot be set manually.`,
+ 'invalid-value': ({ headerName }) =>
+ `The value for the header "${headerName}" is invalid. It cannot contain line breaks.`,
+ } satisfies Record<CustomHeaderIssueCode, (arg: { headerName: string }) => string>,
},
errors: {
invalidUrl: {