Merge branch 'release-2.9.0'

Author: greenrobot-team

Jenkinsfile

@@ -6,22 +6,26 @@ String gradleArgs = '-Dorg.gradle.daemon=false --stacktrace'
 boolean isPublish = BRANCH_NAME == 'publish'
 String versionPostfix = isPublish ? '' : BRANCH_NAME // Build script detects empty string as not set.
 
+// Note: using single quotes to avoid Groovy String interpolation leaking secrets.
+def internalRepoArgs = '-PinternalObjectBoxRepo=$MVN_REPO_URL ' +
+                '-PinternalObjectBoxRepoUser=$MVN_REPO_LOGIN_USR ' +
+                '-PinternalObjectBoxRepoPassword=$MVN_REPO_LOGIN_PSW'
+def uploadRepoArgs = '-PpreferredRepo=$MVN_REPO_UPLOAD_URL ' +
+                '-PpreferredUsername=$MVN_REPO_LOGIN_USR ' +
+                '-PpreferredPassword=$MVN_REPO_LOGIN_PSW '
+// Note: add quotes around URL parameter to avoid line breaks due to semicolon in URL.
+def uploadRepoArgsBintray = '\"-PpreferredRepo=$BINTRAY_URL\" ' +
+                '-PpreferredUsername=$BINTRAY_LOGIN_USR ' +
+                '-PpreferredPassword=$BINTRAY_LOGIN_PSW'
+
 // https://jenkins.io/doc/book/pipeline/syntax/
 pipeline {
     agent { label 'java' }
 
     environment {
-        GITLAB_URL = credentials('gitlab_url')
         MVN_REPO_LOGIN = credentials('objectbox_internal_mvn_user')
         MVN_REPO_URL = credentials('objectbox_internal_mvn_repo_http')
-        MVN_REPO_ARGS = "-PinternalObjectBoxRepo=$MVN_REPO_URL " +
-                        "-PinternalObjectBoxRepoUser=$MVN_REPO_LOGIN_USR " +
-                        "-PinternalObjectBoxRepoPassword=$MVN_REPO_LOGIN_PSW"
         MVN_REPO_UPLOAD_URL = credentials('objectbox_internal_mvn_repo')
-        MVN_REPO_UPLOAD_ARGS = "-PpreferredRepo=$MVN_REPO_UPLOAD_URL " +
-                        "-PpreferredUsername=$MVN_REPO_LOGIN_USR " +
-                        "-PpreferredPassword=$MVN_REPO_LOGIN_PSW " +
-                        "-PversionPostFix=$versionPostfix"
         // Note: for key use Jenkins secret file with PGP key as text in ASCII-armored format.
         ORG_GRADLE_PROJECT_signingKeyFile = credentials('objectbox_signing_key')
         ORG_GRADLE_PROJECT_signingKeyId = credentials('objectbox_signing_key_id')
@@ -31,7 +35,7 @@ pipeline {
     options {
         buildDiscarder(logRotator(numToKeepStr: buildsToKeep, artifactNumToKeepStr: buildsToKeep))
         timeout(time: 1, unit: 'HOURS') // If build hangs (regular build should be much quicker)
-        gitLabConnection("${env.GITLAB_URL}")
+        gitLabConnection('objectbox-gitlab-connection')
     }
 
     triggers {
@@ -54,7 +58,7 @@ pipeline {
 
         stage('build-java') {
             steps {
-                sh "./ci/test-with-asan.sh $gradleArgs $MVN_REPO_ARGS -Dextensive-tests=true clean test " +
+                sh "./ci/test-with-asan.sh $gradleArgs $internalRepoArgs -Dextensive-tests=true clean test " +
                         "--tests io.objectbox.FunctionalTestSuite " +
                         "--tests io.objectbox.test.proguard.ObfuscatedEntityTest " +
                         "--tests io.objectbox.rx.QueryObserverTest " +
@@ -65,7 +69,7 @@ pipeline {
 
         stage('upload-to-internal') {
             steps {
-                sh "./gradlew $gradleArgs $MVN_REPO_ARGS $MVN_REPO_UPLOAD_ARGS uploadArchives"
+                sh "./gradlew $gradleArgs $internalRepoArgs $uploadRepoArgs -PversionPostFix=$versionPostfix uploadArchives"
             }
         }
 
@@ -79,11 +83,8 @@ pipeline {
                 googlechatnotification url: 'id:gchat_java',
                     message: "*Publishing* ${currentBuild.fullDisplayName} to Bintray...\n${env.BUILD_URL}"
 
-                // Note: supply internal Maven repo as tests use native dependencies (can't publish those without the Java libraries).
-                // Note: add quotes around URL parameter to avoid line breaks due to semicolon in URL.
-                sh "./gradlew $gradleArgs $MVN_REPO_ARGS " +
-                   "\"-PpreferredRepo=${BINTRAY_URL}\" -PpreferredUsername=${BINTRAY_LOGIN_USR} -PpreferredPassword=${BINTRAY_LOGIN_PSW} " +
-                   "uploadArchives"
+                // Note: supply internal repo as tests use native dependencies that might not be published, yet.
+                sh "./gradlew $gradleArgs $internalRepoArgs $uploadRepoArgsBintray uploadArchives"
 
                 googlechatnotification url: 'id:gchat_java',
                     message: "Published ${currentBuild.fullDisplayName} successfully to Bintray - check https://bintray.com/objectbox/objectbox\n${env.BUILD_URL}"

README.md

@@ -6,7 +6,7 @@
 ObjectBox is a superfast object-oriented database with strong relation support.
 ObjectBox is embedded into your Android, Linux, macOS, or Windows app.
 
-**Latest version: [2.8.1 (2020/11/10)](https://docs.objectbox.io/#objectbox-changelog)**
+**Latest version: [2.9.0 (2021/02/16)](https://docs.objectbox.io/#objectbox-changelog)**
 
 Demo code using ObjectBox:
 
@@ -33,7 +33,7 @@ Add this to your root build.gradle (project level):
 
 ```groovy
 buildscript {
-    ext.objectboxVersion = '2.8.1'
+    ext.objectboxVersion = '2.9.0'
     dependencies {
         classpath "io.objectbox:objectbox-gradle-plugin:$objectboxVersion"
     }

build.gradle

@@ -1,7 +1,7 @@
 buildscript {
     ext {
         // Typically, only edit those two:
-        def objectboxVersionNumber = '2.8.1' // without "-SNAPSHOT", e.g. '2.5.0' or '2.4.0-RC'
+        def objectboxVersionNumber = '2.9.0' // without "-SNAPSHOT", e.g. '2.5.0' or '2.4.0-RC'
         def objectboxVersionRelease = true  // set to true for releasing to ignore versionPostFix to avoid e.g. "-dev" versions
 
         // version post fix: '-<value>' or '' if not defined; e.g. used by CI to pass in branch name
@@ -22,8 +22,8 @@ buildscript {
         essentials_version = '3.1.0'
         junit_version = '4.13.1'
         mockito_version = '3.3.3'
-        kotlin_version = '1.4.10'
-        dokka_version = '0.10.1'
+        kotlin_version = '1.4.21'
+        dokka_version = '1.4.20'
 
         println "version=$ob_version"
         println "objectboxNativeDependency=$ob_native_dep"

ci/Jenkinsfile-Windows

@@ -1,23 +1,27 @@
+#!/usr/bin/env groovy
+
 String buildsToKeep = '500'
 
 String gradleArgs = '-Dorg.gradle.daemon=false --stacktrace'
+boolean isPublish = BRANCH_NAME == 'publish'
+
+// Note: using single quotes to avoid Groovy String interpolation leaking secrets.
+def internalRepoArgsBat = '-PinternalObjectBoxRepo=%MVN_REPO_URL% ' +
+                '-PinternalObjectBoxRepoUser=%MVN_REPO_LOGIN_USR% ' +
+                '-PinternalObjectBoxRepoPassword=%MVN_REPO_LOGIN_PSW%'
 
 // https://jenkins.io/doc/book/pipeline/syntax/
 pipeline {
     agent { label 'windows' }
 
     environment {
-        GITLAB_URL = credentials('gitlab_url')
         MVN_REPO_URL = credentials('objectbox_internal_mvn_repo_http')
         MVN_REPO_LOGIN = credentials('objectbox_internal_mvn_user')
-        MVN_REPO_ARGS = "-PinternalObjectBoxRepo=$MVN_REPO_URL " +
-                        "-PinternalObjectBoxRepoUser=$MVN_REPO_LOGIN_USR " +
-                        "-PinternalObjectBoxRepoPassword=$MVN_REPO_LOGIN_PSW"
     }
 
     options {
         buildDiscarder(logRotator(numToKeepStr: buildsToKeep, artifactNumToKeepStr: buildsToKeep))
-        gitLabConnection("${env.GITLAB_URL}")
+        gitLabConnection('objectbox-gitlab-connection')
     }
 
     triggers {
@@ -29,27 +33,58 @@ pipeline {
         stage('init') {
             steps {
                 bat 'gradlew -version'
+            }
+        }
+
+        stage('build-java-x64') {
+            steps {
+                // Remove files to avoid archiving them again.
+                bat 'del /q /s hs_err_pid*.log'
+
+                bat "gradlew $gradleArgs $internalRepoArgsBat cleanTest build test"
+            }
+            post {
+                always {
+                    junit '**/build/test-results/**/TEST-*.xml'
+                    archiveArtifacts artifacts: '**/hs_err_pid*.log', allowEmptyArchive: true
+                }
+            }
+        }
+
+        stage('build-java-x86') {
+            steps {
+                // Remove files to avoid archiving them again.
+                bat 'del /q /s hs_err_pid*.log'
 
-                // "cmd /c" for an OK exit code if no file is found
-                bat 'cmd /c del tests\\objectbox-java-test\\hs_err_pid*.log'
+                // TEST_WITH_JAVA_X86 makes objectbox-java-test use 32-bit java executable and therefore
+                // 32-bit ObjectBox to run tests (see build.gradle file).
+                // Note: assumes JAVA_HOME_X86 is set to 32-bit JDK path.
+                // Note: no space before && or value has space as well.
+                bat "set TEST_WITH_JAVA_X86=true&& gradlew $gradleArgs $internalRepoArgsBat cleanTest build test"
+            }
+            post {
+                always {
+                    junit '**/build/test-results/**/TEST-*.xml'
+                    archiveArtifacts artifacts: '**/hs_err_pid*.log', allowEmptyArchive: true
+                }
             }
         }
 
-        stage('build-java') {
+        stage('package-javadoc-for-web') {
+            when { expression { return isPublish } }
             steps {
-                bat "gradlew $gradleArgs $MVN_REPO_ARGS cleanTest build test"
+                bat "gradlew $gradleArgs $internalRepoArgsBat :objectbox-java:packageJavadocForWeb"
+            }
+            post {
+                always {
+                    archiveArtifacts artifacts: 'objectbox-java/build/dist/objectbox-java-web-api-docs.zip'
+                }
             }
         }
     }
 
     // For global vars see /jenkins/pipeline-syntax/globals
     post {
-        always {
-            junit '**/build/test-results/**/TEST-*.xml'
-            archiveArtifacts artifacts: 'tests/*/hs_err_pid*.log', allowEmptyArchive: true  // Only on JVM crash.
-            // currently unused: archiveArtifacts '**/build/reports/findbugs/*'
-        }
-
         failure {
             updateGitlabCommitStatus name: 'build-windows', state: 'failed'
         }

objectbox-java-api/src/main/java/io/objectbox/annotation/Sync.java

@@ -14,4 +14,18 @@
 @Retention(RetentionPolicy.CLASS)
 @Target(ElementType.TYPE)
 public @interface Sync {
+
+    /**
+     * Set to {@code true} to enable shared global IDs for a {@link Sync}-enabled {@link Entity} class.
+     * <p>
+     * By default each Sync client has its own local {@link Id ID} space for Objects.
+     * IDs are mapped to global IDs when syncing behind the scenes. Turn this on
+     * to treat Object IDs as global and turn of ID mapping. The ID of an Object will
+     * then be the same on all clients.
+     * <p>
+     * When using this, it is recommended to use {@link Id#assignable() assignable IDs}
+     * to turn off automatically assigned IDs. Without special care, two Sync clients are
+     * likely to overwrite each others Objects if IDs are assigned automatically.
+     */
+    boolean sharedGlobalIds() default false;
 }

objectbox-java/build.gradle

@@ -38,11 +38,15 @@ javadoc {
 }
 
 // Note: use packageJavadocForWeb to get as ZIP.
-// Note: the style changes only work if using JDK 10+.
 task javadocForWeb(type: Javadoc) {
     group = 'documentation'
     description = 'Builds Javadoc incl. objectbox-java-api classes with web tweaks.'
 
+    javadocTool = javaToolchains.javadocToolFor {
+        // Note: the style changes only work if using JDK 10+, 11 is latest LTS.
+        languageVersion = JavaLanguageVersion.of(11)
+    }
+
     def srcApi = project(':objectbox-java-api').file('src/main/java/')
     if (!srcApi.directory) throw new GradleScriptException("Not a directory: ${srcApi}", null)
     // Hide internal API from javadoc artifact.

objectbox-java/src/main/java/io/objectbox/BoxStore.java

@@ -68,9 +68,9 @@ public class BoxStore implements Closeable {
     @Nullable private static Object relinker;
 
     /** Change so ReLinker will update native library when using workaround loading. */
-    public static final String JNI_VERSION = "2.8.0";
+    public static final String JNI_VERSION = "2.9.0";
 
-    private static final String VERSION = "2.8.0-2020-11-05";
+    private static final String VERSION = "2.9.0-2021-02-16";
     private static BoxStore defaultStore;
 
     /** Currently used DB dirs with values from {@link #getCanonicalPath(File)}. */
@@ -384,6 +384,41 @@ static boolean isFileOpenSync(String canonicalPath, boolean runFinalization) {
         }
     }
 
+    /**
+     * Using an Android Context and an optional database name, as configured with {@link BoxStoreBuilder#name(String)},
+     * checks if the associated database files are in use by a BoxStore instance.
+     * <p>
+     * Use this to check that database files are not open before copying or deleting them.
+     */
+    public static boolean isDatabaseOpen(Object context, @Nullable String dbNameOrNull) throws IOException {
+        File dbDir = BoxStoreBuilder.getAndroidDbDir(context, dbNameOrNull);
+        return isFileOpen(dbDir.getCanonicalPath());
+    }
+
+    /**
+     * Using an optional base directory, as configured with {@link BoxStoreBuilder#baseDirectory(File)},
+     * and an optional database name, as configured with {@link BoxStoreBuilder#name(String)},
+     * checks if the associated database files are in use by a BoxStore instance.
+     * <p>
+     * Use this to check that database files are not open before copying or deleting them.
+     */
+    public static boolean isDatabaseOpen(@Nullable File baseDirectoryOrNull,
+                                         @Nullable String dbNameOrNull) throws IOException {
+        
+        File dbDir = BoxStoreBuilder.getDbDir(baseDirectoryOrNull, dbNameOrNull);
+        return isFileOpen(dbDir.getCanonicalPath());
+    }
+
+    /**
+     * Using a directory, as configured with {@link BoxStoreBuilder#directory(File)},
+     * checks if the associated database files are in use by a BoxStore instance.
+     * <p>
+     * Use this to check that database files are not open before copying or deleting them.
+     */
+    public static boolean isDatabaseOpen(File directory) throws IOException {
+        return isFileOpen(directory.getCanonicalPath());
+    }
+
     /**
      * The size in bytes occupied by the data file on disk.
      *