ไฟล์ Manifest ของส่วนขยายคือรายการอินสแตนซ์ของส่วนขยายและการกำหนดค่า ไฟล์ Manifest ช่วยให้คุณทำสิ่งต่อไปนี้ได้
- แชร์การกำหนดค่าส่วนขยายกับผู้อื่น
- คัดลอกการกำหนดค่าส่วนขยายระหว่างโปรเจ็กต์ต่างๆ (เช่น จากโปรเจ็กต์ชั่วคราวไปยังโปรเจ็กต์ที่ใช้งานจริง)
- ทำให้ส่วนขยายทั้งหมดใช้งานได้พร้อมกัน
- ทดสอบว่าส่วนขยายทำงานร่วมกับแอปของคุณอย่างไรโดยใช้ Firebase Local Emulator Suite
- ยืนยันการกำหนดค่าส่วนขยายให้กับการควบคุมแหล่งที่มา
- รวมส่วนขยายไว้ในไปป์ไลน์ CI/CD
ไฟล์ Manifest ของส่วนขยายมี 2 ส่วน ดังนี้
ส่วน
extensions
ของfirebase.json
ซึ่งเป็นแมปรหัสอินสแตนซ์กับการอ้างอิงเวอร์ชันส่วนขยาย ตัวอย่างเช่น{ "extensions": { "my-bigquery-extension": "firebase/firestore-bigquery-export@^0.1.18", "my-image-resizer": "firebase/storage-resize-images@^0.1.22", } }
.env
ที่มีการกำหนดค่าสำหรับอินสแตนซ์ของส่วนขยายแต่ละรายการในไดเรกทอรีย่อยextensions/
ของไดเรกทอรีโปรเจ็กต์ Firebase เช่น อินสแตนซ์ของstorage-resize-images
อาจมีไฟล์.env
ดังตัวอย่างต่อไปนี้IMAGE_TYPE=jpeg LOCATION=us-central1 IMG_BUCKET=${param:PROJECT_ID}.appspot.com IMG_SIZES=100x100 DELETE_ORIGINAL_FILE=false
สร้างไฟล์ Manifest ของส่วนขยาย
การสร้างไฟล์ Manifest ของส่วนขยายทำได้ 3 วิธีดังนี้
- จัดการไฟล์ Manifest ของส่วนขยายด้วย Firebase CLI
- ส่งออกการกำหนดค่าส่วนขยายของโปรเจ็กต์
- แก้ไขไฟล์ Manifest ด้วยตนเอง
เราจะอธิบาย 2 วิธีแรกด้านล่าง
จัดการไฟล์ Manifest ของส่วนขยายด้วย Firebase CLI
คุณเรียกใช้คำสั่ง ext:
ของ Firebase CLI ส่วนใหญ่ได้ด้วยตัวเลือก --local
เพื่ออัปเดตไฟล์ Manifest ของส่วนขยายโดยไม่ต้องเปลี่ยนการกำหนดค่าปัจจุบันของโปรเจ็กต์
ตัวอย่างเช่น
firebase ext:install --local firebase/firestore-bigquery-export
การเรียกใช้คำสั่งข้างต้นจะแจ้งให้คุณกำหนดค่าส่วนขยาย firebase/firestore-bigquery-export
เวอร์ชันล่าสุด และบันทึกการกำหนดค่าลงในไฟล์ Manifest แต่จะไม่ทำให้การกำหนดค่าใช้งานได้กับโปรเจ็กต์
ตัวอย่างคำสั่งอื่นๆ ที่แก้ไขไฟล์ Manifest ของส่วนขยายมีดังนี้
# ext:configure changes the params for an extension instance in your extensions manifest
$ firebase ext:configure my-bigquery-extension --local
# ext:update --local updates an instance in your extensions manifest
# to the latest version of that extension
$ firebase ext:update my-bigquery-extension --local
# You can also specify a version if you don't want to update to the latest version
$ firebase ext:update my-bigquery-extension firebase/firestore-bigquery-export@0.1.10 --local
# ext:uninstall --local removes an instance from your extensions manifest
$ firebase ext:uninstall my-bigquery-extension --local
ส่งออกการกำหนดค่าส่วนขยายของโปรเจ็กต์
หากต้องการบันทึกการกำหนดค่าส่วนขยายปัจจุบันของโปรเจ็กต์ลงในไฟล์ Manifest ให้ทำตามขั้นตอนต่อไปนี้
- ตั้งค่า Firebase CLI หากยังไม่ได้ทำ
- จากพรอมต์ของ Shell ให้เปลี่ยนเป็นไดเรกทอรีโปรเจ็กต์ (ไดเรกทอรีโปรเจ็กต์มีไฟล์
firebase.json
) - เรียกใช้คำสั่ง
ext:export
ดังนี้firebase ext:export
คำสั่ง ext:export
จะเพิ่มส่วน extensions
ลงในไฟล์ firebase.json
นอกจากนี้ คำสั่ง ext:export
จะสร้างไดเรกทอรี extensions
ที่มีไฟล์ .env
สำหรับอินสแตนซ์ส่วนขยายแต่ละรายการที่คุณติดตั้ง ไฟล์เหล่านี้มีพารามิเตอร์การกำหนดค่าสำหรับแต่ละอินสแตนซ์
ทดสอบการกำหนดค่าส่วนขยายด้วยชุดโปรแกรมจำลองภายในของ Firebase
เมื่อเพิ่มอินสแตนซ์ของส่วนขยายบางรายการลงในไฟล์ Manifest ของส่วนขยายแล้ว คุณจะทดสอบอินสแตนซ์เหล่านั้นได้โดยใช้ชุดโปรแกรมจำลองภายใน
-
- หากต้องการเรียกใช้ชุดโปรแกรมจำลองแบบอินเทอร์แอกทีฟ ให้เรียกใช้คำสั่งต่อไปนี้
firebase emulators:start
- หากต้องการเรียกใช้ชุดโปรแกรมจำลองและเรียกใช้สคริปต์ทดสอบ ให้เรียกใช้คำสั่งต่อไปนี้
firebase emulators:exec my-test.sh
- หากต้องการเรียกใช้ชุดโปรแกรมจำลองแบบอินเทอร์แอกทีฟ ให้เรียกใช้คำสั่งต่อไปนี้
ตอนนี้ หากมีอินสแตนซ์ของส่วนขยายแสดงอยู่ในไฟล์ Manifest ชุดโปรแกรมจำลองภายในจะดาวน์โหลดซอร์สโค้ดของส่วนขยายเหล่านั้นไปยัง ~/.cache/firebase/extensions
เมื่อดาวน์โหลดแล้ว ชุดโปรแกรมจำลองภายในจะเริ่มทำงาน และคุณจะเรียกฟังก์ชันที่เรียกพื้นหลังของส่วนขยายให้แสดงขึ้น และเชื่อมต่อแอปกับชุดโปรแกรมจำลองเพื่อทดสอบการผสานรวมกับแอป
ทำให้การกำหนดค่าส่วนขยายใช้งานได้ในโปรเจ็กต์
เมื่อเพิ่มอินสแตนซ์ของส่วนขยายบางรายการลงในไฟล์ Manifest ของส่วนขยายแล้ว คุณจะทำให้ใช้งานได้กับโปรเจ็กต์ได้โดยใช้ Firebase CLI เมื่อติดตั้งใช้งานด้วยไฟล์ Manifest ของส่วนขยาย คุณจะติดตั้ง อัปเดต และกำหนดค่าอินสแตนซ์ของส่วนขยายทั้งหมดในไฟล์ Manifest ลงในโปรเจ็กต์พร้อมกัน
วิธีทำให้ไฟล์ Manifest ของส่วนขยายใช้งานได้
- จากพรอมต์ของ Shell ให้เปลี่ยนเป็นไดเรกทอรีที่มีการกำหนดค่าส่วนขยายที่บันทึกไว้ (นี่คือไดเรกทอรีที่มี
firebase.json
. หากเพิ่งเรียกใช้ext:export
แสดงว่าคุณอยู่ในไดเรกทอรีที่ถูกต้องแล้ว) - เรียกใช้คำสั่ง
deploy
หากต้องการทำให้ส่วนขยายใช้งานได้กับโปรเจ็กต์อื่นที่ไม่ใช่โปรเจ็กต์ปัจจุบัน ให้ระบุ--project=
ด้วยfirebase deploy --only extensions –-project=YOUR_PROJECT_ID
คำสั่ง deploy
จะตรวจสอบการกำหนดค่าอินสแตนซ์แต่ละรายการ ถามว่าคุณต้องการลบอินสแตนซ์ของส่วนขยายออกจากโปรเจ็กต์ปลายทางที่ไม่ได้ระบุไว้ใน firebase.json
หรือไม่ จากนั้นทำให้อินสแตนซ์ส่วนขยายทั้งหมดใช้งานได้
การกำหนดค่าส่วนขยายเฉพาะโปรเจ็กต์
การกำหนดค่าส่วนขยายที่บันทึกไว้สามารถนำไปใช้เพื่อทำให้ใช้งานได้กับหลายโปรเจ็กต์ เช่น โปรเจ็กต์ชั่วคราวและโปรเจ็กต์ที่ใช้งานจริง โดยค่าพารามิเตอร์บางค่าอาจจะแตกต่างกันสำหรับแต่ละโปรเจ็กต์
ไฟล์ .env
เฉพาะโปรเจ็กต์ช่วยดำเนินการต่อไปนี้ได้
- ใส่ค่าพารามิเตอร์ที่แตกต่างกันระหว่างโปรเจ็กต์ใน
extensions/EXTENSION_INSTANCE_ID.env.YOUR_PROJECT_ID
- ใส่ค่าพารามิเตอร์ที่ใช้ร่วมกันใน
extensions/EXTENSION_INSTANCE_ID.env
บางครั้งคุณอาจต้องใช้ค่าพารามิเตอร์ที่แตกต่างกันเมื่อจำลองส่วนขยาย เช่น คุณอาจต้องการระบุคีย์ API ทดสอบแทนคีย์เวอร์ชันที่ใช้งานจริง ใส่พารามิเตอร์เหล่านี้ในไฟล์ .local
- ใส่พารามิเตอร์ที่ไม่ใช่ข้อมูลลับที่ต้องการใช้ระหว่างการจำลองใน
extensions/EXTENSION_INSTANCE_ID.env.local
- ใส่ค่าพารามิเตอร์ลับใน
extensions/EXTENSION_INSTANCE_ID.secret.local