Skip to content

Commit 712e0a7

Browse files
authored
Remove todo assignment (#12884)
1 parent ce01f00 commit 712e0a7

File tree

26 files changed

+37
-41
lines changed

26 files changed

+37
-41
lines changed

buildscripts/checkstyle.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -405,7 +405,7 @@
405405
<!-- skip jflex generated files -->
406406
<module name="SuppressionSingleFilter">
407407
<property name="checks" value=".*"/>
408-
<!-- TODO(anuraaga): Fix path after https://github.com/jprante/gradle-plugin-jflex/issues/20 -->
408+
<!-- TODO: Fix path after https://github.com/jprante/gradle-plugin-jflex/issues/20 -->
409409
<property name="files"
410410
value="instrumentation-api[/\\]build[/\\]generated[/\\]sources[/\\]main"/>
411411
</module>

conventions/src/main/kotlin/io.opentelemetry.instrumentation.javaagent-testing.gradle.kts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -104,8 +104,8 @@ afterEvaluate {
104104
val agentShadowJar = agentForTesting.resolve().first()
105105

106106
dependsOn(shadowJar)
107-
// TODO(anuraaga): Figure out why dependsOn override is still needed in otel.javaagent-testing
108-
// despite this dependency.
107+
// TODO: Figure out why dependsOn override is still needed in otel.javaagent-testing despite
108+
// this dependency.
109109
dependsOn(agentForTesting.buildDependencies)
110110

111111
jvmArgumentProviders.add(JavaagentTestArgumentsProvider(agentShadowJar, shadowJar.archiveFile.get().asFile))
@@ -119,8 +119,8 @@ afterEvaluate {
119119
return@filter false
120120
}
121121

122-
// TODO(anuraaga): Better not to have this naming constraint, we can likely use
123-
// plugin identification instead.
122+
// TODO: Better not to have this naming constraint, we can likely use plugin identification
123+
// instead.
124124

125125
val lib = it.absoluteFile
126126
if (lib.name.startsWith("opentelemetry-javaagent-")) {

conventions/src/main/kotlin/otel.errorprone-conventions.gradle.kts

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ tasks {
9090
disable("TypeParameterNaming")
9191

9292
// In bytecode instrumentation it's very common to separate across onEnter / onExit
93-
// TODO(anuraaga): Only disable for javaagent instrumentation modules.
93+
// TODO: Only disable for javaagent instrumentation modules.
9494
disable("MustBeClosedChecker")
9595

9696
// Common to avoid an allocation. Revisit if it's worth opt-in suppressing instead of
@@ -101,16 +101,15 @@ tasks {
101101
disable("JdkObsolete")
102102
disable("JavaUtilDate")
103103

104-
// TODO(anuraaga): Remove this, we use this pattern in several tests and it will mean
105-
// some moving.
104+
// TODO: Remove this, we use this pattern in several tests and it will mean some moving.
106105
disable("DefaultPackage")
107106

108107
// we use modified Otel* checks which ignore *Advice classes
109108
disable("PrivateConstructorForUtilityClass")
110109
disable("CanIgnoreReturnValueSuggester")
111110

112-
// TODO(anuraaga): Remove this, probably after instrumenter API migration instead of dealing
113-
// with older APIs.
111+
// TODO: Remove this, probably after instrumenter API migration instead of dealing with
112+
// older APIs.
114113
disable("InconsistentOverloads")
115114

116115
// lots of low level APIs use arrays

conventions/src/main/kotlin/otel.java-conventions.gradle.kts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -342,7 +342,7 @@ tasks.withType<Test>().configureEach {
342342
// There's no real harm in setting this for all tests even if any happen to not be using context
343343
// propagation.
344344
jvmArgs("-Dio.opentelemetry.context.enableStrictContext=${rootProject.findProperty("enableStrictContext") ?: true}")
345-
// TODO(anuraaga): Have agent map unshaded to shaded.
345+
// TODO: Have agent map unshaded to shaded.
346346
if (project.findProperty("disableShadowRelocate") != "true") {
347347
jvmArgs("-Dio.opentelemetry.javaagent.shaded.io.opentelemetry.context.enableStrictContext=${rootProject.findProperty("enableStrictContext") ?: true}")
348348
} else {

examples/distro/smoke-tests/src/test/java/com/example/javaagent/smoketest/SmokeTest.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -158,8 +158,7 @@ protected Collection<ExportTraceServiceRequest> waitForTraces()
158158
.map(
159159
it -> {
160160
ExportTraceServiceRequest.Builder builder = ExportTraceServiceRequest.newBuilder();
161-
// TODO(anuraaga): Register parser into object mapper to avoid de -> re ->
162-
// deserialize.
161+
// TODO: Register parser into object mapper to avoid de -> re -> deserialize.
163162
try {
164163
JsonFormat.parser().merge(OBJECT_MAPPER.writeValueAsString(it), builder);
165164
} catch (InvalidProtocolBufferException | JsonProcessingException e) {

instrumentation/armeria/armeria-1.3/testing/src/main/java/io/opentelemetry/instrumentation/armeria/v1_3/AbstractArmeriaHttpServerTest.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -180,8 +180,8 @@ protected void configure(HttpServerTestOptions options) {
180180
options.setExpectedHttpRoute(
181181
(endpoint, method) -> {
182182
if (endpoint == ServerEndpoint.NOT_FOUND) {
183-
// TODO(anuraaga): Revisit this when applying instrumenters to more libraries, Armeria
184-
// currently reports '/*' which is a fallback route.
183+
// TODO: Revisit this when applying instrumenters to more libraries, Armeria currently
184+
// reports '/*' which is a fallback route.
185185
return "/*";
186186
}
187187
return expectedHttpRoute(endpoint, method);

instrumentation/aws-lambda/aws-lambda-core-1.0/library/src/main/java/io/opentelemetry/instrumentation/awslambdacore/v1_0/internal/ApiGatewayProxyRequest.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ public abstract class ApiGatewayProxyRequest {
2525

2626
private static final Logger logger = Logger.getLogger(ApiGatewayProxyRequest.class.getName());
2727

28-
// TODO(anuraaga): We should create a RequestFactory type of class instead of evaluating this
29-
// for every request.
28+
// TODO: We should create a RequestFactory type of class instead of evaluating this for every
29+
// request.
3030
private static boolean noHttpPropagationNeeded() {
3131
Collection<String> fields =
3232
GlobalOpenTelemetry.getPropagators().getTextMapPropagator().fields();

instrumentation/aws-lambda/aws-lambda-events-2.2/library/build.gradle.kts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ dependencies {
2828
// We need Jackson for wrappers to reproduce the serialization does when Lambda invokes a RequestHandler with event
2929
// since Lambda will only be able to invoke the wrapper itself with a generic Object.
3030
// Note that Lambda itself uses Jackson, but does not expose it to the function so we need to include it here.
31-
// TODO(anuraaga): Switch to aws-lambda-java-serialization to more robustly follow Lambda's serialization logic.
31+
// TODO: Switch to aws-lambda-java-serialization to more robustly follow Lambda's serialization logic.
3232
implementation("com.fasterxml.jackson.core:jackson-databind")
3333
implementation("io.opentelemetry.contrib:opentelemetry-aws-xray-propagator")
3434

instrumentation/aws-sdk/aws-sdk-2.2/testing/src/main/groovy/io/opentelemetry/instrumentation/awssdk/v2_2/AbstractAws2ClientTest.groovy

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -408,7 +408,7 @@ abstract class AbstractAws2ClientTest extends AbstractAws2ClientCoreTest {
408408
"""
409409
}
410410

411-
// TODO(anuraaga): Without AOP instrumentation of the HTTP client, we cannot model retries as
411+
// TODO: Without AOP instrumentation of the HTTP client, we cannot model retries as
412412
// spans because of https://github.com/aws/aws-sdk-java-v2/issues/1741. We should at least tweak
413413
// the instrumentation to add Events for retries instead.
414414
def "timeout and retry errors not captured"() {

instrumentation/finatra-2.9/javaagent/build.gradle.kts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,7 @@ val finatraLatest by configurations.creating {
2828
}
2929

3030
dependencies {
31-
// TODO(anuraaga): Something about library configuration doesn't work well with scala compilation
32-
// here.
31+
// TODO: Something about library configuration doesn't work well with scala compilation here.
3332
compileOnly("com.twitter:finatra-http_2.11:2.9.0")
3433

3534
testInstrumentation(project(":instrumentation:netty:netty-4.1:javaagent"))

0 commit comments

Comments
 (0)