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

feat(Fault Management): allow fault providers to define shelve durations #7849

Merged
merged 22 commits into from
Oct 1, 2024

Conversation

ozyx
Copy link
Contributor

@ozyx ozyx commented Sep 19, 2024

Closes #7853
Closes #5814

Describe your changes:

  • Adds a new, optional method getShelveDurations() to the Fault Management API that allows providers to define their own shelve durations. If no method is defined, a default list of shelve durations will be provided.
  • Adds some additional docs and JSDoc types for Fault Management API
  • Refactors the Fault Management e2e suite to use web-first assertions and locators
  • Build: removes the codecov npm package dependency as it has been deprecated for some time.

All Submissions:

  • Have you followed the guidelines in our Contributing document?
  • Have you checked to ensure there aren't other open Pull Requests for the same update/change?
  • Is this a notable change that will require a special callout in the release notes? For example, will this break compatibility with existing APIs or projects that consume these plugins?

Author Checklist

  • Changes address original issue?
  • Tests included and/or updated with changes?
  • Has this been smoke tested?
  • Have you associated this PR with a type: label? Note: this is not necessarily the same as the original issue.
  • Have you associated a milestone with this PR? Note: leave blank if unsure.
  • Testing instructions included in associated issue OR is this a dependency/testcase change?

Reviewer Checklist

  • Changes appear to address issue?
  • Reviewer has tested changes by following the provided instructions?
  • Changes appear not to be breaking changes?
  • Appropriate automated tests included?
  • Code style and in-line documentation are appropriate?

Copy link

codecov bot commented Sep 19, 2024

Codecov Report

Attention: Patch coverage is 21.05263% with 30 lines in your changes missing coverage. Please review.

Project coverage is 57.30%. Comparing base (29f1956) to head (931aa56).
Report is 1 commits behind head on master.

Files with missing lines Patch % Lines
...rc/plugins/faultManagement/FaultManagementView.vue 0.00% 26 Missing ⚠️
...lugins/faultManagement/FaultManagementListItem.vue 0.00% 3 Missing ⚠️
src/api/faultmanagement/FaultManagementAPI.js 75.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master    #7849      +/-   ##
==========================================
- Coverage   57.43%   57.30%   -0.13%     
==========================================
  Files         675      675              
  Lines       27317    27325       +8     
  Branches     2671     2673       +2     
==========================================
- Hits        15689    15659      -30     
- Misses      11292    11330      +38     
  Partials      336      336              
Flag Coverage Δ
e2e-ci 62.03% <88.88%> (+0.02%) ⬆️
e2e-full 41.81% <22.22%> (-10.34%) ⬇️
unit 49.31% <10.52%> (-0.01%) ⬇️
Files with missing lines Coverage Δ
example/faultManagement/exampleFaultSource.js 100.00% <100.00%> (ø)
example/faultManagement/utils.js 95.65% <100.00%> (+18.37%) ⬆️
src/api/faultmanagement/FaultManagementAPI.js 92.30% <75.00%> (+1.39%) ⬆️
...lugins/faultManagement/FaultManagementListItem.vue 4.34% <0.00%> (-0.20%) ⬇️
...rc/plugins/faultManagement/FaultManagementView.vue 1.16% <0.00%> (-0.03%) ⬇️

... and 5 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 29f1956...931aa56. Read the comment docs.

@ozyx ozyx added notable_change A change which should be noted in the changelog type:enhancement labels Sep 24, 2024
@ozyx ozyx added this to the Target:4.1.0 milestone Sep 24, 2024
@ozyx ozyx marked this pull request as ready for review September 24, 2024 23:04
Copy link
Contributor

@scottbell scottbell left a comment

Choose a reason for hiding this comment

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

@ozyx Can you add some testing instructions please? Code looks good.

Object.values(faults).forEach((selectedFault) => {
this.openmct.faults.shelveFault(selectedFault, shelveData);
});
await Promise.all(
Copy link
Contributor

Choose a reason for hiding this comment

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

nice catch

@ozyx
Copy link
Contributor Author

ozyx commented Sep 25, 2024

@ozyx Can you add some testing instructions please? Code looks good.

yep! will do

@ozyx
Copy link
Contributor Author

ozyx commented Sep 25, 2024

@ozyx Can you add some testing instructions please? Code looks good.

@scottbell done!

@ozyx ozyx requested a review from scottbell September 25, 2024 18:11
Copy link
Contributor

@shefalijoshi shefalijoshi left a comment

Choose a reason for hiding this comment

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

One small change. Very nice documentation!

@ozyx ozyx requested a review from shefalijoshi September 30, 2024 20:18
Copy link
Contributor

@shefalijoshi shefalijoshi left a comment

Choose a reason for hiding this comment

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

Looks good. Thanks.

@ozyx ozyx added the pr:e2e:couchdb npm run test:e2e:couchdb label Sep 30, 2024
@ozyx ozyx added pr:e2e:couchdb npm run test:e2e:couchdb and removed pr:e2e:couchdb npm run test:e2e:couchdb labels Sep 30, 2024
@github-actions github-actions bot removed the pr:e2e:couchdb npm run test:e2e:couchdb label Sep 30, 2024
@ozyx ozyx added the pr:e2e:couchdb npm run test:e2e:couchdb label Oct 1, 2024
@github-actions github-actions bot removed the pr:e2e:couchdb npm run test:e2e:couchdb label Oct 1, 2024
@ozyx ozyx added the pr:e2e:couchdb npm run test:e2e:couchdb label Oct 1, 2024
@github-actions github-actions bot removed the pr:e2e:couchdb npm run test:e2e:couchdb label Oct 1, 2024
@ozyx ozyx added the pr:e2e:couchdb npm run test:e2e:couchdb label Oct 1, 2024
@github-actions github-actions bot removed the pr:e2e:couchdb npm run test:e2e:couchdb label Oct 1, 2024
@ozyx ozyx enabled auto-merge (squash) October 1, 2024 17:39
@ozyx ozyx merged commit ad30a0e into master Oct 1, 2024
22 of 24 checks passed
@ozyx ozyx deleted the vipergc-574 branch October 1, 2024 17:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
notable_change A change which should be noted in the changelog type:enhancement
Projects
None yet
4 participants