Skip to content

Latest commit

 

History

History
282 lines (228 loc) · 11.2 KB

launch_handler.md

File metadata and controls

282 lines (228 loc) · 11.2 KB
Raw

Web App Launch Handling

Authors: [email protected], [email protected], [email protected]
Last updated: 2022-03-03

Overview

Some web apps are designed to work in a single window (e.g. a music player) and aren't intended to be used across multiple instances. Web capabilities like share target, file handlers and link capturing can cause new instances of the web app to be opened even if an app window is already open, putting the user in a non-ideal state.

This document describes a new launch_handler manifest member that lets sites redirect app launches into existing app windows to prevent duplicate windows from being opened.

We found that almost all "launch" use cases could be covered by a select few fixed rules (for example, "choose an existing window in the same app, focus it, and navigate it to the launched URL"). This launch_handler proposal enables sites to specify a set of fixed rules without having to implement custom service worker launch event logic, which should satisfy most use cases, and simplify the implementation in browsers and sites.

Use case

  • Single-window web apps: a web app that prefers to only have a single instance of itself open at any time, with new navigations focusing the existing instance.
    Sub-use cases include:
    • Apps that generally only make sense to have one instance running (e.g., a music player, a game).
    • Apps that include multi-document management within a single instance (e.g., an HTML-implemented tab strip, floating sub-windows like Gmail).

Non-goals

  • Forcing a web app to only ever appear in a single client (e.g., blocking being opened in a browser tab while already opened in an app window).
  • Configuring whether link navigations into the scope of a web app launch the web app (this is out of scope and may be handled by a future version of the Declarative Link Capturing spec).

Background

  • There are several ways for a web app window to be opened:

    Web apps launched via these triggers will open in a new or existing app window depending on the user agent platform. There is currently no mechanism for the web app to configure this behaviour.

  • This is a refactor of the Declarative Link Capturing explainer with a reduced behaviour scope. This does not prescribe link capturing as a means of launching a web app, instead it describes how the launch of a web app (via link capturing or any other means) may be configured by the manifest and service worker.

Proposal

LaunchQueue and LaunchParams interfaces

Add two new interfaces; LaunchParams and LaunchQueue. Add a global instance of LaunchQueue to the window object named launchQueue. These serve as a JavaScript API to programmatically handle launches, in particular those that were redirected into an existing window without navigating the existing document.

Whenever a web app is launched (via any launch trigger), a LaunchParams object will be enqueued in the launchQueue global LaunchQueue instance for the browsing context that handled the launch. Scripts can provide a single LaunchConsumer function to receive enqueued LaunchParams.

This functions similarly to an event listener, but avoids the race condition where scripts may "miss" events if they're too slow to register their event listeners, this problem is particularly pronounced for launch events as they occur during the page's initialization. LaunchParams are buffered indefinitely until they are consumed. Crucially, if any LaunchParams are buffered into a LaunchQueue before a call to setConsumer(), they will be immediately passed into the consumer afterwards.

[Exposed=Window] dictionary LaunchParams {
  readonly attribute DOMString targetURL;
};

callback LaunchConsumer = any (LaunchParams params);

[Exposed=Window] interface LaunchQueue {
  void setConsumer(LaunchConsumer consumer);
};

partial interface Window {
  readonly attribute LaunchQueue launchQueue;
};

Example usage for a single-window music player app:

launchQueue.setConsumer(launchParams => {
  const songID = maybeExtractSongId(launchParams.targetURL);
  if (songID) {
    // No need to navigate the current page; can start playing the launched song
    // directly.
    playSong(songID);
    return;
  }
  location.href = launchParams.targetURL;
});

The targetURL member in LaunchParams will only be set if the launch did not create a new browsing context or navigate an existing one.

Other web app APIs that involve launching may extend LaunchParams with additional members containing data specific to the method of launching, e.g., a share target payload.

launch_handler manifest member

Add a launch_handler member to the web app manifest specifying the default client selection and navigation behaviour for web app launches. The shape of this member is as follows:

"launch_handler": {
  "client_mode": "auto" | "navigate-new" | "navigate-existing" | "focus-existing"
}

