Structuring large code bases with small re-usable components

Slide 1

Slide 1 text

Structuring a large code base with re-usable components @BastianHofmann

Slide 2

Slide 2 text

Let's talk about...

Slide 3

Slide 3 text

Web Application architecture

Slide 4

Slide 4 text

Handling large code-bases

Slide 5

Slide 5 text

Code and component re-use

Slide 6

Slide 6 text

Rapid Development

Slide 7

Slide 7 text

webserver HTML browser JS

Slide 8

Slide 8 text

webserver HTML browser JS Ajax

Slide 9

Slide 9 text

webserver HTML browser JS Ajax

Slide 10

Slide 10 text

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

Slide 11

Slide 11 text

A few words about me

Slide 12

Slide 12 text

No content

Slide 13

Slide 13 text

No content

Slide 14

Slide 14 text

No content

Slide 15

Slide 15 text

No content

Slide 16

Slide 16 text

No content

Slide 17

Slide 17 text

No content

Slide 18

Slide 18 text

No content

Slide 19

Slide 19 text

Questions? Ask

Slide 20

Slide 20 text

http://speakerdeck.com/u/bastianhofmann

Slide 21

Slide 21 text

No content

Slide 22

Slide 22 text

webserver loadbalancer pgsql memcached mongodb services

Slide 23

Slide 23 text

webserver

Slide 24

Slide 24 text

status quo

Slide 25

Slide 25 text

No content

Slide 26

Slide 26 text

PHP

Slide 27

Slide 27 text

MVC

Slide 28

Slide 28 text

PHP templates

Slide 29

Slide 29 text

Duplication and only some Code re- use

Slide 30

Slide 30 text

We can do better

Slide 31

Slide 31 text

Components

Slide 32

Slide 32 text

No content

Slide 33

Slide 33 text

No content

Slide 34

Slide 34 text

No content

Slide 35

Slide 35 text

No content

Slide 36

Slide 36 text

No content

Slide 37

Slide 37 text

No content

Slide 38

Slide 38 text

No content

Slide 39

Slide 39 text

No content

Slide 40

Slide 40 text

Self contained

Slide 41

Slide 41 text

Can be addressed and rendered separately

Slide 42

Slide 42 text

Server JS Browser JSON HTML HTML

Slide 43

Slide 43 text

No content

Slide 44

Slide 44 text

PHP controller is part of the component

Slide 45

Slide 45 text

JS is part of the component

Slide 46

Slide 46 text

CSS can be part of the component

Slide 47

Slide 47 text

Share code between server and client

Slide 48

Slide 48 text

Templates, Validation, Entities,...

Slide 49

Slide 49 text

It needs to be fast

Slide 50

Slide 50 text

PHP Controller Mustache Template JavaScript view class Widget Providing data Handling browser events Displaying data CSS

Slide 51

Slide 51 text

No content

Slide 52

Slide 52 text

Proﬁle Publications Publication Publication Publication AboutMe LeftColumn Image Institution Menu

Slide 53

Slide 53 text

Proﬁle Publications Publication Publication Publication AboutMe LeftColumn Image Menu Server Request Response Institution

Slide 54

Slide 54 text

LeftColumn Image Menu Server Request Response

Slide 55

Slide 55 text

Proﬁle Publications Publication Publication Publication AboutMe LeftColumn Image Institution Menu

Slide 56

Slide 56 text

Widget Requirement

Slide 57

Slide 57 text

Proﬁle Publications Publication Publication Publication AboutMe LeftColumn Image Menu Institution

Slide 58

Slide 58 text

Proﬁle Publications Publication Publication Publication AboutMe LeftColumn Image Menu Institution

Slide 59

Slide 59 text

Proﬁle Publications Publication Publication Publication AboutMe LeftColumn Image Menu Institution

Slide 60

Slide 60 text

Remember: self contained

Slide 61

Slide 61 text

Do not fetch data directly

Slide 62

Slide 62 text

Sssssssllllooooowww

Slide 63

Slide 63 text

Proﬁle Publications Publication Publication Publication AboutMe LeftColumn Image Menu Account Account Account Account Account Publication1 Publication2 Publication3 Institution

Slide 64

Slide 64 text

Require stuff

Slide 65

Slide 65 text

http://www.infoq.com/presentations/Evolution-of-Code- Design-at-Facebook/

Slide 66

Slide 66 text

No content

Slide 67

Slide 67 text

Widget Widget Widget Widget Preparer Resolver Resolver Services Connector Interfaces Connector Implementations

Slide 68

Slide 68 text

Widget Widget Widget Widget Preparer Fetch Requirements Resolver Resolver Services Connector Interfaces Connector Implementations

Slide 69

Slide 69 text

Widget Widget Widget Widget Preparer Resolver Resolver Services Connector Interfaces Connector Implementations Batch requirements and pass them to resolvers

Slide 70

Slide 70 text

Widget Widget Widget Widget Preparer Resolver Resolver Services Connector Interfaces Connector Implementations Call Services as effective as possible (Multi-GET,...)

Slide 71

Slide 71 text

Widget Widget Widget Widget Preparer Resolver Resolver Services Connector Interfaces Connector Implementations Attach fetched data to Requirements and pass them back to the preparer

Slide 72

Slide 72 text

Widget Widget Widget Widget Preparer Resolver Resolver Services Connector Interfaces Connector Implementations Distribute fetched data to the widgets that required it

Slide 73

Slide 73 text

public function collect() {  return [  new EntityRequirement(  'account',  Account::class,  ['id' => $this->request->get('id')]  ),  ];  }

Slide 74

Slide 74 text

