This repository has been archived by the owner on Jul 11, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1
/
services.html
431 lines (247 loc) · 5.95 KB
/
services.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>soa</title>
<meta name="apple-mobile-web-app-capable" content="yes" />
<meta name="apple-mobile-web-app-status-bar-style" content="black-translucent" />
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no">
<link rel="stylesheet" href="lib/reveal.js/css/reveal.min.css">
<link rel="stylesheet" href="lib/reveal.js/css/theme/night.css">
<link rel="stylesheet" href="lib/template.css">
<!-- For syntax highlighting -->
<link rel="stylesheet" href="lib/reveal.js/lib/css/zenburn.css">
<!-- If the query includes 'print-pdf', include the PDF print sheet -->
<script>
if( window.location.search.match( /print-pdf/gi ) ) {
var link = document.createElement( 'link' );
link.rel = 'stylesheet';
link.type = 'text/css';
link.href = 'css/print/pdf.css';
document.getElementsByTagName( 'head' )[0].appendChild( link );
}
</script>
<!--[if lt IE 9]>
<script src="lib/reveal.js/lib/js/html5shiv.js"></script>
<![endif]-->
</head>
<body>
<div class="reveal">
<div class="slides" id="content">
<section data-markdown
data-separator="==="
data-vertical="---"><script type="text/template">
# Services
<br>
### An architectural proposition
===
## Services
> Services are unassociated, loosely coupled units of functionality that are self-contained.
<br>
Its a code **organization** pattern
---
### Key points
* Black boxes with public API
* Speak a standard language
* Isolated from each other
* Data AND/OR functionality
* (Bonus) re-usable
---
It's like developing / using internal apps with APIs
---
### SOA?
* Very broad term
* Enterprise connotations
===
## Isolation
---
* At the model / business / library layer
* We still need **dumb** controllers for
* Routing
* Orchestration
* Rendering
---
* Code is **not** shared
* Models are **not** shared
* Public interface that speaks primitives (JSON-able)
---
### Isolation levels
1. Code-level only
2. Self-hosted, shared database
3. Self hosted, different database
---
### However
You can (and should) call services from other services
===
## Advantages
---
### Robustness
* No side effects
* Fully tested
* Mockable
---
### Performance
* Caching-friendly
* Profilable / Optimizable
<br><small>code AND datastore</small>
* Horizontally scalable
---
### Process
* Handle growing teams
* Separately deployable
* Versionable
---
### Developer-friendly
* Can fit on one's head
* Allow tech experimentation
* Code ownership
===
## Caveats
---
* Services Orchestration
* Heavy functional changes
* Performance impact
===
# SOA in Rails
===
## Isolation
* Data AND/OR functionality
* Via modules
===
## The public API / client
* Most important part
* Static interface
* Speaks primitives or JSON
* RESTful better if applicable
---
```
Recommendations::Client.get_recommended_job_offers(
4, # The student's id
page: 2,
per_page: 5,
order: 'relevance',
filters: {
published_since: (Date.today - 1.week).to_i
}
)
=> {
status: 200,
response: {
total: 124,
offer_ids: [ 8543, 65978, 3244, 54756, 75732 ]
}
}
```
---
### Important bits
* Could be local or remote
* Could call other services or an internal store
* Could have been fetched synchronously or in a cache
* ** We don't care**
===
## Sample implementation
---
```bash
services
- recommendations
- client.rb
- doc.md
- lib
- cache
- models
- engine
- controller.rb
- presenter.rb
- specs
```
---
* client
* controller + presenter
* business (models / logic) + tests
---
### The client / mocks
* Only shared code
* Convert calls to requests
<br>
<small>Basically `to_json`</small>
* May issue / handle HTTP call
* Handles versioning
---
### The controller / presenter
* Route requests
* Parses params
* Format and sends response
---
### The business logic
* Namespaces so no conflicts
* No shared code with other services
* May have own models / datastore
===
## In more details
---
### What goes elsewhere?
* **core app**
* High-level logic
* Sessions handling
* Rendering
* **libs/gems**
* Shared technical dependencies
* **specs**
* Integration suite
---
### What about shared models?
* **A.** Extract in a separate service
* **B.** Split into private sub-models
* **C.** Just use ids and manual joins
* Use hooks for callbacks
===
### Presenter?
> Have a **single** representation for resources returned by data services
* easier to use
* easier to mock
* easier to cache
===
## Tools
* VCR
* HTTParty / typhoeus
* Draper
* Sinatra
* fdoc / swagger / ... (?)
===
# SOA @ jobteaser
===
### Graceful introduction
1. New code in a client
2. Spec it fully
3. Move existing code by pieces
4. Finish last touches
5. Deploy it separately
---
### Services
* Auth / SSO
* Student Preferences
* Job Offers / Events
* Mailing cycle
* Permissions
* ...
---
### Core App
* Sessions
* App configuration (intranet)
* Templates (logic-less)
===
### Read more
* Service-Oriented Design with Ruby on Rails
* [Soundcloud story](https://developers.soundcloud.com/blog/building-products-at-soundcloud-part-1-dealing-with-the-monolith)
* [Songkick story](http://devblog.songkick.com/2012/08/30/the-client-side-of-soa)
* [Square story (YT)](https://www.youtube.com/watch?v=6mesJxUVZyI)
* [Arkency story](http://blog.arkency.com/2013/12/rails-and-soa-do-i-really-need-to-have-this-big-app/)
</script></section>
</div>
</div>
<script src="lib/reveal.js/lib/js/head.min.js"></script>
<script src="lib/reveal.js/js/reveal.min.js"></script>
<script src="lib/jquery/dist/jquery.min.js"></script>
<script src="config.js"></script>
</body>
</html>