com.palantir.baseline.errorprone.JooqResultStreamLeak 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 2019 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.errorprone.BugPattern;
import com.google.errorprone.VisitorState;
import com.google.errorprone.bugpatterns.BugChecker;
import com.google.errorprone.bugpatterns.StreamResourceLeak;
import com.google.errorprone.matchers.Description;
import com.google.errorprone.matchers.Matcher;
import com.google.errorprone.matchers.Matchers;
import com.google.errorprone.matchers.method.MethodMatchers;
import com.google.errorprone.suppliers.Supplier;
import com.google.errorprone.util.ASTHelpers;
import com.sun.source.tree.ExpressionTree;
import com.sun.source.tree.MethodTree;
import com.sun.tools.javac.code.Type;

@AutoService(BugChecker.class)
@BugPattern(
        link = "https://github.com/palantir/gradle-baseline#baseline-error-prone-checks",
        linkType = BugPattern.LinkType.CUSTOM,
        severity = BugPattern.SeverityLevel.WARNING,
        summary = "Methods that return an autocloseable resource on jOOQ's ResultQuery should be closed using"
                + " try-with-resources. Not doing so can result in leaked database resources (such as connections"
                + " or cursors) in code paths that throw an exception or fail to call #close().")
public final class JooqResultStreamLeak extends StreamResourceLeak {
    private static final Matcher MATCHER = Matchers.allOf(
            MethodMatchers.instanceMethod()
                    .onDescendantOf("org.jooq.ResultQuery")
                    .withAnyName(),
            JooqResultStreamLeak::shouldBeAutoClosed);

    private static final Supplier JOOQ_QUERY_PART =
            VisitorState.memoize(state -> state.getTypeFromString("org.jooq.QueryPart"));

    private static final Supplier AUTO_CLOSEABLE =
            VisitorState.memoize(state -> state.getTypeFromString(AutoCloseable.class.getName()));

    @Override
    public Description matchMethod(MethodTree tree, VisitorState state) {
        return scanEntireMethodFor(MATCHER, tree, state);
    }

    private static boolean shouldBeAutoClosed(ExpressionTree tree, VisitorState state) {
        Type returnType = ASTHelpers.getReturnType(tree);

        // Most auto-closeable returns should be auto-closed.
        boolean isAutoCloseable = ASTHelpers.isSubtype(returnType, AUTO_CLOSEABLE.get(state), state);

        // QueryParts can hold resources but usually don't, so auto-tripping and trying to fix on things
        // like SelectConditionStep is unnecessary.
        boolean isJooqQuery = ASTHelpers.isSubtype(returnType, JOOQ_QUERY_PART.get(state), state);

        return isAutoCloseable && !isJooqQuery;
    }
}