Skip to content

[O2B-1450] Update SYNTHETIC run definition#1913

Merged
graduta merged 2 commits into
mainfrom
improv/O2B-1450/update-synthetic-run-definition
Jun 24, 2025
Merged

[O2B-1450] Update SYNTHETIC run definition#1913
graduta merged 2 commits into
mainfrom
improv/O2B-1450/update-synthetic-run-definition

Conversation

@graduta

@graduta graduta commented Jun 24, 2025

Copy link
Copy Markdown
Member

I have a JIRA ticket

  • branch and/or PR name(s) include(s) JIRA ID
  • issue has "Fix version" assigned
  • issue "Status" is set to "In review"
  • PR labels are selected

Notable changes for users:

  • Run Definition of SYNTHETIC drops the check on readout_cfg_uri (as this is now consul config and not file) and adds run_type match criteria for SYNTHETIC or REPLAY

Notable changes for developers:

Changes made to the database:

@graduta graduta requested a review from Copilot June 24, 2025 08:22
@graduta graduta self-assigned this Jun 24, 2025
@graduta graduta requested a review from martinboulais as a code owner June 24, 2025 08:22

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR updates the SYNTHETIC run definition to no longer rely on readout_cfg_uri and instead match on run_type.name (SYNTHETIC or REPLAY). It adjusts fixtures, tests, core logic, and documentation accordingly.

  • Replace PP/PBPB fixtures with REPLAY/SYNTHETIC and remove readoutCfgUri
  • Update tests to expect the new subkeys and logic
  • Modify getRunDefinition to use runType.name regex instead of URI checks
  • Revise docs to describe the new run definition criteria

Reviewed Changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
test/mocks/mock-run.js Updated SYNTHETIC fixtures: removed URI and renamed keys
test/lib/server/services/run/getRunDefinition.test.js Adjusted expectations to use SYNTHETIC.REPLAY and .SYNTHETIC
test/lib/server/services/run/RunService.test.js Updated creation test to use SYNTHETIC.SYNTHETIC
lib/server/services/run/getRunDefinition.js Removed URI check and switched to runType.name regex
docs/RUN_DEFINITIONS.md Updated SYNTHETIC section; added run_type criteria and retained historical definitions
Comments suppressed due to low confidence (3)

test/mocks/mock-run.js:173

  • [nitpick] The nested object under SYNTHETIC.REPLAY and SYNTHETIC.SYNTHETIC may be confusing. Consider adding a comment or using more descriptive keys to clarify the relationship between the top-level SYNTHETIC fixture and its subtypes.
        REPLAY: {

test/lib/server/services/run/getRunDefinition.test.js:42

  • These tests cover uppercase REPLAY and SYNTHETIC. Add cases with mixed or lowercase runType.name values to ensure the regex matching remains truly case-insensitive.
        expect(getRunDefinition(SYNTHETIC.REPLAY)).to.equal(RunDefinition.SYNTHETIC);

docs/RUN_DEFINITIONS.md:60

  • The 'Previous RUN Definitions' section still shows the old readout_cfg_uri criteria without marking it as deprecated, which could confuse readers. Consider clearly labeling it as historical or removing it altogether.
## Previous RUN Definitions

Comment thread lib/server/services/run/getRunDefinition.js Outdated
@codecov

codecov Bot commented Jun 24, 2025

Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 40.89%. Comparing base (b39541c) to head (247424f).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1913   +/-   ##
=======================================
  Coverage   40.89%   40.89%           
=======================================
  Files        1019     1019           
  Lines       17133    17132    -1     
  Branches     3090     3089    -1     
=======================================
  Hits         7006     7006           
+ Misses      10127    10126    -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@graduta graduta merged commit 0648138 into main Jun 24, 2025
38 of 41 checks passed
@graduta graduta deleted the improv/O2B-1450/update-synthetic-run-definition branch June 24, 2025 08:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Development

Successfully merging this pull request may close these issues.

2 participants