-
Notifications
You must be signed in to change notification settings - Fork 3.9k
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
History API #9
Merged
Merged
History API #9
Changes from all commits
Commits
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,363 @@ | ||
| /** | ||
| * Copyright 2015 The AMP HTML Authors. All Rights Reserved. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS-IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| import {Pass} from './pass'; | ||
| import {assert} from './asserts'; | ||
| import {log} from './log'; | ||
| import {timer} from './timer'; | ||
|
|
||
|
|
||
| /** @private @const */ | ||
| let TAG_ = 'History'; | ||
|
|
||
|
|
||
| /** @private @const */ | ||
| let HISTORY_PROP_ = 'AMP.History'; | ||
|
|
||
| /** @typedef {number} */ | ||
| var HistoryId; | ||
|
|
||
|
|
||
| export class History { | ||
|
|
||
| /** | ||
| * @param {!Widnow} win | ||
| */ | ||
| constructor(win) { | ||
| /** @const {!Window} */ | ||
| this.win = win; | ||
|
|
||
| let history = this.win.history; | ||
|
|
||
| /** @private {number} */ | ||
| this.startIndex_ = history.length - 1; | ||
|
|
||
| /** @private {number} */ | ||
| this.stackIndex_ = this.startIndex_; | ||
|
|
||
| /** @private {!Array<!Function|undefined>} */ | ||
| this.stackOnPop_ = []; | ||
|
|
||
| /** | ||
| * @private {{promise: !Promise, resolve: !Function, | ||
| * reject: !Function}|undefined} | ||
| */ | ||
| this.waitingState_; | ||
|
|
||
| // A number of browsers do not support history.state. In this cases, | ||
| // History will track its own version. See unsupportedState_. | ||
| /** @private {boolean} @const */ | ||
| this.supportsState_ = 'state' in history; | ||
|
|
||
| /** @private {*} */ | ||
| this.unsupportedState_ = {}; | ||
| this.unsupportedState_[HISTORY_PROP_] = this.stackIndex_; | ||
|
|
||
| // There are still browsers who do not support push/replaceState. | ||
| let pushState, replaceState; | ||
| if (history.pushState && history.replaceState) { | ||
| /** @private @const {function(*, string=, string=)|undefined} */ | ||
| this.origPushState_ = history.pushState.bind(history); | ||
| /** @private @const {function(*, string=, string=)|undefined} */ | ||
| this.origReplaceState_ = history.replaceState.bind(history); | ||
| pushState = (state, opt_title, opt_url) => { | ||
| this.unsupportedState_ = state; | ||
| this.origPushState_(state, opt_title, opt_url); | ||
| }; | ||
| replaceState = (state, opt_title, opt_url) => { | ||
| this.unsupportedState_ = state; | ||
| this.origReplaceState_(state, opt_title, opt_url); | ||
| }; | ||
| } else { | ||
| pushState = (state, opt_title, opt_url) => { | ||
| this.unsupportedState_ = state; | ||
| }; | ||
| replaceState = (state, opt_title, opt_url) => { | ||
| this.unsupportedState_ = state; | ||
| }; | ||
| } | ||
|
|
||
| /** @private @const {function(*, string=, string=)} */ | ||
| this.pushState_ = pushState; | ||
|
|
||
| /** @private @const {function(*, string=, string=)} */ | ||
| this.replaceState_ = replaceState; | ||
|
|
||
| history.pushState = this.historyPushState_.bind(this); | ||
| history.replaceState = this.historyReplaceState_.bind(this); | ||
|
|
||
| let eventPass = new Pass(this.onHistoryEvent_.bind(this), 50); | ||
| this.popstateHandler_ = (e) => { | ||
| log.fine(TAG_, 'popstate event: ' + this.win.history.length + ', ' + | ||
| JSON.stringify(e.state)); | ||
| eventPass.schedule(); | ||
| }; | ||
| this.hashchangeHandler_ = () => { | ||
| log.fine(TAG_, 'hashchange event: ' + this.win.history.length + ', ' + | ||
| this.win.location.hash); | ||
| eventPass.schedule(); | ||
| }; | ||
| this.win.addEventListener('popstate', this.popstateHandler_); | ||
| this.win.addEventListener('hashchange', this.hashchangeHandler_); | ||
| } | ||
|
|
||
| /** @private */ | ||
| cleanup_() { | ||
| if (this.origPushState_) { | ||
| this.win.history.pushState = this.origPushState_; | ||
| } | ||
| if (this.origReplaceState_) { | ||
| this.win.history.replaceState = this.origReplaceState_; | ||
| } | ||
| this.win.removeEventListener('popstate', this.popstateHandler_); | ||
| this.win.removeEventListener('hashchange', this.hashchangeHandler_); | ||
| } | ||
|
|
||
| /** | ||
| * @param {!Function=} opt_onPop | ||
| * @return {!Promise<!HistoryId>} | ||
| */ | ||
| push(opt_onPop) { | ||
| return this.whenReady_(() => { | ||
| this.historyPushState_(); | ||
| let stackIndex = this.stackIndex_; | ||
| if (opt_onPop) { | ||
| this.stackOnPop_[stackIndex] = opt_onPop; | ||
| } | ||
| return Promise.resolve(stackIndex); | ||
| }); | ||
| } | ||
|
|
||
| /** | ||
| * @param {!HistoryId} stateId | ||
| * @return {!Promise} | ||
| */ | ||
| pop(stateId) { | ||
| // On pop, stack is not allowed to go prior to the starting point. | ||
| stateId = Math.max(stateId, this.startIndex_); | ||
| return this.whenReady_(() => { | ||
| return this.back_(this.win.history.length - stateId); | ||
| }); | ||
| } | ||
|
|
||
| /** | ||
| * @param {!HistoryId} stateId | ||
| * @return {!Promise} | ||
| */ | ||
| backTo(stateId) { | ||
| // On pop, stack is not allowed to go prior to the starting point. | ||
| stateId = Math.max(stateId, this.startIndex_); | ||
| return this.whenReady_(() => { | ||
| return this.back_(this.win.history.length - stateId + 1); | ||
| }); | ||
| } | ||
|
|
||
| /** @private */ | ||
| onHistoryEvent_() { | ||
| let state = this.getState_(); | ||
| log.fine(TAG_, 'history event: ' + this.win.history.length + ', ' + | ||
| JSON.stringify(state)); | ||
| let stateIndex = state ? state[HISTORY_PROP_] : undefined; | ||
| let newStackIndex = this.stackIndex_; | ||
| let waitingState = this.waitingState_; | ||
| this.waitingState_ = undefined; | ||
|
|
||
| if (newStackIndex > this.win.history.length - 2) { | ||
| // Make sure stack has enough space. Whether we are going forward or | ||
| // backward, the stack should have at least one extra cell. | ||
| newStackIndex = this.win.history.length - 2; | ||
| this.updateStackIndex_(newStackIndex); | ||
| } | ||
|
|
||
| if (stateIndex == undefined) { | ||
| // A new navigation forward by the user. | ||
| newStackIndex = newStackIndex + 1; | ||
| } else if (stateIndex < this.win.history.length) { | ||
| // A simple trip back. | ||
| newStackIndex = stateIndex; | ||
| } else { | ||
| // Generally not possible, but for posterity. | ||
| newStackIndex = this.win.history.length - 1; | ||
| } | ||
|
|
||
| // If state index has been updated as the result replace the state. | ||
| if (!state) { | ||
| state = {}; | ||
| } | ||
| state[HISTORY_PROP_] = newStackIndex; | ||
| this.replaceState_(state, undefined, undefined); | ||
|
|
||
| // Update the stack, pop squeezed states. | ||
| if (newStackIndex != this.stackIndex_) { | ||
| this.updateStackIndex_(newStackIndex); | ||
| } | ||
|
|
||
| // User navigation is allowed to move past the starting point of | ||
| // the history stack. | ||
| if (newStackIndex < this.startIndex_) { | ||
| this.startIndex_ = newStackIndex; | ||
| } | ||
|
|
||
| if (waitingState) { | ||
| waitingState.resolve(); | ||
| } | ||
| } | ||
|
|
||
| /** @private */ | ||
| getState_() { | ||
| if (this.supportsState_) { | ||
| return this.win.history.state; | ||
| } | ||
| return this.unsupportedState_; | ||
| } | ||
|
|
||
| /** @private */ | ||
| assertReady_() { | ||
| assert(!this.waitingState_, | ||
| 'The history must not be in the waiting state'); | ||
| } | ||
|
|
||
| /** | ||
| * @param {function():!Promise<RESULT>} callback | ||
| * @return {!Promise<RESULT>} | ||
| * @template RESULT | ||
| * @private | ||
| */ | ||
| whenReady_(callback) { | ||
| if (!this.waitingState_) { | ||
| return callback(); | ||
| } | ||
| return this.waitingState_.promise.then(callback, callback); | ||
| } | ||
|
|
||
| /** | ||
| * @return {!Promise} | ||
| * @private | ||
| */ | ||
| wait_() { | ||
| this.assertReady_(); | ||
| let resolve; | ||
| let reject; | ||
| let promise = timer.timeoutPromise(500, | ||
| new Promise((aResolve, aReject) => { | ||
| resolve = aResolve; | ||
| reject = aReject; | ||
| })); | ||
| this.waitingState_ = { | ||
| promise: promise, | ||
| resolve: resolve, | ||
| reject: reject | ||
| }; | ||
| return promise; | ||
| } | ||
|
|
||
| /** | ||
| * @param {number} steps | ||
| * @return {!Promise} | ||
| */ | ||
| back_(steps) { | ||
| this.assertReady_(); | ||
| if (steps <= 0) { | ||
| return Promise.resolve(); | ||
| } | ||
| this.unsupportedState_ = {}; | ||
| this.unsupportedState_[HISTORY_PROP_] = this.stackIndex_ - steps; | ||
| let promise = this.wait_(); | ||
| this.win.history.go(-steps); | ||
| return promise; | ||
| } | ||
|
|
||
| /** | ||
| * @param {*} state | ||
| * @param {string|undefined} title | ||
| * @param {string|undefined} url | ||
| * @private | ||
| */ | ||
| historyPushState_(state, title, url) { | ||
| this.assertReady_(); | ||
| if (!state) { | ||
| state = {}; | ||
| } | ||
| let stackIndex = this.stackIndex_ + 1; | ||
| state[HISTORY_PROP_] = stackIndex; | ||
| this.pushState_(state, title, url); | ||
| if (stackIndex != this.win.history.length - 1) { | ||
| stackIndex = this.win.history.length - 1; | ||
| state[HISTORY_PROP_] = stackIndex; | ||
| this.replaceState_(state); | ||
| } | ||
| this.updateStackIndex_(stackIndex); | ||
| } | ||
|
|
||
| /** | ||
| * @param {*} state | ||
| * @param {string|undefined} title | ||
| * @param {string|undefined} url | ||
| * @private | ||
| */ | ||
| historyReplaceState_(state, title, url) { | ||
| this.assertReady_(); | ||
| if (!state) { | ||
| state = {}; | ||
| } | ||
| let stackIndex = Math.min(this.stackIndex_, this.win.history.length - 1); | ||
| state[HISTORY_PROP_] = stackIndex; | ||
| this.replaceState_(state, title, url); | ||
| this.updateStackIndex_(stackIndex); | ||
| } | ||
|
|
||
| /** | ||
| * @param {number} stackIndex | ||
| * @private | ||
| */ | ||
| updateStackIndex_(stackIndex) { | ||
| this.assertReady_(); | ||
| stackIndex = Math.min(stackIndex, this.win.history.length - 1); | ||
| if (this.stackIndex_ != stackIndex) { | ||
| log.fine(TAG_, 'stack index changed: ' + this.stackIndex_ + ' -> ' + | ||
| stackIndex); | ||
| this.stackIndex_ = stackIndex; | ||
| this.doPop_(); | ||
| } | ||
| } | ||
|
|
||
| /** @private */ | ||
| doPop_() { | ||
| if (this.stackIndex_ >= this.stackOnPop_.length - 1) { | ||
| return; | ||
| } | ||
|
|
||
| let toPop = []; | ||
| for (let i = this.stackOnPop_.length - 1; i > this.stackIndex_; i--) { | ||
| if (this.stackOnPop_[i]) { | ||
| toPop.push(this.stackOnPop_[i]); | ||
| this.stackOnPop_[i] = undefined; | ||
| } | ||
| } | ||
| this.stackOnPop_.splice(this.stackIndex_ + 1); | ||
|
|
||
| if (toPop.length > 0) { | ||
| for (let i = 0; i < toPop.length; i++) { | ||
| // With the same delay timeouts must observe the order, although | ||
| // there's no hard requirement in this case to follow the pop order. | ||
| timer.delay(toPop[i]); | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
|
|
||
| export const history = new History(window); | ||
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.
typo