feat(system-server): add /system/oem_mode/upload_splash endpoint to change boot splash #14865
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…bleOEMMode feature flag is changed.
make sure robot type is RobotTypeEnum.FLEX when setting the enableOEMMode
sfoster1
reviewed
Apr 11, 2024
| file_size = 0 | ||
| for chunk in file.file: | ||
| file_size += len(chunk) | ||
| if file_size > 5242880: # 5MB |
There was a problem hiding this comment.
nit: can we make this the literal sequence 5 * 1024 * 1024
dont process upload_splash endpoint unless oem mode has been enabled add filetype package
add import-untyped for typefile import
CaseyBatten
approved these changes
Apr 12, 2024
| detail="File is larger than 5mb.", | ||
| ) | ||
|
|
||
| # TODO: Validate image dimensions |
There was a problem hiding this comment.
This TODO can be removed since we will no longer be validating dimensions on this side.
Comment on lines
+55
to
+62
| status.HTTP_201_CREATED: {"message": "OEM Mode splash screen uploaded"}, | ||
| status.HTTP_400_BAD_REQUEST: {"message": "OEM Mode splash screen not set"}, | ||
| status.HTTP_413_REQUEST_ENTITY_TOO_LARGE: { | ||
| "message": "File is larger than 5mb" | ||
| }, | ||
| status.HTTP_415_UNSUPPORTED_MEDIA_TYPE: {"message": "Invalid file type"}, | ||
| status.HTTP_500_INTERNAL_SERVER_ERROR: { | ||
| "message": "OEM Mode splash unhandled exception." |
There was a problem hiding this comment.
Status responses all make sense and are error codes in line with what would reasonably be expected on receiving end.
Carlos-fernandez
pushed a commit
that referenced
this pull request
May 20, 2024
…hange the userspace boot screen. (#14865)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview
Now that we can enable/disable OEM mode, we need an endpoint to upload an image file which will become the splash screen. This pull request adds the endpoint, which takes a file and validates it to make sure it's a PNG image, < 5 MB in size, and is 1024x600 in dimension. Once validated, the file is saved to its final location in
/var/lib/opentrons-system-server/oem_mode/{filename}then we updateOT_SYSTEM_SERVER_oem_mode_splash_customdotenv file with the same location.Closes: PLAT-277
Test Plan
/var/lib/opentrons-system-server/oem_mode/{filename}OT_SYSTEM_SERVER_oem_mode_splash_customto/var/lib/opentrons-system-server/oem_mode/{filename}in thesystem.envfileChangelog
/system/oem_mode/upload_splashendpoint to the system serverReview requests
Risk assessment
Low, unreleased