aboutsummaryrefslogtreecommitdiff
path: root/weed/mq/kafka/schema/decode_encode_test.go
blob: bb6b88625e0519b77194a65efbd6057de35dae4a (plain)
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
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
package schema

import (
	"bytes"
	"encoding/binary"
	"encoding/json"
	"fmt"
	"net/http"
	"net/http/httptest"
	"testing"

	"github.com/linkedin/goavro/v2"
	"github.com/seaweedfs/seaweedfs/weed/pb/schema_pb"
	"github.com/stretchr/testify/assert"
	"github.com/stretchr/testify/require"
)

// TestSchemaDecodeEncode_Avro tests comprehensive Avro decode/encode workflow
func TestSchemaDecodeEncode_Avro(t *testing.T) {
	// Create mock schema registry
	registry := createMockSchemaRegistryForDecodeTest(t)
	defer registry.Close()

	manager, err := NewManager(ManagerConfig{
		RegistryURL: registry.URL,
	})
	require.NoError(t, err)

	// Test data
	testCases := []struct {
		name       string
		schemaID   int32
		schemaJSON string
		testData   map[string]interface{}
	}{
		{
			name:     "Simple User Record",
			schemaID: 1,
			schemaJSON: `{
				"type": "record",
				"name": "User",
				"fields": [
					{"name": "id", "type": "int"},
					{"name": "name", "type": "string"},
					{"name": "email", "type": ["null", "string"], "default": null}
				]
			}`,
			testData: map[string]interface{}{
				"id":    int32(123),
				"name":  "John Doe",
				"email": map[string]interface{}{"string": "john@example.com"},
			},
		},
		{
			name:     "Complex Record with Arrays",
			schemaID: 2,
			schemaJSON: `{
				"type": "record",
				"name": "Order",
				"fields": [
					{"name": "order_id", "type": "string"},
					{"name": "items", "type": {"type": "array", "items": "string"}},
					{"name": "total", "type": "double"},
					{"name": "metadata", "type": {"type": "map", "values": "string"}}
				]
			}`,
			testData: map[string]interface{}{
				"order_id": "ORD-001",
				"items":    []interface{}{"item1", "item2", "item3"},
				"total":    99.99,
				"metadata": map[string]interface{}{
					"source":   "web",
					"campaign": "summer2024",
				},
			},
		},
		{
			name:     "Union Types",
			schemaID: 3,
			schemaJSON: `{
				"type": "record",
				"name": "Event",
				"fields": [
					{"name": "event_id", "type": "string"},
					{"name": "payload", "type": ["null", "string", "int"]},
					{"name": "timestamp", "type": "long"}
				]
			}`,
			testData: map[string]interface{}{
				"event_id":  "evt-123",
				"payload":   map[string]interface{}{"int": int32(42)},
				"timestamp": int64(1640995200000),
			},
		},
	}

	for _, tc := range testCases {
		t.Run(tc.name, func(t *testing.T) {
			// Register schema in mock registry
			registerSchemaInMock(t, registry, tc.schemaID, tc.schemaJSON)

			// Create Avro codec
			codec, err := goavro.NewCodec(tc.schemaJSON)
			require.NoError(t, err)

			// Encode test data to Avro binary
			avroBinary, err := codec.BinaryFromNative(nil, tc.testData)
			require.NoError(t, err)

			// Create Confluent envelope
			envelope := createConfluentEnvelope(tc.schemaID, avroBinary)

			// Test decode
			decoded, err := manager.DecodeMessage(envelope)
			require.NoError(t, err)
			assert.Equal(t, uint32(tc.schemaID), decoded.SchemaID)
			assert.Equal(t, FormatAvro, decoded.SchemaFormat)
			assert.NotNil(t, decoded.RecordValue)

			// Verify decoded fields match original data
			verifyDecodedFields(t, tc.testData, decoded.RecordValue.Fields)

			// Test re-encoding (round-trip)
			reconstructed, err := manager.EncodeMessage(decoded.RecordValue, decoded.SchemaID, decoded.SchemaFormat)
			require.NoError(t, err)

			// Verify reconstructed envelope
			assert.Equal(t, envelope[:5], reconstructed[:5]) // Magic byte + schema ID

			// Decode reconstructed data to verify round-trip integrity
			decodedAgain, err := manager.DecodeMessage(reconstructed)
			require.NoError(t, err)
			assert.Equal(t, decoded.SchemaID, decodedAgain.SchemaID)
			assert.Equal(t, decoded.SchemaFormat, decodedAgain.SchemaFormat)

			// // Verify fields are identical after round-trip
			// verifyRecordValuesEqual(t, decoded.RecordValue, decodedAgain.RecordValue)
		})
	}
}

