-
Notifications
You must be signed in to change notification settings - Fork 13
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.
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
feat: new API loader implementation #137
Draft
usefulthink
wants to merge
4
commits into
develop
Choose a base branch
from
feat/api-loader
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
cc43efa
feat(core): add new API-loader implementation
usefulthink 9f9634b
feat(core): refactor provider implementation to use new loader (squas…
usefulthink 8cf5241
fix: comment
usefulthink f8419dd
fix: add error-message for multiple loads with different parameters
usefulthink File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,213 @@ | ||
| const MAPS_API_BASE_URL = 'https://maps.googleapis.com/maps/api/js'; | ||
|
|
||
| export type ApiParams = { | ||
| key: string; | ||
| v?: string; | ||
| language?: string; | ||
| region?: string; | ||
| libraries?: string; | ||
| authReferrerPolicy?: string; | ||
| }; | ||
|
|
||
| const enum LoadingState { | ||
| UNLOADED, | ||
| UNLOADING, | ||
| QUEUED, | ||
| LOADING, | ||
| LOADED | ||
| } | ||
|
|
||
| /** | ||
| * Temporary document used to abort in-flight scripts. | ||
| * The only way we found so far to stop a script that is already in | ||
| * preparation from executing is to adopt it into a different document. | ||
| */ | ||
| const tmpDoc = new DOMParser().parseFromString('<html></html>', 'text/html'); | ||
|
|
||
| /** | ||
| * API loader to reliably load and unload the Google Maps API. | ||
| * The actual loading and unloading is delayed into the microtask queue, to | ||
| * allow for using this in a useEffect hook without having to worry about | ||
| * starting to load the API multiple times. | ||
| */ | ||
| export class GoogleMapsApiLoader { | ||
| private static params: ApiParams | null = null; | ||
| private static serializedParams: string | null = null; | ||
| private static loadPromise: Promise<void> | null = null; | ||
| private static loadingState = LoadingState.UNLOADED; | ||
|
|
||
| /** | ||
| * Loads the Google Maps API with the specified parameters, reloading | ||
| * it if neccessary. The returned promise resolves when loading completes | ||
| * and rejects in case of an error or when the loading was aborted. | ||
| * @param params | ||
| */ | ||
| static async load(params: ApiParams): Promise<void> { | ||
| const serializedParams = this.serializeParams(params); | ||
| console.debug('api-loader: load', params); | ||
| this.params = params; | ||
|
|
||
| // loading hasn't yet started, so the promise can be reused (loading will | ||
| // use parameters from the last call before loading starts) | ||
| if (this.loadingState <= LoadingState.QUEUED && this.loadPromise) { | ||
| console.debug('api-loader: loading is already queued'); | ||
| return this.loadPromise; | ||
| } | ||
|
|
||
| // loading has already started, but the parameters didn't change | ||
| if ( | ||
| this.loadingState >= LoadingState.LOADING && | ||
| serializedParams === this.serializedParams && | ||
| this.loadPromise | ||
| ) { | ||
| console.debug('api-loader: loading already started'); | ||
| return this.loadPromise; | ||
| } | ||
|
|
||
| // if parameters did change, and we already loaded the API, we need | ||
| // to unload it first. | ||
| if (this.loadPromise) { | ||
| if (this.loadingState >= LoadingState.LOADING) { | ||
| // unloading hasn't started yet; this can only be the case if the loader | ||
| // was called with different parameters for multiple provider instances | ||
| console.error( | ||
| 'The Google Maps API Parameters passed to the `GoogleMapsProvider` ' + | ||
| 'components do not match. The Google Maps API can only be loaded ' + | ||
| 'once. Please make sure to pass the same API parameters to all ' + | ||
| 'of your `GoogleMapsProvider` components.' | ||
| ); | ||
| } | ||
|
|
||
| console.debug( | ||
| 'api-loader: was already loaded with other params, unload first' | ||
| ); | ||
| await this.unloadAsync(); | ||
| } | ||
|
|
||
| console.debug('api-loader: queue request'); | ||
|
|
||
| this.loadingState = LoadingState.QUEUED; | ||
| this.loadPromise = new Promise(async (resolve, reject) => { | ||
| console.debug('api-loader: defer to microtasks'); | ||
| // this causes the rest of the function to be pushed back into the | ||
| // microtask-queue, allowing multiple synchronous calls before actually | ||
| // loading anything. | ||
| await Promise.resolve(); | ||
| console.debug('api-loader: continue'); | ||
|
|
||
| // if the load request was canceled in the meantime, we stop here and | ||
| // reject the promise. This is typically the case in react dev mode when | ||
| // load/unload are called from a hook. | ||
| if (this.loadingState !== LoadingState.QUEUED) { | ||
| console.debug('api-loader: no longer queued'); | ||
| reject(new Error('map loading canceled')); | ||
| return; | ||
| } | ||
|
|
||
| console.debug('api-loader: start actually loading'); | ||
| this.loadingState = LoadingState.LOADING; | ||
| const url = this.getApiUrl(this.params); | ||
|
|
||
| // setup the callback | ||
| window.__gmcb__ = () => { | ||
| console.debug(`api-loader: callback called, loading complete`); | ||
| this.loadingState = LoadingState.LOADED; | ||
| resolve(); | ||
| }; | ||
| url.searchParams.set('callback', '__gmcb__'); | ||
| console.debug(`api-loader: URL: ${url}`); | ||
|
|
||
| // create the script | ||
| const script = document.createElement('script'); | ||
| script.src = url.toString(); | ||
| script.onerror = err => reject(err); | ||
|
|
||
| document.head.appendChild(script); | ||
| }); | ||
|
|
||
| return this.loadPromise; | ||
| } | ||
|
|
||
| /** | ||
| * Unloads the Google Maps API by canceling any pending script downloads | ||
| * and removing the global `google.maps` object. | ||
| */ | ||
| static unload(): void { | ||
| void this.unloadAsync(); | ||
| } | ||
|
|
||
| private static async unloadAsync(): Promise<void> { | ||
| // if loading hasn't started, reset the loadingState. | ||
| // this will cause the loading to not start | ||
| if (this.loadingState <= LoadingState.QUEUED) { | ||
| this.loadingState = LoadingState.UNLOADED; | ||
| return; | ||
| } | ||
|
|
||
| const gmScriptTags = Array.from( | ||
| document.querySelectorAll(`script[src^="${MAPS_API_BASE_URL}"]`) | ||
| ); | ||
| this.loadingState = LoadingState.UNLOADING; | ||
|
|
||
| // defer to the microtask-queue and check if the loading-state was | ||
| // changed in the meantime. If that is the case, unload was likely called | ||
| // in error (or by the React dev-mode calling the effect cleanup function | ||
| // just for fun). In this case, it is just ignored. | ||
| await Promise.resolve(); | ||
|
|
||
| if (this.loadingState !== LoadingState.UNLOADING) { | ||
| return; | ||
| } | ||
|
|
||
| // The elements are removed from the document and adopted into a different | ||
| // one. This prevents the script from executing once it's loaded if it hasn't | ||
| // already. | ||
| for (const el of gmScriptTags) { | ||
| el.remove(); | ||
| tmpDoc.adoptNode(el); | ||
| } | ||
|
|
||
| if (window.google && window.google.maps) { | ||
| // @ts-ignore | ||
| delete window.google.maps; | ||
| } | ||
| } | ||
|
|
||
| private static getApiUrl(params: ApiParams | null): URL { | ||
| if (params === null) { | ||
| throw new Error("api-params can't be null"); | ||
| } | ||
|
|
||
| const url = new URL(MAPS_API_BASE_URL); | ||
| for (const [key, value] of Object.entries(params)) { | ||
| if (value === undefined) { | ||
| continue; | ||
| } | ||
|
|
||
| url.searchParams.set( | ||
| // camelCase to snake_case conversion | ||
| key.replace(/[A-Z]/g, c => `_${c.toLowerCase()}`), | ||
BiniCodes marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| value | ||
| ); | ||
| } | ||
|
|
||
| return url; | ||
| } | ||
|
|
||
| private static serializeParams(params: ApiParams): string { | ||
| return [ | ||
| params.v, | ||
| params.key, | ||
| params.language, | ||
| params.region, | ||
| params.libraries, | ||
| params.authReferrerPolicy | ||
| ].join('/'); | ||
| } | ||
| } | ||
|
|
||
| declare global { | ||
| interface Window { | ||
| __gmcb__: () => void; | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,7 @@ | ||
| { | ||
| "extends": "../tsconfig.json", | ||
| "compilerOptions": { | ||
| "typeRoots": ["./src/types"] | ||
| "typeRoots": ["./src/types", "../node_modules/@types"] | ||
| }, | ||
| "exclude": ["dist"] | ||
| } |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
note: this is why I had to disable the no-void eslint rule. Using
voidhere makes it very explicit that it wasn't just accidentally forgotten to return the promise.