-
Notifications
You must be signed in to change notification settings - Fork 22
/
managedStorage.ts
194 lines (169 loc) · 6.3 KB
/
managedStorage.ts
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
/*
* Copyright (C) 2024 PixieBrix, Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
import { type ManagedStorageState } from "@/store/enterprise/managedStorageTypes";
import { isEmpty, once } from "lodash";
import { expectContext } from "@/utils/expectContext";
import pMemoize, { pMemoizeClear } from "p-memoize";
import { pollUntilTruthy } from "@/utils/promiseUtils";
const MAX_MANAGED_STORAGE_WAIT_MILLIS = 2000;
/**
* The managedStorageState, or undefined if it hasn't been initialized yet.
*/
let managedStorageState: ManagedStorageState | undefined;
// TODO: Use `SimpleEventTarget` instead
// eslint-disable-next-line local-rules/persistBackgroundData -- Functions
const listeners = new Set<(state: ManagedStorageState) => void>();
function notifyAll(managedStorageState: ManagedStorageState): void {
for (const listener of listeners) {
listener(managedStorageState);
}
}
async function readManagedStorageImmediately(): Promise<ManagedStorageState> {
try {
// Get all managed storage values
return await browser.storage.managed.get(null);
} catch {
// Handle Opera: https://github.com/pixiebrix/pixiebrix-extension/issues/4069
// We don't officially support Opera, but to keep the error telemetry clean if someone installs on Opera
return {};
}
}
// It's possible that managed storage is not available on the initial install event
// Privacy Badger does a looping check for managed storage
// - https://github.com/EFForg/privacybadger/blob/aeed0539603356a2825e7ce8472f6478abdc85fb/src/js/storage.js
// - https://github.com/EFForg/privacybadger/issues/2770#issuecomment-853329201
// - https://github.com/uBlockOrigin/uBlock-issues/issues/1660#issuecomment-880150676
// uBlock (still) contains a workaround to automatically reload the extension on initial install
// - https://github.com/gorhill/uBlock/commit/32bd47f05368557044dd3441dcaa414b7b009b39
const waitForInitialManagedStorage = pMemoize(async () => {
managedStorageState = await pollUntilTruthy<ManagedStorageState | undefined>(
async () => {
const values = await readManagedStorageImmediately();
if (typeof values === "object" && !isEmpty(values)) {
return values;
}
},
{
maxWaitMillis: MAX_MANAGED_STORAGE_WAIT_MILLIS,
},
);
if (managedStorageState) {
notifyAll(managedStorageState);
console.info("Read managed storage settings", {
managedStorageState,
});
} else {
console.info("No manual storage settings found", {
managedStorageState,
});
}
return managedStorageState;
});
/**
* Initialize the managed storage state and listen for changes. Safe to call multiple times.
*/
export const initManagedStorage = once(() => {
expectContext("extension");
try {
// https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/storage/onChanged
// `browser.storage.managed.onChanged` might also exist, but it's not available in testing
// See: https://github.com/clarkbw/jest-webextension-mock/issues/170
browser.storage.onChanged.addListener(async (changes, area) => {
if (area === "managed") {
managedStorageState = await readManagedStorageImmediately();
notifyAll(managedStorageState);
}
});
} catch (error) {
// Handle Opera: https://github.com/pixiebrix/pixiebrix-extension/issues/4069
console.warn(
"Not listening for managed storage changes because managed storage is not supported",
{ error },
);
}
void waitForInitialManagedStorage();
});
/**
* Read a single-value from enterprise managed storage.
*
* If managed storage has not been initialized yet, reads from the managed storage API. Waits up to
* MAX_MANAGED_STORAGE_WAIT_MILLIS for the data to be available.
*
* @param key the key to read.
* @see MAX_MANAGED_STORAGE_WAIT_MILLIS
*/
export async function readManagedStorageByKey<
K extends keyof ManagedStorageState,
>(key: K): Promise<ManagedStorageState[K]> {
expectContext("extension");
if (managedStorageState != null) {
// eslint-disable-next-line security/detect-object-injection -- type-checked key
return managedStorageState[key];
}
initManagedStorage();
const storage = (await waitForInitialManagedStorage()) ?? {};
// eslint-disable-next-line security/detect-object-injection -- type-checked key
return storage[key];
}
/**
* Read a managed storage state from enterprise managed storage.
*
* If managed storage has not been initialized yet, reads from the managed storage API. Waits up to
* MAX_MANAGED_STORAGE_WAIT_MILLIS for the data to be available.
*
* @see MAX_MANAGED_STORAGE_WAIT_MILLIS
*/
export async function readManagedStorage(): Promise<ManagedStorageState> {
expectContext("extension");
if (managedStorageState != null) {
return managedStorageState;
}
initManagedStorage();
return (await waitForInitialManagedStorage()) ?? {};
}
/**
* Get a _synchronous_ snapshot of the managed storage state.
* @see useManagedStorageState
* @see readManagedStorage
*/
export function getSnapshot(): ManagedStorageState | undefined {
expectContext("extension");
return managedStorageState;
}
/**
* Subscribe to changes in the managed storage state. In practice, this should only fire once because managed
* storage is not mutable.
* @param callback to receive the updated state.
* @see useManagedStorageState
*/
export function subscribe(
callback: (state: ManagedStorageState) => void,
): () => void {
expectContext("extension");
listeners.add(callback);
return () => {
listeners.delete(callback);
};
}
/**
* Helper method for resetting the module for testing.
*/
export function INTERNAL_reset(): void {
managedStorageState = undefined;
listeners.clear();
pMemoizeClear(waitForInitialManagedStorage);
}