[JENKINS-30101][JENKINS-30175] Simplify persistence design for temporarily offline status #9855

Vlatombe · 2024-10-11T13:45:16Z

There were complex code to synchronize transient state of Computer from Node and vice versa.
But since any temporarily offline cause is being set by a user and should be persisted in a Node, the Computer should actually delegate to Node instead of trying to synchronize its state.

Fixes JENKINS-30101 and JENKINS-30175

Testing done

Proposed changelog entries

Keep user offline reason when agent connects or disconnects for technical reasons.

Proposed upgrade guidelines

N/A

Submitter checklist

Give feedback

The Jira issue, if it exists, is well-described.
The changelog entries and upgrade guidelines are appropriate for the audience affected by the change (users or developers, depending on the change) and are in the imperative mood (see examples). Fill in the Proposed upgrade guidelines section only if there are breaking changes or changes that may require extra steps from users during upgrade.
There is automated testing or an explanation as to why this change has no tests.
New public classes, fields, and methods are annotated with @Restricted or have @since TODO Javadocs, as appropriate.
New deprecations are annotated with @Deprecated(since = "TODO") or @Deprecated(forRemoval = true, since = "TODO"), if applicable.
New or substantially changed JavaScript is not defined inline and does not call eval to ease future introduction of Content Security Policy (CSP) directives (see documentation).
For dependency updates, there are links to external changelogs and, if possible, full differentials.
For new APIs and extension points, there is a link to at least one consumer.
Options

Desired reviewers

@mention

Before the changes are marked as ready-for-merge:

Maintainer checklist

Give feedback

There are at least two (2) approvals for the pull request and no outstanding requests for change.
Conversations in the pull request are over, or it is explicit that a reviewer is not blocking the change.
Changelog entries in the pull request title and/or Proposed changelog entries are accurate, human-readable, and in the imperative mood.
Proper changelog labels are set so that the changelog can be generated automatically.
If the change needs additional upgrade steps from users, the upgrade-guide-needed label is set and there is a Proposed upgrade guidelines section in the pull request title (see example).
If it would make sense to backport the change to LTS, a Jira issue must exist, be a Bug or Improvement, and be labeled as lts-candidate to be considered (see query).
Options

There were complex code to synchronize transient state of Computer from Node. But since any temporarily offline cause is being set by a user and should be persisted in a node, the Computer should actually delegate to Node instead of trying to synchronize it

Vlatombe · 2024-10-11T13:49:29Z

core/src/main/java/hudson/model/Computer.java

+ getNodeOrDie().setTemporaryOfflineCause(temporarilyOfflineCause);
+ if (temporarilyOfflineCause != null) {
+ Listeners.notify(ComputerListener.class, false, l -> l.onTemporarilyOffline(this, temporarilyOfflineCause));
 } else {
 Listeners.notify(ComputerListener.class, false, l -> l.onTemporarilyOnline(this));
 }


The field offlineCause is only for technical offline cause now. temporarilyOfflineCause only exists in Node now.

Vlatombe · 2024-10-11T13:50:06Z

core/src/main/java/hudson/model/Computer.java

+ var temporaryOfflineCause = getNodeOrDie().getTemporaryOfflineCause();
+ return temporaryOfflineCause == null ? offlineCause : temporaryOfflineCause;


Retaining previous behaviour : if a temporary offline cause is defined, from outside PoV, it replaces the technical offline cause.

jglick

getNodeOrDie is probably wrong. Otherwise looks good.

core/src/main/java/hudson/model/Computer.java

core/src/main/java/hudson/model/Node.java

core/src/main/java/hudson/model/Computer.java

jglick

Just a nit in isOffline.

core/src/main/java/hudson/model/Computer.java

Co-authored-by: Jesse Glick <[email protected]>

mawinter69 · 2024-10-14T07:11:56Z

I think this will solve several issues that I also addressed in #6152.
What is missing here is showing the reason why an agent is temporarily offline on the agents page when that reason differs from the agent being disconnected (e.g. lost connection)

mawinter69 · 2024-10-14T07:14:25Z

I think you will also need to adjust setOfflineCause.jelly in some way

Retain the original message for setting the node temporary offline

Vlatombe · 2024-10-14T07:50:41Z

What is missing here is showing the reason why an agent is temporarily offline on the agents page when that reason differs from the agent being disconnected (e.g. lost connection)

Looks like a separate change impacting UX.

timja

LGTM

mawinter69

Previously setting an agent temporarily offline also set the offline cause itself.
With this change once you set the agent temporarily offline it is not possible to get the offline cause that might have been set when disconnecting the agent after it was set temp offline.
Not sure if this will have implications for plugins.

getOfflineCauseReason will return an empty string now if an agent is only temp offline. This will break these tests I think:
https://github.com/jenkinsci/node-sharing-plugin/blob/ae54615d1213196f3ca91073caf7c2850758e85a/jth-tests/src/test/java/com/redhat/jenkins/nodesharing/SharedNodeCloudTest.java#L531
https://github.com/jenkinsci/openstack-cloud-plugin/blob/fc5384db4d5f1f4f2ebdec2aec7e28ce312cf0df/plugin/src/test/java/jenkins/plugins/openstack/compute/SingleUseSlaveTest.java#L137
Maybe also tests in https://github.com/jenkinsci/java-client-api and others

Vlatombe · 2024-10-14T14:55:04Z

@mawinter69 Addressed your remark

jglick

OK I think. Seems worth running tests of the plugins mentioned.

core/src/main/java/hudson/model/Computer.java

mawinter69 · 2024-10-14T16:11:11Z

core/src/main/java/hudson/model/Computer.java

