Decode MessagePack, igbinary, Protobuf and Avro values with Display As

Abierto
  • ¿Algo no está bien?
#3,607 2 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
25/100
Tipo de issue
Nueva funcionalidad
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
kafka, mysql, postgresql, swift
Área
database, databases

Línea de trabajo

Start with apple/TablePro/Core/Services/Formatting/ValueDisplayFormat.swift and ValueDisplayFormatter.swift, then review features/json-viewer.mdx and databases/kafka.mdx for existing viewer behavior. Identify how per-column formats and Kafka schema settings are represented before scoping the decoders. Done means reference-library fixtures decode for each format, invalid values fall back to hex with an explanation, and swapped-time UUIDs display as their original UUID.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

enhancement platform-macos
Problem

Display As has seven formats: Raw Value, Text, UUID, two Unix timestamps, JSON and PHP Serialized (features/json-viewer.mdx:14-22, apple/TablePro/Core/Services/Formatting/ValueDisplayFormat.swift:12-19). A binary column that holds a compact serialization shows only hex:

  • MessagePack, common for cache payloads and job queues.
  • igbinary, the binary form of PHP serialization, which the PHP Serialized viewer does not read.
  • Protobuf and Avro. On Kafka, a topic whose values are Avro or Protobuf shows the raw bytes, five-byte wire-format prefix included (databases/kafka.mdx:151-152).

The UUID format also renders the bytes in stored order (apple/TablePro/Core/Services/Formatting/ValueDisplayFormatter.swift:56-74). A MySQL column filled with UUID_TO_BIN(uuid, 1), which moves the time fields to the front, renders as a UUID that differs from the one the application wrote.

Proposed solution
  • MessagePack on binary columns: decoded into the JSON tree viewer, read-only, with badges for bin, ext and timestamp values.
  • igbinary on binary columns: decoded into the PHP serialized viewer's tree.
  • Protobuf on binary columns: with no schema, the wire format as field numbers and wire types. With a .proto file or descriptor set chosen for the column, field names and types.
  • Avro on binary columns: decoded with a writer schema file chosen for the column.
  • On Kafka, a value with the wire-format prefix reads its schema ID, and when the connection names a Schema Registry URL, the Avro or Protobuf schema is fetched from it.
  • UUID (Swapped Time) for UUID_TO_BIN(uuid, 1) columns, and an edit typed as a UUID is written back in the same byte order.
  • Each format behaves like the existing ones: set per column and scoped to the connection and table, rendering only, a single copied cell copies the decoded text, and filters and highlight rules still read the stored value (features/filtering.mdx:32).
  • A value that does not decode falls back to hex, and the viewer says why.

Done when: each format decodes a fixture written by its reference library, a broken value falls back to hex, and a UUID_TO_BIN(uuid, 1) value renders as the UUID passed in.

Alternatives considered

Copy the hex out and decode it with a script, or write a view that decodes on the server where the engine can.

Platform

macOS

Related database type

N/A / General

Lenguaje dominante
Swift
Estrellas
6.2k
Forks
412
Merge medio
3 h 56 min
PR fusionados (30 d)
669

Preparar el entorno

Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de TableProApp/TablePro

Todos los issues de TableProApp/TablePro

Issues similares

Más issues de Swift

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.