fabriziofortino commented on code in PR #1560:
URL: https://github.com/apache/jackrabbit-oak/pull/1560#discussion_r1672128721
##########
oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/index/AsyncCheckpointService.java:
##########
@@ -0,0 +1,95 @@
+package org.apache.jackrabbit.oak.plugins.index;
+
+
+
+import org.apache.jackrabbit.oak.osgi.OsgiWhiteboard;
+import org.apache.jackrabbit.oak.spi.state.NodeStore;
+import org.apache.jackrabbit.oak.spi.whiteboard.CompositeRegistration;
+import org.apache.jackrabbit.oak.spi.whiteboard.Registration;
+import org.apache.jackrabbit.oak.spi.whiteboard.Whiteboard;
+import org.osgi.framework.BundleContext;
+import org.osgi.service.component.annotations.*;
+import org.osgi.service.metatype.annotations.AttributeDefinition;
+import org.osgi.service.metatype.annotations.Designate;
+import org.osgi.service.metatype.annotations.ObjectClassDefinition;
+
+import java.io.IOException;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Map;
+
+import static
org.apache.jackrabbit.oak.spi.whiteboard.WhiteboardUtils.ScheduleExecutionInstanceTypes.RUN_ON_LEADER;
+import static
org.apache.jackrabbit.oak.spi.whiteboard.WhiteboardUtils.scheduleWithFixedDelay;
+
+@Component(
+ configurationPolicy = ConfigurationPolicy.REQUIRE,
+ service = {})
Review Comment:
`service = {}` is redundant
```suggestion
@Component(configurationPolicy = ConfigurationPolicy.REQUIRE)
```
##########
oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/index/AsyncCheckpointService.java:
##########
@@ -0,0 +1,95 @@
+package org.apache.jackrabbit.oak.plugins.index;
+
+
Review Comment:
nit: multiple blank lines
```suggestion
```
##########
oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/index/AsyncCheckpointCreator.java:
##########
@@ -0,0 +1,121 @@
+/*
+ * 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
+ *
+ * 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 org.apache.jackrabbit.oak.plugins.index;
+
+
+import org.apache.jackrabbit.oak.spi.state.NodeStore;
+import org.apache.jackrabbit.util.ISO8601;
+import org.jetbrains.annotations.NotNull;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import java.util.Calendar;
+import java.util.Map;
+import java.util.Set;
+import java.util.TimeZone;
+
+/**
+ * This class is responsible for creating and deleting checkpoints
asynchronously.
+ * The number of minimum concurrent checkpoints to keep in the system, along
with the default lifetime of a checkpoint
+ * can be configured.
+ * When executed, this class should create one checkpoint in a single run with
a configurable name.
+ * Following the creation of the checkpoint, it should try to delete
checkpoints with the given name,
+ * in case the total number of such checkpoints is greater than the configured
minimum concurrent checkpoints.
+ * By default, this task is registered using AsyncCheckpointService
+ */
+public class AsyncCheckpointCreator implements Runnable {
+
+ /**
+ * Name of service property which determines the name of this Async task
+ */
+ public static final String PROP_ASYNC_NAME = "oak.checkpoint.async";
+
+ private final String name;
+ private final long checkpointLifetimeInSeconds;
+ private final long minConcurrentCheckpoints;
+ private final NodeStore store;
+ public static final String CHECKPOINT_CREATOR_KEY = "creator";
+ public static final String CHECKPOINT_CREATED_KEY = "created";
+ public static final String CHECKPOINT_CREATED_TIMESTAMP_KEY=
"created-epoch";
+ public static final String CHECKPOINT_THREAD_KEY = "thread";
+ public static final String CHECKPOINT_NAME_KEY = "name";
+ private static final Logger log = LoggerFactory
+ .getLogger(AsyncCheckpointCreator.class);
+
+ public AsyncCheckpointCreator(@NotNull NodeStore store, @NotNull String
name, long checkpointLifetimeInSeconds, long minConcurrentCheckpoints) {
+ this.store = store;
+ this.name = name;
+ this.checkpointLifetimeInSeconds = checkpointLifetimeInSeconds;
+ this.minConcurrentCheckpoints = minConcurrentCheckpoints;
+ }
+
+ public String getName() {
+ return name;
+ }
+
+ protected long getCheckpointLifetimeInSeconds() {
+ return checkpointLifetimeInSeconds;
+ }
+
+ protected long getMinConcurrentCheckpoints() {
+ return minConcurrentCheckpoints;
+ }
+
+ @Override
+ public void run() {
+ Calendar cal = Calendar.getInstance(TimeZone.getTimeZone("UTC"));
+ String creationTimeStamp = String.valueOf(cal.getTimeInMillis());
+ String creationTimeISOFormat = ISO8601.format(cal);
+ String checkpoint = store.checkpoint(checkpointLifetimeInSeconds *
1000, Map.of(
+ CHECKPOINT_CREATOR_KEY,
AsyncCheckpointCreator.class.getSimpleName(),
+ CHECKPOINT_CREATED_KEY, creationTimeISOFormat,
+ CHECKPOINT_CREATED_TIMESTAMP_KEY, creationTimeStamp,
+ CHECKPOINT_THREAD_KEY, Thread.currentThread().getName(),
+ CHECKPOINT_NAME_KEY, name));
+ log.info("[{}] Created checkpoint {} with creation time {}", name,
checkpoint, creationTimeISOFormat);
+
+ // Get a list of checkpoints filtered on the basis of
CHECKPOINT_NAME_KEY (name). This is done using the
+ // getFilteredCheckpoints in the IndexUtils, which gets all the
checkpoints in the node store and then filters the list based on
+ // the provided predicate using the checkpoint info map associated
with the checkpoints.
+ // The filtered checkpoints list is then sorted based on the
CHECKPOINT_CREATED_TIMESTAMP_KEY (created-epoch).
+ // Both the initial filtering and sorting is done based on the
information from the associated checkpoint info map of a given checkpoint.
+ Set<String> sortedCheckpointSet =
IndexUtils.getSortedCheckpointMap(IndexUtils.getFilteredCheckpoints(store,
+ entry ->
name.equals(entry.getValue().get(CHECKPOINT_NAME_KEY))),
CHECKPOINT_CREATED_TIMESTAMP_KEY).keySet();
+ int counter = sortedCheckpointSet.size();
+ // Iterate over the sortedCheckpointSet which is sorted based on the
creation timestamp -> the oldest first
+ // We try and delete the checkpoints as long as the counter is greater
than minConcurrentCheckpoints
+ // This ensures that the system always has concurrent checkpoints
equal to or greater than the configured minConcurrentCheckpoints
+ for (String cp : sortedCheckpointSet) {
+ // Delete the checkpoint as long as the checkpoint count is
greater than concurrentCheckpoints
+ if (counter > minConcurrentCheckpoints) {
+ if(store.release(cp) ) {
+ log.info("[{}] Deleted checkpoint {}", name, cp);
+ } else {
+ log.warn("[{}] Unable to delete checkpoint {}. Removal
will be attempted again in next run.", name, cp);
Review Comment:
If we are not able to release a checkpoint we retry in the next run. That's
fine.
What if this condition persists for several runs? In this case, we will keep
adding checkpoints without deleting them.
Should we add some logic before creating a new checkpoint which checks there
are not too many checkpoints?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: oak-dev-unsubscr...@jackrabbit.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
