package service
package user
-import gr.grnet.aquarium.actor._
-
-import gr.grnet.aquarium.actor.message.event.{ProcessResourceEvent, ProcessIMEvent}
-import gr.grnet.aquarium.actor.message.config.{InitializeUserActorState, AquariumPropertiesLoaded}
+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.GetUserBillRequest
+import gr.grnet.aquarium.actor.message.GetUserBillResponse
+import gr.grnet.aquarium.actor.message.GetUserBillResponseData
+import gr.grnet.aquarium.actor.message.GetUserStateRequest
+import gr.grnet.aquarium.actor.message.GetUserStateResponse
+import gr.grnet.aquarium.actor.message.GetUserWalletRequest
+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.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.event.model.im.IMEventModel
-import gr.grnet.aquarium.actor.message.{GetUserStateResponse, GetUserBalanceResponseData, GetUserBalanceResponse, GetUserStateRequest, GetUserBalanceRequest}
import gr.grnet.aquarium.util.{LogHelpers, shortClassNameOf}
-import gr.grnet.aquarium.AquariumInternalError
-import gr.grnet.aquarium.computation.BillingMonthInfo
-import gr.grnet.aquarium.computation.state.UserStateBootstrap
-import gr.grnet.aquarium.charging.state.{WorkingAgreementHistory, WorkingUserState, UserStateModel}
-import gr.grnet.aquarium.charging.reason.{InitialUserActorSetup, RealtimeChargingReason}
-import gr.grnet.aquarium.policy.{PolicyDefinedFullPriceTableRef, StdUserAgreement}
+import gr.grnet.aquarium.policy.{ResourceType, PolicyModel}
+import gr.grnet.aquarium.charging.bill.BillEntryMsg
/**
*
*/
class UserActor extends ReflectiveRoleableActor {
- private[this] var _userID: String = "<?>"
- private[this] var _workingUserState: WorkingUserState = _
- private[this] var _userCreationIMEvent: IMEventModel = _
- private[this] val _workingAgreementHistory: WorkingAgreementHistory = new WorkingAgreementHistory
- private[this] var _latestIMEventID: String = ""
- private[this] var _latestResourceEventID: String = ""
- private[this] var _userStateBootstrap: UserStateBootstrap = _
-
- def unsafeUserID = {
- if(!haveUserID) {
+ private[this] var _imMsgCount = 0
+ 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: UserStateModel) ⇒ {
- aquarium.userStateStore.insertUserState(userState)
+ def onAquariumPropertiesLoaded(event: AquariumPropertiesLoaded): Unit = {
}
- @inline private[this] def haveUserID = {
- this._userID ne null
+ private[this] def unsafeUserCreationIMEventMsg = {
+ this._userStateModel.unsafeUserCreationIMEvent
}
- @inline private[this] def haveUserCreationIMEvent = {
- this._userCreationIMEvent ne null
+ private[this] def haveAgreements = {
+ (this._userStateModel ne null)
}
- def onAquariumPropertiesLoaded(event: AquariumPropertiesLoaded): Unit = {
+ private[this] def haveUserCreationEvent = {
+ haveAgreements &&
+ this._userStateModel.hasUserCreationEvent
}
- @inline private[this] def haveAgreements = {
- this._workingAgreementHistory.size > 0
+ private[this] def haveUserState = {
+ (this._userStateModel ne null)
}
- @inline private[this] def haveWorkingUserState = {
- this._workingUserState ne null
- }
+ private[this] def isInitial = this._userStateModel.isInitial
- @inline private[this] def haveUserStateBootstrap = {
- this._userStateBootstrap ne null
- }
+ /**
+ * Creates the agreement history from all the stored IMEvents.
+ *
+ * @return (`true` iff there was a user CREATE event, the number of events processed)
+ */
+ private[this] def createUserAgreementHistoryFromIMEvents(userID: String): (Boolean, Int) = {
+ DEBUG("createUserAgreementHistoryFromStoredIMEvents()")
+ assert(haveUserState, "haveUserState")
- private[this] def updateAgreementHistoryFrom(imEvent: IMEventModel): Unit = {
- if(imEvent.isCreateUser) {
- if(haveUserCreationIMEvent) {
- throw new AquariumInternalError(
- "Got user creation event (id=%s) but I already have one (id=%s)",
- this._userCreationIMEvent.id,
- imEvent.id
- )
+
+ var _imcounter = 0
+
+ val hadCreateEvent = aquarium.imEventStore.foreachIMEventInOccurrenceOrder(userID) { imEvent ⇒
+ _imcounter += 1
+ DEBUG("Replaying [%s/%s] %s", shortClassNameOf(imEvent), _imcounter, imEvent)
+
+ if(_imcounter == 1 && !MessageHelpers.isUserCreationIMEvent(imEvent)) {
+ // The very first event must be a CREATE event. Otherwise we abort initialization.
+ // This will normally happen during devops :)
+ INFO("Ignoring first %s since it is not CREATE", shortClassNameOf(imEvent))
+ false
}
+ else {
+ 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._userCreationIMEvent = imEvent
+ this._userStateModel.insertUserAgreementMsgFromIMEvent(imEvent)
+ true
+ }
}
- val effectiveFromMillis = imEvent.occurredMillis
- val role = imEvent.role
- // calling unsafe just for the side-effect
- assert(null ne aquarium.unsafePriceTableForRoleAt(role, effectiveFromMillis))
-
- val newAgreement = StdUserAgreement(
- imEvent.id,
- Some(imEvent.id),
- effectiveFromMillis,
- Long.MaxValue,
- role,
- PolicyDefinedFullPriceTableRef
- )
+ this._imMsgCount = _imcounter
- this._workingAgreementHistory += newAgreement
+ DEBUG("Agreements: %s", this._userStateModel.userAgreementHistoryMsg)
+ (hadCreateEvent, _imcounter)
}
- private[this] def updateLatestIMEventIDFrom(imEvent: IMEventModel): Unit = {
- this._latestIMEventID = imEvent.id
+ private[this] def saveFirstUserState(userID: String) {
+ this._userStateModel.userStateMsg.setIsFirst(true)
+ this._userStateModel.updateUserStateMsg(
+ aquarium.userStateStore.insertUserState(this._userStateModel.userStateMsg)
+ )
}
- /**
- * Creates the initial state that is related to IMEvents.
- */
- private[this] def initializeStateOfIMEvents(): Unit = {
- // NOTE: this._userID is already set up by onInitializeUserActorState()
- aquarium.imEventStore.foreachIMEventInOccurrenceOrder(this._userID) { imEvent ⇒
- DEBUG("Replaying %s", imEvent)
-
- updateAgreementHistoryFrom(imEvent)
- updateLatestIMEventIDFrom(imEvent)
- }
-
- if(haveAgreements) {
- DEBUG("Initial %s", this._workingAgreementHistory.toJsonString)
- logSeparator()
- }
+ private[this] def saveSubsequentUserState() {
+ this._userStateModel.userStateMsg.setIsFirst(false)
+ this._userStateModel.updateUserStateMsg(
+ aquarium.userStateStore.insertUserState(this._userStateModel.userStateMsg)
+ )
}
- /**
- * Resource events are processed only if the user has been created and has agreements.
- * Otherwise nothing can be computed.
- */
- private[this] def shouldProcessResourceEvents: Boolean = {
- haveUserCreationIMEvent && haveAgreements && haveUserStateBootstrap
- }
+ private[this] def loadLastKnownUserStateAndUpdateAgreements() {
+ val userID = this._userStateModel.userID
+ aquarium.userStateStore.findLatestUserState(userID) match {
+ case None ⇒
+ // First user state ever
+ saveFirstUserState(userID)
- private[this] def loadWorkingUserStateAndUpdateAgreementHistory(): Unit = {
- assert(this.haveAgreements, "this.haveAgreements")
- assert(this.haveUserCreationIMEvent, "this.haveUserCreationIMEvent")
-
- val userCreationMillis = this._userCreationIMEvent.occurredMillis
- val userCreationRole = this._userCreationIMEvent.role // initial role
- val userCreationIMEventID = this._userCreationIMEvent.id
-
- if(!haveUserStateBootstrap) {
- this._userStateBootstrap = UserStateBootstrap(
- this._userID,
- userCreationMillis,
- aquarium.initialUserAgreement(userCreationRole, userCreationMillis, Some(userCreationIMEventID)),
- aquarium.initialUserBalance(userCreationRole, userCreationMillis)
- )
+ case Some(latestUserState) ⇒
+ this._userStateModel.updateUserStateMsg(latestUserState)
}
+ }
- val now = TimeHelpers.nowMillis()
- this._workingUserState = chargingService.replayMonthChargingUpTo(
- BillingMonthInfo.fromMillis(now),
- now,
- this._userStateBootstrap,
- aquarium.currentResourceTypesMap,
- InitialUserActorSetup(),
- aquarium.userStateStore.insertUserState,
- None
+ private[this] def processResourceEventsAfterLastKnownUserState() {
+ // Update the user state snapshot with fresh (ie not previously processed) events.
+ aquarium.resourceEventStore.foreachResourceEventOccurredInPeriod(
+ this._userStateModel.userID,
+ this._userStateModel.latestResourceEventOccurredMillis,
+ TimeHelpers.nowMillis()
)
-
- // 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(haveWorkingUserState) {
- this._workingUserState.workingAgreementHistory.setFrom(this._workingAgreementHistory)
- DEBUG("Computed %s", this._workingUserState.toJsonString)
- }
}
- private[this] def initializeStateOfResourceEvents(event: InitializeUserActorState): Unit = {
- if(!this.haveAgreements) {
- DEBUG("Cannot initializeResourceEventsState() from %s. There are no agreements", event)
- return
- }
+ private[this] def makeUserStateMsgUpToDate() {
+ loadLastKnownUserStateAndUpdateAgreements()
+ processResourceEventsAfterLastKnownUserState()
+ }
- if(!this.haveUserCreationIMEvent) {
- DEBUG("Cannot initializeResourceEventsState() from %s. I never got a CREATE IMEvent", event)
- return
+ private[this] def checkInitial(nextThing: () ⇒ Any = () ⇒ {}): Boolean = {
+ if(!isInitial) {
+ return false
}
- // We will also need this functionality when receiving IMEvents, so we place it in a method
- loadWorkingUserStateAndUpdateAgreementHistory()
+ val (userCreated, imEventsCount) = createUserAgreementHistoryFromIMEvents(userID)
- if(haveWorkingUserState) {
- DEBUG("Initial %s", this._workingUserState.toJsonString)
- logSeparator()
+ if(userCreated) {
+ makeUserStateMsgUpToDate()
}
- }
- def onInitializeUserActorState(event: InitializeUserActorState): Unit = {
- this._userID = event.userID
- DEBUG("Got %s", event)
+ nextThing()
- initializeStateOfIMEvents()
- initializeStateOfResourceEvents(event)
+ true
}
/**
- * Process [[gr.grnet.aquarium.event.model.im.IMEventModel]]s.
- * When this method is called, we assume that all proper checks have been made and it
- * is OK to proceed with the event processing.
+ * Processes [[gr.grnet.aquarium.message.avro.gen.IMEventMsg]]s that come directly from the
+ * messaging hub (rabbitmq).
*/
- def onProcessIMEvent(processEvent: ProcessIMEvent): Unit = {
- val imEvent = processEvent.imEvent
- val hadUserCreationIMEvent = haveUserCreationIMEvent
-
- if(!haveAgreements) {
- // This is an error. Should have been initialized from somewhere ...
- throw new AquariumInternalError("No agreements. Cannot process %s", processEvent)
+ def onIMEventMsg(imEvent: IMEventMsg) {
+ if(checkInitial()) {
+ return
}
- if(this._latestIMEventID == imEvent.id) {
- // This happens when the actor is brought to life, then immediately initialized, and then
- // sent the first IM event. But from the initialization procedure, this IM event will have
- // already been loaded from DB!
- INFO("Ignoring first %s", imEvent.toDebugString)
- logSeparator()
+ // Check for out of sync (regarding IMEvents)
+ val isOutOfSyncIM = imEvent.getOccurredMillis < this._userStateModel.latestIMEventOccurredMillis
+ if(isOutOfSyncIM) {
+ // clear all resource state
+ // FIXME implement
- //this._latestIMEventID = imEvent.id
return
}
- updateAgreementHistoryFrom(imEvent)
- updateLatestIMEventIDFrom(imEvent)
+ // Check out of sync (regarding ResourceEvents)
+ val isOutOfSyncRC = false // FIXME implement
+ if(isOutOfSyncRC) {
+ // TODO
- // Must also update user state if we know when in history the life of a user begins
- if(!hadUserCreationIMEvent && haveUserCreationIMEvent) {
- loadWorkingUserStateAndUpdateAgreementHistory()
+ return
}
- }
- def onProcessResourceEvent(event: ProcessResourceEvent): Unit = {
- val rcEvent = event.rcEvent
+ // Make new agreement
+ this._userStateModel.insertUserAgreementMsgFromIMEvent(imEvent)
+ this._imMsgCount += 1
- if(!shouldProcessResourceEvents) {
- // This means the user has not been created (at least, as far as Aquarium is concerned).
- // So, we do not process any resource event
- DEBUG("Not processing %s", rcEvent.toJsonString)
- logSeparator()
+ if(MessageHelpers.isUserCreationIMEvent(imEvent)) {
+ makeUserStateMsgUpToDate()
+ }
+ DEBUG("Agreements: %s", this._userStateModel.userAgreementHistoryMsg)
+ }
+
+ def onResourceEventMsg(rcEvent: ResourceEventMsg) {
+ if(checkInitial()) {
return
}
- // Since the latest resource event per resource is recorded in the user state,
- // we do not need to query the store. Just query the in-memory state.
- // Note: This is a similar situation with the first IMEvent received right after the user
- // actor is created.
- if(this._latestResourceEventID == rcEvent.id) {
- INFO("Ignoring first %s", rcEvent.toDebugString)
- logSeparator()
+ if(!haveUserCreationEvent) {
+ DEBUG("No agreements. Ignoring %s", rcEvent)
return
}
- val now = TimeHelpers.nowMillis()
- val billingMonthInfo = BillingMonthInfo.fromMillis(now)
- val currentResourcesMap = aquarium.currentResourceTypesMap
- val calculationReason = RealtimeChargingReason(None, now)
- val eventOccurredMillis = rcEvent.occurredMillis
-
-// DEBUG("Using %s", currentResourceTypesMap.toJsonString)
- if(rcEvent.occurredMillis >= _workingUserState.occurredMillis) {
- chargingService.processResourceEvent(
- rcEvent,
- this._workingUserState,
- calculationReason,
- billingMonthInfo,
- None
- )
- }
- else {
- // Oops. Event is OUT OF SYNC
- DEBUG("OUT OF SYNC %s", rcEvent.toDebugString)
- this._workingUserState = chargingService.replayMonthChargingUpTo(
- billingMonthInfo,
- // 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,
- calculationReason,
- stdUserStateStoreFunc,
- None
- )
+ assert(haveUserState, "haveUserState")
+
+ val oldTotalCredits = this._userStateModel.totalCreditsAsReal
+
+ chargingService.processResourceEvent(
+ rcEvent.getReceivedMillis,
+ rcEvent,
+ this._userStateModel,
+ aquarium.currentResourceMapping,
+ true
+ )
+
+ val newTotalCredits = this._userStateModel.totalCreditsAsReal
+
+ if(oldTotalCredits.signum * newTotalCredits.signum < 0) {
+ aquarium.eventBus ! new BalanceEvent(userID, newTotalCredits >= 0)
}
- DEBUG("Updated %s", this._workingUserState)
- logSeparator()
+ DEBUG("Updated %s", this._userStateModel)
+ }
+
+ def onGetUserBillRequest(event: GetUserBillRequest): Unit = {
+ checkInitial()
+
+ try{
+ val timeslot = event.timeslot
+ 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._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 =>
+ e.printStackTrace()
+ sender ! GetUserBillResponse(Left("Internal Server Error [AQU-BILL-0001]"), 500)
+ }
}
def onGetUserBalanceRequest(event: GetUserBalanceRequest): Unit = {
+ checkInitial()
+
val userID = event.userID
- (haveUserCreationIMEvent, haveWorkingUserState) match {
+ (haveAgreements, haveUserState) match {
case (true, true) ⇒
// (User CREATEd, with balance state)
- sender ! GetUserBalanceResponse(Right(GetUserBalanceResponseData(this._userID, this._workingUserState.totalCredits)))
+ val realtimeMillis = TimeHelpers.nowMillis()
+ chargingService.calculateRealtimeUserState(
+ this._userStateModel,
+ aquarium.currentResourceMapping,
+ realtimeMillis
+ )
+
+ 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.role, this._userCreationIMEvent.occurredMillis)
- )))
+ this.userID,
+ aquarium.initialUserBalance(this.unsafeUserCreationIMEventMsg.getRole, this.unsafeUserCreationIMEventMsg.getOccurredMillis).toString()
+ )))
case (false, true) ⇒
// (Not CREATEd, with balance state)
}
def onGetUserStateRequest(event: GetUserStateRequest): Unit = {
- haveWorkingUserState match {
+ checkInitial()
+
+ haveUserState match {
case true ⇒
- sender ! GetUserStateResponse(Right(this._workingUserState))
+ val realtimeMillis = TimeHelpers.nowMillis()
+ chargingService.calculateRealtimeUserState(
+ this._userStateModel,
+ aquarium.currentResourceMapping,
+ realtimeMillis
+ )
+
+ 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._userStateModel,
+ aquarium.currentResourceMapping,
+ realtimeMillis
+ )
+
+ sender ! GetUserWalletResponse(
+ Right(
+ GetUserWalletResponseData(
+ this.userID,
+ this._userStateModel.totalCredits,
+ MessageFactory.newWalletEntriesMsg(this._userStateModel.userStateMsg.getWalletEntries)
+ )))
+
+ case false ⇒
+ DEBUG("!haveWorkingUserState: %s", event)
+ haveAgreements match {
+ case true ⇒
+ DEBUG("haveAgreements: %s", event)
+ sender ! GetUserWalletResponse(
+ Right(
+ GetUserWalletResponseData(
+ this.userID,
+ Real.toMsgField(aquarium.initialUserBalance(this.unsafeUserCreationIMEventMsg.getRole, this.unsafeUserCreationIMEventMsg.getOccurredMillis)),
+ MessageFactory.newWalletEntriesMsg()
+ )))
+
+ case false ⇒
+ DEBUG("!haveUserCreationIMEvent: %s", event)
+ sender ! GetUserWalletResponse(Left("No wallet for user %s [AQU-WAL-00 8]".format(event.userID)), 404)
+ }
+ }
+ }
+
+ /**
+ * 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*) =
projects / aquarium / blobdiff