คุณทำให้ใช้งานได้ ลบ และแก้ไขฟังก์ชันโดยใช้คำสั่ง Firebase CLI หรือโดยตั้งค่าตัวเลือกรันไทม์ในซอร์สโค้ดของฟังก์ชัน
ทำให้ฟังก์ชันใช้งานได้
หากต้องการทำให้ฟังก์ชันใช้งานได้ ให้เรียกใช้คำสั่ง Firebase CLI ดังนี้
firebase deploy --only functions
โดยค่าเริ่มต้น Firebase CLI จะทำให้ฟังก์ชันทั้งหมดภายในต้นทางใช้งานได้พร้อมกัน หากโปรเจ็กต์มีฟังก์ชันมากกว่า 5 รายการ เราขอแนะนำให้คุณใช้แฟล็ก --only
ที่มีชื่อฟังก์ชันที่เจาะจงเพื่อติดตั้งใช้งานเฉพาะฟังก์ชันที่คุณได้แก้ไขไว้ การทำให้ฟังก์ชันเฉพาะใช้งานได้จะช่วยให้กระบวนการติดตั้งใช้งานเร็วขึ้นและช่วยหลีกเลี่ยงไม่ให้ใช้โควต้าการทำให้ใช้งานได้ เช่น
firebase deploy --only functions:addMessage,functions:makeUppercase
เมื่อทำให้ฟังก์ชันจำนวนมากใช้งานได้ คุณอาจได้รับข้อความแสดงข้อผิดพลาด HTTP 429 หรือ 500 เกินโควต้ามาตรฐาน หากต้องการแก้ปัญหานี้ โปรดทำให้ฟังก์ชันใช้งานได้ในกลุ่มไม่เกิน 10 รายการ
ดูข้อมูลอ้างอิงของ Firebase CLI สำหรับรายการคำสั่งที่ใช้ได้ทั้งหมด
โดยค่าเริ่มต้น Firebase CLI จะดูซอร์สโค้ดในโฟลเดอร์ functions/
หรือจะจัดระเบียบฟังก์ชันในโค้ดเบสหรือไฟล์หลายๆ ชุดก็ได้
ลบฟังก์ชัน
คุณลบฟังก์ชันที่ใช้งานก่อนหน้านี้ได้ด้วยวิธีต่อไปนี้
- อย่างชัดแจ้งใน Firebase CLI ด้วย
functions:delete
- อย่างชัดเจนในคอนโซล Google Cloud
- โดยปริยาย โดยนำฟังก์ชันออกจากซอร์สก่อนทำให้ใช้งานได้
การดำเนินการลบทั้งหมดจะแจ้งให้คุณยืนยันก่อนนำฟังก์ชันออกจากเวอร์ชันที่ใช้งานจริง
การลบฟังก์ชันที่ชัดเจนใน Firebase CLI รองรับอาร์กิวเมนต์หลายตัวและกลุ่มฟังก์ชัน และช่วยให้คุณระบุฟังก์ชันที่ทำงานอยู่ในภูมิภาคใดภูมิภาคหนึ่งได้ นอกจากนี้ คุณยังลบล้างข้อความแจ้งให้ยืนยันได้ด้วย
# 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
เมื่อใช้การลบฟังก์ชันโดยนัย firebase deploy
จะแยกวิเคราะห์ฟังก์ชันต้นทางและนำฟังก์ชันที่นำออกจากไฟล์ออกจากเวอร์ชันที่ใช้งานจริง
แก้ไขชื่อ ภูมิภาค หรือทริกเกอร์ของฟังก์ชัน
หากคุณกำลังเปลี่ยนชื่อหรือเปลี่ยนภูมิภาคหรือทริกเกอร์สำหรับฟังก์ชันที่จัดการการรับส่งข้อมูลเวอร์ชันที่ใช้งานจริง โปรดทำตามขั้นตอนในส่วนนี้เพื่อไม่ให้เหตุการณ์สูญหายระหว่างการแก้ไข ก่อนทำตามขั้นตอนเหล่านี้ ให้ตรวจสอบก่อนว่าฟังก์ชันนั้นเป็น idempotent เนื่องจากทั้งเวอร์ชันใหม่และเวอร์ชันเก่าจะทำงานพร้อมกันระหว่างการเปลี่ยนแปลง
เปลี่ยนชื่อฟังก์ชัน
หากต้องการเปลี่ยนชื่อฟังก์ชัน ให้สร้างเวอร์ชันที่มีการเปลี่ยนชื่อใหม่ของฟังก์ชันในต้นทาง แล้วเรียกใช้คำสั่งการติดตั้งใช้งาน 2 คำสั่งแยกกัน คำสั่งแรกทำให้ฟังก์ชันที่มีชื่อใหม่ใช้งานได้ และคำสั่งที่ 2 จะนำเวอร์ชันที่ใช้งานก่อนหน้านี้ออก ตัวอย่างเช่น หากคุณมีฟังก์ชัน Node.js ที่ชื่อ webhook
ที่ต้องการเปลี่ยนเป็น webhookNew
ให้แก้ไขโค้ดดังนี้
// 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");
});
จากนั้นเรียกใช้คำสั่งต่อไปนี้เพื่อทำให้ฟังก์ชันใหม่ใช้งานได้:
# 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
เปลี่ยนภูมิภาคหรือภูมิภาคของฟังก์ชัน
หากเปลี่ยนภูมิภาคที่ระบุของฟังก์ชันที่จัดการการรับส่งข้อมูลที่ใช้งานจริง คุณจะป้องกันการสูญเสียเหตุการณ์ได้โดยทำตามขั้นตอนต่อไปนี้ตามลำดับ
- เปลี่ยนชื่อฟังก์ชัน แล้วเปลี่ยนภูมิภาคหรือภูมิภาคตามต้องการ
- ทำให้ฟังก์ชันที่เปลี่ยนชื่อใช้งานได้ ซึ่งจะส่งผลให้การเรียกใช้โค้ดเดียวกันชั่วคราวในภูมิภาคทั้ง 2 ชุด
- ลบฟังก์ชันก่อนหน้า
ตัวอย่างเช่น หากคุณมีฟังก์ชันที่ชื่อว่า webhook
ซึ่งขณะนี้อยู่ในภูมิภาคฟังก์ชันเริ่มต้นของ us-central1
และต้องการย้ายข้อมูลไปยัง asia-northeast1
คุณจะต้องแก้ไขซอร์สโค้ดก่อนเพื่อเปลี่ยนชื่อฟังก์ชันและแก้ไขภูมิภาค
// 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");
});
จากนั้นทำให้ใช้งานได้โดยการเรียกใช้:
firebase deploy --only functions:webhookAsia
ตอนนี้มีฟังก์ชันที่เหมือนกัน 2 รายการทำงานอยู่ คือ webhook
กำลังทำงานใน us-central1
และ webhookAsia
กำลังทำงานใน asia-northeast1
จากนั้นลบ webhook
firebase functions:delete webhook
ตอนนี้มีเพียงฟังก์ชันเดียว คือ webhookAsia
ซึ่งกำลังทำงานใน asia-northeast1
เปลี่ยนประเภททริกเกอร์ของฟังก์ชัน
ในขณะที่พัฒนา Cloud Functions สำหรับการทำให้ Firebase ใช้งานได้เมื่อเวลาผ่านไป คุณอาจต้องเปลี่ยนประเภททริกเกอร์ของฟังก์ชันด้วยเหตุผลหลายประการ เช่น คุณอาจต้องการเปลี่ยนจากเหตุการณ์ฐานข้อมูลเรียลไทม์หรือ Cloud Firestore ของ Firebase ประเภทหนึ่งไปเป็นอีกประเภทหนึ่ง
คุณเปลี่ยนประเภทเหตุการณ์ของฟังก์ชันโดยการเปลี่ยนซอร์สโค้ดและเรียกใช้ firebase deploy
ไม่ได้ เพื่อหลีกเลี่ยงข้อผิดพลาด ให้เปลี่ยนประเภททริกเกอร์ของฟังก์ชันโดยทำตามขั้นตอนต่อไปนี้
- แก้ไขซอร์สโค้ดให้รวมฟังก์ชันใหม่ที่มีประเภททริกเกอร์ที่ต้องการ
- ทำให้ฟังก์ชันใช้งานได้ ซึ่งจะส่งผลให้มีการเรียกใช้ทั้งฟังก์ชันเก่าและใหม่ชั่วคราว
- ลบฟังก์ชันเก่าออกจากเวอร์ชันที่ใช้งานจริงอย่างชัดเจนโดยใช้ Firebase CLI
ตัวอย่างเช่น หากคุณมีฟังก์ชัน Node.js ที่ชื่อ objectChanged
ซึ่งมีประเภทเหตุการณ์ onChange
เดิม และต้องการเปลี่ยนเป็น onFinalize
ขั้นแรกให้เปลี่ยนชื่อฟังก์ชันและแก้ไขให้มีประเภทเหตุการณ์ onFinalize
// 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);
});
จากนั้นเรียกใช้คำสั่งต่อไปนี้เพื่อสร้างฟังก์ชันใหม่ก่อนที่จะลบฟังก์ชันเก่า
# 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
ตั้งค่าตัวเลือกรันไทม์
Cloud Functions for Firebase ช่วยให้คุณเลือกตัวเลือกรันไทม์ได้ เช่น เวอร์ชันรันไทม์ของ Node.js และระยะหมดเวลาต่อฟังก์ชัน การจัดสรรหน่วยความจำ และอินสแตนซ์ฟังก์ชันขั้นต่ำ/สูงสุด
แนวทางปฏิบัติแนะนำคือให้ตั้งค่าตัวเลือกเหล่านี้ (ยกเว้นเวอร์ชัน Node.js) ในออบเจ็กต์การกำหนดค่าภายในโค้ดฟังก์ชัน ออบเจ็กต์ RuntimeOptions
นี้เป็นแหล่งข้อมูลที่ถูกต้องสำหรับตัวเลือกรันไทม์ของฟังก์ชัน และจะลบล้างตัวเลือกที่ตั้งค่าไว้ผ่านเมธอดอื่น (เช่น ผ่านคอนโซล Google Cloud หรือ gcloud CLI)
หากเวิร์กโฟลว์การพัฒนามีการตั้งค่าตัวเลือกรันไทม์ด้วยตนเองผ่านคอนโซล Google Cloud หรือ gcloud CLI และคุณไม่ต้องการให้ลบล้างค่าเหล่านี้ในการทำให้ใช้งานได้แต่ละครั้ง ให้ตั้งค่าตัวเลือก preserveExternalChanges
เป็น true
เมื่อใช้ตัวเลือกนี้เป็น true
Firebase จะผสานรวมตัวเลือกรันไทม์ที่ตั้งค่าไว้ในโค้ดกับการตั้งค่าของฟังก์ชันเวอร์ชันที่ทำให้ใช้งานได้อยู่แล้วซึ่งมีลำดับความสำคัญดังต่อไปนี้
- มีการตั้งค่าตัวเลือกในโค้ดฟังก์ชัน: ลบล้างการเปลี่ยนแปลงภายนอก
- ตัวเลือกได้รับการตั้งค่าเป็น
RESET_VALUE
ในโค้ดฟังก์ชัน: ลบล้างการเปลี่ยนแปลงภายนอกด้วยค่าเริ่มต้น - ไม่ได้ตั้งค่าตัวเลือกในโค้ดฟังก์ชัน แต่มีการตั้งค่าไว้ในฟังก์ชันที่ทำให้ใช้งานได้ในปัจจุบัน: ใช้ตัวเลือกที่ระบุไว้ในฟังก์ชันที่ทำให้ใช้งานได้
ไม่แนะนำให้ใช้ตัวเลือก preserveExternalChanges: true
กับสถานการณ์ส่วนใหญ่เนื่องจากโค้ดจะไม่ใช่แหล่งที่มาที่ถูกต้องทั้งหมดของตัวเลือกรันไทม์สำหรับฟังก์ชันอีกต่อไป หากมีการใช้งาน ให้ตรวจสอบ Google Cloud Console หรือใช้ gcloud CLI เพื่อดูการกำหนดค่าทั้งหมดของฟังก์ชัน
ตั้งค่าเวอร์ชัน Node.js
Firebase SDK สำหรับ Cloud Functions อนุญาตให้เลือกรันไทม์ของ Node.js ได้ คุณสามารถเลือกเรียกใช้ฟังก์ชันทั้งหมดในโปรเจ็กต์เฉพาะบนสภาพแวดล้อมรันไทม์ที่สอดคล้องกับเวอร์ชัน Node.js ที่รองรับเวอร์ชันใดเวอร์ชันหนึ่งต่อไปนี้
- Node.js 20 (ตัวอย่าง)
- Node.js 18
- Node.js 16
- Node.js 14
วิธีตั้งค่าเวอร์ชัน Node.js
โดยคุณสามารถตั้งค่าเวอร์ชันได้ในช่อง engines
ในไฟล์ package.json
ที่สร้างขึ้นในไดเรกทอรี functions/
ระหว่างการเริ่มต้น
เช่น หากต้องการใช้เฉพาะเวอร์ชัน 18 ให้แก้ไขบรรทัดนี้ใน package.json
"engines": {"node": "18"}
หากใช้ตัวจัดการแพ็กเกจ Yarn หรือมีข้อกำหนดเฉพาะอื่นๆ สำหรับช่อง engines
คุณสามารถตั้งค่ารันไทม์สำหรับ Firebase SDK สำหรับ Cloud Functions ใน firebase.json
แทนได้
{
"functions": {
"runtime": "nodejs18" // or nodejs14, nodejs16 or nodejs20
}
}
CLI ใช้ค่าที่ตั้งไว้ใน firebase.json
โดยใช้ค่าหรือช่วงใดก็ตามที่คุณตั้งค่าไว้แยกต่างหากใน package.json
อัปเกรดรันไทม์ของ Node.js
วิธีอัปเกรดรันไทม์ของ Node.js
- ตรวจสอบว่าโปรเจ็กต์ใช้แพ็กเกจราคา Blaze
- ตรวจสอบว่าคุณใช้ Firebase CLI เวอร์ชัน 11.18.0 ขึ้นไป
- เปลี่ยนค่า
engines
ในไฟล์package.json
ที่สร้างขึ้นในไดเรกทอรีfunctions/
ระหว่างการเริ่มต้น ตัวอย่างเช่น หากคุณกำลังอัปเกรดจากเวอร์ชัน 16 เป็นเวอร์ชัน 18 รายการควรมีลักษณะดังนี้"engines": {"node": "18"}
- (ไม่บังคับ) ทดสอบการเปลี่ยนแปลงโดยใช้ชุดโปรแกรมจำลองภายในของ Firebase
- ทำให้ฟังก์ชันทั้งหมดใช้งานได้อีกครั้ง
ควบคุมลักษณะการทำงานของการปรับขนาด
โดยค่าเริ่มต้น Cloud Functions for Firebase จะปรับขนาดจำนวนอินสแตนซ์ที่ทำงานอยู่ตามจำนวนคำขอที่เข้ามา ซึ่งอาจลดขนาดลงจนเหลือ 0 อินสแตนซ์ในช่วงที่มีการรับส่งข้อมูลลดลง อย่างไรก็ตาม หากแอปกำหนดให้มีเวลาในการตอบสนองน้อยลงและต้องการจำกัดจำนวน Cold Start ก็เปลี่ยนลักษณะการทำงานเริ่มต้นนี้ได้โดยระบุจำนวนอินสแตนซ์คอนเทนเนอร์ขั้นต่ำเพื่อให้คำขออุ่นและพร้อมที่จะแสดง
ในทำนองเดียวกัน คุณตั้งค่าจำนวนสูงสุดเพื่อจำกัดการปรับขนาดของอินสแตนซ์เพื่อตอบสนองต่อคำขอที่เข้ามาใหม่ได้ ใช้การตั้งค่านี้เพื่อควบคุมค่าใช้จ่ายหรือจำกัดจำนวนการเชื่อมต่อกับบริการสำรองข้อมูล เช่น ฐานข้อมูล
ลดจำนวน Cold Start
หากต้องการตั้งค่าจำนวนอินสแตนซ์ขั้นต่ำสำหรับฟังก์ชันในซอร์สโค้ด ให้ใช้เมธอด runWith
เมธอดนี้ยอมรับออบเจ็กต์ JSON ที่สอดคล้องกับอินเทอร์เฟซ RuntimeOptions
ซึ่งกำหนดค่าสำหรับ minInstances
ตัวอย่างเช่น ฟังก์ชันนี้จะกำหนดอินสแตนซ์อย่างน้อย 5 อินสแตนซ์เพื่อทำให้อุปกรณ์อุ่นอยู่เสมอ ดังนี้
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
});
ต่อไปนี้เป็นสิ่งที่ควรพิจารณาเมื่อตั้งค่าสำหรับ minInstances
- หาก Cloud Functions for Firebase ปรับขนาดแอปให้สูงกว่าการตั้งค่า
minInstances
ระบบจะดำเนินการ Cold Start สำหรับแต่ละอินสแตนซ์ที่สูงกว่าเกณฑ์ดังกล่าว - Cold Start จะส่งผลกระทบรุนแรงที่สุดกับแอปที่มีการรับส่งข้อมูลในปริมาณสูง หากแอปมีการเข้าชมที่พุ่งสูงขึ้น และคุณตั้งค่า
minInstances
สูงพอที่ Cold Start จะลดลงเมื่อการเข้าชมแต่ละครั้งเพิ่มขึ้น คุณจะเห็นเวลาในการตอบสนองที่ลดลงอย่างมาก สำหรับแอปที่มีการเข้าชมคงที่ การเริ่มแอปแบบ Cold Start ไม่ได้ส่งผลต่อประสิทธิภาพมากนัก การตั้งค่าอินสแตนซ์ขั้นต่ำอาจเหมาะสมสำหรับสภาพแวดล้อมการใช้งานจริง แต่โดยปกติแล้วควรหลีกเลี่ยงในสภาพแวดล้อมการทดสอบ หากต้องการปรับขนาดเป็น 0 ในโปรเจ็กต์ทดสอบ แต่ยังคงลด Cold Start ในโปรเจ็กต์ที่ใช้งานจริง คุณสามารถตั้งค่า
minInstances
ตามตัวแปรสภาพแวดล้อม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 });
จำกัดจำนวนอินสแตนซ์สูงสุดสำหรับฟังก์ชัน
หากต้องการตั้งค่าจำนวนอินสแตนซ์สูงสุดในซอร์สโค้ดของฟังก์ชัน ให้ใช้เมธอด runWith
เมธอดนี้ยอมรับออบเจ็กต์ JSON ที่สอดคล้องกับอินเทอร์เฟซ RuntimeOptions
ซึ่งกำหนดค่าสำหรับ maxInstances
เช่น ฟังก์ชันนี้กำหนดขีดจำกัดอยู่ที่ 100 อินสแตนซ์เพื่อป้องกันไม่ให้ฐานข้อมูลเดิมสมมติมากเกินไป
exports.mirrorOrdersToLegacyDatabase = functions
.runWith({
// Legacy database only supports 100 simultaneous connections
maxInstances: 100,
})
.firestore.document("orders/{orderId}")
.onWrite((change, context) => {
// Connect to legacy database
});
หากปรับขนาดฟังก์ชัน HTTP เป็นขีดจำกัด maxInstances
คำขอใหม่จะอยู่ในคิว 30 วินาที จากนั้นจะถูกปฏิเสธด้วยโค้ดตอบกลับ 429 Too Many Requests
หากไม่มีอินสแตนซ์พร้อมใช้งานภายในเวลาดังกล่าว
ดูข้อมูลเพิ่มเติมเกี่ยวกับแนวทางปฏิบัติแนะนำสำหรับการใช้การตั้งค่าอินสแตนซ์สูงสุดได้ในแนวทางปฏิบัติแนะนำสำหรับการใช้ maxInstances
ตั้งค่าการหมดเวลาและการจัดสรรหน่วยความจำ
ในบางกรณี ฟังก์ชันอาจมีข้อกำหนดพิเศษสำหรับค่าระยะหมดเวลาที่นานหรือการจัดสรรหน่วยความจำในปริมาณมาก คุณสามารถตั้งค่าเหล่านี้ได้ในคอนโซล Google Cloud หรือในซอร์สโค้ดของฟังก์ชัน (Firebase เท่านั้น)
หากต้องการตั้งค่าการจัดสรรหน่วยความจำและระยะหมดเวลาในซอร์สโค้ดของฟังก์ชัน ให้ใช้พารามิเตอร์ runWith
ที่นำเสนอใน Firebase SDK สำหรับ Cloud Functions 2.0.0 ตัวเลือกรันไทม์นี้ยอมรับออบเจ็กต์ JSON ที่สอดคล้องกับอินเทอร์เฟซ RuntimeOptions
ซึ่งกำหนดค่าสำหรับ timeoutSeconds
และ memory
ตัวอย่างเช่น ฟังก์ชันพื้นที่เก็บข้อมูลนี้ใช้หน่วยความจำ 1 GB และหมดเวลาหลังจากผ่านไป 300 วินาที
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
});
ค่าสูงสุดสำหรับ timeoutSeconds
คือ 540
หรือ 9 นาที
จำนวนหน่วยความจำที่ให้แก่ฟังก์ชันจะสอดคล้องกับ CPU ที่จัดสรรสำหรับฟังก์ชัน โปรดดูรายละเอียดในรายการค่าที่ถูกต้องสำหรับ memory
ดังนี้
128MB
— 200MHz256MB
— 400MHz512MB
— 800MHz1GB
— 1.4 GHz2GB
- 2.4 GHz4GB
— 4.8 GHz8GB
— 4.8 GHz
วิธีตั้งค่าการจัดสรรหน่วยความจำและระยะหมดเวลาในคอนโซล Google Cloud
- ในคอนโซล Google Google Cloud ให้เลือก Cloud Functions จากเมนูด้านซ้าย
- เลือกฟังก์ชันโดยคลิกชื่อฟังก์ชันในรายการฟังก์ชัน
- คลิกไอคอนแก้ไขในเมนูด้านบน
- เลือกการจัดสรรหน่วยความจำจากเมนูแบบเลื่อนลงที่มีป้ายกำกับจัดสรรหน่วยความจำแล้ว
- คลิกเพิ่มเติมเพื่อแสดงตัวเลือกขั้นสูงและป้อนจำนวนวินาทีในช่องข้อความระยะหมดเวลา
- คลิกบันทึกเพื่ออัปเดตฟังก์ชัน