Panoramica dei publisher delle estensioni

Un'estensione Firebase esegue un'attività o un insieme di attività specifiche in risposta a richieste HTTP o all'attivazione di eventi da altri prodotti Firebase e Google, come Firebase Cloud Messaging, Cloud Firestore o Pub/Sub.

Puoi creare la tua estensione per uso personale o da condividere con il mondo nell'hub delle estensioni Firebase. Ad esempio, l'estensione può eseguire un compito specifico di cui la tua app ha regolarmente bisogno oppure semplificare l'accesso a una delle API della tua azienda. Dopo aver creato l'estensione, puoi condividerla con altre persone. Questi utenti possono installare e configurare l'estensione per utilizzarla nei propri progetti Firebase.

Struttura di un'estensione

Un'estensione è composta da tre componenti principali:

  • Codice Cloud Functions in JavaScript o TypeScript
  • Metadati che descrivono l'estensione
  • Documentazione per aiutare gli utenti a configurare e utilizzare l'estensione

Per sviluppare un'estensione, assembla questi componenti nella seguente struttura:

example-extension
├── functions
│   ├── integration-tests
│   │   ├── extensions
│   │   │   └── example-extension.env
│   │   ├── firebase.json
│   │   └── integration-test.spec.js
│   ├── index.js
│   └── package.json
├── README.md
├── PREINSTALL.md
├── POSTINSTALL.md
├── CHANGELOG.md
├── icon.png
└── extension.yaml
  • La directory functions contiene il codice di Cloud Functions in JavaScript o TypeScript. Questo è il codice che esegue le attività dell'estensione in risposta agli eventi attivati dai servizi Firebase e Google.
  • Il file extension.yaml contiene i metadati della tua estensione, ad esempio i suoi attivatori e i ruoli di accesso IAM, nonché eventuali parametri che vuoi che siano configurabili dall'utente.
  • I file PREINSTALL, POSTINSTALL e CHANGELOG costituiscono la documentazione minima obbligatoria per l'estensione. Questi file aiutano gli utenti a scoprire cosa fa l'estensione, come utilizzarla e quali aggiornamenti hai apportato. Devi anche fornire un'icona per aiutare gli utenti a riconoscere la tua estensione. La Console Firebase, l'interfaccia a riga di comando di Firebase e l'hub delle estensioni mostrano i contenuti di questi file quando gli utenti esplorano, installano e gestiscono l'estensione.

Dopo aver creato l'estensione, puoi utilizzare l'interfaccia a riga di comando di Firebase per installarla in un progetto o pubblicarla nell'hub delle estensioni, dove chiunque può trovarla e installarla nei propri progetti.

Con quali prodotti può interagire la mia estensione?

Poiché un'estensione Firebase svolge il proprio lavoro utilizzando Cloud Functions, puoi pensare alla questione delle possibili integrazioni in due modi: Quali prodotti possono attivare le funzioni della mia estensione? e Una volta attivate, con quali prodotti possono interagire le funzioni della mia estensione?

Trigger delle funzioni supportati

Trigger manuali

Innanzitutto, puoi attivare manualmente una funzione. Le Estensioni Firebase e Cloud Functions supportano due modi per attivare manualmente le funzioni:

  • Trigger HTTP: esegui il deployment di una funzione in un endpoint HTTP
  • Funzioni chiamabili: chiama le tue funzioni Cloud direttamente dal codice client web, Android o iOS utilizzando gli SDK client Firebase.

Se esponi gli endpoint HTTP dalla tua estensione, quest'ultima può essere potenzialmente integrata con qualsiasi servizio web che supporta gli webhook. Con le funzioni richiamabili, gli utenti che installano la tua estensione possono utilizzare gli SDK Firebase come libreria client per accedere all'API implementata dall'estensione.

Trigger di servizio Firebase

La maggior parte dei prodotti Firebase emette eventi che possono attivare le funzioni Cloud di un'estensione.

  • Analytics: attiva le funzioni quando Analytics registra un evento
  • Distribuzione di app:attiva le funzioni quando Distribuzione di app attiva un avviso
  • Autenticazione:attiva le funzioni quando gli utenti creano ed eliminano account
  • Cloud Firestore: attiva le funzioni quando le pagine vengono create, aggiornate o eliminate
  • Cloud Storage: attiva le funzioni quando gli oggetti vengono caricati, archiviati o eliminati dai bucket
  • Crashlytics: attiva le funzioni quando Crashlytics attiva un avviso
  • Monitoraggio delle prestazioni: attiva le funzioni quando il monitoraggio delle prestazioni attiva un avviso
  • Realtime Database: attiva le funzioni quando i dati vengono creati, aggiornati o eliminati
  • Remote Config: attiva le funzioni quando un parametro viene aggiornato
  • Test Lab: attiva le funzioni quando Test Lab attiva un avviso

Trigger dei servizi Google Cloud

Un'estensione può includere anche funzioni che attivano diversi servizi Google Cloud non Firebase:

  • Cloud Pub/Sub: un'estensione può includere funzioni che si attivano quando gli eventi vengono pubblicati in un argomento Pub/Sub configurabile.
  • Cloud Scheduler: un'estensione può includere funzioni che vengono eseguite in base a una pianificazione impostata
  • Cloud Tasks: un'estensione può includere funzioni che possono essere messe in coda utilizzando Cloud Tasks. Le Estensioni Firebase utilizzano questa funzionalità per consentire a te, in qualità di autore dell'estensione, di scrivere funzioni che rispondano agli eventi di "ciclo di vita" di un'estensione: installazione in un progetto per la prima volta, upgrade a una nuova versione e ricofigurazione.
  • Eventarc: un'estensione può includere funzioni che si attivano quando gli eventi vengono pubblicati in un canale Eventarc configurabile. Al contrario, un'estensione può pubblicare i propri eventi in un canale Eventarc per consentire agli utenti di definire le proprie funzioni che si attivano dagli eventi di un'estensione.

Supportato dalle funzioni

Una volta attivata la funzione Cloud di un'estensione, l'ambito delle possibili integrazioni è generalmente aperto. Ecco alcuni punti salienti di ciò che puoi fare da una funzione Cloud:

  • Leggere, scrivere e interagire in altro modo con qualsiasi servizio Firebase o Google Cloud che utilizza un ruolo IAM supportato.
  • Utilizza qualsiasi servizio di terze parti che fornisca un'API web.
  • Utilizza i tuoi servizi personalizzati se fornisci un'API web.
  • Esegui la maggior parte delle librerie JavaScript, tra cui TensorFlow.js, Express.js e così via.

Come creare un'estensione

Il tutorial Inizia illustra la procedura di creazione, test e pubblicazione di un'estensione completa ed è il modo consigliato per imparare a crearne una.

Inizia

Dopo aver letto la guida introduttiva, puoi consultare le singole guide agli argomenti, che spiegano ciascuna delle attività necessarie per creare la tua estensione: