Class TCWrapper

websocket connection wrapper, Can be used to create application-based integration tests.

Hierarchy

StubWebsocketConnection
- TCWrapper

Constructors

constructor

new TCWrapper(client?, token?, supportsCache?): TCWrapper
Creates an instance of TCWrapper.
Parameters
- Optional client: WebsocketClient
- Optional token: string
  
  The token for authentication (optional).
- Optional supportsCache: boolean
Returns TCWrapper
Overrides StubWebsocketConnection.constructor
- Defined in src/integration-testing/connections/tc.ts:333

Properties

_id

_id: number = ++WebsocketConnection.AUTO_INCREMENT

Unique client id per server instance. This incremental value is resetted once the process is restarted.

`Protected` client

client: WebsocketClient

`Readonly` clientInformation

clientInformation: {
    browser: string;
    ip: string;
    location: string;
}

Information about the client connected to the WebSocket.

Type declaration

browser: string
ip: string
location: string

`Protected` connection

connection: WebSocket

The WebSocket connection object representing the connection to the client.

description

description: string = "PUBLIC"

Describes the clients auth state

onCloseCallback

onCloseCallback: Function = ...

token

token: string = null

Can be used to store session credentials.

`Static` router

router: WebsocketRouter = ...

The router used for routing WebSocket requests.

Accessors

id

get id(): number
Gets the ID of the WebSocket connection.

Returns number
Inherited from StubWebsocketConnection.id
- Defined in src/websocket/server/connection/connection.ts:39

identifier

get identifier(): number
Gets the testing identifier of the connection.

Returns number
Inherited from StubWebsocketConnection.identifier
- Defined in src/integration-testing/connections/tc.ts:38

isClosed

get isClosed(): boolean
True if the connection has been closed

Returns boolean
Inherited from StubWebsocketConnection.isClosed
- Defined in src/websocket/server/connection/connection.ts:152

supportsCaching

get supportsCaching(): boolean
True if outbound caching is supported by the client.

Returns boolean
Inherited from StubWebsocketConnection.supportsCaching
- Defined in src/websocket/server/connection/connection.ts:104

Methods

addOutboundData

addOutboundData(method, data): void
Sets the cached outbound data for the associated outbound method.
Parameters
- method: string
  
  The method of the associated Outbound.
- data: any[]
  
  The contents that should be cached for the method.
Returns void
Inherited from StubWebsocketConnection.addOutboundData
- Defined in src/websocket/server/connection/connection.ts:207

closeConnection

closeConnection(): void
Returns void
Inherited from StubWebsocketConnection.closeConnection
- Defined in src/integration-testing/connections/tc.ts:305

dontExpectMethod

dontExpectMethod(method): Promise<void>
Does not expect to receive the method - if received, an error is thrown.
Parameters
- method: string
  
  The method that should not be expected.
Returns Promise<void>
A promise that is rejected with an error if the method is received.
Inherited from StubWebsocketConnection.dontExpectMethod
- Defined in src/integration-testing/connections/tc.ts:251

enableCache

enableCache(): void
States that the client supports caching of outbound data.

Returns void
Inherited from StubWebsocketConnection.enableCache
- Defined in src/websocket/server/connection/connection.ts:97

enableLogging

enableLogging(): void
Enables message logging for the WebSocket connection.

Returns void

Deprecated
Inherited from StubWebsocketConnection.enableLogging
- Defined in src/websocket/server/connection/connection.ts:91

expectCacheRequest

expectCacheRequest(outboundMethod, timeout?): Promise<unknown>
Parameters
- outboundMethod: string
- Optional timeout: number
Returns Promise<unknown>
Inherited from StubWebsocketConnection.expectCacheRequest
- Defined in src/integration-testing/connections/tc.ts:224

expectError

expectError(): Promise<any>
This method is used to catch an error message.

Returns Promise<any>
Promise, that is resolved once a m.error message is received.
Inherited from StubWebsocketConnection.expectError
- Defined in src/integration-testing/connections/tc.ts:269

expectGroupDataUpdate

expectGroupDataUpdate(method, timeout?): Promise<unknown>
Parameters
- method: string
- Optional timeout: number
Returns Promise<unknown>
Inherited from StubWebsocketConnection.expectGroupDataUpdate
- Defined in src/integration-testing/connections/tc.ts:182

