Navigation API : "activation info" #9856

noamr · 2023-10-16T09:10:04Z

Add support for navigation.activation and the NavigationActivation interface
Closes #9760

Upon activating a new document in place of an old one (a cross-document navigation), we save an old and new NavigationHistoryEntry objects to be accessible, and also the navigation type.
This is accessible via navigation.activation.from, navigation.activation.entry and navigation.activation.navigationType.

The initial use case for this is CSS view transitions - being able to curate/customize the transitions based on "where did we come from and how", which is information that's currently not available in an ergonomic way for cross-document navigations. See #9760 for discussion.

At least two implementers are interested (and none opposed):
- Chromium
- …
Tests are written and can be reviewed and commented upon at https://wpt.fyi/results/navigation-api/navigation-activation?label=master&label=experimental&aligned
Implementation bugs are filed:
- Chromium: https://bugs.chromium.org/p/chromium/issues/detail?id=1492932
- Gecko: https://bugzilla.mozilla.org/show_bug.cgi?id=1777171 (main navigation API bug)
- WebKit: https://bugs.webkit.org/show_bug.cgi?id=258384 (main navigation API bug)
MDN issue is filed: Document the navigation.activation APII mdn/mdn#491
The top of this comment includes a clear commit message to use.

(See WHATWG Working Mode: Changes for more details.)

/browsing-the-web.html ( diff )
/index.html ( diff )
/nav-history-apis.html ( diff )

source

domenic · 2023-10-17T06:30:55Z

source

@@ -99509,6 +99577,29 @@ location.href = '#foo';</code></pre>
      data-x="nav-active-history-entry">active session history entry</span>.</p>
     </li>

+     <li>
+      <p>Let <var>activationNavigationType</var> be determined as follows:</p>


OK, this is just further evidence I really should pass in the NavigationType to this algorithm (instead of requiring it to be re-computed).

The initial ideal was that we would just set things up nicely, and "apply the history step" would behave basically the same, with no special casing needed for each type.

However, as noted in #9826 (see especially my reply), this is not working out great. And we have the wrapper algorithms anyway, so this purity is not helping.

An important thing to note is that "apply the history step" can be called for something which is none of these four types: https://html.spec.whatwg.org/#update-for-navigable-creation/destruction . I think this breaks your switch here.

So here's my proposal. We add a NavigationType to "apply the history step", and thread it through from all calling algorithms. (This is slightly more involved for "apply the push/replace history step".) Ideally we fix #9826 as part of this. Then, we can just use it and not re-compute it here.

Maybe we can even add some asserts, that parallel the great work you've done here to re-derive the state from the other parameters. Or maybe we could delete the "reload pending" and "ever populated" flags!! That would be nice.

So here's my proposal. We add a NavigationType to "apply the history step", and thread it through from all calling algorithms. (This is slightly more involved for "apply the push/replace history step".)
Then, we can just use it and not re-compute it here.

Done

Ideally we fix #9826 as part of this.

I think that would have to be a next step on top of this.

Maybe we can even add some asserts, that parallel the great work you've done here to re-derive the state from the other parameters.

Done

Or maybe we could delete the "reload pending" and "ever populated" flags!! That would be nice.

Not just yet unfortunately... still needed for putting all kind of parameters on the request.

source

domenic

This looks solid! Only substantial thing I'm unsure about is whether the null navigationType case is handled.

source

noamr · 2023-10-19T09:28:22Z

This looks solid! Only substantial thing I'm unsure about is whether the null navigationType case is handled.

Yea it can be null when creating the navigable, clarified that we're not creating the activation object in that case.

domenic

LGTM with nits (and a bikeshed question).

source

domenic · 2023-10-20T07:54:25Z

source

+      <p>Switch on <var>navigationType</var>:</p>
+
+      <dl class=switch>
+       <dt>"<span data-x="dom-NavigationType-reload">reload</span>"</dt>


Still to be done.

source

noamr · 2023-10-20T09:02:29Z

@zcorpan Is this something that needs a new "standards position" or do you want to look at this as a detail of the navigation API?

source

Initial discussion: whatwg/html#9760 Draft spec PR: whatwg/html#9856 Bug: 1492932 Change-Id: I2e090a8366906e4cb6778893ad9ffdca18d6ec37

