Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Only clear mod component debug logs if logValues is enabled #9225

Merged
merged 2 commits into from
Oct 3, 2024

Conversation

grahamlangford
Copy link
Collaborator

@grahamlangford grahamlangford commented Oct 3, 2024

What does this PR do?

Discussion

  • logValues only impacts whether we append debug logs to the LOG idb database, so we still need to clear traces
  • Do we really need to clear traces in the content script platform?
    • I left it in because I wasn't certain if it's necessary

Remaining work

  • Add tests

For more information on our expectations for the PR process, see the
code review principles doc

@grahamlangford grahamlangford self-assigned this Oct 3, 2024
@grahamlangford grahamlangford added this to the 2.1.3 milestone Oct 3, 2024
clear: (componentId: UUID) => Promise<void>;
clear: (
componentId: UUID,
{ logValues }: { logValues: boolean },
Copy link
Collaborator

@fungairino fungairino Oct 3, 2024

Choose a reason for hiding this comment

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

We could consider renaming this option to something like clearDebugLogs for clarity

Another consideration is whether to expose this in the protocol interface, or just get the logValues value in the underlying implementation

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Per our sync discussion, we're going to keep it as logValues for consistency. And the implementation doesn't have access to the source for logValues, so we're leaving that to reducePipeline

Copy link

codecov bot commented Oct 3, 2024

Codecov Report

Attention: Patch coverage is 92.85714% with 1 line in your changes missing coverage. Please review.

Project coverage is 74.82%. Comparing base (8318d74) to head (824de8e).
Report is 332 commits behind head on main.

Files with missing lines Patch % Lines
src/runtime/reducePipeline.ts 75.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #9225      +/-   ##
==========================================
+ Coverage   74.24%   74.82%   +0.57%     
==========================================
  Files        1332     1367      +35     
  Lines       40817    42201    +1384     
  Branches     7634     7891     +257     
==========================================
+ Hits        30306    31577    +1271     
- Misses      10511    10624     +113     

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

Copy link

github-actions bot commented Oct 3, 2024

Playwright test results

passed  125 passed
flaky  9 flaky
skipped  4 skipped

Details

report  Open report ↗︎
stats  138 tests across 45 suites
duration  33 minutes, 46 seconds
commit  824de8e
info  For more information on how to debug and view this report, see our readme

Flaky tests

chrome-setup › setup/unaffiliated.setup.ts › authenticate with unaffiliated user
chrome › tests/deployments/deploymentActivation.spec.ts › activate a deployed mod in the extension console
msedge › tests/pageEditor/addStarterBrick.spec.ts › Add starter brick to mod
chrome › tests/pageEditor/brickActions.spec.ts › brick actions panel behavior
chrome › tests/pageEditor/copyMod.spec.ts › run a copied mod with a built-in integration
chrome › tests/pageEditor/modEditorPane.spec.ts › mod editor pane behavior
chrome › tests/runtime/setInputValue.spec.ts › can set input value
chrome › tests/runtime/sidebar/sidebarActivation.spec.ts › initiates sidebar mod activation from activate url click
msedge › tests/runtime/sidebar/sidebarActivation.spec.ts › initiates sidebar mod activation from activate url click

Skipped tests

chrome › tests/regressions/doNotCloseSidebarOnPageEditorSave.spec.ts › #8104: Do not automatically close the sidebar when saving in the Page Editor
msedge › tests/regressions/doNotCloseSidebarOnPageEditorSave.spec.ts › #8104: Do not automatically close the sidebar when saving in the Page Editor
chrome › tests/runtime/googleSheetsIntegration.spec.ts › can activate a google spreadsheet mod with config options
msedge › tests/runtime/googleSheetsIntegration.spec.ts › can activate a google spreadsheet mod with config options

Copy link

github-actions bot commented Oct 3, 2024

No loom links were found in the first post. Please add one there if you'd like to it to appear on Slack.

Do not edit this comment manually.

@twschiller twschiller added runtime enhancement New feature or request labels Oct 3, 2024
@grahamlangford grahamlangford enabled auto-merge (squash) October 3, 2024 16:21
@grahamlangford grahamlangford merged commit 6791c26 into main Oct 3, 2024
26 checks passed
@grahamlangford grahamlangford deleted the skip-clear-logs-log-values branch October 3, 2024 16:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request runtime
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants