Specificare le dipendenze in Node.js

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

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

Nota: se nel progetto viene trovato un file package-lock.json, yarn.lock o pnpm-lock.yaml, questo file di blocco verrà rispettato quando le dipendenze vengono installate 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 quindi 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')}!`);
});

Functions Framework è una dipendenza obbligatoria per tutte le funzioni. Sebbene Cloud Run Functions lo installi per tuo conto al momento della creazione della funzione, ti consigliamo di includerlo come dipendenza esplicita per maggiore chiarezza.

Se la tua funzione si basa su dipendenze private, ti consigliamo di eseguire il mirroring di functions-framework nel tuo registro privato. Includi functions-framework sottoposto a mirroring come dipendenza della tua funzione per evitare di installare il pacchetto dalla rete internet pubblica.

Utilizzo di npm per installare localmente i moduli Node.js

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

npm install uuid

In questo modo, vengono combinati due passaggi:

1. Contrassegna l'ultima versione del modulo come dipendenza nel file package.json. Questo è molto importante: Cloud Run Functions installa solo i moduli dichiarati nel file package.json.
2. Il modulo viene scaricato nella directory node_modules. In questo modo, puoi utilizzare il modulo durante lo sviluppo locale.

Se non hai installato npm sul tuo computer, scarica npm.

Nota: i pacchetti npm sono disponibili per una serie di prodotti Google Cloud . Consulta l'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, Cloud Run Functions installa le dipendenze dichiarate nel file package.json utilizzando il comando npm install:

npm install --production

Filo

Nel runtime Node.js 8 e versioni successive, se esiste un file yarn.lock, le funzioni Cloud Run utilizzano invece il 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 utilizzi un monorepo, potresti voler eseguire uno script di build personalizzato durante il deployment per installare queste dipendenze.

Esecuzione di passaggi di build personalizzati durante il deployment

Dopo il deployment, puoi eseguire un passaggio di build personalizzato durante la processo di compilazione della funzione aggiungendo uno script gcp-build nel file package.json.

Quando questo script viene eseguito, le dipendenze nei campi dependencies e devDependencies del file package.json sono disponibili. Dopo l'esecuzione del passaggio di build personalizzato, Cloud Run Functions rimuove e rigenera la cartella node_modules installando solo le dipendenze di produzione dichiarate nel campo dependencies del file package.json.

Se non è presente alcuno script gcp-build in package.json, Cloud Run Functions installa solo le dipendenze di produzione.

Utilizzo dei pacchetti di sistema

Il runtime 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 delle versioni containerizzate delle funzioni Cloud Run Node.js in Cloud Run utilizzando Functions Framework.

Inclusione di moduli Node.js locali

Puoi anche includere moduli Node.js locali come parte della funzione. Puoi ottenere questo risultato dichiarando il modulo in package.json utilizzando il prefisso file:. Nell'esempio seguente, mymodule si riferisce al nome del modulo e mymoduledir è la directory contenente il modulo:

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

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

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

Caricamento dei moduli Node.js

Utilizza la funzione Node.js require() per caricare qualsiasi modulo Node.js che hai installato. Puoi anche utilizzare la funzione 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 registro in un file .npmrc nella directory della funzione. Se utilizzi Yarn v2 o versioni successive come gestore di 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 Functions, il processo di compilazione genera automaticamente le credenziali Artifact Registry per il service account Cloud Build. Devi solo elencare il repository Artifact Registry in .npmrc senza generare 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 v2 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 di altri repository

La documentazione di npm spiega come creare token di accesso personalizzati di sola lettura. Sconsigliamo l'utilizzo del file .npmrc creato nella directory home perché contiene un token di lettura/scrittura. Le autorizzazioni di scrittura non sono richieste durante l'implementazione e potrebbero rappresentare un rischio per la sicurezza.

Non includere il file .npmrc se non utilizzi repository privati, in quanto può aumentare il tempo di deployment delle tue funzioni.

Nota: se utilizzi autorizzazioni personalizzate (ad esempio quelle necessarie per VPC), assicurati di consentire esplicitamente 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 mostrata di seguito.

//REGISTRY_DOMAIN/:_authToken=AUTH_TOKEN

Sostituisci:

• REGISTRY_DOMAIN: il nome di dominio del tuo registro npm privato. Se il tuo repository è ospitato su npmjs.org, imposta questo campo su registry.npmjs.org.

• AUTH_TOKEN: il token di autorizzazione per il tuo registro npm. Può trattarsi del valore di testo letterale del token o della stringa di testo ${NPM_TOKEN}, che npm sostituisce con il valore effettivo del token dell'ambiente.

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

Crea la funzione con dipendenze fornite

Le dipendenze vendute sono quelle la cui origine è inclusa direttamente nel pacchetto di codice sorgente e ricompilate insieme al tuo codice. Crea dipendenze Node.js vendute e salta l'installazione durante il deployment utilizzando la variabile di ambiente di build GOOGLE_VENDOR_NPM_DEPENDENCIES.

Prerequisiti per le dipendenze vendute

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 locale di Node.js sia la stessa di quella specificata durante il deployment.

5. Esegui il deployment della funzione e delle dipendenze vendute con il 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 Cloud Run Functions che stai eseguendo il deployment
   • RUNTIME_NAME: il nome del runtime Node.js in cui eseguire la funzione di cui è stato eseguito il deployment. Deve essere la stessa versione di Node.js che hai utilizzato nel tuo ambiente di sviluppo locale

Il pacchetto del framework Functions è una dipendenza obbligatoria per le funzioni. Per build più veloci, ti consigliamo di eseguire il vendoring di questo pacchetto. In caso contrario, viene scaricata e installata durante la creazione della funzione.

Se specifichi un motore npm nel file package.json, la versione specificata di npm viene scaricata al momento della build. Per disattivare questo comportamento, rimuovilo dal file package.json.