PersistentBus.java

301 lines | 11.247 kB Blame History Raw Download
/* 
 * Copyright 2010-2011 Ning, Inc.
 *
 * Ning 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 com.ning.billing.util.bus;


import java.util.Collections;
import java.util.Date;
import java.util.List;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.ThreadFactory;
import java.util.concurrent.TimeUnit;

import org.codehaus.jackson.map.ObjectMapper;
import org.codehaus.jackson.map.SerializationConfig;
import org.skife.jdbi.v2.IDBI;
import org.skife.jdbi.v2.Transaction;
import org.skife.jdbi.v2.TransactionStatus;
import org.skife.jdbi.v2.sqlobject.mixins.Transmogrifier;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.google.common.eventbus.EventBus;
import com.google.inject.Inject;
import com.ning.billing.util.Hostname;
import com.ning.billing.util.bus.dao.BusEventEntry;
import com.ning.billing.util.bus.dao.PersistentBusSqlDao;
import com.ning.billing.util.clock.Clock;


public class PersistentBus implements Bus  {

    private final static int NB_BUS_THREADS = 3;
    private final static long TIMEOUT_MSEC = 15L * 1000L; // 15 sec
    private final static long DELTA_IN_PROCESSING_TIME_MS = 1000L * 60L * 5L; // 5 minutes
    private final static long SLEEP_TIME_MS = 1000; // 1 sec
    private final static int MAX_BUS_EVENTS = 1;
    
    private static final Logger log = LoggerFactory.getLogger(PersistentBus.class);
    
    private final PersistentBusSqlDao dao;
    private final ExecutorService executor;
    
    private final ObjectMapper objectMapper;
    private final EventBusDelegate eventBusDelegate;
    private final Clock clock;
    private final String hostname;
    
    protected boolean isProcessingEvents;
    private int curActiveThreads;
    
    
    private static final class EventBusDelegate extends EventBus {
        public EventBusDelegate(String busName) {
            super(busName);
        }

        // STEPH we can't override the method because EventHandler is package private scope
        // Logged a bug against guava (Issue 981)
        /*
        @Override
        protected void dispatch(Object event, EventHandler wrapper) {
            try {
              wrapper.handleEvent(event);
            } catch (InvocationTargetException e) {
              logger.log(Level.SEVERE,
                  "Could not dispatch event: " + event + " to handler " + wrapper, e);
            }
          }
          */
    }
    
    @Inject
    public PersistentBus(final IDBI dbi, final Clock clock) {
        this.dao = dbi.onDemand(PersistentBusSqlDao.class);
        this.clock = clock;
        this.objectMapper = new ObjectMapper();
        this.objectMapper.disable(SerializationConfig.Feature.WRITE_DATES_AS_TIMESTAMPS);
        this.eventBusDelegate = new EventBusDelegate("Killbill EventBus");
        final ThreadGroup group = new ThreadGroup(DefaultBusService.EVENT_BUS_GROUP_NAME);
        this.executor = Executors.newFixedThreadPool(NB_BUS_THREADS, new ThreadFactory() {
            @Override
            public Thread newThread(Runnable r) {
                return new Thread(group, r, DefaultBusService.EVENT_BUS_TH_NAME);
            }
        });
        this.hostname = Hostname.get();
        this.isProcessingEvents = false;
    }

    
    @Override
    public void start() {
        
        isProcessingEvents = true;
        curActiveThreads = 0;
        
        final PersistentBus thePersistentBus = this;
        final CountDownLatch doneInitialization = new CountDownLatch(NB_BUS_THREADS);

        log.info("Starting Persistent BUS with {} threads, countDownLatch = {}", NB_BUS_THREADS, doneInitialization.getCount());
        
        for (int i = 0; i < NB_BUS_THREADS; i++) {
            executor.execute(new Runnable() {
                @Override
                public void run() {

                    log.info(String.format("PersistentBus thread %s [%d] started",
                            Thread.currentThread().getName(),
                            Thread.currentThread().getId()));
                    
                    synchronized(thePersistentBus) {
                        curActiveThreads++;
                    }

                    doneInitialization.countDown();
                    
                    try {
                        while (true) {
                            
                            synchronized(thePersistentBus) {
                                if (!isProcessingEvents) {
                                    thePersistentBus.notify();
                                    break;
                                }
                            }

                            try {
                                doProcessEvents();
                            } catch (Exception e) {
                                log.error(String.format("PersistentBus thread  %s  [%d] got an exception..",
                                        Thread.currentThread().getName(),
                                        Thread.currentThread().getId()), e);
                            }
                            sleepALittle();
                        }
                    } catch (InterruptedException e) {
                        log.info(Thread.currentThread().getName() + " got interrupted, exting...");
                    } catch (Throwable e) {
                        log.error(Thread.currentThread().getName() + " got an exception exiting...", e);
                        // Just to make it really obvious in the log
                        e.printStackTrace();
                    } finally {
                        
                        log.info(String.format("PersistentBus thread %s [%d] exited",
                                Thread.currentThread().getName(),
                                Thread.currentThread().getId()));
                    
                        synchronized(thePersistentBus) {
                            curActiveThreads--;
                        }
                    }
                }
                
                private void sleepALittle() throws InterruptedException {
                    Thread.sleep(SLEEP_TIME_MS);
                }
            });
        }
        try {
            boolean success = doneInitialization.await(TIMEOUT_MSEC, TimeUnit.MILLISECONDS);
            if (!success) {
                log.warn("Failed to wait for all threads to be started, got {}/{}", doneInitialization.getCount(), NB_BUS_THREADS);
            } else {
                log.info("Done waiting for all threads to be started, got {}/{}", doneInitialization.getCount(), NB_BUS_THREADS);
            }
        } catch (InterruptedException e) {
            log.warn("PersistentBus start sequence got interrupted...");
        }
    }
    
    
    private BusEvent deserializeBusEvent(final String className, final String json) {
        try {
            Class<?> claz = Class.forName(className);
            return (BusEvent) objectMapper.readValue(json, claz);
        } catch (Exception e) {
            log.error(String.format("Failed to deserialize json object %s for class %s", json, className), e);
            return null;
        }
    }
    
    private int doProcessEvents() {

        List<BusEventEntry> events = getNextBusEvent();
        if (events.size() == 0) {
            return 0;
        }

        int result = 0;
        for (final BusEventEntry cur : events) {
            BusEvent evt = deserializeBusEvent(cur.getBusEventClass(), cur.getBusEventJson());
            result++;
            // STEPH exception handling is done by GUAVA-- logged a bug Issue-780
            eventBusDelegate.post(evt);
            dao.clearBusEvent(cur.getId(), hostname);
        }
        return result;
    }

    
    private List<BusEventEntry> getNextBusEvent() {

        final Date now = clock.getUTCNow().toDate();
        final Date nextAvailable = clock.getUTCNow().plus(DELTA_IN_PROCESSING_TIME_MS).toDate();

        BusEventEntry input = dao.getNextBusEventEntry(MAX_BUS_EVENTS, now);
        if (input == null) {
            return Collections.emptyList();
        }
        
        final boolean claimed = (dao.claimBusEvent(hostname, nextAvailable, input.getId(), now) == 1);
        if (claimed) {
            dao.insertClaimedHistory(hostname, now, input.getId());
            return Collections.singletonList(input);
        }
        return Collections.emptyList();
    }


    @Override
    public void stop() {
        int remaining = 0;
        try {
            synchronized(this) {
                isProcessingEvents = false;
                long ini = System.currentTimeMillis();
                long remainingWaitTimeMs = TIMEOUT_MSEC;
                while (curActiveThreads > 0 && remainingWaitTimeMs > 0) {
                    wait(1000);
                    remainingWaitTimeMs = TIMEOUT_MSEC - (System.currentTimeMillis() - ini);
                }
                remaining = curActiveThreads;
            }
            
        } catch (InterruptedException ignore) {
            log.info("PersistentBus has been interrupted during stop sequence");
        } finally {
            if (remaining > 0) {
                log.error(String.format("PersistentBus stopped with %d active remaing threads", remaining));
            } else {
                log.info("PersistentBus completed sucesfully shutdown sequence");
            }
            curActiveThreads = 0;
        }
    }

    @Override
    public void register(Object handlerInstance) throws EventBusException {
        eventBusDelegate.register(handlerInstance);
    }

    @Override
    public void unregister(Object handlerInstance) throws EventBusException {
        eventBusDelegate.unregister(handlerInstance);
    }

    @Override
    public void post(final BusEvent event) throws EventBusException {
        dao.inTransaction(new Transaction<Void, PersistentBusSqlDao>() {
            @Override
            public Void inTransaction(PersistentBusSqlDao transactional,
                    TransactionStatus status) throws Exception {
                postFromTransaction(event, transactional);
                return null;
            }
        });
    }

    @Override
    public void postFromTransaction(final BusEvent event, Transmogrifier transmogrifier)
            throws EventBusException {
        PersistentBusSqlDao transactional = transmogrifier.become(PersistentBusSqlDao.class);
        postFromTransaction(event, transactional);
    }
    
    private void postFromTransaction(BusEvent event, PersistentBusSqlDao transactional) {
        try {
            String json = objectMapper.writeValueAsString(event);
            BusEventEntry entry  =  new BusEventEntry(event.getClass().getName(), json);
            transactional.insertBusEvent(entry);
        } catch (Exception e) {
            log.error("Failed to post BusEvent " + event.toString(), e);
        }
    }
}