-
Notifications
You must be signed in to change notification settings - Fork 174
/
Copy pathBadPeriodicWorkRequestEnqueue.md.html
142 lines (118 loc) · 4.03 KB
/
BadPeriodicWorkRequestEnqueue.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
<meta charset="utf-8">
(#) Use `enqueueUniquePeriodicWork()` instead of `enqueue()`
!!! WARNING: Use `enqueueUniquePeriodicWork()` instead of `enqueue()`
This is a warning.
Id
: `BadPeriodicWorkRequestEnqueue`
Summary
: Use `enqueueUniquePeriodicWork()` instead of `enqueue()`
Severity
: Warning
Category
: Correctness
Platform
: Android
Vendor
: Android Open Source Project
Identifier
: androidx.work
Feedback
: https://issuetracker.google.com/issues/new?component=409906
Min
: Lint 7.0
Compiled
: Lint 8.0 and 8.1
Artifact
: [androidx.work:work-runtime](androidx_work_work-runtime.md.html)
Affects
: Kotlin and Java files
Editing
: This check runs on the fly in the IDE editor
Implementation
: [Source Code](https://cs.android.com/androidx/platform/frameworks/support/+/androidx-main:/work/work-lint/src/main/java/androidx/work/lint/PeriodicEnqueueIssueDetector.kt)
Tests
: [Source Code](https://cs.android.com/androidx/platform/frameworks/support/+/androidx-main:/work/work-lint/src/test/java/androidx/work/lint/PeriodicEnqueueIssueDetectorTest.kt)
Copyright Year
: 2019
When using `enqueue()` for `PeriodicWorkRequest`s, you might end up
enqueuing
duplicate requests unintentionally. You should be using
`enqueueUniquePeriodicWork` with an `ExistingPeriodicWorkPolicy.KEEP`
instead.
(##) Including
!!!
This is not a built-in check. To include it, add the below dependency
to your project.
```
// build.gradle.kts
implementation("androidx.work:work-runtime:2.10.0-alpha02")
// build.gradle
implementation 'androidx.work:work-runtime:2.10.0-alpha02'
// build.gradle.kts with version catalogs:
implementation(libs.work.runtime)
# libs.versions.toml
[versions]
work-runtime = "2.10.0-alpha02"
[libraries]
work-runtime = {
module = "androidx.work:work-runtime",
version.ref = "work-runtime"
}
```
2.10.0-alpha02 is the version this documentation was generated from;
there may be newer versions available.
[Additional details about androidx.work:work-runtime](androidx_work_work-runtime.md.html).
(##) Suppressing
You can suppress false positives using one of the following mechanisms:
* Using a suppression annotation like this on the enclosing
element:
```kt
// Kotlin
@Suppress("BadPeriodicWorkRequestEnqueue")
fun method() {
enqueue(...)
}
```
or
```java
// Java
@SuppressWarnings("BadPeriodicWorkRequestEnqueue")
void method() {
enqueue(...);
}
```
* Using a suppression comment like this on the line above:
```kt
//noinspection BadPeriodicWorkRequestEnqueue
problematicStatement()
```
* 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="BadPeriodicWorkRequestEnqueue" 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 'BadPeriodicWorkRequestEnqueue'
}
```
In Android projects this should be nested inside an `android { }`
block.
* For manual invocations of `lint`, using the `--ignore` flag:
```
$ lint --ignore BadPeriodicWorkRequestEnqueue ...`
```
* 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>