Fixes #36166 - Revamp job hooks #791

adamruzicka · 2023-03-06T10:18:11Z

Per host in job now have per feature events when the action succeeds or fails.

Per job now have general running/stopped/failed as well as per feature running/stopped/failed events. Note, both the generic and per-feature are emitted.

m-bucher · 2023-03-14T16:37:19Z

Wanted to try this on my local foreman-3.1, so I backported the fix onto 5.0.6 and built it.
Unfortunately, when trying to create a webhook (foreman_webhooks-3.0.0) I get a UI-error.
Not sure if it is related to the fix 🤔 Any idea (I do not have a 3.1-dev environment, so the traceback is probably not helpful 🙈 )?

MyError: The push method cannot be invoked on an Immutable data structure.,
    in TypeaheadContainer(n)
    in div
    in t
    in div
    in t
    in j
    in t
    in FormikConnect(t)
    in m
    in div
    in section
    in u
    in ForwardRef
    in Tabs
    in l
    in form
    in d
    in t
    in f
    in y
    in y
    in div
    in t
    in div
    in div
    in div
    in me
    in r
    in t
    in H
    in t
    in div
    in Portal
    in t
    in Ae
    in m
    in y
    in y
    in d
    in Unknown
    in Unknown
    in Unknown
    in C
    in t
    in t
    in l
    in f
    in d
    in div
    in u
    in d
    in y
    in t
    in n
    in a
    in C
    in c
    in div
    in g
    in IntlProvider
    in I18nProviderWrapper(g)
    in d
    in StoreProvider(I18nProviderWrapper(g))
    in DataProvider(StoreProvider(I18nProviderWrapper(g)))

adamruzicka · 2023-03-14T17:36:22Z

Not sure if it is related to the fix

Considering I'm not touching any frontend bits here, I'd say it is unrelated, but who knows

m-bucher · 2023-03-21T08:24:55Z

app/lib/actions/remote_execution/event_helpers.rb

+      end
+
+      def emit_event(execution_plan, hook)
+        raise "HALT"


Oops, that was just to see the hooks are actually getting called, fixed.

m-bucher · 2023-03-21T14:36:42Z

Considering I'm not touching any frontend bits here, I'd say it is unrelated, but who knows

My current hypothesis is that simply the number of events is somehow to much for the TypeaheadSelect-component.
Based on the fact, that with this fix it gets 137 events 🤔

m-bucher · 2023-03-21T16:04:37Z

OK, so apparently it also happens on forklift with latest foreman_webhooks-Plugin. I should probably open an issue for foreman_webhooks, even though the problem seems to lay deeper 🤔

MyError: The push method cannot be invoked on an Immutable data structure.
    in TypeaheadContainer(WrappedTypeahead) (created by FieldInner)
    in div (created by Col)
    in Col (created by FormField)
    in div (created by FormGroup)
    in FormGroup (created by FormField)
    in FormField (created by FieldInner)
    in FieldInner (created by Context.Consumer)
    in FormikConnect(FieldInner) (created by ForemanFormikField)
    in ForemanFormikField (created by WebhookFormTabs)
    in div (created by WebhookFormTabs)
    in section (created by Context.Consumer)
    in TabContentBase (created by ForwardRef)
    in ForwardRef (created by Tabs)
    in Tabs (created by WebhookFormTabs)
    in WebhookFormTabs (created by WebhookForm)
    in form (created by Form)
    in Form (created by Formik)
    in Formik (created by ForemanForm)
    in ForemanForm (created by WebhookForm)
    in WebhookForm (created by ConnectedWebhookForm)
    in ConnectedWebhookForm (created by WebhookCreateModal)
    in div (created by ModalBody)
    in ModalBody (created by ForemanModal)
    in div (created by CustomModalDialog)
    in div (created by CustomModalDialog)
    in div (created by CustomModalDialog)
    in CustomModalDialog (created by Modal)
    in Transition (created by Fade)
    in Fade (created by DialogTransition)
    in DialogTransition (created by Modal)
    in RefHolder (created by Modal)
    in div (created by Modal)
    in Portal (created by Modal)
    in Modal (created by Modal)
    in Modal (created by ForemanModal)
    in ForemanModal (created by ConnectedForemanModal)
    in ConnectedForemanModal (created by WebhookCreateModal)
    in WebhookCreateModal (created by WebhooksIndexPage)
    in WebhooksIndexPage (created by Context.Consumer)
    in Route
    in Switch (created by ForemanSwitcher)
    in ForemanSwitcher (created by AppSwitcher)
    in AppSwitcher (created by ReactApp)
    in ErrorBoundary (created by ReactApp)
    in div (created by LayoutContainer)
    in LayoutContainer (created by Layout)
    in Layout (created by ConnectedLayout)
    in ConnectedLayout (created by ReactApp)
    in Router (created by ConnectedRouter)
    in ConnectedRouter (created by Context.Consumer)
    in ConnectedRouterWithContext (created by ConnectFunction)
    in ConnectFunction (created by ReactApp)
    in ApolloProvider (created by ReactApp)
    in div (created by ReactApp)
    in ReactApp (created by I18nProviderWrapper(ReactApp))
    in IntlProvider (created by I18nProviderWrapper(ReactApp))
    in I18nProviderWrapper(ReactApp) (created by StoreProvider(I18nProviderWrapper(ReactApp)))
    in Provider (created by StoreProvider(I18nProviderWrapper(ReactApp)))
    in StoreProvider(I18nProviderWrapper(ReactApp)) (created by DataProvider(StoreProvider(I18nProviderWrapper(ReactApp))))
    in DataProvider(StoreProvider(I18nProviderWrapper(ReactApp)))

ofedoren · 2023-03-22T12:43:25Z

theforeman/foreman_webhooks#56 should fix that.

adamruzicka · 2023-05-05T09:53:49Z

@m-bucher @ofedoren anything left to do here?

m-bucher · 2023-05-15T15:07:26Z

app/lib/actions/remote_execution/event_helpers.rb

+      def emit_event(execution_plan, hook)
+        return unless root_action?
+
+        if input["job_features"]&.any?


Just tested it again on my forklift and had the problem, that the Event was not triggered, because there were no job_features present:

{ "host": { "id": 1, "name": "centos8-katello-devel-stable.example.com" }, "job_category": "Commands", "description": "Run uname -a", "job_invocation_id": 1, "job_features": [], "proxy_id": 1, "delegated_action_id": 2, "with_event_logging": true, "locale": "de", "current_request_id": "8c551231-c6d4-49fa-9864-845ad758a0ba", "current_timezone": "Europe/Berlin", "current_user_id": 4, "current_organization_id": 1, "current_location_id": 2 }

How did you trigger the job?

Edit: Wait, what are we even doing here
Edit 2: Oh, this, I'll take a look

I think we have to trigger the event "#{self.class.event_name_base}_#{self.class.event_name_suffix(hook)}" if there are no features defined, which will then mean triggering the 'generic' actions.remote_execution.run_hosts_job_(failed|success|running) event.

m-bucher · 2023-05-17T14:16:19Z

app/lib/actions/remote_execution/event_helpers.rb

+
+        if input["job_features"]&.any?
+          payload = event_payload(execution_plan)
+          input['job_features'].each do |feature|
+            name = "#{self.class.event_name_base}_#{feature}_#{self.class.event_name_suffix(hook)}"
+            trigger_hook name, payload: payload
+          end


The following change sends 'Host(s) Job' event, if no features are specified.
We could also always trigger that event since 🤔

Suggested change

if input["job_features"]&.any?

payload = event_payload(execution_plan)

input['job_features'].each do |feature|

name = "#{self.class.event_name_base}_#{feature}_#{self.class.event_name_suffix(hook)}"

trigger_hook name, payload: payload

end

payload = event_payload(execution_plan)

if input["job_features"]&.any?

input['job_features'].each do |feature|

name = "#{self.class.event_name_base}_#{feature}_#{self.class.event_name_suffix(hook)}"

trigger_hook name, payload: payload

end

else

name = "#{self.class.event_name_base}_#{self.class.event_name_suffix(hook)}"

trigger_hook name, payload: payload

end

adamruzicka · 2023-08-02T09:15:37Z

@m-bucher Hi, could you please check this out once more?

m-bucher · 2023-08-22T13:12:33Z

@adamruzicka sorry for the delay 😇

The latest patch works for me 👍

Per host in job now have per feature events when the action succeeds or fails. Per job now have general running/stopped/failed as well as per feature running/stopped/failed events.

adamruzicka · 2023-10-16T13:36:41Z

Sorry that I keep changing this all the time, but I managed to remove some of the code by reusing things which were added in tasks recently.

I mapped multiple features to a single template and then run it. Excerpts from logs:

# grep d91fe80a log/development.log | grep EventSubscriber | grep running
2023-10-16T15:18:13 [I|app|d91fe80a] ForemanWebhooks::EventSubscriber: actions.remote_execution.run_hosts_job_ansible_run_host_running.event.foreman event received
2023-10-16T15:18:13 [I|app|d91fe80a] ForemanWebhooks::EventSubscriber: actions.remote_execution.run_hosts_job_katello_package_install_running.event.foreman event received
2023-10-16T15:18:13 [I|app|d91fe80a] ForemanWebhooks::EventSubscriber: actions.remote_execution.run_hosts_job_running.event.foreman event received

# grep d91fe80a log/development.log | grep EventSubscriber | grep succeeded
2023-10-16T15:18:17 [I|app|d91fe80a] ForemanWebhooks::EventSubscriber: actions.remote_execution.run_host_job_ansible_run_host_succeeded.event.foreman event received
2023-10-16T15:18:17 [I|app|d91fe80a] ForemanWebhooks::EventSubscriber: actions.remote_execution.run_host_job_katello_package_install_succeeded.event.foreman event received
2023-10-16T15:18:17 [I|app|d91fe80a] ForemanWebhooks::EventSubscriber: actions.remote_execution.run_host_job_succeeded.event.foreman event received
2023-10-16T15:18:28 [I|app|d91fe80a] ForemanWebhooks::EventSubscriber: actions.remote_execution.run_hosts_job_ansible_run_host_succeeded.event.foreman event received
2023-10-16T15:18:28 [I|app|d91fe80a] ForemanWebhooks::EventSubscriber: actions.remote_execution.run_hosts_job_katello_package_install_succeeded.event.foreman event received
2023-10-16T15:18:28 [I|app|d91fe80a] ForemanWebhooks::EventSubscriber: actions.remote_execution.run_hosts_job_succeeded.event.foreman event received

On failure

# grep 44c0528a log/development.log | grep EventSubscriber | grep running
2023-10-16T15:35:10 [I|app|44c0528a] ForemanWebhooks::EventSubscriber: actions.remote_execution.run_hosts_job_katello_package_install_running.event.foreman event received
2023-10-16T15:35:10 [I|app|44c0528a] ForemanWebhooks::EventSubscriber: actions.remote_execution.run_hosts_job_ansible_run_host_running.event.foreman event received
2023-10-16T15:35:10 [I|app|44c0528a] ForemanWebhooks::EventSubscriber: actions.remote_execution.run_hosts_job_running.event.foreman event received

# grep 44c0528a log/development.log | grep EventSubscriber | grep failed
2023-10-16T15:35:16 [I|app|44c0528a] ForemanWebhooks::EventSubscriber: actions.remote_execution.run_host_job_katello_package_install_failed.event.foreman event received
2023-10-16T15:35:16 [I|app|44c0528a] ForemanWebhooks::EventSubscriber: actions.remote_execution.run_host_job_ansible_run_host_failed.event.foreman event received
2023-10-16T15:35:16 [I|app|44c0528a] ForemanWebhooks::EventSubscriber: actions.remote_execution.run_host_job_failed.event.foreman event received
2023-10-16T15:35:26 [I|app|44c0528a] ForemanWebhooks::EventSubscriber: actions.remote_execution.run_hosts_job_katello_package_install_failed.event.foreman event received
2023-10-16T15:35:26 [I|app|44c0528a] ForemanWebhooks::EventSubscriber: actions.remote_execution.run_hosts_job_ansible_run_host_failed.event.foreman event received
2023-10-16T15:35:26 [I|app|44c0528a] ForemanWebhooks::EventSubscriber: actions.remote_execution.run_hosts_job_failed.event.foreman event received