Automatic update from web-platform-tests NavigationActivation prototype (#42873) NavigationActivation is a new object (exposed as `navigation.activation`). It is updated when a new Document is "activated": initial Document creation, restore from bfcache, or (in a future CL) prerender activation. It has three pieces of state: * `activation.entry`: The current NavigationHistoryEntry at the time of activation. * `activation.from`: The current NavigationHistoryEntry immediately before activation (i.e., the entry we came from). This will be null if the navigation was cross-origin, or if the previous entry was not in the same-origin contiguous region of the back/forward list that is available in `navigation.entries()`. * `activation.navigationType`: The navigationType ('push', 'replace', 'reload', or 'traverse') of the navigation that activated the current Document. Note that `entry` or `from` may be a NavigationHistoryEntry that is no longer present in `navigation.entries()` (e.g., when doing a replace navigation, `activation.from` will be the replaced entry). In that case, the entry will remain visible, but because it is a "disposed" entry, its index will be -1 and attempting to `navigation.traverseTo()` its key will be rejected. Initial discussion: whatwg/html#9760 Draft spec PR: whatwg/html#9856 I2p: https://groups.google.com/a/chromium.org/g/blink-dev/c/EfqxeH3Iwh4 Bug: 1492932 Change-Id: I2e090a8366906e4cb6778893ad9ffdca18d6ec37 Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/4990011 Reviewed-by: Domenic Denicola <domenic@chromium.org> Commit-Queue: Nate Chapin <japhet@chromium.org> Cr-Commit-Position: refs/heads/main@{#1220983} Co-authored-by: Nate Chapin <japhet@chromium.org> -- wpt-commits: c2ca6ebdc7f92fbaf7308c91dda05bcaf24ef455 wpt-pr: 42873

saschanaz · 2023-12-10T18:54:56Z

The name is a bit confusing to me given there is navigator.userActivation, can this be documentActivation or such?

domenic · 2023-12-12T03:33:01Z

The name is a bit confusing to me given there is navigator.userActivation, can this be documentActivation or such?

I would be a bit sad about this. I think navigation and navigator are separate enough, and it's not clear what else you'd be activating during a navigation...

smaug---- · 2023-12-12T14:47:57Z

source

+   <dd>
+    <p>A <code>NavigationHistoryEntry</code>, representing the <code>Document</code> that was active
+    right before the current <code>Document</code>. This might have a value null in case the
+    previous <code>Document</code> was not <span>same origin</span> with this one.</p>


"might" is a bit confusing here. Is the value null or is it not when the previous document was cross origin?

It's null in that case... will reword.

smaug---- · 2023-12-12T14:52:19Z

The name is a bit confusing to me given there is navigator.userActivation, can this be documentActivation or such?

I don't feel navigation.activation is too confusing. It is after all a property of the navigation object.

noamr · 2023-12-12T15:45:40Z

The name is a bit confusing to me given there is navigator.userActivation, can this be documentActivation or such?

I would be a bit sad about this. I think navigation and navigator are separate enough, and it's not clear what else you'd be activating during a navigation...

I feel the same, I think the name is clear enough. There are plenty of reused words in the web platform, and without the word "user" this is distinct enough.

saschanaz · 2023-12-12T15:48:15Z

The only different part between two is or.userA and ion.a which is enough for me to be confused, but if it's not for others, then fine.

noamr · 2023-12-12T20:06:59Z

@domenic I think we're good to go? You've already approved and now that Mozilla gave a thumbs up all the checkboxes are ticket. Of course another pass is always welcome as well.

Update 'update_for_history_step_application' to meet some of the specs introduced in whatwg/html#9856 and in whatwg/html#9990

Update 'update_for_history_step_application' to meet some of the specs introduced in whatwg/html#9856 and in whatwg/html#9990 (cherry picked from commit 2497f43989af3efa695d0d33de59001cb87bacb6)

noamr changed the title ~~Activation info~~ WIP Activation info Oct 16, 2023

noamr changed the title ~~WIP Activation info~~ Navigation API : "activation info" Oct 16, 2023

spectranaut mentioned this pull request Oct 16, 2023

Requesting changes to new implementation-blocked merging process w3c/aria#2055

Closed

domenic reviewed Oct 17, 2023

View reviewed changes

jakearchibald reviewed Oct 17, 2023

View reviewed changes

source Outdated Show resolved Hide resolved

noamr added 6 commits October 17, 2023 18:08

Activation info

da3852a

Handle initial about:blank

5dfe5e6

Apply SOME of the CR comments

a88fd59

Move activation info resolving to update-history

be3b997

Deal with nullable things

f85de8e

Propagate navigationType to applyHistoryStep

bb9ad3e

noamr force-pushed the activation-info branch from f5a025a to bb9ad3e Compare October 17, 2023 17:11

noamr added 6 commits October 17, 2023 18:43

Add domintro

0fa080d

formatting

2aac8d4

formatting

c2af36f

tidbits

789c498

tidbits

e0d58b8

Some line spacing things

b58d3ee

domenic reviewed Oct 19, 2023

View reviewed changes

Apply PR comments

5d495b3

domenic approved these changes Oct 20, 2023

View reviewed changes

Some more nits

77adc13

smaug---- reviewed Oct 24, 2023

View reviewed changes

source Show resolved Hide resolved

Amended note to cover .entry

d6aec96

petervanderbeken reviewed Oct 31, 2023

View reviewed changes

source Show resolved Hide resolved

Add missing 'be'

cee54d8

chromium-wpt-export-bot mentioned this pull request Oct 31, 2023

NavigationActivation prototype web-platform-tests/wpt#42873

Merged

chromium-wpt-export-bot pushed a commit to web-platform-tests/wpt that referenced this pull request Oct 31, 2023

NavigationActivation prototype

40131e8

Initial discussion: whatwg/html#9760 Draft spec PR: whatwg/html#9856 Bug: 1492932 Change-Id: I2e090a8366906e4cb6778893ad9ffdca18d6ec37

domenic added addition/proposal New features or enhancements topic: navigation labels Dec 12, 2023

smaug---- reviewed Dec 12, 2023

View reviewed changes

noamr mentioned this pull request Dec 12, 2023

Document the navigation.activation APII mdn/mdn#491

Closed

3 tasks

nit

5c32c61

domenic merged commit da3a62e into whatwg:main Dec 13, 2023
2 checks passed

noamr mentioned this pull request Dec 13, 2023

Navigation Activation Info w3ctag/design-reviews#921

Closed

1 task

ADKaster mentioned this pull request Jan 25, 2024

navigationType in apply the history step used without a null check #10086

Open

mobounya pushed a commit to mobounya/ladybird that referenced this pull request Jul 21, 2024

LibWeb: update update_for_history_step_application

c21f948

Update 'update_for_history_step_application' to meet some of the specs introduced in whatwg/html#9856 and in whatwg/html#9990

mobounya pushed a commit to mobounya/ladybird that referenced this pull request Jul 21, 2024

LibWeb: Update update_for_history_step_application

00f1d0e

Update 'update_for_history_step_application' to meet some of the specs introduced in whatwg/html#9856 and in whatwg/html#9990

mobounya pushed a commit to mobounya/ladybird that referenced this pull request Jul 21, 2024

LibWeb: Update update_for_history_step_application

3f4910d

Update 'update_for_history_step_application' to meet some of the specs introduced in whatwg/html#9856 and in whatwg/html#9990

mobounya pushed a commit to mobounya/ladybird that referenced this pull request Jul 21, 2024

LibWeb: Update update_for_history_step_application

f7ba67e

Update 'update_for_history_step_application' to meet some of the specs introduced in whatwg/html#9856 and in whatwg/html#9990

mobounya mentioned this pull request Jul 21, 2024

LibWeb: Update 'update_for_history_step_application' to meet new specs LadybirdBrowser/ladybird#757

Merged

mobounya pushed a commit to mobounya/ladybird that referenced this pull request Jul 21, 2024

LibWeb: Update update_for_history_step_application

bd63a33

Update 'update_for_history_step_application' to meet some of the specs introduced in whatwg/html#9856 and in whatwg/html#9990

mobounya pushed a commit to mobounya/ladybird that referenced this pull request Jul 22, 2024

LibWeb: Update update_for_history_step_application

4371988

Update 'update_for_history_step_application' to meet some of the specs introduced in whatwg/html#9856 and in whatwg/html#9990

kalenikaliaksandr pushed a commit to LadybirdBrowser/ladybird that referenced this pull request Jul 22, 2024

LibWeb: Update update_for_history_step_application

2497f43

Update 'update_for_history_step_application' to meet some of the specs introduced in whatwg/html#9856 and in whatwg/html#9990

circl-lastname mentioned this pull request Jul 22, 2024

Cherry-pick "LibWeb: Update 'update_for_history_step_application' to meet new specs" SerenityOS/serenity#24797

Merged

This was referenced Oct 17, 2024

Add Safari impl_url for Navigation API mdn/browser-compat-data#24750

Merged

Remove Chromium impl_url and add Firefox impl_url for NavigationActivation mdn/browser-compat-data#24795

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Navigation API : "activation info" #9856

Navigation API : "activation info" #9856

noamr commented Oct 16, 2023 •

edited by pr-preview bot

Loading

domenic Oct 17, 2023

noamr Oct 17, 2023

domenic left a comment

noamr commented Oct 19, 2023

domenic left a comment

domenic Oct 20, 2023

noamr commented Oct 20, 2023

saschanaz commented Dec 10, 2023

domenic commented Dec 12, 2023

smaug---- Dec 12, 2023

noamr Dec 12, 2023

noamr Dec 12, 2023

smaug---- commented Dec 12, 2023

noamr commented Dec 12, 2023

saschanaz commented Dec 12, 2023

noamr commented Dec 12, 2023

Navigation API : "activation info" #9856

Navigation API : "activation info" #9856

Conversation

noamr commented Oct 16, 2023 • edited by pr-preview bot Loading

domenic Oct 17, 2023

Choose a reason for hiding this comment

noamr Oct 17, 2023

Choose a reason for hiding this comment

domenic left a comment

Choose a reason for hiding this comment

noamr commented Oct 19, 2023

domenic left a comment

Choose a reason for hiding this comment

domenic Oct 20, 2023

Choose a reason for hiding this comment

noamr commented Oct 20, 2023

saschanaz commented Dec 10, 2023

domenic commented Dec 12, 2023

smaug---- Dec 12, 2023

Choose a reason for hiding this comment

noamr Dec 12, 2023

Choose a reason for hiding this comment

noamr Dec 12, 2023

Choose a reason for hiding this comment

smaug---- commented Dec 12, 2023

noamr commented Dec 12, 2023

saschanaz commented Dec 12, 2023

noamr commented Dec 12, 2023

noamr commented Oct 16, 2023 •

edited by pr-preview bot

Loading