// TestSchemaDecodeEncode_JSONSchema tests JSON Schema decode/encode workflow
func TestSchemaDecodeEncode_JSONSchema(t *testing.T) {
	registry := createMockSchemaRegistryForDecodeTest(t)
	defer registry.Close()

	manager, err := NewManager(ManagerConfig{
		RegistryURL: registry.URL,
	})
	require.NoError(t, err)

	testCases := []struct {
		name       string
		schemaID   int32
		schemaJSON string
		testData   map[string]interface{}
	}{
		{
			name:     "Product Schema",
			schemaID: 10,
			schemaJSON: `{
				"type": "object",
				"properties": {
					"product_id": {"type": "string"},
					"name": {"type": "string"},
					"price": {"type": "number"},
					"in_stock": {"type": "boolean"},
					"tags": {
						"type": "array",
						"items": {"type": "string"}
					}
				},
				"required": ["product_id", "name", "price"]
			}`,
			testData: map[string]interface{}{
				"product_id": "PROD-123",
				"name":       "Awesome Widget",
				"price":      29.99,
				"in_stock":   true,
				"tags":       []interface{}{"electronics", "gadget"},
			},
		},
		{
			name:     "Nested Object Schema",
			schemaID: 11,
			schemaJSON: `{
				"type": "object",
				"properties": {
					"customer": {
						"type": "object",
						"properties": {
							"id": {"type": "integer"},
							"name": {"type": "string"},
							"address": {
								"type": "object",
								"properties": {
									"street": {"type": "string"},
									"city": {"type": "string"},
									"zip": {"type": "string"}
								}
							}
						}
					},
					"order_date": {"type": "string", "format": "date"}
				}
			}`,
			testData: map[string]interface{}{
				"customer": map[string]interface{}{
					"id":   float64(456), // JSON numbers are float64
					"name": "Jane Smith",
					"address": map[string]interface{}{
						"street": "123 Main St",
						"city":   "Anytown",
						"zip":    "12345",
					},
				},
				"order_date": "2024-01-15",
			},
		},
	}

	for _, tc := range testCases {
		t.Run(tc.name, func(t *testing.T) {
			// Register schema in mock registry
			registerSchemaInMock(t, registry, tc.schemaID, tc.schemaJSON)

			// Encode test data to JSON
			jsonBytes, err := json.Marshal(tc.testData)
			require.NoError(t, err)

			// Create Confluent envelope
			envelope := createConfluentEnvelope(tc.schemaID, jsonBytes)

			// Test decode
			decoded, err := manager.DecodeMessage(envelope)
			require.NoError(t, err)
			assert.Equal(t, uint32(tc.schemaID), decoded.SchemaID)
			assert.Equal(t, FormatJSONSchema, decoded.SchemaFormat)
			assert.NotNil(t, decoded.RecordValue)

			// Test encode back to Confluent envelope
			reconstructed, err := manager.EncodeMessage(decoded.RecordValue, decoded.SchemaID, decoded.SchemaFormat)
			require.NoError(t, err)

			// Verify reconstructed envelope has correct header
			assert.Equal(t, envelope[:5], reconstructed[:5]) // Magic byte + schema ID

			// Decode reconstructed data to verify round-trip integrity
			decodedAgain, err := manager.DecodeMessage(reconstructed)
			require.NoError(t, err)
			assert.Equal(t, decoded.SchemaID, decodedAgain.SchemaID)
			assert.Equal(t, decoded.SchemaFormat, decodedAgain.SchemaFormat)

			// Verify fields are identical after round-trip
			verifyRecordValuesEqual(t, decoded.RecordValue, decodedAgain.RecordValue)
		})
	}
}

