com.hedera.node.app.service.schedule.impl.schemas.V0570ScheduleSchema Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of app-service-schedule-impl Show documentation
Default Hedera Schedule Service Implementation
The newest version!
/*
 * Copyright (C) 2024 Hedera Hashgraph, LLC
 *
 * 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.hedera.node.app.service.schedule.impl.schemas;

import static com.hedera.node.app.service.schedule.impl.schemas.V0490ScheduleSchema.SCHEDULES_BY_EQUALITY_KEY;
import static com.hedera.node.app.service.schedule.impl.schemas.V0490ScheduleSchema.SCHEDULES_BY_EXPIRY_SEC_KEY;
import static java.util.Objects.requireNonNull;
import static java.util.Spliterator.DISTINCT;
import static java.util.Spliterators.spliterator;

import com.hedera.hapi.node.base.ScheduleID;
import com.hedera.hapi.node.base.SemanticVersion;
import com.hedera.hapi.node.base.TimestampSeconds;
import com.hedera.hapi.node.state.primitives.ProtoBytes;
import com.hedera.hapi.node.state.primitives.ProtoLong;
import com.hedera.hapi.node.state.schedule.ScheduleList;
import com.hedera.hapi.node.state.schedule.ScheduledCounts;
import com.hedera.hapi.node.state.schedule.ScheduledOrder;
import com.hedera.hapi.node.state.throttles.ThrottleUsageSnapshots;
import com.swirlds.state.lifecycle.MigrationContext;
import com.swirlds.state.lifecycle.Schema;
import com.swirlds.state.lifecycle.StateDefinition;
import com.swirlds.state.spi.ReadableKVState;
import com.swirlds.state.spi.WritableKVState;
import edu.umd.cs.findbugs.annotations.NonNull;
import java.util.Set;
import java.util.concurrent.atomic.AtomicInteger;
import java.util.stream.StreamSupport;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;

/**
 * General schema for the schedule service.
 */
public final class V0570ScheduleSchema extends Schema {
    private static final Logger log = LogManager.getLogger(V0570ScheduleSchema.class);

    private static final long MAX_SCHEDULED_COUNTS = 50_000_000L;
    private static final long MAX_SCHEDULED_ORDERS = 50_000_000L;
    private static final long MAX_SCHEDULED_USAGES = 50_000_000L;
    private static final long MAX_SCHEDULE_ID_BY_EQUALITY = 50_000_000L;
    private static final SemanticVersion VERSION =
            SemanticVersion.newBuilder().major(0).minor(57).patch(0).build();
    /**
     * The state key of a map from consensus second to the counts of transactions scheduled
     * and processed within that second.
     */
    public static final String SCHEDULED_COUNTS_KEY = "SCHEDULED_COUNTS";
    /**
     * The state key of a map from an order position within a consensus second to the id of
     * the transaction scheduled to executed in that order within that second.
     */
    public static final String SCHEDULED_ORDERS_KEY = "SCHEDULED_ORDERS";
    /**
     * The state key of a map from consensus second to the throttle utilization of transactions
     * scheduled so far in that second.
     */
    public static final String SCHEDULED_USAGES_KEY = "SCHEDULED_USAGES";
    /**
     * The state key of a map from a hash of the schedule's equality values to its schedule id.
     */
    public static final String SCHEDULE_ID_BY_EQUALITY_KEY = "SCHEDULE_ID_BY_EQUALITY";

    /**
     * Instantiates a new V0570 (version 0.57.0) schedule schema.
     */
    public V0570ScheduleSchema() {
        super(VERSION);
    }

    @SuppressWarnings("rawtypes")
    @Override
    public @NonNull Set statesToCreate() {
        return Set.of(scheduleIdByEquality(), scheduledOrders(), scheduledCounts(), scheduledUsages());
    }

    @Override
    public @NonNull Set statesToRemove() {
        return Set.of(SCHEDULES_BY_EXPIRY_SEC_KEY, SCHEDULES_BY_EQUALITY_KEY);
    }

    @Override
    public void migrate(@NonNull final MigrationContext ctx) {
        requireNonNull(ctx);

        final ReadableKVState schedulesByExpiry =
                ctx.previousStates().get(SCHEDULES_BY_EXPIRY_SEC_KEY);
        final WritableKVState scheduledCounts =
                ctx.newStates().get(SCHEDULED_COUNTS_KEY);
        final WritableKVState scheduledOrders =
                ctx.newStates().get(SCHEDULED_ORDERS_KEY);

        final var secondsMigrated = new AtomicInteger();
        final var schedulesMigrated = new AtomicInteger();
        StreamSupport.stream(spliterator(schedulesByExpiry.keys(), schedulesByExpiry.size(), DISTINCT), false)
                .forEach(second -> {
                    final var scheduleList = schedulesByExpiry.get(second);
                    if (scheduleList != null) {
                        secondsMigrated.incrementAndGet();
                        final var schedules = scheduleList.schedules();
                        final var n = schedules.size();
                        scheduledCounts.put(new TimestampSeconds(second.value()), new ScheduledCounts(n, 0));
                        for (int i = 0; i < n; i++) {
                            scheduledOrders.put(
                                    new ScheduledOrder(second.value(), i),
                                    schedules.get(i).scheduleIdOrThrow());
                        }
                        schedulesMigrated.addAndGet(n);
                    }
                });
        log.info("Migrated {} schedules from {} seconds", schedulesMigrated.get(), secondsMigrated.get());

        final WritableKVState writableScheduleByEquality =
                ctx.newStates().get(SCHEDULE_ID_BY_EQUALITY_KEY);
        final ReadableKVState readableSchedulesByEquality =
                ctx.previousStates().get(SCHEDULES_BY_EQUALITY_KEY);
        StreamSupport.stream(
                        spliterator(readableSchedulesByEquality.keys(), readableSchedulesByEquality.size(), DISTINCT),
                        false)
                .forEach(key -> {
                    final var scheduleList = readableSchedulesByEquality.get(key);
                    if (scheduleList != null) {
                        final var schedulerId = requireNonNull(
                                scheduleList.schedules().getFirst().scheduleId());
                        final var newScheduleId = schedulerId.copyBuilder().build();
                        writableScheduleByEquality.put(key, newScheduleId);
                    }
                });
        log.info("Migrated {} schedules from SCHEDULES_BY_EQUALITY_KEY", readableSchedulesByEquality.size());
    }

    private static StateDefinition scheduledCounts() {
        return StateDefinition.onDisk(
                SCHEDULED_COUNTS_KEY, TimestampSeconds.PROTOBUF, ScheduledCounts.PROTOBUF, MAX_SCHEDULED_COUNTS);
    }

    private static StateDefinition scheduledOrders() {
        return StateDefinition.onDisk(
                SCHEDULED_ORDERS_KEY, ScheduledOrder.PROTOBUF, ScheduleID.PROTOBUF, MAX_SCHEDULED_ORDERS);
    }

    private static StateDefinition scheduledUsages() {
        return StateDefinition.onDisk(
                SCHEDULED_USAGES_KEY, TimestampSeconds.PROTOBUF, ThrottleUsageSnapshots.PROTOBUF, MAX_SCHEDULED_USAGES);
    }

    private static StateDefinition scheduleIdByEquality() {
        return StateDefinition.onDisk(
                SCHEDULE_ID_BY_EQUALITY_KEY, ProtoBytes.PROTOBUF, ScheduleID.PROTOBUF, MAX_SCHEDULE_ID_BY_EQUALITY);
    }
}