flutter_flight_recorder 0.0.7

flutter_flight_recorder: ^0.0.7 copied to clipboard

• Added IncidentAnalyzer: a deterministic, offline analysis pipeline that turns an Incident's raw event timeline into a normalized IncidentTimeline, an inferred List<ReproductionStep>, and a short, evidence-based IncidentStory. New types: IncidentAnalysis, IncidentAnalyzer, IncidentTimeline, TimelineEntry, ReproductionStep, IncidentStory. See IncidentAnalyzer's class doc for exactly how event correlation works and its documented limits.
• Added IncidentMarkdownExporter: renders an Incident and its IncidentAnalysis as a single Markdown bug report — meant to be pasted directly into Jira, Linear, GitHub Issues, Slack, or email. A pure formatter over already-analyzed data (it never analyzes events itself); sections it can produce are What happened, QA report, Reproduction steps, Technical evidence, Network, Errors, Environment, and Incident metadata, each omitted entirely when there's nothing to show for it. Deterministic, no new dependency.
• Added FlightEvent.correlationId: an optional, opaque token an application can explicitly attach to two or more events (via a new correlationId parameter on recordAction, log, recordError, recordNavigation, recordNetwork, and recordLifecycle) to declare they belong to the same interaction — states association, never causation. IncidentAnalyzer now prefers this explicit grouping when two or more surviving events share a usable id, falling back to its original chronological heuristic for everything else — fully backward compatible; every event recorded without a correlationId behaves exactly as before. Added FlightRecorder.newCorrelationId() to generate one. No Zones, no ambient/automatic propagation yet — see IncidentAnalyzer's class doc for exactly how the two strategies interact.

Docs-only patch — no changes to lib/ or test/.

• Added the shake-to-report-demo GIF to this README (with a caption noting it demonstrates the optional flutter_flight_recorder_reporter package, not this core package alone).
• Fixed stale ^0.0.3 install-instruction version pins in this README and the repo-root WALKTHROUGH.md — they hadn't tracked the last few version bumps.

Fix: the logo in the README used a relative path (docs/images/...), which renders fine on GitHub but not on pub.flutter-io.cn, which serves the README disconnected from the repo's file structure. Switched to absolute raw.githubusercontent.com URLs.

Added package logo.

Docs/example-only patch — no changes to any public API or behavior.

• Added dartdoc comments to FlightEvent's constructor, category, severity, timestamp, and toJson, closing a pub.flutter-io.cn score gap (missing documentation on public members).
• Added example/ (a minimal, runnable app showing this package in isolation — FlightRecorder.init(), recordAction/log, and createIncident()), required by pub.flutter-io.cn's scorer at this package's own path, separate from the repo-root example app that demonstrates all three packages together.

Documentation updates only — no changes to lib/ or test/. README overhaul (pub.flutter-io.cn badges, published-package status, simplified installation instructions), a new root-level WALKTHROUGH.md, and the dio/reporter packages switching their dependency on this package from a path dependency to the published, hosted version.

Work in progress — not yet published to pub.flutter-io.cn.

• Event model: FlightEvent, EventCategory, EventSeverity.
• FlightRecorder: init, recordAction, log, recordError, setContext, recordNavigation, recordLifecycle, recordNetwork (used by flutter_flight_recorder_dio).
• Bounded rolling buffer (FlightRecorderConfig.maxEvents, default 500), backed by a ListQueue for O(1) add/evict.
• Privacy sanitization: default sensitive-key masking (nested), custom sanitizers, JSON-safety normalization of metadata. Full detail in docs/privacy.md.
• Application context capture (platform, locale) plus custom context via setContext.
• Incident system: FlightRecorder.createIncident, immutable Incident snapshots, QaReportData/IncidentSeverity, versioned toJson export (schema_version: 1).
• Automatic uncaught-error capture (FlutterError.onError + PlatformDispatcher.onError, always chained to any existing handler).
• FlightRecorderNavigatorObserver: Navigator 1.x push/pop/replace/remove recording, route names only.
• FlightRecorderLifecycleObserver: app lifecycle transition recording.
• Fix: defaultSensitiveKeys is now actually exported from the public barrel — it was documented (and used as a config default) but not reachable from package:flutter_flight_recorder/flutter_flight_recorder.dart before this. Found while building the Dio package, which needed it.
• Fix: createIncident is confirmed and tested to work (with an empty timeline) when called on a session started with enabled: false — corrected FlightRecorderConfig.enabled's doc comment, which had described a scenario (an incident capturing events recorded before a live session was disabled) that the API doesn't actually support, since enabled is fixed per session and can only change via a fresh init() call, which resets the buffer. Found during a test-suite audit.
• Fix: QaReportData's doc comment no longer describes the reporter UI as not yet built — it exists, in flutter_flight_recorder_reporter.

Not implemented, and not currently planned: Navigator 2.0 / go_router / auto_route support, content-aware (as opposed to key-name) privacy sanitization. Network recording, the QA reporter UI, and HTML/JSON sharing live in the separate flutter_flight_recorder_dio and flutter_flight_recorder_reporter packages, not here.