ci: smoke tests using wwebjs

.cursorignore

@@ -0,0 +1 @@
+cypress.config.ts

.github/workflows/e2e.yml

@@ -190,7 +190,11 @@ jobs:
           echo Create cypress.config.ts from example
           cp cypress.config.ts.example cypress.config.ts
           yarn install
-          yarn run cypress run --config excludeSpecPattern=cypress/e2e/filesearch/Filesearch.spec.ts --record --key ${{ secrets.CYPRESS_DASHBOARD_KEY }}
+          yarn run cypress run \
+            --config '{"excludeSpecPattern":["cypress/e2e/filesearch/Filesearch.spec.ts","cypress/e2e/smoke.spec.ts"]}' \
+            --record \
+            --key ${{ secrets.CYPRESS_DASHBOARD_KEY }}
+
         env:
           SPLIT: 2
           SPLIT_INDEX: ${{ matrix.shard }}

.github/workflows/smoke.yml

@@ -0,0 +1,63 @@
+name: Whatsapp Web JS - Flow Smoke Test
+
+permissions:
+  contents: read
+
+on:
+  schedule:
+    - cron: '*/30 * * * *'
+  workflow_dispatch:
+    inputs:
+      environment:
+        description: 'Target environment'
+        required: true
+        default: 'production'
+        type: choice
+        options:
+          - production
+          - staging
+
+concurrency:
+  group: whatsapp-smoke-${{ github.event.inputs.environment || 'production' }}
+  cancel-in-progress: false
+
+jobs:
+  wwebjs-smoke:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '22'
+
+      - name: Install Chromium dependencies
+        run: |
+          sudo apt-get update -qq
+          sudo apt-get install -y \
+            libnss3 libatk1.0-0 libatk-bridge2.0-0 libcups2 \
+            libdrm2 libxkbcommon0 libxcomposite1 libxdamage1 \
+            libxrandr2 libgbm1 libpango-1.0-0 libcairo2 libasound2
+
+      - name: Install dependencies
+        run: yarn install
+
+      - name: Write GCP credentials
+        run: echo '${{ secrets.GCP_SA_KEY_JSON }}' > /tmp/gcp-key.json
+
+      - name: Run WhatsApp flow test
+        env:
+          WHATSAPP_TARGET_ENV: ${{ github.event.inputs.environment || 'production' }}
+          GCS_BUCKET: ${{ secrets.GCS_BUCKET }}
+          GCS_KEY_FILE: /tmp/gcp-key.json
+          INSTATUS_API_KEY: ${{ secrets.INSTATUS_API_KEY }}
+          INSTATUS_PAGE_ID: ${{ secrets.INSTATUS_PAGE_ID }}
+          INSTATUS_COMPONENT_ID: ${{ secrets.INSTATUS_COMPONENT_ID }}
+          BOT_PHONE_NUMBER: ${{ secrets.BOT_PHONE_NUMBER }}
+        run: yarn wa:smoke
+
+      - name: Clean up credentials
+        if: always()
+        run: rm -f /tmp/gcp-key.json

.gitignore

@@ -14,6 +14,7 @@
 # misc
 .DS_Store
 .env
+.envrc
 
 npm-debug.log*
 yarn-debug.log*
@@ -23,4 +24,8 @@ package-lock.json
 
 cypress.config.ts
 cypress/screenshots
-cypress/videos
+cypress/videos
+
+# wwebjs
+.wwebjs_auth
+.wwebjs_cache

cypress/e2e/smoke.spec.ts

@@ -0,0 +1,79 @@
+describe('smoke test', () => {
+  let testPassed = true;
+
+  afterEach(function () {
+    if (this.currentTest?.state === 'failed') {
+      testPassed = false;
+    }
+  });
+
+  after(() => {
+    cy.env(['INSTATUS_API_KEY', 'INSTATUS_PAGE_ID', 'INSTATUS_COMPONENT_ID']).then(
+      ({ INSTATUS_API_KEY, INSTATUS_PAGE_ID, INSTATUS_COMPONENT_ID }) => {
+        const status = testPassed ? 'OPERATIONAL' : 'MAJOROUTAGE';
+        cy.request({
+          method: 'PUT',
+          url: `https://api.instatus.com/v2/${INSTATUS_PAGE_ID}/components/${INSTATUS_COMPONENT_ID}`,
+          headers: { Authorization: `Bearer ${INSTATUS_API_KEY}` },
+          body: { status },
+          failOnStatusCode: false,
+        });
+      }
+    );
+  });
+
+  it('passes', () => {
+    cy.env([
+      'SMOKE_TEST_CHAT_URL',
+      'SMOKE_TEST_LOGIN_PHONE_NUMBER',
+      'SMOKE_TEST_LOGIN_PASSWORD',
+    ]).then(({ SMOKE_TEST_CHAT_URL, SMOKE_TEST_LOGIN_PHONE_NUMBER, SMOKE_TEST_LOGIN_PASSWORD }) => {
+      cy.visit(SMOKE_TEST_CHAT_URL);
+      cy.get('[data-testid="phoneInput"] [name="phoneNumber"]').click();
+      cy.get('[data-testid="phoneInput"] [name="phoneNumber"]').type(SMOKE_TEST_LOGIN_PHONE_NUMBER);
+      cy.get('[data-testid="outlinedInput"] [name="password"]').click();
+      cy.get('[data-testid="outlinedInput"] [name="password"]').click();
+      cy.get('[data-testid="outlinedInput"] [name="password"]').type(SMOKE_TEST_LOGIN_PASSWORD);
+      cy.get('[data-testid="SubmitButton"]').click();
+      cy.get('[data-testid="dropdownIcon"]', { timeout: 10000 }).should('be.visible').click();
+      cy.get('[data-testid="flowButton"]', { timeout: 10000 }).should('be.visible').click();
+
+      cy.get('div[data-testid="AutocompleteInput"]', { timeout: 10000 })
+        .should('be.visible')
+        .within(() => {
+          cy.get('input').type('smoke-test');
+        });
+      cy.get('ul.MuiAutocomplete-listbox')
+        .first()
+        .within(() => {
+          cy.get('li').first().click();
+        });
+
+      cy.get('[data-testid="ok-button"]').click();
+
+      // Wait for 30 seconds to ensure all messages are in
+      cy.wait(30000);
+
+      cy.get('[data-testid="messageContainer"] [data-testid="content"]', { timeout: 10000 }).then(
+        ($messages) => {
+          expect($messages.length).to.be.at.least(3);
+          const lastThree = $messages.slice(-3);
+
+          // First of last three should have the date message
+          const now = new Date();
+          const year = now.getFullYear();
+          const month = String(now.getMonth() + 1).padStart(2, '0');
+          const day = String(now.getDate()).padStart(2, '0');
+          const dateString = `World! ${day}/${month}/${year}`;
+          expect(Cypress.$(lastThree[0]).text()).to.contain(dateString);
+
+          // Second should have 'elephant'
+          expect(Cypress.$(lastThree[1]).text()).to.contain('elephant');
+
+          // Third should have an audio element inside
+          expect(Cypress.$(lastThree[2]).find('audio').length).to.be.greaterThan(0);
+        }
+      );
+    });
+  });
+});

package.json

@@ -6,15 +6,22 @@
   "repository": "git@github.com:glific/cypress-testing.git",
   "author": "Kurund Jalmi <kurund.jalmi@webaccessglobal.com>",
   "dependencies": {
-    "cypress": "13.6.2",
+    "@google-cloud/storage": "^7.14.0",
+    "cypress": "^15.15.0",
     "cypress-split": "^1.24.28",
     "dayjs": "^1.11.10",
-    "typescript": "^5.7.2"
+    "qrcode-terminal": "^0.12.0",
+    "tsx": "^4.19.4",
+    "typescript": "^5.7.2",
+    "whatsapp-web.js": "^1.26.1"
   },
   "devDependencies": {
+    "@types/node": "^22.0.0",
+    "@types/qrcode-terminal": "^0.12.2",
     "prettier": "^2.8.2"
   },
   "scripts": {
-    "cy:run": "cypress run"
+    "cy:run": "cypress run",
+    "wa:smoke": "tsx wwebjs/smoke/runner.ts"
   }
 }

wwebjs/smoke/flows.ts

@@ -0,0 +1,62 @@
+export interface ExpectedMessage {
+  containsText?: string;
+  exactText?: string;
+  hasMedia?: boolean;
+  mediaType?: 'image' | 'audio' | 'video' | 'document' | 'sticker';
+}
+
+export interface FlowDefinition {
+  id: string;
+  description: string;
+  triggerMessage: string;
+  expectedResponses: ExpectedMessage[];
+  timeoutMs?: number;
+}
+
+export interface TargetEnvironment {
+  name: string;
+  botPhoneNumber: string;
+  sessionId: string;
+  gcsBucket: string;
+  instatus: {
+    pageId: string;
+    componentId: string;
+  };
+}
+
+export const FLOWS: Record<string, FlowDefinition> = {
+  'smoke-test': {
+    id: 'smoke-test',
+    description: 'Verify core flow: date message → elephant text → audio',
+    triggerMessage: 'smoke',
+    expectedResponses: [
+      { containsText: 'World!' },
+      { containsText: 'elephant' },
+      { hasMedia: true, mediaType: 'audio' },
+    ],
+    timeoutMs: 120_000,
+  },
+};
+
+export const ENVIRONMENTS: Record<string, TargetEnvironment> = {
+  production: {
+    name: 'production',
+    botPhoneNumber: process.env.BOT_PHONE_NUMBER ?? '+918657048982',
+    sessionId: process.env.WHATSAPP_SESSION_ID ?? 'production-sender',
+    gcsBucket: process.env.GCS_BUCKET ?? '',
+    instatus: {
+      pageId: process.env.INSTATUS_PAGE_ID ?? '',
+      componentId: process.env.INSTATUS_COMPONENT_ID ?? '',
+    },
+  },
+  staging: {
+    name: 'staging',
+    botPhoneNumber: process.env.BOT_PHONE_NUMBER ?? '',
+    sessionId: process.env.WHATSAPP_SESSION_ID ?? 'staging-sender',
+    gcsBucket: process.env.GCS_BUCKET ?? '',
+    instatus: {
+      pageId: process.env.INSTATUS_PAGE_ID ?? '',
+      componentId: process.env.INSTATUS_COMPONENT_ID ?? '',
+    },
+  },
+};

