Merge branch 'master'
[aquarium] / src / main / scala / gr / grnet / aquarium / actor / service / user / UserActor.scala
index 77ebfb9..eeb4821 100644 (file)
@@ -37,18 +37,28 @@ package gr.grnet.aquarium.actor
 package service
 package user
 
-import gr.grnet.aquarium.actor._
-
-import gr.grnet.aquarium.util.shortClassNameOf
-import message.config.{ActorProviderConfigured, AquariumPropertiesLoaded}
-import akka.config.Supervision.Temporary
-import gr.grnet.aquarium.Configurator
-import gr.grnet.aquarium.util.date.{TimeHelpers, MutableDateCalc}
-import gr.grnet.aquarium.actor.message.event.{ProcessResourceEvent, ProcessIMEvent}
-import gr.grnet.aquarium.actor.message.{GetUserStateResponse, GetUserBalanceResponse, GetUserStateRequest, GetUserBalanceRequest}
-import gr.grnet.aquarium.computation.data.IMStateSnapshot
-import gr.grnet.aquarium.computation.UserState
-import gr.grnet.aquarium.event.model.im.IMEventModel
+import gr.grnet.aquarium.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, 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.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
 
 /**
  *
@@ -56,119 +66,471 @@ import gr.grnet.aquarium.event.model.im.IMEventModel
  */
 
 class UserActor extends ReflectiveRoleableActor {
-  private[this] var _imState: IMStateSnapshot = _
-  private[this] var _userState: UserState = _
+  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) {
+      throw new AquariumInternalError("%s not initialized")
+    }
 
-  self.lifeCycle = Temporary
+    this._userID
+  }
 
