ADR-291: Profile names validation

More details about this document
Latest published version:
https://adr.decentraland.org/adr/ADR-291
Authors:
LautaroPetaccio
pentreathm
nachomazzara
kuruk-mm
Feedback:
GitHub decentraland/adr (pull requests, new issue, open issues)
Edit this documentation:
GitHub View commits View commits on githistory.xyz

Abstract

Due to the growth of new clients, the need for proper validation of profile names appeared. This ADR proposes adding new restrictions to profile names, which include length and special characters validations.

Context, Reach & Prioritization

Context

Profile entities currently have no requirements for their names beside being defined. This has caused different clients to allow the deployment of names with different criteria, resulting in naming inconsistencies. The aim of this ADR is to address this issue, standardizing the rules for names validation.

After the implementation of this ADR, names MUST:

To be more explicit about the new restrictions, names MUST now comply with the following JS Regex:

;/^[a-zA-Z0-9]{2,15}$/

Reach

This specification impacts:

Clients and sites deploying profile entities MUST include these validations before the deployment process of profiles. These clients MUST be aware of old profiles that, when being updated, MUST correct or prompt user for a new name or they will be rejected.

RFC 2119 and RFC 8174

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119 and RFC 8174.

License

Copyright and related rights waived via CC0-1.0. DRAFT Draft