Remove global clients #1014
Open
Remove global clients #1014
Conversation
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
…OME and HOME directories
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
per1234
added
type: enhancement
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #1014 +/- ##
==========================================
+ Coverage 20.24% 20.81% +0.57%
==========================================
Files 42 42
Lines 3241 3291 +50
==========================================
+ Hits 656 685 +29
- Misses 2498 2515 +17
- Partials 87 91 +4
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
…serial, and update files
…ating logAction method
|
Tested on linux with MKR 1010
|
lucarin91
reviewed
Apr 3, 2025
hub.go
Outdated
Comment on lines
389
to
392
| p.OnClose = func(port *serport) { | ||
| hub.serialPortList.MarkPortAsClosed(p.portName) | ||
| hub.serialPortList.List() | ||
| } |
There was a problem hiding this comment.
I think you can remove the OnClose callback and move those two lines of code in the spClose method below after calling p.Close(). AFAIK this struct is the only one closing ports, so moving the code there should cover all the cases. The following should be the updated spClose function:
func (hub *hub) spClose(portname string) {
if myport, ok := hub.serialHub.FindPortByName(portname); ok {
hub.broadcastSys <- []byte("Closing serial port " + portname)
myport.Close()
hub.serialPortList.MarkPortAsClosed(myport.portName)
hub.serialPortList.List()
} else {
hub.spErr("We could not find the serial port " + portname + " that you were trying to close.")
}
}There was a problem hiding this comment.
uhm I think it is also called here
arduino-create-agent/serialport.go
Line 171 in b717430
lucarin91
reviewed
Apr 16, 2025
…b for cleaner code
…o hub.go for better organization
alessio-perugini
approved these changes
Apr 17, 2025
|
Tested again like #1014 (comment) |
|
Test: It can download a tool.
This hte was logs |
cmaglie
approved these changes
Apr 18, 2025
lucarin91
reviewed
Apr 18, 2025
hub.go
Outdated
Comment on lines
64
to
78
| onRegister := func(port *serport) { | ||
| broadcastSys <- []byte("{\"Cmd\":\"Open\",\"Desc\":\"Got register/open on port.\",\"Port\":\"" + port.portConf.Name + "\",\"Baud\":" + strconv.Itoa(port.portConf.Baud) + ",\"BufferType\":\"" + port.BufferType + "\"}") | ||
| } | ||
| onUnregister := func(port *serport) { | ||
| broadcastSys <- []byte("{\"Cmd\":\"Close\",\"Desc\":\"Got unregister/close on port.\",\"Port\":\"" + port.portConf.Name + "\",\"Baud\":" + strconv.Itoa(port.portConf.Baud) + "}") | ||
| } | ||
| serialHubub := newSerialHub(onRegister, onUnregister) | ||
|
|
||
| onList := func(data []byte) { | ||
| broadcastSys <- data | ||
| } | ||
| onErr := func(err string) { | ||
| broadcastSys <- []byte("{\"Error\":\"" + err + "\"}") | ||
| } | ||
| serialPortList := newSerialPortList(tools, onList, onErr) |
There was a problem hiding this comment.
I would simplify both of this two with the ChanWriter
Suggested change
| onRegister := func(port *serport) { | |
| broadcastSys <- []byte("{\"Cmd\":\"Open\",\"Desc\":\"Got register/open on port.\",\"Port\":\"" + port.portConf.Name + "\",\"Baud\":" + strconv.Itoa(port.portConf.Baud) + ",\"BufferType\":\"" + port.BufferType + "\"}") | |
| } | |
| onUnregister := func(port *serport) { | |
| broadcastSys <- []byte("{\"Cmd\":\"Close\",\"Desc\":\"Got unregister/close on port.\",\"Port\":\"" + port.portConf.Name + "\",\"Baud\":" + strconv.Itoa(port.portConf.Baud) + "}") | |
| } | |
| serialHubub := newSerialHub(onRegister, onUnregister) | |
| onList := func(data []byte) { | |
| broadcastSys <- data | |
| } | |
| onErr := func(err string) { | |
| broadcastSys <- []byte("{\"Error\":\"" + err + "\"}") | |
| } | |
| serialPortList := newSerialPortList(tools, onList, onErr) | |
| serialHubub := newSerialHub(ChanWriter{Ch:broadcastSys}) | |
| serialPortList := newSerialPortList(tools, ChanWriter{Ch:broadcastSys}) |
Comment on lines
+56
to
+57
| OnList func([]byte) `json:"-"` | ||
| OnErr func(string) `json:"-"` |
There was a problem hiding this comment.
Suggested change
| OnList func([]byte) `json:"-"` | |
| OnErr func(string) `json:"-"` | |
| writer io.Writer `json:"-"` |
serial.go
Outdated
| // Register serial ports from the connections. | ||
| func (sh *serialhub) Register(port *serport) { | ||
| sh.mu.Lock() | ||
| //log.Print("Registering a port: ", p.portConf.Name) | ||
| h.broadcastSys <- []byte("{\"Cmd\":\"Open\",\"Desc\":\"Got register/open on port.\",\"Port\":\"" + port.portConf.Name + "\",\"Baud\":" + strconv.Itoa(port.portConf.Baud) + ",\"BufferType\":\"" + port.BufferType + "\"}") | ||
| sh.onRegister(port) |
There was a problem hiding this comment.
Suggested change
| sh.onRegister(port) | |
| fmt.Fprintf(sh.writer, `{"Cmd":"Open","Desc":"Got register/open on port.","Port":%q,"Baud":%d,"BufferType":%q}`, port.portConf.Name , port.portConf.Baud, port.BufferType) |
| sh.ports[port] = true | ||
| sh.mu.Unlock() | ||
| } | ||
|
|
||
| // Unregister requests from connections. | ||
| func (sh *serialhub) Unregister(port *serport) { | ||
| sh.mu.Lock() | ||
| //log.Print("Unregistering a port: ", p.portConf.Name) | ||
| h.broadcastSys <- []byte("{\"Cmd\":\"Close\",\"Desc\":\"Got unregister/close on port.\",\"Port\":\"" + port.portConf.Name + "\",\"Baud\":" + strconv.Itoa(port.portConf.Baud) + "}") | ||
| sh.onUnregister(port) |
There was a problem hiding this comment.
Suggested change
| sh.onUnregister(port) | |
| fmt.Fprintf(sh.writer, `{"Cmd":"Close","Desc":"Got unregister/close on port.","Port":%q,"Baud":%d}`, port.portConf.Name, port.portConf.Baud) |
Comment on lines
+108
to
+109
| OnList: onList, | ||
| OnErr: onErr, |
There was a problem hiding this comment.
Suggested change
| OnList: onList, | |
| OnErr: onErr, | |
| writer: io.Writer, |
| //log.Println(err) | ||
| h.broadcastSys <- []byte("Error creating json on port list " + | ||
| err.Error()) | ||
| sp.OnErr("Error creating json on port list " + err.Error()) |
There was a problem hiding this comment.
Suggested change
| sp.OnErr("Error creating json on port list " + err.Error()) | |
| fmt.Fprintf(sp.writer,"Error creating json on port list %s", err.Error()) |
| } else { | ||
| h.broadcastSys <- ls | ||
| sp.OnList(ls) |
There was a problem hiding this comment.
Suggested change
| sp.OnList(ls) | |
| sp.Write(ls) |
lucarin91
dismissed
their stale review
I added some comments but I don't want to block the PR
2 tasks
|
I've merged #1032 here. |
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.
Please check if the PR fulfills these requirements
before creating one)
The purpose of this PR is to improve the maintainability, testability, and clarity of the codebase by removing global variables and explicitly passing dependencies as arguments to functions or methods. Global variables can lead to tightly coupled code, making it harder to understand, test, and maintain.
remove global variables, they are now created in the main function and passed explicitly to the components or functions that need them.
move the
go hub.serialPortList.Run()from themaingointo thehub.run()because the hub is in charge of connecting serial events to websocket clients.No.