Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Implement username availability checker #2183

Merged
merged 2 commits into from
May 4, 2017
Merged

Implement username availability checker #2183

merged 2 commits into from
May 4, 2017

Conversation

lukebarnard1
Copy link
Contributor

@lukebarnard1 lukebarnard1 commented May 3, 2017 •
edited
Loading

Outlined here: element-hq/element-web#3605 (comment)

UPDATE: This API should have always been a POST API, I've updated the below to reflect that. (#2209)
ANOTHER UPDATE: @richvdh thinks (and I agree) that this should've been a GET with a query parameter all along! - #2213.

GET /_matrix/.../register/available?username=desiredlocalpart123

If available, the response looks like

HTTP/1.1 200 OK
{
    "available": true
}

Otherwise,

HTTP/1.1 429
{
    "errcode": "M_LIMIT_EXCEEDED",
    "error": "Too Many Requests",
    "retry_after_ms": 2000
}

or

HTTP/1.1 400
{
    "errcode": "M_USER_IN_USE",
    "error": "User ID already taken."
}

or

HTTP/1.1 400
{
    "errcode": "M_INVALID_USERNAME",
    "error": "Some reason for username being invalid"
}

Implement username availability checker
34ed4f4 
Outlined here: element-hq/element-web#3605 (comment)

```HTTP
GET /_matrix/.../register/available
{
    "username": "desiredlocalpart123"
}
```

If available, the response looks like
```HTTP
HTTP/1.1 200 OK
{
    "available": true
}
```

Otherwise,
```HTTP
HTTP/1.1 429
{
    "errcode": "M_LIMIT_EXCEEDED",
    "error": "Too Many Requests",
    "retry_after_ms": 2000
}
```
or
```HTTP
HTTP/1.1 400
{
    "errcode": "M_USER_IN_USE",
    "error": "User ID already taken."
}

```
or
```HTTP
HTTP/1.1 400
{
    "errcode": "M_INVALID_USERNAME",
    "error": "Some reason for username being invalid"
}
```
erikjohnston
erikjohnston reviewed May 3, 2017
View reviewed changes
synapse/rest/client/v2_alpha/register.py Outdated
self.ratelimiter = FederationRateLimiter(
hs.get_clock(),
window_size=2000, # Time window of 2s
sleep_limit=1, # Artificially delay requests if rate > sleep_limit/window_size
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

True here surely?

Copy link
Contributor Author

@lukebarnard1 lukebarnard1 May 3, 2017 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Er, the docs say,
sleep_limit (int): The number of requests received...

erikjohnston
erikjohnston reviewed May 3, 2017
View reviewed changes
synapse/rest/client/v2_alpha/register.py Outdated
sleep_limit=1, # Artificially delay requests if rate > sleep_limit/window_size
sleep_msec=1000, # Amount of artificial delay to apply
reject_limit=1, # Error with 429 if more than reject_limit requests are queued
concurrent_requests=1, # Allow 1 request at a time
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

True

@erikjohnston
Copy link
Member

$ flake8 synapse tests
synapse/rest/client/v2_alpha/register.py:132:30: E261 at least two spaces before inline comment
synapse/rest/client/v2_alpha/register.py:133:27: E261 at least two spaces before inline comment
synapse/rest/client/v2_alpha/register.py:134:29: E261 at least two spaces before inline comment
synapse/rest/client/v2_alpha/register.py:135:28: E261 at least two spaces before inline comment
synapse/rest/client/v2_alpha/register.py:136:35: E261 at least two spaces before inline comment

erikjohnston
erikjohnston approved these changes May 4, 2017
View reviewed changes
Copy link
Member

@erikjohnston erikjohnston left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lgtm

@lukebarnard1 lukebarnard1 merged commit 6aa423a into develop May 4, 2017
This was referenced May 8, 2017
Closed
Merged
lukebarnard1 pushed a commit to matrix-org/matrix-js-sdk that referenced this pull request May 10, 2017
Implement API for username availability
5eafdf5 
Requires synapse with matrix-org/synapse#2183
@lukebarnard1 lukebarnard1 mentioned this pull request May 10, 2017
Merged
lukebarnard1 added a commit to matrix-org/matrix-js-sdk that referenced this pull request May 11, 2017
@lukebarnard1
Implement API for username availability (#432)
cb9a9e8 
Requires synapse with matrix-org/synapse#2183, matrix-org/synapse#2209 and matrix-org/synapse#2213
psaavedra added a commit to psaavedra/synapse that referenced this pull request May 19, 2017
@psaavedra
Merge tag 'v0.21.0' into v0.21.0_no_federate_by_default
badd30b 
Changes in synapse v0.21.0 (2017-05-18)
=======================================

No changes since v0.21.0-rc3

Changes in synapse v0.21.0-rc3 (2017-05-17)
===========================================

Features:

* Add per user rate-limiting overrides (PR matrix-org#2208)
* Add config option to limit maximum number of events requested by ``/sync``
  and ``/messages`` (PR matrix-org#2221) Thanks to @psaavedra!

Changes:

* Various small performance fixes (PR matrix-org#2201, matrix-org#2202, matrix-org#2224, matrix-org#2226, matrix-org#2227, matrix-org#2228,
  matrix-org#2229)
* Update username availability checker API (PR matrix-org#2209, matrix-org#2213)
* When purging, don't de-delta state groups we're about to delete (PR matrix-org#2214)
* Documentation to check synapse version (PR matrix-org#2215) Thanks to @hamber-dick!
* Add an index to event_search to speed up purge history API (PR matrix-org#2218)

Bug fixes:

* Fix API to allow clients to upload one-time-keys with new sigs (PR matrix-org#2206)

Changes in synapse v0.21.0-rc2 (2017-05-08)
===========================================

Changes:

* Always mark remotes as up if we receive a signed request from them (PR matrix-org#2190)

Bug fixes:

* Fix bug where users got pushed for rooms they had muted (PR matrix-org#2200)

Changes in synapse v0.21.0-rc1 (2017-05-08)
===========================================

Features:

* Add username availability checker API (PR matrix-org#2183)
* Add read marker API (PR matrix-org#2120)

Changes:

* Enable guest access for the 3pl/3pid APIs (PR matrix-org#1986)
* Add setting to support TURN for guests (PR matrix-org#2011)
* Various performance improvements (PR matrix-org#2075, matrix-org#2076, matrix-org#2080, matrix-org#2083, matrix-org#2108,
  matrix-org#2158, matrix-org#2176, matrix-org#2185)
* Make synctl a bit more user friendly (PR matrix-org#2078, matrix-org#2127) Thanks @APwhitehat!
* Replace HTTP replication with TCP replication (PR matrix-org#2082, matrix-org#2097, matrix-org#2098,
  matrix-org#2099, matrix-org#2103, matrix-org#2014, matrix-org#2016, matrix-org#2115, matrix-org#2116, matrix-org#2117)
* Support authenticated SMTP (PR matrix-org#2102) Thanks @DanielDent!
* Add a counter metric for successfully-sent transactions (PR matrix-org#2121)
* Propagate errors sensibly from proxied IS requests (PR matrix-org#2147)
* Add more granular event send metrics (PR matrix-org#2178)

Bug fixes:

* Fix nuke-room script to work with current schema (PR matrix-org#1927) Thanks
  @zuckschwerdt!
* Fix db port script to not assume postgres tables are in the public schema
  (PR matrix-org#2024) Thanks @jerrykan!
* Fix getting latest device IP for user with no devices (PR matrix-org#2118)
* Fix rejection of invites to unreachable servers (PR matrix-org#2145)
* Fix code for reporting old verify keys in synapse (PR matrix-org#2156)
* Fix invite state to always include all events (PR matrix-org#2163)
* Fix bug where synapse would always fetch state for any missing event (PR matrix-org#2170)
* Fix a leak with timed out HTTP connections (PR matrix-org#2180)
* Fix bug where we didn't time out HTTP requests to ASes  (PR matrix-org#2192)

Docs:

* Clarify doc for SQLite to PostgreSQL port (PR matrix-org#1961) Thanks @benhylau!
* Fix typo in synctl help (PR matrix-org#2107) Thanks @HarHarLinks!
* ``web_client_location`` documentation fix (PR matrix-org#2131) Thanks @matthewjwolff!
* Update README.rst with FreeBSD changes (PR matrix-org#2132) Thanks @feld!
* Clarify setting up metrics (PR matrix-org#2149) Thanks @encks!
@turt2live turt2live mentioned this pull request Mar 6, 2018
Merged
@hawkowl hawkowl deleted the luke/username-availability branch September 20, 2018 13:58
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@erikjohnston erikjohnston erikjohnston approved these changes

Assignees

@erikjohnston erikjohnston

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@lukebarnard1 @erikjohnston