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

Fix timeout logs #429

Merged
merged 3 commits into from
Sep 12, 2024
Merged

Fix timeout logs #429

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6c109ac
Fix timeout logs
marcospassos Sep 12, 2024
ec435be
Update src/contentFetcher.ts
marcospassos Sep 12, 2024
d2e93c7
Update src/contentFetcher.ts
marcospassos Sep 12, 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
13 changes: 5 additions & 8 deletions src/contentFetcher.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,14 +129,15 @@ export class ContentFetcher {
}

// Types for Browser and Node environment
Copy link
Member

Choose a reason for hiding this comment

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

Move the note as well. Or remove it if you don't think it's needed.

marcospassos marked this conversation as resolved.
Show resolved Hide resolved
let timeoutReference: number | NodeJS.Timeout | undefined;

return new Promise<FetchResponse<P>>((resolve, reject) => {
const abortController = new AbortController();
const timeout = options.timeout ?? this.configuration.defaultTimeout;

let timer: number | NodeJS.Timeout | undefined;
marcospassos marked this conversation as resolved.
Show resolved Hide resolved

if (timeout !== undefined) {
timeoutReference = setTimeout(
timer = setTimeout(
() => {
const response: ErrorResponse = {
title: `Content could not be loaded in time for slot '${slotId}'.`,
Expand All @@ -156,6 +157,7 @@ export class ContentFetcher {
}

this.load(slotId, abortController.signal, options)
.finally(() => clearTimeout(timer))
.then(response => {
const region = response.headers.get('X-Croct-Region');
const timing = response.headers.get('X-Croct-Timing');
Expand Down Expand Up @@ -192,12 +194,7 @@ export class ContentFetcher {
);
}
});
})
.finally(() => {
// Once the fetch completes, regardless of outcome, cancel the timeout
// to avoid logging an error that didn't happen.
clearTimeout(timeoutReference);
});
});
}

private load(slotId: string, signal: AbortSignal, options: FetchOptions): Promise<Response> {
Expand Down
115 changes: 59 additions & 56 deletions src/evaluator.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,8 @@ export class Evaluator {
const abortController = new AbortController();
const timeout = options.timeout ?? this.configuration.defaultTimeout;

let timer: number | NodeJS.Timeout | undefined;

if (timeout !== undefined) {
setTimeout(
() => {
Expand All @@ -187,63 +189,64 @@ export class Evaluator {
);
}

const promise = this.fetch(payload, abortController.signal, options);

promise.then(
response => {
const region = response.headers.get('X-Croct-Region');
const timing = response.headers.get('X-Croct-Timing');

this.logger.debug(
`Evaluation of the query "${reference}" processed by region ${region} in ${timing}.`,
);

return response.json()
.then(body => {
if (response.ok) {
return resolve(body);
}

this.logHelp(response.status);

const problem: ErrorResponse = body;

switch (problem.type) {
case EvaluationErrorType.INVALID_QUERY:
case EvaluationErrorType.EVALUATION_FAILED:
case EvaluationErrorType.TOO_COMPLEX_QUERY:
reject(new QueryError(problem as QueryErrorResponse));

break;

default:
reject(new EvaluationError(problem));

break;
}
})
.catch(error => {
if (!response.ok) {
throw new Error(`Error ${response.status} - ${response.statusText}`);
}

throw error;
});
},
).catch(
error => {
if (!abortController.signal.aborted) {
reject(
new EvaluationError({
title: formatMessage(error),
type: EvaluationErrorType.UNEXPECTED_ERROR,
detail: 'Please try again or contact Croct support if the error persists.',
status: 500, // Internal Server Error
}),
this.fetch(payload, abortController.signal, options)
.finally(() => clearTimeout(timer))
.then(
response => {
const region = response.headers.get('X-Croct-Region');
const timing = response.headers.get('X-Croct-Timing');

this.logger.debug(
`Evaluation of the query "${reference}" processed by region ${region} in ${timing}.`,
);
}
},
);

return response.json()
.then(body => {
if (response.ok) {
return resolve(body);
}

this.logHelp(response.status);

const problem: ErrorResponse = body;

switch (problem.type) {
case EvaluationErrorType.INVALID_QUERY:
case EvaluationErrorType.EVALUATION_FAILED:
case EvaluationErrorType.TOO_COMPLEX_QUERY:
reject(new QueryError(problem as QueryErrorResponse));

break;

default:
reject(new EvaluationError(problem));

break;
}
})
.catch(error => {
if (!response.ok) {
throw new Error(`Error ${response.status} - ${response.statusText}`);
}

throw error;
});
},
)
.catch(
error => {
if (!abortController.signal.aborted) {
reject(
new EvaluationError({
title: formatMessage(error),
type: EvaluationErrorType.UNEXPECTED_ERROR,
detail: 'Please try again or contact Croct support if the error persists.',
status: 500, // Internal Server Error
}),
);
}
},
);
});
}

Expand Down
33 changes: 27 additions & 6 deletions test/evaluator.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -277,9 +277,7 @@ describe('An evaluator', () => {
fetchMock.mock({
...requestMatcher,
delay: 20,
response: {
result: 'Carol',
},
response: JSON.stringify('Carol'),
});

const promise = evaluator.evaluate(query, {
Expand Down Expand Up @@ -315,9 +313,7 @@ describe('An evaluator', () => {
fetchMock.mock({
...requestMatcher,
delay: 20,
response: {
result: 'Carol',
},
response: JSON.stringify('Carol'),
});

const promise = evaluator.evaluate(query);
Expand All @@ -333,6 +329,31 @@ describe('An evaluator', () => {
});
});

it('should not log a timeout error message when request completes before the timeout', async () => {
jest.useFakeTimers();

const logger: Logger = {
debug: jest.fn(),
info: jest.fn(),
warn: jest.fn(),
error: jest.fn(),
};

const evaluator = new Evaluator({
appId: appId,
logger: logger,
});

fetchMock.mock({
...requestMatcher,
response: JSON.stringify('Carol'),
});

await expect(evaluator.evaluate(query, {timeout: 10})).resolves.toBe('Carol');

expect(logger.error).not.toHaveBeenCalled();
});

it('should evaluate queries using the provided context', async () => {
const evaluator = new Evaluator({
appId: appId,
Expand Down
Loading