Synapse

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

This release also includes the changes from v2.173.0, which was not released
due to an issue with CI pipelines.

Model Changes
-------------
- Updates to the ``ou``, ``plan``, and ``ps`` models.
(`3772 <https://github.com/vertexproject/synapse/pull/3772>`_)
(`3773 <https://github.com/vertexproject/synapse/pull/3773>`_)
- See :ref:`userguide_model_v2_173_1` for more detailed model changes.

Bugfixes
--------
- Fix a bug in the ``view.merge`` optimizations from ``v2.172.0`` where deny
rules were not properly accounted for when checking for fast paths on the
``node`` permission hierarchy.
(`3771 <https://github.com/vertexproject/synapse/pull/3771>`_)

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

This release was replaced with ``v2.173.1``.

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

Model Changes
-------------
- Updates to the ``biz``, ``econ``, ``inet``, ``meta``, ``ou`` ``risk``,
and ``transit`` models.
(`3561 <https://github.com/vertexproject/synapse/pull/3561>`_)
(`3756 <https://github.com/vertexproject/synapse/pull/3756>`_)
- See :ref:`userguide_model_v2_172_0` for more detailed model changes.

Features and Enhancements
-------------------------
- Update the permission checking for View merging ( ``view.merge`` ) to
optimize the permission checking based on user permissions and layer index
data.
(`3736 <https://github.com/vertexproject/synapse/pull/3736>`_)
(`3750 <https://github.com/vertexproject/synapse/pull/3750>`_)
(`3758 <https://github.com/vertexproject/synapse/pull/3758>`_)
- Add a hotfix that can be used to migrate ``risk:hasvuln`` nodes to
``risk:vulnerable`` nodes.
(`3745 <https://github.com/vertexproject/synapse/pull/3745>`_)
- Add a Storm API, ``$lib.env.get()``, to get environment variables from
the Cortex process which start with the prefix ``SYN_STORM_ENV_``.
(`3761 <https://github.com/vertexproject/synapse/pull/3761>`_)
- Add a ``edited()`` API to the ``layer`` object in Storm. This API can be
used to get the last time a given layer was edited. Add a ``reverse``
argument to the ``layer.edits()`` API to return the node edits in reverse
order.
(`3763 <https://github.com/vertexproject/synapse/pull/3763>`_)
- Add a ``setArchived()`` API to the ``auth:user`` object in Storm.
(`3759 <https://github.com/vertexproject/synapse/pull/3759>`_)
- The ``synapse.tool.storm`` tool now returns a non-zero status code when
it is invoked to execute a single command and the command encounters an
error.
(`3765 <https://github.com/vertexproject/synapse/pull/3765>`_)
- Add a ``nodup`` option to the ``slab.scanKeys()`` API. Use this to increase
the efficiency of the the Storm ``model.edge.list`` command.
(`3762 <https://github.com/vertexproject/synapse/pull/3762>`_)
- Add a ``synapse.common.trimText()`` API for trimming strings in a consistent
fashion. Use that API to trim long text strings that may be included in
exception messages.
(`3753 <https://github.com/vertexproject/synapse/pull/3753>`_)
- When a Storm subquery assignment yields more than a single node, add the
trimmed subquery text to the ``BadTypeValu`` exception that is raised.
(`3753 <https://github.com/vertexproject/synapse/pull/3753>`_)

Bugfixes
--------
- Fix a typo in the Storm ``gen.it.av.scan.result`` command help output.
(`3766 <https://github.com/vertexproject/synapse/pull/3766>`_)
- Fix a typo in the Rapid Power-Up development documentation.
(`3766 <https://github.com/vertexproject/synapse/pull/3766>`_)

Improved Documentation
----------------------

- Add documentation for ``$lib.auth.easyperm.level`` constants and the
``$lib.dict.has()`` function.
(`3706 <https://github.com/vertexproject/synapse/pull/3706>`_)

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

Features and Enhancements
-------------------------
- Update ``synapse.test.utils.SynTest`` helpers to disable sysctl checks
for test services by default.
(`3741 <https://github.com/vertexproject/synapse/pull/3741>`_)

Bugfixes
--------
- Fix a key positioning error in the LMDBSlab when scanning backwards
by prefix.
(`3739 <https://github.com/vertexproject/synapse/pull/3739>`_)
- Fix a bug in the ``str`` type normalization routine for handling floating
point values. The floating point values are now also run through the
string norming logic.
(`3742 <https://github.com/vertexproject/synapse/pull/3742>`_)
- Add missing beholder messages for view layer modifications.
(`3743 <https://github.com/vertexproject/synapse/pull/3743>`_)

Improved Documentation
----------------------
- Update Devops documentation to add additional information about low downtime
service updates, Rapid Power-Up updates, and release cadence information.
Update references from ``docker-compose`` to use ``docker compose``.
(`3722 <https://github.com/vertexproject/synapse/pull/3722>`_)

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

Automatic Migrations
--------------------
- Populate an additional index of buids by form in Layers.
(`3729 <https://github.com/vertexproject/synapse/pull/3729>`_)
- See :ref:`datamigration` for more information about automatic migrations.

