Kaius Karon - Praktikapäevik

[kaiusk]

Sprint#1

• diplomitöödega tutvumine
• repo forkimine ja seadistamine (githubi õiguste küsimine, API token genereerimine)
• koodiga tutvumine ja esmased katsetused UI's
• backendi readme korrastamine (viited olid valesse reposse)
• koodi korrastamisega alustamine (app.js tükkideks jagamine)
• eslint lisamine, konfimine ja koodi parandamine nii, et eslint jääks rahule
• alustasin unittestide lisamisega (vajalikud node pkg lisatud)
• tiimiga arutasime riske ja plaane tulevikuks

Kõige keerulisem osa oli koodi struktuurist aru saamine. Veel on segane, kuidas täpsemalt kursuste infot git's hoitakse ja kuidas seda sealt kätte saadakse - üldisemalt siis kuidas töötab git'i API

Ajakulu ~20h

[kaiusk]

Sprint#2

octokit'i uurimine (~5h) mermaidi uurimine (~2h) readme kirjutamiseks leidsin sellise asja: https://jefago.github.io/tiny-markdown-editor/

repo loomise testimisel ilmnes huvitav probleem:

• kui repo luuakse, siis POST päringule tuleb kohe OK vastus, aga reaalselt repo on mingi aeg veel tühi
• kui püüdsin lugeda config.json faili, siis sain vastuse 404
• lahenduseks tegin while loop'i, mille sees kontrollin, kas config.json juba saadaval

uue repo loomine (~8h)

päris palju aega (~5h) kulus sellise probleemi lahendamiseks - kui kurususe sai lisatud, siis ei ilmunud see esilehele. Selgus, et probleem selles, et get-repos käsk võtab vaikimisi 30 repot, kuna aga tluhk all on neid juba rohkem, siis osad jäid selle pärast välja. Nüüd on viga parandatud...

[kaiusk]

Sprint#3

• parandasin veel repo loomist: loodud repo ei tulnud UI's nähtavale, kuna andmed cahches ja oli vaja leida koht, kus cache tühjaks teha
• haru lisamise testimine: loogika olemas ja töötab - vaja veel siduda UI'ga (saab teha pärast testimist kasutajatega)
• alustasin kursuse muutmise osaga. See on tõeliselt mahukas tükk ja ühe sprindiga kindlasti valmis ei saa, Esimene probleem, mida lahendada oli see, et hetkel ei ole ühtegi API't, mis annaks kõik andmed ühe kursuse kohta - aga seda on vaja, et ehitada form. Väga hea asi oli vestlus Marttiga - palju häid ideid ja rohkem selgust, kuidas äpp peaks käituma. Siit hargnes kohe järgmine suurem probleem - tükkide taaskasutus. Hetkel on iga kursus 100% ainult selle materjaliga, mis omas repos on kirjeldatud - aga peaks saama linkida teistele repodele. Leidsin, et see config.json, mis meil täna on, peaks tegelikult toetama ka linkimist. Siiski - täna on seal failis viited kõik "slug"'i põhised, aga peaks kasutama hoopis "uuid" välja (mis on küll olemas, aga seda ei kasuta olemasolev kood üldse). Et saaks uuid kasutada, peab ka muutma praegu töötavat koodi (slug -> uuid). Selleks, et kasutaja saaks valida sobivaid tükke (concept) teistest repodest oli vaja API't mis koguks kokku kõik kirjeldatud tükid koos viidetega repodele kus neid kasutatakse. Jagasin kursuse loomise loogilistesse "tükkidesse", mida saaks siis UI's näidata - lõplik versioon selgub peale testimist.
• õppisin, kuidas saab UI's (taas)kasutada koodi tükke. Senises koodis on seda tehtud, aga ilma, et tükile antaks kaasa oma parameetrid. Muutmise osas tuleb see kasuks, kuna paljud kursuse osad on ülesehituselt samad...
• tunnen, et suht suur probleem on selles, et UI's ei kasutata ühtegi raamistiku - see teeb andmete muutmise/lisamise tülikaks - a'la kuidas lahendada failide üleslaadimine või kuidas kasutada form'is keerukaid objekte (array of objects).

[kaiusk]

Sprint #4

Kasutajate testidest lähtudes tegime kursuse lisamise nii, et kasutaja peab andma vaid aine koodi või siis ÕIS'i lingi. Backend'i osa oli minu jaoks üsnagi keeruline - st palju oli asju, millega pole varem otseselt kokku puutunud. Näiteks kuidas express.js võtaks vastu json POST' jms. Backend poole tegin nii, et kasutaja saaks tagasisidet, kui midagi läheb viltu - näiteks ei saa luua kahte sama ÕIS'i koodiga kursust. ~4h

Alustasin uue ühisele api'le (http://users.hk.tlu.ee/) üleminkut. See tähendab kahjuks ka juba varem tehtud osa ümbertegemist, aga asi on seda väärt, sest minu meelest on rakenduse esmane laadimine JUBE aeglane ja see kindlasti ei kutsu uut asja kasutama. Esimese asjana muutsin kasutajate õiguste määramise uue api peale. Järgmiseks hakkasin ringi tegema seda, kuidas reposid näidatakse. Esmalt tõmmatakse uue api abil kõikide kursuste repo lingid ja siis küsitakse github'st nende repode config.json failid ja ÕIS'st sisu. Siin on veel ruumi paremaks tegemisel - ehk saab teha nii, et githubi ei minda ennem, kui konkreetne avatakse õppejõu või õpilase poolt. Ilmselt peaks siis uuele apile veel andmeid juurde lisama.. ~8h

