Serialize updated value of entity document in response

common/scala/src/main/scala/org/apache/openwhisk/core/entity/WhiskAction.scala

@@ -19,6 +19,7 @@ package org.apache.openwhisk.core.entity
 
 import java.io.{ByteArrayInputStream, ByteArrayOutputStream}
 import java.nio.charset.StandardCharsets.UTF_8
+import java.time.Instant
 import java.util.Base64
 
 import akka.http.scaladsl.model.ContentTypes
@@ -122,7 +123,8 @@ abstract class WhiskActionLikeMetaData(override val name: EntityName) extends Wh
  * @param limits the limits to impose on the action
  * @param version the semantic version
  * @param publish true to share the action or false otherwise
- * @param annotation the set of annotations to attribute to the action
+ * @param annotations the set of annotations to attribute to the action
+ * @param updated the timestamp when the action is updated
  * @throws IllegalArgumentException if any argument is undefined
  */
 @throws[IllegalArgumentException]
@@ -133,7 +135,8 @@ case class WhiskAction(namespace: EntityPath,
                        limits: ActionLimits = ActionLimits(),
                        version: SemVer = SemVer(),
                        publish: Boolean = false,
-                       annotations: Parameters = Parameters())
+                       annotations: Parameters = Parameters(),
+                       override val updated: Instant = WhiskEntity.currentMillis())
     extends WhiskActionLike(name) {
 
   require(exec != null, "exec undefined")
@@ -200,6 +203,7 @@ case class WhiskActionMetaData(namespace: EntityPath,
                                version: SemVer = SemVer(),
                                publish: Boolean = false,
                                annotations: Parameters = Parameters(),
+                               override val updated: Instant = WhiskEntity.currentMillis(),
                                binding: Option[EntityPath] = None)
     extends WhiskActionLikeMetaData(name) {
 
@@ -264,7 +268,7 @@ case class WhiskActionMetaData(namespace: EntityPath,
  * @param limits the limits to impose on the action
  * @param version the semantic version
  * @param publish true to share the action or false otherwise
- * @param annotation the set of annotations to attribute to the action
+ * @param annotations the set of annotations to attribute to the action
  * @param binding the path of the package binding if any
  * @throws IllegalArgumentException if any argument is undefined
  */
@@ -330,7 +334,7 @@ case class ExecutableWhiskActionMetaData(namespace: EntityPath,
   require(limits != null, "limits undefined")
 
   def toWhiskAction =
-    WhiskActionMetaData(namespace, name, exec, parameters, limits, version, publish, annotations)
+    WhiskActionMetaData(namespace, name, exec, parameters, limits, version, publish, annotations, updated)
       .revision[WhiskActionMetaData](rev)
 
   /**
@@ -342,11 +346,13 @@ case class ExecutableWhiskActionMetaData(namespace: EntityPath,
 }
 
 object WhiskAction extends DocumentFactory[WhiskAction] with WhiskEntityQueries[WhiskAction] with DefaultJsonProtocol {
+  import WhiskActivation.instantSerdes
 
   val execFieldName = "exec"
   val requireWhiskAuthHeader = "x-require-whisk-auth"
 
   override val collectionName = "actions"
+  override val cacheEnabled = true
 
   override implicit val serdes = jsonFormat(
     WhiskAction.apply,
@@ -357,9 +363,8 @@ object WhiskAction extends DocumentFactory[WhiskAction] with WhiskEntityQueries[
     "limits",
     "version",
     "publish",
-    "annotations")
-
-  override val cacheEnabled = true
+    "annotations",
+    "updated")
 
   // overriden to store attached code
   override def put[A >: WhiskAction](db: ArtifactStore[A], doc: WhiskAction, old: Option[WhiskAction])(
@@ -547,7 +552,10 @@ object WhiskActionMetaData
     with WhiskEntityQueries[WhiskActionMetaData]
     with DefaultJsonProtocol {
 
+  import WhiskActivation.instantSerdes
+
   override val collectionName = "actions"
+  override val cacheEnabled = true
 
   override implicit val serdes = jsonFormat(
     WhiskActionMetaData.apply,
@@ -559,10 +567,9 @@ object WhiskActionMetaData
     "version",
     "publish",
     "annotations",
+    "updated",
     "binding")
 
-  override val cacheEnabled = true
-
   /**
    * Resolves an action name if it is contained in a package.
    * Look up the package to determine if it is a binding or the actual package.

common/scala/src/main/scala/org/apache/openwhisk/core/entity/WhiskEntity.scala

@@ -19,10 +19,9 @@ package org.apache.openwhisk.core.entity
 
 import java.time.Clock
 import java.time.Instant
+import java.time.temporal.ChronoUnit
 
-import scala.Stream
 import scala.util.Try
-
 import spray.json._
 import org.apache.openwhisk.core.database.DocumentUnreadable
 import org.apache.openwhisk.core.database.DocumentTypeMismatchException
@@ -37,7 +36,7 @@ import org.apache.openwhisk.http.Messages
  * @param namespace the namespace for the entity as an abstract field
  * @param version the semantic version as an abstract field
  * @param publish true to share the entity and false to keep it private as an abstract field
- * @param annotation the set of annotations to attribute to the entity
+ * @param annotations the set of annotations to attribute to the entity
  *
  * @throws IllegalArgumentException if any argument is undefined
  */
@@ -49,7 +48,7 @@ abstract class WhiskEntity protected[entity] (en: EntityName, val entityType: St
   val version: SemVer
   val publish: Boolean
   val annotations: Parameters
-  val updated = Instant.now(Clock.systemUTC())
+  val updated = WhiskEntity.currentMillis()
 
   /**
    * The name of the entity qualified with its namespace and version for
@@ -112,6 +111,15 @@ object WhiskEntity {
   def qualifiedName(namespace: EntityPath, activationId: ActivationId) = {
     s"$namespace${EntityPath.PATHSEP}$activationId"
   }
+
+  /**
+   * Get Instant object with a millisecond precision
+   * timestamp of whisk entity is stored in milliseconds in the db
+   */
+  def currentMillis() = {
+    Instant.now(Clock.systemUTC()).truncatedTo(ChronoUnit.MILLIS)
+  }
+
 }
 
 object WhiskDocumentReader extends DocumentReader {

common/scala/src/main/scala/org/apache/openwhisk/core/entity/WhiskPackage.scala

@@ -17,11 +17,12 @@
 
 package org.apache.openwhisk.core.entity
 
+import java.time.Instant
+
 import scala.concurrent.ExecutionContext
 import scala.concurrent.Future
 import scala.language.postfixOps
 import scala.util.Try
-
 import spray.json.DefaultJsonProtocol
 import spray.json.DefaultJsonProtocol._
 import spray.json._
@@ -60,7 +61,8 @@ case class WhiskPackagePut(binding: Option[Binding] = None,
  * @param parameters the set of parameters to bind to the action environment
  * @param version the semantic version
  * @param publish true to share the action or false otherwise
- * @param annotation the set of annotations to attribute to the package
+ * @param annotations the set of annotations to attribute to the package
+ * @param updated the timestamp when the package is updated
  * @throws IllegalArgumentException if any argument is undefined
  */
 @throws[IllegalArgumentException]
@@ -70,7 +72,8 @@ case class WhiskPackage(namespace: EntityPath,
                         parameters: Parameters = Parameters(),
                         version: SemVer = SemVer(),
                         publish: Boolean = false,
-                        annotations: Parameters = Parameters())
+                        annotations: Parameters = Parameters(),
+                        override val updated: Instant = WhiskEntity.currentMillis())
     extends WhiskEntity(name, "package") {
 
   require(binding != null || (binding map { _ != null } getOrElse true), "binding undefined")
@@ -159,6 +162,8 @@ object WhiskPackage
     with WhiskEntityQueries[WhiskPackage]
     with DefaultJsonProtocol {
 
+  import WhiskActivation.instantSerdes
+
   val bindingFieldName = "binding"
   override val collectionName = "packages"
 
@@ -197,7 +202,7 @@ object WhiskPackage
       override def write(b: Option[Binding]) = Binding.optionalBindingSerializer.write(b)
       override def read(js: JsValue) = Binding.optionalBindingDeserializer.read(js)
     }
-    jsonFormat7(WhiskPackage.apply)
+    jsonFormat8(WhiskPackage.apply)
   }
 
   override val cacheEnabled = true

common/scala/src/main/scala/org/apache/openwhisk/core/entity/WhiskRule.scala

@@ -17,10 +17,11 @@
 
 package org.apache.openwhisk.core.entity
 
+import java.time.Instant
+
 import scala.util.Failure
 import scala.util.Success
 import scala.util.Try
-
 import spray.json.DefaultJsonProtocol
 import spray.json.DeserializationException
 import spray.json.JsObject
@@ -65,7 +66,8 @@ case class WhiskRulePut(trigger: Option[FullyQualifiedEntityName] = None,
  * @param action the action name to invoke invoke when trigger is fired
  * @param version the semantic version
  * @param publish true to share the action or false otherwise
- * @param annotation the set of annotations to attribute to the rule
+ * @param annotations the set of annotations to attribute to the rule
+ * @param updated the timestamp when the rule is updated
  * @throws IllegalArgumentException if any argument is undefined
  */
 @throws[IllegalArgumentException]
@@ -75,10 +77,12 @@ case class WhiskRule(namespace: EntityPath,
                      action: FullyQualifiedEntityName,
                      version: SemVer = SemVer(),
                      publish: Boolean = false,
-                     annotations: Parameters = Parameters())
+                     annotations: Parameters = Parameters(),
+                     override val updated: Instant = WhiskEntity.currentMillis())
     extends WhiskEntity(name, "rule") {
 
-  def withStatus(s: Status) = WhiskRuleResponse(namespace, name, s, trigger, action, version, publish, annotations)
+  def withStatus(s: Status) =
+    WhiskRuleResponse(namespace, name, s, trigger, action, version, publish, annotations, updated)
 
   def toJson = WhiskRule.serdes.write(this).asJsObject
 }
@@ -95,7 +99,7 @@ case class WhiskRule(namespace: EntityPath,
  * @param action the action name to invoke invoke when trigger is fired
  * @param version the semantic version
  * @param publish true to share the action or false otherwise
- * @param annotation the set of annotations to attribute to the rule
+ * @param annotations the set of annotations to attribute to the rule
  */
 case class WhiskRuleResponse(namespace: EntityPath,
                              name: EntityName,
@@ -104,7 +108,8 @@ case class WhiskRuleResponse(namespace: EntityPath,
                              action: FullyQualifiedEntityName,
                              version: SemVer = SemVer(),
                              publish: Boolean = false,
-                             annotations: Parameters = Parameters()) {
+                             annotations: Parameters = Parameters(),
+                             updated: Instant) {
 
   def toWhiskRule = WhiskRule(namespace, name, trigger, action, version, publish, annotations)
 }
@@ -195,11 +200,12 @@ protected[core] object Status extends ArgNormalizer[Status] {
 }
 
 object WhiskRule extends DocumentFactory[WhiskRule] with WhiskEntityQueries[WhiskRule] with DefaultJsonProtocol {
+  import WhiskActivation.instantSerdes
 
   override val collectionName = "rules"
 
   private implicit val fqnSerdes = FullyQualifiedEntityName.serdes
-  private val caseClassSerdes = jsonFormat7(WhiskRule.apply)
+  private val caseClassSerdes = jsonFormat8(WhiskRule.apply)
 
   override implicit val serdes = new RootJsonFormat[WhiskRule] {
     def write(r: WhiskRule) = caseClassSerdes.write(r)
@@ -233,8 +239,9 @@ object WhiskRule extends DocumentFactory[WhiskRule] with WhiskEntityQueries[Whis
 }
 
 object WhiskRuleResponse extends DefaultJsonProtocol {
+  import WhiskActivation.instantSerdes
   private implicit val fqnSerdes = FullyQualifiedEntityName.serdes
-  implicit val serdes = jsonFormat8(WhiskRuleResponse.apply)
+  implicit val serdes = jsonFormat9(WhiskRuleResponse.apply)
 }
 
 object WhiskRulePut extends DefaultJsonProtocol {

common/scala/src/main/scala/org/apache/openwhisk/core/entity/WhiskTrigger.scala

@@ -17,6 +17,8 @@
 
 package org.apache.openwhisk.core.entity
 
+import java.time.Instant
+
 import spray.json.DefaultJsonProtocol
 import org.apache.openwhisk.core.database.DocumentFactory
 import spray.json._
@@ -54,8 +56,9 @@ case class ReducedRule(action: FullyQualifiedEntityName, status: Status)
  * @param limits the limits to impose on the trigger
  * @param version the semantic version
  * @param publish true to share the action or false otherwise
- * @param annotation the set of annotations to attribute to the trigger
+ * @param annotations the set of annotations to attribute to the trigger
  * @param rules the map of the rules that are associated with this trigger. Key is the rulename and value is the ReducedRule
+ * @param updated the timestamp when the trigger is updated
  * @throws IllegalArgumentException if any argument is undefined
  */
 @throws[IllegalArgumentException]
@@ -66,7 +69,8 @@ case class WhiskTrigger(namespace: EntityPath,
                         version: SemVer = SemVer(),
                         publish: Boolean = false,
                         annotations: Parameters = Parameters(),
-                        rules: Option[Map[FullyQualifiedEntityName, ReducedRule]] = None)
+                        rules: Option[Map[FullyQualifiedEntityName, ReducedRule]] = None,
+                        override val updated: Instant = WhiskEntity.currentMillis())
     extends WhiskEntity(name, "trigger") {
 
   require(limits != null, "limits undefined")
@@ -108,11 +112,12 @@ object WhiskTrigger
     extends DocumentFactory[WhiskTrigger]
     with WhiskEntityQueries[WhiskTrigger]
     with DefaultJsonProtocol {
+  import WhiskActivation.instantSerdes
 
   override val collectionName = "triggers"
 
   private implicit val fqnSerdesAsDocId = FullyQualifiedEntityName.serdesAsDocId
-  override implicit val serdes = jsonFormat8(WhiskTrigger.apply)
+  override implicit val serdes = jsonFormat9(WhiskTrigger.apply)
 
   override val cacheEnabled = true
 }

core/controller/src/main/resources/apiv1swagger.json

@@ -1998,6 +1998,10 @@
             "deactivating"
           ]
         },
+        "updated": {
+          "type": "integer",
+          "description": "Time when the rule was updated"
+        },
         "trigger": {
           "$ref": "#/definitions/PathName"
         },