package user
import gr.grnet.aquarium.actor._
-import gr.grnet.aquarium.user._
-import gr.grnet.aquarium.util.shortClassNameOf
-import gr.grnet.aquarium.util.chainOfCauses
-import gr.grnet.aquarium.util.date.TimeHelpers
-import gr.grnet.aquarium.actor.message.service.router._
-import message.config.{ActorProviderConfigured, AquariumPropertiesLoaded}
-import gr.grnet.aquarium.event.im.IMEventModel
import akka.config.Supervision.Temporary
-import akka.actor.PoisonPill
-import gr.grnet.aquarium.{AquariumException, Configurator}
-
+import gr.grnet.aquarium.actor.message.event.{ProcessResourceEvent, ProcessIMEvent}
+import gr.grnet.aquarium.computation.data.IMStateSnapshot
+import gr.grnet.aquarium.actor.message.config.{InitializeUserState, ActorProviderConfigured, AquariumPropertiesLoaded}
+import gr.grnet.aquarium.computation.{BillingMonthInfo, UserStateBootstrappingData, UserState}
+import gr.grnet.aquarium.util.date.TimeHelpers
+import gr.grnet.aquarium.event.model.im.IMEventModel
+import gr.grnet.aquarium.{AquariumException, Aquarium}
+import gr.grnet.aquarium.actor.message.{GetUserStateResponse, GetUserBalanceResponseData, GetUserBalanceResponse, GetUserStateRequest, GetUserBalanceRequest}
+import gr.grnet.aquarium.computation.reason.{InitialUserActorSetup, UserStateChangeReason, IMEventArrival, InitialUserStateSetup}
+import gr.grnet.aquarium.util.{LogHelpers, shortClassNameOf, shortNameOfClass, shortNameOfType}
/**
*
*/
class UserActor extends ReflectiveRoleableActor {
- private[this] var _userID: String = _
+ private[this] var _userID: String = "<?>"
+ private[this] var _imState: IMStateSnapshot = _
private[this] var _userState: UserState = _
self.lifeCycle = Temporary
private[this] def _shutmedown(): Unit = {
- if(_haveFullState) {
- UserActorCache.invalidate(this._userID)
+ if(haveUserState) {
+ UserActorCache.invalidate(_userID)
}
- self ! PoisonPill
+ self.stop()
}
override protected def onThrowable(t: Throwable, message: AnyRef) = {
- ERROR("Oops!\n", chainOfCauses(t).map("!! " + _) mkString "\n")
+ LogHelpers.logChainOfCauses(logger, t)
ERROR(t, "Terminating due to: %s(%s)", shortClassNameOf(t), t.getMessage)
_shutmedown()
def role = UserActorRole
- private[this] def _configurator: Configurator = Configurator.MasterConfigurator
-// private[this] def _userId = _userState.userId
+ private[this] def aquarium: Aquarium = Aquarium.Instance
+ private[this] def userStateComputations = aquarium.userStateComputations
- private[this] def _timestampTheshold =
- _configurator.props.getLong(Configurator.Keys.user_state_timestamp_threshold).getOr(10000)
+ private[this] def _timestampTheshold = {
+ aquarium.props.getLong(Aquarium.Keys.user_state_timestamp_threshold).getOr(10000)
+ }
+ private[this] def haveUserState = {
+ this._userState ne null
+ }
- private[this] def _haveFullState = {
- (this._userID ne null) && (this._userState ne null)
+ private[this] def haveIMState = {
+ this._imState ne null
}
def onAquariumPropertiesLoaded(event: AquariumPropertiesLoaded): Unit = {
def onActorProviderConfigured(event: ActorProviderConfigured): Unit = {
}
- private[this] def _computeAgreementForNewUser(imEvent: IMEventModel): String = {
- // FIXME: Implement based on the role
- "default"
+ private[this] def _updateIMStateRoleHistory(imEvent: IMEventModel): (Boolean, Boolean, String) = {
+ if(haveIMState) {
+ val currentRole = this._imState.roleHistory.lastRole.map(_.name).getOrElse(null)
+// logger.debug("Current role = %s".format(currentRole))
+
+ if(imEvent.role != currentRole) {
+// logger.debug("New role = %s".format(imEvent.role))
+ this._imState = this._imState.updateRoleHistoryWithEvent(imEvent)
+ (true, false, "")
+ } else {
+ val noUpdateReason = "Same role '%s'".format(currentRole)
+// logger.debug(noUpdateReason)
+ (false, false, noUpdateReason)
+ }
+ } else {
+ this._imState = IMStateSnapshot.initial(imEvent)
+ (true, true, "")
+ }
}
- private[this] def processCreateUser(imEvent: IMEventModel): Unit = {
- val userID = imEvent.userID
- this._userID = userID
-
- val store = _configurator.storeProvider.userStateStore
- // try find user state. normally should ot exist
- val latestUserStateOpt = store.findLatestUserStateByUserID(userID)
- if(latestUserStateOpt.isDefined) {
- logger.error("Got %s(%s, %s) but user already exists. Ingoring".format(
- userID,
- shortClassNameOf(imEvent),
- imEvent.eventType))
-
- return
+ /**
+ * Creates the IMStateSnapshot and returns the number of updates it made to it.
+ */
+ private[this] def createInitialIMState(event: InitializeUserState): Int = {
+ val userID = event.userID
+ val store = aquarium.imEventStore
+
+ var _updateCount = 0
+
+ store.replayIMEventsInOccurrenceOrder(userID) { imEvent ⇒
+ DEBUG("Replaying %s", imEvent)
+
+ val (updated, firstUpdate, noUpdateReason) = _updateIMStateRoleHistory(imEvent)
+ if(updated) {
+ _updateCount = _updateCount + 1
+ DEBUG("Updated %s for role '%s'", shortNameOfType[IMStateSnapshot], imEvent.role)
+ } else {
+ DEBUG("Not updated %s due to: %s", shortNameOfType[IMStateSnapshot], noUpdateReason)
+ }
}
- val initialAgreementName = _computeAgreementForNewUser(imEvent)
- val newUserState = DefaultUserStateComputations.createInitialUserState(
- userID,
- imEvent.occurredMillis,
- imEvent.isActive,
- 0.0,
- List(imEvent.role),
- initialAgreementName)
+ if(_updateCount > 0)
+ DEBUG("Computed %s = %s", shortNameOfType[IMStateSnapshot], this._imState)
+ else
+ DEBUG("Not computed %s", shortNameOfType[IMStateSnapshot])
- this._userState = newUserState
+ _updateCount
+ }
+
+ /**
+ * Resource events are processed only if the user has been activated.
+ */
+ private[this] def shouldProcessResourceEvents: Boolean = {
+ haveIMState && this._imState.hasBeenActivated
+ }
- // FIXME: If this fails, then the actor must be shut down.
- store.insertUserState(newUserState)
+ private[this] def loadUserStateAndUpdateRoleHistory(): Unit = {
+ val userActivationMillis = this._imState.userActivationMillis.get
+ val initialRole = this._imState.roleHistory.firstRole.get.name
+
+ val userStateBootstrap = UserStateBootstrappingData(
+ this._userID,
+ userActivationMillis,
+ initialRole,
+ aquarium.initialAgreementForRole(initialRole, userActivationMillis),
+ aquarium.initialBalanceForRole(initialRole, userActivationMillis)
+ )
+
+ val userState = userStateComputations.doFullMonthlyBilling(
+ userStateBootstrap,
+ BillingMonthInfo.fromMillis(TimeHelpers.nowMillis()),
+ aquarium.currentResourcesMap,
+ InitialUserStateSetup,
+ None
+ )
+
+ this._userState = userState
+
+ // Final touch: Update role history
+ if(haveIMState && haveUserState) {
+ if(this._userState.roleHistory != this._imState.roleHistory) {
+ this._userState = newUserStateWithUpdatedRoleHistory(InitialUserActorSetup)
+ }
+ }
}
- private[this] def processModifyUser(imEvent: IMEventModel): Unit = {
- val now = TimeHelpers.nowMillis()
+ private[this] def createInitialUserState(event: InitializeUserState): Unit = {
+ if(!haveIMState) {
+ // Should have been created from `createIMState()`
+ DEBUG("Cannot create user state from %s, since %s = %s", event, shortNameOfClass(classOf[IMStateSnapshot]), this._imState)
+ return
+ }
- if(!_haveFullState) {
- ERROR("Got %s(%s) but have no state. Shutting down", shortClassNameOf(imEvent), imEvent.eventType)
- _shutmedown()
+ if(!this._imState.hasBeenActivated) {
+ // Cannot set the initial state!
+ DEBUG("Cannot create %s from %s, since user is inactive", shortNameOfType[UserState], event)
return
}
- this._userState = this._userState.modifyFromIMEvent(imEvent, now)
+ // We will also need this functionality when receiving IMEvents,
+ // so we place it in a method
+ loadUserStateAndUpdateRoleHistory()
+
+ if(haveUserState) {
+ DEBUG("%s = %s", shortNameOfType[UserState], this._userState)
+ }
+ }
+
+ def onInitializeUserState(event: InitializeUserState): Unit = {
+ val userID = event.userID
+ this._userID = userID
+ DEBUG("Got %s", event)
+
+ createInitialIMState(event)
+ createInitialUserState(event)
}
- def onProcessSetUserID(event: ProcessSetUserID): Unit = {
- this._userID = event.userID
+ /**
+ * Creates a new user state, taking into account the latest role history in IM state snapshot.
+ * Having an IM state snapshot is a prerequisite, otherwise you get an exception; so check before you
+ * call this.
+ */
+ private[this] def newUserStateWithUpdatedRoleHistory(stateChangeReason: UserStateChangeReason): UserState = {
+ this._userState.copy(
+ roleHistory = this._imState.roleHistory,
+ // FIXME: Also update agreement
+ stateChangeCounter = this._userState.stateChangeCounter + 1,
+ lastChangeReason = stateChangeReason
+ )
}
- def onProcessIMEvent(event: ProcessIMEvent): Unit = {
- val imEvent = event.imEvent
- if(imEvent.isCreateUser) {
- processCreateUser(imEvent)
- } else if(imEvent.isModifyUser) {
- processModifyUser(imEvent)
+ /**
+ * 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.
+ */
+ def onProcessIMEvent(processEvent: ProcessIMEvent): Unit = {
+ val imEvent = processEvent.imEvent
+
+ if(!haveIMState) {
+ // This is an error. Should have been initialized from somewhere ...
+ throw new AquariumException("Got %s while being uninitialized".format(processEvent))
+ }
+
+ if(this._imState.latestIMEvent.id == 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 just after %s birth", imEvent.toDebugString, shortClassNameOf(this))
+ logSeparator()
+ return
+ }
+
+ val (updated, firstUpdate, noUpdateReason) = _updateIMStateRoleHistory(imEvent)
+
+ if(updated) {
+ DEBUG("Updated %s = %s", shortClassNameOf(this._imState), this._imState)
+
+ // Must also update user state
+ if(shouldProcessResourceEvents) {
+ if(!haveUserState) {
+ loadUserStateAndUpdateRoleHistory()
+ INFO("Loaded %s due to %s", shortNameOfType[UserState], imEvent)
+ } else {
+ // Just update role history
+ this._userState = newUserStateWithUpdatedRoleHistory(IMEventArrival(imEvent))
+ INFO("Updated %s due to %s", shortNameOfType[UserState], imEvent)
+ }
+ }
} else {
- throw new AquariumException("Cannot interpret %s".format(imEvent))
+ DEBUG("Not updating %s from %s due to: %s", shortNameOfType[IMStateSnapshot], imEvent, noUpdateReason)
}
- }
- def onRequestUserBalance(event: RequestUserBalance): Unit = {
- val userId = event.userID
- // FIXME: Implement threshold
- self reply UserResponseGetBalance(userId, _userState.creditsSnapshot.creditAmount)
+ logSeparator()
}
- def onUserRequestGetState(event: UserRequestGetState): Unit = {
- val userId = event.userID
- // FIXME: implement
- self reply UserResponseGetState(userId, this._userState)
+ def onProcessResourceEvent(event: ProcessResourceEvent): Unit = {
+ val rcEvent = event.rcEvent
+
+ if(!shouldProcessResourceEvents) {
+ // This means the user has not been activated. So, we do not process any resource event
+ DEBUG("Not processing %s", rcEvent.toJsonString)
+ logSeparator()
+ return
+ }
}
- def onProcessResourceEvent(event: ProcessResourceEvent): Unit = {
+ def onGetUserBalanceRequest(event: GetUserBalanceRequest): Unit = {
+ val userID = event.userID
+
+ (haveIMState, haveUserState) match {
+ case (true, true) ⇒
+ // (have IMState, have UserState)
+ this._imState.hasBeenActivated match {
+ case true ⇒
+ // (have IMState, activated, have UserState)
+ self reply GetUserBalanceResponse(Right(GetUserBalanceResponseData(userID, this._userState.totalCredits)))
+
+ case false ⇒
+ // (have IMState, not activated, have UserState)
+ // Since we have user state, we should have been activated
+ self reply GetUserBalanceResponse(Left("Internal Server Error [AQU-BAL-0001]"), 500)
+ }
+
+ case (true, false) ⇒
+ // (have IMState, no UserState)
+ this._imState.hasBeenActivated match {
+ case true ⇒
+ // (have IMState, activated, no UserState)
+ // Since we are activated, we should have some state.
+ self reply GetUserBalanceResponse(Left("Internal Server Error [AQU-BAL-0002]"), 500)
+ case false ⇒
+ // (have IMState, not activated, no UserState)
+ // The user is virtually unknown
+ self reply GetUserBalanceResponse(Left("User %s not activated [AQU-BAL-0003]".format(userID)), 404 /*Not found*/)
+ }
+
+ case (false, true) ⇒
+ // (no IMState, have UserState
+ // A bit ridiculous situation
+ self reply GetUserBalanceResponse(Left("Unknown user %s [AQU-BAL-0004]".format(userID)), 404/*Not found*/)
+
+ case (false, false) ⇒
+ // (no IMState, no UserState)
+ self reply GetUserBalanceResponse(Left("Unknown user %s [AQU-BAL-0005]".format(userID)), 404/*Not found*/)
+ }
}
+ def onGetUserStateRequest(event: GetUserStateRequest): Unit = {
+ haveUserState match {
+ case true ⇒
+ self reply GetUserStateResponse(Right(this._userState))
+
+ case false ⇒
+ self reply GetUserStateResponse(Left("No state for user %s [AQU-STA-0006]".format(event.userID)))
+ }
+ }
private[this] def D_userID = {
- if(this._userID eq null)
- "<NOT INITIALIZED>" // We always get a userID first
- else
- if(this._userState eq null)
- "%s, NO STATE".format(this._userID)
- else
- "%s".format(this._userID)
+ this._userID
}
private[this] def DEBUG(fmt: String, args: Any*) =
- logger.debug("UserActor[%s]: %s".format(D_userID, fmt.format(args: _*)))
+ logger.debug("[%s] - %s".format(D_userID, fmt.format(args: _*)))
private[this] def INFO(fmt: String, args: Any*) =
- logger.info("UserActor[%s]: %s".format(D_userID, fmt.format(args: _*)))
+ logger.info("[%s] - %s".format(D_userID, fmt.format(args: _*)))
private[this] def WARN(fmt: String, args: Any*) =
- logger.warn("UserActor[%s]: %s".format(D_userID, fmt.format(args: _*)))
+ logger.warn("[%s] - %s".format(D_userID, fmt.format(args: _*)))
private[this] def ERROR(fmt: String, args: Any*) =
- logger.error("UserActor[%s]: %s".format(D_userID, fmt.format(args: _*)))
+ logger.error("[%s] - %s".format(D_userID, fmt.format(args: _*)))
private[this] def ERROR(t: Throwable, fmt: String, args: Any*) =
- logger.error("UserActor[%s]: %s".format(D_userID, fmt.format(args: _*)), t)
+ logger.error("[%s] - %s".format(D_userID, fmt.format(args: _*)), t)
}
projects / aquarium / blobdiff