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

[CLA Approved] Add openmct type hints #7247

Merged
merged 2 commits into from
Feb 16, 2024
Merged

[CLA Approved] Add openmct type hints #7247

merged 2 commits into from
Feb 16, 2024

Conversation

skrobchik
Copy link
Contributor

@skrobchik skrobchik commented Nov 20, 2023

Closes

Describe your changes:

Adds type information for the setAssetPath method.

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 change backwards compatible? For example, developers won't need to change how they are calling the API or how they've extended core plugins such as Tables or Plots.

Author Checklist

  • Changes address original issue?
  • Tests included and/or updated with changes?
  • Command line build passes?
  • Has this been smoke tested?
  • 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?
  • Has associated issue been labelled unverified? (only applicable if this PR closes the issue)
  • Has associated issue been labelled bug? (only applicable if this PR is for a bug fix)

Copy link

deploysentinel bot commented Nov 20, 2023

Current Playwright Test Results Summary

✅ 162 Passing - ⚠️ 3 Flaky

Run may still be in progress, this comment will be updated as current testing workflow or job completes...

(Last updated on 12/01/2023 09:14:00pm UTC)

Run Details

Running Job e2e-stable on CircleCI

Commit: 9dd5729

Started: 12/01/2023 09:06:55pm UTC

⚠️ Flakes

📄   functional/plugins/timer/timer.e2e.spec.js • 1 Flake

Test Case Results

Test Case Last 7 days Failures Last 7 days Flakes
Timer Can perform actions on the Timer
Retry 1Initial Attempt
0% (0) 0 / 37 runs
failed over last 7 days
18.92% (7) 7 / 37 runs
flaked over last 7 days

📄   functional/plugins/notebook/restrictedNotebook.e2e.spec.js • 1 Flake

Test Case Results

Test Case Last 7 days Failures Last 7 days Flakes
Restricted Notebook with a page locked and with an embed @addinit Disallows embeds to be deleted if page locked @addinit
Retry 1Initial Attempt
0% (0) 0 / 39 runs
failed over last 7 days
28.21% (11) 11 / 39 runs
flaked over last 7 days

📄   functional/plugins/notebook/notebookSnapshots.e2e.spec.js • 1 Flake

Test Case Results

Test Case Last 7 days Failures Last 7 days Flakes
Snapshot image tests Can drop an image onto a notebook and create a new entry
Retry 1Initial Attempt
2.50% (1) 1 / 40 run
failed over last 7 days
62.50% (25) 25 / 40 runs
flaked over last 7 days

View Detailed Build Results


Copy link

codecov bot commented Nov 20, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (bc36a93) 55.40% compared to head (e31a3ee) 55.38%.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #7247      +/-   ##
==========================================
- Coverage   55.40%   55.38%   -0.02%     
==========================================
  Files         671      671              
  Lines       27010    27010              
  Branches     2631     2631              
==========================================
- Hits        14964    14959       -5     
- Misses      11324    11327       +3     
- Partials      722      724       +2     
Flag Coverage Δ *Carryforward flag
e2e-full 41.12% <ø> (ø) Carriedforward from bc36a93
e2e-stable 59.38% <ø> (-0.03%) ⬇️
unit 48.44% <ø> (-0.01%) ⬇️

*This pull request uses carry forward flags. Click here to find out more.

Files Coverage Δ
openmct.js 100.00% <ø> (ø)

... and 4 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 bc36a93...e31a3ee. Read the comment docs.

@skrobchik skrobchik marked this pull request as ready for review November 20, 2023 02:15
@ozyx ozyx added the source:community Community contribution or request label Nov 20, 2023
@ozyx
Copy link
Contributor

ozyx commented Nov 20, 2023

Thank you so much for your contribution! If you haven't already, please complete and submit a Contributor License Agreement (CLA). This is required before we can approve/merge your code. That will take a little bit of time to process, so in the meantime if you'd like to add any more types in this PR please feel free to do so. Thanks again!

@ozyx ozyx changed the title Add setAssetPath method to MCT type information [CLA Needed] Add setAssetPath method to MCT type information Nov 20, 2023
@skrobchik
Copy link
Contributor Author

Hello @ozyx ,

Thank you for reviewing the PR. We're working with Open MCT and TypeScript at our rocketry club, so I will try to add type information for APIs as I go.

