summaryrefslogtreecommitdiffstats
path: root/browser/components/search/test/browser/telemetry/browser_search_telemetry_adImpression_component_skipCount_children.js
blob: 6f4f5d7ec1a2ef45e83fe243e7a24786bcdd6672 (plain)
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
/* Any copyright is dedicated to the Public Domain.
 * http://creativecommons.org/publicdomain/zero/1.0/ */

"use strict";

/**
 * Tests skipCount property on elements in the children.
 */

const TEST_PROVIDER_INFO = [
  {
    telemetryId: "example",
    searchPageRegexp:
      /^https:\/\/example.org\/browser\/browser\/components\/search\/test\/browser\/telemetry\/searchTelemetryAd/,
    queryParamNames: ["s"],
    codeParamName: "abc",
    taggedCodes: ["ff"],
    adServerAttributes: ["mozAttr"],
    extraAdServersRegexps: [/^https:\/\/example\.com\/ad/],
  },
];

const IMPRESSION = {
  provider: "example",
  tagged: "true",
  partner_code: "ff",
  source: "unknown",
  is_shopping_page: "false",
  is_private: "false",
  shopping_tab_displayed: "false",
  is_signed_in: "false",
};

const SERP_URL = getSERPUrl("searchTelemetryAd_searchbox_with_content.html");

async function replaceIncludedProperty(included) {
  let components = [
    {
      type: SearchSERPTelemetryUtils.COMPONENTS.REFINED_SEARCH_BUTTONS,
      included,
      topDown: true,
    },
  ];
  TEST_PROVIDER_INFO[0].components = components;
  SearchSERPTelemetry.overrideSearchTelemetryForTests(TEST_PROVIDER_INFO);
  await waitForIdle();
}

add_setup(async function () {
  SearchSERPTelemetry.overrideSearchTelemetryForTests(TEST_PROVIDER_INFO);
  await waitForIdle();
  // Enable local telemetry recording for the duration of the tests.
  let oldCanRecord = Services.telemetry.canRecordExtended;
  Services.telemetry.canRecordExtended = true;

  registerCleanupFunction(async () => {
    SearchSERPTelemetry.overrideSearchTelemetryForTests();
    Services.telemetry.canRecordExtended = oldCanRecord;
    resetTelemetry();
  });
});

// For older clients, skipCount won't be available.
add_task(async function test_skip_count_not_provided() {
  await replaceIncludedProperty({
    parent: {
      selector: ".refined-search-buttons",
    },
    children: [
      {
        selector: "a",
      },
    ],
  });

  let { cleanup } = await openSerpInNewTab(SERP_URL);

  assertSERPTelemetry([
    {
      impression: IMPRESSION,
      adImpressions: [
        {
          component: SearchSERPTelemetryUtils.COMPONENTS.REFINED_SEARCH_BUTTONS,
          ads_loaded: "1",
          ads_visible: "1",
          ads_hidden: "0",
        },
      ],
    },
  ]);

  await cleanup();
});

add_task(async function test_skip_count_is_false() {
  await replaceIncludedProperty({
    parent: {
      selector: ".refined-search-buttons",
    },
    children: [
      {
        selector: "a",
        skipCount: false,
      },
    ],
  });

  let { cleanup } = await openSerpInNewTab(SERP_URL);

  assertSERPTelemetry([
    {
      impression: IMPRESSION,
      adImpressions: [
        {
          component: SearchSERPTelemetryUtils.COMPONENTS.REFINED_SEARCH_BUTTONS,
          ads_loaded: "1",
          ads_visible: "1",
          ads_hidden: "0",
        },
      ],
    },
  ]);

  await cleanup();
});

add_task(async function test_skip_count_is_true() {
  await replaceIncludedProperty({
    parent: {
      selector: ".refined-search-buttons",
    },
    children: [
      {
        selector: "a",
        skipCount: true,
      },
    ],
  });

  let { cleanup } = await openSerpInNewTab(SERP_URL);

  assertSERPTelemetry([
    {
      impression: IMPRESSION,
      adImpressions: [],
    },
  ]);

  await cleanup();
});