Class: SessionExpiredError

Defined in: src/provider-contract/sessionExpired.ts:22

SessionExpiredError — a remote session that is gone, said ONE way.

A managed backend reaps its sessions on its own schedule (a timeout, a stop, a restart), and each service words that differently: AgentCore's Code Interpreter answers with a ValidationException saying the session is "not active", a stream error naming an inactive session, or a ResourceNotFoundException on a call that addresses nothing but the session. A caller that has to recognise all of those by message text will miss the next one. An adapter recognises them once and raises this instead, so "start a new session" is one instanceof away.

Raised only on evidence that names the session. A "not found" that could be about something else in the session (a file a read asked for) is not taken as proof the session is gone.

It names the session and the signal that said so — never the request that hit it. Nothing reconnects: the session's files and state are gone, and a session name is not an address (names are not unique), so the only honest next step is a new session.

Extends

Error

Constructors

Constructor

new SessionExpiredError(backend, sessionId, evidence): SessionExpiredError

Defined in: src/provider-contract/sessionExpired.ts:31

Parameters

backend

string

sessionId

string

evidence

string

Returns

SessionExpiredError

Overrides

Error.constructor

Properties

backend

readonly backend: string

Defined in: src/provider-contract/sessionExpired.ts:25

The adapter that raised it, e.g. 'agentCoreCodeRunner'.

cause?

optional cause?: unknown

Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:24

Inherited from

Error.cause

code

readonly code: "ERR_SESSION_EXPIRED"

Defined in: src/provider-contract/sessionExpired.ts:23

evidence

readonly evidence: string

Defined in: src/provider-contract/sessionExpired.ts:29

The service's own name for the signal that said so, e.g. 'ResourceNotFoundException'.

message

message: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

Error.message

name

name: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

Error.name

sessionId

readonly sessionId: string

Defined in: src/provider-contract/sessionExpired.ts:27

The backend's id for the session that is gone.

stack?

optional stack?: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

Error.stack

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/@types/node/globals.d.ts:67

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

Error.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/@types/node/globals.d.ts:51

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/@types/node/globals.d.ts:55

SessionExpiredError

On this page