chore: Move Option and Enumerable to immutables (sourcenetwork#939)

Relevant issue(s)
Resolves sourcenetwork#854
Resolves sourcenetwork#853

Description
This PR adds no new code. It's simply moving or renaming things. Mainly, the Option and Enumerable types are moved the external immutable package and the UpdateEvent is moved to the events package are renamed Update.

api/http/handlerfuncs.go

@@ -25,7 +25,6 @@ import (
 	"github.com/multiformats/go-multihash"
 	"github.com/pkg/errors"
 
-	"github.com/sourcenetwork/defradb/client"
 	corecrdt "github.com/sourcenetwork/defradb/core/crdt"
 	"github.com/sourcenetwork/defradb/events"
 )
@@ -266,7 +265,7 @@ func peerIDHandler(rw http.ResponseWriter, req *http.Request) {
 	)
 }
 
-func subscriptionHandler(pub *events.Publisher[client.UpdateEvent], rw http.ResponseWriter, req *http.Request) {
+func subscriptionHandler(pub *events.Publisher[events.Update], rw http.ResponseWriter, req *http.Request) {
 	flusher, ok := rw.(http.Flusher)
 	if !ok {
 		handleErr(req.Context(), rw, errors.New("streaming unsupported"), http.StatusInternalServerError)

api/http/server.go

@@ -19,6 +19,7 @@ import (
 	"path"
 	"strings"
 
+	"github.com/sourcenetwork/immutable"
 	"golang.org/x/crypto/acme/autocert"
 
 	"github.com/sourcenetwork/defradb/client"
@@ -55,7 +56,7 @@ type serverOptions struct {
 	// ID of the server node.
 	peerID string
 	// when the value is present, the server will run with tls
-	tls client.Option[tlsOptions]
+	tls immutable.Option[tlsOptions]
 	// root directory for the node config.
 	rootDir string
 }
@@ -132,7 +133,7 @@ func WithAddress(addr string) func(*Server) {
 			if ip == nil {
 				tlsOpt := s.options.tls.Value()
 				tlsOpt.domain = addr
-				s.options.tls = client.Some(tlsOpt)
+				s.options.tls = immutable.Some(tlsOpt)
 			}
 		}
 	}
@@ -142,7 +143,7 @@ func WithCAEmail(email string) func(*Server) {
 	return func(s *Server) {
 		tlsOpt := s.options.tls.Value()
 		tlsOpt.email = email
-		s.options.tls = client.Some(tlsOpt)
+		s.options.tls = immutable.Some(tlsOpt)
 	}
 }
 
@@ -163,15 +164,15 @@ func WithSelfSignedCert(pubKey, privKey string) func(*Server) {
 		tlsOpt := s.options.tls.Value()
 		tlsOpt.pubKey = pubKey
 		tlsOpt.privKey = privKey
-		s.options.tls = client.Some(tlsOpt)
+		s.options.tls = immutable.Some(tlsOpt)
 	}
 }
 
 func WithTLSPort(port int) func(*Server) {
 	return func(s *Server) {
 		tlsOpt := s.options.tls.Value()
 		tlsOpt.port = fmt.Sprintf(":%d", port)
-		s.options.tls = client.Some(tlsOpt)
+		s.options.tls = immutable.Some(tlsOpt)
 	}
 }
 

client/db.go

@@ -36,7 +36,7 @@ type DB interface {
 	ExecTransactionalQuery(ctx context.Context, query string, txn datastore.Txn) *QueryResult
 	Close(context.Context)
 
-	Events() Events
+	Events() events.Events
 
 	PrintDump(ctx context.Context) error
 }
@@ -48,5 +48,5 @@ type GQLResult struct {
 
 type QueryResult struct {
 	GQL GQLResult
-	Pub *events.Publisher[UpdateEvent]
+	Pub *events.Publisher[events.Update]
 }

client/request/aggregate.go

@@ -10,7 +10,7 @@
 
 package request
 
-import "github.com/sourcenetwork/defradb/client"
+import immutables "github.com/sourcenetwork/immutable"
 
 type Aggregate struct {
 	Field
@@ -20,10 +20,10 @@ type Aggregate struct {
 
 type AggregateTarget struct {
 	HostName  string
-	ChildName client.Option[string]
+	ChildName immutables.Option[string]
 
-	Limit   client.Option[uint64]
-	Offset  client.Option[uint64]
-	OrderBy client.Option[OrderBy]
-	Filter  client.Option[Filter]
+	Limit   immutables.Option[uint64]
+	Offset  immutables.Option[uint64]
+	OrderBy immutables.Option[OrderBy]
+	Filter  immutables.Option[Filter]
 }

client/request/commit.go

@@ -10,7 +10,7 @@
 
 package request
 
-import "github.com/sourcenetwork/defradb/client"
+import "github.com/sourcenetwork/immutable"
 
 var (
 	_ Selection = (*CommitSelect)(nil)
@@ -19,15 +19,15 @@ var (
 type CommitSelect struct {
 	Field
 
-	DocKey    client.Option[string]
-	FieldName client.Option[string]
-	Cid       client.Option[string]
-	Depth     client.Option[uint64]
+	DocKey    immutable.Option[string]
+	FieldName immutable.Option[string]
+	Cid       immutable.Option[string]
+	Depth     immutable.Option[uint64]
 
-	Limit   client.Option[uint64]
-	Offset  client.Option[uint64]
-	OrderBy client.Option[OrderBy]
-	GroupBy client.Option[GroupBy]
+	Limit   immutable.Option[uint64]
+	Offset  immutable.Option[uint64]
+	OrderBy immutable.Option[OrderBy]
+	GroupBy immutable.Option[GroupBy]
 
 	Fields []Selection
 }

client/request/field.go

@@ -10,10 +10,10 @@
 
 package request
 
-import "github.com/sourcenetwork/defradb/client"
+import "github.com/sourcenetwork/immutable"
 
 // Field implements Selection
 type Field struct {
 	Name  string
-	Alias client.Option[string]
+	Alias immutable.Option[string]
 }

client/request/mutation.go

@@ -10,7 +10,7 @@
 
 package request
 
-import "github.com/sourcenetwork/defradb/client"
+import "github.com/sourcenetwork/immutable"
 
 type MutationType int
 
@@ -35,8 +35,8 @@ type Mutation struct {
 	// if this mutation is on an object.
 	Collection string
 
-	IDs    client.Option[[]string]
-	Filter client.Option[Filter]
+	IDs    immutable.Option[[]string]
+	Filter immutable.Option[Filter]
 	Data   string
 
 	Fields []Selection

client/request/select.go

@@ -10,7 +10,11 @@
 
 package request
 
-import "github.com/sourcenetwork/defradb/client"
+import (
+	"github.com/sourcenetwork/immutable"
+
+	"github.com/sourcenetwork/defradb/client"
+)
 
 type SelectionType int
 
@@ -26,17 +30,17 @@ const (
 type Select struct {
 	Field
 
-	DocKeys client.Option[[]string]
-	CID     client.Option[string]
+	DocKeys immutable.Option[[]string]
+	CID     immutable.Option[string]
 
 	// Root is the top level query parsed type
 	Root SelectionType
 
-	Limit   client.Option[uint64]
-	Offset  client.Option[uint64]
-	OrderBy client.Option[OrderBy]
-	GroupBy client.Option[GroupBy]
-	Filter  client.Option[Filter]
+	Limit   immutable.Option[uint64]
+	Offset  immutable.Option[uint64]
+	OrderBy immutable.Option[OrderBy]
+	GroupBy immutable.Option[GroupBy]
+	Filter  immutable.Option[Filter]
 
 	Fields []Selection
 }

client/request/subscription.go

@@ -11,7 +11,7 @@
 package request
 
 import (
-	"github.com/sourcenetwork/defradb/client"
+	"github.com/sourcenetwork/immutable"
 )
 
 // ObjectSubscription is a field on the SubscriptionType
@@ -23,7 +23,7 @@ type ObjectSubscription struct {
 	// Collection is the target collection name
 	Collection string
 
-	Filter client.Option[Filter]
+	Filter immutable.Option[Filter]
 
 	Fields []Selection
 }
@@ -36,8 +36,8 @@ func (m ObjectSubscription) ToSelect(docKey, cid string) *Select {
 			Name:  m.Collection,
 			Alias: m.Alias,
 		},
-		DocKeys: client.Some([]string{docKey}),
-		CID:     client.Some(cid),
+		DocKeys: immutable.Some([]string{docKey}),
+		CID:     immutable.Some(cid),
 		Fields:  m.Fields,
 		Filter:  m.Filter,
 	}

connor/eq.go

@@ -4,7 +4,8 @@ import (
 	"reflect"
 	"time"
 
-	"github.com/sourcenetwork/defradb/client"
+	"github.com/sourcenetwork/immutable"
+
 	"github.com/sourcenetwork/defradb/connor/numbers"
 	ctime "github.com/sourcenetwork/defradb/connor/time"
 	"github.com/sourcenetwork/defradb/core"
@@ -27,25 +28,25 @@ func eq(condition, data any) (bool, error) {
 		}
 		return false, nil
 
-	case client.Option[bool]:
+	case immutable.Option[bool]:
 		if !arr.HasValue() {
 			return condition == nil, nil
 		}
 		data = arr.Value()
 
-	case client.Option[int64]:
+	case immutable.Option[int64]:
 		if !arr.HasValue() {
 			return condition == nil, nil
 		}
 		data = arr.Value()
 
-	case client.Option[float64]:
+	case immutable.Option[float64]:
 		if !arr.HasValue() {
 			return condition == nil, nil
 		}
 		data = arr.Value()
 
-	case client.Option[string]:
+	case immutable.Option[string]:
 		if !arr.HasValue() {
 			return condition == nil, nil
 		}

core/doc.go

@@ -14,7 +14,8 @@ Package core provides commonly shared interfaces and building blocks.
 package core
 
 import (
-	"github.com/sourcenetwork/defradb/client"
+	"github.com/sourcenetwork/immutable"
+
 	"github.com/sourcenetwork/defradb/client/request"
 )
 
@@ -86,7 +87,7 @@ type mappingTypeInfo struct {
 
 type DocumentMapping struct {
 	// The type information for the object, if provided.
-	typeInfo client.Option[mappingTypeInfo]
+	typeInfo immutable.Option[mappingTypeInfo]
 
 	// The set of fields that should be rendered.
 	//
@@ -230,7 +231,7 @@ func (mapping *DocumentMapping) Add(index int, name string) {
 func (mapping *DocumentMapping) SetTypeName(typeName string) {
 	index := mapping.GetNextIndex()
 	mapping.Add(index, request.TypeNameFieldName)
-	mapping.typeInfo = client.Some(mappingTypeInfo{
+	mapping.typeInfo = immutable.Some(mappingTypeInfo{
 		Index: index,
 		Name:  typeName,
 	})