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

Ergün Erdogmus
Ergün Erdogmus
X
Jecelyn Yeen

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

แผงโปรแกรมบันทึกในเครื่องมือสำหรับนักพัฒนาเว็บของ Chrome ช่วยให้คุณบันทึกและเล่นซ้ำเส้นทางของผู้ใช้ ส่งออกเส้นทางไปยังรูปแบบต่างๆ (เช่น สคริปต์ทดสอบ) ผ่านส่วนขยายและไลบรารีของบุคคลที่สามต่างๆ ปรับแต่งเส้นทางของผู้ใช้ด้วยไลบรารี Puppeteer Replay และผสานรวมกับเวิร์กโฟลว์ที่มีอยู่

ในบล็อกโพสต์นี้ เราจะพูดถึงเรื่องต่อไปนี้

  • วิธีส่งออกและเล่นโฟลว์ผู้ใช้ซ้ำแบบเป็นโปรแกรม
  • วิธีปรับแต่งการไหลเวียนของผู้ใช้ด้วยความช่วยเหลือของ Puppeteer Replay
  • วิธีผสานรวมกับเวิร์กโฟลว์ CI/CD

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

ส่งออกขั้นตอนของผู้ใช้และเล่นซ้ำแบบเป็นโปรแกรม

โดยค่าเริ่มต้น โปรแกรมอัดเสียงจะให้คุณส่งออกไฟล์บันทึกเสียงเหล่านี้เป็นสคริปต์ Puppeteer หรือ Puppeteer Replay หรือเป็นไฟล์ JSON ธรรมดา

ตัวเลือกการส่งออก

เมื่อส่งออกโฟลว์ผู้ใช้เป็นไฟล์ JSON แล้ว คุณจะมีตัวเลือกในการนําเข้ากลับไปยังแผงโปรแกรมอัดเสียงและเล่นซ้ำ หรือใช้ไลบรารีภายนอกเพื่อเล่นซ้ำก็ได้ คลัง Puppeteer Replay เป็นหนึ่งในคลังที่ใช้ได้

เล่นซ้ำด้วยการเล่น Puppeteer Replay

ทําตามวิธีการในที่เก็บเพื่อติดตั้ง Puppeteer Replay

สมมติว่าคุณบันทึกโฟลว์ผู้ใช้ JSON ไว้ในโฟลเดอร์ recordings (เช่น โปรเจ็กต์สาธิต) คุณจะใช้คําสั่งต่อไปนี้เพื่อเรียกใช้โฟลว์ผู้ใช้ได้อย่างน้อย 1 รายการ 

# replay one user flow
npx @puppeteer/replay ./recordings/order-a-coffee.json

# replay all user flows under recordings folder
npx @puppeteer/replay ./recordings/*.json

คุณเพิ่มสคริปต์ npm เพื่อเรียกใช้ไฟล์บันทึกได้ (ไม่บังคับ) โดยเพิ่มบรรทัดนี้ลงในช่อง scripts ใน package.json

"replay-all": "replay recordings"

จากนั้นคุณจะเรียกใช้ npm run replay-all ในบรรทัดคำสั่งเพื่อเล่นไฟล์บันทึกเสียงทั้งหมดซ้ำได้

ฟีเจอร์นี้จะเล่นซ้ำเส้นทางของผู้ใช้โดยไม่มี UI โดยค่าเริ่มต้น (หรือที่เรียกว่าโหมดไม่มีส่วนหัว) หากต้องการดู UI ให้กำหนดตัวแปรสภาพแวดล้อม PUPPETEER_HEADLESS เป็น "เท็จ" ก่อนเรียกใช้คำสั่ง

PUPPETEER_HEADLESS=false npm run replay-all

เล่นซ้ำด้วยไลบรารีของบุคคลที่สาม

เรามีไลบรารีของบุคคลที่สามบางรายการที่คุณสามารถใช้เพื่อเล่นซ้ำได้นอกเหนือจากเบราว์เซอร์ Chrome รายการคลังทั้งหมดมีดังนี้

เช่น TestCafe เป็นเฟรมเวิร์กการทดสอบแบบครบวงจร รวมถึงรองรับการเล่นซ้ำของเส้นทางผู้ใช้ JSON ด้วย Safari และอื่นๆ

npm install -g testcafe

# replay with selected browsers
testcafe safari ./recordings/order-one-coffee.json
testcafe firefox ./recordings/order-one-coffee.json
testcafe chrome ./recordings/order-one-coffee.json

# replay with all browsers
testcafe all ./recordings/order-one-coffee.json

ในทางกลับกัน Sacelabs เป็นแพลตฟอร์มทดสอบในระบบคลาวด์ โดยรองรับการเล่นซ้ำของเส้นทางผู้ใช้ JSON ด้วยเบราว์เซอร์และเวอร์ชันต่างๆ ในระบบคลาวด์

ลองดูตัวอย่างไฟล์การกำหนดค่าใน Saucelabs โปรดไปที่ที่เก็บการสาธิต

apiVersion: v1alpha
kind: puppeteer-replay
suites:
  - name: "order a coffee"
    recordings: [ "recordings/order-a-coffee.json" ]
…

ส่งออกการไหลเวียนของผู้ใช้ด้วยส่วนขยายที่แตกต่างกัน

นอกจากตัวเลือกเริ่มต้นแล้ว คุณยังติดตั้งส่วนขยายเพื่อส่งออกการไหลเวียนของผู้ใช้ไปยังรูปแบบต่างๆ ได้ด้วย

ส่งออกเส้นทางของผู้ใช้ด้วยส่วนขยายต่างๆ

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

นอกจากนี้ หากคุณมีเครื่องมือทดสอบอยู่แล้ว ก็ยังมีส่วนขยายสำหรับส่งออกการไหลเวียนของผู้ใช้ไปยังสคริปต์ทดสอบต่างๆ เช่น Cypress, Nightwatch, WebdriverIO, Testing Library และอื่นๆ ดูรายการทั้งหมดได้ที่นี่ ซึ่งจะช่วยให้คุณและทีมเริ่มเขียนแบบทดสอบได้เร็วขึ้น

เปลี่ยนรูปแบบเป็นสคริปต์ทดสอบอื่นแบบเป็นโปรแกรม

นอกจากส่วนขยายแล้ว ผู้ให้บริการทดสอบส่วนใหญ่เหล่านี้ยังเผยแพร่ไลบรารีเพื่อช่วยคุณแปลงการไหลเวียนของผู้ใช้ JSON หลายรายการแบบเป็นโปรแกรมด้วย

ตัวอย่างเช่น ใช้ไลบรารี @cypress/chrome-recorder เพื่อส่งออกโฟลว์ของผู้ใช้ไปยังการทดสอบ Cypress

npm install -g @cypress/chrome-recorder
npx @cypress/chrome-recorder ./recordings/*.json

แสดงการไหลเวียนของผู้ใช้ซ้ำด้วยส่วนขยาย

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

ส่วนขยายการบันทึกซ้ำช่วยให้ส่วนขยายเพิ่มแผงลงในเครื่องมือสำหรับนักพัฒนาซอฟต์แวร์เพื่อกําหนดค่าการบันทึกซ้ำและแสดงผลลัพธ์การบันทึกซ้ำได้

ในการเริ่มต้นใช้งาน ให้ดูรายการส่วนขยายที่ใช้ได้ หรือดูวิธีสร้างส่วนขยายที่กําหนดเอง

สร้างส่วนขยายหรือไลบรารีของคุณเอง

เบื้องหลังคือส่วนขยายและไลบรารีทั้งหมดสร้างขึ้นจากไลบรารีการบันทึกซ้ำของ Puppeteer นอกเหนือจากการอนุญาตให้เล่นซ้ำเส้นทางของผู้ใช้แล้ว Puppeteer Replay ยังมี API ให้คุณปรับแต่งหรือเปลี่ยนรูปแบบการเล่นซ้ำเส้นทางของผู้ใช้

ปรับแต่งการเล่นการไหลเวียนของผู้ใช้ซ้ำ

มาสร้างปลั๊กอินสำหรับภาพหน้าจอกัน สําหรับกระบวนการของผู้ใช้แต่ละรายการ เราต้องการสิ่งต่อไปนี้

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

นี่คือข้อมูลโค้ด คุณสามารถดาวน์โหลดการสาธิตนี้และเล่นได้เช่นกัน

/* screenshot-plugin.mjs */

import { mkdirSync } from "fs";
import { PuppeteerRunnerExtension } from "@puppeteer/replay";

// create folder if not exist
let screenshotFolder = "_screenshots";
mkdirSync(screenshotFolder, { recursive: true });

export default class ScreenshotPlugin extends PuppeteerRunnerExtension {
  count = 0;

  async afterEachStep(step, flow) {
    await super.afterEachStep(step, flow);
    this.count = this.count + 1;

    const path = `${screenshotFolder}/${flow.title}-${this.count}.png`;
    await this.page.screenshot({ path });

    console.log(`Saved screenshot as ${path}`);
  }

  async afterAllSteps(step, flow) {
    await super.afterAllSteps(step, flow);
    console.log("Operation completed successfully.");
  }
}

โค้ดค่อนข้างสื่อความหมายอยู่แล้ว เราขยาย PuppeteerRunnerExtension API เพื่อบันทึกภาพหน้าจอหลังทำแต่ละขั้นตอน และบันทึกข้อความหลังจากทำตามขั้นตอนทั้งหมดแล้ว

บันทึกไฟล์ จากนั้นเราจะเรียกใช้การไหลเวียนของผู้ใช้ด้วยส่วนขยายนี้โดยใช้คําสั่งต่อไปนี้

# replay one user flow with plugin 
npx @puppeteer/replay --extension ./screenshot-plugin.mjs  ./recordings/order-a-coffee.json