// TestSchemaDecodeEncode_Protobuf tests Protobuf decode/encode workflow
func TestSchemaDecodeEncode_Protobuf(t *testing.T) {
	registry := createMockSchemaRegistryForDecodeTest(t)
	defer registry.Close()

	manager, err := NewManager(ManagerConfig{
		RegistryURL: registry.URL,
	})
	require.NoError(t, err)

	// Test that Protobuf text schema parsing and decoding works
	schemaID := int32(20)
	protoSchema := `syntax = "proto3"; message TestMessage { string name = 1; int32 id = 2; }`

	// Register schema in mock registry
	registerSchemaInMock(t, registry, schemaID, protoSchema)

	// Create a Protobuf message: name="test", id=123
	protobufData := []byte{0x0a, 0x04, 0x74, 0x65, 0x73, 0x74, 0x10, 0x7b}
	envelope := createConfluentEnvelope(schemaID, protobufData)

	// Test decode - should work with text .proto schema parsing
	decoded, err := manager.DecodeMessage(envelope)

	// Should successfully decode now that text .proto parsing is implemented
	require.NoError(t, err)
	assert.NotNil(t, decoded)
	assert.Equal(t, uint32(schemaID), decoded.SchemaID)
	assert.Equal(t, FormatProtobuf, decoded.SchemaFormat)
	assert.NotNil(t, decoded.RecordValue)

	// Verify the decoded fields
	assert.Contains(t, decoded.RecordValue.Fields, "name")
	assert.Contains(t, decoded.RecordValue.Fields, "id")
}

// TestSchemaDecodeEncode_ErrorHandling tests various error conditions
func TestSchemaDecodeEncode_ErrorHandling(t *testing.T) {
	registry := createMockSchemaRegistryForDecodeTest(t)
	defer registry.Close()

	manager, err := NewManager(ManagerConfig{
		RegistryURL: registry.URL,
	})
	require.NoError(t, err)

	t.Run("Invalid Confluent Envelope", func(t *testing.T) {
		// Too short envelope
		_, err := manager.DecodeMessage([]byte{0x00, 0x00})
		assert.Error(t, err)
		assert.Contains(t, err.Error(), "message is not schematized")

		// Wrong magic byte
		wrongMagic := []byte{0x01, 0x00, 0x00, 0x00, 0x01, 0x41, 0x42}
		_, err = manager.DecodeMessage(wrongMagic)
		assert.Error(t, err)
		assert.Contains(t, err.Error(), "message is not schematized")
	})

	t.Run("Schema Not Found", func(t *testing.T) {
		// Create envelope with non-existent schema ID
		envelope := createConfluentEnvelope(999, []byte("test"))
		_, err := manager.DecodeMessage(envelope)
		assert.Error(t, err)
		assert.Contains(t, err.Error(), "failed to get schema 999")
	})

	t.Run("Invalid Avro Data", func(t *testing.T) {
		schemaID := int32(100)
		schemaJSON := `{"type": "record", "name": "Test", "fields": [{"name": "id", "type": "int"}]}`
		registerSchemaInMock(t, registry, schemaID, schemaJSON)

		// Create envelope with invalid Avro data that will fail decoding
		invalidAvroData := []byte{0xFF, 0xFF, 0xFF, 0xFF} // Invalid Avro binary data
		envelope := createConfluentEnvelope(schemaID, invalidAvroData)
		_, err := manager.DecodeMessage(envelope)
		assert.Error(t, err)
		assert.Contains(t, err.Error(), "failed to decode Avro")
	})

	t.Run("Invalid JSON Data", func(t *testing.T) {
		schemaID := int32(101)
		schemaJSON := `{"type": "object", "properties": {"name": {"type": "string"}}}`
		registerSchemaInMock(t, registry, schemaID, schemaJSON)

		// Create envelope with invalid JSON data
		envelope := createConfluentEnvelope(schemaID, []byte("{invalid json"))
		_, err := manager.DecodeMessage(envelope)
		assert.Error(t, err)
		assert.Contains(t, err.Error(), "failed to decode")
	})
}

// TestSchemaDecodeEncode_CachePerformance tests caching behavior
func TestSchemaDecodeEncode_CachePerformance(t *testing.T) {
	registry := createMockSchemaRegistryForDecodeTest(t)
	defer registry.Close()

	manager, err := NewManager(ManagerConfig{
		RegistryURL: registry.URL,
	})
	require.NoError(t, err)

	schemaID := int32(200)
	schemaJSON := `{"type": "record", "name": "CacheTest", "fields": [{"name": "value", "type": "string"}]}`
	registerSchemaInMock(t, registry, schemaID, schemaJSON)

	// Create test data
	testData := map[string]interface{}{"value": "test"}
	codec, err := goavro.NewCodec(schemaJSON)
	require.NoError(t, err)
	avroBinary, err := codec.BinaryFromNative(nil, testData)
	require.NoError(t, err)
	envelope := createConfluentEnvelope(schemaID, avroBinary)

	// First decode - should populate cache
	decoded1, err := manager.DecodeMessage(envelope)
	require.NoError(t, err)

	// Second decode - should use cache
	decoded2, err := manager.DecodeMessage(envelope)
	require.NoError(t, err)

	// Verify both results are identical
	assert.Equal(t, decoded1.SchemaID, decoded2.SchemaID)
	assert.Equal(t, decoded1.SchemaFormat, decoded2.SchemaFormat)
	verifyRecordValuesEqual(t, decoded1.RecordValue, decoded2.RecordValue)

	// Check cache stats
	decoders, schemas, subjects := manager.GetCacheStats()
	assert.True(t, decoders > 0)
	assert.True(t, schemas > 0)
	assert.True(t, subjects >= 0)
}

// Helper functions

func createMockSchemaRegistryForDecodeTest(t *testing.T) *httptest.Server {
	schemas := make(map[int32]string)

	return httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
		switch r.URL.Path {
		case "/subjects":
			w.WriteHeader(http.StatusOK)
			w.Write([]byte("[]"))
		default:
			// Handle schema requests like /schemas/ids/1
			var schemaID int32
			if n, err := fmt.Sscanf(r.URL.Path, "/schemas/ids/%d", &schemaID); n == 1 && err == nil {
				if schema, exists := schemas[schemaID]; exists {
					response := fmt.Sprintf(`{"schema": %q}`, schema)
					w.Header().Set("Content-Type", "application/json")
					w.WriteHeader(http.StatusOK)
					w.Write([]byte(response))
				} else {
					w.WriteHeader(http.StatusNotFound)
					w.Write([]byte(`{"error_code": 40403, "message": "Schema not found"}`))
				}
			} else if r.Method == "POST" && r.URL.Path == "/register-schema" {
				// Custom endpoint for test registration
				var req struct {
					SchemaID int32  `json:"schema_id"`
					Schema   string `json:"schema"`
				}
				if err := json.NewDecoder(r.Body).Decode(&req); err == nil {
					schemas[req.SchemaID] = req.Schema
					w.WriteHeader(http.StatusOK)
					w.Write([]byte(`{"success": true}`))
				} else {
					w.WriteHeader(http.StatusBadRequest)
				}
			} else {
				w.WriteHeader(http.StatusNotFound)
			}
		}
	}))
}

func registerSchemaInMock(t *testing.T, registry *httptest.Server, schemaID int32, schema string) {
	reqBody := fmt.Sprintf(`{"schema_id": %d, "schema": %q}`, schemaID, schema)
	resp, err := http.Post(registry.URL+"/register-schema", "application/json", bytes.NewReader([]byte(reqBody)))
	require.NoError(t, err)
	defer resp.Body.Close()
	require.Equal(t, http.StatusOK, resp.StatusCode)
}

func createConfluentEnvelope(schemaID int32, data []byte) []byte {
	envelope := make([]byte, 5+len(data))
	envelope[0] = 0x00 // Magic byte
	binary.BigEndian.PutUint32(envelope[1:5], uint32(schemaID))
	copy(envelope[5:], data)
	return envelope
}

