Keeping Your Massive Rails App From Turning Into a S#!t Show (WindyCityRails 2013)

Slide 1

Slide 1 text

Keeping Your Massive Rails App From Turning Into a S#!t Show Thursday, September 12, 13

Slide 2

Slide 2 text

Keeping Your Massive Rails App From Turning Into a SNAKE Show Thursday, September 12, 13

Slide 3

Slide 3 text

Keeping Your Massive Rails App From Turning Into a SNAKE Show Thursday, September 12, 13

Slide 4

Slide 4 text

Keeping Your Massive Rails App From Turning Into a CYLON Show Thursday, September 12, 13

Slide 5

Slide 5 text

Keeping Your Massive Rails App From Turning Into a SHEEP Show Thursday, September 12, 13

Slide 6

Slide 6 text

gem “sheep” gem “sheepsafe” gem “sheep-sebastian” gem “SheepDog” Thursday, September 12, 13

Slide 7

Slide 7 text

gem “sheep” gem “sheepsafe” gem “sheep-sebastian” gem “SheepDog” Thursday, September 12, 13

Slide 8

Slide 8 text

Thursday, September 12, 13

Slide 9

Slide 9 text

Thursday, September 12, 13

Slide 10

Slide 10 text

Keeping Your Massive Rails App From Turning Into a S#!t Show Benjamin Smith Thursday, September 12, 13

Slide 11

Slide 11 text

Keeping Your Massive Rails App From Turning Into a S#!t Show Benjamin Smith Thursday, September 12, 13

Slide 12

Slide 12 text

Keeping Your Massive Rails App From Turning Into a S#!t Show Benjamin Smith Thursday, September 12, 13

Slide 13

Slide 13 text

Keeping Your Massive Rails App From Turning Into a S#!t Show Benjamin Smith @benjamin_smith Thursday, September 12, 13

Slide 14

Slide 14 text

Keeping Your Massive Rails App From Turning Into a S#!t Show By Architecting It For Success Benjamin Smith Success @benjamin_smith Thursday, September 12, 13

Slide 15

Slide 15 text

Benjamin Smith Success @benjamin_smith Thursday, September 12, 13

Slide 16

Slide 16 text

Benjamin Smith Success @benjamin_smith Thursday, September 12, 13

Slide 17

Slide 17 text

Benjamin Smith Success Architecting Rails @benjamin_smith Thursday, September 12, 13

Slide 18

Slide 18 text

M @benjamin_smith Thursday, September 12, 13

Slide 19

Slide 19 text

M V @benjamin_smith Thursday, September 12, 13

Slide 20

Slide 20 text

M C V @benjamin_smith Thursday, September 12, 13

Slide 21

Slide 21 text

once upon a time @benjamin_smith Thursday, September 12, 13

Slide 22

Slide 22 text

success Thursday, September 12, 13

Slide 23

Slide 23 text

long project Thursday, September 12, 13

Slide 24

Slide 24 text

big dev team Thursday, September 12, 13

Slide 25

Slide 25 text

lots of codez Thursday, September 12, 13

Slide 26

Slide 26 text

scalable Thursday, September 12, 13

Slide 27

Slide 27 text

big bang release Thursday, September 12, 13

Slide 28

Slide 28 text

success • long project • big dev team • lots of code • scalable • big 1st release @benjamin_smith Thursday, September 12, 13

Slide 29

Slide 29 text

a grain of salt @benjamin_smith Thursday, September 12, 13

Slide 30

Slide 30 text

a grain of salt @benjamin_smith Thursday, September 12, 13

Slide 31

Slide 31 text

success • long project • big dev team • lots of code • scalable • big 1st release @benjamin_smith Thursday, September 12, 13

Slide 32

Slide 32 text

engines Thursday, September 12, 13

Slide 33

Slide 33 text

a little background @benjamin_smith Thursday, September 12, 13

Slide 34

Slide 34 text

the product • Multimedia content publishing • A social network • iOS app for consumers (using JSON API) • CMS (Rails) for admins @benjamin_smith Thursday, September 12, 13

Slide 35

Slide 35 text

started simple @benjamin_smith Thursday, September 12, 13

Slide 36

Slide 36 text

Thursday, September 12, 13

Slide 37

Slide 37 text

Thursday, September 12, 13

Slide 38

Slide 38 text

Thursday, September 12, 13

Slide 39

Slide 39 text

Thursday, September 12, 13

Slide 40

Slide 40 text

Thursday, September 12, 13

Slide 41

Slide 41 text

Thursday, September 12, 13

Slide 42

Slide 42 text

Thursday, September 12, 13

Slide 43

Slide 43 text

Thursday, September 12, 13

Slide 44

Slide 44 text

Thursday, September 12, 13

Slide 45

Slide 45 text

not too bad Thursday, September 12, 13

Slide 46

Slide 46 text

Thursday, September 12, 13

Slide 47

Slide 47 text

Thursday, September 12, 13

Slide 48

