NetworkDebugger

class NetworkDebugger

Main entry point for launching the network debugger.

Constructors

NetworkDebugger()

NetworkDebugger()

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

clearCache()

Future<void> clearCache({String? version})

Clears the cache.

If version is specified, only that version is cleared. Otherwise, all cached versions are cleared.

Implementation

dart

static Future<void> clearCache({String? version}) async {
  if (version != null) {
    await BinaryCache.clearVersion(version);
  } else {
    await BinaryCache.clearAll();
  }
}

getCacheDirectory()

Future<String> getCacheDirectory()

Gets the cache directory path.

Implementation

dart

static Future<String> getCacheDirectory() async {
  return BinaryCache.getCacheDir();
}

getCacheSize()

Future<int> getCacheSize()

Gets the total size of the cache in bytes.

Implementation

dart

static Future<int> getCacheSize() async {
  return BinaryCache.getCacheSize();
}

getCacheSizeFormatted()

Future<String> getCacheSizeFormatted()

Gets a human-readable string of the cache size.

Implementation

dart

static Future<String> getCacheSizeFormatted() async {
  final size = await getCacheSize();
  return BinaryCache.formatBytes(size);
}

getPlatformInfo()

String getPlatformInfo()

Gets platform information.

Implementation

dart

static String getPlatformInfo() {
  return PlatformDetector.getPlatformDescription();
}

launch()

Future<DebuggerInstance> launch({
  String? version,
  int port = 9092,
  bool autoOpenBrowser = true,
  bool showDebuggerProcessLogs = false,
  (void Function(int received, int total))? onProgress,
  (void Function(int attempt, Exception error))? onRetry,
  (void Function(bool validated, String? checksum))? onChecksum,
  bool skipChecksumValidation = false,
  String? githubToken,
  String owner = _defaultOwner,
  String repo = _defaultRepo,
  Map<String, String>? environment,
})

Launches the network debugger.

version: Specific version to use (e.g., 'v1.0.0'). If null, uses latest release.
port: Port to run the UI/REST on (default: 9092). Forward proxy runs on 9091.
autoOpenBrowser: Whether to automatically open browser (default: true).
onProgress: Optional callback for download progress.
onRetry: Optional callback for retry attempts.
onChecksum: Optional callback for checksum validation.
skipChecksumValidation: Skip SHA256 checksum validation (NOT RECOMMENDED, default: false).
owner: GitHub repository owner (default: 'cherrypick-agency').
repo: GitHub repository name (default: 'flutter_network_debugger').
environment: Additional environment variables to pass to the process.

Returns a DebuggerInstance that can be used to manage the process.

Throws:

UnsupportedError if the platform is not supported.
GitHubReleaseException if fetching release information fails.
DownloadException if downloading or extracting fails.
ChecksumValidationException if checksum validation fails.
ProcessException if starting the process fails.

Implementation

dart

static Future<DebuggerInstance> launch({
  String? version,
  int port = 9092,
  bool autoOpenBrowser = true,
  bool showDebuggerProcessLogs = false,
  ProgressCallback? onProgress,
  RetryCallback? onRetry,
  ChecksumCallback? onChecksum,
  bool skipChecksumValidation = false,
  String? githubToken,
  String owner = _defaultOwner,
  String repo = _defaultRepo,
  Map<String, String>? environment,
}) async {
  final logger = Logger('NetworkDebugger');

  try {
    logger.info('Launching network debugger on port $port');
    logger.debug('Platform: ${PlatformDetector.getPlatformDescription()}');

    &#47;&#47; Check platform support
    if (!PlatformDetector.isSupported()) {
      logger.error('Platform not supported: ${Platform.operatingSystem}');
      throw UnsupportedError(
        'Platform not supported: ${Platform.operatingSystem}',
      );
    }

    final binaryName = PlatformDetector.getBinaryName(
      binaryBaseName: _binaryBaseName,
    );

    &#47;&#47; Determine version to use
    final token =
        (githubToken ?? Platform.environment['GITHUB_TOKEN'])?.trim();
    final githubClient =
        GitHubRelease(owner: owner, repo: repo, token: token);
    logger.debug('Fetching release information...');
    final release = version == null
        ? await githubClient.getLatestRelease()
        : await githubClient.getRelease(version);

    final versionTag = release.tagName;
    logger.info('Using version: $versionTag');

    &#47;&#47; Check cache first
    logger.debug('Checking cache for version $versionTag...');
    var binaryPath = await BinaryCache.getBinaryPath(versionTag, binaryName);

    if (binaryPath != null) {
      logger.debug('Found cached binary: $binaryPath');
      &#47;&#47; Validate cached binary
      if (await BinaryCache.validateBinary(binaryPath)) {
        logger.info('Using cached binary (validated)');
        &#47;&#47; Binary found in cache and valid
        if (onProgress != null) {
          onProgress(1, 1); &#47;&#47; Report 100% since we're using cache
        }
      } else {
        logger.warning('Cached binary invalid, will re-download');
        &#47;&#47; Invalid binary, download fresh
        binaryPath = null;
      }
    }

    &#47;&#47; Download if not in cache
    if (binaryPath == null) {
      logger.info('Binary not in cache, downloading...');
      final archiveName = PlatformDetector.getArchiveName(
        binaryBaseName: _binaryBaseName,
      );

      final downloadUrl = githubClient.findAssetUrl(release, archiveName);
      if (downloadUrl == null) {
        throw DownloadException(
          'Asset not found for platform: $archiveName',
        );
      }

      &#47;&#47; Get all asset URLs for checksum validation
      final allAssetUrls = githubClient.getAllAssetUrls(release);

      final cacheDir = await BinaryCache.ensureVersionCacheDir(versionTag);
      final downloader = BinaryDownloader();

      binaryPath = await downloader.downloadAndExtract(
        downloadUrl,
        cacheDir,
        expectedBinaryName: binaryName,
        onProgress: onProgress,
        onRetry: onRetry,
        onChecksum: onChecksum,
        availableAssetUrls: allAssetUrls,
        skipChecksumValidation: skipChecksumValidation,
      );
    }

    &#47;&#47; Launch the process
    logger.info('Starting debugger process...');
    logger.debug('Binary path: $binaryPath');

    final process = DebuggerProcess(
      binaryPath: binaryPath,
      port: port,
      autoOpenBrowser: autoOpenBrowser,
      environment: environment,
    );

    await process.start(
      onStdoutLine: showDebuggerProcessLogs ? stdout.writeln : null,
      onStderrLine: showDebuggerProcessLogs ? stderr.writeln : null,
    );

    final instance = DebuggerInstance(process);

    &#47;&#47; Wait for the debugger to be ready
    logger.debug('Waiting for debugger to be ready...');
    final isReady = await instance.waitUntilReady();
    if (!isReady) {
      logger.error('Debugger failed to become ready');
      await instance.stop();
      throw ProcessException(
        'Debugger failed to become ready within timeout',
      );
    }

    logger.info(
      'Network debugger started successfully on http:&#47;&#47;localhost:$port',
    );
    return instance;
  } catch (e) {
    logger.error('Failed to launch debugger', e);
    &#47;&#47; Format error with user-friendly message
    final formattedError = ErrorFormatter.format(e);
    throw Exception(formattedError);
  }
}

listCachedVersions()

Future<List<String>> listCachedVersions()

Lists all cached versions.

Implementation

dart

static Future<List<String>> listCachedVersions() async {
  return BinaryCache.listVersions();
}

NetworkDebugger ​

Constructors ​