Merge pull request #42 from session-foundation/fix-localiser-with-latest-string

fix: use latest strings and localiser

Author: mikimandoki

.github/workflows/pull.yml

@@ -0,0 +1,57 @@
+name: Lint
+
+on:
+  pull_request:
+    branches:
+      - main
+      - dev
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    env:
+      GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+    steps:
+      - run: git config --global core.autocrlf false
+
+      - name: Checkout git repo
+        uses: actions/checkout@v4
+        with:
+          lfs: true
+
+      - name: Install node
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: '.nvmrc'
+
+      - uses: actions/cache/restore@v4
+        id: cache-playwright-modules
+        with:
+          path: node_modules
+          key: ${{ runner.os }}-${{ runner.arch }}-${{ hashFiles('package.json', 'yarn.lock', 'patches/**') }}
+
+      - name: Install dependencies
+        shell: bash
+        if: steps.cache-playwright-modules.outputs.cache-hit != 'true'
+        run: yarn install --immutable
+
+      - uses: actions/cache/save@v4
+        id: cache-playwright-modules-save
+        with:
+          path: node_modules
+          key: ${{ runner.os }}-${{ runner.arch }}-${{ hashFiles('package.json', 'yarn.lock', 'patches/**') }}
+
+      - name: Lint Files
+        run: yarn lint-check
+
+      - name: Compile typescript files
+        shell: bash
+        run: yarn tsc
+
+      - name: Run the only test we can without a browser
+        shell: bash
+        run: PRINT_FAILED_TEST_LOGS=1 npx playwright test  -g "Enforce localized strings return expected values"

.prettierignore

@@ -1,4 +1,5 @@
 .prettierrc.json
 .eslintrc.js
 README.md
-tests/localization/*.ts
+tests/localization/*.ts
+tests/localization/*

eslint.config.mjs

@@ -13,6 +13,7 @@ export default tseslint.config(
       'eslint.config.mjs',
       'run/**/*.js',
       'avd/',
+      'tests/localization/*',
     ],
   },
   eslint.configs.recommended,

package.json

@@ -32,6 +32,7 @@
   "scripts": {
     "build": "yarn tsc --watch",
     "lint": "yarn prettier . --write --cache && yarn eslint .",
+    "lint-check": "yarn prettier . --check && yarn eslint .",
     "dev": "yarn tsc --watch",
     "test": "npx playwright test",
     "watch": "tsc -w",

tests/automation/enforce_localized_str.spec.ts

@@ -1,12 +1,17 @@
 import { test } from '@playwright/test';
 import * as fs from 'fs';
 import * as path from 'path';
+
+import type {
+  TokenPluralWithArgs,
+  TokenSimpleNoArgs,
+  TokenSimpleWithArgs,
+} from '../localization/locales';
+
 import { englishStrippedStr } from '../localization/englishStrippedStr';
 import {
   isPluralToken,
   type MergedLocalizerTokens,
-  type PluralLocalizerTokens,
-  type SimpleLocalizerTokens,
 } from '../localization/Localizer';
 
 function readTsFiles(dir: string): Record<string, string> {
@@ -46,8 +51,8 @@ function extractAllTokens(text: string) {
 
 function getExpectedStringFromKey(
   args:
-    | { key: SimpleLocalizerTokens }
-    | { key: PluralLocalizerTokens; count: number },
+    | { key: TokenPluralWithArgs; count: number }
+    | { key: TokenSimpleNoArgs | TokenSimpleWithArgs },
 ) {
   if (isPluralToken(args.key)) {
     if (!('count' in args)) {
@@ -126,9 +131,9 @@ function getExpectedStringFromKey(
       return 'Message Requests';
     case 'done':
       return 'Done';
-    case 'passwordSetDescription':
+    case 'passwordSetDescriptionToast':
       return 'Your password has been set. Please keep it safe.';
-    case 'passwordChangedDescription':
+    case 'passwordChangedDescriptionToast':
       return 'Your password has been changed. Please keep it safe.';
     case 'sessionPrivacy':
       return 'Privacy';
@@ -245,7 +250,7 @@ function getExpectedStringFromKey(
     case 'recoveryPasswordHidePermanentlyDescription2':
       return 'Are you sure you want to permanently hide your recovery password on this device? This cannot be undone.';
     default:
-      // returning nul means we don't have an expected string yet for this key.
+      // returning null means we don't have an expected string yet for this key.
       // This will make the test fail
       return null;
   }

tests/automation/password.spec.ts

@@ -46,7 +46,7 @@ test_Alice_1W_no_network('Set Password', async ({ alice, aliceWindow1 }) => {
   await waitForTestIdWithText(
     aliceWindow1,
     'session-toast',
-    englishStrippedStr('passwordSetDescription').toString(),
+    englishStrippedStr('passwordSetDescriptionToast').toString(),
   );
   // Click on settings tab
   await sleepFor(300, true);
@@ -88,7 +88,7 @@ test_Alice_1W_no_network('Set Password', async ({ alice, aliceWindow1 }) => {
   await waitForTestIdWithText(
     aliceWindow1,
     'session-toast',
-    englishStrippedStr('passwordChangedDescription').toString(),
+    englishStrippedStr('passwordChangedDescriptionToast').toString(),
   );
 });