flutter_blackbox 0.6.0

All-in-one in-app debug overlay for Flutter. Network inspector, API mocking, live logs, FPS monitor, rebuild tracker, storage inspector, crash reports, and QA tools.

Flutter BlackBox 🐞

An all-in-one in-app debug & QA overlay for Flutter — network inspector, API mocking, live logs, FPS monitor, rebuild tracker, storage inspector, crash reports, and QA tools. Zero runtime cost in release builds. Zero optional dependencies — the CLI generates only the adapters you need.

         

---

🚀 Features

Panel	Description
🌐 Network	Real-time HTTP/Dio interception. Headers, payloads, status codes, timing bars, cURL export, HAR export. Swipe to dismiss individual entries.
🎛 Mocking	Intercept and replace API calls with local JSON responses. Simulate slow networks with throttle slider.
📋 Logs	Auto-captures debugPrint/print. Manual logging with levels and tags. Swipe to dismiss, color-coded accent borders.
⚡ Performance	Live FPS graph, jank detection, frame budget visualization.
🔄 Rebuilds	Track widget rebuild counts — auto-detect ALL rebuilds or wrap specific widgets. Pull-to-refresh resets counts.
💾 Storage	Inspect, search, edit, and delete key-value pairs. Sensitive data auto-redacted. Supports SharedPreferences, GetStorage, Hive, etc.
🔌 Socket IO	Auto-capture all incoming Socket.IO events. Zero code changes.
📱 Device	Platform, screen metrics, pixel ratio, text scale — in glassmorphic cards.
🐛 Crashes	Auto-catches framework errors, async exceptions, and unhandled crashes.
🗺️ Journey	Route changes and interactions logged to reconstruct steps before a crash.
📝 QA Reports	One-tap Markdown reports with screenshot, device info, journey, network logs, and stack traces.
📊 Mini HUD	Drag the floating button to the bottom edge for a persistent live HUD (FPS, HTTP status, crash count).

---

📦 Installation

dependencies:
  flutter_blackbox: ^0.6.0

---

🛠 Quick Start

Core features work with zero adapters — just wrap your app:

import 'package:flutter/foundation.dart';
import 'package:flutter_blackbox/flutter_blackbox.dart';

void main() {
  BlackBox.setup(
    trigger: const BlackBoxTrigger.floatingButton(),
    enabled: kDebugMode,
  );
  runApp(const BlackBoxOverlay(child: MyApp()));
}

This gives you: logs, crashes, FPS, rebuilds, device info, and QA reports out of the box.

---

🤖 Auto-Setup CLI

BlackBox ships with a CLI that reads your pubspec.yaml and generates adapter code for your specific dependencies:

# Generate adapters (Dio, http, Socket.IO, SharedPreferences — only what you use)
dart run flutter_blackbox:init --generate

This creates lib/blackbox_adapters.dart. Then use it:

import 'package:flutter_blackbox/flutter_blackbox.dart';
import 'blackbox_adapters.dart'; // ← generated

final dio = Dio();

void main() {
  BlackBox.setup(
    httpAdapters: [DioBlackBoxAdapter(dio)],
    storageAdapters: [SharedPrefsStorageAdapter()],
    logAdapter: PrintLogAdapter(),
    trigger: const BlackBoxTrigger.floatingButton(),
    enabled: kDebugMode,
  );
  runApp(const BlackBoxOverlay(child: MyApp()));
}

💡 Re-run --generate any time you add a new library.

---

🌐 Network Adapters

// Dio
BlackBox.setup(httpAdapters: [DioBlackBoxAdapter(dio)]);

// http package
final adapter = HttpBlackBoxAdapter();
BlackBox.setup(httpAdapters: [adapter]);
final response = await adapter.client.get(Uri.parse('https://api.example.com'));

BlackBox observes your calls silently — zero changes to your API code.

---

📡 External Observers (Crashlytics / Sentry)

Forward crashes and network errors to external monitoring tools:

class CrashlyticsObserver extends BlackBoxObserver {
  @override
  void onCrash(CrashEntry crash) {
    FirebaseCrashlytics.instance.recordError(crash.message, crash.stackTrace);
  }
}

BlackBox.setup(observers: [CrashlyticsObserver()]);

---

💾 Custom Storage Adapters

Implement BlackBoxStorageAdapter for any key-value store:

class GetStorageAdapter extends BlackBoxStorageAdapter {
  final GetStorage _box;
  GetStorageAdapter(this._box);

  @override String get name => 'GetStorage';
  @override Future<Map<String, dynamic>> readAll() async => _box.getValues();
  @override Future<void> write(String key, dynamic value) async => _box.write(key, value);
  @override Future<void> delete(String key) async => _box.remove(key);
  @override Future<void> clear() async => _box.erase();
}

Sensitive keys (password, token, secret, jwt, etc.) are auto-redacted by default.

---

🔄 Widget Rebuild Tracker

// Automatic — toggle "AUTO ON" in the Rebuilds panel, or:
BlackBox.startRebuildTracking();

// Manual — wrap specific widgets:
RebuildTracker(label: 'ProductCard', child: ProductCard())

---

🎛 API Mocking

BlackBox.mock(
  pattern: '/api/v1/user/profile',
  method: 'GET',
  response: MockResponse(statusCode: 200, body: {'name': 'Alice'}),
);

---

🎮 Panel Triggers

BlackBox.setup(
  trigger: BlackBoxTrigger.floatingButton(),  // Floating button (default)
  // trigger: BlackBoxTrigger.shake(),         // Shake device
  // trigger: BlackBoxTrigger.hotkey(LogicalKeyboardKey.f12), // Desktop F12
);

---

✨ What's New in 0.6.0

• Mini HUD Mode — drag the floating button to the bottom edge for a persistent live status bar
• Swipe-to-Dismiss — swipe left-to-right on network/log entries to delete them
• Scroll-to-Top — floating arrow button after scrolling, one-tap to jump back
• Pull-to-Refresh — pull down on any list panel to refresh or reset data
• Haptic Feedback — tab switches, swipe actions, and pull-to-refresh provide tactile feedback
• Glassmorphic UI — frosted-glass panels with gradient shines, blur effects, and accent borders
• Left Accent Borders — color-coded left borders on network and log rows for instant status scanning
• Performance Boost — implicit animations, cacheExtent pre-building, TickerMode for inactive tabs
• HAR Export — copy all network requests as HAR 1.2 JSON for Postman/Chrome DevTools
• Isolate JSON Parsing — large response bodies parsed off the main thread

See CHANGELOG.md for full details.

---

📄 License

MIT.