func verifyDecodedFields(t *testing.T, expected map[string]interface{}, actual map[string]*schema_pb.Value) {
	for key, expectedValue := range expected {
		actualValue, exists := actual[key]
		require.True(t, exists, "Field %s should exist", key)

		switch v := expectedValue.(type) {
		case int32:
			// Check both Int32Value and Int64Value since Avro integers can be stored as either
			if actualValue.GetInt32Value() != 0 {
				assert.Equal(t, v, actualValue.GetInt32Value(), "Field %s should match", key)
			} else {
				assert.Equal(t, int64(v), actualValue.GetInt64Value(), "Field %s should match", key)
			}
		case string:
			assert.Equal(t, v, actualValue.GetStringValue(), "Field %s should match", key)
		case float64:
			assert.Equal(t, v, actualValue.GetDoubleValue(), "Field %s should match", key)
		case bool:
			assert.Equal(t, v, actualValue.GetBoolValue(), "Field %s should match", key)
		case []interface{}:
			listValue := actualValue.GetListValue()
			require.NotNil(t, listValue, "Field %s should be a list", key)
			assert.Equal(t, len(v), len(listValue.Values), "List %s should have correct length", key)
		case map[string]interface{}:
			// Check if this is an Avro union type (single key-value pair with type name)
			if len(v) == 1 {
				for unionType, unionValue := range v {
					// Handle Avro union types - they are now stored as records
					switch unionType {
					case "int":
						if intVal, ok := unionValue.(int32); ok {
							// Union values are now stored as records with the union type as field name
							recordValue := actualValue.GetRecordValue()
							require.NotNil(t, recordValue, "Field %s should be a union record", key)
							unionField := recordValue.Fields[unionType]
							require.NotNil(t, unionField, "Union field %s should exist", unionType)
							assert.Equal(t, intVal, unionField.GetInt32Value(), "Field %s should match", key)
						}
					case "string":
						if strVal, ok := unionValue.(string); ok {
							recordValue := actualValue.GetRecordValue()
							require.NotNil(t, recordValue, "Field %s should be a union record", key)
							unionField := recordValue.Fields[unionType]
							require.NotNil(t, unionField, "Union field %s should exist", unionType)
							assert.Equal(t, strVal, unionField.GetStringValue(), "Field %s should match", key)
						}
					case "long":
						if longVal, ok := unionValue.(int64); ok {
							recordValue := actualValue.GetRecordValue()
							require.NotNil(t, recordValue, "Field %s should be a union record", key)
							unionField := recordValue.Fields[unionType]
							require.NotNil(t, unionField, "Union field %s should exist", unionType)
							assert.Equal(t, longVal, unionField.GetInt64Value(), "Field %s should match", key)
						}
					default:
						// If not a recognized union type, treat as regular nested record
						recordValue := actualValue.GetRecordValue()
						require.NotNil(t, recordValue, "Field %s should be a record", key)
						verifyDecodedFields(t, v, recordValue.Fields)
					}
					break // Only one iteration for single-key map
				}
			} else {
				// Handle regular maps/objects
				recordValue := actualValue.GetRecordValue()
				require.NotNil(t, recordValue, "Field %s should be a record", key)
				verifyDecodedFields(t, v, recordValue.Fields)
			}
		}
	}
}

func verifyRecordValuesEqual(t *testing.T, expected, actual *schema_pb.RecordValue) {
	require.Equal(t, len(expected.Fields), len(actual.Fields), "Record should have same number of fields")

	for key, expectedValue := range expected.Fields {
		actualValue, exists := actual.Fields[key]
		require.True(t, exists, "Field %s should exist", key)

		// Compare values based on type
		switch expectedValue.Kind.(type) {
		case *schema_pb.Value_StringValue:
			assert.Equal(t, expectedValue.GetStringValue(), actualValue.GetStringValue())
		case *schema_pb.Value_Int64Value:
			assert.Equal(t, expectedValue.GetInt64Value(), actualValue.GetInt64Value())
		case *schema_pb.Value_DoubleValue:
			assert.Equal(t, expectedValue.GetDoubleValue(), actualValue.GetDoubleValue())
		case *schema_pb.Value_BoolValue:
			assert.Equal(t, expectedValue.GetBoolValue(), actualValue.GetBoolValue())
		case *schema_pb.Value_ListValue:
			expectedList := expectedValue.GetListValue()
			actualList := actualValue.GetListValue()
			require.Equal(t, len(expectedList.Values), len(actualList.Values))
			for i, expectedItem := range expectedList.Values {
				verifyValuesEqual(t, expectedItem, actualList.Values[i])
			}
		case *schema_pb.Value_RecordValue:
			verifyRecordValuesEqual(t, expectedValue.GetRecordValue(), actualValue.GetRecordValue())
		}
	}
}

func verifyValuesEqual(t *testing.T, expected, actual *schema_pb.Value) {
	switch expected.Kind.(type) {
	case *schema_pb.Value_StringValue:
		assert.Equal(t, expected.GetStringValue(), actual.GetStringValue())
	case *schema_pb.Value_Int64Value:
		assert.Equal(t, expected.GetInt64Value(), actual.GetInt64Value())
	case *schema_pb.Value_DoubleValue:
		assert.Equal(t, expected.GetDoubleValue(), actual.GetDoubleValue())
	case *schema_pb.Value_BoolValue:
		assert.Equal(t, expected.GetBoolValue(), actual.GetBoolValue())
	default:
		t.Errorf("Unsupported value type for comparison")
	}
}