Change default display of byte count column of asset

[RFSH]

Summary

In #903, we discussed allowing data-modelers to format a byte count column to show human-readable values. While the issue talks about two methods of doing this, we've only implemented the handlebars function for now. Now we would like to explore showing the human readable value by default for the byte_count_column of asset annotation (similar to how we're showing a download button by default for the asset column).

Given that not all deployments might agree about using si by default, we also need to allow them to systematically change this default without the need to add column-display to each individual byte_count_column. Therefore, we are going to introduce new properties inside the column-defaults:

{
  "tag:isrd.isi.edu,2023:column-defaults": {
  "by_name": { ... },
  "by_type": { ... },
  "asset": {
    "url": { ... },
    "byte_count": { ... },
    "filename": { ... },
    "md5": { ... },
    "sha256": { ... }
  }
}

Details

The following is summary of what we discussed. I just copied these from my notes and will clean them up later.

• The current implementation of column-defaults is very simple. It starts with an empty object and adds the annotation under by_type and then by_name. But for asset columns, we need to introduce a more complicated logic. We should not use the column-displays defined under the by_type for any asset properties Does this make sense?.

• We're currently not checking whether a column is used in two different asset annotations. So technically, a column could be both byte_count and filename. While we won't try to solve this now, we should ensure we're deterministically categorizing columns. So, in this case, the column should always be marked byte_count or filename, and the order of columns or definitions shouldn't matter.

• For url

  • if display.markdown_pattern is defined (column, by_name, asset), use it
  • otherwise, display the default download button (default heuristics)
  • we cannot replicate this with markdown_pattern (changes based on filename, url host, etc).

• for bytes

  • if display.markdown_pattern is defined (column, by_name, asset), use it
  • otherwise, display the default value.

• The byte count value should be either a

  • toggle: only if we can find an icon that indicates that
  • open a dropdown: in this case, we would just use the same triangle as other dropdowns

    ideal
    - show the humanize and then click on it to show raw
    less ideal
    - tooltip that shows the raw value
    123 KB (i)
    (i): 123,567 bytes (1 KB = 1000 bytes)
    (i): 123,567 bytes (1 KiB = 1024 bytes)

• Is there a way that data modelers can access the default display we wrote?

  • it would be useful for card view, for example.

[RFSH]

The changes described above has been merged with master. Some clarification about the questions above:

• Instead of complicating the column-defaults logic we decided to go with a simple priority list. asset related properties will be honored first, then by_name, and then by_type.
• We couldn't come up with a toggle UI that made sense, so we ended up implementing the tooltip method.
• The default byte count display is using the humanizeBytes handlebars function which can be called directly, so data-modelers can easily access it.