fastboot/test/fastboot-test.js at c3a0379074412c83a710c5619a6dc29930fde397 · ember-fastboot/fastboot · GitHub

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
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
'use strict';

const expect = require('chai').expect;
const fs = require('fs');
const path = require('path');
const fixture = require('./helpers/fixture-path');
const FastBoot = require('./../src/index');

describe('FastBoot', function() {
  it('throws an exception if no distPath is provided', function() {
    var fn = function() {
      return new FastBoot();
    };

    expect(fn).to.throw(/You must instantiate FastBoot with a distPath option/);
  });

  it('throws an exception if no package.json exists in the provided distPath', function() {
    var distPath = fixture('no-package-json');
    var fn = function() {
      return new FastBoot({
        distPath: distPath,
      });
    };

    expect(fn).to.throw(/Couldn't find (.+)\/fixtures\/no-package-json/);
  });

  it('throws an error when manifest schema version is higher than fastboot schema version', function() {
    var distPath = fixture('higher-schema-version');
    var fn = function() {
      return new FastBoot({
        distPath: distPath,
      });
    };

    expect(fn).to.throw(
      /An incompatible version between `ember-cli-fastboot` and `fastboot` was found/
    );
  });

  it("doesn't throw an exception if a package.json is provided", function() {
    var distPath = fixture('empty-package-json');
    var fn = function() {
      return new FastBoot({
        distPath: distPath,
      });
    };

    expect(fn).to.throw(
      /(.+)\/fixtures\/empty-package-json\/package.json was malformed or did not contain a fastboot config/
    );
  });

  it('can render HTML', function() {
    var fastboot = new FastBoot({
      distPath: fixture('basic-app'),
    });

    return fastboot
      .visit('/')
      .then(r => r.html())
      .then(html => {
        expect(html).to.match(/Welcome to Ember/);
      });
  });

  it('can run multiple visits', async function() {
    this.timeout(3000);

    var fastboot = new FastBoot({
      distPath: fixture('basic-app'),
    });

    let result = await fastboot.visit('/');
    let html = await result.html();

    expect(html).to.match(/Welcome to Ember/);

    result = await fastboot.visit('/');
    html = await result.html();

    expect(html).to.match(/Welcome to Ember/);

    result = await fastboot.visit('/');
    html = await result.html();

    expect(html).to.match(/Welcome to Ember/);
  });

  it('can render HTML with array of app files defined in package.json', function() {
    var fastboot = new FastBoot({
      distPath: fixture('multiple-app-files'),
    });

    return fastboot
      .visit('/')
      .then(r => r.html())
      .then(html => {
        expect(html).to.match(/Welcome to Ember/);
      });
  });

  it('cannot not render app HTML with shouldRender set as false', function() {
    var fastboot = new FastBoot({
      distPath: fixture('basic-app'),
    });

    return fastboot
      .visit('/', {
        shouldRender: false,
      })
      .then(r => r.html())
      .then(html => {
        expect(html).to.not.match(/Welcome to Ember/);
      });
  });

  it('outputs html attributes from the fastboot app', function() {
    var fastboot = new FastBoot({
      distPath: fixture('custom-html-attrs'),
    });

    return fastboot
      .visit('/')
      .then(r => r.html())
      .then(html => {
        expect(html).to.match(/<html data-before=1 +class="a b it-works" data-after=2/);
      });
  });

  it('outputs body attributes from the fastboot app', function() {
    var fastboot = new FastBoot({
      distPath: fixture('custom-body-attrs'),
    });

    return fastboot
      .visit('/')
      .then(r => r.html())
      .then(html => {
        expect(html).to.match(
          /<body data-before=1 +class="no-js default-class it-works" data-after=2/
        );
      });
  });

  it('appends classes correctly even when there are no classes in the original body', function() {
    var fastboot = new FastBoot({
      distPath: fixture('custom-body-attrs-with-no-default-classes'),
    });

    return fastboot
      .visit('/')
      .then(r => r.html())
      .then(html => {
        expect(html).to.match(/<body data-before=1 data-after=2 +class="it-works"/);
      });
  });

  it('appends classes correctly even when there are no classes in the original html', function() {
    var fastboot = new FastBoot({
      distPath: fixture('custom-html-attrs-with-no-default-classes'),
    });

    return fastboot
      .visit('/')
      .then(r => r.html())
      .then(html => {
        expect(html).to.match(/<html data-before=1 data-after=2 +class="it-works"/);
      });
  });

  it('can serialize the head and body', function() {
    var fastboot = new FastBoot({
      distPath: fixture('basic-app'),
    });

    return fastboot.visit('/').then(r => {
      let contents = r.domContents();

      expect(contents.head).to.equal('');
      expect(contents.body).to.match(/Welcome to Ember/);
    });
  });

  it('can forcefully destroy the app instance using destroyAppInstanceInMs', function() {
    var fastboot = new FastBoot({
      distPath: fixture('basic-app'),
    });

    return fastboot
      .visit('/', {
        destroyAppInstanceInMs: 5,
      })
      .catch(e => {
        expect(e.message).to.equal('App instance was forcefully destroyed in 5ms');
      });
  });

  it('can render HTML when a custom set of sandbox globals is provided', function() {
    var fastboot = new FastBoot({
      distPath: fixture('custom-sandbox'),
      buildSandboxGlobals(globals) {
        return Object.assign({}, globals, {
          foo: 5,
          myVar: 'undefined',
        });
      },
    });

    return fastboot
      .visit('/foo')
      .then(r => r.html())
      .then(html => {
        expect(html).to.match(/foo from sandbox: 5/);
      });
  });

  it('rejects the promise if an error occurs', function() {
    var fastboot = new FastBoot({
      distPath: fixture('rejected-promise'),
    });

    return expect(fastboot.visit('/')).to.be.rejected;
  });

  it('catches the error if an error occurs', function() {
    var fastboot = new FastBoot({
      distPath: fixture('rejected-promise'),
    });

    fastboot.visit('/').catch(function(err) {
      return expect(err).to.be.not.null;
    });
  });

  it('renders an empty page if the resilient flag is set', function() {
    var fastboot = new FastBoot({
      distPath: fixture('rejected-promise'),
      resilient: true,
    });

    return fastboot
      .visit('/')
      .then(r => r.html())
      .then(html => {
        expect(html).to.match(/<body>/);
      });
  });

  it('returns only one chunk if the resilient flag is set', function() {
    var fastboot = new FastBoot({
      distPath: fixture('rejected-promise'),
      resilient: true,
    });

    return fastboot
      .visit('/')
      .then(r => r.chunks())
      .then(chunks => {
        expect(chunks.length).to.eq(1);
        expect(chunks[0]).to.match(/<body>/);
      });
  });

  it('can reload the distPath', function() {
    var fastboot = new FastBoot({
      distPath: fixture('basic-app'),
    });

    return fastboot
      .visit('/')
      .then(r => r.html())
      .then(html => expect(html).to.match(/Welcome to Ember/))
      .then(hotReloadApp)
      .then(() => fastboot.visit('/'))
      .then(r => r.html())
      .then(html => expect(html).to.match(/Goodbye from Ember/));

    function hotReloadApp() {
      fastboot.reload({
        distPath: fixture('hot-swap-app'),
      });
    }
  });

  it('can reload the app using the same buildSandboxGlobals', function() {
    var fastboot = new FastBoot({
      distPath: fixture('basic-app'),
      buildSandboxGlobals(globals) {
        return Object.assign({}, globals, {
          foo: 5,
          myVar: 'undefined',
        });
      },
    });

    return fastboot
      .visit('/')
      .then(r => r.html())
      .then(html => expect(html).to.match(/Welcome to Ember/))
      .then(hotReloadApp)
      .then(() => fastboot.visit('/foo'))
      .then(r => r.html())
      .then(html => {
        expect(html).to.match(/foo from sandbox: 5/);
      });

    function hotReloadApp() {
      fastboot.reload({
        distPath: fixture('custom-sandbox'),
      });
    }
  });

  it('reads the config from package.json', function() {
    var fastboot = new FastBoot({
      distPath: fixture('config-app'),
    });

    return fastboot
      .visit('/')
      .then(r => r.html())
      .then(html => expect(html).to.match(/Config foo: bar/));
  });

  it('prefers APP_CONFIG environment variable', function() {
    var config = {
      modulePrefix: 'fastboot-test',
      environment: 'development',
      baseURL: '/',
      locationType: 'auto',
      EmberENV: { FEATURES: {} },
      APP: {
        name: 'fastboot-test',
        version: '0.0.0+3e9fe92d',
        autoboot: false,
        foo: 'baz',
      },
      exportApplicationGlobal: true,
    };

    process.env.APP_CONFIG = JSON.stringify(config);

    var fastboot = new FastBoot({
      distPath: fixture('config-app'),
    });

    delete process.env.APP_CONFIG;

    return fastboot
      .visit('/')
      .then(r => r.html())
      .then(html => expect(html).to.match(/Config foo: baz/));
  });

  it('handles apps with config defined in app.js', function() {
    var fastboot = new FastBoot({
      distPath: fixture('config-not-in-meta-app'),
    });

    return fastboot
      .visit('/')
      .then(r => r.html())
      .then(html => expect(html).to.match(/Welcome to Ember/));
  });

  it('reloads the config when package.json changes', async function() {
    var distPath = fixture('config-swap-app');
    var packagePath = path.join(distPath, 'package.json');
    var package1Path = path.join(distPath, 'package-1.json');
    var package2Path = path.join(distPath, 'package-2.json');

    copyPackage(package1Path);

    var fastboot = new FastBoot({
      distPath: distPath,
    });

    try {
      await fastboot
        .visit('/')
        .then(r => r.html())
        .then(html => expect(html).to.match(/Config foo: bar/))
        .then(() => deletePackage())
        .then(() => copyPackage(package2Path))
        .then(hotReloadApp)
        .then(() => fastboot.visit('/'))
        .then(r => r.html())
        .then(html => expect(html).to.match(/Config foo: boo/));
    } finally {
      deletePackage();
    }

    function hotReloadApp() {
      fastboot.reload({
        distPath: distPath,
      });
    }

    function copyPackage(sourcePackage) {
      fs.symlinkSync(sourcePackage, packagePath);
    }

    function deletePackage() {
      fs.unlinkSync(packagePath);
    }
  });

  it('handles apps boot-time failures by throwing Errors', function() {
    var fastboot = new FastBoot({
      distPath: fixture('boot-time-failing-app'),
    });

    return fastboot.visit('/').catch(e => expect(e).to.be.an('error'));
  });

  it('can read multiple configs', function() {
    var fastboot = new FastBoot({
      distPath: fixture('app-with-multiple-config'),
    });

    return fastboot
      .visit('/')
      .then(r => r.html())
      .then(html => {
        expect(html).to.match(/App Name: app-with-multiple-configs/);
        expect(html).to.match(/Other Config {"default":"bar"}/);
      });
  });

  it('in app prototype mutations do not leak across visits with buildSandboxPerVisit=true', async function() {
    this.timeout(3000);

    var fastboot = new FastBoot({
      distPath: fixture('app-with-prototype-mutations'),
    });

    let result = await fastboot.visit('/', { buildSandboxPerVisit: true });
    let analytics = result.analytics;
    let html = await result.html();

    expect(html).to.match(/Items: 1/);
    expect(analytics.usedPrebuiltSandbox).to.equal(true);

    result = await fastboot.visit('/', { buildSandboxPerVisit: true });
    analytics = result.analytics;
    html = await result.html();

    expect(html).to.match(/Items: 1/);
    expect(analytics.usedPrebuiltSandbox).to.equal(true);

    result = await fastboot.visit('/', { buildSandboxPerVisit: true });
    analytics = result.analytics;
    html = await result.html();

    expect(html).to.match(/Items: 1/);
    expect(analytics.usedPrebuiltSandbox).to.equal(true);
  });

  it('errors can be properly attributed with buildSandboxPerVisit=true', async function() {
    this.timeout(3000);

    var fastboot = new FastBoot({
      distPath: fixture('onerror-per-visit'),
    });

    let first = fastboot.visit('/slow/100/reject', {
      buildSandboxPerVisit: true,
      request: { url: '/slow/100/reject', headers: {} },
    });

    let second = fastboot.visit('/slow/50/resolve', {
      buildSandboxPerVisit: true,
      request: { url: '/slow/50/resolve', headers: {} },
    });

    let third = fastboot.visit('/slow/25/resolve', {
      buildSandboxPerVisit: true,
      request: { url: '/slow/25/resolve', headers: {} },
    });

    await Promise.all([second, third]);

    await first.then(
      () => {
        throw new Error('Visit should not resolve!');
      },
      error => {
        expect(error.code).to.equal('from-slow');
        expect(error.fastbootRequestPath).to.equal('/slow/100/reject');
      }
    );
  });

  it('it eagerly builds sandbox when queue is empty', async function() {
    this.timeout(3000);

    var fastboot = new FastBoot({
      distPath: fixture('onerror-per-visit'),
      maxSandboxQueueSize: 2,
    });

    let first = fastboot.visit('/slow/50/resolve', {
      buildSandboxPerVisit: true,
      request: { url: '/slow/50/resolve', headers: {} },
    });

    let second = fastboot.visit('/slow/50/resolve', {
      buildSandboxPerVisit: true,
      request: { url: '/slow/50/resolve', headers: {} },
    });

    let third = fastboot.visit('/slow/25/resolve', {
      buildSandboxPerVisit: true,
      request: { url: '/slow/25/resolve', headers: {} },
    });

    let result = await first;
    let analytics = result.analytics;
    expect(analytics.usedPrebuiltSandbox).to.equal(true);

    result = await second;
    analytics = result.analytics;
    expect(analytics.usedPrebuiltSandbox).to.equal(true);

    result = await third;
    analytics = result.analytics;
    expect(analytics.usedPrebuiltSandbox).to.equal(false);
  });

  it('it leverages sandbox from queue when present', async function() {
    this.timeout(3000);

    var fastboot = new FastBoot({
      distPath: fixture('onerror-per-visit'),
      maxSandboxQueueSize: 3,
    });

    let first = fastboot.visit('/slow/50/resolve', {
      buildSandboxPerVisit: true,
      request: { url: '/slow/50/resolve', headers: {} },
    });

    let second = fastboot.visit('/slow/50/resolve', {
      buildSandboxPerVisit: true,
      request: { url: '/slow/50/resolve', headers: {} },
    });

    let third = fastboot.visit('/slow/25/resolve', {
      buildSandboxPerVisit: true,
      request: { url: '/slow/25/resolve', headers: {} },
    });

    let result = await first;
    let analytics = result.analytics;
    expect(analytics.usedPrebuiltSandbox).to.equal(true);

    result = await second;
    analytics = result.analytics;
    expect(analytics.usedPrebuiltSandbox).to.equal(true);

    result = await third;
    analytics = result.analytics;
    expect(analytics.usedPrebuiltSandbox).to.equal(true);
  });

  it('should contain the analytics data for the visit', async function() {
    this.timeout(3000);

    var fastboot = new FastBoot({
      distPath: fixture('app-with-prototype-mutations'),
    });

    let resultWithSandboxPerVisit = await fastboot.visit('/', { buildSandboxPerVisit: true });
    expect(Object.keys(resultWithSandboxPerVisit.analytics)).to.deep.equals([
      'appInstanceRetrievalTime',
      'usedPrebuiltSandbox',
      'instanceVisitTime',
      'fastbootVisitTime',
    ]);

    let resultWithoutSandboxPerVisit = await fastboot.visit('/');
    expect(Object.keys(resultWithoutSandboxPerVisit.analytics)).to.deep.equals([
      'appInstanceRetrievalTime',
      'instanceVisitTime',
      'fastbootVisitTime',
    ]);
  });

  it('htmlEntrypoint works', function() {
    var fastboot = new FastBoot({
      distPath: fixture('html-entrypoint'),
    });

    return fastboot
      .visit('/')
      .then(r => r.html())
      .then(html => {
        expect(html).to.match(/Welcome to Ember/);
        expect(html).to.not.match(/fastboot-script/);
      });
  });
});