Model Changes
-------------
- Updates to the ``infotech`` and ``file`` models.
(`3702 <https://github.com/vertexproject/synapse/pull/3702>`_)
(`3725 <https://github.com/vertexproject/synapse/pull/3725>`_)
(`3732 <https://github.com/vertexproject/synapse/pull/3732>`_)
- See :ref:`userguide_model_v2_170_0` for more detailed model changes.

Features and Enhancements
-------------------------
- Added ``$lib.model.migration.s.riskHasVulnToVulnerable`` migration helper
to create ``risk:vulnerable`` nodes from ``risk:hasvuln`` nodes.
(`3734 <https://github.com/vertexproject/synapse/pull/3734>`_)
- Added ``$lib.model.migration.s.itSecCpe_2_170_0()`` migration helper to update
``it:sec:cpe`` nodes created before this release. Details about the migration
helper can be found in the help (``help -v $lib.model.migration.s.itSecCpe_2_170_0``)
(`3515 <https://github.com/vertexproject/synapse/pull/3515>`_)
- Update Storm lift optimization for tag filters to also allow hinting
based on runtsafe variable values.
(`3733 <https://github.com/vertexproject/synapse/pull/3733>`_)
- Log an info message with the current Cell and Synapse version on startup.
(`3723 <https://github.com/vertexproject/synapse/pull/3723>`_)
- Add per-Cell version checks to prevent accidental downgrades of services.
(`3728 <https://github.com/vertexproject/synapse/pull/3728>`_)
- Add a check to Cells that will warn when performance related sysctl values
are not configured correctly on the host. This warning can be disabled with
the ``health:sysctl:checks`` configuration option.
(`3712 <https://github.com/vertexproject/synapse/pull/3712>`_)
- Add ``forms`` and ``interfaces`` type options to the ``ndef`` type, which
require the value to be one of the specified forms, or inherit one of the
specified interfaces.
(`3724 <https://github.com/vertexproject/synapse/pull/3724>`_)
- Add support for pivoting from an ``ndef`` secondary prop to specific form.
(`3715 <https://github.com/vertexproject/synapse/pull/3715>`_)
- Add support for pivoting to or from ``ndef`` array properties.
(`3720 <https://github.com/vertexproject/synapse/pull/3720>`_)
- Add an index of buids by form to Layers. A ``getStorNodesByForm()`` API has
been added to Storm Layer objects to retrieve storage nodes using this index.
(`3729 <https://github.com/vertexproject/synapse/pull/3729>`_)
- Storm Dmon APIs called on a Cortex mirror now call up to the leader to
retrieve their result.
(`3735 <https://github.com/vertexproject/synapse/pull/3735>`_)
- Add a ``insertParentFork()`` API on Storm View objects to insert a new
View between an existing fork and its parent View.
(`3731 <https://github.com/vertexproject/synapse/pull/3731>`_)
- Quorum merge requests are now allowed on Views which have forks.
(`3738 <https://github.com/vertexproject/synapse/pull/3738>`_)

Bugfixes
--------
- Fix a formatting issue in an error message that could be raised during
JSON decoding in a Storm ``http:api:request`` object.
(`3730 <https://github.com/vertexproject/synapse/pull/3730>`_)
- Fix an issue where ``inet:url`` norming did not handle IPv6 addresses
in the host portion of the URL correctly.
(`3727 <https://github.com/vertexproject/synapse/pull/3727>`_)
- Fix an issue where executing the ``view.exec`` command from within a
privileged Storm runtime still checked user permissions for the specified
view.
(`3726 <https://github.com/vertexproject/synapse/pull/3726>`_)
- Update logic for parsing CPE 2.2 and CPE 2.3 strings to be more compliant with
the specification. This resulted in better conversions from CPE 2.2 to CPE 2.3
and CPE 2.3 to CPE 2.2.
(`3515 <https://github.com/vertexproject/synapse/pull/3515>`_)

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

Features and Enhancements
-------------------------
- Add a data migration helper library, ``$lib.model.migration``. This
contains functions to help with migrating data via Storm.
(`3714 <https://github.com/vertexproject/synapse/pull/3714>`_)
- Add Extended HTTP API iden values to structured Storm query logs.
(`3710 <https://github.com/vertexproject/synapse/pull/3710>`_)
- Add ``node.data.set`` and ``node.data.pop`` to the list of declared
Cortex permissions.
(`3716 <https://github.com/vertexproject/synapse/pull/3716>`_)

Bugfixes
--------
- Restore cron iden values in structured Storm query logs.
(`3710 <https://github.com/vertexproject/synapse/pull/3710>`_)
- The Storm APIs ``$lib.min()`` and ``$lib.max()`` now handle a single
input. The Storm APIs ``$lib.min()`` and ``$lib.max()`` now raise a
``StormRuntimeError`` when there is no input provided to them. Previously
these conditions caused a Python exception in the Storm runtime.
(`3711 <https://github.com/vertexproject/synapse/pull/3711>`_)
- The ``onboot:optimize`` configuration now skips optimizing any LMDB files
found in the Cell local backup storage.
(`3713 <https://github.com/vertexproject/synapse/pull/3713>`_)

Deprecations
------------
- Removed the Telepath APIs ``CoreApi.enableMigrationMode`` and
``CoreApi.disableMigrationMode``. Remove support for the Cell
``hiveboot.yaml`` file. These had a removal date of 2025-05-05.
(`3717 <https://github.com/vertexproject/synapse/pull/3717>`_)