Panoramica dei publisher delle estensioni

Un'estensione Firebase esegue un'attività o un insieme di attività specifiche in risposta a richieste HTTP o eventi di attivazione di 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, 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 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 può essere considerata 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 da Firebase e dai servizi Google.
  • Il file extension.yaml contiene metadati sull'estensione, ad esempio i relativi trigger e i ruoli di accesso IAM, nonché tutti i parametri che vuoi che siano configurabili dall'utente.
  • I file PREINSTALL, POSTINSTALL e CHANGELOG sono la documentazione minima che la tua estensione deve avere. Questi file aiutano gli utenti a scoprire cosa fa la tua 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, la CLI Firebase e l'hub delle estensioni mostrano i contenuti di questi file quando gli utenti esplorano, installano e gestiscono la tua estensione.

Dopo aver creato l'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 svolge il suo 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 di 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 su un endpoint HTTP
  • Funzioni chiamabili: chiama le tue Cloud Functions direttamente dal codice client web, iOS o Android utilizzando gli SDK client Firebase.

Se esponi endpoint HTTP dalla tua estensione, questa può potenzialmente integrarsi con qualsiasi servizio web che supporti i webhook. Con le funzioni chiamabili, gli utenti che installano la tua estensione possono utilizzare gli SDK Firebase come libreria client per accedere all'API implementata dalla tua estensione.

Trigger di servizio Firebase

La maggior parte dei prodotti Firebase genera 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
  • Performance Monitoring:attiva le funzioni quando Performance Monitoring 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ò anche includere funzioni che vengono attivate da diversi servizi Google Cloud non Firebase:

  • Cloud Pub/Sub: un'estensione può includere funzioni che vengono attivate 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 fissa.
  • Cloud Tasks: un'estensione può includere funzioni che possono essere accodate utilizzando Cloud Tasks. Le estensioni Firebase utilizzano questa funzionalità per consentire a te, in qualità di autore di un'estensione, di scrivere funzioni che rispondono agli eventi del "ciclo di vita" di un'estensione: l'installazione in un progetto per la prima volta, l'upgrade a una nuova versione e la riconfigurazione.
  • Eventarc: un'estensione può includere funzioni che vengono attivate quando gli eventi vengono pubblicati in un canale Eventarc configurabile; viceversa, un'estensione può pubblicare i propri eventi in un canale Eventarc per consentire agli utenti di definire le proprie funzioni che vengono attivate dagli eventi di un'estensione.

Funzioni supportate

Una volta attivata la funzione Cloud Functions di un'estensione, la gamma di possibili integrazioni è generalmente aperta. 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 Come iniziare ti guida nel processo 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 guide ai singoli argomenti, che spiegano ciascuna delle attività coinvolte nella creazione della tua estensione: