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

[Wf-diagnostics] Introduce a new api to diagnose a workflow execution #6268

Merged
merged 3 commits into from
Sep 9, 2024

Conversation

sankari165
Copy link
Member

@sankari165 sankari165 commented Sep 6, 2024

Detailed Description
[In-depth description of the changes made to the IDL, specifying new fields, removed fields, or modified data structures]
Introduction of new api to trigger workflow to perform diagnostics from cadence frontend. The result of the diagnostics contains the details of the diagnostics workflow that was triggered. The result of the diagnostics can be fetched by querying the diagnostics workflow . This api will be triggered from cli and web to provide diagnostics for a workflow execution to the users.

Impact Analysis

  • Backward Compatibility: [Analysis of backward compatibility] N/A
  • Forward Compatibility: [Analysis of forward compatibility] N/A

Testing Plan

  • Unit Tests: [Do we have unit test covering the change?]
  • Persistence Tests: [If the change is related to a data type which is persisted, do we have persistence tests covering the change?]
  • Integration Tests: [Do we have integration test covering the change?]
  • Compatibility Tests: [Have we done tests to test the backward and forward compatibility?]
    No compatibility issues as it is a new unused API

Rollout Plan

  • What is the rollout plan? Rollout to all cadence clusters
  • Does the order of deployment matter? no
  • Is it safe to rollback? Does the order of rollback matter? no issues as it is a new unused API
  • Is there a kill switch to mitigate the impact immediately?

What changed?
This api will trigger the start of Diagnostics workflow that runs in the cadence worker service.

Why?
Having this as a api in frontend, allows the use of workflow diagnostics from cli or web

How did you test it?
unit tests

Potential risks

Release notes

Documentation Changes

Copy link

codecov bot commented Sep 6, 2024

Codecov Report

Attention: Patch coverage is 87.00000% with 13 lines in your changes missing coverage. Please review.

Project coverage is 73.09%. Comparing base (3f1f3a6) to head (fbb786d).
Report is 7 commits behind head on master.

Files with missing lines Patch % Lines
service/frontend/api/handler.go 82.60% 4 Missing and 4 partials ⚠️
service/frontend/wrappers/metered/metered.go 0.00% 5 Missing ⚠️
Additional details and impacted files
Files with missing lines Coverage Δ
common/types/mapper/proto/api.go 98.33% <100.00%> (+<0.01%) ⬆️
common/types/mapper/thrift/shared.go 97.72% <100.00%> (+0.01%) ⬆️
service/frontend/wrappers/metered/metered.go 96.98% <0.00%> (-2.50%) ⬇️
service/frontend/api/handler.go 65.86% <82.60%> (+0.29%) ⬆️

... and 14 files with indirect coverage changes


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 3f1f3a6...fbb786d. Read the comment docs.

@davidporter-id-au
Copy link
Member

oh, you were going to use the Query API to return data? I guess that works well.

@sankari165 sankari165 merged commit 08dba4d into cadence-workflow:master Sep 9, 2024
21 checks passed
@sankari165 sankari165 deleted the CDNC-10292 branch September 9, 2024 07:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants