Menggunakan Remote Config di lingkungan server

Firebase Remote Config kini mendukung konfigurasi sisi server yang menggunakan Firebase Admin Node.js SDK v12.1.0+. Kemampuan baru ini memungkinkan Anda untuk mengelola perilaku dan konfigurasi aplikasi sisi server secara dinamis menggunakan Remote Config. Hal ini mencakup penerapan serverless seperti Cloud Functions.

Tidak seperti SDK klien Firebase, yang mengambil konfigurasi khusus klien yang berasal dari template Remote Config, Remote Config sisi server SDK mendownload template Remote Config yang lengkap dari Firebase. Server Anda kemudian dapat mengevaluasi template dengan setiap permintaan masuk dan menggunakan logikanya sendiri untuk menyajikan respons yang disesuaikan dengan latensi yang sangat rendah.

Dengan Remote Config sisi server, Anda dapat:

  • Menentukan parameter konfigurasi untuk aplikasi yang berjalan pada atau diakses melalui server Anda, sehingga memungkinkan kasus penggunaan seperti mengonfigurasi parameter dan prompt model AI dari jarak jauh serta integrasi lainnya, untuk memastikan kunci API tetap aman.
  • Menyesuaikan parameter secara dinamis sebagai respons terhadap perubahan lingkungan atau perubahan aplikasi lainnya, seperti memperbarui parameter LLM dan endpoint model.
  • Mengontrol biaya dengan mengupdate API yang dipanggil server Anda dari jarak jauh.
  • Membuat konfigurasi khusus dengan cepat untuk klien yang mengakses server Anda.
  • Mencatat klien mana yang menerima parameter value dan menggunakan catatan ini di Cloud Functions sebagai bagian dari sistem verifikasi hak.

Anda dapat men-deploy Remote Config sisi server di Cloud Run, Cloud Functions, atau lingkungan server yang dihosting sendiri.

Sebelum memulai

Ikuti petunjuk dalam artikel Menambahkan Firebase Admin SDK ke server untuk membuat project Firebase, menyiapkan akun layanan, dan menambahkan Firebase Admin Node.js SDK ke server Anda.

Langkah 1: Inisialisasi Firebase Admin Node.js SDK dan beri otorisasi permintaan API

Saat Anda menginisialisasi Admin SDK tanpa parameter, SDK akan menggunakan Kredensial Default Aplikasi Google dan membaca opsi dari variabel lingkungan GOOGLE_APPLICATION_CREDENTIALS. Misalnya, untuk menginisialisasi SDK dan menambahkan Remote Config:

import { initializeApp } from "firebase-admin/app";
import { getRemoteConfig } from "firebase-admin/remote-config";

// Initialize Firebase
const firebaseApp = initializeApp();

Langkah 2: Identifikasi parameter value default untuk aplikasi server

Identifikasi variabel di aplikasi yang ingin Anda perbarui secara dinamis dengan Remote Config. Kemudian, pertimbangkan variabel mana yang harus ditetapkan secara default di aplikasi Anda dan berapa nilai defaultnya. Hal ini memastikan bahwa aplikasi Anda berjalan dengan sukses meskipun koneksinya ke Server backend Remote Config terganggu.

Misalnya, jika Anda menulis aplikasi server yang mengelola fungsi AI generatif, Anda bisa menetapkan nama model default, field preamble prompt, dan konfigurasi AI generatif, seperti berikut:

Nama parameter Deskripsi Type Nilai default
model_name Nama API Model String gemini-1.5-pro
preamble_prompt Prompt untuk menambahkan kueri pengguna String I'm a developer who wants to learn about Firebase and you are a helpful assistant who knows everything there is to know about Firebase!
generation_config Parameter yang akan dikirim ke model JSON {"stopSequences": ["I hope this helps"], "temperature": 0.7, "maxOutputTokens": 512, "topP": 0.1, "topK": 20}

Langkah 3: Konfigurasikan aplikasi server Anda

Setelah Anda menentukan parameter yang ingin digunakan dengan Remote Config, konfigurasikan aplikasi Anda untuk menetapkan nilai default, mengambil template Remote Config khusus server, dan menggunakan nilainya. Langkah-langkah berikut menjelaskan cara mengonfigurasi aplikasi Node.js Anda.

  1. Mengakses dan memuat template.

    // Initialize server-side Remote Config
const rc = getRemoteConfig(firebaseApp);
const template = rc.initServerTemplate();

// Load Remote Config
await template.load();

    Jika menggunakan Node.js dalam Cloud Functions, Anda dapat menggunakan getServerTemplate asinkron untuk mengambil dan memuat template dalam satu langkah:

    // Initialize server-side Remote Config
const rc = getRemoteConfig(firebaseApp);
const template = await rc.getServerTemplate();

  2. Untuk memastikan bahwa aplikasi Anda berjalan dengan sukses meskipun koneksinya ke server backend Remote Config terganggu, tambahkan nilai default untuk setiap parameter ke aplikasi Anda. Untuk melakukannya, tambahkan defaultConfig di dalam fungsi template initServerTemplate atau getServerTemplate:

    const template = rc.initServerTemplate({
  defaultConfig: {
    model_name: "gemini-pro",
    generation_config: '{"stopSequences": [], "temperature": 0.7, "maxOutputTokens": 512, "topP": 0.1, "topK": 20}',
    preamble_prompt: "I'm a developer who wants to learn about Firebase and you are a helpful assistant who knows everything there is to know about Firebase!"
  },
});

