org.graylog2.migrations.V20230113095301_MigrateGlobalPivotLimitsToGroupingsInSearches Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of graylog2-server Show documentation
Graylog
There is a newer version: 6.1.4
/*
 * Copyright (C) 2020 Graylog, Inc.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the Server Side Public License, version 1,
 * as published by MongoDB, Inc.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * Server Side Public License for more details.
 *
 * You should have received a copy of the Server Side Public License
 * along with this program. If not, see
 * .
 */
package org.graylog2.migrations;

import com.fasterxml.jackson.annotation.JsonProperty;
import com.google.common.collect.ImmutableList;
import com.mongodb.client.MongoCollection;
import com.mongodb.client.model.UpdateOneModel;
import com.mongodb.client.model.UpdateOptions;
import com.mongodb.client.model.WriteModel;
import one.util.streamex.EntryStream;
import org.bson.Document;
import org.bson.conversions.Bson;
import org.bson.types.ObjectId;
import org.graylog2.database.MongoConnection;
import org.graylog2.plugin.cluster.ClusterConfigService;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import javax.inject.Inject;
import java.time.ZonedDateTime;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import java.util.stream.StreamSupport;

public class V20230113095301_MigrateGlobalPivotLimitsToGroupingsInSearches extends Migration {
    private static final int DEFAULT_LIMIT = 15;
    private static final Logger LOG = LoggerFactory.getLogger(V20230113095300_MigrateGlobalPivotLimitsToGroupingsInViews.class);
    private final ClusterConfigService clusterConfigService;
    private final MongoCollection searches;
    private final Document matchValuePivots = doc("pivot.type", "values");

    @Inject
    public V20230113095301_MigrateGlobalPivotLimitsToGroupingsInSearches(MongoConnection mongoConnection, ClusterConfigService clusterConfigService) {
        this.clusterConfigService = clusterConfigService;
        this.searches = mongoConnection.getMongoDatabase().getCollection("searches");
    }

    @Override
    public ZonedDateTime createdAt() {
        return ZonedDateTime.parse("2023-01-13T09:53:01Z");
    }

    @Override
    public void upgrade() {
        if (clusterConfigService.get(MigrationCompleted.class) != null) {
            LOG.debug("Migration already completed!");
            return;
        }

        final List pivotLimitMigrations = StreamSupport.stream(this.searches.find().spliterator(), false)
            .flatMap(document -> {
                final String searchId = document.get("_id", ObjectId.class).toHexString();
                final List queries = document.get("queries", Collections.emptyList());
                return EntryStream.of(queries)
                    .flatMap(entry -> {
                        final Integer queryIndex = entry.getKey();
                        final List searchTypes = entry.getValue().get("search_types", Collections.emptyList());
                        return EntryStream.of(searchTypes)
                            .filter(searchType -> "pivot".equals(searchType.getValue().getString("type")))
                            .flatMap(searchTypeEntry -> {
                                final Document searchType = searchTypeEntry.getValue();
                                final Integer searchTypeIndex = searchTypeEntry.getKey();
                                final boolean hasRowLimit = searchType.containsKey("row_limit");
                                final boolean hasColumnLimit = searchType.containsKey("column_limit");
                                final Optional rowLimit = Optional.ofNullable(searchType.getInteger("row_limit"));
                                final Optional columnLimit = Optional.ofNullable(searchType.getInteger("column_limit"));

                                if (searchTypeIndex != null && (hasRowLimit || hasColumnLimit)) {
                                    return Stream.of(new SearchPivotLimitMigration(searchId, queryIndex, searchTypeIndex, rowLimit, columnLimit));
                                }
                                return Stream.empty();
                            });
                    });
            })
            .collect(Collectors.toList());

        final List> operations = pivotLimitMigrations.stream()
                .flatMap(pivotMigration -> {
                    final ImmutableList.Builder> builder = ImmutableList.builder();
                    builder.add(
                        updateSearch(
                            pivotMigration.searchId(),
                            doc("$unset", doc(pivotPath(pivotMigration) + ".row_limit", 1))
                        )
                    );
                    builder.add(
                        updateSearch(
                            pivotMigration.searchId(),
                            doc("$set", doc(pivotPath(pivotMigration) + ".row_groups.$[pivot].limit", pivotMigration.rowLimit.orElse(DEFAULT_LIMIT))),
                            matchValuePivots
                        )
                    );
                    builder.add(
                            updateSearch(
                                    pivotMigration.searchId(),
                                    doc("$unset", doc(pivotPath(pivotMigration) + ".column_limit", 1))
                            )
                    );
                    builder.add(
                        updateSearch(
                            pivotMigration.searchId(),
                            doc("$set", doc(pivotPath(pivotMigration) + ".column_groups.$[pivot].limit", pivotMigration.columnLimit.orElse(DEFAULT_LIMIT))),
                            matchValuePivots
                        )
                    );
                    return builder.build().stream();
                })
                .collect(Collectors.toList());

        if (!operations.isEmpty()) {
            LOG.debug("Updating {} search types ...", pivotLimitMigrations.size());
            this.searches.bulkWrite(operations);
        }

        clusterConfigService.write(new MigrationCompleted(pivotLimitMigrations.size()));
    }

    private String pivotPath(SearchPivotLimitMigration pivotMigration) {
        return "queries." + pivotMigration.queryIndex() + ".search_types." + pivotMigration.searchTypeIndex();
    }

    private WriteModel updateSearch(String searchId, Document update, List arrayFilters) {
        return new UpdateOneModel<>(
                doc("_id", new ObjectId(searchId)),
                update,
                new UpdateOptions().upsert(false).arrayFilters(arrayFilters)
        );
    }

    private WriteModel updateSearch(String searchId, Document update, Bson arrayFilter) {
        return updateSearch(searchId, update, Collections.singletonList(arrayFilter));
    }

    private WriteModel updateSearch(String searchId, Document update) {
        return updateSearch(searchId, update, (List) null);
    }

    private Document doc(String key, Object value) {
        return new Document(key, value);
    }

    public record SearchPivotLimitMigration(String searchId, Integer queryIndex, Integer searchTypeIndex, Optional rowLimit, Optional columnLimit) {}

    public record MigrationCompleted(@JsonProperty("migrated_search_types") Integer migratedSearchTypes) {}
}