Merge pull request #43 from returntocorp/brandon/add-memory-usage

feat!: add memory usage

Author: brandonspark

semgrep_output_v1.atd

@@ -316,6 +316,8 @@ type core_timing
   (* Needs to be separate to include rules read but not run on any target *)
   rules: rule_id list;
   ?rules_parse_time: float option; (* not used in spacegrep *)
+
+  max_memory_bytes : int;
 }
 
 (* later: could refactor [target_time] and [rule_times] to be equal
@@ -642,6 +644,8 @@ type cli_timing <ocaml attr="deriving show"> = {
     profiling_times: (string * float) list <json repr="object"> <python repr="dict">;
     targets: cli_target_times list;
     total_bytes: int;
+
+    ?max_memory_bytes : int option;
   }
 
 (* LATER: should just use rule_id *)

semgrep_output_v1.jsonschema

@@ -232,7 +232,7 @@
     },
     "core_timing": {
       "type": "object",
-      "required": [ "targets", "rules" ],
+      "required": [ "targets", "rules", "max_memory_bytes" ],
       "properties": {
         "targets": {
           "type": "array",
@@ -242,7 +242,8 @@
           "type": "array",
           "items": { "$ref": "#/definitions/rule_id" }
         },
-        "rules_parse_time": { "type": "number" }
+        "rules_parse_time": { "type": "number" },
+        "max_memory_bytes": { "type": "integer" }
       }
     },
     "target_time": {
@@ -568,7 +569,8 @@
           "type": "array",
           "items": { "$ref": "#/definitions/cli_target_times" }
         },
-        "total_bytes": { "type": "integer" }
+        "total_bytes": { "type": "integer" },
+        "max_memory_bytes": { "type": "integer" }
       }
     },
     "rule_id_dict": {

semgrep_output_v1.py

@@ -2080,6 +2080,7 @@ class CoreTiming:
 
     targets: List[TargetTime]
     rules: List[RuleId]
+    max_memory_bytes: int
     rules_parse_time: Optional[float] = None
 
     @classmethod
@@ -2088,6 +2089,7 @@ def from_json(cls, x: Any) -> 'CoreTiming':
             return cls(
                 targets=_atd_read_list(TargetTime.from_json)(x['targets']) if 'targets' in x else _atd_missing_json_field('CoreTiming', 'targets'),
                 rules=_atd_read_list(RuleId.from_json)(x['rules']) if 'rules' in x else _atd_missing_json_field('CoreTiming', 'rules'),
+                max_memory_bytes=_atd_read_int(x['max_memory_bytes']) if 'max_memory_bytes' in x else _atd_missing_json_field('CoreTiming', 'max_memory_bytes'),
                 rules_parse_time=_atd_read_float(x['rules_parse_time']) if 'rules_parse_time' in x else None,
             )
         else:
@@ -2097,6 +2099,7 @@ def to_json(self) -> Any:
         res: Dict[str, Any] = {}
         res['targets'] = _atd_write_list((lambda x: x.to_json()))(self.targets)
         res['rules'] = _atd_write_list((lambda x: x.to_json()))(self.rules)
+        res['max_memory_bytes'] = _atd_write_int(self.max_memory_bytes)
         if self.rules_parse_time is not None:
             res['rules_parse_time'] = _atd_write_float(self.rules_parse_time)
         return res
@@ -2649,6 +2652,7 @@ class CliTiming:
     profiling_times: Dict[str, float]
     targets: List[CliTargetTimes]
     total_bytes: int
+    max_memory_bytes: Optional[int] = None
 
     @classmethod
     def from_json(cls, x: Any) -> 'CliTiming':
@@ -2659,6 +2663,7 @@ def from_json(cls, x: Any) -> 'CliTiming':
                 profiling_times=_atd_read_assoc_object_into_dict(_atd_read_float)(x['profiling_times']) if 'profiling_times' in x else _atd_missing_json_field('CliTiming', 'profiling_times'),
                 targets=_atd_read_list(CliTargetTimes.from_json)(x['targets']) if 'targets' in x else _atd_missing_json_field('CliTiming', 'targets'),
                 total_bytes=_atd_read_int(x['total_bytes']) if 'total_bytes' in x else _atd_missing_json_field('CliTiming', 'total_bytes'),
+                max_memory_bytes=_atd_read_int(x['max_memory_bytes']) if 'max_memory_bytes' in x else None,
             )
         else:
             _atd_bad_json('CliTiming', x)
