org.killbill.bus.DefaultPersistentBus Maven / Gradle / Ivy
/*
* Copyright 2010-2013 Ning, Inc.
* Copyright 2015 Groupon, Inc
* Copyright 2015 The Billing Project, LLC
*
* The Billing Project 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.killbill.bus;
import java.lang.reflect.InvocationTargetException;
import java.sql.Connection;
import java.util.ArrayList;
import java.util.LinkedList;
import java.util.List;
import java.util.Properties;
import java.util.concurrent.Executors;
import java.util.concurrent.ThreadFactory;
import java.util.concurrent.atomic.AtomicBoolean;
import javax.annotation.Nullable;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import org.killbill.CreatorName;
import org.killbill.bus.api.BusEvent;
import org.killbill.bus.api.BusEventWithMetadata;
import org.killbill.bus.api.PersistentBus;
import org.killbill.bus.api.PersistentBusConfig;
import org.killbill.bus.dao.BusEventModelDao;
import org.killbill.bus.dao.PersistentBusSqlDao;
import org.killbill.clock.Clock;
import org.killbill.clock.DefaultClock;
import org.killbill.commons.jdbi.notification.DatabaseTransactionNotificationApi;
import org.killbill.queue.DBBackedQueue;
import org.killbill.queue.DefaultQueueLifecycle;
import org.killbill.queue.InTransaction;
import org.killbill.queue.api.PersistentQueueEntryLifecycleState;
import org.skife.config.ConfigurationObjectFactory;
import org.skife.jdbi.v2.IDBI;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.codahale.metrics.MetricRegistry;
import com.codahale.metrics.Timer;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.google.common.collect.ImmutableMap;
import com.google.common.eventbus.EventBusThatThrowsException;
public class DefaultPersistentBus extends DefaultQueueLifecycle implements PersistentBus {
private static final Logger log = LoggerFactory.getLogger(DefaultPersistentBus.class);
private final EventBusDelegate eventBusDelegate;
private final DBBackedQueue dao;
private final Clock clock;
final Timer dispatchTimer;
private AtomicBoolean isStarted;
private static final class EventBusDelegate extends EventBusThatThrowsException {
public EventBusDelegate(final String busName) {
super(busName);
}
}
@Inject
public DefaultPersistentBus(@Named(QUEUE_NAME) final IDBI dbi, final Clock clock, final PersistentBusConfig config, final MetricRegistry metricRegistry, final DatabaseTransactionNotificationApi databaseTransactionNotificationApi) {
super("Bus", Executors.newFixedThreadPool(config.getNbThreads(), new ThreadFactory() {
@Override
public Thread newThread(final Runnable r) {
return new Thread(new ThreadGroup(EVENT_BUS_GROUP_NAME),
r,
config.getTableName() + "-th");
}
}), config.getNbThreads(), config);
final PersistentBusSqlDao sqlDao = dbi.onDemand(PersistentBusSqlDao.class);
this.clock = clock;
final String dbBackedQId = "bus-" + config.getTableName();
this.dao = new DBBackedQueue(clock, sqlDao, config, dbBackedQId, metricRegistry, databaseTransactionNotificationApi);
this.eventBusDelegate = new EventBusDelegate("Killbill EventBus");
this.dispatchTimer = metricRegistry.timer(MetricRegistry.name(DefaultPersistentBus.class, "dispatch"));
this.isStarted = new AtomicBoolean(false);
}
public DefaultPersistentBus(final DataSource dataSource, final Properties properties) {
this(InTransaction.buildDDBI(dataSource), new DefaultClock(), new ConfigurationObjectFactory(properties).buildWithReplacements(PersistentBusConfig.class, ImmutableMap.of("instanceName", "main")),
new MetricRegistry(), new DatabaseTransactionNotificationApi());
}
@Override
public void start() {
if (isStarted.compareAndSet(false, true)) {
dao.initialize();
startQueue();
}
}
@Override
public void stop() {
if (isStarted.compareAndSet(true, false)) {
stopQueue();
}
}
@Override
public int doProcessEvents() {
final List events = dao.getReadyEntries();
if (events.size() == 0) {
return 0;
}
int result = 0;
final List historyEvents = new ArrayList();
for (final BusEventModelDao cur : events) {
final BusEvent evt = deserializeEvent(cur.getClassName(), objectMapper, cur.getEventJson());
result++;
long errorCount = cur.getErrorCount();
Throwable lastException = null;
final Timer.Context dispatchTimerContext = dispatchTimer.time();
try {
eventBusDelegate.postWithException(evt);
} catch (final com.google.common.eventbus.EventBusException e) {
if (e.getCause() != null && e.getCause() instanceof InvocationTargetException) {
lastException = e.getCause().getCause();
} else {
lastException = e;
}
errorCount++;
} finally {
dispatchTimerContext.stop();
if (lastException == null) {
final BusEventModelDao processedEntry = new BusEventModelDao(cur, CreatorName.get(), clock.getUTCNow(), PersistentQueueEntryLifecycleState.PROCESSED);
historyEvents.add(processedEntry);
} else if (errorCount <= config.getMaxFailureRetries()) {
log.info("Bus dispatch error, will attempt a retry ", lastException);
// STEPH we could batch those as well
final BusEventModelDao retriedEntry = new BusEventModelDao(cur, CreatorName.get(), clock.getUTCNow(), PersistentQueueEntryLifecycleState.AVAILABLE, errorCount);
dao.updateOnError(retriedEntry);
} else {
log.error("Fatal Bus dispatch error, data corruption...", lastException);
final BusEventModelDao processedEntry = new BusEventModelDao(cur, CreatorName.get(), clock.getUTCNow(), PersistentQueueEntryLifecycleState.FAILED);
historyEvents.add(processedEntry);
}
}
}
dao.moveEntriesToHistory(historyEvents);
return result;
}
@Override
public boolean isStarted() {
return isStarted.get();
}
@Override
public void register(final Object handlerInstance) throws EventBusException {
if (isStarted.get()) {
eventBusDelegate.register(handlerInstance);
} else {
log.warn("Attempting to register handler " + handlerInstance + " in a non initialized bus");
}
}
@Override
public void unregister(final Object handlerInstance) throws EventBusException {
if (isStarted.get()) {
eventBusDelegate.unregister(handlerInstance);
} else {
log.warn("Attempting to unregister handler " + handlerInstance + " in a non initialized bus");
}
}
@Override
public void post(final BusEvent event) throws EventBusException {
try {
if (isStarted.get()) {
final String json = objectMapper.writeValueAsString(event);
final BusEventModelDao entry = new BusEventModelDao(CreatorName.get(), clock.getUTCNow(), event.getClass().getName(), json,
event.getUserToken(), event.getSearchKey1(), event.getSearchKey2());
dao.insertEntry(entry);
} else {
log.warn("Attempting to post event " + event + " in a non initialized bus");
}
} catch (final Exception e) {
log.error("Failed to post BusEvent " + event, e);
}
}
@Override
public void postFromTransaction(final BusEvent event, final Connection connection) throws EventBusException {
if (!isStarted.get()) {
log.warn("Attempting to post event " + event + " in a non initialized bus");
return;
}
final String json;
try {
json = objectMapper.writeValueAsString(event);
} catch (final JsonProcessingException e) {
log.warn("Unable to serialize event " + event, e);
return;
}
final BusEventModelDao entry = new BusEventModelDao(CreatorName.get(),
clock.getUTCNow(),
event.getClass().getName(),
json,
event.getUserToken(),
event.getSearchKey1(),
event.getSearchKey2());
final InTransaction.InTransactionHandler handler = new InTransaction.InTransactionHandler() {
@Override
public Void withSqlDao(final PersistentBusSqlDao transactional) throws Exception {
dao.insertEntryFromTransaction(transactional, entry);
return null;
}
};
InTransaction.execute(connection, handler, PersistentBusSqlDao.class);
}
@Override
public List> getAvailableBusEventsForSearchKeys(final Long searchKey1, final Long searchKey2) {
return getAvailableBusEventsForSearchKeysInternal((PersistentBusSqlDao) dao.getSqlDao(), searchKey1, searchKey2);
}
@Override
public List> getAvailableBusEventsFromTransactionForSearchKeys(final Long searchKey1, final Long searchKey2, final Connection connection) {
final InTransaction.InTransactionHandler>> handler = new InTransaction.InTransactionHandler>>() {
@Override
public List> withSqlDao(final PersistentBusSqlDao transactional) throws Exception {
return getAvailableBusEventsForSearchKeysInternal(transactional, searchKey1, searchKey2);
}
};
return InTransaction.execute(connection, handler, PersistentBusSqlDao.class);
}
@Override
public List> getAvailableBusEventsForSearchKey2(final Long searchKey2) {
return getAvailableBusEventsForSearchKeysInternal((PersistentBusSqlDao) dao.getSqlDao(), null, searchKey2);
}
@Override
public List> getAvailableBusEventsFromTransactionForSearchKey2(final Long searchKey2, final Connection connection) {
final InTransaction.InTransactionHandler>> handler = new InTransaction.InTransactionHandler>>() {
@Override
public List> withSqlDao(final PersistentBusSqlDao transactional) throws Exception {
return getAvailableBusEventsForSearchKeysInternal(transactional, null, searchKey2);
}
};
return InTransaction.execute(connection, handler, PersistentBusSqlDao.class);
}
@Override
public List> getInProcessingBusEvents() {
return toBusEventWithMetadataList(dao.getSqlDao().getInProcessingEntries(config.getTableName()));
}
@Override
public List> getAvailableOrInProcessingBusEventsForSearchKeys(final Long searchKey1, final Long searchKey2) {
return getAvailableOrInProcessingBusEventsForSearchKeysInternal((PersistentBusSqlDao) dao.getSqlDao(), searchKey1, searchKey2);
}
@Override
public List> getAvailableOrInProcessingBusEventsFromTransactionForSearchKeys(final Long searchKey1, final Long searchKey2, final Connection connection) {
final InTransaction.InTransactionHandler>> handler = new InTransaction.InTransactionHandler>>() {
@Override
public List> withSqlDao(final PersistentBusSqlDao transactional) throws Exception {
return getAvailableOrInProcessingBusEventsForSearchKeysInternal(transactional, searchKey1, searchKey2);
}
};
return InTransaction.execute(connection, handler, PersistentBusSqlDao.class);
}
@Override
public List> getAvailableOrInProcessingBusEventsForSearchKey2(final Long searchKey2) {
return getAvailableOrInProcessingBusEventsForSearchKeysInternal((PersistentBusSqlDao) dao.getSqlDao(), null, searchKey2);
}
@Override
public List> getAvailableOrInProcessingBusEventsFromTransactionForSearchKey2(final Long searchKey2, final Connection connection) {
final InTransaction.InTransactionHandler>> handler = new InTransaction.InTransactionHandler>>() {
@Override
public List> withSqlDao(final PersistentBusSqlDao transactional) throws Exception {
return getAvailableOrInProcessingBusEventsForSearchKeysInternal(transactional, null, searchKey2);
}
};
return InTransaction.execute(connection, handler, PersistentBusSqlDao.class);
}
private List> getAvailableBusEventsForSearchKeysInternal(final PersistentBusSqlDao transactionalDao, @Nullable final Long searchKey1, final Long searchKey2) {
final List entries = searchKey1 != null ?
transactionalDao.getReadyQueueEntriesForSearchKeys(searchKey1, searchKey2, config.getTableName()) :
transactionalDao.getReadyQueueEntriesForSearchKey2(searchKey2, config.getTableName());
return toBusEventWithMetadataList(entries);
}
private List> getAvailableOrInProcessingBusEventsForSearchKeysInternal(final PersistentBusSqlDao transactionalDao, @Nullable final Long searchKey1, final Long searchKey2) {
final List entries = searchKey1 != null ?
transactionalDao.getReadyOrInProcessingQueueEntriesForSearchKeys(searchKey1, searchKey2, config.getTableName()) :
transactionalDao.getReadyOrInProcessingQueueEntriesForSearchKey2(searchKey2, config.getTableName());
return toBusEventWithMetadataList(entries);
}
private List> toBusEventWithMetadataList(final List entries) {
final List> result = new LinkedList>();
for (final BusEventModelDao entry : entries) {
final T event = (T) deserializeEvent(entry.getClassName(), objectMapper, entry.getEventJson());
final BusEventWithMetadata eventWithMetadata = new BusEventWithMetadata(entry.getRecordId(),
entry.getUserToken(),
entry.getCreatedDate(),
entry.getSearchKey1(),
entry.getSearchKey2(),
event);
result.add(eventWithMetadata);
}
return result;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy