httprunner/hrp/pkg/uixt/popups.go

package uixt

import (
	"time"

	"github.com/pkg/errors"
	"github.com/rs/zerolog/log"

	"github.com/httprunner/httprunner/v4/hrp/internal/code"
)

// TODO: add more popup texts
var popups = [][]string{
	{".*青少年.*", "我知道了"}, // 青少年弹窗
	{".*个人信息保护.*", "同意"},
	{".*通讯录.*", "拒绝"},
	{".*更新.*", "以后再说|稍后|取消"},
	{".*升级.*", "以后再说|稍后|取消"},
	{".*定位.*", "仅.*允许"},
	{".*拍照.*", "仅.*允许"},
	{".*录音.*", "仅.*允许"},
	{".*位置.*", "仅.*允许"},
	{".*权限.*", "仅.*允许|始终允许"},
	{".*允许.*", "仅.*允许|始终允许"},
	{".*风险.*", "继续使用"},
	{"管理使用时间", ".*忽略.*"},
}

func findTextPopup(screenTexts OCRTexts) (closePoint *OCRText) {
	for _, popup := range popups {
		if len(popup) != 2 {
			continue
		}

		points, err := screenTexts.FindTexts([]string{popup[0], popup[1]}, WithRegex(true))
		if err == nil {
			log.Warn().Interface("popup", popup).
				Interface("texts", screenTexts).Msg("text popup found")
			closePoint = &points[1]
			break
		}
	}
	return
}

func (dExt *DriverExt) handleTextPopup(screenTexts OCRTexts) error {
	closePoint := findTextPopup(screenTexts)
	if closePoint == nil {
		// no popup found
		return nil
	}

	log.Info().Str("text", closePoint.Text).Msg("close popup")
	pointCenter := closePoint.Center()
	if err := dExt.TapAbsXY(pointCenter.X, pointCenter.Y); err != nil {
		log.Error().Err(err).Msg("tap popup failed")
		return errors.Wrap(code.MobileUIPopupError, err.Error())
	}
	// tap popup success
	return nil
}

func (dExt *DriverExt) AutoPopupHandler() error {
	// TODO: check popup by activity type

	// check popup by screenshot
	screenResult, err := dExt.GetScreenResult(
		WithScreenShotOCR(true), WithScreenShotUpload(true))
	if err != nil {
		return errors.Wrap(err, "get screen result failed for popup handler")
	}

	return dExt.handleTextPopup(screenResult.Texts)
}

const (
	CloseStatusFound   = "found"
	CloseStatusSuccess = "success"
	CloseStatusFail    = "fail"
)

// ClosePopupsResult represents the result of recognized popup to close
type ClosePopupsResult struct {
	Type      string `json:"type"`
	PopupArea Box    `json:"popupArea"`
	CloseArea Box    `json:"closeArea"`
	Text      string `json:"text"`
}

type PopupInfo struct {
	CloseStatus string   `json:"close_status"` // found/success/fail
	RetryCount  int      `json:"retry_count"`
	CloseBox    Box      `json:"close_box"`              // CV 识别的弹窗关闭按钮（弹窗存在 && 关闭按钮存在）
	ClosePoints []PointF `json:"close_points,omitempty"` // CV 识别的所有关闭按钮（仅关闭按钮，可能存在多个）
}

func (p *PopupInfo) isIdentical(lastPopup *PopupInfo) bool {
	if lastPopup == nil {
		return false
	}
	if lastPopup.CloseBox.IsEmpty() {
		return false
	}
	if !p.CloseBox.IsIdentical(lastPopup.CloseBox) {
		lastPopup.CloseStatus = CloseStatusSuccess
		return false
	}

	p.CloseStatus = CloseStatusFail
	lastPopup.CloseStatus = CloseStatusFail
	return true
}

func (dExt *DriverExt) ClosePopupsHandler(options ...ActionOption) error {
	actionOptions := NewActionOptions(options...)
	log.Info().Interface("actionOptions", actionOptions).Msg("try to find and close popups")
	maxRetryTimes := actionOptions.MaxRetryTimes
	interval := actionOptions.Interval

	var lastPopup *PopupInfo
	for retryCount := 0; retryCount < maxRetryTimes; retryCount++ {
		screenResult, err := dExt.GetScreenResult(
			WithScreenShotUpload(true),
			WithScreenShotClosePopups(true),
			WithScreenShotUITypes("close"), // get all close buttons
		)
		if err != nil {
			log.Error().Err(err).Msg("get screen result failed for popup handler")
			continue
		}

		popup := screenResult.Popup
		if popup == nil || popup.CloseBox.IsEmpty() {
			log.Debug().Interface("popup", popup).Msg("no popup found")
			break
		}
		popup.CloseStatus = CloseStatusFound
		popup.RetryCount = retryCount

		// check if the current popup equals to the last popup
		if popup.isIdentical(lastPopup) {
			return errors.Wrap(code.MobileUIPopupError, "handle popup failed")
		}

		if err = dExt.tapPopupHandler(popup); err != nil {
			return err
		}

		// sleep for another popup (if existed) to pop
		time.Sleep(time.Duration(1000*interval) * time.Millisecond)
		lastPopup = popup
	}
	return nil
}

func (dExt *DriverExt) tapPopupHandler(popup *PopupInfo) error {
	if popup == nil || popup.CloseBox.IsEmpty() {
		log.Debug().Interface("popup", popup).Msg("no popup found")
		return nil
	}
	popup.CloseStatus = CloseStatusFound

	popupClose := popup.CloseBox
	if popupClose.IsEmpty() {
		log.Error().
			Interface("popup", popup).
			Msg("popup close area not found")
		return errors.Wrap(code.MobileUIPopupError,
			"popup close area not found")
	}

	closePoint := popupClose.Center()
	log.Info().
		Interface("popup", popup).
		Interface("closePoint", closePoint).
		Msg("tap to close popup")
	if err := dExt.TapAbsXY(closePoint.X, closePoint.Y); err != nil {
		log.Error().Err(err).Msg("tap popup failed")
		return errors.Wrap(code.MobileUIPopupError, err.Error())
	}

	// tap popup success
	return nil
}