# replay all user flows with plugin under recordings folder
npx @puppeteer/replay --extension ./screenshot-plugin.mjs ./recordings/*.json

เอาต์พุตมีดังนี้

Saved screenshot as _screenshots/order-a-coffee-1.png
Saved screenshot as _screenshots/order-a-coffee-2.png
Saved screenshot as _screenshots/order-a-coffee-3.png
…

Operation completed successfully.

เปลี่ยนโฟลว์ผู้ใช้

อีกวิธีในการปรับแต่งการไหลเวียนของผู้ใช้คือการแปลงเป็นรูปแบบต่างๆ (เช่น Cypress หรือสคริปต์ทดสอบ Nightwatch)

เช่น ขั้นตอนใน Funnel ของผู้ใช้มีขั้นตอนในการไปยัง URL ไฟล์ JSON มีลักษณะดังนี้

{
  "title": "order-a-coffee",
  "steps": [
    {
      "type": "navigate",
      "url": "https://coffee-cart.netlify.app/"
    },
    …
  ]
}

คุณสร้างปลั๊กอิน stringify เพื่อเปลี่ยนขั้นตอนเป็น JavaScript ได้ คุณยังสามารถดูไลบรารีอื่นๆ ที่มีอยู่เพื่อดูวิธีดำเนินการได้อีกด้วย

ตัวอย่างเช่น ข้อมูลโค้ดต่อไปนี้แสดงวิธีที่ WebdriverIO แปลงขั้นตอนการนําทาง


export class StringifyPlugin extends PuppeteerStringifyExtension {

  #appendStepType(out: LineWriter, step: Step, flow: UserFlow) {
        switch (step.type) {
        case 'navigate':
    return out.appendLine(`await browser.url(${formatAsJSLiteral(step.url)})`)
        …
  }

เมื่อเรียกใช้ปลั๊กอินผ่านการไหลเวียนของผู้ใช้ บรรทัดการนำทางจะแปลงเป็น await browser.url(‘https://coffee-cart.netlify.app/’)

ปรับแต่งประสบการณ์การเล่นซ้ำในเครื่องมือสำหรับนักพัฒนาเว็บ

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

ยกระดับประสบการณ์การเล่นซ้ำด้วยส่วนขยายเบราว์เซอร์

หากต้องการสร้างส่วนขยายการเล่นซ้ำของคุณเอง ให้ดูคู่มือในเอกสารประกอบของส่วนขยายการเล่นซ้ำ และดูคำแนะนำจากส่วนขยายตัวอย่าง

เผยแพร่ส่วนขยาย Chrome

เมื่อปรับแต่งและเปลี่ยนรูปแบบขั้นตอนของผู้ใช้แล้ว คุณจะจัดแพ็กเกจเป็นส่วนขยายของ Chrome และเผยแพร่ไปยัง Chrome เว็บสโตร์ ได้

ดูการสาธิตและวิธีการนี้เพื่อดูวิธีแก้ไขข้อบกพร่องในเครื่องและเผยแพร่ส่วนขยาย Chrome

ผสานรวมกับไปป์ไลน์ CI/CD

ซึ่งทำได้หลายวิธีและมีเครื่องมือมากมายที่พร้อมใช้งาน ต่อไปนี้คือตัวอย่างการทำให้กระบวนการนี้เป็นอัตโนมัติด้วย GitHub Actions 

# .github/node.js.yml

name: Replay recordings

on:
  push:
    branches: [ "main" ]
  schedule:
    - cron: '30 12 * * *' # daily 12:30pm

jobs:
  build:

    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v3
    - name: Use Node.js
      uses: actions/setup-node@v3
      with:
        node-version: 18.x
        cache: 'npm'
    - run: npm install puppeteer
    - run: npm run replay-all
    - run: npm run start

ในตัวอย่างนี้ เราจะแสดงการไหลเวียนของผู้ใช้ซ้ำในกรณีต่อไปนี้

  • พุชการเปลี่ยนแปลงใหม่ไปยัง Branch main
  • ทุกวัน เวลา 12:30 น.

นอกจาก GitHub Actions แล้ว คุณยังผสานรวมกับผู้ให้บริการระบบคลาวด์ที่ชื่นชอบได้ด้วย ไปที่การสาธิตนี้เพื่อดูวิธีการใช้ Google Cloud Run Job เพื่อดำเนินการโฟลว์ผู้ใช้พร้อมกันสูงสุด 10,000 รายการ

บทสรุป

ในบล็อกโพสต์นี้ เราได้พูดถึงตัวเลือกต่างๆ ในการส่งออกโฟลว์ผู้ใช้เป็นไฟล์ JSON, ปรับแต่งการเล่นซ้ำด้วย PuppeteerReplayExtension, เปลี่ยนรูปแบบโฟลว์ของผู้ใช้ด้วย PuppeteerStringifyExtension และผสานรวมตัวเลือกดังกล่าวไว้ในเวิร์กโฟลว์ CI

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

ดาวน์โหลดเวอร์ชันตัวอย่าง

ลองใช้ Chrome Canary, Dev หรือ เบต้า เป็นเบราว์เซอร์เริ่มต้นสำหรับการพัฒนา ช่องทางพรีวิวเหล่านี้จะช่วยให้คุณเข้าถึงฟีเจอร์ล่าสุดของเครื่องมือสำหรับนักพัฒนาเว็บ ทดสอบ API แพลตฟอร์มเว็บที่ล้ำสมัย และพบปัญหาในเว็บไซต์ก่อนผู้ใช้

ติดต่อทีม Chrome DevTools

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