Slide 48 text

Thursday, September 12, 13

Slide 49

Slide 49 text

Thursday, September 12, 13

Slide 50

Slide 50 text

Thursday, September 12, 13

Slide 51

Slide 51 text

Thursday, September 12, 13

Slide 52

Slide 52 text

Thursday, September 12, 13

Slide 53

Slide 53 text

Thursday, September 12, 13

Slide 54

Slide 54 text

Thursday, September 12, 13

Slide 55

Slide 55 text

but why stop there? @benjamin_smith Thursday, September 12, 13

Slide 56

Slide 56 text

Thursday, September 12, 13

Slide 57

Slide 57 text

Thursday, September 12, 13

Slide 58

Slide 58 text

Thursday, September 12, 13

Slide 59

Slide 59 text

Thursday, September 12, 13

Slide 60

Slide 60 text

Thursday, September 12, 13

Slide 61

Slide 61 text

Thursday, September 12, 13

Slide 62

Slide 62 text

Thursday, September 12, 13

Slide 63

Slide 63 text

how to get started Thursday, September 12, 13

Slide 64

Slide 64 text

rails plugin new engine_name --mountable @benjamin_smith Thursday, September 12, 13

Slide 65

Slide 65 text

gem "engine_name", path: "path/to/engine_name" @benjamin_smith Thursday, September 12, 13

Slide 66

Slide 66 text

mount EngineName::Engine => "/engine_name", :as => "engine_name" @benjamin_smith Thursday, September 12, 13

Slide 67

Slide 67 text

rails plugin new engine_name --mountable @benjamin_smith Thursday, September 12, 13

Slide 68

Slide 68 text

rails plugin new engine_template --mountable @benjamin_smith Thursday, September 12, 13

Slide 69

Slide 69 text

s/engine_template/new_engine_name/g s/EngineTemplate/NewEngineName/g for file in $(find . -name "*engine_template*") do mv $file ècho $file | sed s/engine_template/$1/` done @benjamin_smith Thursday, September 12, 13

Slide 70

Slide 70 text

bundle gem gem_name @benjamin_smith Thursday, September 12, 13

Slide 71

Slide 71 text

gem "gem_name", path: "path/to/gem_name" @benjamin_smith Thursday, September 12, 13

Slide 72

Slide 72 text

bundle gem gem_template s/gem_template/new_gem_name/g s/GemTemplate/NewGemName/g for file in $(find . -name "*gem_template*") do mv $file ècho $file | sed s/gem_template/$1/` done @benjamin_smith Thursday, September 12, 13

Slide 73

Slide 73 text

got it? got it? Thursday, September 12, 13

Slide 74

Slide 74 text

engines the right way Thursday, September 12, 13

Slide 75

Slide 75 text

fully contained engines • all tables namespaced • migrations • tests @benjamin_smith Thursday, September 12, 13

Slide 76

Slide 76 text

table namespacing @benjamin_smith Thursday, September 12, 13

Slide 77

Slide 77 text

Thursday, September 12, 13

Slide 78

Slide 78 text

Thursday, September 12, 13

Slide 79

Slide 79 text

Thursday, September 12, 13

Slide 80

Slide 80 text

Thursday, September 12, 13

Slide 81

Slide 81 text

Thursday, September 12, 13

Slide 82

Slide 82 text

migrations inside engines @benjamin_smith Thursday, September 12, 13

Slide 83

Slide 83 text

rake your_engine_name:install:migrations @benjamin_smith Thursday, September 12, 13

Slide 84

Slide 84 text

module EngineWithMigrations class Engine < ::Rails::Engine isolate_namespace EngineWithMigrations initializer :append_migrations do |app| unless app.root.to_s.match root.to_s app.conﬁg.paths["db/migrate"] += conﬁg.paths["db/migrate"].expanded end end end end http://pivotallabs.com/leave-your-migrations-in-your-rails- engines/ Thursday, September 12, 13

Slide 85

Slide 85 text

one table per migration http://pivotallabs.com/moving-db-tables-between-rails- engines/ Thursday, September 12, 13

Slide 86

Slide 86 text

testing the engines in isolation @benjamin_smith Thursday, September 12, 13

Slide 87

Slide 87 text

Thursday, September 12, 13

Slide 88

Slide 88 text

engines the right way Thursday, September 12, 13

Slide 89

Slide 89 text

fully contained engines • all tables namespaced • migrations • tests @benjamin_smith Thursday, September 12, 13

Slide 90

Slide 90 text

no circular dependencies @benjamin_smith Thursday, September 12, 13

Slide 91

Slide 91 text

Thursday, September 12, 13

Slide 92

Slide 92 text

Thursday, September 12, 13

Slide 93

Slide 93 text

Thursday, September 12, 13

Slide 94

Slide 94 text

class User < ActiveRecord::Base has_many :posts end class Post < ActiveRecord::Base belongs_to :user end Thursday, September 12, 13

Slide 95

Slide 95 text

Thursday, September 12, 13

Slide 96

Slide 96 text

domain api Thursday, September 12, 13

Slide 97

Slide 97 text

domain api • simple classes to wrap ActiveRecord calls • take as input: params or ids • output PORO @benjamin_smith Thursday, September 12, 13

Slide 98

Slide 98 text

class UserManager def ﬁnd_by_id(id) User.new(UserRecord.ﬁnd(id)) end private class UserRecord < ActiveRecord::Base validates :email, presence: true end end Thursday, September 12, 13

Slide 99

Slide 99 text

class UserManager def ﬁnd_by_id(id) User.new(UserRecord.ﬁnd(id)) end private class UserRecord < ActiveRecord::Base validates :email, presence: true end end Thursday, September 12, 13

Slide 100

Slide 100 text

class UserManager def ﬁnd_by_id(id) User.new(UserRecord.ﬁnd(id)) end private class UserRecord < ActiveRecord::Base validates :email, presence: true end end Thursday, September 12, 13

Slide 101

Slide 101 text

class UserManager def ﬁnd_by_id(id) User.new(UserRecord.ﬁnd(id)) end private class UserRecord < ActiveRecord::Base validates :email, presence: true end end class User def initialize(user_record) self.email = user_record.email end end Thursday, September 12, 13

Slide 102

Slide 102 text

that’s a lie @benjamin_smith Thursday, September 12, 13

Slide 103

Slide 103 text

it’s called the Data Mapper pattern @benjamin_smith Thursday, September 12, 13

Slide 104

Slide 104 text

Thursday, September 12, 13

Slide 105

Slide 105 text

@user.posts @post.user Thursday, September 12, 13

Slide 106

Slide 106 text

class PostManager def ﬁnd_all_by_user_id(user_id) PostRecord.where(user_id: user_id) # ... convert to PORO ... end end Thursday, September 12, 13

Slide 107

Slide 107 text

class PostManager def ﬁnd_all_by_user_id(user_id) PostRecord.where(user_id: user_id) # ... convert to PORO ... end end post_manager = PostManager.new @posts = post_manager.ﬁnd_all_by_user_id(@user.id) Thursday, September 12, 13

Slide 108

Slide 108 text

Thursday, September 12, 13

Slide 109

Slide 109 text

Thursday, September 12, 13

Slide 110

Slide 110 text

class UserManager def ﬁnd_by_id(id) User.new(UserRecord.ﬁnd(id)) end end Thursday, September 12, 13

Slide 111

Slide 111 text

class UserManager def find_by_id(id) User.new(UserRecord.find(id)) end end user_manager = UserManager.new author = user_manager.find_by_id(@post.user_id) Thursday, September 12, 13

Slide 112

Slide 112 text

Thursday, September 12, 13

Slide 113

Slide 113 text

Thursday, September 12, 13

Slide 114

Slide 114 text

engines the right way Thursday, September 12, 13

Slide 115

Slide 115 text

no circular dependencies @benjamin_smith Thursday, September 12, 13

Slide 116

Slide 116 text

started simple Thursday, September 12, 13

Slide 117

Slide 117 text

Thursday, September 12, 13

Slide 118

Slide 118 text

I live my life one green build at a time Thursday, September 12, 13

Slide 119

Slide 119 text

Thursday, September 12, 13

Slide 120

Slide 120 text

Thursday, September 12, 13

Slide 121

Slide 121 text

Thursday, September 12, 13

Slide 122

Slide 122 text

git whatchanged origin/master.. @benjamin_smith Thursday, September 12, 13

Slide 123

Slide 123 text

Thursday, September 12, 13

Slide 124

Slide 124 text

how did it work out? Thursday, September 12, 13

Slide 125

Slide 125 text

Thursday, September 12, 13

Slide 126

Slide 126 text

engines are a pain... • LOW velocity for weeks (4-6) • client worries • opposite of Rails • one pair to start is a MUST • some technical hurtles • must be diligent about refactoring • monkey patching Rails @benjamin_smith Thursday, September 12, 13

Slide 127

Slide 127 text

Thursday, September 12, 13

Slide 128

Slide 128 text

... but they get better • no slow down in development time • they age well • easier parallel development • potential for scaling • smart and fast build scripts @benjamin_smith Thursday, September 12, 13

Slide 129

Slide 129 text

thumbs up @benjamin_smith Thursday, September 12, 13

Slide 130

Slide 130 text

Thursday, September 12, 13

Slide 131

Slide 131 text

class UserManager def ﬁnd_by_id(id) User.new(UserRecord.ﬁnd(id)) end private class UserRecord < ActiveRecord::Base validates :email, presence: true end end Thursday, September 12, 13

Slide 132

Slide 132 text

thanks Thursday, September 12, 13

Slide 133

Slide 133 text

more infoz: @benjamin_smith http://pivotallabs.com/tag/rails-application-suites/ https://github.com/benjaminleesmith/sup_locator Thursday, September 12, 13