Class TestAdapter

An in-memory adapter used only for tests.

Instead of a server, run() returns a TestClient whose send pushes a caller-supplied IncomingEvent straight through the real adapter + kernel pipeline and returns the resulting OutgoingResponse. There is no request normalisation (you provide a ready event) and the raw response IS the outgoing response, so assertions see exactly what your handlers produced.

Hierarchy

Adapter<
    IncomingEvent,
    OutgoingResponse,
    TestExecutionContext,
    IncomingEvent,
    IncomingEventOptions,
    OutgoingResponse,
    TestAdapterContext,
>
- TestAdapter

Constructors

`Protected`constructor

new TestAdapter(blueprint: IBlueprint): TestAdapter
Create an Adapter.
Parameters
- blueprint: IBlueprint
  The blueprint to create the adapter.
Returns TestAdapter

Inherited from Adapter< IncomingEvent, OutgoingResponse, TestExecutionContext, IncomingEvent, IncomingEventOptions, OutgoingResponse, TestAdapterContext >.constructor

Properties

`Protected` `Readonly`blueprint

blueprint: IBlueprint

`Protected` `Readonly`hooks

hooks: AdapterHookType<TestAdapterContext, OutgoingResponse>

`Protected` `Readonly`middleware

middleware: AdapterMixedPipeType<TestAdapterContext, OutgoingResponse>[]

`Protected` `Readonly`resolvedErrorHandlers

resolvedErrorHandlers: Record<
string,
IAdapterErrorHandler<RawEventType, RawResponseType, ExecutionContextType>,
>

Methods

`Protected`buildRawResponse

buildRawResponse(context: TestAdapterContext): Promise<OutgoingResponse>
The raw response for a test IS the outgoing response the handlers produced.
Parameters
- context: TestAdapterContext
  The adapter context.
Returns Promise<OutgoingResponse>
The outgoing response.

Overrides Adapter.buildRawResponse

`Protected`dispatch

dispatch(event: IncomingEvent): Promise<OutgoingResponse>
Dispatch one event through the kernel and return the outgoing response.
Parameters
- event: IncomingEvent
  The incoming event.
Returns Promise<OutgoingResponse>
The outgoing response.

`Protected`executeEventHandlerHooks

executeEventHandlerHooks(
hook: KernelHookName,
eventHandler: AdapterEventHandlerType<IncomingEvent, OutgoingResponse>,
): Promise<void>
Execute the event handler lifecycle hooks.
Parameters
- hook: KernelHookName
  The hook to execute.
- eventHandler: AdapterEventHandlerType<IncomingEvent, OutgoingResponse>
  The event handler to be run.
Returns Promise<void>

Inherited from Adapter.executeEventHandlerHooks

`Protected`executeHooks

executeHooks(
    name: AdapterHookName,
    context?: TestAdapterContext,
    error?: any,
): Promise<void>
Execute adapter lifecycle hooks.
Parameters
- name: AdapterHookName
  The hook's name.
- Optionalcontext: TestAdapterContext
  The event context.
- Optionalerror: any
  The error to handle.
Returns Promise<void>

Inherited from Adapter.executeHooks

`Protected`handleError

handleError(
error: Error,
context: TestAdapterContext,
): Promise<AdapterEventBuilderType<OutgoingResponse>>
Handle error.
Parameters
- error: Error
  The error to handle.
- context: TestAdapterContext
  The event context.
Returns Promise<AdapterEventBuilderType<OutgoingResponse>>
The raw response.

Inherited from Adapter.handleError

`Protected`handleEvent

handleEvent(
    context: TestAdapterContext,
    eventHandler: AdapterEventHandlerType<IncomingEvent, OutgoingResponse>,
): Promise<
    IAdapterEventBuilder<
        RawResponseOptions,
        IRawResponseWrapper<OutgoingResponse>,
    >,
>
Handle the event.
Parameters
- context: TestAdapterContext
  The event context.
- eventHandler: AdapterEventHandlerType<IncomingEvent, OutgoingResponse>
  The event handler to be run.
Returns Promise<
    IAdapterEventBuilder<
        RawResponseOptions,
        IRawResponseWrapper<OutgoingResponse>,
    >,
>
The raw response wrapper.

Inherited from Adapter.handleEvent

`Protected`makePipelineOptions

makePipelineOptions(): PipelineOptions<
TestAdapterContext,
AdapterEventBuilderType<OutgoingResponse>,
>

Create pipeline options for the Adapter.

Returns PipelineOptions<TestAdapterContext, AdapterEventBuilderType<OutgoingResponse>>
The pipeline options for transforming the event.

Inherited from Adapter.makePipelineOptions

`Protected`onStart

onStart(): Promise<void>

Lifecycle hook run once before the first dispatch.

Returns Promise<void>

`Protected`resolveErrorHandler

