refactor: implement result typing

[Nytelife26]

Fixes #23.

It came to my attention when I was working on martinbrose/cloudflare-speedtest-exporter#54 that it would be useful for end users to have a properly typed results class, instead of either having to work with a loosely structured dict or collect it into their own named tuples.

This also fixes a bug introduced in #19 where --json would omit some entries. See below:

I would recommend #21 be merged first, so this can serve as its successor, and possibly #22.

TODO:

• Readd support for storing results in megabits.
  • Pick a strategy
    • Add _mbps keys alongside _bps
    • Convert keys to a tuple of (bps, mbps)
    • Store results as one or the other
• Decide whether this is worth a major version update so soon after the last one.

[Nytelife26]

@martinbrose I'll need your input on which strategy to use for handling megabits, as listed in the todo section.

[martinbrose]

Thanks @Nytelife26,

I'll have a look by the weekend at the latest. Hopefully earlier.

[Nytelife26]

I took the initiative to evaluate each strategy for handling megabits, and figured the last one would be the simplest and least surprising (implementation wise). cfspeedtest now provides a bits_to_megabits function, and whether results are stored in bits or megabits depends on the megabits flag passed to SuiteResults. the output looks like this:

{
  "megabits": true,
  "meta": {...},
  "tests": {
    "latency": {"value": 15.61, ...},
    "jitter": {"value": 7.19, ...},
    "100kB_down": {"value": 41.33, ...},
    "100kB_up": {"value": 23.01, ...}
  },
  "90th_percentile_down": {"value": 96.43, ...},
  "90th_percentile_up": {"value": 24.67, ...}
}

this is also reported by the CLI, now with keys that reflect the dict structure:

megabits: True
...
meta.region: England
meta.city: Tamworth
tests.latency: 10.77
tests.jitter: 2.06
tests.100kB_down: 35.16
tests.100kB_up: 22.62
...
90th_percentile_down: 97.64
90th_percentile_up: 24.69

[Nytelife26]

quick follow up - @martinbrose, how's your schedule looking? i'm excited to continue working on martinbrose/cloudflare-speedtest-exporter#54 after we land this.

[ErinsMatthew]

Any timeline for this to be implemented?

[ErinsMatthew]

Any further updates?

[Nytelife26]

Any further updates?

I haven't heard anything in quite some time. I would be open to continue working on things when Martin returns, though.