Google Git
Sign in
android / platform / frameworks / support / c68855c64e6a12a4b47d3082417b810f685a72c3
commitc68855c64e6a12a4b47d3082417b810f685a72c3[log] [tgz]
authorelifbilgin <[email protected]>Sun Jan 26 19:25:45 2025 -0800
committerelifbilgin <[email protected]>Mon Mar 03 15:45:29 2025 -0800
tree26d74d189f5b827955d64505fcc3213a09254121
parentaa03a49acbd941bf3f4329f555e1cc3a1e470b6e [diff]
Implementing DirectBoot support in DataStore.

This CL creates APIs that allow a developer to create a DataStore that can be used during direct boot mode, while guarding against any attempt to utilize the existing APIs during direct boot mode (where possible).

There are 2 main paths in creating a DataStore in the current existing API. These are:
[1] Through a DataStoreFactory `create()` function call.
[2] Through a DataStoreDelegate `dataStore()` (which eventually delegates to Pathway [1] via a new DataStoreFile creation).

This CL creates 2 new API paths reserved only for use during direct boot mode. These are:
[1] Through a DataStoreFactory `createInDeviceProtectedStorage()` function call.
[2] Through a DataStoreDelegate `deviceProtectedDataStore()` (which eventually delegates to Pathway [1] via a new DeviceProtectedDataStoreFile creation).

As directBoot support requires the presence of a DeviceProtectedStorageContext in order to create the DataStore file, this change introduces APIs that can access the context and use it for direct boot mode after verification. Direct Boot mode APIs require a minimum of SDK level 24, therefore these APIs are restricted to this API level.

In addition, tests in the jvmAndroidTest source set had to undergo a small refactor as the source set structure does not allow tests in jvmAndroidTest visibility into the jvmMain and androidMain source sets (as it will only see jvmAndroidMain sources), which required changes to how we call DataStoreFactory.create in these existing tests to avoid duplicating each test in each platform's test source sets.

Bug: 370838564
Test: DirectBootDataStoreFactoryTest.kt, DirectBootPreferenceDataStoreFactoryTest.kt, DataStoreDelegateTest.kt
Relnote: Implementing DirectBoot support in DataStore.
Change-Id: Ib90e56ef92a04edcf81d779f4cc0d1ca3ee2495b
26 files changed
tree: 26d74d189f5b827955d64505fcc3213a09254121
  1. .github/
  2. .idea/
  3. activity/
  4. annotation/
  5. appcompat/
  6. appfunctions/
  7. appintegration/
  8. appsearch/
  9. arch/
  10. asynclayoutinflater/
  11. autofill/
  12. benchmark/
  13. binarycompatibilityvalidator/
  14. biometric/
  15. bluetooth/
  16. browser/
  17. buildSrc/
  18. buildSrc-tests/
  19. busytown/
  20. camera/
  21. car/
  22. cardview/
  23. collection/
  24. compose/
  25. concurrent/
  26. constraintlayout/
  27. contentpager/
  28. coordinatorlayout/
  29. core/
  30. credentials/
  31. cursoradapter/
  32. customview/
  33. datastore/
  34. development/
  35. docs/
  36. docs-public/
  37. docs-tip-of-tree/
  38. documentfile/
  39. draganddrop/
  40. drawerlayout/
  41. dynamicanimation/
  42. emoji/
  43. emoji2/
  44. enterprise/
  45. exifinterface/
  46. external/
  47. fragment/
  48. glance/
  49. gradle/
  50. graphics/
  51. gridlayout/
  52. health/
  53. heifwriter/
  54. hilt/
  55. ink/
  56. input/
  57. inspection/
  58. interpolator/
  59. javascriptengine/
  60. kruth/
  61. leanback/
  62. lifecycle/
  63. lint/
  64. lint-checks/
  65. loader/
  66. media/
  67. mediarouter/
  68. metrics/
  69. navigation/
  70. navigation3/
  71. paging/
  72. palette/
  73. pdf/
  74. percentlayout/
  75. performance/
  76. placeholder/
  77. placeholder-tests/
  78. playground-common/
  79. playground-projects/
  80. preference/
  81. print/
  82. privacysandbox/
  83. profileinstaller/
  84. recommendation/
  85. recyclerview/
  86. remotecallback/
  87. resourceinspection/
  88. room/
  89. safeparcel/
  90. samples/
  91. savedstate/
  92. security/
  93. sharetarget/
  94. slidingpanelayout/
  95. sqlite/
  96. stableaidl/
  97. startup/
  98. swiperefreshlayout/
  99. test/
  100. testutils/
  101. text/
  102. tracing/
  103. transition/
  104. tv/
  105. tvprovider/
  106. vectordrawable/
  107. versionedparcelable/
  108. viewpager/
  109. viewpager2/
  110. wear/
  111. webkit/
  112. window/
  113. work/
  114. xr/
  115. .gitignore
  116. build.gradle
  117. cleanBuild.sh
  118. code-review.md
  119. CONTRIBUTING.md
  120. gradle.properties
  121. gradlew
  122. libraryversions.toml
  123. license-baseline.txt
  124. LICENSE.txt
  125. OWNERS
  126. PREUPLOAD.cfg
  127. README.md
  128. settings.gradle
  129. studiow
  130. TEXT_OWNERS
README.md

Android Jetpack

Revved up by Develocity

Jetpack is a suite of libraries, tools, and guidance to help developers write high-quality apps easier. These components help you follow best practices, free you from writing boilerplate code, and simplify complex tasks, so you can focus on the code you care about.

Jetpack comprises the androidx.* package libraries, unbundled from the platform APIs. This means that it offers backward compatibility and is updated more frequently than the Android platform, making sure you always have access to the latest and greatest versions of the Jetpack components.

Our official AARs and JARs binaries are distributed through Google Maven.

You can learn more about using it from Android Jetpack landing page.

Contribution Guide

For contributions via GitHub, see the GitHub Contribution Guide.

Note: The contributions workflow via GitHub is currently experimental - only contributions to the following projects are being accepted at this time:

Code Review Etiquette

When contributing to Jetpack, follow the code review etiquette.

Accepted Types of Contributions

  • Bug fixes - needs a corresponding bug report in the Android Issue Tracker
  • Each bug fix is expected to come with tests
  • Fixing spelling errors
  • Updating documentation
  • Adding new tests to the area that is not currently covered by tests
  • New features to existing libraries if the feature request bug has been approved by an AndroidX team member.

We are not currently accepting new modules.

Checking Out the Code

Head over to the onboarding docs to learn more about getting set up and the development workflow!

Continuous integration

Our continuous integration system builds all in progress (and potentially unstable) libraries as new changes are merged. You can manually download these AARs and JARs for your experimentation.

Password and Contributor Agreement before making a change

Before uploading your first contribution, you will need setup a password and agree to the contribution agreement:

Generate a HTTPS password: https://android-review.googlesource.com/new-password

Agree to the Google Contributor Licenses Agreement: https://android-review.googlesource.com/settings/new-agreement

Getting reviewed

  • After you run repo upload, open r.android.com
  • Sign in into your account (or create one if you do not have one yet)
  • Add an appropriate reviewer (use git log to find who did most modifications on the file you are fixing or check the OWNERS file in the project's directory)

Handling binary dependencies

AndroidX uses git to store all the binary Gradle dependencies. They are stored in prebuilts/androidx/internal and prebuilts/androidx/external directories in your checkout. All the dependencies in these directories are also available from google(), or mavenCentral(). We store copies of these dependencies to have hermetic builds. You can pull in a new dependency using our importMaven tool.