arjunashok commented on code in PR #139: URL: https://github.com/apache/cassandra-sidecar/pull/139#discussion_r1831784749
########## server/src/main/java/org/apache/cassandra/sidecar/job/JobTracker.java: ########## @@ -0,0 +1,254 @@ +/* + * 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.cassandra.sidecar.job; + +import java.util.LinkedHashMap; +import java.util.Map; +import java.util.UUID; +import java.util.concurrent.locks.ReadWriteLock; +import java.util.concurrent.locks.ReentrantReadWriteLock; + +import com.google.common.collect.ImmutableMap; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import org.jetbrains.annotations.NotNull; + +/** + * Tracks and stores the results of long-running jobs running on the sidecar + */ +public class JobTracker extends LinkedHashMap<UUID, Job> +{ + + private static final Logger LOGGER = LoggerFactory.getLogger(JobTracker.class); + int capacity; + private final ReadWriteLock lock = new ReentrantReadWriteLock(); + + public JobTracker(final int initialCapacity) + { + super(initialCapacity); + this.capacity = initialCapacity; + } + + /** + * {@inheritDoc} + */ + @Override + public Job put(final UUID key, final Job value) + { + lock.writeLock().lock(); + try + { + return super.put(key, value); + } + finally + { + lock.writeLock().unlock(); + } + } + + /** + * {@inheritDoc} + */ + @Override + public Job putIfAbsent(final UUID key, final Job value) + { + lock.writeLock().lock(); + try + { + return super.putIfAbsent(key, value); + } + finally + { + lock.writeLock().unlock(); + } + } + + /** + * {@inheritDoc} + */ + @Override + public void putAll(final Map<? extends UUID, ? extends Job> m) + { + lock.writeLock().lock(); + try + { + super.putAll(m); + } + finally + { + lock.writeLock().unlock(); + } + } + + /** + * {@inheritDoc} + */ + @Override + public Job remove(final Object key) + { + lock.writeLock().lock(); + try + { + return super.remove(key); + } + finally + { + lock.writeLock().unlock(); + } + } + + /** + * {@inheritDoc} + */ + @Override + public void clear() + { + lock.writeLock().lock(); + try + { + super.clear(); + } + finally + { + lock.writeLock().unlock(); + } + } + + /** + * {@inheritDoc} + */ + @Override + public Job get(final Object key) + { + lock.readLock().lock(); + try + { + return super.get(key); + } + finally + { + lock.readLock().unlock(); + } + } + + /** + * {@inheritDoc} + */ + @Override + public boolean containsKey(final Object key) + { + lock.readLock().lock(); + try + { + return super.containsKey(key); + } + finally + { + lock.readLock().unlock(); + } + } + + /** + * {@inheritDoc} + */ + @Override + public int size() + { + lock.readLock().lock(); + try + { + return super.size(); + } + finally + { + lock.readLock().unlock(); + } + } + + /** + * {@inheritDoc} + */ + @Override + public boolean isEmpty() + { + lock.readLock().lock(); + try + { + return super.isEmpty(); + } + finally + { + lock.readLock().unlock(); + } + } + + /** + * {@inheritDoc} + */ + @Override + public Object clone() + { + lock.readLock().lock(); + try + { + return super.clone(); + } + finally + { + lock.readLock().unlock(); + } + } + + /** + * {@inheritDoc} + */ + @Override + protected boolean removeEldestEntry(final Map.Entry<UUID, Job> eldest) + { + if (size() <= capacity) Review Comment: So, the intention behind the tracker is only to maintain the state for ongoing jobs without growing unbounded, but not to throttle/limit the no. of jobs that can be posted. Since jobs are typically short-lived, the entry's age based eviction seems reasonable as a capping mechanism. > how can a user track that deleted eldest job Ideally, we should size this optimally to minimize evictions of ongoing jobs. If a job that is inflight on the C* node gets evicted from the cache, the subsequent polling will return a 404. The expected behavior for the client at this point is to retry the command (eg. decommission), here the downstream check will determine that there is an ongoing operation and return a 409 Conflict, and start tracking it with a new UUID (which is part of the response). ########## server/src/main/java/org/apache/cassandra/sidecar/job/JobTracker.java: ########## @@ -0,0 +1,254 @@ +/* + * 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.cassandra.sidecar.job; + +import java.util.LinkedHashMap; +import java.util.Map; +import java.util.UUID; +import java.util.concurrent.locks.ReadWriteLock; +import java.util.concurrent.locks.ReentrantReadWriteLock; + +import com.google.common.collect.ImmutableMap; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import org.jetbrains.annotations.NotNull; + +/** + * Tracks and stores the results of long-running jobs running on the sidecar + */ +public class JobTracker extends LinkedHashMap<UUID, Job> +{ + + private static final Logger LOGGER = LoggerFactory.getLogger(JobTracker.class); + int capacity; + private final ReadWriteLock lock = new ReentrantReadWriteLock(); + + public JobTracker(final int initialCapacity) + { + super(initialCapacity); + this.capacity = initialCapacity; + } + + /** + * {@inheritDoc} + */ + @Override + public Job put(final UUID key, final Job value) + { + lock.writeLock().lock(); + try + { + return super.put(key, value); + } + finally + { + lock.writeLock().unlock(); + } + } + + /** + * {@inheritDoc} + */ + @Override + public Job putIfAbsent(final UUID key, final Job value) + { + lock.writeLock().lock(); + try + { + return super.putIfAbsent(key, value); + } + finally + { + lock.writeLock().unlock(); + } + } + + /** + * {@inheritDoc} + */ + @Override + public void putAll(final Map<? extends UUID, ? extends Job> m) + { + lock.writeLock().lock(); + try + { + super.putAll(m); + } + finally + { + lock.writeLock().unlock(); + } + } + + /** + * {@inheritDoc} + */ + @Override + public Job remove(final Object key) + { + lock.writeLock().lock(); + try + { + return super.remove(key); + } + finally + { + lock.writeLock().unlock(); + } + } + + /** + * {@inheritDoc} + */ + @Override + public void clear() + { + lock.writeLock().lock(); + try + { + super.clear(); + } + finally + { + lock.writeLock().unlock(); + } + } + + /** + * {@inheritDoc} + */ + @Override + public Job get(final Object key) + { + lock.readLock().lock(); + try + { + return super.get(key); + } + finally + { + lock.readLock().unlock(); + } + } + + /** + * {@inheritDoc} + */ + @Override + public boolean containsKey(final Object key) + { + lock.readLock().lock(); + try + { + return super.containsKey(key); + } + finally + { + lock.readLock().unlock(); + } + } + + /** + * {@inheritDoc} + */ + @Override + public int size() + { + lock.readLock().lock(); + try + { + return super.size(); + } + finally + { + lock.readLock().unlock(); + } + } + + /** + * {@inheritDoc} + */ + @Override + public boolean isEmpty() + { + lock.readLock().lock(); + try + { + return super.isEmpty(); + } + finally + { + lock.readLock().unlock(); + } + } + + /** + * {@inheritDoc} + */ + @Override + public Object clone() + { + lock.readLock().lock(); + try + { + return super.clone(); + } + finally + { + lock.readLock().unlock(); + } + } + + /** + * {@inheritDoc} + */ + @Override + protected boolean removeEldestEntry(final Map.Entry<UUID, Job> eldest) + { + if (size() <= capacity) Review Comment: So, the intention behind the tracker is only to maintain the state for ongoing jobs without growing unbounded, but not to throttle/limit the no. of jobs that can be posted. Since jobs are typically short-lived, the entry's age based eviction seems reasonable as a capping mechanism. > how can a user track that deleted eldest job Ideally, we should size this optimally to minimize evictions of ongoing jobs. If a job that is inflight on the C* node gets evicted from the cache, the subsequent polling will return a 404. The expected behavior for the client at this point is to retry the command (eg. decommission), here the downstream check will determine that there is an ongoing operation and return a 409 Conflict, and start tracking it with a new UUID (which is part of the response). -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
