Class: Twilic::Core::Protocol::TwilicCodec

Inherits:
Object
  • Object
show all
Defined in:
lib/twilic/core/protocol.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = nil) ⇒ TwilicCodec

Returns a new instance of TwilicCodec.



37
38
39
40
41
42
 
# File 'lib/twilic/core/protocol.rb', line 37

def initialize(options = nil)
  @state = options ? Session::MutableSessionState.new(options) : Session::MutableSessionState.new
  @state.key_table = Session::MutableInternTable.new
  @state.string_table = Session::MutableInternTable.new
  @state.shape_table = Session::MutableShapeTable.new
end

Instance Attribute Details

#state ⇒ Object

Returns the value of attribute state.



35
36
37
 
# File 'lib/twilic/core/protocol.rb', line 35

def state
  @state
end

Class Method Details

.new_twilic_codec ⇒ Object 



44
45
46
 
# File 'lib/twilic/core/protocol.rb', line 44

def self.new_twilic_codec
  new
end

.twilic_codec_with_options(options) ⇒ Object 



48
49
50
 
# File 'lib/twilic/core/protocol.rb', line 48

def self.twilic_codec_with_options(options)
  new(options)
end

Instance Method Details

#apply_state_patch(base_ref, operations, literals) ⇒ Object 



1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
 
# File 'lib/twilic/core/protocol.rb', line 1484

def apply_state_patch(base_ref, operations, literals)
  base = if base_ref.previous
           raise reference_error("previous", 0) unless state.previous_message

           state.previous_message.clone_message
         else
           b, ok = state.get_base_snapshot(base_ref.base_id)
           raise reference_error("base_id", base_ref.base_id) unless ok

           b
         end
  _ = literals
  fields = message_fields(base)
  operations.each do |op|
    idx = op.field_id
    case op.opcode
    when Model::PatchOpcode::KEEP
      # no-op
    when Model::PatchOpcode::REPLACE_SCALAR,
         Model::PatchOpcode::REPLACE_VECTOR,
         Model::PatchOpcode::INSERT_FIELD,
         Model::PatchOpcode::STRING_REF,
         Model::PatchOpcode::PREFIX_DELTA
      raise Errors.invalid_data("patch operation missing value") if op.value.nil?

      if idx < fields.length
        fields[idx] = op.value.clone_value
      elsif idx == fields.length
        fields << op.value.clone_value
      else
        raise Errors.invalid_data("patch field index out of range")
      end
    when Model::PatchOpcode::DELETE_FIELD
      raise Errors.invalid_data("delete field index out of range") if idx.negative? || idx >= fields.length

      fields.delete_at(idx)
    when Model::PatchOpcode::APPEND_VECTOR
      if op.value.nil? || idx.negative? || idx >= fields.length
        raise Errors.invalid_data("append vector patch invalid")
      end
      if fields[idx].kind != Model::ValueKind::ARRAY || op.value.kind != Model::ValueKind::ARRAY
        raise Errors.invalid_data("append vector requires arrays")
      end

      fields[idx] = fields[idx].with(arr: fields[idx].arr + op.value.arr)
    when Model::PatchOpcode::TRUNCATE_VECTOR
      if op.value.nil? || idx.negative? || idx >= fields.length
        raise Errors.invalid_data("truncate vector patch invalid")
      end
      if fields[idx].kind != Model::ValueKind::ARRAY || op.value.kind != Model::ValueKind::U64
        raise Errors.invalid_data("truncate vector requires array and u64")
      end

      n = op.value.u64
      raise Errors.invalid_data("truncate length") if n.negative? || n > fields[idx].arr.length

      fields[idx] = fields[idx].with(arr: fields[idx].arr[0, n].dup)
    end
  end
  rebuild_message_like(base, fields)
end

#best_prefix_base(value) ⇒ Object 



1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
 
# File 'lib/twilic/core/protocol.rb', line 1373

def best_prefix_base(value)
  best_id = 0
  best_len = 0
  state.string_table.by_id.each_with_index do |candidate, id|
    n = common_prefix_len(value.b, candidate.b)
    if n > best_len
      best_len = n
      best_id = id
    end
  end
  return [0, 0, false] if best_len.zero?

  [best_id, best_len, true]
end

#decode_message(bytes) ⇒ Object 



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
 
# File 'lib/twilic/core/protocol.rb', line 58

def decode_message(bytes)
  reader = Wire::Reader.new(bytes)
  msg = read_message(reader)
  raise Errors.invalid_data("trailing bytes in message") unless reader.eof?

  case msg.kind
  when Model::MessageKind::CONTROL
    # control does not update previous message body
  when Model::MessageKind::STATE_PATCH
    begin
      reconstructed = apply_state_patch(
        msg.state_patch.base_ref,
        msg.state_patch.operations,
        msg.state_patch.literals
      )
      @state.previous_message = reconstructed
      @state.previous_message_size = bytes.bytesize
    rescue StandardError => e
      raise e if Errors.unknown_reference?(e) || Errors.stateless_retry?(e)
    end
  when Model::MessageKind::TEMPLATE_BATCH
    if @state.previous_message.nil?
      @state.previous_message = msg.clone_message
      @state.previous_message_size = bytes.bytesize
    end
  else
    @state.previous_message = msg.clone_message
    @state.previous_message_size = bytes.bytesize
  end
  msg
end

#decode_value(bytes) ⇒ Object 



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
 
# File 'lib/twilic/core/protocol.rb', line 98

def decode_value(bytes)
  msg = decode_message(bytes)
  @state.previous_message = msg.clone_message
  case msg.kind
  when Model::MessageKind::SCALAR
    msg.scalar.clone_value
  when Model::MessageKind::ARRAY
    Model.array_value(msg.array)
  when Model::MessageKind::MAP
    entries = entries_to_map(msg.map, @state)
    Model.map_value(entries)
  when Model::MessageKind::SHAPED_OBJECT
    keys, ok = @state.shape_table.get_keys(msg.shaped_object.shape_id)
    raise reference_error("shape_id", msg.shaped_object.shape_id) unless ok

    Model.map_value(
      shape_values_to_map(
        keys,
        msg.shaped_object.presence,
        msg.shaped_object.has_presence,
        msg.shaped_object.values
      )
    )
  when Model::MessageKind::TYPED_VECTOR
    typed_vector_to_value(msg.typed_vector)
  else
    raise Errors.invalid_data("decode_value expects scalar/array/map/vector message")
  end
end

#encode_message(message) ⇒ Object 



52
53
54
55
56
 
# File 'lib/twilic/core/protocol.rb', line 52

def encode_message(message)
  out = +""
  write_message(message, out)
  out
end

#encode_value(value) ⇒ Object 



90
91
92
93
94
95
96
 
# File 'lib/twilic/core/protocol.rb', line 90

def encode_value(value)
  msg = message_for_value(value)
  out = encode_message(msg)
  @state.previous_message = msg.clone_message
  @state.previous_message_size = out.bytesize
  out
end

#map_message(entries) ⇒ Object 



