Synapse

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

Features and Enhancements
-------------------------
- Add ``$lib.regex.replace()`` Stormtypes API to perform regex based
replacement of string parts.
(`2274 <https://github.com/vertexproject/synapse/pull/2274>`_)
- Add universal properties to the dictionary returned by
``Cortex.getModelDict()`` as a ``univs`` key.
(`2276 <https://github.com/vertexproject/synapse/pull/2276>`_)
- Add additional ``asyncio.sleep(0)`` statements to ``Layer._storNodeEdits``
to improve Cortex responsiveness when storing large numbers of edits at
once.
(`2275 <https://github.com/vertexproject/synapse/pull/2275>`_)

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

Features and Enhancements
-------------------------
- Update the Cortex ``storm:log:level`` configuration value to accept string
values such as ``DEBUG``, ``INFO``, etc. The default log level for Storm
query logs is now ``INFO`` level.
(`2262 <https://github.com/vertexproject/synapse/pull/2262>`_)
- Add ``$lib.regex.findall()`` Stormtypes API to find all matching parts of a
regular expression in a given string.
(`2265 <https://github.com/vertexproject/synapse/pull/2265>`_)
- Add ``$lib.inet.http.head()`` Stormtypes API to perform easy HEAD requests,
and ``allow_redirects`` arguments to existing ``lib.inet.http`` APIs to
allow controlling the redirect behavior.
(`2268 <https://github.com/vertexproject/synapse/pull/2268>`_)
- Add ``$lib.storm.eval()`` API to evaluate Storm values from strings.
(`2269 <https://github.com/vertexproject/synapse/pull/2269>`_)
- Add ``getSystemInfo()`` and ``getBackupInfo()`` APIS to the Cell for getting
useful system information.
(`2267 <https://github.com/vertexproject/synapse/pull/2267>`_)
- Allow lists in rstorm bodies.
(`2261 <https://github.com/vertexproject/synapse/pull/2261>`_)
- Add a ``:desc`` secondary property to the ``proj:sprint`` form.
(`2261 <https://github.com/vertexproject/synapse/pull/2261>`_)
- Call _normStormPkg in all loadStormPkg paths, move validation to post
normalization and remove mutation in validator
(`2260 <https://github.com/vertexproject/synapse/pull/2260>`_)
- Add ``SYN_SLAB_COMMIT_PERIOD`` environment variable to control the Synapse
slab commit period. Add ``layer:lmdb:max_replay_log`` Cortex option to
control the slab replay log size.
(`2266 <https://github.com/vertexproject/synapse/pull/2266>`_)
- Update Ahacell log messages.
(`2270 <https://github.com/vertexproject/synapse/pull/2270>`_)

Bugfixes
--------
- Fix an issue where the ``Trigger.pack()`` method failed when the user that
created the trigger had been deleted.
(`2263 <https://github.com/vertexproject/synapse/pull/2263>`_)

Improved Documentation
----------------------
- Update the Cortex devops documentation for the Cortex to document the Storm
query logging. Update the Cell devops documentation to explain the Cell
logging and how to enable structured (JSON) logging output.
(`2262 <https://github.com/vertexproject/synapse/pull/2262>`_)
- Update Stormtypes API documentation for ``bool``, ``proj:epic``,
``proj:epics``, ``proj:ticket``, ``proj:tickets``, ``proj:sprint``,
``proj:sprints``, ``proj:project``, ``stix:bundle`` types.
(`2261 <https://github.com/vertexproject/synapse/pull/2261>`_)

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

Features and Enhancements
-------------------------
- Add a application level process pool the base Cell implemenation. Move the
processing of Storm query text into the process pool.
(`2250 <https://github.com/vertexproject/synapse/pull/2250>`_)
(`2259 <https://github.com/vertexproject/synapse/pull/2259>`_)
- Minimize the re-validation of Storm code on Cortex boot.
(`2257 <https://github.com/vertexproject/synapse/pull/2257>`_)
- Add the ``ou:preso`` form to record conferences and presentations. Add a
``status`` secondary property to the ``it:mitre:attack:technique`` form to
track if techniques are current, deprecated or withdrawn.
(`2254 <https://github.com/vertexproject/synapse/pull/2254>`_)

