loader

README

Loader

The official config loader for Tableau.

Prerequisites

TODO: devcontainer

• Supported OS: Windows, macOS, Linux
• Init protobuf: bash init.sh
• C++ standard: at least C++17

C++

Dev at Linux

• Install: CMake 3.22 or above
• Change dir: cd test/cpp-tableau-loader
• Generate protoconf: bash ./gen.sh
• Create build dir: mkdir build && cd build
• Run cmake:
  • C++17: cmake ../src/
  • C++20: cmake ../src/ -DCMAKE_CXX_STANDARD=20
  • clang: cmake ../src/ -DCMAKE_CXX_COMPILER=clang++
• Build: make -j8, then the bin dir will be generated at test/cpp-tableau-loader/bin.

References

• Protocol Buffers C++ Installation
• Protocol Buffers C++ Reference

Go

• Install: go1.18 or above
• Install protoc-gen-go: go install google.golang.org/protobuf/cmd/protoc-gen-go@latest
• Change dir: cd test/go-tableau-loader
• Generate protoconf: bash ./gen.sh
• Build: go build

References

• Protocol Buffers Go Reference

TypeScript

Requirements

• nodejs v16.0.0
• protobufjs v7.2.3

Test

• Change dir: cd test/ts-tableau-loader
• Install depedencies: npm install
• Generate protoconf: npm run generate
• Test: npm run test

Problems in protobufjs:

• Unable to use Google well known types
• google.protobuf.Timestamp deserialization incompatible with canonical JSON representation
• Implement wrapper for google.protobuf.Timestamp, and correctly generate wrappers for static target.

protobufjs: Reflection vs. static code

If using reflection (.proto or JSON) but not static code, and for well-known types support, then proto3-json-serializer is a good option. This library implements proto3 JSON serialization and deserialization for protobuf.js protobuf objects according to the spec.

References:

• How to Setup a TypeScript + Node.js Project
• proto3-json-serializer