161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/twilic/core/protocol.rb', line 161

def map_message(entries)
  out = entries.map do |entry|
    key = entry.key
    id, ok = @state.key_table.get_id(key)
    key_ref = if ok
                Model::KeyRef.id_ref(id)
              else
                @state.key_table.register(key)
                Model::KeyRef.literal(key)
              end
    Model::MessageMapEntry.new(key: key_ref, value: entry.value.clone_value)
  end
  Model.message(kind: Model::MessageKind::MAP, map: out)
end

#message_for_value(value) ⇒ Object 



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/twilic/core/protocol.rb', line 139

def message_for_value(value)
  case value.kind
  when Model::ValueKind::ARRAY
    vec, ok = try_make_typed_vector(value.arr)
    return Model.message(kind: Model::MessageKind::TYPED_VECTOR, typed_vector: vec) if ok

    arr = value.arr.map(&:clone_value)
    Model.message(kind: Model::MessageKind::ARRAY, array: arr)
  when Model::ValueKind::MAP
    keys = value.map.map(&:key)
    had_observation = @state.encode_shape_observations.key?(shape_key(keys))
    obs = observe_encode_shape_candidate(keys)
    shape_id, ok = @state.shape_table.get_id(keys)
    return shaped_message(shape_id, value.map) if ok && (!had_observation || obs >= 2)

    map_message(value.map)
  else
    sc = value.clone_value
    Model.message(kind: Model::MessageKind::SCALAR, scalar: sc)
  end
end

#observe_decode_shape_candidate(keys) ⇒ Object 



1546
1547
1548
1549
1550
1551
1552
 
# File 'lib/twilic/core/protocol.rb', line 1546

def observe_decode_shape_candidate(keys)
  _id, ok = state.shape_table.get_id(keys)
  return if ok

  observed = state.shape_table.observe(keys)
  state.shape_table.register(keys) if should_register_shape(keys, observed)
end

#observe_encode_shape_candidate(keys) ⇒ Object 



1558
1559
1560
1561
1562
1563
1564
1565
 
# File 'lib/twilic/core/protocol.rb', line 1558

def observe_encode_shape_candidate(keys)
  sk = shape_key(keys)
  state.encode_shape_observations[sk] ||= 0
  state.encode_shape_observations[sk] += 1
  count = state.encode_shape_observations[sk]
  state.shape_table.register(keys) if should_register_shape(keys, count)
  count
end

#read_base_ref(reader) ⇒ Object 



1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
 
# File 'lib/twilic/core/protocol.rb', line 1326

def read_base_ref(reader)
  mode = reader.read_u8
  case mode
  when 0
    Model::BaseRef.previous
  when 1
    id = reader.read_varuint
    Model::BaseRef.id_ref(id)
  else
    raise Errors.invalid_data("base ref")
  end
end

#read_column(reader) ⇒ Object 



1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
 
# File 'lib/twilic/core/protocol.rb', line 1106

def read_column(reader)
  field_id = reader.read_varuint
  null_byte = reader.read_u8
  null_strategy = Model::NullStrategy.from_byte(null_byte)
  raise Errors.invalid_data("null strategy") if null_strategy.nil?

  presence = nil
  has_presence = false
  case null_strategy
  when Model::NullStrategy::PRESENCE_BITMAP, Model::NullStrategy::INVERTED_PRESENCE_BITMAP
    presence = reader.read_bitmap
    has_presence = true
  end

  codec_byte = reader.read_u8
  codec = Model::VectorCodec.from_byte(codec_byte)
  raise Errors.invalid_data("column codec") if codec.nil?

  has_dict = reader.read_u8
  dictionary_id = nil
  case has_dict
  when 0
  when 1
    id = reader.read_varuint
    has_profile = reader.read_u8
    case has_profile
    when 0
      raise reference_error("dict_id", id) unless @state.dictionaries.key?(id)
    when 1
      version = reader.read_varuint
      hash = reader.read_varuint
      expires_at = reader.read_varuint
      fallback_byte = reader.read_u8
      fallback = Session::DictionaryFallback.from_byte(fallback_byte)
      raise Errors.invalid_data("dictionary fallback") if fallback.nil?

      payload = reader.read_bytes
      if Dictionary.dictionary_payload_hash(payload) != hash
        raise Errors.invalid_data("dictionary profile hash mismatch")
      end
      @state.dictionaries[id] = payload
      @state.dictionary_profiles[id] = Session::DictionaryProfile.new(
        version: version,
        hash: hash,
        expires_at: expires_at,
        fallback: fallback
      )
    else
      raise Errors.invalid_data("dictionary profile flag")
    end
    dictionary_id = id
  else
    raise Errors.invalid_data("dictionary flag")
  end

  payload_mode = reader.read_u8
  values = nil
  case payload_mode
  when 0
    values = read_typed_vector(reader, nil, codec).data
  when 1
    raise Errors.invalid_data("trained dictionary block requires dict_id") if dictionary_id.nil?
    unless codec == Model::VectorCodec::DICTIONARY || codec == Model::VectorCodec::STRING_REF
      raise Errors.invalid_data("trained dictionary block requires string dictionary codec")
    end

    dictionary_payload = @state.dictionaries[dictionary_id]
    raise reference_error("dict_id", dictionary_id) if dictionary_payload.nil?

    dictionary = Dictionary.decode_trained_dictionary_payload(dictionary_payload)
    block = reader.read_bytes
    strings = Dictionary.decode_trained_dictionary_block(block, dictionary)
    values = Model::TypedVectorData.new(
      kind: Model::ElementType::STRING,
      bools: [],
      i64s: [],
      u64s: [],
      f64s: [],
      strings: strings,
      binary: [],
      values: []
    )
  else
    raise Errors.invalid_data("column payload mode")
  end

  Model::Column.new(
    field_id: field_id,
    null_strategy: null_strategy,
    presence: presence,
    has_presence: has_presence,
    codec: codec,
    dictionary_id: dictionary_id,
    values: values
  )
end

#read_control(reader) ⇒ Object 



1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
 
# File 'lib/twilic/core/protocol.rb', line 1246

