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.

Sign up for GitHub

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

Jump to bottom

chore(spotbugs): resolve spotbugs warnings #120

Merged
merged 9 commits into from
Oct 25, 2023
Merged

chore(spotbugs): resolve spotbugs warnings #120

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
70b7697
make constants final
andrewazores Oct 24, 2023
21ba2ad
comment out empty method stub
andrewazores Oct 24, 2023
078ba04
specify UTF_8 encoding
andrewazores Oct 24, 2023
0e818d1
throw if no credential available
andrewazores Oct 24, 2023
793824f
clean dead store
andrewazores Oct 24, 2023
87f30d8
ignore spotbugs warnings about internal representations exposed on co…
andrewazores Oct 24, 2023
98e508c
specify UTF_8 encodings more
andrewazores Oct 24, 2023
6f02f40
make constant static
andrewazores Oct 24, 2023
e698cfa
ignore unread field warning
andrewazores Oct 24, 2023
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
3 changes: 1 addition & 2 deletions src/main/java/io/cryostat/discovery/ContainerDiscovery.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -338,9 +338,8 @@ public void handleContainerEvent(ContainerSpec desc, EventKind evtKind) {
DiscoveryNode node = DiscoveryNode.target(target);
target.discoveryNode = node;
String podName = desc.PodName;
DiscoveryNode pod = new DiscoveryNode();
if (StringUtils.isNotBlank(podName)) {
pod = DiscoveryNode.environment(podName, DiscoveryNode.POD);
DiscoveryNode pod = DiscoveryNode.environment(podName, DiscoveryNode.POD);
if (!realm.children.contains(pod)) {
pod.children.add(node);
realm.children.add(pod);
Expand Down
40 changes: 18 additions & 22 deletions src/main/java/io/cryostat/discovery/DiscoveryNode.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,11 @@
import java.util.function.Predicate;

import io.cryostat.targets.Target;
import io.cryostat.targets.Target.TargetDiscovery;

import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonInclude.Include;
import com.fasterxml.jackson.annotation.JsonView;
import io.quarkus.hibernate.orm.panache.PanacheEntity;
import io.quarkus.vertx.ConsumeEvent;
import io.smallrye.common.annotation.Blocking;
import io.vertx.mutiny.core.eventbus.EventBus;
import jakarta.enterprise.context.ApplicationScoped;
import jakarta.inject.Inject;
Expand All @@ -46,7 +43,6 @@
import jakarta.persistence.PostRemove;
import jakarta.persistence.PostUpdate;
import jakarta.persistence.PrePersist;
import jakarta.transaction.Transactional;
import org.hibernate.annotations.JdbcTypeCode;
import org.hibernate.type.SqlTypes;
import org.jboss.logging.Logger;
Expand All @@ -55,10 +51,10 @@
@EntityListeners(DiscoveryNode.Listener.class)
public class DiscoveryNode extends PanacheEntity {

public static String NODE_TYPE = "nodeType";
public static String UNIVERSE = "Universe";
public static String REALM = "Realm";
public static String POD = "Pod";
public static final String NODE_TYPE = "nodeType";
public static final String UNIVERSE = "Universe";
public static final String REALM = "Realm";
public static final String POD = "Pod";

@Column(unique = false, nullable = false, updatable = false)
@JsonView(Views.Flat.class)
Expand Down Expand Up @@ -151,20 +147,20 @@ static class Listener {
@Inject Logger logger;
@Inject EventBus bus;

@Transactional
@Blocking
@ConsumeEvent(Target.TARGET_JVM_DISCOVERY)
void onMessage(TargetDiscovery event) {
switch (event.kind()) {
case LOST:
break;
case FOUND:
break;
default:
// no-op
break;
}
}
// @Transactional
// @Blocking
// @ConsumeEvent(Target.TARGET_JVM_DISCOVERY)
// void onMessage(TargetDiscovery event) {
// switch (event.kind()) {
// case LOST:
// break;
// case FOUND:
// break;
// default:
// // no-op
// break;
// }
// }

@PrePersist
void prePersist(DiscoveryNode node) {}
Expand Down
41 changes: 26 additions & 15 deletions src/main/java/io/cryostat/discovery/DiscoveryPlugin.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
import java.io.IOException;
import java.net.URI;
import java.net.URISyntaxException;
import java.nio.charset.StandardCharsets;
import java.util.Base64;
import java.util.UUID;

Expand All @@ -36,6 +37,7 @@
import jakarta.persistence.Id;
import jakarta.persistence.OneToOne;
import jakarta.persistence.PrePersist;
import jakarta.ws.rs.BadRequestException;
import jakarta.ws.rs.GET;
import jakarta.ws.rs.Path;
import jakarta.ws.rs.client.ClientRequestContext;
Expand Down Expand Up @@ -119,30 +121,39 @@ public void filter(ClientRequestContext requestContext) throws IOException {
return;
}

Credential credential = null;
if (StringUtils.isNotBlank(userInfo) && userInfo.contains(":")) {
String[] parts = userInfo.split(":");
if ("storedcredentials".equals(parts[0])) {
if (parts.length == 2 && "storedcredentials".equals(parts[0])) {
logger.infov(
"Using stored credentials id:{0} referenced in ping callback"
+ " userinfo",
parts[1]);

credential = Credential.find("id", Long.parseLong(parts[1])).singleResult();
Credential credential =
Credential.find("id", Long.parseLong(parts[1])).singleResult();

requestContext
.getHeaders()
.add(
HttpHeaders.AUTHORIZATION,
"Basic "
+ Base64.getEncoder()
.encodeToString(
(credential.username
+ ":"
+ credential
.password)
.getBytes(
StandardCharsets
.UTF_8)));
} else {
throw new IllegalStateException("Unexpected credential format");
}
} else {
throw new IOException(
new BadRequestException(
"No credentials provided and none found in storage"));
}

requestContext
.getHeaders()
.add(
HttpHeaders.AUTHORIZATION,
"Basic "
+ Base64.getEncoder()
.encodeToString(
(credential.username
+ ":"
+ credential.password)
.getBytes()));
}
}
}
Expand Down
3 changes: 3 additions & 0 deletions src/main/java/io/cryostat/events/SerializableEventTypeInfo.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,9 @@
import org.openjdk.jmc.common.unit.IOptionDescriptor;
import org.openjdk.jmc.rjmx.services.jfr.IEventTypeInfo;

import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;

@SuppressFBWarnings("EI_EXPOSE_REP")
public record SerializableEventTypeInfo(
String name,
String typeId,
Expand Down
3 changes: 3 additions & 0 deletions src/main/java/io/cryostat/expressions/MatchExpression.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonValue;
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
import io.quarkus.hibernate.orm.panache.PanacheEntity;
import io.vertx.mutiny.core.eventbus.EventBus;
import jakarta.annotation.Nullable;
Expand Down Expand Up @@ -89,6 +90,7 @@ public MatchedExpression match(MatchExpression expr) throws ScriptException {
}
}

@SuppressFBWarnings("EI_EXPOSE_REP")
public static record MatchedExpression(
@Nullable Long id, String expression, Collection<Target> targets) {
public MatchedExpression {
Expand Down Expand Up @@ -145,6 +147,7 @@ private void notify(ExpressionEventCategory category, MatchExpression expr) {
}
}

@SuppressFBWarnings("EI_EXPOSE_REP")
public record ExpressionEvent(ExpressionEventCategory category, MatchExpression expression) {
public ExpressionEvent {
Objects.requireNonNull(category);
Expand Down
6 changes: 2 additions & 4 deletions src/main/java/io/cryostat/expressions/MatchExpressionEvaluator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
import io.cryostat.targets.Target;
import io.cryostat.targets.Target.Annotations;

import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
import io.quarkus.cache.Cache;
import io.quarkus.cache.CacheInvalidate;
import io.quarkus.cache.CacheManager;
Expand Down Expand Up @@ -171,10 +172,7 @@ public List<Target> getMatchedTargets(MatchExpression matchExpression) {
@Name("io.cryostat.rules.MatchExpressionEvaluator.MatchExpressionAppliesEvent")
@Label("Match Expression Evaluation")
@Category("Cryostat")
// @SuppressFBWarnings(
// value = "URF_UNREAD_FIELD",
// justification = "The event fields are recorded with JFR instead of accessed
// directly")
@SuppressFBWarnings(value = {"EI_EXPOSE_REP", "URF_UNREAD_FIELD"})
public static class MatchExpressionAppliesEvent extends Event {

String matchExpression;
Expand Down
4 changes: 3 additions & 1 deletion src/main/java/io/cryostat/recordings/EventOptionsBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@
import io.cryostat.core.net.JFRConnection;
import io.cryostat.core.tui.ClientWriter;

import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;

public class EventOptionsBuilder {

private final boolean isV2;
Expand Down Expand Up @@ -82,7 +84,7 @@ static <T, V> V capture(T t) {
return (V) t;
}

// @SuppressFBWarnings(value = "EI_EXPOSE_REP", justification = "Field is never mutated")
@SuppressFBWarnings("EI_EXPOSE_REP")
public IConstrainedMap<EventOptionID> build() {
if (!isV2) {
return null;
Expand Down
14 changes: 10 additions & 4 deletions src/main/java/io/cryostat/recordings/RecordingHelper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ public class RecordingHelper {
Pattern.compile("^template=([\\w]+)(?:,type=([\\w]+))?$");
public static final String DATASOURCE_FILENAME = "cryostat-analysis.jfr";

private final long httpTimeoutSeconds = 5; // TODO: configurable client timeout
private static final long httpTimeoutSeconds = 5; // TODO: configurable client timeout

@Inject Logger logger;
@Inject EntityManager entityManager;
Expand Down Expand Up @@ -608,10 +608,16 @@ private Tagging createMetadataTagging(Metadata metadata) {
Tag.builder()
.key(
base64Url.encodeAsString(
e.getKey().getBytes()))
e.getKey()
.getBytes(
StandardCharsets
.UTF_8)))
.value(
base64Url.encodeAsString(
e.getValue().getBytes()))
e.getValue()
.getBytes(
StandardCharsets
.UTF_8)))
.build())
.toList());
if (metadata.expiry() != null) {
Expand All @@ -623,7 +629,7 @@ private Tagging createMetadataTagging(Metadata metadata) {
metadata.expiry()
.atOffset(ZoneOffset.UTC)
.toString()
.getBytes()))
.getBytes(StandardCharsets.UTF_8)))
.build());
}
return Tagging.builder().tagSet(tags).build();
Expand Down
13 changes: 11 additions & 2 deletions src/main/java/io/cryostat/recordings/Recordings.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@

import com.arjuna.ats.jta.exceptions.NotImplementedException;
import com.fasterxml.jackson.databind.ObjectMapper;
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
import io.quarkus.runtime.StartupEvent;
import io.smallrye.common.annotation.Blocking;
import io.vertx.core.json.JsonObject;
Expand Down Expand Up @@ -849,10 +850,16 @@ private Tagging createMetadataTagging(Metadata metadata) {
Tag.builder()
.key(
base64Url.encodeAsString(
e.getKey().getBytes()))
e.getKey()
.getBytes(
StandardCharsets
.UTF_8)))
.value(
base64Url.encodeAsString(
e.getValue().getBytes()))
e.getValue()
.getBytes(
StandardCharsets
.UTF_8)))
.build())
.toList())
.build();
Expand Down Expand Up @@ -954,6 +961,7 @@ public record ArchivedRecording(
}
}

