Upgrade to Pro — share decks privately, control downloads, hide ads and more …

Marrying front with back end

Marrying front with back end

Confoo 2014 Montreal

This talk will feature and overview of an architecture that enables heavy reuse of even the smallest components by showing the details of the researchgate.net implementation. This approach enables developers to take page elements, like a follow button, and place it everywhere on the site without having to duplicate any PHP, JS, HTML or CSS in the process enabling huge scalability, performance and UX improvements beyond a classic (H)MVC approach.

Bastian Hofmann

February 28, 2014
Tweet

More Decks by Bastian Hofmann

Other Decks in Programming

Transcript

  1. Rapid Development so that you can develop new features quickly

    without breaking the rest of your application or accumulation lots of technical debt
  2. Handling large code-bases especially if your code base becomes larger

    and larger, developed by big, growing teams
  3. Frameworks to the rescue Normally if faced with these problems

    people say: don't reinvent the wheel, let's look what's already out there, let's use some framework (or some libraries), or if you have a bad case of the not-invented-here syndrom in your company, you are going to develop your own
  4. webserver HTML browser JS so the normal flow of a

    web application is that some server code serves some html (and maybe some apis) to the browser, in the browser there is some (or a lot of) javascript that manipulates the DOM
  5. webserver HTML browser JS Ajax and either links to other

    pages served by the server or does ajax requests back to the server. this concept is mostly true for either traditional apps as well as single page applications
  6. webserver HTML browser JS Ajax but the code in both

    worlds, server and client, is seldom connected
  7. de duplication ode duplication code duplication code duplication code duplication

    code duplication code duplication code duplication code duplication code duplication code duplication code duplication code duplication code duplicatio code duplicat code duplic code dup code du code cod co co which leads to lot of code duplication in templates, validation logic, models and lots of boiler plate code for communication between server and client, marshalling data
  8. Questions? Ask by the way, if you have any questions

    throughout this talk, if you don't understand something, just raise your hand and ask.
  9. if we take a small peek into a possible future

    of web application development
  10. Meteor http://www.meteor.com or meteor, that try to bridge the gap

    between server and client. but they are still very alpha, good for prototyping, writing small apps, trying things out, but personally I wouldn't create a big million lines of code web application with 40+ developers yet
  11. Incremental Refactoring the way to make the architecture of your

    existing application better and connect your backend with your frontend code is incremental refactoring, since you hopefully can't afford to sit down, stop development for 6 months and rewrite everything
  12. many roads of course like always there are many ways

    to go about that, which totally depends on you existing code
  13. or what i'm going to talk about for the reminder

    of the talk, what we did at RG
  14. status quo so RG: when we started about over a

    year ago, the status quo was:
  15. Components let's rethink the way we are building pages or

    our whole application and separate it into small components
  16. Server JS Browser JSON HTML HTML so it should have

    it's own url, and for seo reasons can just be included in a page rendered to a browser by the server or can be fetched separately or nested within other components by the apps javascript, where we only wanted to transport the data to the client and render it into html there
  17. JS is part of the component the javascript to bind

    on dom events and manipulate the components should be part of the component
  18. Share code between server and client and we wanted to

    share as much code between server and client as possible (considering our heterogeneous architectur, js client, php server)
  19. It needs to be fast of course ... concerning performance

    as well as development speed and productivity
  20. PHP Controller Mustache Template JavaScript view class Widget Providing data

    Handling browser events Displaying data CSS so to sum it up an widget contains
  21. Profile Publications Publication Publication Publication AboutMe LeftColumn Image Institution Menu

    we see, that it's actually kind of a tree structure, for the sake of this presentation i simplified it slightly, actually our profile consists of over 200 components
  22. Profile Publications Publication Publication Publication AboutMe LeftColumn Image Menu Server

    Request Response Institution i said earlier, that all these components have their own URL. So they can be requested and rendered by the client seperately. For better user experience on the first load or SEO reasons these components can also be bundled together and rendered in a single page load on the backend.
  23. LeftColumn Image Menu Server Request Response if we want to

    fetch the left column separately it looks like this
  24. Widget Requirement this tree structure is achieved through so called

    widget requirements, why they are called requirements
  25. Profile Publications Publication Publication Publication AboutMe LeftColumn Image Menu Institution

    that means the profile widget requires: publications, aboutMe, leftColumn and institution
  26. Profile Publications Publication Publication Publication AboutMe LeftColumn Image Menu Institution

    and Publications requires several publicationItem widgets and leftColumn the Image and the Menu widget
  27. Do not fetch data directly so something you shouldn't do

    is fetching this data directly on you server when composing a page or a subpage
  28. Profile Publications Publication Publication Publication AboutMe LeftColumn Image Menu Account

    Account Account Account Account Publication1 Publication2 Publication3 Institution if we take our simplified example, a lot of components need the account of the user that's displayed, while that could be solved with in memory caching, a list of publications each need the publication entity, if we display 20 publications, that would mean 20 database queries, doing it in one query would be much faster though, and you have lot's of stuff like this
  29. Require stuff so instead of fetching stuff directly, it's way

    better to require stuff (that's also why building up the widget tree was done with widget "requirements"
  30. http://www.infoq.com/presentations/Evolution-of-Code- Design-at-Facebook/ this concept is actually not that new, one

    small company who is doing this very much is for example facebook, who also did a very good talk about this a few years back
  31. so how does it work? around all your components that

    just state data (or widget) requirements you need an instance called a preparer
  32. Widget Widget Widget Widget Preparer Fetch Requirements Resolver Resolver Services

    Connector Interfaces Connector Implementations the preparer iterates over all components and fetches their requirments
  33. Widget Widget Widget Widget Preparer Resolver Resolver Services Connector Interfaces

    Connector Implementations Batch requirements and pass them to resolvers it batches them together as intelligently as possible, passes the requirements to resolvers
  34. Widget Widget Widget Widget Preparer Resolver Resolver Services Connector Interfaces

    Connector Implementations Call Services as effective as possible (Multi-GET,...) which call the services/storages/etc as effective as possible, or just execute some service class methods
  35. Widget Widget Widget Widget Preparer Resolver Resolver Services Connector Interfaces

    Connector Implementations Attach fetched data to Requirements and pass them back to the preparer the fetched data is attached to the requirements, passed back to the preparer
  36. Widget Widget Widget Widget Preparer Resolver Resolver Services Connector Interfaces

    Connector Implementations Distribute fetched data to the widgets that required it who in turn distributes the fetched data to the components
  37. public function collect() { return [ new EntityRequirement( 'account', Account::class,

    ['id' => $this->request->get('id')] ), ]; } because then you can write it like this:
  38. Request Cache nice thing is you can cache this stuff

    intelligently in memory of your current request
  39. public function collect() { yield [ new EntityRequirement( 'account', Account::class,

    ['id' => $this->request->get('id')] ), ]; yield [ new ServiceRequirement( 'scienceDisciplines', AccountService::class, 'getScienceDisciplines', ['account' => $this->account] ) ]; } because then you can write it like this:
  40. trait ServiceRequirementFactory { /** @return $this */ public static function

    getCall() { return new ServiceRequirementFactoryProxy( ! ! ! static::class ! ! ! ); } }
  41. class ServiceRequirementFactoryProxy { private $className; public function __construct($className) { $this->className

    = $className; } public function __call($name, $arguments) { return [ 'serviceClass' => $this->className, 'methodName' => $name, 'arguments' => $arguments ]; } }
  42. Profile Publications Publication Publication Publication AboutMe LeftColumn Image Menu Institution

    e.g. for a list of publications that you got from a solr search, you may not want to go to the database again to fetch each publication in each list item, but since a list item is supposed to be renderable separately as well, it needs this logic in there
  43. class PublicationKeywordSearch { public $publications; public $publicationListItems = []; public

    function collect() { yield [ serviceRequirement( 'publications', PublicationService::getCall()->getByKeywords( ['virology', 'cancer'], 10, 0 ) ) ]; foreach ($this->publications as $publication) { yield new WidgetRequirement( 'publicationListItems', PublicationItem::CLASS, [ ! ! ! ! ! ! ! ! 'publicationId' => $publication->getId(), ! ! ! ! ! ! ! ! 'publication' => $publication ! ! ! ! ! ! ! ] ); } } } in code
  44. class PublicationItem { public $publicationId; public $publication; public function collect()

    { yield new RequestDataRequirement('publicationId'); yield [ new EntityRequirement( 'publication', Publication::class, ['id' => $this->publicationId] ) ]; } } that means if the subwidget has a requirment like this, the preparer would directly put the prefilled data in there instead of passing it on to the resolvers
  45. Whoa, this looks awfully complicated to debug you're right, it

    takes a bit of time to get used to program this way, but everyone who joined our company in the last few months since we are doing it says after a week or so, that they actually can't imagine working any other way again (i'll talk more about the benefits later)
  46. but still it's complex, so a good thing is taking

    a bit of effort to make it as transparent as possible to see what happens in your application (which is a very good thing anyways). we have a debug toolbar that shows all the component on the page
  47. HTML i said earlier we want our widget tree to

    be renderable on the server side as html
  48. JSON and just put out as json and then be

    rendered on the client side by our javascript
  49. Mustache } http://mustache.github.com/ so we decided to use mustache templates,

    we are actually using twitters mustache implementation called hogan
  50. <div id="{{widgetId}}"> <h3> Publications <a href="javascript:" class="js-showAll"> ({{count}}) </a> </h3>

    <ul> {{#publicationItems}} <li>{{{.}}}</li> {{/publicationItems}} </ul> {{#showLegalFooter}} {{{legalFooter}}} {{/showLegalFooter}} </div> that's what a template may look like
  51. Helper Methods there is also a php implementation of mustache,

    but it's not the fastest and one thing is, that mustache oftentimes relies on small helper functions
  52. •nl2br •truncate •pluralize •wordwrap •highlight •... like ... if you

    now use a php implementation on the server and a js implementation on the client, we have to develop these functions twice ... not a good idea
  53. http://pecl.php.net/package/v8js V8js that why we actually execute javascript through a

    php extension that makes the v8 js library available on the server. so we are executing the same code on the server and on the client to render the same templates. suprise: it's acutally really really fast
  54. JavaScript so we handled templates and rendering, the backend controllers

    that provide the data, on the javascript side in the client each component can have a view object to bind on DOM events
  55. <div id="{{widgetId}}"> <h3> Publications <a href="javascript:" class="js-showAll"> ({{count}}) </a> </h3>

    <ul> {{#publicationItems}} <li>{{{.}}}</li> {{/publicationItems}} </ul> {{#showLegalFooter}} {{{legalFooter}}} {{/showLegalFooter}} </div> remember this template
  56. YUI.add('views.publicationList', function (Y) { Y.views.publicationList = Y.Base.create(Y.WidgetView, { events :

    { '.js-showALl' : { click : 'showALl' } }, showAll : function () { var node = this.get('container'); node.addClass('loading'); Y.loadWidget(‚/publications/all', { keywords : this.data.keywords }, function (widget) { widget.render({ replace : node }); }); } }); }); here is an example
  57. http://www.youtube.com/watch?v=fqULJBBEVQE .. this is exactly what web components is about.

    they have their own html, css, js and are even more sandboxed through a shadow dom to limit interactions between different components. an example for webcomponents are the browser controls for videos or forms by the way.
  58. Easier Refactoring even if the implementation of one component is

    very ugly and crude, at least it's encapsulated (hopefully tested) and you can either leave it or revisit this component later on
  59. Profile Publications Publication Publication Publication AboutMe LeftColumn Image Menu EXCEPTION

    Institution if an exception occurs in one of our components while fulfilling a requirement that is not optional
  60. Profile Publications Publication Publication Publication LeftColumn Image Menu Institution we

    just deactivate this component and the rest of the page is still functional
  61. we are doing this excessively, and have over 90 or

    so experiments with sometimes over 20 variants running. the way we can do this quickly and easily is by just switching components for the different variants
  62. Profile Publications Publication Publication Publication AboutMe LeftColumn Image Menu <esi:include

    src="..." /> Institution because every component has it's own url you can just render out a esi placeholder instead of the widget to tell varnish to fetch it separately and provided it has caching headers, get it out of the cache
  63. Load components asynchronously the same way you can also load

    components of the widget tree asynchronously
  64. Profile Publications Publication Publication Publication AboutMe LeftColumn Image Menu <div

    id="placeholder"></div> <script>loadWidget('/aboutMe', function(w) { w.render({ replace : '#placeholder' }); })</script> Institution so instead of rendering the widget you render a placeholder dom element and a script tag that loads the widget with an ajax request and then renders it on the client side
  65. if you look at your widget tree you can mostly

    identify larger parts, which are widgets itself
  66. Profile Menu Header LeftColumn RightColumn like this, so what you

    can do to dramatically increase the perceived load time is prioritizing the rendering
  67. so our http request looks like this, first you compute

    and render the important parts of the page, like the top menu and the profile header as well as the rest of the layout, for the left column and right column which are expensive to compute you just render placeholders and then flush the content to the client so that the browser already renders this
  68. still in the same http request you render out the

    javascript needed to make the already rendered components work, so people can use the menu for example
  69. still in the same http request you then compute the

    data for the left column and render out some javascript that takes this data and renders it into the components template client side and then replaces the placeholder with the rendered template
  70. still in the same request you then can do this

    with the right column -> flush content as early as possible, don't wait for the whole site to be computed
  71. pushState and if you are at that, when you switch

    pages, you can also just load the differences between and use pushState to change the url (if supported) to make your app faster