def read_control(reader)
  op_byte = reader.read_u8
  opcode = Model::ControlOpcode.from_byte(op_byte)
  raise Errors.invalid_data("control opcode") if opcode.nil?

  msg = Model::ControlMessage.new(
    register_keys: [],
    register_shape: nil,
    register_strings: [],
    promote_string_field_to_enum: nil,
    reset_tables: false,
    reset_state: false,
    opcode: opcode
  )
  case opcode
  when Model::ControlOpcode::REGISTER_KEYS
    n = reader.read_varuint
    keys = Array.new(n, "")
    n.times do |i|
      key = reader.read_string
      keys[i] = key
      @state.key_table.register(key)
    end
    msg = msg.with(register_keys: keys)
  when Model::ControlOpcode::REGISTER_SHAPE
    shape_id = reader.read_varuint
    n = reader.read_varuint
    keys = Array.new(n)
    key_names = Array.new(n, "")
    n.times do |i|
      key_ref = read_key_ref(reader)
      keys[i] = key_ref
      key_names[i] = key_ref.literal
    end
    @state.shape_table.register_with_id(shape_id, key_names)
    msg = msg.with(register_shape: Model::RegisterShapeControl.new(shape_id: shape_id, keys: keys))
  when Model::ControlOpcode::REGISTER_STRINGS
    n = reader.read_varuint
    strings = Array.new(n, "")
    n.times do |i|
      str = reader.read_string
      strings[i] = str
      @state.string_table.register(str)
    end
    msg = msg.with(register_strings: strings)
  when Model::ControlOpcode::PROMOTE_STRING_FIELD_TO_ENUM
    field_identity = reader.read_string
    n = reader.read_varuint
    values = Array.new(n, "")
    n.times do |i|
      values[i] = reader.read_string
    end
    @state.field_enums[field_identity] = values.dup
    msg = msg.with(
      promote_string_field_to_enum: Model::PromoteEnumControl.new(
        field_identity: field_identity,
        values: values
      )
    )
  when Model::ControlOpcode::RESET_TABLES
    msg = msg.with(reset_tables: true)
    @state.reset_tables
  when Model::ControlOpcode::RESET_STATE
    msg = msg.with(reset_state: true)
    @state.reset_state
  end
  msg
end

#read_control_stream_payload(codec, reader) ⇒ Object 



1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
 
# File 'lib/twilic/core/protocol.rb', line 1355

def read_control_stream_payload(codec, reader)
  encoded = reader.read_bytes
  case codec
  when Model::ControlStreamCodec::PLAIN
    encoded
  when Model::ControlStreamCodec::RLE
    rle_decode_bytes(encoded)
  when Model::ControlStreamCodec::BITPACK
    control_bitpack_decode_bytes(encoded)
  when Model::ControlStreamCodec::HUFFMAN
    control_huffman_decode_bytes(encoded)
  when Model::ControlStreamCodec::FSE
    control_fse_decode_bytes(encoded)
  else
    raise Errors.invalid_data("control stream codec")
  end
end

#read_key_ref(reader) ⇒ Object 



916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
 
# File 'lib/twilic/core/protocol.rb', line 916

def read_key_ref(reader)
  mode = reader.read_u8
  if mode == 1
    id = reader.read_varuint
    key, ok = @state.key_table.get_value(id)
    raise reference_error("key_id", id) unless ok

    return Model::KeyRef.literal(key)
  end
  raise Errors.invalid_data("key ref mode") unless mode.zero?

  s = reader.read_string
  @state.key_table.register(s)
  Model::KeyRef.literal(s)
end

#read_message(reader) ⇒ Object 



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
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
 
# File 'lib/twilic/core/protocol.rb', line 493

def read_message(reader)
  kind_byte = reader.read_u8
  kind = Model::MessageKind.from_byte(kind_byte)
  raise Errors.invalid_kind(kind_byte) if kind.nil?

  case kind
  when Model::MessageKind::SCALAR
    v = read_value(reader)
    Model.message(kind: Model::MessageKind::SCALAR, scalar: v)
  when Model::MessageKind::ARRAY
    n = reader.read_varuint
    values = []
    n.times { values << read_value(reader) }
    Model.message(kind: Model::MessageKind::ARRAY, array: values)
  when Model::MessageKind::MAP
    n = reader.read_varuint
    entries = []
    n.times do
      key_ref = read_key_ref(reader)
      field_identity = key_ref_field_identity(key_ref, @state)
      v = read_value_with_field(reader, field_identity)
      entries << Model::MessageMapEntry.new(key: key_ref, value: v)
    end
    keys = entries.map { |entry| key_ref_string(entry.key, @state) }
    observe_decode_shape_candidate(keys)
    Model.message(kind: Model::MessageKind::MAP, map: entries)
  when Model::MessageKind::SHAPED_OBJECT
    shape_id = reader.read_varuint
    presence, has_presence = read_presence(reader)
    n = reader.read_varuint
    values = []
    keys, ok = @state.shape_table.get_keys(shape_id)
    if ok
      pres = presence
      unless has_presence
        pres = Array.new(keys.length, true)
      end
      read_count = 0
      keys.each_with_index do |key, i|
        next if i < pres.length && !pres[i]
        break if read_count >= n

        values << read_value_with_field(reader, key)
        read_count += 1
      end
      while read_count < n
        values << read_value(reader)
        read_count += 1
      end
    else
      n.times { values << read_value(reader) }
    end
    Model.message(
      kind: Model::MessageKind::SHAPED_OBJECT,
      shaped_object: Model::ShapedObjectMessage.new(
        shape_id: shape_id, presence: presence, has_presence: has_presence, values: values
      )
    )
  when Model::MessageKind::SCHEMA_OBJECT
    has_schema = reader.read_u8
    schema_id = nil
    if has_schema == 1
      schema_id = reader.read_varuint
    end
    presence, has_presence = read_presence(reader)
    n = reader.read_varuint
    mode = reader.read_u8
    fields = []
    if mode == 1
      effective_id = if schema_id
                       schema_id
                     elsif @state.last_schema_id
                       @state.last_schema_id
                     else
                       raise Errors.invalid_data("schema object requires schema id in context")
                     end
      schema = @state.schemas[effective_id]
      raise reference_error("schema_id", effective_id) if schema.nil?

      fields = read_schema_fields(schema, presence, has_presence, n, reader)
      @state.last_schema_id = effective_id
    else
      n.times { fields << read_value(reader) }
      @state.last_schema_id = schema_id if schema_id
    end
    Model.message(
      kind: Model::MessageKind::SCHEMA_OBJECT,
      schema_object: Model::SchemaObjectMessage.new(
        schema_id: schema_id, presence: presence, has_presence: has_presence, fields: fields
      )
    )
  when Model::MessageKind::TYPED_VECTOR
    tv = read_typed_vector(reader, nil, nil)
    Model.message(kind: Model::MessageKind::TYPED_VECTOR, typed_vector: tv)
  when Model::MessageKind::ROW_BATCH
    row_count = reader.read_varuint
    rows = []
    row_count.times do
      field_count = reader.read_varuint
      row = []
      field_count.times { row << read_value(reader) }
      rows << row
    end
    Model.message(
      kind: Model::MessageKind::ROW_BATCH,
      row_batch: Model::RowBatchMessage.new(rows: rows)
    )
  when Model::MessageKind::COLUMN_BATCH
    count = reader.read_varuint
    col_count = reader.read_varuint
    cols = []
    col_count.times { cols << read_column(reader) }
    Model.message(
      kind: Model::MessageKind::COLUMN_BATCH,
      column_batch: Model::ColumnBatchMessage.new(count: count, columns: cols)
    )
  when Model::MessageKind::CONTROL
    ctrl = read_control(reader)
    Model.message(kind: Model::MessageKind::CONTROL, control: ctrl)
  when Model::MessageKind::EXT
    ext_type = reader.read_varuint
    payload = reader.read_bytes
    Model.message(
      kind: Model::MessageKind::EXT,
      ext: Model::ExtMessage.new(ext_type: ext_type, payload: payload)
    )
  when Model::MessageKind::STATE_PATCH
    base_ref = read_base_ref(reader)
    n = reader.read_varuint
    ops = []
    n.times do
      field_id = reader.read_varuint
      op_byte = reader.read_u8
      opcode = Model::PatchOpcode.from_byte(op_byte)
      raise Errors.invalid_data("patch opcode") if opcode.nil?

      has_value = reader.read_u8
      value = has_value == 1 ? read_value(reader) : nil
      ops << Model::PatchOperation.new(field_id: field_id, opcode: opcode, value: value)
    end
    lit_n = reader.read_varuint
    lits = []
    lit_n.times { lits << read_value(reader) }
    Model.message(
      kind: Model::MessageKind::STATE_PATCH,
      state_patch: Model::StatePatchMessage.new(base_ref: base_ref, operations: ops, literals: lits)
    )
  when Model::MessageKind::TEMPLATE_BATCH
    template_id = reader.read_varuint
    count = reader.read_varuint
    mask = reader.read_bitmap
    col_n = reader.read_varuint
    changed_cols = []
    col_n.times { changed_cols << read_column(reader) }
    full_cols = changed_cols
    prev = @state.template_columns[template_id]
    if prev
      full_cols = merge_template_columns(prev, mask, changed_cols)
    else
      mask.each do |bit|
        raise reference_error("template_id", template_id) unless bit
      end
    end
    @state.template_columns[template_id] = full_cols
    @state.templates[template_id] = template_descriptor_from_columns(template_id, full_cols)
    if count >= 16
      @state.previous_message = Model.message(
        kind: Model::MessageKind::COLUMN_BATCH,
        column_batch: Model::ColumnBatchMessage.new(count: count, columns: full_cols)
      )
    end
    Model.message(
      kind: Model::MessageKind::TEMPLATE_BATCH,
      template_batch: Model::TemplateBatchMessage.new(
        template_id: template_id, count: count, changed_column_mask: mask, columns: changed_cols
      )
    )
  when Model::MessageKind::CONTROL_STREAM
    codec_byte = reader.read_u8
    codec = Model::ControlStreamCodec.from_byte(codec_byte)
    raise Errors.invalid_data("control stream codec") if codec.nil?

    payload = read_control_stream_payload(codec, reader)
    Model.message(
      kind: Model::MessageKind::CONTROL_STREAM,
      control_stream: Model::ControlStreamMessage.new(codec: codec, payload: payload)
    )
  when Model::MessageKind::BASE_SNAPSHOT
    base_id = reader.read_varuint
    schema_or_shape_ref = reader.read_varuint
    payload = read_message(reader)
    @state.register_base_snapshot(base_id, payload)
    Model.message(
      kind: Model::MessageKind::BASE_SNAPSHOT,
      base_snapshot: Model::BaseSnapshotMessage.new(
        base_id: base_id,
        schema_or_shape_ref: schema_or_shape_ref,
        payload: payload
      )
    )
  else
    raise Errors.invalid_data("unsupported message kind")
  end
end

#read_presence(reader) ⇒ Object 



941
942
943
944
945
946
947
 
# File 'lib/twilic/core/protocol.rb', line 941

def read_presence(reader)
  flag = reader.read_u8
  return [nil, false] if flag.zero?
  raise Errors.invalid_data("presence flag") unless flag == 1

  [reader.read_bitmap, true]
end

#read_schema_field_value(field, reader) ⇒ Object 



898
899
900
901
902
903
 
# File 'lib/twilic/core/protocol.rb', line 898

def read_schema_field_value(field, reader)
  if Protocol.normalized_logical_type(field.logical_type) == "string"
    return read_value_with_field(reader, field.name)
  end
  read_value(reader)
end

#read_schema_fields(schema, presence, has_presence, n, reader) ⇒ Object 



860
861
862
863
864
865
866
867
868
869
 
# File 'lib/twilic/core/protocol.rb', line 860

def read_schema_fields(schema, presence, has_presence, n, reader)
  indices = Protocol.schema_present_field_indices(schema, presence, has_presence)
  raise Errors.invalid_data("schema fields length") if indices.length != n

  out = []
  indices.each do |schema_idx|
    out << read_schema_field_value(schema.fields[schema_idx], reader)
  end
  out
end

#read_string_vector(reader, codec) ⇒ Object 



1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
 
# File 'lib/twilic/core/protocol.rb', line 1434

def read_string_vector(reader, codec)
  case codec
  when Model::VectorCodec::DICTIONARY
    dict_n = reader.read_varuint
    dict = Array.new(dict_n, "")
    dict_n.times do |i|
      dict[i] = reader.read_string
    end
    refs = Codec.decode_u64_vector(reader, Model::VectorCodec::DIRECT_BITPACK)
    out = Array.new(refs.length, "")
    refs.each_with_index do |ref, i|
      raise Errors.invalid_data("dictionary reference") if ref >= dict.length

      out[i] = dict[ref]
    end
    out
  when Model::VectorCodec::STRING_REF
    n = reader.read_varuint
    out = Array.new(n, "")
    n.times do |i|
      id = reader.read_varuint
      s, ok = state.string_table.get_value(id)
      raise reference_error("string_id", id) unless ok

      out[i] = s
    end
    out
  when Model::VectorCodec::PREFIX_DELTA
    n = reader.read_varuint
    out = Array.new(n, "")
    prev = ""
    n.times do |i|
      prefix = reader.read_varuint
      suffix = reader.read_string
      raise Errors.invalid_data("prefix delta in string vector") if prefix > prev.length

      out[i] = prev.byteslice(0, prefix) + suffix
      prev = out[i]
    end
    out
  else
    n = reader.read_varuint
    out = Array.new(n, "")
    n.times do |i|
      out[i] = reader.read_string
    end
    out
  end
end

#read_typed_vector(reader, forced_element, expected_codec) ⇒ Object 



996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
 
# File 'lib/twilic/core/protocol.rb', line 996

def read_typed_vector(reader, forced_element, expected_codec)
  elem_type = if forced_element.nil?
                elem_byte = reader.read_u8
                parsed = Model::ElementType.from_byte(elem_byte)
                raise Errors.invalid_data("vector element type") if parsed.nil?

                parsed
              else
                forced_element
              end
  expected_len = reader.read_varuint
  codec_byte = reader.read_u8
  codec = Model::VectorCodec.from_byte(codec_byte)
  raise Errors.invalid_data("vector codec") if codec.nil?
  raise Errors.invalid_data("column codec mismatch") if !expected_codec.nil? && codec != expected_codec

  data = Model::TypedVectorData.new(
    kind: elem_type, bools: [], i64s: [], u64s: [], f64s: [], strings: [], binary: [], values: []
  )
  case elem_type
  when Model::ElementType::BOOL
    data = data.with(bools: reader.read_bitmap)
  when Model::ElementType::I64
    data = data.with(i64s: Codec.decode_i64_vector(reader, codec))
  when Model::ElementType::U64
    data = data.with(u64s: Codec.decode_u64_vector(reader, codec))
  when Model::ElementType::F64
    data = data.with(f64s: Codec.decode_f64_vector(reader, codec))
  when Model::ElementType::STRING
    data = data.with(strings: read_string_vector(reader, codec))
  when Model::ElementType::BINARY
    n = reader.read_varuint
    values = []
    n.times { values << reader.read_bytes }
    data = data.with(binary: values)
  when Model::ElementType::VALUE
    n = reader.read_varuint
    values = []
    n.times { values << read_value(reader) }
    data = data.with(values: values)
  end
  raise Errors.invalid_data("typed vector length mismatch") if typed_vector_len(data) != expected_len

  Model::TypedVector.new(element_type: elem_type, codec: codec, data: data)
