ObjectBox Swift database 4.3.0

Author: greenrobot-team

CHANGELOG.md

@@ -4,9 +4,17 @@ Notable changes to the ObjectBox Swift library.
 
 For more insights into what changed in the ObjectBox C++ core, [check the ObjectBox C changelog](https://github.com/objectbox/objectbox-c/blob/main/CHANGELOG.md).
 
-## Next release
+## 4.3.0 - 2025-05-21
 
 - The generator supports Xcode 16 projects with buildable folders. [#94](https://github.com/objectbox/objectbox-swift/issues/94)
+- External property types and names (via [MongoDB connector Data Mapping](https://sync.objectbox.io/mongodb-sync-connector/mongodb-data-mapping))
+
+### Sync
+
+- Add "Log Events" for important server events, which can be viewed on a new Admin page.
+- Detect and ignore changes for objects that were put but were unchanged.
+- The limit for message size was raised to 32 MB.
+- Transactions above the message size limit now already fail on the client (to better enforce the limit).
 
 ## 4.2.0 - 2025-04-09
 

Source/Gemfile.lock

@@ -5,29 +5,32 @@ GEM
       base64
       nkf
       rexml
-    activesupport (7.1.3.4)
+    activesupport (7.2.2.1)
       base64
+      benchmark (>= 0.3)
       bigdecimal
-      concurrent-ruby (~> 1.0, >= 1.0.2)
+      concurrent-ruby (~> 1.0, >= 1.3.1)
       connection_pool (>= 2.2.5)
       drb
       i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
       minitest (>= 5.1)
-      mutex_m
-      tzinfo (~> 2.0)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
     addressable (2.8.7)
       public_suffix (>= 2.0.2, < 7.0)
     algoliasearch (1.27.5)
       httpclient (~> 2.8, >= 2.8.3)
       json (>= 1.5.1)
     atomos (0.1.3)
     base64 (0.2.0)
-    bigdecimal (3.1.8)
+    benchmark (0.4.0)
+    bigdecimal (3.1.9)
     claide (1.1.0)
-    cocoapods (1.15.2)
+    cocoapods (1.16.2)
       addressable (~> 2.8)
       claide (>= 1.0.2, < 2.0)
-      cocoapods-core (= 1.15.2)
+      cocoapods-core (= 1.16.2)
       cocoapods-deintegrate (>= 1.0.3, < 2.0)
       cocoapods-downloader (>= 2.1, < 3.0)
       cocoapods-plugins (>= 1.0.0, < 2.0)
@@ -41,8 +44,8 @@ GEM
       molinillo (~> 0.8.0)
       nap (~> 1.0)
       ruby-macho (>= 2.3.0, < 3.0)
-      xcodeproj (>= 1.23.0, < 2.0)
-    cocoapods-core (1.15.2)
+      xcodeproj (>= 1.27.0, < 2.0)
+    cocoapods-core (1.16.2)
       activesupport (>= 5.0, < 8)
       addressable (~> 2.8)
       algoliasearch (~> 1.0)
@@ -62,20 +65,21 @@ GEM
       netrc (~> 0.11)
     cocoapods-try (1.2.0)
     colored2 (3.1.2)
-    concurrent-ruby (1.3.3)
-    connection_pool (2.4.1)
+    concurrent-ruby (1.3.5)
+    connection_pool (2.5.3)
     drb (2.2.1)
     escape (0.0.4)
     ethon (0.16.0)
       ffi (>= 1.15.0)
-    ffi (1.17.0)
+    ffi (1.17.2)
     fourflusher (2.3.1)
     fuzzy_match (2.0.4)
     gh_inspector (1.1.3)
-    httpclient (2.8.3)
-    i18n (1.14.5)
+    httpclient (2.9.0)
+      mutex_m
+    i18n (1.14.7)
       concurrent-ruby (~> 1.0)
-    jazzy (0.15.1)
+    jazzy (0.15.3)
       cocoapods (~> 1.5)
       mustache (~> 1.1)
       open4 (~> 1.3)
@@ -85,42 +89,42 @@ GEM
       sassc (~> 2.1)
       sqlite3 (~> 1.3)
       xcinvoke (~> 0.3.0)
-    json (2.7.2)
+    json (2.12.0)
     liferaft (0.0.6)
-    mini_portile2 (2.8.7)
-    minitest (5.24.1)
+    logger (1.7.0)
+    mini_portile2 (2.8.9)
+    minitest (5.25.5)
     molinillo (0.8.0)
     mustache (1.1.1)
-    mutex_m (0.2.0)
-    nanaimo (0.3.0)
+    mutex_m (0.3.0)
+    nanaimo (0.4.0)
     nap (1.1.0)
     netrc (0.11.0)
     nkf (0.2.0)
     open4 (1.3.4)
     public_suffix (4.0.7)
-    redcarpet (3.6.0)
-    rexml (3.2.9)
-      strscan
-    rouge (4.3.0)
+    redcarpet (3.6.1)
+    rexml (3.4.1)
+    rouge (4.5.2)
     ruby-macho (2.5.1)
     sassc (2.4.0)
       ffi (~> 1.9)
+    securerandom (0.4.1)
     sqlite3 (1.7.3)
       mini_portile2 (~> 2.8.0)
-    strscan (3.1.0)
     typhoeus (1.4.1)
       ethon (>= 0.9.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     xcinvoke (0.3.0)
       liferaft (~> 0.0.6)
-    xcodeproj (1.24.0)
+    xcodeproj (1.27.0)
       CFPropertyList (>= 2.3.3, < 4.0)
       atomos (~> 0.1.3)
       claide (>= 1.0.2, < 2.0)
       colored2 (~> 3.1)
-      nanaimo (~> 0.3.0)
-      rexml (~> 3.2.4)
+      nanaimo (~> 0.4.0)
+      rexml (>= 3.3.6, < 4.0)
 
 PLATFORMS
   ruby

Source/external/objectbox-swift-generator

@@ -13,11 +13,11 @@ set -e
 
 # objectbox-swift release version on GitHub:
 # https://github.com/objectbox/objectbox-swift/releases/download/v${version}
-version=4.2.0
+version=4.3.0
 
 # C library version attached to the GitHub release:
 # ObjectBoxCore-static-${c_version}.zip
-c_version=4.2.0
+c_version=4.3.0
 
 # Params supported by apple-build-static-libs.sh
 if [ -n "$OBX_SKIP_STATIC_C_TESTS" ]; then

Source/fetch_dependencies.command

@@ -25,13 +25,16 @@ Adding a test case requires the following steps:
 1. Open `ToolTestProject.xcodeproj` in Xcode.
 2. Duplicate one of the `ToolTestProjectN` command line tool targets and increase to next highest number `N`.
 3. In `RunToolTests.sh` at the bottom add a command to run the test (replace `<N>` with the chosen number):
+
    ```bash
    # If the code generator should succeed
    test_target_num "Test Name" <N> || ((FAIL++))
    # If the code generator should fail
    fail_codegen_target_num "Test Name" <N> || ((FAIL++))
    ```
+
 4. Add a `ToolTestProjectN.swift` source file (replace `N` again) to the command line tool target. It should look like:
+
     ```swift
     import ObjectBox
 
@@ -47,7 +50,16 @@ Adding a test case requires the following steps:
 5. If the code generator should succeed, add the generated `EntityInfo.generatedN.swift` to the `ToolTestProjectN` 
   command line tool target as well (so it's verified it compiles).
 
-The `RunToolTests.sh` script will run the code generator and pass the "Test Name" as the first parameter. It will also check the code generator output against a file named `Entity.generatedN.swift`, the model file against a `modelN.json` and such.
+The `RunToolTests.sh` script will run the code generator and pass the "Test Name" as the first parameter. It will also 
+check the code generator output against files in the `expected` folder:
+
+- (only if expected to fail) that generator output messages contain messages in a file named like `messages/messagesN.log`,
+- the model file against a file named like `model/modelN.json`,
+- the generated code against a file named like `entity-info/Entity.generatedN.swift`, 
+- a dump of the generator schema against a file named like `schema-dump/schemaDumpN.txt`
+                                
+Note: by default a test will copy the expected model file before running the generator (to avoid UIDs from changing).
+To start with a different model file, add a file like `model/modelN.before.json`.
 
 ### Command line tool target settings
 For reference, all of the command line targets have these settings:

Source/ios-framework/CodeGenTests/README.md

@@ -1,7 +1,8 @@
 #!/bin/bash
 
-#  Run this script from Xcode (target & scheme "CodeGenTests"):
-#  it has a dependency and also relies on variables set by Xcode
+#  This script is run from Xcode (target & scheme "CodeGenTests"):
+#  it has a dependency and also relies on variables set by Xcode.
+#  See README for details.
 
 echo -n "note: Starting tests at $(date)"
 
@@ -19,8 +20,8 @@ if [ -z ${PROJECT_DIR} ]; then
 fi
 
 MYDIR="${PROJECT_DIR}/CodeGenTests" # Xcode copies our script into DerivedData before running it, so hard-code our path.
-
-SOURCERY_APP="${PROJECT_DIR}/../external/objectbox-swift-generator/bin/Sourcery.app"
+PARENT_DIR="$(dirname "$PROJECT_DIR")"
+SOURCERY_APP="${PARENT_DIR}/external/objectbox-swift-generator/bin/Sourcery.app"
 SOURCERY="${SOURCERY_APP}/Contents/MacOS/Sourcery"
 
 EXPECTED_DIR="${MYDIR}/expected"
@@ -173,11 +174,10 @@ fail_codegen_target_num () {
     echo "note: ******************** $2: $1 ********************"
 
     MODEL_FILE_EXPECTED="${EXPECTED_DIR}/model/model${2}.json"
-    ORIGINALMESSAGESFILE="${EXPECTED_DIR}/messages/messages${2}.log"
     MODEL_FILE_BEFORE="${EXPECTED_DIR}/model/model${2}.before.json"
     MODEL_FILE_ACTUAL="${BUILT_PRODUCTS_DIR}/model${2}.json"
-    TESTMESSAGESFILE="${BUILT_PRODUCTS_DIR}/messages${2}.log"
-    DUMP_FILE_EXPECTED="${EXPECTED_DIR}/schema-dump/schemaDump${2}.txt"
+    EXPECTED_MESSAGES_FILE="${EXPECTED_DIR}/messages/messages${2}.log"
+    GENERATOR_LOG_FILE="${BUILT_PRODUCTS_DIR}/generator${2}.log"
     DUMP_FILE_ACTUAL="${MYOUTPUTDIR}/schemaDump${2}.txt"
     ENTITY_INFO_FILE_ACTUAL="${MYOUTPUTDIR}/EntityInfo.generated${2}.swift"
     ORIGINALXCODELOGFILE="${MYDIR}/xcode${2}.log"
@@ -196,21 +196,23 @@ fail_codegen_target_num () {
     # Setting --debug-parsetree for the generator also makes it generate non-random UIDs,
     # see objectbox-swift-generator/Sourcery/main.swift runCLI().
     echo "$SOURCERY --xcode-project \"$TESTPROJECT\" --xcode-target \"ToolTestProject${2}\" --model-json \"$MODEL_FILE_ACTUAL\" --debug-parsetree \"$DUMP_FILE_ACTUAL\" --output \"${ENTITY_INFO_FILE_ACTUAL}\" --disableCache"
-    $SOURCERY --xcode-project "$TESTPROJECT" --xcode-target "ToolTestProject${2}" --model-json "$MODEL_FILE_ACTUAL" --debug-parsetree "$DUMP_FILE_ACTUAL" --output "${ENTITY_INFO_FILE_ACTUAL}" --disableCache > "$TESTMESSAGESFILE" 2>&1
-
-    if [ -e "$ORIGINALMESSAGESFILE" ]; then
-        cmp --silent "$TESTMESSAGESFILE" "$ORIGINALMESSAGESFILE"
-        if [ $? -eq 0 ]; then
-            echo "note: $2: $1: Output as expected."
+    $SOURCERY --xcode-project "$TESTPROJECT" --xcode-target "ToolTestProject${2}" --model-json "$MODEL_FILE_ACTUAL" --debug-parsetree "$DUMP_FILE_ACTUAL" --output "${ENTITY_INFO_FILE_ACTUAL}" --disableCache > "$GENERATOR_LOG_FILE" 2>&1
+
+    if [ -e "$EXPECTED_MESSAGES_FILE" ]; then
+        # Check if the generator output contains the expected messages.
+        # Note: as grep can not handle new lines, remove them before searching.
+        EXPECTED_MESSAGES=$(tr -d '\n' < "$EXPECTED_MESSAGES_FILE")
+        FULL_OUTPUT=$(tr -d '\n' < "$GENERATOR_LOG_FILE")
+        # Use grep --fixed-strings to avoid interpreting the expected string as a regex.
+        # Use --quiet to only return an exit code (0 if there is a match, 1 or greater otherwise).
+        if echo "$FULL_OUTPUT" | grep --quiet --fixed-strings "$EXPECTED_MESSAGES"; then
+            echo "note: $2: $1: Generator logs contain the expected messages."
         else
-            echo "error: $2: $1: Output DIFFERENT!"
-
-            echo "====="
-            echo "opendiff \"$TESTMESSAGESFILE\" \"$ORIGINALMESSAGESFILE\" -merge \"$ORIGINALMESSAGESFILE\""
-#             echo "===== $TESTMESSAGESFILE ====="
-#             cat "$TESTMESSAGESFILE"
-#             echo "===== $ORIGINALMESSAGESFILE ====="
-#             cat "$ORIGINALMESSAGESFILE"
+            echo "error: $2: $1: Generator logs do NOT contain the expected messages!"
+            echo "===== Generator logs $GENERATOR_LOG_FILE ====="
+            cat "$GENERATOR_LOG_FILE"
+            echo "===== Expected to contain $EXPECTED_MESSAGES_FILE ====="
+            cat "$EXPECTED_MESSAGES_FILE"
             echo "====="
             FAIL=1
         fi
@@ -270,7 +272,7 @@ fail_codegen_target_num () {
         rm -f "$MODEL_FILE_ACTUAL"
         rm -f "$ENTITY_INFO_FILE_ACTUAL"
         rm -f "$DUMP_FILE_ACTUAL"
-        rm -f "$TESTMESSAGESFILE"
+        rm -f "$GENERATOR_LOG_FILE"
         rm -f "$TESTXCODELOGFILE"
 
         echo "note: $2: $1: Cleaning up."
@@ -339,7 +341,7 @@ test_target_num "Untyped IDs and queries 1" 49 || ((FAIL++))
 test_target_num "Untyped IDs and queries 2" 50 || ((FAIL++))
 #fail_codegen_target_num "Typed IDs still enforce type?" 51 || ((FAIL++))
 
-fail_codegen_target_num "Ensure we don't write JSON before ID errors" 52 || ((FAIL++))
+fail_codegen_target_num "Model JSON is not written on ID errors" 52 || ((FAIL++))
 test_target_num "ToOne Backlink ensure applyToDb is needed" 53 || ((FAIL++))
 test_target_num "ToMany ensure applyToDb is needed" 54 || ((FAIL++))
 test_target_num "ToMany Backlink ensure applyToDb is needed" 55 || ((FAIL++))
@@ -348,6 +350,7 @@ test_target_num "Optional Template Syntax recognized as optional" 57 || ((FAIL++
 
 fail_codegen_target_num "HNSW index not on float array" 58 || ((FAIL++))
 test_target_num "HNSW index" 59 || ((FAIL++))
+test_target_num "ExternalType and ExternalName annotations" 60 || ((FAIL++))
 
 echo "note: Finished tests with $FAIL failures"