UNPKG

17.3 kBHTMLView Raw
1
2<!doctype html>
3<html lang="en">
4
5<head>
6 <title>Code coverage report for src/filesystem.ts</title>
7 <meta charset="utf-8" />
8 <link rel="stylesheet" href="../prettify.css" />
9 <link rel="stylesheet" href="../base.css" />
10 <link rel="shortcut icon" type="image/x-icon" href="../favicon.png" />
11 <meta name="viewport" content="width=device-width, initial-scale=1" />
12 <style type='text/css'>
13 .coverage-summary .sorter {
14 background-image: url(../sort-arrow-sprite.png);
15 }
16 </style>
17</head>
18
19<body>
20<div class='wrapper'>
21 <div class='pad1'>
22 <h1><a href="../index.html">All files</a> / <a href="index.html">src</a> filesystem.ts</h1>
23 <div class='clearfix'>
24
25 <div class='fl pad1y space-right2'>
26 <span class="strong">0% </span>
27 <span class="quiet">Statements</span>
28 <span class='fraction'>0/38</span>
29 </div>
30
31
32 <div class='fl pad1y space-right2'>
33 <span class="strong">0% </span>
34 <span class="quiet">Branches</span>
35 <span class='fraction'>0/29</span>
36 </div>
37
38
39 <div class='fl pad1y space-right2'>
40 <span class="strong">0% </span>
41 <span class="quiet">Functions</span>
42 <span class='fraction'>0/2</span>
43 </div>
44
45
46 <div class='fl pad1y space-right2'>
47 <span class="strong">0% </span>
48 <span class="quiet">Lines</span>
49 <span class='fraction'>0/34</span>
50 </div>
51
52
53 </div>
54 <p class="quiet">
55 Press <em>n</em> or <em>j</em> to go to the next uncovered block, <em>b</em>, <em>p</em> or <em>k</em> for the previous block.
56 </p>
57 </div>
58 <div class='status-line low'></div>
59 <pre><table class="coverage">
60<tr><td class="line-count quiet"><a name='L1'></a><a href='#L1'>1</a>
61<a name='L2'></a><a href='#L2'>2</a>
62<a name='L3'></a><a href='#L3'>3</a>
63<a name='L4'></a><a href='#L4'>4</a>
64<a name='L5'></a><a href='#L5'>5</a>
65<a name='L6'></a><a href='#L6'>6</a>
66<a name='L7'></a><a href='#L7'>7</a>
67<a name='L8'></a><a href='#L8'>8</a>
68<a name='L9'></a><a href='#L9'>9</a>
69<a name='L10'></a><a href='#L10'>10</a>
70<a name='L11'></a><a href='#L11'>11</a>
71<a name='L12'></a><a href='#L12'>12</a>
72<a name='L13'></a><a href='#L13'>13</a>
73<a name='L14'></a><a href='#L14'>14</a>
74<a name='L15'></a><a href='#L15'>15</a>
75<a name='L16'></a><a href='#L16'>16</a>
76<a name='L17'></a><a href='#L17'>17</a>
77<a name='L18'></a><a href='#L18'>18</a>
78<a name='L19'></a><a href='#L19'>19</a>
79<a name='L20'></a><a href='#L20'>20</a>
80<a name='L21'></a><a href='#L21'>21</a>
81<a name='L22'></a><a href='#L22'>22</a>
82<a name='L23'></a><a href='#L23'>23</a>
83<a name='L24'></a><a href='#L24'>24</a>
84<a name='L25'></a><a href='#L25'>25</a>
85<a name='L26'></a><a href='#L26'>26</a>
86<a name='L27'></a><a href='#L27'>27</a>
87<a name='L28'></a><a href='#L28'>28</a>
88<a name='L29'></a><a href='#L29'>29</a>
89<a name='L30'></a><a href='#L30'>30</a>
90<a name='L31'></a><a href='#L31'>31</a>
91<a name='L32'></a><a href='#L32'>32</a>
92<a name='L33'></a><a href='#L33'>33</a>
93<a name='L34'></a><a href='#L34'>34</a>
94<a name='L35'></a><a href='#L35'>35</a>
95<a name='L36'></a><a href='#L36'>36</a>
96<a name='L37'></a><a href='#L37'>37</a>
97<a name='L38'></a><a href='#L38'>38</a>
98<a name='L39'></a><a href='#L39'>39</a>
99<a name='L40'></a><a href='#L40'>40</a>
100<a name='L41'></a><a href='#L41'>41</a>
101<a name='L42'></a><a href='#L42'>42</a>
102<a name='L43'></a><a href='#L43'>43</a>
103<a name='L44'></a><a href='#L44'>44</a>
104<a name='L45'></a><a href='#L45'>45</a>
105<a name='L46'></a><a href='#L46'>46</a>
106<a name='L47'></a><a href='#L47'>47</a>
107<a name='L48'></a><a href='#L48'>48</a>
108<a name='L49'></a><a href='#L49'>49</a>
109<a name='L50'></a><a href='#L50'>50</a>
110<a name='L51'></a><a href='#L51'>51</a>
111<a name='L52'></a><a href='#L52'>52</a>
112<a name='L53'></a><a href='#L53'>53</a>
113<a name='L54'></a><a href='#L54'>54</a>
114<a name='L55'></a><a href='#L55'>55</a>
115<a name='L56'></a><a href='#L56'>56</a>
116<a name='L57'></a><a href='#L57'>57</a>
117<a name='L58'></a><a href='#L58'>58</a>
118<a name='L59'></a><a href='#L59'>59</a>
119<a name='L60'></a><a href='#L60'>60</a>
120<a name='L61'></a><a href='#L61'>61</a>
121<a name='L62'></a><a href='#L62'>62</a>
122<a name='L63'></a><a href='#L63'>63</a>
123<a name='L64'></a><a href='#L64'>64</a>
124<a name='L65'></a><a href='#L65'>65</a>
125<a name='L66'></a><a href='#L66'>66</a>
126<a name='L67'></a><a href='#L67'>67</a>
127<a name='L68'></a><a href='#L68'>68</a>
128<a name='L69'></a><a href='#L69'>69</a>
129<a name='L70'></a><a href='#L70'>70</a>
130<a name='L71'></a><a href='#L71'>71</a>
131<a name='L72'></a><a href='#L72'>72</a>
132<a name='L73'></a><a href='#L73'>73</a>
133<a name='L74'></a><a href='#L74'>74</a>
134<a name='L75'></a><a href='#L75'>75</a>
135<a name='L76'></a><a href='#L76'>76</a>
136<a name='L77'></a><a href='#L77'>77</a>
137<a name='L78'></a><a href='#L78'>78</a>
138<a name='L79'></a><a href='#L79'>79</a>
139<a name='L80'></a><a href='#L80'>80</a>
140<a name='L81'></a><a href='#L81'>81</a>
141<a name='L82'></a><a href='#L82'>82</a>
142<a name='L83'></a><a href='#L83'>83</a>
143<a name='L84'></a><a href='#L84'>84</a>
144<a name='L85'></a><a href='#L85'>85</a>
145<a name='L86'></a><a href='#L86'>86</a>
146<a name='L87'></a><a href='#L87'>87</a>
147<a name='L88'></a><a href='#L88'>88</a>
148<a name='L89'></a><a href='#L89'>89</a>
149<a name='L90'></a><a href='#L90'>90</a>
150<a name='L91'></a><a href='#L91'>91</a>
151<a name='L92'></a><a href='#L92'>92</a>
152<a name='L93'></a><a href='#L93'>93</a>
153<a name='L94'></a><a href='#L94'>94</a>
154<a name='L95'></a><a href='#L95'>95</a>
155<a name='L96'></a><a href='#L96'>96</a>
156<a name='L97'></a><a href='#L97'>97</a>
157<a name='L98'></a><a href='#L98'>98</a>
158<a name='L99'></a><a href='#L99'>99</a></td><td class="line-coverage quiet"><span class="cline-any cline-neutral">&nbsp;</span>
159<span class="cline-any cline-neutral">&nbsp;</span>
160<span class="cline-any cline-neutral">&nbsp;</span>
161<span class="cline-any cline-neutral">&nbsp;</span>
162<span class="cline-any cline-neutral">&nbsp;</span>
163<span class="cline-any cline-neutral">&nbsp;</span>
164<span class="cline-any cline-neutral">&nbsp;</span>
165<span class="cline-any cline-neutral">&nbsp;</span>
166<span class="cline-any cline-neutral">&nbsp;</span>
167<span class="cline-any cline-neutral">&nbsp;</span>
168<span class="cline-any cline-neutral">&nbsp;</span>
169<span class="cline-any cline-neutral">&nbsp;</span>
170<span class="cline-any cline-neutral">&nbsp;</span>
171<span class="cline-any cline-neutral">&nbsp;</span>
172<span class="cline-any cline-neutral">&nbsp;</span>
173<span class="cline-any cline-neutral">&nbsp;</span>
174<span class="cline-any cline-neutral">&nbsp;</span>
175<span class="cline-any cline-neutral">&nbsp;</span>
176<span class="cline-any cline-neutral">&nbsp;</span>
177<span class="cline-any cline-neutral">&nbsp;</span>
178<span class="cline-any cline-neutral">&nbsp;</span>
179<span class="cline-any cline-neutral">&nbsp;</span>
180<span class="cline-any cline-neutral">&nbsp;</span>
181<span class="cline-any cline-neutral">&nbsp;</span>
182<span class="cline-any cline-neutral">&nbsp;</span>
183<span class="cline-any cline-neutral">&nbsp;</span>
184<span class="cline-any cline-neutral">&nbsp;</span>
185<span class="cline-any cline-neutral">&nbsp;</span>
186<span class="cline-any cline-neutral">&nbsp;</span>
187<span class="cline-any cline-neutral">&nbsp;</span>
188<span class="cline-any cline-neutral">&nbsp;</span>
189<span class="cline-any cline-no">&nbsp;</span>
190<span class="cline-any cline-no">&nbsp;</span>
191<span class="cline-any cline-neutral">&nbsp;</span>
192<span class="cline-any cline-neutral">&nbsp;</span>
193<span class="cline-any cline-no">&nbsp;</span>
194<span class="cline-any cline-neutral">&nbsp;</span>
195<span class="cline-any cline-neutral">&nbsp;</span>
196<span class="cline-any cline-no">&nbsp;</span>
197<span class="cline-any cline-no">&nbsp;</span>
198<span class="cline-any cline-neutral">&nbsp;</span>
199<span class="cline-any cline-no">&nbsp;</span>
200<span class="cline-any cline-neutral">&nbsp;</span>
201<span class="cline-any cline-no">&nbsp;</span>
202<span class="cline-any cline-neutral">&nbsp;</span>
203<span class="cline-any cline-no">&nbsp;</span>
204<span class="cline-any cline-neutral">&nbsp;</span>
205<span class="cline-any cline-no">&nbsp;</span>
206<span class="cline-any cline-no">&nbsp;</span>
207<span class="cline-any cline-no">&nbsp;</span>
208<span class="cline-any cline-neutral">&nbsp;</span>
209<span class="cline-any cline-no">&nbsp;</span>
210<span class="cline-any cline-neutral">&nbsp;</span>
211<span class="cline-any cline-no">&nbsp;</span>
212<span class="cline-any cline-no">&nbsp;</span>
213<span class="cline-any cline-neutral">&nbsp;</span>
214<span class="cline-any cline-no">&nbsp;</span>
215<span class="cline-any cline-neutral">&nbsp;</span>
216<span class="cline-any cline-no">&nbsp;</span>
217<span class="cline-any cline-no">&nbsp;</span>
218<span class="cline-any cline-no">&nbsp;</span>
219<span class="cline-any cline-neutral">&nbsp;</span>
220<span class="cline-any cline-neutral">&nbsp;</span>
221<span class="cline-any cline-neutral">&nbsp;</span>
222<span class="cline-any cline-no">&nbsp;</span>
223<span class="cline-any cline-no">&nbsp;</span>
224<span class="cline-any cline-no">&nbsp;</span>
225<span class="cline-any cline-neutral">&nbsp;</span>
226<span class="cline-any cline-neutral">&nbsp;</span>
227<span class="cline-any cline-neutral">&nbsp;</span>
228<span class="cline-any cline-neutral">&nbsp;</span>
229<span class="cline-any cline-no">&nbsp;</span>
230<span class="cline-any cline-neutral">&nbsp;</span>
231<span class="cline-any cline-no">&nbsp;</span>
232<span class="cline-any cline-no">&nbsp;</span>
233<span class="cline-any cline-neutral">&nbsp;</span>
234<span class="cline-any cline-neutral">&nbsp;</span>
235<span class="cline-any cline-no">&nbsp;</span>
236<span class="cline-any cline-no">&nbsp;</span>
237<span class="cline-any cline-no">&nbsp;</span>
238<span class="cline-any cline-neutral">&nbsp;</span>
239<span class="cline-any cline-neutral">&nbsp;</span>
240<span class="cline-any cline-no">&nbsp;</span>
241<span class="cline-any cline-neutral">&nbsp;</span>
242<span class="cline-any cline-neutral">&nbsp;</span>
243<span class="cline-any cline-neutral">&nbsp;</span>
244<span class="cline-any cline-neutral">&nbsp;</span>
245<span class="cline-any cline-neutral">&nbsp;</span>
246<span class="cline-any cline-neutral">&nbsp;</span>
247<span class="cline-any cline-neutral">&nbsp;</span>
248<span class="cline-any cline-neutral">&nbsp;</span>
249<span class="cline-any cline-no">&nbsp;</span>
250<span class="cline-any cline-no">&nbsp;</span>
251<span class="cline-any cline-no">&nbsp;</span>
252<span class="cline-any cline-no">&nbsp;</span>
253<span class="cline-any cline-no">&nbsp;</span>
254<span class="cline-any cline-no">&nbsp;</span>
255<span class="cline-any cline-neutral">&nbsp;</span>
256<span class="cline-any cline-neutral">&nbsp;</span></td><td class="text"><pre class="prettyprint lang-js">import localforage from 'localforage'
257&nbsp;
258import FileSystem from './fs'
259import * as cidLog from './common/cid-log'
260import * as debug from './common/debug'
261import * as dataRoot from './data-root'
262import * as ucan from './ucan/internal'
263import { Maybe, authenticatedUsername } from './common'
264import { Permissions } from './ucan/permissions'
265import { Ucan } from './ucan'
266&nbsp;
267&nbsp;
268/**
269 * Load a user's file system.
270 *
271 * @param permissions The permissions from initialise.
272 * Pass `null` if working without permissions
273 * @param username Optional, username of the user to load the file system from.
274 * Will try to load the file system of the authenticated user
275 * by default. Throws an error if there's no authenticated user.
276 * @param rootKey Optional, AES key to be the root key of a new filesystem.
277 * Will be used if a filesystem hasn't been created yet.
278 */
279export async function <span class="fstat-no" title="function not covered" >loadFileSystem(</span>
280 permissions: Maybe&lt;Permissions&gt;,
281 username?: string,
282 rootKey?: string
283): Promise&lt;FileSystem&gt; {
284 let cid, fs
285&nbsp;
286 // Look for username
287<span class="cstat-no" title="statement not covered" > username = username || (await authenticatedUsername() || undefined)</span>
288<span class="cstat-no" title="statement not covered" > if (!username) <span class="cstat-no" title="statement not covered" >throw new Error("User hasn't authenticated yet")</span></span>
289&nbsp;
290 // Ensure internal UCAN dictionary
291<span class="cstat-no" title="statement not covered" > await ucan.store([])</span>
292&nbsp;
293 // Determine the correct CID of the file system to load
294 const dataCid = <span class="cstat-no" title="statement not covered" >navigator.onLine ? await dataRoot.lookup(username) : null</span>
295 const [ logIdx, logLength ] = <span class="cstat-no" title="statement not covered" >dataCid ? await cidLog.index(dataCid) : [ -1, 0 ]</span>
296&nbsp;
297<span class="cstat-no" title="statement not covered" > if (!navigator.onLine) {</span>
298 // Offline, use local CID
299<span class="cstat-no" title="statement not covered" > cid = await cidLog.newest()</span>
300&nbsp;
301 } else <span class="cstat-no" title="statement not covered" >if (!dataCid) {</span>
302 // No DNS CID yet
303<span class="cstat-no" title="statement not covered" > cid = await cidLog.newest()</span>
304<span class="cstat-no" title="statement not covered" > if (cid) <span class="cstat-no" title="statement not covered" >debug.log("📓 No DNSLink, using local CID:", cid)</span></span>
305 else <span class="cstat-no" title="statement not covered" >debug.log("📓 Creating a new file system")</span>
306&nbsp;
307 } else <span class="cstat-no" title="statement not covered" >if (logIdx === 0) {</span>
308 // DNS is up to date
309<span class="cstat-no" title="statement not covered" > cid = dataCid</span>
310<span class="cstat-no" title="statement not covered" > debug.log("📓 DNSLink is up to date:", cid)</span>
311&nbsp;
312 } else <span class="cstat-no" title="statement not covered" >if (logIdx &gt; 0) {</span>
313 // DNS is outdated
314<span class="cstat-no" title="statement not covered" > cid = await cidLog.newest()</span>
315 const idxLog = <span class="cstat-no" title="statement not covered" >logIdx === 1 ? "1 newer local entry" : logIdx + " newer local entries"</span>
316<span class="cstat-no" title="statement not covered" > debug.log("📓 DNSLink is outdated (" + idxLog + "), using local CID:", cid)</span>
317&nbsp;
318 } else {
319 // DNS is newer
320<span class="cstat-no" title="statement not covered" > cid = dataCid</span>
321<span class="cstat-no" title="statement not covered" > await cidLog.add(cid)</span>
322<span class="cstat-no" title="statement not covered" > debug.log("📓 DNSLink is newer:", cid)</span>
323&nbsp;
324 }
325&nbsp;
326 // If a file system exists, load it and return it
327 const p = <span class="cstat-no" title="statement not covered" >permissions || undefined</span>
328&nbsp;
329<span class="cstat-no" title="statement not covered" > fs = cid ? await FileSystem.fromCID(cid, { permissions: p }) : null</span>
330<span class="cstat-no" title="statement not covered" > if (fs) <span class="cstat-no" title="statement not covered" >return fs</span></span>
331&nbsp;
332 // Otherwise make a new one
333<span class="cstat-no" title="statement not covered" > if (!rootKey) <span class="cstat-no" title="statement not covered" >throw new Error("Can't make new filesystem without a root AES key")</span></span>
334<span class="cstat-no" title="statement not covered" > fs = await FileSystem.empty({ permissions: p, rootKey })</span>
335<span class="cstat-no" title="statement not covered" > await addSampleData(fs)</span>
336&nbsp;
337 // Fin
338<span class="cstat-no" title="statement not covered" > return fs</span>
339}
340&nbsp;
341&nbsp;
342&nbsp;
343// ㊙️
344&nbsp;
345&nbsp;
346async function <span class="fstat-no" title="function not covered" >addSampleData(</span>fs: FileSystem): Promise&lt;void&gt; {
347<span class="cstat-no" title="statement not covered" > await fs.mkdir("private/Apps")</span>
348<span class="cstat-no" title="statement not covered" > await fs.mkdir("private/Audio")</span>
349<span class="cstat-no" title="statement not covered" > await fs.mkdir("private/Documents")</span>
350<span class="cstat-no" title="statement not covered" > await fs.mkdir("private/Photos")</span>
351<span class="cstat-no" title="statement not covered" > await fs.mkdir("private/Video")</span>
352<span class="cstat-no" title="statement not covered" > await fs.publish()</span>
353}
354&nbsp;</pre></td></tr></table></pre>
355
356 <div class='push'></div><!-- for sticky footer -->
357 </div><!-- /wrapper -->
358 <div class='footer quiet pad2 space-top1 center small'>
359 Code coverage generated by
360 <a href="https://istanbul.js.org/" target="_blank">istanbul</a>
361 at Fri Mar 12 2021 16:29:42 GMT+0100 (Central European Standard Time)
362 </div>
363 </div>
364 <script src="../prettify.js"></script>
365 <script>
366 window.onload = function () {
367 prettyPrint();
368 };
369 </script>
370 <script src="../sorter.js"></script>
371 <script src="../block-navigation.js"></script>
372 </body>
373</html>
374
\No newline at end of file