feat(hiber): implement hibernation (#143)

Taskfile.yml

@@ -80,6 +80,10 @@ tasks:
     cmds:
       - go test ./core
 
+  tf-hiber:
+    cmds:
+      - go test ./internal/feat/hiber
+
   toc:
     cmds:
       - go test ./collections

builders.go

@@ -110,8 +110,9 @@ func (bs *Builders) buildAll() (*buildArtefacts, error) {
 	order := manifest(active)
 	artefacts.Mediator.Arrange(active, order)
 	pi := &types.PluginInit{
-		Actions: actions,
-		O:       o,
+		Actions:  actions,
+		O:        o,
+		Controls: artefacts.Mediator.Controls(),
 	}
 
 	for _, p := range plugins {

core/hibernate.go

@@ -0,0 +1,9 @@
+package core
+
+type Hibernate struct {
+	// Node denotes the filter object that represents the current file system item
+	// being visited.
+	//
+	StartAt *FilterDef
+	StopAt  *FilterDef
+}

director-prime_test.go

@@ -7,14 +7,27 @@ import (
 	"github.com/fortytw2/leaktest"
 	. "github.com/onsi/ginkgo/v2" //nolint:revive // ok
 	. "github.com/onsi/gomega"    //nolint:revive // ok
+	"github.com/snivilised/li18ngo"
 	tv "github.com/snivilised/traverse"
 	"github.com/snivilised/traverse/core"
 	"github.com/snivilised/traverse/cycle"
+	"github.com/snivilised/traverse/enums"
 	"github.com/snivilised/traverse/internal/services"
+	"github.com/snivilised/traverse/locale"
 	"github.com/snivilised/traverse/pref"
 )
 
-var _ = Describe("Director(Prime)", func() {
+var _ = Describe("Director(Prime)", Ordered, func() {
+	BeforeAll(func() {
+		Expect(li18ngo.Use(
+			func(o *li18ngo.UseOptions) {
+				o.From.Sources = li18ngo.TranslationFiles{
+					locale.SourceID: li18ngo.TranslationSource{Name: "traverse"},
+				}
+			},
+		)).To(Succeed())
+	})
+
 	BeforeEach(func() {
 		services.Reset()
 	})
@@ -162,7 +175,11 @@ var _ = Describe("Director(Prime)", func() {
 							Subscription: tv.SubscribeFiles,
 							Handler:      noOpHandler,
 						},
-						tv.WithHibernationWake(&core.FilterDef{}),
+						tv.WithHibernationWake(&core.FilterDef{
+							Description: "nonsense",
+							Type:        enums.FilterTypeGlob,
+							Pattern:     "*",
+						}),
 						tv.WithOnStop(func(_ string) {}),
 					)).Navigate(ctx)
 
@@ -183,7 +200,11 @@ var _ = Describe("Director(Prime)", func() {
 							Subscription: tv.SubscribeFiles,
 							Handler:      noOpHandler,
 						},
-						tv.WithHibernationSleep(&core.FilterDef{}),
+						tv.WithHibernationSleep(&core.FilterDef{
+							Description: "nonsense",
+							Type:        enums.FilterTypeGlob,
+							Pattern:     "*",
+						}),
 						tv.WithOnStop(func(_ string) {}),
 					)).Navigate(ctx)
 

director-resume_test.go

@@ -11,11 +11,13 @@ import (
 	. "github.com/onsi/ginkgo/v2" //nolint:revive // ok
 	. "github.com/onsi/gomega"    //nolint:revive // ok
 
+	"github.com/snivilised/li18ngo"
 	tv "github.com/snivilised/traverse"
 	"github.com/snivilised/traverse/core"
 	"github.com/snivilised/traverse/cycle"
 	"github.com/snivilised/traverse/enums"
 	"github.com/snivilised/traverse/internal/services"
+	"github.com/snivilised/traverse/locale"
 	"github.com/snivilised/traverse/pref"
 )
 
@@ -36,6 +38,14 @@ var _ = Describe("Director(Resume)", Ordered, func() {
 				Mode: os.ModeDir,
 			},
 		}
+
+		Expect(li18ngo.Use(
+			func(o *li18ngo.UseOptions) {
+				o.From.Sources = li18ngo.TranslationFiles{
+					locale.SourceID: li18ngo.TranslationSource{Name: "traverse"},
+				}
+			},
+		)).To(Succeed())
 	})
 
 	BeforeEach(func() {
@@ -151,7 +161,11 @@ var _ = Describe("Director(Resume)", Ordered, func() {
 							From:     RestorePath,
 							Strategy: tv.ResumeStrategySpawn,
 						},
-						tv.WithHibernationWake(&core.FilterDef{}),
+						tv.WithHibernationWake(&core.FilterDef{
+							Description: "nonsense",
+							Type:        enums.FilterTypeGlob,
+							Pattern:     "*",
+						}),
 						restore,
 					)).Navigate(ctx)
 

enums/hibernation-en.go

@@ -8,21 +8,13 @@ type Hibernation uint
 const (
 	HibernationUndefined Hibernation = iota // undefined
 
-	// HibernationSleep listen not active, callback always invoked (subject to filtering)
-	//
-	HibernationSleep // sleep-hibernation
-
-	// HibernationFastward listen used to resume by fast-forwarding
-	//
-	HibernationFastward // fastward-hibernation
-
 	// HibernationPending conditional listening is awaiting activation
 	//
 	HibernationPending // pending-hibernation
 
-	// HibernationAwake conditional listening is active (callback is invoked)
+	// HibernationActive conditional listening is active (callback is invoked)
 	//
-	HibernationAwake // awake-hibernation
+	HibernationActive // active-hibernation
 
 	// HibernationRetired conditional listening is now deactivated
 	//

enums/role-en.go

@@ -5,11 +5,9 @@ package enums
 type Role uint32
 
 const (
-	RoleUndefined        Role = iota // undefined-role
-	RoleAnchor                       // anchor-role
-	RoleClientFilter                 // client-filter-role
-	RoleClientHiberWake              // client-hiber-wake-role
-	RoleClientHiberSleep             // client-hiber-sleep-role
-	RoleFastward                     // fastward-role
-	RoleSampler                      // sampler-role
+	RoleUndefined    Role = iota // undefined-role
+	RoleAnchor                   // anchor-role
+	RoleClientFilter             // client-filter-role
+	RoleHibernate                // hibernate-role
+	RoleSampler                  // sampler-role
 )

go.mod

@@ -17,7 +17,7 @@ require (
 	github.com/nicksnyder/go-i18n/v2 v2.4.0
 	github.com/pkg/errors v0.9.1
 	github.com/rogpeppe/go-internal v1.12.0 // indirect
-	github.com/snivilised/li18ngo v0.1.2
+	github.com/snivilised/li18ngo v0.1.3
 	github.com/snivilised/pants v0.1.2
 	golang.org/x/net v0.28.0 // indirect
 	golang.org/x/sys v0.24.0 // indirect

go.sum

@@ -28,8 +28,8 @@ github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZb
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
 github.com/rogpeppe/go-internal v1.12.0 h1:exVL4IDcn6na9z1rAb56Vxr+CgyK3nn3O+epU5NdKM8=
 github.com/rogpeppe/go-internal v1.12.0/go.mod h1:E+RYuTGaKKdloAfM02xzb0FW3Paa99yedzYV+kq4uf4=
-github.com/snivilised/li18ngo v0.1.2 h1:xiOZnAcIkeHfEVuTy/FBwA1u9IrAfYSjO/DYMC77z/I=
-github.com/snivilised/li18ngo v0.1.2/go.mod h1:Or3qUhpR6AM1X51i82RtyCvORWy2/hrxY9lg1i1gFTE=
+github.com/snivilised/li18ngo v0.1.3 h1:wi5pa66vs2/gXyvZP64i9uwlCvXpedELKdFpn3B3SR8=
+github.com/snivilised/li18ngo v0.1.3/go.mod h1:Or3qUhpR6AM1X51i82RtyCvORWy2/hrxY9lg1i1gFTE=
 github.com/snivilised/pants v0.1.2 h1:6Abj02gV5rFYyKfCsmeEiOi1pLdRyITKUY5oDoRgYuU=
 github.com/snivilised/pants v0.1.2/go.mod h1:BOZa24yLxVjjnTCFWQeCzUWL8eK4TLtXtkz3pMdEFQM=
 github.com/stretchr/testify v1.8.4 h1:CcVxjf3Q8PM0mHUKJCdn+eZZtm5yQwehR5yeSVQQcUk=

internal/feat/hiber/hibernation-defs.go → internal/feat/hiber/hibernate-defs.go

@@ -1,5 +1,11 @@
 package hiber
 
+import (
+	"github.com/snivilised/traverse/core"
+	"github.com/snivilised/traverse/enums"
+	"github.com/snivilised/traverse/pref"
+)
+
 const (
 	badge = "badge: hibernator"
 )
@@ -19,3 +25,22 @@ func RestoreOptions() {
 	// called by resume to load options from json file and
 	// setup binder to reflect this
 }
+
+type (
+	nextFn func(node *core.Node, inspection core.Inspection) (bool, error)
+
+	state struct {
+		next nextFn
+	}
+	hibernateStates map[enums.Hibernation]state
+
+	hibernateOptions struct {
+		o   *pref.HibernateOptions
+		beh *pref.HibernationBehaviour
+	}
+
+	triggers struct {
+		wake  core.TraverseFilter
+		sleep core.TraverseFilter
+	}
+)

internal/feat/hiber/hibernate-plugin.go

@@ -9,11 +9,19 @@ import (
 )
 
 func IfActive(o *pref.Options, mediator types.Mediator) types.Plugin {
-	if o.Hibernate.Wake != nil {
+	if o.Hibernate.IsHibernateActive() {
 		return &Plugin{
 			BasePlugin: kernel.BasePlugin{
 				Mediator:      mediator,
-				ActivatedRole: enums.RoleClientHiberSleep, // TODO: or wake; to be resolved
+				ActivatedRole: enums.RoleHibernate,
+			},
+			profile: &simple{
+				common: common{
+					ho: &hibernateOptions{
+						o:   &o.Hibernate,
+						beh: &o.Behaviours.Hibernation,
+					},
+				},
 			},
 		}
 	}
@@ -23,6 +31,7 @@ func IfActive(o *pref.Options, mediator types.Mediator) types.Plugin {
 
 type Plugin struct {
 	kernel.BasePlugin
+	profile profile
 }
 
 func (p *Plugin) Name() string {
@@ -36,11 +45,13 @@ func (p *Plugin) Register(kc types.KernelController) error {
 }
 
 func (p *Plugin) Next(node *core.Node, inspection core.Inspection) (bool, error) {
-	_, _ = node, inspection
-
-	return true, nil
+	return p.profile.next(node, inspection)
 }
 
-func (p *Plugin) Init(_ *types.PluginInit) error {
+func (p *Plugin) Init(pi *types.PluginInit) error {
+	if err := p.profile.init(pi.Controls); err != nil {
+		return err
+	}
+
 	return p.Mediator.Decorate(p)
 }