1.4.6

Bug when detecting earnable points from more promotions

.gitignore

@@ -5,4 +5,5 @@ package-lock.json
 accounts.json
 notes
 accounts.dev.json
-accounts.main.json
+accounts.main.json
+.DS_Store

Dockerfile

@@ -12,6 +12,7 @@ RUN apt-get update && apt-get install -y jq
 COPY . .
 
 # Check if "headless" is set to "true" in the config.json file
+# DELETE BELOW IF YOU WANT TO RUN THE DOCKER SCRIPT HEADFULL!
 RUN HEADLESS=$(cat src/config.json | jq -r .headless) \
     && if [ "$HEADLESS" != "true" ]; then \
     echo "Error: 'headless' in src/config.json is not true."; \

README.md

@@ -12,16 +12,38 @@ Under development, however mainly for personal use!
 6. Run `npm run start` to start the built script
 
 ## Notes ##
-- If you end the script without closing the browser window first (only with headless as false), you'll be left with hanging chrome instances using resources. Use taskmanager to kill these or use the included `npm run chrome-kill-win` script. (Windows)
+- If you end the script without closing the browser window first (only with headless as false), you'll be left with hanging chrome instances using resources. Use taskmanager to kill these or use the included `npm run kill-chrome-win` script. (Windows)
 - If you automate this script, set it to run at least 2 times a day to make sure it picked up all tasks, set `"runOnZeroPoints": false` so it doesn't run when no points are found.
-- Docker container has to be recreated for any changes regardings the `config.json` and/or `accounts.json`.
+
+## Docker (Experimental) ##
+1. Download the source code
+2. Make changes to your `accounts.json`
+3. Make sure to change `"headless": false` to `"headless": true` in your `config.json` 
+4. Note, the container has to be recreated for any changes regarding the `config.json` and/or `accounts.json`!
+### Option 1: build and run with docker run
+
+1. Run `docker build -t microsoft-rewards-script-docker .` to build the container
+2. Run the container with `docker run --name netsky -d microsoft-rewards-script-docker` or, omit the detached flag `-d` to view the script output in your terminal. 
+3. Optionally, change the name of the container by changing `--name netsky` to your preferred container name
+4. The container will exit after completing the script, run it again using `docker start netsky`
+5. If you are running the container `-d` detached, you can view logs with `docker logs netsky`
+
+### Option 2: use docker compose
+
+1. A basic docker compose.yaml has been provided, which can be run with `docker compose up -d` or, omit the detached flag `-d` to view the script output in your terminal. 
+
+2. The container will exit after completing the script, run it again using `docker start netsky`
+
+3. If you are running the container `-d` detached, you can view logs with `docker logs netsky`
+
+   
 
 ## Config ## 
 | Setting        | Description           | Default  |
 | :------------- |:-------------| :-----|
 |  baseURL    | MS Rewards page | `https://rewards.bing.com` |
-|  sessionPath    | Path to where you want sessions/fingerprints to be stored | `sessions` (In src/browser/sessions) |
-|  headless    | If the browser window should be visable be ran in the background | `false` (Browser is visable) |
+|  sessionPath    | Path to where you want sessions/fingerprints to be stored | `sessions` (In ./browser/sessions) |
+|  headless    | If the browser window should be visible be ran in the background | `false` (Browser is visible) |
 |  runOnZeroPoints    | Run the rest of the script if 0 points can be earned | `false` (Will not run on 0 points) |
 |  clusters    | Amount of instances ran on launch, 1 per account | `1` (Will run 1 account at the time) |
 |  saveFingerprint    | Re-use the same fingerprint each time | `false` (Will generate a new fingerprint each time) |
@@ -30,6 +52,7 @@ Under development, however mainly for personal use!
 |  workers.doPunchCards    | Complete punchcards | `true`  |
 |  workers.doDesktopSearch    | Complete daily desktop searches | `true`  |
 |  workers.doMobileSearch    | Complete daily mobile searches | `true`  |