If unspecified then launch_handler defaults to { "client_mode": "auto" }.

client_mode:

  • auto: The behaviour is up to the user agent to decide what works best for the platform. This reflects the status quo of user agent implementations prior to this proposal: mobile agents typically navigate an existing client, while desktop agents typically create a new one and avoid clobbering state.
  • navigate-new: A new browsing context is created in a web app window to load the launch's target URL.
  • navigate-existing: The most recently interacted with browsing context in a web app window is navigated to the launch's target URL.
  • focus-existing: The most recently interacted with browsing context in a web app window is chosen to handle the launch. A new LaunchParams with its targetURL set to the launch URL will be enqueued in the document's window.launchQueue.

client_mode accepts a list of values, the first valid value will be used. This is to allow new values to be added to the spec without breaking backwards compatibility with old implementations by using them.
For example, if "focus-matching-url" were added, sites would specify "client_mode": ["focus-matching-url", "focus-existing"] to continue to control the behaviour of older browsers that didn't support "matching-url-client".

Example manifest that choses to receive all app launches as events in existing web app windows:

{
  "name": "Example app",
  "start_url": "/index.html",
  "launch_handler": {
    "client_mode": "focus-existing"
  }
}

Possible extensions to this proposal

  • Add "service-worker" as a client_mode option. This would invoke a service worker launch event.

    This would allow web apps that open documents in their own app instances but want to bring an existing document instance into focus when the same document is re-launched instead of opening a duplicate app instance for it.

  • Add two members:

    "launch_handler": {
  "navigate_new_clients": "always" | "never",
  "new_client_url": <URL>,
}

    This allows web apps to intercept new client navigations and provide a constant alternative URL to handle the enqueued LaunchParams with targetURL set.

  • Add the launch_handler field to other launch methods to allow sites to customise the launch behaviour for specfic launch methods. For example:

    {
  "name": "Example app",
  "description": "This app will navigate existing clients unless it was launched via the share target API.",
  "launch_handler": {
    "client_mode": "navigate-existing"
  },
  "share_target": {
    "action": "share.html",
    "params": {
      "title": "name",
      "text": "description",
      "url": "link"
    },
    "launch_handler": {
      "client_mode": "focus-existing"
    }
  }
}

  • Add attribute readonly LaunchConsumer? consumer to LaunchQueue. This will allow sites to chain LaunchConsumers together more independently.

    function addLaunchConsumer(launchConsumer) {
  const existingLaunchConsumer = launchQueue.consumer;
  launchQueue.setConsumer(launchParams => {
    existingLaunchConsumer?.(launchParams);
    launchConsumer(launchParams);
  });
}

    Or maybe the LaunchQueue interface should be addConsumer/removeConsumer like addEventListener/removeEventListener, but with buffering.

Related proposals

Service Worker launch event

This proposal is declarative alternative to the service worker launch proposal in WICG. It covers many of the same use cases, but omits the more advanced use cases (specifically, the option to choose which client to focus).

Use of launch_handler in the manifest would provide a "default" launch behaviour that the service worker launch event handler can choose to override.

Declarative Link Capturing

This launch_handler proposal is intended to be a successor to the "launch" components of DLC and decouple launch configuration from "link capturing" behaviour.

launch_handler generalises the concept of a launch into two core primitive actions; launch client selection and navigation, and explicitly decouples them from the "link capturing" launch trigger.

WICG: URL Handlers

Similarly to Declarative Link Capturing this launch_handler proposal refactors out the "launch" component from the URL Handler proposal. launch_handler behaviour is intended for being "invoked" by URL Handlers at the point in which a web app has been chosen to handle an out-of-browser link navigation.

File Handling

This proposal takes LaunchQueue and LaunchParams from the File Handling proposal with a few changes:

  • Instead of enqueuing LaunchParams for specific types of launches they will be enqueued for every type of web app launch.
  • An optional targetURL field is added.
  • The interface is explicitly intended to be extended by other launch related specs to contain launch specific data, e.g., file handles or share data.

Tabbed Application Mode

This proposal is intended to work in tandem with tabbed mode web app windows. The behaviour of "client_mode": "navigate-new" with an already open tabbed window is to open a new tab in that window.