Better async at the start

Savegames using Alpine.js persistence

requirements-server.txt

@@ -50,11 +50,11 @@ mdurl==0.1.2
     # via markdown-it-py
 packaging==24.2
     # via gunicorn
-pydantic==2.9.2
+pydantic==2.10.1
     # via
     #   fastapi
     #   pydantic-settings
-pydantic-core==2.23.4
+pydantic-core==2.27.1
     # via pydantic
 pydantic-settings==2.6.1
     # via -r requirements.in
@@ -86,7 +86,7 @@ typing-extensions==4.12.2
     #   pydantic
     #   pydantic-core
     #   typer
-uvicorn==0.32.0
+uvicorn==0.32.1
     # via
     #   fastapi
     #   fastapi-cli

requirements.txt

@@ -46,11 +46,11 @@ markupsafe==3.0.2
     # via jinja2
 mdurl==0.1.2
     # via markdown-it-py
-pydantic==2.9.2
+pydantic==2.10.1
     # via
     #   fastapi
     #   pydantic-settings
-pydantic-core==2.23.4
+pydantic-core==2.27.1
     # via pydantic
 pydantic-settings==2.6.1
     # via -r requirements.in
@@ -82,7 +82,7 @@ typing-extensions==4.12.2
     #   pydantic
     #   pydantic-core
     #   typer
-uvicorn==0.32.0
+uvicorn==0.32.1
     # via
     #   fastapi
     #   fastapi-cli

src/alfagok/main.py

@@ -1,9 +1,9 @@
 """Main alfagok API application."""
 import logging
-from datetime import date
+from datetime import date, datetime, timezone
 from typing import Union
 
-from fastapi import FastAPI, Request
+from fastapi import FastAPI, Request, HTTPException
 from fastapi.responses import HTMLResponse
 from fastapi.staticfiles import StaticFiles
 from fastapi.templating import Jinja2Templates
@@ -11,6 +11,9 @@ from pydantic import DirectoryPath, FilePath
 from pydantic_settings import BaseSettings
 
 
+VERSION = '0.3.0'
+
+
 class Settings(BaseSettings):
     """Configuration needed for alfagok to find its word list, using environment variables."""
 
@@ -51,11 +54,19 @@ if settings.debug:
 
 def get_game_id():
     """Calculate the index for the game/word we are handling today."""
-    today = date.today()
+    today = datetime.now(timezone.utc).date()
     # Calculate the amount of days since the start of the games so we know which word is used today
     return (today - settings.start_date).days
 
 
+def get_game_deadline():
+    """Calculate the amount of time left for the current game."""
+    this_moment = datetime.now(timezone.utc)
+    midnight = datetime.now(timezone.utc).replace(hour=23, minute=59, second=59, microsecond=0)
+    # Calculate the amount of time left till midnight (and the start of the next game)
+    return midnight - this_moment
+
+
 def is_valid_dictionary_word(word: str) -> bool:
     """Verify if `word` is in the dictionary provided."""
     # Either we: [ ] strip all the endlines during file load, or [x] use the endline to search here
@@ -66,13 +77,13 @@ def is_valid_dictionary_word(word: str) -> bool:
 async def index(request: Request):
     """Generate the main HTML page of the game."""
     language = 'nl'
-    return templates.TemplateResponse(request=request, name='index.html', context={'language': language})
+    return templates.TemplateResponse(request=request, name='index.html', context={'language': language, 'version': VERSION})
 
 
 @app.get('/api/game')
 def what_game():
-    """Handle incoming guess."""
-    return {'game': get_game_id()}
+    """Which game is currently on?"""
+    return {'game': get_game_id(), 'deadline': get_game_deadline()}
 
 
 @app.get('/api/guess/{word}')
@@ -98,7 +109,10 @@ def handle_guess(word: Union[str, None] = None):
 
 
 @app.get('/api/answer/{item_id}')
-def read_item(item_id: int, guess: Union[str, None] = None):
-    """Get the word for the current game."""
+def read_item(item_id: int):
+    """Get the word for the game with ID `item_id`."""
+    current_game_id = get_game_id()
+    if item_id > current_game_id:
+        raise HTTPException(status_code=403, detail='No peaking!')
     word = words[item_id].strip()
-    return {'item_id': item_id, 'guess': guess, 'word': word}
+    return {'item_id': item_id, 'word': word}

src/alfagok/static/game.css

@@ -37,6 +37,10 @@ a.title {
     color: #CCC;;
 }
 
