ฉันจะทดสอบและดีบักเครื่องมือที่กำหนดเองก่อนที่จะเพิ่มลงในพื้นที่ทำงานของฉันได้อย่างไร

-

การตั้งค่าสภาพแวดล้อมการพัฒนา

ก่อนที่จะทดสอบเครื่องมือที่กำหนดเองของคุณตรวจสอบให้แน่ใจว่าสภาพแวดล้อมการพัฒนาของคุณได้รับการกำหนดค่าอย่างเหมาะสม ซึ่งหมายถึงการติดตั้ง IDE ที่ถูกต้อง, debuggers, SDKs และเครื่องมือปรับใช้ที่ติดตั้ง

ตัวอย่างเช่นหากคุณกำลังพัฒนา Add-on ของ Google Workspace เครื่องมือเช่นสคริปต์แอพสคริปต์ IDE, Node.js, Python Environment และ Ngrok สำหรับการขุดอุโมงค์มีประโยชน์ Visual Studio Code เป็น IDE ที่แนะนำอย่างกว้างขวางสำหรับคุณสมบัติการดีบักที่หลากหลายในขณะที่ Visual Studio เป็นสิ่งจำเป็นสำหรับการดีบักเครื่องมือที่กำหนดเองบางอย่างเช่นเทมเพลตข้อความ T4 หรือ SingleGileGenerators

การตั้งค่าสภาพแวดล้อมของคุณรวมถึง:
- การติดตั้ง Runtimes และ Libraries ที่ต้องการ (node.js, Python, .NET ฯลฯ )
- การกำหนดค่า IDE ของคุณสำหรับการดีบัก (launch.json ในรหัส VS หรือ likn.vs.json ใน Visual Studio)
- เข้าถึง API หรือบริการใด ๆ เครื่องมือของคุณโต้ตอบด้วย
- รับสิทธิ์ที่จำเป็นสำหรับการทดสอบเครื่องมือที่ไม่ได้เผยแพร่หรือนักพัฒนาในสภาพแวดล้อมของคุณ

สำหรับการทดสอบการทำงานร่วมกันให้แน่ใจว่าการจัดการการเข้าถึงที่เหมาะสมเช่นการแบ่งปันโครงการและให้สิทธิ์การเข้าถึงบรรณาธิการ

-

การทดสอบในท้องถิ่นของเครื่องมือที่ไม่ได้เผยแพร่

ก่อนที่จะเผยแพร่ให้ทดสอบเครื่องมือที่กำหนดเองของคุณในสภาพแวดล้อมท้องถิ่นหรือการพัฒนาที่ควบคุม ตัวอย่างเช่น Google Workspace Add-On สามารถติดตั้งเป็นเวอร์ชันที่ไม่ได้เผยแพร่เพื่อทดสอบโดยตรงภายในแอปพลิเคชันโฮสต์ที่รองรับ (Gmail, เอกสาร, แผ่น)

ขั้นตอนในการทดสอบในพื้นที่รวมถึง:
1. ในตัวแก้ไขสคริปต์แอพใช้คุณสมบัติการปรับใช้> การทดสอบการปรับใช้เพื่อติดตั้ง add-on ที่ไม่ได้เผยแพร่
2. รีเฟรชแอปพลิเคชันโฮสต์เพื่อให้แน่ใจว่าส่วนเสริมจะปรากฏขึ้น
3. อนุญาตส่วนเสริมหากได้รับแจ้ง
4. ออกกำลังกายคุณสมบัติของเครื่องมือเพื่อตรวจสอบพฤติกรรม

สำหรับเครื่องมือที่กำหนดเอง Visual Studio หรือเครื่องกำเนิดรหัสการทดสอบมักหมายถึงการเรียกใช้เครื่องมือที่กำหนดเองด้วยตนเองหรือตั้งค่าโครงการเครื่องมือเป็นโครงการเริ่มต้นเพื่อแก้ไขข้อบกพร่องโดยตรงใน IDE

-

เทคนิคการดีบักใน IDES

การดีบักเป็นสิ่งสำคัญในการระบุและแก้ไขปัญหาระหว่างการพัฒนาเครื่องมือ IDE ที่ทันสมัยส่วนใหญ่สนับสนุนจุดพักการตรวจสอบตัวแปรการโทรสแต็คและการจัดการข้อยกเว้น

Visual Studio

สำหรับเครื่องมือที่กำหนดเองที่พัฒนาขึ้นใน Visual Studio (เช่น SingleFileGenerators หรือ T4 Templates):
- แนบดีบักเกอร์กับอินสแตนซ์ที่กำลังทำงานอยู่ของ Visual Studio (เครื่องมือ> แนบไปยังกระบวนการ> devenv.exe)
- หรือตั้งค่า Visual Studio เป็นโครงการเริ่มต้นสำหรับเครื่องมือของคุณ
- ใช้จุดพักภายในตรรกะการสร้างรหัสเพื่อติดตามการดำเนินการ
- เปิดการกำหนดค่าการสร้างหรือการดีบักที่กำหนดเองโดยใช้ Launch.vs.json เพื่อควบคุมเซสชันการดีบัก
- ใช้ Windows Debugger โดยละเอียดเช่น Watch, Locals และ Call Stack เพื่อตรวจสอบสถานะรันไทม์