+ * Use {@link #setTemporaryOfflineCause(OfflineCause)} instead.
+ */
+ @Deprecated
+ public void setTemporarilyOffline(boolean temporarilyOffline, OfflineCause cause) {


The javadoc is lost here especially that the second argument is only considered when the first is true. But maybe this doesn't matter as the method is now set to deprecated.

Yes, I'm dropping existing javadoc to avoid repeats, and only refer to the current methods.

Vlatombe · 2024-10-14T16:15:06Z

/label ready-for-merge

This PR is now ready for merge, after ~24 hours, we will merge it if there's no negative feedback.

Thanks!

mawinter69 · 2024-10-14T22:07:24Z

Can we mark this as fix for
JENKINS-30101
JENKINS-30175
JENKINS-50313

Vlatombe · 2024-10-15T07:01:10Z

Keeping JENKINS-50313 out, since this PR doesn't cover showing both offline causes.

Vlatombe requested a review from jglick October 11, 2024 13:45

Fix javadoc

962a286

Vlatombe commented Oct 11, 2024

View reviewed changes

jglick requested changes Oct 11, 2024

View reviewed changes

Vlatombe added 3 commits October 11, 2024 16:34

Fix tests and apply suggestions

888103c

Fix getNodeOrDie()

0d129d9

Reduce visibility of Node#isTemporarilyOffline

1d20b1c

Vlatombe requested a review from jglick October 11, 2024 16:05

jglick reviewed Oct 11, 2024

View reviewed changes

core/src/main/java/hudson/model/Computer.java Outdated Show resolved Hide resolved

jglick reviewed Oct 11, 2024

View reviewed changes

core/src/main/java/hudson/model/Computer.java Outdated Show resolved Hide resolved

Remove getNodeOrDie

d60e43a

jglick reviewed Oct 13, 2024

View reviewed changes

core/src/main/java/hudson/model/Computer.java Outdated Show resolved Hide resolved

Update core/src/main/java/hudson/model/Computer.java

83026da

Co-authored-by: Jesse Glick <[email protected]>

Fix setOfflineCause

59da0e8

Retain the original message for setting the node temporary offline

Vlatombe requested review from jglick and a team October 14, 2024 07:50

timja approved these changes Oct 14, 2024

View reviewed changes

jglick approved these changes Oct 14, 2024

View reviewed changes

jglick requested a review from mawinter69 October 14, 2024 13:08

mawinter69 reviewed Oct 14, 2024

View reviewed changes

Align getOfflineCauseReason with getOfflineCause

a6c06cf

jglick approved these changes Oct 14, 2024

View reviewed changes

mawinter69 suggested changes Oct 14, 2024

View reviewed changes

core/src/main/java/hudson/model/Computer.java Show resolved Hide resolved

Fix behaviour of setTemporarilyOffline(boolean, OfflineCause)

e2d4126

Vlatombe requested a review from mawinter69 October 14, 2024 15:54

mawinter69 approved these changes Oct 14, 2024

View reviewed changes

comment-ops-bot bot added the ready-for-merge The PR is ready to go, and it will be merged soon if there is no negative feedback label Oct 14, 2024

timja added the skip-changelog Should not be shown in the changelog label Oct 14, 2024

Vlatombe changed the title ~~Simplify persistence design for temporarily offline status~~ [JENKINS-30101][JENKINS-30175][JENKINS-50313] Simplify persistence design for temporarily offline status Oct 15, 2024

Vlatombe changed the title ~~[JENKINS-30101][JENKINS-30175][JENKINS-50313] Simplify persistence design for temporarily offline status~~ [JENKINS-30101][JENKINS-30175] Simplify persistence design for temporarily offline status Oct 15, 2024

Vlatombe removed the skip-changelog Should not be shown in the changelog label Oct 15, 2024

Vlatombe added 2 commits October 15, 2024 09:03

Flag deprecation correctly

3a6d79c

Javadoc and @SInCE as applicable

168ffeb

mawinter69 mentioned this pull request Oct 15, 2024

[JENKINS-30101] avoid temporarily offline cause is overwritten #6152

Closed

10 tasks

jglick approved these changes Oct 15, 2024

View reviewed changes

timja merged commit b50cf51 into jenkinsci:master Oct 15, 2024
16 checks passed

Vlatombe deleted the temporarily-offline-cause branch October 15, 2024 15:38

MarkEWaite added the bug For changelog: Minor bug. Will be listed after features label Oct 16, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[JENKINS-30101][JENKINS-30175] Simplify persistence design for temporarily offline status #9855

[JENKINS-30101][JENKINS-30175] Simplify persistence design for temporarily offline status #9855

Vlatombe commented Oct 11, 2024 •

edited

Loading

Submitter checklist

Maintainer checklist

Vlatombe Oct 11, 2024

Vlatombe Oct 11, 2024

jglick left a comment

jglick left a comment

mawinter69 commented Oct 14, 2024 •

edited

Loading

mawinter69 commented Oct 14, 2024

Vlatombe commented Oct 14, 2024

timja left a comment

mawinter69 left a comment

Vlatombe commented Oct 14, 2024

jglick left a comment

mawinter69 Oct 14, 2024

Vlatombe Oct 14, 2024

Vlatombe commented Oct 14, 2024

mawinter69 commented Oct 14, 2024

Vlatombe commented Oct 15, 2024

		var temporaryOfflineCause = getNodeOrDie().getTemporaryOfflineCause();
		return temporaryOfflineCause == null ? offlineCause : temporaryOfflineCause;

[JENKINS-30101][JENKINS-30175] Simplify persistence design for temporarily offline status #9855

[JENKINS-30101][JENKINS-30175] Simplify persistence design for temporarily offline status #9855

Conversation

Vlatombe commented Oct 11, 2024 • edited Loading

Testing done

Proposed changelog entries

Proposed upgrade guidelines

Submitter checklist

Desired reviewers

Maintainer checklist

Vlatombe Oct 11, 2024

Choose a reason for hiding this comment

Vlatombe Oct 11, 2024

Choose a reason for hiding this comment

jglick left a comment

Choose a reason for hiding this comment

jglick left a comment

Choose a reason for hiding this comment

mawinter69 commented Oct 14, 2024 • edited Loading

mawinter69 commented Oct 14, 2024

Vlatombe commented Oct 14, 2024

timja left a comment

Choose a reason for hiding this comment

mawinter69 left a comment

Choose a reason for hiding this comment

Vlatombe commented Oct 14, 2024

jglick left a comment

Choose a reason for hiding this comment

mawinter69 Oct 14, 2024

Choose a reason for hiding this comment

Vlatombe Oct 14, 2024

Choose a reason for hiding this comment

Vlatombe commented Oct 14, 2024

mawinter69 commented Oct 14, 2024

Vlatombe commented Oct 15, 2024

Vlatombe commented Oct 11, 2024 •

edited

Loading

mawinter69 commented Oct 14, 2024 •

edited

Loading