perf: add cloud scenario benchmark results#339
Merged
Conversation
Contributor
Dependency Review✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.Scanned FilesNone |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR expands PatternKit’s BenchmarkDotNet “cloud architecture patterns” coverage by adding dedicated scenario benchmark classes for Ambassador, Cache-Aside, and Retry, publishing the latest measured results in the README/docs, and enforcing documentation drift checks so scenario timing rows stay in sync with benchmark classes.
Changes:
- Added dedicated BenchmarkDotNet scenario benchmarks for Ambassador, Cache-Aside, and Retry (fluent vs generated; construction vs execution).
- Published the new scenario timing rows across
README.md,docs/guides/benchmarks.md, anddocs/guides/benchmark-results.md. - Added a TinyBDD coverage test to require that every dedicated
*Benchmarks.csscenario class has published Construction and Execution rows inbenchmark-results.md.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| test/PatternKit.Examples.Tests/ProductionReadiness/PatternKitBenchmarkCoverageTests.cs | Adds a docs drift check ensuring each dedicated scenario benchmark has published Construction/Execution timing rows. |
| benchmarks/PatternKit.Benchmarks/Cloud/AmbassadorBenchmarks.cs | Introduces Ambassador scenario benchmarks (construction + invocation) with fluent vs generated categories. |
| benchmarks/PatternKit.Benchmarks/Cloud/CacheAsideBenchmarks.cs | Introduces Cache-Aside scenario benchmarks (policy creation + miss-then-hit workflow) with fluent vs generated categories. |
| benchmarks/PatternKit.Benchmarks/Cloud/RetryBenchmarks.cs | Introduces Retry scenario benchmarks (policy creation + transient retry workflow) with fluent vs generated categories. |
| docs/guides/benchmark-results.md | Publishes the expanded scenario timing table (Ambassador/Cache-Aside/Retry added). |
| docs/guides/benchmarks.md | Updates the “Latest Snapshot” table to include the new scenario timings. |
| README.md | Updates the benchmark snapshot table to include the new scenario timings. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+26
to
+31
| var service = new ProductCatalogCacheAsideService( | ||
| new ScriptedProductCatalogRepository(ActiveProduct), | ||
| ProductCatalogCacheAsidePolicies.CreateFluentPolicy()); | ||
|
|
||
| _ = await service.FindAsync("SKU-42"); | ||
| return await service.FindAsync("SKU-42"); |
Comment on lines
+27
to
+32
| var service = new InventoryLookupService( | ||
| new ScriptedInventoryClient(Transient, Available), | ||
| InventoryRetryPolicies.CreateFluentPolicy()); | ||
|
|
||
| return service.CheckAsync("SKU-42"); | ||
| } |
Contributor
Test Results 1 files 1 suites 2m 34s ⏱️ Results for commit f63f82a. |
Contributor
Code Coverage |
Contributor
🔍 PR Validation ResultsVersion: `` ✅ Validation Steps
📊 ArtifactsDry-run artifacts have been uploaded and will be available for 7 days. This comment was automatically generated by the PR validation workflow. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #339 +/- ##
==========================================
+ Coverage 89.65% 95.64% +5.99%
==========================================
Files 486 486
Lines 40002 40002
Branches 5756 5756
==========================================
+ Hits 35864 38261 +2397
+ Misses 1877 1741 -136
+ Partials 2261 0 -2261
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
JerrettDavis
changed the title
JerrettDavis
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Validation
Refs #328