expectIdDataUpdate

expectIdDataUpdate(method, timeout?): Promise<unknown>
Parameters
- method: string
- Optional timeout: number
Returns Promise<unknown>
Inherited from StubWebsocketConnection.expectIdDataUpdate
- Defined in src/integration-testing/connections/tc.ts:203

expectMethod

expectMethod(method, messageId?, timeout?, hashCallback?): Promise<any>
This method is used to react to a specific message in a test case. The promises will be resolved in the order of the expected methods. All previously expected methods have to be received, before the method is expected.
Parameters
- method: string
  
  A message with this method is expected.
- Optional messageId: number
- Optional timeout: number
  
  Timeout value in milliseconds before test fails.
- Optional hashCallback: ((specificHash, inserted, updated, deleted) => void)
  - - (specificHash, inserted, updated, deleted): void
    - Parameters
      
      specificHash: number
      
      inserted: any[]
      
      updated: any[]
      
      deleted: any[]
      
      Returns void
Returns Promise<any>
Promise, that is resolved once the provided method is received.
Inherited from StubWebsocketConnection.expectMethod
- Defined in src/integration-testing/connections/tc.ts:149

getOutboundDiffAndUpdateCache

getOutboundDiffAndUpdateCache(method, data, isPartial?): {
    data: string | any[];
    deleted: any[];
    inserted: any[];
    updated: any[];
}
Calculates the modified rows of data, that have been changed since the last time data was cached.
Parameters
- method: string
  
  The method of the associated Outbound.
- data: {
  id: number;
  }[]
  
  The data returned from the outbound function.
- Optional isPartial: boolean
  
  True when a part of the data is only present
Returns {
    data: string | any[];
    deleted: any[];
    inserted: any[];
    updated: any[];
}
the data changes (inserted, updated, deleted)
- data: string | any[]
- deleted: any[]
- inserted: any[]
- updated: any[]
Inherited from StubWebsocketConnection.getOutboundDiffAndUpdateCache
- Defined in src/websocket/server/connection/connection.ts:254

getOutboundRequestConfig

getOutboundRequestConfig(method): {
    count: number;
    groupId: number;
    id: number;
}
Outbound request config is used to store the length of entries, that have been previously requested by this client for partially sent outbounds.
Parameters
- method: string
  
  The method of the outbound
Returns {
    count: number;
    groupId: number;
    id: number;
}
the outbound request config
- count: number
- groupId: number
- id: number
Inherited from StubWebsocketConnection.getOutboundRequestConfig
- Defined in src/websocket/server/connection/connection.ts:377

`Protected` onClose

onClose(): void
Returns void
Inherited from StubWebsocketConnection.onClose
- Defined in src/websocket/server/connection/connection.ts:156

`Protected` onMessage

onMessage(message): void
Handles incoming WebSocket messages.
Parameters
- message: string
  
  The message received from the WebSocket connection.
Returns void
Inherited from StubWebsocketConnection.onMessage
- Defined in src/websocket/server/connection/connection.ts:124

resetOutboundCache

resetOutboundCache(method): void
Parameters
- method: string
Returns void
Inherited from StubWebsocketConnection.resetOutboundCache
- Defined in src/websocket/server/connection/connection.ts:242

runRequest

runRequest(method, data, noMessageId?): void
Parameters
- method: string
- data: any
- Optional noMessageId: boolean
Returns void
Inherited from StubWebsocketConnection.runRequest
- Defined in src/integration-testing/connections/tc.ts:288

send

send(method, value, messageId?, specificHash?, inserted?, updated?, deleted?, length?): Promise<unknown>
Sends a WebSocket message.
Parameters
- method: string
  
  The method of the message.
- value: any
  
  The value of the message.
- Optional messageId: number
  
  The ID of the message (optional).
- Optional specificHash: number
  
  The specific hash value - used by outbounds with caching enabled.
- Optional inserted: any[]
- Optional updated: any[]
- Optional deleted: any[]
- Optional length: number
Returns Promise<unknown>
Overrides StubWebsocketConnection.send
- Defined in src/integration-testing/connections/tc.ts:365

setIp

setIp(ip): void
Sets the IP address of the client.
Parameters
- ip: string
  
  The IP address to set.
Returns void
Inherited from StubWebsocketConnection.setIp
- Defined in src/websocket/server/connection/connection.ts:341

