com.palantir.baseline.errorprone.PreferSafeLoggableExceptions Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of baseline-error-prone Show documentation
A Gradle plugin for applying Baseline-recommended build and IDE settings
There is a newer version: 6.11.0
/*
 * (c) Copyright 2018 Palantir Technologies Inc. All rights reserved.
 *
 * 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
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * 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 com.palantir.baseline.errorprone;

import com.google.auto.service.AutoService;
import com.google.common.collect.ImmutableMap;
import com.google.errorprone.BugPattern;
import com.google.errorprone.VisitorState;
import com.google.errorprone.bugpatterns.BugChecker;
import com.google.errorprone.fixes.SuggestedFix;
import com.google.errorprone.matchers.CompileTimeConstantExpressionMatcher;
import com.google.errorprone.matchers.Description;
import com.google.errorprone.matchers.Matcher;
import com.google.errorprone.matchers.Matchers;
import com.google.errorprone.suppliers.Supplier;
import com.google.errorprone.util.ASTHelpers;
import com.sun.source.tree.ExpressionTree;
import com.sun.source.tree.NewClassTree;
import com.sun.tools.javac.code.Type;
import java.io.IOException;
import java.util.List;
import java.util.Optional;
import java.util.stream.Collectors;

@AutoService(BugChecker.class)
@BugPattern(
        link = "https://github.com/palantir/gradle-baseline#baseline-error-prone-checks",
        linkType = BugPattern.LinkType.CUSTOM,
        severity = BugPattern.SeverityLevel.WARNING,
        summary = "Throw SafeLoggable exceptions to ensure the exception message will not be redacted")
@SuppressWarnings("PreferSafeLoggableExceptions")
public final class PreferSafeLoggableExceptions extends BugChecker implements BugChecker.NewClassTreeMatcher {

    private static final long serialVersionUID = 1L;

    // github.com/palantir/safe-logging/tree/develop/preconditions/src/main/java/com/palantir/logsafe/exceptions
    @SuppressWarnings("DangerousIdentityKey")
    private static final ImmutableMap, String> EXCEPTION_MAPPINGS = ImmutableMap.of(
            IllegalArgumentException.class, "SafeIllegalArgumentException",
            IllegalStateException.class, "SafeIllegalStateException",
            IOException.class, "SafeIoException",
            NullPointerException.class, "SafeNullPointerException",
            RuntimeException.class, "SafeRuntimeException");

    private static final Matcher FAST_EXCEPTION_TYPE_CHECK = Matchers.anyOf(
            EXCEPTION_MAPPINGS.keySet().stream().map(Matchers::isSameType).collect(Collectors.toList()));

    private final Matcher compileTimeConstExpressionMatcher =
            new CompileTimeConstantExpressionMatcher();

    private static final Supplier JAVA_STRING =
            VisitorState.memoize(state -> state.getTypeFromString("java.lang.String"));

    @Override
    public Description matchNewClass(NewClassTree tree, VisitorState state) {
        // This is invoked for all new class creations, so we execute a fast check first to
        // rule out irrelevant code before doing more involved work.
        if (!FAST_EXCEPTION_TYPE_CHECK.matches(tree.getIdentifier(), state)) {
            return Description.NO_MATCH;
        }
        List args = tree.getArguments();
        Optional messageArg = args.stream()
                .filter(arg -> ASTHelpers.isSameType(ASTHelpers.getType(arg), JAVA_STRING.get(state), state))
                .reduce((one, two) -> one);

        if (!messageArg.isPresent()) {
            return Description.NO_MATCH;
        }

        if (!compileTimeConstExpressionMatcher.matches(messageArg.get(), state)) {
            // ignore exceptions with non-constant messages to minimise the hits
            return Description.NO_MATCH;
        }

        if (TestCheckUtils.isTestCode(state)) {
            // devs don't have to use log-collection infrastructure in tests, so this would be purely annoying
            return Description.NO_MATCH;
        }

        return EXCEPTION_MAPPINGS.entrySet().stream()
                .filter(entry -> Matchers.isSameType(entry.getKey()).matches(tree.getIdentifier(), state))
                .map(entry -> buildDescription(tree)
                        .setMessage("Prefer " + entry.getValue() + " from com.palantir.safe-logging:preconditions")
                        .addFix(SuggestedFix.builder()
                                .replace(tree.getIdentifier(), entry.getValue())
                                .addImport("com.palantir.logsafe.exceptions." + entry.getValue())
                                .build())
                        .build())
                .findAny()
                .orElseThrow(() -> new IllegalStateException("Expected to match a known replaceable exception type"));
    }
}