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

Change: deprecate environment storage bytesUsed for kibUsed #3658

Merged
merged 1 commit into from Mar 12, 2024

Conversation

shreddedbacon
Copy link
Member

@shreddedbacon shreddedbacon commented Feb 23, 2024

General Checklist

  • Affected Issues have been mentioned in the Closing issues section
  • Documentation has been written/updated
  • PR title is ready for inclusion in changelog

Database Migrations

  • If your PR contains a database migation, it MUST be the latest in date order alphabetically

This introduces a deprecation on bytesUsed when interacting with environment storage queries and mutations.

When retrieving environment storage sizes, bytesUsed is provided as the name when the value of this data is actually kibibytes. This PR is the first step in the removal of bytesUsed and renaming to kibUsed. A follow up PR will introduce the actual breaking change to remove it in a future release.

Additionally, bytesUsed is an Int type, which has a 32bit integer limitation. The new kibUsed input is a Float type to allow greater input.

For now, bytesUsed is still the required input for addOrUpdateEnvironmentStorage with kibUsed as an optional argument. kibUsed will be preferred though if it is provided. Unfortunately, as bytesUsed is still an Int large numbers will still cause an error if they are provided, until bytesUsed is completely removed from the API in a future version

Closing issues

closes #2245

@shreddedbacon shreddedbacon marked this pull request as ready for review February 23, 2024 01:33
@shreddedbacon shreddedbacon changed the title feature: deprecate environment storage bytesused for kilobytesused Change: deprecate environment storage bytesused for kilobytesused Feb 23, 2024
@shreddedbacon shreddedbacon changed the title Change: deprecate environment storage bytesused for kilobytesused Change: deprecate environment storage bytesUsed for kibUsed Feb 27, 2024
@shreddedbacon shreddedbacon force-pushed the storage-kilobytesused branch 3 times, most recently from 65c864d to 263cc9c Compare March 1, 2024 02:04
@tobybellwood tobybellwood added this to the 2.18.0 milestone Mar 4, 2024
@shreddedbacon shreddedbacon force-pushed the storage-kilobytesused branch 2 times, most recently from 88743fb to 930ad88 Compare March 4, 2024 23:10
Copy link
Member

@rocketeerbkw rocketeerbkw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There could be nicer ways to deprecate this schema but it's primary use is for integrations with other systems (not end-user facing) and it requires platform-owner privileges, so I don't think it's worth any further effort.

@tobybellwood tobybellwood merged commit 7e006b1 into main Mar 12, 2024
2 checks passed
@tobybellwood tobybellwood deleted the storage-kilobytesused branch March 13, 2024 01:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Lagoon API lists bytesUsed when it is actually kiloBytesUsed
3 participants