Specifica le dipendenze in Node.js

Una funzione può utilizzare moduli Node.js esterni e locali e i dati di Google Cloud. Le dipendenze in Node.js vengono gestite con npm ed espresse in un denominato package.json. I runtime Node.js delle funzioni Cloud Run supportano l'installazione utilizzando npm, yarn o pnpm.

Per specificare una dipendenza per la funzione, aggiungila al file package.json.

Nota: se viene trovato un file package-lock.json, yarn.lock o pnpm-lock.yaml all'interno del tuo progetto, il file di blocco verrà rispettato quando le dipendenze installato utilizzando npm ci, yarn install o pnpm install.

In questo esempio, una dipendenza è elencata nel file package.json:

{
  "dependencies": {
    "escape-html": "^1.0.3"
  }
}

La dipendenza viene poi importata nella funzione:

const functions = require('@google-cloud/functions-framework');
const escapeHtml = require('escape-html');

/**
 * Responds to an HTTP request using data from the request body parsed according
 * to the "content-type" header.
 *
 * @param {Object} req Cloud Function request context.
 * @param {Object} res Cloud Function response context.
 */
functions.http('helloHttp', (req, res) => {
  res.send(`Hello ${escapeHtml(req.query.name || req.body.name || 'World')}!`);
});

Il framework delle funzioni è un la dipendenza richiesta per tutte le funzioni. Sebbene Cloud Run funzioni lo installi per tuo conto quando viene creata la funzione, ti consigliamo includerla come dipendenza esplicita per maggiore chiarezza.

Se le tue si basa su dipendenze private, ti consigliamo di esegui il mirroring di functions-framework nel tuo registro privato. Includi lo stato functions-framework come dipendenza dalla tua funzione per evitare di installare il componente dalla rete internet pubblica.

Utilizzo di npm per installare i moduli Node.js localmente

Il modo più semplice per installare un modulo Node.js localmente è utilizzare l'npm install nella cartella contenente la funzione Cloud Run. Ad esempio, il comando seguente aggiunge il modulo uuid:

npm install uuid

che combina due passaggi:

1. Contrassegna l'ultima versione del modulo come dipendenza nel tuo package.json. Questo è molto importante: le funzioni Cloud Run installano solo i moduli dichiarati nel file package.json.
2. Il modulo viene scaricato nella directory node_modules. Questo consente di puoi utilizzare il modulo durante lo sviluppo locale.

Se npm non è installato sulla tua macchina, scaricalo.

Nota: i pacchetti npm sono disponibili per una serie di prodotti Google Cloud. Consulta le elenco qui.

Configurazione delle dipendenze del deployment

Puoi installare le dipendenze di produzione per NPM, Yarn o Pnpm:

NPM

Quando esegui il deployment della funzione, le funzioni Cloud Run installano le dipendenze dichiarate nel file package.json utilizzando il comando npm install:

npm install --production

Filato

Nel runtime Node.js 8 e versioni successive, se esiste un file yarn.lock, Le funzioni Cloud Run utilizzano invece Comando yarn install:

yarn install --production

PNPM

Nel runtime Node.js 8 e versioni successive, se esiste un file pnpm-lock.yaml, le funzioni Cloud Run utilizzano invece il comando pnpm install:

pnpm install

Nota: le dipendenze dichiarate nelle sottodirectory non vengono installate. Se utilizzando un monorepo, può essere utile eseguire uno script di build personalizzato deployment per installare queste dipendenze.

Esecuzione di passaggi di compilazione personalizzati durante il deployment

Dopo il deployment, puoi eseguire una durante il processo di compilazione della funzione aggiungendo un'istruzione Script gcp-build nel file package.json.

Quando viene eseguito questo script, le dipendenze in dependencies e devDependencies campi del file package.json sono disponibili. Dopo il giorno eseguendo il passaggio di build personalizzato, Cloud Run Functions rimuove rigenera la cartella node_modules installando solo delle dipendenze dichiarate nel campo dependencies del file package.json.

Se in package.json non è presente uno script gcp-build, Cloud Run funziona si limita a installare le dipendenze di produzione.

Utilizzo dei pacchetti di sistema

Il runtime di Node.js include anche una serie di pacchetti di sistema nell'ambiente di esecuzione. Se la tua funzione utilizza una dipendenza che richiede un pacchetto non elencato, puoi richiedere un pacchetto.

Nota: puoi anche eseguire il deployment di versioni containerizzate della tua funzione Node.js Cloud Run in Cloud Run utilizzando il Functions Framework.

Inclusione di moduli Node.js locali

Puoi anche includere moduli Node.js locali nella funzione. Puoi raggiungere questo obiettivo dichiarando il tuo modulo in package.json utilizzando il Prefisso file:. Nella nell'esempio seguente, mymodule si riferisce al nome del modulo e mymoduledir è nella directory contenente il modulo:

{
  "dependencies": {
    "mymodule": "file:mymoduledir"
  }
}

Il codice per questo modulo locale deve essere archiviato in una posizione diversa dalla node_modules all'interno della directory principale della funzione.

Nota: se esegui il deployment utilizzando lo strumento a riga di comando gcloud, gcloud automaticamente crea un .gcloudignore nella directory della funzione. Per impostazione predefinita, la cartella node_modules viene aggiunta a questo .gcloudignore e non viene caricata durante il deployment. Non è necessario includere la cartella node_modules quando carichi manualmente come file .zip, puoi eseguire il deployment della funzione senza nella cartella node_modules.

