lamtonylam / haalarimerkkidex

Tietokannat ja web-ohjelmointi harjoitustyö

Hi 👋, I'm Tony

CS Student at University of Helsinki

haalarimerkkidex's Issues

I can create an user without a password

When registering I can create an account while the password field is empty

Vertaispalaute #2

Yleiskuva

Sovelluksen idea on minusta hauska ja toimiva. Myös dokumentaatio ja käynnistysohjeet olivat todella selkeät eikä niiden kannsa ollut mitään ongelmia. Myös koodi näytti todella hyvältä enkä löytänyt siitä mitään merkittäviä ongelmia tai virheitä. Myös koodissa olevat kommentit antoivat hyvän käsityksen kaikista funktioista ja niiden käyttötarkoituksista. Alla kuitenkin muutamia pieniä huomioita sovelluksesta ja sen käytöstä:

Huomioita / bugeja

• Kun hakee kaikkia yhteisön merkkejä niin hakusana ja valittu kategoria voisi jäädä näkyviin sen sijaan että nollautuu joka kerta.
• Huomasin myös, että sovellus kaatuu kun valitsee sekä hakusanan että kategorian.
  • Johtuu todennäköisesti siitä, että tässä sql kyselyyn tulee "WHERE" kaksi kertaa:
    https://github.com/lamtonylam/haalarimerkkidex/blob/e488c4281a89b86a3fff9efd8dbd5c8814cc87f6/routes.py#L65C1-L71C50
• Sovellukseen saa myös lisättyä haalarimerkin ilman kuvaa. Tämä tosin voi olla tarkoituksellista?
• Kirjautumis-sivulla käyttäjätunnus voisi jäädä näkyviin vaikka salasanan kirjoittaa väärin kuten rekisteröintisivullakin.
• Tällä funktiolla ei näyttäisi olevan mitään käyttötarkoitusta (ainakaan tällä hetkellä).

  • haalarimerkkidex/sendpatch.py

    Line 41 in e488c42

    def get_patch_id(name):

• Kommenttien pituudelle voisi lisätä jonkin backend-tarkistuksen. Nyt kommenttien maksimipituus määritetään html-tekstikentässä, mutta tämän voi helpoisti ohittaa muokkaamalla suoraan selaimessa html-tiedostoa (inspect, inspect elements...)
  • -> sivulle saa siis lähetettyä tyhjiä kommentteja tai huolestuttavammin teoriassa äärettömän pitkiä kommentteja.
• Ei sinänsä liity sovelluksen toimintaan, mutta tuota github-etusivua ja hakemistoa saisi kenties hiukan siistimmän näköiseksi + parantaisi luettavuutta jos jakaisi esimerkiksi .py moduulit omaan kansioon.
• Joka kerta kun poistaa merkin omasta kokoelmasta niin aiheutuu 404-virhe.
• Myös merkki-sivulla kun yrittää palata navbarin kautta taaksepäin niin joutuu 404-virhesivulle koska html-pohja ohjaa sivulle jota ei ole.

  • haalarimerkkidex/templates/merkki.html

    Line 13 in e488c42

    <a href="/haalarimerkit">Haalarimerkit</a>

yhteenveto

Kaikenkaikkiaan sovellus vaikuttaa jo nyt todella hyvältä ja toimivalta kokonaisuudelta. Suurimmat huomiot olivatkin vain pieniä käytettävyyttä koskevia yksityiskohtia enkä itse huomannut mitään suurempia puutteita tai ongelmia.

Ensimmäinen vertaisarviointi

Käyttökokemus

Käyttäjätunnuksen luominen, merkin lisääminen yhteisöön ja sieltä omiin kokoelmiin onnistui vaivatta.
Ulkoasu on selkeä ja oletan sen olevan optimoitu puhelimia varten, koska sitä kautta se ainakin näyttää selkeämmältä.

Huomioita

• Etusivulla ei ole selkeää funktiota, joka liittyisi sovelluksen toimintaan olennaisesti.
• Uuden merkin lisääminen ensin yhteisöön ja sitten kokoelmaan on hieman kankeaa. Käyttäjälle voisi antaa valinnaksi merkin lisääminen suoraan omaan profiiliin.
• "Katso lisätietoja / lisää merkki omaan kokoelmaasi" on vähän turhan pitkä teksti, eikä se täysin kuvaa napin toimintaa

Koodikanta

Koodi on selkeää, jaoteltu tarpeeksi fiksusti ja noudattaa pääsääntöisesti Pythonin yleisiä sopimuksia.
En näe räikeitä virheitä tai puutteita, joten nillitän alempana hieman kurssin tavoitteisiin sopivammista tyyleistä tehdä samat toiminnallisuudet. Mainitsen myös räikeästä tietoturvaongelmasta.

Huomioita

haalarimerkkidex/sendpatch.py

Line 10 in 49f5006

def patchname_exists(name):

Voit korvata tämän komennon SQL:n puolella käyttämällä tietokannassa UNIQUE-rajoitusta.
Sovelluksen toiminta luottaa ilmeisesti nimien uniikkiuteen, joten se kannattaa varmistaa ihan tietokannan puolella myös.

haalarimerkkidex/schema.sql

Line 15 in 49f5006

created_by_user TEXT REFERENCES Users(username)

Pääsääntöisesti kannattaa viitata taulusta tauluun aina id:llä.

haalarimerkkidex/routes.py

Line 44 in 49f5006

if sort_order == "asc":

Voit pistää nämä testit suoraan SQL:aan myös if-elsenä

haalarimerkkidex/routes.py

Line 195 in 49f5006

"new_merkki.html", success="Merkki lisätty yhteiseen kokoelmaan onnistuneesti"

Luonteva uudelleenohjaus olisi uuden merkin sivulle. Tällöin käyttäjä voi lisätä merkin suoraan kokoelmaansa. Toki monen merkin lisääminen on vähän vaikeampaa... Makukysymys.

haalarimerkkidex/routes.py

Line 137 in 49f5006

if masterpassword != "tsohatsoha":

Tämä kannattaa heittää .env-tiedostoon.

haalarimerkkidex/routes.py

Line 97 in 1f8767d

if data is not None:

Sama kuin if data

Lopetus

Hyvin on lähtenyt projekti käyntiin. Pientä hiomista ja muutama ominaisuus lisää, niin hyvä tulee. Ei ole tässä vaiheessa mikään kiire, mutta kannattaa kokeilla hieman tyylitellä sivua jossain välissä. Käyttäjäkokemuksen helppokäyttöisyyteen kannattaa panostaa, koska käyttäjäkuntasi toimii pääsääntöisesti kognitiivisesti rajoittuneessa tilassa, jossa pienetkin jutut voivat ärsyttää.