Skip to content
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.

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

Add support for custom JdbcCustomization via Spring Boot #357

Merged
merged 5 commits into from
Apr 17, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
import com.github.kagkarlsson.scheduler.Scheduler;
import com.github.kagkarlsson.scheduler.SchedulerBuilder;
import com.github.kagkarlsson.scheduler.SchedulerName;
import com.github.kagkarlsson.scheduler.jdbc.AutodetectJdbcCustomization;
import com.github.kagkarlsson.scheduler.serializer.Serializer;
import com.github.kagkarlsson.scheduler.boot.config.DbSchedulerCustomizer;
import com.github.kagkarlsson.scheduler.boot.config.DbSchedulerProperties;
Expand All @@ -29,6 +30,7 @@
import com.github.kagkarlsson.scheduler.stats.StatsRegistry;
import com.github.kagkarlsson.scheduler.task.OnStartup;
import com.github.kagkarlsson.scheduler.task.Task;

import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.ObjectInput;
Expand All @@ -39,6 +41,7 @@
import java.util.function.Predicate;
import java.util.stream.Collectors;
import javax.sql.DataSource;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.boot.autoconfigure.AutoConfigurationPackage;
Expand Down Expand Up @@ -143,6 +146,11 @@ public Scheduler scheduler(DbSchedulerCustomizer customizer, StatsRegistry regis
// Use custom serializer if provided. Otherwise use devtools friendly serializer.
builder.serializer(customizer.serializer().orElse(SPRING_JAVA_SERIALIZER));

// Use custom JdbcCustomizer if provided.
builder.jdbcCustomization(
customizer.jdbcCustomization()
.orElse(new AutodetectJdbcCustomization(transactionalDataSource)));

if (config.isImmediateExecutionEnabled()) {
builder.enableImmediateExecution();
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,9 @@
package com.github.kagkarlsson.scheduler.boot.config;

import com.github.kagkarlsson.scheduler.SchedulerName;
import com.github.kagkarlsson.scheduler.jdbc.JdbcCustomization;
import com.github.kagkarlsson.scheduler.serializer.Serializer;

import java.util.Optional;
import java.util.concurrent.ExecutorService;

Expand Down Expand Up @@ -45,4 +47,11 @@ default Optional<Serializer> serializer() {
default Optional<ExecutorService> executorService() {
return Optional.empty();
}

/**
* Provide a custom JdbcCustomization.
*/
default Optional<JdbcCustomization> jdbcCustomization() {
return Optional.empty();
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,16 @@ public Instant getInstant(ResultSet rs, String columnName) throws SQLException {
return jdbcCustomization.getInstant(rs, columnName);
}

@Override
public void setTaskData(PreparedStatement p, int index, byte[] value) throws SQLException {
jdbcCustomization.setTaskData(p, index, value);
}

@Override
public byte[] getTaskData(ResultSet rs, String columnName) throws SQLException {
return jdbcCustomization.getTaskData(rs, columnName);
}

@Override
public boolean supportsExplicitQueryLimitPart() {
return jdbcCustomization.supportsExplicitQueryLimitPart();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,16 @@ public Instant getInstant(ResultSet rs, String columnName) throws SQLException {
return Optional.ofNullable(rs.getTimestamp(columnName)).map(Timestamp::toInstant).orElse(null);
}

@Override
public void setTaskData(PreparedStatement p, int index, byte[] value) throws SQLException {
p.setObject(index, value);
}

@Override
public byte[] getTaskData(ResultSet rs, String columnName) throws SQLException {
return rs.getBytes(columnName);
}

@Override
public boolean supportsExplicitQueryLimitPart() {
return false;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,10 @@ public interface JdbcCustomization {
void setInstant(PreparedStatement p, int index, Instant value) throws SQLException;
Instant getInstant(ResultSet rs, String columnName) throws SQLException;

void setTaskData(PreparedStatement p, int index, byte[] value) throws SQLException;
byte[] getTaskData(ResultSet rs, String columnName) throws SQLException;


boolean supportsExplicitQueryLimitPart();
String getQueryLimitPart(int limit);

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ public boolean createIfNotExists(SchedulableInstance instance) {
(PreparedStatement p) -> {
p.setString(1, taskInstance.getTaskName());
p.setString(2, taskInstance.getId());
p.setObject(3, serializer.serialize(taskInstance.getData()));
jdbcCustomization.setTaskData(p, 3, serializer.serialize(taskInstance.getData()));
jdbcCustomization.setInstant(p, 4, instance.getNextExecutionTime(clock.now()));
p.setBoolean(5, false);
p.setLong(6, 1L);
Expand Down Expand Up @@ -470,7 +470,7 @@ public Void map(ResultSet rs) throws SQLException {
}

String instanceId = rs.getString("task_instance");
byte[] data = rs.getBytes("task_data");
byte[] data = jdbcCustomization.getTaskData(rs,"task_data");

Instant executionTime = jdbcCustomization.getInstant(rs, "execution_time");

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
import java.util.Optional;
import java.util.TimeZone;

public class MssqlJdbcCustomization implements JdbcCustomization {
public class MssqlJdbcCustomization extends DefaultJdbcCustomization {

@Override
public String getName() {
Expand All @@ -39,28 +39,4 @@ public void setInstant(PreparedStatement p, int index, Instant value) throws SQL
p.setTimestamp(index, value != null ? Timestamp.from(value) : null, Calendar.getInstance(TimeZone.getTimeZone("UTC")));
}

@Override
public Instant getInstant(ResultSet rs, String columnName) throws SQLException {
return Optional.ofNullable(rs.getTimestamp(columnName)).map(Timestamp::toInstant).orElse(null);
}

@Override
public boolean supportsExplicitQueryLimitPart() {
return false;
}

@Override
public String getQueryLimitPart(int limit) {
return "";
}

@Override
public boolean supportsLockAndFetch() {
return false;
}

@Override
public List<Execution> lockAndFetch(JdbcTaskRepositoryContext ctx, Instant now, int limit) {
throw new UnsupportedOperationException("lockAndFetch not supported for " + this.getClass().getName());
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
import java.util.Objects;

public class PlainScheduleAndData implements ScheduleAndData, Serializable {
private static final long serialVersionUID = 1L;
private final Schedule schedule;
private final Object data;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,11 @@
*/
public class CronSchedule implements Schedule, Serializable {

private static final long serialVersionUID = 1L;

private static final String DISABLED = "-";
private static final Logger LOG = LoggerFactory.getLogger(CronSchedule.class);

private final String pattern;
private final ZoneId zoneId;
private transient ExecutionTime cronExecutionTime; // lazily initialized
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@

public class Daily implements Schedule, Serializable {

private static final long serialVersionUID = 1L;

private final List<LocalTime> times;
private final ZoneId zone;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@

public class FixedDelay implements Schedule, Serializable {

private static final long serialVersionUID = 1L;

private final Duration duration;

private FixedDelay() { // For serializers
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
import java.time.ZoneId;

public class PersistentCronSchedule implements ScheduleAndData {
private static final long serialVersionUID = 1L;
private final String cronPattern;
private final String zoneId;
private final Object data;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,6 @@
*/
package com.github.kagkarlsson.examples.boot.config;

import static com.github.kagkarlsson.scheduler.task.schedule.Schedules.fixedDelay;

import com.github.kagkarlsson.examples.boot.CounterService;
import com.github.kagkarlsson.examples.boot.ExampleContext;
import com.github.kagkarlsson.scheduler.task.Task;
Expand All @@ -31,6 +29,8 @@
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import static com.github.kagkarlsson.scheduler.task.schedule.Schedules.fixedDelay;

@Configuration
public class BasicExamplesConfiguration {

Expand Down