Catch up on everthing we announced at this year's Firebase Summit. Learn more

Quản lý các tùy chọn triển khai và thời gian chạy chức năng

Bạn có thể triển khai, xóa và sửa đổi các chức năng bằng cách sử dụng lệnh Firebase CLI hoặc bằng cách đặt các tùy chọn thời gian chạy trong mã nguồn chức năng của bạn.

Triển khai các chức năng

Để triển khai các chức năng, hãy chạy lệnh Firebase CLI này:

$ firebase deploy --only functions

Theo mặc định, căn cứ hỏa lực CLI triển khai tất cả các chức năng bên trong index.js cùng một lúc. Nếu dự án của bạn có chứa hơn 5 chức năng, chúng tôi khuyên bạn nên sử dụng --only cờ với tên hàm cụ thể để triển khai chỉ các chức năng mà bạn đã chỉnh sửa. Triển khai chức năng cụ thể theo cách này tăng tốc quá trình triển khai và giúp bạn tránh chạy vào hạn ngạch triển khai. Ví dụ:

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

Khi triển khai số lượng lớn các chức năng, bạn có thể vượt quá hạn ngạch tiêu chuẩn và nhận được thông báo lỗi HTTP 429 hoặc 500. Để giải quyết vấn đề này, hãy triển khai các chức năng theo nhóm 10 người trở xuống.

Xem các tài liệu tham khảo căn cứ hỏa lực CLI cho đầy đủ danh sách các lệnh có sẵn.

Theo mặc định, căn cứ hỏa lực CLI trông trong functions/ thư mục cho mã nguồn. Bạn có thể chỉ định một thư mục khác bằng cách thêm các dòng sau trong firebase.json :

"functions": {
  "source": "another-folder"
}

Xóa các chức năng

Bạn có thể xóa các chức năng đã triển khai trước đó theo những cách sau:

  • rõ ràng trong căn cứ hỏa lực CLI với functions:delete
  • một cách rõ ràng bằng cách sử dụng menu ngữ cảnh trong danh sách các chức năng trong căn cứ hỏa lực console
  • implictly bằng cách loại bỏ các chức năng từ index.js trước khi triển khai.

Tất cả các thao tác xóa đều nhắc bạn xác nhận trước khi xóa chức năng khỏi sản xuất.

Xóa hàm rõ ràng trong Firebase CLI hỗ trợ nhiều đối số cũng như các nhóm hàm và cho phép bạn chỉ định một hàm đang chạy trong một vùng cụ thể. Ngoài ra, bạn có thể ghi đè lời nhắc xác nhận.

# 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

Với xóa chức năng tiềm ẩn, firebase deploy phân tích index.js và loại bỏ từ khâu sản xuất bất kỳ chức năng đã được lấy ra từ các tập tin.

Sửa đổi tên, khu vực hoặc trình kích hoạt của chức năng

Nếu bạn đang đổi tên hoặc thay đổi vùng hoặc kích hoạt các chức năng đang xử lý lưu lượng sản xuất, hãy làm theo các bước trong phần này để tránh mất các sự kiện trong quá trình sửa đổi. Trước khi bạn làm theo các bước này, đầu tiên đảm bảo rằng chức năng của bạn là idempotent , vì cả hai phiên bản mới và phiên bản cũ của chức năng của bạn sẽ được chạy cùng một lúc trong sự thay đổi.

Đổi tên một hàm

Để đổi tên một chức năng, tạo ra một phiên bản đổi tên mới của các chức năng trong index.js và sau đó chạy hai lệnh triển khai riêng biệt. Lệnh đầu tiên triển khai chức năng mới được đặt tên và lệnh thứ hai loại bỏ phiên bản đã triển khai trước đó. Ví dụ, nếu bạn có một chức năng gọi là webhook mà bạn muốn thay đổi để webhookNew , rà soát lại các mã như sau:

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

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

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

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

Sau đó chạy các lệnh sau để triển khai chức năng mới:

