summaryrefslogtreecommitdiffstats
path: root/toolkit/components/extensions/ExtensionDNRLimits.sys.mjs
blob: 12919e4ee1a265db4f103bc4bea2cf59e5d146e1 (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
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

import { XPCOMUtils } from "resource://gre/modules/XPCOMUtils.sys.mjs";

// TODO(Bug 1803370): allow extension to exceed the GUARANTEED_MINIMUM_STATIC_RULES limit.
//
// The maximum number of static rules exceeding the per-extension
// GUARANTEED_MINIMUM_STATIC_RULES across every extensions.
//
// const MAX_GLOBAL_NUMBER_OF_STATIC_RULES = 300000;

const lazy = {};

XPCOMUtils.defineLazyPreferenceGetter(
  lazy,
  "GUARANTEED_MINIMUM_STATIC_RULES",
  "extensions.dnr.guaranteed_minimum_static_rules",
  30000
);

XPCOMUtils.defineLazyPreferenceGetter(
  lazy,
  "MAX_NUMBER_OF_STATIC_RULESETS",
  "extensions.dnr.max_number_of_static_rulesets",
  100
);

XPCOMUtils.defineLazyPreferenceGetter(
  lazy,
  "MAX_NUMBER_OF_ENABLED_STATIC_RULESETS",
  "extensions.dnr.max_number_of_enabled_static_rulesets",
  20
);

/**
 * NOTE: this limit may be increased in the future, see
 * https://github.com/w3c/webextensions/issues/319
 */
XPCOMUtils.defineLazyPreferenceGetter(
  lazy,
  "MAX_NUMBER_OF_DYNAMIC_AND_SESSION_RULES",
  "extensions.dnr.max_number_of_dynamic_and_session_rules",
  5000
);

// TODO bug 1821033: Bump limit after optimizing regexFilter.
XPCOMUtils.defineLazyPreferenceGetter(
  lazy,
  "MAX_NUMBER_OF_REGEX_RULES",
  "extensions.dnr.max_number_of_regex_rules",
  1000
);

export const ExtensionDNRLimits = {
  /**
   * The minimum number of static rules guaranteed to an extension across its
   * enabled static rulesets. Any rules above this limit will count towards the
   * global static rule limit.
   */
  get GUARANTEED_MINIMUM_STATIC_RULES() {
    return lazy.GUARANTEED_MINIMUM_STATIC_RULES;
  },

  /**
   * The maximum number of static Rulesets an extension can specify as part of
   * the "rule_resources" manifest key.
   */
  get MAX_NUMBER_OF_STATIC_RULESETS() {
    return lazy.MAX_NUMBER_OF_STATIC_RULESETS;
  },

  /**
   * The maximum number of static Rulesets an extension can enable at any one
   * time.
   */
  get MAX_NUMBER_OF_ENABLED_STATIC_RULESETS() {
    return lazy.MAX_NUMBER_OF_ENABLED_STATIC_RULESETS;
  },

  /**
   * The maximum number of dynamic and session rules an extension can add.
   *
   * NOTE: in the Firefox we are enforcing this limit to the session and
   * dynamic rules count separately, instead of enforcing it to the rules count
   * for both combined as the Chrome implementation does.
   */
  get MAX_NUMBER_OF_DYNAMIC_AND_SESSION_RULES() {
    return lazy.MAX_NUMBER_OF_DYNAMIC_AND_SESSION_RULES;
  },

  /**
   * The maximum number of regular expression rules that an extension can add.
   * Session, dynamic and static rules have their own quota.
   */
  get MAX_NUMBER_OF_REGEX_RULES() {
    return lazy.MAX_NUMBER_OF_REGEX_RULES;
  },
};