Andreas Svanberg
27204cba5e
The end purpose is to enable removal of entire threads. Previous attempts have failed, all because of something JPA/Hibernate related such as not-null constraint, transient/detached entities, or something else. The approach is to get rid of @Entitys throughout the system and use data transfer objects (DTOs) and to make the thread more of a central concept rather than an empty container with an "initial" post. This should allow a more dedicated "delete thread" method that can take care of all the issues instead of "is this the last post then do extra steps" which is causing the problems. Changing to DTOs will also align better with the technical future that the current developers want and have decided on "Never return @Entity classes from services" (https://gitea.dsv.su.se/DMC/scipro/wiki/Technical-future).
Working with the web GUI (Wicket)
The web GUI is protected by OAuth 2 log in. Run the Docker Compose containers with
docker compose up to start the authorization server to be able to log in.
If you run SciPro in development mode (DEV profile) you will be able to log in as the "default" OAuth 2 user populated in the upper form. If you have other data in your database you will have to use the lower form and specify a valid username in the principal field.
Working with the API
The API is protected by OAuth 2 acting as a resource server verifying tokens using token introspection.
When developing it uses a locally running instance of an
authorization server
that is run inside Docker. It can be started with docker compose -f docker-compose.yml up.
Since there is no frontend to interact with the authorization server there's a helper script in
GetToken.java that can be run directly with java GetToken.java to run through the authorization flow
and get an access token.
Once the token has been obtained go to the Swagger UI to interact with the API. Click the "Authorize" button in the top right and paste the access token to log in.
Code formatting
This project uses prettier-java
to format all Java code. To reformat the code run
./mvnw validate frontend:npm@reformat -pl ..
Yes it's a mouthful but unfortunately the prettier-maven-plugin
does not work due to an outstanding issue.
The formatting is validated by CI, but you should do it beforehand with a simple ./mvnw verify -pl ..
Making IntelliJ format for you
For this to work you also need to have Node.js
installed and configured under Settings -> Language & Frameworks -> Node.js
and the file you're saving must be able to compile otherwise no formatting
can be performed.
Go to Settings -> Language & Frameworks -> JavaScript -> Prettier and then check
Automatic Prettier Configuration, set Run for files to **/*.{java},
and finally check Run on save.
Test servers
All pull requests are automatically deployed to a test server. The URL to the test server will be posted as a comment in the pull request once deployed.
Prepare test data in the DataInitializer class to help others test your changes.
Document (in the pull request) which users to log in as and what to do to see the changes.
If you want to reset the data to its original state you can re-run the "deploy-branch.yaml" workflow at https://gitea.dsv.su.se/DMC/scipro/actions for the branch you want to reset.