// Load Remote Config
await template.load();

  3. Setelah template dimuat, gunakan template.evaluate() untuk mengimpor parameter dan nilai dari template:

    // Add template parameters to config
const config = template.evaluate();

  4. Secara opsional, jika Anda menetapkan persentase kondisi dalam template Remote Config, tentukan dan berikan randomizationId yang ingin Anda gunakan untuk mengevaluasi kondisi di dalam fungsi template.evaluate().

    Misalnya, Anda dapat menetapkan ID penginstalan Firebase sebagai randomizationId, atau ID pengguna, untuk memastikan bahwa setiap pengguna yang menghubungi server Anda ditambahkan ke grup acak yang sesuai. Contoh berikut adalah contoh dasar, tetapi Anda dapat mengonfigurasi server untuk membuat randomizationIds yang berbeda untuk permintaan klien yang berbeda, untuk memastikan pengguna diberikan nilai yang konsisten dari Remote Config berdasarkan keanggotaannya dalam grup kondisi persentase.

    Untuk mengetahui informasi selengkapnya tentang kondisi persentase, lihat Pengguna dalam persentase acak.

    // Set the randomizationId
const randomizationId = "2ac93c28-c459-4760-963d-a3974ec26c04"

// Add template parameters to `config`. Evaluates the
// template and returns the parameter value assigned to
// the group assigned to the {randomizationId}.
const config = template.evaluate({
  randomizationId
});

  5. Selanjutnya, ekstrak parameter value yang Anda perlukan dari konstan konfigurasi. Gunakan getters untuk mentransmisikan nilai dari Remote Config ke nilai format yang diharapkan. Berikut adalah jenis-jenis yang didukung:

    • Boolean: getBoolean
    • Objek: getValue
    • Angka: getNumber
    • String: getString

    Misalnya, jika Anda mengimplementasikan Vertex AI pada server dan ingin mengubah model dan parameter model, Anda dapat mengonfigurasi parameter untuk model_name dan generationConfig. Berikut ini contoh cara mengakses nilai Remote Config:

    // Replace defaults with values from Remote Config.
const generationConfig =
  JSON.parse(
    config.getString('generation_config'));

const is_ai_enabled = config.getBool('is_ai_enabled');

const model = config.getString('model_name');

// Generates a prompt comprised of the Remote Config
// parameter and prepends it to the user prompt
const prompt = `${config.getString('preamble_prompt')} ${req.query.prompt}`;

  6. Jika server Anda berjalan lama, dibandingkan dengan lingkungan serverless, gunakan setInterval untuk memuat ulang template secara berkala guna memastikan bahwa Anda secara berkala mengambil template terbaru dari server Remote Config.

Langkah 4: Menetapkan parameter value khusus server di Remote Config

Selanjutnya, buat template Remote Config server serta konfigurasikan parameter dan nilai yang akan digunakan dalam aplikasi Anda.

Untuk membuat template Remote Config khusus server:

  1. Buka halaman parameter Remote Config Firebase console dan dari pemilih Client/Server, pilih Server.
  2. Tentukan parameter Remote Config dengan nama dan jenis data yang sama dengan parameter yang Anda tetapkan dalam aplikasi dan berikan nilainya. Nilai ini akan menggantikan defaultConfig yang Anda tetapkan di Konfigurasikan aplikasi server saat Anda mengambil dan mengevaluasi template serta menetapkan nilai-nilai ini ke variabel Anda.
  3. Opsional, tetapkan ketentuan persentase untuk terus menerapkan nilai ke sampel acak instance. Untuk mengetahui informasi selengkapnya tentang kondisi persentase, lihat Pengguna dalam persentase acak.
  4. Setelah selesai menambahkan parameter, klik Publish changes.
  5. Tinjau perubahan, lalu klik kembali Publish changes.

Langkah 5: Deploy dengan Cloud Functions atau Cloud Run

Jika aplikasi server Anda ringan dan berbasis peristiwa, Anda dapat mempertimbangkan untuk men-deploy kode menggunakan Cloud Functions. Misalnya, Anda memiliki aplikasi yang menyertakan dialog karakter yang didukung oleh AI generatif API (misalnya, Google AI atau Vertex AI). Dalam hal ini, Anda dapat menghosting logika penyajian LLM dalam fungsi yang dipanggil aplikasi Anda on-demand.

Jika aplikasi Anda dimaksudkan untuk berjalan lama (misalnya, aplikasi web dengan aset), Anda dapat mempertimbangkan Cloud Run. Untuk men-deploy aplikasi server Anda dengan Cloud Run, ikuti panduan di Panduan Memulai: Men-deploy Layanan Node.js ke Cloud Run.

Untuk mengetahui informasi selengkapnya tentang kasus penggunaan terbaik untuk Cloud Run dan Cloud Functions, lihat Cloud Functions vs. Cloud Run: kapan harus menggunakan salah satu dari keduanya.