fix(bluetoothle): fix typo in BluetoothLeService and migrate to snippets by ithinkihaveacat · Pull Request #934 · android/snippets

ithinkihaveacat · 2026-06-01T15:51:53Z

Fix typo 'Return;' -> 'return;' in Java BluetoothLeService.
Migrate inline code samples from connect-gatt-server.md to snippets.
Create BluetoothLeService and DeviceControlActivity in Java and Kotlin.
Add gatt_services_characteristics layout and string resources to enable compilation.

Bug: 359501045

gemini-code-assist

Code Review

This pull request introduces Bluetooth Low Energy (BLE) GATT service and activity implementations in both Java and Kotlin. The code reviewer identified several critical issues, including potential GATT connection leaks due to unclosed BluetoothGatt instances, ServiceConnection leaks from missing unbindService calls in onDestroy, control flow bugs where connection attempts proceed after initialization failures, and unsafe null assertions (!!) in the Kotlin activity that could cause runtime crashes.

gemini-code-assist · 2026-06-01T15:53:19Z

+                if (!bluetoothService.initialize()) {
+                    Log.e(TAG, "Unable to initialize Bluetooth");
+                    finish();
+                }
+                // [END gatt_initialize_activity_java]
+                // perform device connection
+                // [START gatt_connect_activity_java]
+                bluetoothService.connect(deviceAddress);
+                // [END gatt_connect_activity_java]


If bluetoothService.initialize() fails, finish() is called to destroy the activity, but the method continues executing and attempts to call connect(). Add an early return; statement to prevent further execution.

if (!bluetoothService.initialize()) {\n Log.e(TAG, "Unable to initialize Bluetooth");\n finish();\n return;\n }\n // [END gatt_initialize_activity_java]\n // perform device connection\n // [START gatt_connect_activity_java]\n bluetoothService.connect(deviceAddress);\n // [END gatt_connect_activity_java]

snippet-bot · 2026-06-01T16:30:56Z

Here is the summary of changes.

You are about to add 34 region tags.

bluetoothle/src/main/java/com/sample/android/bluetoothle/java/BluetoothLeService.java:34, tag android_bluetooth_service_all_java
bluetoothle/src/main/java/com/sample/android/bluetoothle/java/BluetoothLeService.java:44, tag android_bluetooth_callback_java
bluetoothle/src/main/java/com/sample/android/bluetoothle/java/BluetoothLeService.java:70, tag android_bluetooth_binder_java
bluetoothle/src/main/java/com/sample/android/bluetoothle/java/BluetoothLeService.java:84, tag android_bluetooth_initialize_java
bluetoothle/src/main/java/com/sample/android/bluetoothle/java/BluetoothLeService.java:95, tag android_bluetooth_connect_simple_java
bluetoothle/src/main/java/com/sample/android/bluetoothle/java/BluetoothLeService.java:119, tag android_bluetooth_connect_java
bluetoothle/src/main/java/com/sample/android/bluetoothle/java/BluetoothLeService.java:128, tag android_bluetooth_connect_gatt_java
bluetoothle/src/main/java/com/sample/android/bluetoothle/java/BluetoothLeService.java:139, tag android_bluetooth_callback_simple_java
bluetoothle/src/main/java/com/sample/android/bluetoothle/java/BluetoothLeService.java:159, tag android_bluetooth_broadcast_java
bluetoothle/src/main/java/com/sample/android/bluetoothle/java/BluetoothLeService.java:167, tag android_bluetooth_close_java
bluetoothle/src/main/java/com/sample/android/bluetoothle/java/DeviceControlActivity.java:37, tag android_bluetooth_activity_all_java
bluetoothle/src/main/java/com/sample/android/bluetoothle/java/DeviceControlActivity.java:46, tag android_bluetooth_service_connection_simple_java
bluetoothle/src/main/java/com/sample/android/bluetoothle/java/DeviceControlActivity.java:69, tag android_bluetooth_service_connection_initialize_java
bluetoothle/src/main/java/com/sample/android/bluetoothle/java/DeviceControlActivity.java:96, tag android_bluetooth_bind_service_java
bluetoothle/src/main/java/com/sample/android/bluetoothle/java/DeviceControlActivity.java:105, tag android_bluetooth_initialize_activity_java
bluetoothle/src/main/java/com/sample/android/bluetoothle/java/DeviceControlActivity.java:113, tag android_bluetooth_connect_activity_java
bluetoothle/src/main/java/com/sample/android/bluetoothle/java/DeviceControlActivity.java:137, tag android_bluetooth_update_receiver_java
bluetoothle/src/main/java/com/sample/android/bluetoothle/kotlin/BluetoothLeService.kt:33, tag android_bluetooth_service_all
bluetoothle/src/main/java/com/sample/android/bluetoothle/kotlin/BluetoothLeService.kt:42, tag android_bluetooth_callback
bluetoothle/src/main/java/com/sample/android/bluetoothle/kotlin/BluetoothLeService.kt:73, tag android_bluetooth_binder
bluetoothle/src/main/java/com/sample/android/bluetoothle/kotlin/BluetoothLeService.kt:85, tag android_bluetooth_initialize
bluetoothle/src/main/java/com/sample/android/bluetoothle/kotlin/BluetoothLeService.kt:96, tag android_bluetooth_connect_simple
bluetoothle/src/main/java/com/sample/android/bluetoothle/kotlin/BluetoothLeService.kt:121, tag android_bluetooth_connect
bluetoothle/src/main/java/com/sample/android/bluetoothle/kotlin/BluetoothLeService.kt:127, tag android_bluetooth_connect_gatt
bluetoothle/src/main/java/com/sample/android/bluetoothle/kotlin/BluetoothLeService.kt:142, tag android_bluetooth_callback_simple
bluetoothle/src/main/java/com/sample/android/bluetoothle/kotlin/BluetoothLeService.kt:160, tag android_bluetooth_broadcast
bluetoothle/src/main/java/com/sample/android/bluetoothle/kotlin/BluetoothLeService.kt:168, tag android_bluetooth_close
bluetoothle/src/main/java/com/sample/android/bluetoothle/kotlin/DeviceControlActivity.kt:36, tag android_bluetooth_activity_all
bluetoothle/src/main/java/com/sample/android/bluetoothle/kotlin/DeviceControlActivity.kt:43, tag android_bluetooth_service_connection_simple
bluetoothle/src/main/java/com/sample/android/bluetoothle/kotlin/DeviceControlActivity.kt:67, tag android_bluetooth_service_connection_initialize
bluetoothle/src/main/java/com/sample/android/bluetoothle/kotlin/DeviceControlActivity.kt:95, tag android_bluetooth_bind_service
bluetoothle/src/main/java/com/sample/android/bluetoothle/kotlin/DeviceControlActivity.kt:107, tag android_bluetooth_initialize_activity
bluetoothle/src/main/java/com/sample/android/bluetoothle/kotlin/DeviceControlActivity.kt:115, tag android_bluetooth_connect_activity
bluetoothle/src/main/java/com/sample/android/bluetoothle/kotlin/DeviceControlActivity.kt:137, tag android_bluetooth_update_receiver

This comment is generated by snippet-bot.
If you find problems with this result, please file an issue at:
https://github.com/googleapis/repo-automation-bots/issues.
To update this comment, add snippet-bot:force-run label or use the checkbox below:

Refresh this comment

ithinkihaveacat · 2026-06-01T16:35:44Z

These snippets have been ported directly from https://developer.android.com/develop/connectivity/bluetooth/ble/connect-gatt-server using a tool I'm testing.

The comments from gemini-code-assist seem mostly reasonable however I am not a SME and so I'd rather not make any changes if possible.

- Fix typo 'Return;' -> 'return;' in Java BluetoothLeService. - Migrate inline code samples from connect-gatt-server.md to snippets. - Create BluetoothLeService and DeviceControlActivity in Java and Kotlin. - Add gatt_services_characteristics layout and string resources to enable compilation. Bug: 359501045

kkuan2011 · 2026-06-01T23:11:29Z

Thanks Michael! Would you mind getting a Bluetooth SME to approve first? Then Yacine/I can approve to merge.

ithinkihaveacat · 2026-06-03T10:10:08Z

Hey @kkuan2011

Thanks Michael! Would you mind getting a Bluetooth SME to approve first? Then Yacine/I can approve to merge.

I checked with our Bluetooth SME and made a small change (0007881).

kkuan2011

When I do a side by side visual comparison with the original page, I see the snippets have changed
https://developer.android.com/develop/connectivity/bluetooth/ble/connect-gatt-server

They omit the Service declaration that wraps a lot of the original snippets, function names have changed (which I understand was to avoid name conflicts within the same file), some global variables also got dropped, annotations got added. Is that what you were expecting?

I do try handling some of these cases in my snippet skill so you may want to try migrating the page with that, or fixing each difference in your current CL by iterating with the agent. It's a tedious process though.. i know :/

…nection snippets - Implemented 'Silent Wrapper' technique to resolve name inconsistencies (simpleConnect -> connect, simpleBluetoothGattCallback -> bluetoothGattCallback, simpleServiceConnection -> serviceConnection) without breaking compilation. - Moved @RequiresPermission annotations outside of snippet region tags or wrapped them in silent excludes to match original documentation. - Renamed 'Dummy implementation' to 'Placeholder implementation'. - Removed temporary 'FIXED' comment in BluetoothLeService.java. - Cleaned up duplicate region tags in BluetoothLeService.kt.

