Architecture

[sidvishnoi]

Similar to Favicon loading in browser/actors/LinkHandlerChild.jsm, we make use of the JSWindowActor APIs.

browser/actors/WebMonetizationChild.jsm interacts with the document to run the observable mechanics. It is responsible to find the valid monetization element (at any time), running the fetch and process steps and communicating with browser/actors/WebMonetizationParent.jsm.

The MonetizationService in browser/actors/WebMonetizationParent.jsm is responsible for managing and communicating the monetization state across all documents. The WebMonetizationParent can also control the browser UI and manage payment history.

WebMonetizationParent and MonetizationService also communicate start/stop/pause/resume events to the browser extensions with "webmonetization" permission. They're also listen to "completePayment" and "refresh" requests from the extension. All event management is done via the Services.io message passing API.

The extension uses "completePayment(sessionId, amount)" to notify the browser for a completed payment, and the browser in turn dispatches MonetizationProgressEvent to window.monetization for the relevant document. The document can listen to the MonetizationProgressEvent as window.monetization.addEventListener("progress", ev).

The extension can also request a refresh(sessionId) when it deems necessary (primarily on expiration of previous SPSP response). The browser then runs the fetch and process steps for the document/activeEl corresponding to sessionId, stops payments for sessionId (by dispatching a stop(sessionId) to the extension), and starts a new payment (by dispatching a start(newSessionId, newSpspResponse) to the extension). The call to refresh(sessionId) resolves with a newSessionId.

monetization-src CSP directive

See 6ad0f18

MonetizationProgressEvent and Window.Monetization interface

WebIDL interfaces

• MonetizationProgressEvent
• Monetization
• Extensions to Window interface

Implementation

• Window.Monetization + dom/base/nsGlobalWindowInner.cpp
• dispatching MonetizationProgressEvent

Extension API

• Schema: toolkit/components/extensions/schemas/monetization.json
• Implementation: toolkit/components/extensions/parent/ext-monetization.js