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

feat: Reject promise immediately if var not found #1718

Merged
merged 4 commits into from
Jan 11, 2024
Merged

feat: Reject promise immediately if var not found #1718

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
06f0dc1
feat: Reject promise immediately if var not found
wusteven815 Jan 8, 2024
26b2d7c
feat(ConnectionUtils): improve error messages
wusteven815 Jan 9, 2024
8fa92e2
test(ConnectionUtils): update for new behaviour
wusteven815 Jan 9, 2024
1a2626a
fix: small grammar change
wusteven815 Jan 10, 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
36 changes: 9 additions & 27 deletions packages/jsapi-utils/src/ConnectionUtils.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,38 +56,24 @@ it('finds the right definition if variable exists', async () => {
expect(mockRemoveListener).toHaveBeenCalled();
});

it('finds the definition in the second update if not after the first update', async () => {
it('throws a TimeoutError if finding the variable timed out', async () => {
const timeout = 1000;
const fetchPromise = fetchVariableDefinition(
connection,
testDefinition2.title
testDefinition2.title,
timeout
);

expect(mockSubscribeToFieldUpdates).toHaveBeenCalled();
expect(mockRemoveListener).not.toHaveBeenCalled();

const listener = mockSubscribeToFieldUpdates.mock.calls[0][0];

listener({
created: [testDefinition1],
updated: [],
removed: [],
});

expect(mockRemoveListener).not.toHaveBeenCalled();
jest.advanceTimersByTime(timeout + 2000);

listener({
created: [testDefinition2],
updated: [],
removed: [],
});

const result = await fetchPromise;

expect(result).toBe(testDefinition2);
await expect(fetchPromise).rejects.toThrow(TimeoutError);
expect(mockRemoveListener).toHaveBeenCalled();
});

it('throws a TimeoutError if variable not found', async () => {
it('throws an Error if variable not found', async () => {
const fetchPromise = fetchVariableDefinition(
connection,
testDefinition2.title
Expand All @@ -104,11 +90,7 @@ it('throws a TimeoutError if variable not found', async () => {
removed: [],
});

expect(mockRemoveListener).not.toHaveBeenCalled();

jest.runOnlyPendingTimers();

await expect(fetchPromise).rejects.toThrow(Error);
await expect(fetchPromise).rejects.not.toThrow(TimeoutError);
expect(mockRemoveListener).toHaveBeenCalled();

await expect(fetchPromise).rejects.toThrow(TimeoutError);
});
8 changes: 5 additions & 3 deletions packages/jsapi-utils/src/ConnectionUtils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ export function fetchVariableDefinition(

const timeoutId = setTimeout(() => {
removeListener?.();
reject(new TimeoutError(`Variable ${name} not found`));
reject(new TimeoutError(`Timeout looking for variable ${name}`));
}, timeout);

/**
Expand All @@ -34,10 +34,12 @@ export function fetchVariableDefinition(
*/
function handleFieldUpdates(changes: VariableChanges): void {
const definition = changes.created.find(def => def.title === name);
clearTimeout(timeoutId);
removeListener?.();
if (definition != null) {
clearTimeout(timeoutId);
removeListener?.();
resolve(definition);
} else {
reject(new Error(`Variable ${name} not found`));
}
}

Expand Down
Loading