-
Notifications
You must be signed in to change notification settings - Fork 63
fix(server): stop scene lock release from getting stuck on a canceled context (REL-03) #2371
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
Open
wilfredmulenga
wants to merge
2
commits into
main
Choose a base branch
from
note-rel-03-scene-lock-context-cancel
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+68
−1
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| package interactor | ||
|
|
||
| import ( | ||
| "context" | ||
| "testing" | ||
|
|
||
| "github.com/reearth/reearth/server/pkg/id" | ||
| "github.com/reearth/reearth/server/pkg/scene" | ||
| "github.com/stretchr/testify/assert" | ||
| ) | ||
|
|
||
| type recordingSceneLockRepo struct { | ||
| saveLockCtxErr error | ||
| } | ||
|
|
||
| func (r *recordingSceneLockRepo) GetLock(context.Context, id.SceneID) (scene.LockMode, error) { | ||
| return scene.LockModeFree, nil | ||
| } | ||
|
|
||
| func (r *recordingSceneLockRepo) GetAllLock(context.Context, id.SceneIDList) ([]scene.LockMode, error) { | ||
| return nil, nil | ||
| } | ||
|
|
||
| func (r *recordingSceneLockRepo) SaveLock(ctx context.Context, _ id.SceneID, _ scene.LockMode) error { | ||
| r.saveLockCtxErr = ctx.Err() | ||
| return ctx.Err() | ||
| } | ||
|
|
||
| func (r *recordingSceneLockRepo) ReleaseAllLock(context.Context) error { | ||
| return nil | ||
| } | ||
|
|
||
| // TestReleaseSceneLock_SurvivesCanceledContext is a regression test for REL-03: | ||
| // ReleaseSceneLock is deferred from publish flows using the same request context | ||
| // the publish itself used. If that request's context is already canceled (e.g. | ||
| // the client disconnected mid upload), calling SaveLock on the bare context fails | ||
| // with "context canceled" and leaves the scene stuck locked forever. This confirms | ||
| // the SaveLock call underneath still runs against a live context even when the | ||
| // caller's context is canceled first. | ||
| func TestReleaseSceneLock_SurvivesCanceledContext(t *testing.T) { | ||
| repo := &recordingSceneLockRepo{} | ||
| d := commonSceneLock{sceneLockRepo: repo} | ||
|
|
||
| ctx, cancel := context.WithCancel(context.Background()) | ||
| cancel() | ||
|
|
||
| d.ReleaseSceneLock(ctx, id.NewSceneID()) | ||
|
|
||
| assert.NoError(t, repo.saveLockCtxErr) | ||
| } | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
saveLockCtxErr starts as nil (Go zero value). If a future change removes or skips the SaveLock call, this assert.NoError still passes because nil == no error. The test does not check that SaveLock was actually called. Adding a called bool field to the mock and asserting assert.True(t, repo.called) would catch that case.