m-bucher

Still works as far as I can say so 👍

But you might want to merge it eventually 😉

adamruzicka · 2023-11-22T13:07:55Z

Thank you @m-bucher !

theforeman-bot added the Not yet reviewed label Mar 6, 2023

adamruzicka mentioned this pull request Mar 6, 2023

Fixes #36149 - Emit event when job fails #790

Closed

adamruzicka force-pushed the event-revamp branch from 954b183 to c94b00c Compare March 6, 2023 13:27

m-bucher suggested changes Mar 21, 2023

View reviewed changes

theforeman-bot added Waiting on contributor and removed Not yet reviewed labels Mar 21, 2023

adamruzicka force-pushed the event-revamp branch from c94b00c to 3717b5f Compare March 21, 2023 08:38

theforeman-bot added Needs re-review and removed Waiting on contributor labels Mar 21, 2023

adamruzicka force-pushed the event-revamp branch from 3717b5f to 6750648 Compare March 21, 2023 08:51

m-bucher reviewed May 15, 2023

View reviewed changes

m-bucher reviewed May 17, 2023

View reviewed changes

adamruzicka force-pushed the event-revamp branch from 6750648 to a3869bb Compare July 19, 2023 08:29

m-bucher approved these changes Aug 22, 2023

View reviewed changes

theforeman-bot removed the Needs re-review label Aug 22, 2023

adamruzicka added 2 commits October 16, 2023 14:52

Fixes #36166 - Revamp job hooks

46d3031

Per host in job now have per feature events when the action succeeds or fails. Per job now have general running/stopped/failed as well as per feature running/stopped/failed events.

Fixes #36166 - Reuse new things from f-t

dd72122

adamruzicka force-pushed the event-revamp branch from a3869bb to dd72122 Compare October 16, 2023 13:25

m-bucher approved these changes Nov 17, 2023

View reviewed changes

adamruzicka merged commit cde629a into theforeman:master Nov 22, 2023
4 checks passed

adamruzicka deleted the event-revamp branch November 22, 2023 13:07

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fixes #36166 - Revamp job hooks #791

Fixes #36166 - Revamp job hooks #791

adamruzicka commented Mar 6, 2023 •

edited

m-bucher commented Mar 14, 2023

adamruzicka commented Mar 14, 2023

m-bucher Mar 21, 2023

adamruzicka Mar 21, 2023

m-bucher commented Mar 21, 2023

m-bucher commented Mar 21, 2023

ofedoren commented Mar 22, 2023

adamruzicka commented May 5, 2023

m-bucher May 15, 2023

adamruzicka May 15, 2023 •

edited

m-bucher May 15, 2023

m-bucher May 17, 2023

adamruzicka commented Aug 2, 2023

m-bucher commented Aug 22, 2023

adamruzicka commented Oct 16, 2023

m-bucher left a comment

adamruzicka commented Nov 22, 2023

Fixes #36166 - Revamp job hooks #791

Fixes #36166 - Revamp job hooks #791

Conversation

adamruzicka commented Mar 6, 2023 • edited

m-bucher commented Mar 14, 2023

adamruzicka commented Mar 14, 2023

m-bucher Mar 21, 2023

Choose a reason for hiding this comment

adamruzicka Mar 21, 2023

Choose a reason for hiding this comment

m-bucher commented Mar 21, 2023

m-bucher commented Mar 21, 2023

ofedoren commented Mar 22, 2023

adamruzicka commented May 5, 2023

m-bucher May 15, 2023

Choose a reason for hiding this comment

adamruzicka May 15, 2023 • edited

Choose a reason for hiding this comment

m-bucher May 15, 2023

Choose a reason for hiding this comment

m-bucher May 17, 2023

Choose a reason for hiding this comment

adamruzicka commented Aug 2, 2023

m-bucher commented Aug 22, 2023

adamruzicka commented Oct 16, 2023

m-bucher left a comment

Choose a reason for hiding this comment

adamruzicka commented Nov 22, 2023

adamruzicka commented Mar 6, 2023 •

edited

adamruzicka May 15, 2023 •

edited