summaryrefslogtreecommitdiffstats
path: root/toolkit/components/antitracking/test/xpcshell/test_validate_strip_on_share_list.js
blob: f8be5fccad90de3eb675adabdb33cb9042d71363 (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
/* Any copyright is dedicated to the Public Domain.
   http://creativecommons.org/publicdomain/zero/1.0/ */

"use strict";

const { JsonSchema } = ChromeUtils.importESModule(
  "resource://gre/modules/JsonSchema.sys.mjs"
);

let stripOnShareMergedList, stripOnShareLGPLParams, stripOnShareList;

async function fetchAndParseList(fileName) {
  let response = await fetch("chrome://global/content/" + fileName);
  if (!response.ok) {
    throw new Error(
      "Error fetching strip-on-share strip list" + response.status
    );
  }
  return await response.json();
}

async function validateSchema(paramList, nameOfList) {
  let schema = {
    $schema: "http://json-schema.org/draft-07/schema#",
    type: "object",
    properties: {
      type: "object",
      properties: {
        queryParams: {
          type: "array",
          items: { type: "string" },
        },
        topLevelSites: {
          type: "array",
          items: { type: "string" },
        },
      },
      required: ["queryParams", "topLevelSites"],
    },
    required: ["global"],
  };

  let validator = new JsonSchema.Validator(schema);
  let { valid, errors } = validator.validate(paramList);

  if (!valid) {
    info(
      nameOfList +
        " JSON contains these validation errors: " +
        JSON.stringify(errors, null, 2)
    );
  }

  Assert.ok(valid, nameOfList + " JSON is valid");
}

// Fetching strip on share list
add_setup(async function () {
  /* globals fetch */

  [stripOnShareList, stripOnShareLGPLParams] = await Promise.all([
    fetchAndParseList("antitracking/StripOnShare.json"),
    fetchAndParseList("antitracking/StripOnShareLGPL.json"),
  ]);

  stripOnShareMergedList = stripOnShareList;

  // Combines the mozilla licensed strip on share param
  // list and the LGPL licensed strip on share param list
  for (const key in stripOnShareLGPLParams) {
    if (Object.hasOwn(stripOnShareMergedList, key)) {
      stripOnShareMergedList[key].queryParams.push(
        ...stripOnShareLGPLParams[key].queryParams
      );
    } else {
      stripOnShareMergedList[key] = stripOnShareLGPLParams[key];
    }
  }
});

// Check if the Strip on Share list contains any duplicate params
add_task(async function test_check_duplicates() {
  for (const domain in stripOnShareMergedList) {
    // Creates a set of query parameters for a given domain to check
    // for duplicates
    let setOfParams = new Set(stripOnShareMergedList[domain].queryParams);

    // If there are duplicates which is known because the sizes of the set
    // and array don't match, then we check which parameters are duplciates
    if (setOfParams.size != stripOnShareMergedList[domain].queryParams.length) {
      let setToCheckDupes = new Set();
      let dupeList = new Set();
      for (let param in stripOnShareMergedList[domain].queryParams) {
        let tempParam = stripOnShareMergedList[domain].queryParams[param];

        if (setToCheckDupes.has(tempParam)) {
          dupeList.add(tempParam);
        } else {
          setToCheckDupes.add(tempParam);
        }
      }

      Assert.equal(
        setOfParams.size,
        stripOnShareMergedList[domain].queryParams.length,
        "There are duplicates rules in " +
          domain +
          ". The duplicate rules are " +
          [...dupeList]
      );
    }

    Assert.equal(
      setOfParams.size,
      stripOnShareMergedList[domain].queryParams.length,
      "There are no duplicates rules."
    );
  }
});

// Validate the format of Strip on Share list with Schema
add_task(async function test_check_schema() {
  validateSchema(stripOnShareLGPLParams, "Strip On Share LGPL");
  validateSchema(stripOnShareList, "Strip On Share");
});