com.google.gerrit.server.notedb.rebuild.OnlineNoteDbMigrator Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of gerrit-plugin-api Show documentation
API for Gerrit Plugins
There is a newer version: 3.10.0-rc4
// Copyright (C) 2017 The Android Open Source Project
//
// 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.google.gerrit.server.notedb.rebuild;

import com.google.common.base.Stopwatch;
import com.google.common.flogger.FluentLogger;
import com.google.gerrit.extensions.events.LifecycleListener;
import com.google.gerrit.lifecycle.LifecycleModule;
import com.google.gerrit.server.config.GerritServerConfig;
import com.google.gerrit.server.index.OnlineUpgrader;
import com.google.gerrit.server.index.VersionManager;
import com.google.inject.Inject;
import com.google.inject.Provider;
import com.google.inject.Singleton;
import com.google.inject.name.Named;
import com.google.inject.name.Names;
import java.util.concurrent.TimeUnit;
import org.eclipse.jgit.lib.Config;

@Singleton
public class OnlineNoteDbMigrator implements LifecycleListener {
  private static final FluentLogger logger = FluentLogger.forEnclosingClass();

  private static final String TRIAL = "OnlineNoteDbMigrator/trial";

  public static class Module extends LifecycleModule {
    private final boolean trial;

    public Module(boolean trial) {
      this.trial = trial;
    }

    @Override
    public void configure() {
      listener().to(OnlineNoteDbMigrator.class);
      bindConstant().annotatedWith(Names.named(TRIAL)).to(trial);
    }
  }

  private final GcAllUsers gcAllUsers;
  private final OnlineUpgrader indexUpgrader;
  private final Provider migratorBuilderProvider;
  private final boolean upgradeIndex;
  private final boolean trial;

  @Inject
  OnlineNoteDbMigrator(
      @GerritServerConfig Config cfg,
      GcAllUsers gcAllUsers,
      OnlineUpgrader indexUpgrader,
      Provider migratorBuilderProvider,
      @Named(TRIAL) boolean trial) {
    this.gcAllUsers = gcAllUsers;
    this.indexUpgrader = indexUpgrader;
    this.migratorBuilderProvider = migratorBuilderProvider;
    this.upgradeIndex = VersionManager.getOnlineUpgrade(cfg);
    this.trial = trial || NoteDbMigrator.getTrialMode(cfg);
  }

  @Override
  public void start() {
    Thread t = new Thread(this::migrate);
    t.setDaemon(true);
    t.setName(getClass().getSimpleName());
    t.start();
  }

  private void migrate() {
    logger.atInfo().log("Starting online NoteDb migration");
    if (upgradeIndex) {
      logger.atInfo().log(
          "Online index schema upgrades will be deferred until NoteDb migration is complete");
    }
    Stopwatch sw = Stopwatch.createStarted();
    // TODO(dborowitz): Tune threads, maybe expose a progress monitor somewhere.
    try (NoteDbMigrator migrator =
        migratorBuilderProvider.get().setAutoMigrate(true).setTrialMode(trial).build()) {
      migrator.migrate();
    } catch (Exception e) {
      logger.atSevere().withCause(e).log("Error in online NoteDb migration");
    }
    gcAllUsers.runWithLogger();
    logger.atInfo().log("Online NoteDb migration completed in %ss", sw.elapsed(TimeUnit.SECONDS));

    if (upgradeIndex) {
      logger.atInfo().log("Starting deferred index schema upgrades");
      indexUpgrader.start();
    }
  }

  @Override
  public void stop() {
    // Do nothing; upgrade process uses daemon threads and knows how to recover from failures on
    // next attempt.
  }
}