Class MemoryInboxStore

An in-memory InboxStore for tests; it behaves like FileInboxStore but is lost on exit. Entries are kept in arrival order, so entries without seq keep their arrival order.

Example

const verifier = new InvocationVerifier({ instanceId, agentId, jwks, replay: new MemoryInboxStore() });

Implements

InboxStore

Index

Constructors

constructor

Methods

add close forRun get inStates jtiSeen prune redelivered rememberJti replaceToken setState

Constructors

constructor

new MemoryInboxStore(): MemoryInboxStore
Returns MemoryInboxStore

Methods

add

add(entry: InboxEntry): Promise<void>
Stores a new entry with a copy of its envelope.
Parameters
- entry: InboxEntry
  The entry.
Returns Promise<void>
A promise that resolves when stored.

Throws
RangeError when the event is already stored, its ID is not a UUID or the envelope carries a token.

Implementation of InboxStore.add

close

close(): Promise<void>
Nothing to release.

Returns Promise<void>
A resolved promise.

Implementation of InboxStore.close

forRun

forRun(runId: string): Promise<InboxEntry[]>
Returns the entries of a run in seq order.
Parameters
- runId: string
  The run.
Returns Promise<InboxEntry[]>
The entries.

Implementation of InboxStore.forRun

get

get(eventId: string): Promise<InboxEntry | undefined>
Returns the entry of eventId.
Parameters
- eventId: string
  The envelope id.
Returns Promise<InboxEntry | undefined>
The entry, or undefined.

Implementation of InboxStore.get

inStates

inStates(...states: EntryState[]): Promise<InboxEntry[]>
Returns the entries in one of states in seq order.
Parameters
- ...states: EntryState[]
  The states asked for.
Returns Promise<InboxEntry[]>
The entries.

Implementation of InboxStore.inStates

jtiSeen

jtiSeen(jti: string, nowMs: number): Promise<boolean>
Returns whether jti is remembered beyond nowMs.
Parameters
- jti: string
  The token ID.
- nowMs: number
  The current wall time.
Returns Promise<boolean>
Whether the jti is still remembered.

Implementation of InboxStore.jtiSeen

prune

prune(nowMs: number): Promise<void>
Drops the expired jti rows.
Parameters
- nowMs: number
  The current wall time.
Returns Promise<void>
A promise that resolves when done.

Implementation of InboxStore.prune

redelivered

redelivered(
    eventId: string,
    token: Secret | undefined,
    iat: number | undefined,
    jti: string | undefined,
): Promise<InboxEntry>
Counts a redelivery; see InboxStore.redelivered.
Parameters
- eventId: string
  The envelope id.
- token: Secret | undefined
  The token of the redelivery, if any.
- iat: number | undefined
  Its iat.
- jti: string | undefined
  Its jti.
Returns Promise<InboxEntry>
The entry after the update.

Throws
RangeError when the event is not stored.

Implementation of InboxStore.redelivered

rememberJti

rememberJti(jti: string, untilMs: number): Promise<void>
Remembers jti until untilMs (an earlier end never shortens a later one).
Parameters
- jti: string
  The token ID.
- untilMs: number
  When the token cannot pass anymore (exp plus the leeway).
Returns Promise<void>
A promise that resolves when stored.

Implementation of InboxStore.rememberJti

replaceToken

replaceToken(
    eventId: string,
    token: Secret,
    iat: number,
    jti: string,
): Promise<void>
Replaces the token unconditionally.
Parameters
- eventId: string
  The envelope id.
- token: Secret
  The granted token.
- iat: number
  Its iat.
- jti: string
  Its jti.
Returns Promise<void>
A promise that resolves when stored.

Throws
RangeError when the event is not stored.

Implementation of InboxStore.replaceToken

setState

setState(eventId: string, state: EntryState): Promise<void>
Sets the state of an entry.
Parameters
- eventId: string
  The envelope id.
- state: EntryState
  The new state.
Returns Promise<void>
A promise that resolves when stored.

Throws
RangeError when the event is not stored.

Implementation of InboxStore.setState

Class MemoryInboxStore

Example

Implements

Index

Constructors

Methods

Constructors

constructor

Returns MemoryInboxStore

Methods

add

Parameters

Returns Promise<void>

Throws

close

Returns Promise<void>

forRun

Parameters

Returns Promise<InboxEntry[]>

get

Parameters

Returns Promise<InboxEntry | undefined>

inStates

Parameters

Returns Promise<InboxEntry[]>

jtiSeen

Parameters

Returns Promise<boolean>

prune

Parameters

Returns Promise<void>

redelivered

Parameters

Returns Promise<InboxEntry>

Throws

rememberJti

Parameters

Returns Promise<void>

replaceToken

Parameters

Returns Promise<void>

Throws

setState

Parameters

Returns Promise<void>

Throws

Settings

On This Page