Send notifications upon errors

[tafaust]

So far, I have only found that we can periodically fetch the health of our system under test (SUT) to send a message but not be able to report any errors throughout mokapi testing.

import { cron } from 'mokapi'

// Run every 2 minutes
cron('*/2 * * * *', function() {
    const sutUrl = 'http://system-under-test.com/api/health'
    
    try {
        const response = fetch(sutUrl)
        
        if (response.status !== 200) {
            sendTelegram(`Smoke Test Failed! SUT returned ${response.status}`);
        }
    } catch (err) {
        sendTelegram(`Smoke Test Error: Could not reach SUT at ${sutUrl}`);
    }
})

function sendTelegram(message) {
    const token = 'YOUR_BOT_TOKEN'
    const chatId = 'YOUR_CHAT_ID'
    
    fetch(`api.telegram.org{token}/sendMessage`, {
        method: 'POST',
        headers: { 'Content-Type': 'application/json' },
        body: JSON.stringify({ chat_id: chatId, text: message })
    })
}

Active external reporting to e.g. a Telegram bot is helpful for GitOps deployments that can change upon push.

[marle3003]

Hi @tafaust,

Thanks for reporting this! I reviewed the script you shared and there are several issues that prevent it from running correctly in Mokapi. Here’s a detailed overview along with recommendations and a corrected example:

Identified Issues:

1. No default export function.
   Mokapi only executes JavaScript files that export a default function. Scripts without a default export are treated as modules and will not be executed, which is why nothing was logged.

   Note: In the next Mokapi release, a debug message will be logged whenever a script does not have a default function to make this behavior more visible.

2. fetch is not defined
   Mokapi does not run in Node.js or a browser environment, so global functions like fetch are not available. You must import it explicitly from mokapi/http:

   import { fetch } from 'mokapi/http';

3. Async handling
   Since fetch returns a promise, all functions using it must be async and awaited.
4. Response object
   Mokapi’s fetch response uses statusCode for the HTTP status code, not status.
5. Invalid URL in sendTelegram
   The URL in your original script lacked a scheme, a slash after .org, and the template literal was missing the $ for embedded expressions:
6. Cron jobs delay execution
   Because your code was wrapped in a cron job, errors in scripts without a default function weren’t visible.
7. Optional: TypeScript type definitions
   Using @types/mokapi is highly recommended. It helps catch issues like missing imports, incorrect function signatures, or misuse of response properties at compile time.

Corrected Script:

import { cron } from 'mokapi'
import { fetch } from 'mokapi/http'

export default async function() {
    // Run every 2 minutes
    cron('*/2 * * * *', async function() {
        const sutUrl = 'http://system-under-test.com/api/health'
        
        try {
            const response = await fetch(sutUrl)
            
            if (response.statusCode !== 200) {
                await sendTelegram(`Smoke Test Failed! SUT returned ${response.statusCode}`)
            }
        } catch (err) {
            await sendTelegram(`Smoke Test Error: Could not reach SUT at ${sutUrl}`)
        }
    })
}

async function sendTelegram(message) {
    const token = 'YOUR_BOT_TOKEN'
    const chatId = 'YOUR_CHAT_ID'
    
    await fetch(`https://api.telegram.org/bot${token}/sendMessage`, {
        method: 'POST',
        headers: { 'Content-Type': 'application/json' },
        body: JSON.stringify({ chat_id: chatId, text: message })
    })
}

Summary / Recommendations:

• Always define a default export function for executable Mokapi scripts.
• Import fetch from mokapi/http instead of relying on Node.js or browser globals.
• Mark functions async when using fetch and await all promises.
• Consider using @types/mokapi for TypeScript validation.
• Upcoming release: Mokapi will log a debug message if a script does not have a default function.
• Improved Documentation: I’ve updated the JavaScript API documentation to clarify how Mokapi executes scripts and the role of the default function. You can find it here: Mokapi JavaScript API