Fixes #31425 - Render statuses #8984

kamils-iRonin · 2021-12-09T14:22:19Z

Reopened #8377

I have a feeling the previous PR was overcomplicated and I wanted to keep this one as simple as possible. It includes saving the status after each render attempt and displaying that on the template and host pages. I think this is more about the template than the host (we want to make sure that the templates are not broken), so I'm not really sure if host status is suitable here. Once this is merged, we can think about some kind of monitoring/notifications.

Here are some screenshots:

theforeman-bot · 2021-12-09T14:22:22Z

Issues: #31425

amirfefer · 2021-12-13T15:39:02Z

Thanks @kamils-iRonin!

I'm not sure if the card "Render Statuses" fits the overview tab, it has too much data IMHO which takes much of the screen's real estate, the overview tab mostly shows recent / aggregated information regarding the host.

MariSvirik · 2021-12-13T15:52:48Z

Hey, @kamils-iRonin it's a great effort.
I agree with what @amirfefer said.
Still, I have a couple of questions about render statuses as I'm hearing about it for the first time. (Apologies for a lack of my technical knowledge)
What are render statuses? Do they tell a user if a template rendered correctly?
How is it important for a user? And is it important in the context of a specific host?

kamils-iRonin · 2021-12-14T12:36:54Z

@amirfefer @MariSvirik thanks for the feedback! I'll try to address the questions below, do not hesitate to ask if something is still unclear 😄

What are render statuses?

Basically, the render statuses are designed to provide information about possible rendering problems. We would like to know which templates are used with which hosts and if any errors occurred during the rendering process.

Do they tell a user if a template rendered correctly? How is it important for a user?

Exactly, with this we can prevent further problems, if we detect that there is a problem with rendering some template, we can check which hosts may be affected. Also, if you use the renderer in unsafe mode, it can be helpful to migrate to safe mode.

And is it important in the context of a specific host?

The first idea was to introduce a new host status, but now I think it's more about the template. I don't have a strong opinion on whether the render statuses should be displayed on the host page or not.

I'm not sure if the card "Render Statuses" fits the overview tab, it has too much data IMHO which takes much of the screen's real estate.

Maybe it would be enough to show how many templates were rendered for this particular host and if all renderings were successful? (we can also add a "Details" button)

ares · 2021-12-15T20:01:29Z

