Skip to main content

QueueBenchHarness

@webda/bench

Interface: QueueBenchHarness

Defined in: packages/bench/src/suites/queue.ts:13

What a queue package provides to run benchQueue

Properties​

backend​

backend: string

Defined in: packages/bench/src/suites/queue.ts:17

Backend name displayed in the results: MemoryQueue, SQSQueue...

emulated?​

optional emulated?: boolean

Defined in: packages/bench/src/suites/queue.ts:58

The backend is an emulator: numbers are for regression tracking only

inconsistentSize?​

optional inconsistentSize?: boolean

Defined in: packages/bench/src/suites/queue.ts:42

size() is approximate (SQS, GCP...): size checks are skipped

rawReceive?​

optional rawReceive?: boolean

Defined in: packages/bench/src/suites/queue.ts:54

receiveMessage / deleteMessage can be called directly, enables the queue.drain.raw scenario

Set to false for queues that only deliver through consume() (e.g. GCPQueue in consumer mode).

Default​

true

redeliveryDelayMs?​

optional redeliveryDelayMs?: number

Defined in: packages/bench/src/suites/queue.ts:46

Delay after which a message not acknowledged is delivered again, enables the queue.redelivery scenario

Methods​

createQueue()​

createQueue(name): Promise<Queue<any, QueueParameters>>

Defined in: packages/bench/src/suites/queue.ts:24

Create, register in the Core, resolve and initialize an EMPTY queue of the type under test

Parameters​

name​

string

service name

Returns​

Promise<Queue<any, QueueParameters>>

the queue

purge()?​

optional purge(queue): Promise<void>

Defined in: packages/bench/src/suites/queue.ts:32

Remove every message of the queue

Defaults to the __clean test hook of the queue.

Parameters​

queue​

Queue

the queue

Returns​

Promise<void>

stopQueue()?​

optional stopQueue(queue): Promise<void>

Defined in: packages/bench/src/suites/queue.ts:38

Release the queue resources at the end

Parameters​

queue​

Queue

the queue

Returns​

Promise<void>