summaryrefslogtreecommitdiffstats
path: root/browser/components/shopping/tests/browser/browser_review_highlights.js
blob: f4f3467a800eab699488dd405b96cb8694da807c (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
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
/* Any copyright is dedicated to the Public Domain.
 * http://creativecommons.org/publicdomain/zero/1.0/ */

"use strict";

async function verifyHighlights(
  browser,
  data,
  productUrl /* optional, set to override */,
  expectedHighlightTypes,
  expectedLang
) {
  return SpecialPowers.spawn(
    browser,
    [{ data, productUrl, expectedHighlightTypes, expectedLang }],
    async args => {
      let shoppingContainer =
        content.document.querySelector("shopping-container").wrappedJSObject;
      shoppingContainer.data = Cu.cloneInto(args.data, content);
      if (args.productUrl) {
        shoppingContainer.productUrl = args.productUrl;
      }
      await shoppingContainer.updateComplete;

      let reviewHighlights = shoppingContainer.highlightsEl;
      ok(reviewHighlights, "Got review-highlights");
      await reviewHighlights.updateComplete;

      let highlightsList = reviewHighlights.reviewHighlightsListEl;
      await highlightsList.updateComplete;

      is(
        highlightsList.children.length,
        args.expectedHighlightTypes.length,
        "review-highlights should have the right number of highlight-items"
      );

      // Verify number of reviews for each available highlight
      for (let key of args.expectedHighlightTypes) {
        let highlightEl = highlightsList.querySelector(
          `#${content.CSS.escape(key)}`
        );

        ok(highlightEl, "highlight-item for " + key + " exists");
        is(
          highlightEl.lang,
          args.expectedLang,
          `highlight-item should have lang set to ${args.expectedLang}`
        );

        let actualNumberOfReviews = highlightEl.shadowRoot.querySelector(
          ".highlight-details-list"
        ).children.length;
        let expectedNumberOfReviews = Object.values(
          args.data.highlights[key]
        ).flat().length;

        is(
          actualNumberOfReviews,
          expectedNumberOfReviews,
          "There should be equal number of reviews displayed for " + key
        );
      }
    }
  );
}

/**
 * Tests that the review highlights custom components are visible on the page
 * if there is valid data.
 */
add_task(async function test_review_highlights() {
  await BrowserTestUtils.withNewTab(
    {
      url: "about:shoppingsidebar",
      gBrowser,
    },
    async browser => {
      let data = MOCK_ANALYZED_PRODUCT_RESPONSE;
      let expectedHighlightTypes = [
        "price",
        "quality",
        "competitiveness",
        "packaging/appearance",
      ];

      info("Testing with default en highlights");
      await verifyHighlights(
        browser,
        data,
        undefined,
        expectedHighlightTypes,
        "en"
      );

      info("Testing with www.amazon.fr");
      await verifyHighlights(
        browser,
        data,
        "https://www.amazon.fr",
        expectedHighlightTypes,
        "fr"
      );

      info("Testing with www.amazon.de");
      await verifyHighlights(
        browser,
        data,
        "https://www.amazon.de",
        expectedHighlightTypes,
        "de"
      );
    }
  );
});

/**
 * Tests that entire highlights components is still hidden if we receive falsy data.
 */
add_task(async function test_review_highlights_no_highlights() {
  await BrowserTestUtils.withNewTab(
    {
      url: "about:shoppingsidebar",
      gBrowser,
    },
    async browser => {
      await SpecialPowers.spawn(
        browser,
        [MOCK_ANALYZED_PRODUCT_RESPONSE],
        async mockData => {
          mockData.highlights = null;

          let shoppingContainer =
            content.document.querySelector(
              "shopping-container"
            ).wrappedJSObject;
          shoppingContainer.data = Cu.cloneInto(mockData, content);
          await shoppingContainer.updateComplete;

          let reviewHighlights = shoppingContainer.highlightsEl;
          ok(reviewHighlights, "Got review-highlights");
          await reviewHighlights.updateComplete;

          ok(
            ContentTaskUtils.isHidden(reviewHighlights),
            "review-highlights should not be visible"
          );

          let highlightsList = reviewHighlights?.reviewHighlightsListEl;
          ok(!highlightsList, "review-highlights-list should not be visible");
        }
      );
    }
  );
});

/**
 * Tests that we do not show an invalid highlight type and properly filter data.
 */
add_task(async function test_review_highlights_invalid_type() {
  await BrowserTestUtils.withNewTab(
    {
      url: "about:shoppingsidebar",
      gBrowser,
    },
    async browser => {
      const invalidHighlightData = structuredClone(
        MOCK_ANALYZED_PRODUCT_RESPONSE
      );
      invalidHighlightData.highlights = MOCK_INVALID_KEY_OBJ;
      await SpecialPowers.spawn(
        browser,
        [invalidHighlightData],
        async mockData => {
          let shoppingContainer =
            content.document.querySelector(
              "shopping-container"
            ).wrappedJSObject;
          shoppingContainer.data = Cu.cloneInto(mockData, content);
          await shoppingContainer.updateComplete;

          let reviewHighlights = shoppingContainer.highlightsEl;
          ok(reviewHighlights, "Got review-highlights");
          await reviewHighlights.updateComplete;

          ok(
            ContentTaskUtils.isHidden(reviewHighlights),
            "review-highlights should not be visible"
          );
        }
      );
    }
  );
});