feat: reserve tag [0xF000, 0xFFFF]

ai/function_call.go

@@ -8,7 +8,7 @@ import (
 )
 
 // ReducerTag is the observed tag of the reducer
-var ReducerTag uint32 = 0x61
+var ReducerTag uint32 = 0xE000
 
 // FunctionCall describes the data structure when invoking the sfn function
 type FunctionCall struct {

core/client.go

@@ -426,8 +426,18 @@ func (c *Client) SetDataFrameObserver(fn func(*frame.DataFrame)) {
 }
 
 // SetObserveDataTags set the data tag list that will be observed.
-func (c *Client) SetObserveDataTags(tag ...frame.Tag) {
-	c.opts.observeDataTags = tag
+func (c *Client) SetObserveDataTags(tags ...frame.Tag) {
+	for _, tag := range tags {
+		if isReservedTag(tag) {
+			panic("[0xF000, 0xFFFF] is reserved for Yomo; please do not observe within this range")
+		}
+	}
+
+	c.opts.observeDataTags = tags
+}
+
+func isReservedTag(tag frame.Tag) bool {
+	return tag >= 0xF000 && tag <= 0xFFFF
 }
 
 // SetErrorHandler set error handler

core/client_test.go

@@ -21,6 +21,7 @@ import (
 const (
 	testaddr     = "127.0.0.1:19999"
 	redirectAddr = "127.0.0.1:19998"
+	testaddr1    = "127.0.0.1:19997"
 )
 
 var discardingLogger = ylog.NewFromConfig(ylog.Config{Output: "/dev/null", ErrorOutput: "/dev/null"})
@@ -38,6 +39,15 @@ func TestClientDialNothing(t *testing.T) {
 	assert.ErrorAs(t, err, &qerr, "dial must timeout")
 }
 
+func TestReservedTag(t *testing.T) {
+	sfn := NewClient("sfn", testaddr1, ClientTypeStreamFunction, WithLogger(discardingLogger))
+
+	assert.Panics(t, func() { sfn.SetObserveDataTags(0xF000) })
+	assert.Panics(t, func() { sfn.SetObserveDataTags(0xF001) })
+	assert.Panics(t, func() { sfn.SetObserveDataTags(0xFFFF) })
+
+}
+
 func TestConnectTo(t *testing.T) {
 	t.Parallel()
 	connectToEndpoint := "127.0.0.1:19996"