Remove context lock from API VM interface #2148
Closed
Conversation
This file contains 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
StephenButtolph
commented
Oct 9, 2023
There was a problem hiding this comment.
The changes are done in this file to ensure that json.Marshal is called with the lock held. Previously the json-rpc logic would marshal the structs with the lock held. However, now we release the lock before passing the reply back into the json-rpc framework.
StephenButtolph
commented
Oct 9, 2023
| @@ -69,11 +70,14 @@ func NewService(config Config) (*common.HTTPHandler, error) { | |||
| }, "admin"); err != nil { | |||
| return nil, err | |||
| } | |||
| return &common.HTTPHandler{Handler: newServer}, nil | |||
There was a problem hiding this comment.
This used to hold a WriteLock - note: the lock was scoped to this API.
StephenButtolph
commented
Oct 9, 2023
| @@ -43,7 +44,7 @@ func NewService(log logging.Logger, chainManager chains.Manager, httpServer serv | |||
| newServer.RegisterCodec(codec, "application/json") | |||
| newServer.RegisterCodec(codec, "application/json;charset=UTF-8") | |||
|
|
|||
| return &common.HTTPHandler{Handler: newServer}, newServer.RegisterService(ipcServer, "ipcs") | |||
There was a problem hiding this comment.
This used to hold a WriteLock - note: the lock was scoped to this API.
This was referenced Oct 9, 2023
|
see: #2165 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Why this should be merged
While the
ctx.Lockwas important to add in the early days - it is heavily overused. This is the start of the effort to completely remove thectx.Lockfrom thesnow.Context.How this works
Changes
vm.CreateHandlersandvm.CreateStaticHandlersto no longer expose any locking options.For the most part, this PR doesn't try to reduce the scope of locking. It primarily just moves the locking from the API server into the individual services. There will be follow-up PRs to actually reduce the scope of the locking.
How this was tested
CI