replace QuartzScheduler with a more lightweight scheduler

The new scheduler is based on the cron-utils package and uses the same cron syntax as quartz.
CronScheduler was mainly introduced, because of a ClassLoader leak with the old Quartz implementation.
The leak comes from shiros use of InheriatableThreadLocal in combination with the WorkerThreads of Quartz.
CronScheduler uses a ThreadFactory which clears the Shiro context before a new Thread is created (see CronThreadFactory).
This commit is contained in:
Sebastian Sdorra
2019-06-05 16:15:06 +02:00
parent 2b64a49e11
commit 3c373a4c4d
20 changed files with 746 additions and 818 deletions

View File

@@ -80,7 +80,7 @@ import sonia.scm.repository.api.RepositoryServiceFactory;
import sonia.scm.repository.spi.HookEventFacade;
import sonia.scm.repository.xml.XmlRepositoryDAO;
import sonia.scm.repository.xml.XmlRepositoryRoleDAO;
import sonia.scm.schedule.QuartzScheduler;
import sonia.scm.schedule.CronScheduler;
import sonia.scm.schedule.Scheduler;
import sonia.scm.security.AccessTokenCookieIssuer;
import sonia.scm.security.AuthorizationChangedEventProducer;
@@ -218,7 +218,7 @@ public class ScmServletModule extends ServletModule
bind(PluginManager.class, DefaultPluginManager.class);
// bind scheduler
bind(Scheduler.class).to(QuartzScheduler.class);
bind(Scheduler.class).to(CronScheduler.class);
// bind health check stuff
bind(HealthCheckContextListener.class);

View File

@@ -0,0 +1,59 @@
package sonia.scm.schedule;
import com.cronutils.model.Cron;
import com.cronutils.model.CronType;
import com.cronutils.model.definition.CronDefinition;
import com.cronutils.model.definition.CronDefinitionBuilder;
import com.cronutils.model.time.ExecutionTime;
import com.cronutils.parser.CronParser;
import java.time.Clock;
import java.time.Duration;
import java.time.ZonedDateTime;
import java.util.Optional;
final class CronExpression {
private final Clock clock;
private final String expression;
private final ExecutionTime executionTime;
CronExpression(String expression) {
this(Clock.systemUTC(), expression);
}
CronExpression(Clock clock, String expression) {
this.clock = clock;
this.expression = expression;
executionTime = createExecutionTime(expression);
}
boolean shouldRun(ZonedDateTime time) {
ZonedDateTime now = ZonedDateTime.now(clock);
return time.isBefore(now);
}
Optional<ZonedDateTime> calculateNextRun() {
ZonedDateTime now = ZonedDateTime.now(clock);
Optional<ZonedDateTime> nextExecution = executionTime.nextExecution(now);
if (nextExecution.isPresent()) {
ZonedDateTime next = nextExecution.get();
if (Duration.between(now, next).toMillis() < 1000) {
return executionTime.nextExecution(now.plusSeconds(1L));
}
}
return nextExecution;
}
private ExecutionTime createExecutionTime(String expression) {
CronDefinition cronDefinition = CronDefinitionBuilder.instanceDefinitionFor(CronType.QUARTZ);
CronParser parser = new CronParser(cronDefinition);
Cron cron = parser.parse(expression);
return ExecutionTime.forCron(cron);
}
@Override
public String toString() {
return expression;
}
}

View File

