fxpakpro: upgrade serial module and call SetReadTimeout using context…

….Deadline() or timeouts as appropriate
alttpo · Jul 12, 2021 · 3d9d914 · 3d9d914
1 parent c5c901f
commit 3d9d914
Show file tree

Hide file tree

Showing 14 changed files with 43 additions and 44 deletions.
diff --git a/go.mod b/go.mod
@@ -10,7 +10,7 @@ require (
 	github.com/gobwas/pool v0.2.1 // indirect
 	github.com/gobwas/ws v1.0.4
 	github.com/spf13/viper v1.8.1
-	go.bug.st/serial v1.1.3
+	go.bug.st/serial v1.3.0
 	golang.org/x/sys v0.0.0-20210603125802-9665404d3644 // indirect
 	google.golang.org/grpc v1.38.0
 	google.golang.org/protobuf v1.26.0

diff --git a/go.sum b/go.sum
@@ -359,6 +359,8 @@ github.com/yuin/goldmark v1.3.5 h1:dPmz1Snjq0kmkz159iL7S6WzdahUTHnHB5M56WFVifs=
 github.com/yuin/goldmark v1.3.5/go.mod h1:mwnBkeHKe2W/ZEtQ+71ViKU8L12m81fl3OWwC1Zlc8k=
 go.bug.st/serial v1.1.3 h1:YEBxJa9pKS9Wdg46B/jiaKbvvbUrjhZZZITfJHEJhaE=
 go.bug.st/serial v1.1.3/go.mod h1:8TT7u/SwwNIpJ8QaG4s+HTjFt9ReXs2cdOU7ZEk50Dk=
+go.bug.st/serial v1.3.0 h1:liPN6f/Xk0qaUByg0H2LOSns+2RuAuNXmXZyQOLVwVE=
+go.bug.st/serial v1.3.0/go.mod h1:8TT7u/SwwNIpJ8QaG4s+HTjFt9ReXs2cdOU7ZEk50Dk=
 go.etcd.io/etcd/api/v3 v3.5.0 h1:GsV3S+OfZEOCNXdtNkBSR7kgLobAa/SO6tCxRa0GAYw=
 go.etcd.io/etcd/api/v3 v3.5.0/go.mod h1:cbVKeC6lCfl7j/8jBhAK6aIYO9XOjdptoxU/nLQcPvs=
 go.etcd.io/etcd/client/pkg/v3 v3.5.0 h1:2aQv6F436YnN7I4VbI8PPYrBhu+SmrTaADcf8Mi/6PU=

diff --git a/snes/drivers/fxpakpro/boot.go b/snes/drivers/fxpakpro/boot.go
@@ -29,7 +29,7 @@ func (d *Device) boot(ctx context.Context, path string) (err error) {
 	}
 
 	// read response:
-	err = recvSerial(d.f, sb, 512)
+	err = recvSerial(ctx, d.f, sb, 512)
 	if err != nil {
 		_ = d.Close()
 		return

diff --git a/snes/drivers/fxpakpro/control.go b/snes/drivers/fxpakpro/control.go
@@ -23,7 +23,7 @@ func (d *Device) ResetSystem(ctx context.Context) (err error) {
 		return
 	}
 
-	err = recvSerial(d.f, sb, 512)
+	err = recvSerial(ctx, d.f, sb, 512)
 	if err != nil {
 		_ = d.Close()
 		return

diff --git a/snes/drivers/fxpakpro/getfile.go b/snes/drivers/fxpakpro/getfile.go
@@ -32,7 +32,7 @@ func (d *Device) getFile(ctx context.Context, path string, w io.Writer, sizeRece
 	}
 
 	// read response:
-	err = recvSerial(d.f, sb, 512)
+	err = recvSerial(ctx, d.f, sb, 512)
 	if err != nil {
 		_ = d.Close()
 		return

diff --git a/snes/drivers/fxpakpro/ls.go b/snes/drivers/fxpakpro/ls.go
@@ -31,7 +31,7 @@ func (d *Device) listFiles(ctx context.Context, path string) (files []snes.DirEn
 	}
 
 	// await the first response packet for error status:
-	err = recvSerial(d.f, sb, 512)
+	err = recvSerial(ctx, d.f, sb, 512)
 	if err != nil {
 		_ = d.Close()
 		return
@@ -59,7 +59,9 @@ func (d *Device) listFiles(ctx context.Context, path string) (files []snes.DirEn
 
 recvLoop:
 	for {
-		err = recvSerial(d.f, sb, 512)
+		iterCtx, iterCancel := context.WithTimeout(ctx, safeTimeout)
+		err = recvSerial(iterCtx, d.f, sb, 512)
+		iterCancel()
 		if err != nil {
 			_ = d.Close()
 			return

diff --git a/snes/drivers/fxpakpro/ls_test.go b/snes/drivers/fxpakpro/ls_test.go
@@ -2,8 +2,6 @@ package fxpakpro
 
 import (
 	"context"
-	"reflect"
-	"sni/protos/sni"
 	"sni/snes"
 	"testing"
 )
@@ -26,32 +24,6 @@ func TestDevice_listFiles(t *testing.T) {
 			args: args{
 				path: "/",
 			},
-			wantFiles: []snes.DirEntry{
-				{Name: "o2", Type: sni.DirEntryType_Directory},
-				{Name: "poop", Type: sni.DirEntryType_Directory},
-				{Name: "roms", Type: sni.DirEntryType_Directory},
-				{Name: "System Volume Information", Type: sni.DirEntryType_Directory},
-				{Name: "sd2snes", Type: sni.DirEntryType_Directory},
-			},
-			wantErr: false,
-		},
-		{
-			name: "list /o2",
-			args: args{
-				path: "/o2",
-			},
-			wantFiles: []snes.DirEntry{
-				{Name: ".", Type: sni.DirEntryType_Directory},
-				{Name: "..", Type: sni.DirEntryType_Directory},
-				{Name: "lttp.smc", Type: sni.DirEntryType_File},
-				{Name: "lttphack-vanilla.sfc", Type: sni.DirEntryType_File},
-				{Name: "patched.smc", Type: sni.DirEntryType_File},
-				{Name: "lttpj.smc", Type: sni.DirEntryType_File},
-				{Name: "lttphack-v13.1.1-emulator-vanillahud.sfc", Type: sni.DirEntryType_File},
-				{Name: "alttp-jp.smc", Type: sni.DirEntryType_File},
-				{Name: "lttphack-vanilla.smc", Type: sni.DirEntryType_File},
-				{Name: "alttpr - noglitches-standard-ganon_gvmrxlwjy5.sfc", Type: sni.DirEntryType_File},
-			},
 			wantErr: false,
 		},
 	}
@@ -62,9 +34,7 @@ func TestDevice_listFiles(t *testing.T) {
 				t.Errorf("listFiles() error = %v, wantErr %v", err, tt.wantErr)
 				return
 			}
-			if !reflect.DeepEqual(gotFiles, tt.wantFiles) {
-				t.Errorf("listFiles() gotFiles = %#v, want %#v", gotFiles, tt.wantFiles)
-			}
+			t.Log(gotFiles)
 		})
 	}
 }
diff --git a/snes/drivers/fxpakpro/mkdir.go b/snes/drivers/fxpakpro/mkdir.go
@@ -29,7 +29,7 @@ func (d *Device) mkdir(ctx context.Context, path string) (err error) {
 	}
 
 	// read response:
-	err = recvSerial(d.f, sb, 512)
+	err = recvSerial(ctx, d.f, sb, 512)
 	if err != nil {
 		_ = d.Close()
 		return

diff --git a/snes/drivers/fxpakpro/mv.go b/snes/drivers/fxpakpro/mv.go
@@ -32,7 +32,7 @@ func (d *Device) mv(ctx context.Context, path, newFilename string) (err error) {
 	}
 
 	// read response:
-	err = recvSerial(d.f, sb, 512)
+	err = recvSerial(ctx, d.f, sb, 512)
 	if err != nil {
 		_ = d.Close()
 		return

diff --git a/snes/drivers/fxpakpro/put.go b/snes/drivers/fxpakpro/put.go
@@ -49,7 +49,7 @@ func (d *Device) put(ctx context.Context, space space, address uint32, data []by
 	}
 
 	// await single response:
-	err = recvSerial(d.f, sb, 512)
+	err = recvSerial(ctx, d.f, sb, 512)
 	if err != nil {
 		_ = d.Close()
 		return

diff --git a/snes/drivers/fxpakpro/putfile.go b/snes/drivers/fxpakpro/putfile.go
@@ -41,7 +41,7 @@ func (d *Device) putFile(ctx context.Context, path string, size uint32, r io.Rea
 	}
 
 	// read response:
-	err = recvSerial(d.f, sb, 512)
+	err = recvSerial(ctx, d.f, sb, 512)
 	if err != nil {
 		_ = d.Close()
 		return

diff --git a/snes/drivers/fxpakpro/rm.go b/snes/drivers/fxpakpro/rm.go
@@ -29,7 +29,7 @@ func (d *Device) rm(ctx context.Context, path string) (err error) {
 	}
 
 	// read response:
-	err = recvSerial(d.f, sb, 512)
+	err = recvSerial(ctx, d.f, sb, 512)
 	if err != nil {
 		_ = d.Close()
 		return

diff --git a/snes/drivers/fxpakpro/serial.go b/snes/drivers/fxpakpro/serial.go
@@ -2,13 +2,17 @@ package fxpakpro
 
 import (
 	"bytes"
+	"context"
 	"fmt"
 	"go.bug.st/serial"
 	"io"
 	"log"
 	"sni/snes"
+	"time"
 )
 
+const safeTimeout = time.Millisecond * 250
+
 func readExact(r io.Reader, chunkSize int, buf []byte) (err error) {
 	p := 0
 	for p < chunkSize {
@@ -86,7 +90,16 @@ func sendSerialProgress(f serial.Port, chunkSize int, size uint32, r io.Reader,
 	return
 }
 
-func recvSerial(f serial.Port, rsp []byte, expected int) (err error) {
+func recvSerial(ctx context.Context, f serial.Port, rsp []byte, expected int) (err error) {
+	var timeout time.Duration = serial.NoTimeout
+	if deadline, ok := ctx.Deadline(); ok {
+		timeout = deadline.Sub(time.Now())
+	}
+	err = f.SetReadTimeout(timeout)
+	if err != nil {
+		return
+	}
+
 	err = readExact(f, expected, rsp)
 	if err != nil {
 		err = fmt.Errorf("recvSerial: %w", err)
@@ -104,6 +117,12 @@ func recvSerialProgress(f serial.Port, w io.Writer, size uint32, chunkSize int,
 			progress(received, size)
 		}
 
+		err = f.SetReadTimeout(safeTimeout)
+		if err != nil {
+			err = fmt.Errorf("recvSerialProgress: %w", err)
+			return
+		}
+
 		err = readExact(f, chunkSize, buf)
 		if err != nil {
 			err = fmt.Errorf("recvSerialProgress: %w", err)
@@ -129,5 +148,11 @@ func recvSerialProgress(f serial.Port, w io.Writer, size uint32, chunkSize int,
 		progress(received, size)
 	}
 
+	err = f.SetReadTimeout(serial.NoTimeout)
+	if err != nil {
+		err = fmt.Errorf("recvSerialProgress: %w", err)
+		return
+	}
+
 	return
 }
diff --git a/snes/drivers/fxpakpro/vget.go b/snes/drivers/fxpakpro/vget.go
@@ -56,7 +56,7 @@ func (d *Device) vget(ctx context.Context, space space, chunks ...vgetChunk) (er
 	// read the expected number of 64-byte packets:
 	expected := packets * 64
 	rsp := make([]byte, expected)
-	err = recvSerial(d.f, rsp, expected)
+	err = recvSerial(ctx, d.f, rsp, expected)
 	if err != nil {
 		_ = d.Close()
 		return