Skip to content

Latest commit

 

History

History
165 lines (121 loc) · 6.48 KB

README.md

File metadata and controls

165 lines (121 loc) · 6.48 KB

SVG Optimizer Benchmark

This document provides instructions on how to use the svg_optimizer_benchmark tool to evaluate the performance impact of the svg_optimizer package on Flutter projects of varying sizes.

Overview

The benchmark utility is designed to measure the effectiveness of the svg_optimizer package by comparing the size of output files generated by the flutter build command, with and without the optimization package applied. This comparison helps in understanding the impact of SVG optimization on the overall project size.

Project Categories

  • Small Project: Consists of 10 SVG files located in the assets/benchmark_svg/small_project directory.
  • Medium Project: Comprises 100 SVG files from the assets/benchmark_svg/medium_project directory, in addition to the files in the small project category.
  • Big Project: Includes 400 SVG files from the assets/benchmark_svg/big_project directory, along with the files from both the small and medium project categories.

Prerequisites

Before running the benchmark, ensure that:

  • The flutter command-line tool is installed and accessible in your environment.
  • The svg_optimizer package is correctly configured in your project's pubspec.yaml file.

Running the Benchmark

To execute the benchmark, navigate to the svg_optimizer/benchmark directory and run the following commands based on your target platform:

  • For Android (App Bundle):

    dart run svg_optimizer_benchmark.dart --android

  • For iOS (IPA):

    dart run svg_optimizer_benchmark.dart --ios

The benchmark tool will automatically modify the pubspec.yaml file to include or exclude the svg_optimizer package, execute the flutter build command for each project category, and log the size of the output files for comparison.

Example Output

*** Benchmarking small project... ***

Building without svg_optimizer...
Building with svg_optimizer...

Small project benchmark result:
Build size without svg_optimizer: 18.98 MB
Build size with svg_optimizer: 18.88 MB
Optimized build size is 102.63 KB smaller (0.53%)

*** Benchmarking medium project... ***

Building without svg_optimizer...
Building with svg_optimizer...

Medium project benchmark result:
Build size without svg_optimizer: 20.55 MB
Build size with svg_optimizer: 19.65 MB
Optimized build size is 915.68 KB smaller (4.35%)

*** Benchmarking big project... ***

Building without svg_optimizer...
Building with svg_optimizer...

Big project benchmark result:
Build size without svg_optimizer: 29.49 MB
Build size with svg_optimizer: 24.00 MB
Optimized build size is 5.49 MB smaller (18.60%)

Sources

Benchmarking on-screen loading times of SVGs

This section outlines the process for benchmarking the on-screen loading times of SVG files using the svg_optimizer package. The goal is to measure the performance improvement in loading times when SVGs are optimized.

Overview

The benchmarking process involves using the flutter_driver package to automate the loading of SVG files on-screen and measuring the time taken for them to render. This method provides a quantitative measure of the performance benefits gained from optimizing SVG files with the svg_optimizer package.

Steps for benchmarking

To run benchmark tests for on-screen loading times, follow these steps:

  • Include benchmark assets in pubspec.yaml:

    • Add the following lines to the pubspec.yaml file to include the benchmark SVG files WITHOUT svg_optimizer package and measure loading time of unoptimized SVGs:

      assets:
  - path: assets/benchmark_svg/big_project/
  - path: assets/benchmark_svg/medium_project/
  - path: assets/benchmark_svg/small_project/

    • Add the following lines to the pubspec.yaml file to include the benchmark SVG files WITH svg_optimizer package and measure loading time of optimized SVGs:

      assets:
  - path: assets/benchmark_svg/big_project/
    transformers:
      - package: svg_optimizer
  - path: assets/benchmark_svg/medium_project/
    transformers:
      - package: svg_optimizer
  - path: assets/benchmark_svg/small_project/
    transformers:
      - package: svg_optimizer

  • Navigate to the svg_optimizer/example directory.

  • Run the following command to start the benchmark tests:

    flutter drive --driver=test/test_driver/perf_driver.dart --target=test/benchmark_svg_loading_test.dart --no-dds --profile

Upon completion, the test results are saved in the example/build directory. Two files, loading_svgs.timeline.json and loading_svgs.timeline_summary.json, contain detailed metrics on the rendering times.

Use the Chrome browser's tracing tools available at chrome://tracing to open and analyze the loading_svgs.timeline.json file. This tool provides a visual representation of the rendering times, allowing for an in-depth analysis of the performance impact.

Results

This section documents the results of benchmarking tests conducted to evaluate the performance improvement in on-screen loading times of SVG files after optimization with the svg_optimizer package. The tests demonstrated a significant reduction in rendering times, highlighting the efficiency of SVG optimization in real-world application scenarios.

Key Points:

  • The benchmarking was performed on an example application that utilizes the svg_optimizer package.
  • A comprehensive test covering all SVG files included in the project was conducted.
  • The results indicated a notable improvement, with a ~30% reduction in the time required to render SVGs on-screen.
  • The testing device used for this benchmark was an iPhone 15 Plus.