sloveniaengineering / laguna-backend Goto Github PK

Description

• If user forgot password, user inputs their email/username and then performs a forgot password operation.
• This means that we send email to this user with a special link that allows this user reset password.

This is a very low priority long distance issue ATM.
Independence only applies to backend.

Get rid of following systems:

• crates.io by caching required crates in Alt Registry on GitHub
• GitHub
• Ubuntu APT manager in CI/CD

Run multiple DBs, multiple root services, promotion system to Primary. Independent of providers, on "internal" network.

Description

Powerful search > any filter.

Since we are using postgres we can have tsvector and tsquery based searches while introducing a search-optimized index on torrent filename https://www.postgresql.org/docs/current/textsearch-intro.html.

Idea of filtering

• Much like Twitter or GH, Search = filter via "query" strings such as title:<title of torrent> uploaded_by:<username> from:<date>. (Postgres supports this very nicely).

Technical notes

• We might even consider search by category this would require per cat/ PARTITION BY and indexing of categories.

Probably argon2

Can we make it fail tolerant?

This is not a priority, but adds to DX.

• Username
• Email
• Password

Completed in #87 . @kozabrada123 close plz, tnx

Reported by @zigapovhe

My proposal:

.toml config files that can be overwriten by environment variables

ex:
Config.toml
port = 8000

No PORT enviornment variable

Server uses port 8000

Config.toml
port = 8000

Enviornment variables
PORT=8080

Server uses port 8080

• Problem: INSERT, CREATE and UPDATE queries carry digest('plaintext password', 'sha-256') with current design.
• Solution: Hash password on server.

This is something that could be fixed with GraphQL, so many different flavours of DTOs for the same thing: TorrentPatchDTO, TorrentPutDTO, TorrentDTO.

Is trying to abstract here violation of WET?

• /api/user/me (current user, based on JWT)
• /api/user/{id}

• All API docs must look about the same and must be True.
• All CONTRIBUTING.md sections must be short and on point
• Optional: Some things can be marked #[doc(hidden)] (ie. having a struct and fn after macro is applied on eg. get_me() function in laguna-backend-api).
• Slovenščina? (Za vse).
• User-facing docs in laguna-docs.
• Lektura obstoječih docsov.

Currently logging in requires a timestamp that is blindly inserted into the database

that timestamp can be any valid timestamp, it can even be 20 years old or 20 years in the future

ex:

POST /login/

{
    "username_or_email": "test",
    "password": "testpassword",
    "login_timestamp": "1997-07-05T11:41:08+0000"
}

->

{
    "LoginSuccess": {
        "user": {
            "id": "b33b630d-e098-47d0-bc21-94c6a7467f17",
            "username": "test",
            "email": "test@microsoft-net",
            "first_login": "2023-07-05T11:36:26.431821Z",
            "last_login": "1997-07-05T11:41:08Z",
            "avatar_url": null,
            "role": "Normie",
            "behaviour": "Lurker",
            "is_active": true,
            "has_verified_email": false,
            "is_history_private": true,
            "is_profile_private": true
        }
    }
}

we should either validate the timestamp is plausible or generate the timestamp ourselves

• PATCH /api/user

Using Docker. This is a Could-Have for now.

Check this out: https://github.com/HDInnovations/UNIT3D-Community-Edition/blob/master/database/schema.pdf

User tablespace

User

• id (uuid, v4)
• username (string, unicode, escaped)
• email (string, unicode, specific format)
• password (hash)
• first_login (datetime for account age)
• last_login (datetime)
• avatar_url (usually "link to avatar provider" + hash(email))
• role (enum)
  • user
  • verified
  • mod
  • admin
• behaviour (enum, computable from Torrent)
  • lurker (default, potential leech)
  • downloader (could be leech, but not known yet due to file not transferred fully)
  • freeleecher (never uploads, but thats fine because he is doing it on Freeleech)
  • leech (never uploads, ratio upload:download is very low — bad user)
  • seed (downloads and seeds for other users — good user)
  • chocked (seed but; uploading at full capacity || using blacklisted torrent client || all downloaders of this seed are seed ergo. completely uninterested)
  • uploader (seed which added Torrent to this DB — best user)
