package service
package user
-import gr.grnet.aquarium.AquariumInternalError
+import gr.grnet.aquarium.{Real, AquariumInternalError}
import gr.grnet.aquarium.actor.message.GetUserBalanceRequest
import gr.grnet.aquarium.actor.message.GetUserBalanceResponse
import gr.grnet.aquarium.actor.message.GetUserBalanceResponseData
import gr.grnet.aquarium.actor.message.GetUserWalletResponse
import gr.grnet.aquarium.actor.message.GetUserWalletResponseData
import gr.grnet.aquarium.actor.message.config.AquariumPropertiesLoaded
-import gr.grnet.aquarium.charging.bill.AbstractBillEntry
-import gr.grnet.aquarium.charging.state.{UserStateModel, UserAgreementHistoryModel, UserStateBootstrap}
-import gr.grnet.aquarium.computation.BillingMonthInfo
-import gr.grnet.aquarium.message.avro.gen.{IMEventMsg, ResourceEventMsg, UserStateMsg}
-import gr.grnet.aquarium.message.avro.{ModelFactory, MessageFactory, MessageHelpers, AvroHelpers}
+import gr.grnet.aquarium.charging.state.UserStateModel
+import gr.grnet.aquarium.message.avro.gen.{UserAgreementHistoryMsg, IMEventMsg, ResourceEventMsg}
+import gr.grnet.aquarium.message.avro.{ModelFactory, MessageFactory, MessageHelpers}
import gr.grnet.aquarium.service.event.BalanceEvent
import gr.grnet.aquarium.util.date.TimeHelpers
import gr.grnet.aquarium.util.{LogHelpers, shortClassNameOf}
import gr.grnet.aquarium.policy.{ResourceType, PolicyModel}
+import gr.grnet.aquarium.charging.bill.BillEntryMsg
/**
*
*/
class UserActor extends ReflectiveRoleableActor {
- private[this] var _rcMsgCount = 0
private[this] var _imMsgCount = 0
- private[this] var _userID: String = "<?>"
- private[this] var _userState: UserStateModel = _
- private[this] var _userCreationIMEvent: IMEventMsg = _
- private[this] var _userAgreementHistoryModel: UserAgreementHistoryModel = _
- private[this] var _latestIMEventOriginalID: String = ""
- private[this] var _latestIMEventOccurredMillis: Long = -1L
- private[this] var _latestResourceEventOriginalID: String = ""
- private[this] var _userStateBootstrap: UserStateBootstrap = _
-
- def unsafeUserID = {
- if(!haveUserID) {
+ private[this] var _userStateModel: UserStateModel = _
+
+ def userID = {
+ if(!haveUserState) {
throw new AquariumInternalError("%s not initialized")
}
- this._userID
+ this._userStateModel.userID
}
override def postStop() {
}
private[this] def shutmedown(): Unit = {
- if(haveUserID) {
+ if(haveUserState) {
aquarium.akkaService.invalidateUserActor(this)
}
}
private[this] def chargingService = aquarium.chargingService
- private[this] def stdUserStateStoreFunc = (userState: UserStateMsg) ⇒ {
- aquarium.userStateStore.insertUserState(userState)
- }
-
- @inline private[this] def haveUserID = {
- this._userID ne null
- }
-
def onAquariumPropertiesLoaded(event: AquariumPropertiesLoaded): Unit = {
}
- @inline private[this] def haveAgreements = {
- (this._userAgreementHistoryModel ne null) && this._userAgreementHistoryModel.size > 0
- }
-
- @inline private[this] def haveUserState = {
- this._userState ne null
+ private[this] def unsafeUserCreationIMEventMsg = {
+ this._userStateModel.unsafeUserCreationIMEvent
}
- @inline private[this] def haveUserStateBootstrap = {
- this._userStateBootstrap ne null
+ private[this] def haveAgreements = {
+ (this._userStateModel ne null)
}
- private[this] def createUserAgreementHistoryModel(imEvent: IMEventMsg) {
- assert(MessageHelpers.isIMEventCreate(imEvent))
- assert(this._userAgreementHistoryModel eq null)
- assert(this._userCreationIMEvent eq null)
-
- this._userCreationIMEvent = imEvent
- this._userAgreementHistoryModel = ModelFactory.newUserAgreementHistoryModelFromIMEvent(
- imEvent,
- imEvent.getOriginalID
- )
+ private[this] def haveUserCreationEvent = {
+ haveAgreements &&
+ this._userStateModel.hasUserCreationEvent
}
- private[this] def updateAgreementHistoryFrom(imEvent: IMEventMsg): Unit = {
- val isCreateUser = MessageHelpers.isIMEventCreate(imEvent)
- if(isCreateUser) {
- if(haveAgreements) {
- throw new AquariumInternalError(
- "Got user creation event (id=%s) but I already have one (id=%s)",
- this._userCreationIMEvent.getOriginalID,
- imEvent.getOriginalID
- )
- }
-
- createUserAgreementHistoryModel(imEvent) // now we have an agreement history
- createUserStateBootstrap(imEvent)
- }
-
- val effectiveFromMillis = imEvent.getOccurredMillis
- val role = imEvent.getRole
- // calling unsafe just for the side-effect
- assert(null ne aquarium.unsafeFullPriceTableForRoleAt(role, effectiveFromMillis))
-
- // add to model (will update the underlying messages as well)
- val newUserAgreementModel = ModelFactory.newUserAgreementModelFromIMEvent(imEvent, imEvent.getOriginalID)
- this._userAgreementHistoryModel += newUserAgreementModel
-
- // We assume that we always call this method with in-sync events
- assert(imEvent.getOccurredMillis >= this._latestIMEventOccurredMillis)
- updateLatestIMEventStateFrom(imEvent)
+ private[this] def haveUserState = {
+ (this._userStateModel ne null)
}
-// private[this] def updateLatestIMEventIDFrom(imEvent: IMEventMsg): Unit = {
-// this._latestIMEventOriginalID = imEvent.getOriginalID
-// }
-
- private[this] def updateLatestIMEventStateFrom(imEvent: IMEventMsg) {
- this._latestIMEventOriginalID = imEvent.getOriginalID
- this._latestIMEventOccurredMillis = imEvent.getOccurredMillis
- this._imMsgCount += 1
- }
-
- private[this] def updateLatestResourceEventIDFrom(rcEvent: ResourceEventMsg): Unit = {
- this._latestResourceEventOriginalID = rcEvent.getOriginalID
- }
+ private[this] def isInitial = this._userStateModel.isInitial
/**
- * Creates the initial state that is related to IMEvents.
+ * Creates the agreement history from all the stored IMEvents.
*
- * @return `true` if there was a user CREATE event
+ * @return (`true` iff there was a user CREATE event, the number of events processed)
*/
- private[this] def initializeStateOfIMEvents(): Boolean = {
- DEBUG("initializeStateOfIMEvents()")
+ private[this] def createUserAgreementHistoryFromIMEvents(userID: String): (Boolean, Int) = {
+ DEBUG("createUserAgreementHistoryFromStoredIMEvents()")
+ assert(haveUserState, "haveUserState")
+
- // NOTE: this._userID is already set up our caller
var _imcounter = 0
- aquarium.imEventStore.foreachIMEventInOccurrenceOrder(this._userID) { imEvent ⇒
+ val hadCreateEvent = aquarium.imEventStore.foreachIMEventInOccurrenceOrder(userID) { imEvent ⇒
_imcounter += 1
- DEBUG("Replaying [%s] %s", _imcounter, imEvent)
+ DEBUG("Replaying [%s/%s] %s", shortClassNameOf(imEvent), _imcounter, imEvent)
if(_imcounter == 1 && !MessageHelpers.isIMEventCreate(imEvent)) {
// The very first event must be a CREATE event. Otherwise we abort initialization.
false
}
else {
- updateAgreementHistoryFrom(imEvent)
+ val effectiveFromMillis = imEvent.getOccurredMillis
+ val role = imEvent.getRole
+ // calling unsafe just for the side-effect
+ assert(
+ aquarium.unsafeFullPriceTableForRoleAt(role, effectiveFromMillis) ne null,
+ "aquarium.unsafeFullPriceTableForRoleAt(%s, %s) ne null".format(role, effectiveFromMillis)
+ )
+
+ this._userStateModel.insertUserAgreementMsgFromIMEvent(imEvent)
true
}
}
+
+ this._imMsgCount = _imcounter
+
+ DEBUG("Agreements: %s", this._userStateModel.userAgreementHistoryMsg)
+ (hadCreateEvent, _imcounter)
}
- private[this] def loadUserStateAndUpdateAgreementHistory(): Unit = {
- assert(this.haveAgreements, "this.haveAgreements")
+ private[this] def saveFirstUserState(userID: String) {
+ this._userStateModel.userStateMsg.setIsFirst(true)
+ this._userStateModel.updateUserStateMsg(
+ aquarium.userStateStore.insertUserState(this._userStateModel.userStateMsg)
+ )
+ }
- if(!haveUserStateBootstrap) {
- this._userStateBootstrap = aquarium.getUserStateBootstrap(this._userCreationIMEvent)
- }
- logger.debug("#### this._userStateBootStrap %s".format(this._userStateBootstrap.toString))
- val now = TimeHelpers.nowMillis()
- this._userState = chargingService.replayMonthChargingUpTo(
- BillingMonthInfo.fromMillis(now),
- now,
- this._userStateBootstrap,
- aquarium.currentResourceTypesMap,
- aquarium.userStateStore.insertUserState
+ private[this] def saveSubsequentUserState() {
+ this._userStateModel.userStateMsg.setIsFirst(false)
+ this._userStateModel.updateUserStateMsg(
+ aquarium.userStateStore.insertUserState(this._userStateModel.userStateMsg)
)
+ }
- // Final touch: Update agreement history in the working user state.
- // The assumption is that all agreement changes go via IMEvents, so the
- // state this._workingAgreementHistory is always the authoritative source.
- if(haveUserState) {
- this._userState.userAgreementHistoryModel = this._userAgreementHistoryModel
- DEBUG("Computed working user state %s", AvroHelpers.jsonStringOfSpecificRecord(this._userState.msg))
+ private[this] def loadLastKnownUserStateAndUpdateAgreements(historyMsg: UserAgreementHistoryMsg) {
+ val userID = historyMsg.getUserID
+ val latestUserStateOpt = aquarium.userStateStore.findLatestUserState(userID)
+ latestUserStateOpt match {
+ case None ⇒
+ // First user state ever
+ saveFirstUserState(userID)
+
+ case Some(latestUserState) ⇒
+ this._userStateModel.updateUserStateMsg(latestUserState)
+ this._userStateModel.updateUserAgreementHistoryMsg(historyMsg)
}
}
- private[this] def initializeStateOfResourceEvents(): Unit = {
- DEBUG("initializeStateOfResourceEvents()")
- assert(haveAgreements)
-
- // We will also need this functionality when receiving IMEvents, so we place it in a method
- loadUserStateAndUpdateAgreementHistory()
-
- if(haveUserState) {
- DEBUG("Initial working user state %s", AvroHelpers.jsonStringOfSpecificRecord(this._userState.msg))
- logSeparator()
+ private[this] def checkInitial(nextThing: () ⇒ Any = () ⇒ {}): Boolean = {
+ if(!isInitial) {
+ return false
}
- }
- /**
- * Initializes the actor state from DB.
- */
- def initializeUserActorState(userID: String): Boolean = {
- this._userID = userID
+ val (userCreated, imEventsCount) = createUserAgreementHistoryFromIMEvents(userID)
- if(initializeStateOfIMEvents()) {
- initializeStateOfResourceEvents()
- // Even if we have no resource events, the user is at least CREATEd
- true
- }
- else {
- false
+ if(userCreated) {
+ loadLastKnownUserStateAndUpdateAgreements(this._userStateModel.userAgreementHistoryMsg)
}
- }
- def createUserStateBootstrap(imEvent: IMEventMsg) {
- assert(MessageHelpers.isIMEventCreate(imEvent), "MessageHelpers.isIMEventCreate(imEvent)")
- assert(this._userCreationIMEvent == imEvent, "this._userCreationIMEvent == imEvent")
+ nextThing()
- this._userStateBootstrap = aquarium.getUserStateBootstrap(this._userCreationIMEvent)
+ true
}
/**
* messaging hub (rabbitmq).
*/
def onIMEventMsg(imEvent: IMEventMsg) {
- if(!haveAgreements) {
- // If we have no agreements so far, then it does not matter what kind of event
- // this is. So we replay the log (ehm.. store)
- initializeUserActorState(imEvent.getUserID)
-
+ if(checkInitial()) {
return
}
// Check for out of sync (regarding IMEvents)
- val isOutOfSyncIM = imEvent.getOccurredMillis < this._latestIMEventOccurredMillis
+ val isOutOfSyncIM = imEvent.getOccurredMillis < this._userStateModel.latestIMEventOccurredMillis
if(isOutOfSyncIM) {
// clear all resource state
// FIXME implement
return
}
- // OK, seems good
- assert(!MessageHelpers.isIMEventCreate(imEvent), "!MessageHelpers.isIMEventCreate(imEvent)")
- updateAgreementHistoryFrom(imEvent)
+ // Make new agreement
+ this._userStateModel.insertUserAgreementMsgFromIMEvent(imEvent)
+ this._imMsgCount += 1
+
+ if(haveUserCreationEvent) {
+ loadLastKnownUserStateAndUpdateAgreements(this._userStateModel.userAgreementHistoryMsg)
+ }
+
+ DEBUG("Agreements: %s", this._userStateModel.userAgreementHistoryMsg)
}
def onResourceEventMsg(rcEvent: ResourceEventMsg) {
- if(!haveAgreements) {
- DEBUG("No agreement. Ignoring %s", rcEvent)
-
+ if(checkInitial()) {
return
}
- val now = TimeHelpers.nowMillis()
- // TODO: Review this and its usage in user state.
- // TODO: The assumption is that the resource set increases all the time,
- // TODO: so the current map contains everything ever known (assuming we do not run backwards in time).
- val currentResourcesMap = aquarium.currentResourceTypesMap
-
- val nowBillingMonthInfo = BillingMonthInfo.fromMillis(now)
- val nowYear = nowBillingMonthInfo.year
- val nowMonth = nowBillingMonthInfo.month
-
- val eventOccurredMillis = rcEvent.getOccurredMillis
- val eventBillingMonthInfo = BillingMonthInfo.fromMillis(eventOccurredMillis)
- val eventYear = eventBillingMonthInfo.year
- val eventMonth = eventBillingMonthInfo.month
-
- def computeBatch(): Unit = {
- DEBUG("Going for out of sync charging for %s", rcEvent.getOriginalID)
- this._userState = chargingService.replayMonthChargingUpTo(
- nowBillingMonthInfo,
- // Take into account that the event may be out-of-sync.
- // TODO: Should we use this._latestResourceEventOccurredMillis instead of now?
- now max eventOccurredMillis,
- this._userStateBootstrap,
- currentResourcesMap,
- stdUserStateStoreFunc
- )
-
- updateLatestResourceEventIDFrom(rcEvent)
+ if(!haveUserCreationEvent) {
+ DEBUG("No agreements. Ignoring %s", rcEvent)
+
+ return
}
- def computeRealtime(): Unit = {
- DEBUG("Going for in sync charging for %s", rcEvent.getOriginalID)
- chargingService.processResourceEvent(
- rcEvent,
- this._userState,
- nowBillingMonthInfo,
- true
- )
+ assert(haveUserState, "haveUserState")
- updateLatestResourceEventIDFrom(rcEvent)
- }
+ val oldTotalCredits = this._userStateModel.totalCreditsAsReal
- val oldTotalCredits =
- if(this._userState!=null)
- this._userState.totalCredits
- else
- 0.0D
- // FIXME check these
- if(this._userState eq null) {
- computeBatch()
- }
- else if(nowYear != eventYear || nowMonth != eventMonth) {
- DEBUG(
- "nowYear(%s) != eventYear(%s) || nowMonth(%s) != eventMonth(%s)",
- nowYear, eventYear,
- nowMonth, eventMonth
- )
- computeBatch()
- }
- else if(this._userState.latestResourceEventOccurredMillis < rcEvent.getOccurredMillis) {
- DEBUG("this._workingUserState.latestResourceEventOccurredMillis < rcEvent.occurredMillis")
- DEBUG(
- "%s < %s",
- TimeHelpers.toYYYYMMDDHHMMSSSSS(this._userState.latestResourceEventOccurredMillis),
- TimeHelpers.toYYYYMMDDHHMMSSSSS(rcEvent.getOccurredMillis)
- )
- computeRealtime()
- }
- else {
- DEBUG("OUT OF ORDER! this._workingUserState.latestResourceEventOccurredMillis=%s and rcEvent.occurredMillis=%s",
- TimeHelpers.toYYYYMMDDHHMMSSSSS(this._userState.latestResourceEventOccurredMillis),
- TimeHelpers.toYYYYMMDDHHMMSSSSS(rcEvent.getOccurredMillis))
+ chargingService.processResourceEvent(
+ rcEvent.getReceivedMillis,
+ rcEvent,
+ this._userStateModel,
+ aquarium.currentResourceMapping,
+ true
+ )
+
+ val newTotalCredits = this._userStateModel.totalCreditsAsReal
- computeBatch()
+ if(oldTotalCredits.signum * newTotalCredits.signum < 0) {
+ aquarium.eventBus ! new BalanceEvent(userID, newTotalCredits >= 0)
}
- val newTotalCredits = this._userState.totalCredits
- if(oldTotalCredits * newTotalCredits < 0)
- aquarium.eventBus ! new BalanceEvent(this._userState.userID,
- newTotalCredits>=0)
- DEBUG("Updated %s", this._userState)
- logSeparator()
+
+ DEBUG("Updated %s", this._userStateModel)
}
def onGetUserBillRequest(event: GetUserBillRequest): Unit = {
+ checkInitial()
+
try{
val timeslot = event.timeslot
- val resourceTypes = aquarium.policyStore.
+ val resourceTypes: Map[String, ResourceType] = aquarium.policyStore.
loadSortedPolicyModelsWithin(timeslot.from.getTime,
timeslot.to.getTime).
values.headOption match {
case None => Map[String,ResourceType]()
case Some(policy:PolicyModel) => policy.resourceTypesMap
}
- val state= if(haveUserState) Some(this._userState.msg) else None
- val billEntry = AbstractBillEntry.fromWorkingUserState(timeslot,this._userID,state,resourceTypes)
- val billData = GetUserBillResponseData(this._userID,billEntry)
+ val state= if(haveUserState) Some(this._userStateModel.userStateMsg) else None
+ val billEntryMsg = BillEntryMsg.fromWorkingUserState(timeslot,this.userID,state,resourceTypes)
+ //val billEntryMsg = MessageFactory.createBillEntryMsg(billEntry)
+ //logger.debug("BILL ENTRY MSG: " + billEntryMsg.toString)
+ val billData = GetUserBillResponseData(this.userID,billEntryMsg)
sender ! GetUserBillResponse(Right(billData))
} catch {
case e:Exception =>
}
def onGetUserBalanceRequest(event: GetUserBalanceRequest): Unit = {
+ checkInitial()
+
val userID = event.userID
(haveAgreements, haveUserState) match {
// (User CREATEd, with balance state)
val realtimeMillis = TimeHelpers.nowMillis()
chargingService.calculateRealtimeUserState(
- this._userState,
- BillingMonthInfo.fromMillis(realtimeMillis),
+ this._userStateModel,
+ aquarium.currentResourceMapping,
realtimeMillis
)
- sender ! GetUserBalanceResponse(Right(GetUserBalanceResponseData(this._userID, this._userState.totalCredits)))
+ sender ! GetUserBalanceResponse(Right(GetUserBalanceResponseData(this.userID, this._userStateModel.totalCredits)))
case (true, false) ⇒
// (User CREATEd, no balance state)
sender ! GetUserBalanceResponse(
Right(
GetUserBalanceResponseData(
- this._userID,
- aquarium.initialUserBalance(this._userCreationIMEvent.getRole, this._userCreationIMEvent.getOccurredMillis)
+ this.userID,
+ aquarium.initialUserBalance(this.unsafeUserCreationIMEventMsg.getRole, this.unsafeUserCreationIMEventMsg.getOccurredMillis).toString()
)))
case (false, true) ⇒
}
def onGetUserStateRequest(event: GetUserStateRequest): Unit = {
+ checkInitial()
+
haveUserState match {
case true ⇒
val realtimeMillis = TimeHelpers.nowMillis()
chargingService.calculateRealtimeUserState(
- this._userState,
- BillingMonthInfo.fromMillis(realtimeMillis),
+ this._userStateModel,
+ aquarium.currentResourceMapping,
realtimeMillis
)
- sender ! GetUserStateResponse(Right(this._userState.msg))
+ sender ! GetUserStateResponse(Right(this._userStateModel.userStateMsg))
case false ⇒
sender ! GetUserStateResponse(Left("No state for user %s [AQU-STA-0006]".format(event.userID)), 404)
}
def onGetUserWalletRequest(event: GetUserWalletRequest): Unit = {
+ checkInitial()
+
haveUserState match {
case true ⇒
DEBUG("haveWorkingUserState: %s", event)
val realtimeMillis = TimeHelpers.nowMillis()
chargingService.calculateRealtimeUserState(
- this._userState,
- BillingMonthInfo.fromMillis(realtimeMillis),
+ this._userStateModel,
+ aquarium.currentResourceMapping,
realtimeMillis
)
sender ! GetUserWalletResponse(
Right(
GetUserWalletResponseData(
- this._userID,
- this._userState.totalCredits,
- MessageFactory.newWalletEntriesMsg(this._userState.msg.getWalletEntries)
+ this.userID,
+ this._userStateModel.totalCredits,
+ MessageFactory.newWalletEntriesMsg(this._userStateModel.userStateMsg.getWalletEntries)
)))
case false ⇒
sender ! GetUserWalletResponse(
Right(
GetUserWalletResponseData(
- this._userID,
- aquarium.initialUserBalance(this._userCreationIMEvent.getRole, this._userCreationIMEvent.getOccurredMillis),
+ this.userID,
+ Real.toMsgField(aquarium.initialUserBalance(this.unsafeUserCreationIMEventMsg.getRole, this.unsafeUserCreationIMEventMsg.getOccurredMillis)),
MessageFactory.newWalletEntriesMsg()
)))
}
}
+ /**
+ * Initializes the actor's internal state.
+ *
+ * @param userID
+ */
+ def onSetUserActorUserID(userID: String) {
+ // Create the full agreement history from the original sources (IMEvents)
+ this._userStateModel = ModelFactory.newInitialUserStateModel(
+ userID,
+ Real(0),
+ TimeHelpers.nowMillis()
+ )
+
+ require(this._userStateModel.isInitial, "this._userStateModel.isInitial")
+ }
+
private[this] def D_userID = {
- this._userID
+ if(haveUserState) userID else "???"
}
private[this] def DEBUG(fmt: String, args: Any*) =