Changes in data model and implementation of image scaling #199

albertobucesGdtl · 2025-01-20T13:15:21Z

Changes in data model

stm_tree

Added field tre_type
Added field tre_image_name

stm_tree_nod

Added field tno_type
Added field tno_image
Added field tno_image_name
Added field tno_view_mode
Added field tno_taskid
Added field tno_filterable

Implementation of image scaling (ImageTransformer.java)

fjlopez · 2025-01-20T16:28:18Z

src/main/java/org/sitmun/domain/tree/node/TreeNode.java

+
+  @JsonSetter("image")
+  public void imageDeserialize(String image) {
+	  this.image = ImageTransformer.scaleImage(image, type);


How do you ensure that the type field is set before the image field when the JSON is unmarshalled?

In the administration web, tree and tree node forms, the json sended when submit follows the defined structure in tree.model.ts and tree-node.model.ts respectively. So if type is defined before image in the model then the json will be equal.

So, Do this behaviour require two calls, one for creating the TreeNode in the database with the type and a second to update the image field? Please confirm.

What happens when the user do the following path:

Creates the node with some type

Uploads the image

Later, decide that is better to assign a different role to the node and changes the type

The @JsonSetter tag will be changed to @PrePersist and @PreUpdate to avoid the need to have the type value before the image in the json.
By this way the method is executed after the java object is completely created and before being saved in the database.

If the user changes the node type or deletes the image in the form, the image field is saved as null.

fjlopez · 2025-01-20T16:30:08Z

env/heroku/resources/config/liquibase/changelog/02_codelists/STM_CODELIST.csv

+111,application.type,APP Turística,false,false,app-turistica
+112,treenode.folder.type,Cartografía,false,true,cartography
+113,treenode.final.type,Cartografía,false,true,cartography
+114,treenode.folder.type,Menú,false,false,menu


menu and list are mentioned in ImageTransformer, and hence they must have COD_SYSTEM set to true

fjlopez · 2025-01-20T16:30:56Z

src/main/java/org/sitmun/infrastructure/utils/ImageTransformer.java

+				}
+				result = scaledImage != null ? encodeImageToBase64(scaledImage, imageFormat.toLowerCase()) : image;
+			} catch (Exception e) {
+				e.printStackTrace();


Use the standard logger.

fjlopez · 2025-01-20T16:34:57Z

src/main/java/org/sitmun/infrastructure/utils/ImageTransformer.java

+				e.printStackTrace();
+			}
+		}
+		return result;


Could you confirm that the expected logic is this:

The client sends an url, and the url matches the size expected to the type -> keep the url

The client sends an url, and the url does not matches the size expected to the type -> retrieve, resize and encode as data

The client sends a base64 array which encodes an image that matches the size -> encode as data

The client sends a base64 array which encodes an image that does not match the size -> resize and encode as data

Any missing case?

Those are the cases but I correct one of them:

The client sends a base64 array which encodes an image that matches the size -> keep the base64

When the base64 reaches the backend it is already in data protocol so it no needs any changes if it matches the size

Just to confirm, the first time that an image is uploaded in the application, do it will be sent with or without the data: prefix?

The image will be send with data: prefix

fjlopez · 2025-01-20T16:36:33Z

src/main/java/org/sitmun/infrastructure/utils/ImageTransformer.java

+                return reader.getFormatName(); // Retorna el formato, como "JPEG" o "PNG"
+            }
+        }
+        return DEFAULT_IMAGE_FORMAT; // No se pudo detectar


If the image cannot be detected, it could be anything (e.g. an excel file). This should be an error.

fjlopez · 2025-01-21T10:46:50Z

src/main/java/org/sitmun/infrastructure/utils/ImageTransformer.java

