Porting Flickr to YUI3 - F2E Summit


Published on

Published in: Technology, Sports
1 Like
  • Be the first to comment

No Downloads
Total views
On SlideShare
From Embeds
Number of Embeds
Embeds 0
No embeds

No notes for slide
  • http://www.flickr.com/photos/mrhappy8/2079473624/
  • I'm Ross, a frontend engineer at Flickr.http://www.flickr.com/photos/protohiro/5123921842/
  • This is a story about problems we found after the launch of that photo page, and a few of the unanticipated consequences of building a page from scratch using YUI3 and the Y! Performance GuidelinesThe primary goal of the project, from the engineering side, was to improve performance:The old page took 4-6 seconds to loadThe frontend code was 5 years old To put some perspective on it, the JS contained hand-coded special cases for Opera 7 There were tons of global variables, and a dependency tree that was so complicated that we were terrified to pull out pieces of JS It was ready to be put to rest.
  • We investigated doing a retrofit with YUI3 We determined that it would take longer to do that than it would to throw everything out and start from scratch We also determined that retrofitting wouldn't really improve performance:The only way we could meet our goal was to throw everything awayWe started from scratch using YUI3 and the Y! Performance GuidelinesAnd I mean, really started from scratch. We used empty CSS and JS files and built the page againhttp://www.flickr.com/photos/jasonscottmeans/3391919037/
  • Page load times are down significantly (900ms for Safari, 1.5 for Chrome) We essentially cut the load time in half for the worst case (IE), and reduced it by 80% for the best case (Safari)Code is modular and maintainable The architecture will last us for the next 5 years, even if the individual modules that make it up don't Modules and dependencies mean that 5 engineers can work on the page at the same timeDevelopment time was extremely fast Existing gallery modules mean you don’t have to reinvent the wheel Convenience methods mean you can do extremely complex things with very little code (more on this later) Good documentation means that even though we weren't initially familiar with YUI3's syntax, we soon picked it up Porting code from YUI2 to 3 is an easy process – analogous functions exist, and it's a simple matter of changing the syntaxhttp://www.flickr.com/photos/kevinkyen/4721020630/
  • 99% of the things we used YUI3 for went off without a hitchBut there were a few things that caught us by surprise Some where caused by using YUI3, and some were caused by implementing the Performance Guidelines The guidelines are taken as gospel at this point; everyone know them and tried to implement them We found that, at the edges of normal use, some of the guidelines start to break downI'm going to spend the rest of this talk going over the 4 problems that we found, and how we fixed each one.These all happened after launch, and most of them were reported by usershttp://www.flickr.com/photos/warquel/3991665628/
  • http://www.flickr.com/photos/jiuguangw/4982410568/
  • http://www.flickr.com/photos/danielygo/5021424805/
  • http://www.flickr.com/photos/fdecomite/3016623321/
  • From there it gets a bit trickierhttp://www.flickr.com/photos/publicenergy/1846375599/
  • http://www.flickr.com/photos/44442915@N00/3226341868/
  • With this approach, you are essentially swapping out one JS lib for another, with the fewest number of code changes possible. You don't get a lot of the architectural improvements, but you still get deferred loading and the performance improvements internal to YUI3 itself.This is definitely the fastest way to convert over to YUI3. We found that you could convert most reasonably sized JS files in a day or less. You can even continue to use YUI2 widgets, with 2to3.http://www.flickr.com/photos/bflv/4032221304/
  • This obviously takes a lot longer, but will result in terser, more easily maintainable code. You separate code into discrete modules, set up dependencies, set up a combo-handler, and load only the JS you need on each page.
  • We used both techniques; the older, more stand-alone or one-off features we simply converted enough to work, tossed them into a module, and then left them alone. The more central and often used parts we entirely re-wrote (these were also the modules that we expected to use on other pages).The combination means we were able to go entirely to YUI3 on the photo page in 6 months, with 5 frontends working fulltime.
  • It’s easy to say that it would be too much work to convert your site over to YUI3. Instead, give it a try. Convert a small part of your site to use YUI3 as a test, and see how long it takes with your setup. Use that as ammunition (along with all of the studies that show how small performance improvements lead to much higher levels of conversion) to get time and resources to convert everything over.We used the photo page as a launching pad, since it’s the biggest and more important page of the site. Now we are converting over all of the other pages as we get to them. The entire process will probably make more than a year.
  • Converting over to YUI3 gives you a speed boost right off the bat, but there are things you can do to make it even better.These are some things that worked for us
  • This makes sense in most cases, since script tags block and slow down the page from being rendered.But if your page depends heavily on JS, it can actually increase perceived loading timehttp://www.flickr.com/photos/sshb/3981130921/
  • It means that the bulk of your JS won't be downloaded and executed until a second or two after the rest of the UI. Having no-JS fallbacks also makes it worse.Instead of a button that does nothing for a short time, it actually takes you off the page.The problem is exasperated by using YUI3's deferred module loading .http://www.flickr.com/photos/blueskin808/1422588776/
  • We include a small amount of JS in the head, enough to attach click events and to show a busy indicator.We then start to queue up clicks.When a module registers itself, it checks the queue and performs the necessary actions.The action queue code handles cleanup of the busy indicators. http://www.flickr.com/photos/boliston/3958674786/
  • It tricks people into thinking the UI is responsive.Action queuing doesn't actually solve the problem, it just improves the perceived load timehttp://www.flickr.com/photos/markscott/1117392453/
  • Page load times are down significantly (900ms for Safari, 1.5 for Chrome)Code is modular and maintainableThe architecture will last us for the next 5 years, even if the individual modules that make it up don't
  • http://www.flickr.com/photos/pedrovezini/5369646057/
  • These users get pages that sort of work, but don't have all the JS modulesIt's their problem to fix, but most can't do anything about itWe had to fix it on our endhttp://www.flickr.com/photos/simonhua/4696240744/
  • We replaced the names of modules with single or double character strings. This algorithm wasn't reversible, but it was easy to implement and doesn't require a database to store shortened names.We have to run the script that builds the substitution dictionary every once in a while, but that's easy
  • They are a small minority at the moment, but eventually we'll have to deal with this problem.1600 characters or lower is the limit we found covers pretty much everyone.http://www.flickr.com/photos/inkiboo/203350186/
  • It seems that some corporate firewall refuse to load any URL that has the string 'xxx' in it. We had to implement a check that would use the longer version of the string if xxx was detected. There is a long list of words that triggers this response from corporate firewalls. http://www.flickr.com/photos/sahlgoode/5012048467/
  • http://www.flickr.com/photos/jpellgen/4225409668/
  • Not just scrolling, but almost all UI interactions requiring a click or a draghttp://www.flickr.com/photos/lin/372711782/
  • Both of these need to poll, with setInterval() in case the elements don't exist yet. We found that we were able to create our own delegate method, using Y.on and Y.Node.test that was twice as fast, when run through a massive selenium test. This isn't to say that ours is better (it isn't), but that Y.delegate() has to handle a lot of cases, and has baggage for most uses cases.
  • This probably goes without saying, but customizing the solutions for each situation is obviously going to be faster.What was surprising to me was just how slow delegate and on were before we customized them.http://www.flickr.com/photos/cybertoad/2102752062/
  • Don't assume that, just because you're using an established library, you don't need to know what's going on under the hood. We removed all instances of Y.delegate and Y.on, and massively improved the click performance of IE. YMMV.http://www.flickr.com/photos/roadsidepictures/1389358202/
  • http://www.flickr.com/photos/geckoam/2739383271/
  • There are things on every page that are only used very infrequently. We found that most of the buttons on our photo page are used a very small percentage of the time, and that most users are just there to passively view the photo
  • There is no need to include markup, JS and CSS on the page at load time for things that are rarely used. Instead, attach event handlers that will fetch the markup and invoke Y.use() to fetch the CSS and JS.
  • It’s definitely not a good an experience to have to load things only when, for example, a button is clicked. You can make it seems faster by showing a loading indicator when the fragment is being fetched, or have the markup fetch start early, when the user mouses over a link (lots of false positives from this, though).One optimization is to fetch multiple fragments at once, as soon as it becomes clear that the user will need them at some point.
  • DOMReady and window.load are meaningless once you start deferring assets. They are no longer important moments in the loading of your page.http://www.flickr.com/photos/mattimattila/3822631755/
  • The important moments for us are:When the photo is visible, andWhen the JS is done loading and the UI is fully functionalTrack everything, but only actively monitor a few important metricshttp://www.flickr.com/photos/whiteoakart/471538245/
  • We generally take timing data from 1% of all users (on some pages, this is as high as 2-4%).This gives us enough data to create smooth graphs, without burdening too many page loads with the extra code needed to gather and report the timings.The exact percentage you need varies according to traffic.http://www.flickr.com/photos/wwarby/3016567069/
  • Having a visible dashboard that's easy to get to is a really important part of the feedback cycle. Engineers will notice when performance gets worse, and will investigate what caused it. They will also try to improve the load times and Also serves as quality assurance, since it lets you know when site performance is down.Side note: RRDtool is really useful for storing and displaying this kind of timing data.RRDtool is a round robin database that stores data at decreasing granularity as time goes on: http://www.mrtg.org/rrdtool/
  • Performance is excellent for Safari, Chrome and Firefox. IE8 is mediocre and IE7 is terrible. If we were to average all of these numbers together, it would mask the 900ms page load times we're getting with Safari.Lumping them in together also hides browser-specific problems. After a recent deploy, we noticed that the IE8 load times were slightly higher than normal; having separate graphs allowed us to find and fix the problem.The real solution is to have reference systems: a fixed computer, OS, connection, and browser configuration, that we can use to compare the performance of the page over time.http://www.flickr.com/photos/richoz/3791167457/
  • The real solution is to have reference systems: a fixed computer, OS, connection, and browser configuration, that we can use to compare the performance of the page over time.Put it under a desk or on a rack and have it hit a page every 10 or 20 seconds. You will get variation from things like load, but it should be relatively consistent.For bonus points, have your graphs show when deploys happened, and what changed for each.http://www.flickr.com/photos/br1dotcom/4737073824/
  • YUI3 is amazingIf you can't have real performance, fake itDig deeply into the JS library you useMeasure the moments important to youNEVER include XXX in a URLhttp://www.flickr.com/photos/cdhc/274211112/
  • YUI3 is amazingIf you can't have real performance, fake itDig deeply into the JS library you useMeasure the moments important to youNEVER include XXX in a URLhttp://www.flickr.com/photos/ennor/353250218/
  • YUI3 is amazingIf you can't have real performance, fake itDig deeply into the JS library you useMeasure the moments important to youNEVER include XXX in a URLhttp://www.flickr.com/photos/candyflossblackmarket/1139767634/
  • YUI3 is amazingIf you can't have real performance, fake itDig deeply into the JS library you useMeasure the moments important to youNEVER include XXX in a URLhttp://www.flickr.com/photos/jensaar/386863409/
  • YUI3 is amazingIf you can't have real performance, fake itDig deeply into the JS library you useMeasure the moments important to youNEVER include XXX in a URLhttp://www.flickr.com/photos/sterlic/4299631538/
  • YUI3 is amazingIf you can't have real performance, fake itDig deeply into the JS library you useMeasure the moments important to youNEVER include XXX in a URLhttp://www.flickr.com/photos/bobcatrock/2653120251/
  • Porting Flickr to YUI3 - F2E Summit

    1. 1. Porting Flickr to YUI 3Ross Harmes<br />
    2. 2. Porting Flickr to YUI 3Lessons in Performance<br />Ross Harmes<br />
    3. 3. In August we launched a new photo page…<br />
    4. 4. We decided to completely demolish the old page and rebuild with YUI3<br />
    5. 5. Using YUI3 was a delight…<br />
    6. 6. …but blindly converting from 2 to 3 could lead to some problems<br />
    7. 7. The easy part: converting from YUI2 to 3<br />
    8. 8. The big secret: it's really easy, and mostly mechanical<br />
    9. 9. Events work in mostly the same way<br />
    10. 10.
    11. 11. DOM calls are now made off of nodes instead of Y.DOM<br />
    12. 12.
    13. 13. Events and DOM interactions are probably 90% of the code for most sites<br />
    14. 14. We found that there were two ways to do it<br />
    15. 15. 1. Convert just enough to make it work in YUI3<br />
    16. 16. 2. Rewrite it using YUI3 idioms<br />
    17. 17. We used both techniques<br />
    18. 18. The bottom line: give it a try<br />
    19. 19. The harder part: making your converted code fast<br />
    20. 20. 1. Action queuing<br />
    21. 21. One of the first perf. recommendations is to move all the JS to the bottom of the page<br />
    22. 22. This means UI elements that need JS to work will fallback to the non-JS case until the scripts load<br />
    23. 23. Our solution: Action Queuing<br />
    24. 24. This isn't making the JS load faster<br />
    25. 25. Getting creative with the loading indicators helps<br />
    26. 26. 2. Combo handler<br />
    27. 27. We use a lot of small JS modules on the page. This made our combo URLs very long:<br />http://l.yimg.com/g/combo.gne?event/event-min.js&j/query-string-args.js.v85201.14&j/flickr_location_search.js.v85793.14&j/flickr_nav.js.v92497.14&base/base-min.js&anim/anim-min.js&dump/dump-min.js&datatype/datatype-xml-min.js&substitute/substitute-min.js&queue-promote/queue-promote-min.js&io/io-min.js&json/json-min.js&j/flickr_api.js.v93039.14&j/history-manager.js.v90829.14&j/photo-data.js.v92868.14&j/context-data.js.v92557.14&j/context-manager.js.v91220.14&j/sprintf.js.v90343.14&j/transjax-base.js.v85036.14&j/focus-tracker.js.v93044.14&event-simulate/event-simulate-min.js&j/photo-button-bar-transjax-en-us.js.v92588.14&j/image-fader.js.v85225.14&j/number-transjax-en-us.js.v90582.14&j/number.js.v87306.14&j/photo-filmstrip-transjax-en-us.js.v90793.14&j/photo-filmstrip.js.v92881.14&event/event-synthetic-min.js&j/event-annotations.js.v91160.14&j/event-mousedrag.js.v90789.14&j/math.js.v87441.14&j/fave-star.js.v91965.14&j/global-dialog-transjax-en-us.js.v85507.14&j/global-dialog-zeus.js.v92830.14&j/keyboard-shortcut-manager.js.v92698.14&node/node-event-simulate-min.js&j/photo-permalink.js.v91170.14&j/yahoo/autocomplete_2.5.1-zeus.js.v92829.14&j/bo-selecta-transjax-en-us.js.v90792.14&j/bo-selecta-zeus.js.v91866.14&cookie/cookie-min.js&j/dejaview-zeus.js.v90642.14&j/photo-people-transjax-en-us.js.v90822.14&j/photo-people-controller.js.v88235.14&j/input-hint.js.v86479.14&j/photo-comments-transjax-en-us.js.v92483.14&j/swfobject.js.v85491.14&j/photo-comments.js.v92853.14&j/photo-keyboard-shortcuts.js.v92892.14&j/box-host.js.v89305.14&j/photo-notes-transjax-en-us.js.v93010.14&j/string-filters.js.v91087.14&j/photo-notes-zeus.js.v93044.14&j/excanvas.js.v39120.14&j/bitmap-text-zeus.js.v87486.14&j/bitmap-type-silkscreen.js.v87486.14&j/photo-sidebar-transjax-en-us.js.v90794.14&stylesheet/stylesheet-min.js&j/photo-sidebar.js.v92813.14&j/photo-context-menu-transjax-en-us.js.v90793.14&j/photo-lightbox-transjax-en-us.js.v92868.14&j/ywa.js.v89879.14&j/photo-ywa-tracking.js.v92723.14&j/occult.js.v90963.14&j/yahoo-ult.js.v92052.14&j/photo-zeus.js.v93054.14&j/photo-people-list.js.v92992.14&j/photo-button-bar.js.v92891.14&j/photo-context-menu.js.v92706.14&j/photo-lightbox.js.v93054.14&j/insitu-transjax-en-us.js.v90792.14&j/insitu-zeus.js.v91793.14&j/photo-insitu.js.v91169.14&j/photo-group-invites-transjax-en-us.js.v90793.14&j/photo-group-invites.js.v91020.14&j/tagrs_zeus-transjax-en-us.js.v93081.14&j/tagrs_zeus.js.v93081.14&j/photo-sidebar-owner-transjax-en-us.js.v91626.14&j/photo-sidebar-owner.js.v92860.14&j/photo-sidebar-admin.js.v92656.14&j/photo-geolocation-transjax-en-us.js.v92191.14&j/photo-geolocation.js.v92894.14&j/personmenu-transjax-en-us.js.v90792.14&j/personmenu-zeus.js.v92796.14&j/share-menu-zeus-transjax-en-us.js.v92581.14&j/share-menu-zeus.js.v92971.14<br />2,792 characters<br />
    28. 28. Turns out that a small but vocal minority of users sit behind firewalls that restrict URL length<br />
    29. 29. The algorithm we settled on was string substitution:<br />http://l.yimg.com/g/combo.gne?event/event-min.js&j/.H-.K.A.vNKE8&j/.CP-.U-.DE.A.vKEJx&j/.J_.BR_.CA.A.vKYke&j/.J_.DB.A.vPpBR&base/base-min.js&anim/anim-min.js&dump/dump-min.js&datatype/datatype-xml-min.js&substitute/substitute-min.js&queue-promote/queue-promote-min.js&io/io-min.js&json/json-min.js&j/.J_.DS.A.vPFJk&j/.CE-.K.A.vNy2Z&j/.B-.BY.A.vPADv&j/.H-.BY.A.vPrpi&j/.CC.A.vNiA4&j/.C-.BL.A.vPL3k&j/.CV-.CH.A.vPFSX&event-simulate/event-simulate-min.js&j/.B-.T-.CI-.C-.F.A.vPJPD&j/.CW-.CU.A.vKFrV&j/.Y-.C-.F.A.vNqG8&j/.Y.A.vLKiR&j/.B-.M-.C-.F.A.vPKTH&j/.B-.M.A.vPKTH&event/event-synthetic-min.js&j/.G-.BD.A.vNHSF&j/.G-.BO.A.vNwR2&j/.DL.A.vLPjB&j/.CX-.CY.A.vP8NB&j/.X-.W-.C-.F.A.vKPQ8&j/.X-.W-.D.A.vPzvZ&j/.Q-.BX-.K.A.vPvAp&node/node-event-simulate-min.js&j/.B-.BP.A.vNJaV&j/.CM/.BA_2.5.1-.D.A.vPzug&j/bo-.S-.C-.F.A.vNwWc&j/bo-.S-.D.A.vP5RV&cookie/cookie-min.js&j/.BZ-.D.A.vNstz&j/.B-.L-.C-.F.A.vNxPV&j/.B-.L-.BH.A.vMdVz&j/.CN-.DD.A.vLjHZ&j/.B-.O-.C-.F.A.vPpcH&j/.BM.A.vKPmx&j/.B-.O.A.vPHa6&j/.B-.Q-.BQ.A.vPBmT&j/.DR-.DG.A.vMLJp&j/.B-.BE-.C-.F.A.vPHP2&j/.U-.CG.A.vNFGP&j/.B-.BE-.D.A.vPFSX&j/.BV.A.vm3Ux&j/.Z-.DK-.D.A.vLQEc&j/.Z-.DJ-.BJ.A.vLQEc&j/.B-.I-.C-.F.A.vPKTH&stylesheet/stylesheet-min.js&j/.B-.I.A.vPLW4&j/.B-.H-.BB-.C-.F.A.vNwXV&j/.B-.N-.C-.F.A.vPADv&j/.CL.A.vN4N4&j/.B-.CL-.BW.A.vPwkv&j/.CF.A.vNC22&j/.CM-.DO.A.vPboB&j/.B-.D.A.vPGbc&j/.B-.L-.CZ.A.vPJpv&j/.B-.T-.CI.A.vPKDV&j/.B-.H-.BB.A.vPvQc&j/.B-.N.A.vPGbc&j/.B-.DM-.CO-.C-.F.A.vNwXV&j/.B-.DM-.CO.A.vNDHi&j/.BF_.D-.C-.F.A.vPGYK&j/.BF_.D.A.vPGYK&j/.B-.I-.CQ-.BK-.C-.F.A.vNwZD&j/.B-.I-.CQ-.BK.A.vLWQP&j/.B-.I-ad.E.A.vPukZ&j/.B-.R-.C-.F.A.vPfwg&j/.B-.R.A.vPBqk&j/.CB-.C-.F.A.vNwWc&j/.CB-.D.A.vPyvn&j/.DN-.BB-.D-.C-.F.A.vPs7F&j/.DN-.BB-.D.A.vPM5F<br />1,702 characters (40% smaller)<br />
    30. 30. This fixes the problem for almost all users… but Sonicwall turns out to have a limit below 1600 characters<br />
    31. 31. And then there was the XXX problem<br />
    32. 32. 3. Convenience methods<br />
    33. 33. We noticed that on IE8/7, scrolling was very jerky <br />
    34. 34. The culprit: pollers in Y.delegate() and Y.on()<br />
    35. 35. We replaced both with Y.all().on(),and more customized solutions<br />
    36. 36. Convenience methods have a cost<br />
    37. 37. 4. Fragment fetcher<br />
    38. 38. On most pages, there are a lot of low percentage actions<br />
    39. 39. Optimize for the 99% case; don’t load markup, CSS or JS for rarely used actions<br />
    40. 40. Loading indicators can help here as well<br />
    41. 41. The long-term part: a culture of performance<br />
    42. 42. The old metrics are meaningless<br />
    43. 43. What do we measure?<br />
    44. 44. What is the best sampling rate?<br />
    45. 45. Put the graphs in a place where FEs will see them<br />
    46. 46. Browsers behave so differently that lumping them in together hides successes<br />
    47. 47. In order to measure just the changes you make, you need a reference system<br />
    48. 48.
    49. 49. In closing…<br />
    50. 50. YUI3 is amazing – give it a try!<br />
    51. 51. If you can't have real performance, fake it<br />
    52. 52. Dig deeply into the JS library you use<br />
    53. 53. Measure the moments important to your page<br />
    54. 54. And NEVER include XXX in a URL<br />
    55. 55. Thank you!<br />ross@flickr.com<br />Slides at: lanyrd.com/spdm<br />Photo credits<br />http://www.flickr.com/photos/markscott/1117392453/<br />http://www.flickr.com/photos/cybertoad/2102752062/<br />http://www.flickr.com/photos/whiteoakart/471538245/<br />http://www.flickr.com/photos/wwarby/3016567069/<br />http://www.flickr.com/photos/richoz/3791167457/<br />http://www.flickr.com/photos/lin/372711782/<br />http://www.flickr.com/photos/cdhc/274211112/<br />http://www.flickr.com/photos/ennor/353250218/<br />http://www.flickr.com/photos/jensaar/386863409/<br />http://www.flickr.com/photos/sterlic/4299631538/http://www.flickr.com/photos/candyflossblackmarket/1139767634/<br />http://www.flickr.com/photos/bobcatrock/2653120251/<br />http://www.flickr.com/photos/jm2c/3677835375/<br />http://www.flickr.com/photos/kevinkyen/4721020630/<br />http://www.flickr.com/photos/sindykids/2666402195/<br />http://www.flickr.com/photos/simonhua/4696240744/<br />http://www.flickr.com/photos/inkiboo/203350186/<br />http://www.flickr.com/photos/sahlgoode/5012048467/<br />http://www.flickr.com/photos/sshb/3981130921/<br />http://www.flickr.com/photos/blueskin808/1422588776/<br />http://www.flickr.com/photos/roadsidepictures/1389358202/<br />http://www.flickr.com/photos/boliston/3958674786/<br />http://www.flickr.com/photos/httpwwwactionpixsmarukocom/4812699768/<br />