end

#read_value(reader) ⇒ Object 



770
771
772
 
# File 'lib/twilic/core/protocol.rb', line 770

def read_value(reader)
  read_value_with_field(reader, nil)
end

#read_value_with_field(reader, field_identity) ⇒ Object 



774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
 
# File 'lib/twilic/core/protocol.rb', line 774

def read_value_with_field(reader, field_identity)
  tag = reader.read_u8
  case tag
  when TAG_NULL
    Model.null_value
  when TAG_BOOL_FALSE
    Model.bool_value(false)
  when TAG_BOOL_TRUE
    Model.bool_value(true)
  when TAG_I64
    Model.i64_value(Wire.decode_zigzag(read_smallest_u64(reader)))
  when TAG_U64
    Model.u64_value(read_smallest_u64(reader))
  when TAG_F64
    Model.f64_value(Wire.read_f64_le(reader))
  when TAG_STRING
    mode_byte = reader.read_u8
    mode = Model::StringMode.from_byte(mode_byte)
    raise Errors.invalid_data("string mode") if mode.nil?

    case mode
    when Model::StringMode::EMPTY
      Model.string_value("")
    when Model::StringMode::LITERAL
      s = reader.read_string
      @state.string_table.register(s)
      Model.string_value(s)
    when Model::StringMode::REF
      id = reader.read_varuint
      s, ok = @state.string_table.get_value(id)
      raise reference_error("string_id", id) unless ok

      Model.string_value(s)
    when Model::StringMode::PREFIX_DELTA
      base_id = reader.read_varuint
      prefix_len = reader.read_varuint
      suffix = reader.read_string
      base, ok = @state.string_table.get_value(base_id)
      raise reference_error("string_id", base_id) unless ok
      raise Errors.invalid_data("prefix delta length") if prefix_len > base.bytesize

      s = base.byteslice(0, prefix_len) + suffix
      @state.string_table.register(s)
      Model.string_value(s)
    when Model::StringMode::INLINE_ENUM
      raise Errors.invalid_data("inline enum missing field identity") if field_identity.nil?

      enum_vals = @state.field_enums[field_identity]
      raise Errors.invalid_data("inline enum unknown field") if enum_vals.nil?

      code = reader.read_varuint
      raise Errors.invalid_data("inline enum code") if code >= enum_vals.length

      Model.string_value(enum_vals[code])
    end
  when TAG_BINARY
    Model.binary_value(reader.read_bytes)
  when TAG_ARRAY
    n = reader.read_varuint
    out = []
    n.times { out << read_value(reader) }
    Model.array_value(out)
  when TAG_MAP
    n = reader.read_varuint
    out = []
    n.times do
      key_ref = read_key_ref(reader)
      key = key_ref.literal
      value = read_value_with_field(reader, key)
      out << Model.entry(key, value)
    end
    Model.map_value(out)
  else
    raise Errors.invalid_tag(tag)
  end
end

#reference_error(kind, id) ⇒ Object 



128
129
130
131
132
133
 
# File 'lib/twilic/core/protocol.rb', line 128

def reference_error(kind, id)
  if @state.options.unknown_reference_policy == Session::UnknownReferencePolicy::STATELESS_RETRY
    raise Errors.stateless_retry_required(kind, id)
  end
  raise Errors.unknown_reference(kind, id)
end

#shape_key(keys) ⇒ Object 



135
136
137
 
# File 'lib/twilic/core/protocol.rb', line 135

def shape_key(keys)
  @state.shape_table.shape_key(keys)
end

#shaped_message(shape_id, entries) ⇒ Object 



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
 
# File 'lib/twilic/core/protocol.rb', line 176

def shaped_message(shape_id, entries)
  keys, = @state.shape_table.get_keys(shape_id)
  index = {}
  entries.each { |entry| index[entry.key] = entry.value }

  values = []
  presence = Array.new(keys.length, false)
  all = true
  keys.each_with_index do |key, i|
    v = index[key]
    if v
      presence[i] = true
      values << v.clone_value
    else
      presence[i] = false
      all = false
    end
  end

  msg = Model::ShapedObjectMessage.new(
    shape_id: shape_id,
    values: values,
    has_presence: !all,
    presence: all ? nil : presence
  )
  Model.message(kind: Model::MessageKind::SHAPED_OBJECT, shaped_object: msg)
end

#should_register_shape(keys, observed_count) ⇒ Object 



1554
1555
1556
 
# File 'lib/twilic/core/protocol.rb', line 1554

def should_register_shape(keys, observed_count)
  !keys.empty? && observed_count >= 2
end

#try_make_typed_vector(values) ⇒ Object 



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
 
# File 'lib/twilic/core/protocol.rb', line 204

