ref: Add typealias for bytes

[kevinrenskers]

This should make it clear what kind of size these variables are. Are they KB, MB, GB? Nope, they are all bytes.

#skip-changelog

[github-actions]

Performance metrics 🚀

	Plain	With Sentry	Diff
Startup time	1217.12 ms	1243.86 ms	26.74 ms
Size	20.51 KiB	331.79 KiB	311.28 KiB

Baseline results on branch: master

Startup times

Revision	Plain	With Sentry	Diff
5025d2e	1248.52 ms	1251.72 ms	3.20 ms
b869536	1250.37 ms	1274.84 ms	24.47 ms
5025d2e	1245.14 ms	1268.58 ms	23.44 ms
9fc2dd0	1246.14 ms	1275.00 ms	28.86 ms

App size

Revision	Plain	With Sentry	Diff
5025d2e	20.51 KiB	331.79 KiB	311.28 KiB
b869536	20.51 KiB	331.79 KiB	311.28 KiB
5025d2e	20.51 KiB	331.79 KiB	311.28 KiB
9fc2dd0	20.50 KiB	331.79 KiB	311.28 KiB

Previous results on branch: fix/bytes-type

Startup times

Revision	Plain	With Sentry	Diff
a5014e6	1247.04 ms	1261.68 ms	14.64 ms
e22634b	1205.16 ms	1233.28 ms	28.12 ms
1e02273	1228.39 ms	1257.07 ms	28.68 ms

App size

Revision	Plain	With Sentry	Diff
a5014e6	20.50 KiB	331.79 KiB	311.29 KiB
e22634b	20.51 KiB	331.79 KiB	311.28 KiB
1e02273	20.51 KiB	331.79 KiB	311.28 KiB

[philipphofmann]

Thanks, please prefix the PR title for refactorings with ref:

[philipphofmann]

LGTM

[armcknight]

There are still usages of uint64_t in SentryCrashMonitor_System.m that would intermix with this typedef, this only got about half of them. Did you intend to not change those?

Nice change overall. Relatedly, one of the only times I like using a sort of Hungarian notation is to put units like _bytes/_mb/_ms/_minutes/_degrees/_radians on variable/function names. Also relatedly, one of my favorite reasons to use Swift is to be able to use https://github.com/pointfreeco/swift-tagged for even better type safety around this kind of thing.

[kevinrenskers]

I must've missed those, I'll take a look tomorrow. And yea I'm a huge fan of everything the Point-Free guys do :)

[brustolin]

TBH Im not a huge fan of this change. The result information should be clear in the documentation, and the function name should be clear.

Having bytes as a value type is confusing, nothing indicates that this is a number indicating the amount of bytes. This could easily be misunderstood as a collection of byte (which btw is a valid type in other languages).

Take - (bytes)freeMemory for example. Am I freeing some memory? Is this function returning the actual bytes released as a collection? What about - (bytes)freeStorage what storage in being released?
I would rather call freeMemorySize, freeStorageSize and 'appMemorySize'

[kevinrenskers]

We can do both. If we call it freeStorageSize then question is still "what is the unit", which has come up in multiple comments already.

[brustolin]

IMO a simple

/**
* Returns the amount of bytes...
*/

Above the function in the header should be enough to solve this.

That being said, I will not oppose if you want to merge this. Just sharing my thoughts.

[armcknight]

We could always add the _bytes suffix to those methods to show that is the unit that is being returned. Alternatively, we could define a struct like

NS_ENUM(NSUInteger, SentryMemoryUnit) {
  SentryMemoryUnitByte,
  SentryMemoryUnitMegabyte,
...
}

typedef struct {
  int quantity;
  SentryMemoryUnit unit;
} SentryMemorySize;

maybe overkill, just looking at alternatives. I'm mostly fine with the proposed typedef. One benefit of having the enum/struct is that doc comments can be attached that can be brought up with a doc popover in Xcode with an ⌥ + click on the names.