Skip to content

Commit 5d07c34

Browse files
authored
Merge branch 'master' into synapse-3xx
2 parents 7bc092f + f0b9e0f commit 5d07c34

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+1601
-157
lines changed

.bumpversion.cfg

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[bumpversion]
2-
current_version = 2.159.0
2+
current_version = 2.160.0
33
commit = True
44
tag = True
55
tag_message =

.circleci/config.yml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ commands:
7474
7575
- restore_cache:
7676
keys:
77-
- v3-docvenv-{{ .Environment.CIRCLE_STAGE }}-{{ .Branch }}-{{ checksum "pyproject.toml" }}
77+
- v3-docvenv-{{ .Environment.CIRCLE_JOB }}-{{ .Branch }}-{{ checksum "pyproject.toml" }}
7878

7979
- run:
8080
name: setup venv
@@ -92,7 +92,7 @@ commands:
9292
- save_cache:
9393
paths:
9494
- ./venv
95-
key: v2-docvenv-{{ .Environment.CIRCLE_STAGE }}-{{ .Branch }}-{{ checksum "pyproject.toml" }}
95+
key: v3-docvenv-{{ .Environment.CIRCLE_JOB }}-{{ .Branch }}-{{ checksum "pyproject.toml" }}
9696

9797
- run:
9898
name: executing docs jupyter notebooks
@@ -112,14 +112,14 @@ commands:
112112
113113
- restore_cache:
114114
keys:
115-
- v3-venv-{{ .Environment.CIRCLE_STAGE }}-{{ .Branch }}-{{ checksum "pyproject.toml" }}
115+
- v3-venv-{{ .Environment.CIRCLE_JOB }}-{{ .Branch }}-{{ checksum "pyproject.toml" }}
116116

117117
- do_venv_setup
118118

119119
- save_cache:
120120
paths:
121121
- ./venv
122-
key: v2-venv-{{ .Environment.CIRCLE_STAGE }}-{{ .Branch }}-{{ checksum "pyproject.toml" }}
122+
key: v3-venv-{{ .Environment.CIRCLE_JOB }}-{{ .Branch }}-{{ checksum "pyproject.toml" }}
123123

124124
- run:
125125
name: syntax
@@ -145,7 +145,7 @@ commands:
145145

146146
- restore_cache:
147147
keys:
148-
- v2-venv-{{ .Environment.CIRCLE_STAGE }}-{{ .Branch }}-{{ checksum "pyproject.toml" }}
148+
- v3-venv-{{ .Environment.CIRCLE_JOB }}-{{ .Branch }}-{{ checksum "pyproject.toml" }}
149149

150150
- run:
151151
name: install python dependencies
@@ -158,7 +158,7 @@ commands:
158158
- save_cache:
159159
paths:
160160
- ./venv
161-
key: v1-venv-{{ .Environment.CIRCLE_STAGE }}-{{ .Branch }}-{{ checksum "pyproject.toml" }}
161+
key: v3-venv-{{ .Environment.CIRCLE_JOB }}-{{ .Branch }}-{{ checksum "pyproject.toml" }}
162162

163163
- run:
164164
name: init .pypirc

CHANGELOG.rst

Lines changed: 135 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,141 @@
66
Synapse Changelog
77
*****************
88

