// (C) 2007-2019 GoodData Corporation import { IHeadlineData } from "../../../../../interfaces/Headlines"; import * as headerPredicateFactory from "../../../../../factory/HeaderPredicateFactory"; import { getHeadlineData, applyDrillableItems, buildDrillEventData } from "../HeadlineTransformationUtils"; import { SINGLE_URI_METRIC_EXECUTION_REQUEST, SINGLE_IDENTIFIER_METRIC_EXECUTION_REQUEST, SINGLE_METRIC_EXECUTION_RESPONSE, SINGLE_METRIC_EXECUTION_RESULT, } from "../../test/fixtures/one_measure"; import { EMPTY_FIRST_MEASURE_VALUE_EXECUTION_RESULT, EMPTY_MEASURE_VALUES_EXECUTION_RESULT, EMPTY_SECOND_MEASURE_VALUE_EXECUTION_RESULT, TWO_MEASURES_EXECUTION_RESPONSE, TWO_MEASURES_EXECUTION_RESULT, TWO_MEASURES_WITH_IDENTIFIER_EXECUTION_REQUEST, TWO_MEASURES_WITH_URI_EXECUTION_REQUEST, ZERO_FIRST_MEASURE_VALUE_EXECUTION_RESULT, ZERO_MEASURE_VALUES_EXECUTION_RESULT, ZERO_SECOND_MEASURE_VALUE_EXECUTION_RESULT, SAME_MEASURE_VALUES_EXECUTION_RESULT, } from "../../test/fixtures/two_measures"; import { createIntlMock } from "../../../utils/intlUtils"; import { IHeadlineDrillItemContext } from "../../types"; describe("HeadlineTransformationUtils", () => { describe("getData", () => { it("should set primary item data from the execution", () => { const intl = createIntlMock(); const data = getHeadlineData( SINGLE_METRIC_EXECUTION_RESPONSE, SINGLE_METRIC_EXECUTION_RESULT, intl, ); expect(data).toEqual({ primaryItem: { localIdentifier: "m1", title: "Lost", value: "42470571.16", format: "$#,##0.00", isDrillable: false, }, }); }); it("should set primary, secondary and tertiary item data from the execution", () => { const intl = createIntlMock(); const data = getHeadlineData( TWO_MEASURES_EXECUTION_RESPONSE, TWO_MEASURES_EXECUTION_RESULT, intl, ); expect(data).toEqual({ primaryItem: { localIdentifier: "m1", title: "Lost", value: "42470571.16", format: "$#,##0.00", isDrillable: false, }, secondaryItem: { localIdentifier: "m2", title: "Found", value: "12345678", format: "$#,##0.00", isDrillable: false, }, tertiaryItem: { localIdentifier: "tertiaryIdentifier", value: "244.01165460495565", format: null, title: "Versus", isDrillable: false, }, }); }); it("should set null for tertiary value when primary value is null", () => { const intl = createIntlMock(); const data = getHeadlineData( TWO_MEASURES_EXECUTION_RESPONSE, EMPTY_FIRST_MEASURE_VALUE_EXECUTION_RESULT, intl, ); expect(data).toEqual({ primaryItem: { localIdentifier: "m1", title: "Lost", value: null, format: "$#,##0.00", isDrillable: false, }, secondaryItem: { localIdentifier: "m2", title: "Found", value: "12345678", format: "$#,##0.00", isDrillable: false, }, tertiaryItem: { localIdentifier: "tertiaryIdentifier", value: null, format: null, title: "Versus", isDrillable: false, }, }); }); it("should set null for tertiary value when secondary value is null", () => { const intl = createIntlMock(); const data = getHeadlineData( TWO_MEASURES_EXECUTION_RESPONSE, EMPTY_SECOND_MEASURE_VALUE_EXECUTION_RESULT, intl, ); expect(data).toEqual({ primaryItem: { localIdentifier: "m1", title: "Lost", value: "42470571.16", format: "$#,##0.00", isDrillable: false, }, secondaryItem: { localIdentifier: "m2", title: "Found", value: null, format: "$#,##0.00", isDrillable: false, }, tertiaryItem: { localIdentifier: "tertiaryIdentifier", value: null, format: null, title: "Versus", isDrillable: false, }, }); }); it("should set null for tertiary value when both primary & secondary values are null", () => { const intl = createIntlMock(); const data = getHeadlineData( TWO_MEASURES_EXECUTION_RESPONSE, EMPTY_MEASURE_VALUES_EXECUTION_RESULT, intl, ); expect(data).toEqual({ primaryItem: { localIdentifier: "m1", title: "Lost", value: null, format: "$#,##0.00", isDrillable: false, }, secondaryItem: { localIdentifier: "m2", title: "Found", value: null, format: "$#,##0.00", isDrillable: false, }, tertiaryItem: { localIdentifier: "tertiaryIdentifier", value: null, format: null, title: "Versus", isDrillable: false, }, }); }); it("should set -100 for tertiary value when primary value is 0", () => { const intl = createIntlMock(); const data = getHeadlineData( TWO_MEASURES_EXECUTION_RESPONSE, ZERO_FIRST_MEASURE_VALUE_EXECUTION_RESULT, intl, ); expect(data).toEqual({ primaryItem: { localIdentifier: "m1", title: "Lost", value: "0", format: "$#,##0.00", isDrillable: false, }, secondaryItem: { localIdentifier: "m2", title: "Found", value: "12345678", format: "$#,##0.00", isDrillable: false, }, tertiaryItem: { localIdentifier: "tertiaryIdentifier", value: "-100", format: null, title: "Versus", isDrillable: false, }, }); }); it("should set null for tertiary value when secondary value is 0", () => { const intl = createIntlMock(); const data = getHeadlineData( TWO_MEASURES_EXECUTION_RESPONSE, ZERO_SECOND_MEASURE_VALUE_EXECUTION_RESULT, intl, ); expect(data).toEqual({ primaryItem: { localIdentifier: "m1", title: "Lost", value: "42470571.16", format: "$#,##0.00", isDrillable: false, }, secondaryItem: { localIdentifier: "m2", title: "Found", value: "0", format: "$#,##0.00", isDrillable: false, }, tertiaryItem: { localIdentifier: "tertiaryIdentifier", value: null, format: null, title: "Versus", isDrillable: false, }, }); }); it("should set null for tertiary value when both primary & secondary values are 0", () => { const intl = createIntlMock(); const data = getHeadlineData( TWO_MEASURES_EXECUTION_RESPONSE, ZERO_MEASURE_VALUES_EXECUTION_RESULT, intl, ); expect(data).toEqual({ primaryItem: { localIdentifier: "m1", title: "Lost", value: "0", format: "$#,##0.00", isDrillable: false, }, secondaryItem: { localIdentifier: "m2", title: "Found", value: "0", format: "$#,##0.00", isDrillable: false, }, tertiaryItem: { localIdentifier: "tertiaryIdentifier", value: null, format: null, title: "Versus", isDrillable: false, }, }); }); it("should set 0 for tertiary value when both primary & secondary are the same values except 0", () => { const intl = createIntlMock(); const data = getHeadlineData( TWO_MEASURES_EXECUTION_RESPONSE, SAME_MEASURE_VALUES_EXECUTION_RESULT, intl, ); expect(data).toEqual({ primaryItem: { localIdentifier: "m1", title: "Lost", value: "1234", format: "$#,##0.00", isDrillable: false, }, secondaryItem: { localIdentifier: "m2", title: "Found", value: "1234", format: "$#,##0.00", isDrillable: false, }, tertiaryItem: { localIdentifier: "tertiaryIdentifier", value: "0", format: null, title: "Versus", isDrillable: false, }, }); }); }); describe("applyDrillableItems", () => { it("should NOT throw any error when drillable items do not match defined headline or execution data", () => { const headlineData = {}; const data = applyDrillableItems( headlineData as IHeadlineData, [headerPredicateFactory.uriMatch("some-uri")], TWO_MEASURES_WITH_URI_EXECUTION_REQUEST, TWO_MEASURES_EXECUTION_RESPONSE, ); expect(data).toEqual({}); }); it("should reset drilling state of every item when drillable items does not match any header item", () => { const data = { primaryItem: { localIdentifier: "m1", title: "Lost", value: "120", isDrillable: true, }, }; const updatedData = applyDrillableItems( data, [headerPredicateFactory.uriMatch("some-uri")], TWO_MEASURES_WITH_URI_EXECUTION_REQUEST, TWO_MEASURES_EXECUTION_RESPONSE, ); expect(updatedData).toEqual({ primaryItem: { localIdentifier: "m1", title: "Lost", value: "120", isDrillable: false, }, }); }); it("should enable drilling of the primary item identified by the drillable item uri", () => { const data = applyDrillableItems( { primaryItem: { localIdentifier: "m1", title: "Lost", value: "120", isDrillable: false, }, }, [headerPredicateFactory.uriMatch("/gdc/md/project_id/obj/1")], SINGLE_URI_METRIC_EXECUTION_REQUEST, SINGLE_METRIC_EXECUTION_RESPONSE, ); expect(data).toEqual({ primaryItem: { localIdentifier: "m1", title: "Lost", value: "120", isDrillable: true, }, }); }); it("should enable drilling of the primary item identified by the drillable item identifier", () => { const data = applyDrillableItems( { primaryItem: { localIdentifier: "m1", title: "Lost", value: "120", isDrillable: false, }, }, [headerPredicateFactory.identifierMatch("metric.lost")], SINGLE_IDENTIFIER_METRIC_EXECUTION_REQUEST, SINGLE_METRIC_EXECUTION_RESPONSE, ); expect(data).toEqual({ primaryItem: { localIdentifier: "m1", title: "Lost", value: "120", isDrillable: true, }, }); }); it("should enable drilling of the secondary item identified by the drillable item uri", () => { const headlineData = { secondaryItem: { localIdentifier: "m2", title: "Found", value: "220", isDrillable: false, }, }; const data = applyDrillableItems( headlineData as IHeadlineData, [headerPredicateFactory.uriMatch("/gdc/md/project_id/obj/2")], TWO_MEASURES_WITH_URI_EXECUTION_REQUEST, TWO_MEASURES_EXECUTION_RESPONSE, ); expect(data).toEqual({ secondaryItem: { localIdentifier: "m2", title: "Found", value: "220", isDrillable: true, }, }); }); it("should enable drilling of the secondary item identified by the drillable item identifier", () => { const headlineData = { secondaryItem: { localIdentifier: "m2", title: "Found", value: "220", isDrillable: false, }, }; const data = applyDrillableItems( headlineData as IHeadlineData, [headerPredicateFactory.identifierMatch("measure.found")], TWO_MEASURES_WITH_IDENTIFIER_EXECUTION_REQUEST, TWO_MEASURES_EXECUTION_RESPONSE, ); expect(data).toEqual({ secondaryItem: { localIdentifier: "m2", title: "Found", value: "220", isDrillable: true, }, }); }); it("should enable drilling of the both items (primary, secondary)", () => { const data = applyDrillableItems( { primaryItem: { localIdentifier: "m1", title: "Lost", value: "120", isDrillable: false, }, secondaryItem: { localIdentifier: "m2", title: "Found", value: "220", isDrillable: false, }, }, [ headerPredicateFactory.identifierMatch("measure.lost"), headerPredicateFactory.uriMatch("/gdc/md/project_id/obj/1"), headerPredicateFactory.uriMatch("/gdc/md/project_id/obj/2"), ], TWO_MEASURES_WITH_URI_EXECUTION_REQUEST, TWO_MEASURES_EXECUTION_RESPONSE, ); expect(data).toEqual({ primaryItem: { localIdentifier: "m1", title: "Lost", value: "120", isDrillable: true, }, secondaryItem: { localIdentifier: "m2", title: "Found", value: "220", isDrillable: true, }, }); }); it("should treat provided data object as immutable", () => { const data = { primaryItem: { localIdentifier: "m1", title: "Lost", value: "120", isDrillable: false, }, }; const updatedData = applyDrillableItems( data, [ headerPredicateFactory.identifierMatch("metric.lost"), headerPredicateFactory.uriMatch("/gdc/md/project_id/obj/1"), ], SINGLE_URI_METRIC_EXECUTION_REQUEST, SINGLE_METRIC_EXECUTION_RESPONSE, ); expect(updatedData).toEqual({ primaryItem: { localIdentifier: "m1", title: "Lost", value: "120", isDrillable: true, }, }); expect(data.primaryItem.isDrillable).toEqual(false); }); }); describe("buildDrillEventData", () => { it("should build expected drill event data from execution request made with metric uri", () => { const itemContext: IHeadlineDrillItemContext = { localIdentifier: "m1", element: "primaryValue", value: "42", }; const eventData = buildDrillEventData( itemContext, SINGLE_URI_METRIC_EXECUTION_REQUEST, SINGLE_METRIC_EXECUTION_RESPONSE, ); expect(eventData).toEqual({ executionContext: { measures: [ { localIdentifier: "m1", definition: { measure: { item: { uri: "/gdc/md/project_id/obj/1", }, }, }, }, ], }, drillContext: { type: "headline", element: "primaryValue", value: "42", intersection: [ { header: { measureHeaderItem: { name: "Lost", format: "$#,##0.00", localIdentifier: "m1", uri: "/gdc/md/project_id/obj/1", identifier: "metric.lost", }, }, }, ], }, }); }); it("should build expected drill event data from execution request made with metric identifier", () => { const itemContext: IHeadlineDrillItemContext = { localIdentifier: "m1", element: "primaryValue", value: "42", }; const eventData = buildDrillEventData( itemContext, SINGLE_IDENTIFIER_METRIC_EXECUTION_REQUEST, SINGLE_METRIC_EXECUTION_RESPONSE, ); expect(eventData).toEqual({ executionContext: { measures: [ { localIdentifier: "m1", definition: { measure: { item: { identifier: "metric.lost", }, }, }, }, ], }, drillContext: { type: "headline", element: "primaryValue", value: "42", intersection: [ { header: { measureHeaderItem: { name: "Lost", format: "$#,##0.00", localIdentifier: "m1", uri: "/gdc/md/project_id/obj/1", identifier: "metric.lost", }, }, }, ], }, }); }); it("should build drill event data from execution for secondary value", () => { const itemContext: IHeadlineDrillItemContext = { localIdentifier: "m2", element: "secondaryValue", value: "12345678", }; const eventData = buildDrillEventData( itemContext, TWO_MEASURES_WITH_URI_EXECUTION_REQUEST, TWO_MEASURES_EXECUTION_RESPONSE, ); expect(eventData).toEqual({ executionContext: { measures: [ { localIdentifier: "m1", definition: { measure: { item: { uri: "/gdc/md/project_id/obj/1", }, }, }, }, { localIdentifier: "m2", definition: { measure: { item: { uri: "/gdc/md/project_id/obj/2", }, }, }, }, ], }, drillContext: { type: "headline", element: "secondaryValue", value: "12345678", intersection: [ { header: { measureHeaderItem: { name: "Found", format: "$#,##0.00", localIdentifier: "m2", }, }, }, ], }, }); }); it("should throw exception when metric from item context is not found in the execution response.", () => { const itemContext: IHeadlineDrillItemContext = { localIdentifier: "abc", element: "primaryValue", value: "42", }; expect(() => buildDrillEventData( itemContext, SINGLE_URI_METRIC_EXECUTION_REQUEST, SINGLE_METRIC_EXECUTION_RESPONSE, ), ).toThrow(); }); }); });