+.guessesheading, .guessesbefore, .guessesafter {
+    text-align: center;
+}
+
 input[type="text"] {
     box-sizing: border-box;
     width: 100%;

src/alfagok/static/game.js

@@ -1,31 +1,39 @@
 document.addEventListener('alpine:init', () => {
     Alpine.store('alfagok', {
-        // isLocalStorageAvailable: this.testLocalStorage(),
-        isLocalStorageAvailable: false,
-
-        /* Main alfagok application, state etc */
-        gameID: 0,
+        /** Main alfagok application, state etc */
+        gameID: Alpine.$persist(0).as('gameID'),
+        countingDown: '',
+        nextGameIn: 0,
+        gameFetchedAt: null,
 
         loading: false,
 
-        winTime: null,
-        startTime: null,
-        gaveUpTime: null, // not implemented yet
+        winTime: Alpine.$persist(null).as('winTime'),
+        startTime: Alpine.$persist(null).as('startTime'),
+        gaveUpTime: Alpine.$persist(null).as('gaveUpTime'), // not implemented yet
 
-        nrGuesses: 0,
-        guessesBefore: [],
-        guessesAfter: [],
+        nrGuesses: Alpine.$persist(0).as('nrGuesses'),
+        guessesBefore: Alpine.$persist([]).as('guessesBefore'),
+        guessesAfter: Alpine.$persist([]).as('guessesAfter'),
 
-        guessValue: '',
+        guessValue: Alpine.$persist('').as('guessValue'),
 
         guessError: '',
 
-        resultGameID: '',
-        resultGuesses: '',
-        resultTimeTaken: '',
+        resultGameID: Alpine.$persist('').as('resultGameID'),
+        resultGuesses: Alpine.$persist('').as('resultGuesses'),
+        resultTimeTaken: Alpine.$persist('').as('resultTimeTaken'),
 
+        async init() {
+            /** Initialise the application after loading */
+            await this.getGameID();
+            setInterval(() => {
+                // Update counter to next game (midnight UTC, fetched from API) every second
+                this.countDownTimer();
+            }, 1000);
+        },
         async getGameID() {
-            /* Get the game number from the backend */
+            /** Get the game number from the backend */
             this.loading = true;
             console.log('Loading gameID...');
             let response = await fetch('/api/game');
@@ -33,11 +41,19 @@ document.addEventListener('alpine:init', () => {
             console.log(result);
             this.loading = false;
             if (result.game) {
+                if (this.gameID !== result.game) {
+                    this.setEmptyGameState();
+                }
+                this.nextGameIn = result.deadline;
+                this.gameFetchedAt = new Date();
+                if (this.countingDown === '') {
+                    this.countDownTimer();
+                }
                 return this.gameID = result.game;
             }
         },
-
         async doGuess() {
+            /** Handle the newly entered guess */
             this.guessError = null;
 
             /* Normalise on lowercase, and strip whitespace from begin and end, just in case */
@@ -90,12 +106,17 @@ document.addEventListener('alpine:init', () => {
                 this.winTime = new Date();
                 this.resultGameID = '🧩 Puzzel #' + this.gameID;
                 this.resultGuesses = '🤔 '+ this.nrGuesses + ' gokken';
-                this.resultTimeTaken = '⏱️ ' + getFormattedTime(this.winTime - this.startTime);
+                let winTimeDate = new Date(this.winTime);
+                let startTimeDate = new Date(this.startTime);
+                // this.resultTimeTaken = '⏱️ ' + getFormattedTime(this.winTime - this.startTime);
+                this.resultTimeTaken = '⏱️ ' + this.getFormattedTime(winTimeDate - startTimeDate);
             }
         },
         setEmptyGameState() {
+            /** Clean slate for new game */
             this.winTime = null;
             this.startTime = null;
+            this.gaveUpTime = null;
 
             this.nrGuesses = 0;
             this.guessesBefore = [];
@@ -108,76 +129,51 @@ document.addEventListener('alpine:init', () => {
             this.resultGameID = '';
             this.resultGuesses = '';
             this.resultTimeTaken = '';
+        },
+        getFormattedTime(milliseconds) {
+            /** Nicely format time for 'time played' */
+            if (!Number.isInteger(milliseconds)) {
+                return '';
+            }
+            let seconds = Math.round((milliseconds) / 1000);
+            const hours = Math.floor(seconds / 3600);
+            seconds %= 3600;
+            const minutes = Math.floor(seconds / 60);
+            seconds %= 60;
 
-            this.getGameID();
-        },
-        // # Local Storage Persistence
-        storeGameState() {
-        },
-        getStoredGameState() {
-            if (!this.isLocalStorageAvailable) return undefined;
+            const formattedTime = [];
+            if (hours) {
+                formattedTime.push(`${hours}u`);
+            }
+            if (minutes) {
+                formattedTime.push(`${minutes}m`);
+            }
+            if (seconds) {
+                formattedTime.push(`${seconds}s`);
+            }
 
-            const savedGameJson = localStorage.getItem('saveGame');
-            try {
-                return savedGameJSON && JSON.parse(savedGameJSON);
-            } catch (e) {
-                localStorage.removeItem('saveGame');
-            }
-            return undefined;
+            return formattedTime.join(' ') || '0s';
         },
-        loadGameState() {
-            const savedGame = this.getStoredGameState();
+        // # Countdown timer
+        addZero(num){
+            /** Pad with 0 if needed */
+            if (num <= 9) return '0' + num;
+            else return num;
+        },
+        countDownTimer(){
+            /** Update counter to next game (midnight UTC, fetched from API) */
+            if (this.gameFetchedAt === null) { return; }
+            let now = new Date();
+            let gameDataFetched = new Date(this.gameFetchedAt);
+            let nextGameStart = gameDataFetched.setSeconds(gameDataFetched.getSeconds() + this.nextGameIn);
+            let diff =  Math.floor((nextGameStart - now) / 1000);
+            let hoursRemain = Math.floor(diff / (60*60));
+            let minutesRemain = Math.floor((diff - hoursRemain*60*60) / 60);
+            let secondsRemain = Math.floor(diff % 60);
 
-            if (!savedGame || !savedGame.gameID || (savedGame.gameID !== this.gameID)) {
-                this.setEmptyGameState();
-                return;
-            }
-            if (!savedGame || !savedGame.startTime) {
-                this.setEmptyGameState();
-                return;
-            }
-            const startTime = new Date(savedGame.startTime);
-            if (!isPlayDateToday(app.playDate)) {
-                this.setEmptyGameState();
-                return;
-            }
-            const savedGameForToday = getDOY(startTime) === getDOY(now());
-            if (!savedGameForToday) {
-                this.resetSavedGames();
-                this.setEmptyGameState();
-                return;
-            }
-            const {
-                winTime,
-                guessesBefore,
-                guessesAfter,
-                guessValue,
-            } = savedGame;
-            const gaveUpTime = null; // to be implemented
-            this.startTime = startTime;
-            this.winTime = (winTime && new Date(winTime)) || null;
-            this.guessesBefore = guessesBefore || [];
-            this.guessesAfter = guessesAfter || [];
-            if (gaveUpTime || this.winTime) {
-                this.guessValue = guessValue;
-            }
-        },
-        resetSavedGames() {
-            localStorage.removeItem('saveGame');
-        },
-        testLocalStorage() {
-            // stolen from https://stackoverflow.com/questions/16427636/check-if-localstorage-is-available
-            const test = 'test';
-            try {
-                localStorage.setItem(test, test);
-                localStorage.removeItem(test);
-                this.isLocalStorageAvailable = true;
-            } catch (e) {
-                this.isLocalStorageAvailable = false;
-            }
-            console.log('Local storage is available? ' + this.isLocalStorageAvailable);
+            this.countingDown = this.addZero(hoursRemain) + ':' + this.addZero(minutesRemain) + ':' + this.addZero(secondsRemain) + ' over';
         }
-    }),
+    })
 
     Alpine.store('darkMode', {
         /* Different Alpine app, dark mode settings for the game */
@@ -195,35 +191,9 @@ document.addEventListener('alpine:init', () => {
 });
 
 
-/* Time formatting **/
-
-function getFormattedTime(milliseconds) {
-    if (!Number.isInteger(milliseconds)) {
-        return '';
-    }
-    let seconds = Math.round((milliseconds) / 1000);
-    const hours = Math.floor(seconds / 3600);
-    seconds %= 3600;
-    const minutes = Math.floor(seconds / 60);
-    seconds %= 60;
-
-    const formattedTime = [];
-    if (hours) {
-        formattedTime.push(`${hours}u`);
-    }
-    if (minutes) {
-        formattedTime.push(`${minutes}m`);
-    }
-    if (seconds) {
-        formattedTime.push(`${seconds}s`);
-    }
-
-    return formattedTime.join(' ') || '0s';
-}
-
 /* Clipboard stuff **/
 
-var clip = new Clipboard('.copy');
+let clip = new ClipboardJS('.copy');
 
 clip.on("success", function(e) {
   document.getElementById('copyresults').innerHTML = '<p style="font-size:var(--small);opacity:50%">Gekopieerd! Deel je resultaat.</p>';
@@ -235,35 +205,9 @@ clip.on("error", function() {
 });
 
 
-/* Game timer, original from alphaguess.com **/
-
-function go() {
-  window.timerID = window.setInterval(timer, 0);
-}
-
-function timer(){
-  var nextgame = document.getElementById('nextgame');
-  var now = new Date();
-  var midnight = new Date(now.getFullYear(), now.getMonth(), now.getDate()+1, 0, 0, 0);
-  var diff =  Math.floor((midnight - now)/1000);
-  var hoursRemain   = Math.floor(diff/(60*60));
-  var minutesRemain = Math.floor((diff-hoursRemain*60*60)/60);
-  var secondsRemain = Math.floor(diff%60);
-  nextgame.innerHTML   = '<span class="nextgame">'+addZero(hoursRemain)+':'+addZero(minutesRemain)+':'+addZero(secondsRemain)+' over</span>';
-}
-
-function addZero(num){
-  if(num <=9) return '0'+num;
-  else return num;
-}
-
-go();
-
-
 /* Get current gameID etc **/
 
-document.addEventListener('alpine:initialized', () => {
+// document.addEventListener('alpine:initialized', () => {
     /* On AlpineJS completely loaded, do all this */
-    Alpine.store('alfagok').getGameID();
-    Alpine.store('alfagok').testLocalStorage();
-})
+    // Alpine.store('alfagok').getGameID();
+// })

src/alfagok/templates/index.html

@@ -5,71 +5,67 @@
         <meta charset="UTF-8">
         <meta name="viewport" content="width=device-width, initial-scale=1.0">
         <meta name="description" content="Raad het woord van de dag. Elke gok geeft een hint over waar het woord zich in het alfabet bevindt. Iedereen speelt hetzelfde woord.">
-        <link rel="stylesheet" href="/static/game.css">
-        <link id="favicon" rel="icon" type="image/x-icon" href="static/images/favicon.ico">
-        <link rel="apple-touch-icon" sizes="180x180" href="static/images/apple-touch-icon.png">
-        <link rel="icon" type="image/png" sizes="32x32" href="static/images/favicon-32x32.png">
-        <link rel="icon" type="image/png" sizes="16x16" href="static/images/favicon-16x16.png">
-        <link rel="manifest" href="static/images/site.webmanifest">
+        <link rel="stylesheet" href="/static/game.css?v={{ version }}">
+        <link id="favicon" rel="icon" type="image/x-icon" href="/static/images/favicon.ico">
+        <link rel="apple-touch-icon" sizes="180x180" href="/static/images/apple-touch-icon.png">
+        <link rel="icon" type="image/png" sizes="32x32" href="/static/images/favicon-32x32.png">
+        <link rel="icon" type="image/png" sizes="16x16" href="/static/images/favicon-16x16.png">
+        <link rel="manifest" href="/static/images/site.webmanifest">
+        <script src="https://cdn.jsdelivr.net/npm/@alpinejs/persist@3.x.x/dist/cdn.min.js"></script>
         <script defer src="https://cdn.jsdelivr.net/npm/alpinejs@3.x.x/dist/cdn.min.js"></script>
     </head>
     <body>
 
         <div id="container" x-data="">
 
-            <a href="/" x-cloak class="title">alfagok</a> <span class="puzzleno">puzzel #<span x-text="$store.alfagok.gameID"></span> • <span id="nextgame"></span> • <span x-text="$store.alfagok.nrGuesses"></span> gokken</span>
+            <a href="/" x-cloak class="title">alfagok</a> <span class="puzzleno">puzzel #<span x-text="$store.alfagok.gameID"></span> • <span x-text="$store.alfagok.countingDown"></span> • <span x-text="$store.alfagok.nrGuesses"></span> gokken</span>
 
             <div x-cloak class="instructions" x-show="$store.alfagok.guessesBefore.length === 0 && $store.alfagok.guessesAfter.length === 0">
                 <p>Raad het woord van de dag. Elke gok geeft een hint over waar het woord zich in het alfabet bevindt.</p>
-                <p x-show="$store.alfagok.isLocalStorageAvailable"></p>
             </div>
 
-            <center>
+            <p class="guessesheading" x-cloak x-show="$store.alfagok.guessesBefore.length">Het woord van de dag komt <em>na</em>:</p>
+            <ul class="guessesbefore">
+                <template x-for="item in $store.alfagok.guessesBefore" :key="item">
+                    <li x-text="item"></li>
+                </template>
+            </ul>
 
-                <p class="guessesheading" x-cloak x-show="$store.alfagok.guessesBefore.length">Het woord van de dag komt <em>na</em>:</p>
-                <ul class="guessesbefore">
-                    <template x-for="item in $store.alfagok.guessesBefore" :key="item">
-                        <li x-text="item"></li>
-                    </template>
-                </ul>
-
-                <div x-show="!$store.alfagok.winTime">
-                    <input type="text" autocomplete="new-password" autocorrect="off" x-model="$store.alfagok.guessValue" @keyup.enter="$store.alfagok.doGuess()">
+            <div x-show="!$store.alfagok.winTime">
+                <input type="text" autocomplete="new-password" autocorrect="off" x-model="$store.alfagok.guessValue" @keyup.enter="$store.alfagok.doGuess()">
 {#                <p x-cloak>Je huidige gok is: <span x-text="$store.alfagok.guessValue"></span></p>#}
-                    <button @click="$store.alfagok.doGuess()">Doe een gok</button>
-                    <p class="error" x-cloak x-show="$store.alfagok.guessError" x-text="$store.alfagok.guessError"></p>
-                </div>
+                <button @click="$store.alfagok.doGuess()">Doe een gok</button>
+                <p class="error" x-cloak x-show="$store.alfagok.guessError" x-text="$store.alfagok.guessError"></p>
+            </div>
 
-                <div x-cloak x-show="$store.alfagok.winTime" class="win">
-                    <h3><b>Je hebt hem! 🎉</b></h3>
-                    <p>Het woord van vandaag was <b x-text="$store.alfagok.guessValue"></b>.</p>
-                    <div id="stats">
-                        <div id="results">
-                            <p><b x-text="$store.alfagok.resultGameID"></b></p>
-                            <p x-text="$store.alfagok.resultGuesses"></p>
-                            <p x-text="$store.alfagok.resultTimeTaken"></p>
-                            <p>🔗 <span style="color:var(--blue)">alfagok.diginaut.net</span></p>
-                        </div>
+            <div x-cloak x-show="$store.alfagok.winTime" class="win">
+                <h3><b>Je hebt hem! 🎉</b></h3>
+                <p>Het woord van vandaag was <b x-text="$store.alfagok.guessValue"></b>.</p>
+                <div id="stats">
+                    <div id="results">
+                        <p><b x-text="$store.alfagok.resultGameID"></b></p>
+                        <p x-text="$store.alfagok.resultGuesses"></p>
+                        <p x-text="$store.alfagok.resultTimeTaken"></p>
+                        <p>🔗 <span class="link">alfagok.diginaut.net</span></p>
                     </div>
-                    <div id="copyresults"></div>
-                    <button class="copy" data-clipboard-target="#results">
-                          Tik om te kopi&euml;ren en te delen ❤️
-                    </button>
                 </div>
+                <div id="copyresults"></div>
+                <button class="copy" data-clipboard-target="#results">
+                      Tik om te kopi&euml;ren en te delen ❤️
+                </button>
+            </div>
 
-                <p class="guessesheading" x-cloak x-show="$store.alfagok.guessesAfter.length">Het woord van de dag komt <em>voor</em>:</p>
-                <ul class="guessesafter">
-                    <template x-for="item in $store.alfagok.guessesAfter" :key="item">
-                        <li x-text="item"></li>
-                    </template>
-                </ul>
-
-            </center>
+            <p class="guessesheading" x-cloak x-show="$store.alfagok.guessesAfter.length">Het woord van de dag komt <em>voor</em>:</p>
+            <ul class="guessesafter">
+                <template x-for="item in $store.alfagok.guessesAfter" :key="item">
+                    <li x-text="item"></li>
+                </template>
+            </ul>
 
         </div>
 
-        <script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/1.5.12/clipboard.min.js" rel=preload></script>
-        <script src="/static/game.js"></script>
+        <script src="https://cdn.jsdelivr.net/npm/clipboard@2.0.11/dist/clipboard.min.js"></script>
+        <script src="/static/game.js?v={{ version }}"></script>
 {#
         <button x-data @click="$store.darkMode.toggle()">Toggle Dark Mode</button>
         <div x-data :class="$store.darkMode.on && 'bg-black'">...</div>