MockForgeAdapter

Defined in: packages/core/src/test-utils/MockForgeAdapter.ts:57

A test double for ForgeAdapter that records all calls and returns configurable responses from a FIFO queue.

This is the primary tool for unit testing generated client functions without a real Forge runtime or network connection.

Responses are dequeued in the order they were queued. If the queue is empty, a default 200 OK with {} body is returned. Errors queued via queueThrow() are thrown before checking the response queue.

Example

import { MockForgeAdapter, asApp } from '@forge-clients/core';
import { getIssue } from '@forge-clients/jira/v3';

const mock = new MockForgeAdapter('jira');
mock.queueResponse({ id: '123', key: 'PROJ-1', fields: {} });

const client = asApp(mock);
const issue = await getIssue(client, { path: { issueIdOrKey: 'PROJ-1' } });

expect(mock.callCount).toBe(1);
expect(mock.getLastCall()?.path).toBe('/rest/api/3/issue/PROJ-1');

Implements

ForgeAdapter

Constructors

Constructor

new MockForgeAdapter(product?): MockForgeAdapter

Defined in: packages/core/src/test-utils/MockForgeAdapter.ts:68

Create a new MockForgeAdapter.

Parameters

product?

"jira" | "confluence"

The Atlassian product to simulate (default: 'jira')

Returns

MockForgeAdapter

Properties

product

readonly product: "jira" | "confluence"

Defined in: packages/core/src/test-utils/MockForgeAdapter.ts:58

The Atlassian product this adapter is configured to make requests to

Implementation of

ForgeAdapter.product

Accessors

callCount

Get Signature

get callCount(): number

Defined in: packages/core/src/test-utils/MockForgeAdapter.ts:107

The total number of calls made to fetch() since the last reset()

Returns

number

Methods

fetch()

fetch(options): Promise<Response>

Defined in: packages/core/src/test-utils/MockForgeAdapter.ts:72

Execute an HTTP request and return a standard Response. Implementations are responsible for authentication header injection, URL construction, and serialisation.