• is_active (bool) (#9 )
• has_verified_email (bool)
• is_history_private (bool, history not visible) (#11 )
• is_profile_private (bool, profile not visible)
• [WILL_BE_COMPUTED] bytes_downloaded (bigint or decimal, computable from Torrent) (should probably be VIEW-ed)
• [WILL_BE_COMPUTED] bytes_uploaded (bigint or decimal, computable from Torrent) (should probably be VIEW-ed)

DTOs

• UserDTO
• LoginDTO
• RegisterDTO

User API

• JWT Authorization and Role claim (#1 )
• POST (#4 )
  • /register
    • Documentation
  • /login
    • Documentation
• PATCH (#5 )
• DELETE (#6 )
• GET (#7 )
• [NOT PLANNED] PUT (#8 )

Torrent tracking tablespace

Torrent

• id (uuid)
• name (string)
• file_name (string)
• nfo (null or string)
• path (pathbuf)
• info_hash (hash of info section of torrent file at path "path")
• uploaded_by (FK onto User)
• modded_ by (FK onto User)

Torrent API (Tracker)

• #30
• #31
• #33
• #32

Probably using GitHub pages

Description

Additional technical notes

• Na FE se uporabi plugin: https://pub.dev/packages/platform_device_id
  Plugin pridobi device id.. Ob prijavi na api pošljemo še device id, in ga shranimo v bazo. V bazo tako shranimo vse device-idje per user in ko rabimo nekega userja bannat, preprosto bannamo vse device-idje
• There should be a "strike counter", 3 strikes and you are out automatically.

• Include UUID
• Remove password hash

Currently success on login returns:

{
    "LoginSuccess": {
        "user": {
            "id": "b33b630d-e098-47d0-bc21-94c6a7467f17"
            "username": "test",
            "email": "[email protected]",
            "first_login": "2023-07-04T10:18:17.391698Z",
            "last_login": "2023-07-04T10:18:17.391698Z",
            "avatar_url": null,
            "role": "Normie",
            "is_active": true,
            "has_verified_email": false,
            "is_history_private": true,
            "is_profile_private": true
        }
    }
}

We want:

{
    "id": "b33b630d-e098-47d0-bc21-94c6a7467f17"
    "username": "test",
    "email": "[email protected]",
    "first_login": "2023-07-04T10:18:17.391698Z",
    "last_login": "2023-07-04T10:18:17.391698Z",
    "avatar_url": null,
    "role": "Normie",
    "is_active": true,
    "has_verified_email": false,
    "is_history_private": true,
    "is_profile_private": true
}

When its just:

"RegisterSuccess"

We want:

This can probably be achieved using #[serde(transparent)] on enum (or enum member).

Do we even need *State structs? Is 200 OK not sufficient?

This would reduce CI/CD pipeline time by cca 3min.

• #29
• /api/user/me/delete

Ban mechanism tablespace

DeviceOwner (M2M between User and Device)

DeviceOwner API

Device

• id (unique hardware id of device)

Device API

Ban

• id (id of ban, int)
• device_owner_id_fk (fk to DeviceOwner)
• ban_reason (string)

Ban API

This is SQLx WIP thing. Do we wait it out?

This is really about solving the multithread issue with current tests. The problem is that all tests ATM access single laguna_test_db which means many conflicts and forced us into doing DELETE FROM on teardown.

Theres two ways to combat this:

1. Wrap every test in transaction and rollback at the end, but still use single DB. This is however cumbersome (remember its still single database).
2. Create small DB for every test.

I think its better to do (2).

Instead of Cookies or other header trickery.

Zgledi:

• https://github.com/SakaDream/actix-web-rest-api-with-jwt

Uporabljene knjiznice:

• https://docs.rs/actix-jwt-auth-middleware/latest/actix_jwt_auth_middleware/
• https://github.com/actix/actix-extras

Inactive users are marked false on is_active field. This allows for reasonable account cleanup if DB gets big.

Description

Verify email when registring by sending user a "confirmation code" (this prevents spam accounts).
This requires mailer.

Description

• User history (uploads, downloads, completed times, choked times, gave up times, etc per torrent).
• Maybe as a timeline.
• Edit: Needs triage, after reconsideration, I don't think this is a good idea.