Skip to content

fix(#11051): log getUserSettings errors instead of silently swallowing them #11065

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
shivv23 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix(#11051): log getUserSettings errors instead of silently swallowing them #11065

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
5 changes: 4 additions & 1 deletion api/src/middleware/authorization.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,10 @@ const getUserSettings = (req) => {
.then(userCtx => {
req.userCtx = userCtx;
})
.catch(err => err);
.catch(err => {
logger.error('Failed to get user settings: %o', err);
return err;
});
};

module.exports = {
Expand Down
14 changes: 12 additions & 2 deletions api/tests/mocha/middleware/authorization.spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -206,7 +206,8 @@ describe('Authorization middleware', () => {
});
});

it('catches user_settings errors', () => {
it('catches user_settings errors and logs them', () => {
sinon.stub(logger, 'error');
testReq.userCtx = { name: 'user' };
auth.getUserCtx.resolves({ name: 'user' });
auth.isOnlineOnly.withArgs({ name: 'user' }).returns(false);
Expand All @@ -222,6 +223,10 @@ describe('Authorization middleware', () => {
testReq.userCtx.should.deep.equal({ name: 'user' });
auth.isOnlineOnly.args[0][0].should.deep.equal({ name: 'user'});
auth.getUserSettings.args[0][0].should.deep.equal({ name: 'user'});
logger.error.callCount.should.equal(1);
logger.error.args[0][0].should.equal('Failed to get user settings: %o');
logger.error.args[0][1].should.deep.equal({ some: 'error' });
logger.error.restore();
});
});
});
Expand Down Expand Up @@ -258,7 +263,8 @@ describe('Authorization middleware', () => {
});
});

it('catches user_settings errors', () => {
it('catches user_settings errors and logs them', () => {
sinon.stub(logger, 'error');
testReq.userCtx = { name: 'user' };
auth.isOnlineOnly.withArgs({ name: 'user' }).returns(false);
auth.getUserSettings.withArgs({ name: 'user' }).rejects({ some: 'error' });
Expand All @@ -272,6 +278,10 @@ describe('Authorization middleware', () => {
testReq.userCtx.should.deep.equal({ name: 'user' });
auth.isOnlineOnly.args[0][0].should.deep.equal({ name: 'user'});
auth.getUserSettings.args[0][0].should.deep.equal({ name: 'user'});
logger.error.callCount.should.equal(1);
logger.error.args[0][0].should.equal('Failed to get user settings: %o');
logger.error.args[0][1].should.deep.equal({ some: 'error' });
logger.error.restore();
});
});
});
Expand Down