refactor: Centralise deeplink encode and decode into server #3489
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,108 @@ | ||
| use anyhow::Result; | ||
| use base64::{engine::general_purpose::URL_SAFE_NO_PAD, Engine as _}; | ||
| use thiserror::Error; | ||
|
|
||
| use crate::recipe::Recipe; | ||
|
|
||
| #[derive(Error, Debug)] | ||
| pub enum DecodeError { | ||
|
Contributor
There was a problem hiding this comment. For future, it would be nice to distinguish the errors. #[derive(Error, Debug)]
pub enum DecodeError {
#[error("Invalid base64 encoding")]
InvalidBase64,
#[error("Invalid JSON format: {0}")]
InvalidJson(String),
#[error("Invalid recipe format: missing required fields")]
InvalidRecipe,
#[error("Unsupported deeplink format")]
UnsupportedFormat,
} |
||
| #[error("All decoding methods failed")] | ||
| AllMethodsFailed, | ||
| } | ||
|
|
||
| pub fn encode(recipe: &Recipe) -> Result<String, serde_json::Error> { | ||
| let recipe_json = serde_json::to_string(recipe)?; | ||
| let encoded = URL_SAFE_NO_PAD.encode(recipe_json.as_bytes()); | ||
| Ok(encoded) | ||
| } | ||
|
|
||
| pub fn decode(link: &str) -> Result<Recipe, DecodeError> { | ||
| // Handle the current format: URL-safe Base64 without padding. | ||
| if let Ok(decoded_bytes) = URL_SAFE_NO_PAD.decode(link) { | ||
| if let Ok(recipe_json) = String::from_utf8(decoded_bytes) { | ||
| if let Ok(recipe) = serde_json::from_str::<Recipe>(&recipe_json) { | ||
| return Ok(recipe); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // Handle legacy formats of 'standard base64 encoded' and standard base64 encoded that was then url encoded. | ||
| if let Ok(url_decoded) = urlencoding::decode(link) { | ||
| if let Ok(decoded_bytes) = | ||
| base64::engine::general_purpose::STANDARD.decode(url_decoded.as_bytes()) | ||
| { | ||
| if let Ok(recipe_json) = String::from_utf8(decoded_bytes) { | ||
| if let Ok(recipe) = serde_json::from_str::<Recipe>(&recipe_json) { | ||
| return Ok(recipe); | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| Err(DecodeError::AllMethodsFailed) | ||
| } | ||
|
|
||
| #[cfg(test)] | ||
| mod tests { | ||
| use super::*; | ||
| use crate::recipe::Recipe; | ||
|
|
||
| fn create_test_recipe() -> Recipe { | ||
| Recipe::builder() | ||
| .title("Test Recipe") | ||
| .description("A test recipe for deeplink encoding/decoding") | ||
| .instructions("Act as a helpful assistant") | ||
| .build() | ||
| .expect("Failed to build test recipe") | ||
| } | ||
|
|
||
| #[test] | ||
| fn test_encode_decode_round_trip() { | ||
| let original_recipe = create_test_recipe(); | ||
|
|
||
| let encoded = encode(&original_recipe).expect("Failed to encode recipe"); | ||
| assert!(!encoded.is_empty()); | ||
|
|
||
| let decoded_recipe = decode(&encoded).expect("Failed to decode recipe"); | ||
|
|
||
| assert_eq!(original_recipe.title, decoded_recipe.title); | ||
| assert_eq!(original_recipe.description, decoded_recipe.description); | ||
| assert_eq!(original_recipe.instructions, decoded_recipe.instructions); | ||
| assert_eq!(original_recipe.version, decoded_recipe.version); | ||
| } | ||
|
|
||
| #[test] | ||
| fn test_decode_legacy_standard_base64() { | ||
| let recipe = create_test_recipe(); | ||
| let recipe_json = serde_json::to_string(&recipe).unwrap(); | ||
| let legacy_encoded = | ||
| base64::engine::general_purpose::STANDARD.encode(recipe_json.as_bytes()); | ||
|
|
||
| let decoded_recipe = decode(&legacy_encoded).expect("Failed to decode legacy format"); | ||
| assert_eq!(recipe.title, decoded_recipe.title); | ||
| assert_eq!(recipe.description, decoded_recipe.description); | ||
| assert_eq!(recipe.instructions, decoded_recipe.instructions); | ||
| } | ||
|
|
||
| #[test] | ||
| fn test_decode_legacy_url_encoded_base64() { | ||
| let recipe = create_test_recipe(); | ||
| let recipe_json = serde_json::to_string(&recipe).unwrap(); | ||
| let base64_encoded = | ||
| base64::engine::general_purpose::STANDARD.encode(recipe_json.as_bytes()); | ||
| let url_encoded = urlencoding::encode(&base64_encoded); | ||
|
|
||
| let decoded_recipe = | ||
| decode(&url_encoded).expect("Failed to decode URL-encoded legacy format"); | ||
| assert_eq!(recipe.title, decoded_recipe.title); | ||
| assert_eq!(recipe.description, decoded_recipe.description); | ||
| assert_eq!(recipe.instructions, decoded_recipe.instructions); | ||
| } | ||
|
|
||
| #[test] | ||
| fn test_decode_invalid_input() { | ||
| let result = decode("invalid_base64!"); | ||
| assert!(result.is_err()); | ||
| assert!(matches!(result.unwrap_err(), DecodeError::AllMethodsFailed)); | ||
| } | ||
| } | ||
This file contains hidden or 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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It looks like this entire recipe thing is not part of our open-api integration somehow. this should be integrated with openapi.rs and then we can autogenerate the ts code. can you check how much work it is to do this the right way? if too much, we can do in a follow up
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not familiar with the open-api pieces. I can rectifying that in a future pr.