Mengelola fungsi


Anda dapat men-deploy, menghapus, dan mengubah fungsi menggunakan perintah Firebase CLI atau dengan menyetel opsi runtime dalam kode sumber fungsi Anda.

Men-deploy fungsi

Untuk men-deploy fungsi, jalankan perintah Firebase CLI ini:

firebase deploy --only functions

Secara default, Firebase CLI men-deploy semua fungsi di dalam sumber Anda secara bersamaan. Jika project Anda berisi lebih dari 5 fungsi, sebaiknya gunakan flag --only dengan nama fungsi tertentu untuk men-deploy fungsi yang sudah diedit saja. Men-deploy fungsi tertentu dengan cara ini akan mempercepat proses deployment dan membantu agar Anda tidak melampaui kuota deployment. Contoh:

firebase deploy --only functions:addMessage,functions:makeUppercase

Saat men-deploy fungsi dalam jumlah besar, Anda mungkin melebihi kuota standar dan menerima pesan error HTTP 429 atau 500. Untuk mengatasi hal ini, deploy fungsi secara berkelompok, yang setiap kelompoknya berisi maksimal 10 fungsi.

Baca referensi Firebase CLI untuk melihat daftar lengkap perintah yang tersedia.

Secara default, Firebase CLI akan mencari kode sumber di folder functions/. Jika ingin, Anda dapat mengatur fungsi di codebase atau beberapa kumpulan file.

Menghapus fungsi

Anda dapat menghapus fungsi yang telah di-deploy sebelumnya dengan cara berikut:

  • secara eksplisit di Firebase CLI dengan functions:delete
  • secara eksplisit di Google Cloud console.
  • secara implisit dengan menghapus fungsi dari sumber sebelum deployment.

Semua operasi penghapusan akan meminta Anda untuk mengonfirmasi sebelum menghapus fungsi dari production.

Penghapusan fungsi secara eksplisit di Firebase CLI mendukung banyak argumen serta grup fungsi, dan dapat Anda gunakan untuk menentukan fungsi yang dijalankan di region tertentu. Selain itu, Anda juga dapat mengganti permintaan konfirmasi.

# Delete all functions that match the specified name in all regions.
firebase functions:delete myFunction

# Delete a specified function running in a specific region.
firebase functions:delete myFunction --region us-east-1

# Delete more than one function
firebase functions:delete myFunction myOtherFunction

# Delete a specified functions group.
firebase functions:delete groupA

# Bypass the confirmation prompt.
firebase functions:delete myFunction --force

Dengan penghapusan fungsi secara implisit, firebase deploy akan mengurai sumber Anda dan menghapus dari production semua fungsi yang telah dihapus dari file.

Mengubah nama, region, atau pemicu fungsi

Jika Anda mengganti nama atau mengubah region atau pemicu untuk fungsi yang menangani traffic lingkungan production, ikuti langkah-langkah di bagian ini untuk menghindari hilangnya peristiwa selama modifikasi. Sebelum mengikuti langkah-langkah ini, pastikan fungsi Anda idempoten, karena versi baru dan versi lama fungsi akan berjalan pada waktu yang sama selama perubahan.

Mengganti nama fungsi

Untuk mengganti nama fungsi, buat versi baru fungsi dengan nama yang baru di sumber Anda, lalu jalankan dua perintah deployment yang berbeda. Perintah pertama men-deploy fungsi dengan nama yang baru, dan perintah kedua menghapus versi yang di-deploy sebelumnya. Misalnya, jika Anda memiliki fungsi Node.js bernama webhook yang ingin diganti namanya menjadi webhookNew, revisi kode sebagai berikut:

// before
const functions = require('firebase-functions/v1');

exports.webhook = functions.https.onRequest((req, res) => {
    res.send("Hello");
});

// after
const functions = require('firebase-functions/v1');

exports.webhookNew = functions.https.onRequest((req, res) => {
    res.send("Hello");
});

Lalu, jalankan perintah berikut untuk men-deploy fungsi yang baru:

# Deploy new function called webhookNew
firebase deploy --only functions:webhookNew

# Wait until deployment is done; now both webhookNew and webhook are running

# Delete webhook
firebase functions:delete webhook

Mengganti region fungsi

Jika Anda mengganti region yang ditentukan untuk fungsi yang menangani traffic lingkungan production, Anda dapat mencegah kehilangan peristiwa dengan melakukan langkah-langkah berikut secara berurutan:

  1. Ubah nama fungsi, dan ubah regionnya sesuai keinginan.
  2. Deploy fungsi dengan nama yang baru, sehingga untuk sementara kode yang sama akan dijalankan di kedua region.
  3. Hapus fungsi sebelumnya.