resolveErrorHandler(
    error: Error,
): IAdapterErrorHandler<
    IncomingEvent,
    OutgoingResponse,
    TestExecutionContext,
>
Get the error handler for the given error.
Parameters
- error: Error
  The error to get the handler for.
Returns IAdapterErrorHandler<IncomingEvent, OutgoingResponse, TestExecutionContext>
The error handler.

Throws
IntegrationError

Inherited from Adapter.resolveErrorHandler

`Protected`resolveEventHandler

resolveEventHandler(): AdapterEventHandlerType<IncomingEvent, OutgoingResponse>

Get the event handler for the adapter.

Returns AdapterEventHandlerType<IncomingEvent, OutgoingResponse>
The event handler for the adapter.

Throws
If the event handler is missing.

Inherited from Adapter.resolveEventHandler

run

run<ExecutionResultType = TestClient>(): Promise<ExecutionResultType>
Start the adapter and return a test client.
Type Parameters
- ExecutionResultType = TestClient
Returns Promise<ExecutionResultType>
The test client.

Overrides Adapter.run

`Protected`sendEventThroughDestination

sendEventThroughDestination(
context: TestAdapterContext,
eventHandler: AdapterEventHandlerType<IncomingEvent, OutgoingResponse>,
): Promise<OutgoingResponse>
Send the raw event through the destination.
Parameters
- context: TestAdapterContext
  The event context.
- eventHandler: AdapterEventHandlerType<IncomingEvent, OutgoingResponse>
  The event handler to be run.
Returns Promise<OutgoingResponse>
Platform-specific response.

Throws
IntegrationError

Inherited from Adapter.sendEventThroughDestination

`Protected`validateContextAndEventHandler

validateContextAndEventHandler(
context: TestAdapterContext,
eventHandler: AdapterEventHandlerType<IncomingEvent, OutgoingResponse>,
): void
Validate the context and event handler.
Parameters
- context: TestAdapterContext
  The context to validate.
- eventHandler: AdapterEventHandlerType<IncomingEvent, OutgoingResponse>
  The event handler to validate.
Returns void

Throws
IntegrationError

Inherited from Adapter.validateContextAndEventHandler

`Static`create

create(blueprint: IBlueprint): TestAdapter
Parameters
- blueprint: IBlueprint
  The application blueprint.
Returns TestAdapter
A new adapter instance.

Class TestAdapter

Hierarchy

Index

Constructors

Properties

Methods

Constructors

Protectedconstructor

Parameters

Returns TestAdapter

Properties

Protected Readonlyblueprint

Protected Readonlyhooks

Protected Readonlymiddleware

Protected ReadonlyresolvedErrorHandlers

Methods

ProtectedbuildRawResponse

Parameters

Returns Promise<OutgoingResponse>

Protecteddispatch

Parameters

Returns Promise<OutgoingResponse>

ProtectedexecuteEventHandlerHooks

Parameters

Returns Promise<void>

ProtectedexecuteHooks

Parameters

Returns Promise<void>

ProtectedhandleError

Parameters

Returns Promise<AdapterEventBuilderType<OutgoingResponse>>

ProtectedhandleEvent

Parameters

Returns Promise< IAdapterEventBuilder< RawResponseOptions, IRawResponseWrapper<OutgoingResponse>, >,>

ProtectedmakePipelineOptions

Returns PipelineOptions<TestAdapterContext, AdapterEventBuilderType<OutgoingResponse>>

ProtectedonStart

Returns Promise<void>

ProtectedresolveErrorHandler

Parameters

Returns IAdapterErrorHandler<IncomingEvent, OutgoingResponse, TestExecutionContext>

Throws

ProtectedresolveEventHandler

Returns AdapterEventHandlerType<IncomingEvent, OutgoingResponse>

Throws

run

Type Parameters

Returns Promise<ExecutionResultType>

ProtectedsendEventThroughDestination

Parameters

Returns Promise<OutgoingResponse>

Throws

ProtectedvalidateContextAndEventHandler

Parameters

Returns void

Throws

Staticcreate

Parameters

Returns TestAdapter

Settings

On This Page

`Protected`constructor

`Protected` `Readonly`blueprint

`Protected` `Readonly`hooks

`Protected` `Readonly`middleware

`Protected` `Readonly`resolvedErrorHandlers

`Protected`buildRawResponse

`Protected`dispatch

`Protected`executeEventHandlerHooks

`Protected`executeHooks

`Protected`handleError

`Protected`handleEvent

Returns Promise<
IAdapterEventBuilder<
RawResponseOptions,
IRawResponseWrapper<OutgoingResponse>,
>,
>

`Protected`makePipelineOptions

`Protected`onStart

`Protected`resolveErrorHandler

`Protected`resolveEventHandler

`Protected`sendEventThroughDestination

`Protected`validateContextAndEventHandler

`Static`create