# 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

Thay đổi vùng hoặc các vùng của chức năng

Nếu bạn đang thay đổi quy định khu vực cho một chức năng đó là xử lý giao thông sản xuất, bạn có thể ngăn chặn sự mất mát sự kiện bằng cách thực hiện các bước sau theo thứ tự:

  1. Đổi tên chức năng và thay đổi vùng hoặc các vùng của nó như mong muốn.
  2. Triển khai chức năng đã đổi tên, dẫn đến tạm thời chạy cùng một mã trong cả hai nhóm vùng.
  3. Xóa chức năng trước đó.

Ví dụ, nếu bạn có một chức năng gọi là webhook hiện đang có trong các chức năng mặc định khu vực của us-central1 , và bạn muốn di chuyển nó đến asia-northeast1 , bạn cần phải đầu tiên sửa đổi mã nguồn của bạn để đổi tên các chức năng và rà soát khu vực .

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

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

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

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

Sau đó triển khai bằng cách chạy:

$ firebase deploy --only functions:webhookAsia

Bây giờ có hai chức năng giống hệt nhau chạy: webhook đang chạy trong us-central1 , và webhookAsia đang chạy trong asia-northeast1 .

Sau đó, xóa webhook :

$ firebase functions:delete webhook

Bây giờ chỉ có một chức năng - webhookAsia , mà đang chạy trong asia-northeast1 .

Thay đổi loại trình kích hoạt của một chức năng

Khi bạn phát triển các Chức năng đám mây của mình để triển khai Firebase theo thời gian, bạn có thể cần phải thay đổi loại kích hoạt của một chức năng vì nhiều lý do khác nhau. Ví dụ: bạn có thể muốn:

  • Thay đổi từ việc lưu trữ di sản onChange sự kiện để onFinalize , onDelete , onArchive , và onMetadataUpdate . (Tìm hiểu thêm về điều này trong phiên bản beta để v1 hoặc v2 nâng cấp hướng dẫn ).
  • Thay đổi từ một loại cơ sở dữ liệu căn cứ hỏa lực Realtime hoặc sự kiện đám mây FireStore với nhau, chẳng hạn như chung onWrite sự kiện vào hạt onCreate sự kiện.

Nó không phải là có thể thay đổi loại sự kiện của chức năng bằng cách chỉ cần thay đổi mã nguồn và chạy firebase deploy . Để tránh lỗi, hãy thay đổi kiểu kích hoạt của hàm bằng quy trình sau:

  1. Sửa đổi mã nguồn để bao gồm một chức năng mới với loại trình kích hoạt mong muốn.
  2. Triển khai chức năng, dẫn đến việc chạy tạm thời cả chức năng cũ và mới.
  3. Xóa rõ ràng chức năng cũ khỏi sản xuất bằng cách sử dụng Firebase CLI.

Ví dụ, nếu bạn đã có một chức năng objectChanged có những di sản onChange loại sự kiện, và bạn muốn thay đổi nó để onFinalize , đầu tiên đổi tên chức năng và chỉnh sửa nó để có onFinalize loại sự kiện.

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

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

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

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

Sau đó, chạy các lệnh sau để tạo hàm mới trước, trước khi xóa hàm cũ:

# 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

Đặt tùy chọn thời gian chạy

Chức năng đám mây cho Firebase cho phép bạn chọn các tùy chọn thời gian chạy như phiên bản thời gian chạy Node.js và thời gian chờ cho mỗi chức năng, phân bổ bộ nhớ và các phiên bản chức năng tối thiểu / tối đa.

Đặt phiên bản Node.js

