Synapse

=====================

Model Changes
-------------
- Updates to the ``infotech``, ``ou``, and ``risk`` models.
(`3436 <https://github.com/vertexproject/synapse/pull/3436>`_)
(`3438 <https://github.com/vertexproject/synapse/pull/3438>`_)
(`3446 <https://github.com/vertexproject/synapse/pull/3447>`_)
(`3447 <https://github.com/vertexproject/synapse/pull/3447>`_)
- See :ref:`userguide_model_v2_156_0` for more detailed model changes.

Features and Enhancements
-------------------------
- Add an ``empty`` keyword to Storm to conditionally execute queries when
there are no nodes in the pipeline.
(`3434 <https://github.com/vertexproject/synapse/pull/3434>`_)
- Add Storm APIs for getting property counts for a given ``layer`` or
``view.``. These APIs are ``getPropCount()``, ``getPropArrayCount()``,
``getTagPropCount()``.
(`3435 <https://github.com/vertexproject/synapse/pull/3435>`_)
- Add a new permission, ``view.fork``, which can be used to control access
for forking a view. This permission defaults to being allowed.
(`3437 <https://github.com/vertexproject/synapse/pull/3437>`_)
- Add Storm operators to allow pivoting and joining across light edges. The
following examples show pivoting across ``refs`` edges and joining the
destination nodes with the inbound nodes: ``-(refs)+>`` and ``<+(refs)-``.
(`3441 <https://github.com/vertexproject/synapse/pull/3441>`_)
- Add Storm operators to do pivot out and join ( ``--+>`` ) and pivot in
and join ( ``<+--``) operations across light edges.
(`3441 <https://github.com/vertexproject/synapse/pull/3441>`_)
(`3442 <https://github.com/vertexproject/synapse/pull/3442>`_)
- Storm subqueries used to assign a value now always run.
(`3445 <https://github.com/vertexproject/synapse/pull/3445>`_)
- Non-runtsafe ``try...catch`` blocks in Storm now run when there are no
inbound nodes.
(`3445 <https://github.com/vertexproject/synapse/pull/3445>`_)
- The Storm API ``$lib.storm.eval()`` now logs its ``text`` argument to the
``synapse.storm`` logger.
(`3448 <https://github.com/vertexproject/synapse/pull/3448>`_)
- Add a ``--by-name`` argument to the Storm ``stats.countby`` command. This
can be used to sort the results by name instead of count.
(`3450 <https://github.com/vertexproject/synapse/pull/3450>`_)
- Add a new Storm API ``$lib.gis.bbox()`` to allow computing geospatial
bounding boxes.
(`3455 <https://github.com/vertexproject/synapse/pull/3455>`_)

Bugfixes
--------
- Prevent recursion errors in ``inet:fqdn`` onset handlers.
(`3433 <https://github.com/vertexproject/synapse/pull/3433>`_)
- When dereferencing a list or dictionary object off of a Node in Storm, the
returned value is now a copy of the value. This avoids the situation where
modifying the deferenced value appeared to alter the node but did not
actually result in any edits to the underlying data.
(`3439 <https://github.com/vertexproject/synapse/pull/3439>`_)
- Add a missing sub-query example to Storm ``for`` loop documentation.
(`3451 <https://github.com/vertexproject/synapse/pull/3451>`_)
- Fix an issue where attempting to norm an IPv4 with an invalid netmask
would raise a Python error.
(`3459 <https://github.com/vertexproject/synapse/pull/3459>`_)

Deprecations
------------
- Deprecated Cortex and splice related APIs which were marked for removal
after 2023-10-01 have been removed. The list of these APIs can be found
at :ref:`changelog-depr-20231001`. These additional splice related changes
have also been made:

The HTTP API ``/api/v1/storm`` now sets the default ``editformat`` opt
value to ``nodeedits``. Previously this API produced splice changes by
default.

The ``synapse.tools.cmdr`` ``storm`` command no longer displays splices.

The ``synapse.tools.cmdr`` ``log`` command no longer records splices.

The ``synapse.tools.csvtool`` tool no longer records or displays splices.

The ``synapse.tools.feed`` tool no longer supports splices or nodeedits as
input and the splice documentation example has been removed.

(`3449 <https://github.com/vertexproject/synapse/pull/3449>`_)
- The deprecated function ``synapse.common.aclosing()`` has been removed.
(`3449 <https://github.com/vertexproject/synapse/pull/3449>`_)
- Provisioning a Synapse service with AHA now always updates the local CA
certificate and generates new host and user certificates for the service.
Previously these would not be regenerated if the CA or service names did
not change.
(`3457 <https://github.com/vertexproject/synapse/pull/3457>`_)

=====================

