Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[fix][proxy] Only go to connecting state once #19331

Merged

Conversation

michaeljmarshall
Copy link
Member

@michaeljmarshall michaeljmarshall commented Jan 26, 2023

Relates to: #17831 (comment)

Motivation

When the ProxyConnection handles a Connect command, that is the time to go to Connecting state. There is no other time that makes sense to switch to connecting. The current logic will go to connecting in certain re-authentication scenarios, but those are incorrect. By moving the state change to earlier in the logic, we make the state transition clearer and prevent corrupted state.

Modifications

  • Remove state = State.Connecting from the doAuthentication method, which is called multiple times for various reasons
  • Add state = State.Connecting to the start of the handleConnect method.

Verifying this change

The existing tests will verify this change, and reading through the code makes it clear this is a correct change.

Does this pull request potentially affect one of the following parts:

Not a breaking change.

Documentation

  • doc-not-needed

It would be nice to map out the state transitions for our connection classes. That is our of the scope of this small improvement.

Matching PR in forked repository

PR in forked repository: michaeljmarshall#21

@michaeljmarshall michaeljmarshall self-assigned this Jan 26, 2023
@michaeljmarshall michaeljmarshall added doc-not-needed Your PR changes do not impact docs area/proxy and removed doc-label-missing labels Jan 26, 2023
@michaeljmarshall michaeljmarshall added this to the 2.12.0 milestone Jan 26, 2023
@apache apache deleted a comment from github-actions bot Jan 26, 2023
@michaeljmarshall michaeljmarshall changed the title [improve][proxy] Only go to connecting once [fix][proxy] Only go to connecting state once Jan 26, 2023
@lhotari
Copy link
Member

lhotari commented Jan 27, 2023

/pulsarbot rerun-failure-checks

@michaeljmarshall michaeljmarshall merged commit c8650ce into apache:master Jan 31, 2023
michaeljmarshall added a commit that referenced this pull request Jan 31, 2023
Relates to: #17831 (comment)

### Motivation

When the `ProxyConnection` handles a `Connect` command, that is the time to go to `Connecting` state. There is no other time that makes sense to switch to connecting. The current logic will go to connecting in certain re-authentication scenarios, but those are incorrect. By moving the state change to earlier in the logic, we make the state transition clearer and prevent corrupted state.

### Modifications

* Remove `state = State.Connecting` from the `doAuthentication` method, which is called multiple times for various reasons
* Add `state = State.Connecting` to the start of the `handleConnect` method.

### Verifying this change

The existing tests will verify this change, and reading through the code makes it clear this is a correct change.

### Does this pull request potentially affect one of the following parts:

Not a breaking change.

### Documentation

- [x] `doc-not-needed`

It would be nice to map out the state transitions for our connection classes. That is our of the scope of this small improvement.

### Matching PR in forked repository

PR in forked repository: michaeljmarshall#21

(cherry picked from commit c8650ce)
michaeljmarshall added a commit that referenced this pull request Jan 31, 2023
Relates to: #17831 (comment)

### Motivation

When the `ProxyConnection` handles a `Connect` command, that is the time to go to `Connecting` state. There is no other time that makes sense to switch to connecting. The current logic will go to connecting in certain re-authentication scenarios, but those are incorrect. By moving the state change to earlier in the logic, we make the state transition clearer and prevent corrupted state.

### Modifications

* Remove `state = State.Connecting` from the `doAuthentication` method, which is called multiple times for various reasons
* Add `state = State.Connecting` to the start of the `handleConnect` method.

### Verifying this change

The existing tests will verify this change, and reading through the code makes it clear this is a correct change.

### Does this pull request potentially affect one of the following parts:

Not a breaking change.

### Documentation

- [x] `doc-not-needed`

It would be nice to map out the state transitions for our connection classes. That is our of the scope of this small improvement.

### Matching PR in forked repository

PR in forked repository: michaeljmarshall#21

(cherry picked from commit c8650ce)
michaeljmarshall added a commit that referenced this pull request Jan 31, 2023
Relates to: #17831 (comment)

### Motivation

When the `ProxyConnection` handles a `Connect` command, that is the time to go to `Connecting` state. There is no other time that makes sense to switch to connecting. The current logic will go to connecting in certain re-authentication scenarios, but those are incorrect. By moving the state change to earlier in the logic, we make the state transition clearer and prevent corrupted state.

### Modifications

* Remove `state = State.Connecting` from the `doAuthentication` method, which is called multiple times for various reasons
* Add `state = State.Connecting` to the start of the `handleConnect` method.

### Verifying this change

The existing tests will verify this change, and reading through the code makes it clear this is a correct change.

### Does this pull request potentially affect one of the following parts:

Not a breaking change.

### Documentation

- [x] `doc-not-needed`

It would be nice to map out the state transitions for our connection classes. That is our of the scope of this small improvement.

### Matching PR in forked repository

PR in forked repository: michaeljmarshall#21

(cherry picked from commit c8650ce)
@michaeljmarshall michaeljmarshall added the cherry-picked/branch-2.9 Archived: 2.9 is end of life label Jan 31, 2023
@michaeljmarshall michaeljmarshall deleted the proxy-connecting-state branch February 1, 2023 06:57
nicoloboschi pushed a commit to datastax/pulsar that referenced this pull request Feb 28, 2023
Relates to: apache#17831 (comment)

### Motivation

When the `ProxyConnection` handles a `Connect` command, that is the time to go to `Connecting` state. There is no other time that makes sense to switch to connecting. The current logic will go to connecting in certain re-authentication scenarios, but those are incorrect. By moving the state change to earlier in the logic, we make the state transition clearer and prevent corrupted state.

### Modifications

* Remove `state = State.Connecting` from the `doAuthentication` method, which is called multiple times for various reasons
* Add `state = State.Connecting` to the start of the `handleConnect` method.

### Verifying this change

The existing tests will verify this change, and reading through the code makes it clear this is a correct change.

### Does this pull request potentially affect one of the following parts:

Not a breaking change.

### Documentation

- [x] `doc-not-needed`

It would be nice to map out the state transitions for our connection classes. That is our of the scope of this small improvement.

### Matching PR in forked repository

PR in forked repository: michaeljmarshall#21

(cherry picked from commit c8650ce)
(cherry picked from commit f9e24f2)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants