Skip to content

Breaks Fate into Fate and FateClient #6142

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
keith-turner merged 1 commit into from
Feb 24, 2026
Merged

Breaks Fate into Fate and FateClient #6142

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
146 changes: 3 additions & 143 deletions core/src/main/java/org/apache/accumulo/core/fate/Fate.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,6 @@
package org.apache.accumulo.core.fate;

import static java.util.concurrent.TimeUnit.SECONDS;
import static org.apache.accumulo.core.fate.ReadOnlyFateStore.TStatus.FAILED;
import static org.apache.accumulo.core.fate.ReadOnlyFateStore.TStatus.FAILED_IN_PROGRESS;
import static org.apache.accumulo.core.fate.ReadOnlyFateStore.TStatus.NEW;
import static org.apache.accumulo.core.fate.ReadOnlyFateStore.TStatus.SUBMITTED;
import static org.apache.accumulo.core.fate.ReadOnlyFateStore.TStatus.SUCCESSFUL;
import static org.apache.accumulo.core.fate.ReadOnlyFateStore.TStatus.UNKNOWN;
import static org.apache.accumulo.core.util.threads.ThreadPoolNames.META_DEAD_RESERVATION_CLEANER_POOL;
import static org.apache.accumulo.core.util.threads.ThreadPoolNames.USER_DEAD_RESERVATION_CLEANER_POOL;

Expand All @@ -36,7 +30,6 @@
import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;
import java.util.Optional;
import java.util.Set;
import java.util.TreeSet;
import java.util.concurrent.ExecutorService;
Expand All @@ -48,18 +41,12 @@
import java.util.concurrent.atomic.AtomicInteger;
import java.util.function.Function;
import java.util.stream.Collectors;
import java.util.stream.Stream;

import org.apache.accumulo.core.conf.AccumuloConfiguration;
import org.apache.accumulo.core.conf.Property;
import org.apache.accumulo.core.fate.FateStore.FateTxStore;
import org.apache.accumulo.core.fate.FateStore.Seeder;
import org.apache.accumulo.core.fate.ReadOnlyFateStore.TStatus;
import org.apache.accumulo.core.logging.FateLogger;
import org.apache.accumulo.core.manager.thrift.TFateOperation;
import org.apache.accumulo.core.util.UtilWaitThread;
import org.apache.accumulo.core.util.threads.ThreadPools;
import org.apache.thrift.TApplicationException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

