adjust /authenticate api

jhipster · Aug 23, 2024 · feaa9b8 · feaa9b8
1 parent eeb62e5
commit feaa9b8
Show file tree

Hide file tree

Showing 14 changed files with 90 additions and 102 deletions.
diff --git a/.github/labeler.yml b/.github/labeler.yml
@@ -75,7 +75,10 @@
   - changed-files:
       - any-glob-to-any-file:
           - generators/common/**
+          - generators/java/**/*
+          - generators/liquibase/**/*
           - generators/server/**/*
+          - generators/spring-*/**/*
 
 'theme: upgrade':
   - changed-files:

diff --git a/generators/app/__snapshots__/generator.spec.ts.snap b/generators/app/__snapshots__/generator.spec.ts.snap
@@ -585,6 +585,7 @@ exports[`generator - app with default config should match snapshot 1`] = `
   ],
   "liquibaseAddH2Properties": false,
   "liquibaseDefaultSchemaName": "",
+  "listOrFlux": "List",
   "lowercaseBaseName": "jhipster",
   "mainClass": "JhipsterApp",
   "mainJavaDir": "src/main/java/",
@@ -682,6 +683,8 @@ exports[`generator - app with default config should match snapshot 1`] = `
   },
   "nodePackageManager": "npm",
   "nodeVersion": "NODE_VERSION",
