Panoramica dell'editore di estensioni

Un'estensione Firebase esegue un'attività specifica o una serie di attività in risposta a richieste HTTP o attivando 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 per condividerla con il mondo nell'hub delle estensioni Firebase. Ad esempio, la tua estensione può eseguire un'attività specifica di cui la tua app ha regolarmente bisogno oppure può semplificare l'accesso a una delle API della tua azienda. Dopo aver creato la tua estensione, puoi condividerla con altri. Tali utenti possono installare e configurare l'estensione per l'utilizzo nei propri progetti Firebase.

Struttura di un'estensione

Puoi pensare a un'estensione come composta da tre componenti principali:

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

Per sviluppare un'estensione, assembli 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 Cloud Functions in JavaScript o TypeScript. Questo è il codice che esegue le attività dell'estensione in risposta agli eventi attivati ​​da Firebase e dai servizi Google.
  • Il file extension.yaml contiene metadati sulla tua estensione, come i trigger e i ruoli di accesso IAM, nonché eventuali parametri che desideri siano configurabili dall'utente.
  • I file PREINSTALL , POSTINSTALL e CHANGELOG rappresentano la documentazione minima che la tua estensione deve avere. Questi file aiutano i tuoi utenti a scoprire cosa fa la tua estensione, come usarla e quali aggiornamenti hai apportato. Dovresti anche fornire un'icona per aiutare gli utenti a riconoscere la tua estensione. La console Firebase, la CLI Firebase e l'hub estensioni visualizzano il contenuto di questi file quando gli utenti esplorano, installano e gestiscono la tua estensione.

Dopo aver creato la tua estensione, puoi utilizzare la CLI Firebase per installarla in un progetto o pubblicarla nell'hub delle estensioni, dove chiunque può scoprirla e installarla nei propri progetti.

Con quali prodotti può interagire la mia estensione?

Poiché un'estensione Firebase funziona 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 attivata, con quali prodotti possono interagire le funzioni della mia estensione?

Trigger di funzioni supportate

Trigger manuali

Prima di tutto, puoi attivare manualmente una funzione. Firebase Extensions e Cloud Functions supportano due modi per attivare manualmente le funzioni:

  • Trigger HTTP: distribuisci una funzione su un endpoint HTTP
  • Funzioni richiamabili: chiama le tue Funzioni Cloud direttamente dal tuo codice client iOS, Android o Web, utilizzando gli SDK del client Firebase.

Esponendo gli endpoint HTTP dalla tua estensione, la tua estensione può potenzialmente integrarsi con qualsiasi servizio web che supporti i 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 dalla tua estensione.

Trigger del servizio Firebase

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

  • Analytics: attiva le funzioni quando Analytics registra un evento
  • App Distribution: attiva le funzioni quando App Distribution 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 del servizio 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 secondo una pianificazione prestabilita
  • Cloud Tasks : un'estensione può includere funzioni che possono essere messe in coda utilizzando Cloud Tasks. Firebase Extensions utilizza questa funzionalità per consentirti, in qualità di autore dell'estensione, di scrivere funzioni che rispondono agli eventi del "ciclo di vita" di un'estensione: essere installato in un progetto per la prima volta, essere aggiornato a una nuova versione e essere riconfigurato.
  • Eventarc : un'estensione può includere funzioni che si attivano quando gli eventi vengono pubblicati su un canale Eventarc configurabile; al contrario, un'estensione può pubblicare i propri eventi su 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 Cloud Function di un'estensione, la gamma delle possibili integrazioni è generalmente illimitata. Ecco alcuni punti salienti di ciò che puoi fare da una Cloud Function:

  • Leggi, scrivi e interagisci in altro modo con qualsiasi servizio Firebase o Google Cloud che utilizza un ruolo IAM supportato .
  • Funziona con qualsiasi servizio di terze parti che fornisce 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 costruire un'estensione

Il tutorial Get Started ti guida attraverso il processo di creazione, test e pubblicazione di un'estensione completa ed è il modo consigliato per imparare a crearne una.

Iniziare

Dopo aver letto una volta la guida introduttiva, puoi fare riferimento alle guide dei singoli argomenti, che spiegano ciascuna delle attività coinvolte nella creazione della tua estensione: