@thoughtspot/visual-embed-sdk 1.47.2 → 1.47.3

package/cjs/src/embed/ts-embed.spec.js

@@ -3648,5 +3648,144 @@ describe('ShowPreRender with UpdateEmbedParams', () => {
         expect(iframe.allow).toContain('clipboard-read');
         expect(iframe.allow).toContain('clipboard-write');
     });
+    describe('shouldSkipEvent', () => {
+        beforeAll(() => {
+            (0, index_1.init)({
+                thoughtSpotHost: 'tshost',
+                authType: index_1.AuthType.None,
+            });
+        });
+        // Matches the structure produced by createValidationError / embedErrorDetails
+        const makeNestedValidationData = (message = 'invalid payload') => ({
+            type: index_1.EmbedEvent.Error,
+            data: {
+                errorType: 'VALIDATION_ERROR',
+                message,
+                code: types_1.EmbedErrorCodes.HOST_EVENT_VALIDATION,
+                error: message,
+            },
+        });
+        // Matches the flat structure where errorType sits at the top level of data
+        const makeFlatValidationData = (message = 'invalid payload') => ({
+            errorType: types_1.EmbedErrorCodes.HOST_EVENT_VALIDATION,
+            message,
+            code: types_1.EmbedErrorCodes.HOST_EVENT_VALIDATION,
+        });
+        const makeEmbed = (viewConfig) => {
+            const embed = new index_1.SearchEmbed((0, test_utils_1.getRootEl)(), {
+                ...defaultViewConfig,
+                ...viewConfig,
+            });
+            return embed;
+        };
+        test('skips Error event and logs warning when useHostEventsV2 is true and shouldBypassPayloadValidation is true', () => {
+            jest.spyOn(logger_1.logger, 'warn');
+            const errorHandler = jest.fn();
+            const embed = makeEmbed({ useHostEventsV2: true, shouldBypassPayloadValidation: true });
+            embed.on(index_1.EmbedEvent.Error, errorHandler);
+            embed.executeCallbacks(index_1.EmbedEvent.Error, makeNestedValidationData());
+            expect(errorHandler).not.toHaveBeenCalled();
+            expect(logger_1.logger.warn).toHaveBeenCalledWith('Host Event Validation failed: invalid payload');
+        });
+        test('skips Error event when errorType is resolved from data.data.code (nested format)', () => {
+            jest.spyOn(logger_1.logger, 'warn');
+            const errorHandler = jest.fn();
+            const embed = makeEmbed({ useHostEventsV2: true, shouldBypassPayloadValidation: true });
+            embed.on(index_1.EmbedEvent.Error, errorHandler);
+            embed.executeCallbacks(index_1.EmbedEvent.Error, makeNestedValidationData('nested error'));
+            expect(errorHandler).not.toHaveBeenCalled();
+            expect(logger_1.logger.warn).toHaveBeenCalledWith('Host Event Validation failed: nested error');
+        });
+        test('skips Error event when errorType is resolved from data.errorType (flat format)', () => {
+            jest.spyOn(logger_1.logger, 'warn');
+            const errorHandler = jest.fn();
+            const embed = makeEmbed({ useHostEventsV2: true, shouldBypassPayloadValidation: true });
+            embed.on(index_1.EmbedEvent.Error, errorHandler);
+            embed.executeCallbacks(index_1.EmbedEvent.Error, makeFlatValidationData());
+            expect(errorHandler).not.toHaveBeenCalled();
+        });
+        test('delivers Error event to handler when useHostEventsV2 is true and shouldBypassPayloadValidation is undefined', () => {
+            const errorHandler = jest.fn();
+            const embed = makeEmbed({ useHostEventsV2: true, shouldBypassPayloadValidation: undefined });
+            embed.on(index_1.EmbedEvent.Error, errorHandler);
+            embed.executeCallbacks(index_1.EmbedEvent.Error, makeNestedValidationData());
+            expect(errorHandler).toHaveBeenCalled();
+        });
+        test('delivers Error event to handler when useHostEventsV2 is true and shouldBypassPayloadValidation is false', () => {
+            const errorHandler = jest.fn();
+            const embed = makeEmbed({ useHostEventsV2: true, shouldBypassPayloadValidation: false });
+            embed.on(index_1.EmbedEvent.Error, errorHandler);
+            embed.executeCallbacks(index_1.EmbedEvent.Error, makeNestedValidationData());
+            expect(errorHandler).toHaveBeenCalled();
+        });
+        test('skips Error event when useHostEventsV2 is false regardless of shouldBypassPayloadValidation', () => {
+            jest.spyOn(logger_1.logger, 'warn');
+            const errorHandler = jest.fn();
+            const embed = makeEmbed({ useHostEventsV2: false, shouldBypassPayloadValidation: undefined });
+            embed.on(index_1.EmbedEvent.Error, errorHandler);
+            embed.executeCallbacks(index_1.EmbedEvent.Error, makeNestedValidationData());
+            expect(errorHandler).not.toHaveBeenCalled();
+            expect(logger_1.logger.warn).toHaveBeenCalledWith('Host Event Validation failed: invalid payload');
+        });
+        test('logs warning with undefined message when flat format has no nested data', () => {
+            jest.spyOn(logger_1.logger, 'warn');
+            const embed = makeEmbed({ useHostEventsV2: true, shouldBypassPayloadValidation: true });
+            embed.on(index_1.EmbedEvent.Error, jest.fn());
+            embed.executeCallbacks(index_1.EmbedEvent.Error, makeFlatValidationData());
+            expect(logger_1.logger.warn).toHaveBeenCalledWith('Host Event Validation failed: undefined');
+        });
+        test('skips Error event when useHostEventsV2 is false and shouldBypassPayloadValidation is true', () => {
+            jest.spyOn(logger_1.logger, 'warn');
+            const errorHandler = jest.fn();
+            const embed = makeEmbed({ useHostEventsV2: false, shouldBypassPayloadValidation: true });
+            embed.on(index_1.EmbedEvent.Error, errorHandler);
+            embed.executeCallbacks(index_1.EmbedEvent.Error, makeNestedValidationData());
+            expect(errorHandler).not.toHaveBeenCalled();
+            expect(logger_1.logger.warn).toHaveBeenCalledWith('Host Event Validation failed: invalid payload');
+        });
+        test('skips via handleError when shouldBypassPayloadValidation is true', () => {
+            jest.spyOn(logger_1.logger, 'warn');
+            const errorHandler = jest.fn();
+            const embed = makeEmbed({ useHostEventsV2: true, shouldBypassPayloadValidation: true });
+            embed.on(index_1.EmbedEvent.Error, errorHandler);
+            embed.handleError({
+                type: index_1.EmbedEvent.Error,
+                data: {
+                    errorType: 'VALIDATION_ERROR',
+                    message: 'bad payload',
+                    code: types_1.EmbedErrorCodes.HOST_EVENT_VALIDATION,
+                    error: 'bad payload',
+                },
+            });
+            expect(errorHandler).not.toHaveBeenCalled();
+            expect(logger_1.logger.warn).toHaveBeenCalledWith('Host Event Validation failed: bad payload');
+        });
+        test('delivers Error event to EmbedEvent.ALL handler when not skipped', () => {
+            const allHandler = jest.fn();
+            const embed = makeEmbed({ useHostEventsV2: true, shouldBypassPayloadValidation: false });
+            embed.on(index_1.EmbedEvent.ALL, allHandler);
+            embed.executeCallbacks(index_1.EmbedEvent.Error, makeNestedValidationData());
+            expect(allHandler).toHaveBeenCalled();
+        });
+        test('does not skip non-Error events even with HOST_EVENT_VALIDATION error code', () => {
+            const customActionHandler = jest.fn();
+            const embed = makeEmbed({ useHostEventsV2: true, shouldBypassPayloadValidation: false });
+            embed.on(index_1.EmbedEvent.CustomAction, customActionHandler);
+            embed.executeCallbacks(index_1.EmbedEvent.CustomAction, {
+                data: { code: types_1.EmbedErrorCodes.HOST_EVENT_VALIDATION },
+            });
+            expect(customActionHandler).toHaveBeenCalled();
+        });
+        test('does not skip Error events with unrelated error codes', () => {
+            const errorHandler = jest.fn();
+            const embed = makeEmbed({ useHostEventsV2: true, shouldBypassPayloadValidation: false });
+            embed.on(index_1.EmbedEvent.Error, errorHandler);
+            embed.executeCallbacks(index_1.EmbedEvent.Error, {
+                errorType: 'SOME_OTHER_ERROR',
+                message: 'something else failed',
+            });
+            expect(errorHandler).toHaveBeenCalled();
+        });
+    });
 });
 //# sourceMappingURL=ts-embed.spec.js.map