org.quickperf.sql.SqlExecutions Maven / Gradle / Ivy

Go to download
/*
 * 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.
 *
 * Copyright 2019-2021 the original author or authors.
 */

package org.quickperf.sql;

import net.ttddyy.dsproxy.ExecutionInfo;
import net.ttddyy.dsproxy.QueryInfo;
import net.ttddyy.dsproxy.QueryType;
import org.quickperf.SystemProperties;
import org.quickperf.issue.PerfIssue;
import org.quickperf.issue.PerfIssuesFormat;
import org.quickperf.perfrecording.ViewablePerfRecordIfPerfIssue;
import org.quickperf.sql.framework.quickperf.DataSourceConfig;
import org.quickperf.sql.update.columns.NumberOfUpdatedColumnsStatistics;

import java.io.Serializable;
import java.util.*;

public class SqlExecutions implements Iterable, ViewablePerfRecordIfPerfIssue, Serializable {

    public static final SqlExecutions NONE = new SqlExecutions();

    private final Deque sqlExecutions = new ArrayDeque<>();

    public void add(ExecutionInfo execInfo, List queries) {
        SqlExecution sqlExecution = new SqlExecution(execInfo, queries);
        sqlExecutions.addLast(sqlExecution);
    }

    // Workaround: avoid duplicate call to retrieveNumberOfReturnedColumns within SqlExecution constructor
    // in add method by forcing the column count. Related commit https://github.com/quick-perf/quickperf/issues/141
    private void addWithoutCall(ExecutionInfo executionInfo, List queries){
        SqlExecution sqlExecution = new SqlExecution(executionInfo, queries, 0);
        sqlExecutions.addLast(sqlExecution);
    }

    public SqlExecutions filterByQueryType(QueryType queryType) {
        SqlExecutions filteredSqlExecutions = new SqlExecutions();

        for (SqlExecution execution : this.sqlExecutions) {
            List queries = new ArrayList<>();
            boolean added = false;

            for (QueryInfo query : execution.getQueries()) {
                if (queryType.equals(QueryTypeRetriever.INSTANCE.typeOf(query))) {
                    added = true;
                    queries.add(query);
                }
            }

            if(added){
                filteredSqlExecutions.addWithoutCall(execution.getExecutionInfo(), queries);
            }
        }
        return filteredSqlExecutions;
    }

    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder();
        for (SqlExecution sqlExecution : sqlExecutions) {
            sb.append("\t").append(sqlExecution.toString());
            sb.append(System.lineSeparator());
            sb.append(System.lineSeparator());
        }
        return sb.toString();
    }

    public boolean isEmpty() {
        return this == NONE || sqlExecutions.isEmpty();
    }

    public int retrieveQueryNumberOfType(QueryType queryType) {
        int queryNumber = 0;
        QueryTypeRetriever queryTypeRetriever = QueryTypeRetriever.INSTANCE;
        for (SqlExecution sqlExecution : sqlExecutions) {
            for (QueryInfo query : sqlExecution.getQueries()) {
                if (queryType.equals(queryTypeRetriever.typeOf(query))) {
                    queryNumber++;
                }
            }
        }
        return queryNumber;
    }

    public NumberOfUpdatedColumnsStatistics getUpdatedColumnsStatistics() {

        long minColumnCount = 0;
        long maxColumnCount = 0;

        for (SqlExecution sqlExecution : sqlExecutions) {
            for (QueryInfo query : sqlExecution.getQueries()) {
                QueryTypeRetriever queryTypeRetriever = QueryTypeRetriever.INSTANCE;
                if (queryTypeRetriever.typeOf(query) == QueryType.UPDATE) {
                    long updatedColumnCount = countUpdatedColumn(query.getQuery());
                    if(minColumnCount == 0 || updatedColumnCount < minColumnCount) {
                        minColumnCount = updatedColumnCount;
                    }
                    if (updatedColumnCount > maxColumnCount) {
                        maxColumnCount = updatedColumnCount;
                    }
                }
            }
        }

        return new NumberOfUpdatedColumnsStatistics(minColumnCount, maxColumnCount);

    }

    private long countUpdatedColumn(String sql) {
        // UPDATE book SET isbn = ?, title = ? WHERE id = ?
        int setIndex = sql.toLowerCase().indexOf("set");
        int whereIndex = sql.toLowerCase().indexOf("where");
        whereIndex = whereIndex > -1 ? whereIndex : sql.length();

        String sqlSetClause = sql.substring(setIndex, whereIndex);
        return countUnquotedEquals(sqlSetClause);
    }

    /**
     * Examples :
     *  - "SET isbn = ?, title = ? " returns 2
     *  - "SET isbn = '123', title = '1 + 1 = 0' " returns 2
     */
    private long countUnquotedEquals(String setClause) {
        boolean inQuote = false;
        long equalCounter = 0;
        for (char c : setClause.toCharArray()) {
            if (c == '\'') {
               inQuote = !inQuote;
            }
            if (!inQuote && c == '=') {
                equalCounter++;
            }
        }
        return equalCounter;
    }

    public long getMaxNumberOfSelectedColumns() {
        long maxNumberOfColumnsForAllExecs = 0;
        for (SqlExecution sqlExecution : sqlExecutions) {
            long columnCount = sqlExecution.getColumnCount();
            if (columnCount > maxNumberOfColumnsForAllExecs) {
                maxNumberOfColumnsForAllExecs = columnCount;
            }
        }
        return maxNumberOfColumnsForAllExecs;
    }

    @Override
    public String format(Collection perfIssues) {
        String standardFormatting = PerfIssuesFormat.STANDARD.format(perfIssues);

        if(SystemProperties.SIMPLIFIED_SQL_DISPLAY.evaluate()) {
            return standardFormatting;
        }

        return    standardFormatting
                + System.lineSeparator()
                + System.lineSeparator()
                + "[JDBC QUERY EXECUTION (executeQuery, executeBatch, ...)]"
                + System.lineSeparator()
                + (noJdbcExecution() ? new DataSourceConfig().getMessage()
                                     : toString());
    }

    private boolean noJdbcExecution() {
        return sqlExecutions.size() == 0;
    }

    @Override
    public Iterator iterator() {
        return sqlExecutions.iterator();
    }

    public int getNumberOfExecutions() {
        return sqlExecutions.size();
    }

}