Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create explainer.md #16

Merged
merged 10 commits into from
Jul 27, 2016
Merged

Create explainer.md #16

merged 10 commits into from
Jul 27, 2016

Commits on Jul 15, 2016

  1. Create explainer.md

    Long overdue, this is an attempt to describe the API and its reasons for existing
    bsittler committed Jul 15, 2016
    Configuration menu
    Copy the full SHA
    267789a View commit details
    Browse the repository at this point in the history
  2. Update explainer.md

    bsittler committed Jul 15, 2016
    Configuration menu
    Copy the full SHA
    c04da75 View commit details
    Browse the repository at this point in the history
  3. Update explainer.md

    bsittler committed Jul 15, 2016
    Configuration menu
    Copy the full SHA
    68d83e7 View commit details
    Browse the repository at this point in the history

Commits on Jul 22, 2016

  1. Applying feedback, round 1

    - cookieList is indeed an array. Examples have been expanded to show this
    
    - regexp is gone in favor of strict name matching, name prefix matching, and "give me everything" where the developer-supplied script sorts it out; tried to strike a balance between not waking up handlers when the change is to an unrelated cookie that happens to be in-scope and the matching is definitely practical to implement in the browser (exact match or exact prefix match - both are used in ServiceWorker already) on the one hand and allowing JS to decide whether a change is interesting on the other hand (omit interest list and you get called back every time)
    
    - switched to `get`
    
    - added `delete`
    
    - proposed restricting write operations to secure contexts
    
    - `expires` rather than `expiration`, added explicit examples of numeric expiration timestamps
    
    - added some initial discussion of security implications
    
    - overhauled change monitoring APIs
    
    - attempted to explain change coalescing
    
    - attempted to explain ServiceWorker API and rationale
    
    - `match`/`matchAll` are gone
    
    - `await`
    
    - silent failures are gone
    
    - changed event name
    bsittler committed Jul 22, 2016
    Configuration menu
    Copy the full SHA
    2a84c02 View commit details
    Browse the repository at this point in the history
  2. Update explainer.md

    - minor reformatting
    
    - note limitation of ServiceWorker cookie monitoring
    bsittler committed Jul 22, 2016
    Configuration menu
    Copy the full SHA
    dba7692 View commit details
    Browse the repository at this point in the history
  3. Update explainer.md

    bsittler committed Jul 22, 2016
    Configuration menu
    Copy the full SHA
    c94e291 View commit details
    Browse the repository at this point in the history
  4. Update explainer.md

    clarify that the only ephemeral script contexts supported is ServiceWorker
    bsittler committed Jul 22, 2016
    Configuration menu
    Copy the full SHA
    9ee4444 View commit details
    Browse the repository at this point in the history
  5. Update explainer.md

    Clarifications
    bsittler committed Jul 22, 2016
    Configuration menu
    Copy the full SHA
    b8c6d90 View commit details
    Browse the repository at this point in the history
  6. Update explainer.md

    typofix
    bsittler committed Jul 22, 2016
    Configuration menu
    Copy the full SHA
    2fb063c View commit details
    Browse the repository at this point in the history

Commits on Jul 27, 2016

  1. Applying feedback, round N + modify CookieObserver

     - Mention cookie-aversion and other contexts with disallowed cookie access, and our chosen approach: reject operations, allow monitoring (but don't call back unless/until reads are possible)
    - Explain why we path-scope a ServiceWorker/disallow reading for out-of-scope URLs
    - Describe how fragile path-scoping is for this API
    - Mention possibly-surprising port number handling
    - Mention possibly-surprising different-path cookie-writing
    - Removed unobserve, replaced it with less-flexible disconnect
    - Changed description of observe to clarify additive behavior and lack of duplicated change reports
    - Changed (optional) matchType to accept one of two values: 'equals' and 'startsWith'; clarified that 'equals' is the default
    - CookieStore and URL are now one-per-item in CookieChange entries
    - The first parameter for CookieObserver callbacks and event.data for the CookieChangeEvent are now simply arrays of cookie changes
    - The second paramter for CookieObserver callbacks is now the CookieObserver
    - The url is now per-CookieInterest item in calls to observe and InstallEvent's registerCookieChangeInterest
    bsittler committed Jul 27, 2016
    Configuration menu
    Copy the full SHA
    fe094d2 View commit details
    Browse the repository at this point in the history