feature: Creating database models with reverse database engineering provided by jpa buddy #72

KinTrae · 2024-12-09T23:17:28Z

It's a part of bigger changes, in the upcoming PR's and with promotor's insight there will a restructurization of the project, in the direction of DDD architeture.

In this PR:

successful creation of all database models using jpa buddy (with needed refactoring, cause it wasn't perfect)
refactor of existing code, so it now uses the created models
creation of enums that will reflect the databases 'dictionary' tables
dev test that shows successful creation of a user, sign-in, and post creation with all the changes mentioned above

Dev test: https://pejot.sharepoint.com/:w:/s/MeowHub/EZLwRwAB3gBBh4uXNHbpFr0B5XDrxO66kkOToV9K0jDD-A?e=3f4V7X

Task: 8696y76r9

JimTheCat · 2024-12-09T23:17:33Z

Task linked: CU-8696y76jy EPIC - API v3

JimTheCat · 2024-12-10T12:24:07Z

backend/src/main/java/meowhub/backend/security/services/impl/AuthServiceImpl.java

+                .postsPrivacy(publicSettings)
+                .friendsPrivacy(publicSettings)
+                .birthdate(request.getBirthdate())
+                .salt("salt")


You should create a salt implementation to generate actual things. :-(

JimTheCat · 2024-12-10T12:25:36Z

backend/src/main/java/meowhub/backend/jpa_buddy/UserToken.java

+    @JoinColumn(name = "USER_ID", nullable = false)
+    private User user;
+
+    @Size(max = 40)


I'm not sure if jwt token is that short. Please double check it

JimTheCat · 2024-12-10T12:27:23Z

backend/src/main/java/meowhub/backend/jpa_buddy/UserRelation.java

+    @NotNull
+    @Column(name = "ANSWER_DATE", nullable = false)


Annotation @NotNull and nullable attribute is redundant. Maybe let's choose how we are going to set if something is not nullable

It is not redundant, as they serve different purpose. @NotNull is bean validation and is used to validate that a property is not null at runtime during validation.
Nullable = false is a databae constraint.

…rovided by jpa buddy Task: 8696y76r9

sonarqubecloud · 2024-12-11T10:38:35Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

KinTrae · 2024-12-11T10:44:40Z

.github/workflows/maven.yml

@@ -32,4 +32,4 @@ jobs:
        distribution: 'temurin'
        cache: maven
    - name: Build with Maven
-      run: mvn -B package -Dspring.profiles.active=dev --file pom.xml
+      run: mvn -B package -Dspring.profiles.active=test --file pom.xml


i created a dedicated for tests test profile, and deleted the dev profile as it was no longer needed

JimTheCat · 2024-12-11T10:47:15Z

backend/src/main/java/meowhub/backend/jpa_buddy/User.java

+    @Override
+    public boolean equals(Object o) {
+        if (this == o) return true;
+        if (!(o instanceof User)) return false;
+        return id != null && id.equals(((User) o).getId());
+    }
+
+    @Override
+    public int hashCode() {
+        return getClass().hashCode();
+    }


Why don't you use @EqualsAndHashCode annotation? If they're not custom then please replace them

oh yeah, i thought u might look into it. As you can see, the equals function is overrided -> the object is only compared by its id. So i can't use @EqualsAndHashCode

Okay so it's fine ✨

KinTrae · 2024-12-11T10:50:16Z

backend/src/main/java/meowhub/backend/jpa_buddy/GroupchatMessage.java

+    @Column(name = "MSG_DATE", nullable = false)
+    private LocalDate msgDate;
+
+    @Column(name = "CREATED_AT")


you may have noticed, but i deleted @NotNull and nullable=false annotation for createdBy and createdAt.
These fields are populated by an audit trigger that is not visible from hibernate's perspective.
@NotNull was throwing an error, because it checks on application level before save, if the field is not null.
nullable = false was deleted, because when running tests for h2, (h2 database for tests is populated by hibernate with models) was throwing an exception, because the triggers are not created there. For production environment is still works correctly, as we are using database-first approach

Fair enough 😊

KinTrae · 2024-12-11T10:56:18Z

backend/src/main/java/meowhub/backend/jpa_buddy/UserToken.java

+    @Size(max = 512)
+    @Column(name = "TOKEN", length = 512)
+    private String token;
+


i modified the size of the column that will store tokens in the future. Currently, our token only stores user basic data and roles, and it will be more than enough. Token size monitoring is recommended in the future

KinTrae · 2024-12-11T11:00:23Z

backend/src/main/java/meowhub/backend/security/SecurityConfig.java

                user1.setName("Jan");
                user1.setSurname("Kos");
+                user1.setSalt("salt");


i am aware that this approach to hardcode salt is disgusting, but currently we don't have a working mechanism for it yet. Also, this task was meant only to create models with reverse database engineering and adjust the project so it can run with then smoothly.

The salt implementation will be provided in the future, it might be after delivering certain API's like posts API or profiles API though, as they have higher priority now.

KinTrae · 2024-12-11T11:01:13Z

backend/src/main/resources/application-swagger.properties

@@ -0,0 +1,2 @@
+springdoc.api-docs.enabled=true


i created a separate profile, just for swagger for clarity

KinTrae · 2024-12-11T11:02:40Z

backend/src/test/resources/create_schemas_h2.sql

+CREATE SCHEMA IF NOT EXISTS MH_USERS;
+CREATE SCHEMA IF NOT EXISTS MH_CHATS;
+CREATE SCHEMA IF NOT EXISTS MH_MATCHING;
+CREATE SCHEMA IF NOT EXISTS MH_POSTS;


needed init schema file, as the h2 db ran in create-drop mode does not have any recollection of used schema's for the tables and throws exceptions

KinTrae · 2024-12-11T11:03:33Z

backend/src/test/resources/application-test.properties

+spring.datasource.password=
+
+spring.sql.init.mode=always
+spring.sql.init.schema-locations=classpath:create_schemas_h2.sql


initialization of create schemas

JimTheCat · 2024-12-11T11:10:51Z

Green light!

KinTrae force-pushed the CU-8696y76jy_EPIC---API-v3_Kinga-Traczyk branch 4 times, most recently from 2c61db9 to dc72213 Compare December 10, 2024 12:22

JimTheCat requested changes Dec 10, 2024

View reviewed changes

feature: Creating database models with reverse database engineering p…

0364984

…rovided by jpa buddy Task: 8696y76r9

KinTrae force-pushed the CU-8696y76jy_EPIC---API-v3_Kinga-Traczyk branch from dc72213 to 0364984 Compare December 11, 2024 10:38

KinTrae commented Dec 11, 2024

View reviewed changes

JimTheCat requested changes Dec 11, 2024

View reviewed changes

KinTrae commented Dec 11, 2024

View reviewed changes

JimTheCat approved these changes Dec 11, 2024

View reviewed changes

KinTrae merged commit e42fb28 into dev Dec 11, 2024
9 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feature: Creating database models with reverse database engineering provided by jpa buddy #72

feature: Creating database models with reverse database engineering provided by jpa buddy #72

KinTrae commented Dec 9, 2024

JimTheCat commented Dec 9, 2024

JimTheCat Dec 10, 2024

JimTheCat Dec 10, 2024

JimTheCat Dec 10, 2024

KinTrae Dec 11, 2024

sonarqubecloud bot commented Dec 11, 2024

KinTrae Dec 11, 2024

JimTheCat Dec 11, 2024

JimTheCat Dec 11, 2024

KinTrae Dec 11, 2024

JimTheCat Dec 11, 2024

KinTrae Dec 11, 2024

JimTheCat Dec 11, 2024

KinTrae Dec 11, 2024

KinTrae Dec 11, 2024

KinTrae Dec 11, 2024

KinTrae Dec 11, 2024

KinTrae Dec 11, 2024

JimTheCat commented Dec 11, 2024

feature: Creating database models with reverse database engineering provided by jpa buddy #72

feature: Creating database models with reverse database engineering provided by jpa buddy #72

Conversation

KinTrae commented Dec 9, 2024

JimTheCat commented Dec 9, 2024

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

sonarqubecloud bot commented Dec 11, 2024

Quality Gate passed

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

Choose a reason for hiding this comment

JimTheCat commented Dec 11, 2024