HTM-1697: Add organisation field to user (#1418)

* HTM-1697: Add organisation field to user

* Update

Author: matthijsln

src/main/java/org/tailormap/api/controller/UserController.java

@@ -57,6 +57,8 @@ public ResponseEntity<Serializable> getUser() {
           .collect(Collectors.toSet()));
 
       if (authentication.getPrincipal() instanceof TailormapUserDetails userProperties) {
+        userResponse.setOrganisation(userProperties.getOrganisation());
+
         // Public user and group properties are meant for a (modified) frontend to implement custom
         // logic depending on who's logged in. When used for authorization for something, the check
         // should also be performed server-side, possibly in an extra microservice.

src/main/java/org/tailormap/api/persistence/User.java

@@ -54,6 +54,8 @@ public class User {
 
   private String name;
 
+  private String organisation;
+
   @Column(columnDefinition = "text")
   private String notes;
 
@@ -118,6 +120,15 @@ public User setName(String name) {
     return this;
   }
 
+  public String getOrganisation() {
+    return organisation;
+  }
+
+  public User setOrganisation(String organisation) {
+    this.organisation = organisation;
+    return this;
+  }
+
   public String getNotes() {
     return notes;
   }

src/main/java/org/tailormap/api/security/TailormapOidcUser.java

@@ -21,13 +21,17 @@ public class TailormapOidcUser extends DefaultOidcUser implements TailormapUserD
 
   private final Collection<TailormapAdditionalProperty> additionalGroupProperties;
 
+  private final String oidcRegistrationName;
+
   public TailormapOidcUser(
       Collection<? extends GrantedAuthority> authorities,
       OidcIdToken idToken,
       OidcUserInfo userInfo,
       String nameAttributeKey,
+      String oidcRegistrationName,
       Collection<TailormapAdditionalProperty> additionalGroupProperties) {
     super(authorities, idToken, userInfo, nameAttributeKey);
+    this.oidcRegistrationName = oidcRegistrationName;
     this.additionalGroupProperties = Collections.unmodifiableCollection(additionalGroupProperties);
   }
 
@@ -50,4 +54,9 @@ public String getPassword() {
   public String getUsername() {
     return super.getName();
   }
+
+  @Override
+  public String getOrganisation() {
+    return oidcRegistrationName;
+  }
 }

src/main/java/org/tailormap/api/security/TailormapOidcUserService.java

@@ -55,7 +55,14 @@ public OidcUser loadUser(OidcUserRequest userRequest) throws OAuth2Authenticatio
         .getUserInfoEndpoint()
         .getUserNameAttributeName();
 
+    String oidcRegistrationName = userRequest.getClientRegistration().getClientName();
+
     return new TailormapOidcUser(
-        authorities, user.getIdToken(), user.getUserInfo(), userNameAttributeName, groupProperties);
+        authorities,
+        user.getIdToken(),
+        user.getUserInfo(),
+        userNameAttributeName,
+        oidcRegistrationName,
+        groupProperties);
   }
 }

src/main/java/org/tailormap/api/security/TailormapUserDetails.java

@@ -33,4 +33,6 @@ default Stream<Object> streamAllPropertiesForKey(String key) {
         .filter(p -> p.key().equals(key))
         .map(TailormapAdditionalProperty::value);
   }
+
+  String getOrganisation();
 }

src/main/java/org/tailormap/api/security/TailormapUserDetailsImpl.java

@@ -30,6 +30,7 @@ class TailormapUserDetailsImpl implements TailormapUserDetails {
   private final String password;
   private final ZonedDateTime validUntil;
   private final boolean enabled;
+  private final String organisation;
 
   private final Collection<TailormapAdditionalProperty> additionalProperties = new ArrayList<>();
   private final Collection<TailormapAdditionalProperty> additionalGroupProperties = new ArrayList<>();
@@ -51,6 +52,7 @@ public TailormapUserDetailsImpl(User user, GroupRepository groupRepository) {
     password = user.getPassword();
     validUntil = user.getValidUntil();
     enabled = user.isEnabled();
+    organisation = user.getOrganisation();
 
     if (user.getAdditionalProperties() != null) {
       for (AdminAdditionalProperty property : user.getAdditionalProperties()) {
@@ -90,6 +92,11 @@ public boolean isEnabled() {
     return enabled;
   }
 
+  @Override
+  public String getOrganisation() {
+    return organisation;
+  }
+
   @Override
   public Collection<TailormapAdditionalProperty> getAdditionalProperties() {
     return additionalProperties;

src/main/resources/db/migration/V20__user_organisation.sql

@@ -0,0 +1 @@
+alter table users add organisation varchar(255);

src/main/resources/openapi/viewer-api.yaml

@@ -75,6 +75,9 @@ components:
         username:
           type: string
           description: 'username of the authenticated user'
+        organisation:
+          type: string
+          description: 'organisation of the authenticated user'
         roles:
           type: array
           uniqueItems: true

src/test/java/org/tailormap/api/controller/UserControllerIntegrationTest.java

@@ -79,6 +79,11 @@ public String getUsername() {
         return "tm-admin";
       }
 
+      @Override
+      public String getOrganisation() {
+        return null;
+      }
+
       @Override
       public Collection<TailormapAdditionalProperty> getAdditionalProperties() {
         return List.of(
@@ -103,6 +108,7 @@ public Collection<TailormapAdditionalProperty> getAdditionalGroupProperties() {
         .andExpect(content().contentType(MediaType.APPLICATION_JSON))
         .andExpect(jsonPath("$.isAuthenticated").value(true))
         .andExpect(jsonPath("$.username").value("tm-admin"))
+        .andExpect(jsonPath("$.organisation").isEmpty())
         .andExpect(jsonPath("$.roles.length()").value(3))
         .andExpect(jsonPath("$.roles").value(Matchers.containsInAnyOrder(Group.ADMIN, "test-bar", "test-baz")))
         .andExpect(jsonPath("$.properties.length()").value(1))