Union Chat v2 by cyyynthia · Pull Request #14 · Union-Chat/API

cyyynthia · 2018-10-25T19:21:25Z

It's time to update Union backend owo

This PR is a major rewrite of the API (v2) and a v2 of the websocket! OwO
APIv2 implements more consistent endpoints with cleaner path, a brunch of new features and is covered by unit tests
WebSocket is also in a new version with fancy new features!

WARNING: Neither the old API nor the old websocket are supported by this version. Support of the old API is
not complicated, but it's not the case for the current websocket. Partial support would be just a waste of time imo

Features

Clean code (as always)
Unit tests yarn run test (note: you can skip long test with the env variable SKIP_LONG_TESTS=yes)
Stable and consistent
Ez installation system & migrator yarn run setup
reCAPTCHA support (should work, didn't tested and not covered by unit tests, because I don't know how to test it properly)
User & server settings (very basic for now)
Docs! :D

Ez installer

The installer will prepare the app to start working quickly and easily

Build the beautiful es6 code in ugly but (we all hope) working code
Migrates the database (no database required, everything will be created)
Download & build union-react (union-website can be used but some adjustments will be probably required)

Endpoints

POST /api/v2/users - Create an user

GET /api/v2/users/self - Get current user
PUT, PATCH /api/v2/users/self - Updates the current user
DELETE /api/v2/users/self - Delete the current user

POST /api/v2/servers - Create a server
PUT, PATCH /api/v2/servers/:serverId - Delete a server
DELETE /api/v2/servers/:serverId/leave - Leave a server
DELETE /api/v2/servers/:serverId - Delete a server

POST /api/v2/servers/:serverId/invites - Create an invite to a server
POST /api/v2/invites/:invite - Accept an invite

POST /api/v2/servers/:serverId/messages - Post a message
PUT/PATCH /api/v2/servers/:serverId/messages/:messageId - Update a message
DELETE /api/v2/servers/:serverId/messages/:messageId - Delete a message

Not implemented endpoints

GET /api/v2/themes - Get a list of all themes, ordered by votes (with pagination)
POST /api/v2/themes/:themeId/vote - Upvote a theme
DELETE /api/v2/themes/:themeId/vote - Remove the upvote for a theme

POST /api/v2/themes - Create a theme
PUT, PATCH /api/v2/themes/:themeId - Update a theme
DELETE /api/v2/themes/:themeId - Delete a theme

GET /api/v2/developers/applications - Get applications
POST /api/v2/developers/applications - Create an application
PUT, PATCH /api/v2/developers/applications/:applicationId - Update an application
DELETE /api/v2/developers/applications/:applicationId - Delete an application

GET /api/v2/oauth2/authorize - Oauth2 classic routes
POST /api/v2/oauth2/token - Oauth2 classic routes
POST /api/v2/oauth2/revoke - Oauth2 classic routes

New WebSocket server

Don't be a Discord. Union websocket is Subscription-based, for the happiness of your network and CPU
See the docs for more details

Some other ideas & stuff to do

Snipe but directly in the API (with maybe more advanced behaviour)
Channels & DMs
Improve scalability of Union

- Controllers and middlewares separated from route declaration - es6 imports & Babel to transpile everything - eslint to have a beautiful code - ez installer

Will resolve conflicts later, too lazy rn

I can't find a clean way to support two versions of the websocket server. Partial support is just a waste of time, so let's do a breaking update

These tests are a bit useless. Important tests are in s_core

devoxin · 2018-10-28T16:54:20Z

+        "maxServersPerUser": 5,
+        "maxAppsPerUser": 5
+    },
+    "recaptcha (Remove this entirely if you don't want to setup it)": {


Perhaps the note could be moved to a property within this object to save having to edit this line if the user wants recaptcha (mostly a nitpick here)

devoxin · 2018-10-28T18:57:16Z

+|---------------|-----------|---------------------------------------|
+| id            | snowflake | User internal ID                      |
+| username      | string    | Username                              |
+| discriminator | int       | Discriminator fo the user             |


devoxin · 2018-10-28T18:57:36Z

+| discriminator | int       | Discriminator fo the user             |
+| avatarUrl     | string?   | Url of the user's avatar              |
+| servers       | int[]     | List of the server IDs the user is in |
+| online        | boolean   | Whenever or not the user is online    |


devoxin · 2018-10-28T18:58:23Z

+<span class='api-endpoint'><span class='sun-flower-text'>POST</span> /servers</span>
+<span class='api-auth'>Requires authentication</span>
+
+**Note:** You can't create more server than specified in `maxServersPerUser`


Suggested change

**Note:** You can't create more server than specified in `maxServersPerUser`

**Note:** You can't exceed the `maxServersPerUser` limit

devoxin · 2018-10-28T19:02:41Z

+| Field         | Type         | Description                                                        |
+|---------------|--------------|--------------------------------------------------------------------|
+| id            | snowflake    | User ID                                                            |
+| username      | string       |                                                                    |


Missing desc?

devoxin · 2018-10-28T19:05:56Z

this is so damn big.

On another note, please lint with the old settings (semicolons, yoda, etc...)

cyyynthia · 2018-10-28T19:19:39Z

Done :D

cyyynthia · 2018-10-29T13:41:57Z

oof also just notices some stuff:

I completely forgot to impement the rate limit documented in api.md
s_core.js test is inconsistent and behave weirdly, fails randomly and keeps the process alive, I'll probably remove it too

I'll fix that a bit later and add a comment when it's fixed

s_core was inconsistent and didn't behave like a test should do (random failures and keeps the process alive) Rate limiting is here to prevent API abuse and is Cloudflare-proof (IP detection)

cyyynthia · 2018-10-29T23:13:47Z

Fixed and changes pushed. Note that the rate limiter should use a Redis server in the future, to improve reliability and scalability

cyyynthia · 2018-10-29T23:15:40Z

And on another note, i'm just wondering, why you prefer yoda syntax?

cyyynthia added 30 commits October 7, 2018 00:40

Better project structure

f15aec0

- Controllers and middlewares separated from route declaration - es6 imports & Babel to transpile everything - eslint to have a beautiful code - ez installer

nearly perfect

f782728

Setup unit testing

87a9a3c

Database migrations

650ae62

Don't spam console

6296f3f

More tests, beginning of API v2

e877eb7

User create endpoint

253b5e3

Reflect sources on the main repo

d3337cd

Will resolve conflicts later, too lazy rn

Port users and servers to APIv2

0166c28

Implement invites

3a070cf

Finish APIv1 port to v2

486b0f0

Merge branch 'pr/1'

35b53c6

Add reCAPTCHA support (closes Union-Chat#8)

929ba5f

Add developer routes (Not implemented yet)

397e30c

Implement user settings (hi Union-Chat#9)

7cf377d

Implement server settings (closes Union-Chat#9)

2bcafb0

Finally remove support for API v1

0020e7b

I can't find a clean way to support two versions of the websocket server. Partial support is just a waste of time, so let's do a breaking update

Move websocket in a subfolder

aa67e78

Start some docs (hi Union-Chat#12)

e113de4

I guess this is how to use Jekyll

aeecc6b

Socket docs

b6c2526

Fix package.json

3352877

Start API docs

22645d5

Prepare the theme feature

f8d0d32

Finish docs (closes Union-Chat#12) and fix some stuff

5b8ce96

New socket tests (not written yet)

ff2c7f7

Socket core

92d6e1b

Remove not core socket tests

ed7ddee

These tests are a bit useless. Important tests are in s_core

Renaming memes

7068c88

Fully implement new socket

5b56e52

cyyynthia added 2 commits October 25, 2018 20:37

Message edit & deletion

295601a

Update Modesta, typo and add auth requirements

1894e9f

This was referenced Oct 26, 2018

Changeable usernames/Nicks #11

Open

Bot accounts #7

Open

Persistent messages #3

Open

cyyynthia added 6 commits October 26, 2018 11:57

set NODE_ENV in setup, valid JSON in docs

f60b889

Use the latest Modesta

9007956

target='_blank'

1837e1a

Fix installer

c5eae8a

console.log memes

1ac4a8a

Fix SERVER_CREATE event

d614bbe

devoxin requested changes Oct 28, 2018

View reviewed changes

cyyynthia added 2 commits October 28, 2018 20:15

eslint changes

614bcfc

Grammar fixes

ecee1cb

Remove unused eslint dependencies

e63d959

Removed s_core and implemented rate limiting

1abef0d

s_core was inconsistent and didn't behave like a test should do (random failures and keeps the process alive) Rate limiting is here to prevent API abuse and is Cloudflare-proof (IP detection)

Let's be nice and unban people

e6fe5ec

devoxin approved these changes Nov 22, 2018

View reviewed changes

devoxin changed the base branch from master to dev November 22, 2018 01:54

devoxin merged commit 604a1cb into Union-Chat:dev Nov 22, 2018

Navigation Menu

Repository navigation

Union Chat v2 - #14

Union Chat v2#14
devoxin merged 43 commits into
Union-Chat:devfrom
cyyynthia:master

cyyynthia commented Oct 25, 2018

Uh oh!

devoxin Oct 28, 2018

Uh oh!

devoxin Oct 28, 2018

Uh oh!

devoxin Oct 28, 2018

Uh oh!

devoxin Oct 28, 2018

Uh oh!

devoxin Oct 28, 2018

Uh oh!

devoxin commented Oct 28, 2018

Uh oh!

cyyynthia commented Oct 28, 2018

Uh oh!

cyyynthia commented Oct 29, 2018

Uh oh!

cyyynthia commented Oct 29, 2018

Uh oh!

cyyynthia commented Oct 29, 2018

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	\| discriminator \| int \| Discriminator fo the user \|
	\| discriminator \| int \| Discriminator for the user \|

	\| online \| boolean \| Whenever or not the user is online \|
	\| online \| boolean \| Whether or not the user is online \|

	Note: You can't create more server than specified in `maxServersPerUser`
	Note: You can't exceed the `maxServersPerUser` limit

Conversation

cyyynthia commented Oct 25, 2018

Features

Ez installer

Endpoints

Not implemented endpoints

New WebSocket server

Some other ideas & stuff to do

Uh oh!

devoxin Oct 28, 2018

Choose a reason for hiding this comment

Uh oh!

devoxin Oct 28, 2018

Choose a reason for hiding this comment

Uh oh!

devoxin Oct 28, 2018

Choose a reason for hiding this comment

Uh oh!

devoxin Oct 28, 2018

Choose a reason for hiding this comment

Uh oh!

devoxin Oct 28, 2018

Choose a reason for hiding this comment

Uh oh!

devoxin commented Oct 28, 2018

Uh oh!

cyyynthia commented Oct 28, 2018

Uh oh!

cyyynthia commented Oct 29, 2018

Uh oh!

cyyynthia commented Oct 29, 2018

Uh oh!

cyyynthia commented Oct 29, 2018

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants