ref(nav): adapt runner and session for concurrency (#320)"

ref(boost); update lint config for go 1.21 (#320)

ref(nav): type renames (#320)

ref(nav): add runner skelton (#320)

ref(nav): add sync skelton (#320)

ref(nav): partially define sync run (#320)

ref(nav): add context to ensync (#320)

ref(nav): migrate tests to use nav.New (#320)

Author: plastikfan

.golangci.yml

@@ -25,7 +25,10 @@ linters:
   enable:
     - bodyclose
     # - deadcode
-    - depguard
+    # depguard needs to be reviewed properly and then configured, before
+    # it can be re-enabled.
+    # https://github.com/OpenPeeDeeP/depguard#example-configs
+    # - depguard
     - dogsled
     # - dupl
     - errcheck

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/golangci/golangci-lint
-    rev: v1.52.2
+    rev: v1.54.2
     hooks:
       - id: golangci-lint
 

.vscode/settings.json

@@ -60,6 +60,7 @@
     "staticcheck",
     "structcheck",
     "stylecheck",
+    "syncable",
     "Syncer",
     "teivah",
     "thelper",

xfs/nav/bootstrapper.go

@@ -13,8 +13,8 @@ func (d *nullDetacher) detach(_ *navigationFrame) {
 
 type bootstrapper struct {
 	o        *TraverseOptions
-	nc       *navigatorController
-	rc       *resumeController
+	nc       *navigationController
+	rc       *resumeStrategyController
 	detacher resumeDetacher
 }
 
@@ -34,7 +34,10 @@ func (b *bootstrapper) init() {
 }
 
 func (b *bootstrapper) initFilters() {
-	b.o.Hooks.InitFilters(b.o, b.nc.frame)
+	b.o.Hooks.InitFilters(
+		b.o,
+		b.nc.frame,
+	)
 }
 
 func (b *bootstrapper) initNotifiers() {
@@ -58,12 +61,14 @@ func (b *bootstrapper) initListener() {
 	}
 
 	b.nc.frame.listener.makeStates(&listenStatesParams{
-		o: b.o, frame: b.nc.frame,
+		o:        b.o,
+		frame:    b.nc.frame,
 		detacher: b,
 	})
 
 	b.nc.frame.listener.decorate(&listenStatesParams{
-		triggers: &state.Listen, frame: b.nc.frame,
+		triggers: &state.Listen,
+		frame:    b.nc.frame,
 	})
 }
 

xfs/nav/filter-glob_test.go

@@ -75,11 +75,10 @@ var _ = Describe("FilterGlob", Ordered, func() {
 					},
 				}
 			}
-			session := nav.PrimarySession{
-				Path:     path,
-				OptionFn: optionFn,
-			}
-			result, _ := session.Init().Run()
+			result, err := nav.New().Primary(&nav.Prime{
+				Path:      path,
+				OptionsFn: optionFn,
+			}).Run()
 
 			if entry.mandatory != nil {
 				for _, name := range entry.mandatory {
@@ -95,6 +94,7 @@ var _ = Describe("FilterGlob", Ordered, func() {
 				}
 			}
 
+			Expect(err).Error().To(BeNil())
 			Expect(result.Metrics.Count(nav.MetricNoFilesInvokedEn)).To(Equal(entry.expectedNoOf.files),
 				"Incorrect no of files")
 			Expect(result.Metrics.Count(nav.MetricNoFoldersInvokedEn)).To(Equal(entry.expectedNoOf.folders),
@@ -235,11 +235,11 @@ var _ = Describe("FilterGlob", Ordered, func() {
 					},
 				}
 			}
-			session := nav.PrimarySession{
-				Path:     path,
-				OptionFn: optionFn,
-			}
-			result, _ := session.Init().Run()
+
+			result, _ := nav.New().Primary(&nav.Prime{
+				Path:      path,
+				OptionsFn: optionFn,
+			}).Run()
 
 			if entry.mandatory != nil {
 				for _, name := range entry.mandatory {

xfs/nav/filter-regex_test.go

@@ -76,11 +76,10 @@ var _ = Describe("FilterRegex", Ordered, func() {
 					},
 				}
 			}
-			session := nav.PrimarySession{
-				Path:     path,
-				OptionFn: optionFn,
-			}
-			result, _ := session.Init().Run()
+			result, err := nav.New().Primary(&nav.Prime{
+				Path:      path,
+				OptionsFn: optionFn,
+			}).Run()
 
 			if entry.mandatory != nil {
 				for _, name := range entry.mandatory {
@@ -96,6 +95,7 @@ var _ = Describe("FilterRegex", Ordered, func() {
 				}
 			}
 
+			Expect(err).Error().To(BeNil())
 			Expect(result.Metrics.Count(nav.MetricNoFilesInvokedEn)).To(Equal(entry.expectedNoOf.files),
 				"Incorrect no of files")
 			Expect(result.Metrics.Count(nav.MetricNoFoldersInvokedEn)).To(Equal(entry.expectedNoOf.folders),
@@ -278,11 +278,11 @@ var _ = Describe("FilterRegex", Ordered, func() {
 					},
 				}
 			}
-			session := nav.PrimarySession{
-				Path:     path,
-				OptionFn: optionFn,
-			}
-			result, _ := session.Init().Run()
+
+			result, _ := nav.New().Primary(&nav.Prime{
+				Path:      path,
+				OptionsFn: optionFn,
+			}).Run()
 
 			if entry.mandatory != nil {
 				for _, name := range entry.mandatory {
@@ -364,6 +364,7 @@ var _ = Describe("FilterRegex", Ordered, func() {
 				pe := recover()
 				if entry.errorContains != "" {
 					if err, ok := pe.(error); ok {
+						// nil pointer dereference
 						Expect(strings.Contains(err.Error(), entry.errorContains)).To(BeTrue())
 					}
 				} else {
@@ -392,11 +393,11 @@ var _ = Describe("FilterRegex", Ordered, func() {
 					},
 				}
 			}
-			session := nav.PrimarySession{
-				Path:     path,
-				OptionFn: optionFn,
-			}
-			_, _ = session.Init().Run()
+
+			_, _ = nav.New().Primary(&nav.Prime{
+				Path:      path,
+				OptionsFn: optionFn,
+			}).Run()
 
 			Fail(fmt.Sprintf("❌ expected panic due to '%v'", entry.name))
 		},
@@ -448,11 +449,11 @@ var _ = Describe("FilterRegex", Ordered, func() {
 					},
 				}
 			}
-			session := nav.PrimarySession{
-				Path:     path,
-				OptionFn: optionFn,
-			}
-			_, _ = session.Init().Run()
+
+			_, _ = nav.New().Primary(&nav.Prime{
+				Path:      path,
+				OptionsFn: optionFn,
+			}).Run()
 
 			Fail(fmt.Sprintf("❌ expected panic due to '%v'", entry.name))
 		},

xfs/nav/marshal-state_test.go

@@ -68,13 +68,14 @@ var _ = Describe("MarshalOptions", Ordered, func() {
 						},
 					}
 				}
-				session := &nav.PrimarySession{
-					Path:     path,
-					OptionFn: optionFn,
-				}
 
-				_, _ = session.Init().Run()
-				err := session.Save(toJSONPath)
+				runner := nav.New().Primary(&nav.Prime{
+					Path:      path,
+					OptionsFn: optionFn,
+				})
+
+				_, _ = runner.Run()
+				err := runner.Save(toJSONPath)
 
 				Expect(err).To(BeNil())
 			})
@@ -104,13 +105,13 @@ var _ = Describe("MarshalOptions", Ordered, func() {
 						},
 					}
 				}
-				session := &nav.PrimarySession{
-					Path:     path,
-					OptionFn: optionFn,
-				}
+				runner := nav.New().Primary(&nav.Prime{
+					Path:      path,
+					OptionsFn: optionFn,
+				})
 
-				_, _ = session.Init().Run()
-				_ = session.Save(toJSONPath)
+				_, _ = runner.Run()
+				_ = runner.Save(toJSONPath)
 
 				Fail(fmt.Sprintf("❌ expected panic due to %v", entry.errorContains))
 			},

xfs/nav/navigation-agent.go

@@ -28,10 +28,9 @@ func (agentFactory) new(params *agentFactoryParams) *navigationAgent {
 }
 
 type navigationAgent struct {
-	doInvoke  utils.RoProp[bool]
-	o         *TraverseOptions
-	deFactory directoryEntriesFactory
-	handler   fileSystemErrorHandler
+	doInvoke utils.RoProp[bool]
+	o        *TraverseOptions
+	handler  fileSystemErrorHandler
 }
 
 type agentTopParams struct {
@@ -81,7 +80,8 @@ func (a *navigationAgent) read(path string, order DirectoryEntryOrderEnum) (*Dir
 	//
 	entries, err := a.o.Hooks.ReadDirectory(path)
 
-	de := a.deFactory.new(&directoryEntriesFactoryParams{
+	deFactory := directoryEntriesFactory{}
+	de := deFactory.new(&directoryEntriesFactoryParams{
 		o:       a.o,
 		order:   order,
 		entries: &entries,

xfs/nav/navigation-async-defs.go

@@ -25,7 +25,7 @@ type TraverseItemOutputStreamR = boost.OutputStreamR[TraverseOutput]
 type TraverseItemOutputStreamW = boost.OutputStreamW[TraverseOutput]
 
 type AsyncInfo struct {
-	Context context.Context
+	Context context.Context // this will be retired, instead passed into Run
 
 	// this doesn't seem right, the client shouldn't have to specify
 	// the routine name for the navigator; should be a readonly prop