Skip to content

Commit

Permalink
mockRunRequest
Browse files Browse the repository at this point in the history
  • Loading branch information
@gorakong
gorakong committed Nov 15, 2023
1 parent 1943236 commit fe4e0c5
Showing 1 changed file with 105 additions and 78 deletions.
183 changes: 105 additions & 78 deletions packages/core/core/test/RequestTracker.test.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,12 @@

import assert from 'assert';
import nullthrows from 'nullthrows';
import RequestTracker, {type RunAPI} from '../src/RequestTracker';
import RequestTracker, {
type RunAPI,
type Request,
type RequestType,
type RunRequestOpts,
} from '../src/RequestTracker';
import WorkerFarm from '@parcel/workers';
import {DEFAULT_OPTIONS} from './test-utils';
import {INITIAL_BUILD} from '../src/constants';
Expand All @@ -11,20 +16,68 @@ import {makeDeferredWithPromise} from '@parcel/utils';
const options = DEFAULT_OPTIONS;
const farm = new WorkerFarm({workerPath: require.resolve('../src/worker.js')});

type MockRequest<TInput, TResult> = {
...Request<TInput, TResult>,
type: RequestType | 'mock_request',
...
};

const extractRequestType = <TInput, TResult>(
request: MockRequest<TInput, TResult>,
): Request<TInput, TResult> => {
let newRequest: ?Request<TInput, TResult>;
if (request.type === 'mock_request') {
newRequest = {
id: request.id,
// For Flow: Mock all mock_request types to parcel_build_request
type: 'parcel_build_request',
input: request.input,
run: request.run,
};
} else {
newRequest = {
id: request.id,
type: request.type,
input: request.input,
run: request.run,
};
}
return newRequest;
};

// eslint-disable-next-line require-await
async function mockRunRequest<TInput, TResult>(
tracker: RequestTracker,
request: MockRequest<TInput, TResult>,
opts?: RunRequestOpts,
): Promise<TResult> {
const newRequest = extractRequestType(request);
return tracker.runRequest(newRequest, opts);
}

// eslint-disable-next-line require-await
async function apiMockRunRequest<TInput, TResult>(
api: RunAPI<TResult>,
request: MockRequest<TInput, TResult>,
opts?: RunRequestOpts,
): Promise<TResult> {
const newRequest = extractRequestType(request);

return api.runRequest(newRequest, opts);
}