Caricamento dei moduli Node.js

Utilizza la funzione Node.js require() per caricare qualsiasi modulo Node.js che hai installato. Puoi utilizzare anche require() per importare i file locali di cui esegui il deployment insieme alla funzione.

Utilizzo di moduli privati

Puoi utilizzare un modulo npm privato fornendo le impostazioni per l'autenticazione con il registry in un file .npmrc nella directory della funzione. Se utilizzi Yarn 2.0 o versioni successive come gestore dei pacchetti, questo file si chiama .yarnrc.yml.

Moduli privati di Artifact Registry

Un repository di pacchetti Node.js di Artifact Registry può ospitare moduli privati per la tua funzione. Quando esegui il deployment di una funzione Cloud Run, il processo di compilazione genera automaticamente le credenziali di Artifact Registry per l'account di servizio Cloud Build. Devi solo elencare il repository Artifact Registry in .npmrc senza generando credenziali aggiuntive. Ad esempio:

@SCOPE:registry=https://REGION_ID-npm.pkg.dev/PROJECT_ID/REPOSITORY_NAME
//REGION_ID-npm.pkg.dev/PROJECT_ID/REPOSITORY_NAME:always-auth=true

Questo approccio funziona anche per il gestore di pacchetti Yarn v1. Se utilizzi Yarn 2.0 o versioni successive, devi solo elencare il repository Artifact Registry in .yarnrc.yml senza credenziali aggiuntive. Ad esempio:

npmScopes:
  SCOPE:
    npmRegistryServer: https://REGION_ID-npm.pkg.dev/PROJECT_ID/REPOSITORY_NAME
    npmAlwaysAuth: true

Moduli privati da altri repository

La documentazione di npm spiega come creare token di accesso personalizzati di sola lettura. È sconsigliato utilizzare il file .npmrc creato in casa perché contiene un token di lettura/scrittura. Le autorizzazioni di scrittura non sono necessarie durante il deployment e potrebbe rappresentare un rischio per la sicurezza.

Non includere il file .npmrc se non utilizzi repository privati. in quanto possono aumentare i tempi di deployment delle tue funzioni.

Nota: se utilizzi autorizzazioni personalizzate (ad esempio quelle necessarie per VPC), devi assicurarti di eseguire consentire alle tue funzioni di accedere al repository privato di destinazione.

Formato file

Se utilizzi un file .npmrc per impostare un token di autenticazione personalizzato, deve includere la riga riportata di seguito.

//REGISTRY_DOMAIN/:_authToken=AUTH_TOKEN

Sostituisci:

• REGISTRY_DOMAIN: il nome di dominio del tuo registry npm privato. Imposta questo campo se il repository è ospitato con npmjs.org a registry.npmjs.org.

• AUTH_TOKEN: il token di autorizzazione per il tuo registry npm. Può essere il valore di testo letterale del token o la stringa di testo ${NPM_TOKEN}, che npm sostituisce con il valore effettivo del token indicato in completamente gestito di Google Cloud.

  Puoi impostare la variabile di ambiente $NPM_TOKEN con l'argomento --set-build-env-vars per il comando gcloud functions deploy. Per ulteriori dettagli sul token di autenticazione NPM, consulta il tutorial di NPM sui moduli privati.

Creare la funzione con dipendenze del fornitore

Le dipendenze del fornitore sono quelle il cui codice sorgente è incluso direttamente nel pacchetto di codice sorgente e viene ricostruito insieme al tuo codice. Puoi creare dipendenze Node.js di terze parti e saltarne l'installazione durante il deployment utilizzando la variabile di ambiente di compilazione GOOGLE_VENDOR_NPM_DEPENDENCIES.

Prerequisiti per le dipendenze del fornitore

1. Assicurati di avere una funzione funzionante con tutte le dipendenze che vuoi che il fornitore definisca nel file package.json.

2. Installa queste dipendenze localmente eseguendo

       npm install
   

3. Rimuovi node_modules dal file .gcloudignore nella directory di lavoro.

4. Esegui il deployment della funzione, assicurandoti che la versione di Node.js locale sia la stessa di quella specificata durante il deployment.

5. Esegui il deployment della funzione e delle dipendenze del fornitore con seguente comando:

     gcloud functions deploy FUNCTION_NAME \
       --runtime RUNTIME_NAME \
       --set-build-env-vars GOOGLE_VENDOR_NPM_DEPENDENCIES=true
   

   Sostituisci:

   • FUNCTION_NAME: il nome della funzione di Cloud Run stai eseguendo il deployment
   • RUNTIME_NAME: il nome del runtime Node.js su cui eseguire la funzione di cui è stato eseguito il deployment. Deve essere la stessa versione di Node.js utilizzata nell'ambiente di sviluppo locale

Il pacchetto del framework Functions è una dipendenza obbligatoria per le funzioni. Per build più rapide, consigliamo di acquistare questo pacchetto. In caso contrario, viene scaricato e installato al momento della compilazione della funzione.

Se specifichi un motore npm nel file package.json, il parametro specificato di npm viene scaricata al momento della build. Per eliminare questo comportamento, rimuovilo dal file package.json.