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

[apiFetch] Fix preloading middleware referencing stale data #25550

Merged
merged 2 commits into from
Sep 24, 2020
Merged

[apiFetch] Fix preloading middleware referencing stale data #25550

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a570088
Reference the preload cache only for the first request
jeyip Sep 22, 2020
0449a0f
Unset cache keys instead of adding a boolean
jeyip Sep 24, 2020
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
12 changes: 10 additions & 2 deletions packages/api-fetch/src/middlewares/preloading.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,10 @@ export function getStablePath( path ) {

function createPreloadingMiddleware( preloadedData ) {
const cache = Object.keys( preloadedData ).reduce( ( result, path ) => {
result[ getStablePath( path ) ] = preloadedData[ path ];
result[ getStablePath( path ) ] = {
...preloadedData[ path ],
hasBeenPreloaded: false,
};
return result;
}, {} );

Expand All @@ -45,7 +48,12 @@ function createPreloadingMiddleware( preloadedData ) {
const method = options.method || 'GET';
const path = getStablePath( options.path );

if ( 'GET' === method && cache[ path ] ) {
if (
'GET' === method &&
cache[ path ] &&
! cache[ path ].hasBeenPreloaded
) {
cache[ path ].hasBeenPreloaded = true;
Copy link
Contributor

Choose a reason for hiding this comment

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

maybe instead of adding a boolean we can just unset the cache key?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

That's a great point! Unsetting would probably work as well and be less verbose. 👍

return Promise.resolve(
parse
? cache[ path ].body
Expand Down
94 changes: 75 additions & 19 deletions packages/api-fetch/src/middlewares/test/preloading.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,26 +27,82 @@ describe( 'Preloading Middleware', () => {
} );
} );

it( 'should return the preloaded data if provided', () => {
const body = {
status: 'this is the preloaded response',
};
const preloadedData = {
'wp/v2/posts': {
body,
},
};
const preloadingMiddleware = createPreloadingMiddleware(
preloadedData
);
const requestOptions = {
method: 'GET',
path: 'wp/v2/posts',
};
describe( 'given preloaded data', () => {
describe( 'when data is requested from a preloaded endpoint', () => {
describe( 'and it is requested for the first time', () => {
it( 'should return the preloaded data', () => {
const body = {
status: 'this is the preloaded response',
};
const preloadedData = {
'wp/v2/posts': {
body,
},
};
const preloadingMiddleware = createPreloadingMiddleware(
preloadedData
);
const requestOptions = {
method: 'GET',
path: 'wp/v2/posts',
};

const response = preloadingMiddleware( requestOptions );
return response.then( ( value ) => {
expect( value ).toEqual( body );
} );
} );
} );

describe( 'and it has already been requested', () => {
it( 'should not return the preloaded data', () => {
const body = {
status: 'this is the preloaded response',
};
const preloadedData = {
'wp/v2/posts': {
body,
},
};
const preloadingMiddleware = createPreloadingMiddleware(
preloadedData
);
const requestOptions = {
method: 'GET',
path: 'wp/v2/posts',
};
const nextSpy = jest.fn();

const response = preloadingMiddleware( requestOptions );
return response.then( ( value ) => {
expect( value ).toEqual( body );
preloadingMiddleware( requestOptions, nextSpy );
expect( nextSpy ).not.toHaveBeenCalled();
preloadingMiddleware( requestOptions, nextSpy );
expect( nextSpy ).toHaveBeenCalled();
} );
} );
} );

describe( 'when the requested data is not from a preloaded endpoint', () => {
it( 'should not return preloaded data', () => {
const body = {
status: 'this is the preloaded response',
};
const preloadedData = {
'wp/v2/posts': {
body,
},
};
const preloadingMiddleware = createPreloadingMiddleware(
preloadedData
);
const requestOptions = {
method: 'GET',
path: 'wp/v2/fake_resource',
};
const nextSpy = jest.fn();

preloadingMiddleware( requestOptions, nextSpy );
expect( nextSpy ).toHaveBeenCalled();
} );
} );
} );

Expand Down