import gr.grnet.aquarium.actor._
import akka.config.Supervision.Temporary
-import gr.grnet.aquarium.Aquarium
import gr.grnet.aquarium.actor.message.event.{ProcessResourceEvent, ProcessIMEvent}
-import gr.grnet.aquarium.actor.message.{GetUserStateRequest, GetUserBalanceRequest}
import gr.grnet.aquarium.computation.data.IMStateSnapshot
-import gr.grnet.aquarium.event.model.im.IMEventModel
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 _imState: IMStateSnapshot = _
-// private[this] var _userState: UserState = _
-// private[this] var _newUserState: NewUserState = _
+ private[this] var _userState: UserState = _
self.lifeCycle = Temporary
-// private[this] def _userID = this._newUserState.userID
private[this] def _shutmedown(): Unit = {
-// if(_haveUserState) {
-// UserActorCache.invalidate(_userID)
-// }
+ if(haveUserState) {
+ UserActorCache.invalidate(_userID)
+ }
self.stop()
}
override protected def onThrowable(t: Throwable, message: AnyRef) = {
- logChainOfCauses(t)
-// ERROR(t, "Terminating due to: %s(%s)", shortClassNameOf(t), t.getMessage)
+ LogHelpers.logChainOfCauses(logger, t)
+ ERROR(t, "Terminating due to: %s(%s)", shortClassNameOf(t), t.getMessage)
_shutmedown()
}
def role = UserActorRole
private[this] def aquarium: Aquarium = Aquarium.Instance
+ private[this] def userStateComputations = aquarium.userStateComputations
- private[this] def _timestampTheshold =
+ 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 _haveUserState = {
-// this._newUserState ne null
-// }
-
- private[this] def _haveIMState = {
+ private[this] def haveIMState = {
this._imState ne null
}
def onActorProviderConfigured(event: ActorProviderConfigured): Unit = {
}
- private[this] def createIMState(userID: String): Unit = {
+ 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, "")
+ }
+ }
+
+ /**
+ * 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
- // TODO: Optimization: Since IMState only records roles, we should incrementally
- // TODO: built it only for those IMEvents that changed the role.
+
+ var _updateCount = 0
+
store.replayIMEventsInOccurrenceOrder(userID) { imEvent ⇒
- logger.debug("Replaying %s".format(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)
+ }
+ }
+
+ if(_updateCount > 0)
+ DEBUG("Computed %s = %s", shortNameOfType[IMStateSnapshot], this._imState)
+ else
+ DEBUG("Not computed %s", shortNameOfType[IMStateSnapshot])
+
+ _updateCount
+ }
- val newState = this._imState match {
- case null ⇒
- IMStateSnapshot.initial(imEvent)
+ /**
+ * Resource events are processed only if the user has been activated.
+ */
+ private[this] def shouldProcessResourceEvents: Boolean = {
+ haveIMState && this._imState.hasBeenActivated
+ }
- case currentState ⇒
- currentState.copyWithEvent(imEvent)
+ 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 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
+ }
- this._imState = newState
+ if(!this._imState.hasBeenActivated) {
+ // Cannot set the initial state!
+ DEBUG("Cannot create %s from %s, since user is inactive", shortNameOfType[UserState], event)
+ return
}
- logger.debug("Recomputed %s".format(this._imState))
+ // 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 = {
- logger.debug("Got %s".format(event))
- createIMState(event.userID)
+ val userID = event.userID
+ this._userID = userID
+ DEBUG("Got %s", event)
+
+ createInitialIMState(event)
+ createInitialUserState(event)
}
- private[this] def _getAgreementNameForNewUser(imEvent: IMEventModel): String = {
- // FIXME: Implement based on the role
- "default"
+ /**
+ * 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(processEvent: ProcessIMEvent): Unit = {
val imEvent = processEvent.imEvent
- val hadIMState = _haveIMState
-
- if(hadIMState) {
- 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!
- logger.debug("Ignoring first %s after birth".format(imEvent.toDebugString))
- return
- }
- this._imState = this._imState.copyWithEvent(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 {
- this._imState = IMStateSnapshot.initial(imEvent)
+ DEBUG("Not updating %s from %s due to: %s", shortNameOfType[IMStateSnapshot], imEvent, noUpdateReason)
}
-// DEBUG("%s %s = %s", if(hadIMState) "Update" else "Set", shortClassNameOf(this._imState), this._imState)
+ logSeparator()
+ }
+
+ 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 onGetUserBalanceRequest(event: GetUserBalanceRequest): Unit = {
- val userId = event.userID
- // FIXME: Implement
-// self reply GetUserBalanceResponse(userId, Right(_userState.creditsSnapshot.creditAmount))
+ 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 = {
- val userId = event.userID
- // FIXME: Implement
-// self reply GetUserStateResponse(userId, Right(this._userState))
+ 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)))
+ }
}
- def onProcessResourceEvent(event: ProcessResourceEvent): Unit = {
- val rcEvent = event.rcEvent
+ private[this] def D_userID = {
+ this._userID
+ }
+
+ private[this] def DEBUG(fmt: String, args: Any*) =
+ logger.debug("[%s] - %s".format(D_userID, fmt.format(args: _*)))
+
+ private[this] def INFO(fmt: String, args: Any*) =
+ logger.info("[%s] - %s".format(D_userID, fmt.format(args: _*)))
+
+ private[this] def WARN(fmt: String, args: Any*) =
+ logger.warn("[%s] - %s".format(D_userID, fmt.format(args: _*)))
+
+ private[this] def ERROR(fmt: String, args: Any*) =
+ logger.error("[%s] - %s".format(D_userID, fmt.format(args: _*)))
- logger.info("Got\n{}", rcEvent.toJsonString)
- }
-
-
-// private[this] def D_userID = {
-// if(this._newUserState eq null)
-// if(this._imState eq null)
-// "<NOT INITIALIZED>"
-// else
-// this._imState.latestIMEvent.userID
-// else
-// this._newUserState.userID
-// }
-//
-// private[this] def DEBUG(fmt: String, args: Any*) =
-// logger.debug("UserActor[%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: _*)))
-//
-// private[this] def WARN(fmt: String, args: Any*) =
-// logger.warn("UserActor[%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: _*)))
-//
-// private[this] def ERROR(t: Throwable, fmt: String, args: Any*) =
-// logger.error("UserActor[%s]: %s".format(D_userID, fmt.format(args: _*)), t)
+ private[this] def ERROR(t: Throwable, fmt: String, args: Any*) =
+ logger.error("[%s] - %s".format(D_userID, fmt.format(args: _*)), t)
}