สำหรับเทมเพลตข้อความ T4 ให้สร้างโซลูชันใหม่และเริ่มการดีบักเพื่อดูขั้นตอนการแปลงและข้อผิดพลาดที่อาจเกิดขึ้นระหว่างการประมวลผลแม่แบบ

รหัสสตูดิโอ Visual

VS CODE รองรับการสร้างการกำหนดค่าการดีบักผ่านไฟล์ launch.json:
- สร้างการกำหนดค่าเริ่มต้นสำหรับ node.js, python หรือภาษาอื่น ๆ
- เพิ่มการกำหนดค่าที่กำหนดเองสำหรับการเปิดตัวหรือแนบการดีบัก
- ใช้เบรกพอยต์นาฬิกาตัวแปรและคอนโซลดีบั๊กแบบโต้ตอบ
- ใช้ส่วนขยายสำหรับการปรับปรุงการดีบักเฉพาะภาษา
- ด้วยการรวม AI เช่น GitHub Copilot คุณสามารถสร้างการกำหนดค่าการกำหนดค่าได้เร็วขึ้น

-

การดีบักสภาพแวดล้อมระยะไกลและท้องถิ่น

สำหรับเครื่องมือที่ปรับใช้บนเซิร์ฟเวอร์หรือสภาพแวดล้อมระยะไกลการดีบักอาจต้องใช้:
- การตั้งค่า Tunnels SSH เพื่อส่งต่อพอร์ตการดีบักจากเครื่องรีโมตไปยัง IDE ท้องถิ่น
- การใช้การกำหนดค่าการดีบักระยะไกลเพื่อแนบดีบักเกอร์ IDE เข้ากับกระบวนการระยะไกล
- ใช้เครื่องมือเช่น NGROK เพื่อสร้างอุโมงค์ที่ปลอดภัยไปยังจุดสิ้นสุดของ LocalHost สำหรับการทดสอบแบบเรียลไทม์

ตัวอย่าง: การดีบักของ Google Workspace Add-On ที่ดำเนินการตามคำขอ HTTP สามารถทำได้จากระยะไกลโดยเปิดใช้งานพอร์ตดีบั๊ก, การตั้งค่าอุโมงค์ SSH และแนบดีบักเกอร์ IDE ท้องถิ่นจากนั้นโต้ตอบกับ Add-on ราวกับว่าเป็นท้องถิ่น

-

การทดสอบอัตโนมัติและการรวมอย่างต่อเนื่อง

เพื่อปรับปรุงความน่าเชื่อถือให้รวมการทดสอบอัตโนมัติสำหรับเครื่องมือที่กำหนดเองของคุณ:
- การเขียนหน่วยและการทดสอบการรวมสำหรับตรรกะหลัก
- ใช้ระบบการรวมอย่างต่อเนื่อง (CI) เพื่อเรียกใช้การทดสอบของคุณโดยอัตโนมัติ
- ใช้คุณสมบัติการทดสอบหน่วยสด (เช่นการทดสอบหน่วยการใช้งาน Live Studio ของ Visual Studio) เพื่อดูผลการทดสอบตามรหัสของคุณ
- ตรวจสอบการจัดการข้อผิดพลาดกรณีขอบและคอขวดประสิทธิภาพ

-

ทำงานร่วมกันสำหรับการทดสอบ

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

-

ความท้าทายและการแก้ปัญหาการดีบักทั่วไป

- ปัญหาการอนุญาต: เครื่องมือเช่น Google Workspace Add-ons ต้องการขอบเขตและการอนุญาต OAuth; การอนุญาตที่ขาดหายไปหรือไม่ถูกต้องทำให้เกิดความล้มเหลว
- ความแตกต่างของสภาพแวดล้อม: พฤติกรรมในพื้นที่เมื่อเทียบกับสภาพแวดล้อมที่ปรับใช้อาจแตกต่างกันไป ใช้การบันทึกและการกำหนดค่าที่สอดคล้องกัน
- ข้อผิดพลาดในการดำเนินการเครื่องมือ: การดีบักโดยการแนบกับกระบวนการโฮสต์หรือใช้การบันทึก verbose
- ไม่ได้รับความเสียหาย: ตรวจสอบให้แน่ใจว่ามีการโหลดสัญลักษณ์การดีบักและมีการแนบกระบวนการที่ถูกต้อง
- ปัญหาด้านประสิทธิภาพ: ใช้เครื่องมือการทำโปรไฟล์ที่รวมอยู่ใน IDE เพื่อระบุคอขวด

-

สรุป

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

ตัวอย่างเช่นใน Google Workspace:
- ใช้แอพสคริปต์ IDE สำหรับการปรับใช้และทดสอบส่วนเสริมที่ไม่ได้เผยแพร่
- จ้าง Ngrok และ SSH สำหรับการดีบัก add-ons http ระยะไกล
- ใช้รหัส Visual Studio หรือเครื่องมือการดีบักของ Visual Studio สำหรับจุดพักและการตรวจสอบรหัส

สำหรับเครื่องมือที่กำหนดเอง Visual Studio:
- แนบดีบักเกอร์เข้ากับกระบวนการ Visual Studio
- ใช้ไฟล์การกำหนดค่าเปิดใช้งานและงานสร้าง/ดีบักที่กำหนดเอง
- เทมเพลต Debug T4 โดยการสร้างใหม่ภายในเซสชั่นการดีบัก

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

-