Skip to content

Commit e0df4cc

Browse files
authored
chore(docs): Change "whitelist" to "allow list" (#30756)
1 parent 81ec270 commit e0df4cc

File tree

3 files changed

+7
-7
lines changed

3 files changed

+7
-7
lines changed

docs/docs/resource-handling-and-service-workers.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ It's important that this array is accurate - if a page entered the array when it
2727
When all resources for a page have been successfully prefetched, we do _one_ of the following:
2828

2929
- Add the page's path to a temporary array of prefetched paths, if the service worker has not yet installed
30-
- Send a message to the service worker to let it know to whitelist the page's path, if it is installed
30+
- Send a message to the service worker to let it know to allow the page's path, if it is installed
3131

3232
Upon initial install, we do the following:
3333

@@ -36,7 +36,7 @@ Upon initial install, we do the following:
3636

3737
Note that in both of the above cases, all these files should have already been downloaded once by the browser, so with [proper HTTP caching setup](/docs/caching/) we don't have to download any of the files again. However, one exception to this is `<style>` elements with a `data-href` attribute (indicating that the embedded stylesheet is the same as the stylesheet at the location specified) - we currently fetch the specified file rather than caching the contents of the element.
3838

39-
Another current problem is that we may start fetching the resources for a page before the service worker has finished installing, but finish fetching them all after it has installed - this could cause a page's path to be whitelisted even if some of its resources haven't been cached (since Gatsby assumes the service worker was installed at the start of fetching resources, if it was installed at the end).
39+
Another current problem is that we may start fetching the resources for a page before the service worker has finished installing, but finish fetching them all after it has installed - this could cause a page's path to be allowed even if some of its resources haven't been cached (since Gatsby assumes the service worker was installed at the start of fetching resources, if it was installed at the end).
4040

4141
## Gatsby Core
4242

@@ -72,8 +72,8 @@ The following are some invalid reasons why we might not have resources, i.e. thi
7272

7373
### Service worker update handling
7474

75-
The service worker updates automatically when the browser detects that the contents of the `sw.js` file have changed from the currently installed version. Upon an update, we clear all whitelisted paths to prevent old pages from loading after the update.
75+
The service worker updates automatically when the browser detects that the contents of the `sw.js` file have changed from the currently installed version. Upon an update, we clear all allowed paths to prevent old pages from loading after the update.
7676

77-
Blank pages can theoretically occur if we serve the app shell when resources are unavailable - however, this _should_ never occur since we only serve the app shell with whitelisted paths (i.e. ones whose resources have been cached entirely). There may be some edge cases when this can occur, e.g. when the webpack runtime from the old site attempts to load a chunk which is unavailable on the updated site - we are currently investigating ways to prevent this, and make using service workers with Gatsby even more robust.
77+
Blank pages can theoretically occur if we serve the app shell when resources are unavailable - however, this _should_ never occur since we only serve the app shell with allowed paths (i.e. ones whose resources have been cached entirely). There may be some edge cases when this can occur, e.g. when the webpack runtime from the old site attempts to load a chunk which is unavailable on the updated site - we are currently investigating ways to prevent this, and make using service workers with Gatsby even more robust.
7878

79-
We should also never get incorrect 404 pages following a site update, since we never whitelist 404 pages to serve using the offline shell, meaning that a page which was previously a 404 should always load from the server. If it's no longer a 404, then it will be cached as usual.
79+
We should also never get incorrect 404 pages following a site update, since we never allow 404 pages to serve using the offline shell, meaning that a page which was previously a 404 should always load from the server. If it's no longer a 404, then it will be cached as usual.

examples/simple-auth/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ This is a simplified demo to show how an authentication workflow is implemented
55
The short version is:
66

77
- Gatsby statically renders all unauthenticated routes as usual
8-
- Authenticated routes are whitelisted as client-only
8+
- Authenticated routes are allowed as client-only
99
- Logged out users are redirected to the login page if they attempt to visit private routes
1010
- Logged in users will see their private content
1111

packages/gatsby-source-wordpress/src/utils/fetch-graphql.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -441,7 +441,7 @@ ${getLowerRequestConcurrencyOptionMessage()}`,
441441
id: CODES.RequestDenied,
442442
context: {
443443
sourceMessage: formatLogMessage(
444-
`${e.message}\n\nThe GraphQL request was forbidden.\nIf you are using a security plugin like WordFence or a server firewall you may need to whitelist your IP address or adjust your firewall settings for your GraphQL endpoint.\n\n${errorContext}`
444+
`${e.message}\n\nThe GraphQL request was forbidden.\nIf you are using a security plugin like WordFence or a server firewall you may need to add your IP address to the allow list or adjust your firewall settings for your GraphQL endpoint.\n\n${errorContext}`
445445
),
446446
},
447447
})

0 commit comments

Comments
 (0)