Synapse

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

Features and Enhancements
-------------------------
- Updated the ``lmdb`` library constraints to ``>=1.2.1,<1.7.0``.
(`4145 <https://github.com/vertexproject/synapse/pull/4145>`_)
- Added Endpoints section with path and description to Storm command help
output when defined.
(`4149 <https://github.com/vertexproject/synapse/pull/4149>`_)

Bugfixes
--------
- Fixed an issue where the guid dictionary syntax could raise an exception when
attempting to filter by alternate property values.
(`4147 <https://github.com/vertexproject/synapse/pull/4147>`_)
- Fixed bug where data model interface template values were modified by
inheritors.
(`4148 <https://github.com/vertexproject/synapse/pull/4148>`_)

Deprecations
------------
- Removed ``hiveauth.py`` and related APIs which depended on it.
(`4140 <https://github.com/vertexproject/synapse/pull/4140>`_)

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

Features and Enhancements
-------------------------
- Updated property set behavior to avoid warning when deprecated properties are
set as subs.
(`4143 <https://github.com/vertexproject/synapse/pull/4143>`_)
- Increased performance of the Storm ``merge`` command and ``View.merge()``
method.
(`4144 <https://github.com/vertexproject/synapse/pull/4144>`_)

Bugfixes
--------
- Fixed an issue with Snap construction in the Storm ``merge`` command.
(`4144 <https://github.com/vertexproject/synapse/pull/4144>`_)

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

Automatic Migrations
--------------------
- Added a migration to lock any service users which are marked as archived but
are not locked.
(`4100 <https://github.com/vertexproject/synapse/pull/4100>`_)
- See :ref:`datamigration` for more information about automatic migrations.

Model Changes
-------------
- See :ref:`userguide_model_v2_198_0` for more detailed model changes.

Features and Enhancements
-------------------------
- Added brief I/O yields for various LMDB operations to help improve
responsiveness when handling certain transactions.
(`3937 <https://github.com/vertexproject/synapse/pull/3937>`_)
- Added edit syntax for adding/removing node edges using a variable value
rather than a subquery.
(`4117 <https://github.com/vertexproject/synapse/pull/4117>`_)
- Added new endpoints section in the package definition schema, allowing the
configuration of multiple endpoints and details.
(`4127 <https://github.com/vertexproject/synapse/pull/4127>`_)
- Added ``++=``, ``--=``, ``?++=``, and ``?--=`` edit operators to Storm for
adding or removing multiple values from an array property in a single
operation.
(`4130 <https://github.com/vertexproject/synapse/pull/4130>`_)
- Updated Storm lift behavior to allow lifting guid forms and properties using
the property dictionary syntax.
(`4132 <https://github.com/vertexproject/synapse/pull/4132>`_)

Bugfixes
--------
- Fixed bug where archived users could be unlocked.
(`4100 <https://github.com/vertexproject/synapse/pull/4100>`_)
- Fixed an issue in ``$lib.regex`` where Python regex exceptions were leaking
into the Storm runtime.
(`4118 <https://github.com/vertexproject/synapse/pull/4118>`_)
- Fixed bug with ``syn:user`` and ``syn:role`` nodes when queried name does not
exist and the value is not a valid ``guid``.
(`4119 <https://github.com/vertexproject/synapse/pull/4119>`_)
- Fixed an issue where certain ``BadSyntax`` exceptions had incomplete error
highlighting information.
(`4120 <https://github.com/vertexproject/synapse/pull/4120>`_)
- Fixed an issue where leading/trailing whitespace and comments were not
included in the string representation of embedded Storm query objects.
(`4121 <https://github.com/vertexproject/synapse/pull/4121>`_)
- Fixed a bug where ``syn:user`` and ``syn:role`` types could take a ``*`` and
return a new ``guid``.
(`4122 <https://github.com/vertexproject/synapse/pull/4122>`_)
- Fixed an issue where the Axon failed to yield when calling the ``history()``
or ``get()`` APIs.
(`4131 <https://github.com/vertexproject/synapse/pull/4131>`_)

Deprecations
------------
- Deprecated ``synapse/lib/hiveauth.py`` and added deprecation messages to
related APIs. This file and related APIs will be removed in ``v2.199.0``.
(`4100 <https://github.com/vertexproject/synapse/pull/4100>`_)
(`4141 <https://github.com/vertexproject/synapse/pull/4141>`_)

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

Model Changes
-------------
- Added ``doc:resume`` and ``doc:requirement`` to the data model.
(`4104 <https://github.com/vertexproject/synapse/pull/4104>`_)
- See :ref:`userguide_model_v2_197_0` for more detailed model changes.

Features and Enhancements
-------------------------
- Increased the performance of executing Storm commands which have type
annotations.
(`4111 <https://github.com/vertexproject/synapse/pull/4111>`_)
- Move Storm Package JSON schema to ``synapse.lib.schemas``.
(`4112 <https://github.com/vertexproject/synapse/pull/4112>`_)
- Added ``index.count.prop`` command to make it easier to count properties
stored in the view and layers.
(`4113 <https://github.com/vertexproject/synapse/pull/4113>`_)

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

Automatic Migrations
--------------------
- Generated ``entity:name`` nodes for existing ``transport:sea:vessel:name``
properties.
(`4096 <https://github.com/vertexproject/synapse/pull/4096>`_)
- See :ref:`datamigration` for more information about automatic migrations.

Model Changes
-------------
- See :ref:`userguide_model_v2_196_0` for more detailed model changes.

Features and Enhancements
-------------------------
- Added new AHA APIs that may be used to dispatch functions on service
clusters.
(`3795 <https://github.com/vertexproject/synapse/pull/3795>`_)
- Added new ``getTasks()`` API which can include gathering tasks from peers
via AHA.
(`3795 <https://github.com/vertexproject/synapse/pull/3795>`_)
- Added a new ``aha.svc.mirror`` Storm command to query the status of the
mirror clusters managed by the AHA server.
(`4019 <https://github.com/vertexproject/synapse/pull/4019>`_)
- Added a new command-line tool ``synapse.tools.aha.mirror`` for querying the
status of service mirror clusters managed by the AHA server.
(`4019 <https://github.com/vertexproject/synapse/pull/4019>`_)
- Added ``$lib.axon.read()`` and ``$lib.axon.unpack()`` Storm APIs.
(`4097 <https://github.com/vertexproject/synapse/pull/4097>`_)
- Added ``liftByNodeData()`` API to the Storm ``layer`` type to allow lifting
by node data in a given layer.
(`4099 <https://github.com/vertexproject/synapse/pull/4099>`_)

Bugfixes
--------
- Fixed issue where sub-properties were being assigned when the sub-property
was deprecated and locked.
(`4098 <https://github.com/vertexproject/synapse/pull/4098>`_)
- Fixed an issue where ``JsonStor.delPathObjProp()`` could raise a KeyError.
(`4101 <https://github.com/vertexproject/synapse/pull/4101>`_)

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

Bugfixes
--------
- Fixed an issue with unbound text values being included in some
``StormRuntimeError`` exceptions raised when interacting with Storm APIs.
(`4092 <https://github.com/vertexproject/synapse/pull/4092>`_)
- Fixed an issue where pending Nexus edits to an object which was in the
process of being deleted could potentially still be distributed to mirrors.
(`4094 <https://github.com/vertexproject/synapse/pull/4094>`_)