1347823 - Label HistoryTracker in docshell/

Status: RESOLVED FIXED

(Core :: DOM: Navigation, defect, P2)

Description

[Bevis Tseng[:bevis][:btseng](Exited)]

This is a follow-up of the finding in bug 1339707 comment 10 to have the use of nsExpirationTracker in docshell/ being labeled.

Comment 1

[Samael Wang [:freesamael] (away for now)]

Attachment: Bug 1347823 - Part 1: Reorder includes and data members.

Re-order includes to meet gecko's coding style, and move bool data members
to the bottom for slightly better alignment (nsSHEntry down from 192->176,
nsSHEntryShared down from 208->200 on a Linux64 build).

Review commit: https://reviewboard.mozilla.org/r/134632/diff/#index_header
See other reviews: https://reviewboard.mozilla.org/r/134632/

Comment 2

[Samael Wang [:freesamael] (away for now)]

Attachment: Bug 1347823 - Part 2: Move HistoryTracker to nsSHistory and bind its event target to the TabGroup.

Convert the singleton HistoryTracker implementation to a per-nsSHistory based
implementation so that it can be bound to a TabGroup.

Review commit: https://reviewboard.mozilla.org/r/134634/diff/#index_header
See other reviews: https://reviewboard.mozilla.org/r/134634/

Comment 3

[Samael Wang [:freesamael] (away for now)]

Attachment: Bug 1347823 - Part 3: Add a test case.

Review commit: https://reviewboard.mozilla.org/r/134636/diff/#index_header
See other reviews: https://reviewboard.mozilla.org/r/134636/

Comment 4

[Olli Pettay [:smaug][[e-mail]]]

Comment on attachment 8862761 [details]
Bug 1347823 - Part 1: Reorder includes and data members.

https://reviewboard.mozilla.org/r/134632/#review137618

Just random thought, is there some tool to detect when member variables are ordered in a bit silly way?

Comment 5

[Olli Pettay [:smaug][[e-mail]]]

Comment on attachment 8862762 [details]
Bug 1347823 - Part 2: Move HistoryTracker to nsSHistory and bind its event target to the TabGroup.

https://reviewboard.mozilla.org/r/134634/#review137620

I think this could be simplified a bit without UniquePtr usage. 
Or explain why it is needed.

::: docshell/shistory/nsSHistory.h:63
(Diff revision 1)
> +        shistory->EvictExpiredContentViewerForEntry(aObj);
> +      }
> +    }
> +
> +  private:
> +    nsWeakPtr mSHistory;

Why nsWeakPtr? SHistory object itself controls the lifetime of HistoryTracker, so using raw pointer here should be fine.

::: docshell/shistory/nsSHistory.h:122
(Diff revision 1)
>    // If aKeepNext is true, aIndex is compared to aIndex + 1,
>    // otherwise comparison is done to aIndex - 1.
>    bool RemoveDuplicate(int32_t aIndex, bool aKeepNext);
>  
> +  // Track all bfcache entries and evict on expiration.
> +  mozilla::UniquePtr<HistoryTracker> mHistoryTracker;

Why this needs to be UniquePtr? Why not just HistoryTracker mHistoryTracker?

Comment 6

[Olli Pettay [:smaug][[e-mail]]]

Comment on attachment 8862763 [details]
Bug 1347823 - Part 3: Add a test case.

https://reviewboard.mozilla.org/r/134636/#review137622

Comment 7

[Samael Wang [:freesamael] (away for now)]

Comment on attachment 8862762 [details]
Bug 1347823 - Part 2: Move HistoryTracker to nsSHistory and bind its event target to the TabGroup.

https://reviewboard.mozilla.org/r/134634/#review137620

> Why this needs to be UniquePtr? Why not just HistoryTracker mHistoryTracker?

mHistoryTracker has to be lazy-init on nsSHistory::SetRootDocShell, otherwise there's no suitable nsIEventTarget I can pass to the constructor of nsExpirationTracker.

Comment 8

[Samael Wang [:freesamael] (away for now)]

Comment on attachment 8862762 [details]
Bug 1347823 - Part 2: Move HistoryTracker to nsSHistory and bind its event target to the TabGroup.

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/134634/diff/1-2/

Comment 9

[Samael Wang [:freesamael] (away for now)]

Comment on attachment 8862763 [details]
Bug 1347823 - Part 3: Add a test case.

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/134636/diff/1-2/

Comment 10

[Samael Wang [:freesamael] (away for now)]

Comment on attachment 8862762 [details]
Bug 1347823 - Part 2: Move HistoryTracker to nsSHistory and bind its event target to the TabGroup.

https://reviewboard.mozilla.org/r/134634/#review137620

> mHistoryTracker has to be lazy-init on nsSHistory::SetRootDocShell, otherwise there's no suitable nsIEventTarget I can pass to the constructor of nsExpirationTracker.

I'm dropping this issue as explained above. Let me know if you still have concerns.

Comment 11

[Olli Pettay [:smaug][[e-mail]]]

Comment on attachment 8862762 [details]
Bug 1347823 - Part 2: Move HistoryTracker to nsSHistory and bind its event target to the TabGroup.

https://reviewboard.mozilla.org/r/134634/#review138370

::: docshell/shistory/nsSHistory.h:59
(Diff revision 2)
> +      RemoveObject(aObj);
> +      mSHistory->EvictExpiredContentViewerForEntry(aObj);
> +    }
> +
> +  private:
> +    nsSHistory* mSHistory;

Add a comment that nsSHistory owns HistoryTracker, so it always outlives HistoryTracker object.

Comment 12

[Samael Wang [:freesamael] (away for now)]

Comment on attachment 8862762 [details]
Bug 1347823 - Part 2: Move HistoryTracker to nsSHistory and bind its event target to the TabGroup.

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/134634/diff/2-3/

Comment 13

[Samael Wang [:freesamael] (away for now)]

Comment on attachment 8862763 [details]
Bug 1347823 - Part 3: Add a test case.

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/134636/diff/2-3/

Comment 14

[Samael Wang [:freesamael] (away for now)]

https://treeherder.mozilla.org/#/jobs?repo=try&revision=2e62a33d1891986d694415e2b0f3142cc5d8f47c&group_state=expanded

Comment 15

[Carsten Book [:Tomcat]]

seems there is a open issue for part 2 that need to be fixed first.

Comment 16

[Samael Wang [:freesamael] (away for now)]

(In reply to Carsten Book [:Tomcat] from comment #15)
> seems there is a open issue for part 2 that need to be fixed first.

Sorry I forgot to mark it fixed. It's fixed in revision 3.

Comment 17

[Carsten Book [:Tomcat]]

np, landed!

Comment 18

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/d2fbb471ba83
Part 1: Reorder includes and data members. r=smaug
https://hg.mozilla.org/integration/autoland/rev/f8bebf994dbf
Part 2: Move HistoryTracker to nsSHistory and bind its event target to the TabGroup. r=smaug
https://hg.mozilla.org/integration/autoland/rev/05a2a58f887e
Part 3: Add a test case. r=smaug

Comment 19

[Carsten Book [:Tomcat]]

https://hg.mozilla.org/mozilla-central/rev/d2fbb471ba83
https://hg.mozilla.org/mozilla-central/rev/f8bebf994dbf
https://hg.mozilla.org/mozilla-central/rev/05a2a58f887e