GH-89: (Minimal) System Monitor Plugin (a.k.a. SysMon) #297

wesleyboar · 2021-08-02T17:18:49Z

Important

The PR TACC/Core-CMS-Resources#67 is dependent on this PR.

To Do

0d9491f (Optional) Rename sysmon to system_monitor.*
a36e978 Remove unused get_direction_classname import.
(no change) Revisit setStatusStyle().
(no change) Re-evaluate where to place constants.
5ed2892, a2807a2 Resolve unexpected plugin installs (and search for related problems)
7220bc1 Ensure multiple instances (a) can exist or (b) are not permitted to exist.†
333918d Fix warning badge missing background color.

Footnotes

* Rename to be consistent with upcoming system_specs and possible system_....
† Either (a) do not use GetElementById or ~~(b) limit plugin to one instance~~. Try not to over-engineer the JavaScript, because #295 will delete it.

Overview

Implement minimal SysMon plugin using polished CSS and JavaScript.

Issues

System Monitor - Styles & Plugin #89

Changes

Create plugin from snippet.

Screenshots

Core

Toggle visibility

Form

Render

Structure

Frontera

Toggle visibility

Render

Structure

Testing

Last recorded deploy to Frontera (dev) was Build #383 (Aug 2, 2021 1:58:12 PM).

Important: If you tested this plugin before it was renamed from "Sysmon" to "System Monitor", then you must follow these cleanup steps to prevent a CMS server crash:
Steps for Plugin Rename
Checkout commit or branch that does not crash server.

If you have only been testing this plugin, then a36e978 should work.

If you have been testing several plugins, then site/frontera/main might work.
Delete "Sysmon" plugin instances:
python3 manage.py cms uninstall plugins TaccsiteSysmonPlugin
Checkout task/GH-89 branch at latest commit.
Perform database migrations for new "System Monitor" plugin:
python3 manage.py migrate
Re-add deleted plugin instances (as necessary for testing) using new "System Monitor" plugin.
Rebuild assets and collect static files:
npm run build && docker exec -it core_cms python manage.py collectstatic --no-input

If no environment, then prepare to test CMS changes.
In CMS container, run python3 manage.py migrate.
On CMS website, logged in as admin, add "TACC Site" > "System Monitor" plugin.
Reload page (to trigger client-side* data retrieval).
Ensure the following:
- styles match system monitor on [Old Homepage][old-home] / [Phase 0 Homepage][new-home]
  - the text may be larger; this is acceptable†
- data shown is for system chosen
- plugin description (next to name) in Structure view is the system chosen
Add "Generic" > "Text" plugin.
In Text plugin, in "CMS Plugins" dropdown, confirm "TACC Site" > "System Monitor" plugin is not available.
Add another "TACC Site" > "System Monitor" plugin, and choose "Stampede2".
Ensure Stampede2 monitor—
- if on local server—has "Warning" state
- if on remote server—is populated with live data

Footnotes

* I hope to implement server-side retrieval later via #295.
† Different projects and templates have different root font size. (Values have been standardized, but implementation has not caught up to standards.)

Notes

This is a minimal version of a functionally better plugin, ~~bitbucket:rochaa/tacc-sysmon~~ bitbucket.org:tacc-system-monitor. @tacc-wbomar has deadline to finish #88 (which requires #89) this week. So #295 has been created to enhance this plugin later.

wesleyboar

Added notes for other reviewers.

taccsite_cms/contrib/taccsite_sysmon/cms_plugins.py

taccsite_cms/contrib/taccsite_sysmon/static/taccsite_sysmon/css/sysmon.css

taccsite_cms/contrib/taccsite_sysmon/static/taccsite_sysmon/js/sysmon.js

taccsite_cms/contrib/taccsite_sysmon/templates/sysmon.html

iamthatian

I've approved! However, I also included some minor questions/comments.

taccsite_cms/contrib/taccsite_sysmon/cms_plugins.py

taccsite_cms/contrib/taccsite_sysmon/models.py

taccsite_cms/contrib/taccsite_sysmon/static/taccsite_sysmon/js/sysmon.js

wesleyboar

@duckonomy, thanks. I've responded.

Also, what you think of renaming this plugin (to mirror system_specs plugin name)?

taccsite_cms/contrib/taccsite_sysmon/cms_plugins.py

taccsite_cms/contrib/taccsite_sysmon/models.py

taccsite_cms/contrib/taccsite_sysmon/static/taccsite_sysmon/js/sysmon.js

iamthatian · 2021-08-11T21:11:46Z

@duckonomy, thanks. I've responded.

Also, what you think of renaming this plugin (to mirror system_specs plugin name)?

@tacc-wbomar That sounds good!

iamthatian · 2021-08-11T21:18:19Z

@tacc-wbomar For 2,3 I think those are valid reasons 👍🏼

wesleyboar · 2021-08-12T19:46:53Z

@duckonomy I have re-requested review merely to remove approval to help remind me that this PR is not complete. There is nothing new to review, yet.

wesleyboar · 2021-08-16T21:40:00Z

@duckonomy I completed the To Do items. Code was changed only for:

removal of errant import (a36e978)
plugin rename (0d9491f)
- To test, follow "Steps for Plugin Rename" in "Testing" section of description.
addition of missing functions (871676e)
- I found this bug during my re-test.

Please review.

iamthatian

The plugin works great!

There was one configuration value that was causing an error on docker-compose up.
Other than that, I've noticed this time that the plugin didn't work when having multiple instances (of Frontera).
Is this intended behavior?

iamthatian · 2021-08-16T22:17:33Z

taccsite_cms/settings.py

+    'taccsite_cms.contrib.taccsite_static_article_list',
+    'taccsite_cms.contrib.taccsite_static_article_preview',
+    'taccsite_cms.contrib.taccsite_blockquote',
+    'taccsite_cms.contrib.taccsite_offset',


These cause an error on initialization (I had to comment them to make it run properly).

That is a problem. [All] of those should not be [in this branch]. This problem suggests that more code may be present that should not be. I will investigate. Thank you.

Details

There are so many dependent branches for Frontera System Specs page and Frontera Homepage plugins that I am trying to author independently but test together 🤕 and I crossed the streams.

I have removed those lines (via 5ed2892). No related erroneous code was found, but I found and resolved* a different unexpected change in the submodule diff.

Footnotes