+|  globalTimeout    | The length before the action gets timeout | 30 seconds (30.000 miliseconds)   |
 |  searchSettings.useGeoLocaleQueries    | Generate search queries based on your geo-location | `false` (Uses EN-US generated queries)  |
 |  scrollRandomResults    | Scroll randomly in search results | `true`   |
 |  searchSettings.clickRandomResults    | Visit random website from search result| `true`   |

compose.yaml

@@ -0,0 +1,8 @@
+services:
+  microsoft-rewards-script:
+    build: .
+    container_name: netsky
+    environment:
+      - NODE_ENV=production
+    volumes:
+      - .:/usr/src/microsoft-rewards-script

package.json

@@ -1,6 +1,6 @@
 {
   "name": "microsoft-rewards-script",
-  "version": "1.4.1",
+  "version": "1.4.6",
   "description": "Automatically do tasks for Microsoft Rewards but in TS!",
   "main": "index.js",
   "engines": {
@@ -12,7 +12,7 @@
     "ts-start": "ts-node ./src/index.ts",
     "dev": "ts-node ./src/index.ts -dev",
     "kill-chrome-win": "powershell -Command \"Get-Process | Where-Object { $_.MainModule.FileVersionInfo.FileDescription -eq 'Google Chrome for Testing' } | ForEach-Object { Stop-Process -Id $_.Id -Force }\"",
-    "create-docker" : "docker build -t microsoft-rewards-script-docker ."
+    "create-docker": "docker build -t microsoft-rewards-script-docker ."
   },
   "keywords": [
     "Bing Rewards",
@@ -26,17 +26,17 @@
   "author": "Netsky",
   "license": "ISC",
   "devDependencies": {
-    "@typescript-eslint/eslint-plugin": "^6.7.0",
-    "eslint": "^8.54.0",
+    "@typescript-eslint/eslint-plugin": "^6.20.0",
+    "eslint": "^8.56.0",
     "eslint-plugin-modules-newline": "^0.0.6",
     "typescript": "^5.3.3"
   },
   "dependencies": {
-    "axios": "^1.6.2",
+    "axios": "^1.6.7",
     "cheerio": "^1.0.0-rc.12",
-    "fingerprint-generator": "^2.1.46",
-    "fingerprint-injector": "^2.1.46",
-    "playwright": "^1.40.1",
+    "fingerprint-generator": "^2.1.49",
+    "fingerprint-injector": "^2.1.49",
+    "playwright": "^1.42.0",
     "ts-node": "^10.9.2"
   }
 }

src/browser/Browser.ts

@@ -43,6 +43,9 @@ class Browser {
 
         const context = await newInjectedContext(browser, { fingerprint: fingerpint })
 
+        // Set timeout to preferred amount
+        context.setDefaultTimeout(this.bot.config?.globalTimeout ?? 30_000)
+
         await context.addCookies(sessionData.cookies)
 
         if (this.bot.config.saveFingerprint) {

src/browser/BrowserFunc.ts

@@ -95,13 +95,13 @@ export default class BrowserFunc {
             const scripts = Array.from(document.querySelectorAll('script'))
             const targetScript = scripts.find(script => script.innerText.includes('var dashboard'))
 
-            if (targetScript) {
-                return targetScript.innerText
-            } else {
-                throw this.bot.log('GET-DASHBOARD-DATA', 'Script containing dashboard data not found', 'error')
-            }
+            return targetScript?.innerText ? targetScript.innerText : null
         })
 
+        if (!scriptContent) {
+            throw this.bot.log('GET-DASHBOARD-DATA', 'Dashboard data not found within script', 'error')
+        }
+
         // Extract the dashboard object from the script content
         const dashboardData = await this.bot.homePage.evaluate(scriptContent => {
             // Extract the dashboard object using regex
@@ -110,11 +110,13 @@ export default class BrowserFunc {
 
             if (match && match[1]) {
                 return JSON.parse(match[1])
-            } else {
-                throw this.bot.log('GET-DASHBOARD-DATA', 'Dashboard data not found within script', 'error')
             }
         }, scriptContent)
 
+        if (!dashboardData) {
+            throw this.bot.log('GET-DASHBOARD-DATA', 'Unable to parse dashboard script', 'error')
+        }
+
         return dashboardData
     }
 
@@ -140,7 +142,9 @@ export default class BrowserFunc {
             let totalEarnablePoints = 0
 
             // Desktop Search Points
-            data.userStatus.counters.pcSearch.forEach(x => totalEarnablePoints += (x.pointProgressMax - x.pointProgress))
+            if (data.userStatus.counters.pcSearch?.length) {
+                data.userStatus.counters.pcSearch.forEach(x => totalEarnablePoints += (x.pointProgressMax - x.pointProgress))
+            }
 
             // Mobile Search Points
             if (data.userStatus.counters.mobileSearch?.length) {
@@ -151,12 +155,14 @@ export default class BrowserFunc {
             data.dailySetPromotions[this.bot.utils.getFormattedDate()]?.forEach(x => totalEarnablePoints += (x.pointProgressMax - x.pointProgress))
 
             // More Promotions
-            data.morePromotions.forEach(x => {
-                // Only count points from supported activities
-                if (['quiz', 'urlreward'].includes(x.activityType)) {
-                    totalEarnablePoints += (x.pointProgressMax - x.pointProgress)
-                }
-            })
+            if (data.morePromotions?.length) {
+                data.morePromotions.forEach(x => {
+                    // Only count points from supported activities
+                    if (['quiz', 'urlreward'].includes(x.promotionType)) {
+                        totalEarnablePoints += (x.pointProgressMax - x.pointProgress)
+                    }
+                })
+            }
 
             return totalEarnablePoints
         } catch (error) {

src/browser/BrowserUtil.ts

@@ -12,6 +12,7 @@ export default class BrowserUtil {
 
     async tryDismissAllMessages(page: Page): Promise<boolean> {
         const buttons = [
+            { selector: '#acceptButton', label: 'AcceptButton' },
             { selector: '#iLandingViewAction', label: 'iLandingViewAction' },
             { selector: '#iShowSkip', label: 'iShowSkip' },
             { selector: '#iNext', label: 'iNext' },

src/config.json

@@ -12,6 +12,7 @@
         "doDesktopSearch": true,
         "doMobileSearch": true
     },
+    "globalTimeout": 30000,
     "searchSettings": {
         "useGeoLocaleQueries": false,
         "scrollRandomResults": true,
@@ -26,4 +27,4 @@
         "enabled": false,
         "url": ""
     }
-}
+}

src/functions/Login.ts

@@ -2,6 +2,7 @@ import { Page } from 'playwright'
 import readline from 'readline'
 
 import { MicrosoftRewardsBot } from '../index'
+import { saveSessionData } from '../util/Load'
 
 const rl = readline.createInterface({
     input: process.stdin,
@@ -26,14 +27,12 @@ export class Login {
 
             if (!isLoggedIn) {
                 // Check if account is locked
-                const isLocked = await page.waitForSelector('.serviceAbusePageContainer', { state: 'visible', timeout: 10_000 }).then(() => true).catch(() => false)
+                const isLocked = await page.waitForSelector('.serviceAbusePageContainer', { state: 'visible', timeout: 1000 }).then(() => true).catch(() => false)
                 if (isLocked) {
                     this.bot.log('LOGIN', 'This account has been locked!', 'error')
                     throw new Error('Account has been locked!')
                 }
 
-                await page.waitForSelector('#loginHeader', { state: 'visible', timeout: 10_000 })
-
                 await this.execLogin(page, email, password)
                 this.bot.log('LOGIN', 'Logged into Microsoft successfully')
             } else {
@@ -43,6 +42,9 @@ export class Login {
             // Check if logged in to bing
             await this.checkBingLogin(page)
 
+            // Save session
+            await saveSessionData(this.bot.config.sessionPath, page.context(), email, this.bot.isMobile)
+
             // We're done logging in
             this.bot.log('LOGIN', 'Logged in successfully')
 
@@ -53,35 +55,41 @@ export class Login {
     }
 
     private async execLogin(page: Page, email: string, password: string) {
-        await page.type('#i0116', email)
-        await page.click('#idSIButton9')
-
-        this.bot.log('LOGIN', 'Email entered successfully')
-
         try {
-            await page.waitForSelector('#i0118', { state: 'visible', timeout: 2000 })
-            await this.bot.utils.wait(2000)
-
-            await page.type('#i0118', password)
+            // Enter email
+            await page.fill('#i0116', email)
             await page.click('#idSIButton9')
 
-            // When erroring at this stage it means a 2FA code is required
-        } catch (error) {
-            this.bot.log('LOGIN', '2FA code required')
+            this.bot.log('LOGIN', 'Email entered successfully')
 
-            // Wait for user input
-            const code = await new Promise<string>((resolve) => {
-                rl.question('Enter 2FA code:\n', (input) => {
-                    rl.close()
-                    resolve(input)
+            try {
+                // Enter password
+                await page.waitForSelector('#i0118', { state: 'visible', timeout: 2000 })
+                await this.bot.utils.wait(2000)
+
+                await page.fill('#i0118', password)
+                await page.click('#idSIButton9')
+
+                // When erroring at this stage it means a 2FA code is required
+            } catch (error) {
+                this.bot.log('LOGIN', '2FA code required')
+
+                // Wait for user input
+                const code = await new Promise<string>((resolve) => {
+                    rl.question('Enter 2FA code:\n', (input) => {
+                        rl.close()
+                        resolve(input)
+                    })
                 })
-            })
 
-            await page.type('input[name="otc"]', code)
-            await page.keyboard.press('Enter')
+                await page.fill('input[name="otc"]', code)
+                await page.keyboard.press('Enter')
+            }
 
-        } finally {
             this.bot.log('LOGIN', 'Password entered successfully')
+
+        } catch (error) {
+            this.bot.log('LOGIN', 'An error occurred:' + error, 'error')
         }
 
         const currentURL = new URL(page.url())

src/functions/Workers.ts

@@ -38,7 +38,7 @@ export class Workers {
     // Punch Card
     async doPunchCard(page: Page, data: DashboardData) {
 
-        const punchCardsUncompleted = data.punchCards?.filter(x => !x.parentPromotion.complete) ?? [] // Only return uncompleted punch cards
+        const punchCardsUncompleted = data.punchCards?.filter(x => !x.parentPromotion?.complete) ?? [] // Only return uncompleted punch cards
 
         if (!punchCardsUncompleted.length) {
             this.bot.log('PUNCH-CARD', 'All "Punch Cards" have already been completed')

src/functions/activities/Search.ts

@@ -1,5 +1,6 @@
 import { Page } from 'playwright'
 import axios from 'axios'
+import { platform } from 'os'
 
 import { Workers } from '../Workers'
 
@@ -128,17 +129,25 @@ export class Search extends Workers {
     }
 
     private async bingSearch(searchPage: Page, query: string) {
+        const platformControlKey = platform() === 'darwin' ? 'Meta' : 'Control'
+
         // Try a max of 5 times
         for (let i = 0; i < 5; i++) {
             try {
+
+                // Go to top of the page
+                await searchPage.evaluate(() => {
+                    window.scrollTo(0, 0)
+                })
+
                 const searchBar = '#sb_form_q'
-                await searchPage.waitForSelector(searchBar, { state: 'attached', timeout: 10_000 })
+                await searchPage.waitForSelector(searchBar, { state: 'visible', timeout: 10_000 })
                 await searchPage.click(searchBar) // Focus on the textarea
                 await this.bot.utils.wait(500)
-                await searchPage.keyboard.down('Control')
+                await searchPage.keyboard.down(platformControlKey)
                 await searchPage.keyboard.press('A')
                 await searchPage.keyboard.press('Backspace')
-                await searchPage.keyboard.up('Control')
+                await searchPage.keyboard.up(platformControlKey)
                 await searchPage.keyboard.type(query)
                 await searchPage.keyboard.press('Enter')
 
@@ -152,6 +161,7 @@ export class Search extends Workers {
                     await this.clickRandomLink(searchPage)
                 }
 
+                // Delay between searches
                 await this.bot.utils.wait(Math.floor(this.bot.utils.randomNumber(this.bot.config.searchSettings.searchDelay.min, this.bot.config.searchSettings.searchDelay.max)))
 
                 return await this.bot.browser.func.getSearchPoints()
@@ -248,10 +258,11 @@ export class Search extends Workers {
 
     private async randomScroll(page: Page) {
         try {
-            // Press the arrow down key to scroll
-            for (let i = 0; i < this.bot.utils.randomNumber(5, 600); i++) {
-                await page.keyboard.press('ArrowDown')
-            }
+            const scrollAmount = this.bot.utils.randomNumber(5, 5000)
+
+            await page.evaluate((scrollAmount) => {
+                window.scrollBy(0, scrollAmount)
+            }, scrollAmount)
 
         } catch (error) {
             this.bot.log('SEARCH-RANDOM-SCROLL', 'An error occurred:' + error, 'error')

src/index.ts

@@ -125,6 +125,8 @@ export class MicrosoftRewardsBot {
 
     // Desktop
     async Desktop(account: Account) {
+        this.isMobile = false
+
         const browser = await this.browserFactory.createBrowser(account.proxy, account.email)
         this.homePage = await browser.newPage()
 
@@ -176,11 +178,11 @@ export class MicrosoftRewardsBot {
         }
 
         // Save cookies
-        const cookies = await browser.cookies()
-        await saveSessionData(this.config.sessionPath, account.email, this.isMobile, cookies)
+        await saveSessionData(this.config.sessionPath, browser, account.email, this.isMobile)
 
         // Close desktop browser
-        return await this.closeBrowser(browser, account.email)
+        await this.closeBrowser(browser, account.email)
+        return
     }
 
     // Mobile
@@ -240,13 +242,13 @@ export class MicrosoftRewardsBot {
         log('MAIN-POINTS', `The script collected ${this.collectedPoints} points today`)
 
         // Close mobile browser
-        return await this.closeBrowser(browser, account.email)
+        await this.closeBrowser(browser, account.email)
+        return
     }
 
     private async closeBrowser(browser: BrowserContext, email: string) {
         // Save cookies
-        const cookies = await browser.cookies()
-        await saveSessionData(this.config.sessionPath, email, this.isMobile, cookies)
+        await saveSessionData(this.config.sessionPath, browser, email, this.isMobile)
 
         // Close browser
         await browser.close()

src/interface/Config.ts

@@ -5,6 +5,7 @@ export interface Config {
     runOnZeroPoints: boolean;
     clusters: number;
     workers: Workers;
+    globalTimeout: number;
     searchSettings: SearchSettings;
     webhook: Webhook;
     saveFingerprint: boolean;

src/util/Load.ts

@@ -1,4 +1,4 @@
-import { Cookie } from 'playwright'
+import { BrowserContext, Cookie } from 'playwright'
 import { BrowserFingerprintWithHeaders } from 'fingerprint-generator'
 import fs from 'fs'
 import path from 'path'
@@ -67,8 +67,10 @@ export async function loadSessionData(sessionPath: string, email: string, isMobi
     }
 }
 
-export async function saveSessionData(sessionPath: string, email: string, isMobile: boolean, cookies: Cookie[]): Promise<string> {
+export async function saveSessionData(sessionPath: string, browser: BrowserContext, email: string, isMobile: boolean): Promise<string> {
     try {
+        const cookies = await browser.cookies()
+
         // Fetch path
         const sessionDir = path.join(__dirname, '../browser/', sessionPath, email)