Registrazione del gestore del protocollo URL per le PWA

Consenti alle PWA installate di gestire i link che utilizzano un protocollo specifico per un'esperienza più integrata.

Thomas Steiner

Informazioni sugli schemi (ovvero i protocolli)

Un URI (Uniform Resource Identifier) è una sequenza compatta di caratteri che identifica una risorsa astratta o fisica. Ogni URI inizia con un nome di schema che fa riferimento a una specifica per l'assegnazione di identificatori all'interno di questo schema. Pertanto, la sintassi URI è un sistema di denominazione federato ed estensibile in cui la specifica di ogni schema può limitare ulteriormente la sintassi e la semantica degli identificatori che utilizzano questo schema. Gli schemi sono noti anche come protocolli. Puoi vedere alcuni esempi di schemi.

tel:+1-816-555-1212
mailto:Jane.Doe@example.com
news:comp.infosystems.www.servers.unix
https://web.dev/

Il termine URL (Uniform Resource Locator) si riferisce al sottoinsieme di URI che, oltre a identificare una risorsa, forniscono un mezzo per localizzarla descrivendo il suo meccanismo di accesso principale (ad es. la sua posizione di rete).

Informazioni sul metodo registerProtocolHandler()

Il metodo Navigator disponibile solo per i contenuti sicuri registerProtocolHandler() consente ai siti di registrare la propria capacità di aprire o gestire schemi URL specifici. Pertanto, i siti devono chiamare il metodo nel seguente modo: navigator.registerProtocolHandler(scheme, url). I due parametri sono definiti come segue:

  • scheme: una stringa contenente il protocollo che il sito vuole gestire.
  • url: una stringa contenente l'URL del gestore. Questo URL deve includere %s come segnaposto che verrà sostituito con l'URL con escape da gestire.

Lo schema deve essere uno degli schemi inclusi nella lista consentita (ad esempio mailto, bitcoin o magnet) o iniziare con web+, seguito da una o più lettere ASCII minuscole dopo il prefisso web+, ad esempio web+coffee.

Per una maggiore chiarezza, ecco un esempio concreto del flusso:

  1. L'utente visita un sito all'indirizzo https://coffeeshop.example.com/ che effettua la seguente chiamata: navigator.registerProtocolHandler('web+coffee', 'coffee?type=%s').
  2. In un secondo momento, mentre visita https://randomsite.example.com/, l'utente fa clic su un link come <a href="web+coffee:latte-macchiato">All about latte macchiato</a>.
  3. In questo modo, il browser passa al seguente URL: https://coffeeshop.example.com/coffee?type=web%2Bcoffee%3A%2F%2Flatte-macchiato. La stringa di ricerca con URL decodificato è quindi ?type=web+coffee://latte-macchiato.

Che cos'è la gestione dei protocolli

L'attuale meccanismo di registrazione del gestore di protocollo URL per le PWA consiste nell'offrire la registrazione del gestore di protocollo come parte dell'installazione di una PWA tramite il relativo manifest. Dopo aver registrato una PWA come gestore di protocollo, quando un utente fa clic su un collegamento ipertestuale con uno schema specifico come mailto, bitcoin o web+music da un browser o da un'app specifica della piattaforma, la PWA registrata si aprirà e riceverà l'URL. È importante notare che sia la registrazione basata sul manifest proposta sia la tradizionale registerProtocolHandler() svolgono ruoli molto simili nella pratica, pur consentendo la possibilità di esperienze utente complementari:

  • Le somiglianze includono i requisiti relativi all'elenco degli schemi che possono essere registrati, al nome e al formato dei parametri e così via.
  • Le differenze nella registrazione basata sul manifest sono sottili, ma potrebbero essere utili per migliorare l'esperienza degli utenti PWA. Ad esempio, la registrazione PWA basata sul manifest potrebbe non richiedere un'azione utente aggiuntiva oltre all'installazione della PWA avviata dall'utente.

Casi d'uso

  • In una PWA di elaborazione testi, l'utente in un documento trova un link a una presentazione come web+presentations://deck2378465. Quando l'utente fa clic sul link, la PWA di presentazione si apre automaticamente nell'ambito corretto e mostra il set di diapositive.
  • In un'app di chat specifica della piattaforma, l'utente in un messaggio chat riceve un link a un URL magnet. Quando l'utente fa clic sul link, viene avviata una PWA torrent installata e inizia il download.
  • L'utente ha installato una PWA di streaming musicale. Quando un amico condivide un link a un brano come web+music://songid=1234&time=0:13 e l'utente fa clic su di esso, la PWA di streaming musicale si avvia automaticamente in una finestra autonoma.

Come utilizzare la registrazione del gestore di protocollo URL per le PWA