Model Changes
-------------
- Updates to the ``infotech``, ``proj``, and ``risk`` models.
(`3422 <https://github.com/vertexproject/synapse/pull/3422>`_)
- See :ref:`userguide_model_v2_155_0` for more detailed model changes.

Features and Enhancements
-------------------------
- Add a ``detach()`` method to the Storm ``view`` object. This will detach a
forked View from its parent.
(`3423 <https://github.com/vertexproject/synapse/pull/3423>`_)
- Change the method used to generate the ``took`` value in the Storm ``fini``
message to use a monotonic clock.
(`3425 <https://github.com/vertexproject/synapse/pull/3425>`_)
- Performing an invalid "pivot in" operation with a form target
(``<- some:form``) now raises a ``StormRuntimeError`` instead of silently
doing nothing.
(`3426 <https://github.com/vertexproject/synapse/pull/3426>`_)
- Allow relative properties on the right hand side of a filter operation
when using Storm expression syntax.
(`3424 <https://github.com/vertexproject/synapse/pull/3424>`_)
- Add an ``/api/v1/logout`` method on the Cell to allow HTTPS users to logout
of their sessions.
(`3430 <https://github.com/vertexproject/synapse/pull/3430>`_)
- Allow taxonomy prefix lift and filter operations to work with taxon parts.
(`3429 <https://github.com/vertexproject/synapse/pull/3429>`_)
- Update the allowed versions of the ``cbor2``, ``pycryptodome``,
``pygments``, ``vcrpy``, and ``xxhash`` libraries. Update the pinned version
of the ``lark`` library.
(`3418 <https://github.com/vertexproject/synapse/pull/3418>`_)

Bugfixes
--------
- Fix a performance regression in graph projection for computing large graphs
in Storm.
(`3375 <https://github.com/vertexproject/synapse/pull/3375>`_)
- Fix a conflict between Storm ``$lib.inet.http`` functions and ``vcrpy``
where ``json`` and ``data`` args shouldn't be passed together.
(`3428 <https://github.com/vertexproject/synapse/pull/3428>`_)

Improved Documentation
----------------------
- Fix an error in the Cortex mirror deployment guide. The example
``docker-compose.yaml`` was missing the environment variables for
``SYN_CORTEX_AXON`` and ``SYN_CORTEX_JSONSTOR``.
(`3430 <https://github.com/vertexproject/synapse/pull/3430>`_)

=====================

This release is for updating the version of the ``cryptography`` package in
Synapse containers to ``41.0.5``.

=====================

Automatic Migrations
--------------------
- Update the ``inet:ipv4:type`` value for RFC6598 addresses to ``shared``.
(`3410 <https://github.com/vertexproject/synapse/pull/3410>`_)
- See :ref:`datamigration` for more information about automatic migrations.

Model Changes
-------------
- Update to the ``inet`` and ``ou`` models.

(`3406 <https://github.com/vertexproject/synapse/pull/3406>`_)
(`3407 <https://github.com/vertexproject/synapse/pull/3407>`_)
(`3410 <https://github.com/vertexproject/synapse/pull/3410>`_)
(`3416 <https://github.com/vertexproject/synapse/pull/3416>`_)
- See :ref:`userguide_model_v2_154_0` for more detailed model changes.

Features and Enhancements
-------------------------
- Add ``edge:add`` and ``edge:del`` as trigger conditions. These trigger when
light edges are added or removed from a node.
(`3389 <https://github.com/vertexproject/synapse/pull/3389>`_)
- Storm lift and filter operations using regular expressions (``~=``) are now
case insensitive by default.
(`3403 <https://github.com/vertexproject/synapse/pull/3403>`_)
- Add a ``unique()`` method to the Storm ``list`` object. This returns a new
list with only unique elements in it.
(`3415 <https://github.com/vertexproject/synapse/pull/3415>`_)
- Add support for ``synapse.tools.autodoc`` to generate documentation for
API definitions declared in Storm packages.
(`3382 <https://github.com/vertexproject/synapse/pull/3382>`_)
- A review of Storm library functions was performed and all ``readonly`` safe
functions have been marked for execution in a ``readonly`` Storm runtime.
(`3402 <https://github.com/vertexproject/synapse/pull/3402>`_)
- Allow setting the layers on a root View with forks.
(`3413 <https://github.com/vertexproject/synapse/pull/3413>`_)

Bugfixes
--------
- Per-node Storm variables are now passed into subquery assignment
expressions.
(`3405 <https://github.com/vertexproject/synapse/pull/3405>`_)
- Fix an issue with Storm Dmon hive storage being opened too late in the
Cortex startup sequence.
(`3411 <https://github.com/vertexproject/synapse/pull/3411>`_)
- Remove a check when deleting tags from a node which prevented tag deletion
from a node when the root tag was deleted in a parent view.
(`3408 <https://github.com/vertexproject/synapse/pull/3408>`_)

