All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.jooq.impl.DiagnosticsConnection Maven / Gradle / Ivy

There is a newer version: 3.19.15
Show newest version
/*
 * 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
 *
 *  https://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.
 *
 * Other licenses:
 * -----------------------------------------------------------------------------
 * Commercial licenses for this work are available. These replace the above
 * ASL 2.0 and offer limited warranties, support, maintenance, and commercial
 * database integrations.
 *
 * For more information, please visit: https://www.jooq.org/legal/licensing
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 */
package org.jooq.impl;

import static java.util.Arrays.asList;
import static java.util.Collections.synchronizedMap;
// ...
// ...
// ...
import static org.jooq.conf.DiagnosticsConnection.OFF;
import static org.jooq.conf.ParamType.FORCE_INDEXED;
import static org.jooq.impl.DSL.count;
import static org.jooq.impl.DSL.noCondition;
import static org.jooq.impl.QOM.commutativeCheck;

import java.sql.CallableStatement;
import java.sql.Connection;
import java.sql.PreparedStatement;
import java.sql.SQLException;
import java.sql.Statement;
import java.util.ArrayList;
import java.util.HashSet;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Set;
import java.util.function.Predicate;

import org.jooq.AggregateFunction;
import org.jooq.Condition;
import org.jooq.Configuration;
import org.jooq.Field;
import org.jooq.Parser;
// ...
import org.jooq.Queries;
import org.jooq.Query;
import org.jooq.QueryPart;
import org.jooq.RenderContext;
// ...
import org.jooq.Select;
import org.jooq.conf.Settings;
import org.jooq.impl.QOM.CompareCondition;
import org.jooq.impl.QOM.Concat;
import org.jooq.impl.QOM.Eq;
import org.jooq.impl.QOM.In;
import org.jooq.impl.QOM.InList;
import org.jooq.impl.QOM.IsDistinctFrom;
import org.jooq.impl.QOM.Mod;
import org.jooq.impl.QOM.NotInList;
import org.jooq.impl.QOM.UCommutativeOperator;
import org.jooq.tools.jdbc.DefaultConnection;

/**
 * @author Lukas Eder
 */
final class DiagnosticsConnection extends DefaultConnection {

    // TODO: Make these configurable
    static final int                LRU_SIZE_GLOBAL = 50000;
    static final int                LRU_SIZE_LOCAL  = 500;
    static final int                DUP_SIZE        = 500;

    final Map> repeatedSQL     = new LRU<>(LRU_SIZE_LOCAL);
    final Map> consecutiveAgg  = new LRU<>(LRU_SIZE_LOCAL);
    final Configuration             configuration;
    final Configuration             configurationTranformPatterns;
    final RenderContext             normalisingRenderer;
    final Parser                    parser;
    final DiagnosticsListeners      listeners;
    final boolean                   release;

    DiagnosticsConnection(Configuration configuration) {
        this(configuration, null);
    }

    DiagnosticsConnection(Configuration configuration, Connection c) {
        super(c != null ? c : configuration.connectionProvider().acquire());

        this.release = c == null;

        // [#7527] The Settings.diagnosticsPattern flag overrides the Settings.transformPatterns flag.
        this.configuration = configuration;
        this.configurationTranformPatterns = configuration.deriveSettings(s -> s.withTransformPatterns(true));
        this.normalisingRenderer = configuration.deriveSettings(s -> s

            // Forcing all inline parameters to be indexed helps find opportunities to use bind variables
            .withParamType(FORCE_INDEXED)

            // Padding IN lists shows duplicates that arise from arbitrary-length dynamic IN lists
            .withInListPadding(true)
            .withInListPadBase(16)
        ).dsl().renderContext();
        this.parser = configuration.dsl().parser();
        this.listeners = DiagnosticsListeners.get(configuration);
    }

    @Override
    public final Statement createStatement() throws SQLException {
        return new DiagnosticsStatement(this, getDelegate().createStatement());
    }

    @Override
    public final Statement createStatement(int resultSetType, int resultSetConcurrency) throws SQLException {
        return new DiagnosticsStatement(this, getDelegate().createStatement(resultSetType, resultSetConcurrency));
    }

    @Override
    public final Statement createStatement(int resultSetType, int resultSetConcurrency, int resultSetHoldability) throws SQLException {
        return new DiagnosticsStatement(this, getDelegate().createStatement(resultSetType, resultSetConcurrency, resultSetHoldability));
    }

    @Override
    public final PreparedStatement prepareStatement(String sql) throws SQLException {
        return new DiagnosticsStatement(this, getDelegate().prepareStatement(parse(sql)), sql);
    }

    @Override
    public final PreparedStatement prepareStatement(String sql, int resultSetType, int resultSetConcurrency) throws SQLException {
        return new DiagnosticsStatement(this, getDelegate().prepareStatement(parse(sql), resultSetType, resultSetConcurrency), sql);
    }

