Fix edge and timeedge type deprecations (SYN-7775)

vertexproject · Jan 20, 2025 · 7914d5a · 7914d5a
1 parent 2f5c32b
commit 7914d5a
Show file tree

Hide file tree

Showing 5 changed files with 19 additions and 3 deletions.
diff --git a/changes/15f2326e94fb0c6a0dff8325285ef354.yaml b/changes/15f2326e94fb0c6a0dff8325285ef354.yaml
@@ -0,0 +1,6 @@
+---
+desc: Fixed an issue where the deprecated types ``edge`` and ``timeedge`` were not annotated
+  as such by the ``getModelDict()`` API.
+prs: []
+type: bug
+...
diff --git a/changes/4dc8e5d43f4cd25953b363a3ef469d7a.yaml b/changes/4dc8e5d43f4cd25953b363a3ef469d7a.yaml
@@ -0,0 +1,5 @@
+---
+desc: Deprecated ``$lib.infosec.cvss.calculate()`` and ``$lib.infosec.cvss.calculateFromProps()``.
+prs: []
+type: deprecation
+...
diff --git a/synapse/datamodel.py b/synapse/datamodel.py
@@ -583,11 +583,11 @@ def __init__(self, core=None):
         item = s_types.Array(self, 'array', info, {'type': 'int'})
         self.addBaseType(item)
 
-        info = {'doc': 'An digraph edge base type.'}
+        info = {'doc': 'An digraph edge base type.', 'deprecated': True}
         item = s_types.Edge(self, 'edge', info, {})
         self.addBaseType(item)
 
-        info = {'doc': 'An digraph edge base type with a unique time.'}
+        info = {'doc': 'An digraph edge base type with a unique time.', 'deprecated': True}
         item = s_types.TimeEdge(self, 'timeedge', info, {})
         self.addBaseType(item)
 

diff --git a/synapse/lib/stormlib/infosec.py b/synapse/lib/stormlib/infosec.py
@@ -515,6 +515,7 @@ class CvssLib(s_stormtypes.Lib):
     '''
     _storm_locals = (
         {'name': 'calculate', 'desc': 'Calculate the CVSS score values for an input risk:vuln node.',
+         'deprecated': {'eolvers': 'v3.0.0'},
          'type': {'type': 'function', '_funcname': 'calculate',
                   'args': (
                       {'name': 'node', 'type': 'node',
@@ -527,6 +528,7 @@ class CvssLib(s_stormtypes.Lib):
                   'returns': {'type': 'dict', 'desc': 'A dictionary containing the computed score and subscores.', }
         }},
         {'name': 'calculateFromProps', 'desc': 'Calculate the CVSS score values from a props dict.',
+         'deprecated': {'eolvers': 'v3.0.0'},
          'type': {'type': 'function', '_funcname': 'calculateFromProps',
                   'args': (
                       {'name': 'props', 'type': 'dict',

diff --git a/synapse/tests/test_cortex.py b/synapse/tests/test_cortex.py
@@ -3048,7 +3048,7 @@ async def test_cortex_coreinfo(self):
 
             depr = [x for x in coreinfo['stormdocs']['libraries'] if x['path'] == ('lib', 'infosec', 'cvss')]
             self.len(1, depr)
-            self.len(2, [x for x in depr[0]['locals'] if x.get('deprecated')])
+            self.len(4, [x for x in depr[0]['locals'] if x.get('deprecated')])
 
     async def test_cortex_model_dict(self):
 
@@ -3107,6 +3107,9 @@ async def test_cortex_model_dict(self):
             self.nn(model['univs'].get('.created'))
             self.nn(model['univs'].get('.seen'))
 
+            self.true(model['types']['edge'].get('deprecated'))
+            self.true(model['types']['timeedge'].get('deprecated'))
+
     async def test_storm_graph(self):
 
         async with self.getTestCoreAndProxy() as (core, prox):