Misalnya, jika Anda memiliki fungsi bernama webhook yang saat ini berada di region fungsi default us-central1, dan Anda ingin memigrasikannya ke asia-northeast1, Anda harus terlebih dahulu mengubah kode sumber untuk mengganti nama fungsi dan merevisi region tersebut.

// before
const functions = require('firebase-functions/v1');

exports.webhook = functions
    .https.onRequest((req, res) => {
            res.send("Hello");
    });

// after
const functions = require('firebase-functions/v1');

exports.webhookAsia = functions
    .region('asia-northeast1')
    .https.onRequest((req, res) => {
            res.send("Hello");
    });

Kemudian deploy dengan menjalankan:

firebase deploy --only functions:webhookAsia

Sekarang terdapat dua fungsi identik yang berjalan: webhook berjalan di us-central1, dan webhookAsia berjalan di asia-northeast1.

Selanjutnya, hapus webhook:

firebase functions:delete webhook

Sekarang hanya ada satu fungsi - webhookAsia, yang berjalan di asia-northeast1.

Mengganti jenis pemicu fungsi

Selama pengembangan deployment Cloud Functions for Firebase dari waktu ke waktu, Anda mungkin perlu mengganti jenis pemicu fungsi karena berbagai alasan. Misalnya, Anda mungkin ingin beralih dari satu jenis peristiwa Firebase Realtime Database atau Cloud Firestore ke jenis lainnya.

Anda tidak dapat mengganti jenis peristiwa fungsi hanya dengan mengganti kode sumber dan menjalankan firebase deploy. Untuk menghindari error, ganti jenis pemicu fungsi dengan prosedur ini:

  1. Ubah kode sumber untuk menyertakan fungsi baru dengan jenis pemicu yang diinginkan.
  2. Deploy fungsi, sehingga untuk sementara fungsi lama dan fungsi baru akan dijalankan bersama-sama.
  3. Hapus fungsi lama secara eksplisit dari production menggunakan Firebase CLI.

Misalnya, jika Anda memiliki fungsi Node.js bernama objectChanged yang memiliki jenis peristiwa onChange lama dan ingin menggantinya menjadi onFinalize, ganti nama fungsi terlebih dahulu dan edit agar memiliki jenis peristiwa onFinalize.

// before
const functions = require('firebase-functions/v1');

exports.objectChanged = functions.storage.object().onChange((object) => {
    return console.log('File name is: ', object.name);
});

// after
const functions = require('firebase-functions/v1');

exports.objectFinalized = functions.storage.object().onFinalize((object) => {
    return console.log('File name is: ', object.name);
});

Lalu, jalankan perintah berikut untuk membuat fungsi baru terlebih dahulu, sebelum menghapus fungsi lama:

# Create new function objectFinalized
firebase deploy --only functions:objectFinalized

# Wait until deployment is done; now both objectChanged and objectFinalized are running

# Delete objectChanged
firebase functions:delete objectChanged

Menetapkan opsi runtime

Cloud Functions for Firebase memungkinkan Anda memilih opsi runtime seperti versi runtime Node.js, waktu tunggu per fungsi, alokasi memori, dan instance fungsi minimum/maksimum.

Sebagai praktik terbaik, opsi ini (kecuali untuk versi Node.js) harus ditetapkan pada objek konfigurasi di dalam kode fungsi tersebut. Objek RuntimeOptions ini merupakan sumber tepercaya untuk opsi runtime fungsi Anda, dan akan mengganti opsi yang ditetapkan melalui metode lain (seperti melalui Google Cloud Console atau gcloud CLI).

Jika alur kerja pengembangan Anda melibatkan penetapan opsi runtime secara manual melalui Google Cloud Console atau gcloud CLI dan Anda tidak ingin nilai ini diganti pada setiap deployment, tetapkan preserveExternalChanges ke true. Jika opsi ini ditetapkan ke true, Firebase akan menggabungkan opsi runtime yang ditetapkan dalam kode Anda dengan setelan versi fungsi yang saat ini di-deploy dengan prioritas berikut:

  1. Opsi ditetapkan dalam kode fungsi: mengganti perubahan eksternal.
  2. Opsi ditetapkan ke RESET_VALUE dalam kode fungsi: mengganti perubahan eksternal dengan nilai default.
  3. Opsi tidak ditetapkan dalam kode fungsi, tetapi ditetapkan dalam fungsi yang saat ini di-deploy: menggunakan opsi yang ditentukan dalam fungsi yang di-deploy.

