Update to construct complete list of allowedEvents and check all of them instead of only those in child class. Fixes bug for allowing load event handler.

Matt Mazzola · Matt Mazzola · commit 23e0432840eb · 2016-06-29T13:22:40.000-07:00
diff --git a/src/embed.ts b/src/embed.ts
@@ -42,16 +42,18 @@ export interface IInternalEventHandler<T> {
 }
 
 export abstract class Embed {
-    public static accessTokenAttribute = 'powerbi-access-token';
-    public static embedUrlAttribute = 'powerbi-embed-url';
-    public static nameAttribute = 'powerbi-name';
-    public static typeAttribute = 'powerbi-type';
-    public static type: string;
+    static allowedEvents = ["loaded"];
+    static accessTokenAttribute = 'powerbi-access-token';
+    static embedUrlAttribute = 'powerbi-embed-url';
+    static nameAttribute = 'powerbi-name';
+    static typeAttribute = 'powerbi-type';
+    static type: string;
 
     private static defaultSettings: models.ISettings = {
         filterPaneEnabled: true
     };
 
+    allowedEvents = [];
     eventHandlers: IInternalEventHandler<any>[];
     hpm: hpm.HttpPostMessage;
     service: service.Service;
@@ -64,6 +66,7 @@ export abstract class Embed {
      * The service has list of all embeds on the host page, and each embed has reference to the service that created it.
      */
     constructor(service: service.Service, hpmFactory: service.IHpmFactory, element: HTMLElement, config: IEmbedConfiguration) {
+        Array.prototype.push.apply(this.allowedEvents, Embed.allowedEvents);
         this.eventHandlers = [];
         this.service = service;
         this.element = element;
@@ -154,6 +157,10 @@ export abstract class Embed {
      * ```
      */
     on<T>(eventName: string, handler: service.IEventHandler<T>): void {
+        if(this.allowedEvents.indexOf(eventName) === -1) {
+            throw new Error(`eventName is must be one of ${this.allowedEvents}. You passed: ${eventName}`);
+        }
+
         this.eventHandlers.push({
             test: (event: service.IEvent<T>) => event.name === eventName,
             handle: handler
diff --git a/src/report.ts b/src/report.ts
@@ -9,6 +9,11 @@ export class Report extends embed.Embed {
     static reportIdAttribute = 'powerbi-report-id';
     static type = "Report";
 
+    constructor(service: service.Service, hpmFactory: service.IHpmFactory, element: HTMLElement, config: embed.IEmbedConfiguration) {
+        super(service, hpmFactory, element, config);
+        Array.prototype.push.apply(this.allowedEvents, Report.allowedEvents);
+    }
+
     /**
      * This adds backwards compatibility for older config which used the reportId query param to specify report id.
      * E.g. http://embedded.powerbi.com/appTokenReportEmbed?reportId=854846ed-2106-4dc2-bc58-eb77533bf2f1
@@ -113,14 +118,6 @@ export class Report extends embed.Embed {
                 });
     }
     
-    on<T>(eventName: string, handler: service.IEventHandler<T>): void {
-        if(Report.allowedEvents.indexOf(eventName) === -1) {
-            throw new Error(`eventName is must be one of ${Report.allowedEvents}. You passed: ${eventName}`);
-        }
-        
-        super.on<T>(eventName, handler);
-    }
-
     /**
      * Set the active page
      */
diff --git a/test/test.spec.ts b/test/test.spec.ts
@@ -4314,5 +4314,27 @@ describe('SDK-to-MockApp', function () {
           expect(testData.handler).not.toHaveBeenCalled();
         });
     });
+
+    it(`ensure load event is allowed`, function () {
+      // Arrange
+      const testData = {
+        uniqueId: 'uniqueId',
+        reportId: 'fakeReportId',
+        eventName: 'loaded',
+        handler: jasmine.createSpy('handler'),
+        simulatedBody: {
+          initiator: 'sdk'
+        }
+      };
+
+      report.on(testData.eventName, testData.handler);
+
+      // Act
+      iframeHpm.post(`/reports/${report2.config.uniqueId}/events/${testData.eventName}`, testData.simulatedBody)
+        .then(response => {
+          // Assert
+          expect(testData.handler).toHaveBeenCalledWith(testData.simulatedBody);
+        });
+    });
   });
 });