setOutboundRequestConfig

setOutboundRequestConfig(method, count, groupId, id): void
Outbound request config is used to store the length of entries, that have been previously requested by this client for partially sent outbounds.
Parameters
- method: string
  
  The method of the outbound
- count: number
  
  The length of entries that have been requested.
- groupId: number
- id: number
Returns void
Inherited from StubWebsocketConnection.setOutboundRequestConfig
- Defined in src/websocket/server/connection/connection.ts:397

timeout

timeout(ms): Promise<void>
Wait a given amount of ms during a test case.
Parameters
- ms: number
  
  Time duration in milliseconds before the promise is resolved.
Returns Promise<void>
Promise, that is resolved after the given amount of milliseconds.
Inherited from StubWebsocketConnection.timeout
- Defined in src/integration-testing/connections/tc.ts:279

updateOutboundCache

updateOutboundCache(method, inserted, updated, deleted): void
Updates the cached outbound data for the associated outbound method.
Parameters
- method: string
  
  The method of the associated Outbound.
- inserted: any[]
  
  The contents that have been added since the last time.
- updated: any[]
  
  The contents that have been modified since the last time.
- deleted: any[]
  
  The contents that have been removed since the last time.
Returns void
Inherited from StubWebsocketConnection.updateOutboundCache
- Defined in src/websocket/server/connection/connection.ts:218

`Protected` withContext

withContext(func, path?, objectId?): Promise<void>
Parameters
- func: Function
- path: string = null
- objectId: number = null
Returns Promise<void>
Inherited from StubWebsocketConnection.withContext
- Defined in src/integration-testing/connections/tc.ts:309

`Static` addCloseHandler

addCloseHandler(callback): void
Adds a close handler to be called when the connection is closed.
Parameters
- callback: DecorableFunction
  
  The callback function to be called on connection close.
Returns void
Inherited from StubWebsocketConnection.addCloseHandler
- Defined in src/websocket/server/connection/connection.ts:25

`Static` `Protected` getLookup

getLookup(): any
Returns any
Inherited from StubWebsocketConnection.getLookup
- Defined in src/websocket/server/connection/connection.ts:354

Class TCWrapper

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional client: WebsocketClient

Optional token: string

Optional supportsCache: boolean

Returns TCWrapper

Properties

_id

Protected client

Readonly clientInformation

Type declaration

browser: string

ip: string

location: string

Protected connection

description

onCloseCallback

token

Static router

Accessors

id

Returns number

identifier

Returns number

isClosed

Returns boolean

supportsCaching

Returns boolean

Methods

addOutboundData

Parameters

method: string

data: any[]

Returns void

closeConnection

Returns void

dontExpectMethod

Parameters

method: string

Returns Promise<void>

enableCache

Returns void

enableLogging

Returns void

Deprecated

expectCacheRequest

Parameters

outboundMethod: string

Optional timeout: number

Returns Promise<unknown>

expectError

Returns Promise<any>

expectGroupDataUpdate

Parameters

method: string

Optional timeout: number

Returns Promise<unknown>

expectIdDataUpdate

Parameters

method: string

Optional timeout: number

Returns Promise<unknown>

expectMethod

Parameters

method: string

Optional messageId: number

Optional timeout: number

Optional hashCallback: ((specificHash, inserted, updated, deleted) => void)

Parameters

specificHash: number

inserted: any[]

updated: any[]

`Optional` client: WebsocketClient

`Optional` token: string

`Optional` supportsCache: boolean

`Protected` client

`Readonly` clientInformation

`Protected` connection

`Static` router

`Optional` timeout: number

`Optional` timeout: number

`Optional` timeout: number

`Optional` messageId: number

`Optional` timeout: number

`Optional` hashCallback: ((specificHash, inserted, updated, deleted) => void)

data: {
id: number;
}[]

`Optional` isPartial: boolean

Returns {
data: string | any[];
deleted: any[];
inserted: any[];
updated: any[];
}

Returns {
count: number;
groupId: number;
id: number;
}

`Protected` onClose

`Protected` onMessage

`Optional` noMessageId: boolean

`Optional` messageId: number

`Optional` specificHash: number

`Optional` inserted: any[]

`Optional` updated: any[]

`Optional` deleted: any[]

`Optional` length: number

`Protected` withContext