Penggunaan opsi preserveExternalChanges: true tidak direkomendasikan untuk sebagian besar skenario karena kode Anda tidak akan lagi menjadi sumber tepercaya penuh untuk opsi runtime fungsi Anda. Jika Anda menggunakannya, periksa Google Cloud Console atau gunakan gcloud CLI untuk melihat konfigurasi lengkap fungsi.

Menetapkan versi Node.js

Firebase SDK untuk Cloud Functions memungkinkan pemilihan runtime Node.js. Anda dapat memilih untuk menjalankan semua fungsi dalam project secara eksklusif di lingkungan runtime yang terkait dengan salah satu versi Node.js yang didukung ini:

  • Node.js 20 (pratinjau)
  • Node.js 18
  • Node.js 16
  • Node.js 14

Untuk menetapkan versi Node.js:

Anda dapat menetapkan versi di kolom engines pada file package.json yang dibuat dalam direktori functions/ selama inisialisasi. Misalnya, agar hanya menggunakan versi 18, edit baris berikut di package.json:

  "engines": {"node": "18"}

Jika menggunakan pengelola paket Yarn atau memiliki persyaratan khusus lainnya untuk kolom engines, Anda dapat menetapkan runtime untuk Firebase SDK untuk Cloud Functions di firebase.json:

  {
    "functions": {
      "runtime": "nodejs18" // or nodejs14, nodejs16 or nodejs20
    }
  }

CLI menggunakan nilai yang ditetapkan di firebase.json sebagai preferensi untuk nilai atau rentang apa pun yang Anda tetapkan secara terpisah di package.json.

Mengupgrade runtime Node.js Anda

Untuk mengupgrade runtime Node.js:

  1. Pastikan project Anda menggunakan paket harga Blaze.
  2. Pastikan Anda menggunakan Firebase CLI v11.18.0 atau yang lebih baru.
  3. Ubah nilai engines pada file package.json yang dibuat dalam direktori functions/ selama inisialisasi. Misalnya, jika Anda melakukan upgrade dari versi 16 ke versi 18, entrinya akan terlihat seperti ini: "engines": {"node": "18"}
  4. Jika ingin, Anda dapat menguji perubahan menggunakan Firebase Local Emulator Suite.
  5. Deploy ulang semua fungsi.

Mengontrol perilaku penskalaan

Secara default, Cloud Functions for Firebase menskalakan jumlah instance yang berjalan berdasarkan jumlah permintaan masuk dan berpotensi untuk memperkecil skala hingga nol instance pada saat traffic berkurang. Namun, jika aplikasi Anda memerlukan latensi yang lebih rendah dan Anda ingin membatasi jumlah cold start, perilaku default ini dapat diubah dengan menentukan jumlah minimum instance container yang harus tetap aktif dan siap untuk melayani permintaan.

Demikian pula, Anda dapat menetapkan jumlah maksimum untuk membatasi penskalaan instance sebagai respons terhadap permintaan masuk. Gunakan setelan ini sebagai salah satu cara untuk mengontrol biaya Anda atau untuk membatasi jumlah koneksi ke layanan pendukung seperti ke database.

Mengurangi jumlah cold start

Untuk menetapkan jumlah minimum instance untuk fungsi dalam kode sumber, gunakan metode runWith. Metode ini menerima objek JSON yang sesuai dengan antarmuka RuntimeOptions, yang menentukan nilai untuk minInstances. Misalnya, fungsi ini menetapkan minimum 5 instance yang harus tetap aktif:

exports.getAutocompleteResponse = functions
    .runWith({
      // Keep 5 instances warm for this latency-critical function
      minInstances: 5,
    })
    .https.onCall((data, context) => {
      // Autocomplete a user's search term
    });
index.js

