agora-testing-guidance

Included with Lifetime

$97 forever

Mocking patterns and testing requirements for Agora SDK integration code. Covers RTC Web, RTC React, RTC iOS, RTC Android, RTC React Native, RTC Flutter, RTM Web, RTM iOS, RTM Android, and ConvoAI REST API. Use when generating tests for any Agora integration, or when reminding the user to add tests to an implementation.

Web Dev

What this skill does


# Agora Testing Guidance

Mocking patterns and completeness requirements for Agora SDK integration code.

## When to Generate Tests

Every code generation task that produces implementation code must include test stubs.
If the user asks to "implement" something, remind them to generate tests before the
task is complete. Do not mark an implementation task as done until tests are addressed.

For the reminder template, see [completeness-gate.md](completeness-gate.md).

## Route by Stack

Use the file that matches the user's integration:

| Stack | File |
|---|---|
| RTC Web (`agora-rtc-sdk-ng`) | [rtc-web.md](rtc-web.md) |
| RTC React (`agora-rtc-react`) | [rtc-react.md](rtc-react.md) |
| RTC iOS (Swift) | [rtc-ios.md](rtc-ios.md) |
| RTC Android (Kotlin/Java) | [rtc-android.md](rtc-android.md) |
| RTC React Native / Flutter / RTM Web / RTM iOS / RTM Android / token renewal | [mobile-rtm-and-renewal.md](mobile-rtm-and-renewal.md) |
| ConvoAI REST API / backend HTTP integrations | [convoai-rest.md](convoai-rest.md) |
| Completeness reminder and behavior-specific test prompts | [completeness-gate.md](completeness-gate.md) |

## Core Rule

Mock at the boundary your code owns:

- SDK wrapper code: mock the SDK module or engine/client abstraction
- UI hooks/components: mock the hooks or provider layer
- REST integrations: mock the HTTP client, not the SDK
- Native singletons/factories: wrap behind protocols/interfaces first, then inject mocks

## Platform Notes

- Prefer unit tests for join/publish/subscribe/token-renewal behavior.
- For UI tests, assert rendered state after simulated SDK callbacks rather than trying to render the actual native/media views.
- For ConvoAI, assert both request shape and auth headers.

## Required Behaviors to Cover

At minimum, generated tests should verify the behaviors most likely to break:

- join/login is called with the correct channel and identity
- tokens are renewed before expiry
- cleanup happens in the right order
- ConvoAI payload types are correct (`agent_rtc_uid` string, `remote_rtc_uids` array)
- auth headers are present and sourced correctly
- failure paths do not continue with partial initialization

Files: 8

Size: 17.4 KB

Complexity: 36/100

Category: Web Dev

Source: https://github.com/agoraio/skills/tree/main/skills/agora/references/testing-guidance

Related in Web Dev

generating-lwc-components

Included

Lightning Web Components with PICKLES methodology and 165-point scoring. Use this skill when the user creates or edits LWC components, builds wire service patterns, or writes Jest tests for LWC. TRIGGER when: user creates/edits LWC components, touches lwc/**/*.js, .html, .css, .js-meta.xml files, or asks about wire service, SLDS, or Jest LWC tests. DO NOT TRIGGER when: Apex classes (use generating-apex), Aura components, or Visualforce.

Web Devscripts

tanstack-query

Included

Manage server state in React with TanStack Query v5. Set up queries with useQuery, mutations with useMutation, configure QueryClient caching strategies, implement optimistic updates, and handle infinite scroll with useInfiniteQuery. Use when: setting up data fetching in React projects, migrating from v4 to v5, or fixing object syntax required errors, query callbacks removed issues, cacheTime renamed to gcTime, isPending vs isLoading confusion, keepPreviousData removed problems.

Web Devscripts

document-processor-api

Included

Process documents with Nutrient DWS. Use when the user wants to generate PDFs from HTML or URLs, convert Office/images/PDFs, assemble or split packets, OCR scans, extract text/tables/key-value pairs, redact PII, watermark, sign, fill forms, optimize PDFs, or produce compliance outputs like PDF/A or PDF/UA. Triggers include convert to PDF, merge these PDFs, OCR this scan, extract tables, redact PII, sign this PDF, make this PDF/A, or linearize for web delivery.

Web Devscripts

nutrient-document-processing

Included

Web Devscripts

tanstack-query

Included

Manage server state in React with TanStack Query v5. Covers useMutationState, simplified optimistic updates, throwOnError, network mode (offline/PWA), and infiniteQueryOptions. Use when setting up data fetching, fixing v4→v5 migration errors (object syntax, gcTime, isPending, keepPreviousData), or debugging SSR/hydration issues with streaming server components.

Web Devscripts

accelint-nextjs-best-practices

Included

Next.js performance optimization and best practices. Use when writing Next.js code (App Router or Pages Router); implementing Server Components, Server Actions, or API routes; optimizing RSC serialization, data fetching, or server-side rendering; reviewing Next.js code for performance issues; fixing authentication in Server Actions; or implementing Suspense boundaries, parallel data fetching, or request deduplication.

Web Devscripts