Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Time offset format is inconsistent between plan JSON and Aerie UI #87

Open
parkerabercrombie opened this issue Oct 5, 2023 · 3 comments
Labels
breaking change Proposal or code break existing interfaces. enhancement New/improved features and capabilities
Milestone

Comments

@parkerabercrombie
Copy link
Collaborator

The Aerie UI (and GraphQL response) displays start offests as hh:mm:ss.sss. Aerie always shows number of hours, even if the offset is more than 24 hrs. However, when I download a plan using the aerie-cli the offset is represented as "D days, hh:mm:ss.sss". For example "start_offset": "2 days, 0:59:59.897000", where as in the Aerie GUI, it's 48:59:59.897.

This difference in format makes it difficult to match up times in the plan JSON file with activities in the Aeri/e UI. We should use the same offset format as in Aerie.

@cartermak
Copy link
Member

I'd be happy to support an audit of time formats with some more intentional design decisions like this. I'll just note that this would be another breaking change to the plan JSON format; the current time/duration string formats are based on standard string-ify methods from Python libraries, so any other tools that interact with JSON plans would need to update their de/serialization to handle a custom format.

@parkerabercrombie
Copy link
Collaborator Author

I think it would be worth a breaking change to standardize with the Aerie time format. Let's talk about the potential impact to other tools.

@cartermak cartermak added this to the v3 milestone Jan 29, 2024
@cartermak cartermak added enhancement New/improved features and capabilities breaking change Proposal or code break existing interfaces. labels Jan 29, 2024
@cartermak
Copy link
Member

Adding some notes here in support of the Aerie Plan JSON format effort:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking change Proposal or code break existing interfaces. enhancement New/improved features and capabilities
Projects
None yet
Development

No branches or pull requests

2 participants