Berikut beberapa hal yang perlu dipertimbangkan saat menetapkan nilai untuk minInstances:

  • Jika Cloud Functions for Firebase menskalakan aplikasi Anda melampaui batas pada setelan minInstances, Anda akan mengalami cold start untuk setiap instance yang melampaui batas tersebut.
  • Cold start memiliki dampak yang paling signifikan pada aplikasi dengan lonjakan traffic yang tajam. Jika aplikasi Anda memiliki lonjakan traffic yang tajam, dan nilai minInstances yang Anda tetapkan cukup tinggi sehingga cold start berkurang pada setiap peningkatan traffic, akan terjadi penurunan latensi yang signifikan. Untuk aplikasi dengan traffic yang konstan, cold start kemungkinan tidak akan memengaruhi performa secara signifikan.

  • Menetapkan instance minimum dapat dilakukan untuk lingkungan production, tetapi biasanya sebaiknya dihindari di lingkungan pengujian. Untuk melakukan penskalaan hingga nol dalam project pengujian, tetapi tetap mengurangi cold start di project lingkungan production, Anda dapat menetapkan minInstances berdasarkan variabel lingkungan FIREBASE_CONFIG:

    // Get Firebase project id from `FIREBASE_CONFIG` environment variable
const envProjectId = JSON.parse(process.env.FIREBASE_CONFIG).projectId;

exports.renderProfilePage = functions
    .runWith({
      // Keep 5 instances warm for this latency-critical function
      // in production only. Default to 0 for test projects.
      minInstances: envProjectId === "my-production-project" ? 5 : 0,
    })
    .https.onRequest((req, res) => {
      // render some html
    });
    index.js

Membatasi jumlah maksimum instance untuk fungsi

Untuk menetapkan instance maksimum dalam kode sumber fungsi, gunakan metode runWith. Metode ini menerima objek JSON yang sesuai dengan antarmuka RuntimeOptions, yang menentukan nilai untuk maxInstances. Misalnya, fungsi ini menetapkan batas 100 instance agar tidak membebani suatu database lama fiktif:

exports.mirrorOrdersToLegacyDatabase = functions
    .runWith({
      // Legacy database only supports 100 simultaneous connections
      maxInstances: 100,
    })
    .firestore.document("orders/{orderId}")
    .onWrite((change, context) => {
      // Connect to legacy database
    });
index.js

Jika fungsi HTTP ditingkatkan skalanya hingga batas maxInstances, permintaan baru akan dimasukkan ke dalam antrean selama 30 detik, lalu ditolak dengan kode respons 429 Too Many Requests jika tidak ada instance yang tersedia hingga saat itu.

Untuk mempelajari lebih lanjut praktik terbaik dalam menggunakan setelan instance maksimum, baca praktik terbaik dalam menggunakan maxInstances ini.

Menetapkan waktu tunggu dan alokasi memori

Dalam beberapa kasus, fungsi Anda dapat memiliki persyaratan khusus untuk nilai waktu tunggu yang lama atau alokasi memori yang besar. Anda dapat menetapkan nilai-nilai ini di Konsol Google Cloud atau di kode sumber fungsi (khusus Firebase).

Untuk menetapkan alokasi memori dan waktu tunggu dalam kode sumber fungsi, gunakan parameter runWith yang diperkenalkan di Firebase SDK untuk Cloud Functions 2.0.0. Opsi runtime ini menerima objek JSON yang sesuai dengan antarmuka RuntimeOptions, yang menentukan nilai untuk timeoutSeconds dan memory. Misalnya, fungsi penyimpanan ini menggunakan memori 1 GB dan akan berakhir setelah 300 detik:

exports.convertLargeFile = functions
    .runWith({
      // Ensure the function has enough memory and time
      // to process large files
      timeoutSeconds: 300,
      memory: "1GB",
    })
    .storage.object()
    .onFinalize((object) => {
      // Do some complicated things that take a lot of memory and time
    });
index.js

Nilai maksimum untuk timeoutSeconds adalah 540, atau 9 menit. Jumlah memori yang diberikan ke sebuah fungsi sesuai dengan CPU yang dialokasikan untuk fungsi tersebut, seperti yang dijelaskan dalam daftar nilai yang valid untuk memory ini:

  • 128MB — 200 MHz
  • 256MB — 400 MHz
  • 512MB — 800 MHz
  • 1GB — 1,4 GHz
  • 2GB — 2,4 GHz
  • 4GB — 4,8 GHz
  • 8GB — 4,8 GHz

Untuk menetapkan alokasi memori dan waktu tunggu di Google Cloud console:

  1. Di Konsol Google Google Cloud, pilih Cloud Functions dari menu sebelah kiri.
  2. Pilih fungsi dengan mengklik namanya di daftar fungsi.
  3. Klik ikon Edit di menu atas.
  4. Pilih alokasi memori dari menu drop-down berlabel Memory allocated.
  5. Klik More untuk menampilkan opsi lanjutan, dan masukkan jumlah detik di kotak teks Timeout.
  6. Klik Save untuk mengubah fungsi.