[kaiusk]

Sprint#5

Koosolek kliendiga ~1h, Loeng ~3h Issuete loomine ~1

Nii nagu kokku sai lepitud, siis tõeallikas ainekursuste ja kasutajate kohta saab olema user.hk.tlu.ee api. See tähendab, et ümber tuli teha väga palju asju. Alustasin õpilase avalehest - api käest küsin kasutaja kursused. Siin oli toredaks üllatuseks see, et sama /groups/user/:id andis mulle ka õppejõu kursused :) Iga saadud kasutaja kuruse kohta küsin github'st config.json faili - kui faili ei leita, siis rakendus kursust näidata ei saa. Kuna andmete struktuur on teine, siis tuli pisut muuta vaadete faile - pigem just väljade nimetused jms.

Järgmiseks sammuks oli õpetaja avaleht - siin oli suurem eeltöö juba õpilase vaatega ära tehtud. Õpetaja avalehelt korjasin ära "teiste õpetajate kursused" sektsiooni - see on plaanis panna eraldi menüü punkti alla.

Järgmine samm - ühe kursuse vaade. Jällegi suured muutused andmete küsimisel ja saatmisel vaatesse. Positiivne oli see, et kood on läinud palju lühemaks ja rakendus kiiremaks. Kuna mul oli vaja pidevalt testida kord õpilase, kord õpetaja vaadet, siis tõmbasin omale HK-Users-Service repo ja panin selle käima kohaliku DB'ga.

Mihkli käest sain ligipääsu http://ainekursus.hk.tlu.ee/ serverile, kuhu panin tööle varasema versiooni, mis veel ei suhtle uue API'ga (tol hetkel oli uus API maas ka). Ülespanemine ei läinud valutult - nimelt oli probleem .env failis githubi muutujatega. Õnneks ledsin serverist eelmise aasta versiooni ja sain sealt õiged .env faili muutujad.

Hetkel oleme umbes täpselt tagasi alguses, ainult et rakendus kasutab uut API't. Kokku tööd vähemalt 10h

[kaiusk]

Sprint#6

Jätkasin uuele apile üleminekuga. Eelmisest korrast jäid teha progressi ülevaate leht ja teiste õppejõudude kursuste leht. Progressi backend osa alustasin nullist - nii oli lihtsam. Parandasin ära tudengi vaates kursuse materjalis liikumiseks "järgmine" ja "eelmine" nupud, samuti parandasin "märgi tehtuks" nupud ja loogika. Sellega seoses komistasin ka enda jaoks uudse probleemi otsa - JSON salvestamine DB'sse. Probleem tekkis sellest, et JSON võtme väärtuseks peab olema kursuse materjali UUID väärtus, see väärtus aga sisaldab "-" märke ja need omakorda ei töötanud JSON_KEYS funktsioonis. Muutsin andmebaasi mariadb'st -> mysql ja siis sain ka JSON_KEYS tööle.

Uue asjana tegime ära kasutaja rolli valiku. juhul kui kasutajal on mitu rolli, siis nüüd saab ta valida, millises rollis soovib vaateid näha.

Samuti uue asjana alustasin "poolikule kursusele" config.json faili loomist - juhul kui api kaudu antakse kursuse repo link, millel puudub config.json fail. siis rakendus ei ole võimeline seda kursuse näitama (avalehel on näha, aga edasi minna ei saa). Hetkel suudab skript luua faili põhilise struktuuri, puudu on veel teemade nimede lugemine failist. Näide - kui kausta nimi on "lessons/loeng_01" siis selle nime peaks lugema "lessons/loeng_01/about.md" failist...

Aega kulus kokku vähemalt 10h

[kaiusk]

Sprint#7

• live serveris sai käima pandud mysql server (dockeri konteiner)
• users api muudatuste sisse viimine: users muutus students ja kursuse lisamine aktsepeerib userId'd
• kursuse arhiveerimine korralikult tööle (õpetaja saab luua master harust enda antud nimega uue haru, e. "arhiivi")
• kui api kaudu saadaval kursusel puudub config.json fail, siis nüüd luuakse algne variant sellest. Õpetaja peab kursuse muutmise vaates tegema parandused ja täiendused, aga vähemalt on võimalik kursust nüüd muutma hakata.
• kursuse muutmisel luuakse automaatselt 'draft' nimega haru ja kui muudatused on tehtud, on võimalik need 'avaldada', ehk et taustal tehakse git merge 'draft' -> 'master' ja 'draft' haru kustutatakse.
• kursuse muutmine. Kuna muudetavaid välju on tohutult, otsustasin tena nii, et salvestamine toimub pidevalt taustal (a'la google docs) ja eraldi "salvesta" nuppu ei ole vaja. Hetkel töötab frontendi pool, st muudatused saadetakse backendi. Iga muudetud väli saadab enda uue väärtuse ja nimena läheb kaasa fail mida muudeti - näiteks {'lessons/lesson_02/README.md': 'uus sisu...'} Backendis on asjad veel pooleli...

Aega kulus: ∞h