* I resolved unexpected submod diff with a merge of main, a2807a2 (after a submod pointer update: #315).

These plugin install lines come from various other plugins. See "Details" at https://github.com/TACC/Core-CMS/pull/297/files#r689904516.

wesleyboar · 2021-08-16T23:04:35Z

Good catch: the multiple instances bug.

I have added a task to either support multiple instances or not.

Details

The problem is caused by the JavaScript I borrowed and cleaned up still using document.getElementById. There really should be only one instance of this plugin on a page. I need to either (with Python) prevent multiple instances or (with JavaScript) allow multiple instances.

Use `element.querySelector('[data-id=""]')`. Do not use `document.getElementById`.

Use JavaScript module and class. Do not use window variables and functions.

Why? 1. The Bootstrap "success" pill color is used. - See `badge-success` in HTML but not CSS. 2. The custom warning color was recently removed. - #312 3. The Portal success, warn, etc colors are not standardized. - They will be in FP-1145, but CMS's could differ.

wesleyboar · 2021-08-17T18:43:28Z

@duckonomy, fixes:

Multiple instances are now functional.

For just the diff relevant to this…

I suggest reviewing first 30c78a6, then 7220bc1 (instead of "changes since last review").
Also, the warning state is now testable (see new "Testing" step 8 & 9).

For just the diff relevant to this…

I suggest reviewing 333918d (instead of "changes since last review").

iamthatian

LGTM!

wesleyboar added 3 commits August 2, 2021 12:17

GH-89: Initial SysMon plugin (functional)

dd87a29

GH-89: Reference GH-295 for enhancements

c4cfd35

GH-89: Use system desc as plugin short desc

3508020

wesleyboar linked an issue Aug 2, 2021 that may be closed by this pull request

System Monitor - Styles & Plugin #89

Closed

wesleyboar mentioned this pull request Aug 2, 2021

[Site/Frontera] GH-89: (Minimal) System Monitor Plugin (a.k.a. SysMon) #296

Closed

wesleyboar changed the title ~~GH-89: Initial SysMon plugin (functional)~~ GH-89: (Minimal) System Monitor Plugin (a.k.a. SysMon) Aug 2, 2021

wesleyboar added 2 commits August 2, 2021 13:43

GH-89: Do not allow SysMon plugin in Text plugin

fdd5566

GH-89: Noop: Fix inaccurate documentation

8b6cd4f

wesleyboar added the priority ━ Medium priority label Aug 8, 2021

wesleyboar added 2 commits August 9, 2021 11:45

Merge branch 'main' into task/GH-89

9fa50c3

GH-89: Remove outdated snippet from frontera-cms

ce317c4

wesleyboar mentioned this pull request Aug 9, 2021

GH-89: Remove SysMon Snippet TACC/Core-CMS-Resources#67

Merged

wesleyboar commented Aug 9, 2021

View reviewed changes

wesleyboar requested a review from iamthatian August 9, 2021 17:02

GH-89: Update submod to resolve snippet removal

c76c388

iamthatian approved these changes Aug 11, 2021

View reviewed changes

taccsite_cms/contrib/taccsite_sysmon/cms_plugins.py Outdated Show resolved Hide resolved

taccsite_cms/contrib/taccsite_sysmon/models.py Show resolved Hide resolved

taccsite_cms/contrib/taccsite_sysmon/static/taccsite_sysmon/js/sysmon.js Outdated Show resolved Hide resolved

wesleyboar commented Aug 11, 2021

View reviewed changes

taccsite_cms/contrib/taccsite_sysmon/cms_plugins.py Outdated Show resolved Hide resolved

taccsite_cms/contrib/taccsite_sysmon/models.py Show resolved Hide resolved

taccsite_cms/contrib/taccsite_sysmon/static/taccsite_sysmon/js/sysmon.js Outdated Show resolved Hide resolved

wesleyboar requested a review from iamthatian August 12, 2021 19:45

wesleyboar added priority ▲ High priority and removed priority ━ Medium priority labels Aug 13, 2021

wesleyboar mentioned this pull request Aug 13, 2021

GH-88: System Specs #313

Closed

wesleyboar added 4 commits August 16, 2021 14:05

Merge branch 'main' into task/GH-89

8ab7562

GH-89: Add missing helpers.py functions

871676e

GH-89: Remove unused get_direction_classname

a36e978

GH-89: Rename "Sysmon" to "System Monitor"

0d9491f

wesleyboar mentioned this pull request Aug 16, 2021

System Monitor - Multiple Systems & Server-Side Support #295

Closed

iamthatian suggested changes Aug 16, 2021

View reviewed changes

wesleyboar added 2 commits August 16, 2021 17:49

Merge branch 'main' into task/GH-89

a2807a2

GH-89: Bugfix: Remove erroneously added plugins

5ed2892

These plugin install lines come from various other plugins. See "Details" at https://github.com/TACC/Core-CMS/pull/297/files#r689904516.

wesleyboar added 5 commits August 16, 2021 18:34

Merge branch 'main' into task/GH-89

c3db8ea

GH-89: Noop: Add comments about using a class

67ef38b

GH-89: Support internally unique IDs

30c78a6

Use `element.querySelector('[data-id=""]')`. Do not use `document.getElementById`.

GH-89: Support multiple instances

7220bc1

Use JavaScript module and class. Do not use window variables and functions.

wesleyboar requested a review from iamthatian August 17, 2021 18:48

iamthatian approved these changes Aug 17, 2021

View reviewed changes

Merge branch 'main' into task/GH-89

d858a0d

wesleyboar merged commit 5b97b8f into main Aug 17, 2021

wesleyboar deleted the task/GH-89 branch August 17, 2021 22:25

wesleyboar mentioned this pull request Aug 24, 2021

GH-88: System Specs Plugin #330

Merged

2 tasks

GH-89: (Minimal) System Monitor Plugin (a.k.a. SysMon) #297

GH-89: (Minimal) System Monitor Plugin (a.k.a. SysMon) #297

Uh oh!

Conversation

wesleyboar commented Aug 2, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Important

To Do

Overview

Issues

Changes

Screenshots

Core

Form

Render

Structure

Frontera

Render

Structure

Testing

Notes

Uh oh!

wesleyboar left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

iamthatian left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

wesleyboar left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

iamthatian commented Aug 11, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

iamthatian commented Aug 11, 2021

Uh oh!

wesleyboar commented Aug 12, 2021

Uh oh!

wesleyboar commented Aug 16, 2021

Uh oh!

iamthatian left a comment

Choose a reason for hiding this comment

Uh oh!

iamthatian Aug 16, 2021

Choose a reason for hiding this comment

Uh oh!

wesleyboar Aug 16, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

wesleyboar Aug 16, 2021

Choose a reason for hiding this comment

Uh oh!

wesleyboar commented Aug 16, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

wesleyboar commented Aug 17, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

iamthatian left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

wesleyboar commented Aug 2, 2021 •

edited

Loading

iamthatian commented Aug 11, 2021 •

edited

Loading

wesleyboar Aug 16, 2021 •

edited

Loading

wesleyboar commented Aug 16, 2021 •

edited

Loading

wesleyboar commented Aug 17, 2021 •

edited

Loading