1.5.0 collected changes

Author: greenrobot

README.md

@@ -73,6 +73,7 @@ Here's a list of ObjectBox releases, and the Swift versions they were compiled w
 
 | ObjectBox version(s) | Swift version |
 |:--------------------:|:-------------:|
+|        1.5.0         |     5.3(.2)   |        
 |        1.4.1         |      5.3      |        
 |      1.3, 1.4.0      |      5.2      |        
 |         1.2          |      5.1      |
@@ -138,7 +139,7 @@ License
 -------
 All files in this repository are under the Apache 2 license:
 
-    Copyright 2018-2020 ObjectBox Ltd. All rights reserved.
+    Copyright 2018-2021 ObjectBox Ltd. All rights reserved.
 
     Licensed under the Apache License, Version 2.0 (the "License");
     you may not use this file except in compliance with the License.

Source/Makefile

@@ -17,7 +17,7 @@ build_swiftlint:
 build_sourcery:
 	@echo "$(BLUE)Building Sourcery...$(NC)"
 	@echo $(SOURCERY_PATH)
-	(cd "$(SOURCERY_PATH)"; swift build --configuration release)
+	(cd "$(SOURCERY_PATH)"; rake build)
 
 archive_framework:
 	(cd "$(FRAMEWORK_PATH)"; make all)

Source/README.md

@@ -8,12 +8,29 @@ Repository Contents
 -------------------
 - `ios-framework/`: The Cocoa Swift framework.
     - `docs/swift_output/`: The generated framework documentation.
-- `external/`: git submodule and pre-built binary container.
+- `external/`: git submodule and/or pre-built binary container.
    This contains the ObjectBoxCore static libraries and our code generator.
-- `fetch_dependencies.command`: Script for downloading libObjectBoxCore into `externals`.
-   You must run this script before you can build the framework.
 - `docs/`: Documentation and discussion of concepts, ideas, and approaches to bring ObjectBox to Swift.
 
+**Scripts** and how they depend on each other (subject to future simplifications):
+
+- `fetch_dependencies.command`: populates `external/objectbox-static` with libObjectBoxCore.
+  libObjectBoxCore is a crucial requirement build the Swift framework.
+- `create-xcframework.sh`: builds the multi-platform archive containing binaries for multiple platforms and architectures.
+
+Tests
+-----
+ObjectBox comes with a couple of tests of different categories:
+
+* Unit tests: `ios-framework/CommonTests`, based on XCTestCase
+* Integration tests "CodeGen": `ios-framework/CodeGenTests` run via script (for now only via Xcode/xcodebuild);
+  uses a separate Xcode project and an ObjectBox generator executable to generate actual binding classes.
+  [README](ios-framework/CodeGenTests/README.md)
+* Integration tests "IntegrationTests": `ios-framework/IntegrationTests`, currently not maintained, run via script;
+  somewhat similar to CodeGen; subject to a general clean up; see also its [README](ios-framework/IntegrationTests/Readme.md)
+* External integration test project: https://github.com/objectbox/objectbox-swift-integration-test
+  runs "real projects" with "full ObjectBox round-trip" on internal CI and CircleCI
+
 Setup
 -----
 * Install latest Xcode (Swift 5.3+) with command line tools prepared to build from the shell
@@ -98,9 +115,6 @@ You look at and build the framework itself via `ios-framework/ObjectBox.xcodepro
 
 Build notes
 -----------
-* Build phases; check Xcode project
-  * "Rename C Header": takes the standard C objectbox.h and augments it with some Swift specifics into ObjectBoxC.h
-    (TODO: Can we do this differently, e.g. use the standard objectbox.h and then have a second .h for Swift specifics?)
 * SwiftLint (macOS build only): calls `swiftlint lint --config .swiftlint-macOS.yml`
   * Edit .swiftlint-macOS.yml file to customize (e.g. "id" is OK despite less than 3 chars)
 
@@ -175,4 +189,3 @@ xcodebuild -derivedDataPath ./DerivedData test -project ObjectBox.xcodeproj -sch
 xcodebuild -derivedDataPath ./DerivedData test -project ObjectBox.xcodeproj -scheme ObjectBox-iOS -destination 'platform=iOS Simulator,name=iPhone 11' -only-testing ObjectBoxTests-iOS/StoreTests/test32vs64BitForOs | xcpretty
 ```
 
-

Source/create-xcframework.sh

@@ -7,26 +7,40 @@ myDir=$( cd "$(dirname "$0")" ; pwd -P )
 cd "${myDir}/ios-framework"
 dir_build="${myDir}/build-deploy"
 mkdir -p "$dir_build"
+derived_data_path=$( mktemp -d )
 
-function build_archive() {
+function build() {
   echo "************* Building archive for $1 $2 (${3:-$1}) *************"
-  xcodebuild archive -scheme "$1" -destination "$2" -archivePath "$dir_build/${3:-$1}" \
-    SKIP_INSTALL=NO BUILD_LIBRARIES_FOR_DISTRIBUTION=YES
+  xcodebuild build \
+    -scheme "$1" \
+    -destination "$2" \
+    -configuration Release \
+    -derivedDataPath "${derived_data_path}" \
+    -quiet \
+    SKIP_INSTALL=NO \
+    BUILD_LIBRARIES_FOR_DISTRIBUTION=YES
 }
 
-build_archive "ObjectBox-macOS" "platform=macOS"
-build_archive "ObjectBox-iOS" "generic/platform=iOS"
-build_archive "ObjectBox-iOS" "generic/platform=iOS Simulator" "ObjectBox-iOS-Sim"
+build "ObjectBox-macOS" "platform=macOS"
+build "ObjectBox-iOS" "generic/platform=iOS"
+build "ObjectBox-iOS Simulator" "generic/platform=iOS Simulator"
 
 echo "************* Building XCFramework *************"
 path_in_xcarchive="Products/Library/Frameworks/ObjectBox.framework"
 dir_xcframework="$dir_build/ObjectBox.xcframework"
 rm -rf "$dir_xcframework"
-xcodebuild -create-xcframework -output "$dir_xcframework" \
- -framework "$dir_build/ObjectBox-macOS.xcarchive/$path_in_xcarchive" \
- -framework "$dir_build/ObjectBox-iOS.xcarchive/$path_in_xcarchive" \
- -framework "$dir_build/ObjectBox-iOS-Sim.xcarchive/$path_in_xcarchive"
 
-zip -r "$dir_xcframework.zip" "$dir_xcframework"
+xcodebuild -create-xcframework \
+  -output "$dir_xcframework" \
+  -framework "${derived_data_path}/Build/Products/Release/ObjectBox.framework" \
+  -framework "${derived_data_path}/Build/Products/Release-iphoneos/ObjectBox.framework" \
+  -framework "${derived_data_path}/Build/Products/Release-iphonesimulator/ObjectBox.framework"
 
-ls -lh "$dir_xcframework.zip"
+pushd "$dir_xcframework/.."
+zip --symlinks -r -o "$dir_xcframework.zip" "ObjectBox.xcframework"
+popd
+
+rm -rf ${derived_data_path}
+
+ls -lh "$dir_xcframework.zip"
+xcrun swift package compute-checksum "$dir_xcframework.zip"

Source/fetch_dependencies.command

@@ -27,9 +27,47 @@ if [ "$verify_only" = true ]; then
 else
 
 if [ -d "$code_dir" ]; then # Do we have an existing code repo?
-    pushd "$code_dir"  # todo fix this workaround for building into cbuild dir in "our" objectbox-swift dir
-    echo "Have repository, building."
-    "$code_dir/scripts/apple-build-static-libs.sh" "$dest_dir" release
+    pushd "$code_dir"  # note: this also "fixed" building into cbuild dir in "our" objectbox-swift dir
+    build_params="" # must also part of the cache key
+    commit_id=$(git rev-parse HEAD)
+    cache_dir="$HOME/Library/Caches/ObjectBox"
+    mkdir -p "${cache_dir}"
+    find "${cache_dir}" -name "objectbox-static-*.zip" -type f -mtime +30 # -delete # TODO enable delete once this looks good
+    cache_key="${commit_id}"
+    if [ -n "$build_params" ]; then
+      cache_key="${cache_key}-$(echo "$build_params" | tr -cd '[a-zA-Z0-9]._-')"
+    fi
+    cache_zip="${cache_dir}/objectbox-static-${cache_key}.zip"
+    do_build=true
+    git_clean=false
+    git_status=$(git status --porcelain)
+    # ignore untracked uws submodule (left over when switching from a sync to a non-sync branch)
+    git_status=${git_status#"?? objectbox/src/main/cpp/external/uws-objectbox/"}
+    if [ -z "$git_status" ]; then
+      git_clean=true
+      if [ -f "${cache_zip}" ]; then
+        echo "ObjectBox core is clean and cache ZIP found for ${cache_key}. Extracting..."
+        unzip -o "${cache_zip}" -d "${dest_dir}"
+        do_build=false
+      else
+        echo "ObjectBox core is clean but no cache ZIP found for ${cache_key}. Building..."
+      fi
+    else
+      git status
+      echo "ObjectBox core is not clean, won't use caching. Building..."
+    fi
+    if [ "$do_build" = true ]; then
+      "$code_dir/scripts/apple-build-static-libs.sh" $build_params "$dest_dir" release
+      if [ "$git_clean" = true ] ; then  # clean before?
+        git_status=${git_status#"?? objectbox/src/main/cpp/external/uws-objectbox/"}
+        if [ -z "$git_status" ]; then  # still clean
+          cp "${dest_dir}/objectbox-static.zip" "${cache_zip}"
+          echo "Cache ZIP created: ${cache_zip}"
+        else
+          echo "Git status is not clean anymore; skipped caching the ZIP"
+        fi
+      fi
+    fi
     popd
 else # Download static public release and unzip into $dest
     if [ ! -d "${dest_dir}" ] || [ ! -e "${dest_dir}/libObjectBoxCore-iOS.a" ]; then
@@ -70,7 +108,14 @@ for filename in ./*.a; do
   # Match our version/date pattern like "2.6.1-2020-06-09"
   obx_version=$(strings "$filename" | grep "[0-9]\.[0-9]\.[0-9]-[0-9][0-9][0-9][0-9]-[0-9][0-9]-[0-9][0-9]")
   echo "  >> Version found: $obx_version"
-  obx_symbols=$(nm -gj "$filename" | grep -c obx_  || true)
-  obx_sync_symbols=$(nm -gj "$filename" | grep -c obx_sync_ || true)
-  echo "  >> Symbols found: $obx_symbols obx, $obx_sync_symbols obx_sync"
+  obx_symbols=$(nm -gj "$filename" | grep -c obx_) || true
+  obx_sync_symbols=$(nm -gj "$filename" | grep -c obx_sync_) || true
+  # Also include "external libs" to expose potential build problems
+  obx_lws_symbols=$(nm -gj "$filename" | grep -c lws_) || true
+  obx_mbedtls_symbols=$(nm -gj "$filename" | grep -c mbedtls_) || true
+  echo "  >> Symbols found: $obx_symbols obx, $obx_sync_symbols obx_sync, $obx_lws_symbols lws, $obx_mbedtls_symbols mbedtls"
+  obx_archs=$(lipo -archs "$filename")
+  echo "  >> Architectures: $obx_archs"
+  sha=($(shasum -a 256 "$filename"))
+  echo "  >> SHA256: $sha"
 done

Source/ios-framework/CodeGenTests/RunToolTests.sh

@@ -8,6 +8,14 @@ date
 
 if [ -z ${PROJECT_DIR} ]; then
   echo "PROJECT_DIR unavailable; please run from Xcode"
+
+  # TODO: In the future we could also setup the vars for derived data etc. to make it work; until then exit...
+
+  # macOS does not have realpath and readlink does not have -f option, so do this instead:
+  script_dir=$( cd "$(dirname "$0")" ; pwd -P )
+
+  PROJECT_DIR="${script_dir}/../"
+
   exit 1
 fi
 

Source/ios-framework/CodeGenTests/ToolTestProject3.swift

@@ -8,8 +8,8 @@
 
 import ObjectBox
 
-
 // objectbox: entity
+// objectbox: sync = { "sharedGlobalIds": true }
 class BusRoute {
     var id: EntityId<BusRoute> = 0
 

Source/ios-framework/CodeGenTests/expected/entity-info/EntityInfo.generated3.swift

@@ -27,6 +27,7 @@ extension BusRoute: ObjectBox.EntityInspectable {
 
     fileprivate static func buildEntity(modelBuilder: ObjectBox.ModelBuilder) throws {
         let entityBuilder = try modelBuilder.entityBuilder(for: BusRoute.self, id: 1, uid: 5107964062888457216)
+        try entityBuilder.flags([.syncEnabled, .sharedGlobalIds])
         try entityBuilder.addProperty(name: "id", type: EntityId<BusRoute>.entityPropertyType, flags: [.id], id: 1, uid: 7895576389419683840)
 
         try entityBuilder.lastProperty(id: 2, uid: 6687926154759915520)

Source/ios-framework/CodeGenTests/expected/model/model3.json

@@ -7,6 +7,7 @@
       "id": "1:5107964062888457216",
       "lastPropertyId": "2:6687926154759915520",
       "name": "BusRoute",
+      "flags": 6,
       "properties": [
         {
           "flags": 1,

Source/ios-framework/CommonSource/Entities/EntityFlags.swift

@@ -17,8 +17,6 @@
 // automatically generated by the FlatBuffers compiler, do not modify
 // swiftlint:disable all
 
-
-
 ///  Not really an enum, but binary flags to use across languages
 public enum EntityFlags: UInt32 {
     public typealias T = UInt32
@@ -29,9 +27,17 @@ public enum EntityFlags: UInt32 {
     ///  Enable "data synchronization" for this entity type: objects will be synced with other stores over the network.
     ///  It's possible to have local-only (non-synced) types and synced types in the same store (schema/data model).
     case syncEnabled = 2
-    
+    ///  Makes object IDs for a synced types (SYNC_ENABLED is set) global.
+    ///  By default (not using this flag), the 64 bit object IDs have a local scope and are not unique globally.
+    ///  This flag tells ObjectBox to treat object IDs globally and thus no ID mapping (local <-> global) is performed.
+    ///  Often this is used with assignable IDs (ID_SELF_ASSIGNABLE property flag is set) and some special ID scheme.
+    ///  Note: typically you won't do this with automatically assigned IDs, set by the local ObjectBox store.
+    ///        Two devices would likely overwrite each other's object during sync as object IDs are prone to collide.
+    ///        It might be OK if you can somehow ensure that only a single device will create new IDs.
+    case sharedGlobalIds = 4
+
 
-    public static var max: EntityFlags { return .syncEnabled }
+    public static var max: EntityFlags { return .sharedGlobalIds }
     public static var min: EntityFlags { return .useNoArgConstructor }
 }
 

Source/ios-framework/CommonSource/Errors.swift

@@ -109,6 +109,17 @@ internal func checkLastError(_ error: obx_err) throws {
     try throwObxErr(error, message: message)
 }
 
+internal func checkLastErrorSuccessFlag(_ error: obx_err) throws -> Bool {
+    if error == OBX_SUCCESS {
+        return true
+    } else if error == OBX_NO_SUCCESS {
+        return false
+    } else {
+        try checkLastError(error)  // Should always throw at this point
+        return false
+    }
+}
+
 /// E.g. prints error
 func checkLastErrorNoThrow(_ error: obx_err) {
     if error == OBX_SUCCESS { return }
@@ -125,18 +136,23 @@ internal func failFatallyIfError() {
     checkFatalError(obx_last_error_code())
 }
 
+/// Reserved for "wrong usages" by the user that the compiler cannot detect (try/catch otherwise).
+internal func fatalErrorWithStack(_ message: String) -> Never {
+    for symbol in Thread.callStackSymbols {
+        // Print the stack trace without the "unexciting" symbols
+        if !symbol.contains("XCTest") && !symbol.contains("xctest") && !symbol.contains("CoreFoundation")
+                   && !symbol.contains("checkFatalError") && !symbol.contains("failFatallyIfError") {
+            print(symbol)
+        }
+    }
+    fatalError(message)
+}
+
 /// Reserved for "wrong usages" by the user that the compiler cannot detect (try/catch otherwise).
 internal func checkFatalError(_ err: obx_err) {
     if err != OBX_SUCCESS {
-        for symbol in Thread.callStackSymbols {
-            // Print the stack trace without the "unexciting" symbols
-            if !symbol.contains("XCTest") && !symbol.contains("xctest") && !symbol.contains("CoreFoundation") 
-                       && !symbol.contains("checkFatalError") && !symbol.contains("failFatallyIfError") {
-                print(symbol)
-            }
-        }
         let message = String(utf8String: obx_last_error_message()) ?? "Unknown"
-        fatalError("\(message) (\(err))")
+        fatalErrorWithStack("\(message) (\(err))")
     }
 }
 
@@ -170,7 +186,7 @@ internal func throwObxErr(_ err: obx_err, message: String = "") throws -> Never
     /// This is NOT an error condition, and thus no last error info is set.
     case OBX_NOT_FOUND:
         throw ObjectBoxError.notFound(message: message)
-    
+
     // General errors
     case OBX_ERROR_ILLEGAL_STATE:
         if message.hasPrefix("Cannot start a write transaction inside a read only transaction") {
@@ -188,7 +204,7 @@ internal func throwObxErr(_ err: obx_err, message: String = "") throws -> Never
         throw ObjectBoxError.general(message: message)
     case OBX_ERROR_UNKNOWN:
         throw ObjectBoxError.unknown(code: OBX_ERROR_UNKNOWN, message: message)
-    
+
     // Storage errors (often have a secondary error code)
     case OBX_ERROR_DB_FULL:
         throw ObjectBoxError.dbFull(message: message)
@@ -200,7 +216,7 @@ internal func throwObxErr(_ err: obx_err, message: String = "") throws -> Never
         #if os(macOS) // Only macOS needs an App Group to do its mutexes, iOS uses a different mutex.
         if message.hasPrefix("Could not open env for DB") { // Error reported from obx_store_open().
             throw ObjectBoxError.storageGeneral(message: message + " - did you perhaps forget to set up an "
-                + "\"App Group\" Capability in your target settings?")
+                    + "\"App Group\" Capability in your target settings?")
         }
         #endif
         throw ObjectBoxError.storageGeneral(message: message)
@@ -240,9 +256,10 @@ internal func throwObxErr(_ err: obx_err, message: String = "") throws -> Never
 
     case 2: // testStorageException receives this code for a Store on a nonexistent file path.
         throw ObjectBoxError.storageGeneral(message: message.isEmpty ? "Storage error \(err)" : message)
-        
+
     default:
         throw ObjectBoxError.unknown(code: err, message: message)
     }
 }
+
 // swiftlint:enable cyclomatic_complexity function_body_length

Source/ios-framework/CommonSource/Internal/Util.swift

@@ -0,0 +1,40 @@
+//
+// Copyright © 2021 ObjectBox Ltd. All rights reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+internal class Util {
+
+    /// Note: binary representation matters for ObjectBox, not signed/unsigned state (e.g. a casted UInt32.max works).
+    /// - Returns: a new Int32 array or the given array if it already was an Int32 array.
+    /// - Throws: ObjectBoxError.illegalArgument if a value is outside the 32 bit integer range
+    internal static func toInt32Array<T>(_ collection: [T]) throws -> [Int32] where T: FixedWidthInteger {
+        if MemoryLayout<T>.size > 4 {  // casting down: check if values fit into 32 bit
+            return try collection.map {
+                if $0 < Int32.min || $0 > UInt32.max { // That should work with signed and unsigned Ts
+                    throw ObjectBoxError.illegalArgument(message: "Value outside the 32 bit integer range: \($0)")
+                }
+                return Int32(truncatingIfNeeded: $0)
+            }
+        } else {
+            return collection as? [Int32] ?? collection.map { Int32(truncatingIfNeeded: $0) }
+        }
+    }
+
+    /// Note: binary representation matters for ObjectBox, not signed/unsigned state (e.g. a casted UInt64.max works).
+    /// - Returns: a new Int64 array or the given array if it already was an Int64 array.
+    internal static func toInt64Array<T>(_ collection: [T]) -> [Int64] where T: FixedWidthInteger {
+        return collection as? [Int64] ?? collection.map { Int64(truncatingIfNeeded: $0) }
+    }
+}