Skip to content

Feat: handle 'Welcome Tour' dialog for new accounts #453

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Titaniumtown wants to merge 1 commit into from
Closed

Feat: handle 'Welcome Tour' dialog for new accounts #453

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions src/functions/Activities.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import { UrlReward } from './activities/api/UrlReward'
import { Quiz } from './activities/api/Quiz'
import { FindClippy } from './activities/api/FindClippy'
import { DoubleSearchPoints } from './activities/api/DoubleSearchPoints'
import { WelcomeTour } from './activities/api/WelcomeTour'

// Browser
import { SearchOnBing } from './activities/browser/SearchOnBing'
Expand Down Expand Up @@ -84,6 +85,11 @@ export default class Activities {
await doubleSearchPoints.doDoubleSearchPoints(promotion)
}

doWelcomeTour = async (promotion: BasePromotion, page: Page): Promise<void> => {
const welcomeTour = new WelcomeTour(this.bot)
await welcomeTour.doWelcomeTour(promotion, page)
}

// App Activities
doAppReward = async (promotion: Promotion): Promise<void> => {
const urlReward = new AppReward(this.bot)
Expand Down
14 changes: 14 additions & 0 deletions src/functions/Workers.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -253,6 +253,20 @@ export class Workers {
break
}

// Welcome Tour activity (Take the tour)
case 'welcometour': {
const basePromotion = activity as BasePromotion

this.bot.logger.info(
this.bot.isMobile,
'ACTIVITY',
`Found activity type "WelcomeTour" | title="${activity.title}" | offerId=${offerId}`
)

await this.bot.activities.doWelcomeTour(basePromotion, page)
break
}

// Unsupported types
default: {
this.bot.logger.warn(
Expand Down
213 changes: 213 additions & 0 deletions src/functions/activities/api/WelcomeTour.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,213 @@
import type { Page } from 'patchright'
import type { BasePromotion } from '../../../interface/DashboardData'
import { Workers } from '../../Workers'

export class WelcomeTour extends Workers {
public async doWelcomeTour(promotion: BasePromotion, page: Page): Promise<void> {
const offerId = promotion.offerId
const oldBalance = Number(this.bot.userData.currentPoints ?? 0)

this.bot.logger.info(
this.bot.isMobile,
'WELCOME-TOUR',
`Starting WelcomeTour | offerId=${offerId} | geo=${this.bot.userData.geoLocale} | oldBalance=${oldBalance}`
)

try {
const destinationUrl = promotion.destinationUrl
if (!destinationUrl) {
this.bot.logger.warn(
this.bot.isMobile,
'WELCOME-TOUR',
`No destination URL for WelcomeTour | offerId=${offerId}`
)
return
}

await page.goto(destinationUrl, { waitUntil: 'domcontentloaded', timeout: 30000 })
await this.bot.utils.wait(this.bot.utils.randomDelay(3000, 5000))

await this.bot.browser.utils.tryDismissAllMessages(page)

const tourStarted = await this.startTour(page, offerId)
if (!tourStarted) {
this.bot.logger.warn(this.bot.isMobile, 'WELCOME-TOUR', `Could not start tour | offerId=${offerId}`)
return
}

await this.navigateTour(page, offerId)

const newBalance = await this.bot.browser.func.getCurrentPoints()
const gainedPoints = newBalance - oldBalance

if (gainedPoints > 0) {
this.bot.userData.currentPoints = newBalance
this.bot.userData.gainedPoints = (this.bot.userData.gainedPoints ?? 0) + gainedPoints

this.bot.logger.info(
this.bot.isMobile,
'WELCOME-TOUR',
`Completed WelcomeTour | offerId=${offerId} | gainedPoints=${gainedPoints} | newBalance=${newBalance}`,
'green'
)
} else {
this.bot.logger.info(
this.bot.isMobile,
'WELCOME-TOUR',
`Completed WelcomeTour (no points) | offerId=${offerId} | oldBalance=${oldBalance} | newBalance=${newBalance}`
)
}
} catch (error) {
this.bot.logger.error(
this.bot.isMobile,
'WELCOME-TOUR',
`Error in doWelcomeTour | offerId=${promotion.offerId} | message=${error instanceof Error ? error.message : String(error)}`
)
} finally {
await page.goto(this.bot.config.baseURL, { timeout: 10000 }).catch(() => {})
await this.bot.utils.wait(this.bot.utils.randomDelay(2000, 3000))
}
}

private async startTour(page: Page, offerId: string): Promise<boolean> {
const startSelectors = [
'a:has-text("Start Earning Points")',
'a:has-text("Start earning points")',
'button:has-text("Start Earning Points")',
'a:has-text("Start earning")',
'[data-bi-id*="start"]',
'a.c-call-to-action:has-text("Start")'
]

for (const selector of startSelectors) {
try {
const element = await page.$(selector)
if (element && (await element.isVisible())) {
await element.click()
this.bot.logger.info(
this.bot.isMobile,
'WELCOME-TOUR',
`Started tour | selector=${selector} | offerId=${offerId}`
)
await this.bot.utils.wait(this.bot.utils.randomDelay(3000, 4000))
return true
}
} catch {
continue
}
}

this.bot.logger.debug(this.bot.isMobile, 'WELCOME-TOUR', `No start button found | offerId=${offerId}`)
return false
}

private async navigateTour(page: Page, offerId: string): Promise<void> {
const categoryNames = [
'Entertainment',
'Shopping',
'News',
'Gaming',
'Sports',
'Technology',
'Travel',
'Finance',
'Music',
'Movies',
'Food',
'Health'
]

const nextSelectors = [
'[aria-label*="next" i]',
'[aria-label*="forward" i]',
'button:has-text("Next")',
'a:has-text("Next")',
'button:has-text("Continue")',
'[data-bi-id*="next"]',
'.c-flipper[aria-label*="next" i]',
'.c-glyph.glyph-chevron-right'
]

let slidesClicked = 0
const maxSlides = 15

for (let i = 0; i < maxSlides; i++) {
await this.bot.utils.wait(this.bot.utils.randomDelay(1000, 1500))

const categoryClicked = await this.tryCategoryInModal(page, categoryNames, offerId)
if (categoryClicked) {
this.bot.logger.info(
this.bot.isMobile,
'WELCOME-TOUR',
`Category selected after ${slidesClicked} slides | offerId=${offerId}`
)
return
}

let clickedNext = false
for (const selector of nextSelectors) {
try {
const element = await page.$(selector)
if (element && (await element.isVisible())) {
await element.click()
slidesClicked++
clickedNext = true

this.bot.logger.info(
this.bot.isMobile,
'WELCOME-TOUR',
`Clicked Next | slide=${slidesClicked} | selector=${selector} | offerId=${offerId}`
)

await this.bot.utils.wait(this.bot.utils.randomDelay(1500, 2500))
break
}
} catch {
continue
}
}

if (!clickedNext) {
this.bot.logger.info(
this.bot.isMobile,
'WELCOME-TOUR',
`No more next buttons | totalSlides=${slidesClicked} | offerId=${offerId}`
)
break
}
}
}

private async tryCategoryInModal(page: Page, categoryNames: string[], offerId: string): Promise<boolean> {
for (const category of categoryNames) {
const modalSelectors = [
`[role="dialog"] button:has-text("${category}")`,
`[role="dialog"] [role="button"]:has-text("${category}")`,
`[role="dialog"] label:has-text("${category}")`,
`[role="dialog"] span:text-is("${category}")`,
`[class*="modal"] button:has-text("${category}")`,
`[class*="dialog"] button:has-text("${category}")`
]

for (const selector of modalSelectors) {
try {
const element = await page.$(selector)
if (element && (await element.isVisible())) {
await element.click()
this.bot.logger.info(
this.bot.isMobile,
'WELCOME-TOUR',
`Selected category "${category}" in modal | selector=${selector} | offerId=${offerId}`
)
await this.bot.utils.wait(this.bot.utils.randomDelay(2000, 3000))
return true
}
} catch {
continue
}
}
}

return false
}
}