+  "optionalOrMono": "Optional",
+  "optionalOrMonoOfNullable": "Optional.ofNullable",
   "packageFolder": "com/mycompany/myapp/",
   "packageInfoJavadocs": [
     {
@@ -1197,6 +1200,7 @@ exports[`generator - app with gateway should match snapshot 1`] = `
   ],
   "liquibaseAddH2Properties": false,
   "liquibaseDefaultSchemaName": "",
+  "listOrFlux": "Flux",
   "lowercaseBaseName": "jhipster",
   "mainClass": "JhipsterApp",
   "mainJavaDir": "src/main/java/",
@@ -1294,6 +1298,8 @@ exports[`generator - app with gateway should match snapshot 1`] = `
   },
   "nodePackageManager": "npm",
   "nodeVersion": "NODE_VERSION",
+  "optionalOrMono": "Mono",
+  "optionalOrMonoOfNullable": "justOrEmpty",
   "packageFolder": "com/mycompany/myapp/",
   "packageInfoJavadocs": [
     {
@@ -1815,6 +1821,7 @@ exports[`generator - app with microservice should match snapshot 1`] = `
   ],
   "liquibaseAddH2Properties": false,
   "liquibaseDefaultSchemaName": "",
+  "listOrFlux": "List",
   "lowercaseBaseName": "jhipster",
   "mainClass": "JhipsterApp",
   "mainJavaDir": "src/main/java/",
@@ -1853,6 +1860,8 @@ exports[`generator - app with microservice should match snapshot 1`] = `
   },
   "nodePackageManager": "npm",
   "nodeVersion": "NODE_VERSION",
+  "optionalOrMono": "Optional",
+  "optionalOrMonoOfNullable": "Optional.ofNullable",
   "packageFolder": "com/mycompany/myapp/",
   "packageInfoJavadocs": [
     {

diff --git a/generators/base-application/types/entity.d.ts b/generators/base-application/types/entity.d.ts
@@ -128,6 +128,11 @@ type Entity = Required<BaseEntity> &
      */
     anyFieldHasFileBasedContentType: boolean;
 
+    /**
+     * Any relationship is required or id
+     */
+    anyRelationshipIsRequired: boolean;
+
     dtoMapstruct: boolean;
   };
 

diff --git a/generators/bootstrap-application-base/generator.ts b/generators/bootstrap-application-base/generator.ts
@@ -382,6 +382,9 @@ export default class BootstrapApplicationBase extends BaseApplicationGenerator {
 
   get postPreparingEachEntity() {
     return this.asPostPreparingEachEntityTaskGroup({
+      hasRequiredRelationship({ entity }) {
+        entity.anyRelationshipIsRequired = entity.relationships.some(rel => rel.relationshipRequired || rel.id);
+      },
       checkForCircularRelationships({ entity }) {
         const detectCyclicRequiredRelationship = (entity, relatedEntities) => {
           if (relatedEntities.has(entity)) return true;

diff --git a/generators/bootstrap-application/generator.spec.ts b/generators/bootstrap-application/generator.spec.ts
@@ -189,6 +189,7 @@ describe(`generator - ${generator}`, () => {
   "anyFieldIsUUID": true,
   "anyFieldIsZonedDateTime": false,
   "anyPropertyHasValidation": true,
+  "anyRelationshipIsRequired": false,
   "applicationType": "monolith",
   "auditableEntity": true,
   "authenticationType": "jwt",
@@ -1089,6 +1090,7 @@ describe(`generator - ${generator}`, () => {
   "anyFieldIsUUID": true,
   "anyFieldIsZonedDateTime": false,
   "anyPropertyHasValidation": false,
+  "anyRelationshipIsRequired": false,
   "applicationType": "monolith",
   "authenticationType": "jwt",
   "baseName": "jhipster",
@@ -1432,6 +1434,7 @@ describe(`generator - ${generator}`, () => {
   "anyFieldIsUUID": true,
   "anyFieldIsZonedDateTime": false,
   "anyPropertyHasValidation": false,
+  "anyRelationshipIsRequired": false,
   "applicationType": "monolith",
   "authenticationType": "jwt",
   "baseName": "jhipster",

diff --git a/generators/java/generators/bootstrap/generator.ts b/generators/java/generators/bootstrap/generator.ts
@@ -92,6 +92,13 @@ export default class BootstrapGenerator extends BaseApplicationGenerator {
             ...editFileCallback,
           );
       },
+      imperativeOrReactive({ applicationDefaults }) {
+        applicationDefaults({
+          optionalOrMono: ({ reactive }) => (reactive ? 'Mono' : 'Optional'),
+          optionalOrMonoOfNullable: ({ reactive }) => (reactive ? 'justOrEmpty' : 'Optional.ofNullable'),
+          listOrFlux: ({ reactive }) => (reactive ? 'Flux' : 'List'),
+        });
+      },
     });
   }
 

diff --git a/generators/server/types.d.ts b/generators/server/types.d.ts
@@ -107,6 +107,9 @@ export type SpringBootApplication = JavaApplication &
     skipCheckLengthOfIdentifier: boolean;
 
     imperativeOrReactive: string;
+    optionalOrMono: string;
+    optionalOrMonoOfNullable: string;
+    listOrFlux: string;
     generateAuthenticationApi?: boolean;
     generateInMemoryUserCredentials?: boolean;
 

diff --git a/generators/spring-boot/templates/src/main/java/_package_/web/rest/AccountResource.java.ejs b/generators/spring-boot/templates/src/main/java/_package_/web/rest/AccountResource.java.ejs
@@ -18,13 +18,13 @@
 -%>
 package <%= packageName %>.web.rest;
 
-  <%_ if (authenticationTypeSession && !reactive) { _%>
+<%_ if (authenticationTypeSession && !reactive) { _%>
 import <%= packageName %>.domain.PersistentToken;
 import <%= packageName %>.repository.PersistentTokenRepository;
-  <%_ } _%>
-  <%_ if (!reactive) { _%>
+<%_ } _%>
+<%_ if (!reactive) { _%>
 import <%= user.entityAbsoluteClass %>;
-  <%_ } _%>
+<%_ } _%>
 import <%= packageName %>.repository.UserRepository;
 import <%= packageName %>.security.SecurityUtils;
 import <%= packageName %>.service.MailService;
@@ -35,31 +35,23 @@ import <%= packageName %>.web.rest.errors.*;
 import <%= packageName %>.web.rest.vm.KeyAndPasswordVM;
 import <%= packageName %>.web.rest.vm.ManagedUserVM;
 
+import java.security.Principal;
 import org.apache.commons.lang3.StringUtils;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.http.HttpStatus;
 import org.springframework.web.bind.annotation.*;
-  <%_ if (reactive) { _%>
-import org.springframework.web.server.ServerWebExchange;
+<%_ if (reactive) { _%>
+import java.util.Objects;
 import reactor.core.publisher.Mono;
-  <%_ } _%>
-
-  <%_ if (!reactive && !authenticationTypeJwt) { _%>
-import jakarta.servlet.http.HttpServletRequest;
-  <%_ } _%>
+<%_ } else { _%>
+import java.util.*;
+<%_ } _%>
 import jakarta.validation.Valid;
-  <%_ if (authenticationTypeSession && !reactive) { _%>
+<%_ if (authenticationTypeSession && !reactive) { _%>
 import java.nio.charset.StandardCharsets;
 import java.net.URLDecoder;
-  <%_ } _%>
-  <%_ if (reactive) { _%>
-import java.security.Principal;
-import java.util.Objects;
-  <%_ } _%>
-  <%_ if (!reactive) { _%>
-import java.util.*;
-  <%_ } _%>
+<%_ } _%>
 
 /**
  * REST controller for managing the current user's account.
@@ -144,19 +136,13 @@ public class AccountResource {
     /**
      * {@code GET  /authenticate} : check if the user is authenticated, and return its login.
      *
-     * @param request the HTTP request.
+     * @param principal the authentication principal.
      * @return the login if the user is authenticated.
      */
     @GetMapping("/authenticate")
-    <%_ if (reactive) { _%>
-    public Mono<String> isAuthenticated(ServerWebExchange request) {
+    public <%- optionalOrMono %><String> isAuthenticated(Principal principal) {
         LOG.debug("REST request to check if the current user is authenticated");
-        return request.getPrincipal().map(Principal::getName);
-    <%_ } else { _%>
-    public String isAuthenticated(HttpServletRequest request) {
-        LOG.debug("REST request to check if the current user is authenticated");
-        return request.getRemoteUser();
-    <%_ } _%>
+        return <%- optionalOrMonoOfNullable %>(principal).map(Principal::getName);
     }
 
   <%_ } _%>

diff --git a/...rs/spring-boot/templates/src/main/java/_package_/web/rest/AccountResource_oauth2.java.ejs b/...rs/spring-boot/templates/src/main/java/_package_/web/rest/AccountResource_oauth2.java.ejs
@@ -24,21 +24,19 @@ import <%= packageName %>.security.SecurityUtils;
 import <%= packageName %>.service.UserService;
 import <%= packageName %>.service.dto.<%= user.adminUserDto %>;
 
+import java.security.Principal;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.security.authentication.AbstractAuthenticationToken;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RestController;
 <%_ if (reactive) { _%>
-import org.springframework.web.server.ServerWebExchange;
 import reactor.core.publisher.Mono;
 <%_ } else { _%>
-import jakarta.servlet.http.HttpServletRequest;
+import java.util.Optional;
 <%_ } _%>
 
-import java.security.Principal;
-
 /**
  * REST controller for managing the current user's account.
  */
@@ -82,18 +80,12 @@ public class AccountResource {
     /**
      * {@code GET  /authenticate} : check if the user is authenticated, and return its login.
      *
-     * @param request the HTTP request.
+     * @param principal the authentication principal.
      * @return the login if the user is authenticated.
      */
     @GetMapping("/authenticate")
-<%_ if (reactive) { _%>
-    public Mono<String> isAuthenticated(ServerWebExchange request) {
+    public <%- optionalOrMono %><String> isAuthenticated(Principal principal) {
         LOG.debug("REST request to check if the current user is authenticated");
-        return request.getPrincipal().map(Principal::getName);
-<%_ } else { _%>
-    public String isAuthenticated(HttpServletRequest request) {
-        LOG.debug("REST request to check if the current user is authenticated");
-        return request.getRemoteUser();
-<%_ } _%>
+        return <%- optionalOrMonoOfNullable %>(principal).map(Principal::getName);
     }
 }
diff --git a/...ot/templates/src/main/java/_package_/web/rest/AccountResource_skipUserManagement.java.ejs b/...ot/templates/src/main/java/_package_/web/rest/AccountResource_skipUserManagement.java.ejs
@@ -23,26 +23,21 @@ import <%= packageName %>.security.SecurityUtils;
 import <%= packageName %>.domain.Authority;
 
 <%_ } _%>
+
+import java.security.Principal;
 <%_ if (reactive) { _%>
 import reactor.core.publisher.Mono;
 <%_ } else { _%>
-import jakarta.servlet.http.HttpServletRequest;
+import java.util.Optional;
 <%_ } _%>
-
 <%_ if (authenticationTypeOauth2) { _%>
 import org.springframework.security.oauth2.client.authentication.OAuth2AuthenticationToken;
-  <%_ if (reactive) { _%>
-import org.springframework.web.server.ServerWebExchange;
-  <%_ } _%>
 <%_ } _%>
 <%_ if (authenticationTypeOauth2 || authenticationTypeJwt) { _%>
-import java.security.Principal;
 import org.springframework.security.oauth2.server.resource.authentication.JwtAuthenticationToken;
 import org.springframework.security.authentication.AbstractAuthenticationToken;
 <%_ } else { _%>
   <%_ if (reactive) { _%>
-import java.security.Principal;
-import org.springframework.web.server.ServerWebExchange;
 import org.springframework.security.core.context.ReactiveSecurityContextHolder;
 import org.springframework.security.core.context.SecurityContext;
 import org.springframework.security.core.userdetails.UserDetails;
@@ -147,19 +142,13 @@ public class AccountResource {
     /**
      * {@code GET  /authenticate} : check if the user is authenticated, and return its login.
      *
-     * @param request the HTTP request.
+     * @param principal the authentication principal.
      * @return the login if the user is authenticated.
      */
     @GetMapping("/authenticate")
-  <%_ if (reactive) { _%>
-    public Mono<String> isAuthenticated(ServerWebExchange request) {
+    public <%- optionalOrMono %><String> isAuthenticated(Principal principal) {
         LOG.debug("REST request to check if the current user is authenticated");
-        return request.getPrincipal().map(Principal::getName);
-  <%_ } else { _%>
-    public String isAuthenticated(HttpServletRequest request) {
-        LOG.debug("REST request to check if the current user is authenticated");
-        return request.getRemoteUser();
-  <%_ } _%>
+        return <%- optionalOrMonoOfNullable %>(principal).map(Principal::getName);
     }
 <%_ } _%>
 

diff --git a/...rs/spring-boot/templates/src/main/java/_package_/web/rest/AuthenticateController.java.ejs b/...rs/spring-boot/templates/src/main/java/_package_/web/rest/AuthenticateController.java.ejs
@@ -43,13 +43,12 @@ import org.springframework.security.oauth2.jwt.JwtClaimsSet;
 import org.springframework.security.oauth2.jwt.JwtEncoder;
 import org.springframework.security.oauth2.jwt.JwtEncoderParameters;
 import org.springframework.web.bind.annotation.*;
-<%_ if (reactive) { _%>
 import java.security.Principal;
+<%_ if (reactive) { _%>
 import reactor.core.publisher.Mono;
-import org.springframework.web.server.ServerWebExchange;
 import org.springframework.security.authentication.ReactiveAuthenticationManager;
 <%_ } else { _%>
-import jakarta.servlet.http.HttpServletRequest;
+import java.util.Optional;
 import org.springframework.security.config.annotation.authentication.builders.AuthenticationManagerBuilder;
 import org.springframework.security.core.context.SecurityContextHolder;
 <%_ } _%>
@@ -120,19 +119,13 @@ public class AuthenticateController {
     /**
      * {@code GET /authenticate} : check if the user is authenticated, and return its login.
      *
-     * @param request the HTTP request.
+     * @param principal the authentication principal.
      * @return the login if the user is authenticated.
      */
     @GetMapping("/authenticate")
-<%_ if (reactive) { _%>
-    public Mono<String> isAuthenticated(ServerWebExchange request) {
+    public <%- optionalOrMono %><String> isAuthenticated(Principal principal) {
         LOG.debug("REST request to check if the current user is authenticated");
-        return request.getPrincipal().map(Principal::getName);
-<%_ } else { _%>
-    public String isAuthenticated(HttpServletRequest request) {
-        LOG.debug("REST request to check if the current user is authenticated");
-        return request.getRemoteUser();
-<%_ } _%>
+        return <%- optionalOrMonoOfNullable %>(principal).map(Principal::getName);
     }
 
     public String createToken(Authentication authentication, boolean rememberMe) {

diff --git a/.../templates/src/test/java/_package_/_entityPackage_/web/rest/PublicUserResourceIT.java.ejs b/.../templates/src/test/java/_package_/_entityPackage_/web/rest/PublicUserResourceIT.java.ejs
@@ -75,9 +75,6 @@ import org.springframework.transaction.annotation.Transactional;
 import reactor.core.publisher.Mono;
 <%_ } _%>
 
-<%_ if (databaseTypeSql && !reactive) { _%>
-import jakarta.persistence.EntityManager;
-<%_ } _%>
 <%_ if (databaseTypeCassandra || databaseTypeCouchbase) { _%>
 import java.util.stream.Stream;
 <%_ } _%>
@@ -130,11 +127,6 @@ class PublicUserResourceIT {
     @Autowired
     private UserSearchRepository mockUserSearchRepository;
 <%_ } _%>
-<%_ if (databaseTypeSql) { _%>
-
-    @Autowired
-    private EntityManager em;
-<%_ } _%>
 <%_ if (cacheProviderAny) { _%>
 
     @Autowired
@@ -168,7 +160,7 @@ class PublicUserResourceIT {
 <%_ } _%>
     @BeforeEach
     public void initTest() {
-        user = UserResourceIT.initTestUser(<% if (databaseTypeSql) { %>em<% } %>);
+        user = UserResourceIT.initTestUser();
     }
 
     @AfterEach