Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove the osemgrep sarif metrics #317

Merged
merged 1 commit into from
Dec 2, 2024
Merged

Remove the osemgrep sarif metrics #317

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 2 additions & 36 deletions semgrep_metrics.atd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@
* `pysemgrep`. Currently, we try to fit the tests and don't update the
* JSON output.
* - specify the schema for the answer from https://metrics.semgrep.dev
* - document also what we send via open telemetry in our traces when
* using --trace?
*)

<python text="from dataclasses import field">
Expand Down Expand Up @@ -71,12 +73,6 @@ type payload = {
errors: errors;
value: value;
extension: extension;

(* Metrics related to osemgrep migration. It's intentionally made optional
* so that it's easier to remove the field without breaking backward
* compatibility once the migration is complete.
*)
?osemgrep <ocaml mutable>: osemgrep_metrics option;
}

(*****************************************************************************)
Expand Down Expand Up @@ -272,36 +268,6 @@ type extension = {
?ignoreCount <ocaml mutable>: int option;
}

(*****************************************************************************)
(* Osemgrep specific metrics *)
(*****************************************************************************)

type osemgrep_metrics = {
?format_output: osemgrep_format_output option;
}

type osemgrep_format_output = {
(* Whether the RPC succeeded. *)
?succeeded: bool option;
(* Name of the output format. *)
?format: string option;
(* Time in seconds to call osemgrep through RPC and get its result back. *)
?osemgrep_rpc_response_time_seconds: float option;
(* Time in seconds for osemgrep to format the output, excluding RPC. *)
?osemgrep_format_time_seconds: float option;

(* We also validate whether osemgrep and pysemgrep return the same output or not.
* The fields below help us keep track of this information.
*)

(* Time in seconds for pysemgrep to format the output. *)
?pysemgrep_format_time_seconds: float option;
(* Time in seconds to validate whether the output from osemgrep matches pysemgrep. *)
?validation_time_seconds: float option;
(* Whether the osemgrep output matched the pysemgrep output. *)
?is_match: bool option;
}

(*****************************************************************************)
(* TODO Response by metrics.semgrep.dev *)
(*****************************************************************************)
Expand Down
86 changes: 0 additions & 86 deletions semgrep_metrics.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -864,88 +864,6 @@ def to_json_string(self, **kw: Any) -> str:
return json.dumps(self.to_json(), **kw)


@dataclass
class OsemgrepFormatOutput:
"""Original type: osemgrep_format_output = { ... }"""

succeeded: Optional[bool] = None
format: Optional[str] = None
osemgrep_rpc_response_time_seconds: Optional[float] = None
osemgrep_format_time_seconds: Optional[float] = None
pysemgrep_format_time_seconds: Optional[float] = None
validation_time_seconds: Optional[float] = None
is_match: Optional[bool] = None

@classmethod
def from_json(cls, x: Any) -> 'OsemgrepFormatOutput':
if isinstance(x, dict):
return cls(
succeeded=_atd_read_bool(x['succeeded']) if 'succeeded' in x else None,
format=_atd_read_string(x['format']) if 'format' in x else None,
osemgrep_rpc_response_time_seconds=_atd_read_float(x['osemgrep_rpc_response_time_seconds']) if 'osemgrep_rpc_response_time_seconds' in x else None,
osemgrep_format_time_seconds=_atd_read_float(x['osemgrep_format_time_seconds']) if 'osemgrep_format_time_seconds' in x else None,
pysemgrep_format_time_seconds=_atd_read_float(x['pysemgrep_format_time_seconds']) if 'pysemgrep_format_time_seconds' in x else None,
validation_time_seconds=_atd_read_float(x['validation_time_seconds']) if 'validation_time_seconds' in x else None,
is_match=_atd_read_bool(x['is_match']) if 'is_match' in x else None,
)
else:
_atd_bad_json('OsemgrepFormatOutput', x)

def to_json(self) -> Any:
res: Dict[str, Any] = {}
if self.succeeded is not None:
res['succeeded'] = _atd_write_bool(self.succeeded)
if self.format is not None:
res['format'] = _atd_write_string(self.format)
if self.osemgrep_rpc_response_time_seconds is not None:
res['osemgrep_rpc_response_time_seconds'] = _atd_write_float(self.osemgrep_rpc_response_time_seconds)
if self.osemgrep_format_time_seconds is not None:
res['osemgrep_format_time_seconds'] = _atd_write_float(self.osemgrep_format_time_seconds)
if self.pysemgrep_format_time_seconds is not None:
res['pysemgrep_format_time_seconds'] = _atd_write_float(self.pysemgrep_format_time_seconds)
if self.validation_time_seconds is not None:
res['validation_time_seconds'] = _atd_write_float(self.validation_time_seconds)
if self.is_match is not None:
res['is_match'] = _atd_write_bool(self.is_match)
return res

@classmethod
def from_json_string(cls, x: str) -> 'OsemgrepFormatOutput':
return cls.from_json(json.loads(x))

def to_json_string(self, **kw: Any) -> str:
return json.dumps(self.to_json(), **kw)


@dataclass
class OsemgrepMetrics:
"""Original type: osemgrep_metrics = { ... }"""

format_output: Optional[OsemgrepFormatOutput] = None

@classmethod
def from_json(cls, x: Any) -> 'OsemgrepMetrics':
if isinstance(x, dict):
return cls(
format_output=OsemgrepFormatOutput.from_json(x['format_output']) if 'format_output' in x else None,
)
else:
_atd_bad_json('OsemgrepMetrics', x)

def to_json(self) -> Any:
res: Dict[str, Any] = {}
if self.format_output is not None:
res['format_output'] = (lambda x: x.to_json())(self.format_output)
return res

@classmethod
def from_json_string(cls, x: str) -> 'OsemgrepMetrics':
return cls.from_json(json.loads(x))

def to_json_string(self, **kw: Any) -> str:
return json.dumps(self.to_json(), **kw)


@dataclass
class Extension:
"""Original type: extension = { ... }"""
Expand Down Expand Up @@ -1149,7 +1067,6 @@ class Payload:
value: Value
extension: Extension
parse_rate: List[Tuple[str, ParseStat]] = field(default_factory=lambda: [])
osemgrep: Optional[OsemgrepMetrics] = None

@classmethod
def from_json(cls, x: Any) -> 'Payload':
Expand All @@ -1165,7 +1082,6 @@ def from_json(cls, x: Any) -> 'Payload':
value=Value.from_json(x['value']) if 'value' in x else _atd_missing_json_field('Payload', 'value'),
extension=Extension.from_json(x['extension']) if 'extension' in x else _atd_missing_json_field('Payload', 'extension'),
parse_rate=_atd_read_assoc_object_into_list(ParseStat.from_json)(x['parse_rate']) if 'parse_rate' in x else [],
osemgrep=OsemgrepMetrics.from_json(x['osemgrep']) if 'osemgrep' in x else None,
)
else:
_atd_bad_json('Payload', x)
Expand All @@ -1182,8 +1098,6 @@ def to_json(self) -> Any:
res['value'] = (lambda x: x.to_json())(self.value)
res['extension'] = (lambda x: x.to_json())(self.extension)
res['parse_rate'] = _atd_write_assoc_list_to_object((lambda x: x.to_json()))(self.parse_rate)
if self.osemgrep is not None:
res['osemgrep'] = (lambda x: x.to_json())(self.osemgrep)
return res

@classmethod
Expand Down