refactor: rename 'Hub' and 'Serialhub' types to 'hub' and 'serialhub' for consistency

Author: dido18

conn.go

@@ -80,7 +80,7 @@ type Upload struct {
 
 var uploadStatusStr = "ProgrammerStatus"
 
-func uploadHandler(h *Hub, pubKey *rsa.PublicKey) func(*gin.Context) {
+func uploadHandler(h *hub, pubKey *rsa.PublicKey) func(*gin.Context) {
 	return func(c *gin.Context) {
 		data := new(Upload)
 		if err := c.BindJSON(data); err != nil {
@@ -193,7 +193,7 @@ func uploadHandler(h *Hub, pubKey *rsa.PublicKey) func(*gin.Context) {
 // PLogger sends the info from the upload to the websocket
 type PLogger struct {
 	Verbose bool
-	h       *Hub
+	h       *hub
 }
 
 // Debug only sends messages if verbose is true (always true for now)
@@ -210,12 +210,12 @@ func (l PLogger) Info(args ...interface{}) {
 	send(l.h, map[string]string{uploadStatusStr: "Busy", "Msg": output})
 }
 
-func send(h *Hub, args map[string]string) {
+func send(h *hub, args map[string]string) {
 	mapB, _ := json.Marshal(args)
 	h.broadcastSys <- mapB
 }
 
-func wsHandler(h *Hub) *WsServer {
+func wsHandler(h *hub) *WsServer {
 	server, err := socketio.NewServer(nil)
 	if err != nil {
 		log.Fatal(err)

hub.go

@@ -29,7 +29,7 @@ import (
 	log "github.com/sirupsen/logrus"
 )
 
-type Hub struct {
+type hub struct {
 	// Registered connections.
 	connections map[*connection]bool
 
@@ -47,15 +47,13 @@ type Hub struct {
 
 	//TODO globals clients
 	// Serial hub to communicate with serial ports
-	serialHub *Serialhub
+	serialHub *serialhub
 
-	serialPortList *SerialPortList
+	serialPortList *serialPortList
 }
 
-// NewHub creates a hub that acts as a central hub for handling
-// WebSocket connections, broadcasting messages, and processing commands.
-func NewHub(serialhub *Serialhub, serialList *SerialPortList) *Hub {
-	hub := &Hub{
+func newHub(serialhub *serialhub, serialList *serialPortList) *hub {
+	hub := &hub{
 		broadcast:      make(chan []byte, 1000),
 		broadcastSys:   make(chan []byte, 1000),
 		register:       make(chan *connection),
@@ -102,15 +100,15 @@ const commands = `{
   ]
 }`
 
-func (h *Hub) unregisterConnection(c *connection) {
+func (h *hub) unregisterConnection(c *connection) {
 	if _, contains := h.connections[c]; !contains {
 		return
 	}
 	delete(h.connections, c)
 	close(c.send)
 }
 
-func (h *Hub) sendToRegisteredConnections(data []byte) {
+func (h *hub) sendToRegisteredConnections(data []byte) {
 	for c := range h.connections {
 		select {
 		case c.send <- data:
@@ -123,7 +121,7 @@ func (h *Hub) sendToRegisteredConnections(data []byte) {
 	}
 }
 
-func (h *Hub) run() {
+func (h *hub) run() {
 	for {
 		select {
 		case c := <-h.register:
@@ -146,7 +144,7 @@ func (h *Hub) run() {
 	}
 }
 
-func (h *Hub) checkCmd(m []byte) {
+func (h *hub) checkCmd(m []byte) {
 	//log.Print("Inside checkCmd")
 	s := string(m[:])
 
@@ -284,23 +282,23 @@ func logAction(sl string) {
 	}
 }
 
-func (h *Hub) memoryStats() {
+func (h *hub) memoryStats() {
 	var memStats runtime.MemStats
 	runtime.ReadMemStats(&memStats)
 	json, _ := json.Marshal(memStats)
 	log.Printf("memStats:%v\n", string(json))
 	h.broadcastSys <- json
 }
 
-func (h *Hub) getHostname() {
+func (h *hub) getHostname() {
 	h.broadcastSys <- []byte("{\"Hostname\" : \"" + *hostname + "\"}")
 }
 
-func (h *Hub) getVersion() {
+func (h *hub) getVersion() {
 	h.broadcastSys <- []byte("{\"Version\" : \"" + version + "\"}")
 }
 
-func (h *Hub) garbageCollection() {
+func (h *hub) garbageCollection() {
 	log.Printf("Starting garbageCollection()\n")
 	h.broadcastSys <- []byte("{\"gc\":\"starting\"}")
 	h.memoryStats()

info.go

@@ -41,7 +41,7 @@ func infoHandler(c *gin.Context) {
 	})
 }
 
-func pauseHandler(h *Hub, s *systray.Systray) func(c *gin.Context) {
+func pauseHandler(h *hub, s *systray.Systray) func(c *gin.Context) {
 	return func(c *gin.Context) {
 		go func() {
 			ports, _ := serial.GetPortsList()

main.go

@@ -191,12 +191,12 @@ func loop(stray *systray.Systray, configPath *paths.Path) {
 	}
 
 	// serialPorts contains the ports attached to the machine
-	serialPorts := NewSerialPortList()
-	serialHub := NewSerialHub()
+	serialPorts := newSerialPortList()
+	serialHub := newSerialHub()
 
 	// var loggerWs logWriter
 
-	hub := NewHub(serialHub, serialPorts)
+	hub := newHub(serialHub, serialPorts)
 
 	logger := func(msg string) {
 		mapD := map[string]string{"DownloadStatus": "Pending", "Msg": msg}

main_test.go

@@ -56,7 +56,7 @@ func TestValidSignatureKey(t *testing.T) {
 
 func TestUploadHandlerAgainstEvilFileNames(t *testing.T) {
 	r := gin.New()
-	r.POST("/", uploadHandler(NewHub(NewSerialHub(), NewSerialPortList()), utilities.MustParseRsaPublicKey([]byte(globals.ArduinoSignaturePubKey))))
+	r.POST("/", uploadHandler(newHub(newSerialHub(), newSerialPortList()), utilities.MustParseRsaPublicKey([]byte(globals.ArduinoSignaturePubKey))))
 	ts := httptest.NewServer(r)
 
 	uploadEvilFileName := Upload{
@@ -93,7 +93,7 @@ func TestUploadHandlerAgainstEvilFileNames(t *testing.T) {
 func TestUploadHandlerAgainstBase64WithoutPaddingMustFail(t *testing.T) {
 	r := gin.New()
 
-	r.POST("/", uploadHandler(NewHub(NewSerialHub(), NewSerialPortList()), utilities.MustParseRsaPublicKey([]byte(globals.ArduinoSignaturePubKey))))
+	r.POST("/", uploadHandler(newHub(newSerialHub(), newSerialPortList()), utilities.MustParseRsaPublicKey([]byte(globals.ArduinoSignaturePubKey))))
 	ts := httptest.NewServer(r)
 	defer ts.Close()
 

serial.go

@@ -29,7 +29,7 @@ import (
 	"github.com/sirupsen/logrus"
 )
 
-type Serialhub struct {
+type serialhub struct {
 	// Opened serial ports.
 	ports map[*serport]bool
 	mu    sync.Mutex
@@ -38,26 +38,22 @@ type Serialhub struct {
 	OnUnregister func(port *serport)
 }
 
-// NewSerialHub creates a new serial hub
-// It is used to manage serial ports and their connections.
-func NewSerialHub() *Serialhub {
-	return &Serialhub{
+func newSerialHub() *serialhub {
+	return &serialhub{
 		ports: make(map[*serport]bool),
 	}
 }
 
-// SerialPortList is the serial port list
-type SerialPortList struct {
+type serialPortList struct {
 	Ports     []*SpPortItem
 	portsLock sync.Mutex
 
 	OnList func([]byte) `json:"-"`
 	OnErr  func(string) `json:"-"`
 }
 
-// NewSerialPortList creates a new serial port list
-func NewSerialPortList() *SerialPortList {
-	return &SerialPortList{}
+func newSerialPortList() *serialPortList {
+	return &serialPortList{}
 }
 
 // SpPortItem is the serial port item
@@ -75,7 +71,7 @@ type SpPortItem struct {
 }
 
 // Register serial ports from the connections.
-func (sh *Serialhub) Register(port *serport) {
+func (sh *serialhub) Register(port *serport) {
 	sh.mu.Lock()
 	//log.Print("Registering a port: ", p.portConf.Name)
 	sh.OnRegister(port)
@@ -84,7 +80,7 @@ func (sh *Serialhub) Register(port *serport) {
 }
 
 // Unregister requests from connections.
-func (sh *Serialhub) Unregister(port *serport) {
+func (sh *serialhub) Unregister(port *serport) {
 	sh.mu.Lock()
 	//log.Print("Unregistering a port: ", p.portConf.Name)
 	sh.OnUnregister(port)
@@ -94,7 +90,7 @@ func (sh *Serialhub) Unregister(port *serport) {
 	sh.mu.Unlock()
 }
 
-func (sh *Serialhub) FindPortByName(portname string) (*serport, bool) {
+func (sh *serialhub) FindPortByName(portname string) (*serport, bool) {
 	sh.mu.Lock()
 	defer sh.mu.Unlock()
 
@@ -109,7 +105,7 @@ func (sh *Serialhub) FindPortByName(portname string) (*serport, bool) {
 }
 
 // List broadcasts a Json representation of the ports found
-func (sp *SerialPortList) List() {
+func (sp *serialPortList) List() {
 	sp.portsLock.Lock()
 	ls, err := json.MarshalIndent(sp, "", "\t")
 	sp.portsLock.Unlock()
@@ -122,7 +118,7 @@ func (sp *SerialPortList) List() {
 }
 
 // Run is the main loop for port discovery and management
-func (sp *SerialPortList) Run() {
+func (sp *serialPortList) Run() {
 	for retries := 0; retries < 10; retries++ {
 		sp.runSerialDiscovery()
 
@@ -132,7 +128,7 @@ func (sp *SerialPortList) Run() {
 	logrus.Errorf("Failed restarting serial discovery. Giving up...")
 }
 
-func (sp *SerialPortList) runSerialDiscovery() {
+func (sp *serialPortList) runSerialDiscovery() {
 	// First ensure that all the discoveries are available
 	if err := Tools.Download("builtin", "serial-discovery", "latest", "keep"); err != nil {
 		logrus.Errorf("Error downloading serial-discovery: %s", err)
@@ -176,13 +172,13 @@ func (sp *SerialPortList) runSerialDiscovery() {
 	logrus.Errorf("Serial discovery stopped.")
 }
 
-func (sp *SerialPortList) reset() {
+func (sp *serialPortList) reset() {
 	sp.portsLock.Lock()
 	defer sp.portsLock.Unlock()
 	sp.Ports = []*SpPortItem{}
 }
 
-func (sp *SerialPortList) add(addedPort *discovery.Port) {
+func (sp *serialPortList) add(addedPort *discovery.Port) {
 	if addedPort.Protocol != "serial" {
 		return
 	}
@@ -226,7 +222,7 @@ func (sp *SerialPortList) add(addedPort *discovery.Port) {
 	})
 }
 
-func (sp *SerialPortList) remove(removedPort *discovery.Port) {
+func (sp *serialPortList) remove(removedPort *discovery.Port) {
 	sp.portsLock.Lock()
 	defer sp.portsLock.Unlock()
 
@@ -237,7 +233,7 @@ func (sp *SerialPortList) remove(removedPort *discovery.Port) {
 }
 
 // MarkPortAsOpened marks a port as opened by the user
-func (sp *SerialPortList) MarkPortAsOpened(portname string) {
+func (sp *serialPortList) MarkPortAsOpened(portname string) {
 	sp.portsLock.Lock()
 	defer sp.portsLock.Unlock()
 	port := sp.getPortByName(portname)
@@ -247,7 +243,7 @@ func (sp *SerialPortList) MarkPortAsOpened(portname string) {
 }
 
 // MarkPortAsClosed marks a port as no more opened by the user
-func (sp *SerialPortList) MarkPortAsClosed(portname string) {
+func (sp *serialPortList) MarkPortAsClosed(portname string) {
 	sp.portsLock.Lock()
 	defer sp.portsLock.Unlock()
 	port := sp.getPortByName(portname)
@@ -256,7 +252,7 @@ func (sp *SerialPortList) MarkPortAsClosed(portname string) {
 	}
 }
 
-func (sp *SerialPortList) getPortByName(portname string) *SpPortItem {
+func (sp *serialPortList) getPortByName(portname string) *SpPortItem {
 	for _, port := range sp.Ports {
 		if port.Name == portname {
 			return port
@@ -265,13 +261,13 @@ func (sp *SerialPortList) getPortByName(portname string) *SpPortItem {
 	return nil
 }
 
-func (h *Hub) spErr(err string) {
+func (h *hub) spErr(err string) {
 	//log.Println("Sending err back: ", err)
 	//sh.hub.broadcastSys <- []byte(err)
 	h.broadcastSys <- []byte("{\"Error\" : \"" + err + "\"}")
 }
 
-func (h *Hub) spClose(portname string) {
+func (h *hub) spClose(portname string) {
 	if myport, ok := h.serialHub.FindPortByName(portname); ok {
 		h.broadcastSys <- []byte("Closing serial port " + portname)
 		myport.Close()
@@ -280,7 +276,7 @@ func (h *Hub) spClose(portname string) {
 	}
 }
 
-func (h *Hub) spWrite(arg string) {
+func (h *hub) spWrite(arg string) {
 	// we will get a string of comXX asdf asdf asdf
 	//log.Println("Inside spWrite arg: " + arg)
 	arg = strings.TrimPrefix(arg, " ")

serialport.go

@@ -287,7 +287,7 @@ func (p *serport) writerRaw() {
 	p.OnMessage([]byte(msgstr))
 }
 
-func (h *Hub) spHandlerOpen(portname string, baud int, buftype string) {
+func (h *hub) spHandlerOpen(portname string, baud int, buftype string) {
 
 	log.Print("Inside spHandler")