    @Override
    public final PreparedStatement prepareStatement(String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability) throws SQLException {
        return new DiagnosticsStatement(this, getDelegate().prepareStatement(parse(sql), resultSetType, resultSetConcurrency, resultSetHoldability), sql);
    }

    @Override
    public final PreparedStatement prepareStatement(String sql, int autoGeneratedKeys) throws SQLException {
        return new DiagnosticsStatement(this, getDelegate().prepareStatement(parse(sql), autoGeneratedKeys), sql);
    }

    @Override
    public final PreparedStatement prepareStatement(String sql, int[] columnIndexes) throws SQLException {
        return new DiagnosticsStatement(this, getDelegate().prepareStatement(parse(sql), columnIndexes), sql);
    }

    @Override
    public final PreparedStatement prepareStatement(String sql, String[] columnNames) throws SQLException {
        return new DiagnosticsStatement(this, getDelegate().prepareStatement(parse(sql), columnNames), sql);
    }

    @Override
    public final CallableStatement prepareCall(String sql) throws SQLException {
        return new DiagnosticsStatement(this, getDelegate().prepareCall(parse(sql)), sql);
    }

    @Override
    public final CallableStatement prepareCall(String sql, int resultSetType, int resultSetConcurrency) throws SQLException {
        return new DiagnosticsStatement(this, getDelegate().prepareCall(parse(sql), resultSetType, resultSetConcurrency), sql);
    }

    @Override
    public final CallableStatement prepareCall(String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability) throws SQLException {
        return new DiagnosticsStatement(this, getDelegate().prepareCall(parse(sql), resultSetType, resultSetConcurrency, resultSetHoldability), sql);
    }

    @Override
    public final void close() throws SQLException {
        repeatedSQL.clear();

        if (release)
            configuration.connectionProvider().release(getDelegate());
    }

    final boolean checkPattern(Predicate test) {
        return DiagnosticsListeners.checkPattern(configuration.settings(), test);
    }

    final boolean check(Predicate test) {
        return DiagnosticsListeners.check(configuration.settings(), test);
    }

    @SuppressWarnings("unchecked")
    final Map> duplicateSql() {
        return (Map>) configuration.data().computeIfAbsent(
            "org.jooq.diagnostics.duplicate-sql",
            k -> synchronizedMap(new LRU<>(LRU_SIZE_GLOBAL))
        );
    }

    final boolean disabled() {
        return configuration.settings().getDiagnosticsConnection() == OFF;
    }

    final String parse(String sql) {

        // [#7398] Don't do anything if the feature is turned OFF
        if (disabled())
            return sql;

        Queries queries = null;
        Queries transformed = null;
        String normalised;

        try {

            // [#14137] TODO: Avoid unnecessary work, depending on the Settings
            transformed = queries = parser.parse(sql);




            normalised = normalisingRenderer.render(transformed);
        }
        catch (ParserException exception) {
            normalised = sql;
            listeners.exception(new DefaultDiagnosticsContext(
                configuration,
                "Query could not be parsed.", sql, exception
            ));
        }

        try {
            if (check(Settings::isDiagnosticsDuplicateStatements)) {
                Set duplicates = duplicates(duplicateSql(), sql, normalised);

                if (duplicates != null)
                    listeners.duplicateStatements(new DefaultDiagnosticsContext(
                        configuration,
                        "Duplicate statements encountered.",
                        sql, normalised, duplicates, null, queries, transformed, null
                    ));
            }

            if (check(Settings::isDiagnosticsRepeatedStatements)) {
                List repetitions = repetitions(repeatedSQL, sql, normalised);
                if (repetitions != null)
                    listeners.repeatedStatements(new DefaultDiagnosticsContext(
                        configuration,
                        "Repeated statements encountered.",
                        sql, normalised, null, repetitions, queries, transformed, null
                    ));
            }

            if (queries != null) {








































































            }
        }
        catch (Error e) {
            throw e;
        }
        catch (Throwable exception) {
            listeners.exception(new DefaultDiagnosticsContext(
                configuration,
                "An unexpected exception has occurred. See exception for details.",
                sql, normalised, null, null, queries, transformed, exception
            ));
        }

        return sql;
    }


























































    private final Set duplicates(Map> map, String sql, String normalised) {
        synchronized (map) {
            Set v = map.computeIfAbsent(normalised, k -> new HashSet<>());

            if (v.size() >= DUP_SIZE || (v.add(sql) && v.size() > 1))
                return v;
            else
                return null;
        }
    }

    private final List repetitions(Map> map, String sql, String normalised) {
        List v = map.computeIfAbsent(normalised, k -> new ArrayList<>());

        if (v.size() >= DUP_SIZE || (v.add(sql) && v.size() > 1))
            return v;
        else
            return null;
    }

    // See https://stackoverflow.com/a/1953516/521799
    static final class LRU extends LinkedHashMap {
        private final int size;

        LRU(int size) {
            super(size + 1, 1.0f, true);
            this.size = size;
        }

        @Override
        protected boolean removeEldestEntry(Entry eldest) {
            return size() > size;
        }
    }
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy