Improving .so loading by using the ReLinker library by kneth · Pull Request #1771 · realm/realm-java

kneth · 2015-11-13T14:24:29Z

We have seen a number of reports on problems with loading .so files. The origins can be that the .so loader in Android is known to be unreliable and some end-users do not use Google's Play Store (often the case in China).

TODO:

Proposed entry in changelog.txt: "Improving .so loading by using the ReLinker library (https://github.com/KeepSafe/ReLinker)"

@realm/java

emanuelez · 2015-11-13T14:27:35Z

We should add ReLinker as a dependency in Gradle and not just copy pasting the file

cmelchior · 2015-11-13T14:29:22Z

Agreeded. We can can shadow it the same way we do JavaWriter to avoid versioning conflicts from other libraries

cmelchior · 2015-11-13T14:30:25Z

realm/realm-library/src/main/java/io/realm/RealmConfiguration.java

Remove FIXME?

kneth · 2015-11-13T14:30:32Z

@cmelchior You had the opposite opinion yesterday but I'll be happy to change it back.

cmelchior · 2015-11-13T14:30:36Z

realm/realm-library/src/main/java/io/realm/RealmConfiguration.java

What happens if the context is null?

We check in line 245 and throw an exception.

cmelchior · 2015-11-13T14:31:19Z

Alternative suggestion to the changelog: "Improved .so loading by using ReLinker (link)"

cmelchior · 2015-11-13T14:32:59Z

@kneth Yes, I believe I might accidentally have voiced that opinion, sorry. Shadowing does the same thing, except we don't have to add the file to the code base.

bmunkholm · 2015-11-13T19:48:07Z

realm/realm-library/build.gradle

remove comment. Doesn't add any info.

beeender · 2015-11-18T01:57:30Z

realm/realm-library/src/main/java/io/realm/RealmConfiguration.java

Doesn't this cause problem with our JNI testing? If the case is only about Table, the Builder will not be called. And also, I think put this in a static block would be a good idea since it only needs to be ran once.

The problem with the static block is that it doesn't have access to a Context.

beeender · 2015-11-18T05:35:45Z

The failed monkeyTest is because of the ReLinker class is not packed in the final apk file. Gradle experts @emanuelez @zaki50 ?

zaki50 · 2015-11-18T08:11:41Z

I think we need add ReLInker to https://github.com/realm/realm-java/blob/master/gradle-plugin/src/main/groovy/io/realm/gradle/Realm.groovy#L14 or repackage ReLinker into realm-library

emanuelez · 2015-11-18T08:17:45Z

@zaki50 That should not be needed as it should be handled as a transitive dependency, just like JavaWriter

zaki50 · 2015-11-18T08:20:24Z

@emanuelez make sense. We need to add "https://jitpack.io" as a maven repository?

emanuelez · 2015-11-18T08:21:16Z

Ohhh... yes! That's probably it!

zaki50 · 2015-11-18T08:30:45Z

But should we avoid to implicitly add an maven repository?

zaki50 · 2015-11-18T08:52:09Z

RealmConfiguration.Builder has another constructor Builder(File folder) and it does not load the native library.

Adding @aar at the end of a dependency turns off the transitive dependencies. See https://docs.gradle.org/current/userguide/dependency_management.html , specifically the "Artifact only notation" section

kneth · 2015-11-19T07:11:56Z

Bump @realm/java

cmelchior · 2015-11-19T07:24:28Z

realm/realm-library/src/main/java/io/realm/internal/RealmCore.java

Missing Javadoc for this method and loadLibrary() so the difference is clear.

beeender · 2015-12-30T09:46:00Z

@diegomontoya When the problem happens, can you please check in the /data/data/<package-name/lib directory to see if the so file is the same with the newly installed version? If it is not, is it the previous version?

Can you please test if the Relinker solve this problem by calling Relinker to load the librealm-jni.so before calling any Realm functions

I really want to try this by myself but none of my phones can reproduce this issue...

And what does below mean?

Strange thing is, the library .so appears to be loaded correctly with System.loadLibrary() not triggering any errors.

Qubitium · 2015-12-31T04:16:30Z

@beeender The "NoClassDefNotFound" for io/realm/internal/SharedGroup for my case is not caused as result of the system unable to load the .so file aka System.loadLibrary() throwing errors. That was very strange.

Unfortunately I have use builds/installed hundreds of times on the device and yesterday was the first time ever I could reproduce this type of bug on any device. Next time I will make sure to freeze the /data/data path for future inspection. Too bad I wasn't thinking clearly at the time. Opportunity wasted on catching the bigfoot.

Strange thing is, the library .so appears to be loaded correctly with System.loadLibrary() not triggering any errors.

kneth · 2016-01-05T12:44:06Z

@diegomontoya Do you suggest that corrupted .so is the result of a bug in the package manager? It's going to be hard to fix that 😄

…oving-so-loading-using-relinker

Qubitium · 2016-01-06T04:34:05Z

@kneth Yes, I am suggesting there are two bugs here, one of which relink can fix. The first bug is that the install completely bonks the .so copy so there are no .so file to be found. Relink can fix this. But the issue I encountered appears to be the .so loading was completed without errors but still triggering the cryptic io/ream/internal/SharedGroup not found error. The second bug may be hopeless since it may mean the .so is actually corrupted but loadable.

cmelchior · 2016-01-07T10:31:55Z

Fixed the last bug in the unit tests, so should be ready now @realm/java