def try_make_typed_vector(values)
  return [nil, false] if values.length < 4

  all_bool = true
  all_i64 = true
  all_u64 = true
  all_f64 = true
  all_str = true
  values.each do |value|
    case value.kind
    when Model::ValueKind::BOOL
      all_i64 = false
      all_u64 = false
      all_f64 = false
      all_str = false
    when Model::ValueKind::I64
      all_bool = false
      all_u64 = false
      all_f64 = false
      all_str = false
    when Model::ValueKind::U64
      all_bool = false
      all_i64 = false
      all_f64 = false
      all_str = false
    when Model::ValueKind::F64
      all_bool = false
      all_i64 = false
      all_u64 = false
      all_str = false
    when Model::ValueKind::STRING
      all_bool = false
      all_i64 = false
      all_u64 = false
      all_f64 = false
    else
      return [nil, false]
    end
  end

  if all_bool
    bools = values.map(&:bool)
    return [
      Model::TypedVector.new(
        element_type: Model::ElementType::BOOL,
        codec: Model::VectorCodec::DIRECT_BITPACK,
        data: Model::TypedVectorData.new(
          kind: Model::ElementType::BOOL,
          bools: bools,
          i64s: [],
          u64s: [],
          f64s: [],
          strings: [],
          binary: [],
          values: []
        )
      ),
      true
    ]
  end

  if all_i64
    vals = values.map(&:i64)
    return [
      Model::TypedVector.new(
        element_type: Model::ElementType::I64,
        codec: select_integer_codec(vals),
        data: Model::TypedVectorData.new(
          kind: Model::ElementType::I64,
          bools: [],
          i64s: vals,
          u64s: [],
          f64s: [],
          strings: [],
          binary: [],
          values: []
        )
      ),
      true
    ]
  end

  if all_u64
    vals = values.map(&:u64)
    return [
      Model::TypedVector.new(
        element_type: Model::ElementType::U64,
        codec: select_u64_codec(vals),
        data: Model::TypedVectorData.new(
          kind: Model::ElementType::U64,
          bools: [],
          i64s: [],
          u64s: vals,
          f64s: [],
          strings: [],
          binary: [],
          values: []
        )
      ),
      true
    ]
  end

  if all_f64
    vals = values.map(&:f64)
    return [
      Model::TypedVector.new(
        element_type: Model::ElementType::F64,
        codec: select_float_codec(vals),
        data: Model::TypedVectorData.new(
          kind: Model::ElementType::F64,
          bools: [],
          i64s: [],
          u64s: [],
          f64s: vals,
          strings: [],
          binary: [],
          values: []
        )
      ),
      true
    ]
  end

  if all_str
    vals = values.map(&:str)
    return [
      Model::TypedVector.new(
        element_type: Model::ElementType::STRING,
        codec: select_string_codec(vals),
        data: Model::TypedVectorData.new(
          kind: Model::ElementType::STRING,
          bools: [],
          i64s: [],
          u64s: [],
          f64s: [],
          strings: vals,
          binary: [],
          values: []
        )
      ),
      true
    ]
  end

  [nil, false]
end

#typed_vector_len(data) ⇒ Object 



949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
 
# File 'lib/twilic/core/protocol.rb', line 949

def typed_vector_len(data)
  case data.kind
  when Model::ElementType::BOOL
    data.bools.length
  when Model::ElementType::I64
    data.i64s.length
  when Model::ElementType::U64
    data.u64s.length
  when Model::ElementType::F64
    data.f64s.length
  when Model::ElementType::STRING
    data.strings.length
  when Model::ElementType::BINARY
    data.binary.length
  when Model::ElementType::VALUE
    data.values.length
  else
    0
  end
end

#write_base_ref(base_ref, out) ⇒ Object 



1317
1318
1319
1320
1321
1322
1323
1324
 
# File 'lib/twilic/core/protocol.rb', line 1317

def write_base_ref(base_ref, out)
  if base_ref.previous
    out << 0.chr
    return
  end
  out << 1.chr
  Wire.encode_varuint(base_ref.base_id, out)
end

#write_column(column, out) ⇒ Object 



1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
 
# File 'lib/twilic/core/protocol.rb', line 1042

def write_column(column, out)
  Wire.encode_varuint(column.field_id, out)
  out << column.null_strategy.value.chr
  case column.null_strategy
  when Model::NullStrategy::PRESENCE_BITMAP, Model::NullStrategy::INVERTED_PRESENCE_BITMAP
    if !column.has_presence || column.presence.nil?
      raise Errors.invalid_data("missing column presence bitmap")
    end
    Wire.encode_bitmap(column.presence, out)
  end
  out << column.codec.value.chr
  if column.dictionary_id
    out << 1.chr
    Wire.encode_varuint(column.dictionary_id, out)
    payload = @state.dictionaries[column.dictionary_id]
    if payload
      profile = @state.dictionary_profiles[column.dictionary_id]
      if profile
        out << 1.chr
        Wire.encode_varuint(profile.version, out)
        Wire.encode_varuint(profile.hash, out)
        Wire.encode_varuint(profile.expires_at, out)
        out << dictionary_fallback_to_byte(profile.fallback).chr
        Wire.encode_bytes(payload, out)
      else
        out << 0.chr
      end
    else
      out << 0.chr
    end
  else
    out << 0.chr
  end

  trained_block = nil
  if !column.dictionary_id.nil? && column.values.kind == Model::ElementType::STRING
    if column.codec == Model::VectorCodec::DICTIONARY || column.codec == Model::VectorCodec::STRING_REF
      payload = @state.dictionaries[column.dictionary_id]
      if payload
        begin
          dictionary = Dictionary.decode_trained_dictionary_payload(payload)
          block, ok = Dictionary.encode_trained_dictionary_block(column.values.strings, dictionary)
          trained_block = block if ok
        rescue StandardError
          # fall through to regular typed-vector encoding
        end
      end
    end
  end
  unless trained_block.nil?
    out << 1.chr
    Wire.encode_bytes(trained_block, out)
    return
  end

  out << 0.chr
  tv = Model::TypedVector.new(
    element_type: column.values.kind,
    codec: column.codec,
    data: Model.clone_typed_vector_data(column.values)
  )
  write_typed_vector(tv, out)
end

#write_control(control, out) ⇒ Object 



1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
 
# File 'lib/twilic/core/protocol.rb', line 1203

def write_control(control, out)
  out << control.opcode.value.chr
  case control.opcode
  when Model::ControlOpcode::REGISTER_KEYS
    Wire.encode_varuint(control.register_keys.length, out)
    control.register_keys.each do |key|
      Wire.encode_string(key, out)
      @state.key_table.register(key)
    end
  when Model::ControlOpcode::REGISTER_SHAPE
    raise Errors.invalid_data("register shape payload missing") if control.register_shape.nil?

    Wire.encode_varuint(control.register_shape.shape_id, out)
    Wire.encode_varuint(control.register_shape.keys.length, out)
    keys = []
    control.register_shape.keys.each do |key_ref|
      write_key_ref(key_ref, out)
      keys << key_ref.literal
    end
    @state.shape_table.register_with_id(control.register_shape.shape_id, keys)
  when Model::ControlOpcode::REGISTER_STRINGS
    Wire.encode_varuint(control.register_strings.length, out)
    control.register_strings.each do |str|
      Wire.encode_string(str, out)
      @state.string_table.register(str)
    end
  when Model::ControlOpcode::PROMOTE_STRING_FIELD_TO_ENUM
    raise Errors.invalid_data("promote enum payload missing") if control.promote_string_field_to_enum.nil?

    Wire.encode_string(control.promote_string_field_to_enum.field_identity, out)
    Wire.encode_varuint(control.promote_string_field_to_enum.values.length, out)
    control.promote_string_field_to_enum.values.each { |value| Wire.encode_string(value, out) }
    @state.field_enums[control.promote_string_field_to_enum.field_identity] =
      control.promote_string_field_to_enum.values.dup
  when Model::ControlOpcode::RESET_TABLES
    @state.reset_tables
  when Model::ControlOpcode::RESET_STATE
    @state.reset_state
  else
    raise Errors.invalid_data("control opcode")
  end
end

#write_control_stream_payload(codec, payload, out) ⇒ Object 



1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
 
# File 'lib/twilic/core/protocol.rb', line 1339

