Network Debugger Docs

Appearance

web_socket_debugger›Classes

WebSocketDebugger ​

class WebSocketDebugger

Main class for WebSocket connection debugging.

Provides methods for configuring proxy and establishing connections.

Properties ​

hashCode no setter inherited ​

int get hashCode

The hash code for this object.

A hash code is a single integer which represents the state of the object that affects operator == comparisons.

All objects have hash codes. The default hash code implemented by Object represents only the identity of the object, the same way as the default operator == implementation only considers objects equal if they are identical (see identityHashCode).

If operator == is overridden to use the object state instead, the hash code must also be changed to represent that state, otherwise the object cannot be used in hash based data structures like the default Set and Map implementations.

Hash codes must be the same for objects that are equal to each other according to operator ==. The hash code of an object should only change if the object changes in a way that affects equality. There are no further requirements for the hash codes. They need not be consistent between executions of the same program and there are no distribution guarantees.

Objects that are not equal are allowed to have the same hash code. It is even technically allowed that all instances have the same hash code, but if clashes happen too often, it may reduce the efficiency of hash-based data structures like HashSet or HashMap.

If a subclass overrides hashCode, it should override the operator == operator as well to maintain consistency.

Inherited from Object.

Implementation
dart
external int get hashCode;

runtimeType no setter inherited ​

Type get runtimeType

A representation of the runtime type of the object.

Inherited from Object.

Implementation
dart
external Type get runtimeType;

Methods ​

noSuchMethod() inherited ​

dynamic noSuchMethod(Invocation invocation)

Invoked when a nonexistent method or property is accessed.

A dynamic member invocation can attempt to call a member which doesn't exist on the receiving object. Example:

dart
dynamic object = 1;
object.add(42); // Statically allowed, run-time error

This invalid code will invoke the noSuchMethod method of the integer 1 with an Invocation representing the .add(42) call and arguments (which then throws).

Classes can override noSuchMethod to provide custom behavior for such invalid dynamic invocations.

A class with a non-default noSuchMethod invocation can also omit implementations for members of its interface. Example:

dart
class MockList<T> implements List<T> {
  noSuchMethod(Invocation invocation) {
    log(invocation);
    super.noSuchMethod(invocation); // Will throw.
  }
}
void main() {
  MockList().add(42);
}

