V2.1 (#375)

* feat: Implement edge version fetching with retry logic and caching * chore: Update version to 2.1.0 in package.json * fix: Update package version to 2.1.0 and enhance user agent metadata * feat: Enhance 2FA handling with improved TOTP input and submission logic * fix: Refactor getSystemComponents to improve mobile user agent string generation * feat: Add support for cron expressions for advanced scheduling * feat: Improve humanization feature with detailed logging for off-days configuration * feat: Add live log streaming via webhook and enhance logging configuration * fix: Remove unused @types/cron-parser dependency from devDependencies * feat: Add cron-parser dependency and enhance Axios error handling for proxy authentication * feat: Enhance dashboard data retrieval with retry logic and diagnostics capture * feat: Add ready-to-use sample configurations and update configuration settings for better customization * feat: Add buy mode detection and configuration methods for enhanced manual redemption * feat: Migrate configuration from JSON to JSONC format for improved readability and comments support feat: Implement centralized diagnostics capture for better error handling and reporting fix: Update documentation references from config.json to config.jsonc chore: Add .vscode to .gitignore for cleaner project structure refactor: Enhance humanization and diagnostics capture logic in BrowserUtil and Login classes * feat: Reintroduce ambiance declarations for the 'luxon' module to unlock TypeScript * feat: Update search delay settings for improved performance and reliability * feat: Update README and SECURITY documentation for clarity and improved data handling guidelines * Enhance README and SECURITY documentation for Microsoft Rewards Script V2 - Updated README.md to improve structure, add badges, and enhance clarity on features and setup instructions. - Expanded SECURITY.md to provide detailed data handling practices, security guidelines, and best practices for users. - Included sections on data flow, credential management, and responsible use of the automation tool. - Added a security checklist for users to ensure safe practices while using the script. * feat: Réorganiser et enrichir la documentation du README pour une meilleure clarté et accessibilité * feat: Updated and reorganized the README for better presentation and clarity * feat: Revised and simplified the README for better clarity and accessibility * Update README.md
2026-01-21 23:43:57 +00:00 · 2025-10-11 16:54:07 +02:00
parent 3e499be8a9
commit dc7e122bce
34 changed files with 1571 additions and 356 deletions
--- a/src/scheduler.ts
+++ b/src/scheduler.ts
@@ -1,4 +1,5 @@
 import { DateTime, IANAZone } from 'luxon'
+import cronParser from 'cron-parser'
 import { spawn } from 'child_process'
 import fs from 'fs'
 import path from 'path'
@@ -7,6 +8,9 @@ import { loadConfig } from './util/Load'
 import { log } from './util/Logger'
 import type { Config } from './interface/Config'

+type CronExpressionInfo = { expression: string; tz: string }
+type DateTimeInstance = ReturnType<typeof DateTime.fromJSDate>
+
 function resolveTimeParts(schedule: Config['schedule'] | undefined): { tz: string; hour: number; minute: number } {
  const tz = (schedule?.timeZone && IANAZone.isValidZone(schedule.timeZone)) ? schedule.timeZone : 'UTC'
  // Determine source string
@@ -47,6 +51,55 @@ function parseTargetToday(now: Date, schedule: Config['schedule'] | undefined) {
  return dtn.set({ hour, minute, second: 0, millisecond: 0 })
 }

+function normalizeCronExpressions(schedule: Config['schedule'] | undefined, fallbackTz: string): CronExpressionInfo[] {
+  if (!schedule) return []
+  const raw = schedule.cron
+  if (!raw) return []
+  const expressions = Array.isArray(raw) ? raw : [raw]
+  return expressions
+    .map(expr => (typeof expr === 'string' ? expr.trim() : ''))
+    .filter(expr => expr.length > 0)
+    .map(expr => ({ expression: expr, tz: (schedule.timeZone && IANAZone.isValidZone(schedule.timeZone)) ? schedule.timeZone : fallbackTz }))
+}
+
+function getNextCronOccurrence(after: DateTimeInstance, items: CronExpressionInfo[]): { next: DateTimeInstance; source: string } | null {
+  let soonest: { next: DateTimeInstance; source: string } | null = null
+  for (const item of items) {
+    try {
+      const iterator = cronParser.parseExpression(item.expression, {
+        currentDate: after.toJSDate(),
+        tz: item.tz
+      })
+      const nextDate = iterator.next().toDate()
+      const nextDt = DateTime.fromJSDate(nextDate, { zone: item.tz })
+      if (!soonest || nextDt < soonest.next) {
+        soonest = { next: nextDt, source: item.expression }
+      }
+    } catch (error) {
+      void log('main', 'SCHEDULER', `Invalid cron expression "${item.expression}": ${error instanceof Error ? error.message : String(error)}`, 'warn')
+    }
+  }
+  return soonest
+}
+
+function getNextDailyOccurrence(after: DateTimeInstance, schedule: Config['schedule'] | undefined): DateTimeInstance {
+  const todayTarget = parseTargetToday(after.toJSDate(), schedule)
+  const target = after >= todayTarget ? todayTarget.plus({ days: 1 }) : todayTarget
+  return target
+}
+
+function computeNextRun(after: DateTimeInstance, schedule: Config['schedule'] | undefined, cronItems: CronExpressionInfo[]): { next: DateTimeInstance; source: 'cron' | 'daily'; detail?: string } {
+  if (cronItems.length > 0) {
+    const cronNext = getNextCronOccurrence(after, cronItems)
+    if (cronNext) {
+      return { next: cronNext.next, source: 'cron', detail: cronNext.source }
+    }
+    void log('main', 'SCHEDULER', 'All cron expressions invalid; falling back to daily schedule', 'warn')
+  }
+
+  return { next: getNextDailyOccurrence(after, schedule), source: 'daily' }
+}
+
 async function runOnePass(): Promise<void> {
  const bot = new MicrosoftRewardsBot(false)
  await bot.initialize()
@@ -195,7 +248,8 @@ async function main() {
    }
    offDays = chosen.sort((a,b)=>a-b)
    offWeek = week
-    await log('main','SCHEDULER',`Selected random off-days this week (ISO): ${offDays.join(', ')}`,'warn')
+  const msg = offDays.length ? offDays.join(', ') : 'none'
+  await log('main','SCHEDULER',`Weekly humanization off-day sample (ISO weekday): ${msg} | adjust via config.humanization.randomOffDaysPerWeek`,'warn')
  }

  const chooseVacationRange = async (now: typeof DateTime.prototype) => {
@@ -226,6 +280,7 @@ async function main() {
  }

  const tz = (schedule.timeZone && IANAZone.isValidZone(schedule.timeZone)) ? schedule.timeZone : 'UTC'
+  const cronExpressions = normalizeCronExpressions(schedule, tz)
  // Default to false to avoid unexpected immediate runs
  const runImmediate = schedule.runImmediatelyOnStart === true
  let running = false
@@ -256,7 +311,7 @@ async function main() {
    if (isVacationToday) {
      await log('main','SCHEDULER',`Skipping immediate run: vacation day (${todayIso})`,'warn')
    } else if (offDays.includes(nowDT.weekday)) {
-      await log('main','SCHEDULER',`Skipping immediate run: off-day (weekday ${nowDT.weekday})`,'warn')
+  await log('main','SCHEDULER',`Skipping immediate run: humanization off-day (ISO weekday ${nowDT.weekday}). Set humanization.randomOffDaysPerWeek=0 to disable.`,'warn')
    } else {
      await runPasses(passes)
    }
@@ -264,38 +319,32 @@ async function main() {
  }

  for (;;) {
-    const now = new Date()
-  const targetToday = parseTargetToday(now, schedule)
-    let next = targetToday
-    const nowDT = DateTime.fromJSDate(now, { zone: targetToday.zone })
-
-    if (nowDT >= targetToday) {
-      next = targetToday.plus({ days: 1 })
-    }
-
+  const nowDT = DateTime.local().setZone(tz)
+  const nextInfo = computeNextRun(nowDT, schedule, cronExpressions)
+  const next = nextInfo.next
  let ms = Math.max(0, next.toMillis() - nowDT.toMillis())

    // Optional daily jitter to further randomize the exact start time each day
-    const dailyJitterMin = Number(process.env.SCHEDULER_DAILY_JITTER_MINUTES_MIN || process.env.SCHEDULER_DAILY_JITTER_MIN || 0)
-    const dailyJitterMax = Number(process.env.SCHEDULER_DAILY_JITTER_MINUTES_MAX || process.env.SCHEDULER_DAILY_JITTER_MAX || 0)
-    const djMin = isFinite(dailyJitterMin) ? dailyJitterMin : 0
-    const djMax = isFinite(dailyJitterMax) ? dailyJitterMax : 0
    let extraMs = 0
-    if (djMin > 0 || djMax > 0) {
-      const mn = Math.max(0, Math.min(djMin, djMax))
-      const mx = Math.max(0, Math.max(djMin, djMax))
-      const jitterSec = (mn === mx) ? mn * 60 : (mn * 60 + Math.floor(Math.random() * ((mx - mn) * 60)))
-      extraMs = jitterSec * 1000
-      ms += extraMs
+    if (cronExpressions.length === 0) {
+      const dailyJitterMin = Number(process.env.SCHEDULER_DAILY_JITTER_MINUTES_MIN || process.env.SCHEDULER_DAILY_JITTER_MIN || 0)
+      const dailyJitterMax = Number(process.env.SCHEDULER_DAILY_JITTER_MINUTES_MAX || process.env.SCHEDULER_DAILY_JITTER_MAX || 0)
+      const djMin = isFinite(dailyJitterMin) ? dailyJitterMin : 0
+      const djMax = isFinite(dailyJitterMax) ? dailyJitterMax : 0
+      if (djMin > 0 || djMax > 0) {
+        const mn = Math.max(0, Math.min(djMin, djMax))
+        const mx = Math.max(0, Math.max(djMin, djMax))
+        const jitterSec = (mn === mx) ? mn * 60 : (mn * 60 + Math.floor(Math.random() * ((mx - mn) * 60)))
+        extraMs = jitterSec * 1000
+        ms += extraMs
+      }
    }

    const human = next.toFormat('yyyy-LL-dd HH:mm ZZZZ')
    const totalSec = Math.round(ms / 1000)
-    if (extraMs > 0) {
-      await log('main', 'SCHEDULER', `Next run at ${human} plus daily jitter (+${Math.round(extraMs/60000)}m) → in ${totalSec}s`)
-    } else {
-      await log('main', 'SCHEDULER', `Next run at ${human} (in ${totalSec}s)`) 
-    }
+    const jitterMsg = extraMs > 0 ? ` plus daily jitter (+${Math.round(extraMs/60000)}m)` : ''
+    const sourceMsg = nextInfo.source === 'cron' ? ` [cron: ${nextInfo.detail}]` : ''
+    await log('main', 'SCHEDULER', `Next run at ${human}${jitterMsg}${sourceMsg} (in ${totalSec}s)`) 

    await new Promise((resolve) => setTimeout(resolve, ms))

@@ -310,7 +359,7 @@ async function main() {
      continue
    }
    if (offDays.includes(nowRun.weekday)) {
-      await log('main','SCHEDULER',`Skipping scheduled run: off-day (weekday ${nowRun.weekday})`,'warn')
+      await log('main','SCHEDULER',`Skipping scheduled run: humanization off-day (ISO weekday ${nowRun.weekday}). Set humanization.randomOffDaysPerWeek=0 to disable.`,'warn')
      continue
    }
    if (!running) {