package service
package user
-import java.util.Date
-import com.ckkloverdos.maybe.{Failed, NoVal, Just}
-
import gr.grnet.aquarium.actor._
-import gr.grnet.aquarium.Configurator
-import gr.grnet.aquarium.user._
-import gr.grnet.aquarium.util.Loggable
+import akka.config.Supervision.Temporary
+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.logic.accounting.RoleAgreements
-import gr.grnet.aquarium.messaging.AkkaAMQP
-import gr.grnet.aquarium.actor.message.config.user.UserActorInitWithUserId
-import gr.grnet.aquarium.actor.message.service.dispatcher._
-import message.config.{ActorProviderConfigured, AquariumPropertiesLoaded}
-import gr.grnet.aquarium.events.{WalletEntry, IMEvent}
-
+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}
/**
*
* @author Christos KK Loverdos <loverdos@gmail.com>
*/
-class UserActor extends AquariumActor
-with AkkaAMQP
-with ReflectiveAquariumActor
-with Loggable {
- @volatile
- private[this] var _userId: String = _
- @volatile
+class UserActor extends ReflectiveRoleableActor {
+ private[this] var _userID: String = "<?>"
+ private[this] var _imState: IMStateSnapshot = _
private[this] var _userState: UserState = _
- @volatile
- private[this] var _timestampTheshold: Long = _
- private[this] lazy val messenger = producer("aquarium") // FIXME: Read this from configuration
-
- def role = UserActorRole
+ self.lifeCycle = Temporary
- private[this] def _configurator: Configurator = Configurator.MasterConfigurator
+ private[this] def _shutmedown(): Unit = {
+ if(haveUserState) {
+ UserActorCache.invalidate(_userID)
+ }
- /**
- * Replay the event log for all events that affect the user state.
- */
- def rebuildState(from: Long, to: Long): Unit = {
- val start = TimeHelpers.nowMillis
- if(_userState == null)
- createBlankState
-
- //Rebuild state from user events
- val usersDB = _configurator.storeProvider.userEventStore
- val userEvents = usersDB.findIMEventsByUserId(_userId)
- val numUserEvents = userEvents.size
- _userState = replayIMEvents(_userState, userEvents, from, to)
-
- //Rebuild state from resource events
- val eventsDB = _configurator.storeProvider.resourceEventStore
- val resourceEvents = eventsDB.findResourceEventsByUserIdAfterTimestamp(_userId, from)
- val numResourceEvents = resourceEvents.size
- // _userState = replayResourceEvents(_userState, resourceEvents, from, to)
-
- //Rebuild state from wallet entries
- val wallet = _configurator.storeProvider.walletEntryStore
- val walletEnties = wallet.findWalletEntriesAfter(_userId, new Date(from))
- val numWalletEntries = walletEnties.size
- _userState = replayWalletEntries(_userState, walletEnties, from, to)
-
- INFO(("Rebuilt state from %d events (%d user events, " +
- "%d resource events, %d wallet entries) in %d msec").format(
- numUserEvents + numResourceEvents + numWalletEntries,
- numUserEvents, numResourceEvents, numWalletEntries,
- TimeHelpers.nowMillis - start))
+ self.stop()
}
- /**
- * Create an empty state for a user
- */
- def createBlankState = {
- this._userState = DefaultUserStateComputations.createInitialUserState(this._userId, 0L, true, 0.0)
- }
+ override protected def onThrowable(t: Throwable, message: AnyRef) = {
+ LogHelpers.logChainOfCauses(logger, t)
+ ERROR(t, "Terminating due to: %s(%s)", shortClassNameOf(t), t.getMessage)
- /**
- * Replay user events on the provided user state
- */
- def replayIMEvents(initState: UserState, events: List[IMEvent],
- from: Long, to: Long): UserState = {
- initState
+ _shutmedown()
}
+ def role = UserActorRole
- /**
- * Replay wallet entries on the provided user state
- */
- def replayWalletEntries(initState: UserState, events: List[WalletEntry],
- from: Long, to: Long): UserState = {
- initState
+ private[this] def aquarium: Aquarium = Aquarium.Instance
+ private[this] def userStateComputations = aquarium.userStateComputations
+
+ private[this] def _timestampTheshold = {
+ aquarium.props.getLong(Aquarium.Keys.user_state_timestamp_threshold).getOr(10000)
}
- /**
- * Persist current user state
- */
- private[this] def saveUserState(): Unit = {
- _configurator.storeProvider.userStateStore.storeUserState(this._userState) match {
- case Just(record) => record
- case NoVal => ERROR("Unknown error saving state")
- case Failed(e) =>
- ERROR("Saving state failed: %s".format(e));
- }
+ private[this] def haveUserState = {
+ this._userState ne null
+ }
+
+ private[this] def haveIMState = {
+ this._imState ne null
}
def onAquariumPropertiesLoaded(event: AquariumPropertiesLoaded): Unit = {
- this._timestampTheshold = event.props.getLong(Configurator.Keys.user_state_timestamp_threshold).getOr(10000)
- INFO("Setup my timestampTheshold = %s", this._timestampTheshold)
}
- def onUserActorInitWithUserId(event: UserActorInitWithUserId): Unit = {
- this._userId = event.userId
- DEBUG("Actor starting, loading state")
+ def onActorProviderConfigured(event: ActorProviderConfigured): Unit = {
}
- def onProcessResourceEvent(event: ProcessResourceEvent): Unit = {
- val resourceEvent = event.rcEvent
- if(resourceEvent.userID != this._userId) {
- ERROR("Received %s but my userId = %s".format(event, this._userId))
+ 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 {
- //ensureUserState()
- // calcWalletEntries()
- //processResourceEvent(resourceEvent, true)
+ this._imState = IMStateSnapshot.initial(imEvent)
+ (true, true, "")
}
}
- private[this] def processCreateUser(event: IMEvent): Unit = {
- val userId = event.userID
- DEBUG("Creating user from state %s", event)
- val usersDB = _configurator.storeProvider.userStateStore
- usersDB.findUserStateByUserId(userId) match {
- case Just(userState) ⇒
- WARN("User already created, state = %s".format(userState))
- case failed@Failed(e) ⇒
- ERROR("[%s] %s", e.getClass.getName, e.getMessage)
- case NoVal ⇒
- val agreement = RoleAgreements.agreementForRole(event.role)
- DEBUG("User %s assigned agreement %s".format(userId, agreement.name))
-
- this._userState = DefaultUserStateComputations.createInitialUserState(
- userId,
- event.occurredMillis,
- event.isActive, 0.0, List(event.role), agreement.name)
- saveUserState
- DEBUG("Created and stored %s", this._userState)
+ /**
+ * 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)
+ }
}
- }
- private[this] def processModifyUser(event: IMEvent): Unit = {
- val now = TimeHelpers.nowMillis
- val newActive = ActiveStateSnapshot(event.isStateActive, now)
+ if(_updateCount > 0)
+ DEBUG("Computed %s = %s", shortNameOfType[IMStateSnapshot], this._imState)
+ else
+ DEBUG("Not computed %s", shortNameOfType[IMStateSnapshot])
- DEBUG("New active status = %s".format(newActive))
+ _updateCount
+ }
- this._userState = this._userState.copy(activeStateSnapshot = newActive)
+ /**
+ * Resource events are processed only if the user has been activated.
+ */
+ private[this] def shouldProcessResourceEvents: Boolean = {
+ haveIMState && this._imState.hasBeenActivated
}
- def onProcessUserEvent(event: ProcessUserEvent): Unit = {
- val userEvent = event.imEvent
- if(userEvent.userID != this._userId) {
- ERROR("Received %s but my userId = %s".format(userEvent, this._userId))
- } else {
- if(userEvent.isCreateUser) {
- processCreateUser(userEvent)
- } else if(userEvent.isModifyUser) {
- processModifyUser(userEvent)
+ 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)
}
}
}
- def onRequestUserBalance(event: RequestUserBalance): Unit = {
- val userId = event.userId
- val timestamp = event.timestamp
+ 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(!this._imState.hasBeenActivated) {
+ // Cannot set the initial state!
+ DEBUG("Cannot create %s from %s, since user is inactive", shortNameOfType[UserState], event)
+ return
+ }
+
+ // We will also need this functionality when receiving IMEvents,
+ // so we place it in a method
+ loadUserStateAndUpdateRoleHistory()
- if(TimeHelpers.nowMillis - _userState.newestSnapshotTime > 60 * 1000) {
- // calcWalletEntries()
+ if(haveUserState) {
+ DEBUG("%s = %s", shortNameOfType[UserState], this._userState)
}
- self reply UserResponseGetBalance(userId, _userState.creditsSnapshot.creditAmount)
}
- def onUserRequestGetState(event: UserRequestGetState): Unit = {
- val userId = event.userId
- if(this._userId != userId) {
- ERROR("Received %s but my userId = %s".format(event, this._userId))
- // TODO: throw an exception here
+ def onInitializeUserState(event: InitializeUserState): Unit = {
+ val userID = event.userID
+ this._userID = userID
+ DEBUG("Got %s", event)
+
+ createInitialIMState(event)
+ createInitialUserState(event)
+ }
+
+ /**
+ * 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
+ )
+ }
+
+ /**
+ * 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 {
- // FIXME: implement
- ERROR("FIXME: Should have properly computed the user state")
- // ensureUserState()
- self reply UserResponseGetState(userId, this._userState)
+ DEBUG("Not updating %s from %s due to: %s", shortNameOfType[IMStateSnapshot], imEvent, noUpdateReason)
}
+
+ logSeparator()
}
- def onActorProviderConfigured(event: ActorProviderConfigured): Unit = {
+ 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
+ }
}
- override def postStop {
- DEBUG("Stopping, saving state")
- saveUserState
+ 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*/)
+ }
}
- override def preRestart(reason: Throwable) {
- DEBUG("Actor failed, restarting")
+ 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)))
+ }
}
- override def postRestart(reason: Throwable) {
- DEBUG("Actor restarted succesfully")
+ private[this] def D_userID = {
+ this._userID
}
private[this] def DEBUG(fmt: String, args: Any*) =
- logger.debug("UserActor[%s]: %s".format(_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(_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(_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(_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("[%s] - %s".format(D_userID, fmt.format(args: _*)), t)
}
projects / aquarium / blobdiff