SDK Firebase cho Chức năng đám mây 2.0.0 trở lên cho phép lựa chọn thời gian chạy Node.js. Bạn có thể chọn chạy tất cả các chức năng trong một dự án độc quyền trên môi trường thời gian chạy tương ứng với một trong các phiên bản Node.js được hỗ trợ sau:

  • Node.js 16 (beta)
  • Node.js 14
  • Node.js 12
  • Node.js 10
  • Node.js 8 (bị phản đối trên 08 Tháng Sáu 2020) Triển khai các chức năng để các Node.js 8 runtime được vô hiệu hóa trong căn cứ hỏa lực CLI vào ngày 15, năm 2020. Thực hiện các chức năng đã triển khai-sẽ dừng lại ở một số điểm trong tương lai; nếu bạn đã triển khai chức năng để thời gian chạy Node.js 8, chúng tôi khuyên bạn nên nâng cấp lên Node.js 14 runtime .

Để đặt phiên bản Node.js:

Đặt phiên bản trong engines trường trong package.json tập tin được tạo ra trong bạn functions/ thư mục trong quá trình khởi. Ví dụ, để chỉ sử dụng phiên bản 14, chỉnh sửa dòng này trong package.json :

  "engines": {"node": "14"}

Các engines lĩnh vực được yêu cầu; nó phải xác định một trong những phiên bản Node.js được hỗ trợ theo thứ tự để bạn có thể triển khai và chức năng chạy. Hiện nay firebase init functions bộ lĩnh vực này để 14 .

Nâng cấp thời gian chạy Node.js của bạn

Để nâng cấp thời gian chạy Node.js của bạn:

  1. Hãy chắc chắn rằng dự án của bạn là trên kế hoạch giá Blaze .
  2. Đảm bảo rằng bạn đang sử dụng Firebase CLI v8.6.0 trở lên.
  3. Thay đổi engines giá trị trong package.json tập tin được tạo ra trong bạn functions/ thư mục trong quá trình khởi. Ví dụ, nếu bạn đang nâng cấp từ phiên bản 10 lên phiên bản 14, sự xâm nhập sẽ trông như thế này: "engines": {"node": "14"}
  4. Tùy chọn, kiểm tra những thay đổi của bạn bằng cách sử dụng căn cứ hỏa lực địa phương Emulator Suite .
  5. Triển khai lại các chức năng bằng Firebase CLI v8.1.0 trở lên.

Kiểm soát hành vi mở rộng quy mô

Theo mặc định, Chức năng đám mây cho Firebase chia tỷ lệ số lượng phiên bản đang chạy dựa trên số lượng yêu cầu đến, có khả năng giảm xuống 0 phiên bản trong thời gian lưu lượng truy cập giảm. Tuy nhiên, nếu ứng dụng của bạn yêu cầu giảm độ trễ và bạn muốn giới hạn số lần khởi động nguội, bạn có thể thay đổi hành vi mặc định này bằng cách chỉ định số lượng phiên bản vùng chứa tối thiểu để giữ ấm và sẵn sàng cung cấp yêu cầu.

Tương tự, bạn có thể đặt số lượng tối đa để giới hạn quy mô của các phiên bản để phản hồi các yêu cầu đến. Sử dụng cài đặt này như một cách để kiểm soát chi phí của bạn hoặc để giới hạn số lượng kết nối đến dịch vụ hỗ trợ chẳng hạn như cơ sở dữ liệu.

Giảm số lần khởi động lạnh

Để số tối thiểu đã đặt các trường hợp cho một hàm trong mã nguồn, sử dụng runWith tham số. Lựa chọn thời gian chạy này chấp nhận một đối tượng JSON phù hợp với các RuntimeOptions giao diện, trong đó xác định giá trị cho minInstances . Ví dụ: chức năng này đặt tối thiểu 5 trường hợp để giữ ấm:

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
    });

