Synapse

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

Model Changes
-------------
- Updates to the ``inet`` model.
(`3811 <https://github.com/vertexproject/synapse/pull/3811>`_)
(`3814 <https://github.com/vertexproject/synapse/pull/3814>`_)
- See :ref:`userguide_model_v2_176_0` for more detailed model changes.

Features and Enhancements
-------------------------
- Add ``storm.exec`` command for executing arbitrary text as Storm.
(`3807 <https://github.com/vertexproject/synapse/pull/3807>`_)
(`3812 <https://github.com/vertexproject/synapse/pull/3812>`_)
- Ensure the ``synapse.storm`` structured log messages contain the view iden.
(`3812 <https://github.com/vertexproject/synapse/pull/3812>`_)
- Added ``$lib.storm.run()`` to programmatically invoke Storm.
(`3813 <https://github.com/vertexproject/synapse/pull/3813>`_)
- Remove the per-node pivot errors from the Cortex log output.
(`3819 <https://github.com/vertexproject/synapse/pull/3819>`_)

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

Automatic Migrations
--------------------
- Migrate existing ndef secondary properties to use the new ndef property
indexing.
(`3794 <https://github.com/vertexproject/synapse/pull/3794>`_)
(`3809 <https://github.com/vertexproject/synapse/pull/3809>`_)
- See :ref:`datamigration` for more information about automatic migrations.

Features and Enhancements
-------------------------
- Update Cell with ``_getCellHttpOpts()`` method to allow for overriding default
HTTP options.
(`3770 <https://github.com/vertexproject/synapse/pull/3770>`_)
- Add additional indexing for ndef based secondary properties.
(`3794 <https://github.com/vertexproject/synapse/pull/3794>`_)
(`3809 <https://github.com/vertexproject/synapse/pull/3809>`_)
- Implement ``--prs-from-git`` in ``synapse.tools.changelog``.
(`3800 <https://github.com/vertexproject/synapse/pull/3800>`_)
- Update the ``getCellInfo()`` API to include HTTPS listener addresses and
ports.
(`3802 <https://github.com/vertexproject/synapse/pull/3802>`_)
- Improve permissions checking performance in the Storm ``merge`` command.
(`3804 <https://github.com/vertexproject/synapse/pull/3804>`_)
- Support multiple tags in the diff command, which also allows for more
efficient deduplication (e.g. ``diff --tag foo bar``
versus ``diff --tag foo | diff --tag bar | uniq``).
(`3806 <https://github.com/vertexproject/synapse/pull/3806>`_)
- Add information about the remote link when logging common server side
Telepath errors.
(`3808 <https://github.com/vertexproject/synapse/pull/3808>`_)

Bugfixes
--------
- Fix an AttributeError in ``synapse.tools.changelog``.
(`3798 <https://github.com/vertexproject/synapse/pull/3798>`_)
- Fix for large array props causing system lag.
(`3799 <https://github.com/vertexproject/synapse/pull/3799>`_)

Improved documentation
----------------------
- Remaining docs have been converted from Jupyter notebook format to RST.
(`3803 <https://github.com/vertexproject/synapse/pull/3803>`_)

Deprecations
------------
- Deprecate the use of the ``synapse.lib.jupyter`` library. This will be
removed on 2024-08-26.
(`3803 <https://github.com/vertexproject/synapse/pull/3803>`_)

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

Automatic Migrations
--------------------
- Renormalize ``ou:position:title``, ``ou:conference:name``, and
``ou:conference:names`` secondary properties.
(`3701 <https://github.com/vertexproject/synapse/pull/3701>`_)
- Populate new ``econ:currency`` nodes from existing secondary properties.
(`3790 <https://github.com/vertexproject/synapse/pull/3790>`_)
- Add a Cortex storage migration to set the correct View iden value on all
Trigger definitions.
(`3760 <https://github.com/vertexproject/synapse/pull/3760>`_)
- See :ref:`datamigration` for more information about automatic migrations.

Model Changes
-------------
- Add a new model, ``entity``, for modeling elements related to entity
resolution.
(`3781 <https://github.com/vertexproject/synapse/pull/3781>`_)
- Updates to the ``crypto``, ``econ``, ``files``, ``ou``, and ``pol`` models.
(`3790 <https://github.com/vertexproject/synapse/pull/3790>`_)
(`3781 <https://github.com/vertexproject/synapse/pull/3781>`_)
- See :ref:`userguide_model_v2_174_0` for more detailed model changes.

Features and Enhancements
-------------------------
- Add additional context to structured log information when a long LMDB commit
is detected.
(`3747 <https://github.com/vertexproject/synapse/pull/3747>`_)
- Add support to ``synapse.lib.msgpack`` functions for handling integers
requiring more than 64 bits to store them.
(`3767 <https://github.com/vertexproject/synapse/pull/3767>`_)
(`3780 <https://github.com/vertexproject/synapse/pull/3780>`_)
- Add support for Storm variables in array filters.
(`3775 <https://github.com/vertexproject/synapse/pull/3775>`_)
- Add a ``kill()`` API to the Storm ``cron`` objects.
(`3787 <https://github.com/vertexproject/synapse/pull/3787>`_)
(`3796 <https://github.com/vertexproject/synapse/pull/3796>`_)
- Add log messages when a cron job is enabled or disabled.
(`3793 <https://github.com/vertexproject/synapse/pull/3793>`_)

Bugfixes
--------
- Trigger definitions now always have the View iden that they belong to set
upon View creation. The Storm ``$lib.trigger.set()`` API now uses the trigger
view instead of the current view when checking permissions.
(`3760 <https://github.com/vertexproject/synapse/pull/3760>`_)
- Add missing item information when an error occurs while replaying a nexus
change entry upon startup
(`3778 <https://github.com/vertexproject/synapse/pull/3778>`_)
- Fix the startup order for the Cortex embedded JSONStor to avoid an issue with
the nexus replay on startup.
(`3779 <https://github.com/vertexproject/synapse/pull/3779>`_)
- Wrap the Nexus mirror loop setup code in a try/except block to handle
unexpected errors.
(`3781 <https://github.com/vertexproject/synapse/pull/3781>`_)
- Only fire the beholder ``pkg:add`` events when the contents of a Storm
package change.
(`3785 <https://github.com/vertexproject/synapse/pull/3785>`_)

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

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>`_)