Improve Matrix class

[bmarty]

Small change in the Matrix class: deprecated methods have been removed and the constructor is now public. Also the fun workerFactory() has been renamed to getWorkerFactory()

Documentation has been improved to.

Knit has been set up, also on the CI. For now we are not doing a big usage of it, but can be more useful in the future.

Also generated documentation header will have working link:

(see previous version without links in #5854)

[github-actions]

Unit Test Results

122 files  122 suites   2m 32s ⏱️
205 tests 205 ✔️ 0 💤 0 ❌
690 runs  690 ✔️ 0 💤 0 ❌

Results for commit 0ed647d.

♻️ This comment has been updated with latest results.

[ouchadam]

not for this PR, we have a mix of get${object} and ${object}, is it something we want to align on in the public api?

[bmarty]

Yes, we have a mix, the (un-official!) rule so far is to not use the get prefix for the SDK services, and I think this is the case for all services, to avoid having long name for the methods.

Happy to discuss this more, and/or to change the rule.

I have renamed workerFactory() because this is not a SDK service.

[bmarty]

thanks for the review. I have force pushed to fix merge conflict, also added a last commit to fix Kdoc issue.

[github-actions]

Matrix SDK

Integration Tests Results:

• [org.matrix.android.sdk.session]
  = passed=7 failures=13 errors=0 skipped=3
• [org.matrix.android.sdk.account]
  = passed=1 failures=2 errors=0 skipped=2
• [org.matrix.android.sdk.internal]
  = passed=5 failures=1 errors=0 skipped=0
• [org.matrix.android.sdk.ordering]
  = passed=16 failures=0 errors=0 skipped=0
• [org.matrix.android.sdk.PermalinkParserTest]
  = passed=2 failures=0 errors=0 skipped=0

[michaelkaye]

https://github.com/vector-im/element-android/runs/6450886478?check_suite_focus=true#step:8:392

I think this has caused a regression in the integration tests (this also happened to me locally) - looks like we've changed how we instantiate the TestMatrix, and the android WorkManagerImpl is complaining.

 org.matrix.android.sdk.session.search.SearchMessagesTest > sendTextMessageAndSearchPartOfItUsingSession[test(AVD) - 9] FAILED 
	java.lang.IllegalStateException: WorkManager is already initialized.  Did you try to initialize it manually without disabling WorkManagerInitializer? See WorkManager#initialize(Context, Configuration) or the class level Javadoc for more information.
	at androidx.work.impl.WorkManagerImpl.initialize(WorkManagerImpl.java:185)

org.matrix.android.sdk.session.space.SpaceCreationTest > createSimplePublicSpace[test(AVD) - 9] FAILED 
	java.lang.IllegalStateException: WorkManager is already initialized.  Did you try to initialize it manually without disabling WorkManagerInitializer? See WorkManager#initialize(Context, Configuration) or the class level Javadoc for more information.
	at androidx.work.impl.WorkManagerImpl.initialize(WorkManagerImpl.java:185)

[michaelkaye]

        val delegate = WorkManagerImpl(
                context,
                configuration,
                WorkManagerTaskExecutor(configuration.taskExecutor)
        )
        WorkManagerImpl.setDelegate(delegate)

Might work (so using the unit test delegate thing to handle it) to avoid repeated initialization BUT, it's still a global and I think this means we need to prevent tests running in parallel otherwise race conditions will happen.

(trying this locally to see how it fares)

[bmarty]

Thanks for your investigation