Skip to content

fix: Reduces logging of client errors (SYSADMIN-11114) #764

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

Merged
ryasmi merged 1 commit into from
Mar 30, 2021
Merged

fix: Reduces logging of client errors (SYSADMIN-11114) #764

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@
"http-status-codes": "^2.0.0",
"install": "^0.13.0",
"ioredis": "^4.14.0",
"jscommons": "^3.0.0",
"jscommons": "^3.0.1",
"jsonwebtoken": "^8.5.1",
"lodash": "^4.17.4",
"mime-types": "2.1.29",
Expand Down
16 changes: 1 addition & 15 deletions src/apps/activities/expressPresenter/utils/handleError.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,53 +24,43 @@ export interface Options extends CommonOptions {
}

export default ({ config, errorId, res, err }: Options): Response => {
const { logger, translator } = config;
const logError = (msg: string, meta?: any) => {
logger.error(`${errorId}: xapi-activities handled - ${msg}`, meta);
};
const { translator } = config;

res.setHeader('X-Experience-API-Version', xapiHeaderVersion);

if (err instanceof JsonSyntaxError) {
const code = StatusCodes.BAD_REQUEST;
const message = translator.jsonSyntaxError(err);
logError(message);
return sendMessage({ res, code, errorId, message });
}
if (err instanceof MissingEtags) {
const code = StatusCodes.BAD_REQUEST;
const message = translator.missingEtagsError(err);
logError(message);
return sendMessage({ res, code, errorId, message });
}
if (err instanceof MaxEtags) {
const code = StatusCodes.BAD_REQUEST;
const message = translator.maxEtagsError(err);
logError(message);
return sendMessage({ res, code, errorId, message });
}
if (err instanceof Conflict) {
const code = StatusCodes.CONFLICT;
const message = translator.conflictError(err);
logError(message);
return sendMessage({ res, code, errorId, message });
}
if (err instanceof IfMatch) {
const code = StatusCodes.PRECONDITION_FAILED;
const message = translator.ifMatchError(err);
logError(message);
return sendMessage({ res, code, errorId, message });
}
if (err instanceof IfNoneMatch) {
const code = StatusCodes.PRECONDITION_FAILED;
const message = translator.ifNoneMatchError(err);
logError(message);
return sendMessage({ res, code, errorId, message });
}
if (err instanceof NonJsonObject) {
const code = StatusCodes.BAD_REQUEST;
const message = translator.nonJsonObjectError(err);
logError(message);
return sendMessage({ res, code, errorId, message });
}
if (err instanceof Warnings) {
Expand All @@ -80,25 +70,21 @@ export default ({ config, errorId, res, err }: Options): Response => {
return translateWarning(translator, warning);
});
const obj = { warnings: strWarnings };
logError('Validation warnings', strWarnings);
return sendObject({ res, code, errorId, obj });
}
if (err instanceof InvalidMethod) {
const code = StatusCodes.BAD_REQUEST;
const message = translator.invalidMethodError(err);
logError(message);
return sendMessage({ res, code, errorId, message });
}
if (err instanceof ExpiredClientError) {
const code = StatusCodes.FORBIDDEN;
const message = translator.expiredClientError(err);
logError(message);
return sendMessage({ res, code, errorId, message });
}
if (err instanceof UntrustedClientError) {
const code = StatusCodes.FORBIDDEN;
const message = translator.untrustedClientError(err);
logError(message);
return sendMessage({ res, code, errorId, message });
}
return commonErrorHandler({ config, errorId, res, err });
Expand Down
16 changes: 1 addition & 15 deletions src/apps/agents/expressPresenter/utils/handleError.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,53 +24,43 @@ export interface Options extends CommonOptions {
}

export default ({ config, errorId, res, err }: Options): Response => {
const { logger, translator } = config;
const logError = (msg: string, meta?: any) => {
logger.error(`${errorId}: xapi-agents handled - ${msg}`, meta);
};
const { translator } = config;

res.setHeader('X-Experience-API-Version', xapiHeaderVersion);

if (err instanceof MissingEtags) {
const code = StatusCodes.BAD_REQUEST;
const message = translator.missingEtagsError(err);
logError(message);
return sendMessage({ res, code, errorId, message });
}
if (err instanceof JsonSyntaxError) {
const code = StatusCodes.BAD_REQUEST;
const message = translator.jsonSyntaxError(err);
logError(message);
return sendMessage({ res, code, errorId, message });
}
if (err instanceof MaxEtags) {
const code = StatusCodes.BAD_REQUEST;
const message = translator.maxEtagsError(err);
logError(message);
return sendMessage({ res, code, errorId, message });
}
if (err instanceof Conflict) {
const code = StatusCodes.CONFLICT;
const message = translator.conflictError(err);
logError(message);
return sendMessage({ res, code, errorId, message });
}
if (err instanceof IfMatch) {
const code = StatusCodes.PRECONDITION_FAILED;
const message = translator.ifMatchError(err);
logError(message);
return sendMessage({ res, code, errorId, message });
}
if (err instanceof IfNoneMatch) {
const code = StatusCodes.PRECONDITION_FAILED;
const message = translator.ifNoneMatchError(err);
logError(message);
return sendMessage({ res, code, errorId, message });
}
if (err instanceof NonJsonObject) {
const code = StatusCodes.BAD_REQUEST;
const message = translator.nonJsonObjectError(err);
logError(message);
return sendMessage({ res, code, errorId, message });
}
if (err instanceof Warnings) {
Expand All @@ -80,25 +70,21 @@ export default ({ config, errorId, res, err }: Options): Response => {
return translateWarning(translator, warning);
});
const obj = { warnings: strWarnings };
logError('Validation warnings', strWarnings);
return sendObject({ res, code, errorId, obj });
}
if (err instanceof InvalidMethod) {
const code = StatusCodes.BAD_REQUEST;
const message = translator.invalidMethodError(err);
logError(message);
return sendMessage({ res, code, errorId, message });
}
if (err instanceof ExpiredClientError) {
const code = StatusCodes.FORBIDDEN;
const message = translator.expiredClientError(err);
logError(message);
return sendMessage({ res, code, errorId, message });
}
if (err instanceof UntrustedClientError) {
const code = StatusCodes.FORBIDDEN;
const message = translator.untrustedClientError(err);
logError(message);
return sendMessage({ res, code, errorId, message });
}
return commonErrorHandler({ config, errorId, res, err });
Expand Down
23 changes: 0 additions & 23 deletions src/apps/statements/expressPresenter/utils/handleError.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,38 +53,32 @@ export default ({ config, errorId, res, err }: Options): Response => {
if (err instanceof InvalidSignatureAlgorithm) {
const code = StatusCodes.BAD_REQUEST;
const message = translator.invalidSignatureAlgorithmError(err);
logError(message);
return sendMessage({ res, code, errorId, message });
}
if (err instanceof InvalidX5CType) {
const code = StatusCodes.BAD_REQUEST;
const message = translator.invalidX5CTypeError(err);
logError(message);
return sendMessage({ res, code, errorId, message });
}
if (err instanceof InvalidX5CChain) {
const code = StatusCodes.BAD_REQUEST;
const message = translator.invalidX5CChainError(err);
logError(message);
return sendMessage({ res, code, errorId, message });
}
if (err instanceof InvalidJws) {
const code = StatusCodes.BAD_REQUEST;
const message = translator.invalidJwsError(err);
logError(message);
return sendMessage({ res, code, errorId, message });
}
if (err instanceof InvalidSignedStatement) {
const code = StatusCodes.BAD_REQUEST;
const message = translator.invalidSignedStatementError(err);
const obj = { message, statement: err.originalStatement };
logError(message);
return sendObject({ res, code, errorId, obj });
}
if (err instanceof JsonSyntaxError) {
const code = StatusCodes.BAD_REQUEST;
const message = translator.jsonSyntaxError(err);
logError(message);
return sendMessage({ res, code, errorId, message });
}
if (err instanceof ChangedStatementRef) {
Expand All @@ -96,67 +90,56 @@ export default ({ config, errorId, res, err }: Options): Response => {
if (err instanceof Conflict) {
const code = 409;
const message = translator.conflictError(err);
logError(message);
return sendMessage({ res, code, errorId, message });
}
if (err instanceof DataBeforeFirstBoundary) {
const code = StatusCodes.BAD_REQUEST;
const message = translator.dataBeforeFirstBoundaryError(err);
logError(message);
return sendMessage({ res, code, errorId, message });
}
if (err instanceof DataBeyondFinalBoundary) {
const code = StatusCodes.BAD_REQUEST;
const message = translator.dataBeyondFinalBoundaryError(err);
logError(message);
return sendMessage({ res, code, errorId, message });
}
if (err instanceof DuplicateId) {
const code = StatusCodes.BAD_REQUEST;
const message = translator.duplicateIdError(err);
logError(message);
return sendMessage({ res, code, errorId, message });
}
if (err instanceof ExtraAttachments) {
const code = StatusCodes.BAD_REQUEST;
const message = translator.extraAttachmentsError(err);
logError(message);
return sendMessage({ res, code, errorId, message });
}
if (err instanceof InvalidBoundary) {
const code = StatusCodes.BAD_REQUEST;
const message = translator.invalidBoundaryError(err);
logError(message);
return sendMessage({ res, code, errorId, message });
}
if (err instanceof InvalidContentType) {
const code = StatusCodes.BAD_REQUEST;
const message = translator.invalidContentTypeError(err);
logError(message);
return sendMessage({ res, code, errorId, message });
}
if (err instanceof InvalidContentTransferEncoding) {
const code = StatusCodes.BAD_REQUEST;
const message = translator.invalidContentTransferEncodingError(err);
logError(message);
return sendMessage({ res, code, errorId, message });
}
if (err instanceof InvalidMethod) {
const code = StatusCodes.BAD_REQUEST;
const message = translator.invalidMethodError(err);
logError(message);
return sendMessage({ res, code, errorId, message });
}
if (err instanceof InvalidVoidType) {
const code = StatusCodes.BAD_REQUEST;
const message = translator.invalidVoidTypeError(err);
logError(message);
return sendMessage({ res, code, errorId, message });
}
if (err instanceof MissingAttachments) {
const code = StatusCodes.BAD_REQUEST;
const message = translator.missingAttachmentsError(err);
logError(message);
return sendMessage({ res, code, errorId, message });
}
if (err instanceof MissingLoadedId) {
Expand All @@ -168,37 +151,31 @@ export default ({ config, errorId, res, err }: Options): Response => {
if (err instanceof MissingStatementId) {
const code = StatusCodes.BAD_REQUEST;
const message = translator.missingStatementIdError(err);
logError(message);
return sendMessage({ res, code, errorId, message });
}
if (err instanceof NoStatements) {
const code = StatusCodes.BAD_REQUEST;
const message = translator.noStatementsError(err);
logError(message);
return sendMessage({ res, code, errorId, message });
}
if (err instanceof QueryIds) {
const code = StatusCodes.BAD_REQUEST;
const message = translator.queryIdsError(err);
logError(message);
return sendMessage({ res, code, errorId, message });
}
if (err instanceof UnknownParams) {
const code = StatusCodes.BAD_REQUEST;
const message = translator.unknownParamsError(err);
logError(message);
return sendMessage({ res, code, errorId, message });
}
if (err instanceof UnequalStatementId) {
const code = StatusCodes.BAD_REQUEST;
const message = translator.unequalStatementIdError(err);
logError(message);
return sendMessage({ res, code, errorId, message });
}
if (err instanceof VoidingError) {
const code = StatusCodes.BAD_REQUEST;
const message = translator.voidingErrorError(err);
logError(message);
return sendMessage({ res, code, errorId, message });
}
if (err instanceof ExpiredClientError) {
Expand Down
9 changes: 1 addition & 8 deletions src/apps/states/expressPresenter/utils/handleError.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,23 +19,18 @@ export interface Options extends CommonOptions {
}

export default ({ config, errorId, res, err }: Options): Response => {
const { logger, translator } = config;
const logError = (msg: string, meta?: any) => {
logger.error(`${errorId}: xapi-state handled - ${msg}`, meta);
};
const { translator } = config;

res.setHeader('X-Experience-API-Version', xapiHeaderVersion);

if (err instanceof JsonSyntaxError) {
const code = StatusCodes.BAD_REQUEST;
const message = translator.jsonSyntaxError(err);
logError(message);
return sendMessage({ res, code, errorId, message });
}
if (err instanceof NonJsonObject) {
const code = StatusCodes.BAD_REQUEST;
const message = translator.nonJsonObjectError(err);
logError(message);
return sendMessage({ res, code, errorId, message });
}
if (err instanceof Warnings) {
Expand All @@ -45,13 +40,11 @@ export default ({ config, errorId, res, err }: Options): Response => {
return translateWarning(translator, warning);
});
const obj = { warnings: strWarnings };
logError('Validation warnings', strWarnings);
return sendObject({ res, code, errorId, obj });
}
if (err instanceof InvalidMethod) {
const code = StatusCodes.BAD_REQUEST;
const message = translator.invalidMethodError(err);
logError(message);
return sendMessage({ res, code, errorId, message });
}
if (err instanceof ExpiredClientError) {
Expand Down
Loading