Files
ladybird/Libraries/LibWeb/CookieStore/CookieStore.h
Timothy Flynn 76eb5b2fa6 LibWeb+LibWebView+WebContent: Perform cookie URL filtering in the UI
When cookies change or expire, we currently send a list of all changed
cookies to all WebContent processes. We then filter that list in the
WebContent process for cookies that match the page's URL before sending
out cookie change events to JS.

We now perform this filtering in the UI process, so each WebContent
process only receives the cookies it would be interested in, if any.
This serves two purposes:

1. Less IPC chatter.
2. This will let each ViewImplementation know that its cookie value has
   actually changed.

(2) is for an upcoming change that will introduce a cookie cache, and
will allow each view to know it should bust that cache.

Note that for this filtering to work, we must iterate ViewImplementation
instances rather than WebContentClient in order to have the view's URL.
We must then associate the IPC with the view's page ID.

No changes to the /cookiestore WPT subtests.
2026-02-01 08:31:58 -05:00

88 lines
2.3 KiB
C++

/*
* Copyright (c) 2025, Idan Horowitz <idan.horowitz@serenityos.org>
*
* SPDX-License-Identifier: BSD-2-Clause
*/
#pragma once
#include <AK/Optional.h>
#include <AK/String.h>
#include <LibWeb/Bindings/CookieStorePrototype.h>
#include <LibWeb/DOM/EventTarget.h>
#include <LibWeb/Export.h>
#include <LibWeb/HighResolutionTime/DOMHighResTimeStamp.h>
namespace Web::CookieStore {
// https://cookiestore.spec.whatwg.org/#dictdef-cookielistitem
struct CookieListItem {
Optional<String> name;
Optional<String> value;
};
// https://cookiestore.spec.whatwg.org/#dictdef-cookiestoregetoptions
struct CookieStoreGetOptions {
Optional<String> name;
Optional<String> url;
};
// https://cookiestore.spec.whatwg.org/#dictdef-cookieinit
struct CookieInit {
String name;
String value;
Optional<HighResolutionTime::DOMHighResTimeStamp> expires;
Optional<String> domain;
String path;
Bindings::CookieSameSite same_site;
bool partitioned { false };
};
// https://cookiestore.spec.whatwg.org/#dictdef-cookiestoredeleteoptions
struct CookieStoreDeleteOptions {
String name;
Optional<String> domain;
String path;
bool partitioned { false };
};
// https://cookiestore.spec.whatwg.org/#cookiestore
class WEB_API CookieStore final : public DOM::EventTarget {
WEB_PLATFORM_OBJECT(CookieStore, DOM::EventTarget);
GC_DECLARE_ALLOCATOR(CookieStore);
public:
GC::Ref<WebIDL::Promise> get(String name);
GC::Ref<WebIDL::Promise> get(CookieStoreGetOptions const&);
GC::Ref<WebIDL::Promise> get_all(String name);
GC::Ref<WebIDL::Promise> get_all(CookieStoreGetOptions const&);
GC::Ref<WebIDL::Promise> set(String name, String value);
GC::Ref<WebIDL::Promise> set(CookieInit const&);
GC::Ref<WebIDL::Promise> delete_(String name);
GC::Ref<WebIDL::Promise> delete_(CookieStoreDeleteOptions const&);
void set_onchange(WebIDL::CallbackType*);
WebIDL::CallbackType* onchange();
void process_cookie_changes(Vector<Cookie::Cookie>);
private:
CookieStore(JS::Realm&, PageClient&);
virtual void initialize(JS::Realm&) override;
virtual void visit_edges(Cell::Visitor&) override;
GC::Ref<PageClient> m_client;
};
}
namespace Web::Bindings {
JS::Value cookie_list_item_to_value(JS::Realm&, CookieStore::CookieListItem const&);
}