cmelchior · 2016-01-07T10:32:24Z

👍 from me, but I made the last change, so ... ;)

Conflicts: changelog.txt

beeender · 2016-01-11T08:01:49Z

retest this please

beeender · 2016-01-11T08:01:58Z

👍

…oving-so-loading-using-relinker

emanuelez · 2016-01-11T09:44:37Z

gradle-plugin/src/main/groovy/io/realm/gradle/Realm.groovy

Are you sure the annotations don't need to be added as apt?

…om:realm/realm-java into kg/bug/improving-so-loading-using-relinker

…-relinker Improving .so loading by using the ReLinker library

Improving .so loading by using the ReLinker library

08ce9b4

kneth added the Review label Nov 13, 2015

kneth self-assigned this Nov 13, 2015

cmelchior reviewed Nov 13, 2015
View reviewed changes

realm/realm-library/src/main/java/io/realm/RealmConfiguration.java Outdated

Copy link

Contributor

cmelchior Nov 13, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove FIXME?

cmelchior reviewed Nov 13, 2015
View reviewed changes

kneth added 3 commits November 13, 2015 15:40

Use ReLinker as a dependency

a3586f1

Removing a FIXME

2537c0f

Adding entry in changelog

b1d021b

bmunkholm reviewed Nov 13, 2015
View reviewed changes

realm/realm-library/build.gradle Outdated

Copy link

Contributor

bmunkholm Nov 13, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

remove comment. Doesn't add any info.

Moving dependencies

7ca80fa

beeender reviewed Nov 18, 2015
View reviewed changes

emanuelez and others added 4 commits November 18, 2015 10:00

Let the Gradle plugin add the jitpack repo.

3336c3d

Fix the transitive dependency issue

c67b9a7

Adding @aar at the end of a dependency turns off the transitive dependencies. See https://docs.gradle.org/current/userguide/dependency_management.html , specifically the "Artifact only notation" section

Moving actual loading to RealmCore

3835bbf

Adding loading to both Builder() calls.

0147cbb

cmelchior reviewed Nov 19, 2015
View reviewed changes

kneth added 3 commits January 5, 2016 16:42

Merge branch 'master' of github.com:realm/realm-java into kg/bug/impr…

b92f44d

…oving-so-loading-using-relinker

Merge branch 'master' of github.com:realm/realm-java into kg/bug/impr…

e4a1cb0

…oving-so-loading-using-relinker

Oops, manual merge went bad

0cf2b76

kneth and others added 4 commits January 6, 2016 12:34

Merged

e946ea4

PR feedback

bce619d

Merge branch 'master' into kg/bug/improving-so-loading-using-relinker

4989ad5

Cleanup RealmCore. Internal Util must load RealmCore itself.

18656bb

Merge branch 'master' into kg/bug/improving-so-loading-using-relinker

9aa44d9

Conflicts: changelog.txt

Merge branch 'master' of github.com:realm/realm-java into kg/bug/impr…

6e6fc05

…oving-so-loading-using-relinker

emanuelez reviewed Jan 11, 2016
View reviewed changes

kneth added 2 commits January 11, 2016 10:57

Merge branch 'kg/bug/improving-so-loading-using-relinker' of github.c…

fca4487

…om:realm/realm-java into kg/bug/improving-so-loading-using-relinker

PR feedback

9d200cc

kneth pushed a commit that referenced this pull request Jan 11, 2016

Merge pull request #1771 from realm/kg/bug/improving-so-loading-using…

d7b401d

…-relinker Improving .so loading by using the ReLinker library

kneth merged commit d7b401d into master Jan 11, 2016

kneth removed the Review label Jan 11, 2016

kneth deleted the kg/bug/improving-so-loading-using-relinker branch January 11, 2016 11:33

This was referenced Jan 12, 2016

Couldn't load realm-jni (io.realm.internal.RealmCore.loadLibrary) 0.82.2 #1534

Closed

Couldn't load realm-jni from loader #1527

Closed

ghost mentioned this pull request Feb 3, 2019

[WIP] Remove the libraries loading mechanism kivy/python-for-android#1543

Open

github-actions bot locked as resolved and limited conversation to collaborators Mar 16, 2024

Conversation

kneth commented Nov 13, 2015

Uh oh!

emanuelez commented Nov 13, 2015

Uh oh!

cmelchior commented Nov 13, 2015

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kneth commented Nov 13, 2015

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cmelchior commented Nov 13, 2015

Uh oh!

cmelchior commented Nov 13, 2015

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

beeender commented Nov 18, 2015

Uh oh!

zaki50 commented Nov 18, 2015

Uh oh!

emanuelez commented Nov 18, 2015

Uh oh!

zaki50 commented Nov 18, 2015

Uh oh!

emanuelez commented Nov 18, 2015

Uh oh!

zaki50 commented Nov 18, 2015

Uh oh!

zaki50 commented Nov 18, 2015

Uh oh!

kneth commented Nov 19, 2015

Uh oh!

Choose a reason for hiding this comment

Uh oh!

beeender commented Dec 30, 2015

Uh oh!

Qubitium commented Dec 31, 2015

Uh oh!

kneth commented Jan 5, 2016

Uh oh!

Qubitium commented Jan 6, 2016

Uh oh!

cmelchior commented Jan 7, 2016

Uh oh!

cmelchior commented Jan 7, 2016

Uh oh!

beeender commented Jan 11, 2016

Uh oh!

beeender commented Jan 11, 2016

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants