Add option to load rtl-text-plugin lazily #8865
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
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,77 +1,144 @@ | ||
| // @flow | ||
|
|
||
| import {Event, Evented} from '../util/evented'; | ||
| import {getArrayBuffer} from '../util/ajax'; | ||
| import browser from '../util/browser'; | ||
| import window from '../util/window'; | ||
| import assert from 'assert'; | ||
| import {isWorker} from '../util/util'; | ||
|
|
||
| const status = { | ||
| unavailable: 'unavailable', // Not loaded | ||
| available: 'available', // The plugin URL has been specified, but loading has been deferred | ||
|
There was a problem hiding this comment. maybe this status should be |
||
| loading: 'loading', // request in-flight | ||
| loaded: 'loaded', | ||
| error: 'error' | ||
| }; | ||
| export type PluginState = { | ||
| pluginStatus: $Values<typeof status>; | ||
| pluginURL: ?string, | ||
| pluginBlobURL: ?string | ||
| }; | ||
|
|
||
| type ErrorCallback = (error: ?Error) => void; | ||
| type PluginStateSyncCallback = (state: PluginState) => void; | ||
| let _completionCallback = null; | ||
|
|
||
| //Variables defining the current state of the plugin | ||
| let pluginStatus = status.unavailable; | ||
| let pluginURL = null; | ||
| let pluginBlobURL = null; | ||
|
|
||
| export const triggerPluginCompletionEvent = function(error: ?Error) { | ||
| if (_completionCallback) { | ||
| _completionCallback(error); | ||
| } | ||
| }; | ||
|
|
||
| function sendPluginStateToWorker() { | ||
| evented.fire(new Event('pluginStateChange', {pluginStatus, pluginURL, pluginBlobURL})); | ||
| } | ||
|
|
||
| export const evented = new Evented(); | ||
|
|
||
| export const getRTLTextPluginStatus = function () { | ||
| return pluginStatus; | ||
| }; | ||
|
|
||
| export const registerForPluginStateChange = function(callback: PluginStateSyncCallback) { | ||
| // Do an initial sync of the state | ||
| callback({pluginStatus, pluginURL, pluginBlobURL}); | ||
| // Listen for all future state changes | ||
| evented.on('pluginStateChange', callback); | ||
| return callback; | ||
| }; | ||
|
|
||
| export const clearRTLTextPlugin = function() { | ||
| pluginStatus = status.unavailable; | ||
| pluginURL = null; | ||
| if (pluginBlobURL) { | ||
| const URL = window.URL || window.webkitURL; | ||
|
There was a problem hiding this comment. think we can get rid of |
||
| URL.revokeObjectURL(pluginBlobURL); | ||
| } | ||
| pluginBlobURL = null; | ||
| }; | ||
|
|
||
| export const setRTLTextPlugin = function(url: string, callback: ?ErrorCallback, lazy: boolean = false) { | ||
| if (pluginStatus === status.available || pluginStatus === status.loading || pluginStatus === status.loaded) { | ||
| throw new Error('setRTLTextPlugin cannot be called multiple times.'); | ||
| } | ||
| pluginURL = browser.resolveURL(url); | ||
| pluginStatus = status.available; | ||
| _completionCallback = callback; | ||
| sendPluginStateToWorker(); | ||
|
|
||
| //Start downloading the plugin immediately if not intending to lazy-load | ||
| if (!lazy) { | ||
| downloadRTLTextPlugin(); | ||
| } | ||
| }; | ||
|
|
||
| export const downloadRTLTextPlugin = function() { | ||
| if (pluginStatus !== status.available || !pluginURL) { | ||
| throw new Error('rtl-text-plugin cannot be downloaded unless a pluginURL is specified'); | ||
| } | ||
| pluginStatus = status.loading; | ||
| sendPluginStateToWorker(); | ||
| if (pluginURL) { | ||
| getArrayBuffer({url: pluginURL}, (error, data) => { | ||
| if (error) { | ||
| triggerPluginCompletionEvent(error); | ||
| } else { | ||
| const rtlBlob = new window.Blob([data], {type: 'application/javascript'}); | ||
| const URL = window.URL || window.webkitURL; | ||
|
There was a problem hiding this comment. why do we need There was a problem hiding this comment. This may have been added in the past when Safari/Webkit didn't support |
||
| pluginBlobURL = URL.createObjectURL(rtlBlob); | ||
| pluginStatus = status.loaded; | ||
| sendPluginStateToWorker(); | ||
| } | ||
| }); | ||
| } | ||
| }; | ||
|
|
||
| export const plugin: { | ||
| applyArabicShaping: ?Function, | ||
| processBidirectionalText: ?(string, Array<number>) => Array<string>, | ||
| processStyledBidirectionalText: ?(string, Array<number>, Array<number>) => Array<[string, Array<number>]>, | ||
| isLoaded: () => boolean, | ||
| isLoading: () => boolean, | ||
| setState: (state: PluginState) => void, | ||
| isParsed: () => boolean, | ||
| getURLs: () => { blob: ?string, host: ?string } | ||
| } = { | ||
| applyArabicShaping: null, | ||
| processBidirectionalText: null, | ||
| processStyledBidirectionalText: null, | ||
| isLoaded() { | ||
| return pluginStatus === status.loaded || // Main Thread: loaded if the completion callback returned successfully | ||
| plugin.applyArabicShaping != null; // Web-worker: loaded if the plugin functions have been compiled | ||
| }, | ||
| isLoading() { // Main Thread Only: query the loading status, this function does not return the correct value in the worker context. | ||
| return pluginStatus === status.loading; | ||
| }, | ||
| setState(state: PluginState) { // Worker thread only: this tells the worker threads that the plugin is available on the Main thread | ||
| assert(isWorker(), 'Cannot set the state of the rtl-text-plugin when not in the web-worker context'); | ||
|
|
||
| pluginStatus = state.pluginStatus; | ||
| pluginURL = state.pluginURL; | ||
| pluginBlobURL = state.pluginBlobURL; | ||
| }, | ||
| isParsed(): boolean { | ||
| assert(isWorker(), 'rtl-text-plugin is only parsed on the worker-threads'); | ||
|
|
||
| return plugin.applyArabicShaping != null && | ||
| plugin.processBidirectionalText != null && | ||
| plugin.processStyledBidirectionalText != null; | ||
| }, | ||
| getURLs(): { blob: ?string, host: ?string } { | ||
| assert(isWorker(), 'rtl-text-plugin urls can only be queried from the worker threads'); | ||
|
|
||
| return { | ||
| blob: pluginBlobURL, | ||
| host: pluginURL, | ||
| }; | ||
| } | ||
| }; | ||
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
Oops, something went wrong.
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.
Should there be a warning emitted here so that customers don't just see a map with no labels and wonder what the heck is going on?
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.
I've changed the behavior now so that only when lazy loading, does it skip rendering the text.