Page MenuHomePhabricator

Quicksand, an ignoble successor to Quickling
ClosedPublic

Authored by epriestley on Jan 26 2015, 4:39 PM.
Tags
None
Referenced Files
F14019092: D11507.id27737.diff
Tue, Nov 5, 9:33 PM
F14019091: D11507.id27686.diff
Tue, Nov 5, 9:33 PM
F14019090: D11507.id27684.diff
Tue, Nov 5, 9:32 PM
F14019089: D11507.id27683.diff
Tue, Nov 5, 9:32 PM
F14019088: D11507.id27669.diff
Tue, Nov 5, 9:32 PM
F14019087: D11507.id.diff
Tue, Nov 5, 9:32 PM
F14016476: D11507.diff
Mon, Nov 4, 9:53 AM
F14011057: D11507.id.diff
Thu, Oct 31, 4:07 PM
Subscribers
Tokens
"The World Burns" token, awarded by btrahan.

Details

Reviewers
btrahan
chad
Maniphest Tasks
Restricted Maniphest Task
T7014: Annouce Persistent Chat option in Conpherence
Commits
Restricted Diffusion Commit
rP5c71da8cdb6c: Quicksand, an ignoble successor to Quickling
Summary

Ref T2086. Ref T7014. With the persistent column, there is significant value in retaining chrome state through navigation events, because the user may have a lot of state in the chat window (scroll position, text selection, room juggling, partially entered text, etc). We can do this by capturing navigation events and faking them with Javascript.

(This can also improve performance, albeit slightly, and I believe there are better approaches to tackle performance any problems which exist with the chrome in many cases).

At Facebook, this system was "Photostream" in photos and then "Quickling" in general, and the technical cost of the system was staggering. I am loathe to pursue it again. However:

  • Browsers are less junky now, and we target a smaller set of browsers. A large part of the technical cost of Quickling was the high complexity of emulating nagivation events in IE, where we needed to navigate a hidden iframe to make history entries. All desktop browsers which we might want to use this system on support the History API (although this prototype does not yet implement it).
  • Javelin and Phabricator's architecture are much cleaner than Facebook's was. A large part of the technical cost of Quickling was inconsistency, inlined onclick handlers, and general lack of coordination and abstraction. We will have some of this, but "correctly written" behaviors are mostly immune to it by design, and many of Javelin's architectural decisions were influenced by desire to avoid issues we encountered building this stuff for Facebook.
  • Some of the primitives which Quickling required (like loading resources over Ajax) have existed in a stable state in our codebase for a year or more, and adoption of these primitives was trivial and uneventful (vs a huge production at Facebook).
  • My hubris is bolstered by recent success with WebSockets and JX.Scrollbar, both of which I would have assessed as infeasibly complex to develop in this project a few years ago.

To these points, the developer cost to prototype Photostream was several weeks; the developer cost to prototype this was a bit less than an hour. It is plausible to me that implementing and maintaining this system really will be hundreds of times less complex than it was at Facebook.

Test Plan

My plan for this and D11497 is:

  • Get them in master.
  • Some secret key / relatively-hidden preference activates the column.
  • Quicksand activates only when the column is open.
  • We can use column + quicksand for a long period of time (i.e., over the course of Conpherence v2 development) and hammer out the long tail of issues.
  • When it derps up, you just hide the column and you're good to go.

Diff Detail

Repository
rP Phabricator
Branch
durable2
Lint
Lint Passed
SeverityLocationCodeMessage
Advicesrc/view/page/PhabricatorStandardPageView.php:543XHP16TODO Comment
Unit
Tests Passed
Build Status
Buildable 4064
Build 4077: [Placeholder Plan] Wait for 30 Seconds

Event Timeline

epriestley retitled this revision from to [DRAFT] Quicksand, an ignoble successor to Quickling.
epriestley updated this object.
epriestley edited the test plan for this revision. (Show Details)
epriestley added reviewers: chad, btrahan.
epriestley added tasks: T7014: Annouce Persistent Chat option in Conpherence, Restricted Maniphest Task.

Let me prototype the History API stuff, at least.

  • Make history work, to a first approximation.
epriestley retitled this revision from [DRAFT] Quicksand, an ignoble successor to Quickling to Quicksand, an ignoble successor to Quickling.Jan 26 2015, 9:37 PM
  • Add some comments / clarity.
  • Couldn't find anything clearly wrong with this in Firefox, Chrome or Safari.
chad edited edge metadata.

shipitquick (sand)

This revision is now accepted and ready to land.Jan 27 2015, 8:43 PM
This revision was automatically updated to reflect the committed changes.