@@ -0,0 +1,57 @@
package sonia.scm.schedule;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import javax.inject.Inject;
import javax.inject.Singleton;
import java.util.concurrent.Executors;
import java.util.concurrent.Future;
import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.TimeUnit;
@Singleton
public class CronScheduler implements Scheduler {
private static final Logger LOG = LoggerFactory.getLogger(CronScheduler.class);
private final ScheduledExecutorService executorService;
private final CronTaskFactory taskFactory;
@Inject
public CronScheduler(CronTaskFactory taskFactory) {
this.taskFactory = taskFactory;
this.executorService = createExecutor();
}
private ScheduledExecutorService createExecutor() {
return Executors.newScheduledThreadPool(2, new CronThreadFactory());
}
@Override
public CronTask schedule(String expression, Runnable runnable) {
return schedule(taskFactory.create(expression, runnable));
}
@Override
public CronTask schedule(String expression, Class<? extends Runnable> runnable) {
return schedule(taskFactory.create(expression, runnable));
}
private CronTask schedule(CronTask task) {
if (task.hasNextRun()) {
LOG.debug("schedule task {}", task);
Future<?> future = executorService.scheduleAtFixedRate(task, 0L, 1L, TimeUnit.SECONDS);
task.setFuture(future);
} else {
LOG.debug("skip scheduling, because task {} has no next run", task);
}
return task;
}
@Override
public void close() {
LOG.debug("shutdown underlying executor service");
executorService.shutdown();
}
}

View File

@@ -0,0 +1,74 @@
package sonia.scm.schedule;
import com.cronutils.utils.VisibleForTesting;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.time.ZonedDateTime;
import java.util.Optional;
import java.util.concurrent.Future;
class CronTask implements Task, Runnable {
private static final Logger LOG = LoggerFactory.getLogger(CronTask.class);
private final String name;
private final CronExpression expression;
private final Runnable runnable;
private ZonedDateTime nextRun;
private Future<?> future;
CronTask(String name, CronExpression expression, Runnable runnable) {
this.name = name;
this.expression = expression;
this.runnable = runnable;
this.nextRun = expression.calculateNextRun().orElse(null);
}
void setFuture(Future<?> future) {
this.future = future;
}
@Override
public synchronized void run() {
if (expression.shouldRun(nextRun)) {
LOG.debug("execute task {}, because of matching expression {}", name, expression);
runnable.run();
Optional<ZonedDateTime> next = expression.calculateNextRun();
if (next.isPresent()) {
nextRun = next.get();
} else {
LOG.debug("cancel task {}, because expression {} has no next execution", name, expression);
cancel();
}
} else {
LOG.trace("skip execution of task {}, because expression {} does not match", name, expression);
}
}
boolean hasNextRun() {
return nextRun != null;
}
@VisibleForTesting
String getName() {
return name;
}
@VisibleForTesting
CronExpression getExpression() {
return expression;
}
@Override
public synchronized void cancel() {
LOG.debug("cancel task {} with expression {}", name, expression);
future.cancel(false);
}
@Override
public String toString() {
return name + "(" + expression + ")";
}
}

View File

@@ -0,0 +1,32 @@
package sonia.scm.schedule;
import com.google.inject.Injector;
import com.google.inject.util.Providers;
import javax.inject.Inject;
import javax.inject.Provider;
class CronTaskFactory {
private final Injector injector;
private final PrivilegedRunnableFactory runnableFactory;
@Inject
public CronTaskFactory(Injector injector, PrivilegedRunnableFactory runnableFactory) {
this.injector = injector;
this.runnableFactory = runnableFactory;
}
CronTask create(String expression, Runnable runnable) {
return create(expression, runnable.getClass().getName(), Providers.of(runnable));
}
CronTask create(String expression, Class<? extends Runnable> runnable) {
return create(expression, runnable.getName(), injector.getProvider(runnable));
}
private CronTask create(String expression, String name, Provider<? extends Runnable> runnableProvider) {
Runnable runnable = runnableFactory.create(runnableProvider);
return new CronTask(name, new CronExpression(expression), runnable);
}
}

View File

@@ -0,0 +1,47 @@
package sonia.scm.schedule;
import org.apache.shiro.util.ThreadContext;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.ThreadFactory;
import java.util.concurrent.atomic.AtomicLong;
/**
* This thread factory creates threads without a shiro context.
* This is to avoid classloader leaks, because the {@link ThreadContext} of shiro uses {@link InheritableThreadLocal},
* which could bind a class with a reference to a {@link sonia.scm.plugin.PluginClassLoader}.
*/
class CronThreadFactory implements ThreadFactory, AutoCloseable {
private static final String NAME_TEMPLATE = "CronScheduler-%d-%d";
private static final AtomicLong FACTORY_COUNTER = new AtomicLong();
private final ExecutorService executorService = Executors.newSingleThreadExecutor();
private final long factoryId = FACTORY_COUNTER.incrementAndGet();
private final AtomicLong threadCounter = new AtomicLong();
@Override
public Thread newThread(final Runnable r) {
try {
return executorService.submit(() -> {
ThreadContext.remove();
return new Thread(r, createName());
}).get();
} catch (InterruptedException | ExecutionException e) {
throw new RuntimeException("failed to schedule runnable");
}
}
private String createName() {
long threadId = threadCounter.incrementAndGet();
return String.format(NAME_TEMPLATE, factoryId, threadId);
}
@Override
public void close() {
executorService.shutdown();
}
}

