{"id":13547984,"url":"https://github.com/VeryGoodOpenSource/very_good_performance","last_synced_at":"2025-04-02T20:31:20.879Z","repository":{"id":41147110,"uuid":"368974387","full_name":"VeryGoodOpenSource/very_good_performance","owner":"VeryGoodOpenSource","description":"Utility on top of the Flutter Driver API that facilitates measuring the performance of your app in an automated way created by Very Good Ventures 🦄","archived":true,"fork":false,"pushed_at":"2023-01-10T18:04:35.000Z","size":921,"stargazers_count":80,"open_issues_count":0,"forks_count":9,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-03-06T20:04:16.550Z","etag":null,"topics":["automation","dart","e2e","flutter","performance","test"],"latest_commit_sha":null,"homepage":"https://pub.dev/packages/very_good_performance","language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/VeryGoodOpenSource.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null}},"created_at":"2021-05-19T19:03:35.000Z","updated_at":"2024-10-01T12:25:57.000Z","dependencies_parsed_at":"2023-02-08T19:45:46.846Z","dependency_job_id":null,"html_url":"https://github.com/VeryGoodOpenSource/very_good_performance","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VeryGoodOpenSource%2Fvery_good_performance","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VeryGoodOpenSource%2Fvery_good_performance/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VeryGoodOpenSource%2Fvery_good_performance/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VeryGoodOpenSource%2Fvery_good_performance/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/VeryGoodOpenSource","download_url":"https://codeload.github.com/VeryGoodOpenSource/very_good_performance/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246887987,"owners_count":20850179,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["automation","dart","e2e","flutter","performance","test"],"created_at":"2024-08-01T12:01:04.176Z","updated_at":"2025-04-02T20:31:15.865Z","avatar_url":"https://github.com/VeryGoodOpenSource.png","language":"C++","funding_links":[],"categories":["C++"],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\u003cb\u003e⚠️ Attention: This repository has been archived and is now read-only!\u003c/b\u003e\u003c/p\u003e\n\n# Very Good Performance\n\n[![Very Good Ventures][logo_white]][very_good_ventures_link_dark]\n[![Very Good Ventures][logo_black]][very_good_ventures_link_light]\n\nDeveloped with 💙 by [Very Good Ventures][very_good_ventures_link] 🦄\n\n[![ci][ci_badge]][ci_link]\n[![coverage][coverage_badge]][ci_link]\n[![pub package][pub_badge]][pub_link]\n[![License: MIT][license_badge]][license_link]\n[![style: very good analysis][very_good_analysis_badge]][very_good_analysis_badge_link]\n\n---\n\nUtility on top of the [Flutter Driver API](https://api.flutter.dev/flutter/flutter_driver/flutter_driver-library.html) that facilitates measuring the performance of your app in an automated way\n\n## Usage\n\n#### `very_good_performance.yaml`\n\nAdd a new file at root of your project named `very_good_performance.yaml` with the following fields.\n\nYou can modify these values to match your own performance expectations.\n\n```yaml\nperformance_report:\n  directory: performance/reports\nintegration_test_expectations:\n  should_fail_build_on_warning: true\n  should_fail_build_on_error: true\nperformance_metrics:\n  missed_frames_threshold:\n    warning: 5\n    error: 10\n  average_frame_build_rate_threshold:\n    warning_time_in_milliseconds: 14.0\n    error_time_in_milliseconds: 16.0\n  worst_frame_build_rate_threshold:\n    warning_time_in_milliseconds: 14.0\n    error_time_in_milliseconds: 16.0\n```\n\n#### Running tests with `FlutterDriver`\n\nSimply wrap your `FlutterDriver` tests with the method `capturePerformanceReport` to start collecting performance information\n\n```dart\ntest('tapping on the Increment button updates the counter', () async {\n  await driver.capturePerformanceReport(\n    reportName: 'counter_performance',\n    action: () async {\n      await driver.tap(find.byType(FloatingActionButton));\n      expect(await driver.getText(find.text('1')), '1');\n      await driver.tap(find.byType(FloatingActionButton));\n      expect(await driver.getText(find.text('2')), '2');\n    },\n  );\n});\n```\n\nAt the end of the execution, you will see a similar report to this one:\n\n![Performance Report](https://github.com/VeryGoodOpenSource/very_good_performance/raw/main/assets/performance_report.png)\n\n#### Running the example project\n\nYou can find an `example` project that showcases how to use this library.\n\n```bash\n$\u003e cd example\n$\u003e flutter drive --target=e2e/e2e.dart --driver=e2e/counter_test.dart -d macos --profile\n```\n\nYou should see the Counter app running and, at the end of the execution, it will print the performance overview in the console, and will generate the performance reports under `e2e/performance/reports`.\n\n[ci_badge]: https://github.com/VeryGoodOpenSource/very_good_performance/workflows/ci/badge.svg\n[ci_link]: https://github.com/VeryGoodOpenSource/very_good_performance/actions\n[coverage_badge]: https://raw.githubusercontent.com/VeryGoodOpenSource/very_good_performance/main/coverage_badge.svg\n[license_badge]: https://img.shields.io/badge/license-MIT-blue.svg\n[license_link]: https://opensource.org/licenses/MIT\n[logo_black]: https://raw.githubusercontent.com/VGVentures/very_good_brand/main/styles/README/vgv_logo_black.png#gh-light-mode-only\n[logo_white]: https://raw.githubusercontent.com/VGVentures/very_good_brand/main/styles/README/vgv_logo_white.png#gh-dark-mode-only\n[pub_badge]: https://img.shields.io/pub/v/very_good_performance.svg\n[pub_link]: https://pub.dartlang.org/packages/very_good_performance\n[very_good_analysis_badge]: https://img.shields.io/badge/style-very_good_analysis-B22C89.svg\n[very_good_analysis_badge_link]: https://pub.dev/packages/very_good_analysis\n[very_good_ventures_link]: https://verygood.ventures\n[very_good_ventures_link_dark]: https://verygood.ventures#gh-dark-mode-only\n[very_good_ventures_link_light]: https://verygood.ventures#gh-light-mode-only\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FVeryGoodOpenSource%2Fvery_good_performance","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FVeryGoodOpenSource%2Fvery_good_performance","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FVeryGoodOpenSource%2Fvery_good_performance/lists"}