Refactoring the web translations

.github/workflows/weblate-merge-po.yml

@@ -35,7 +35,7 @@ jobs:
             zypper --non-interactive ref
 
       - name: Install tools
-        run: zypper --non-interactive install --no-recommends git gettext-tools python3-langtable
+        run: zypper --non-interactive install --no-recommends nodejs npm git gettext-tools python3-langtable
 
       - name: Configure Git
         run: |
@@ -53,61 +53,67 @@ jobs:
           path: agama-weblate
           repository: ${{ github.repository_owner }}/agama-weblate
 
-      - name: Update PO files
+      - name: Install NPM packages
+        working-directory: ./agama/web/share/po
+        run: npm ci
+
+      - name: Validate the PO files
+        working-directory: ./agama-weblate
+        run:  ls web/*.po | xargs -n1 msgfmt --check-format -o /dev/null
+
+      - name: Update JS translations
         working-directory: ./agama
         run: |
-          mkdir -p web/po
+          mkdir -p web/src/po
           # delete the current translations
-          find web/po -name '*.po' -exec git rm '{}' ';'
+          find web/src/po -name '*.js' -exec git rm '{}' ';'
 
-          # copy the new ones
-          mkdir -p web/po
-          cp -a ../agama-weblate/web/*.po web/po
-          git add web/po/*.po
+          # update the list of supported languages, it is used by the PO->JS converter in the next step
+          web/share/update-languages.py --po-directory ../agama-weblate/web > web/src/languages.json
 
-      - name: Validate the PO files
-        working-directory: ./agama
-        run:  ls web/po/*.po | xargs -n1 msgfmt --check-format -o /dev/null
+          # rebuild the JS files
+          (cd web/src/po && SRCDIR=../../../../agama-weblate/web ../../share/po/po-converter.js)
+
+          # stage the changes
+          git add web/src/po/*.js web/src/languages.json
 
-      # any changes besides the timestamps in the PO files?
+      # any changes detected?
       - name: Check changes
         id: check_changes
         working-directory: ./agama
         run: |
-          git diff --staged --ignore-matching-lines="POT-Creation-Date:" \
-            --ignore-matching-lines="PO-Revision-Date:" web/po > po.diff
+          git diff --staged web | tee tr.diff
 
-          if [ -s po.diff ]; then
-            echo "PO files updated"
+          if [ -s tr.diff ]; then
+            echo "Translations updated"
             # this is an Output Parameter
             # https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#setting-an-output-parameter
-            echo "po_updated=true" >> $GITHUB_OUTPUT
+            echo "updated=true" >> $GITHUB_OUTPUT
           else
-            echo "PO files unchanged"
-            echo "po_updated=false" >> $GITHUB_OUTPUT
+            echo "Translations not changed"
+            echo "updated=false" >> $GITHUB_OUTPUT
           fi
 
-          rm po.diff
+          rm tr.diff
 
       - name: Push updated PO files
         # run only when a PO file has been updated
-        if: steps.check_changes.outputs.po_updated == 'true'
+        if: steps.check_changes.outputs.updated == 'true'
         working-directory: ./agama
         run: |
-          web/share/update-languages.py > web/src/languages.json
-          # use a unique branch to avoid possible conflicts with already existing branches
+          # use an unique branch to avoid possible conflicts with already existing branches
           git checkout -b "po_merge_${GITHUB_RUN_ID}"
-          git commit -a -m "Update web PO files"$'\n\n'"Agama-weblate commit: `git -C ../agama-weblate rev-parse HEAD`"
+          git commit -a -m "Update web translation files"$'\n\n'"Agama-weblate commit: `git -C ../agama-weblate rev-parse HEAD`"
           git push origin "po_merge_${GITHUB_RUN_ID}"
 
       - name: Create pull request
         # run only when a PO file has been updated
-        if: steps.check_changes.outputs.po_updated == 'true'
+        if: steps.check_changes.outputs.updated == 'true'
         working-directory: ./agama
         run: |
           gh pr create -B master -H "po_merge_${GITHUB_RUN_ID}" \
             --label translations --label bot \
-            --title "Update web PO files" \
+            --title "Update web translation files" \
             --body "Updating the web translation files from the agama-weblate repository"
         env:
           GH_TOKEN: ${{ github.token }}

rust/agama-server/src/web/http.rs

@@ -23,13 +23,11 @@
 use super::{auth::AuthError, state::ServiceState};
 use agama_lib::auth::{AuthToken, TokenClaims};
 use axum::{
-    body::Body,
     extract::{Query, State},
     http::{header, HeaderMap, HeaderValue, StatusCode},
     response::IntoResponse,
     Json,
 };
-use axum_extra::extract::cookie::CookieJar;
 use pam::Client;
 use serde::{Deserialize, Serialize};
 use utoipa::ToSchema;
@@ -160,61 +158,3 @@ pub async fn session(_claims: TokenClaims) -> Result<(), AuthError> {
 fn auth_cookie_from_token(token: &AuthToken) -> String {
     format!("agamaToken={}; HttpOnly", &token.to_string())
 }
-
-// builds a response tuple for translation redirection
-fn redirect_to_file(file: &str) -> (StatusCode, HeaderMap, Body) {
-    tracing::info!("Redirecting to translation file {}", file);
-
-    let mut response_headers = HeaderMap::new();
-    // translation found, redirect to the real file
-    response_headers.insert(
-        header::LOCATION,
-        // if the file exists then the name is a valid value and unwrapping is safe
-        HeaderValue::from_str(file).unwrap(),
-    );
-
-    (
-        StatusCode::TEMPORARY_REDIRECT,
-        response_headers,
-        Body::empty(),
-    )
-}
-
-// handle the /po.js request
-// the requested language (locale) is sent in the "agamaLang" HTTP cookie
-// this reimplements the Cockpit translation support
-pub async fn po(State(state): State<ServiceState>, jar: CookieJar) -> impl IntoResponse {
-    if let Some(cookie) = jar.get("agamaLang") {
-        tracing::info!("Language cookie: {}", cookie.value());
-        // try parsing the cookie
-        if let Some((lang, region)) = cookie.value().split_once('-') {
-            // first try language + country
-            let target_file = format!("po.{}_{}.js", lang, region.to_uppercase());
-            if state.public_dir.join(&target_file).exists() {
-                return redirect_to_file(&target_file);
-            } else {
-                // then try the language only
-                let target_file = format!("po.{}.js", lang);
-                if state.public_dir.join(&target_file).exists() {
-                    return redirect_to_file(&target_file);
-                };
-            }
-        } else {
-            // use the cookie as is
-            let target_file = format!("po.{}.js", cookie.value());
-            if state.public_dir.join(&target_file).exists() {
-                return redirect_to_file(&target_file);
-            }
-        }
-    }
-
-    tracing::info!("Translation not found");
-    // fallback, return empty javascript translations if the language is not supported
-    let mut response_headers = HeaderMap::new();
-    response_headers.insert(
-        header::CONTENT_TYPE,
-        HeaderValue::from_static("text/javascript"),
-    );
-
-    (StatusCode::OK, response_headers, Body::empty())
-}

rust/agama-server/src/web/service.rs

@@ -115,7 +115,6 @@ impl MainServiceBuilder {
         Router::new()
             .nest_service("/", serve)
             .route("/login", get(login_from_query))
-            .route("/po.js", get(super::http::po))
             .nest("/api", api_router)
             .layer(
                 TraceLayer::new_for_http()

rust/package/agama.changes

@@ -1,3 +1,10 @@
+-------------------------------------------------------------------
+Thu Nov 28 15:58:59 UTC 2024 - Ladislav Slezák <[email protected]>
+
+- Drop the handler for the "po.js" path in the HTTP server,
+  the web frontend now uses dynamic imports for loading the
+  translation files (gh#agama-project/agama#1777)
+
 -------------------------------------------------------------------
 Thu Nov 28 11:07:58 UTC 2024 - Imobach Gonzalez Sosa <[email protected]>
 

web/.gitignore

@@ -7,7 +7,6 @@ coverage/
 dist/
 /*.spec
 /.vagrant
-package-lock.json
 Test*FAIL*
 /bots
 test/common/

web/eslint.config.mjs

@@ -92,6 +92,13 @@ export default [
     files: ["src/i18n.test.js"],
     rules: { "agama-i18n/string-literals": "off" },
   },
+  {
+    // the translation JS files generated from the PO files use some code in the plural form rule,
+    // ignore the possible "problems" there (using "==" operator instead of more strict "===" or not
+    // using the "n" variable in languages which do not have plural form)
+    files: ["src/po/*.js"],
+    rules: { eqeqeq: "off", "@typescript-eslint/no-unused-vars": "off" },
+  },
   {
     ignores: ["node_modules/*", "src/lib/*", "src/**/test-data/*"],
   },