Merge pull request #849 from nasa/event-throttle-time-dict

Fix dictionary encoding of event throttles

Author: Kronos3

compiler/lib/src/main/scala/codegen/DictionaryJsonWriter/DictionaryJsonEncoder.scala

@@ -461,6 +461,25 @@ case class DictionaryJsonEncoder(
         }
     }
 
+    /** JSON Encoding for Event.Throttle */
+    private implicit def eventThrottleEncoder: Encoder[Event.Throttle] = new Encoder[Event.Throttle] {
+        override def apply(throttle: Event.Throttle): Json = {
+            throttle match {
+                case Event.Throttle(count, Some(every)) => Json.obj(
+                    "count" -> count.asJson,
+                    "every" -> Json.obj(
+                        "seconds" -> every.seconds.asJson,
+                        "useconds" -> every.useconds.asJson
+                    )
+                )
+                case Event.Throttle(count, None) => Json.obj(
+                    "count" -> count.asJson,
+                    "every" -> Json.Null
+                )
+            }
+        }
+    }
+
     /** JSON Encoding for TlmChannel.Limits */
     private implicit def channelLimitEncoder: Encoder[TlmChannel.Limits] = new Encoder[TlmChannel.Limits] {
         override def apply(limits: TlmChannel.Limits): Json = {
@@ -604,6 +623,7 @@ case class DictionaryJsonEncoder(
                 }
                 case x: Value => Json.obj(key -> valueAsJson(x)).deepMerge(json)
                 case x: Ast.QueueFull => Json.obj(key -> x.toString.asJson).deepMerge(json)
+                case x: Event.Throttle => Json.obj(key -> x.asJson).deepMerge(json)
             }
             case None => json
         }

compiler/tools/fpp-to-dict/test/dictionary.schema.json

@@ -407,7 +407,26 @@
                         "type": "string"
                     },
                     "throttle": {
-                        "type": "number"
+                        "type": "object",
+                        "properties": {
+                            "count": {
+                                "type": "integer",
+                                "minimum": 1
+                            },
+                            "interval": {
+                                "type": "object",
+                                "properties": {
+                                    "seconds": {
+                                        "type": "integer",
+                                        "minimum": 0
+                                    },
+                                    "useconds": {
+                                        "type": "integer",
+                                        "minimum": 0
+                                    }
+                                }
+                            }
+                        }
                     }
                 },
                 "required": [
@@ -568,4 +587,4 @@
             }
         }
     }
-}
+}

compiler/tools/fpp-to-dict/test/top/FirstTopTopologyDictionary.ref.json

@@ -978,6 +978,55 @@
       "format" : "Arg1 is {f}",
       "annotation" : "Event with format specifier\nMultiple lines of annotation\nAnd not used on purpose"
     },
+    {
+      "name" : "Module1.myFirstC1.Event4",
+      "severity" : "ACTIVITY_HI",
+      "formalParams" : [
+        {
+          "name" : "arg1",
+          "type" : {
+            "name" : "F64",
+            "kind" : "float",
+            "size" : 64
+          },
+          "ref" : false,
+          "annotation" : "description of arg1 formal param"
+        }
+      ],
+      "id" : 771,
+      "format" : "Arg1 is {}",
+      "annotation" : "Event with throttle",
+      "throttle" : {
+        "count" : 10,
+        "every" : null
+      }
+    },
+    {
+      "name" : "Module1.myFirstC1.Event5",
+      "severity" : "ACTIVITY_HI",
+      "formalParams" : [
+        {
+          "name" : "arg1",
+          "type" : {
+            "name" : "F64",
+            "kind" : "float",
+            "size" : 64
+          },
+          "ref" : false,
+          "annotation" : "description of arg1 formal param"
+        }
+      ],
+      "id" : 772,
+      "format" : "Arg1 is {}",
+      "annotation" : "Event with throttle and timeout",
+      "throttle" : {
+        "count" : 10,
+        "every" : {
+          "seconds" : 10,
+          "useconds" : 0
+        }
+      }
+    },
     {
       "name" : "Module1.myFirstC2.Event1",
       "severity" : "WARNING_LO",

compiler/tools/fpp-to-dict/test/top/SecondTopTopologyDictionary.ref.json

@@ -978,6 +978,55 @@
       "format" : "Arg1 is {f}",
       "annotation" : "Event with format specifier\nMultiple lines of annotation\nAnd not used on purpose"
     },
+    {
+      "name" : "Module1.mySecondC1.Event4",
+      "severity" : "ACTIVITY_HI",
+      "formalParams" : [
+        {
+          "name" : "arg1",
+          "type" : {
+            "name" : "F64",
+            "kind" : "float",
+            "size" : 64
+          },
+          "ref" : false,
+          "annotation" : "description of arg1 formal param"
+        }
+      ],
+      "id" : 1283,
+      "format" : "Arg1 is {}",
+      "annotation" : "Event with throttle",
+      "throttle" : {
+        "count" : 10,
+        "every" : null
+      }
+    },
+    {
+      "name" : "Module1.mySecondC1.Event5",
+      "severity" : "ACTIVITY_HI",
+      "formalParams" : [
+        {
+          "name" : "arg1",
+          "type" : {
+            "name" : "F64",
+            "kind" : "float",
+            "size" : 64
+          },
+          "ref" : false,
+          "annotation" : "description of arg1 formal param"
+        }
+      ],
+      "id" : 1284,
+      "format" : "Arg1 is {}",
+      "annotation" : "Event with throttle and timeout",
+      "throttle" : {
+        "count" : 10,
+        "every" : {
+          "seconds" : 10,
+          "useconds" : 0
+        }
+      }
+    },
     {
       "name" : "Module1.mySecondC2.Event1",
       "severity" : "WARNING_LO",

compiler/tools/fpp-to-dict/test/top/multipleTops.fpp

@@ -132,6 +132,23 @@ module Module1 {
       severity activity high \
       format "Arg1 is {f}"
 
+    @ Event with throttle
+    event Event4(
+      arg1: F64 @< description of arg1 formal param
+    ) \
+      severity activity high \
+      format "Arg1 is {}" \
+      throttle 10
+
+    @ Event with throttle and timeout
+    event Event5(
+      arg1: F64 @< description of arg1 formal param
+    ) \
+      severity activity high \
+      format "Arg1 is {}" \
+      throttle 10 \
+      every {seconds=10}
+
 
     # Telemtry Channels
     @ Telemetry channel of type F64 with high and low limits