Introduce TokenDisabled event for WorkflowRuns by hellcp-work · Pull Request #19431 · openSUSE/open-build-service

hellcp-work · 2026-03-13T13:42:31Z

src/api/app/models/event/token_disabled.rb

hennevogel · 2026-03-13T14:30:25Z

src/api/app/models/event/token_disabled.rb

+    receiver_roles :token_executor, :token_member
+    delegate :members, to: :token, prefix: true
+
+    self.notification_explanation = 'Receive notifications for disabled workflow tokens.'


I guess this begs the question that people probably want to know about other Token state changes too...

hennevogel · 2026-03-13T15:27:48Z

src/api/app/models/event/token_disabled.rb

+    receiver_roles :token_executor, :token_member
+    delegate :members, to: :token, prefix: true
+
+    self.notification_explanation = 'Receive notifications for disabled workflow tokens.'


Suggested change

self.notification_explanation = 'Receive notifications for disabled workflow tokens.'

self.notification_explanation = 'Receive a notification when a workflow token is disabled.'

hennevogel · 2026-03-13T15:28:38Z

src/api/app/models/event/token_disabled.rb

+    self.notification_explanation = 'Receive notifications for disabled workflow tokens.'
+
+    def subject
+      "Workflow Token '#{token.description}' was disabled"


Suggested change

"Workflow Token '#{token.description}' was disabled"

"Workflow Token '#{token.id}' was disabled"

hennevogel · 2026-03-13T15:29:22Z

src/api/app/views/event_mailer/token_disabled.html.haml

@@ -0,0 +1,7 @@
+%p
+  The Workflow Token
+  '#{Token.find(event['token_id']).description}'


description might be nil...

hennevogel · 2026-03-13T15:31:02Z

src/api/app/views/event_mailer/token_disabled.html.haml

+%p
+  The Workflow Token
+  '#{Token.find(event['token_id']).description}'
+  was disabled.


Suggested change

was disabled.

was disabled because we encountered authentication problems while reporting workflow status back to the SCM. Please check your setup.

hennevogel · 2026-03-13T15:31:41Z

src/api/app/models/event/token_disabled.rb

+    self.notification_explanation = 'Receive notifications for workflow tokens disabled automatically.'
+
+    def subject
+      "Workflow Token '#{token.description}' was disabled automatically"


Suggested change

"Workflow Token '#{token.description}' was disabled automatically"

"Workflow Token '#{token.id}' was disabled automatically"

hennevogel · 2026-03-13T15:32:14Z

src/api/app/models/event/token_disabled.rb

+    receiver_roles :token_executor, :token_member
+    delegate :members, to: :token, prefix: true
+
+    self.notification_explanation = 'Receive notifications for workflow tokens disabled automatically.'


Suggested change

self.notification_explanation = 'Receive notifications for workflow tokens disabled automatically.'

self.notification_explanation = 'Receive notifications when a workflow token gets disabled.'

hennevogel · 2026-03-13T15:33:27Z

src/api/app/views/event_mailer/token_disabled.html.haml

+%p
+  The Workflow Token
+  '#{Token.find(event['token_id']).description}'
+  was automatically disabled due to a failed call to the SCM.


Suggested change

was automatically disabled due to a failed call to the SCM.

was automatically disabled due to authorization problems when reporting workflow status to Gihub/Gitlab/Gitea. Please check your setup.

hennevogel · 2026-03-13T15:33:51Z

src/api/app/views/event_mailer/token_disabled.text.erb

@@ -0,0 +1,3 @@
+The Workflow Token '<%= Token.find(event['token_id']).description %>' was automatically disabled due to a failed call to the SCM.


Suggested change

The Workflow Token '<%= Token.find(event['token_id']).description %>' was automatically disabled due to a failed call to the SCM.

The Workflow Token '<%= Token.find(event['token_id']).description %>' was automatically disabled due to authorization problems when reporting workflow status to Gihub/Gitlab/Gitea. Please check your setup.

hennevogel · 2026-03-16T15:58:03Z

src/api/app/controllers/person/token_controller.rb

+      token_enabled = token.enabled
      if token.update(xml_attributes)
+        Event::TokenDisabled.create(id: token.workflow_runs.first&.id, token_id: token.id, user_id: @user.id, reason: "Disabled by #{@user.login}.") if token_enabled && !token.enabled


This sounds like Token (callback) code to me to be honest.

I'm worried about triggering this twice in case of the detected automated token disablement

What exactly are you worried about?

If we do it when the change is triggered on the after save level and then trigger it on the change happens in the automated way in another model, we end up with two events for the same action

why would you do both?

To know what the reason for the change was

See the commit_opts pattern in Project for instance...

hennevogel · 2026-03-23T12:53:25Z

src/api/app/models/event/token_disabled.rb

@@ -0,0 +1,52 @@
+module Event
+  class TokenDisabled < Base


Time to rename this event and also notify when the token is enabled again.

github-actions bot added the Frontend Things related to the OBS RoR app label Mar 13, 2026

eduardoj reviewed Mar 13, 2026

View reviewed changes

src/api/app/models/event/token_disabled.rb Outdated Show resolved Hide resolved

hellcp-work force-pushed the token-notif branch from b221b71 to 3aba0a8 Compare March 13, 2026 15:30

hennevogel requested changes Mar 13, 2026

View reviewed changes

hellcp-work force-pushed the token-notif branch 2 times, most recently from e6c2648 to f7747f7 Compare March 16, 2026 13:25

github-actions bot added the Test Suite / CI 💉 Things related to our tests/CI label Mar 16, 2026

hennevogel reviewed Mar 16, 2026

View reviewed changes

hellcp-work force-pushed the token-notif branch 2 times, most recently from 405443f to e7b0054 Compare March 19, 2026 12:09

Introduce TokenDisabled event for WorkflowRuns

e62dfc5

hellcp-work force-pushed the token-notif branch from e7b0054 to e62dfc5 Compare March 20, 2026 09:37

hennevogel reviewed Mar 23, 2026

View reviewed changes

	self.notification_explanation = 'Receive notifications for disabled workflow tokens.'
	self.notification_explanation = 'Receive a notification when a workflow token is disabled.'

	"Workflow Token '#{token.description}' was disabled"
	"Workflow Token '#{token.id}' was disabled"

	was disabled.
	was disabled because we encountered authentication problems while reporting workflow status back to the SCM. Please check your setup.

	was automatically disabled due to a failed call to the SCM.
	was automatically disabled due to authorization problems when reporting workflow status to Gihub/Gitlab/Gitea. Please check your setup.

		@@ -0,0 +1,3 @@
		The Workflow Token '<%= Token.find(event['token_id']).description %>' was automatically disabled due to a failed call to the SCM.

Conversation

hellcp-work commented Mar 13, 2026

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hennevogel Mar 16, 2026 • 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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

hennevogel Mar 16, 2026 •

edited

Loading