Feature/1135 formatter

.github/workflows/format-action.yml

@@ -3,7 +3,7 @@ name: 'Format'
 on: [push]
 jobs:
 
-  Frontend:
+  frontend:
     runs-on: ubuntu-latest
     defaults:
       run:
@@ -15,33 +15,19 @@ jobs:
       - name: Setup Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: 22.10.0
+          node-version: ${{vars.NODE_VERSION}}
 
       - name: Npm install
         run: npm ci
 
       - name: Format frontend
-        run: npm run format
+        run: npm run check-linting:all
 
-      - name: Commit and Push formated frontend
-        shell: bash
-        env:
-          COMMITPREFIX: '[FM]'
-        run: |
-          git config --global user.email "[email protected]"
-          git config --global user.name "GitHub Actions"
-          git add . || {
-            echo "No files were changed, so we did not commit anything"
-            exit 1
-          }
-          git commit -m "$COMMITPREFIX Automated formating frontend" || {
-            echo "No changes to commit, skipping push"
-            exit 0
-          }
-          git push -f
-
-  Backend:
+  backend:
     runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: backend
     steps:
       - name: Checkout
         uses: actions/checkout@v4
@@ -55,21 +41,4 @@ jobs:
           settings-path: ${{github.workspace}}
 
       - name: Format backend
-        run: mvn formatter:format -f backend/pom.xml
-
-      - name: Commit and Push formated backend
-        shell: bash
-        env:
-          COMMITPREFIX: '[FM]'
-        run: |
-          git config --global user.email "[email protected]"
-          git config --global user.name "GitHub Actions"
-          git add . || {
-            echo "No files were changed, so we did not commit anything"
-            exit 1
-          }
-          git commit -m "$COMMITPREFIX Automated formating backend" || {
-            echo "No changes to commit, skipping push"
-            exit 0
-          }
-          git push -f
+        run: mvn spotless:check

backend/README.md

@@ -33,17 +33,23 @@ USING DOCKER
   - backend/target
 
 Formatting:
-- Check code formatting: `mvn formatter:validate`
-- Format the code: `mvn formatter:format`
+- Check code formatting: `mvn spotless:check`
+- Format the code: `mvn spotless:apply`
 
-The `compile` goal execute also a `formatter:format` goal.
+We also run the formatter with `spotless:apply` in the `compile` goal.
 
 Verify the Backend for coverage check:
 - `mvn clean verify`
 
 ## Formatting
-We use the **formatter-maven-plugin** Plugin for formatting the Java code:
-https://code.revelc.net/formatter-maven-plugin/
-
+We use the ***spotless*** Plugin for formatting the Java code:
+https://github.com/diffplug/spotless
+
+### How to update the spotless configuration using intelij:
+- Open `Go to Settings -> Editor -> Code styles -> Java` 
+- Select the default project config and export it to a file
+- Then make the changes you want to the code style config ***HIT APPLY*** and then export it to a file
+- Then run the following command `git --no-pager diff --no-index -U0 default.xml changed.xml | egrep '^\+' | diff-so-fancy` to see the changes
+- then copy all additions to the formatter file in the backend project
 ## Build
 _tbd_

backend/pom.xml

@@ -231,24 +231,29 @@
                 <artifactId>maven-surefire-plugin</artifactId>
                 <version>3.5.2</version>
             </plugin>
-
             <plugin>
-                <groupId>net.revelc.code.formatter</groupId>
-                <artifactId>formatter-maven-plugin</artifactId>
-                <version>2.24.1</version>
-                <configuration>
-                    <compilerSource>${maven.compiler.source}</compilerSource>
-                    <compilerCompliance>${maven.compiler.source}</compilerCompliance>
-                    <compilerTargetPlatform>${maven.compiler.source}</compilerTargetPlatform>
-                </configuration>
+                <groupId>com.diffplug.spotless</groupId>
+                <artifactId>spotless-maven-plugin</artifactId>
+                <version>2.43.0</version>
                 <executions>
                     <execution>
                         <id>code-format</id>
                         <goals>
-                            <goal>format</goal>
+                            <goal>apply</goal>
                         </goals>
                     </execution>
                 </executions>
+                <configuration>
+                    <java>
+                        <eclipse>
+                            <version>4.26</version>
+                            <file>${project.basedir}/src/main/resources/formatting.xml</file>
+<!--                            <file>${project.basedir}/src/main/resources/formatters/default.xml</file>-->
+                        </eclipse>
+                        <removeUnusedImports />
+                        <importOrder />
+                    </java>
+                </configuration>
             </plugin>
         </plugins>
     </build>
@@ -305,9 +310,9 @@
             <build>
                 <plugins>
                     <plugin>
