อัปเกรดฟังก์ชัน Node.js รุ่นที่ 1 เป็นรุ่นที่ 2

แอปที่ใช้ฟังก์ชันรุ่นที่ 1 อยู่ในปัจจุบันควรพิจารณาย้ายข้อมูลไปยังรุ่นที่ 2 โดยใช้วิธีการในคู่มือนี้ ฟังก์ชันรุ่นที่ 2 ใช้ Cloud Run เพื่อมอบประสิทธิภาพที่ดีขึ้น การกำหนดค่าที่ดีขึ้น การตรวจสอบที่ดีขึ้น และอื่นๆ อีกมากมาย

ตัวอย่างในหน้านี้สมมติว่าคุณใช้ JavaScript กับโมดูล CommonJS (require การนำเข้ารูปแบบ) แต่หลักการเดียวกันนี้จะใช้กับ JavaScript ที่มี ESM (การนำเข้ารูปแบบ import … from) และ TypeScript

ขั้นตอนการย้ายข้อมูล

ฟังก์ชันรุ่นที่ 1 และรุ่นที่ 2 สามารถอยู่คู่กันในไฟล์เดียวกัน วิธีนี้จะช่วยให้การย้ายข้อมูลทีละส่วนทำได้ง่ายขึ้น เมื่อคุณพร้อมแล้ว เราขอแนะนำให้ย้ายข้อมูลทีละฟังก์ชัน แล้วทำการทดสอบและยืนยันก่อนดำเนินการต่อ

ยืนยันเวอร์ชันของ Firebase CLI และ firebase-function

ตรวจสอบว่าคุณใช้ Firebase CLI เวอร์ชัน 12.00 และ firebase-functions เวอร์ชัน 4.3.0 เป็นอย่างต่ำ ส่วนเวอร์ชันใหม่กว่าจะรองรับรุ่นที่ 2 และรุ่นที่ 1

อัปเดตการนำเข้า

นำเข้าฟังก์ชันรุ่นที่ 2 จากแพ็กเกจย่อย v2 ใน SDK ของ firebase-functions เส้นทางการนำเข้าที่แตกต่างกันนี้ก็คือ Firebase CLI ทั้งหมดจำเป็นต้องพิจารณาว่าจะใช้งานโค้ดฟังก์ชันเป็นฟังก์ชันรุ่นที่ 1 หรือ 2

แพ็กเกจย่อย v2 เป็นแบบโมดูล และเราขอแนะนำให้นำเข้าเฉพาะโมดูลที่คุณต้องการเท่านั้น

ก่อน: รุ่นที่ 1

const functions = require("firebase-functions");

หลัง: รุ่นที่ 2

// explicitly import each trigger
const {onRequest} = require("firebase-functions/v2/https");
const {onDocumentCreated} = require("firebase-functions/v2/firestore");

อัปเดตคำจำกัดความของทริกเกอร์

เนื่องจาก SDK รุ่นที่ 2 ชอบการนำเข้าแบบแยกส่วน คุณจึงควรอัปเดตคำจำกัดความของทริกเกอร์เพื่อแสดงการนำเข้าที่เปลี่ยนแปลงจากขั้นตอนก่อนหน้า

มีการเปลี่ยนแปลงอาร์กิวเมนต์ที่ส่งผ่านไปยังโค้ดเรียกกลับสำหรับทริกเกอร์บางรายการ ในตัวอย่างนี้ โปรดทราบว่าระบบได้รวมอาร์กิวเมนต์ของโค้ดเรียกกลับ onDocumentCreated ไว้ในออบเจ็กต์ event รายการเดียว นอกจากนี้ ทริกเกอร์บางตัวมีฟีเจอร์การกำหนดค่าใหม่ที่ใช้งานง่าย เช่น ตัวเลือก cors ของทริกเกอร์ onRequest

ก่อน: รุ่นที่ 1

const functions = require("firebase-functions");

