-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathindex.html
559 lines (452 loc) · 16.2 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
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
<!DOCTYPE html>
<html lang="" xml:lang="">
<head>
<title>{shinyValidator}: toward a new audit process for Shiny apps quality through CI/CD</title>
<meta charset="utf-8" />
<meta name="author" content="SCC" />
<meta name="date" content="2022-04-29" />
<script src="assets/libs/header-attrs/header-attrs.js"></script>
<link href="assets/libs/tile-view/tile-view.css" rel="stylesheet" />
<script src="assets/libs/tile-view/tile-view.js"></script>
<script src="assets/libs/clipboard/clipboard.min.js"></script>
<link href="assets/libs/shareon/shareon.min.css" rel="stylesheet" />
<script src="assets/libs/shareon/shareon.min.js"></script>
<link href="assets/libs/xaringanExtra-shareagain/shareagain.css" rel="stylesheet" />
<script src="assets/libs/xaringanExtra-shareagain/shareagain.js"></script>
<link href="assets/libs/xaringanExtra-clipboard/xaringanExtra-clipboard.css" rel="stylesheet" />
<script src="assets/libs/xaringanExtra-clipboard/xaringanExtra-clipboard.js"></script>
<script>window.xaringanExtraClipboard(null, {"button":"Copy Code","success":"Copied!","error":"Press Ctrl+C to Copy"})</script>
<link href="assets/libs/tachyons/tachyons.min.css" rel="stylesheet" />
<script src="assets/libs/xaringanExtra_fit-screen/fit-screen.js"></script>
<link href="assets/libs/panelset/panelset.css" rel="stylesheet" />
<script src="assets/libs/panelset/panelset.js"></script>
<link href="assets/libs/xaringanExtra-extra-styles/xaringanExtra-extra-styles.css" rel="stylesheet" />
<link href="assets/libs/js4shiny/css/_variables-fonts.css" rel="stylesheet" />
<link href="assets/libs/js4shiny/css/_variables.css" rel="stylesheet" />
<link href="assets/libs/js4shiny/css/code.css" rel="stylesheet" />
<link href="assets/libs/js4shiny/jsonview/jsonview.css" rel="stylesheet" />
<script src="assets/libs/js4shiny/jsonview/jsonview.min.js"></script>
<link href="assets/libs/js4shiny-redirectConsoleLog/jslog.css" rel="stylesheet" />
<script src="assets/libs/js4shiny-redirectConsoleLog/redirectConsoleLog.js"></script>
<link rel="stylesheet" href="assets/css/js4shiny-xaringan-base.css" type="text/css" />
<link rel="stylesheet" href="assets/css/tachyons.min.css" type="text/css" />
<link rel="stylesheet" href="assets/css/js4shiny-xaringan-extra.css" type="text/css" />
<link rel="stylesheet" href="assets/css/custom.css" type="text/css" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap@5.0.1/dist/css/bootstrap.min.css" type="text/css" />
</head>
<body>
<textarea id="source">
class: inverse, center, title-slide, middle
## {shinyValidator}: toward a new audit process for Shiny apps quality through CI/CD
###### AppsilonConf 2022 Apr 29
.flex.tc[
.w-30.mr3.center[
<img class="br-100" width="100px" height="100px" src="assets/images/jpeg/david.jpeg" class="svg-img"/>
<br>
.f5[David Granjon]
.small[Senior Expert Data Scientist]
]
]
---
class: header_background
# <img src="assets/images/svg/shiny.svg" width="5%" style="display: inline; margin: auto;" class="svg-img"/> apps may look amazing ...
<br/>
`{Shiny}` is about __10__ years old 😲😲😲.
--
Today, many tools can make your apps __shining__...
.center[
<img src="assets/images/jpeg/outstanding-shiny.jpg" width="20%" />
]
---
class: header_background
# Clothes don't make the man
<br/>
Yet ... too many __unexplained__ syndromes:
--
- The well known "It worked for me ... but not for you" 🤷♀️
- The famous "It was fine yesterday" 😎
- And many others...
---
class: header_background
# Clothes don't make the man
<br/>
.center[
<img src="assets/images/svg/404.svg" width="40%" style="display: block; margin: auto;" class="svg-img"/>
]
Your app may be as beautiful and as cool as you want, it is __useless__ if it does not start/run.
---
class: header_background
# Most Shiny apps are "just" prototypes
<br/>
Why is my app not starting/running ❓
--
Possible answers:
- __Quickly__ developed, no planning 😱
- No code quality __management__ 😱
- No __tests__ 😱
- ...
--
This must stop 😈!
---
class: header_background
# About software validation
<br/>
Check that a product is __conform__ to initial __requirements__ (Software engineering).
--
For Shiny apps:
- __Reliability__: is the app doing what it is intended to do?
- __Stability__: how often does it crash?
- __Performance/Availability__: is the app fast enough to handle multiple concurrent users?
--
In practice, a few apps meet all these requirements 😈.
How do we transition from __prototypes__ to __production-ready__ tools ❓
---
class: inverse center middle title-slide-without-bg title-slide
# 1. Production Ready Shiny Apps
<img src="assets/images/jpeg/engineering-shiny.jpg" width="20%" style="display: block; margin: auto;" />
---
class: header_background
# Consolidate Shiny apps projects
<br/>
.panelset[
.panel[.panel-name[Package your app]
.center[
<img src="assets/images/svg/golem.svg" width="10%" style="display: block; margin: auto;" class="svg-img"/>
]
- Easier checking, linting, documentation and testing.
- Just ... __easier__. 😀
]
.panel[.panel-name[Manage your __dependencies__]
.center[
<img src="assets/images/svg/renv.svg" width="10%" style="display: block; margin: auto;" class="svg-img"/>
]
- Fix package versions.
- Increased __reproducibility__.
]
.panel[.panel-name[__Test__ your code]
.center[
<img src="assets/images/svg/testthat.svg" width="10%" style="display: inline; margin: auto;" class="svg-img"/>
]
- Unit tests: test business logic.
- Server testing: test how Shiny modules or pieces work together (with reactivity).
- UI testing: test UI components, snapshots, headless-testing (`{shinytest2}`).
]
.panel[.panel-name[Optimize]
Are there bottlenecks?
- __Load__ testing: How does the app behave with 10 simultaneous user? `{shinyloadtest}`.
- __Profiling__: What part of my app is slow?`{profvis}`.
- Reactivity: Are there any reactivity issues? <img src="assets/images/svg/reactlog.svg" width="10%" style="display: inline; margin: auto;" class="svg-img"/>.
]
]
---
class: header_background
# Stop ... I am lost ...
<br>
.center[
<img src="assets/images/svg/sad.svg" width="40%" style="display: block; margin: auto;" class="svg-img"/>
]
- There are just so many tools! How to use them properly?
- Is there a way to __automate__ all of this? I just don't have time ... 😞
---
class: inverse center middle title-slide-without-bg title-slide
# 3. Leveraging CI/CD
---
class: header_background
# What, why and how?
<br>
.panelset[
.panel[.panel-name[What]
- Continuous integration: automatically __check__ new features. 🏥
- Continuous deployment: automatically __deploy__ content. ✉️
- Running on a __remote__ environment ☁️:
- [Github Actions](https://github.com/features/actions).
- [Jenkins](https://www.jenkins.io/).
- [Gitlab CI/CD](https://docs.gitlab.com/ee/ci/).
]
.panel[.panel-name[Benefits]
- __Automated__.
- More __reproducible__ (more os/R flavors available).
- __Time saver__.
- Less duplication.
]
.panel[.panel-name[How?]
Not easy 😢
- Select __DevOps__ platform (GitLab, GitHub, ...).
- Add __version control__ (git knowledge).
- Build custom GitLab runner (optional).
- Write __CI/CD instructions__ (better support for GitHub).
- Enjoy ...
Can't we make things easier❓
]
]
---
class: inverse center middle title-slide-without-bg title-slide
# 4. Welcome {shinyValidator}
---
class: header_background
# {shinyValidator}
<br>
.panelset[
.panel[.panel-name[Purpose]
- __Eases__ Shiny Apps validation:
- __Provides__ plug and play CI/CD pipelines.
- __Lints__ and __checks__ the package code.
- Performs a Shiny app __crash test__.
- Displays __outputs__ differences: plots, htmlwidgets.
- Measure __performance__: load-test, profiling and reactivity checkup.
All is __integrated__ into a nice HTML report.
]
.panel[.panel-name[Requirements]
- Requires a __package__, especially with `{golem}`.
- Control R __dependencies__ with `{renv}`.
- Requires __git__ + remote repository.
- Have __unit tests__.
]
.panel[.panel-name[Setup]
- Install it:
.small[
```r
remotes::install_github("Novartis/shinyValidator")
```
]
- Run `use_validator("github")` (for Github Actions).
- `devtools::document()`.
- Run `renv::snapshot()` to capture dependencies.
- Commit, push and enjoy. 🚀
]
]
---
class: header_background
# {shinyValidator}: audit app
<br>
`audit_app()` main package function:
.pull-left.small[
```r
audit_app(
timeout = 5,
headless_actions = NULL,
workers = 5,
scope = c("DMC", "POC"),
output_validation = TRUE,
coverage = TRUE,
load_testing = TRUE,
profile_code = TRUE,
check_reactivity = TRUE,
flow = TRUE
)
```
]
.pull-right[
<img src="assets/images/png/shinyValidator.png" width="100%" />
]
---
class: header_background
# Live Demo
<br>
Because a demo is better than 30 slides.
---
class: header_background
# Thanks 🙏🏻
<br>
- Barret Schloerke (RStudio).
- Peter Krusche (Novartis).
- Lucas Widmer (Novartis).
- Janice Branson (Novartis).
- Technology & Innovation Team (Novartis): Aleks, Bo, Marie, Dave, David, Mustapha, Ardalan, Bill and Stefan.
- Christophe Dervieux (RStudio).
- Sebastien Rochette (ThinkR).
- Romain Lesur (Insee).
- Katerina Limpitsouni (unDraw, illustrations).
---
# Follow me
<br>
- <img src="assets/images/svg/twitter.svg" width="5%" style="display: inline; margin: auto;" class="svg-img"/> [Twitter](https://twitter.com/divadnojnarg).
- <img src="assets/images/svg/github.svg" width="5%" style="display: inline; margin: auto;" class="svg-img"/> [Github](https://github.com/DivadNojnarg).
</textarea>
<style data-target="print-only">@media screen {.remark-slide-container{display:block;}.remark-slide-scaler{box-shadow:none;}}</style>
<script src="assets/js/remark-latest.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/jquery@3.6.0/dist/jquery.min.js"></script>
<script src="assets/js/custom.js"></script>
<script>var slideshow = remark.create({
"ratio": "16:9",
"slideNumberFormat": "%current%",
"highlightStyle": "docco",
"highlightLines": true,
"countIncrementalSlides": false
});
if (window.HTMLWidgets) slideshow.on('afterShowSlide', function (slide) {
window.dispatchEvent(new Event('resize'));
});
(function(d) {
var s = d.createElement("style"), r = d.querySelector(".remark-slide-scaler");
if (!r) return;
s.type = "text/css"; s.innerHTML = "@page {size: " + r.style.width + " " + r.style.height +"; }";
d.head.appendChild(s);
})(document);
(function(d) {
var el = d.getElementsByClassName("remark-slides-area");
if (!el) return;
var slide, slides = slideshow.getSlides(), els = el[0].children;
for (var i = 1; i < slides.length; i++) {
slide = slides[i];
if (slide.properties.continued === "true" || slide.properties.count === "false") {
els[i - 1].className += ' has-continuation';
}
}
var s = d.createElement("style");
s.type = "text/css"; s.innerHTML = "@media print { .has-continuation { display: none; } }";
d.head.appendChild(s);
})(document);
// delete the temporary CSS (for displaying all slides initially) when the user
// starts to view slides
(function() {
var deleted = false;
slideshow.on('beforeShowSlide', function(slide) {
if (deleted) return;
var sheets = document.styleSheets, node;
for (var i = 0; i < sheets.length; i++) {
node = sheets[i].ownerNode;
if (node.dataset["target"] !== "print-only") continue;
node.parentNode.removeChild(node);
}
deleted = true;
});
})();
(function() {
"use strict"
// Replace <script> tags in slides area to make them executable
var scripts = document.querySelectorAll(
'.remark-slides-area .remark-slide-container script'
);
if (!scripts.length) return;
for (var i = 0; i < scripts.length; i++) {
var s = document.createElement('script');
var code = document.createTextNode(scripts[i].textContent);
s.appendChild(code);
var scriptAttrs = scripts[i].attributes;
for (var j = 0; j < scriptAttrs.length; j++) {
s.setAttribute(scriptAttrs[j].name, scriptAttrs[j].value);
}
scripts[i].parentElement.replaceChild(s, scripts[i]);
}
})();
(function() {
var links = document.getElementsByTagName('a');
for (var i = 0; i < links.length; i++) {
if (/^(https?:)?\/\//.test(links[i].getAttribute('href'))) {
links[i].target = '_blank';
}
}
})();
// adds .remark-code-has-line-highlighted class to <pre> parent elements
// of code chunks containing highlighted lines with class .remark-code-line-highlighted
(function(d) {
const hlines = d.querySelectorAll('.remark-code-line-highlighted');
const preParents = [];
const findPreParent = function(line, p = 0) {
if (p > 1) return null; // traverse up no further than grandparent
const el = line.parentElement;
return el.tagName === "PRE" ? el : findPreParent(el, ++p);
};
for (let line of hlines) {
let pre = findPreParent(line);
if (pre && !preParents.includes(pre)) preParents.push(pre);
}
preParents.forEach(p => p.classList.add("remark-code-has-line-highlighted"));
})(document);</script>
<script>
(function (d) {
d.addEventListener('DOMContentLoaded', function () {
// find code chunks that get special colors
const langSpecial = ['r', 'js', 'yaml', 'json', 'bash']
const codeSpecial = d.querySelectorAll(langSpecial.map(l => 'pre code.' + l))
// find code chunks with highlighted lines
const hlines = d.querySelectorAll('.remark-code-line-highlighted')
const preHLParents = []
const findPreParent = function (line, p = 0) {
if (p > 1) return null // traverse up no further than grandparent
const el = line.parentElement
if (el.tagName === 'PRE') {
return el
} else {
return findPreParent(el, ++p)
}
}
// add the code language to the parent <pre> element
for (const code of codeSpecial) {
const pre = findPreParent(code)
const codeLang = code.className.split(' ').filter(c => langSpecial.includes(c))
pre.classList += ` ${codeLang}`
}
// add remark-code-has-line-highlighted to parent <pre> element
for (const line of hlines) {
const pre = findPreParent(line)
if (pre && !preHLParents.includes(pre)) {
preHLParents.push(pre)
}
}
preHLParents.forEach(p => p.classList.add('remark-code-has-line-highlighted'))
})
})(document)
</script>
<style>
.remark-code-has-line-highlighted .remark-code-line:not(.remark-code-line-highlighted) {
opacity: 0.4;
}
.remark-code-line-highlighted {
background-color: inherit; /* Override highlight color */
/* font-weight: 500; */
}
/* Line Hover Indicator */
.remark-code-line:hover {
font-weight: bold;
opacity: 1 !important;
}
.remark-code-line:hover:before {
content: "\25B6";
color: #6d7e8a;
position: absolute;
transform: translateX(-1.2em);
animation: hover 0.66s alternate 8 cubic-bezier(0.445, 0.05, 0.55, 0.95);
}
@keyframes hover {
0% {
transform: translateX(-1.2em);
}
100% {
transform: translateX(-1.5em);
}
}
</style>
<script>
slideshow._releaseMath = function(el) {
var i, text, code, codes = el.getElementsByTagName('code');
for (i = 0; i < codes.length;) {
code = codes[i];
if (code.parentNode.tagName !== 'PRE' && code.childElementCount === 0) {
text = code.textContent;
if (/^\\\((.|\s)+\\\)$/.test(text) || /^\\\[(.|\s)+\\\]$/.test(text) ||
/^\$\$(.|\s)+\$\$$/.test(text) ||
/^\\begin\{([^}]+)\}(.|\s)+\\end\{[^}]+\}$/.test(text)) {
code.outerHTML = code.innerHTML; // remove <code></code>
continue;
}
}
i++;
}
};
slideshow._releaseMath(document);
</script>
<!-- dynamically load mathjax for compatibility with self-contained -->
<script>
(function () {
var script = document.createElement('script');
script.type = 'text/javascript';
script.src = 'https://mathjax.rstudio.com/latest/MathJax.js?config=TeX-MML-AM_CHTML';
if (location.protocol !== 'file:' && /^https?:/.test(script.src))
script.src = script.src.replace(/^https?:/, '');
document.getElementsByTagName('head')[0].appendChild(script);
})();
</script>
</body>
</html>