-  private[this] def _userID = this._userState.userID
-  private[this] def _shutmedown(): Unit = {
-    if(_haveUserState) {
-      UserActorCache.invalidate(_userID)
-    }
+  override def postStop() {
+    DEBUG("I am finally stopped (in postStop())")
+    aquarium.akkaService.notifyUserActorPostStop(this)
+  }
 
-    self.stop()
+  private[this] def shutmedown(): Unit = {
+    if(haveUserID) {
+      aquarium.akkaService.invalidateUserActor(this)
+    }
   }
 
   override protected def onThrowable(t: Throwable, message: AnyRef) = {
-    logChainOfCauses(t)
+    LogHelpers.logChainOfCauses(logger, t)
     ERROR(t, "Terminating due to: %s(%s)", shortClassNameOf(t), t.getMessage)
 
-    _shutmedown()
+    shutmedown()
   }
 
   def role = UserActorRole
 
-  private[this] def _configurator: Configurator = Configurator.MasterConfigurator
+  private[this] def chargingService = aquarium.chargingService
 
-  private[this] def _timestampTheshold =
-    _configurator.props.getLong(Configurator.Keys.user_state_timestamp_threshold).getOr(10000)
+  private[this] def stdUserStateStoreFunc = (userState: UserStateMsg) ⇒ {
+    aquarium.userStateStore.insertUserState(userState)
+  }
+
+  @inline private[this] def haveUserID = {
+    this._userID ne null
+  }
 
+  def onAquariumPropertiesLoaded(event: AquariumPropertiesLoaded): Unit = {
+  }
 
-  private[this] def _haveUserState = {
+  @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 _haveIMState = {
-    this._imState ne null
+  @inline private[this] def haveUserStateBootstrap = {
+    this._userStateBootstrap ne null
   }
 
-  def onAquariumPropertiesLoaded(event: AquariumPropertiesLoaded): Unit = {
+  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 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 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
   }
 
-  def onActorProviderConfigured(event: ActorProviderConfigured): Unit = {
+  private[this] def updateLatestResourceEventIDFrom(rcEvent: ResourceEventMsg): Unit = {
+    this._latestResourceEventOriginalID = rcEvent.getOriginalID
   }
 
-  private[this] def _getAgreementNameForNewUser(imEvent: IMEventModel): String = {
-    // FIXME: Implement based on the role
-    "default"
+  /**
+   * Creates the initial state that is related to IMEvents.
+   *
+   * @return `true` if there was a user CREATE event
+   */
+  private[this] def initializeStateOfIMEvents(): Boolean = {
+    DEBUG("initializeStateOfIMEvents()")
+
+    // NOTE: this._userID is already set up our caller
+    var _imcounter = 0
+
+    aquarium.imEventStore.foreachIMEventInOccurrenceOrder(this._userID) { imEvent ⇒
+      _imcounter += 1
+      DEBUG("Replaying [%s] %s", _imcounter, imEvent)
+
+      if(_imcounter == 1 && !MessageHelpers.isIMEventCreate(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 {
+        updateAgreementHistoryFrom(imEvent)
+        true
+      }
+    }
   }
 
-  def onProcessIMEvent(event: ProcessIMEvent): Unit = {
+  private[this] def loadUserStateAndUpdateAgreementHistory(): Unit = {
+    assert(this.haveAgreements, "this.haveAgreements")
+
+    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
+    )
+
+    // 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))
+    }
+  }
 
-    val imEvent = event.imEvent
-    val hadIMState = _haveIMState
+  private[this] def initializeStateOfResourceEvents(): Unit = {
+    DEBUG("initializeStateOfResourceEvents()")
+    assert(haveAgreements)
 
-    if(hadIMState) {
-      val newOccurredMillis = imEvent.occurredMillis
-      val currentOccurredMillis = this._imState.imEvent.occurredMillis
+    // We will also need this functionality when receiving IMEvents, so we place it in a method
+    loadUserStateAndUpdateAgreementHistory()
 
-      if(newOccurredMillis < currentOccurredMillis) {
-        INFO(
-          "Ignoring older IMEvent: [%s] < [%s]",
-          new MutableDateCalc(newOccurredMillis).toYYYYMMDDHHMMSSSSS,
-          new MutableDateCalc(currentOccurredMillis).toYYYYMMDDHHMMSSSSS)
+    if(haveUserState) {
+      DEBUG("Initial working user state %s", AvroHelpers.jsonStringOfSpecificRecord(this._userState.msg))
+      logSeparator()
+    }
+  }
 
-        return
-      }
+  /**
+   * Initializes the actor state from DB.
+   */
+  def initializeUserActorState(userID: String): Boolean = {
+    this._userID = userID
+
+    if(initializeStateOfIMEvents()) {
+      initializeStateOfResourceEvents()
+      // Even if we have no resource events, the user is at least CREATEd
+      true
+    }
+    else {
+      false
+    }
+  }
+
+  def createUserStateBootstrap(imEvent: IMEventMsg) {
+    assert(MessageHelpers.isIMEventCreate(imEvent), "MessageHelpers.isIMEventCreate(imEvent)")
+    assert(this._userCreationIMEvent == imEvent, "this._userCreationIMEvent == imEvent")
+
+    this._userStateBootstrap = aquarium.getUserStateBootstrap(this._userCreationIMEvent)
+  }
+
+  /**
+   * Processes [[gr.grnet.aquarium.message.avro.gen.IMEventMsg]]s that come directly from the
+   * 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)
+
+      return
     }
 
-    this._imState = IMStateSnapshot(imEvent)
-    DEBUG("%s %s", if(hadIMState) "Update" else "Set", shortClassNameOf(this._imState))
+    // Check for out of sync (regarding IMEvents)
+    val isOutOfSyncIM = imEvent.getOccurredMillis < this._latestIMEventOccurredMillis
+    if(isOutOfSyncIM) {
+      // clear all resource state
+      // FIXME implement
+
+      return
+    }
+
+    // Check out of sync (regarding ResourceEvents)
+    val isOutOfSyncRC = false // FIXME implement
+    if(isOutOfSyncRC) {
+      // TODO
+
+      return
+    }
+
+    // OK, seems good
+    assert(!MessageHelpers.isIMEventCreate(imEvent), "!MessageHelpers.isIMEventCreate(imEvent)")
+    updateAgreementHistoryFrom(imEvent)
   }
 
-  def onGetUserBalanceRequest(event: GetUserBalanceRequest): Unit = {
-    val userId = event.userID
-    // FIXME: Implement
-    self reply GetUserBalanceResponse(userId, Right(_userState.creditsSnapshot.creditAmount))
+  def onResourceEventMsg(rcEvent: ResourceEventMsg) {
+    if(!haveAgreements) {
+      DEBUG("No agreement. Ignoring %s", rcEvent)
+
+      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)
+    }
+
+    def computeRealtime(): Unit = {
+      DEBUG("Going for in sync charging for %s", rcEvent.getOriginalID)
+      chargingService.processResourceEvent(
+        rcEvent,
+        this._userState,
+        nowBillingMonthInfo,
+        true
+      )
+
+      updateLatestResourceEventIDFrom(rcEvent)
+    }
+
+    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))
+
+      computeBatch()
+    }
+    val newTotalCredits = this._userState.totalCredits
+    if(oldTotalCredits * newTotalCredits < 0)
+      aquarium.eventBus ! new BalanceEvent(this._userState.userID,
+        newTotalCredits>=0)
+    DEBUG("Updated %s", this._userState)
+    logSeparator()
   }
 
-  def onGetUserStateRequest(event: GetUserStateRequest): Unit = {
-    val userId = event.userID
-   // FIXME: Implement
-    self reply GetUserStateResponse(userId, Right(this._userState))
+  def onGetUserBillRequest(event: GetUserBillRequest): Unit = {
+    try{
+      val timeslot = event.timeslot
+      val resourceTypes = 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 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 onProcessResourceEvent(event: ProcessResourceEvent): Unit = {
-    val rcEvent = event.rcEvent
+  def onGetUserBalanceRequest(event: GetUserBalanceRequest): Unit = {
+    val userID = event.userID
+
+    (haveAgreements, haveUserState) match {
+      case (true, true) ⇒
+        // (User CREATEd, with balance state)
+        val realtimeMillis = TimeHelpers.nowMillis()
+        chargingService.calculateRealtimeUserState(
+          this._userState,
+          BillingMonthInfo.fromMillis(realtimeMillis),
+          realtimeMillis
+        )
+
+        sender ! GetUserBalanceResponse(Right(GetUserBalanceResponseData(this._userID, this._userState.totalCredits)))
+
+      case (true, false) ⇒
+        // (User CREATEd, no balance state)
+        // Return the default initial balance
+        sender ! GetUserBalanceResponse(
+          Right(
+            GetUserBalanceResponseData(
+              this._userID,
+              aquarium.initialUserBalance(this._userCreationIMEvent.getRole, this._userCreationIMEvent.getOccurredMillis)
+            )))
+
+      case (false, true) ⇒
+        // (Not CREATEd, with balance state)
+        // Clearly this is internal error
+        sender ! GetUserBalanceResponse(Left("Internal Server Error [AQU-BAL-0001]"), 500)
+
+      case (false, false) ⇒
+        // (Not CREATEd, no balance state)
+        // The user is completely unknown
+        sender ! GetUserBalanceResponse(Left("Unknown user %s [AQU-BAL-0004]".format(userID)), 404/*Not found*/)
+    }
+  }
 
-    logger.info("Got\n{}", rcEvent.toJsonString)
+  def onGetUserStateRequest(event: GetUserStateRequest): Unit = {
+    haveUserState match {
+      case true ⇒
+        val realtimeMillis = TimeHelpers.nowMillis()
+        chargingService.calculateRealtimeUserState(
+          this._userState,
+          BillingMonthInfo.fromMillis(realtimeMillis),
+          realtimeMillis
+        )
+
+        sender ! GetUserStateResponse(Right(this._userState.msg))
+
+      case false ⇒
+        sender ! GetUserStateResponse(Left("No state for user %s [AQU-STA-0006]".format(event.userID)), 404)
+    }
   }
 
+  def onGetUserWalletRequest(event: GetUserWalletRequest): Unit = {
+    haveUserState match {
+      case true ⇒
+        DEBUG("haveWorkingUserState: %s", event)
+        val realtimeMillis = TimeHelpers.nowMillis()
+        chargingService.calculateRealtimeUserState(
+          this._userState,
+          BillingMonthInfo.fromMillis(realtimeMillis),
+          realtimeMillis
+        )
+
+        sender ! GetUserWalletResponse(
+          Right(
+            GetUserWalletResponseData(
+              this._userID,
+              this._userState.totalCredits,
+              MessageFactory.newWalletEntriesMsg(this._userState.msg.getWalletEntries)
+            )))
+
+      case false ⇒
+        DEBUG("!haveWorkingUserState: %s", event)
+        haveAgreements match {
+          case true ⇒
+            DEBUG("haveAgreements: %s", event)
+            sender ! GetUserWalletResponse(
+              Right(
+                GetUserWalletResponseData(
+                  this._userID,
+                  aquarium.initialUserBalance(this._userCreationIMEvent.getRole, this._userCreationIMEvent.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)
+        }
+    }
+  }
 
   private[this] def D_userID = {
-    if(this._userState eq null)
-      if(this._imState eq null)
-        "<NOT INITIALIZED>"
-      else
-        this._imState.imEvent.userID
-    else
-      this._userState.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)
 }