exports.date = functions.https.onRequest((req, res) => {
  // ...
});

exports.uppercase = functions.firestore
  .document("my-collection/{docId}")
  .onCreate((change, context) => {
    // ...
  });

หลัง: รุ่นที่ 2

const {onRequest} = require("firebase-functions/v2/https");
const {onDocumentCreated} = require("firebase-functions/v2/firestore");

exports.date = onRequest({cors: true}, (req, res) => {
  // ...
});

exports.uppercase = onDocumentCreated("my-collection/{docId}", (event) => {
  /* ... */
});

ใช้การกำหนดค่าที่ทำเป็นพารามิเตอร์

ฟังก์ชันรุ่นที่ 2 จะรองรับ functions.config น้อยลง เพื่อเปลี่ยนไปใช้อินเทอร์เฟซที่มีความปลอดภัยมากขึ้นสำหรับการกำหนดพารามิเตอร์การกำหนดค่าอย่างชัดเจนภายในฐานของโค้ด เมื่อใช้โมดูล params ใหม่ CLI จะบล็อกการติดตั้งใช้งาน เว้นแต่พารามิเตอร์ทั้งหมดมีค่าที่ถูกต้อง ทำให้มั่นใจได้ว่าฟังก์ชันจะไม่ทำให้ใช้งานได้โดยที่ไม่มีการกำหนดค่า

ย้ายข้อมูลไปยังแพ็กเกจย่อย params

หากใช้การกำหนดค่าสภาพแวดล้อมกับ functions.config อยู่ คุณจะย้ายข้อมูลการกำหนดค่าที่มีอยู่ไปยังการกำหนดค่าที่ทำเป็นพารามิเตอร์ได้

ก่อน: รุ่นที่ 1

const functions = require("firebase-functions");

exports.date = functions.https.onRequest((req, res) => {
  const date = new Date();
  const formattedDate =
date.toLocaleDateString(functions.config().dateformat);

  // ...
});

หลัง: รุ่นที่ 2

const {onRequest} = require("firebase-functions/v2/https");
const {defineString} = require("firebase-functions/params");

const dateFormat = defineString("DATE_FORMAT");

exports.date = onRequest((req, res) => {
  const date = new Date();
  const formattedDate = date.toLocaleDateString(dateFormat.value());

  // ...
});

ตั้งค่าพารามิเตอร์

ครั้งแรกที่คุณทำให้ใช้งานได้ Firebase CLI จะแสดงค่าทั้งหมดของพารามิเตอร์ แล้วบันทึกค่าลงในไฟล์ dotenv หากต้องการส่งออกค่าfunctions.config ให้เรียกใช้ firebase functions:config:export

นอกจากนี้ คุณยังระบุประเภทและกฎการตรวจสอบของพารามิเตอร์เพื่อความปลอดภัยเพิ่มเติมได้

กรณีพิเศษ: คีย์ API

โมดูล params ผสานรวมกับ Cloud Secret Manager ซึ่งต้องมีการควบคุมการเข้าถึงแบบละเอียดสำหรับค่าที่มีความละเอียดอ่อน เช่น คีย์ API ดูพารามิเตอร์ลับสำหรับข้อมูลเพิ่มเติม

ก่อน: รุ่นที่ 1

const functions = require("firebase-functions");

exports.getQuote = functions.https.onRequest(async (req, res) => {
  const quote = await fetchMotivationalQuote(functions.config().apiKey);
  // ...
});

หลัง: รุ่นที่ 2

const {onRequest} = require("firebase-functions/v2/https");
const {defineSecret} = require("firebase-functions/params");

// Define the secret parameter
const apiKey = defineSecret("API_KEY");

exports.getQuote = onRequest(
  // make the secret available to this function
  { secrets: [apiKey] },
  async (req, res) => {
    // retrieve the value of the secret
    const quote = await fetchMotivationalQuote(apiKey.value());
    // ...
  }
);

