Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add URLEqualHashCode Recipe #251

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
/*
* Copyright 2024 the original author or authors.
* <p>
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* <p>
* https://www.apache.org/licenses/LICENSE-2.0
* <p>
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.openrewrite.staticanalysis;

import com.google.errorprone.refaster.annotation.AfterTemplate;
import com.google.errorprone.refaster.annotation.BeforeTemplate;
import org.openrewrite.java.template.RecipeDescriptor;

import java.net.URI;
import java.net.URL;

@SuppressWarnings("UrlHashCode")
@RecipeDescriptor(
name = "URL Equals and Hash Code",
description = "Uses of `equals()` and `hashCode()` cause `java.net.URL` to make blocking internet connections. " +
"Instead, use `java.net.URI`.",
tags = {"RSPEC-2112"}
)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should add some Markdown formatting here. Also, I don't think the errorprone tag is very useful. Does Errorprone have a check of this type?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://errorprone.info/bugpattern/URLEqualsHashCode

I'll add the markdown formatting. Good point. 😄

public class URLEqualsHashCode {

@RecipeDescriptor(
name = "URL Equals",
description = "Uses of `equals()` cause `java.net.URL` to make blocking internet connections. " +
"Instead, use `java.net.URI`.",
tags = {"RSPEC-2112"}
)
public static class URLEquals {
@BeforeTemplate
boolean before(URL a, URL b) {
return a.equals(b);
}

@AfterTemplate
boolean after(URL a, URL b) {
return URI.create(a.toString()).equals(URI.create(b.toString()));
}
}

@RecipeDescriptor(
name = "URL Hash Code",
description = "Uses of `hashCode()` cause `java.net.URL` to make blocking internet connections. " +
"Instead, use `java.net.URI`.",
tags = {"RSPEC-2112"}
)
public static class URLHashCode {
@BeforeTemplate
int before(URL a) {
return a.hashCode();
}

@AfterTemplate
int after(URL a) {
return URI.create(a.toString()).hashCode();
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
/*
* Copyright 2024 the original author or authors.
* <p>
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* <p>
* https://www.apache.org/licenses/LICENSE-2.0
* <p>
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.openrewrite.staticanalysis;

import org.junit.jupiter.api.Test;

timtebeek marked this conversation as resolved.
Show resolved Hide resolved
timtebeek marked this conversation as resolved.
Show resolved Hide resolved
import org.openrewrite.DocumentExample;
import org.openrewrite.test.RecipeSpec;
import org.openrewrite.test.RewriteTest;
timtebeek marked this conversation as resolved.
Show resolved Hide resolved

import static org.openrewrite.java.Assertions.java;

class URLEqualsHashCodeTest implements RewriteTest {

@Override
public void defaults(RecipeSpec spec) {
spec.recipe(new URLEqualsHashCodeRecipes());
}

@DocumentExample
@Test
timtebeek marked this conversation as resolved.
Show resolved Hide resolved
void urlHashCode() {
rewriteRun(
java(
"""
import java.net.URL;

class Test {
public void test() {
URL url = new URL("https://example.com");
int hash = url.hashCode();
}
}
""",
"""
import java.net.URI;
import java.net.URL;

class Test {
public void test() {
URL url = new URL("https://example.com");
int hash = URI.create(url.toString()).hashCode();
}
}
"""
)
);
}

@Test
void urlEquals() {
rewriteRun(
java(
"""
import java.net.URL;

class Test {
public void test() {
URL url1 = new URL("https://example.com");
URL url2 = new URL("https://example.com");
boolean equals = url1.equals(url2);
}
}
""",
"""
import java.net.URI;
import java.net.URL;

class Test {
public void test() {
URL url1 = new URL("https://example.com");
URL url2 = new URL("https://example.com");
boolean equals = URI.create(url1.toString()).equals(URI.create(url2.toString()));
}
}
"""
)
);
}
}
Loading