+import javax.imageio.ImageReader;
+import javax.imageio.stream.ImageInputStream;
+
+public class ImageTransformer {


Consider to turn this into a @Converter / AttributeConverter

The converter does not have access to the type attribute and that attribute is necessary to select the appropriate size of the image

fjlopez · 2025-01-21T10:47:28Z

src/main/java/org/sitmun/infrastructure/utils/ImageTransformer.java

+	private static final int DEFAULT_ICON_HEIGHT = 25;
+	private static final int DEFAULT_ICON_WIDTH = 25;
+	private static final int DEFAULT_APP_IMAGE_HEIGHT = 125;
+	private static final int DEFAULT_APP_IMAGE_WIDTH = 125;


Consider to use @Value annotations and allow to reconfigure externally

Alternativelly, you can use a @ConfigurationProperties with the following structure:

defaultImageFormat: String (and this should be a list of valid image formats!)

defaultWidth: Int

defaultHeight: Int

sizes: List<ImageConstaintProperty>

where ImageConstaintProperty contains

property: String

width: Int

height: Int

In this way, the code becomes independent of the effective values and also get simpler and maintainable.

fjlopez · 2025-01-21T10:48:11Z

src/main/java/org/sitmun/infrastructure/utils/ImageTransformer.java

+			int width = DEFAULT_APP_IMAGE_WIDTH;
+			int height = DEFAULT_APP_IMAGE_HEIGHT;
+
+			if ("menu".equals(type)) {


Document that menu and list are values from code lists.

fjlopez · 2025-01-22T11:34:09Z

src/main/java/org/sitmun/infrastructure/utils/ImageTransformer.java

+	private static final int DEFAULT_ICON_HEIGHT = 25;
+	private static final int DEFAULT_ICON_WIDTH = 25;
+	private static final int DEFAULT_APP_IMAGE_HEIGHT = 125;
+	private static final int DEFAULT_APP_IMAGE_WIDTH = 125;


Alternativelly, you can use a @ConfigurationProperties with the following structure:

defaultImageFormat: String (and this should be a list of valid image formats!)

defaultWidth: Int

defaultHeight: Int

sizes: List<ImageConstaintProperty>

where ImageConstaintProperty contains

property: String

width: Int

height: Int

In this way, the code becomes independent of the effective values and also get simpler and maintainable.

fjlopez · 2025-01-22T11:49:37Z

src/main/java/org/sitmun/infrastructure/utils/ImageTransformer.java

+					scaledImage = scaleImageFromBase64(image.split(",")[1], width, height);
+					imageFormat = image.substring(image.indexOf("/") + 1, image.indexOf(";"));
+				}
+				result = scaledImage != null ? encodeImageToBase64(scaledImage, imageFormat.toLowerCase()) : image;


The logic that I see here is:

When the URL starts with http you will always try to retrieve it.

Then you will check size and then resize to a standardised size according type.

But only will be stored in the database if it has been uploaded by the administrator app or if its has been resized to fit the dimensions

If it does not matches the standardised size, you will keep the original URL, even if the image with its size breaks the UI.

Why not

you check that the uploaded content or the url is effectively an image (using ImageIO)

resize if required or possible, e.g. if the image is a svg it cannot be resized but it can be encoded in data

compute the image format and validate it against a list of supported formats

store the result always as data, in base64 if the image is binary or as is if the image is svg

Also, confirm with the developer of the mobile application:

formats supported

if there is no problem in send the images embebed in the JSON configuration in base64

albertobucesGdtl · 2025-01-29T07:42:30Z

New changes:

Change tag @JsonSetter to @PrePersist and @PreUpdate in image attribute
ImageTransformer class is now a @service and includes image validations and errors control
Configurations for image scaling lie sizes and suported formats are obtains by ImageScalingProperties class (@ConfigurationProperties)

Changes in data model and implementation of image scaling

9e1b47c

albertobucesGdtl requested a review from fjlopez January 20, 2025 13:15

fjlopez reviewed Jan 20, 2025

View reviewed changes

fjlopez requested changes Jan 21, 2025

View reviewed changes

fjlopez requested changes Jan 22, 2025

View reviewed changes

Changes in image scaling

56a4c69

albertobucesGdtl requested a review from fjlopez January 29, 2025 07:47

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Changes in data model and implementation of image scaling #199

Changes in data model and implementation of image scaling #199

albertobucesGdtl commented Jan 20, 2025

fjlopez Jan 20, 2025

albertobucesGdtl Jan 21, 2025

fjlopez Jan 22, 2025 •

edited

Loading

albertobucesGdtl Jan 22, 2025

fjlopez Jan 20, 2025

fjlopez Jan 20, 2025

fjlopez Jan 20, 2025

albertobucesGdtl Jan 21, 2025 •

edited

Loading

fjlopez Jan 22, 2025

albertobucesGdtl Jan 23, 2025

fjlopez Jan 20, 2025

fjlopez Jan 21, 2025

albertobucesGdtl Jan 22, 2025

fjlopez Jan 21, 2025

fjlopez Jan 22, 2025

fjlopez Jan 21, 2025

fjlopez Jan 22, 2025

fjlopez Jan 22, 2025

albertobucesGdtl commented Jan 29, 2025

Changes in data model and implementation of image scaling #199

Are you sure you want to change the base?

Changes in data model and implementation of image scaling #199

Conversation

albertobucesGdtl commented Jan 20, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fjlopez Jan 22, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

albertobucesGdtl Jan 21, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

albertobucesGdtl commented Jan 29, 2025

fjlopez Jan 22, 2025 •

edited

Loading

albertobucesGdtl Jan 21, 2025 •

edited

Loading