synapse 3.5.0__tar.gz → 3.6.0__tar.gz

{synapse-3.5.0/synapse.egg-info → synapse-3.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: synapse
-Version: 3.5.0
+Version: 3.6.0
 Summary: Synapse Intelligence Analysis Framework
 Author-email: The Vertex Project LLC <root@vertex.link>
 License-Expression: Apache-2.0

{synapse-3.5.0 → synapse-3.6.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = 'setuptools.build_meta'
 
 [project]
 name = 'synapse'
-version = '3.5.0'
+version = '3.6.0'
 authors = [
     { name = 'The Vertex Project LLC', email = 'root@vertex.link'},
 ]

{synapse-3.5.0 → synapse-3.6.0}/synapse/axon.py

@@ -1504,6 +1504,9 @@ class Axon(s_cell.Cell):
             if first:
                 first = False
                 delt = boff - offs
+                if delt == 0:
+                    continue
+
                 yield byts[-delt:]
                 continue
 

{synapse-3.5.0 → synapse-3.6.0}/synapse/data/skills/storm/SKILL.md

@@ -653,6 +653,7 @@ inet:fqdn { -> inet:dns:a [ +#reviewed ] } // still has inet:fqdn nodes in the p
 init { ... }                                  // runs once before any nodes are allowed through the pipeline
 empty { ... }                                 // runs if pipeline is empty
 fini { ... }                                  // runs once after all nodes have passed through the pipeline
+exec { ... }                                  // runs once, discarding the nodes it yields; inbound nodes pass through
 ```
 
 ### Built-in Commands
@@ -661,7 +662,6 @@ fini { ... }                                  // runs once after all nodes have
 limit 10                                      // limit output count
 count                                         // count nodes
 uniq                                          // deduplicate
-spin                                          // consume without output
 max :prop                                     // keep max by property
 min :prop                                     // keep min by property
 tee { query1 } { query2 }                   // branch pipeline
@@ -974,6 +974,7 @@ $func("positional", key=1)
 - Double-underscore `__` prefix for module-internal variables and functions: they cannot be accessed from outside the module that defines them (e.g. `function __getJson()`)
 - Module variables at top level: `$setup = $lib.import(...)`, `$srcnode = (null)`
 - Format strings with backticks for interpolation: `` `text {$var}` ``
+- Avoid `spin`: run a query whose nodes are not needed in an `exec { ... }` block, or isolate it in a function, and a query that returns a value uses `return()`, or `fini { return() }` when more than one node can flow
 - Parenthesize values and conditions so Storm evaluates them as typed expressions rather than bare strings or edit syntax: `(true)` / `(false)` / `(null)` (not `$lib.true` / `$lib.false` / `$lib.null`), numbers `(42)`, collections `([])` / `({})`, and comparisons like `if ($a = null)`
 - Use `$lib.raise(ErrName, "message")` for errors, `$lib.exit("message")` for fatal exits
 - Use `return()` with empty parens to return `(null)`

{synapse-3.5.0 → synapse-3.6.0}/synapse/lib/autodoc.py

@@ -1752,22 +1752,35 @@ async def processStormModulesMd(md, pkgname, modules):
         md.addHead(mname, lvl=2, anchor=anchor)
 
         for apidef in apidefs:
-
-            apiname = apidef['name']
-            apidesc = apidef['desc']
-            apitype = apidef['type']
-
-            callsig = genCallsig(apitype)
-            md.addHead(f'{apiname}{callsig}', lvl=3)
-            if depr := apidef.get('deprecated'):
-                md.addLines(*genDeprecationWarningMd(apiname, depr))
-            md.addLines(*prepareMdLines(apidesc))
-            md.addLines(*getArgLinesMd(apitype))
-            md.addLines(*getReturnLinesMd(apitype))
+            _renderApiDefMd(md, apidef, 3)
 
     if not hasapi:
         md.addLines('This package does not export any Storm APIs.', '')
 
+def _renderApiDefMd(md, apidef, lvl):
+    '''
+    Render one module apidef: a function, or a class followed by each of its methods one level down.
+    '''
+    apiname = apidef['name']
+    apidesc = apidef['desc']
+    apitype = apidef['type']
+
+    callsig = genCallsig(apitype)
+    md.addHead(f'{apiname}{callsig}', lvl=lvl)
+    if depr := apidef.get('deprecated'):
+        md.addLines(*genDeprecationWarningMd(apiname, depr))
+
+    md.addLines(*prepareMdLines(apidesc))
+    md.addLines(*getArgLinesMd(apitype))
+
+    # a class returns nothing itself: its methods each document their own returns
+    if apitype.get('type') != 'class':
+        md.addLines(*getReturnLinesMd(apitype))
+        return
+
+    for methdef in apitype['methods']:
+        _renderApiDefMd(md, methdef, lvl + 1)
+
 def _renderDepsTableMd(rows):
     lines = ['| Name | Version | Optional | Description |', '|---|---|---|---|']
     for name, vers, optional, desc in rows:

{synapse-3.5.0 → synapse-3.6.0}/synapse/lib/cell.py

@@ -948,7 +948,7 @@ class Cell(s_nexus.Pusher, s_telepath.Aware):
             'type': 'string',
         },
         'aha:promotable': {
-            'description': 'Set to false to prevent this service from being promoted to leader.',
+            'description': 'Set to false to exclude this service from automatic leader selection when the leader demotes, including during a graceful shutdown. It does not prevent an explicit promotion.',
             'type': 'boolean',
             'default': True,
         },
@@ -2094,12 +2094,8 @@ class Cell(s_nexus.Pusher, s_telepath.Aware):
         # consult the AHA leadership term for our service type to determine
         # whether we should take leadership or follow the current leader.
         proxy = await self.getAhaProxy()
-        if proxy is None:  # pragma: no cover
-            ahaurls = self.conf.get('aha:registry', ())
-            if isinstance(ahaurls, str):
-                ahaurls = (ahaurls,)
-
-            ahaurls = [s_urlhelp.sanitizeUrl(u) for u in ahaurls]
+        if proxy is None:
+            ahaurls = [s_urlhelp.sanitizeUrl(u) for u in self.conf.get('aha:servers', ())]
             mesg = f'Unable to reach AHA to register the leadership term during boot. Configured AHA URLs: {ahaurls}'
             raise s_exc.NotReady(mesg=mesg, aha=ahaurls)
 
@@ -2656,7 +2652,7 @@ class Cell(s_nexus.Pusher, s_telepath.Aware):
         retn = []
         async for svcentry in ahaproxy.getAhaSvcsByIden(self.iden, skiprun=self.runid):
 
-            if not svcentry['info'].get('promotable'): # pragma: no cover
+            if not svcentry['info'].get('promotable'):
                 continue
 
             retn.append(svcentry)
@@ -2703,7 +2699,7 @@ class Cell(s_nexus.Pusher, s_telepath.Aware):
                     logger.warning('...no suitable services discovered. Aborting demotion.', extra=extra)
                     return False
 
-                for svcindx, svcproxy in sorted(cands):
+                for svcindx, svcproxy in sorted(cands, key=lambda c: c[0], reverse=True):
 
                     try:
                         await svcproxy.promote()

{synapse-3.5.0 → synapse-3.6.0}/synapse/lib/mddocs.py

@@ -392,8 +392,11 @@ def bundleManifestEntries(srcdir, outdir, basedir):
 def saveManifest(path, entries):
     '''
     Write entries as a GNU sha256sum-format manifest: MANIFEST_HEADER, then one
-    "<hex>  <relpath>" line per entry, sorted by relpath, single trailing
-    newline.
+    "<hex>  <relpath>" line per entry, sorted by relpath, with a '#' comment line
+    between entries and a single trailing newline.
+
+    The comment lines keep every entry from touching its neighbors, so two
+    branches that each change a different page's hash merge without a conflict.
 
     Sorting happens HERE, and only here -- a plain codepoint sorted() on the
     relpath string, no locale, no str.lower(), no path-segment-aware comparison
@@ -420,7 +423,10 @@ def saveManifest(path, entries):
 
     with open(path, 'w') as fd:
         fd.write(MANIFEST_HEADER)
-        for relpath in sorted(byrelpath):
+        for i, relpath in enumerate(sorted(byrelpath)):
+            if i:
+                fd.write('#\n')
+
             fd.write(f'{byrelpath[relpath]}  {relpath}\n')
 
 def checkManifest(bundle, entries, basedir, hint=None):

{synapse-3.5.0 → synapse-3.6.0}/synapse/lib/schemas.py

@@ -1195,42 +1195,80 @@ _reqValidPkgdefSchema = {
                 'name': {'type': 'string'},
                 'desc': {'type': 'string'},
                 'deprecated': {'$ref': '#/definitions/deprecatedItem'},
+                # branched on type.type rather than oneOf, so an error names the field that failed
                 'type': {
+                    'if': {'properties': {'type': {'const': 'class'}}, 'required': ['type']},
+                    'then': {'$ref': '#/definitions/apiclass'},
+                    'else': {'$ref': '#/definitions/apifunc'},
+                },
+            },
+            'additionalProperties': False,
+            'required': ['name', 'desc', 'type']
+        },
+        # a method of a class apidef: a function, which may be deprecated on its own
+        'apimethod': {
+            'type': 'object',
+            'properties': {
+                'name': {'type': 'string'},
+                'desc': {'type': 'string'},
+                'deprecated': {'$ref': '#/definitions/deprecatedItem'},
+                'type': {'$ref': '#/definitions/apifunc'},
+            },
+            'additionalProperties': False,
+            'required': ['name', 'desc', 'type']
+        },
+        'apifunc': {
+            'type': 'object',
+            'properties': {
+                'type': {
+                    'type': 'string',
+                    'enum': ['function']
+                },
+                'args': {
+                    'type': 'array',
+                    'items': {'$ref': '#/definitions/apiarg'},
+                },
+                'returns': {
                     'type': 'object',
                     'properties': {
-                        'type': {
+                        'name': {
                             'type': 'string',
-                            'enum': ['function']
-                        },
-                        'args': {
-                            'type': 'array',
-                            'items': {'$ref': '#/definitions/apiarg'},
+                            'enum': ['yields'],
                         },
-                        'returns': {
-                            'type': 'object',
-                            'properties': {
-                                'name': {
-                                    'type': 'string',
-                                    'enum': ['yields'],
-                                },
-                                'desc': {'type': 'string'},
-                                'type': {
-                                    'oneOf': [
-                                        {'$ref': '#/definitions/apitype'},
-                                        {'type': 'array', 'items': {'$ref': '#/definitions/apitype'}},
-                                    ],
-                                },
-                            },
-                            'additionalProperties': False,
-                            'required': ['type', 'desc']
+                        'desc': {'type': 'string'},
+                        'type': {
+                            'oneOf': [
+                                {'$ref': '#/definitions/apitype'},
+                                {'type': 'array', 'items': {'$ref': '#/definitions/apitype'}},
+                            ],
                         },
                     },
                     'additionalProperties': False,
-                    'required': ['type', 'returns'],
+                    'required': ['type', 'desc']
                 },
             },
             'additionalProperties': False,
-            'required': ['name', 'desc', 'type']
+            'required': ['type', 'returns'],
+        },
+        'apiclass': {
+            'type': 'object',
+            'properties': {
+                'type': {
+                    'type': 'string',
+                    'enum': ['class']
+                },
+                # the arguments the class constructor takes
+                'args': {
+                    'type': 'array',
+                    'items': {'$ref': '#/definitions/apiarg'},
+                },
+                'methods': {
+                    'type': 'array',
+                    'items': {'$ref': '#/definitions/apimethod'},
+                },
+            },
+            'additionalProperties': False,
+            'required': ['type', 'methods'],
         },
         'apiarg': {
             'type': 'object',
@@ -1725,3 +1763,17 @@ _jwtclaimschema = {
 }
 reqValidJwtClaims = s_config.getJsValidator(_jwtclaimschema)
 jwtRegisteredClaims = frozenset(_jwtclaimschema['properties'])
+
+_stormLintStrList = {'type': 'array', 'items': {'type': 'string'}}
+
+_stormLintConfSchema = {
+    'type': 'object',
+    'properties': {
+        'select': _stormLintStrList,
+        'ignore': _stormLintStrList,
+        'enable': _stormLintStrList,
+        'exclude': _stormLintStrList,
+    },
+    'additionalProperties': False,
+}
+reqValidStormLintConf = s_config.getJsValidator(_stormLintConfSchema)