Skip to content

refactor: improve logging on Factory download failure #1686

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
simonfernandes wants to merge 4 commits into
base: develop
Choose a base branch
from
Open

refactor: improve logging on Factory download failure #1686

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b948b91
Fix swallowing factory error with tracing enabled
simonfernandes Jul 28, 2026
e9853fc
Use error message from factory
simonfernandes Jul 28, 2026
c3e9e57
Merge branch 'develop' into fix-factory-failure-logging
simonfernandes Jul 29, 2026
1af3f57
Merge branch 'develop' into fix-factory-failure-logging
simonfernandes Jul 31, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 25 additions & 3 deletions apps/backend/src/factory/service.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,27 @@ export type XLSXMetaBase = MetaBase & { columns: string[] };

const ENDPOINT = process.env.USER_OFFICE_FACTORY_ENDPOINT;

async function throwFactoryError(
factoryResp: globalThis.Response,
downloadType: DownloadType,
type: PDFType | XLSXType | ZIPType
) {
const body = await factoryResp.text();

let parsed: { message?: string } | undefined;
try {
parsed = JSON.parse(body);
} catch {
parsed = undefined;
}

const detail = typeof parsed?.message === 'string' ? parsed.message : body;

throw new Error(
`Factory service failed to generate ${downloadType}/${type}: ${detail}`
);
}

export default async function callFactoryService<TData, TMeta extends MetaBase>(
downloadType: DownloadType,
type: PDFType | XLSXType | ZIPType,
Expand Down Expand Up @@ -90,7 +111,7 @@ export default async function callFactoryService<TData, TMeta extends MetaBase>(
);

if (!factoryResp.ok) {
throw new Error(await factoryResp.text());
await throwFactoryError(factoryResp, downloadType, type);
}

factoryRespBody = factoryResp.body;
Expand All @@ -110,6 +131,7 @@ export default async function callFactoryService<TData, TMeta extends MetaBase>(
});
span.setStatus({ code: 2, message: String(err) });
}
throw err;
} finally {
span.end();
}
Expand All @@ -124,7 +146,7 @@ export default async function callFactoryService<TData, TMeta extends MetaBase>(
});

if (!factoryResp.ok) {
throw new Error(await factoryResp.text());
await throwFactoryError(factoryResp, downloadType, type);
}

factoryRespBody = factoryResp.body;
Expand All @@ -141,7 +163,7 @@ export default async function callFactoryService<TData, TMeta extends MetaBase>(

readableStream.on('error', (err) => {
next({
error: err.toString(),
error: err,
message: `Could not download generated ${downloadType}/${type}`,
});
});
Expand Down
13 changes: 11 additions & 2 deletions apps/backend/src/middlewares/factory.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,17 +83,26 @@ factoryDownloadRouter.use(
next: NextFunction
) => {
let message: string;
let underlyingError: Error | undefined;

if (err instanceof Error) {
message = err.message;
underlyingError = err;
} else if (typeof err === 'string') {
message = err;
} else if (err.error instanceof Error) {
message = err.error.message;
underlyingError = err.error;
} else {
message = err.message;
}

err instanceof Error
? logger.logException(err.message, err, getLogContextFromRequest(req))
underlyingError
? logger.logException(
message,
underlyingError,
getLogContextFromRequest(req)
)
: logger.logError(defaultErrorMessage, {
err,
...getLogContextFromRequest(req),
Expand Down
Loading