-
Notifications
You must be signed in to change notification settings - Fork 1
/
index.html
422 lines (276 loc) · 6.79 KB
/
index.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
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<meta name="keywords" content="remark,remarkjs,markdown,slideshow,presentation" />
<meta name="description" content="A simple, in-browser, markdown-driven slideshow tool." />
<title>Quiver.js - A New Server-side Component Architecture</title>
<link rel="stylesheet" href="stylesheet.css" type="text/css" />
</head>
<body>
<textarea id="source">
name: inverse
layout: true
class: center, middle, inverse
---
#Quiver.js
A New Server-side Component Architecture
![Quiver Icon](images/quiver-icon.png)
.footnote[By [Soares Chen](http://github.com/soareschen)]
---
layout: false
# Introduction to Quiver
.center[
![Quiver Cover](images/quiver-model.jpg)
]
- Component-based architecture
- Server-side applications
- Implemented in Node
---
# Coding in Quiver
.center[
![Quiver Craft](images/quiver-craft.png)
]
- Code organized as small and reusable components
- Functions with standardized signatures
- JSON-like component definition
---
# Related Works
- Concepts and best practices other systems
- REST Architecture
- Unix Philosophy
- Functional Programming
---
# Architecture Overview
.center[
![Architecture Layers](images/layers.png)
]
- Six layers of constructs
- Current focus: stream handler and filter
---
# Stream Handler
.center[
![Stream Handler](images/stream-handler-1.png)
]
- Accept a key-value object `args`
- Accept a stream-like object `streamable`
- Asynchronously return a stream-like object
---
# Example Hello Handler
```javascript
var helloHandler = function(args, callback) {
callback(null, 'Hello World!')
}
exports.quiverComponents = [
{
name: 'demo hello handler',
type: 'simple handler',
inputType: 'void',
outputType: 'text',
handler: helloHandler
}
]
```
---
# Image Thumbnail Server
.left-column[
- Create a simple HTTP server
- Static image files
- Resize on the fly
- Quiver's approach
- Reuse existing components
- Code has no knowledge of image manipulation
]
.right-column[
![Quiver back](images/quiver-back.png)
]
---
# Step #1: Static File Server
.center[
![File Handler](images/file-handler.png)
]
- npm install `quiver-file-component`
- run `quiver file directory handler` component
---
# Quiver Server
- npm install -g `quiver-server`
- Wrapper tool to run a handler component as HTTP server
- Require a config.js or config.json file
```javascript
var path = require('path')
module.exports = {
dirPath: path.join(__dirname, 'static')
}
```
```bash
$ quiver-server . --config ./config.js --main \
'quiver file directory handler'
```
---
# Image Conversion
.center[
![Image Conversion Pipeline](images/pipeline-1.png)
]
- Form a image conversion pipeline
- Second component: `resize image handler`
- Whole pipeline as component: `image thumbnail handler`
---
# ImageMagick
- Image conversion not done in JS
- Use ImageMagick's `convert` command
```bash
$ convert in.jpg -resize 200 out.jpg
```
- Doc: http://www.imagemagick.org/script/convert.php
---
# Command Handler
- npm install `quiver-command-component`
- Resize image handler extends from `file convert command handler`
- Generic handler for running any file conversion command
- Handler perform implicit conversion
1. Input stream to file
2. Execute Command
3. Output file to stream
---
# Command Args Extractor
.center[
<img src="images/command-args.png" style="width:50%">
]
- Handler need to know how to execute command
- Supply a `commandArgsExtractor` function to specify the command
---
# Image Convert Component
```javascript
{
name: 'demo resize image handler',
type: 'stream handler',
configOverride: {
commandArgsExtractor:
function(args, inFile, outFile) { ... },
},
resultContentType: 'image/jpeg',
handler: 'quiver file convert command handler'
}
```
- Customize existing component
- Supply custom configuration in `configOverride`
---
# Pipeline Component
```javascript
{
name: 'demo image thumbnail handler',
type: 'stream pipeline',
pipeline: [
'quiver file directory handler',
'demo resize image handler'
]
}
```
```bash
$ quiver-server . --config ./config.js --main \
'demo image thumbnail handler'
```
---
# Caching Resize Result
.center[
![Filter](images/filter-1.png)
]
- One issue remain
- Pipeline executed repeatedly
- Quiver has no implicit optimization
- Filter is the general solution
- Extends existing handler
- Intercept original input/output
---
# Cache Filter
.center[
![Filtered Pipeline](images/pipeline-2.png)
]
- Caching done outside the entire pipeline
- Result cached based on `args.path`
- Pipeline skipped if cached result available
---
# Final Thumbnail Component
```javascript
{
name: 'demo image thumbnail handler',
type: 'stream pipeline',
middlewares: [
'quiver memory cache filter'
],
pipeline: [
'quiver file directory handler',
'demo resize image handler'
]
}
```
- npm install `quiver-cache-component`
- 3 extra lines of code
- Filter is a subtype of middleware
---
# Component Reuse
.center[
![Quiver Cover](images/quiver-cover.png)
]
- Advantage of Quiver
- Smaller components can be recombined and reused
- Components run on both server and command line
---
# Image Resize
- Resize command
```bash
$ quiver-command . --main 'demo resize image handler' \
< static/images/blue-hat.jpg > temp/out.jpg
```
- Resize server
```bash
$ quiver-server . --main 'demo resize image handler'
$ curl http://localhost:8080 -X POST \
--data-binary @static/images/blue-hat.jpg > temp/out.jpg
```
---
# Proxy Pipeline
.center[
![Proxy Pipeline](images/proxy-pipeline.png)
]
- Horizontal scaling
---
# One Pattern, Unlimited Combination
- File + Image Resize + Memory Cache
- S3 + Audio Encode + Disk Cache
- Git + Compilation + CDN Cache
- Remote API + Template + Permission
---
name: inverse
class: center, middle, inverse
# Full Demo
![Quiver 3D](images/quiver-3d.jpg)
http://github.com/quiverjs/demo/02-format-convert
---
# Preview of All Constructs
.center[
![Quiver Constructs](images/constructs.png)
]
- True power of Quiver lies in more advanced constructs
- Quiver solves many other problems in web development
- Dependency management
---
# Thank you!
.center[
![Bring back quiver](images/bring-back-quiver.png)
]
- Slide available at http://quiverjs.github.io/slides-01
- Quiver.js Homepage: http://quiverjs.org
</textarea>
<script src="remark-latest.min.js" type="text/javascript"></script>
<script type="text/javascript">
var hljs = remark.highlighter.engine;
</script>
<script type="text/javascript">
var slideshow = remark.create({
highlightStyle: 'monokai',
highlightLanguage: 'remark'
}) ;
</script>
</body>
</html>