Skip to content
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

Jump to bottom

[TECH] Refactorer le logger #254

Merged
merged 2 commits into from
Sep 12, 2023
Merged

[TECH] Refactorer le logger #254

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f3c8485
refactor
octo-topi May 30, 2023
b78e110
add ok level to logger
annemarie35 Sep 8, 2023
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
50 changes: 17 additions & 33 deletions common/services/logger.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,49 +1,33 @@
function createMessage({ event, message, job, stack }, level) {
let obj = {};

if (event) {
obj.event = event;
}

if (message) {
if (typeof message === 'object') {
message = JSON.stringify(message);
}

obj.message = message;
}

if (job) {
obj.job = job;
}

if (stack) {
if (typeof stack === 'object') {
stack = JSON.stringify(message);
}

obj.stack = stack;
}

obj.level = level;

return JSON.stringify(obj);
function serialize({ event, message, job, stack, level }) {
const log = {
event,
message: typeof message === 'object' ? JSON.stringify(message) : message,
annemarie35 marked this conversation as resolved.
Show resolved Hide resolved
job,
stack: typeof stack === 'object' ? JSON.stringify(stack) : stack,
level,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Marrant parce qu'on avait fait ça avant :

stack = JSON.stringify(message);

};

return JSON.stringify(log);
}

const error = ({ event, message, job, stack }, injectedLogger = console) => {
injectedLogger.error(createMessage({ event, message, job, stack }, 'error'));
injectedLogger.error(serialize({ event, message, job, stack, level: 'error' }));
};

const info = ({ event, message, job, stack }, injectedLogger = console) => {
injectedLogger.log(createMessage({ event, message, job, stack }, 'info'));
injectedLogger.log(serialize({ event, message, job, stack, level: 'info' }));
};

const warn = ({ event, message, job, stack }, injectedLogger = console) => {
injectedLogger.warn(createMessage({ event, message, job, stack }, 'warn'));
octo-topi marked this conversation as resolved.
Show resolved Hide resolved
injectedLogger.warn(serialize({ event, message, job, stack, level: 'warn' }));
};
const ok = ({ event, message, job, stack }, injectedLogger = console) => {
injectedLogger.ok(serialize({ event, message, job, stack, level: 'ok' }));
};

module.exports = {
error,
info,
warn,
ok,
};
32 changes: 32 additions & 0 deletions test/unit/common/services/logger_test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,4 +97,36 @@ describe('logger', function () {
});
});
});
describe('ok', function () {
describe('when an message is passed', function () {
it('should call injectedLogger ok', function () {
// given
const injectedLogger = { ok: sinon.stub() };

// when
logger.ok({ event: 'toto', message: 'titi', stack: 'stack' }, injectedLogger);

// then
expect(injectedLogger.ok.calledOnce).to.be.true;
expect(injectedLogger.ok.firstCall.args[0]).to.equal(
'{"event":"toto","message":"titi","stack":"stack","level":"ok"}',
);
});
});
describe('when an object is passed', function () {
it('should call injectedLogger warn with object in message', function () {
// given
const injectedLogger = { ok: sinon.stub() };

// when
logger.ok({ event: 'toto', message: { foo: 'bar' }, stack: 'stack' }, injectedLogger);

// then
expect(injectedLogger.ok.calledOnce).to.be.true;
expect(injectedLogger.ok.firstCall.args[0]).to.equal(
'{"event":"toto","message":"{\\"foo\\":\\"bar\\"}","stack":"stack","level":"ok"}',
);
});
});
});
});
Loading