Merge pull request #187 from Poeschl/add-user-registration-setting

Poeschl · web-flow · commit 6e5eee743115 · 2024-08-03T15:25:46.000+02:00
✨ Add setting for disabling user registration
diff --git a/backend/src/main/kotlin/xyz/poeschl/roborush/controller/ConfigRestController.kt b/backend/src/main/kotlin/xyz/poeschl/roborush/controller/ConfigRestController.kt
@@ -125,7 +125,8 @@ class ConfigRestController(private val configService: ConfigService, private val
   fun getClientSettings(): ClientSettings {
     return ClientSettings(
       configService.getGlobalNotificationText(),
-      configService.getBooleanSetting(SettingKey.ENABLE_WEB_ROBOT_CONTROL).value
+      configService.getBooleanSetting(SettingKey.ENABLE_WEB_ROBOT_CONTROL).value,
+      configService.getBooleanSetting(SettingKey.ENABLE_USER_REGISTRATION).value
     )
   }
 }
diff --git a/backend/src/main/kotlin/xyz/poeschl/roborush/models/settings/Setting.kt b/backend/src/main/kotlin/xyz/poeschl/roborush/models/settings/Setting.kt
@@ -35,7 +35,8 @@ enum class SettingKey(@JsonIgnore val isFrontendSetting: Boolean = false) {
   ENABLE_FULL_MAP_SCAN,
   ENABLE_DUMMY_ROBOTS,
   ENABLE_WEB_ROBOT_CONTROL(isFrontendSetting = true),
-  DISTANCE_ROBOT_SIGHT_ON_MOVE
+  DISTANCE_ROBOT_SIGHT_ON_MOVE,
+  ENABLE_USER_REGISTRATION(isFrontendSetting = true)
 }
 
 enum class SettingType {
@@ -44,4 +45,4 @@ enum class SettingType {
   BOOLEAN
 }
 
-data class ClientSettings(val globalNotificationText: String, val enableWebRobotControl: Boolean)
+data class ClientSettings(val globalNotificationText: String, val enableWebRobotControl: Boolean, val enableUserRegistration: Boolean)
diff --git a/backend/src/main/kotlin/xyz/poeschl/roborush/security/restcontroller/AuthRestController.kt b/backend/src/main/kotlin/xyz/poeschl/roborush/security/restcontroller/AuthRestController.kt
@@ -9,16 +9,22 @@ import org.springframework.security.authentication.AuthenticationManager
 import org.springframework.security.authentication.UsernamePasswordAuthenticationToken
 import org.springframework.security.core.Authentication
 import org.springframework.security.core.context.SecurityContextHolder
-import org.springframework.web.bind.annotation.*
+import org.springframework.web.bind.annotation.PostMapping
+import org.springframework.web.bind.annotation.RequestBody
+import org.springframework.web.bind.annotation.RequestMapping
+import org.springframework.web.bind.annotation.RestController
+import xyz.poeschl.roborush.models.settings.SettingKey
 import xyz.poeschl.roborush.security.service.UserDetailsService
 import xyz.poeschl.roborush.security.utils.JwtTokenProvider
+import xyz.poeschl.roborush.service.ConfigService
 
 @RestController
 @RequestMapping("/auth")
 class AuthRestController(
   private val authenticationManager: AuthenticationManager,
   private val jwtTokenProvider: JwtTokenProvider,
-  private val userDetailsService: UserDetailsService
+  private val userDetailsService: UserDetailsService,
+  private val configService: ConfigService
 ) {
 
   companion object {
@@ -40,12 +46,19 @@ class AuthRestController(
 
   @PostMapping("/register", produces = [MediaType.APPLICATION_JSON_VALUE], consumes = [MediaType.APPLICATION_JSON_VALUE])
   fun registerUser(@RequestBody registerRequest: RegisterRequest): ResponseEntity<Void> {
-    try {
-      userDetailsService.registerNewUser(registerRequest.username, registerRequest.password)
-    } catch (ex: DataIntegrityViolationException) {
-      LOGGER.warn("Username '${registerRequest.username}' is already taken. Registration not possible")
-      return ResponseEntity.status(HttpStatus.CONFLICT).build()
+    if (registerRequest.username.length > 3 &&
+      registerRequest.password.length > 8 &&
+      configService.getBooleanSetting(SettingKey.ENABLE_USER_REGISTRATION).value
+    ) {
+      try {
+        userDetailsService.registerNewUser(registerRequest.username, registerRequest.password)
+      } catch (ex: DataIntegrityViolationException) {
+        LOGGER.warn("Username '${registerRequest.username}' is already taken. Registration not possible")
+        return ResponseEntity.status(HttpStatus.CONFLICT).build()
+      }
+      return ResponseEntity.ok().build()
+    } else {
+      return ResponseEntity.badRequest().build()
     }
-    return ResponseEntity.ok().build()
   }
 }
diff --git a/backend/src/main/kotlin/xyz/poeschl/roborush/service/ConfigService.kt b/backend/src/main/kotlin/xyz/poeschl/roborush/service/ConfigService.kt
@@ -62,7 +62,8 @@ class ConfigService(
     websocketController.sendClientSettingsUpdate(
       ClientSettings(
         globalNotificationText,
-        getBooleanSetting(SettingKey.ENABLE_FULL_MAP_SCAN).value
+        getBooleanSetting(SettingKey.ENABLE_FULL_MAP_SCAN).value,
+        getBooleanSetting(SettingKey.ENABLE_USER_REGISTRATION).value
       )
     )
   }
diff --git a/backend/src/main/resources/db/migration/V1_002__create_config_schemas.sql b/backend/src/main/resources/db/migration/V1_002__create_config_schemas.sql
@@ -17,3 +17,4 @@ INSERT INTO config (key, type, value) values ('ENABLE_FULL_MAP_SCAN', 'BOOLEAN',
 INSERT INTO config (key, type, value) values ('ENABLE_DUMMY_ROBOTS', 'BOOLEAN', 'true');
 INSERT INTO config (key, type, value) values ('ENABLE_WEB_ROBOT_CONTROL', 'BOOLEAN', 'true');
 INSERT INTO config (key, type, value) values ('DISTANCE_ROBOT_SIGHT_ON_MOVE', 'INT', '2');
+INSERT INTO config (key, type, value) values ('ENABLE_USER_REGISTRATION', 'BOOLEAN', 'true');
diff --git a/backend/src/test/kotlin/xyz/poeschl/roborush/DBMigrationIntegrityTest.kt b/backend/src/test/kotlin/xyz/poeschl/roborush/DBMigrationIntegrityTest.kt
@@ -29,7 +29,7 @@ class DBMigrationIntegrityTest {
     .withHashAlgorithm(HashAlgorithm.MD5)
     .withHashPair("V1_000__create_user_schemas.sql", "5982877bb3946da9beea4e57f4d1f57e")
     .withHashPair("V1_001__create_robot_schemas.sql", "6b37f4a87fa7ff214b3f61b997cc83c4")
-    .withHashPair("V1_002__create_config_schemas.sql", "561fed397577fecf52e169147a4719f6")
+    .withHashPair("V1_002__create_config_schemas.sql", "935942d229304ef2116299aac7697f4c")
     .withHashPair("V1_003__create_map_schemas.sql", "69f4ddc8bd39e42d586afca833e4e6f8")
     .withHashPair("V1_004__add_map_icon_map.sql", "018fc6ef7adba9b861d33394bbcc57c2")
     .withHashPair("V1_005__add_map_easy.sql", "c0a99225ea3ac682bd576590d630d94b")
diff --git a/backend/src/test/kotlin/xyz/poeschl/roborush/service/ConfigServiceTest.kt b/backend/src/test/kotlin/xyz/poeschl/roborush/service/ConfigServiceTest.kt
@@ -52,9 +52,11 @@ class ConfigServiceTest {
     val controlDto = SaveSettingDto(controlSettingEntity.key, "true")
 
     val enableFullScanSettingEntity = a(`$SettingEntity`().withKey(SettingKey.ENABLE_FULL_MAP_SCAN).withType(SettingType.BOOLEAN).withValue("true"))
+    val enableUserRegisterSettingEntity = a(`$SettingEntity`().withKey(SettingKey.ENABLE_USER_REGISTRATION).withType(SettingType.BOOLEAN).withValue("true"))
 
     every { configRepository.findByKey(enableFullScanSettingEntity.key) } returns enableFullScanSettingEntity
     every { configRepository.findByKey(controlSettingEntity.key) } returns controlSettingEntity
+    every { configRepository.findByKey(enableUserRegisterSettingEntity.key) } returns enableUserRegisterSettingEntity
 
     every { settingEntityMapper.toEntity(controlSettingEntity, controlDto) } returns controlConvertedEntity
     every { configRepository.save(controlConvertedEntity) } returns controlConvertedEntity
@@ -164,6 +166,7 @@ class ConfigServiceTest {
 
     every { configRepository.findByKey(SettingKey.ENABLE_FULL_MAP_SCAN) } returns settingEntity
     every { configRepository.findByKey(SettingKey.ENABLE_WEB_ROBOT_CONTROL) } returns settingEntity
+    every { configRepository.findByKey(SettingKey.ENABLE_USER_REGISTRATION) } returns settingEntity
     every { settingEntityMapper.fromEntity(settingEntity) } answers { callOriginal() }
 
     // THEN
diff --git a/frontend/src/components/NavbarUserComponent.vue b/frontend/src/components/NavbarUserComponent.vue
@@ -1,6 +1,6 @@
 <template>
   <div class="navbar-item is-button" v-if="!userStore.loggedIn">
-    <button class="button" @click="openRegister">
+    <button class="button" @click="openRegister" :disabled="!registerEnabled">
       <span class="has-text-weight-semibold">Create a account</span>
     </button>
   </div>
@@ -18,13 +18,13 @@
   </a>
 
   <LoginForm v-if="loginIsShowing" :loading="loginLoading" @close="loginIsShowing = false" @login="loginUser" />
-  <RegisterForm v-if="registerIsShowing" :loading="registerLoading" @close="registerIsShowing = false" @register="registerUser" />
+  <RegisterForm v-if="registerIsShowing && registerEnabled" :loading="registerLoading" @close="registerIsShowing = false" @register="registerUser" />
   <UserModal v-if="userDetailsShown" @close="() => (userDetailsShown = false)" />
   <Toast v-if="toast.shown" :type="toast.type" :message="toast.message" @close="() => (toast.shown = false)" />
 </template>
 
 <script setup lang="ts">
-import { ref } from "vue";
+import { computed, ref } from "vue";
 import LoginForm from "@/components/LoginForm.vue";
 import type { LoginRequest, RegisterRequest } from "@/models/User";
 import RegisterForm from "@/components/RegisterForm.vue";
@@ -33,13 +33,16 @@ import Toast from "@/components/Toast.vue";
 import { ToastType } from "@/models/ToastType";
 import UserModal from "@/components/UserModal.vue";
 import log from "loglevel";
+import { useConfigStore } from "@/stores/ConfigStore";
 
 const userStore = useUserStore();
+const configStore = useConfigStore();
 
 const loginIsShowing = ref<boolean>(false);
 const loginLoading = ref<boolean>(false);
 const registerIsShowing = ref<boolean>(false);
 const registerLoading = ref<boolean>(false);
+const registerEnabled = computed<boolean>(() => configStore.clientSettings.enableUserRegistration);
 const toast = ref<{ shown: boolean; type: ToastType; message: string }>({ shown: false, type: ToastType.INFO, message: "" });
 const userDetailsShown = ref<boolean>(false);
 
@@ -68,8 +71,10 @@ const loginUser = (data: LoginRequest) => {
 };
 
 const openRegister = () => {
-  registerLoading.value = false;
-  registerIsShowing.value = true;
+  if (registerEnabled.value) {
+    registerLoading.value = false;
+    registerIsShowing.value = true;
+  }
 };
 
 const registerUser = (data: RegisterRequest) => {
diff --git a/frontend/src/models/Config.ts b/frontend/src/models/Config.ts
@@ -22,4 +22,5 @@ export interface MapGenerationResult {
 export interface ClientSettings {
   globalNotificationText: string;
   enableWebRobotControl: boolean;
+  enableUserRegistration: boolean;
 }
diff --git a/frontend/src/stores/ConfigStore.ts b/frontend/src/stores/ConfigStore.ts
@@ -11,7 +11,7 @@ export const useConfigStore = defineStore("configStore", () => {
 
   const currentConfig = ref<Map<string, Setting>>(new Map());
   const availableMaps = ref<{ maps: PlaygroundMap[] }>({ maps: [] });
-  const clientSettings = ref<ClientSettings>({ globalNotificationText: "", enableWebRobotControl: true });
+  const clientSettings = ref<ClientSettings>({ globalNotificationText: "", enableWebRobotControl: true, enableUserRegistration: false });
 
   const initWebsocket = (webSocketInstance: { initWebsocket: Function; registerForTopicCallback: Function }) => {
     websocketService.value = webSocketInstance;

Original file line number	Diff line number	Diff line change
`@@ -125,7 +125,8 @@ class ConfigRestController(private val configService: ConfigService, private val`
`125`	`125`	`fun getClientSettings(): ClientSettings {`
`126`	`126`	`return ClientSettings(`
`127`	`127`	`configService.getGlobalNotificationText(),`
`128`		`- configService.getBooleanSetting(SettingKey.ENABLE_WEB_ROBOT_CONTROL).value`
	`128`	`+ configService.getBooleanSetting(SettingKey.ENABLE_WEB_ROBOT_CONTROL).value,`
	`129`	`+ configService.getBooleanSetting(SettingKey.ENABLE_USER_REGISTRATION).value`
`129`	`130`	`)`
`130`	`131`	`}`
`131`	`132`	`}`
Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,8 @@ enum class SettingKey(@JsonIgnore val isFrontendSetting: Boolean = false) {`
`35`	`35`	`ENABLE_FULL_MAP_SCAN,`
`36`	`36`	`ENABLE_DUMMY_ROBOTS,`
`37`	`37`	`ENABLE_WEB_ROBOT_CONTROL(isFrontendSetting = true),`
`38`		`- DISTANCE_ROBOT_SIGHT_ON_MOVE`
	`38`	`+ DISTANCE_ROBOT_SIGHT_ON_MOVE,`
	`39`	`+ ENABLE_USER_REGISTRATION(isFrontendSetting = true)`
`39`	`40`	`}`
`40`	`41`
`41`	`42`	`enum class SettingType {`
`@@ -44,4 +45,4 @@ enum class SettingType {`
`44`	`45`	`BOOLEAN`
`45`	`46`	`}`
`46`	`47`
`47`		`-data class ClientSettings(val globalNotificationText: String, val enableWebRobotControl: Boolean)`
	`48`	`+data class ClientSettings(val globalNotificationText: String, val enableWebRobotControl: Boolean, val enableUserRegistration: Boolean)`
Original file line number	Diff line number	Diff line change
`@@ -62,7 +62,8 @@ class ConfigService(`
`62`	`62`	`websocketController.sendClientSettingsUpdate(`
`63`	`63`	`ClientSettings(`
`64`	`64`	`globalNotificationText,`
`65`		`- getBooleanSetting(SettingKey.ENABLE_FULL_MAP_SCAN).value`
	`65`	`+ getBooleanSetting(SettingKey.ENABLE_FULL_MAP_SCAN).value,`
	`66`	`+ getBooleanSetting(SettingKey.ENABLE_USER_REGISTRATION).value`
`66`	`67`	`)`
`67`	`68`	`)`
`68`	`69`	`}`
Original file line number	Diff line number	Diff line change
`@@ -22,4 +22,5 @@ export interface MapGenerationResult {`
`22`	`22`	`export interface ClientSettings {`
`23`	`23`	`globalNotificationText: string;`
`24`	`24`	`enableWebRobotControl: boolean;`
	`25`	`+ enableUserRegistration: boolean;`
`25`	`26`	`}`