feat: add ephemeral attributes

internal/graph/schema/attribute.graphqls

@@ -34,6 +34,14 @@ type Attribute implements Node {
   """
   immutable: Boolean!
 
+  """
+  ephemeral indicates the Attribute should not be persisted. Ephemeral
+  Attributes are not stored in the database and are only synced to the
+  connected clients. An ephemeral Attribute cannot become non-ephemeral and vice
+  versa.
+  """
+  ephemeral: Boolean!
+
   """
   deletedAt is the time when the Attribute was deleted. If null, the Attribute
   was not deleted.
@@ -123,6 +131,15 @@ input SetAttributeInput {
   """
   immutable: Boolean
 
+  """
+  ephemeral indicates the Attribute should not be persisted. Ephemeral
+  Attributes are not stored in the database and are only synced to the
+  connected clients.
+  Defaults to false and does need to be sent on subsequent updates. An ephemeral
+  Attribute cannot become non-ephemeral and vice versa.
+  """
+  ephemeral: Boolean
+
   """
   ID of object on which to update the value. NodeID is required if attribute is
   not created with addScope().

internal/models/attribute.go

@@ -40,6 +40,10 @@ type Attribute struct {
 	Versions []*Attribute `json:"-"`
 	// version is the version number of this Attribute, starting at 1.
 	Version int `json:"-"`
+	// ephemeral indicates the Attribute should not be persisted. Ephemeral
+	// Attributes are not stored in the database and are only synced to the
+	// connected clients.
+	Ephemeral bool `json:"-"`
 	// private indicates whether the Attribute shouldn't be visible to Participants
 	// in the scope.
 	// private must be set on the Attribute at creation.

internal/runtime/attribute.go

@@ -73,7 +73,7 @@ func (r *Runtime) prepAttributes(
 
 		index := input.Index
 
-		var vector, private, protected, immutable bool
+		var vector, private, protected, immutable, ephemeral bool
 
 		if input.Append != nil && *input.Append {
 			vector = true
@@ -129,6 +129,10 @@ func (r *Runtime) prepAttributes(
 			immutable = true
 		}
 
+		if input.Ephemeral != nil && *input.Ephemeral {
+			ephemeral = true
+		}
+
 		a := &models.Attribute{
 			ID:          ids.ID(ctx),
 			CreatedAt:   now,
@@ -144,6 +148,7 @@ func (r *Runtime) prepAttributes(
 			Private:     private,
 			Protected:   protected,
 			Immutable:   immutable,
+			Ephemeral:   ephemeral,
 		}
 
 		last := scope.AttributesMap[a.LookupKey()]
@@ -158,6 +163,14 @@ func (r *Runtime) prepAttributes(
 				return nil, ErrImmutable
 			}
 
+			if last.Ephemeral && !a.Ephemeral {
+				return nil, ErrEphemeral
+			}
+
+			if !last.Ephemeral && a.Ephemeral {
+				return nil, ErrNotEphemeral
+			}
+
 			if (a.Vector && !last.Vector) || !a.Vector && last.Vector {
 				return nil, errors.New("cannot mutate vector")
 			}
@@ -194,12 +207,15 @@ func (r *Runtime) setAttributes(
 	attrs []*models.Attribute,
 ) (attributes []*models.Attribute, err error) {
 	conn := store.ForContext(ctx)
+
 	for _, attr := range attrs {
-		err = conn.Save(attr)
-		if err != nil {
-			log.Ctx(r.ctx).Error().Err(err).Msg("runtime: failed to save attribute")
+		if !attr.Ephemeral {
+			err = conn.Save(attr)
+			if err != nil {
+				log.Ctx(r.ctx).Error().Err(err).Msg("runtime: failed to save attribute")
 
-			continue
+				continue
+			}
 		}
 
 		scope, _ := attr.Node.(*models.Scope)

internal/runtime/errors.go

@@ -8,6 +8,8 @@ var (
 	ErrCursorNotFound       = errors.New("cursor not found")
 	ErrLengthInvalid        = errors.New("invalid pagination length")
 	ErrImmutable            = errors.New("record is immutable")
+	ErrEphemeral            = errors.New("record is ephemeral")
+	ErrNotEphemeral         = errors.New("record is not ephemeral")
 	ErrInvalidNode          = errors.New("invalid node")
 	ErrNotAuthorized        = errors.New("not authorized")
 	ErrAuthenticationFailed = errors.New("authentication failed")

lib/tajriba/modd.conf

@@ -2,15 +2,15 @@ src/documents/**/*.graphql codegen.yml {
   prep: npm run generate
 }
 
-src/**/*.ts {
+src/**/*.ts !src/generated/**/*.ts {
   prep: npm run build
 }
 
-src/**/*.ts {
+src/**/*.ts !src/generated/**/*.ts {
   prep: npm run check
 }
 
-# Requires Tajriba to be running on the default port.
-dist/module.js src/test.mjs {
-  prep: npm run test
-}
+# # Requires Tajriba to be running on the default port.
+# dist/module.js src/test.mjs {
+#   prep: npm run test
+# }

lib/tajriba/package.json

@@ -40,11 +40,11 @@
     "access": "public"
   },
   "volta": {
-    "node": "20.10.0",
-    "npm": "10.2.3"
+    "node": "20.12.0",
+    "npm": "10.5.0"
   },
   "engines": {
-    "node": ">= 20.10.0"
+    "node": ">= 20.12.0"
   },
   "scripts": {
     "generate": "graphql-codegen",

lib/tajriba/src/documents/attributes.graphql

@@ -8,6 +8,7 @@ fragment attributeFields on Attribute {
   private
   protected
   immutable
+  ephemeral
   deletedAt
   key
   val