View File

@@ -1,85 +0,0 @@
/***
* Copyright (c) 2015, Sebastian Sdorra
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
* 3. Neither the name of SCM-Manager; nor the names of its
* contributors may be used to endorse or promote products derived from this
* software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
* ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* https://bitbucket.org/sdorra/scm-manager
*
*/
package sonia.scm.schedule;
import com.google.common.base.Preconditions;
import com.google.inject.Injector;
import com.google.inject.Provider;
import org.quartz.Job;
import org.quartz.JobDataMap;
import org.quartz.JobDetail;
import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import sonia.scm.web.security.AdministrationContext;
/**
* InjectionEnabledJob allows the execution of quartz jobs and enable injection on them.
*
* @author Sebastian Sdorra <sebastian.sdorra@triology.de>
* @since 1.47
*/
public class InjectionEnabledJob implements Job {
private static final Logger logger = LoggerFactory.getLogger(InjectionEnabledJob.class);
@Override
@SuppressWarnings("unchecked")
public void execute(JobExecutionContext jec) throws JobExecutionException {
Preconditions.checkNotNull(jec, "execution context is null");
JobDetail detail = jec.getJobDetail();
Preconditions.checkNotNull(detail, "job detail not provided");
JobDataMap dataMap = detail.getJobDataMap();
Preconditions.checkNotNull(dataMap, "job detail does not contain data map");
Injector injector = (Injector) dataMap.get(Injector.class.getName());
Preconditions.checkNotNull(injector, "data map does not contain injector");
final Provider<Runnable> runnableProvider = (Provider<Runnable>) dataMap.get(Runnable.class.getName());
if (runnableProvider == null) {
throw new JobExecutionException("could not find runnable provider");
}
AdministrationContext ctx = injector.getInstance(AdministrationContext.class);
ctx.runAsAdmin(() -> {
logger.trace("create runnable from provider");
Runnable runnable = runnableProvider.get();
logger.debug("execute injection enabled job {}", runnable.getClass());
runnable.run();
});
}
}

View File

@@ -0,0 +1,29 @@
package sonia.scm.schedule;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import sonia.scm.web.security.AdministrationContext;
import javax.inject.Inject;
import javax.inject.Provider;
class PrivilegedRunnableFactory {
private static final Logger LOG = LoggerFactory.getLogger(PrivilegedRunnableFactory.class);
private final AdministrationContext context;
@Inject
PrivilegedRunnableFactory(AdministrationContext context) {
this.context = context;
}
public Runnable create(Provider<? extends Runnable> runnableProvider) {
return () -> context.runAsAdmin(() -> {
LOG.trace("create runnable from provider");
Runnable runnable = runnableProvider.get();
LOG.debug("execute scheduled job {}", runnable.getClass());
runnable.run();
});
}
}

View File