describe('RequestTracker', () => {
it('should not run requests that have not been invalidated', async () => {
let tracker = new RequestTracker({farm, options});
await tracker.runRequest({
await mockRunRequest(tracker, {
id: 'abc',
// $FlowFixMe[incompatible-call]
type: 'mock_request',
run: () => {},
input: null,
});
let called = false;
await tracker.runRequest({
await mockRunRequest(tracker, {
id: 'abc',
// $FlowFixMe[incompatible-call]
type: 'mock_request',
run: () => {
called = true;
Expand All @@ -36,9 +89,8 @@ describe('RequestTracker', () => {

it('should rerun requests that have been invalidated', async () => {
let tracker = new RequestTracker({farm, options});
await tracker.runRequest({
await mockRunRequest(tracker, {
id: 'abc',
// $FlowFixMe[incompatible-call]
type: 'mock_request',
run: () => {},
input: null,
Expand All @@ -48,9 +100,8 @@ describe('RequestTracker', () => {
INITIAL_BUILD,
);
let called = false;
await tracker.runRequest({
await mockRunRequest(tracker, {
id: 'abc',
// $FlowFixMe[incompatible-call]
type: 'mock_request',
run: () => {
called = true;
Expand All @@ -62,14 +113,12 @@ describe('RequestTracker', () => {

it('should invalidate requests with invalidated subrequests', async () => {
let tracker = new RequestTracker({farm, options});
await tracker.runRequest({
await mockRunRequest(tracker, {
id: 'abc',
// $FlowFixMe[incompatible-call]
type: 'mock_request',
run: async ({api}) => {
await api.runRequest({
await apiMockRunRequest(api, {
id: 'xyz',
// $FlowFixMe[incompatible-call]
type: 'mock_request',
run: () => {},
input: null,
Expand All @@ -91,20 +140,17 @@ describe('RequestTracker', () => {

it('should invalidate requests that failed', async () => {
let tracker = new RequestTracker({farm, options});
await tracker
.runRequest({
id: 'abc',
// $FlowFixMe[incompatible-call]
type: 'mock_request',
run: async () => {
await Promise.resolve();
throw new Error('woops');
},
input: null,
})
.then(null, () => {
/* do nothing */
});
await mockRunRequest(tracker, {
id: 'abc',
type: 'mock_request',
run: async () => {
await Promise.resolve();
throw new Error('woops');
},
input: null,
}).then(null, () => {
/* do nothing */
});
assert(
tracker
.getInvalidRequests()
Expand All @@ -115,14 +161,12 @@ describe('RequestTracker', () => {

it('should remove subrequests that are no longer called within a request', async () => {
let tracker = new RequestTracker({farm, options});
await tracker.runRequest({
await mockRunRequest(tracker, {
id: 'abc',
// $FlowFixMe[incompatible-call]
type: 'mock_request',
run: async ({api}) => {
await api.runRequest({
await apiMockRunRequest(api, {
id: 'xyz',
// $FlowFixMe[incompatible-call]
type: 'mock_request',
run: () => {},
input: null,
Expand All @@ -132,14 +176,12 @@ describe('RequestTracker', () => {
});
let nodeId = nullthrows(tracker.graph.getNodeIdByContentKey('abc'));
tracker.graph.invalidateNode(nodeId, INITIAL_BUILD);
await tracker.runRequest({
await mockRunRequest(tracker, {
id: 'abc',
// $FlowFixMe[incompatible-call]
type: 'mock_request',
run: async ({api}) => {
await api.runRequest({
await apiMockRunRequest(api, {
id: '123',
// $FlowFixMe[incompatible-call]
type: 'mock_request',
run: () => {},
input: null,
Expand All @@ -152,19 +194,17 @@ describe('RequestTracker', () => {

it('should return a cached result if it was stored', async () => {
let tracker = new RequestTracker({farm, options});
await tracker.runRequest({
await mockRunRequest(tracker, {
id: 'abc',
// $FlowFixMe[incompatible-call]
type: 'mock_request',
run: async ({api}: {api: RunAPI<string | void>, ...}) => {
let result = await Promise.resolve('hello');
api.storeResult(result);
},
input: null,
});
let result = await tracker.runRequest({
let result = await mockRunRequest(tracker, {
id: 'abc',
// $FlowFixMe[incompatible-call]
type: 'mock_request',
run: async () => {},
input: null,
Expand All @@ -174,19 +214,16 @@ describe('RequestTracker', () => {

it('should reject all in progress requests when the abort controller aborts', async () => {
let tracker = new RequestTracker({farm, options});
let p = tracker
.runRequest({
id: 'abc',
// $FlowFixMe[incompatible-call]
type: 'mock_request',
run: async () => {
await Promise.resolve('hello');
},
input: null,
})
.then(null, () => {
/* do nothing */
});
let p = mockRunRequest(tracker, {
id: 'abc',
type: 'mock_request',
run: async () => {
await Promise.resolve('hello');
},
input: null,
}).then(null, () => {
/* do nothing */
});
// $FlowFixMe
tracker.setSignal({aborted: true});
await p;
Expand All @@ -200,13 +237,11 @@ describe('RequestTracker', () => {

it('should not requeue requests if the previous request is still running', async () => {
let tracker = new RequestTracker({farm, options});

let lockA = makeDeferredWithPromise();
let lockB = makeDeferredWithPromise();

let requestA = tracker.runRequest({
let requestA = mockRunRequest(tracker, {
id: 'abc',
// $FlowFixMe[incompatible-call]
type: 'mock_request',
run: async ({api}: {api: RunAPI<string>, ...}) => {
await lockA.promise;
Expand All @@ -217,9 +252,8 @@ describe('RequestTracker', () => {
});

let calledB = false;
let requestB = tracker.runRequest({
let requestB = mockRunRequest(tracker, {
id: 'abc',
// $FlowFixMe[incompatible-call]
type: 'mock_request',
run: async ({api}: {api: RunAPI<string>, ...}) => {
calledB = true;
Expand All @@ -238,9 +272,8 @@ describe('RequestTracker', () => {
assert.strictEqual(resultB, 'a');
assert.strictEqual(calledB, false);

let cachedResult = await tracker.runRequest({
let cachedResult = await mockRunRequest(tracker, {
id: 'abc',
// $FlowFixMe[incompatible-call]
type: 'mock_request',
run: () => {},
input: null,
Expand All @@ -250,28 +283,23 @@ describe('RequestTracker', () => {

it('should requeue requests if the previous request is still running but failed', async () => {
let tracker = new RequestTracker({farm, options});

let lockA = makeDeferredWithPromise();
let lockB = makeDeferredWithPromise();

let requestA = tracker
.runRequest({
id: 'abc',
// $FlowFixMe[incompatible-call]
type: 'mock_request',
run: async () => {
await lockA.promise;
throw new Error('whoops');
},
input: null,
})
.catch(() => {
// ignore
});
let requestA = mockRunRequest(tracker, {
id: 'abc',
type: 'mock_request',
run: async () => {
await lockA.promise;
throw new Error('whoops');
},
input: null,
}).catch(() => {
// ignore
});

let requestB = tracker.runRequest({
let requestB = mockRunRequest(tracker, {
id: 'abc',
// $FlowFixMe[incompatible-call]
type: 'mock_request',
run: async ({api}: {api: RunAPI<string | void>, ...}) => {
await lockB.promise;
Expand All @@ -286,9 +314,8 @@ describe('RequestTracker', () => {
await requestB;

let called = false;
let cachedResult = await tracker.runRequest({
let cachedResult = await mockRunRequest(tracker, {
id: 'abc',
// $FlowFixMe[incompatible-call]
type: 'mock_request',
run: () => {
called = true;
Expand Down

0 comments on commit fe4e0c5

Please sign in to comment.