Great work so far! I'd say the templates would deserve it's own tab. Either for this table with perhaps more info (link to audits of this template, info about it's type etc) or it should be a part of a new Provisioning tab. We can start with Templates tab and then perhaps move it if it would be better. Just my 2 cents

Ron-Lavi · 2022-04-03T12:24:13Z

Hey @kamils-iRonin what is the status here?
is it just waiting for another review?

kamils-iRonin · 2022-04-05T15:22:27Z

@Ron-Lavi If I remember correctly, there are minor things to improve and tests to fix. I'm quite busy with another project at the moment, but I'll try to finish it in the next few days.

kamils-iRonin · 2022-05-19T08:21:47Z

I believe the failed JavaScript tests are not related, I just ran the tests on develop and I see the same errors

kamils-iRonin · 2022-05-19T08:55:06Z

[test foreman]

kamils-iRonin · 2022-05-25T14:48:29Z

@Ron-Lavi I think it's ready for another review

Ron-Lavi · 2022-10-02T06:22:51Z

Hey @kamils-iRonin, I guess this PR fell through the cracks,
I rebased it for you and fixed the conflict with the safemode UI setting change

kamils-iRonin · 2022-11-10T09:00:33Z

Hi @Ron-Lavi, thanks and I think it is ready now

sbernhard · 2023-12-08T16:57:41Z

What shall we do with this PR? Rebase and finish or close it? @MariaAga ?

kamils-iRonin · 2023-12-12T13:32:44Z

It is quite old PR and the details are not entirely fresh in my memory. Just in case I have rebased and tested. It seems to work fine.

kmalyjur · 2023-12-13T13:52:06Z

Since this PR is quite old, I just want to let you know that I'm going to take a look at it within the next few days.

kmalyjur

@adamruzicka helped me with the review (mainly with the backend) and we came to the conclusion that it might be worth adding the same "Render Statuses" tab to the Host Groups and also to the Provisioning templates card in the new host detail page -> Details (sort of like the Overview -> Recent jobs card), however, I know that this has already been discussed and it's possible it was decided not to include it there.
Idk about the tests, hopefully rebasing would help.

kmalyjur · 2024-03-14T15:07:30Z

app/views/api/v2/render_statuses/base.json.rabl

+object @render_status
+
+attributes :id


This only seems to be used to extend the main.json.rabl. Does it need to be a separate file?

kmalyjur · 2024-03-18T12:18:32Z

webpack/assets/javascripts/react_app/components/RenderStatuses/Empty.js

+import { translate as __ } from '../../common/I18n';
+import { STATUS } from '../../constants';
+
+const Empty = ({ responseStatus }) => (


We already have /common/EmptyState in Foreman, couldn't you please use that instead of creating a new component?

kmalyjur · 2024-03-18T12:18:32Z

webpack/assets/javascripts/react_app/components/RenderStatuses/index.js

+            page={page}
+            onSetPage={(_event, newPage) => setPage(newPage)}
+            onPerPageSelect={(_event, newPerPage) => updatePerPage(newPerPage)}
+            widgetId="pagination-options-menu-top"


I don't think we use widgetId

kmalyjur · 2024-03-18T12:18:32Z

webpack/assets/javascripts/react_app/components/RenderStatuses/index.js

+              style={{ fill: 'var(--pf-global--success-color--100)' }}
+            />
+          ) : (
+            <ExclamationCircleIcon
+              style={{ fill: 'var(--pf-global--danger-color--100)' }}
+            />
+          ),
+        safemode: () =>
+          safemode ? (
+            <Fragment />
+          ) : (
+            <Tooltip position="right" content={__('Unsafe Mode')}>
+              <ExclamationTriangleIcon
+                style={{ fill: 'var(--pf-global--warning-color--100)' }}


Please import colors like this:
import { global_success_color_100 as successedColor } from '@patternfly/react-tokens';
And then you can use them this way:
<CheckCircleIcon color={successedColor.value} />

kmalyjur · 2024-03-18T12:19:58Z

webpack/assets/javascripts/react_app/components/RenderStatuses/index.js

+    setPage(1);
+  };
+
+  const columnLabels = {


There is some issue with the labels. It looks like this when the screen is too small:

github-actions · 2024-06-25T01:49:59Z

Thank you for your contribution! This PR has been inactive for 3 months, closing for now. Feel free to reopen when you return to it. This is an automated process.

theforeman-bot added Needs testing Not yet reviewed UI labels Dec 9, 2021

kamils-iRonin force-pushed the 31425-templates-rendering-host-status-3 branch 4 times, most recently from f3fb9d2 to d8f24e5 Compare December 10, 2021 14:50

kamils-iRonin force-pushed the 31425-templates-rendering-host-status-3 branch from d8f24e5 to 5aeebc8 Compare December 14, 2021 15:59

ezr-ondrej assigned ezr-ondrej and amirfefer Dec 15, 2021

kamils-iRonin force-pushed the 31425-templates-rendering-host-status-3 branch from 5aeebc8 to 0100b65 Compare February 3, 2022 17:47

Ron-Lavi marked this pull request as draft April 12, 2022 16:33

kamils-iRonin force-pushed the 31425-templates-rendering-host-status-3 branch 3 times, most recently from 24a8c50 to 3d9e63a Compare May 17, 2022 19:54

kamils-iRonin force-pushed the 31425-templates-rendering-host-status-3 branch from 3d9e63a to cc5bb6a Compare May 19, 2022 07:55

kamils-iRonin force-pushed the 31425-templates-rendering-host-status-3 branch from cc5bb6a to c484d4c Compare May 23, 2022 20:59

kamils-iRonin marked this pull request as ready for review May 25, 2022 14:47

kamils-iRonin force-pushed the 31425-templates-rendering-host-status-3 branch from c484d4c to a1f2f71 Compare May 30, 2022 06:58

ezr-ondrej removed their assignment Jun 2, 2022

ezr-ondrej unassigned amirfefer Jun 2, 2022

MariaAga assigned Ron-Lavi Jun 8, 2022

kamils-iRonin force-pushed the 31425-templates-rendering-host-status-3 branch from a1f2f71 to dc5f00e Compare June 14, 2022 12:03

Ron-Lavi force-pushed the 31425-templates-rendering-host-status-3 branch from dc5f00e to f92a74b Compare October 2, 2022 06:19

kamils-iRonin force-pushed the 31425-templates-rendering-host-status-3 branch from f92a74b to 409c027 Compare October 13, 2022 08:20

kamils-iRonin force-pushed the 31425-templates-rendering-host-status-3 branch from 409c027 to 1e9ba24 Compare November 10, 2022 08:28

kamils-iRonin force-pushed the 31425-templates-rendering-host-status-3 branch from 1e9ba24 to 1bed7b1 Compare December 12, 2023 13:25

kamils-iRonin force-pushed the 31425-templates-rendering-host-status-3 branch from 1bed7b1 to 7ccdc13 Compare December 12, 2023 15:19

Fixes #31425 - Render statuses

b1f012b

kamils-iRonin force-pushed the 31425-templates-rendering-host-status-3 branch from 7ccdc13 to b1f012b Compare February 15, 2024 19:14

kmalyjur suggested changes Mar 18, 2024

View reviewed changes

pr-processor bot added Waiting on contributor and removed Not yet reviewed labels Mar 18, 2024

github-actions bot added the Stale label Jun 18, 2024

github-actions bot added the Inactive label Jun 25, 2024

github-actions bot closed this Jun 25, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fixes #31425 - Render statuses #8984

Fixes #31425 - Render statuses #8984

kamils-iRonin commented Dec 9, 2021

theforeman-bot commented Dec 9, 2021

amirfefer commented Dec 13, 2021 •

edited

Loading

MariSvirik commented Dec 13, 2021

kamils-iRonin commented Dec 14, 2021

ares commented Dec 15, 2021

Ron-Lavi commented Apr 3, 2022

kamils-iRonin commented Apr 5, 2022

kamils-iRonin commented May 19, 2022

kamils-iRonin commented May 19, 2022

kamils-iRonin commented May 25, 2022

Ron-Lavi commented Oct 2, 2022

kamils-iRonin commented Nov 10, 2022

sbernhard commented Dec 8, 2023

kamils-iRonin commented Dec 12, 2023

kmalyjur commented Dec 13, 2023

kmalyjur left a comment •

edited

Loading

kmalyjur Mar 14, 2024

kmalyjur Mar 18, 2024

kmalyjur Mar 18, 2024

kmalyjur Mar 18, 2024

kmalyjur Mar 18, 2024

github-actions bot commented Jun 25, 2024

		object @render_status

		attributes :id

Fixes #31425 - Render statuses #8984

Fixes #31425 - Render statuses #8984

Conversation

kamils-iRonin commented Dec 9, 2021

theforeman-bot commented Dec 9, 2021

amirfefer commented Dec 13, 2021 • edited Loading

MariSvirik commented Dec 13, 2021

kamils-iRonin commented Dec 14, 2021

ares commented Dec 15, 2021

Ron-Lavi commented Apr 3, 2022

kamils-iRonin commented Apr 5, 2022

kamils-iRonin commented May 19, 2022

kamils-iRonin commented May 19, 2022

kamils-iRonin commented May 25, 2022

Ron-Lavi commented Oct 2, 2022

kamils-iRonin commented Nov 10, 2022

sbernhard commented Dec 8, 2023

kamils-iRonin commented Dec 12, 2023

kmalyjur commented Dec 13, 2023

kmalyjur left a comment • edited Loading

Choose a reason for hiding this comment

kmalyjur Mar 14, 2024

Choose a reason for hiding this comment

kmalyjur Mar 18, 2024

Choose a reason for hiding this comment

kmalyjur Mar 18, 2024

Choose a reason for hiding this comment

kmalyjur Mar 18, 2024

Choose a reason for hiding this comment

kmalyjur Mar 18, 2024

Choose a reason for hiding this comment

github-actions bot commented Jun 25, 2024

amirfefer commented Dec 13, 2021 •

edited

Loading

kmalyjur left a comment •

edited

Loading