@@ -1,175 +0,0 @@
/***
* Copyright (c) 2015, Sebastian Sdorra
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
* 3. Neither the name of SCM-Manager; nor the names of its
* contributors may be used to endorse or promote products derived from this
* software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
* ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* https://bitbucket.org/sdorra/scm-manager
*
*/
package sonia.scm.schedule;
import com.google.common.base.Throwables;
import com.google.inject.Injector;
import com.google.inject.Provider;
import com.google.inject.Singleton;
import java.io.IOException;
import javax.inject.Inject;
import org.quartz.CronScheduleBuilder;
import org.quartz.JobBuilder;
import org.quartz.JobDataMap;
import org.quartz.JobDetail;
import org.quartz.SchedulerException;
import org.quartz.Trigger;
import org.quartz.TriggerBuilder;
import org.quartz.impl.StdSchedulerFactory;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import sonia.scm.Initable;
import sonia.scm.SCMContextProvider;
/**
* {@link Scheduler} which uses the quartz scheduler.
*
* @author Sebastian Sdorra
* @since 1.47
*
* @see <a href="http://www.quartz-scheduler.org/">Quartz Job Scheduler</a>
*/
@Singleton
public class QuartzScheduler implements Scheduler, Initable {
private static final Logger logger = LoggerFactory.getLogger(QuartzScheduler.class);
private final Injector injector;
private final org.quartz.Scheduler scheduler;
/**
* Creates a new quartz scheduler.
*
* @param injector injector
*/
@Inject
public QuartzScheduler(Injector injector)
{
this.injector = injector;
// get default scheduler
try {
scheduler = StdSchedulerFactory.getDefaultScheduler();
} catch (SchedulerException ex) {
throw Throwables.propagate(ex);
}
}
/**
* Creates a new quartz scheduler. This constructor is only for testing.
*
* @param injector injector
* @param scheduler quartz scheduler
*/
QuartzScheduler(Injector injector, org.quartz.Scheduler scheduler)
{
this.injector = injector;
this.scheduler = scheduler;
}
@Override
public void init(SCMContextProvider context)
{
try
{
if (!scheduler.isStarted())
{
scheduler.start();
}
}
catch (SchedulerException ex)
{
logger.error("can not start scheduler", ex);
}
}
@Override
public void close() throws IOException
{
try
{
if (scheduler.isStarted()){
scheduler.shutdown();
}
}
catch (SchedulerException ex)
{
logger.error("can not stop scheduler", ex);
}
}
@Override
public Task schedule(String expression, final Runnable runnable)
{
return schedule(expression, new Provider<Runnable>(){
@Override
public Runnable get()
{
return runnable;
}
});
}
@Override
public Task schedule(String expression, Class<? extends Runnable> runnable)
{
return schedule(expression, injector.getProvider(runnable));
}
private Task schedule(String expression, Provider<? extends Runnable> provider){
// create data map with injection provider for InjectionEnabledJob
JobDataMap map = new JobDataMap();
map.put(Runnable.class.getName(), provider);
map.put(Injector.class.getName(), injector);
// create job detail for InjectionEnabledJob with the provider for the annotated class
JobDetail detail = JobBuilder.newJob(InjectionEnabledJob.class)
.usingJobData(map)
.build();
// create a trigger with the cron expression from the annotation
Trigger trigger = TriggerBuilder.newTrigger()
.forJob(detail)
.withSchedule(CronScheduleBuilder.cronSchedule(expression))
.build();
try {
scheduler.scheduleJob(detail, trigger);
} catch (SchedulerException ex) {
throw Throwables.propagate(ex);
}
return new QuartzTask(scheduler, trigger.getJobKey());
}
}

View File

@@ -1,68 +0,0 @@
/***
* Copyright (c) 2015, Sebastian Sdorra
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
* 3. Neither the name of SCM-Manager; nor the names of its
* contributors may be used to endorse or promote products derived from this
* software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
* ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* https://bitbucket.org/sdorra/scm-manager
*
*/
package sonia.scm.schedule;
import com.google.common.base.Throwables;
import org.quartz.JobKey;
import org.quartz.Scheduler;
import org.quartz.SchedulerException;
/**
* Task implementation for the {@link QuartzScheduler}.
*
* @author Sebastian Sdorra
*/
public class QuartzTask implements Task {
private final org.quartz.Scheduler scheduler;
private final JobKey jobKey;
QuartzTask(Scheduler scheduler, JobKey jobKey)
{
this.scheduler = scheduler;
this.jobKey = jobKey;
}
@Override
public void cancel()
{
try
{
scheduler.deleteJob(jobKey);
}
catch (SchedulerException ex)
{
throw Throwables.propagate(ex);
}
}
}