Expand All @@ -73,16 +60,15 @@
*/
@SuppressFBWarnings(value = "CT_CONSTRUCTOR_THROW",
justification = "Constructor validation is required for proper initialization")
public class Fate<T> {
public class Fate<T> extends FateClient<T> {

private static final Logger log = LoggerFactory.getLogger(Fate.class);
static final Logger log = LoggerFactory.getLogger(Fate.class);

private final FateStore<T> store;
private final ScheduledFuture<?> fatePoolsWatcherFuture;
private final AtomicInteger needMoreThreadsWarnCount = new AtomicInteger(0);
private final ExecutorService deadResCleanerExecutor;

private static final EnumSet<TStatus> FINISHED_STATES = EnumSet.of(FAILED, SUCCESSFUL, UNKNOWN);
public static final Duration INITIAL_DELAY = Duration.ofSeconds(3);
private static final Duration DEAD_RES_CLEANUP_DELAY = Duration.ofMinutes(3);
public static final Duration POOL_WATCHER_DELAY = Duration.ofSeconds(30);
Expand Down Expand Up @@ -262,6 +248,7 @@ public void run() {
public Fate(T environment, FateStore<T> store, boolean runDeadResCleaner,
Function<Repo<T>,String> toLogStrFunc, AccumuloConfiguration conf,
ScheduledThreadPoolExecutor genSchedExecutor) {
super(store, toLogStrFunc);
this.store = FateLogger.wrap(store, toLogStrFunc, false);

fatePoolsWatcherFuture =
Expand Down Expand Up @@ -382,133 +369,6 @@ public AtomicInteger getNeedMoreThreadsWarnCount() {
return needMoreThreadsWarnCount;
}

// get a transaction id back to the requester before doing any work
public FateId startTransaction() {
return store.create();
}

public Seeder<T> beginSeeding() {
return store.beginSeeding();
}

public void seedTransaction(FateOperation fateOp, FateKey fateKey, Repo<T> repo,
boolean autoCleanUp) {
try (var seeder = store.beginSeeding()) {
@SuppressWarnings("unused")
var unused = seeder.attemptToSeedTransaction(fateOp, fateKey, repo, autoCleanUp);
}
}

// start work in the transaction.. it is safe to call this
// multiple times for a transaction... but it will only seed once
public void seedTransaction(FateOperation fateOp, FateId fateId, Repo<T> repo,
boolean autoCleanUp, String goalMessage) {
log.info("[{}] Seeding {} {} {}", store.type(), fateOp, fateId, goalMessage);
store.seedTransaction(fateOp, fateId, repo, autoCleanUp);
}

// check on the transaction
public TStatus waitForCompletion(FateId fateId) {
return store.read(fateId).waitForStatusChange(FINISHED_STATES);
}

/**
* Attempts to cancel a running Fate transaction
*
* @param fateId fate transaction id
* @return true if transaction transitioned to a failed state or already in a completed state,
* false otherwise
*/
public boolean cancel(FateId fateId) {
for (int retries = 0; retries < 5; retries++) {
Optional<FateTxStore<T>> optionalTxStore = store.tryReserve(fateId);
if (optionalTxStore.isPresent()) {
var txStore = optionalTxStore.orElseThrow();
try {
TStatus status = txStore.getStatus();
log.info("[{}] status is: {}", store.type(), status);
if (status == NEW || status == SUBMITTED) {
txStore.setTransactionInfo(TxInfo.EXCEPTION, new TApplicationException(
TApplicationException.INTERNAL_ERROR, "Fate transaction cancelled by user"));
txStore.setStatus(FAILED_IN_PROGRESS);
log.info(
"[{}] Updated status for {} to FAILED_IN_PROGRESS because it was cancelled by user",
store.type(), fateId);
return true;
} else {
log.info("[{}] {} cancelled by user but already in progress or finished state",
store.type(), fateId);
return false;
}
} finally {
txStore.unreserve(Duration.ZERO);
}
} else {
// reserved, lets retry.
UtilWaitThread.sleep(500);
}
}
log.info("[{}] Unable to reserve transaction {} to cancel it", store.type(), fateId);
return false;
}

// resource cleanup
public void delete(FateId fateId) {
FateTxStore<T> txStore = store.reserve(fateId);
try {
switch (txStore.getStatus()) {
case NEW:
case SUBMITTED:
case FAILED:
case SUCCESSFUL:
txStore.delete();
break;
case FAILED_IN_PROGRESS:
case IN_PROGRESS:
throw new IllegalStateException("Can not delete in progress transaction " + fateId);
case UNKNOWN:
// nothing to do, it does not exist
break;
}
} finally {
txStore.unreserve(Duration.ZERO);
}
}

public String getReturn(FateId fateId) {
FateTxStore<T> txStore = store.reserve(fateId);
try {
if (txStore.getStatus() != SUCCESSFUL) {
throw new IllegalStateException(
"Tried to get exception when transaction " + fateId + " not in successful state");
}
return (String) txStore.getTransactionInfo(TxInfo.RETURN_VALUE);
} finally {
txStore.unreserve(Duration.ZERO);
}
}

// get reportable failures
public Exception getException(FateId fateId) {
FateTxStore<T> txStore = store.reserve(fateId);
try {
if (txStore.getStatus() != FAILED) {
throw new IllegalStateException(
"Tried to get exception when transaction " + fateId + " not in failed state");
}
return (Exception) txStore.getTransactionInfo(TxInfo.EXCEPTION);
} finally {
txStore.unreserve(Duration.ZERO);
}
}

/**
* Lists transctions for a given fate key type.
*/
public Stream<FateKey> list(FateKey.FateKeyType type) {
return store.list(type);
}

/**
* Initiates shutdown of background threads that run fate operations and cleanup fate data and
* optionally waits on them. Leaves the fate object in a state where it can still update and read
Expand Down
179 changes: 179 additions & 0 deletions core/src/main/java/org/apache/accumulo/core/fate/FateClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,179 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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.
*/
package org.apache.accumulo.core.fate;

import static org.apache.accumulo.core.fate.ReadOnlyFateStore.TStatus.FAILED;
import static org.apache.accumulo.core.fate.ReadOnlyFateStore.TStatus.FAILED_IN_PROGRESS;
import static org.apache.accumulo.core.fate.ReadOnlyFateStore.TStatus.NEW;
import static org.apache.accumulo.core.fate.ReadOnlyFateStore.TStatus.SUBMITTED;
import static org.apache.accumulo.core.fate.ReadOnlyFateStore.TStatus.SUCCESSFUL;
import static org.apache.accumulo.core.fate.ReadOnlyFateStore.TStatus.UNKNOWN;

import java.time.Duration;
import java.util.EnumSet;
import java.util.Optional;
import java.util.function.Function;
import java.util.stream.Stream;

import org.apache.accumulo.core.logging.FateLogger;
import org.apache.accumulo.core.util.UtilWaitThread;
import org.apache.thrift.TApplicationException;

/**
* Supports initiating and checking status of fate operations.
*
*/
public class FateClient<T> {

private final FateStore<T> store;

private static final EnumSet<ReadOnlyFateStore.TStatus> FINISHED_STATES =
EnumSet.of(FAILED, SUCCESSFUL, UNKNOWN);

public FateClient(FateStore<T> store, Function<Repo<T>,String> toLogStrFunc) {
this.store = FateLogger.wrap(store, toLogStrFunc, false);
}

// get a transaction id back to the requester before doing any work
public FateId startTransaction() {
return store.create();
}

public FateStore.Seeder<T> beginSeeding() {
return store.beginSeeding();
}

public void seedTransaction(Fate.FateOperation fateOp, FateKey fateKey, Repo<T> repo,
boolean autoCleanUp) {
try (var seeder = store.beginSeeding()) {
@SuppressWarnings("unused")
var unused = seeder.attemptToSeedTransaction(fateOp, fateKey, repo, autoCleanUp);
}
}

// start work in the transaction.. it is safe to call this
// multiple times for a transaction... but it will only seed once
public void seedTransaction(Fate.FateOperation fateOp, FateId fateId, Repo<T> repo,
boolean autoCleanUp, String goalMessage) {
Fate.log.info("[{}] Seeding {} {} {}", store.type(), fateOp, fateId, goalMessage);
store.seedTransaction(fateOp, fateId, repo, autoCleanUp);
}

// check on the transaction
public ReadOnlyFateStore.TStatus waitForCompletion(FateId fateId) {
return store.read(fateId).waitForStatusChange(FINISHED_STATES);
}

/**
* Attempts to cancel a running Fate transaction
*
* @param fateId fate transaction id
* @return true if transaction transitioned to a failed state or already in a completed state,
* false otherwise
*/
public boolean cancel(FateId fateId) {
for (int retries = 0; retries < 5; retries++) {
Optional<FateStore.FateTxStore<T>> optionalTxStore = store.tryReserve(fateId);
if (optionalTxStore.isPresent()) {
var txStore = optionalTxStore.orElseThrow();
try {
ReadOnlyFateStore.TStatus status = txStore.getStatus();
Fate.log.info("[{}] status is: {}", store.type(), status);
if (status == NEW || status == SUBMITTED) {
txStore.setTransactionInfo(Fate.TxInfo.EXCEPTION, new TApplicationException(
TApplicationException.INTERNAL_ERROR, "Fate transaction cancelled by user"));
txStore.setStatus(FAILED_IN_PROGRESS);
Fate.log.info(
"[{}] Updated status for {} to FAILED_IN_PROGRESS because it was cancelled by user",
store.type(), fateId);
return true;
} else {
Fate.log.info("[{}] {} cancelled by user but already in progress or finished state",
store.type(), fateId);
return false;
}
} finally {
txStore.unreserve(Duration.ZERO);
}
} else {
// reserved, lets retry.
UtilWaitThread.sleep(500);
}
}
Fate.log.info("[{}] Unable to reserve transaction {} to cancel it", store.type(), fateId);
return false;
}

// resource cleanup
public void delete(FateId fateId) {
FateStore.FateTxStore<T> txStore = store.reserve(fateId);
try {
switch (txStore.getStatus()) {
case NEW:
case SUBMITTED:
case FAILED:
case SUCCESSFUL:
txStore.delete();
break;
case FAILED_IN_PROGRESS:
case IN_PROGRESS:
throw new IllegalStateException("Can not delete in progress transaction " + fateId);
case UNKNOWN:
// nothing to do, it does not exist
break;
}
} finally {
txStore.unreserve(Duration.ZERO);
}
}

public String getReturn(FateId fateId) {
FateStore.FateTxStore<T> txStore = store.reserve(fateId);
try {
if (txStore.getStatus() != SUCCESSFUL) {
throw new IllegalStateException(
"Tried to get exception when transaction " + fateId + " not in successful state");
}
return (String) txStore.getTransactionInfo(Fate.TxInfo.RETURN_VALUE);
} finally {
txStore.unreserve(Duration.ZERO);
}
}

// get reportable failures
public Exception getException(FateId fateId) {
FateStore.FateTxStore<T> txStore = store.reserve(fateId);
try {
if (txStore.getStatus() != FAILED) {
throw new IllegalStateException(
"Tried to get exception when transaction " + fateId + " not in failed state");
}
return (Exception) txStore.getTransactionInfo(Fate.TxInfo.EXCEPTION);
} finally {
txStore.unreserve(Duration.ZERO);
}
}

/**
* Lists transctions for a given fate key type.
*/
public Stream<FateKey> list(FateKey.FateKeyType type) {
return store.list(type);
}
}
Loading