Dưới đây là một số điều cần xem xét khi thiết lập một giá trị cho minInstances :

  • Nếu Cloud Chức năng cho căn cứ hỏa lực quy mô ứng dụng của bạn trên của bạn minInstances cài đặt, bạn sẽ trải nghiệm một sự khởi đầu lạnh cho mỗi trường hợp trên ngưỡng đó.
  • Khởi động lạnh có ảnh hưởng nghiêm trọng nhất đến các ứng dụng có lưu lượng truy cập tăng đột biến. Nếu ứng dụng của bạn có giao thông có gai nhọn và bạn thiết lập một minInstances đánh giá đủ cao mà bắt đầu lạnh được giảm trên mỗi tăng giao thông, bạn sẽ thấy giảm đáng kể độ trễ. Đối với các ứng dụng có lưu lượng truy cập liên tục, khởi động nguội không có khả năng ảnh hưởng nghiêm trọng đến hiệu suất.
  • Việc thiết lập các trường hợp tối thiểu có thể có ý nghĩa đối với môi trường sản xuất, nhưng thường nên tránh trong môi trường thử nghiệm. Để mở rộng quy mô bằng không trong dự án thử nghiệm của bạn nhưng vẫn giảm bắt đầu lạnh trong dự án sản xuất, bạn có thể thiết lập minInstances dựa trên FIREBASE_CONFIG biến môi trường:

    // 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
        });
    

Giới hạn số lượng phiên bản tối đa cho một hàm

Để các trường hợp tối đa bộ trong mã nguồn của chức năng, sử dụng runWith tham số. Lựa chọn thời gian chạy này chấp nhận một đối tượng JSON phù hợp với các RuntimeOptions giao diện, trong đó xác định giá trị cho maxInstances . Ví dụ: chức năng này đặt giới hạn 100 trường hợp để không lấn át cơ sở dữ liệu kế thừa giả định:

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

Nếu một chức năng HTTP được nhân rộng đến maxInstances giới hạn, yêu cầu mới đang xếp hàng đợi trong 30 giây và sau đó bị từ chối với một mã phản hồi của 429 Too Many Requests nếu không có trường hợp có sẵn bằng cách sau đó.

Để tìm hiểu thêm về thực tiễn tốt nhất cho việc sử dụng các thiết lập trường hợp tối đa, hãy kiểm tra các thực hành tốt nhất cho việc sử dụng maxInstances .

Đặt thời gian chờ và phân bổ bộ nhớ

Trong một số trường hợp, các hàm của bạn có thể có các yêu cầu đặc biệt đối với giá trị thời gian chờ dài hoặc phân bổ bộ nhớ lớn. Bạn có thể đặt các giá trị này trong Google Cloud Console hoặc trong mã nguồn chức năng (chỉ Firebase).

Để cấp phát bộ nhớ thiết lập và thời gian chờ trong mã nguồn các chức năng, sử dụng runWith tham số được giới thiệu vào căn cứ hỏa lực SDK cho Cloud Chức năng 2.0.0. Lựa chọn thời gian chạy này chấp nhận một đối tượng JSON phù hợp với các RuntimeOptions giao diện, trong đó xác định giá trị cho timeoutSecondsmemory . Ví dụ: chức năng lưu trữ này sử dụng 1GB bộ nhớ và hết thời gian sau 300 giây:

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
    });

Giá trị tối đa cho timeoutSeconds540 , tương đương 9 phút. Dung lượng bộ nhớ cấp cho một chức năng tương ứng với CPU phân bổ cho các chức năng, như trình bày chi tiết trong danh sách này của giá trị hợp lệ cho memory :

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

Để đặt phân bổ bộ nhớ và thời gian chờ trong Google Cloud Console:

  1. Trong Google Google Cloud Bảng điều khiển chọn Mây Chức năng từ menu bên trái.
  2. Chọn một chức năng bằng cách nhấp vào tên của nó trong danh sách chức năng.
  3. Nhấp vào biểu tượng Chỉnh sửa trong top menu.
  4. Chọn một phân bổ bộ nhớ từ menu dán nhãn Memory thả xuống cấp.
  5. Nhấp vào Thêm để hiển thị các tùy chọn nâng cao, và nhập số giây vào hộp văn bản Timeout.
  6. Nhấp vào Lưu để cập nhật các chức năng.