Add duration and byte-count formatters by gheine · Pull Request #188 · flowcommerce/lib-util

gheine · 2024-06-19T15:31:49Z

No description provided.

flow-tech · 2024-06-19T15:50:32Z

Click here for code coverage report: https://jenkins.flo.pub/job/flowcommerce/job/lib-util/job/PR-188/4/scoverage-report/

flow-tech · 2024-06-19T16:06:52Z

Click here for code coverage report: https://jenkins.flo.pub/job/flowcommerce/job/lib-util/job/PR-188/5/scoverage-report/

nicolagi · 2024-06-19T15:40:05Z

src/main/scala/io/flow/util/ByteFormatter.scala

+
+object ByteFormatter {
+  def byteCountSI(bytes: Long): String = {
+    format(bytes, true)


Not sure how you feel about flag arguments but throwing in an alternative, e.g., format(value, multiplier) where the multiplier has only two cases (SI, Binary) and the list of symbols is derived from it with pattern matching.

nicolagi · 2024-06-19T15:48:56Z

src/main/scala/io/flow/util/DurationFormatter.scala

+
+object DurationFormatter {
+  import ByteFormatter.{df0, df1, df2}
+  private val units = Seq((1000L, "ns"), (1000L, "us"), (1000L, "ms"), (60L, "sec"), (60L, "min"), (24L, "h"))


Why not μs and s? I'd suggest m instead of min, because while m is very common for durations, although techinically that's a meter, and d for days (also avois "days" vs "day") 🤷‍♂️ FWIW, Go (hence k8s and all infra stuff written in Go) formats durations as, e.g., 2d9h45m19s.

nicolagi · 2024-06-19T15:57:47Z

src/main/scala/io/flow/util/ByteFormatter.scala

+    } else {
+      val signum = if (bytes < 0) "-" else ""
+      val exponent = getExponent(absBytes, baseValue)
+      val divisor = Math.pow(baseValue.toDouble, exponent.toDouble)


Hmm. Seems both simpler and more precise to just return both exponent and divisor from getExponent. (In the recursive step, exponent becomes exponent+1 and divisor becomes divisor*baseValue.) Or just look it up like the unit perhaps.

nicolagi · 2024-06-19T16:02:40Z

src/test/scala/io/flow/util/ByteFormatterSpec.scala

+    "TiB values" in {
+      ByteFormatter.byteCountBinary(1024L * 1024 * 1024 * 1024) mustBe "1 TiB"
+      ByteFormatter.byteCountBinary(1024L * 1024 * 1024 * 1024 * 1024 - 1) mustBe "1023 TiB"
+    }
