feat(api): add /api/v2/users and deprecate /api/v1/users

simplify the user DTO classes make api logout endpoint to version agnostic
gotson · Mar 3, 2022 · fa04d95 · fa04d95
1 parent f1ab136
commit fa04d95
Show file tree

Hide file tree

Showing 14 changed files with 508 additions and 71 deletions.
diff --git a/komga-webui/src/components/UsersList.vue b/komga-webui/src/components/UsersList.vue
@@ -142,15 +142,15 @@ export default Vue.extend({
     modalDeleteUser: false,
     userToDelete: {} as UserDto,
     modalEditSharedLibraries: false,
-    userToEditSharedLibraries: {} as UserWithSharedLibrariesDto,
+    userToEditSharedLibraries: {} as UserDto,
     modalEditUser: false,
     userToEdit: {} as UserDto,
     modalChangePassword: false,
     userToChangePassword: {} as UserDto,
     usersLastActivity: {} as any,
   }),
   computed: {
-    users(): UserWithSharedLibrariesDto[] {
+    users(): UserDto[] {
       return this.$store.state.komgaUsers.users
     },
     me(): UserDto {
@@ -175,7 +175,7 @@ export default Vue.extend({
       this.userToDelete = user
       this.modalDeleteUser = true
     },
-    editSharedLibraries(user: UserWithSharedLibrariesDto) {
+    editSharedLibraries(user: UserDto) {
       this.userToEditSharedLibraries = user
       this.modalEditSharedLibraries = true
     },

diff --git a/komga-webui/src/components/dialogs/UserEditDialog.vue b/komga-webui/src/components/dialogs/UserEditDialog.vue
@@ -104,11 +104,11 @@ export default Vue.extend({
     },
     async editUser() {
       try {
-        const roles = {
+        const patch = {
           roles: this.roles,
-        } as RolesUpdateDto
+        } as UserUpdateDto
 
-        await this.$store.dispatch('updateUserRoles', {userId: this.user.id, roles: roles})
+        await this.$store.dispatch('updateUser', {userId: this.user.id, patch: patch})
       } catch (e) {
         this.$eventHub.$emit(ERROR, {message: e.message} as ErrorEvent)
       }

diff --git a/komga-webui/src/components/dialogs/UserSharedLibrariesEditDialog.vue b/komga-webui/src/components/dialogs/UserSharedLibrariesEditDialog.vue
@@ -91,12 +91,12 @@ export default Vue.extend({
     },
   },
   methods: {
-    dialogReset(user: UserWithSharedLibrariesDto) {
+    dialogReset(user: UserDto) {
       this.allLibraries = user.sharedAllLibraries
       if (user.sharedAllLibraries) {
         this.selectedLibraries = this.libraries.map(x => x.id)
       } else {
-        this.selectedLibraries = user.sharedLibraries.map(x => x.id)
+        this.selectedLibraries = user.sharedLibrariesIds
       }
     },
     dialogCancel() {
@@ -110,12 +110,14 @@ export default Vue.extend({
     },
     async editUser() {
       try {
-        const sharedLibraries = {
-          all: this.allLibraries,
-          libraryIds: this.selectedLibraries,
-        } as SharedLibrariesUpdateDto
+        const patch = {
+          sharedLibraries: {
+            all: this.allLibraries,
+            libraryIds: this.selectedLibraries,
+          },
+        } as UserUpdateDto
 
-        await this.$store.dispatch('updateUserSharedLibraries', {user: this.user, sharedLibraries: sharedLibraries})
+        await this.$store.dispatch('updateUser', {userId: this.user.id, patch: patch})
       } catch (e) {
         this.$eventHub.$emit(ERROR, {message: e.message} as ErrorEvent)
       }

diff --git a/komga-webui/src/plugins/komga-users.plugin.ts b/komga-webui/src/plugins/komga-users.plugin.ts
@@ -9,7 +9,7 @@ let service: KomgaUsersService
 const vuexModule: Module<any, any> = {
   state: {
     me: {} as UserDto,
-    users: [] as UserWithSharedLibrariesDto[],
+    users: [] as UserDto[],
   },
   getters: {
     meAdmin: state => state.me.hasOwnProperty('roles') && state.me.roles.includes(UserRoles.ADMIN),
@@ -21,7 +21,7 @@ const vuexModule: Module<any, any> = {
     setMe (state, user: UserDto) {
       state.me = user
     },
-    setAllUsers (state, users: UserWithSharedLibrariesDto[]) {
+    setAllUsers (state, users: UserDto[]) {
       state.users = users
     },
   },
@@ -46,18 +46,14 @@ const vuexModule: Module<any, any> = {
       await service.postUser(user)
       dispatch('getAllUsers')
     },
-    async updateUserRoles ({ dispatch }, { userId, roles }: { userId: string, roles: RolesUpdateDto }) {
-      await service.patchUserRoles(userId, roles)
+    async updateUser ({ dispatch }, { userId, patch }: { userId: string, patch: UserUpdateDto }) {
+      await service.patchUser(userId, patch)
       dispatch('getAllUsers')
     },
     async deleteUser ({ dispatch }, user: UserDto) {
       await service.deleteUser(user)
       dispatch('getAllUsers')
     },
-    async updateUserSharedLibraries ({ dispatch }, { user, sharedLibraries }: { user: UserDto, sharedLibraries: SharedLibrariesUpdateDto }) {
-      await service.patchUserSharedLibraries(user, sharedLibraries)
-      dispatch('getAllUsers')
-    },
   },
 }
 

diff --git a/komga-webui/src/services/komga-users.service.ts b/komga-webui/src/services/komga-users.service.ts
@@ -2,7 +2,7 @@ import {AxiosInstance} from 'axios'
 
 const qs = require('qs')
 
-const API_USERS = '/api/v1/users'
+const API_USERS = '/api/v2/users'
 
 export default class KomgaUsersService {
   private http: AxiosInstance
@@ -50,7 +50,7 @@ export default class KomgaUsersService {
     }
   }
 
-  async getAll(): Promise<UserWithSharedLibrariesDto[]> {
+  async getAll(): Promise<UserDto[]> {
     try {
       return (await this.http.get(`${API_USERS}`)).data
     } catch (e) {
@@ -74,9 +74,9 @@ export default class KomgaUsersService {
     }
   }
 
-  async patchUserRoles(userId: string, roles: RolesUpdateDto): Promise<UserDto> {
+  async patchUser(userId: string, patch: UserUpdateDto) {
     try {
-      return (await this.http.patch(`${API_USERS}/${userId}`, roles)).data
+      await this.http.patch(`${API_USERS}/${userId}`, patch)
     } catch (e) {
       let msg = `An error occurred while trying to patch user '${userId}'`
       if (e.response.data.message) {
@@ -100,7 +100,7 @@ export default class KomgaUsersService {
 
   async patchUserPassword(user: UserDto, newPassword: PasswordUpdateDto) {
     try {
-      return (await this.http.patch(`${API_USERS}/${user.id}/password`, newPassword)).data
+      await this.http.patch(`${API_USERS}/${user.id}/password`, newPassword)
     } catch (e) {
       let msg = `An error occurred while trying to update password for user ${user.email}`
       if (e.response.data.message) {
@@ -110,21 +110,9 @@ export default class KomgaUsersService {
     }
   }
 
-  async patchUserSharedLibraries(user: UserDto, sharedLibrariesUpdateDto: SharedLibrariesUpdateDto) {
-    try {
-      return (await this.http.patch(`${API_USERS}/${user.id}/shared-libraries`, sharedLibrariesUpdateDto)).data
-    } catch (e) {
-      let msg = `An error occurred while trying to update shared libraries for user ${user.email}`
-      if (e.response.data.message) {
-        msg += `: ${e.response.data.message}`
-      }
-      throw new Error(msg)
-    }
-  }
-
   async logout() {
     try {
-      await this.http.post(`${API_USERS}/logout`)
+      await this.http.post('api/logout')
     } catch (e) {
       let msg = 'An error occurred while trying to logout'
       if (e.response.data.message) {

diff --git a/komga-webui/src/types/komga-users.ts b/komga-webui/src/types/komga-users.ts
@@ -1,19 +1,9 @@
 interface UserDto {
-  id: string,
-  email: string,
-  roles: string[]
-}
-
-interface UserWithSharedLibrariesDto {
   id: string,
   email: string,
   roles: string[],
   sharedAllLibraries: boolean,
-  sharedLibraries: SharedLibraryDto[]
-}
-
-interface SharedLibraryDto {
-  id: string
+  sharedLibrariesIds: string[]
 }
 
 interface UserCreationDto {
@@ -25,13 +15,12 @@ interface PasswordUpdateDto {
   password: string
 }
 
-interface SharedLibrariesUpdateDto {
-  all: boolean,
-  libraryIds: string[]
-}
-
-interface RolesUpdateDto {
-  roles: string[]
+interface UserUpdateDto {
+  roles?: string[],
+  sharedLibraries?: {
+    all: boolean,
+    libraryIds: string[]
+  },
 }
 
 interface AuthenticationActivityDto {

diff --git a/komga/src/main/kotlin/org/gotson/komga/infrastructure/security/SecurityConfiguration.kt b/komga/src/main/kotlin/org/gotson/komga/infrastructure/security/SecurityConfiguration.kt
@@ -67,7 +67,7 @@ class SecurityConfiguration(
         it.authenticationDetailsSource(userAgentWebAuthenticationDetailsSource)
       }
       .logout {
-        it.logoutUrl("/api/v1/users/logout")
+        it.logoutUrl("/api/logout")
         it.deleteCookies(sessionCookieName)
         it.invalidateHttpSession(true)
       }

diff --git a/komga/src/main/kotlin/org/gotson/komga/interfaces/api/rest/ClaimController.kt b/komga/src/main/kotlin/org/gotson/komga/interfaces/api/rest/ClaimController.kt
@@ -2,8 +2,8 @@ package org.gotson.komga.interfaces.api.rest
 
 import org.gotson.komga.domain.model.KomgaUser
 import org.gotson.komga.domain.service.KomgaUserLifecycle
-import org.gotson.komga.interfaces.api.rest.dto.UserDto
-import org.gotson.komga.interfaces.api.rest.dto.toDto
+import org.gotson.komga.interfaces.api.rest.dto.UserDtoV2
+import org.gotson.komga.interfaces.api.rest.dto.toDtoV2
 import org.springframework.http.HttpStatus
 import org.springframework.http.MediaType
 import org.springframework.validation.annotation.Validated
@@ -30,7 +30,7 @@ class ClaimController(
   fun claimAdmin(
     @Email(regexp = ".+@.+\\..+") @RequestHeader("X-Komga-Email") email: String,
     @NotBlank @RequestHeader("X-Komga-Password") password: String,
-  ): UserDto {
+  ): UserDtoV2 {
     if (userDetailsLifecycle.countUsers() > 0)
       throw ResponseStatusException(HttpStatus.BAD_REQUEST, "This server has already been claimed")
 
@@ -40,7 +40,7 @@ class ClaimController(
         password = password,
         roleAdmin = true,
       ),
-    ).toDto()
+    ).toDtoV2()
   }
 
   data class ClaimStatus(

diff --git a/...mga/interfaces/api/rest/UserController.kt → ...a/interfaces/api/rest/UserV1Controller.kt b/...mga/interfaces/api/rest/UserController.kt → ...a/interfaces/api/rest/UserV1Controller.kt
@@ -1,3 +1,5 @@
+@file:Suppress("DEPRECATION")
+
 package org.gotson.komga.interfaces.api.rest
 
 import io.swagger.v3.oas.annotations.Parameter
@@ -46,9 +48,10 @@ import javax.validation.Valid
 
 private val logger = KotlinLogging.logger {}
 
+@Deprecated("User api/v2/users instead")
 @RestController
 @RequestMapping("api/v1/users", produces = [MediaType.APPLICATION_JSON_VALUE])
-class UserController(
+class UserV1Controller(
   private val userLifecycle: KomgaUserLifecycle,
   private val userRepository: KomgaUserRepository,
   private val libraryRepository: LibraryRepository,
@@ -59,10 +62,12 @@ class UserController(
   private val demo = env.activeProfiles.contains("demo")
 
   @GetMapping("me")
+  @Deprecated("User api/v2/users instead")
   fun getMe(@AuthenticationPrincipal principal: KomgaPrincipal): UserDto =
     principal.user.toDto()
 
   @PatchMapping("me/password")
+  @Deprecated("User api/v2/users instead")
   @ResponseStatus(HttpStatus.NO_CONTENT)
   fun updateMyPassword(
     @AuthenticationPrincipal principal: KomgaPrincipal,
@@ -76,12 +81,14 @@ class UserController(
 
   @GetMapping
   @PreAuthorize("hasRole('$ROLE_ADMIN')")
+  @Deprecated("User api/v2/users instead")
   fun getAll(): List<UserWithSharedLibrariesDto> =
     userRepository.findAll().map { it.toWithSharedLibrariesDto() }
 
   @PostMapping
   @ResponseStatus(HttpStatus.CREATED)
   @PreAuthorize("hasRole('$ROLE_ADMIN')")
+  @Deprecated("User api/v2/users instead")
   fun addOne(@Valid @RequestBody newUser: UserCreationDto): UserDto =
     try {
       userLifecycle.createUser(newUser.toDomain()).toDto()
@@ -92,6 +99,7 @@ class UserController(
   @DeleteMapping("{id}")
   @ResponseStatus(HttpStatus.NO_CONTENT)
   @PreAuthorize("hasRole('$ROLE_ADMIN') and #principal.user.id != #id")
+  @Deprecated("User api/v2/users instead")
   fun delete(
     @PathVariable id: String,
     @AuthenticationPrincipal principal: KomgaPrincipal,
@@ -104,6 +112,7 @@ class UserController(
   @PatchMapping("{id}")
   @ResponseStatus(HttpStatus.NO_CONTENT)
   @PreAuthorize("hasRole('$ROLE_ADMIN') and #principal.user.id != #id")
+  @Deprecated("User api/v2/users instead")
   fun updateUserRoles(
     @PathVariable id: String,
     @Valid @RequestBody patch: RolesUpdateDto,
@@ -123,6 +132,7 @@ class UserController(
   @PatchMapping("{id}/password")
   @ResponseStatus(HttpStatus.NO_CONTENT)
   @PreAuthorize("hasRole('$ROLE_ADMIN') or #principal.user.id == #id")
+  @Deprecated("User api/v2/users instead")
   fun updatePassword(
     @PathVariable id: String,
     @AuthenticationPrincipal principal: KomgaPrincipal,
@@ -137,6 +147,7 @@ class UserController(
   @PatchMapping("{id}/shared-libraries")
   @ResponseStatus(HttpStatus.NO_CONTENT)
   @PreAuthorize("hasRole('$ROLE_ADMIN')")
+  @Deprecated("User api/v2/users instead")
   fun updateSharesLibraries(
     @PathVariable id: String,
     @Valid @RequestBody sharedLibrariesUpdateDto: SharedLibrariesUpdateDto,
@@ -156,6 +167,7 @@ class UserController(
 
   @GetMapping("me/authentication-activity")
   @PageableAsQueryParam
+  @Deprecated("User api/v2/users instead")
   fun getMyAuthenticationActivity(
     @AuthenticationPrincipal principal: KomgaPrincipal,
     @RequestParam(name = "unpaged", required = false) unpaged: Boolean = false,
@@ -180,6 +192,7 @@ class UserController(
   @GetMapping("authentication-activity")
   @PageableAsQueryParam
   @PreAuthorize("hasRole('$ROLE_ADMIN')")
+  @Deprecated("User api/v2/users instead")
   fun getAuthenticationActivity(
     @RequestParam(name = "unpaged", required = false) unpaged: Boolean = false,
     @Parameter(hidden = true) page: Pageable,
@@ -201,6 +214,7 @@ class UserController(
 
   @GetMapping("{id}/authentication-activity/latest")
   @PreAuthorize("hasRole('$ROLE_ADMIN') or #principal.user.id == #id")
+  @Deprecated("User api/v2/users instead")
   fun getLatestAuthenticationActivityForUser(
     @PathVariable id: String,
     @AuthenticationPrincipal principal: KomgaPrincipal,