/*
* Copyright 2010-2013 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 org.killbill.billing.jaxrs.resources;
import java.util.List;
import javax.annotation.Nullable;
import javax.inject.Inject;
import javax.servlet.http.HttpServletRequest;
import javax.ws.rs.DefaultValue;
import javax.ws.rs.GET;
import javax.ws.rs.POST;
import javax.ws.rs.PUT;
import javax.ws.rs.Path;
import javax.ws.rs.Produces;
import javax.ws.rs.QueryParam;
import javax.ws.rs.core.Response;
import javax.ws.rs.core.Response.Status;
import org.joda.time.DateTime;
import org.joda.time.DateTimeZone;
import org.joda.time.LocalDate;
import org.killbill.billing.ObjectType;
import org.killbill.billing.account.api.AccountUserApi;
import org.killbill.billing.jaxrs.util.Context;
import org.killbill.billing.jaxrs.util.JaxrsUriBuilder;
import org.killbill.billing.payment.api.PaymentApi;
import org.killbill.billing.util.api.AuditUserApi;
import org.killbill.billing.util.api.CustomFieldUserApi;
import org.killbill.billing.util.api.RecordIdApi;
import org.killbill.billing.util.api.TagUserApi;
import org.killbill.billing.util.callcontext.TenantContext;
import org.killbill.clock.Clock;
import org.killbill.clock.ClockMock;
import org.killbill.notificationq.api.NotificationQueue;
import org.killbill.notificationq.api.NotificationQueueService;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.google.common.base.Predicate;
import com.google.common.collect.Iterables;
import static javax.ws.rs.core.MediaType.APPLICATION_JSON;
//
// Test endpoint that should not be enabled on a production system.
// The clock manipulation will only work if the ClockMock instance was injected
// throughout the system; if not it will throw 500 (UnsupportedOperationException)
//
// Note that moving the clock back and forth on a running system may cause weird side effects,
// so to be used with great caution.
//
//
@Path(JaxrsResource.PREFIX + "/test")
public class TestResource extends JaxRsResourceBase {
private static final Logger log = LoggerFactory.getLogger(TestResource.class);
private static final int MILLIS_IN_SEC = 1000;
private final NotificationQueueService notificationQueueService;
private final RecordIdApi recordIdApi;
@Inject
public TestResource(final JaxrsUriBuilder uriBuilder, final TagUserApi tagUserApi, final CustomFieldUserApi customFieldUserApi,
final AuditUserApi auditUserApi, final AccountUserApi accountUserApi, final RecordIdApi recordIdApi,
final NotificationQueueService notificationQueueService, final PaymentApi paymentApi,
final Clock clock, final Context context) {
super(uriBuilder, tagUserApi, customFieldUserApi, auditUserApi, accountUserApi, paymentApi, clock, context);
this.notificationQueueService = notificationQueueService;
this.recordIdApi = recordIdApi;
}
public final class ClockResource {
private final DateTime currentUtcTime;
private final String timeZone;
private final LocalDate localDate;
@JsonCreator
public ClockResource(@JsonProperty("currentUtcTime") final DateTime currentUtcTime,
@JsonProperty("timeZone") final String timeZone,
@JsonProperty("localDate") final LocalDate localDate) {
this.currentUtcTime = currentUtcTime;
this.timeZone = timeZone;
this.localDate = localDate;
}
public DateTime getCurrentUtcTime() {
return currentUtcTime;
}
public String getTimeZone() {
return timeZone;
}
public LocalDate getLocalDate() {
return localDate;
}
}
@GET
@Path("/clock")
@Produces(APPLICATION_JSON)
public Response getCurrentTime(@QueryParam("timeZone") final String timeZoneStr) {
final DateTimeZone timeZone = timeZoneStr != null ? DateTimeZone.forID(timeZoneStr) : DateTimeZone.UTC;
final DateTime now = clock.getUTCNow();
final ClockResource result = new ClockResource(now, timeZone.getID(), new LocalDate(now, timeZone));
return Response.status(Status.OK).entity(result).build();
}
@POST
@Path("/clock")
@Produces(APPLICATION_JSON)
public Response setTestClockTime(@QueryParam(QUERY_REQUESTED_DT) final String requestedClockDate,
@QueryParam("timeZone") final String timeZoneStr,
@QueryParam("timeoutSec") @DefaultValue("5") final Long timeoutSec,
@javax.ws.rs.core.Context final HttpServletRequest request) {
final ClockMock testClock = getClockMock();
if (requestedClockDate == null) {
log.info("************ RESETTING CLOCK to " + clock.getUTCNow());
testClock.resetDeltaFromReality();
} else {
final DateTime newTime = DATE_TIME_FORMATTER.parseDateTime(requestedClockDate);
testClock.setTime(newTime);
}
waitForNotificationToComplete(request, timeoutSec);
return getCurrentTime(timeZoneStr);
}
@PUT
@Path("/clock")
@Produces(APPLICATION_JSON)
public Response updateTestClockTime(@QueryParam("days") final Integer addDays,
@QueryParam("weeks") final Integer addWeeks,
@QueryParam("months") final Integer addMonths,
@QueryParam("years") final Integer addYears,
@QueryParam("timeZone") final String timeZoneStr,
@QueryParam("timeoutSec") @DefaultValue("5") final Long timeoutSec,
@javax.ws.rs.core.Context final HttpServletRequest request) {
final ClockMock testClock = getClockMock();
if (addDays != null) {
testClock.addDays(addDays);
} else if (addWeeks != null) {
testClock.addWeeks(addWeeks);
} else if (addMonths != null) {
testClock.addMonths(addMonths);
} else if (addYears != null) {
testClock.addYears(addYears);
}
waitForNotificationToComplete(request, timeoutSec);
return getCurrentTime(timeZoneStr);
}
private void waitForNotificationToComplete(final HttpServletRequest request, final Long timeoutSec) {
final TenantContext tenantContext = context.createContext(request);
final Long tenantRecordId = recordIdApi.getRecordId(tenantContext.getTenantId(), ObjectType.TENANT, tenantContext);
final List<NotificationQueue> queues = notificationQueueService.getNotificationQueues();
int nbTryLeft = timeoutSec != null ? timeoutSec.intValue() : 0;
try {
boolean areAllNotificationsProcessed = false;
while (!areAllNotificationsProcessed && nbTryLeft > 0) {
areAllNotificationsProcessed = areAllNotificationsProcessed(queues, tenantRecordId);
if (!areAllNotificationsProcessed) {
Thread.sleep(MILLIS_IN_SEC);
nbTryLeft--;
}
}
} catch (final InterruptedException ignore) {
}
}
private boolean areAllNotificationsProcessed(final Iterable<NotificationQueue> queues, final Long tenantRecordId) {
final Iterable<NotificationQueue> filtered = Iterables.filter(queues, new Predicate<NotificationQueue>() {
@Override
public boolean apply(@Nullable final NotificationQueue input) {
return input.getFutureNotificationForSearchKey2(tenantRecordId).size() > 0;
}
});
return !filtered.iterator().hasNext();
}
private ClockMock getClockMock() {
if (!(clock instanceof ClockMock)) {
throw new UnsupportedOperationException("Kill Bill has not been configured to update the time");
}
return (ClockMock) clock;
}
}