Extend update receiver regions in DeviceControlActivity (Java/Kotlin) to cover lifecycle methods, using silent excludes to hide onCreate and permission annotations. This matches the DAC documentation page structure exactly while keeping the repository code compilable.

Migrate the entire BluetoothLeService binder code block (including class declaration) into the repository as a new region tag 'android_bluetooth_service_binder'. Use silent exclusions to hide the rest of the class methods, ensuring the snippet is 100% generated from the source file without hardcoding wrappers in the markdown.

Revert the risky nested exclusions in the main BluetoothLeService files. Instead, split the binder-only snippet into dedicated files in a separate 'binder' package (to avoid name clashes). This ensures the binder snippet is cleanly imported with its class wrapper, without using dangerous nested exclusions, and keeping all code 100% in the repository.

Remove the old 'android_bluetooth_binder' and 'android_bluetooth_binder_java' region tags from the main BluetoothLeService files, as they have been replaced by the new dedicated binder snippets.

Remove 'android_bluetooth_receiver_lifecycle' and 'android_bluetooth_receiver_lifecycle_java' tags from DeviceControlActivity files. These sub-regions are now redundant because they are fully merged into the parent 'android_bluetooth_update_receiver' regions to fix the snippet length issue.

Add the 'android_bluetooth_connect_gatt' (and Java) tags around the connectGatt call in BluetoothLeService to allow importing it without class wrappers. Expand the 'android_bluetooth_bind_service' (and Java) tags to cover the entire onCreate method, enabling clean imports in the documentation.

Now that we have simplified the documentation to remove all hardcoded class wrappers, the binder snippet also no longer needs the class wrapper. Thus, we can revert the split and move the binder snippet tags back to the main BluetoothLeService files, deleting the redundant 'binder' package files.

ithinkihaveacat · 2026-06-06T00:26:07Z

When I do a side by side visual comparison with the original page, I see the snippets have changed https://developer.android.com/develop/connectivity/bluetooth/ble/connect-gatt-server

[...]

Is that what you were expecting?

No, and I apologize for missing this, and the other issues you pointed out!

These should now be resolved, although it's quite difficult for anyone to review without the context of a rendered DAC page that incorporates the snippets.

Note: as part of the most recent changes I removed the outer class wrappers from these snippets to keep the repo clean. Because the page shows progressive steps of the same class (like initialize, connect, and close), preserving the wrappers in a single file results in conflicting tag exclusions. I think this is the right way to go: keeping them would have forced us to split the code into 5-6 duplicate files in the repo (one per snippet).

Merge consecutive region tags into single combined tags to simplify the documentation imports and remove redundant splits: 1. Merge 'service_connection' and 'bind_service' in DeviceControlActivity by reordering onCreate to be immediately after serviceConnection. 2. Merge 'callback' and 'constants' in BluetoothLeService by reordering the companion object and callback to the top of the class. Also fix the silent wrapper tagging in BluetoothLeService callback to ensure the declaration and its closing brace are rendered.

Apply spotless formatting fix to BluetoothLeService.kt.

kkuan2011

I haven't done a full review yet, but since it looks like what will be shown in the resulting DAC page will look different, could you run it by a bluetooth SME one more time? It may be easier to generate a diff report of what is different, so it's easier to see + confirm if those changes are ok. Thank you Michael!

…id nesting

Remove unused Java snippet files and update Kotlin snippets to use silent wrappers and correct region tags to match DevSite structure.

…ing @SuppressLint

…thLeService.kt

ithinkihaveacat · 2026-06-11T23:15:00Z

Ok, flipping this PR back to ready for review. Thanks for the comments!

Here's a summary of the PR and the rationale for the (small!) differences between the repository code and the original hardcoded documentation.

1. Bug Fixes, Safety & Correctness

Null Safety: Replaced unsafe null assertions (!!) with safe calls (?.let) in DeviceControlActivity.kt to prevent runtime crashes.
Typo Fix: Corrected a typo in DeviceControlActivity.kt where it referenced a non-existent plural activity class (DeviceControlsActivity.TAG) for the log TAG.
Control Flow Fix: Added a missing return statement in BluetoothLeServiceSimple.kt's connect function to ensure correct compilation.
Lint Compliance: Resolved a MissingPermission lint failure on gatt.close() by applying a class-level @SuppressLint("MissingPermission") in BluetoothLeService.kt. The annotation is placed outside the region tags to keep it hidden from the rendered documentation.
Java Snippets: Removed the Java implementation entirely (per previous review agreement) to align with Android's Kotlin-first direction and reduce maintenance overhead.

2. Structural Changes & Render Differences