Request Cache

Slide 75

Slide 75 text

Multi-GET

Slide 76

Slide 76 text

Futures

Slide 77

Slide 77 text

Data dependencies within a widget

Slide 78

Slide 78 text

=> Callbacks

Slide 79

Slide 79 text

public function collect() {  yield [  new EntityRequirement(  'account',  Account::class,  ['id' => $this->request->get('id')]  ),  ];    yield [  new ServiceRequirement(  'scienceDisciplines',  AccountService::class,  'getScienceDisciplines',  ['account' => $this->account]  )  ];  }

Slide 80

Slide 80 text

Data dependencies between Widgets

Slide 81

Slide 81 text

Proﬁle Publications Publication Publication Publication AboutMe LeftColumn Image Menu Institution

Slide 82

Slide 82 text

Prefills

Slide 83

Slide 83 text

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 ]  );  }  } 

Slide 84

Slide 84 text

class PublicationItem {    public $publicationId;  public $publication;    public function collect() {  yield new RequestDataRequirement('publicationId');  yield [  new EntityRequirement(  'publication',  Publication::class,  ['id' => $this->publicationId]  )  ];  }  }

Slide 85

Slide 85 text

Whoa, this looks awfully complicated to debug

Slide 86

Slide 86 text

No content

Slide 87

Slide 87 text

No content

Slide 88

Slide 88 text

No content

Slide 89

Slide 89 text

No content

Slide 90

Slide 90 text

No content

Slide 91

Slide 91 text

So that was the backend

Slide 92

Slide 92 text

No content

Slide 93

Slide 93 text

Rendering

Slide 94

Slide 94 text

HTML

Slide 95

Slide 95 text

JSON

Slide 96

Slide 96 text

Templates

Slide 97

Slide 97 text

Mustache } http://mustache.github.com/

Slide 98

Slide 98 text

  Publications     ({{count}})   

{{{.}}}

  {{#showLegalFooter}}  {{{legalFooter}}}  {{/showLegalFooter}} 

Slide 99

Slide 99 text

http://pecl.php.net/package/v8js V8js

Slide 100

Slide 100 text

JavaScript

Slide 101

Slide 101 text

WidgetViews

Slide 102

Slide 102 text

  Publications     ({{count}})   

{{{.}}}

  {{#showLegalFooter}}  {{{legalFooter}}}  {{/showLegalFooter}} 

Slide 103

Slide 103 text

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  });  });  }  });  });

Slide 104

Slide 104 text

http://twitter.github.io/ﬂight/

Slide 105

Slide 105 text

http://facebook.github.io/react/

Slide 106

Slide 106 text

http://www.youtube.com/watch?v=fqULJBBEVQE

Slide 107

Slide 107 text

http://www.polymer-project.org/

Slide 108

Slide 108 text

    This is {{owner}}'s tk-element.  Not ready...      Polymer('tk-element', {  owner: "Bastian",  color: "red",  ready: function() {  this.$.el.innerText = this.owner + " is ready!";  }  });   

Slide 109

Slide 109 text

Slide 110

Slide 110 text

Benefits

Slide 111

Slide 111 text

Enables developers to only focus on their components

Slide 112

Slide 112 text

Rapid prototyping

Slide 113

Slide 113 text

Easier Refactoring

Slide 114

Slide 114 text

Error Handling

Slide 115

Slide 115 text

Proﬁle Publications Publication Publication Publication AboutMe LeftColumn Image Menu Institution

Slide 116

Slide 116 text

Proﬁle Publications Publication Publication Publication AboutMe LeftColumn Image Menu EXCEPTION Institution

Slide 117

Slide 117 text

Proﬁle Publications Publication Publication Publication LeftColumn Image Menu Institution

Slide 118

Slide 118 text

Experiments (A/B Testing)

Slide 119

Slide 119 text

No content

Slide 120

Slide 120 text

Caching of Components

Slide 121

Slide 121 text

Proﬁle Publications Publication Publication Publication AboutMe LeftColumn Image Menu Institution

Slide 122

Slide 122 text

Easy re-using of components

Slide 123

Slide 123 text

No content

Slide 124

Slide 124 text

Load components asynchronously

Slide 125

Slide 125 text

Proﬁle Publications Publication Publication Publication AboutMe LeftColumn Image Menu

loadWidget('/aboutMe', function(w) { w.render({ replace : '#placeholder' }); }) Institution

Slide 126

Slide 126 text

BigPipe https://www.facebook.com/note.php? note_id=389414033919

Slide 127

Slide 127 text

No content

Slide 128

Slide 128 text

Proﬁle Menu Header LeftColumn RightColumn

Slide 129

Slide 129 text

No content

Slide 130

Slide 130 text

No content

Slide 131

Slide 131 text

No content

Slide 132

Slide 132 text

No content

Slide 133

Slide 133 text

pushState

Slide 134

Slide 134 text

Proﬁle Publications Publication Publication Publication AboutMe LeftColumn Image Menu Institution

Slide 135

Slide 135 text

Proﬁle Questions Question Question Question AboutMe LeftColumn Image Menu Institution

Slide 136

Slide 136 text

Conclusion?

Slide 137

Slide 137 text

Think about your architecture

Slide 138

Slide 138 text

Refactor and make it better continuously

Slide 139

Slide 139 text

Frontend and backend are part of the same application

Slide 140

Slide 140 text

Don't rewrite your whole codebase in one go

Slide 141

Slide 141 text

http://twitter.com/BastianHofmann http://lanyrd.com/people/BastianHofmann http://speakerdeck.com/u/bastianhofmann ! [email protected]