9+
v2.160.0 - 2024-01-24
10+
=====================
11+
12+
Automatic Migrations
13+
--------------------
14+
- Update ``inet:ipv6`` nodes to set their ``:type`` and ``:scope`` properties.
15+
(`#3498 <https://github.com/vertexproject/synapse/pull/3498>`_)
16+
- Update existing layer push and layer pull configurations to set the default
17+
chunk size and queue size values on them.
18+
(`#3480 <https://github.com/vertexproject/synapse/pull/3480>`_)
19+
- See :ref:`datamigration` for more information about automatic migrations.
20+
21+
Model Changes
22+
-------------
23+
- Updates to the ``infotech``, ``ou``, and ``risk`` models.
24+
(`#3501 <https://github.com/vertexproject/synapse/pull/3501>`_)
25+
(`#3504 <https://github.com/vertexproject/synapse/pull/3504>`_)
26+
(`#3498 <https://github.com/vertexproject/synapse/pull/3498>`_)
27+
28+
**New Properties**
29+
30+
``risk:vuln``
31+
The form had the following properties added to it:
32+
33+
``severity``
34+
The severity of the vulnerability.
35+
36+
``priority``
37+
The priority of the vulnerability.
38+
39+
``inet:ipv6``
40+
The form had the following properties added to it:
41+
42+
``type``
43+
The type of IP address (e.g., private, multicast, etc.).
44+
45+
``scope``
46+
The IPv6 scope of the address (e.g., global, link-local, etc.).
47+
48+
**Updated Types**
49+
50+
``it:exec:proc``
51+
This now inherits the ``it:host:activity`` interface.
52+
53+
``it:exec:thread``
54+
This now inherits the ``it:host:activity`` interface.
55+
56+
``it:exec:loadlib``
57+
This now inherits the ``it:host:activity`` interface.
58+
59+
``it:exec:mmap``
60+
This now inherits the ``it:host:activity`` interface.
61+
62+
``it:exec:mutex``
63+
This now inherits the ``it:host:activity`` interface.
64+
65+
``it:exec:pipe``
66+
This now inherits the ``it:host:activity`` interface.
67+
68+
``it:exec:url``
69+
This now inherits the ``it:host:activity`` interface.
70+
71+
``it:exec:bind``
72+
This now inherits the ``it:host:activity`` interface.
73+
74+
``it:exec:file:add``
75+
This now inherits the ``it:host:activity`` interface.
76+
77+
``it:exec:file:read``
78+
This now inherits the ``it:host:activity`` interface.
79+
80+
``it:exec:file:write``
81+
This now inherits the ``it:host:activity`` interface.
82+
83+
``it:exec:file:del``
84+
This now inherits the ``it:host:activity`` interface.
85+
86+
``it:exec:reg:get``
87+
This now inherits the ``it:host:activity`` interface.
88+
89+
``it:exec:reg:set``
90+
This now inherits the ``it:host:activity`` interface.
91+
92+
``it:exec:reg:del``
93+
This now inherits the ``it:host:activity`` interface.
94+
95+
Features and Enhancements
96+
-------------------------
97+
- Add tab completion of commands, forms, properties, tags, and ``$lib.``
98+
functions the Storm CLI tool.
99+
(`#3493 <https://github.com/vertexproject/synapse/pull/3493>`_)
100+
(`#3507 <https://github.com/vertexproject/synapse/pull/3507>`_)
101+
- Add ``node.set.<form>.<prop>`` and ``node.del.<form>.<prop>`` permissions
102+
conventions to the Cortex for property sets and deletes.
103+
(`#3505 <https://github.com/vertexproject/synapse/pull/3505>`_)
104+
- Add experimental support for Storm query offloading to the Cortex. This can
105+
be used to offload Storm queries to an AHA service pool. This can be
106+
configured with the ``storm:pool`` option on the Cortex.
107+
(`#3452 <https://github.com/vertexproject/synapse/pull/3452>`_)
108+
(`#3513 <https://github.com/vertexproject/synapse/pull/3513>`_)
109+
- Add a ``--deledges`` option to the ``delnode`` command. This deletes the N2
110+
edges for a node before deleting the node.
111+
(`#3503 <https://github.com/vertexproject/synapse/pull/3503>`_)
112+
- When creating layer push or pull configurations, the chunk size and queue
113+
size can now be set.
114+
(`#3480 <https://github.com/vertexproject/synapse/pull/3480>`_)
115+
- Add a ``cell.hasHttpSess()`` API to check if a given Cell has a known HTTP
116+
session.
117+
(`#3485 <https://github.com/vertexproject/synapse/pull/3485>`_)
118+
- Fire a ``core:pkg:onload:complete`` event when a Storm package ``onload``
119+
handler is completed. This can be used when writing unit tests for Rapid
120+
Power-ups.
121+
(`#3497 <https://github.com/vertexproject/synapse/pull/3497>`_)
122+
123+
Bugfixes
124+
--------
125+
- Remove dataname index entries when removing all nodedata from a node.
126+
(`#3499 <https://github.com/vertexproject/synapse/pull/3499>`_)
127+
- Fix an issue with ``tagprops`` not being correctly returned in
128+
``$node.getByLayer()``.
129+
(`#3500 <https://github.com/vertexproject/synapse/pull/3500>`_)
130+
- Fix an issue with the ``edges.del`` command when using the ``--n2`` option.
131+
This now behaves correctly when the N1 node does not exist.
132+
(`#3506 <https://github.com/vertexproject/synapse/pull/3506>`_)
133+
- Fix an issue with duplicate properties being tracked in the property type
134+
map of the data model. This could have resulted in multiple nodes being
135+
lifted with interface properties.
136+
(`#3512 <https://github.com/vertexproject/synapse/pull/3512>`_)
137+
138+
Improved Documentation
139+
----------------------
140+
- Update Storm filter documentation. Additional information about tag globbing
141+
and interval filtering has been included.
142+
(`#3489 <https://github.com/vertexproject/synapse/pull/3489>`_)
143+
9144
v2.159.0 - 2024-01-16
10145
=====================
11146

docs/synapse/adminguide.rstorm

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1385,6 +1385,13 @@ The Synapse data model in a Cortex can be extended with custom `forms`_ or `prop
13851385
extension Storm Library (:ref:`stormlibs-lib-model-ext`). Extended model forms and properties must have names
13861386
beginning with an underscore (``_``) to avoid potential naming conflicts with built-in model elements.
13871387

1388+
.. NOTE::
1389+
1390+
Extended model elements that are in-use (have nodes using the extended forms or properties) cannot be removed until
1391+
all instances of that extended model element are removed. In other words, before removing extended forms any nodes
1392+
created with that extended form must be delete first, and before removing extended properties any nodes with that
1393+
extended property must have the property value removed.
1394+
13881395
Extended Forms
13891396
--------------
13901397

docs/synapse/devguides/storm_api.rst

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -524,6 +524,42 @@ Example:
524524
525525
opts = {'ndefs': ndefs}
526526
527+
nexsoffs
528+
--------
529+
530+
Wait for the Cortex to reach the specified Nexus offset before executing the query.
531+
This is intended for internal use when offloading queries to a mirror.
532+
533+
Example:
534+
535+
.. code:: python3
536+
537+
opts = {'nexsoffs': 7759195}
538+
539+
nexstimeout
540+
-----------
541+
542+
Timeout (in seconds) to wait for the Cortex to reach the Nexus offset specified by ``nexsoffs``.
543+
This is intended for internal use when offloading queries to a mirror.
544+
545+
Example:
546+
547+
.. code:: python3
548+
549+
opts = {'nexstimeout': 5}
550+
551+
mirror
552+
------
553+
554+
If Storm query offloading is configured and ``mirror`` is ``true`` (the default value),
555+
the Cortex will attempt to offload the query to a mirror. Setting this to ``false`` will
556+
force the query to be run on the local Cortex rather than a mirror.
557+
558+
Example:
559+
560+
.. code:: python3
561+
562+
opts = {'mirror': False}
527563
528564
path
529565
----

0 commit comments

Comments
 (0)