ตั้งค่าตัวเลือกรันไทม์

มีการเปลี่ยนแปลงการกำหนดค่าตัวเลือกรันไทม์ระหว่างรุ่นที่ 1 และ 2 นอกจากนี้ รุ่นที่ 2 ยังเพิ่มความสามารถใหม่เพื่อตั้งค่าตัวเลือกสำหรับฟังก์ชันทั้งหมดอีกด้วย

ก่อน: รุ่นที่ 1

const functions = require("firebase-functions");

exports.date = functions
  .runWith({
    // Keep 5 instances warm for this latency-critical function
    minInstances: 5,
  })
  // locate function closest to users
  .region("asia-northeast1")
  .https.onRequest((req, res) => {
    // ...
  });

exports.uppercase = functions
  // locate function closest to users and database
  .region("asia-northeast1")
  .firestore.document("my-collection/{docId}")
  .onCreate((change, context) => {
    // ...
  });

หลัง: รุ่นที่ 2

const {onRequest} = require("firebase-functions/v2/https");
const {onDocumentCreated} = require("firebase-functions/v2/firestore");
const {setGlobalOptions} = require("firebase-functions/v2");

// locate all functions closest to users
setGlobalOptions({ region: "asia-northeast1" });

exports.date = onRequest({
    // Keep 5 instances warm for this latency-critical function
    minInstances: 5,
  }, (req, res) => {
  // ...
});

exports.uppercase = onDocumentCreated("my-collection/{docId}", (event) => {
  /* ... */
});

ใช้การเกิดขึ้นพร้อมกัน

ข้อได้เปรียบที่สำคัญของฟังก์ชันรุ่นที่ 2 คือความสามารถของอินสแตนซ์ฟังก์ชันเดียวในการแสดงคำขอมากกว่า 1 รายการพร้อมกัน วิธีนี้สามารถลดจำนวน Cold Start ที่ผู้ใช้ปลายทางพบได้อย่างมาก โดยค่าเริ่มต้น การเกิดขึ้นพร้อมกันจะตั้งไว้ที่ 80 แต่คุณสามารถตั้งค่าให้เกิดขึ้นได้ตั้งแต่ 1 ถึง 1000 ดังนี้

const {onRequest} = require("firebase-functions/v2/https");

exports.date = onRequest({
    // set concurrency value
    concurrency: 500
  },
  (req, res) => {
    // ...
});

การปรับการเกิดขึ้นพร้อมกันจะช่วยปรับปรุงประสิทธิภาพและลดต้นทุนของฟังก์ชันได้ ดูข้อมูลเพิ่มเติมเกี่ยวกับการเกิดขึ้นพร้อมกันในหัวข้ออนุญาตคำขอหลายรายการพร้อมกัน

ตรวจสอบการใช้งานตัวแปรร่วม

ฟังก์ชันรุ่นที่ 1 ที่เขียนโดยไม่คํานึงถึงการเกิดขึ้นพร้อมกันอาจใช้ตัวแปรร่วมที่ตั้งค่าไว้และอ่านในคำขอแต่ละรายการ เมื่อเปิดใช้การเกิดขึ้นพร้อมกันและอินสแตนซ์เดียวเริ่มจัดการคำขอหลายรายการพร้อมกัน อาจทำให้เกิดข้อบกพร่องในฟังก์ชันเนื่องจากคำขอที่ดำเนินการพร้อมกันจะเริ่มตั้งค่าและอ่านตัวแปรร่วมพร้อมกัน

ขณะอัปเกรด คุณจะตั้งค่า CPU ของฟังก์ชันเป็น gcf_gen1 และตั้ง concurrency เป็น 1 เพื่อคืนค่าลักษณะการทำงานของรุ่นที่ 1 ได้ ดังนี้

const {onRequest} = require("firebase-functions/v2/https");