-                        <groupId>net.revelc.code.formatter</groupId>
-                        <artifactId>formatter-maven-plugin</artifactId>
-                        <version>2.24.1</version>
+                        <groupId>com.diffplug.spotless</groupId>
+                        <artifactId>spotless-maven-plugin</artifactId>
+                        <version>2.43.0</version>
                         <executions>
                             <execution>
                                 <id>code-format</id>

backend/src/main/java/ch/puzzle/okr/Constants.java

@@ -1,12 +1,11 @@
 package ch.puzzle.okr;
 
+import static java.util.Map.entry;
+
 import ch.puzzle.okr.dto.checkin.*;
 import ch.puzzle.okr.dto.keyresult.*;
-
 import java.util.Map;
 
-import static java.util.Map.entry;
-
 public class Constants {
     private Constants() {
     }
@@ -29,11 +28,11 @@ private Constants() {
     public static final String CHECK_IN_KEY_RESULT_ID_ATTRIBUTE_NAME = "keyResultId";
     public static final String KEY_RESULT_TYPE_ATTRIBUTE_NAME = "keyResultType";
 
-    public static final Map<String, Class<? extends KeyResultDto>> KEY_RESULT_MAP = Map.ofEntries(
-            entry(KEY_RESULT_TYPE_METRIC, KeyResultMetricDto.class),
-            entry(KEY_RESULT_TYPE_ORDINAL, KeyResultOrdinalDto.class));
+    public static final Map<String, Class<? extends KeyResultDto>> KEY_RESULT_MAP = Map
+            .ofEntries(entry(KEY_RESULT_TYPE_METRIC, KeyResultMetricDto.class),
+                       entry(KEY_RESULT_TYPE_ORDINAL, KeyResultOrdinalDto.class));
 
-    public static final Map<String, Class<? extends CheckInDto>> CHECK_IN_MAP = Map.ofEntries(
-            entry(KEY_RESULT_TYPE_METRIC, CheckInMetricDto.class),
-            entry(KEY_RESULT_TYPE_ORDINAL, CheckInOrdinalDto.class));
+    public static final Map<String, Class<? extends CheckInDto>> CHECK_IN_MAP = Map
+            .ofEntries(entry(KEY_RESULT_TYPE_METRIC, CheckInMetricDto.class),
+                       entry(KEY_RESULT_TYPE_ORDINAL, CheckInOrdinalDto.class));
 }

backend/src/main/java/ch/puzzle/okr/ErrorKey.java

@@ -1,8 +1,22 @@
 package ch.puzzle.okr;
 
 public enum ErrorKey {
-    ATTRIBUTE_NULL, ATTRIBUTE_CHANGED, ATTRIBUTE_SET_FORBIDDEN, ATTRIBUTE_NOT_SET, ATTRIBUTE_CANNOT_CHANGE,
-    ATTRIBUTE_MUST_BE_DRAFT, KEY_RESULT_CONVERSION, ALREADY_EXISTS_SAME_NAME, CONVERT_TOKEN, DATA_HAS_BEEN_UPDATED,
-    MODEL_NULL, MODEL_WITH_ID_NOT_FOUND, NOT_AUTHORIZED_TO_READ, NOT_AUTHORIZED_TO_WRITE, NOT_AUTHORIZED_TO_DELETE,
-    TOKEN_NULL, TRIED_TO_DELETE_LAST_ADMIN, TRIED_TO_REMOVE_LAST_OKR_CHAMPION
+    ATTRIBUTE_NULL,
+    ATTRIBUTE_CHANGED,
+    ATTRIBUTE_SET_FORBIDDEN,
+    ATTRIBUTE_NOT_SET,
+    ATTRIBUTE_CANNOT_CHANGE,
+    ATTRIBUTE_MUST_BE_DRAFT,
+    KEY_RESULT_CONVERSION,
+    ALREADY_EXISTS_SAME_NAME,
+    CONVERT_TOKEN,
+    DATA_HAS_BEEN_UPDATED,
+    MODEL_NULL,
+    MODEL_WITH_ID_NOT_FOUND,
+    NOT_AUTHORIZED_TO_READ,
+    NOT_AUTHORIZED_TO_WRITE,
+    NOT_AUTHORIZED_TO_DELETE,
+    TOKEN_NULL,
+    TRIED_TO_DELETE_LAST_ADMIN,
+    TRIED_TO_REMOVE_LAST_OKR_CHAMPION
 }

backend/src/main/java/ch/puzzle/okr/ForwardFilter.java

@@ -5,14 +5,11 @@
 import jakarta.servlet.ServletRequest;
 import jakarta.servlet.ServletResponse;
 import jakarta.servlet.http.HttpServletRequest;
+import java.io.IOException;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
-import org.springframework.stereotype.Component;
 import org.springframework.web.filter.GenericFilterBean;
 
-import java.io.IOException;
-import java.util.Arrays;
-
 public class ForwardFilter extends GenericFilterBean {
 
     private static final Logger logger = LoggerFactory.getLogger(ForwardFilter.class);

backend/src/main/java/ch/puzzle/okr/OkrErrorAttributes.java

@@ -1,13 +1,12 @@
 package ch.puzzle.okr;
 
 import ch.puzzle.okr.exception.OkrResponseStatusException;
+import java.util.Map;
 import org.springframework.boot.web.error.ErrorAttributeOptions;
 import org.springframework.boot.web.servlet.error.DefaultErrorAttributes;
 import org.springframework.stereotype.Component;
 import org.springframework.web.context.request.WebRequest;
 
-import java.util.Map;
-
 @Component
 public class OkrErrorAttributes extends DefaultErrorAttributes {
 

backend/src/main/java/ch/puzzle/okr/OpenAPI30Configuration.java

@@ -12,9 +12,15 @@ public class OpenAPI30Configuration {
     @Bean
     public OpenAPI customizeOpenAPI() {
         final String securitySchemeName = "bearerAuth";
-        return new OpenAPI().addSecurityItem(new SecurityRequirement().addList(securitySchemeName))
-                .components(new Components().addSecuritySchemes(securitySchemeName, new SecurityScheme()
-                        .name(securitySchemeName).type(SecurityScheme.Type.HTTP).scheme("bearer").bearerFormat("JWT")));
+        return new OpenAPI()
+                .addSecurityItem(new SecurityRequirement().addList(securitySchemeName))
+                .components(new Components()
+                        .addSecuritySchemes(securitySchemeName,
+                                            new SecurityScheme()
+                                                    .name(securitySchemeName)
+                                                    .type(SecurityScheme.Type.HTTP)
+                                                    .scheme("bearer")
+                                                    .bearerFormat("JWT")));
     }
 
 }

backend/src/main/java/ch/puzzle/okr/SecurityConfig.java

@@ -1,5 +1,9 @@
 package ch.puzzle.okr;
 
+import static org.springframework.security.web.header.writers.CrossOriginEmbedderPolicyHeaderWriter.CrossOriginEmbedderPolicy.REQUIRE_CORP;
+import static org.springframework.security.web.header.writers.ReferrerPolicyHeaderWriter.ReferrerPolicy.NO_REFERRER;
+import static org.springframework.security.web.header.writers.XXssProtectionHeaderWriter.HeaderValue.ENABLED_MODE_BLOCK;
+
 import com.nimbusds.jose.proc.SecurityContext;
 import com.nimbusds.jwt.proc.ConfigurableJWTProcessor;
 import com.nimbusds.jwt.proc.DefaultJWTProcessor;
@@ -33,10 +37,6 @@
 import org.springframework.security.web.header.writers.CrossOriginResourcePolicyHeaderWriter;
 import org.springframework.security.web.header.writers.StaticHeadersWriter;
 
-import static org.springframework.security.web.header.writers.CrossOriginEmbedderPolicyHeaderWriter.CrossOriginEmbedderPolicy.REQUIRE_CORP;
-import static org.springframework.security.web.header.writers.ReferrerPolicyHeaderWriter.ReferrerPolicy.NO_REFERRER;
-import static org.springframework.security.web.header.writers.XXssProtectionHeaderWriter.HeaderValue.ENABLED_MODE_BLOCK;
-
 @Configuration
 @EnableWebSecurity
 @EnableMethodSecurity
@@ -58,10 +58,12 @@ public SecurityFilterChain apiSecurityFilterChain(HttpSecurity http, @Value("${c
         http.addFilterAfter(new ForwardFilter(), BasicAuthenticationFilter.class);
         logger.debug("*** apiSecurityFilterChain reached");
         setHeaders(http);
-        return http.cors(Customizer.withDefaults())
+        return http
+                .cors(Customizer.withDefaults())
                 .authorizeHttpRequests(e -> e.requestMatchers("/api/**").authenticated().anyRequest().permitAll())
                 .exceptionHandling(e -> e.authenticationEntryPoint(new HttpStatusEntryPoint(HttpStatus.UNAUTHORIZED)))
-                .oauth2ResourceServer(oauth2 -> oauth2.jwt(Customizer.withDefaults())).build();
+                .oauth2ResourceServer(oauth2 -> oauth2.jwt(Customizer.withDefaults()))
+                .build();
     }
 
     @Bean
@@ -75,14 +77,15 @@ JWTProcessor<SecurityContext> jwtProcessor(JWTClaimsSetAwareJWSKeySelector<Secur
     JwtDecoder jwtDecoder(JWTProcessor<SecurityContext> jwtProcessor, OAuth2TokenValidator<Jwt> jwtValidator) {
         NimbusJwtDecoder decoder = new NimbusJwtDecoder(jwtProcessor);
         OAuth2TokenValidator<Jwt> validator = new DelegatingOAuth2TokenValidator<>(JwtValidators.createDefault(),
-                jwtValidator);
+                                                                                   jwtValidator);
         decoder.setJwtValidator(validator);
         return decoder;
     }
 
     private HttpSecurity setHeaders(HttpSecurity http) throws Exception {
         return http
-                .headers(headers -> headers.contentSecurityPolicy(c -> c.policyDirectives(okrContentSecurityPolicy()))
+                .headers(headers -> headers
+                        .contentSecurityPolicy(c -> c.policyDirectives(okrContentSecurityPolicy()))
                         .crossOriginEmbedderPolicy(c -> c.policy(REQUIRE_CORP))
                         .crossOriginOpenerPolicy(c -> c.policy(OPENER_SAME_ORIGIN))
                         .crossOriginResourcePolicy(c -> c.policy(RESOURCE_SAME_ORIGIN))
@@ -96,32 +99,31 @@ private HttpSecurity setHeaders(HttpSecurity http) throws Exception {
 
     private String okrContentSecurityPolicy() {
         return "default-src 'self';" //
-                + "script-src 'self' 'unsafe-inline';" //
-                + "        style-src 'self' 'unsafe-inline';" //
-                + "        object-src 'none';" //
-                + "        base-uri 'self';" //
-                + "        connect-src 'self' " + connectSrc + ";" //
-                + "        font-src 'self';" //
-                + "        frame-src 'self';" //
-                + "        img-src 'self' data: ;" //
-                + "        manifest-src 'self';" //
-                + "        media-src 'self';" //
-                + "        worker-src 'none';"; //
+               + "script-src 'self' 'unsafe-inline';" //
+               + "        style-src 'self' 'unsafe-inline';" //
+               + "        object-src 'none';" //
+               + "        base-uri 'self';" //
+               + "        connect-src 'self' " + connectSrc + ";" //
+               + "        font-src 'self';" //
+               + "        frame-src 'self';" //
+               + "        img-src 'self' data: ;" //
+               + "        manifest-src 'self';" //
+               + "        media-src 'self';" //
+               + "        worker-src 'none';"; //
     }
 
     private String okrPermissionPolicy() {
         return "accelerometer=(), ambient-light-sensor=(), autoplay=(), "
-                + "battery=(), camera=(), cross-origin-isolated=(), display-capture=(), document-domain=(), encrypted-media=(), "
-                + "execution-while-not-rendered=(), execution-while-out-of-viewport=(), fullscreen=(),"
-                + " geolocation=(), gyroscope=(), keyboard-map=(), magnetometer=(), microphone=(), "
-                + "midi=(), navigation-override=(), payment=(), picture-in-picture=(),"
-                + " publickey-credentials-get=(), screen-wake-lock=(), sync-xhr=(self), "
-                + "usb=(), web-share=(), xr-spatial-tracking=()";
+               + "battery=(), camera=(), cross-origin-isolated=(), display-capture=(), document-domain=(), encrypted-media=(), "
+               + "execution-while-not-rendered=(), execution-while-out-of-viewport=(), fullscreen=(),"
+               + " geolocation=(), gyroscope=(), keyboard-map=(), magnetometer=(), microphone=(), "
+               + "midi=(), navigation-override=(), payment=(), picture-in-picture=(),"
+               + " publickey-credentials-get=(), screen-wake-lock=(), sync-xhr=(self), "
+               + "usb=(), web-share=(), xr-spatial-tracking=()";
     }
 
     @Bean
-    public AuthenticationEventPublisher authenticationEventPublisher(
-            ApplicationEventPublisher applicationEventPublisher) {
+    public AuthenticationEventPublisher authenticationEventPublisher(ApplicationEventPublisher applicationEventPublisher) {
         return new DefaultAuthenticationEventPublisher(applicationEventPublisher);
     }
 

backend/src/main/java/ch/puzzle/okr/UserKeyGenerator.java

@@ -2,10 +2,9 @@
 
 import ch.puzzle.okr.models.User;
 import ch.puzzle.okr.multitenancy.TenantContext;
-import org.springframework.cache.interceptor.KeyGenerator;
-
 import java.lang.reflect.Method;
 import java.text.MessageFormat;
+import org.springframework.cache.interceptor.KeyGenerator;
 
 public class UserKeyGenerator implements KeyGenerator {
     @Override