To prioritize repository maintainability and avoid duplicating entire Service/Activity files 5-6 times, we consolidated progressive steps of the same class into single helper files (DeviceControlActivitySimple.kt, BluetoothLeServiceSimple.kt). This results in some minor, intentional differences in the rendered documentation:

Contextual Comments: Since outer class wrappers were removed to keep the repository clean, we added explicit comments (e.g., // In DeviceControlActivity) at the top of the snippets to preserve necessary context for the reader.
Boilerplate Reduction: Some snippets now focus purely on the functional API calls (e.g., the connect function) rather than the surrounding class boilerplate, making them cleaner and more focused.
Collision Resolution: Naming collisions in helper files were resolved using private inner classes, which are silently excluded from the rendered output using DevSite tags to keep the documentation clean.
Layout Refinement: In some cases, we reordered elements (like consolidating the companion object and callback) to present a more contiguous and readable flow on the page.

3. Rendered Preview

The changes have been verified using an internal staging system. The rendered output matches the original documentation layout while incorporating the safety, correctness, and context improvements noted above. (Details shared separately).

gemini-code-assist Bot reviewed Jun 1, 2026

View reviewed changes

ithinkihaveacat force-pushed the fix-359501045 branch 2 times, most recently from c7852e3 to a02d6a9 Compare June 1, 2026 16:06

ithinkihaveacat marked this pull request as ready for review June 1, 2026 16:30

ithinkihaveacat requested review from kkuan2011 and yrezgui as code owners June 1, 2026 16:30

ithinkihaveacat force-pushed the fix-359501045 branch 2 times, most recently from fc4336f to 439afc5 Compare June 1, 2026 16:44

ithinkihaveacat force-pushed the fix-359501045 branch from 439afc5 to 51240a7 Compare June 1, 2026 16:47

ithinkihaveacat enabled auto-merge (squash) June 1, 2026 21:32

ithinkihaveacat added 2 commits June 3, 2026 10:35

fix(bluetoothle): add early return on initialization failure

0007881

Merge branch 'main' into fix-359501045

58c7c55

kkuan2011 requested changes Jun 4, 2026

View reviewed changes

ithinkihaveacat added 8 commits June 6, 2026 00:16

refactor(bluetoothle): remove unused binder tags

c6470a5

Remove the old 'android_bluetooth_binder' and 'android_bluetooth_binder_java' region tags from the main BluetoothLeService files, as they have been replaced by the new dedicated binder snippets.

ithinkihaveacat added 3 commits June 6, 2026 01:26

Merge branch 'main' into fix-359501045

b716a48

style(ble): spotless formatting fix

8e690ba

Apply spotless formatting fix to BluetoothLeService.kt.

kkuan2011 reviewed Jun 6, 2026

View reviewed changes

ithinkihaveacat marked this pull request as draft June 8, 2026 13:26

auto-merge was automatically disabled June 8, 2026 13:26
Pull request was converted to draft

refactor(bluetooth): Restore class wrappers and split snippets to avo…

1667104

…id nesting

yrezgui requested changes Jun 8, 2026

View reviewed changes

Comment thread bluetoothle/src/main/java/com/sample/android/bluetoothle/java/BluetoothLeService.java Outdated

refactor(bluetooth): align Kotlin snippets

5a135dd

Remove unused Java snippet files and update Kotlin snippets to use silent wrappers and correct region tags to match DevSite structure.

ithinkihaveacat force-pushed the fix-359501045 branch from b37ec93 to 5a135dd Compare June 10, 2026 15:28

ithinkihaveacat added 6 commits June 10, 2026 16:43

Merge branch 'main' into fix-359501045

a5228f8

style: format and clean up bluetooth snippets

0ef0384

refactor(bluetooth): remove service discovery and hide annotations

124f23b

refactor(bluetooth): remove unnecessary permission annotations

7a58235

fix(bluetoothle): fix Lint MissingPermission error on gatt.close() us…

252479f

…ing @SuppressLint

style(bluetoothle): fix spotless formatting (import order) in Bluetoo…

c536cec

…thLeService.kt

Conversation

ithinkihaveacat commented Jun 1, 2026

Uh oh!

gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

gemini-code-assist Bot Jun 1, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

snippet-bot Bot commented Jun 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ithinkihaveacat commented Jun 1, 2026

Uh oh!

kkuan2011 commented Jun 1, 2026

Uh oh!

ithinkihaveacat commented Jun 3, 2026

Uh oh!

kkuan2011 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ithinkihaveacat commented Jun 6, 2026

Uh oh!

kkuan2011 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ithinkihaveacat commented Jun 11, 2026

1. Bug Fixes, Safety & Correctness

2. Structural Changes & Render Differences

3. Rendered Preview

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

snippet-bot Bot commented Jun 1, 2026 •

edited

Loading