def write_control_stream_payload(codec, payload, out)
  encoded = case codec
            when Model::ControlStreamCodec::PLAIN
              payload.b.dup
            when Model::ControlStreamCodec::RLE
              rle_encode_bytes(payload)
            when Model::ControlStreamCodec::BITPACK
              control_bitpack_encode_bytes(payload)
            when Model::ControlStreamCodec::HUFFMAN
              control_huffman_encode_bytes(payload)
            when Model::ControlStreamCodec::FSE
              control_fse_encode_bytes(payload)
            end
  Wire.encode_bytes(encoded, out)
end

#write_key_ref(key_ref, out) ⇒ Object 



905
906
907
908
909
910
911
912
913
914
 
# File 'lib/twilic/core/protocol.rb', line 905

def write_key_ref(key_ref, out)
  if key_ref.is_id
    out << 1.chr
    Wire.encode_varuint(key_ref.id, out)
    return
  end
  out << 0.chr
  Wire.encode_string(key_ref.literal, out)
  @state.key_table.register(key_ref.literal)
end

#write_message(message, out) ⇒ Object 



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
 
# File 'lib/twilic/core/protocol.rb', line 352

def write_message(message, out)
  case message.kind
  when Model::MessageKind::SCALAR
    out << message.kind.value.chr
    write_value(message.scalar, out)
  when Model::MessageKind::ARRAY
    out << message.kind.value.chr
    Wire.encode_varuint(message.array.length, out)
    message.array.each { |value| write_value(value, out) }
  when Model::MessageKind::MAP
    out << message.kind.value.chr
    Wire.encode_varuint(message.map.length, out)
    message.map.each do |entry|
      write_key_ref(entry.key, out)
      field_id = key_ref_field_identity(entry.key, @state)
      write_value_with_field(entry.value, field_id, out)
    end
  when Model::MessageKind::SHAPED_OBJECT
    out << message.kind.value.chr
    Wire.encode_varuint(message.shaped_object.shape_id, out)
    write_presence(message.shaped_object.presence, message.shaped_object.has_presence, out)
    Wire.encode_varuint(message.shaped_object.values.length, out)
    keys, ok = @state.shape_table.get_keys(message.shaped_object.shape_id)
    if ok
      pres = message.shaped_object.presence
      unless message.shaped_object.has_presence
        pres = Array.new(keys.length, true)
      end
      value_idx = 0
      keys.each_with_index do |key, i|
        next if i < pres.length && !pres[i]
        break if value_idx >= message.shaped_object.values.length

        write_value_with_field(message.shaped_object.values[value_idx], key, out)
        value_idx += 1
      end
      while value_idx < message.shaped_object.values.length
        write_value(message.shaped_object.values[value_idx], out)
        value_idx += 1
      end
    else
      message.shaped_object.values.each { |value| write_value(value, out) }
    end
  when Model::MessageKind::SCHEMA_OBJECT
    out << message.kind.value.chr
    schema_id = nil
    if message.schema_object.schema_id
      out << 1.chr
      Wire.encode_varuint(message.schema_object.schema_id, out)
      schema_id = message.schema_object.schema_id
    else
      out << 0.chr
    end
    write_presence(message.schema_object.presence, message.schema_object.has_presence, out)
    Wire.encode_varuint(message.schema_object.fields.length, out)

    schema = nil
    if schema_id
      schema = @state.schemas[schema_id]
    elsif @state.last_schema_id
      schema = @state.schemas[@state.last_schema_id]
    end

    if schema
      out << 1.chr
      write_schema_fields(
        schema,
        message.schema_object.presence,
        message.schema_object.has_presence,
        message.schema_object.fields,
        out
      )
      @state.last_schema_id = schema_id if schema_id
    else
      out << 0.chr
      message.schema_object.fields.each { |field| write_value(field, out) }
    end
  when Model::MessageKind::TYPED_VECTOR
    out << message.kind.value.chr
    write_typed_vector(message.typed_vector, out)
  when Model::MessageKind::ROW_BATCH
    out << message.kind.value.chr
    Wire.encode_varuint(message.row_batch.rows.length, out)
    message.row_batch.rows.each do |row|
      Wire.encode_varuint(row.length, out)
      row.each { |value| write_value(value, out) }
    end
  when Model::MessageKind::COLUMN_BATCH
    out << message.kind.value.chr
    Wire.encode_varuint(message.column_batch.count, out)
    Wire.encode_varuint(message.column_batch.columns.length, out)
    message.column_batch.columns.each { |column| write_column(column, out) }
  when Model::MessageKind::CONTROL
    out << message.kind.value.chr
    write_control(message.control, out)
  when Model::MessageKind::EXT
    out << message.kind.value.chr
    Wire.encode_varuint(message.ext.ext_type, out)
    Wire.encode_bytes(message.ext.payload, out)
  when Model::MessageKind::STATE_PATCH
    out << message.kind.value.chr
    write_base_ref(message.state_patch.base_ref, out)
    Wire.encode_varuint(message.state_patch.operations.length, out)
    message.state_patch.operations.each do |op|
      Wire.encode_varuint(op.field_id, out)
      out << op.opcode.value.chr
      if op.value
        out << 1.chr
        write_value(op.value, out)
      else
        out << 0.chr
      end
    end
    Wire.encode_varuint(message.state_patch.literals.length, out)
    message.state_patch.literals.each { |literal| write_value(literal, out) }
  when Model::MessageKind::TEMPLATE_BATCH
    out << message.kind.value.chr
    Wire.encode_varuint(message.template_batch.template_id, out)
    Wire.encode_varuint(message.template_batch.count, out)
    Wire.encode_bitmap(message.template_batch.changed_column_mask, out)
    Wire.encode_varuint(message.template_batch.columns.length, out)
    message.template_batch.columns.each { |column| write_column(column, out) }
  when Model::MessageKind::CONTROL_STREAM
    out << message.kind.value.chr
    out << message.control_stream.codec.value.chr
    write_control_stream_payload(
      message.control_stream.codec,
      message.control_stream.payload,
      out
    )
  when Model::MessageKind::BASE_SNAPSHOT
    out << message.kind.value.chr
    Wire.encode_varuint(message.base_snapshot.base_id, out)
    Wire.encode_varuint(message.base_snapshot.schema_or_shape_ref, out)
    write_message(message.base_snapshot.payload, out)
    @state.register_base_snapshot(message.base_snapshot.base_id, message.base_snapshot.payload)
  else
    raise Errors.invalid_data("unsupported message kind")
  end
end

#write_presence(presence, has_presence, out) ⇒ Object 



932
933
934
935
936
937
938
939
 
# File 'lib/twilic/core/protocol.rb', line 932

def write_presence(presence, has_presence, out)
  unless has_presence
    out << 0.chr
    return
  end
  out << 1.chr
  Wire.encode_bitmap(presence, out)
end

#write_schema_field_value(field, value, out) ⇒ Object 



871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
 
# File 'lib/twilic/core/protocol.rb', line 871