=====================

Model Changes
-------------
- Update to the ``inet`` and ``ou`` models.
(`3393 <https://github.com/vertexproject/synapse/pull/3393>`_)
(`3396 <https://github.com/vertexproject/synapse/pull/3396>`_)
- See :ref:`userguide_model_v2_153_0` for more detailed model changes.

Features and Enhancements
-------------------------
- Add a new Storm API, ``$lib.cortex.httpapi``, for creating and managing
Extended HTTP API endpoints. These Cortex HTTP API endpoints allow a user to
create custom responses via Storm. Documentation for this feature can be
found at :ref:`devops-svc-cortex-ext-http`.
(`3366 <https://github.com/vertexproject/synapse/pull/3366>`_)
- Add a new Storm API, ``$lib.iters.zip()``, to iterate over sequences of
items together.
(`3392 <https://github.com/vertexproject/synapse/pull/3392>`_)
(`3398 <https://github.com/vertexproject/synapse/pull/3398>`_)
- Add a Storm command ``stats.countby`` to tally occurrences of values and
display a barchart representing the values.
(`3385 <https://github.com/vertexproject/synapse/pull/3385>`_)
- Update the Storm command ``auth.user.mod`` to allow setting a user as admin
on a specific auth gate.
(`3391 <https://github.com/vertexproject/synapse/pull/3391>`_)
- The ``proxy`` argument to ``$lib.inet.http.*``, ``$lib.axon.wget()``,
``$lib.axon.urlfile()``, and ``$lib.axon.wput()`` APIs is now gated behind
the permission ``storm.lib.inet.http.proxy``. Previously this required
admin permission to utilize.
(`3397 <https://github.com/vertexproject/synapse/pull/3397>`_)
- Add an ``errors`` parameter to ``$lib.axon.readlines()``,
``$lib.axon.csvrows()``, and ``$lib.axon.jsonlines()``. This parameter
defaults to ``ignore`` to ignore any decoding errors that are encountered
when decoding text.
(`3395 <https://github.com/vertexproject/synapse/pull/3395>`_)
- Lower the maximum allowed version of the ``pyopenssl`` library.
(`3399 <https://github.com/vertexproject/synapse/pull/3399>`_)

Bugfixes
--------
- Fix a bug in the ``Cortex.syncLayersEvents()`` and
``Cortex.syncIndexEvents()`` APIs which caused layers to stop sending their
node edits under certain conditions.
(`3394 <https://github.com/vertexproject/synapse/pull/3394>`_)
- Storm now raises a ``BadSyntaxError`` when attempting to filter by wildcard
tags or tagprops when a value is specified for the filter.
(`3373 <https://github.com/vertexproject/synapse/pull/3373>`_)

=====================

Model Changes
-------------
- Update to the ``biz``, ``crypto``, ``geo``, ``it``, ``mat``, ``media``,
and ``risk`` models.
(`3341 <https://github.com/vertexproject/synapse/pull/3341>`_)
(`3377 <https://github.com/vertexproject/synapse/pull/3377>`_)
(`3376 <https://github.com/vertexproject/synapse/pull/3376>`_)
(`3381 <https://github.com/vertexproject/synapse/pull/3381>`_)
- See :ref:`userguide_model_v2_152_0` for more detailed model changes.

Features and Enhancements
-------------------------
- Update the Storm string repr for ``$lib.null`` and ``$lib.undef`` values to
``$lib.null`` and ``$lib.undef``. Previously these printed ``None`` and an
opaque Python object repr.
(`3361 <https://github.com/vertexproject/synapse/pull/3361>`_)
- The ``synapse.tools.aha.list`` CLI tool now checks if it is connected to an
Aha server prior to enumerating Aha services.
(`3371 <https://github.com/vertexproject/synapse/pull/3371>`_)

Bugfixes
--------
- Update the ``file:path`` support for scrape related APIs to address an
issue when matching against Linux style paths.
(`3378 <https://github.com/vertexproject/synapse/pull/3378>`_)
- Update the ``hex`` type to ``zeropad`` strings prior to checking their
validity.
(`3387 <https://github.com/vertexproject/synapse/pull/3387>`_)
- Update the ``yaml.CSafeLoader`` check to not require the class to be
available.
(`3386 <https://github.com/vertexproject/synapse/pull/3386>`_)

Improved Documentation
----------------------
- Update the documentation for the Storm ``view.exec`` command to explain the
separation of events and nodes between the parent and sub-runtimes.
(`3379 <https://github.com/vertexproject/synapse/pull/3379>`_)