ydb-platform / ydb-embedded-ui

Apache License 2.0
28 stars 7 forks source link

Display base64 query response as string #639

Closed artemmufazalov closed 8 months ago

artemmufazalov commented 10 months ago

To do it, special flag should be passed to viewer/json/query api call.

Additional setting should be added, this flag should be passed only if setting is active


Param name: base64, by default true (strings are returned encoded). It should be 'false' to receive decoded strings in response.

We need to discuss, whether this flag could be added to General Settings section, since it is present only on latest ydb versions.

antonkovalenko commented 9 months ago

the aforementioned flag was added at https://github.com/ydb-platform/ydb/pull/647

vovaspace commented 8 months ago

We need to discuss, whether this flag could be added to General Settings section, since it is present only on latest ydb versions.

Can we add this flag without any conditions, since newer versions of UI will be embedded into newer versions of ydb?

artemmufazalov commented 8 months ago

Can we add this flag without any conditions, since newer versions of UI will be embedded into newer versions of ydb?

  1. After some discussions we decided not to turn it on by default, but add as an option for the user

  2. Embedded version correlates with specific ydb version. However, it's also used as a package in multi-cluster view, where we could have clusters with different ydb versions, including old ones, so it should work on all that versions

That's why the question, where to add this setting, has arised. It seems, currently it better fits experiments section

vovaspace commented 8 months ago

For multi-cluster UI I suggest just add a description under the setting title like "it will work starting from x.x.x version".

artemmufazalov commented 8 months ago

For multi-cluster UI I suggest just add a description under the setting title like "it will work starting from x.x.x version".

If there is ydb version with this feature, this could be a solution

vovaspace commented 8 months ago

How is it better to formulate the flag title? “Disable base64 encoding” with default false value or “Enable …” with default true value?

As I see, all of other flags have default false values. But in my opinion, disabled base64 is like “normal” behavior and the flag should be about enabling.

antonkovalenko commented 8 months ago

Let's name the flag 'Display binary data in plain text', set default to true, it will BREAK current behaviour. Place the flag to Settings sections