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

CHES Notifications & Logger Adjustment #2730

Merged
merged 10 commits into from
Oct 22, 2024
Merged

CHES Notifications & Logger Adjustment #2730

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
c49fb28
stop resending notifications on previous status
dbarkowsky Oct 16, 2024
5f4b14b
cancel notifications on cancelled status
dbarkowsky Oct 16, 2024
60afac3
changed condition, added test
dbarkowsky Oct 17, 2024
e897205
Merge branch 'main' into PIMS-1946-Cancel/Stop-Notifications
LawrenceLau2020 Oct 17, 2024
f583404
send cancelled message still
dbarkowsky Oct 18, 2024
393e268
add formatter, stack to logger
dbarkowsky Oct 21, 2024
851a6cd
address !ok response from CHES
dbarkowsky Oct 21, 2024
15bae5a
Merge branch 'main' into PIMS-1946-Cancel/Stop-Notifications
dbarkowsky Oct 21, 2024
90ccff9
prettyprint or json
dbarkowsky Oct 21, 2024
ae31ff2
test update
dbarkowsky Oct 21, 2024
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
10 changes: 9 additions & 1 deletion express-api/src/services/ches/chesServices.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,11 +97,19 @@ const sendAsync = async (endpoint: string, method: string, data: Record<string,
body: data ? JSON.stringify(data) : undefined,
});

if (!response.ok) {
logger.error({
message: 'CHES Error',
chesResponse: JSON.parse(await response.text()),
});
return null;
}

const text = await response.text();
if (text.length) {
return JSON.parse(text);
} else {
return {};
return null;
}
};

Expand Down
6 changes: 4 additions & 2 deletions express-api/src/utilities/winstonLogger.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
import { format, createLogger, transports } from 'winston';
import constants from '@/constants';

const { timestamp, combine, json } = format;
const { timestamp, combine, json, prettyPrint } = format;
const { TESTING } = constants;
const { CONTAINERIZED } = process.env;

/**
* Creates a logger object that can be called to generate log messages.
Expand All @@ -19,7 +20,8 @@ const logger = createLogger({
timestamp({
format: 'YYYY-MM-DD hh:mm:ss.SSS A',
}),
json(),
CONTAINERIZED ? json() : prettyPrint(),
format.errors({ stack: true }),
),
transports: [new transports.Console()],
silent: TESTING,
Expand Down
36 changes: 35 additions & 1 deletion express-api/tests/unit/services/ches/chesServices.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ describe('UNIT - Ches Services', () => {
text: () => '{"access_token":"eyAiYSI6IDEgfQ==.ewoiZXhwIjoxCn0="}',
}));
_fetch.mockImplementationOnce(() => ({
ok: true,
text: () => `{ "messages": [{}], "txId": "${randomUUID()}" }`,
}));
const response = await chesServices.sendEmailAsync(email, keycloak);
Expand All @@ -35,10 +36,37 @@ describe('UNIT - Ches Services', () => {
text: () => '{"access_token":"eyAiYSI6IDEgfQ==.ewoiZXhwIjoxCn0="}',
}));
_fetch.mockImplementationOnce(() => ({
ok: false,
text: () => `{ "messages": [{}], "txId": "${randomUUID()}" }`,
}));
expect(async () => await chesServices.sendEmailAsync(email, keycloak)).rejects.toThrow();
});
it('should return null if the CHES response is not OK', async () => {
const email = produceEmail({ cc: ['[email protected]'], bcc: ['[email protected]'] });
const keycloak = producePimsRequestUser();
_fetch.mockImplementationOnce(() => ({
text: () => '{"access_token":"eyAiYSI6IDEgfQ==.ewoiZXhwIjoxCn0="}',
}));
_fetch.mockImplementationOnce(() => ({
ok: false,
text: () => `{ "messages": [{}], "txId": "${randomUUID()}" }`,
}));
const result = await chesServices.sendEmailAsync(email, keycloak);
expect(result).toBeNull();
});
it('should return null if the CHES response has no text length', async () => {
const email = produceEmail({ cc: ['[email protected]'], bcc: ['[email protected]'] });
const keycloak = producePimsRequestUser();
_fetch.mockImplementationOnce(() => ({
text: () => '{"access_token":"eyAiYSI6IDEgfQ==.ewoiZXhwIjoxCn0="}',
}));
_fetch.mockImplementationOnce(() => ({
ok: true,
text: () => ``,
}));
const result = await chesServices.sendEmailAsync(email, keycloak);
expect(result).toBeNull();
});
it('should send email with extra config', async () => {
const email: IEmail = produceEmail({});
const keycloak = producePimsRequestUser();
Expand All @@ -55,6 +83,7 @@ describe('UNIT - Ches Services', () => {
text: () => '{"access_token":"eyAiYSI6IDEgfQ==.ewoiZXhwIjoxCn0="}',
}));
_fetch.mockImplementationOnce(() => ({
ok: true,
text: () => `{ "messages": [{}], "txId": "${randomUUID()}" }`,
}));
const response = await chesServices.sendEmailAsync(email, keycloak);
Expand All @@ -67,8 +96,8 @@ describe('UNIT - Ches Services', () => {
text: () => '{"access_token":"eyAiYSI6IDEgfQ==.ewoiZXhwIjoxCn0="}',
}));
_fetch.mockImplementationOnce(() => ({
ok: true,
text: () => `

{

"createdTS": 1560000000,
Expand Down Expand Up @@ -102,6 +131,7 @@ describe('UNIT - Ches Services', () => {
text: () => '{"access_token":"eyAiYSI6IDEgfQ==.ewoiZXhwIjoxCn0="}',
}));
_fetch.mockImplementationOnce(() => ({
ok: true,
text: () => `
[
{
Expand Down Expand Up @@ -143,6 +173,7 @@ describe('UNIT - Ches Services', () => {
text: () => '{"access_token":"eyAiYSI6IDEgfQ==.ewoiZXhwIjoxCn0="}',
}));
_fetch.mockImplementationOnce(() => ({
ok: true,
text: () => `

{
Expand Down Expand Up @@ -177,6 +208,7 @@ describe('UNIT - Ches Services', () => {
text: () => '{"access_token":"eyAiYSI6IDEgfQ==.ewoiZXhwIjoxCn0="}',
}));
_fetch.mockImplementationOnce(() => ({
ok: true,
text: () => `

{
Expand All @@ -202,6 +234,7 @@ describe('UNIT - Ches Services', () => {
text: () => '{"access_token":"eyAiYSI6IDEgfQ==.ewoiZXhwIjoxCn0="}',
}));
_fetch.mockImplementationOnce(() => ({
ok: true,
text: () => `

{
Expand Down Expand Up @@ -238,6 +271,7 @@ describe('UNIT - Ches Services', () => {
text: () => '{"access_token":"eyAiYSI6IDEgfQ==.ewoiZXhwIjoxCn0="}',
}));
_fetch.mockImplementationOnce(() => ({
ok: true,
text: () => `
[
{
Expand Down
Loading