@SuppressFBWarnings("EI_EXPOSE_REP")
public record ArchivedRecordingDirectory(
String connectUrl, String jvmId, List<ArchivedRecording> recordings) {
public ArchivedRecordingDirectory {
Expand All @@ -965,6 +973,7 @@ public record ArchivedRecordingDirectory(
}
}

@SuppressFBWarnings("EI_EXPOSE_REP")
public record Metadata(Map<String, String> labels, Instant expiry) {
public Metadata {
Objects.requireNonNull(labels);
Expand Down
7 changes: 7 additions & 0 deletions src/main/java/io/cryostat/rules/Rule.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
import io.cryostat.ws.MessagingServer;
import io.cryostat.ws.Notification;

import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
import io.quarkus.hibernate.orm.panache.PanacheEntity;
import io.vertx.mutiny.core.eventbus.EventBus;
import jakarta.enterprise.context.ApplicationScoped;
Expand All @@ -41,6 +42,11 @@

@Entity
@EntityListeners(Rule.Listener.class)
@SuppressFBWarnings(
value = "URF_UNREAD_PUBLIC_OR_PROTECTED_FIELD",
justification =
"rule.description is not used directly anywhere, but it is serialized and may be"
+ " displayed by clients")
public class Rule extends PanacheEntity {
public static final String RULE_ADDRESS = "io.cryostat.rules.Rule";

Expand Down Expand Up @@ -121,6 +127,7 @@ private void notify(RuleEventCategory category, Rule rule) {
}
}

@SuppressFBWarnings("EI_EXPOSE_REP")
public record RuleEvent(RuleEventCategory category, Rule rule) {
public RuleEvent {
Objects.requireNonNull(category);
Expand Down
2 changes: 2 additions & 0 deletions src/main/java/io/cryostat/rules/RuleService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@
import io.cryostat.targets.Target;
import io.cryostat.targets.TargetConnectionManager;

import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
import io.quarkus.runtime.StartupEvent;
import io.quarkus.vertx.ConsumeEvent;
import io.smallrye.common.annotation.Blocking;
Expand Down Expand Up @@ -281,6 +282,7 @@ private void cancelTasksForRule(Rule rule) {
}
}

@SuppressFBWarnings(value = {"EI_EXPOSE_REP", "EI_EXPOSE_REP2"})
public record RuleRecording(Rule rule, ActiveRecording recording) {
public RuleRecording {
Objects.requireNonNull(rule);
Expand Down
3 changes: 3 additions & 0 deletions src/main/java/io/cryostat/targets/Target.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@
import io.cryostat.ws.Notification;

import com.fasterxml.jackson.annotation.JsonIgnore;
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
import io.quarkus.hibernate.orm.panache.PanacheEntity;
import io.quarkus.vertx.ConsumeEvent;
import io.smallrye.common.annotation.Blocking;
Expand Down Expand Up @@ -125,6 +126,7 @@ public ActiveRecording getRecordingById(long remoteId) {
.orElse(null);
}

@SuppressFBWarnings("EI_EXPOSE_REP")
public static record Annotations(Map<String, String> platform, Map<String, String> cryostat) {
public Annotations {
if (platform == null) {
Expand Down Expand Up @@ -171,6 +173,7 @@ public enum EventKind {
;
}

@SuppressFBWarnings(value = {"EI_EXPOSE_REP", "EI_EXPOSE_REP2"})
public record TargetDiscovery(EventKind kind, Target serviceRef) {
public TargetDiscovery {
Objects.requireNonNull(kind);
Expand Down
Loading