wwebjs/smoke/gcs-store.ts

@@ -0,0 +1,78 @@
+import { Storage } from '@google-cloud/storage';
+import * as fs from 'fs';
+import * as path from 'path';
+
+export interface GCSStoreOptions {
+  bucket: string;
+  keyFilename?: string;
+  prefix?: string;
+  /** Must match RemoteAuth dataPath (default: ./.wwebjs_auth/) */
+  dataPath?: string;
+}
+
+export interface StoreSessionParams {
+  session: string;
+  path?: string;
+}
+
+export class GCSRemoteAuthStore {
+  private storage: Storage;
+  private bucket: string;
+  private prefix: string;
+  private dataPath: string;
+
+  constructor(options: GCSStoreOptions) {
+    this.storage = new Storage(options.keyFilename ? { keyFilename: options.keyFilename } : {});
+    this.bucket = options.bucket;
+    this.prefix = options.prefix ?? 'whatsapp-sessions';
+    this.dataPath = path.resolve(options.dataPath ?? './.wwebjs_auth');
+  }
+
+  /** RemoteAuth writes zips as {dataPath}/{session}.zip (e.g. RemoteAuth-production-sender.zip). */
+  private localZipPath(session: string): string {
+    return path.join(this.dataPath, `${session}.zip`);
+  }
+
+  private objectName(session: string): string {
+    return `${this.prefix}/${session}.zip`;
+  }
+
+  async sessionExists({ session }: { session: string }): Promise<boolean> {
+    console.log(`Checking if session exists: ${session}`);
+    const [exists] = await this.storage.bucket(this.bucket).file(this.objectName(session)).exists();
+    return exists;
+  }
+
+  async save({ session }: StoreSessionParams): Promise<void> {
+    console.log(`Saving session: ${session}`);
+    const localZip = this.localZipPath(session);
+    if (!fs.existsSync(localZip)) {
+      throw new Error(`Session zip not found at ${localZip}`);
+    }
+    await this.storage
+      .bucket(this.bucket)
+      .upload(localZip, { destination: this.objectName(session) });
+    console.log(`Session saved to GCS: gs://${this.bucket}/${this.objectName(session)}`);
+  }
+
+  async extract({ session, path: destPath }: StoreSessionParams): Promise<void> {
+    console.log(`Extracting session: ${session}`);
+    const localZip = destPath ?? this.localZipPath(session);
+    fs.mkdirSync(path.dirname(localZip), { recursive: true });
+    await this.storage
+      .bucket(this.bucket)
+      .file(this.objectName(session))
+      .download({ destination: localZip });
+    console.log(`Session restored from GCS: gs://${this.bucket}/${this.objectName(session)}`);
+  }
+
+  async delete({ session }: { session: string }): Promise<void> {
+    console.log(`Deleting session: ${session}`);
+    try {
+      await this.storage.bucket(this.bucket).file(this.objectName(session)).delete();
+    } catch (err: unknown) {
+      if ((err as NodeJS.ErrnoException)?.code !== '404') throw err;
+    }
+    console.log(`Session deleted from GCS: ${this.objectName(session)}`);
+  }
+}

wwebjs/smoke/instatus.ts

@@ -0,0 +1,26 @@
+export async function reportToInstatus(
+  apiKey: string,
+  pageId: string,
+  componentId: string,
+  passed: boolean
+): Promise<void> {
+  if (!apiKey || !pageId || !componentId) {
+    console.warn('Instatus credentials not set — skipping status report');
+    return;
+  }
+  const status = passed ? 'OPERATIONAL' : 'MAJOROUTAGE';
+  const url = `https://api.instatus.com/v2/${pageId}/components/${componentId}`;
+  try {
+    const res = await fetch(url, {
+      method: 'PUT',
+      headers: {
+        Authorization: `Bearer ${apiKey}`,
+        'Content-Type': 'application/json',
+      },
+      body: JSON.stringify({ status }),
+    });
+    console.log(`Instatus report: ${status} → HTTP ${res.status}`);
+  } catch (err) {
+    console.error('Instatus report failed:', err);
+  }
+}