This code has no compile-time warnings or errors even though the MockList class has no concrete implementation of any of the List interface methods. Calls to List methods are forwarded to noSuchMethod, so this code will log an invocation similar to Invocation.method(#add, [42]) and then throw.

If a value is returned from noSuchMethod, it becomes the result of the original invocation. If the value is not of a type that can be returned by the original invocation, a type error occurs at the invocation.

The default behavior is to throw a NoSuchMethodError.

Inherited from Object.

Implementation
dart
@pragma("vm:entry-point")
@pragma("wasm:entry-point")
external dynamic noSuchMethod(Invocation invocation);

toString() inherited ​

String toString()

A string representation of this object.

Some classes have a default textual representation, often paired with a static parse function (like int.parse). These classes will provide the textual representation as their string representation.

Other classes have no meaningful textual representation that a program will care about. Such classes will typically override toString to provide useful information when inspecting the object, mainly for debugging or logging.

Inherited from Object.

Implementation
dart
external String toString();

Operators ​

operator ==() inherited ​

bool operator ==(Object other)

The equality operator.

The default behavior for all Objects is to return true if and only if this object and other are the same object.

Override this method to specify a different equality relation on a class. The overriding method must still be an equivalence relation. That is, it must be:

  • Total: It must return a boolean for all arguments. It should never throw.

  • Reflexive: For all objects o, o == o must be true.

  • Symmetric: For all objects o1 and o2, o1 == o2 and o2 == o1 must either both be true, or both be false.

  • Transitive: For all objects o1, o2, and o3, if o1 == o2 and o2 == o3 are true, then o1 == o3 must be true.

The method should also be consistent over time, so whether two objects are equal should only change if at least one of the objects was modified.

If a subclass overrides the equality operator, it should override the hashCode method as well to maintain consistency.

Inherited from Object.

Implementation
dart
external bool operator ==(Object other);

Static Methods ​

attach() ​

WebSocketProxyConfig attach({
  required String baseUrl,
  String proxyBaseUrl = 'http://localhost:9091',
  String proxyPath = '/wsproxy',
  bool? enabled,
  String? mode,
})

Configures proxy settings for WebSocket connection.

Creates the appropriate configuration based on mode (forward or reverse). If proxy is disabled or not configured, returns direct connection config.

Parameters can be passed via method arguments or environment variables:

  • SOCKET_PROXY_ENABLED - enable/disable proxy (default: enabled)
  • SOCKET_PROXY_MODE - mode: 'forward', 'reverse' or 'none'
  • SOCKET_PROXY - proxy server address
  • SOCKET_PROXY_PATH - path on proxy server for reverse mode

baseUrl - original WebSocket connection URL. proxyBaseUrl - base URL of proxy server (default: localhost:9091). proxyPath - path on proxy server for reverse mode. enabled - explicitly enable or disable proxy (if null, from env). mode - mode: 'forward', 'reverse' or 'none' (if null, from env).

Returns configuration for proxy or direct connection.

Implementation
dart
static WebSocketProxyConfig attach({
  required String baseUrl,
  String proxyBaseUrl = 'http:&#47;&#47;localhost:9091',
  String proxyPath = '&#47;wsproxy',
  bool? enabled,
  String? mode,
}) {
  final enabledEffective = enabled ?? _computeEnabledFromEnv();
  if (!enabledEffective) {
    return WebSocketProxyConfig(
      connectUrl: Uri.parse(baseUrl),
      query: const {},
      useForwardOverrides: false,
    );
  }

  final modeEffective = (mode ?? _computeMode());
  final proxy = proxyBaseUrl.isNotEmpty
      ? proxyBaseUrl
      : (_firstNonEmpty([_kDefineProxy, readEnvVar('SOCKET_PROXY')]) ?? '');
  final rawPath = proxyPath.isNotEmpty
      ? proxyPath
      : (_firstNonEmpty(
              [_kDefineProxyPath, readEnvVar('SOCKET_PROXY_PATH')]) ??
          '&#47;wsproxy');
  final path = _normalizeProxyPath(rawPath);

  _debugLog(
    '[WebSocketDebugger] mode=$modeEffective base=$baseUrl proxy=$proxy path=$path',
  );

  if (modeEffective == 'forward') {
    if (proxy.isEmpty) {
      return WebSocketProxyConfig(
        connectUrl: Uri.parse(baseUrl),
        query: const {},
        useForwardOverrides: false,
      );
    }
    final allowBad = _computeAllowBadCerts();
    final proxyHostPort = normalizeProxyHostPort(proxy);
    return forwardProxyAttach(
      baseUrl: baseUrl,
      proxyHostPort: proxyHostPort,
      allowBadCerts: allowBad,
    );
  }

  if (modeEffective == 'reverse') {
    if (proxy.isEmpty) {
      return WebSocketProxyConfig(
        connectUrl: Uri.parse(baseUrl),
        query: const {},
        useForwardOverrides: false,
      );
    }
    final proxyHttp = ensureHttpScheme(proxy);

    &#47;&#47; If baseUrl points to the proxy itself, try to get real upstream from ENV&#47;define
    var upstream = baseUrl;
    if (hostPort(proxyHttp) == hostPort(ensureHttpScheme(upstream))) {
      final envUp = _firstNonEmpty(
          [_kDefineUpstreamUrl, readEnvVar('SOCKET_UPSTREAM_URL')]);
      if (envUp != null && envUp.trim().isNotEmpty) upstream = envUp;
    }

    final explicitTarget = _firstNonEmpty(
        [_kDefineUpstreamTarget, readEnvVar('SOCKET_UPSTREAM_TARGET')]);
    final target = explicitTarget?.trim().isNotEmpty == true
        ? explicitTarget!.trim()
        : buildWsTarget(upstream);

    final uri = Uri.parse(proxyHttp);
    final wsScheme = uri.scheme == 'https' ? 'wss' : 'ws';
    final effective = uri.replace(scheme: wsScheme, path: path);
    return WebSocketProxyConfig(
      connectUrl: effective,
      query: {'_target': target},
      useForwardOverrides: false,
    );
  }

  return WebSocketProxyConfig(
    connectUrl: Uri.parse(baseUrl),
    query: const {},
    useForwardOverrides: false,
  );
}

connect() ​

Future<dynamic> connect({
  required WebSocketProxyConfig config,
  Map<String, dynamic>? headers,
})

Establishes WebSocket connection using the given configuration.

Creates a connection with all parameters from config including URL, query params and proxy settings. In dart:io environments, headers (e.g. Authorization, Cookie) are supported; on web they are ignored.

config - proxy config from attach. headers - additional HTTP headers for connection (IO only).

Returns the established WebSocket connection.

Implementation
dart
static Future<ws.WebSocket> connect({
  required WebSocketProxyConfig config,
  Map<String, dynamic>? headers,
}) async {
  &#47;&#47; Build query manually to preserve ws:&#47;&#47; scheme and avoid adding '#'
  Uri uri;
  if (config.query.isEmpty) {
    uri = config.connectUrl;
  } else {
    final merged = <String, String>{
      ...config.connectUrl.queryParameters,
      ...config.query.map((k, v) => MapEntry(k, v.toString())),
    };
    final encodedQuery = Uri(queryParameters: merged).query;
    uri = config.connectUrl.replace(query: encodedQuery, fragment: null);
  }
  &#47;&#47; In IO environment pass headers (Authorization&#47;Cookie etc.),
  &#47;&#47; on web headers are ignored at transport level
  return connectWS(uri, headers: headers);
}