Operator status

[charlesh88]

Closes #5193

Describe your changes:

Operator status functionality for managing and responding to operations status polls questions.

To Do

@charlesh88

• Moved to followup issue - https://github.com/nasa/openmct/issues/new?assignees=&labels=type%3Aenhancement&template=enhancement-request.md&title=

@akhenry

• Testing instructions
• Other todo items moved to followup issue - Add tests and API documentation for operator status functionality #5214

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?
• Unit tests included and/or updated with changes?
• Command line build passes?
• Has this been smoke tested?
• Testing instructions included in associated issue?

Reviewer Checklist

• Changes appear to address issue?
• Changes appear not to be breaking changes?
• Appropriate unit tests included?
• Code style and in-line documentation are appropriate?
• Commit messages meet standards?
• 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)

[charlesh88]

Todos

@akhenry

• Rather than always using a predetermined CSS class, allow indicators to optionally set their icon and its color
  via a configured color property (like this in ExampleUserProvider.js):

const STATUSES = [{
    key: "GO",
    label: "GO",
    iconClass: "icon-check",
    iconClassPoll: "icon-status-poll-check",
    statusClass: "s-status-ok",
    statusBgColor: "#33cc33",
    statusFgColor: "#000"
}, {

[akhenry]

Implementation Notes

• This implements the API for supporting operator status, and extends the existing Example User plugin to handle status.
• The existing User API has been extended with new status-specific functionality via a sub-api that is referenced like so:
  openmct.user.status.whatever
• There are two classes that constitute interfaces and have only been included as it was the simplest way of documenting these interfaces. They are UserProvider and StatusUserProvider
• I believe this is the first usage of private class members in Open MCT, which will break downstream projects if they are compiling Open MCT into their build artifacts and not using Webpack 5.
• A couple of concepts may not be immediately clear just from looking at the code:
  • A "status role" is a user role that can provide status updates. The User API already had basic support for roles, but not all user roles will necessarily be providing status. This is because not every user of Open MCT during a mission is necessarily involved in real-time operations, and so an operational status is not needed from them. As such, the API distinguishes between regular user roles and "status roles"
• To enable the example user plugin and test Operator Status locally, add the following lines to index.html:

openmct.install(openmct.plugins.example.ExampleUser({
    autoLoginUser: 'guest',
    defaultStatusRole: 'Driver'
}));
openmct.install(openmct.plugins.OperatorStatus());

[codecov]

Codecov Report

Merging #5179 (e7323f8) into master (50b642f) will decrease coverage by 0.12%.
The diff coverage is 31.96%.

@@            Coverage Diff             @@
##           master    #5179      +/-   ##
==========================================
- Coverage   50.28%   50.15%   -0.13%     
==========================================
  Files         548      556       +8     
  Lines       20133    20393     +260     
  Branches     1866     1876      +10     
==========================================
+ Hits        10123    10229     +106     
- Misses       9514     9677     +163     
+ Partials      496      487       -9     

Impacted Files	Coverage Δ
src/api/api.js	100.00% <ø> (ø)
src/api/telemetry/TelemetryMetadataManager.js	70.21% <0.00%> (ø)
...plugins/displayLayout/components/TelemetryView.vue	2.80% <ø> (ø)
src/plugins/objectMigration/Migrations.js	1.61% <0.00%> (ø)
.../plugins/operatorStatus/AbstractStatusIndicator.js	0.00% <0.00%> (ø)
...s/operatorStatus/operatorStatus/OperatorStatus.vue	0.00% <0.00%> (ø)
...orStatus/operatorStatus/OperatorStatusIndicator.js	0.00% <0.00%> (ø)
src/plugins/operatorStatus/plugin.js	0.00% <0.00%> (ø)
...ugins/operatorStatus/pollQuestion/PollQuestion.vue	0.00% <0.00%> (ø)
...eratorStatus/pollQuestion/PollQuestionIndicator.js	0.00% <0.00%> (ø)
... and 28 more

---

Continue to review full report at Codecov.

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

[shefalijoshi]

This is really solid! Nicely done!

I'm curious, what is the expected behavior if the same user is logged in on multiple tabs?

[shefalijoshi]

Looks good to me