-
Notifications
You must be signed in to change notification settings - Fork 179
/
types.go
332 lines (302 loc) · 9.34 KB
/
types.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
// Licensed to the Apache Software Foundation (ASF) under one or more
// contributor license agreements. See the NOTICE file distributed with
// this work for additional information regarding copyright ownership.
// The ASF licenses this file to You under the Apache License, Version 2.0
// (the "License"); you may not use this file except in compliance with
// the License. You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package statefun
import (
"encoding/json"
"errors"
"github.com/apache/flink-statefun/statefun-sdk-go/v3/pkg/statefun/internal/protocol"
"google.golang.org/protobuf/proto"
"io"
"log"
)
// SimpleType interface is the core abstraction used by Stateful
// Function's type system, and consists of a few things
// that StateFun uses to handle Message's and ValueSpec's
//
// 1. TypeName to identify the type.
// 2. (De)serialization methods for marshalling and unmarshalling data
//
// Cross-language primitive types
//
// StateFun's type system has cross-language support for common primitive
// types, such as boolean, integer (int32), long (int64), etc. These
// primitive types have built-in SimpleType's implemented for them already
// with predefined TypeName's.
//
// These primitives have standard encoding across all StateFun language
// SDKs, so functions in various other languages (Java, Python, etc) can
// message Golang functions by directly sending supported primitive
// values as message arguments. Moreover, the type system is used for
// state values as well; so you can expect that a function can safely
// read previous state after reimplementing it in a different language.
//
// Common custom types
//
// The type system is also very easily extensible to support more complex types.
// The Go SDK ships with predefined support for JSON and Protobuf - see MakeJsonType
// MakeProtobufType. For other formats, it is just a matter of implementing
// your own SimpleType with a custom typename and serializer.
type SimpleType interface {
GetTypeName() TypeName
Deserialize(r io.Reader, receiver interface{}) error
Serialize(writer io.Writer, data interface{}) error
}
type PrimitiveType int
const (
BoolType PrimitiveType = iota
Int32Type
Int64Type
Float32Type
Float64Type
StringType
)
var (
boolWrapperType = MakeProtobufTypeWithTypeName(boolTypeName)
int32WrapperType = MakeProtobufTypeWithTypeName(int32TypeName)
int64WrapperType = MakeProtobufTypeWithTypeName(int64TypeName)
float32WrapperType = MakeProtobufTypeWithTypeName(float64TypeName)
float64WrapperType = MakeProtobufTypeWithTypeName(float64TypeName)
stringWrapperType = MakeProtobufTypeWithTypeName(stringTypeName)
)
func (p PrimitiveType) GetTypeName() TypeName {
switch p {
case BoolType:
return boolTypeName
case Int32Type:
return int32TypeName
case Int64Type:
return int64TypeName
case Float32Type:
return float32TypeName
case Float64Type:
return float64TypeName
case StringType:
return stringTypeName
default:
log.Fatalf("unknown primitive type %v", p)
// unreachable
return nil
}
}
func (p PrimitiveType) Deserialize(r io.Reader, receiver interface{}) error {
switch p {
case BoolType:
switch data := receiver.(type) {
case *bool:
var wrapper protocol.BooleanWrapper
if err := boolWrapperType.Deserialize(r, &wrapper); err != nil {
return err
}
*data = wrapper.Value
default:
return errors.New("receiver must be of type bool or *bool")
}
case Int32Type:
switch data := receiver.(type) {
case *int32:
var wrapper protocol.IntWrapper
if err := int32WrapperType.Deserialize(r, &wrapper); err != nil {
return err
}
*data = wrapper.Value
default:
return errors.New("receiver must be of type *int32")
}
case Int64Type:
switch data := receiver.(type) {
case *int64:
var wrapper protocol.LongWrapper
if err := int64WrapperType.Deserialize(r, &wrapper); err != nil {
return err
}
*data = wrapper.Value
default:
return errors.New("receiver must be of type *int64")
}
case Float32Type:
switch data := receiver.(type) {
case *float32:
var wrapper protocol.FloatWrapper
if err := float32WrapperType.Deserialize(r, &wrapper); err != nil {
return err
}
*data = wrapper.Value
default:
return errors.New("receiver must be of type *float32")
}
case Float64Type:
switch data := receiver.(type) {
case *float64:
var wrapper protocol.DoubleWrapper
if err := float64WrapperType.Deserialize(r, &wrapper); err != nil {
return err
}
*data = wrapper.Value
default:
return errors.New("receiver must be of type *float64")
}
case StringType:
switch data := receiver.(type) {
case *string:
var wrapper protocol.StringWrapper
if err := stringWrapperType.Deserialize(r, &wrapper); err != nil {
return err
}
*data = wrapper.Value
default:
return errors.New("receiver must be of type *string")
}
default:
log.Fatalf("unknown primitive type %v", p)
// unreachable
return nil
}
return nil
}
func (p PrimitiveType) Serialize(writer io.Writer, data interface{}) error {
switch p {
case BoolType:
switch data := data.(type) {
case bool:
wrapper := protocol.BooleanWrapper{Value: data}
return boolWrapperType.Serialize(writer, &wrapper)
case *bool:
wrapper := protocol.BooleanWrapper{Value: *data}
return boolWrapperType.Serialize(writer, &wrapper)
default:
return errors.New("data must be of type bool or *bool")
}
case Int32Type:
switch data := data.(type) {
case int32:
wrapper := protocol.IntWrapper{Value: data}
return int32WrapperType.Serialize(writer, &wrapper)
case *int32:
wrapper := protocol.IntWrapper{Value: *data}
return int32WrapperType.Serialize(writer, &wrapper)
default:
return errors.New("data must be of type int32 or *int32")
}
case Int64Type:
switch data := data.(type) {
case int64:
wrapper := protocol.LongWrapper{Value: data}
return int64WrapperType.Serialize(writer, &wrapper)
case *int64:
wrapper := protocol.LongWrapper{Value: *data}
return int64WrapperType.Serialize(writer, &wrapper)
default:
return errors.New("data must be of type int64 or *int64")
}
case Float32Type:
switch data := data.(type) {
case float32:
wrapper := protocol.FloatWrapper{Value: data}
return float32WrapperType.Serialize(writer, &wrapper)
case *float32:
wrapper := protocol.FloatWrapper{Value: *data}
return float32WrapperType.Serialize(writer, &wrapper)
default:
return errors.New("data must be of type float32 or *float32")
}
case Float64Type:
switch data := data.(type) {
case float64:
wrapper := protocol.DoubleWrapper{Value: data}
return float64WrapperType.Serialize(writer, &wrapper)
case *float64:
wrapper := protocol.DoubleWrapper{Value: *data}
return float64WrapperType.Serialize(writer, &wrapper)
default:
return errors.New("data must be of type float64 or *float64")
}
case StringType:
switch data := data.(type) {
case string:
wrapper := protocol.StringWrapper{Value: data}
return stringWrapperType.Serialize(writer, &wrapper)
case *string:
wrapper := protocol.StringWrapper{Value: *data}
return stringWrapperType.Serialize(writer, &wrapper)
default:
return errors.New("data must be of type string or *string")
}
default:
log.Fatalf("unknown primitive type %v", p)
// unreachable
return nil
}
}
type jsonType struct {
typeName TypeName
}
// MakeJsonType creates a new SimpleType with a given TypeName
// using the standard Go JSON library.
func MakeJsonType(name TypeName) SimpleType {
return jsonType{typeName: name}
}
func (j jsonType) GetTypeName() TypeName {
return j.typeName
}
func (j jsonType) Deserialize(r io.Reader, receiver interface{}) error {
return json.NewDecoder(r).Decode(receiver)
}
func (j jsonType) Serialize(writer io.Writer, data interface{}) error {
return json.NewEncoder(writer).Encode(data)
}
type protoType struct {
typeName TypeName
}
// MakeProtobufType creates a new SimpleType for the given protobuf Message.
func MakeProtobufType(m proto.Message) SimpleType {
name := proto.MessageName(m)
tName, _ := TypeNameFromParts("type.googleapis.com", string(name))
return MakeProtobufTypeWithTypeName(tName)
}
// MakeProtobufTypeWithTypeName creates a new SimpleType for the
// given protobuf Message with a custom namespace.
func MakeProtobufTypeWithTypeName(typeName TypeName) SimpleType {
return protoType{
typeName: typeName,
}
}
func (p protoType) GetTypeName() TypeName {
return p.typeName
}
func (p protoType) Deserialize(r io.Reader, receiver interface{}) (err error) {
switch receiver := receiver.(type) {
case proto.Message:
data, err := io.ReadAll(r)
if err != nil {
return err
}
return proto.Unmarshal(data, receiver)
default:
return errors.New("receiver must implement proto.Message")
}
}
func (p protoType) Serialize(writer io.Writer, data interface{}) error {
switch data := data.(type) {
case proto.Message:
if value, err := proto.Marshal(data); err != nil {
return err
} else {
_, err = writer.Write(value)
return err
}
default:
return errors.New("data must implement proto.Message")
}
}