ably / ably-asset-tracking-common

Common resources used by the Ably Asset Tracking SDKs.
Apache License 2.0
3 stars 3 forks source link

Add platform identifier to `LocationHistoryData` objects #63

Closed lawrence-forooghian closed 1 year ago

lawrence-forooghian commented 1 year ago

As described in #62, the publisher SDK emits {{LocationHistoryData}} objects. These objects can subsequently be serialised and stored for later use. Currently, only the Android SDK emits these objects, but in https://github.com/ably/ably-asset-tracking-swift/issues/111 we'll start emitting them from iOS too. We should add some information (need to determine best format for this) that identifies the platform (possibly even library version) that the data was generated by. We should then add it to the JSON schema created in https://github.com/ably/ably-asset-tracking-common/issues/62.

lawrence-forooghian commented 1 year ago

@QuintinWillison @KacperKluka @rdeoliv do you have any suggestions about what format this identifier should take? Are there any examples, either within the asset tracking SDK or more widely at Ably, that we could take advantage of / should be consistent with?

QuintinWillison commented 1 year ago

What immediately comes to mind is the similarity to the Agents supplied by SDKs to the Ably service when they connect.

It doesn't sound like we need to worry about the overhead (in terms of data size) of this additional information, so I would prefer something verbose and unabbreviated. Other than that, no strong opinions. Design away! 😁

deanna-lad commented 1 year ago

The corresponding Jira issue is https://ably.atlassian.net/browse/SDK-2717