feat(nav): add supporting code and failing tests for sample (#366)

fix(nav): remove incorrect use of pointer to slice in sort (#366) ref(nav): use item.IsDir (#366) ref(nav): fix more pointer to slices (#366) test(nav): use expectedNo struct in skip tests (#366) ref(nav): rename expectedNo to directoryQuantities (#366) ref(nav): panic if subscription type not set (#366) ref(nav): add benign node filter for compound only filtering (#366) ref(nav): add isFilteringActive (#366) ref(nav): simplify useExtendHook (#366) ref(nav): streamline filter init and automatically apply benigh filter (#366) feat(nav): setup sample failing tests and other sample support (#366)
snivilised · Nov 16, 2023 · 9f3e294 · 9f3e294
1 parent aeb9bb4
commit 9f3e294
Show file tree

Hide file tree

Showing 20 changed files with 497 additions and 127 deletions.
diff --git a/.github/workflows/ci-workflow.yml b/.github/workflows/ci-workflow.yml
@@ -14,7 +14,7 @@ jobs:
       - name: golangci-lint
         uses: golangci/golangci-lint-action@v3
         with:
-          version: v1.52.2
+          version: v1.54.2
           args: --verbose
 
   test:

diff --git a/xfs/nav/directory-entries.go b/xfs/nav/directory-entries.go
@@ -1,6 +1,7 @@
 package nav
 
 import (
+	"fmt"
 	"io/fs"
 
 	"github.com/samber/lo"
@@ -24,7 +25,7 @@ type directoryEntriesFactory struct{}
 type directoryEntriesFactoryParams struct {
 	o       *TraverseOptions
 	order   DirectoryEntryOrderEnum
-	entries *[]fs.DirEntry
+	entries []fs.DirEntry
 }
 
 func (directoryEntriesFactory) new(params *directoryEntriesFactoryParams) *DirectoryEntries {
@@ -46,8 +47,13 @@ type DirectoryEntries struct {
 	Files   []fs.DirEntry
 }
 
-func (e *DirectoryEntries) arrange(entries *[]fs.DirEntry) {
-	grouped := lo.GroupBy(*entries, func(item fs.DirEntry) bool {
+func (e *DirectoryEntries) Sample() *DirectoryEntries {
+	fmt.Println("❌❌❌ DirectoryEntries.Sample NOT-IMPLEMENTED")
+	return e
+}
+
+func (e *DirectoryEntries) arrange(entries []fs.DirEntry) {
+	grouped := lo.GroupBy(entries, func(item fs.DirEntry) bool {
 		return item.IsDir()
 	})
 
@@ -76,8 +82,8 @@ func (e *DirectoryEntries) all() []fs.DirEntry {
 	return result
 }
 
-func (e *DirectoryEntries) sort(entries *[]fs.DirEntry) {
-	if err := e.Options.Hooks.Sort(*entries); err != nil {
+func (e *DirectoryEntries) sort(entries []fs.DirEntry) {
+	if err := e.Options.Hooks.Sort(entries); err != nil {
 		panic(xi18n.NewSortFnFailedError())
 	}
 }
diff --git a/xfs/nav/errors.go b/xfs/nav/errors.go
@@ -1,9 +1,14 @@
 package nav
 
 import (
+	"errors"
 	"fmt"
 )
 
+// Errors defined here are internal errors that are of no value to end
+// users (hence not l10n). There are usually programming errors which
+// means they only have meaning for client developers.
+
 // ❌ Invalid Notification Mute Requested
 
 // NewInvalidNotificationMuteRequestedNativeError creates an untranslated error to
@@ -51,3 +56,11 @@ func NewInvalidPeriscopeRootPathNativeError(root, current string) error {
 func NewResumeControllerNotSetNativeError(from string) error {
 	return fmt.Errorf("internal: resume controller not set (from: '%v')", from)
 }
+
+// static errors, identifiable with errors.Is
+
+// ErrUndefinedSubscriptionType indicates client has not set the navigation
+// subscription type at /Options.Store.Subscription.
+var ErrUndefinedSubscriptionType = errors.New(
+	"undefined subscription type; please set in traverse options (/Options.Store.Subscription)",
+)
diff --git a/xfs/nav/filter-defs.go b/xfs/nav/filter-defs.go
@@ -167,3 +167,10 @@ type compoundCounters struct {
 	filteredIn  uint
 	filteredOut uint
 }
+
+var BenignNodeFilterDef = FilterDef{
+	Type:        FilterTypeRegexEn,
+	Description: "benign allow all",
+	Pattern:     ".",
+	Scope:       ScopeRootEn,
+}
diff --git a/xfs/nav/filter-glob_test.go b/xfs/nav/filter-glob_test.go
@@ -114,7 +114,7 @@ var _ = Describe("FilterGlob", Ordered, func() {
 				message:      "universal(any scope): glob filter",
 				relative:     "RETRO-WAVE",
 				subscription: nav.SubscribeAny,
-				expectedNoOf: expectedNo{
+				expectedNoOf: directoryQuantities{
 					files:   8,
 					folders: 0,
 				},
@@ -129,7 +129,7 @@ var _ = Describe("FilterGlob", Ordered, func() {
 				message:      "universal(any scope): glob filter (negate)",
 				relative:     "RETRO-WAVE",
 				subscription: nav.SubscribeAny,
-				expectedNoOf: expectedNo{
+				expectedNoOf: directoryQuantities{
 					files:   6,
 					folders: 8,
 				},
@@ -145,7 +145,7 @@ var _ = Describe("FilterGlob", Ordered, func() {
 				message:      "universal(undefined scope): glob filter",
 				relative:     "RETRO-WAVE",
 				subscription: nav.SubscribeAny,
-				expectedNoOf: expectedNo{
+				expectedNoOf: directoryQuantities{
 					files:   8,
 					folders: 0,
 				},
@@ -161,7 +161,7 @@ var _ = Describe("FilterGlob", Ordered, func() {
 				message:      "universal(any scope): glob filter (ifNotApplicable=true)",
 				relative:     "RETRO-WAVE",
 				subscription: nav.SubscribeAny,
-				expectedNoOf: expectedNo{
+				expectedNoOf: directoryQuantities{
 					files:   8,
 					folders: 4,
 				},
@@ -178,7 +178,7 @@ var _ = Describe("FilterGlob", Ordered, func() {
 				message:      "universal(leaf scope): glob filter (ifNotApplicable=false)",
 				relative:     "RETRO-WAVE",
 				subscription: nav.SubscribeAny,
-				expectedNoOf: expectedNo{
+				expectedNoOf: directoryQuantities{
 					files:   8,
 					folders: 0,
 				},
@@ -272,7 +272,7 @@ var _ = Describe("FilterGlob", Ordered, func() {
 				message:      "folder(with files): glob filter",
 				relative:     "RETRO-WAVE",
 				subscription: nav.SubscribeFoldersWithFiles,
-				expectedNoOf: expectedNo{
+				expectedNoOf: directoryQuantities{
 					files:   0,
 					folders: 8,
 					children: map[string]int{
@@ -292,7 +292,7 @@ var _ = Describe("FilterGlob", Ordered, func() {
 				message:      "folder(with files): glob filter (negate)",
 				relative:     "RETRO-WAVE",
 				subscription: nav.SubscribeFoldersWithFiles,
-				expectedNoOf: expectedNo{
+				expectedNoOf: directoryQuantities{
 					files:   0,
 					folders: 8,
 					children: map[string]int{

diff --git a/xfs/nav/filter-init.go b/xfs/nav/filter-init.go
@@ -15,30 +15,40 @@ func InitFiltersHookFn(o *TraverseOptions, frame *navigationFrame) {
 	if o.Store.FilterDefs != nil {
 		frame.filters = &NavigationFilters{}
 
-		if o.Store.FilterDefs.Node.Pattern != "" || o.Store.FilterDefs.Node.Custom != nil {
-			o.useExtendHook()
-			frame.filters.Node = newNodeFilter(&o.Store.FilterDefs.Node)
-			decorated := frame.client
-			decorator := &LabelledTraverseCallback{
-				Label: "filter decorator",
-				Fn: func(item *TraverseItem) error {
-					if frame.filters.Node.IsMatch(item) {
-						return decorated.Fn(item)
-					}
-
-					item.filteredOut = true
-					return nil
-				},
+		if !o.isSamplingActive() {
+			if o.isFilteringActive() {
+				o.useExtendHook()
+				applyNodeFilterDecoration(&o.Store.FilterDefs.Node, frame)
 			}
-			frame.raw = decorator
-			frame.decorate("init-current-filter 🎁", decorator)
-		}
 
-		if o.Store.FilterDefs.Children.Pattern != "" || o.Store.FilterDefs.Children.Custom != nil {
-			o.useExtendHook()
-			frame.filters.Children = newCompoundFilter(&o.Store.FilterDefs.Children)
+			if o.Store.FilterDefs.Children.Pattern != "" || o.Store.FilterDefs.Children.Custom != nil {
+				if frame.filters.Node == nil {
+					applyNodeFilterDecoration(&BenignNodeFilterDef, frame)
+				}
+
+				frame.filters.Children = newCompoundFilter(&o.Store.FilterDefs.Children)
+			}
 		}
 	} else {
 		frame.raw = frame.client
 	}
 }
+
+func applyNodeFilterDecoration(nodeDef *FilterDef, frame *navigationFrame) {
+	frame.filters.Node = newNodeFilter(nodeDef)
+	decorated := frame.client
+	decorator := &LabelledTraverseCallback{
+		Label: "filter decorator",
+		Fn: func(item *TraverseItem) error {
+			if frame.filters.Node.IsMatch(item) {
+				return decorated.Fn(item)
+			}
+
+			item.filteredOut = true
+			return nil
+		},
+	}
+
+	frame.raw = decorator
+	frame.decorate("init-current-filter 🎁", decorator)
+}
diff --git a/xfs/nav/filter-regex_test.go b/xfs/nav/filter-regex_test.go
@@ -112,7 +112,7 @@ var _ = Describe("FilterRegex", Ordered, func() {
 				message:      "files(any scope): regex filter",
 				relative:     "RETRO-WAVE",
 				subscription: nav.SubscribeFiles,
-				expectedNoOf: expectedNo{
+				expectedNoOf: directoryQuantities{
 					files:   4,
 					folders: 0,
 				},
@@ -126,7 +126,7 @@ var _ = Describe("FilterRegex", Ordered, func() {
 				message:      "files(any scope): regex filter (negate)",
 				relative:     "RETRO-WAVE",
 				subscription: nav.SubscribeFiles,
-				expectedNoOf: expectedNo{
+				expectedNoOf: directoryQuantities{
 					files:   10,
 					folders: 0,
 				},
@@ -141,7 +141,7 @@ var _ = Describe("FilterRegex", Ordered, func() {
 				message:      "files(default to any scope): regex filter",
 				relative:     "RETRO-WAVE",
 				subscription: nav.SubscribeFiles,
-				expectedNoOf: expectedNo{
+				expectedNoOf: directoryQuantities{
 					files:   4,
 					folders: 0,
 				},
@@ -157,7 +157,7 @@ var _ = Describe("FilterRegex", Ordered, func() {
 				message:      "folders(any scope): regex filter",
 				relative:     "RETRO-WAVE",
 				subscription: nav.SubscribeFolders,
-				expectedNoOf: expectedNo{
+				expectedNoOf: directoryQuantities{
 					files:   0,
 					folders: 2,
 				},
@@ -172,7 +172,7 @@ var _ = Describe("FilterRegex", Ordered, func() {
 				message:      "folders(any scope): regex filter (negate)",
 				relative:     "RETRO-WAVE",
 				subscription: nav.SubscribeFolders,
-				expectedNoOf: expectedNo{
+				expectedNoOf: directoryQuantities{
 					files:   0,
 					folders: 6,
 				},
@@ -188,7 +188,7 @@ var _ = Describe("FilterRegex", Ordered, func() {
 				message:      "folders(undefined scope): regex filter",
 				relative:     "RETRO-WAVE",
 				subscription: nav.SubscribeFolders,
-				expectedNoOf: expectedNo{
+				expectedNoOf: directoryQuantities{
 					files:   0,
 					folders: 2,
 				},
@@ -204,7 +204,7 @@ var _ = Describe("FilterRegex", Ordered, func() {
 				message:      "folders(top): regex filter (ifNotApplicable=true)",
 				relative:     "PROGRESSIVE-HOUSE",
 				subscription: nav.SubscribeFolders,
-				expectedNoOf: expectedNo{
+				expectedNoOf: directoryQuantities{
 					files:   0,
 					folders: 10,
 				},
@@ -222,7 +222,7 @@ var _ = Describe("FilterRegex", Ordered, func() {
 				relative:     "",
 				subscription: nav.SubscribeFolders,
 				mandatory:    []string{"PROGRESSIVE-HOUSE"},
-				expectedNoOf: expectedNo{
+				expectedNoOf: directoryQuantities{
 					files:   0,
 					folders: 1,
 				},
@@ -320,7 +320,7 @@ var _ = Describe("FilterRegex", Ordered, func() {
 				relative:     "RETRO-WAVE",
 				subscription: nav.SubscribeFoldersWithFiles,
 
-				expectedNoOf: expectedNo{
+				expectedNoOf: directoryQuantities{
 					files:   0,
 					folders: 8,
 					children: map[string]int{
@@ -340,7 +340,7 @@ var _ = Describe("FilterRegex", Ordered, func() {
 				message:      "folder(with files): regex filter (negate)",
 				relative:     "RETRO-WAVE",
 				subscription: nav.SubscribeFoldersWithFiles,
-				expectedNoOf: expectedNo{
+				expectedNoOf: directoryQuantities{
 					files:   0,
 					folders: 8,
 					children: map[string]int{