@@ -2670,6 +2675,8 @@ def to_json(self) -> Any:
         res['profiling_times'] = _atd_write_assoc_dict_to_object(_atd_write_float)(self.profiling_times)
         res['targets'] = _atd_write_list((lambda x: x.to_json()))(self.targets)
         res['total_bytes'] = _atd_write_int(self.total_bytes)
+        if self.max_memory_bytes is not None:
+            res['max_memory_bytes'] = _atd_write_int(self.max_memory_bytes)
         return res
 
     @classmethod

semgrep_output_v1.ts

@@ -128,6 +128,7 @@ export type CoreTiming = {
   targets: TargetTime[];
   rules: RuleId[];
   rules_parse_time?: number;
+  max_memory_bytes: Int;
 }
 
 export type TargetTime = {
@@ -292,6 +293,7 @@ export type CliTiming = {
   profiling_times: [string, number][];
   targets: CliTargetTimes[];
   total_bytes: Int;
+  max_memory_bytes?: Int;
 }
 
 export type RuleIdDict = {
@@ -775,6 +777,7 @@ export function writeCoreTiming(x: CoreTiming, context: any = x): any {
     'targets': _atd_write_required_field('CoreTiming', 'targets', _atd_write_array(writeTargetTime), x.targets, x),
     'rules': _atd_write_required_field('CoreTiming', 'rules', _atd_write_array(writeRuleId), x.rules, x),
     'rules_parse_time': _atd_write_optional_field(_atd_write_float, x.rules_parse_time, x),
+    'max_memory_bytes': _atd_write_required_field('CoreTiming', 'max_memory_bytes', _atd_write_int, x.max_memory_bytes, x),
   };
 }
 
@@ -783,6 +786,7 @@ export function readCoreTiming(x: any, context: any = x): CoreTiming {
     targets: _atd_read_required_field('CoreTiming', 'targets', _atd_read_array(readTargetTime), x['targets'], x),
     rules: _atd_read_required_field('CoreTiming', 'rules', _atd_read_array(readRuleId), x['rules'], x),
     rules_parse_time: _atd_read_optional_field(_atd_read_float, x['rules_parse_time'], x),
+    max_memory_bytes: _atd_read_required_field('CoreTiming', 'max_memory_bytes', _atd_read_int, x['max_memory_bytes'], x),
   };
 }
 
@@ -1238,6 +1242,7 @@ export function writeCliTiming(x: CliTiming, context: any = x): any {
     'profiling_times': _atd_write_required_field('CliTiming', 'profiling_times', _atd_write_assoc_array_to_object(_atd_write_float), x.profiling_times, x),
     'targets': _atd_write_required_field('CliTiming', 'targets', _atd_write_array(writeCliTargetTimes), x.targets, x),
     'total_bytes': _atd_write_required_field('CliTiming', 'total_bytes', _atd_write_int, x.total_bytes, x),
+    'max_memory_bytes': _atd_write_optional_field(_atd_write_int, x.max_memory_bytes, x),
   };
 }
 
@@ -1248,6 +1253,7 @@ export function readCliTiming(x: any, context: any = x): CliTiming {
     profiling_times: _atd_read_required_field('CliTiming', 'profiling_times', _atd_read_assoc_object_into_array(_atd_read_float), x['profiling_times'], x),
     targets: _atd_read_required_field('CliTiming', 'targets', _atd_read_array(readCliTargetTimes), x['targets'], x),
     total_bytes: _atd_read_required_field('CliTiming', 'total_bytes', _atd_read_int, x['total_bytes'], x),
+    max_memory_bytes: _atd_read_optional_field(_atd_read_int, x['max_memory_bytes'], x),
   };
 }