I emailed the Contributor License Agreement to arc-sra-team@mail.nasa.gov and kimberly.minafra@nasa.gov, hope they can review it soon.

@skrobchik
Copy link
Contributor Author

Also added type for the TypeRegistry

@skrobchik skrobchik changed the title [CLA Needed] Add setAssetPath method to MCT type information [CLA Needed] Add openmct type hints Nov 24, 2023
@skrobchik
Copy link
Contributor Author

@ozyx Any updates on the CLA?

@ozyx
Copy link
Contributor

ozyx commented Nov 30, 2023

@skrobchik No updates yet, I just sent a follow-up so I'll let you know once they get back to me on the CLA status. We have a few folks waiting on approval. Unfortunately this is largely a manual process and can take some time, especially during the holidays. Appreciate your patience!

@unlikelyzero unlikelyzero added the type:maintenance tests, chores, or project maintenance label Dec 14, 2023
@skrobchik
Copy link
Contributor Author

I've followed up on the email to arc-sra-team@mail.nasa.gov and kimberly.minafra@nasa.gov, but still haven't received a response.

@ozyx
Copy link
Contributor

ozyx commented Feb 8, 2024

I've followed up on the email to arc-sra-team@mail.nasa.gov and kimberly.minafra@nasa.gov, but still haven't received a response.

I will also follow up and see if I can get a confirmation. Apologies again for the wait.

@ozyx ozyx changed the title [CLA Needed] Add openmct type hints [CLA Approved] Add openmct type hints Feb 15, 2024
@ozyx ozyx added type:docs updates to documentation and removed type:maintenance tests, chores, or project maintenance labels Feb 15, 2024
@ozyx ozyx self-requested a review February 15, 2024 16:52
@ozyx ozyx added this to the Target:4.0.0 milestone Feb 15, 2024
@ozyx
Copy link
Contributor

ozyx commented Feb 15, 2024

@skrobchik Your CLA has been approved! Thank you for waiting.

Copy link
Contributor

@ozyx ozyx left a comment

Choose a reason for hiding this comment

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

LGTM

@ozyx
Copy link
Contributor

ozyx commented Feb 15, 2024

@skrobchik Please merge master into this branch or rebase it on top of master-- otherwise, this is good to go!

@skrobchik
Copy link
Contributor Author

Rebased

@ozyx ozyx enabled auto-merge (squash) February 16, 2024 00:46
@ozyx ozyx disabled auto-merge February 16, 2024 00:47
@ozyx
Copy link
Contributor

ozyx commented Feb 16, 2024

@skrobchik I don't have write access to the branch you're trying to merge from, so this is proving difficult as master continually changes. Please do one of the following:

  1. Rebase on master again and ping me, and I'll try to get to it in time 😬
  2. (Better option) Retarget the PR to merge from a public fork of Open MCT instead

@skrobchik
Copy link
Contributor Author

@ozyx I'm not quite sure what you mean with option 2 ?

I rebased on top of master anyway. I thought that GitHub automatically rebased pull-requests on top of master before merging if there are no merge conflicts.

@ozyx ozyx added the pr:e2e:couchdb npm run test:e2e:couchdb label Feb 16, 2024
@ozyx ozyx enabled auto-merge (squash) February 16, 2024 16:51
@ozyx ozyx disabled auto-merge February 16, 2024 16:51
@ozyx ozyx enabled auto-merge (squash) February 16, 2024 16:51
@ozyx ozyx merged commit 317ea8c into nasa:master Feb 16, 2024
19 of 21 checks passed
@ozyx
Copy link
Contributor

ozyx commented Feb 16, 2024

@ozyx I'm not quite sure what you mean with option 2 ?

I rebased on top of master anyway. I thought that GitHub automatically rebased pull-requests on top of master before merging if there are no merge conflicts.

Yeah you're doing everything correctly, what I mean is that since the repo it's merging from is protected, if master were to change while I'm waiting for our CI checks to complete I wouldn't be able to rebase or add a merge commit because I don't have write access to your fork. Regardless-- option 1 worked :)

@ozyx ozyx added the type:maintenance tests, chores, or project maintenance label Apr 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pr:e2e:couchdb npm run test:e2e:couchdb source:community Community contribution or request type:docs updates to documentation type:maintenance tests, chores, or project maintenance
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants