This repository was archived by the owner on Jul 13, 2022. It is now read-only.
forked from microsoft/PowerBI-JavaScript
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathSDK-to-MockApp.spec.ts
More file actions
597 lines (536 loc) · 21.2 KB
/
Copy pathSDK-to-MockApp.spec.ts
File metadata and controls
597 lines (536 loc) · 21.2 KB
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
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
import * as utils from '../src/util';
import * as service from '../src/service';
import * as embed from '../src/embed';
import * as report from '../src/report';
import * as page from '../src/page';
import * as Hpm from 'http-post-message';
import * as models from 'powerbi-models';
import * as factories from '../src/factories';
import * as util from '../src/util';
import { spyApp, setupEmbedMockApp } from './utility/mockEmbed';
import { iframeSrc } from './constsants';
describe('SDK-to-MockApp', function () {
let element: HTMLDivElement;
let iframe: HTMLIFrameElement;
let iframeHpm: Hpm.HttpPostMessage;
let powerbi: service.Service;
let report: report.Report;
let page1: page.Page;
const embedConfiguration: embed.IEmbedConfiguration = {
type: "report",
id: "fakeReportIdInitialEmbed",
accessToken: 'fakeTokenInitialEmbed',
embedUrl: iframeSrc
};
beforeEach(async function () {
powerbi = new service.Service(factories.hpmFactory, factories.wpmpFactory, factories.routerFactory, {
wpmpName: 'SDK-to-MockApp HostWpmp'
});
element = document.createElement('div');
element.id = "reportContainer1";
element.className = 'powerbi-report-container2';
document.body.appendChild(element);
report = <report.Report>powerbi.embed(element, embedConfiguration);
page1 = report.page('ReportSection1');
iframe = element.getElementsByTagName('iframe')[0];
/**
* Note: For testing we need to configure the eventSourceOverrideWindow to allow the host to respond to
* the iframe window; however, the iframe window doesn't exist until the first embed is created.
*
* To work around this we create a service for the initial embed, embed a report, then set the private variable
*/
(<any>powerbi.wpmp).eventSourceOverrideWindow = iframe.contentWindow;
// Register Iframe side
let hpmPostSpy = spyOn(powerbi.hpm, "post").and.returnValue(Promise.resolve(<any>{}));
iframeHpm = setupEmbedMockApp(iframe.contentWindow, window, 'SDK-to-MockApp IframeWpmp');
await new Promise<void>((resolve, _reject) => {
iframe.addEventListener('load', () => {
resolve(null);
});
});
hpmPostSpy.and.callThrough();
});
afterEach(function () {
powerbi.reset(element);
element.remove();
powerbi.wpmp?.stop();
spyApp.reset();
});
describe('report', function () {
beforeEach(function () {
spyOn(utils, "getTimeDiffInMilliseconds").and.callFake(() => 700); // Prevent requests from being throttled.
});
describe('load', function () {
it('report.load() returns promise that resolves with null if the report load successful', async function () {
try {
const response = await report.load(undefined);
// Assert
expect(response).toEqual({} as any);
} catch (error) {
fail("lod shouldn't fail");
}
});
});
describe('pages', function () {
it('report.getPages() return promise that rejects with server error if there was error getting pages', async function () {
// Arrange
const testData = {
expectedError: {
message: 'internal server error'
}
};
try {
spyApp.getPages.and.callFake(() => Promise.reject(testData.expectedError));
// Act
await report.getPages();
fail("getPagesshouldn't succeed");
} catch (error) {
// Assert
expect(spyApp.getPages).toHaveBeenCalled();
expect(error).toEqual(jasmine.objectContaining(testData.expectedError));
}
});
it('report.getPages() returns promise that resolves with list of page names', async function () {
// Arrange
const testData = {
pages: [
{
name: "page1",
displayName: "Page 1",
isActive: true
}
]
};
try {
spyApp.getPages.and.returnValue(Promise.resolve(testData.pages));
const pages = await report.getPages();
// Assert
expect(spyApp.getPages).toHaveBeenCalled();
// Workaround to compare pages
pages.forEach(page => {
const testPage = util.find(p => p.name === page.name, testData.pages);
if (testPage) {
expect(page.name).toEqual(testPage.name);
expect(page.isActive).toEqual(testPage.isActive);
}
else {
expect(true).toBe(false);
}
});
} catch (error) {
console.log("getPages failed with", error);
fail("getPages failed");
}
});
});
describe('filters', function () {
it('report.getFilters() returns promise that rejects with server error if there was problem getting filters', async function () {
// Arrange
const testData = {
expectedError: {
message: 'could not serialize filters'
}
};
try {
spyApp.getFilters.and.callFake(() => Promise.reject(testData.expectedError));
await report.getFilters();
fail("getFilters shouldn't succeed");
} catch (error) {
// Assert
expect(spyApp.getFilters).toHaveBeenCalled();
expect(error).toEqual(jasmine.objectContaining(testData.expectedError));
}
});
it('report.getFilters() returns promise that resolves with filters is request is successful', async function () {
// Arrange
const testData = {
filters: [
{ x: 'fakeFilter' }
]
};
spyApp.getFilters.and.returnValue(Promise.resolve(testData.filters));
try {
// Act
const filters = await report.getFilters();
// Assert
expect(spyApp.getFilters).toHaveBeenCalled();
// @ts-ignore as testData is not of type IFilter
expect(filters).toEqual(testData.filters);
} catch (error) {
fail("get filtershousln't fails");
}
});
it('report.setFilters(filters) returns promise that rejects with validation errors if filter is invalid', async function () {
// Arrange
const testData = {
filters: [
(new models.BasicFilter({ table: "cars", column: "make" }, "In", ["subaru", "honda"])).toJSON()
],
expectedErrors: [
{
message: 'invalid filter'
}
]
};
spyApp.validateFilter.and.callFake(() => Promise.reject(testData.expectedErrors));
try {
// Act
await report.setFilters(testData.filters);
fail("et filter should fail");
} catch (error) {
// Assert
expect(spyApp.validateFilter).toHaveBeenCalledWith(testData.filters[0]);
expect(spyApp.setFilters).not.toHaveBeenCalled();
expect(error).toEqual(jasmine.objectContaining(testData.expectedErrors));
}
});
it('report.setFilters(filters) returns promise that resolves with null if filter was valid and request is accepted', async function () {
// Arrange
const testData = {
filters: [(new models.BasicFilter({ table: "cars", column: "make" }, "In", ["subaru", "honda"])).toJSON()]
};
spyApp.validateFilter.and.returnValue(Promise.resolve(null));
spyApp.setFilters.and.returnValue(Promise.resolve(null));
try {
// Act
await report.setFilters(testData.filters);
expect(spyApp.validateFilter).toHaveBeenCalledWith(testData.filters[0]);
expect(spyApp.setFilters).toHaveBeenCalledWith(testData.filters);
} catch (error) {
fail("why fail");
}
});
it('report.removeFilters() returns promise that resolves with null if the request was accepted', async function () {
// Arrange
let spy = spyOn(report, 'updateFilters').and.callFake(() => Promise.resolve(null));
try {
// Act
await report.removeFilters();
// Assert
expect(spy).toHaveBeenCalledWith(models.FiltersOperations.RemoveAll);
} catch (error) {
fail("remove fialter shouldn't fail");
}
});
});
describe('print', function () {
it('report.print() returns promise that resolves with null if the report print command was accepted', async function () {
// Arrange
spyApp.print.and.returnValue(Promise.resolve({}));
// Act
const response = await report.print();
// Assert
expect(spyApp.print).toHaveBeenCalled();
expect(response).toEqual();
});
});
describe('refresh', function () {
it('report.refresh() returns promise that resolves with null if the report refresh command was accepted', async function () {
// Arrange
spyApp.refreshData.and.returnValue(Promise.resolve(null));
// Act
const response = await report.refresh();
// Assert
expect(spyApp.refreshData).toHaveBeenCalled();
expect(response).toEqual(undefined);
});
});
describe('settings', function () {
it('report.updateSettings(setting) returns promise that rejects with validation error if object is invalid', async function () {
// Arrange
const testData = {
settings: {
filterPaneEnabled: false
},
expectedErrors: [
{
message: 'invalid target'
}
]
};
spyApp.validateSettings.and.callFake(() => Promise.reject(testData.expectedErrors));
try {
// Act
await report.updateSettings(testData.settings);
fail("shouldfail");
} catch (errors) {
// Assert
expect(spyApp.validateSettings).toHaveBeenCalledWith(testData.settings);
expect(spyApp.updateSettings).not.toHaveBeenCalled();
expect(errors).toEqual(jasmine.objectContaining(testData.expectedErrors));
}
});
it('report.updateSettings(settings) returns promise that resolves with null if requst is valid and accepted', async function () {
// Arrange
const testData = {
settings: {
filterPaneEnabled: false
},
expectedErrors: [
{
message: 'invalid target'
}
]
};
try {
spyApp.validateSettings.and.returnValue(Promise.resolve(null));
spyApp.updateSettings.and.returnValue(Promise.resolve(null));
// Act
await report.updateSettings(testData.settings);
// Assert
expect(spyApp.validateSettings).toHaveBeenCalledWith(testData.settings);
expect(spyApp.updateSettings).toHaveBeenCalledWith(testData.settings);
} catch (error) {
console.log("updateSettings failed with", error);
fail("updateSettings failed");
}
});
});
describe('page', function () {
describe('filters', function () {
beforeEach(() => {
spyApp.validatePage.and.returnValue(Promise.resolve(null));
});
it('page.getFilters() returns promise that rejects with server error if there was problem getting filters', async function () {
// Arrange
const testData = {
expectedError: {
message: 'could not serialize filters'
}
};
try {
spyApp.getFilters.and.callFake(() => Promise.reject(testData.expectedError));
await page1.getFilters();
} catch (error) {
// Assert
expect(spyApp.getFilters).toHaveBeenCalled();
expect(error).toEqual(jasmine.objectContaining(testData.expectedError));
}
});
it('page.getFilters() returns promise that resolves with filters is request is successful', async function () {
// Arrange
const testData = {
filters: [
{ x: 'fakeFilter' }
]
};
try {
spyApp.getFilters.and.returnValue(Promise.resolve(testData.filters));
const filters = await page1.getFilters();
// Assert
expect(spyApp.getFilters).toHaveBeenCalled();
// @ts-ignore as testData is not of type IFilter as testData is not of type IFilter
expect(filters).toEqual(testData.filters);
} catch (error) {
fail("getFilters shouldn't fail");
}
});
it('page.setFilters(filters) returns promise that rejects with validation errors if filter is invalid', async function () {
// Arrange
const testData = {
filters: [
(new models.BasicFilter({ table: "cars", column: "make" }, "In", ["subaru", "honda"])).toJSON()
],
expectedErrors: [
{
message: 'invalid filter'
}
]
};
// await iframeLoaded;
try {
spyApp.validateFilter.and.callFake(() => Promise.reject(testData.expectedErrors));
await page1.setFilters(testData.filters);
fail("setilters shouldn't fail");
} catch (error) {
expect(spyApp.validateFilter).toHaveBeenCalledWith(testData.filters[0]);
expect(spyApp.setFilters).not.toHaveBeenCalled();
expect(error).toEqual(jasmine.objectContaining(testData.expectedErrors));
}
});
it('page.setFilters(filters) returns promise that resolves with null if filter was valid and request is accepted', async function () {
// Arrange
const testData = {
filters: [(new models.BasicFilter({ table: "cars", column: "make" }, "In", ["subaru", "honda"])).toJSON()]
};
spyApp.validateFilter.and.returnValue(Promise.resolve(null));
spyApp.setFilters.and.returnValue(Promise.resolve(null));
try {
await page1.setFilters(testData.filters);
expect(spyApp.validateFilter).toHaveBeenCalledWith(testData.filters[0]);
expect(spyApp.setFilters).toHaveBeenCalledWith(testData.filters);
} catch (error) {
console.log("setFilters failed with", error);
fail("setilters failed");
}
});
it('page.removeFilters() returns promise that resolves with null if the request was accepted', async function () {
// Arrange
try {
spyApp.updateFilters.and.returnValue(Promise.resolve(null));
// Act
await page1.removeFilters();
} catch (error) {
console.log("removeFilters failed with", error);
fail("removeFilters failed");
}
// Assert
expect(spyApp.updateFilters).toHaveBeenCalledWith(models.FiltersOperations.RemoveAll, undefined);
});
describe('setActive', function () {
it('page.setActive() returns promise that rejects if page is invalid', async function () {
// Arrange
const testData = {
errors: [
{
message: 'page xyz was not found in report'
}
]
};
spyApp.validatePage.and.callFake(() => Promise.reject(testData.errors));
try {
// Act
await page1.setActive();
fail("setActive shouldn't succeed");
} catch (errors) {
expect(spyApp.validatePage).toHaveBeenCalled();
expect(spyApp.setPage).not.toHaveBeenCalled();
expect(errors).toEqual(jasmine.objectContaining(testData.errors));
}
spyApp.validatePage.and.callThrough();
});
it('page.setActive() returns promise that resolves with null if request is successful', async function () {
// Act
spyApp.validatePage.and.returnValue(Promise.resolve(null));
spyApp.setPage.and.returnValue(Promise.resolve(null));
try {
await page1.setActive();
expect(spyApp.validatePage).toHaveBeenCalled();
expect(spyApp.setPage).toHaveBeenCalled();
} catch (error) {
console.log("setActive failed with ", error);
fail("setActive failed");
}
});
});
});
});
describe('SDK-to-Router (Event subscription)', function () {
it(`report.on(eventName, handler) should throw error if eventName is not supported`, function () {
// Arrange
const testData = {
eventName: 'xyz',
handler: jasmine.createSpy('handler')
};
try {
report.on(testData.eventName, testData.handler);
fail("should throw exception");
} catch (error) {
expect(1).toEqual(1);
}
});
it(`report.on(eventName, handler) should register handler and be called when POST /report/:uniqueId/events/:eventName is received`, async function () {
// Arrange
const testData = {
reportId: 'fakeReportId',
eventName: 'pageChanged',
handler: jasmine.createSpy('handler'),
simulatedPageChangeBody: {
initiator: 'sdk',
newPage: {
name: 'page1',
displayName: 'Page 1'
}
},
expectedEvent: {
detail: {
initiator: 'sdk',
newPage: report.page('page1')
}
}
};
report.on(testData.eventName, testData.handler);
try {
// Act
await iframeHpm.post(`/reports/${report.config.uniqueId}/events/${testData.eventName}`, testData.simulatedPageChangeBody);
} catch (error) {
fail("testshouldn't fail");
}
// Assert
expect(testData.handler).toHaveBeenCalledWith(jasmine.any(CustomEvent));
// Workaround to compare pages which prevents recursive loop in jasmine equals
// expect(testData.handler2).toHaveBeenCalledWith(jasmine.objectContaining({ detail: testData.simulatedPageChangeBody }));
expect(testData.handler.calls.mostRecent().args[0].detail.newPage.name).toEqual(testData.expectedEvent.detail.newPage.name);
});
it(`if multiple reports with the same id are loaded into the host, and event occurs on one of them, only one report handler should be called`, async function () {
// Arrange
const testData = {
reportId: 'fakeReportId',
eventName: 'pageChanged',
handler: jasmine.createSpy('handler'),
handler2: jasmine.createSpy('handler2'),
simulatedPageChangeBody: {
initiator: 'sdk',
newPage: {
name: 'page1',
displayName: 'Page 1'
}
}
};
// Create a second iframe and report
const element2 = document.createElement('div');
element2.id = "reportContainer2";
element2.className = 'powerbi-report-container3';
document.body.appendChild(element2);
const report2 = <report.Report>powerbi.embed(element2, embedConfiguration);
const iframe2 = element2.getElementsByTagName('iframe')[0];
setupEmbedMockApp(iframe2.contentWindow, window, 'SDK-to-MockApp IframeWpmp2');
await new Promise<void>((resolve, _reject) => {
iframe2.addEventListener('load', () => {
resolve(null);
});
});
report.on(testData.eventName, testData.handler);
report2.on(testData.eventName, testData.handler2);
try {
await iframeHpm.post(`/reports/${report2.config.uniqueId}/events/${testData.eventName}`, testData.simulatedPageChangeBody);
} catch (error) {
powerbi.reset(element2);
element2.remove();
fail("hpm post shouldn't fail");
}
// Act
expect(testData.handler).not.toHaveBeenCalled();
expect(testData.handler2).toHaveBeenCalledWith(jasmine.any(CustomEvent));
// Workaround to compare pages which prevents recursive loop in jasmine equals
// expect(testData.handler).toHaveBeenCalledWith(jasmine.objectContaining(testData.expectedEvent));
expect(testData.handler2.calls.mostRecent().args[0].detail.newPage.name).toEqual(testData.simulatedPageChangeBody.newPage.name);
powerbi.reset(element2);
element2.remove();
});
it(`ensure load event is allowed`, async function () {
// Arrange
const testData = {
reportId: 'fakeReportId',
eventName: 'loaded',
handler: jasmine.createSpy('handler3'),
simulatedBody: {
initiator: 'sdk'
}
};
report.on(testData.eventName, testData.handler);
// Act
try {
await iframeHpm.post(`/reports/${report.config.uniqueId}/events/${testData.eventName}`, testData.simulatedBody);
} catch (error) {
fail("ensure load event is allowed failed");
}
// Assert
expect(testData.handler).toHaveBeenCalledWith(jasmine.any(CustomEvent));
expect(testData.handler).toHaveBeenCalledWith(jasmine.objectContaining({ detail: testData.simulatedBody }));
});
});
});
});