Bugfixes
--------
- Remove incorrect use of ``cmdopts`` in Storm command definitions unit tests.
(`2258 <https://github.com/vertexproject/synapse/pull/2258>`_

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

This release contains an automatic data migration that may cause additional
startup time on the first boot. This only applies to a Cortex that is using
user defined tag properties or using ``ps:person:name`` properties.
Deployments with startup or liveliness probes should have those disabled while
this upgrade is performed to prevent accidental termination of the Cortex
process. Please ensure you have a tested backup available before applying this
update.

Features and Enhancements
-------------------------
- Add a ``.move()`` method on Stormtypes ``trigger`` objects to allow
moving a Trigger from one View to another View.
(`2252 <https://github.com/vertexproject/synapse/pull/2252>`_)
- When the Aha service marks a service as down, log why that service is being
marked as such.
(`2255 <https://github.com/vertexproject/synapse/pull/2255>`_)
- Add ``:budget:price`` property to the ``ou:contract`` form. Add ``:settled``
property to the ``econ:purchase`` form.
(`2253 <https://github.com/vertexproject/synapse/pull/2253>`_

Bugfixes
--------
- Make the array property ``ps:person:names`` a unique array property.
(`2253 <https://github.com/vertexproject/synapse/pull/2253>`_
- Add missing tagprop key migration for the bybuidv3 index.
(`2256 <https://github.com/vertexproject/synapse/pull/2256>`_)

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

Features and Enhancements
-------------------------
- Add a ``.type`` string to the Stormtypes ``auth:gate`` object to
allow a user to identify the type of auth gate it is.
(`2238 <https://github.com/vertexproject/synapse/pull/2238>`_)
- Add ``$lib.user.iden`` reference to the Stormtype ``$lib.user`` to get the
iden of the current user executing Storm code.
(`2236 <https://github.com/vertexproject/synapse/pull/2236>`_)
- Add a ``--no-build`` option to ``synapse.tools.genpkg`` to allow pushing an
a complete Storm Package file.
(`2231 <https://github.com/vertexproject/synapse/pull/2231>`_)
(`2232 <https://github.com/vertexproject/synapse/pull/2232>`_)
(`2233 <https://github.com/vertexproject/synapse/pull/2233>`_)
- The Storm ``movetag`` command now checks for cycles when setting the
``syn:tag:isnow`` property.
(`2229 <https://github.com/vertexproject/synapse/pull/2229>`_)
- Deprecate the ``ou:org:has`` form, in favor of using light edges for
storing those relationships.
(`2234 <https://github.com/vertexproject/synapse/pull/2234>`_)
- Add a ``description`` property to the ``ou:industry`` form.
(`2239 <https://github.com/vertexproject/synapse/pull/2239>`_)
- Add a ``--name`` parameter to the Storm ``trigger.add`` command to name
triggers upon creation.
(`2237 <https://github.com/vertexproject/synapse/pull/2237>`_)
- Add ``regx`` to the ``BadTypeValu`` exception of the ``str`` type when
a regular expression fails to match.
(`2240 <https://github.com/vertexproject/synapse/pull/2240>`_)
- Consolidate Storm parsers to a single Parser object to improve startup time.
(`2247 <https://github.com/vertexproject/synapse/pull/2247>`_)
- Improve error logging in the Cortex ``callStorm()`` and ``storm()`` APIs.
(`2243 <https://github.com/vertexproject/synapse/pull/2243>`_)
- Add ``from:contract``, ``to:contract``, and ``memo`` properties to the
``econ:acct:payment`` form.
(`2248 <https://github.com/vertexproject/synapse/pull/2248>`_)
- Improve the Cell backup streaming APIs link cleanup.
(`2249 <https://github.com/vertexproject/synapse/pull/2249>`_)

Bugfixes
--------
- Fix issue with grabbing the incorrect Telepath link when performing a Cell
backup.
(`2246 <https://github.com/vertexproject/synapse/pull/2246>`_)
- Fix missing ``toprim`` calls in ``$lib.inet.http.connect()``.
(`2235 <https://github.com/vertexproject/synapse/pull/2235>`_)
- Fix missing Storm command form hint schema from the Storm Package schema.
(`2242 <https://github.com/vertexproject/synapse/pull/2242>`_)

Improved Documentation
----------------------
- Add documentation for deprecated model forms and properties, along with
modeling alternatives.
(`2234 <https://github.com/vertexproject/synapse/pull/2234>`_)
- Update documentation for the Storm ``help`` command to add examples of
command substring matching.
(`2241 <https://github.com/vertexproject/synapse/pull/2241>`_)

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

Bugfixes
--------
- Protect against a few possible RuntimeErrors due to dictionary sizes
changing during iteration.
(`2227 <https://github.com/vertexproject/synapse/pull/2227>`_)
- Fix StormType ``Lib`` lookups with imported modules which were raising
a ``TypeError`` instead of a ``NoSuchName`` error.
(`2228 <https://github.com/vertexproject/synapse/pull/2228>`_)
- Drop old Storm Packages if they are present when re-adding them. This fixes
an issue with runtime updates leaving old commands in the Cortex.
(`2230 <https://github.com/vertexproject/synapse/pull/2230>`_)