Braze refactor #9565

joaquincasal · 2025-03-17T12:29:46Z

Purpose

Replace field types with classes for easier usage.

Approach

There's a class for each field type. Each class knows how to generate their part of the graphql query and also the liquid tags.

Testing steps

Automated steps were added.

Breaking Changes

Types are no longer available, the new classes should be used instead.

Dependencies and/or References

N/A

Deployment

N/A

joaquincasal · 2025-03-17T18:57:54Z

apps/braze/src/fields/BasicField.ts

+    switch (this.type) {
+      case 'RichText':
+        return '';
+      case 'Location':


Move to another class

joaquincasal · 2025-03-17T19:06:15Z

apps/braze/src/helpers/assembleQuery.ts

@@ -107,69 +34,5 @@ export function assembleQuery(contentTypeId: string, entryId: string, entryField
 }

 function assembleFieldsQuery(entryFields: Field[]): string {


Maybe move this logic into a Entry class?

joaquincasal · 2025-03-17T19:09:48Z

apps/braze/src/helpers/assembleQuery.ts

@@ -96,9 +26,6 @@ export async function getGraphQLResponse(spaceId: string, token: string, query:
    },
    body: query,
  });
-  if (!response.ok) {
-    return null;
-  }
  return response.json();


Maybe add the indication that the request failed, so we can show it accordingly in the third code block

JuliRossi · 2025-03-18T13:11:50Z

apps/braze/src/fields/BasicField.ts

@@ -0,0 +1,15 @@
+import { Field } from './Field';
+
+export class BasicField extends Field {


nit: I think we should add a comment specifying which are the "BasicFields" (Symbol, number, decimal, date, bool, json, Text, etc) for future reference.

JuliRossi

Incredible work Joa! The code really needed this refactor. Added a few no-blocking comments.

JuliRossi · 2025-03-18T13:20:01Z

apps/braze/src/fields/AssetArrayField.ts

+    this.id = id;
+    this.localized = localized;


nit: I think these aren't needed

they are! the id is used in line 12 of the class and the localized property is used outside of it to determine if any of the fields of the entry are localized

JuliRossi · 2025-03-18T13:25:10Z

apps/braze/src/fields/RichTextField.ts

@@ -0,0 +1,15 @@
+import { Field } from './Field';
+
+export class RichTextField extends Field {


:nit: I'd add a comment here saying, we are not handling rich text for now.

* 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>

joaquincasal added 3 commits March 17, 2025 09:19

Add classes for each field type

04432ca

Replace usage of field types with classes

b5c69bd

Add and reorganize tests

914b144

joaquincasal requested a review from a team as a code owner March 17, 2025 12:29

Set max depth for nested fields

bc10129

joaquincasal commented Mar 17, 2025

View reviewed changes

Merge branch 'braze-integ-2407' into braze-refactor

7e956c7

Base automatically changed from braze-integ-2407 to braze-app March 17, 2025 20:44

joaquincasal added 2 commits March 17, 2025 18:16

Separate Location and RichText from BasicField

b763a52

Refactor: create Entry class

70fc933

JuliRossi reviewed Mar 18, 2025

View reviewed changes

JuliRossi approved these changes Mar 18, 2025

View reviewed changes

Add clarifying comments

b2afbfa

joaquincasal merged commit ac0edce into braze-app Mar 18, 2025
10 checks passed

joaquincasal deleted the braze-refactor branch March 18, 2025 15:33

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Braze refactor #9565

Braze refactor #9565

joaquincasal commented Mar 17, 2025

joaquincasal Mar 17, 2025

joaquincasal Mar 17, 2025

joaquincasal Mar 17, 2025

JuliRossi Mar 18, 2025

JuliRossi left a comment

JuliRossi Mar 18, 2025

joaquincasal Mar 18, 2025

JuliRossi Mar 18, 2025

		@@ -107,69 +34,5 @@ export function assembleQuery(contentTypeId: string, entryId: string, entryField
		}

		function assembleFieldsQuery(entryFields: Field[]): string {

		@@ -0,0 +1,15 @@
		import { Field } from './Field';

		export class BasicField extends Field {

		@@ -0,0 +1,15 @@
		import { Field } from './Field';

		export class RichTextField extends Field {

Braze refactor #9565

Braze refactor #9565

Conversation

joaquincasal commented Mar 17, 2025

Purpose

Approach

Testing steps

Breaking Changes

Dependencies and/or References

Deployment

joaquincasal Mar 17, 2025

Choose a reason for hiding this comment

joaquincasal Mar 17, 2025

Choose a reason for hiding this comment

joaquincasal Mar 17, 2025

Choose a reason for hiding this comment

JuliRossi Mar 18, 2025

Choose a reason for hiding this comment

JuliRossi left a comment

Choose a reason for hiding this comment

JuliRossi Mar 18, 2025

Choose a reason for hiding this comment

joaquincasal Mar 18, 2025

Choose a reason for hiding this comment

JuliRossi Mar 18, 2025

Choose a reason for hiding this comment