L'API per la registrazione del gestore di protocollo URL è modellata in modo simile a navigator.registerProtocolHandler(). Questa volta, le informazioni vengono trasmesse in modo dichiarativo utilizzando il manifest dell'app web in una nuova proprietà denominata "protocol_handlers" che accetta un array di oggetti con le due chiavi obbligatorie "protocol" e "url". Il seguente snippet di codice mostra come registrare web+tea e web+coffee. I valori sono stringhe contenenti l'URL del gestore con il segnaposto obbligatorio %s per l'URL con escape.

{
  "protocol_handlers": [
    {
      "protocol": "web+tea",
      "url": "/tea?type=%s"
    },
    {
      "protocol": "web+coffee",
      "url": "/coffee?type=%s"
    }
  ]
}

Più app che si registrano per lo stesso protocollo

Se più applicazioni si registrano come gestori per lo stesso schema, ad esempio il protocollo mailto, il sistema operativo mostrerà all'utente un selettore e gli consentirà di decidere quale dei gestori registrati utilizzare.

La stessa app che si registra per più protocolli

La stessa app può registrarsi per più protocolli, come puoi vedere nell'esempio di codice.

Aggiornamenti delle app e registrazione dei gestori

Le registrazioni dei gestori vengono sincronizzate con la versione più recente del manifest fornita dall'app. Esistono due casi:

  • Un aggiornamento che aggiunge nuovi gestori attiva la registrazione dei gestori (separata dall'installazione dell'app).
  • Un aggiornamento che rimuove i gestori attiva l'annullamento della registrazione dei gestori (separato dalla disinstallazione dell'app).

Debug dei gestori di protocollo in DevTools

Vai alla sezione Gestori di protocollo utilizzando il riquadro Applicazione > Manifest. Qui puoi visualizzare e testare tutti i protocolli disponibili.

Gestori di protocollo nel riquadro Manifest

Considerazioni sulla sicurezza

Poiché l'installazione della PWA richiede che il contesto sia sicuro, la gestione dei protocolli eredita questo vincolo. L'elenco dei gestori di protocollo registrati non è esposto al web in alcun modo, quindi non può essere utilizzato come vettore di fingerprinting.

Tentativi di navigazione non avviati dall'utente

I tentativi di navigazione non avviati dall'utente, ma programmatici, potrebbero non aprire le app. L'URL del protocollo personalizzato può essere utilizzato solo nei contesti di navigazione di primo livello, ma non, ad esempio, come URL di un iframe.

Lista consentita di protocolli

Come per registerProtocolHandler(), esiste una lista consentita di protocolli che le app possono registrare per la gestione.

Al primo avvio della PWA a causa di un protocollo richiamato, all'utente verrà presentata una finestra di dialogo delle autorizzazioni. Questa finestra di dialogo mostrerà il nome e l'origine dell'app e chiederà all'utente se l'app è autorizzata a gestire i link del protocollo. Se un utente rifiuta la finestra di dialogo delle autorizzazioni, il gestore di protocollo registrato verrà ignorato dal sistema operativo. Per annullare la registrazione del gestore di protocollo, l'utente deve disinstallare la PWA che lo ha registrato. Il browser annullerà anche la registrazione del gestore di protocollo se l'utente seleziona "Ricorda la mia scelta" e "Non consentire".

Feedback

Il team di Chromium vuole conoscere le tue esperienze con la registrazione del gestore di protocollo URL per le PWA.

Parlaci della progettazione dell'API

C'è qualcosa nell'API che non funziona come previsto? Oppure mancano metodi o proprietà di cui hai bisogno per implementare la tua idea? Hai una domanda o un commento sul modello di sicurezza? Segnala un problema relativo alle specifiche nel repository GitHub corrispondente o aggiungi i tuoi pensieri a un problema esistente.

Segnala un problema relativo all'implementazione

Hai trovato un bug nell'implementazione di Chromium? Oppure l'implementazione è diversa dalle specifiche? Segnala un bug all'indirizzo new.crbug.com. Assicurati di includere il maggior numero di dettagli possibile, le istruzioni per la riproduzione e inserisci UI>Browser>WebAppInstalls nella casella Componenti.

Mostra il tuo sostegno all'API

Hai intenzione di utilizzare la registrazione del gestore di protocollo URL per le PWA? Il tuo sostegno pubblico aiuta il team di Chromium a dare la priorità alle funzionalità e mostra ad altri fornitori di browser quanto sia fondamentale supportarle.

Condividi come prevedi di utilizzarlo nel thread di discussione WICG. Invia un tweet a @ChromiumDev utilizzando l'hashtag #ProtocolHandler e comunicaci dove e come lo utilizzi.

Ringraziamenti

La registrazione del gestore di protocollo URL per le PWA è stata implementata e specificata da Fabio Rocha, Diego González, Connor Moody e Samuel Tang del team di Microsoft Edge. Questo documento è stato rivisto da Joe Medley e Fabio Rocha.