exports.date = onRequest({
    // TEMPORARY FIX: remove concurrency
    cpu: "gcf_gen1",
    concurrency: 1
  },
  (req, res) => {
    // ...
});

แต่เราไม่แนะนําให้วิธีนี้เป็นการแก้ไขระยะยาว เนื่องจากจะทำให้ไม่ได้เปรียบด้านประสิทธิภาพของฟังก์ชันรุ่นที่ 2 ให้ตรวจสอบการใช้งานตัวแปรร่วมในฟังก์ชันแทน และนำการตั้งค่าชั่วคราวเหล่านี้ออกเมื่อพร้อม

ย้ายข้อมูลการเข้าชมไปยังฟังก์ชันรุ่นที่ 2 ใหม่

เช่นเดียวกับเมื่อเปลี่ยนแปลงภูมิภาคหรือประเภททริกเกอร์ คุณจะต้องตั้งชื่อใหม่ให้ฟังก์ชันรุ่นที่ 2 แล้วย้ายการเข้าชมไปยังฟังก์ชันดังกล่าวช้าๆ

อัปเกรดฟังก์ชันจากรุ่นที่ 1 เป็นรุ่นที่ 2 ที่มีชื่อเดียวกันและเรียกใช้ firebase deploy ไม่ได้ การดำเนินการนี้จะทำให้เกิดข้อผิดพลาด:

Upgrading from GCFv1 to GCFv2 is not yet supported. Please delete your old function or wait for this feature to be ready.

ก่อนที่จะทำตามขั้นตอนเหล่านี้ ก่อนอื่นให้ตรวจสอบว่าฟังก์ชันเป็นแบบ idempotent เนื่องจากทั้งเวอร์ชันใหม่และเวอร์ชันเก่าของฟังก์ชันจะทำงานพร้อมกันในระหว่างการเปลี่ยนแปลง เช่น หากคุณมีฟังก์ชันรุ่นที่ 1 ที่ตอบสนองต่อการเขียนเหตุการณ์ใน Firestore ตรวจสอบว่าการตอบกลับการเขียน 2 ครั้งคือ 1 ครั้งโดยฟังก์ชันรุ่นที่ 1 และอีกครั้งในฟังก์ชันรุ่นที่ 2 เพื่อตอบสนองต่อเหตุการณ์เหล่านั้นทำให้แอปของคุณอยู่ในสถานะที่สอดคล้องกัน

  1. เปลี่ยนชื่อฟังก์ชันในโค้ดฟังก์ชัน เช่น เปลี่ยนชื่อ resizeImage เป็น resizeImageSecondGen
  2. ทำให้ฟังก์ชันนี้ใช้งานได้เพื่อให้ทั้งฟังก์ชันรุ่นที่ 1 เดิมและฟังก์ชันรุ่นที่ 2 ทํางานอยู่
    1. ในกรณีของทริกเกอร์ที่เรียกใช้ได้ คิวงาน และ HTTP ให้เริ่มชี้ไคลเอ็นต์ทั้งหมดไปยังฟังก์ชันรุ่นที่ 2 โดยการอัปเดตโค้ดไคลเอ็นต์ด้วยชื่อหรือ URL ของฟังก์ชันรุ่นที่ 2
    2. เมื่อใช้ทริกเกอร์ในเบื้องหลัง ทั้งฟังก์ชันรุ่นที่ 1 และรุ่นที่ 2 จะตอบสนองต่อทุกเหตุการณ์ทันทีที่ติดตั้งใช้งาน
  3. เมื่อย้ายข้อมูลการเข้าชมทั้งหมดปิดแล้ว ให้ลบฟังก์ชันรุ่นที่ 1 โดยใช้คำสั่ง firebase functions:delete ของ Firebase CLI
    1. (ไม่บังคับ) เปลี่ยนชื่อฟังก์ชันรุ่นที่ 2 ให้ตรงกับชื่อของฟังก์ชันรุ่นที่ 1