Merge pull request #12575 from keymanapp/chore/merge-master-into-dict…

…-breaker chore: merge master into dict-breaker 🔬
keymanapp · Oct 25, 2024 · c3f9917 · c3f9917
2 parents 04cab9d + 0db0b26
commit c3f9917
Show file tree

Hide file tree

Showing 36 changed files with 569 additions and 38 deletions.
diff --git a/.github/workflows/api-verification.yml b/.github/workflows/api-verification.yml
@@ -67,7 +67,7 @@ jobs:
 
     - name: "Verify API for libkeymancore*.so (${{ steps.environment_step.outputs.GIT_BRANCH }}, branch ${{ steps.environment_step.outputs.GIT_BASE_BRANCH }}, by ${{ steps.environment_step.outputs.GIT_USER }})"
       run: |
-        echo "Verify API for libkeymancore*.so (${{ steps.environment_step.outputs.GIT_BRANCH }}, branch ${{ steps.environment_step.outputs.GIT_BASE_BRANCH }}, by ${{ steps.environment_step.outputs.GIT_USER }})" >> $GITHUB_STEP_SUMMARY
+        echo "Verify API for libkeymancore*.so (${{ steps.environment_step.outputs.GIT_BRANCH }}, branch ${{ steps.environment_step.outputs.GIT_BASE_BRANCH }}, by ${{ steps.environment_step.outputs.GIT_USER }}):" >> $GITHUB_STEP_SUMMARY
 
         BIN_PACKAGE=$(ls "${GITHUB_WORKSPACE}/artifacts/" | grep "${PKG_NAME}[0-9]*_${{ steps.environment_step.outputs.VERSION }}-1${{ steps.environment_step.outputs.PRERELEASE_TAG }}+$(lsb_release -c -s)1_amd64.deb")
         cd ${{ github.workspace }}/keyman/linux

diff --git a/HISTORY.md b/HISTORY.md
@@ -1,5 +1,27 @@
 # Keyman Version History
 
+## 18.0.130 alpha 2024-10-24
+
+* fix(android/engine): Increase robustness when checking package kmp.json languages (#12567)
+* chore(ios): support xcode 16 build (#12570)
+
+## 18.0.129 alpha 2024-10-21
+
+* chore(mac): support Xcode 16 build (#12554)
+
+## 18.0.128 alpha 2024-10-14
+
+* docs(developer): add refs to Keyman MIME types (#12540)
+
+## 18.0.127 alpha 2024-10-12
+
+* fix(developer): use TextDecoder to convert Uint8Array to string (#12537)
+
+## 18.0.126 alpha 2024-10-11
+
+* test(common): add markdown link check test for product documentation (#12472)
+* chore(linux): improve output if `dpkg-gensymbols` fails and run other tests (#12527)
+
 ## 18.0.125 alpha 2024-10-10
 
 * chore(common): allow to run `build.sh` scripts in `bashdb` debugger (#12518)

diff --git a/VERSION.md b/VERSION.md
@@ -1 +1 @@
-18.0.126
+18.0.131
diff --git a/android/KMEA/app/src/main/java/com/keyman/engine/packages/JSONUtils.java b/android/KMEA/app/src/main/java/com/keyman/engine/packages/JSONUtils.java
@@ -38,6 +38,9 @@ public static JSONArray getLanguages() {
       return new JSONArray();
     }
     File[] packages = resourceRoot.listFiles();
+    if (packages == null) {
+      return new JSONArray();
+    }
     JSONArray languagesArray = new JSONArray();
     JSONParser parser = new JSONParser();
 
@@ -60,6 +63,9 @@ public static JSONArray getLanguages() {
               String kbdFilename = pkg.getName() + "/" + kbdID + ".js";
 
               // Merge languages
+              if (!kmpKeyboardObj.has("languages")) {
+                continue;
+              }
               JSONArray kmpLanguageArray = kmpKeyboardObj.getJSONArray("languages");
               for (int j=0; j<kmpLanguageArray.length(); j++) {
                 JSONObject languageObj = kmpLanguageArray.getJSONObject(j);

diff --git a/android/KMEA/app/src/test/java/com/keyman/engine/packages/JSONUtilsTest.java b/android/KMEA/app/src/test/java/com/keyman/engine/packages/JSONUtilsTest.java
@@ -19,6 +19,7 @@
 @RunWith(RobolectricTestRunner.class)
 public class JSONUtilsTest {
   private static final File TEST_RESOURCE_ROOT = new File("test_resources", "packages");
+  private static final File TEST_INVALID_RESOURCE_ROOT = new File("test_resources", "invalid_packages");
   private static final String TAG = "JSONUtilsTest";
 
   @Before
@@ -52,6 +53,18 @@ public void test_getLanguages() {
     }
   }
 
+  /**
+   * Test parsing null_languages/kmp.json which has no languages
+   */
+  @Test
+  public void test_invalid_getLanguages() {
+    JSONUtils.initialize(TEST_INVALID_RESOURCE_ROOT);
+    JSONArray result = JSONUtils.getLanguages();
+    final int EXPECTED_NUM_LANGUAGES = 0;
+
+    Assert.assertEquals(EXPECTED_NUM_LANGUAGES, result.length());
+  }
+
   @Test
   public void test_findID() {
     JSONParser parser = new JSONParser();

diff --git a/android/KMEA/test_resources/invalid_packages/null_languages/kmp.json b/android/KMEA/test_resources/invalid_packages/null_languages/kmp.json
@@ -0,0 +1,127 @@
+{
+  "system": {
+    "keymanDeveloperVersion": "11.0.1304.0",
+    "fileVersion": "7.0"
+  },
+  "options": {
+    "graphicFile": "splash.bmp"
+  },
+  "info": {
+    "name": {
+      "description": "Cameroon QWERTY"
+    },
+    "version": {
+      "description": "6.0.2"
+    },
+    "copyright": {
+      "description": "\u00A92018 SIL Cameroon"
+    },
+    "author": {
+      "description": "Matthew Lee",
+      "url": "mailto:[email protected]"
+    },
+    "website": {
+      "description": "LangTechCameroon.info",
+      "url": "LangTechCameroon.info"
+    }
+  },
+  "files": [
+    {
+      "name": "Cameroon.ico",
+      "description": "File Cameroon.ico"
+    },
+    {
+      "name": "sil_cameroon_qwerty.css",
+      "description": "File sil_cameroon_qwerty.css"
+    },
+    {
+      "name": "AndikaAfr-R.ttf",
+      "description": "Font Andika Afr"
+    },
+    {
+      "name": "sil_cameroon_qwerty.kvk",
+      "description": "File sil_cameroon_qwerty.kvk"
+    },
+    {
+      "name": "sil_cameroon_qwerty.kmx",
+      "description": "Keyboard Cameroon QWERTY"
+    },
+    {
+      "name": "splash.bmp",
+      "description": "File splash.bmp"
+    },
+    {
+      "name": "welcome.htm",
+      "description": "File welcome.htm"
+    },
+    {
+      "name": "e_chart.png",
+      "description": "File e_chart.png"
+    },
+    {
+      "name": "e_tableau.png",
+      "description": "File e_tableau.png"
+    },
+    {
+      "name": "helpIcon.png",
+      "description": "File helpIcon.png"
+    },
+    {
+      "name": "ic_launcher.png",
+      "description": "File ic_launcher.png"
+    },
+    {
+      "name": "icon.png",
+      "description": "File icon.png"
+    },
+    {
+      "name": "QwertyColor.png",
+      "description": "File QwertyColor.png"
+    },
+    {
+      "name": "sil-logo-blue.png",
+      "description": "File sil-logo-blue.png"
+    },
+    {
+      "name": "kb.css",
+      "description": "File kb.css"
+    },
+    {
+      "name": "sil_cameroon_qwerty.js",
+      "description": "File sil_cameroon_qwerty.js"
+    },
+    {
+      "name": "globe.png",
+      "description": "File globe.png"
+    },
+    {
+      "name": "longpress-qwerty.png",
+      "description": "File longpress-qwerty.png"
+    },
+    {
+      "name": "modkeys-en-q.png",
+      "description": "File modkeys-en-q.png"
+    },
+    {
+      "name": "modkeys-fr-q.png",
+      "description": "File modkeys-fr-q.png"
+    },
+    {
+      "name": "kmp.inf",
+      "description": "Package information"
+    },
+    {
+      "name": "kmp.json",
+      "description": "Package information (JSON)"
+    }
+  ],
+  "keyboards": [
+    {
+      "name": "Cameroon QWERTY",
+      "id": "sil_cameroon_qwerty",
+      "version": "6.0.2",
+      "oskFont": "AndikaAfr-R.ttf",
+      "displayFont": "AndikaAfr-R.ttf"
+    }
+  ]
+}
diff --git a/android/build.sh b/android/build.sh
@@ -14,6 +14,7 @@ THIS_SCRIPT="$(readlink -f "${BASH_SOURCE[0]}")"
 
 builder_describe \
   "Build Keyman Engine for Android, Keyman for Android, and FirstVoices Android app." \
+  "@/resources/tools/check-markdown  test:help" \
   clean \
   configure \
   build \
@@ -23,6 +24,7 @@ builder_describe \
   --upload-sentry+ \
   ":engine=KMEA                             Keyman Engine for Android" \
   ":app=KMAPro                              Keyman for Android" \
+  ":help                                    Online documentation" \
   ":sample1=Samples/KMSample1               Sample app: KMSample1" \
   ":sample2=Samples/KMSample2               Sample app: KMSample2" \
   ":keyboardharness=Tests/KeyboardHarness   Test app: KeyboardHarness" \
@@ -42,4 +44,7 @@ if builder_start_action clean; then
   builder_finish_action success clean
 fi
 
-builder_run_child_actions configure build test publish
+builder_run_child_actions configure build test
+builder_run_action        test:help    check-markdown  "$KEYMAN_ROOT/android/docs/help"
+
+builder_run_child_actions publish
diff --git a/developer/docs/help/reference/file-types/kmp.md b/developer/docs/help/reference/file-types/kmp.md
@@ -21,6 +21,8 @@ Details:
     Developer will also include a [metadata](metadata) file in the
     package. Lexical model packages contain one lexical model instead of
     keyboards.
+:   .kmp file format has registered MIME type
+    [`application/vnd.keyman.kmp+zip`](https://www.iana.org/assignments/media-types/application/vnd.keyman.kmp+zip).
 
 Distributed with keyboard:
 :   A Keyman keyboard Package file (.KMP) can include keyboard files

diff --git a/developer/docs/help/reference/file-types/kmx.md b/developer/docs/help/reference/file-types/kmx.md
@@ -3,7 +3,7 @@ title: KMX files
 ---
 
 Used by:
-:   <span class="application">Keyman Desktop</span>,
+:   Keyman Core in <span class="application">Keyman for Windows</span>,
     <span class="application">Keyman for macOS</span>, and
     <span class="application">Keyman for Linux</span>.
 
@@ -16,6 +16,8 @@ Details:
     for the keyboard (.ICO/.BMP). Note that .KMX files are not used for
     <span class="application">Keyman for Android</span> and
     <span class="application">Keyman for iPhone and iPad</span>.
+:   .KMX file format has registered MIME type
+    [`application/vnd.keyman.kmx`](https://www.iana.org/assignments/media-types/application/vnd.keyman.kmx).
 
 Distributed with keyboard:
 :   This is the keyboard file. It must be distributed with your package

diff --git a/developer/src/build.sh b/developer/src/build.sh
@@ -11,6 +11,7 @@ THIS_SCRIPT="$(readlink -f "${BASH_SOURCE[0]}")"
 
 builder_describe \
   "Keyman Developer" \
+  "@/resources/tools/check-markdown  test:help" \
   clean \
   configure \
   build \
@@ -20,6 +21,7 @@ builder_describe \
   "install                      Install built programs locally" \
   ":common                      Developer common files" \
   ":ext                         Third party components" \
+  ":help                        Online documentation" \
   ":kmcmplib                    Compiler - .kmn compiler" \
   ":kmc-analyze                 Compiler - Analysis Tools" \
   ":kmc-keyboard-info           Compiler - .keyboard_info Module" \
@@ -125,6 +127,7 @@ fi
 #-------------------------------------------------------------------------------------------------------------------
 
 builder_run_child_actions  clean configure build test
+builder_run_action         test:help    check-markdown  "$KEYMAN_ROOT/developer/docs/help"
 
 #-------------------------------------------------------------------------------------------------------------------
 

diff --git a/developer/src/common/web/utils/src/types/kpj/kpj-file-reader.ts b/developer/src/common/web/utils/src/types/kpj/kpj-file-reader.ts
@@ -14,7 +14,7 @@ export class KPJFileReader {
     let data: KPJFile;
 
     data = new KeymanXMLReader('kpj')
-      .parse(file.toString());
+      .parse(new TextDecoder().decode(file));
 
     data = this.boxArrays(data);
     if(data.KeymanDeveloperProject?.Files?.File?.length) {

diff --git a/developer/src/common/web/utils/src/types/kvks/kvks-file-reader.ts b/developer/src/common/web/utils/src/types/kvks/kvks-file-reader.ts
@@ -22,7 +22,7 @@ export default class KVKSFileReader {
 
     try {
       source = new KeymanXMLReader('kvks')
-        .parse(file.toString()) as KVKSourceFile;
+        .parse(new TextDecoder().decode(file)) as KVKSourceFile;
     } catch(e) {
       if(file.byteLength > 4 && file.subarray(0,3).every((v,i) => v == KVK_HEADER_IDENTIFIER_BYTES[i])) {
         throw new Error('File appears to be a binary .kvk file', {cause: e});

diff --git a/developer/src/common/web/utils/src/types/ldml-keyboard/ldml-keyboard-xml-reader.ts b/developer/src/common/web/utils/src/types/ldml-keyboard/ldml-keyboard-xml-reader.ts
@@ -302,7 +302,7 @@ export class LDMLKeyboardXMLSourceFileReader {
 
   loadTestDataUnboxed(file: Uint8Array): any {
     const source = new KeymanXMLReader('keyboardTest3')
-      .parse(file.toString()) as any;
+      .parse(new TextDecoder().decode(file)) as any;
     return source;
   }
 

diff --git a/developer/src/kmc-package/src/compiler/kmp-compiler.ts b/developer/src/kmc-package/src/compiler/kmp-compiler.ts
@@ -183,7 +183,7 @@ export class KmpCompiler implements KeymanCompiler {
 
         try {
           a = new KeymanXMLReader('kps')
-            .parse(data.toString()) as KpsFile.KpsPackage;
+            .parse(data) as KpsFile.KpsPackage;
         } catch(e) {
           this.callbacks.reportMessage(PackageCompilerMessages.Error_InvalidPackageFile({e}));
         }

diff --git a/ios/Cartfile b/ios/Cartfile
@@ -1,4 +1,4 @@
 github "weichsel/ZIPFoundation" ~> 0.9
 github "devicekit/DeviceKit" ~> 5.0
 github "ashleymills/Reachability.swift"
-github "getsentry/sentry-cocoa" ~> 8.7.0
+github "getsentry/sentry-cocoa" ~> 8.38.0
diff --git a/ios/Cartfile.resolved b/ios/Cartfile.resolved
@@ -1,4 +1,4 @@
-github "ashleymills/Reachability.swift" "v5.1.0"
-github "devicekit/DeviceKit" "5.1.0"
-github "getsentry/sentry-cocoa" "8.15.2"
-github "weichsel/ZIPFoundation" "0.9.17"
+github "ashleymills/Reachability.swift" "v5.2.4"
+github "devicekit/DeviceKit" "5.5.0"
+github "getsentry/sentry-cocoa" "8.38.0"
+github "weichsel/ZIPFoundation" "0.9.19"
diff --git a/ios/build.sh b/ios/build.sh
@@ -1,28 +1,27 @@
 #!/usr/bin/env bash
-
 ## START STANDARD BUILD SCRIPT INCLUDE
 # adjust relative paths as necessary
 THIS_SCRIPT="$(readlink -f "${BASH_SOURCE[0]}")"
 . "${THIS_SCRIPT%/*}/../resources/build/builder.inc.sh"
 ## END STANDARD BUILD SCRIPT INCLUDE
 
-# Include our resource functions; they're pretty useful!
 . "$KEYMAN_ROOT/resources/shellHelperFunctions.sh"
 
-# Please note that this build script (understandably) assumes that it is running on Mac OS X.
-verify_on_mac
-
 builder_describe "Builds Keyman Engine and the Keyman app for use on iOS devices - iPhone and iPad." \
+  "@/resources/tools/check-markdown  test:help" \
   "clean" \
   "configure" \
   "build" \
+  "test" \
   ":engine                      Builds KeymanEngine.xcframework, usable by our main app and by third-party apps" \
   ":app=keyman                  Builds the Keyman app for iOS platforms" \
+  ":help                        Online documentation" \
   ":sample1=Samples/KMSample1   Builds the first KeymanEngine sample app" \
   ":sample2=Samples/KMSample2   Builds the second KeymanEngine sample app" \
   ":fv=../oem/firstvoices/ios   Builds OEM FirstVoices for iOS platforms" \
   "--sim-artifact+              Also outputs a simulator-friendly test artifact corresponding to the build"
 
 builder_parse "$@"
 
-builder_run_child_actions clean configure build
+builder_run_child_actions clean configure build test
+builder_run_action        test:help    check-markdown  "$KEYMAN_ROOT/ios/docs/help"