-
Notifications
You must be signed in to change notification settings - Fork 174
/
Copy pathAppLinkSplitToWebAndCustom.md.html
160 lines (138 loc) · 6.69 KB
/
AppLinkSplitToWebAndCustom.md.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
<meta charset="utf-8">
(#) Android App links should only use http(s) schemes
!!! ERROR: Android App links should only use http(s) schemes
This is an error.
Id
: `AppLinkSplitToWebAndCustom`
Summary
: Android App links should only use http(s) schemes
Severity
: Error
Category
: Correctness
Platform
: Android
Vendor
: Android Open Source Project
Feedback
: https://issuetracker.google.com/issues/new?component=192708
Affects
: Manifest files
Editing
: This check runs on the fly in the IDE editor
See
: https://developer.android.com/training/app-links/verify-android-applinks#add-intent-filters
Implementation
: [Source Code](https://cs.android.com/android-studio/platform/tools/base/+/mirror-goog-studio-main:lint/libs/lint-checks/src/main/java/com/android/tools/lint/checks/AppLinksValidDetector.kt)
Tests
: [Source Code](https://cs.android.com/android-studio/platform/tools/base/+/mirror-goog-studio-main:lint/libs/lint-tests/src/test/java/com/android/tools/lint/checks/AppLinksValidDetectorTest.kt)
Copyright Year
: 2017
In order for Android App Links to open in your app, Android must perform
domain verification. However, Android only sends domain verification
requests for `<intent-filter>`s that only contain http(s) schemes.
To ensure correct behavior, please split your http(s) schemes and other
schemes into two different `<intent-filter>`s.
!!! Tip
This lint check has an associated quickfix available in the IDE.
(##) Example
Here is an example of lint warnings produced by this check:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~text
AndroidManifest.xml:7:Error: Split your http(s) and custom schemes into
separate intent filters [AppLinkSplitToWebAndCustom]
<intent-filter android:autoVerify="true" android:order="-1" android:priority="-1">
^
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Here are the relevant source files:
`AndroidManifest.xml`:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~xml linenumbers
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
package="com.example.helloworld" >
<uses-sdk android:minSdkVersion="31" android:targetSdkVersion="34" />
<application>
<activity android:name=".SplitWebAndCustomActivity" android:exported="true">
<intent-filter android:autoVerify="true" android:order="-1" android:priority="-1">
<action android:name="android.intent.action.VIEW" />
<category android:name="android.intent.category.DEFAULT" />
<category android:name="android.intent.category.BROWSABLE" />
<uri-relative-filter-group>
<data android:path="/path" />
<data android:query="queryparam=value" />
</uri-relative-filter-group>
<data android:scheme="http" />
<data android:scheme="custom" />
<data android:host="library.com" />
<data android:path="@string/path" />
<data android:path="/<&''" />
<data android:path='/single"quote' />
<data android:path="" />
<!-- Test having tags underneath the host elements as well -->
<action android:name="android.intent.action.SEND"/>
<uri-relative-filter-group>
<data android:path="/path" />
<data android:query="queryparam=value" />
</uri-relative-filter-group>
</intent-filter>
</activity>
</application>
</manifest>
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
`res/values/strings.xml`:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~xml linenumbers
<resources>
<string name="path">/path</string>
</resources>
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
You can also visit the
[source code](https://cs.android.com/android-studio/platform/tools/base/+/mirror-goog-studio-main:lint/libs/lint-tests/src/test/java/com/android/tools/lint/checks/AppLinksValidDetectorTest.kt)
for the unit tests for this check to see additional scenarios.
The above example was automatically extracted from the first unit test
found for this lint check, `AppLinksValidDetector.test_splitToWebAndCustomSchemes`.
To report a problem with this extracted sample, visit
https://issuetracker.google.com/issues/new?component=192708.
(##) Suppressing
You can suppress false positives using one of the following mechanisms:
* Adding the suppression attribute
`tools:ignore="AppLinkSplitToWebAndCustom"` on the problematic XML
element (or one of its enclosing elements). You may also need to add
the following namespace declaration on the root element in the XML
file if it's not already there:
`xmlns:tools="http://schemas.android.com/tools"`.
```xml
<?xml version="1.0" encoding="UTF-8"?>
<manifest xmlns:tools="http://schemas.android.com/tools">
...
<activity tools:ignore="AppLinkSplitToWebAndCustom" .../>
...
</manifest>
```
* Using a special `lint.xml` file in the source tree which turns off
the check in that folder and any sub folder. A simple file might look
like this:
```xml
<?xml version="1.0" encoding="UTF-8"?>
<lint>
<issue id="AppLinkSplitToWebAndCustom" severity="ignore" />
</lint>
```
Instead of `ignore` you can also change the severity here, for
example from `error` to `warning`. You can find additional
documentation on how to filter issues by path, regular expression and
so on
[here](https://googlesamples.github.io/android-custom-lint-rules/usage/lintxml.md.html).
* In Gradle projects, using the DSL syntax to configure lint. For
example, you can use something like
```gradle
lintOptions {
disable 'AppLinkSplitToWebAndCustom'
}
```
In Android projects this should be nested inside an `android { }`
block.
* For manual invocations of `lint`, using the `--ignore` flag:
```
$ lint --ignore AppLinkSplitToWebAndCustom ...`
```
* Last, but not least, using baselines, as discussed
[here](https://googlesamples.github.io/android-custom-lint-rules/usage/baselines.md.html).
<!-- Markdeep: --><style class="fallback">body{visibility:hidden;white-space:pre;font-family:monospace}</style><script src="markdeep.min.js" charset="utf-8"></script><script src="https://morgan3d.github.io/markdeep/latest/markdeep.min.js" charset="utf-8"></script><script>window.alreadyProcessedMarkdeep||(document.body.style.visibility="visible")</script>