refactor(cardinal): untangle iterator and filter package

cardinal/benchmark/benchmark_test.go

@@ -10,7 +10,7 @@ import (
 
 	"pkg.world.dev/world-engine/assert"
 	"pkg.world.dev/world-engine/cardinal"
-	"pkg.world.dev/world-engine/cardinal/search/filter"
+	"pkg.world.dev/world-engine/cardinal/filter"
 	"pkg.world.dev/world-engine/cardinal/types"
 )
 

cardinal/cardinal.go

@@ -8,18 +8,18 @@ import (
 	"github.com/rotisserie/eris"
 
 	"pkg.world.dev/world-engine/cardinal/component"
-	"pkg.world.dev/world-engine/cardinal/iterators"
+	"pkg.world.dev/world-engine/cardinal/gamestate"
 	"pkg.world.dev/world-engine/cardinal/types"
 	"pkg.world.dev/world-engine/cardinal/worldstage"
 )
 
 var (
 	ErrEntityMutationOnReadOnly          = errors.New("cannot modify state with read only context")
 	ErrEntitiesCreatedBeforeReady        = errors.New("entities should not be created before world is ready")
-	ErrEntityDoesNotExist                = iterators.ErrEntityDoesNotExist
-	ErrEntityMustHaveAtLeastOneComponent = iterators.ErrEntityMustHaveAtLeastOneComponent
-	ErrComponentNotOnEntity              = iterators.ErrComponentNotOnEntity
-	ErrComponentAlreadyOnEntity          = iterators.ErrComponentAlreadyOnEntity
+	ErrEntityDoesNotExist                = gamestate.ErrEntityDoesNotExist
+	ErrEntityMustHaveAtLeastOneComponent = gamestate.ErrEntityMustHaveAtLeastOneComponent
+	ErrComponentNotOnEntity              = gamestate.ErrComponentNotOnEntity
+	ErrComponentAlreadyOnEntity          = gamestate.ErrComponentAlreadyOnEntity
 )
 
 // FilterFunction wrap your component filter function of func(comp T) bool inside FilterFunction to use

cardinal/cardinal_test.go

@@ -19,8 +19,8 @@ import (
 
 	"pkg.world.dev/world-engine/assert"
 	"pkg.world.dev/world-engine/cardinal"
+	"pkg.world.dev/world-engine/cardinal/filter"
 	"pkg.world.dev/world-engine/cardinal/router/mocks"
-	"pkg.world.dev/world-engine/cardinal/search/filter"
 	"pkg.world.dev/world-engine/cardinal/testutils"
 	"pkg.world.dev/world-engine/cardinal/types"
 	"pkg.world.dev/world-engine/sign"

cardinal/component/component_test.go

@@ -5,8 +5,8 @@ import (
 
 	"pkg.world.dev/world-engine/assert"
 	"pkg.world.dev/world-engine/cardinal"
-	"pkg.world.dev/world-engine/cardinal/iterators"
-	"pkg.world.dev/world-engine/cardinal/search/filter"
+	"pkg.world.dev/world-engine/cardinal/filter"
+	"pkg.world.dev/world-engine/cardinal/gamestate"
 	"pkg.world.dev/world-engine/cardinal/types"
 )
 
@@ -276,7 +276,7 @@ func TestErrorWhenAccessingComponentNotOnEntity(t *testing.T) {
 	id, err := cardinal.Create(wCtx, foundComp{})
 	assert.NilError(t, err)
 	_, err = cardinal.GetComponent[notFoundComp](wCtx, id)
-	assert.ErrorIs(t, err, iterators.ErrComponentNotOnEntity)
+	assert.ErrorIs(t, err, gamestate.ErrComponentNotOnEntity)
 }
 
 type ValueComponent struct {

cardinal/composedsearch.go

@@ -3,7 +3,7 @@ package cardinal
 import (
 	"github.com/rotisserie/eris"
 
-	"pkg.world.dev/world-engine/cardinal/search/filter"
+	"pkg.world.dev/world-engine/cardinal/filter"
 	"pkg.world.dev/world-engine/cardinal/types"
 )
 

cardinal/ecs_test.go

@@ -6,8 +6,7 @@ import (
 
 	"pkg.world.dev/world-engine/assert"
 	"pkg.world.dev/world-engine/cardinal"
-	"pkg.world.dev/world-engine/cardinal/iterators"
-	"pkg.world.dev/world-engine/cardinal/search/filter"
+	"pkg.world.dev/world-engine/cardinal/filter"
 	"pkg.world.dev/world-engine/cardinal/types"
 )
 
@@ -367,7 +366,7 @@ func TestAddingAComponentThatAlreadyExistsIsError(t *testing.T) {
 	wCtx := cardinal.NewWorldContext(world)
 	ent, err := cardinal.Create(wCtx, EnergyComponent{})
 	assert.NilError(t, err)
-	assert.ErrorIs(t, cardinal.AddComponentTo[EnergyComponent](wCtx, ent), iterators.ErrComponentAlreadyOnEntity)
+	assert.ErrorIs(t, cardinal.AddComponentTo[EnergyComponent](wCtx, ent), cardinal.ErrComponentAlreadyOnEntity)
 }
 
 func TestRemovingAMissingComponentIsError(t *testing.T) {
@@ -380,7 +379,7 @@ func TestRemovingAMissingComponentIsError(t *testing.T) {
 	ent, err := cardinal.Create(wCtx, ReactorEnergy{})
 	assert.NilError(t, err)
 
-	assert.ErrorIs(t, cardinal.RemoveComponentFrom[WeaponEnergy](wCtx, ent), iterators.ErrComponentNotOnEntity)
+	assert.ErrorIs(t, cardinal.RemoveComponentFrom[WeaponEnergy](wCtx, ent), cardinal.ErrComponentNotOnEntity)
 }
 
 func TestVerifyAutomaticCreationOfArchetypesWorks(t *testing.T) {

cardinal/errors_test.go

@@ -8,7 +8,7 @@ import (
 
 	"pkg.world.dev/world-engine/assert"
 	"pkg.world.dev/world-engine/cardinal/component"
-	"pkg.world.dev/world-engine/cardinal/search/filter"
+	"pkg.world.dev/world-engine/cardinal/filter"
 )
 
 // TestSystemsReturnNonFatalErrors ensures system will surface non-fatal read and write errors to the user.

cardinal/search/filter/filter_test.go → cardinal/filter/filter_test.go

@@ -8,8 +8,7 @@ import (
 
 	"pkg.world.dev/world-engine/assert"
 	"pkg.world.dev/world-engine/cardinal"
-	"pkg.world.dev/world-engine/cardinal/iterators"
-	"pkg.world.dev/world-engine/cardinal/search/filter"
+	"pkg.world.dev/world-engine/cardinal/filter"
 	"pkg.world.dev/world-engine/cardinal/server/handler/cql"
 	"pkg.world.dev/world-engine/cardinal/types"
 )
@@ -87,7 +86,7 @@ func TestCanFilterByArchetype(t *testing.T) {
 			count++
 			// Make sure the gamma component is not on this entity
 			_, err = cardinal.GetComponent[Gamma](wCtx, id)
-			assert.ErrorIs(t, err, iterators.ErrComponentNotOnEntity)
+			assert.ErrorIs(t, err, cardinal.ErrComponentNotOnEntity)
 			return true
 		},
 	)

cardinal/gamestate/ecb.go

@@ -13,9 +13,8 @@ import (
 	"go.opentelemetry.io/otel/trace"
 
 	"pkg.world.dev/world-engine/cardinal/codec"
-	"pkg.world.dev/world-engine/cardinal/iterators"
+	"pkg.world.dev/world-engine/cardinal/filter"
 	ecslog "pkg.world.dev/world-engine/cardinal/log"
-	"pkg.world.dev/world-engine/cardinal/search/filter"
 	"pkg.world.dev/world-engine/cardinal/types"
 )
 
@@ -231,7 +230,7 @@ func (m *EntityCommandBuffer) SetComponentForEntity(
 		return err
 	}
 	if !filter.MatchComponentMetadata(comps, cType) {
-		return eris.Wrap(iterators.ErrComponentNotOnEntity, "")
+		return eris.Wrap(ErrComponentNotOnEntity, "")
 	}
 
 	key := compKey{cType.ID(), id}
@@ -252,7 +251,7 @@ func (m *EntityCommandBuffer) GetComponentForEntity(cType types.ComponentMetadat
 		return nil, err
 	}
 	if !filter.MatchComponentMetadata(comps, cType) {
-		return nil, eris.Wrap(iterators.ErrComponentNotOnEntity, "")
+		return nil, eris.Wrap(ErrComponentNotOnEntity, "")
 	}
 
 	// Fetch the value from storage
@@ -297,7 +296,7 @@ func (m *EntityCommandBuffer) AddComponentToEntity(cType types.ComponentMetadata
 		return err
 	}
 	if filter.MatchComponentMetadata(fromComps, cType) {
-		return eris.Wrap(iterators.ErrComponentAlreadyOnEntity, "")
+		return eris.Wrap(ErrComponentAlreadyOnEntity, "")
 	}
 	toComps := append(fromComps, cType) //nolint:gocritic // easier this way.
 	if err = sortComponentSet(toComps); err != nil {
@@ -332,10 +331,10 @@ func (m *EntityCommandBuffer) RemoveComponentFromEntity(cType types.ComponentMet
 		newCompSet = append(newCompSet, comp)
 	}
 	if !found {
-		return eris.Wrap(iterators.ErrComponentNotOnEntity, "")
+		return eris.Wrap(ErrComponentNotOnEntity, "")
 	}
 	if len(newCompSet) == 0 {
-		return eris.Wrap(iterators.ErrEntityMustHaveAtLeastOneComponent, "")
+		return eris.Wrap(ErrEntityMustHaveAtLeastOneComponent, "")
 	}
 	key := compKey{cType.ID(), id}
 	err = m.compValues.Delete(key)
@@ -409,8 +408,8 @@ func (m *EntityCommandBuffer) GetEntitiesForArchID(archID types.ArchetypeID) ([]
 
 // SearchFrom returns an ArchetypeIterator based on a component filter. The iterator will iterate over all archetypes
 // that match the given filter.
-func (m *EntityCommandBuffer) SearchFrom(filter filter.ComponentFilter, start int) *iterators.ArchetypeIterator {
-	itr := &iterators.ArchetypeIterator{}
+func (m *EntityCommandBuffer) SearchFrom(filter filter.ComponentFilter, start int) *ArchetypeIterator {
+	itr := &ArchetypeIterator{}
 	for i := start; i < m.archIDToComps.Len(); i++ {
 		archID := types.ArchetypeID(i)
 		// TODO: error was swallowed here.
@@ -454,7 +453,7 @@ func (m *EntityCommandBuffer) getArchetypeForEntity(id types.EntityID) (types.Ar
 	if err != nil {
 		// todo: Make redis.Nil a general error on storage
 		if errors.Is(err, redis.Nil) {
-			return 0, eris.Wrap(redis.Nil, iterators.ErrEntityDoesNotExist.Error())
+			return 0, eris.Wrap(redis.Nil, ErrEntityDoesNotExist.Error())
 		}
 		return 0, eris.Wrap(err, "")
 	}

cardinal/gamestate/ecb_test.go

@@ -12,9 +12,8 @@ import (
 	"pkg.world.dev/world-engine/assert"
 	"pkg.world.dev/world-engine/cardinal"
 	"pkg.world.dev/world-engine/cardinal/component"
+	"pkg.world.dev/world-engine/cardinal/filter"
 	"pkg.world.dev/world-engine/cardinal/gamestate"
-	"pkg.world.dev/world-engine/cardinal/iterators"
-	"pkg.world.dev/world-engine/cardinal/search/filter"
 	"pkg.world.dev/world-engine/cardinal/types"
 )
 
@@ -224,7 +223,7 @@ func TestCannotGetComponentOnEntityThatIsMissingTheComponent(t *testing.T) {
 	assert.NilError(t, err)
 	// barComp has not been assigned to this entity
 	_, err = manager.GetComponentForEntity(barComp, id)
-	assert.ErrorIs(t, err, iterators.ErrComponentNotOnEntity)
+	assert.ErrorIs(t, err, gamestate.ErrComponentNotOnEntity)
 }
 
 func TestCannotSetComponentOnEntityThatIsMissingTheComponent(t *testing.T) {
@@ -233,15 +232,15 @@ func TestCannotSetComponentOnEntityThatIsMissingTheComponent(t *testing.T) {
 	assert.NilError(t, err)
 	// barComp has not been assigned to this entity
 	err = manager.SetComponentForEntity(barComp, id, Bar{100})
-	assert.ErrorIs(t, err, iterators.ErrComponentNotOnEntity)
+	assert.ErrorIs(t, err, gamestate.ErrComponentNotOnEntity)
 }
 
 func TestCannotRemoveAComponentFromAnEntityThatDoesNotHaveThatComponent(t *testing.T) {
 	manager := newCmdBufferForTest(t)
 	id, err := manager.CreateEntity(fooComp)
 	assert.NilError(t, err)
 	err = manager.RemoveComponentFromEntity(barComp, id)
-	assert.ErrorIs(t, err, iterators.ErrComponentNotOnEntity)
+	assert.ErrorIs(t, err, gamestate.ErrComponentNotOnEntity)
 }
 
 func TestCanAddAComponentToAnEntity(t *testing.T) {
@@ -288,7 +287,7 @@ func TestCannotAddComponentToEntityThatAlreadyHasTheComponent(t *testing.T) {
 	assert.NilError(t, err)
 
 	err = manager.AddComponentToEntity(fooComp, id)
-	assert.ErrorIs(t, err, iterators.ErrComponentAlreadyOnEntity)
+	assert.ErrorIs(t, err, gamestate.ErrComponentAlreadyOnEntity)
 }
 
 type Health struct {

cardinal/iterators/constants.go → cardinal/gamestate/errors.go

@@ -1,15 +1,10 @@
-package iterators
+package gamestate
 
 import (
 	"errors"
-	"math"
-
-	"pkg.world.dev/world-engine/cardinal/types"
 )
 
 var (
-	BadID types.EntityID = math.MaxUint64
-
 	ErrEntityDoesNotExist                = errors.New("entity does not exist")
 	ErrComponentAlreadyOnEntity          = errors.New("component already on entity")
 	ErrComponentNotOnEntity              = errors.New("component not on entity")

cardinal/iterators/index.go → cardinal/gamestate/iter_archetype.go

@@ -1,4 +1,4 @@
-package iterators
+package gamestate
 
 import (
 	"pkg.world.dev/world-engine/cardinal/types"

cardinal/gamestate/manager.go

@@ -4,8 +4,7 @@ import (
 	"context"
 	"encoding/json"
 
-	"pkg.world.dev/world-engine/cardinal/iterators"
-	"pkg.world.dev/world-engine/cardinal/search/filter"
+	"pkg.world.dev/world-engine/cardinal/filter"
 	"pkg.world.dev/world-engine/cardinal/types"
 )
 
@@ -25,7 +24,7 @@ type Reader interface {
 	GetEntitiesForArchID(archID types.ArchetypeID) ([]types.EntityID, error)
 
 	// Misc
-	SearchFrom(filter filter.ComponentFilter, start int) *iterators.ArchetypeIterator
+	SearchFrom(filter filter.ComponentFilter, start int) *ArchetypeIterator
 	ArchetypeCount() int
 }
 

cardinal/gamestate/read_only.go

@@ -8,8 +8,7 @@ import (
 	"github.com/rotisserie/eris"
 
 	"pkg.world.dev/world-engine/cardinal/codec"
-	"pkg.world.dev/world-engine/cardinal/iterators"
-	"pkg.world.dev/world-engine/cardinal/search/filter"
+	"pkg.world.dev/world-engine/cardinal/filter"
 	"pkg.world.dev/world-engine/cardinal/types"
 )
 
@@ -149,8 +148,8 @@ func (r *readOnlyManager) GetEntitiesForArchID(archID types.ArchetypeID) ([]type
 	return ids, nil
 }
 
-func (r *readOnlyManager) SearchFrom(filter filter.ComponentFilter, start int) *iterators.ArchetypeIterator {
-	itr := &iterators.ArchetypeIterator{}
+func (r *readOnlyManager) SearchFrom(filter filter.ComponentFilter, start int) *ArchetypeIterator {
+	itr := &ArchetypeIterator{}
 	if err := r.refreshArchIDToCompTypes(); err != nil {
 		return itr
 	}

cardinal/gamestate/read_only_test.go

@@ -6,7 +6,7 @@ import (
 
 	"pkg.world.dev/world-engine/assert"
 	"pkg.world.dev/world-engine/cardinal"
-	"pkg.world.dev/world-engine/cardinal/search/filter"
+	"pkg.world.dev/world-engine/cardinal/filter"
 	"pkg.world.dev/world-engine/cardinal/types"
 )
 

cardinal/gamestate/recovery_test.go

@@ -6,7 +6,6 @@ import (
 
 	"pkg.world.dev/world-engine/assert"
 	"pkg.world.dev/world-engine/cardinal/gamestate"
-	"pkg.world.dev/world-engine/cardinal/iterators"
 	"pkg.world.dev/world-engine/cardinal/types"
 )
 
@@ -256,7 +255,7 @@ func TestRemovedComponentDataCanBeRecovered(t *testing.T) {
 
 	// Make sure we can no longer get the foo component
 	_, err = manager.GetComponentForEntity(fooComp, id)
-	assert.ErrorIs(t, err, iterators.ErrComponentNotOnEntity)
+	assert.ErrorIs(t, err, gamestate.ErrComponentNotOnEntity)
 	// But uhoh, there was a problem. This means the removal of the Foo component
 	// will be undone, and the original value can be found
 	err = manager.DiscardPending()

cardinal/gamestate/redis.go

@@ -12,7 +12,6 @@ import (
 	ddtracer "gopkg.in/DataDog/dd-trace-go.v1/ddtrace/tracer"
 
 	"pkg.world.dev/world-engine/cardinal/codec"
-	"pkg.world.dev/world-engine/cardinal/iterators"
 	"pkg.world.dev/world-engine/cardinal/types"
 )
 
@@ -395,7 +394,7 @@ func getArchIDToCompTypesFromRedis(
 		for _, compTypeID := range compTypeIDs {
 			currComp, err := typeToComp.Get(compTypeID)
 			if err != nil {
-				return nil, false, eris.Wrap(iterators.ErrComponentMismatchWithSavedState, "")
+				return nil, false, eris.Wrap(ErrComponentMismatchWithSavedState, "")
 			}
 			currComps = append(currComps, currComp)
 		}