angular/packages/core/test/render3/perf
Alex Rickabaugh 06e74a5583 refactor(core): run effects during change detection (#49641)
This commit updates the `effect` primitive and significantly changes the
timing of effect execution.

Previously, effects were scheduled via the microtask queue. This commit
changes effects to run throughout the change detection process instead.
Running effects this way avoids needing additional rounds of change
detection to resolve effects, with the tradeoff that they're harder to use
for model-to-model synchronization (which can be seen as a good thing).

PR Close #49641
2023-03-30 09:37:47 -07:00
..
class_binding refactor(core): use relative import paths in micro benchmarks (#39142) 2020-10-14 14:10:13 -07:00
directive_inputs build: update license headers to reference Google LLC (#37205) 2020-05-26 14:26:58 -04:00
directive_instantiate refactor(core): consolidate LView state from injectors (#49641) 2023-03-30 09:37:47 -07:00
duplicate_map_based_style_and_class_bindings build: update license headers to reference Google LLC (#37205) 2020-05-26 14:26:58 -04:00
duplicate_style_and_class_bindings build: update license headers to reference Google LLC (#37205) 2020-05-26 14:26:58 -04:00
element_text_create refactor(core): consolidate LView state from injectors (#49641) 2023-03-30 09:37:47 -07:00
embedded_view_injector refactor(core): change component emit to 'dependencies' (#45672) 2022-04-20 05:45:56 -07:00
host_binding build: update license headers to reference Google LLC (#37205) 2020-05-26 14:26:58 -04:00
i18n test(core): add micro benchmarks for i18n scenarios (#39142) 2020-10-14 14:10:13 -07:00
interpolation build: update license headers to reference Google LLC (#37205) 2020-05-26 14:26:58 -04:00
listeners refactor(core): consolidate LView state from injectors (#49641) 2023-03-30 09:37:47 -07:00
map_based_style_and_class_bindings build: update license headers to reference Google LLC (#37205) 2020-05-26 14:26:58 -04:00
ng_template refactor(core): consolidate LView state from injectors (#49641) 2023-03-30 09:37:47 -07:00
noop_change_detection build: update license headers to reference Google LLC (#37205) 2020-05-26 14:26:58 -04:00
property_binding build: update license headers to reference Google LLC (#37205) 2020-05-26 14:26:58 -04:00
property_binding_update build: update license headers to reference Google LLC (#37205) 2020-05-26 14:26:58 -04:00
render_stringify fix(core): not invoking object's toString when rendering to the DOM (#39843) 2020-11-30 15:49:57 -08:00
style_and_class_bindings build: update license headers to reference Google LLC (#37205) 2020-05-26 14:26:58 -04:00
style_binding build: update license headers to reference Google LLC (#37205) 2020-05-26 14:26:58 -04:00
view_destroy_hook refactor(core): consolidate LView state from injectors (#49641) 2023-03-30 09:37:47 -07:00
BUILD.bazel build: disable bazel nodejs linker to improve stability on windows (#45872) 2022-05-04 16:20:57 -07:00
micro_bench.ts build: switch all instances from ng_rollup_bundle to app_bundle (#44490) 2022-01-04 12:14:14 -08:00
noop_renderer.ts test(core): migrate tests off of Renderer3 interfaces (#46605) 2022-06-30 09:04:56 -07:00
noop_renderer_spec.ts test(core): migrate tests off of Renderer3 interfaces (#46605) 2022-06-30 09:04:56 -07:00
profile_all.js build: switch all instances from ng_rollup_bundle to app_bundle (#44490) 2022-01-04 12:14:14 -08:00
profile_in_browser.html build: switch all instances from ng_rollup_bundle to app_bundle (#44490) 2022-01-04 12:14:14 -08:00
README.md build: switch all instances from ng_rollup_bundle to app_bundle (#44490) 2022-01-04 12:14:14 -08:00
setup.ts refactor(core): run effects during change detection (#49641) 2023-03-30 09:37:47 -07:00
shared.ts build: update license headers to reference Google LLC (#37205) 2020-05-26 14:26:58 -04:00

Build

yarn bazel build //packages/core/test/render3/perf:${BENCHMARK}_lib.debug.min.js

Run

node dist/bin/packages/core/test/render3/perf/${BENCHMARK}_lib.debug.min.js

Profile

node --no-turbo-inlining --inspect-brk dist/bin/packages/core/test/render3/perf/${BENCHMARK}_lib.debug.min.js

then connect with a debugger (the --inspect-brk option will make sure that benchmark execution doesn't start until a debugger is connected and the code execution is manually resumed).

The actual benchmark code has calls that will start (console.profile) and stop (console.profileEnd) a profiling session.

Deoptigate

yarn add deoptigate
yarn deoptigate dist/bin/packages/core/test/render3/perf/${BENCHMARK}_lib.debug.min.js

Run All

To run all of the benchmarks use the profile_all.js script:

node packages/core/test/render3/perf/profile_all.js

NOTE: This command will build all of the tests, so there is no need to do so manually.

Optionally use the --write command to save the run result to a file for later comparison.

node packages/core/test/render3/perf/profile_all.js --write baseline.json

Comparing Runs

If you have saved the baseline (as described in the step above) you can use it to get change in performance like so:

node packages/core/test/render3/perf/profile_all.js --read baseline.json

The resulting output should look something like this:

┌────────────────────────────────────┬─────────┬──────┬───────────┬───────────┬───────┐
│              (index)               │  time   │ unit │ base_time │ base_unit │   %   │
├────────────────────────────────────┼─────────┼──────┼───────────┼───────────┼───────┤
│       directive_instantiate        │ 276.652 │ 'ms' │  286.292  │   'ms'    │ -3.37 │
│        element_text_create         │ 262.868 │ 'ms' │  260.031  │   'ms'    │ 1.09  │
│           interpolation            │ 257.733 │ 'us' │  260.489  │   'us'    │ -1.06 │
│             listeners              │  1.997  │ 'us' │   1.985   │   'us'    │  0.6  │
│ map_based_style_and_class_bindings │  10.07  │ 'ms' │   9.786   │   'ms'    │  2.9  │
│       noop_change_detection        │ 93.256  │ 'us' │  91.745   │   'us'    │ 1.65  │
│          property_binding          │ 290.777 │ 'us' │  280.586  │   'us'    │ 3.63  │
│      property_binding_update       │ 588.545 │ 'us' │  583.334  │   'us'    │ 0.89  │
│      style_and_class_bindings      │  1.061  │ 'ms' │   1.047   │   'ms'    │ 1.34  │
│           style_binding            │ 543.841 │ 'us' │  545.385  │   'us'    │ -0.28 │
└────────────────────────────────────┴─────────┴──────┴───────────┴───────────┴───────┘

Notes

To run the benchmark use bazel run <benchmark_target>, example:

  • yarn bazel run //packages/core/test/render3/perf:noop_change_detection

To profile, append _profile to the target name and attach a debugger via chrome://inspect, example:

  • yarn bazel run //packages/core/test/render3/perf:noop_change_detection_profile

To interactively edit/rerun benchmarks use ibazel instead of bazel.

To debug

  • Follow the directions in profile_in_browser.html OR
  • yarn bazel build //packages/core/test/render3/perf:noop_change_detection
  • node --inspect-brk bazel-out/darwin-fastbuild/bin/packages/core/test/render3/perf/noop_change_detection.debug.min.js