Skip to content

Commit 972a6ce

Browse files
MoeBazziGITxeenon
MoeBazziGIT
authored and
xeenon
committed
Implement browser.storageArea.getKeys() for Web Extension Storage API.
https://bugs.webkit.org/show_bug.cgi?id=280275 Reviewed by Timothy Hatcher. This patch implements a web extension API to retrieve all keys for a given storage area in the browser.storage API. WECG Proposal: https://github.com/w3c/webextensions/blob/main/proposals/storage-get-keys.md WECG Original Issue: w3c/webextensions#601 This patch also includes the following clean-ups: - Change 'auto' to 'auto *' when assigning the result of WebExtensionContext::storageForType() to explicitly denote pointer type. - Update strongSelf retrieval to in _WKWebExtensionStorageSQLiteStore.mm methods to leverage ARC in extension code, allowing the use of Objective-C pointers instead of RetainPtr, which is only necessary in other parts of WebKit that do not utilize ARC. - Remove unnecessary explicit template types from WeakObjCPtr in _WKWebExtensionStorageSQLiteStore. * Source/WebKit/UIProcess/Extensions/Cocoa/API/WebExtensionContextAPIStorageCocoa.mm: (WebKit::WebExtensionContext::storageGet): (WebKit::WebExtensionContext::storageGetKeys): (WebKit::WebExtensionContext::storageGetBytesInUse): * Source/WebKit/UIProcess/Extensions/Cocoa/_WKWebExtensionStorageSQLiteStore.h: * Source/WebKit/UIProcess/Extensions/Cocoa/_WKWebExtensionStorageSQLiteStore.mm: (-[_WKWebExtensionStorageSQLiteStore getAllKeys:]): (-[_WKWebExtensionStorageSQLiteStore getValuesForKeys:completionHandler:]): (-[_WKWebExtensionStorageSQLiteStore getStorageSizeForKeys:completionHandler:]): (-[_WKWebExtensionStorageSQLiteStore getStorageSizeForAllKeysIncludingKeyedData:withCompletionHandler:]): (-[_WKWebExtensionStorageSQLiteStore setKeyedData:completionHandler:]): (-[_WKWebExtensionStorageSQLiteStore deleteValuesForKeys:completionHandler:]): * Source/WebKit/UIProcess/Extensions/WebExtensionContext.h: * Source/WebKit/UIProcess/Extensions/WebExtensionContext.messages.in: * Source/WebKit/WebProcess/Extensions/API/Cocoa/WebExtensionAPIStorageAreaCocoa.mm: (WebKit::WebExtensionAPIStorageArea::getKeys): * Source/WebKit/WebProcess/Extensions/API/WebExtensionAPIStorageArea.h: * Source/WebKit/WebProcess/Extensions/Interfaces/WebExtensionAPIStorageArea.idl: * Tools/TestWebKitAPI/Tests/WebKitCocoa/WKWebExtensionAPIStorage.mm: (TestWebKitAPI::TEST(WKWebExtensionAPIStorage, Errors)): (TestWebKitAPI::TEST(WKWebExtensionAPIStorage, GetKeys)): Canonical link: https://commits.webkit.org/284602@main
1 parent 85240f4 commit 972a6ce

File tree

9 files changed

+96
-14
lines changed

9 files changed

+96
-14
lines changed

‎Source/WebKit/UIProcess/Extensions/Cocoa/API/WebExtensionContextAPIStorageCocoa.mm‎

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@
5555
{
5656
auto callingAPIName = makeString("browser.storage."_s, toAPIString(dataType), ".get()"_s);
5757

58-
auto storage = storageForType(dataType);
58+
auto *storage = storageForType(dataType);
5959
[storage getValuesForKeys:createNSArray(keys).get() completionHandler:makeBlockPtr([callingAPIName, completionHandler = WTFMove(completionHandler)](NSDictionary<NSString *, NSString *> *values, NSString *errorMessage) mutable {
6060
if (errorMessage)
6161
completionHandler(toWebExtensionError(callingAPIName, nil, errorMessage));
@@ -64,11 +64,24 @@
6464
}).get()];
6565
}
6666

67+
void WebExtensionContext::storageGetKeys(WebPageProxyIdentifier webPageProxyIdentifier, WebExtensionDataType dataType, CompletionHandler<void(Expected<Vector<String>, WebExtensionError>&&)>&& completionHandler)
68+
{
69+
auto callingAPIName = makeString("browser.storage."_s, toAPIString(dataType), ".getKeys()"_s);
70+
71+
auto *storage = storageForType(dataType);
72+
[storage getAllKeys:makeBlockPtr([callingAPIName, completionHandler = WTFMove(completionHandler)](NSArray<NSString *> *keys, NSString *errorMessage) mutable {
73+
if (errorMessage)
74+
completionHandler(toWebExtensionError(callingAPIName, nil, errorMessage));
75+
else
76+
completionHandler(makeVector<String>(keys));
77+
}).get()];
78+
}
79+
6780
void WebExtensionContext::storageGetBytesInUse(WebPageProxyIdentifier webPageProxyIdentifier, WebExtensionDataType dataType, const Vector<String>& keys, CompletionHandler<void(Expected<size_t, WebExtensionError>&&)>&& completionHandler)
6881
{
6982
auto callingAPIName = makeString("browser.storage."_s, toAPIString(dataType), ".getBytesInUse()"_s);
7083

71-
auto storage = storageForType(dataType);
84+
auto *storage = storageForType(dataType);
7285
[storage getStorageSizeForKeys:createNSArray(keys).get() completionHandler:makeBlockPtr([callingAPIName, completionHandler = WTFMove(completionHandler)](size_t size, NSString *errorMessage) mutable {
7386
if (errorMessage)
7487
completionHandler(toWebExtensionError(callingAPIName, nil, errorMessage));

‎Source/WebKit/UIProcess/Extensions/Cocoa/_WKWebExtensionStorageSQLiteStore.h‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ enum class WebExtensionDataType : uint8_t;
4040

4141
- (instancetype)initWithUniqueIdentifier:(NSString *)uniqueIdentifier storageType:(WebKit::WebExtensionDataType)storageType directory:(NSString *)directory usesInMemoryDatabase:(BOOL)useInMemoryDatabase;
4242

43+
- (void)getAllKeys:(void (^)(NSArray<NSString *> *keys, NSString * _Nullable errorMessage))completionHandler;
4344
- (void)getValuesForKeys:(NSArray<NSString *> *)keys completionHandler:(void (^)(NSDictionary<NSString *, NSString *> *results, NSString * _Nullable errorMessage))completionHandler;
4445
- (void)getStorageSizeForKeys:(NSArray<NSString *> *)keys completionHandler:(void (^)(size_t storageSize, NSString * _Nullable errorMessage))completionHandler;
4546
- (void)getStorageSizeForAllKeysIncludingKeyedData:(NSDictionary<NSString *, NSString *> *)additionalKeyedData withCompletionHandler:(void (^)(size_t storageSize, NSUInteger numberOfKeysIncludingAdditionalKeyedData, NSDictionary<NSString *, NSString *> *existingKeysAndValues, NSString * _Nullable errorMessage))completionHandler;

‎Source/WebKit/UIProcess/Extensions/Cocoa/_WKWebExtensionStorageSQLiteStore.mm‎

Lines changed: 32 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -71,14 +71,34 @@ - (instancetype)initWithUniqueIdentifier:(NSString *)uniqueIdentifier storageTyp
7171
return self;
7272
}
7373

74+
- (void)getAllKeys:(void (^)(NSArray<NSString *> *keys, NSString *errorMessage))completionHandler
75+
{
76+
auto weakSelf = WeakObjCPtr { self };
77+
dispatch_async(_databaseQueue, ^{
78+
auto *strongSelf = weakSelf.get().get();
79+
if (!strongSelf) {
80+
RELEASE_LOG_ERROR(Extensions, "Failed to retrieve all keys for extension %{private}@.", self->_uniqueIdentifier);
81+
completionHandler(nil, @"Failed to retrieve all keys");
82+
return;
83+
}
84+
85+
NSString *errorMessage;
86+
auto *keysArray = [self _getAllKeysReturningErrorMessage:&errorMessage].allObjects;
87+
88+
dispatch_async(dispatch_get_main_queue(), ^{
89+
completionHandler(keysArray, errorMessage);
90+
});
91+
});
92+
}
93+
7494
- (void)getValuesForKeys:(NSArray<NSString *> *)keys completionHandler:(void (^)(NSDictionary<NSString *, NSString *> *results, NSString *errorMessage))completionHandler
7595
{
76-
auto weakSelf = WeakObjCPtr<_WKWebExtensionStorageSQLiteStore> { self };
96+
auto weakSelf = WeakObjCPtr { self };
7797
dispatch_async(_databaseQueue, ^{
78-
auto strongSelf = weakSelf.get();
98+
auto *strongSelf = weakSelf.get().get();
7999
if (!strongSelf) {
80-
RELEASE_LOG_ERROR(Extensions, "Failed to retrieve keys: %{private}@ for extension %{private}@.", keys, self->_uniqueIdentifier);
81-
completionHandler(nil, [NSString stringWithFormat:@"Failed to retrieve keys %@", keys]);
100+
RELEASE_LOG_ERROR(Extensions, "Failed to retrieve values for keys: %{private}@ for extension %{private}@.", keys, self->_uniqueIdentifier);
101+
completionHandler(nil, [NSString stringWithFormat:@"Failed to retrieve values for keys %@", keys]);
82102
return;
83103
}
84104

@@ -93,9 +113,9 @@ - (void)getValuesForKeys:(NSArray<NSString *> *)keys completionHandler:(void (^)
93113

94114
- (void)getStorageSizeForKeys:(NSArray<NSString *> *)keys completionHandler:(void (^)(size_t storageSize, NSString *errorMessage))completionHandler
95115
{
96-
auto weakSelf = WeakObjCPtr<_WKWebExtensionStorageSQLiteStore> { self };
116+
auto weakSelf = WeakObjCPtr { self };
97117
dispatch_async(_databaseQueue, ^{
98-
auto strongSelf = weakSelf.get();
118+
auto *strongSelf = weakSelf.get().get();
99119
if (!strongSelf) {
100120
RELEASE_LOG_ERROR(Extensions, "Failed to calculate storage size for keys: %{private}@ for extension %{private}@.", keys, self->_uniqueIdentifier);
101121
completionHandler(0, [NSString stringWithFormat:@"Failed to caluclate storage size for keys: %@", keys]);
@@ -144,9 +164,9 @@ - (void)getStorageSizeForAllKeysIncludingKeyedData:(NSDictionary<NSString *, NSS
144164
return;
145165
}
146166

147-
auto weakSelf = WeakObjCPtr<_WKWebExtensionStorageSQLiteStore> { self };
167+
auto weakSelf = WeakObjCPtr { self };
148168
dispatch_async(self->_databaseQueue, ^{
149-
auto strongSelf = weakSelf.get();
169+
auto *strongSelf = weakSelf.get().get();
150170
if (!strongSelf) {
151171
RELEASE_LOG_ERROR(Extensions, "Failed to calculate storage size for extension %{private}@.", self->_uniqueIdentifier);
152172
completionHandler(0.0, 0, @{ }, @"Failed to calculate storage size");
@@ -171,9 +191,9 @@ - (void)getStorageSizeForAllKeysIncludingKeyedData:(NSDictionary<NSString *, NSS
171191

172192
- (void)setKeyedData:(NSDictionary<NSString *, NSString *> *)keyedData completionHandler:(void (^)(NSArray<NSString *> *keysSuccessfullySet, NSString *errorMessage))completionHandler
173193
{
174-
auto weakSelf = WeakObjCPtr<_WKWebExtensionStorageSQLiteStore> { self };
194+
auto weakSelf = WeakObjCPtr { self };
175195
dispatch_async(_databaseQueue, ^{
176-
auto strongSelf = weakSelf.get();
196+
auto *strongSelf = weakSelf.get().get();
177197
if (!strongSelf) {
178198
completionHandler(nil, [NSString stringWithFormat:@"Failed to set keys %@", keyedData.allKeys]);
179199
return;
@@ -207,9 +227,9 @@ - (void)setKeyedData:(NSDictionary<NSString *, NSString *> *)keyedData completio
207227

208228
- (void)deleteValuesForKeys:(NSArray<NSString *> *)keys completionHandler:(void (^)(NSString *errorMessage))completionHandler
209229
{
210-
auto weakSelf = WeakObjCPtr<_WKWebExtensionStorageSQLiteStore> { self };
230+
auto weakSelf = WeakObjCPtr { self };
211231
dispatch_async(_databaseQueue, ^{
212-
auto strongSelf = weakSelf.get();
232+
auto *strongSelf = weakSelf.get().get();
213233
if (!strongSelf) {
214234
completionHandler([NSString stringWithFormat:@"Failed to delete keys %@", keys]);
215235
return;

‎Source/WebKit/UIProcess/Extensions/WebExtensionContext.h‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -857,6 +857,7 @@ class WebExtensionContext : public API::ObjectImpl<API::Object::Type::WebExtensi
857857
// Storage APIs
858858
bool isStorageMessageAllowed();
859859
void storageGet(WebPageProxyIdentifier, WebExtensionDataType, const Vector<String>& keys, CompletionHandler<void(Expected<String, WebExtensionError>&&)>&&);
860+
void storageGetKeys(WebPageProxyIdentifier, WebExtensionDataType, CompletionHandler<void(Expected<Vector<String>, WebExtensionError>&&)>&&);
860861
void storageGetBytesInUse(WebPageProxyIdentifier, WebExtensionDataType, const Vector<String>& keys, CompletionHandler<void(Expected<size_t, WebExtensionError>&&)>&&);
861862
void storageSet(WebPageProxyIdentifier, WebExtensionDataType, const String& dataJSON, CompletionHandler<void(Expected<void, WebExtensionError>&&)>&&);
862863
void storageRemove(WebPageProxyIdentifier, WebExtensionDataType, const Vector<String>& keys, CompletionHandler<void(Expected<void, WebExtensionError>&&)>&&);

‎Source/WebKit/UIProcess/Extensions/WebExtensionContext.messages.in‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -133,6 +133,7 @@ messages -> WebExtensionContext {
133133

134134
// Storage APIs
135135
[EnabledIf='isStorageMessageAllowed()'] StorageGet(WebKit::WebPageProxyIdentifier webPageProxyIdentifier, WebKit::WebExtensionDataType dataType, Vector<String> keys) -> (Expected<String, WebKit::WebExtensionError> result)
136+
[EnabledIf='isStorageMessageAllowed()'] StorageGetKeys(WebKit::WebPageProxyIdentifier webPageProxyIdentifier, WebKit::WebExtensionDataType dataType) -> (Expected<Vector<String>, WebKit::WebExtensionError> result)
136137
[EnabledIf='isStorageMessageAllowed()'] StorageGetBytesInUse(WebKit::WebPageProxyIdentifier webPageProxyIdentifier, WebKit::WebExtensionDataType dataType, Vector<String> keys) -> (Expected<size_t, WebKit::WebExtensionError> result)
137138
[EnabledIf='isStorageMessageAllowed()'] StorageSet(WebKit::WebPageProxyIdentifier webPageProxyIdentifier, WebKit::WebExtensionDataType dataType, String dataJSON) -> (Expected<void, WebKit::WebExtensionError> result)
138139
[EnabledIf='isStorageMessageAllowed()'] StorageRemove(WebKit::WebPageProxyIdentifier webPageProxyIdentifier, WebKit::WebExtensionDataType dataType, Vector<String> keys) -> (Expected<void, WebKit::WebExtensionError> result)

‎Source/WebKit/WebProcess/Extensions/API/Cocoa/WebExtensionAPIStorageAreaCocoa.mm‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -116,6 +116,18 @@
116116
}, extensionContext().identifier());
117117
}
118118

119+
void WebExtensionAPIStorageArea::getKeys(WebPage& page, Ref<WebExtensionCallbackHandler>&& callback, NSString **outExceptionString)
120+
{
121+
WebProcess::singleton().sendWithAsyncReply(Messages::WebExtensionContext::StorageGetKeys(page.webPageProxyIdentifier(), m_type), [protectedThis = Ref { *this }, callback = WTFMove(callback)](Expected<Vector<String>, WebExtensionError>&& result) {
122+
if (!result) {
123+
callback->reportError(result.error());
124+
return;
125+
}
126+
127+
callback->call(createNSArray(result.value()).get());
128+
}, extensionContext().identifier());
129+
}
130+
119131
void WebExtensionAPIStorageArea::getBytesInUse(WebPage& page, id keys, Ref<WebExtensionCallbackHandler>&& callback, NSString **outExceptionString)
120132
{
121133
// Documentation: https://developer.mozilla.org/docs/Mozilla/Add-ons/WebExtensions/API/storage/StorageArea/getBytesInUse

‎Source/WebKit/WebProcess/Extensions/API/WebExtensionAPIStorageArea.h‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ class WebExtensionAPIStorageArea : public WebExtensionAPIObject, public JSWebExt
4343
bool isPropertyAllowed(const ASCIILiteral& propertyName, WebPage*);
4444

4545
void get(WebPage&, id items, Ref<WebExtensionCallbackHandler>&&, NSString **outExceptionString);
46+
void getKeys(WebPage&, Ref<WebExtensionCallbackHandler>&&, NSString **outExceptionString);
4647
void getBytesInUse(WebPage&, id keys, Ref<WebExtensionCallbackHandler>&&, NSString **outExceptionString);
4748
void set(WebPage&, NSDictionary *items, Ref<WebExtensionCallbackHandler>&&, NSString **outExceptionString);
4849
void remove(WebPage&, id keys, Ref<WebExtensionCallbackHandler>&&, NSString **outExceptionString);

‎Source/WebKit/WebProcess/Extensions/Interfaces/WebExtensionAPIStorageArea.idl‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@
3030
] interface WebExtensionAPIStorageArea {
3131

3232
[RaisesException] void get([Optional, NSObject=StopAtTopLevel, DOMString] any items, [Optional, CallbackHandler] function callback);
33+
[RaisesException] void getKeys([Optional, CallbackHandler] function callback);
3334
[RaisesException] void getBytesInUse([Optional, NSObject, DOMString] any keys, [Optional, CallbackHandler] function callback);
3435
[RaisesException] void set([NSDictionary=StopAtTopLevel] any items, [Optional, CallbackHandler] function callback);
3536
[RaisesException] void remove([NSObject] any keys, [Optional, CallbackHandler] function callback);

‎Tools/TestWebKitAPI/Tests/WebKitCocoa/WKWebExtensionAPIStorage.mm‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,8 @@
5959
auto *backgroundScript = Util::constructScript(@[
6060
@"browser.test.assertThrows(() => browser?.storage?.local?.get(Date.now()), /'items' value is invalid, because an object or a string or an array of strings or null is expected, but a number was provided/i)",
6161

62+
@"browser.test.assertThrows(() => browser?.storage?.local?.getKeys('invalid'), /'callback' value is invalid, because a function is expected/i)",
63+
6264
@"browser.test.assertThrows(() => browser?.storage?.local?.getBytesInUse({}), /'keys' value is invalid, because a string or an array of strings or null is expected, but an object was provided/i)",
6365
@"browser.test.assertThrows(() => browser?.storage?.local?.getBytesInUse([1]), /'keys' value is invalid, because a string or an array of strings or null is expected, but an array of other values was provided/i)",
6466

@@ -311,6 +313,36 @@
311313
Util::loadAndRunExtension(storageManifest, @{ @"background.js": backgroundScript });
312314
}
313315

316+
TEST(WKWebExtensionAPIStorage, GetKeys)
317+
{
318+
auto *backgroundScript = Util::constructScript(@[
319+
@"const data = { 'string': 'string', 'number': 1, 'boolean': true, 'dictionary': {'key': 'value'}, 'array': [1, true, 'string'], 'null': null }",
320+
@"await browser?.storage?.local?.set(data)",
321+
322+
@"var keys = await browser?.storage?.local?.getKeys()",
323+
@"browser.test.assertEq(keys.length, 6, 'Should have 6 keys')",
324+
@"browser.test.assertTrue(keys.includes('string'), 'Should include string key')",
325+
@"browser.test.assertTrue(keys.includes('number'), 'Should include number key')",
326+
@"browser.test.assertTrue(keys.includes('boolean'), 'Should include boolean key')",
327+
@"browser.test.assertTrue(keys.includes('dictionary'), 'Should include dictionary key')",
328+
@"browser.test.assertTrue(keys.includes('array'), 'Should include array key')",
329+
@"browser.test.assertTrue(keys.includes('null'), 'Should include null key')",
330+
331+
@"await browser?.storage?.local?.remove('number')",
332+
@"keys = await browser?.storage?.local?.getKeys()",
333+
@"browser.test.assertEq(keys.length, 5, 'Should have 5 keys after removal')",
334+
@"browser.test.assertFalse(keys.includes('number'), 'Should not include removed number key')",
335+
336+
@"await browser?.storage?.local?.clear()",
337+
@"keys = await browser?.storage?.local?.getKeys()",
338+
@"browser.test.assertEq(keys.length, 0, 'Should have no keys after clear')",
339+
340+
@"browser.test.notifyPass()",
341+
]);
342+
343+
Util::loadAndRunExtension(storageManifest, @{ @"background.js": backgroundScript });
344+
}
345+
314346
TEST(WKWebExtensionAPIStorage, GetBytesInUse)
315347
{
316348
auto *backgroundScript = Util::constructScript(@[

0 commit comments

Comments
 (0)