Configurable username length

[devin-ai-integration]

---

Originally from spacebarchat/server issue spacebarchat#745, created by erkinalp, closed as not planned

[traycerai]

Plan

Observations

I analyzed the codebase and found that username length validation is currently partially configurable. The maximum username length is already configurable via Config.get().limits.user.maxUsername (default: 32), but the minimum length is hardcoded to 2 characters in multiple places. The issue requests making username length fully configurable, which means adding a configurable minimum length option.

Approach

I'll implement configurable username length by:

1. Adding minUsername configuration: Extend the UserLimits class to include a configurable minimum username length
2. Updating validation logic: Replace all hardcoded minimum length checks (currently 2) with the configurable value
3. Updating error messages: Make error messages dynamic to reflect the actual configured limits
4. Ensuring consistency: Update all places where username validation occurs to use the new configurable minimum

The changes will maintain backward compatibility by setting a sensible default value for the minimum username length.

Reasoning

I explored the repository structure and identified this as a Discord-like chat server implementation. I searched for username validation patterns and found the current implementation uses a configurable maximum length but hardcoded minimum length of 2. I located the key files: UserLimits.ts for configuration, NameValidation.ts for the main validation function, and several API routes that duplicate the validation logic.

Proposed File Changes

📄 src/util/config/types/subconfigurations/limits/UserLimits.ts ^(MODIFY) 🔗

Add a new minUsername property to the UserLimits class with a default value of 2 to maintain backward compatibility. This will allow server administrators to configure the minimum username length according to their requirements.

export class UserLimits {
	maxGuilds: number = 1048576;
	maxUsername: number = 32;
	minUsername: number = 2; // Add configurable minimum username length
	maxFriends: number = 5000;
	maxBio: number = 190;
}

📄 src/util/util/NameValidation.ts ^(MODIFY) 🔗

References

• 📄 src/util/config/types/subconfigurations/limits/UserLimits.ts ^(MODIFY)

Update the ValidateName function to use the configurable minimum username length instead of the hardcoded value of 2. Also update the error message to dynamically reflect the configured limits.

export function ValidateName(name: string) {
	const check_username = name.replace(/\s/g, "");
	if (!check_username) {
		throw FieldErrors({
			username: {
				code: "BASE_TYPE_REQUIRED",
				message: "common:field.BASE_TYPE_REQUIRED",
			},
		});
	}
	const general = Config.get();
	const { maxUsername, minUsername } = general.limits.user; // Extract both min and max
	if (check_username.length > maxUsername || check_username.length < minUsername) {
		throw FieldErrors({
			username: {
				code: "BASE_TYPE_BAD_LENGTH",
				message: `Must be between ${minUsername} and ${maxUsername} in length.`, // Dynamic message
			},
		});
	}
	// ... rest of the function remains unchanged
}

📄 src/api/routes/users/@me/index.ts ^(MODIFY) 🔗

References

• 📄 src/util/config/types/subconfigurations/limits/UserLimits.ts ^(MODIFY)

Update the username validation logic in the user profile update endpoint to use the configurable minimum username length instead of the hardcoded value of 2. Also update the error message to be dynamic.

if (body.username) {
	const check_username = body?.username?.replace(/\s/g, "");
	if (!check_username) {
		throw FieldErrors({
			username: {
				code: "BASE_TYPE_REQUIRED",
				message: req.t("common:field.BASE_TYPE_REQUIRED"),
			},
		});
	}

	const { maxUsername, minUsername } = Config.get().limits.user; // Extract both min and max
	if (
		check_username.length > maxUsername ||
		check_username.length < minUsername // Use configurable minimum
	) {
		throw FieldErrors({
			username: {
				code: "BASE_TYPE_BAD_LENGTH",
				message: `Must be between ${minUsername} and ${maxUsername} in length.`, // Dynamic message
			},
		});
	}
	// ... rest of validation logic remains unchanged
}

📄 src/api/routes/auth/register.ts ^(MODIFY) 🔗

References

• 📄 src/util/config/types/subconfigurations/limits/UserLimits.ts ^(MODIFY)

Update the username validation logic in the registration endpoint to include minimum username length validation using the configurable value. Currently, this endpoint only validates the maximum length.

const { maxUsername, minUsername } = Config.get().limits.user; // Extract both min and max
if (body.username.length > maxUsername || body.username.length < minUsername) { // Add minimum length check
	throw FieldErrors({
		username: {
			code: "BASE_TYPE_BAD_LENGTH",
			message: `Must be between ${minUsername} and ${maxUsername} in length.`, // Dynamic message
		},
	});
}

This ensures that the registration endpoint has consistent validation with the other username validation points in the codebase.

📄 src/util/entities/User.ts ^(MODIFY) 🔗

References

• 📄 src/util/config/types/subconfigurations/limits/UserLimits.ts ^(MODIFY)

Update the comment on the username field to reflect that both minimum and maximum lengths are now configurable, removing the outdated reference to hardcoded values.

@Column()
username: string; // username length is configurable (min and max)

This documentation update ensures that developers understand that username length limits are fully configurable through the server configuration.

Import In IDE

🤖 Prompt for AI Agents

I have created the following plan after thorough exploration and analysis of the codebase. Follow the below plan verbatim. Trust the files and references. Do not re-verify what's written in the plan. Explore only when absolutely necessary. First implement all the proposed file changes and then I'll review all the changes together at the end.

### Observations

I analyzed the codebase and found that username length validation is currently partially configurable. The maximum username length is already configurable via `Config.get().limits.user.maxUsername` (default: 32), but the minimum length is hardcoded to 2 characters in multiple places. The issue requests making username length fully configurable, which means adding a configurable minimum length option.

### Approach

I'll implement configurable username length by:

1. **Adding `minUsername` configuration**: Extend the `UserLimits` class to include a configurable minimum username length
2. **Updating validation logic**: Replace all hardcoded minimum length checks (currently 2) with the configurable value
3. **Updating error messages**: Make error messages dynamic to reflect the actual configured limits
4. **Ensuring consistency**: Update all places where username validation occurs to use the new configurable minimum

The changes will maintain backward compatibility by setting a sensible default value for the minimum username length.

### Reasoning

I explored the repository structure and identified this as a Discord-like chat server implementation. I searched for username validation patterns and found the current implementation uses a configurable maximum length but hardcoded minimum length of 2. I located the key files: `UserLimits.ts` for configuration, `NameValidation.ts` for the main validation function, and several API routes that duplicate the validation logic.

## Proposed File Changes

### src/util/config/types/subconfigurations/limits/UserLimits.ts(MODIFY)

Add a new `minUsername` property to the `UserLimits` class with a default value of 2 to maintain backward compatibility. This will allow server administrators to configure the minimum username length according to their requirements.

```typescript
export class UserLimits {
	maxGuilds: number = 1048576;
	maxUsername: number = 32;
	minUsername: number = 2; // Add configurable minimum username length
	maxFriends: number = 5000;
	maxBio: number = 190;
}

src/util/util/NameValidation.ts(MODIFY)

References:

• src/util/config/types/subconfigurations/limits/UserLimits.ts(MODIFY)

Update the ValidateName function to use the configurable minimum username length instead of the hardcoded value of 2. Also update the error message to dynamically reflect the configured limits.

export function ValidateName(name: string) {
	const check_username = name.replace(/\s/g, "");
	if (!check_username) {
		throw FieldErrors({
			username: {
				code: "BASE_TYPE_REQUIRED",
				message: "common:field.BASE_TYPE_REQUIRED",
			},
		});
	}
	const general = Config.get();
	const { maxUsername, minUsername } = general.limits.user; // Extract both min and max
	if (check_username.length > maxUsername || check_username.length < minUsername) {
		throw FieldErrors({
			username: {
				code: "BASE_TYPE_BAD_LENGTH",
				message: `Must be between ${minUsername} and ${maxUsername} in length.`, // Dynamic message
			},
		});
	}
	// ... rest of the function remains unchanged
}

src/api/routes/users/@me/index.ts(MODIFY)

References:

• src/util/config/types/subconfigurations/limits/UserLimits.ts(MODIFY)

Update the username validation logic in the user profile update endpoint to use the configurable minimum username length instead of the hardcoded value of 2. Also update the error message to be dynamic.

if (body.username) {
	const check_username = body?.username?.replace(/\s/g, "");
	if (!check_username) {
		throw FieldErrors({
			username: {
				code: "BASE_TYPE_REQUIRED",
				message: req.t("common:field.BASE_TYPE_REQUIRED"),
			},
		});
	}

	const { maxUsername, minUsername } = Config.get().limits.user; // Extract both min and max
	if (
		check_username.length > maxUsername ||
		check_username.length < minUsername // Use configurable minimum
	) {
		throw FieldErrors({
			username: {
				code: "BASE_TYPE_BAD_LENGTH",
				message: `Must be between ${minUsername} and ${maxUsername} in length.`, // Dynamic message
			},
		});
	}
	// ... rest of validation logic remains unchanged
}

src/api/routes/auth/register.ts(MODIFY)

References:

• src/util/config/types/subconfigurations/limits/UserLimits.ts(MODIFY)

Update the username validation logic in the registration endpoint to include minimum username length validation using the configurable value. Currently, this endpoint only validates the maximum length.

const { maxUsername, minUsername } = Config.get().limits.user; // Extract both min and max
if (body.username.length > maxUsername || body.username.length < minUsername) { // Add minimum length check
	throw FieldErrors({
		username: {
			code: "BASE_TYPE_BAD_LENGTH",
			message: `Must be between ${minUsername} and ${maxUsername} in length.`, // Dynamic message
		},
	});
}

This ensures that the registration endpoint has consistent validation with the other username validation points in the codebase.

src/util/entities/User.ts(MODIFY)

References:

• src/util/config/types/subconfigurations/limits/UserLimits.ts(MODIFY)

Update the comment on the username field to reflect that both minimum and maximum lengths are now configurable, removing the outdated reference to hardcoded values.

@Column()
username: string; // username length is configurable (min and max)

This documentation update ensures that developers understand that username length limits are fully configurable through the server configuration.

</details>

---


## Developer Humor

> 🎯 Username lengths, once set in stone,  \n> Now dance to config's flexible tone!  \n> From rigid \2\ we break free,  \n> To let admins choose what they see—  \n> A server that's truly their own! 📏✨
---


<details>
<summary>Execution Information</summary>

**Branch**: [master](https://github.com/erkinalp/anticensor/tree/master)
**Commit**: e031e729117666d33ad376d29553f37f34efca3b
</details>
<!-- traycer_tip_section_start -->

---


<details>
<summary>:bulb: Tips</summary>


### Supported Commands (Inside Comments)
- Use `@traycerai generate` to iterate on the previous version of the implementation plan.

### Supported Commands (Inside Description)
- Add `@traycerai ignore` anywhere in the ticket description to prevent this ticket from being processed.
- Add `@traycerai branch:<branch-name>` anywhere in the ticket description to specify the target branch for the implementation plan.

### Community

- Join our [Discord Community](https://traycer.ai/discord) to get help, request features, and share feedback.
- Follow us on [X/Twitter](https://twitter.com/traycerai) for updates and announcements.

</details>

<!-- traycer_tip_section_end -->
<!-- traycer_plan_end -->
<!-- traycer_root_comment_end -->