Braze app config validations #9577
Merged
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
joaquincasal
approved these changes
Mar 19, 2025
| @@ -22,17 +22,51 @@ export interface AppInstallationParameters { | |||
|
|
|||
| export const BRAZE_DOCUMENTATION = | |||
| 'https://braze.com/docs/user_guide/personalization_and_dynamic_content/connected_content'; | |||
| export const CONTENTFUL_BASE_URL = 'https://cdn.contentful.com/spaces/'; | |||
There was a problem hiding this comment.
I think this can be obtained from the sdk if I remember correctly. sdk.hostnames or something like that 🤔
There was a problem hiding this comment.
Done! Now it is handled like this:
const url = `https://${sdk.hostnames.delivery}/spaces/${sdk.ids.space}`;
const response: Response = await callToContentful(url, newApiKey);
| const [parameters, setParameters] = useState<AppInstallationParameters>({ | ||
| apiKey: '', | ||
| }); | ||
| const sdk = useSDK<ConfigAppSDK>(); | ||
| const spaceId = sdk.ids.space; | ||
|
|
||
| async function apiKeyCheck(newApiKey: string) { |
There was a problem hiding this comment.
Just a suggestion, I'd rename this method and the argument
Suggested change
| async function apiKeyCheck(newApiKey: string) { | |
| async function checkApiKey(apiKey: string) { |
joaquincasal
approved these changes
Mar 20, 2025
mgoudy91
added a commit
that referenced
this pull request
Mar 25, 2025
* add base braze app * Add sidebar button (#9495) * [INTEG-2399] Braze app config screen (#9496) * adding main structure to configscreen * refactor: generic splitter * updating labels * adding configuration parameters on app instalation * adding tests fot the configuration screen * adding test to check if the link manage api key renders * adding test to check if the api key is set correctly * Fixing tests * removing comments * running prettier * adding placeholder --------- Co-authored-by: francobanfi <franco.banfi@external.contentful.com> * Braze liquid tags (#9556) * Assemble graphql query * Fix type for contentful-resolve-response * Refactor graphql query assembly * test for simple liquid tag generation * multiple liquid tag generation * test for asset liquid tag generation * new test for location and list of texts + refactor on basic field liquid tag generation test * removing test for list text * refactor to use a utils constant to generate location lat and long liquid tag * initial structure for polimorfic fields * Adding simple references and asset * Braze integ 2403 (#9545) * Display example response * Fix linter * Adding arrays of entries * refactor on the field type to generate the array liquid tags * new test and implementation for text array liquid tag generation * extracting methods refactor * skiping generation of rich text liquid tag * liquid tags for basic fields --------- Revert "addressing array types" This reverts commit d57c5e9. addressing array types Co-Authored-By: francobanfi <franco.banfi@external.contentful.com> Co-Authored-By: Juli Rossi <juliana.rossi@10pines.com> * Braze liquid tags complex array types (#9561) * addressing array types removing todo Revert "addressing array types" This reverts commit d57c5e9. addressing array types * test for nested entry references * array for basic fields * asset array liquid tag modification * Addressing tests errors * Fixing prettier * correcting pr comments --------- Co-authored-by: francobanfi <franco.banfi@external.contentful.com> * Setup dialog steps (#9557) * Setup dialog steps * Create components for each step * Allow to select locales * Complete types in tests * Add WizardFooter component * Braze app code block component (#9566) * wip code block component creation * Adding styles * Adding styles * styling code block * Updating styles * adding formating to the graphql response to ident the example json code block * Fixing indentation * Test * omiting richtext in the connected content call query and json * correcting an import * adding tests * changing the import of the react-syntax-highlighter * format import with prettier --------- Co-authored-by: Juli Rossi <juliana.rossi@10pines.com> * Braze refactor (#9565) * Add classes for each field type * Replace usage of field types with classes * Add and reorganize tests * Set max depth for nested fields * Separate Location and RichText from BasicField * Refactor: create Entry class * Add clarifying comments * Fix queries case (#9573) * Save content type id instead of name * Set first letter of content type to lowercase * Update apps/braze/src/utils.ts Co-authored-by: JuliRossi <juliana.rossi@10pines.com> --------- Co-authored-by: JuliRossi <juliana.rossi@10pines.com> * Braze app config validations (#9577) * config screen validation when api key is null * first version of the config screen validations * adding validation message to textinput * fixing test to work with validations * adding test for invalid api key * changes in the validations for the config screen * test to install the app when api key is invalid * using sdk to get the contentful base url * changing method name in config screen location * Braze app styles refactor (#9578) * changing the extensions for the style files * changing the extensions for the style files * correction of PR comments * Adding type password to the contentful api key input (#9588) * adding type password to the contentful api key input * removing braces * Braze app generate localize content (#9576) * WIP * Refactor * refactor * making better tests * Fix indentation * Fix initialization * Refactor * updating dependency (#9589) * Braze INTEG-2406: Allow to select entry fields (#9574) * Allow to select entry fields * Rename styles file * Apply margin to nested fields * Address PR comments * Display field name in checkbox * Address PR comments - Replace field.select and field.deselect with field.toggle - Extracted repeated logic into entry.selectedFields - Updated fields ids in tests * Update apps/braze/package.json Co-authored-by: Mitch Goudy <mgoudy91@gmail.com> * Update apps/braze/package.json --------- Co-authored-by: francobanfi <franco.banfi@external.contentful.com> Co-authored-by: JuliRossi <juliana.rossi@10pines.com> Co-authored-by: Franco Banfi <62450599+FBanfi@users.noreply.github.com> Co-authored-by: JuliRossi <juliana.rossi@external.contentful.com> Co-authored-by: Mitch Goudy <mgoudy91@gmail.com>
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.
Purpose
Adding validation in the config screen location in order not to allow the user to install the application if the api key is not valid.
Approach
There are two validations:
Note: This validations are done when the user click the install button.
Grabacion.de.pantalla.2025-03-19.a.la.s.12.05.52.p.m.mov
Testing
Dependencies and/or References
Link to INTEG-2404 ticket
Collaborators
Thanks @JuliRossi for helping and pairing.