def write_schema_field_value(field, value, out)
  case Protocol.normalized_logical_type(field.logical_type)
  when "bool"
    raise Errors.invalid_data("schema bool field type mismatch") unless value.kind == Model::ValueKind::BOOL

    write_value(value, out)
  when "i64", "int64", "int"
    raise Errors.invalid_data("schema i64 field type mismatch") unless value.kind == Model::ValueKind::I64

    write_value(value, out)
  when "u64", "uint64", "uint"
    raise Errors.invalid_data("schema u64 field type mismatch") unless value.kind == Model::ValueKind::U64

    write_value(value, out)
  when "f64", "float64", "float"
    raise Errors.invalid_data("schema f64 field type mismatch") unless value.kind == Model::ValueKind::F64

    write_value(value, out)
  when "string"
    raise Errors.invalid_data("schema string field type mismatch") unless value.kind == Model::ValueKind::STRING

    write_value_with_field(value, field.name, out)
  else
    write_value(value, out)
  end
end

#write_schema_fields(schema, presence, has_presence, fields, out) ⇒ Object 



851
852
853
854
855
856
857
858
 
# File 'lib/twilic/core/protocol.rb', line 851

def write_schema_fields(schema, presence, has_presence, fields, out)
  indices = Protocol.schema_present_field_indices(schema, presence, has_presence)
  indices.each_with_index do |schema_idx, i|
    raise Errors.invalid_data("schema fields length mismatch") if i >= fields.length

    write_schema_field_value(schema.fields[schema_idx], fields[i], out)
  end
end

#write_string_vector(values, codec, out) ⇒ Object 



1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
 
# File 'lib/twilic/core/protocol.rb', line 1388

def write_string_vector(values, codec, out)
  case codec
  when Model::VectorCodec::DICTIONARY
    dict = {}
    uniq = []
    refs = Array.new(values.length, 0)
    values.each_with_index do |v, i|
      id = dict[v]
      if id
        refs[i] = id
      else
        id = uniq.length
        dict[v] = id
        uniq << v
        refs[i] = id
      end
    end
    Wire.encode_varuint(uniq.length, out)
    uniq.each { |v| Wire.encode_string(v, out) }
    Codec.encode_u64_vector(refs, Model::VectorCodec::DIRECT_BITPACK, out)
  when Model::VectorCodec::STRING_REF
    Wire.encode_varuint(values.length, out)
    values.each do |v|
      id, ok = state.string_table.get_id(v)
      if ok
        Wire.encode_varuint(id, out)
      else
        id = state.string_table.register(v)
        Wire.encode_varuint(id, out)
      end
    end
  when Model::VectorCodec::PREFIX_DELTA
    Wire.encode_varuint(values.length, out)
    prev = ""
    values.each do |v|
      prefix = common_prefix_len(prev.b, v.b)
      Wire.encode_varuint(prefix, out)
      Wire.encode_string(v.byteslice(prefix, v.bytesize - prefix), out)
      prev = v
    end
  else
    Wire.encode_varuint(values.length, out)
    values.each { |v| Wire.encode_string(v, out) }
  end
end

#write_typed_vector(vector, out) ⇒ Object 



970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
 
# File 'lib/twilic/core/protocol.rb', line 970

def write_typed_vector(vector, out)
  out << vector.element_type.value.chr
  Wire.encode_varuint(typed_vector_len(vector.data), out)
  out << vector.codec.value.chr
  case vector.element_type
  when Model::ElementType::BOOL
    Wire.encode_bitmap(vector.data.bools, out)
  when Model::ElementType::I64
    Codec.encode_i64_vector(vector.data.i64s, vector.codec, out)
  when Model::ElementType::U64
    Codec.encode_u64_vector(vector.data.u64s, vector.codec, out)
  when Model::ElementType::F64
    Codec.encode_f64_vector(vector.data.f64s, vector.codec, out)
  when Model::ElementType::STRING
    write_string_vector(vector.data.strings, vector.codec, out)
  when Model::ElementType::BINARY
    Wire.encode_varuint(vector.data.binary.length, out)
    vector.data.binary.each { |bytes| Wire.encode_bytes(bytes, out) }
  when Model::ElementType::VALUE
    Wire.encode_varuint(vector.data.values.length, out)
    vector.data.values.each { |entry| write_value(entry, out) }
  else
    raise Errors.invalid_data("unsupported element type")
  end
end

#write_value(value, out) ⇒ Object 



698
699
700
 
# File 'lib/twilic/core/protocol.rb', line 698

def write_value(value, out)
  write_value_with_field(value, nil, out)
end

#write_value_with_field(value, field_identity, out) ⇒ Object 



702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
 
# File 'lib/twilic/core/protocol.rb', line 702

def write_value_with_field(value, field_identity, out)
  case value.kind
  when Model::ValueKind::NULL
    out << TAG_NULL.chr
  when Model::ValueKind::BOOL
    out << (value.bool ? TAG_BOOL_TRUE : TAG_BOOL_FALSE).chr
  when Model::ValueKind::I64
    out << TAG_I64.chr
    write_smallest_u64(Wire.encode_zigzag(value.i64), out)
  when Model::ValueKind::U64
    out << TAG_U64.chr
    write_smallest_u64(value.u64, out)
  when Model::ValueKind::F64
    out << TAG_F64.chr
    Wire.append_f64_le(out, value.f64)
  when Model::ValueKind::STRING
    out << TAG_STRING.chr
    unless field_identity.nil?
      enum_vals = @state.field_enums[field_identity]
      unless enum_vals.nil?
        enum_vals.each_with_index do |enum_value, i|
          if enum_value == value.str
            out << Model::StringMode::INLINE_ENUM.value.chr
            Wire.encode_varuint(i, out)
            return
          end
        end
      end
    end
    if value.str.empty?
      out << Model::StringMode::EMPTY.value.chr
      return
    end
    id, ok = @state.string_table.get_id(value.str)
    if ok
      out << Model::StringMode::REF.value.chr
      Wire.encode_varuint(id, out)
      return
    end
    base_id, prefix_len, has_prefix = best_prefix_base(value.str)
    if has_prefix && prefix_len >= 4 && prefix_len < value.str.bytesize
      out << Model::StringMode::PREFIX_DELTA.value.chr
      Wire.encode_varuint(base_id, out)
      Wire.encode_varuint(prefix_len, out)
      Wire.encode_string(value.str.byteslice(prefix_len, value.str.bytesize - prefix_len), out)
      @state.string_table.register(value.str)
      return
    end
    out << Model::StringMode::LITERAL.value.chr
    Wire.encode_string(value.str, out)
    @state.string_table.register(value.str)
  when Model::ValueKind::BINARY
    out << TAG_BINARY.chr
    Wire.encode_bytes(value.bin, out)
  when Model::ValueKind::ARRAY
    out << TAG_ARRAY.chr
    Wire.encode_varuint(value.arr.length, out)
    value.arr.each { |entry| write_value(entry, out) }
  when Model::ValueKind::MAP
    out << TAG_MAP.chr
    Wire.encode_varuint(value.map.length, out)
    value.map.each do |entry|
      write_key_ref(Model::KeyRef.literal(entry.key), out)
      write_value_with_field(entry.value, entry.key, out)
    end
  end
end