synapse 2.195.1__py311-none-any.whl → 2.197.0__py311-none-any.whl

synapse/lib/modelrev.py

@@ -13,7 +13,7 @@ import synapse.models.infotech as s_infotech
 
 logger = logging.getLogger(__name__)
 
-maxvers = (0, 2, 32)
+maxvers = (0, 2, 33)
 
 class ModelRev:
 
@@ -51,6 +51,7 @@ class ModelRev:
             ((0, 2, 30), self.revModel_0_2_30),
             ((0, 2, 31), self.revModel_0_2_31),
             ((0, 2, 32), self.revModel_0_2_32),
+            ((0, 2, 33), self.revModel_0_2_33),
         )
 
     async def _uniqSortArray(self, todoprops, layers):
@@ -820,6 +821,9 @@ class ModelRev:
         await self._normPropValu(layers, 'transport:air:craft:model')
         await self._normPropValu(layers, 'transport:sea:vessel:model')
 
+    async def revModel_0_2_33(self, layers):
+        await self._propToForm(layers, 'transport:sea:vessel:name', 'entity:name')
+
     async def runStorm(self, text, opts=None):
         '''
         Run storm code in a schedcoro and log the output messages.

synapse/lib/multislabseqn.py

@@ -150,7 +150,7 @@ class MultiSlabSeqn(s_base.Base):
                     firstidx = firstitem[0]  # might not match the separately stored first index due to culling
 
                     if firstidx < fnstartidx:
-                        raise s_exc.BadCoreStore('Multislab:  filename inconsistent with contents')
+                        raise s_exc.BadCoreStore(mesg='Multislab:  filename inconsistent with contents')
 
                     lastidx = seqn.index() - 1
 
@@ -161,7 +161,7 @@ class MultiSlabSeqn(s_base.Base):
             self.firstindx = lowindx
 
         if self.firstindx > self.indx:
-            raise s_exc.BadCoreStore('Invalid firstindx value')
+            raise s_exc.BadCoreStore(mesg='Invalid firstindx value')
 
         await self._initTailSlab(fnstartidx)
 

synapse/lib/nexus.py

@@ -413,7 +413,7 @@ class NexsRoot(s_base.Base):
 
         return await func(nexus, *args, **kwargs)
 
-    async def iter(self, offs: int, tellready=False) -> AsyncIterator[Any]:
+    async def iter(self, offs: int, tellready=False, wait=True) -> AsyncIterator[Any]:
         '''
         Returns an iterator of change entries in the log
         '''
@@ -434,6 +434,9 @@ class NexsRoot(s_base.Base):
         if tellready:
             yield None
 
+        if not wait:
+            return
+
         async with self.getChangeDist(maxoffs) as dist:
             async for item in dist:
                 if self.isfini:

synapse/lib/reflect.py

@@ -87,17 +87,16 @@ def getShareInfo(item):
         if not callable(attr):
             continue
 
+        meths[name] = meth = {}
+
         # We know we can cleanly unwrap these functions
         # for asyncgenerator inspection.
         wrapped = getattr(attr, '__syn_wrapped__', None)
         if wrapped in unwraps:
-            real = inspect.unwrap(attr)
-            if inspect.isasyncgenfunction(real):
-                meths[name] = {'genr': True}
-                continue
+            attr = inspect.unwrap(attr)
 
         if inspect.isasyncgenfunction(attr):
-            meths[name] = {'genr': True}
+            meth['genr'] = True
 
     try:
         setattr(item, key, info)

synapse/lib/schemas.py

@@ -1,7 +1,8 @@
 import synapse.lib.const as s_const
 import synapse.lib.config as s_config
+import synapse.lib.grammar as s_grammar
 import synapse.lib.msgpack as s_msgpack
-
+import synapse.lib.version as s_version
 
 easyPermSchema = {
     'type': 'object',
@@ -551,3 +552,479 @@ stixIngestBundleSchema = {
     },
 }
 reqValidStixIngestBundle = s_config.getJsValidator(stixIngestBundleSchema)
+
+_reqValidGdefSchema = {
+    'type': 'object',
+    'properties': {
+        'iden': {'type': 'string', 'pattern': s_config.re_iden},
+        'name': {'type': 'string', 'minLength': 1},
+        'desc': {'type': 'string', 'default': ''},
+        'scope': {'type': 'string', 'enum': ['user', 'power-up']},
+        'creator': {'type': 'string', 'pattern': s_config.re_iden},
+        'power-up': {'type': 'string', 'minLength': 1},
+        'maxsize': {'type': 'number', 'minimum': 0},
+        'existing': {'type': 'array', 'items': {'type': 'string'}},
+        'created': {'type': 'number'},
+        'updated': {'type': 'number'},
+        'refs': {'type': 'boolean', 'default': False},
+        'edges': {'type': 'boolean', 'default': True},
+        'edgelimit': {'type': 'number', 'default': 3000},
+        'degrees': {'type': ['integer', 'null'], 'minimum': 0},
+        'filterinput': {'type': 'boolean', 'default': True},
+        'yieldfiltered': {'type': 'boolean', 'default': False},
+        'filters': {
+            'type': ['array', 'null'],
+            'items': {'type': 'string'}
+        },
+        'pivots': {
+            'type': ['array', 'null'],
+            'items': {'type': 'string'}
+        },
+        'forms': {
+            'type': 'object',
+            'patternProperties': {
+                '^.*$': {
+                    'type': 'object',
+                    'properties': {
+                        'filters': {
+                            'type': ['array', 'null'],
+                            'items': {'type': 'string'}
+                        },
+                        'pivots': {
+                            'type': ['array', 'null'],
+                            'items': {'type': 'string'}
+                        }
+                    },
+                    'additionalProperties': False,
+                }
+            }
+        },
+        'permissions': s_msgpack.deepcopy(easyPermSchema)
+    },
+    'additionalProperties': False,
+    'required': ['iden', 'name', 'scope'],
+    'allOf': [
+        {
+            'if': {'properties': {'scope': {'const': 'power-up'}}},
+            'then': {'required': ['power-up']},
+            'else': {'required': ['creator']},
+        }
+    ]
+}
+reqValidGdef = s_config.getJsValidator(_reqValidGdefSchema)
+
+_reqValidPermDefSchema = {
+    'type': 'object',
+    'properties': {
+        'perm': {'type': 'array', 'items': {'type': 'string'}},
+        'desc': {'type': 'string'},
+        'gate': {'type': 'string'},
+        'ex': {'type': 'string'},  # Example string
+        'workflowconfig': {'type': 'boolean'},
+        'default': {'type': 'boolean', 'default': False},
+    },
+    'required': ['perm', 'desc', 'gate'],
+}
+
+reqValidPermDef = s_config.getJsValidator(_reqValidPermDefSchema)
+
+# N.B. This is kept in sync with s_datamodel.Datamodel().types
+# with the DatamodelTest.test_datamodel_schema_basetypes test.
+datamodel_basetypes = [
+    'int',
+    'float',
+    'range',
+    'str',
+    'hex',
+    'bool',
+    'time',
+    'duration',
+    'ival',
+    'guid',
+    'syn:tag:part',
+    'syn:tag',
+    'comp',
+    'loc',
+    'ndef',
+    'array',
+    'edge',
+    'timeedge',
+    'data',
+    'nodeprop',
+    'hugenum',
+    'taxon',
+    'taxonomy',
+    'velocity',
+]
+
+_reqValidPkgdefSchema = {
+    'type': 'object',
+    'properties': {
+        'name': {'type': 'string'},
+        'version': {
+            'type': 'string',
+            'pattern': s_version.semverstr,
+        },
+        'build': {
+            'type' 'object'
+            'properties': {
+                'time': {'type': 'number'},
+            },
+            'required': ['time'],
+        },
+        'codesign': {
+            'type': 'object',
+            'properties': {
+                'sign': {'type': 'string'},
+                'cert': {'type': 'string'},
+            },
+            'required': ['cert', 'sign'],
+        },
+        # TODO: Remove me after Synapse 3.0.0.
+        'synapse_minversion': {
+            'type': ['array', 'null'],
+            'items': {'type': 'number'}
+        },
+        'synapse_version': {
+            'type': 'string',
+        },
+        'modules': {
+            'type': ['array', 'null'],
+            'items': {'$ref': '#/definitions/module'}
+        },
+        'docs': {
+            'type': ['array', 'null'],
+            'items': {'$ref': '#/definitions/doc'},
+        },
+        'logo': {
+            'type': 'object',
+            'properties': {
+                'mime': {'type': 'string'},
+                'file': {'type': 'string'},
+            },
+            'additionalProperties': True,
+            'required': ['mime', 'file'],
+        },
+        'commands': {
+            'type': ['array', 'null'],
+            'items': {'$ref': '#/definitions/command'},
+        },
+        'graphs': {
+            'type': ['array', 'null'],
+            'items': s_msgpack.deepcopy(_reqValidGdefSchema, use_list=True),
+        },
+        'desc': {'type': 'string'},
+        'svciden': {'type': ['string', 'null'], 'pattern': s_config.re_iden},
+        'onload': {'type': 'string'},
+        'author': {
+            'type': 'object',
+            'properties': {
+                'url': {'type': 'string'},
+                'name': {'type': 'string'},
+            },
+            'required': ['name', 'url'],
+        },
+        'depends': {
+            'properties': {
+                'requires': {'type': 'array', 'items': {'$ref': '#/definitions/require'}},
+                'conflicts': {'type': 'array', 'items': {'$ref': '#/definitions/conflict'}},
+            },
+            'additionalProperties': True,
+        },
+        'perms': {
+            'type': 'array',
+            'items': s_msgpack.deepcopy(_reqValidPermDefSchema),
+        },
+        'configvars': {
+            'type': 'array',
+            'items': {
+                'type': 'object',
+                'properties': {
+                    'name': {'type': 'string'},
+                    'varname': {'type': 'string'},
+                    'desc': {'type': 'string'},
+                    'default': {},
+                    'workflowconfig': {'type': 'boolean'},
+                    'type': {'$ref': '#/definitions/configvartype'},
+                    'scopes': {
+                        'type': 'array',
+                        'items': {
+                            'type': 'string',
+                            'enum': ['global', 'self']
+                        },
+                    },
+                },
+                'required': ['name', 'varname', 'desc', 'type', 'scopes'],
+            },
+        },
+    },
+    'additionalProperties': True,
+    'required': ['name', 'version'],
+    'definitions': {
+        'doc': {
+            'type': 'object',
+            'properties': {
+                'title': {'type': 'string'},
+                'content': {'type': 'string'},
+            },
+            'additionalProperties': True,
+            'required': ['title', 'content'],
+        },
+        'module': {
+            'type': 'object',
+            'properties': {
+                'name': {'type': 'string'},
+                'storm': {'type': 'string'},
+                'modconf': {'type': 'object'},
+                'apidefs': {
+                    'type': ['array', 'null'],
+                    'items': {'$ref': '#/definitions/apidef'},
+                },
+                'asroot': {'type': 'boolean'},
+                'asroot:perms': {'type': 'array',
+                    'items': {'type': 'array',
+                        'items': {'type': 'string'}},
+                },
+            },
+            'additionalProperties': True,
+            'required': ['name', 'storm']
+        },
+        'apidef': {
+            'type': 'object',
+            'properties': {
+                'name': {'type': 'string'},
+                'desc': {'type': 'string'},
+                'deprecated': {'$ref': '#/definitions/deprecatedItem'},
+                'type': {
+                    'type': 'object',
+                    'properties': {
+                        'type': {
+                            'type': 'string',
+                            'enum': ['function']
+                        },
+                        'args': {
+                            'type': 'array',
+                            'items': {'$ref': '#/definitions/apiarg'},
+                        },
+                        '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']
+                        },
+                    },
+                    'additionalProperties': False,
+                    'required': ['type', 'returns'],
+                },
+            },
+            'additionalProperties': False,
+            'required': ['name', 'desc', 'type']
+        },
+        'apiarg': {
+            'type': 'object',
+            'properties': {
+                'name': {'type': 'string'},
+                'desc': {'type': 'string'},
+                'type': {
+                    'oneOf': [
+                        {'$ref': '#/definitions/apitype'},
+                        {'type': 'array', 'items': {'$ref': '#/definitions/apitype'}},
+                    ],
+                },
+                'default': {'type': ['boolean', 'integer', 'string', 'null']},
+            },
+            'additionalProperties': False,
+            'required': ['name', 'desc', 'type']
+        },
+        'deprecatedItem': {
+            'type': 'object',
+            'properties': {
+                'eolvers': {'type': 'string', 'minLength': 1,
+                            'description': "The version which will not longer support the item."},
+                'eoldate': {'type': 'string', 'minLength': 1,
+                            'description': 'Optional string indicating Synapse releases after this date may no longer support the item.'},
+                'mesg': {'type': ['string', 'null'], 'default': None,
+                         'description': 'Optional message to include in the warning text.'}
+            },
+            'oneOf': [
+                {
+                    'required': ['eolvers'],
+                    'not': {'required': ['eoldate']}
+                },
+                {
+                    'required': ['eoldate'],
+                    'not': {'required': ['eolvers']}
+                }
+            ],
+            'additionalProperties': False,
+        },
+        'apitype': {
+            'type': 'string',
+        },
+        'command': {
+            'type': 'object',
+            'properties': {
+                'name': {
+                    'type': 'string',
+                    'pattern': s_grammar.re_scmd
+                },
+                'cmdargs': {
+                    'type': ['array', 'null'],
+                    'items': {'$ref': '#/definitions/cmdarg'},
+                },
+                'cmdinputs': {
+                    'type': ['array', 'null'],
+                    'items': {'$ref': '#/definitions/cmdinput'},
+                },
+                'storm': {'type': 'string'},
+                'forms': {'$ref': '#/definitions/cmdformhints'},
+                'perms': {'type': 'array',
+                    'items': {'type': 'array',
+                        'items': {'type': 'string'}},
+                },
+            },
+            'additionalProperties': True,
+            'required': ['name', 'storm']
+        },
+        'cmdarg': {
+            'type': 'array',
+            'items': [
+                {'type': 'string'},
+                {
+                    'type': 'object',
+                    'properties': {
+                        'help': {'type': 'string'},
+                        'default': {},
+                        'dest': {'type': 'string'},
+                        'required': {'type': 'boolean'},
+                        'action': {'type': 'string'},
+                        'nargs': {'type': ['string', 'integer']},
+                        'choices': {
+                            'type': 'array',
+                            'uniqueItems': True,
+                            'minItems': 1,
+                        },
+                        'type': {
+                            'type': 'string',
+                            'enum': s_msgpack.deepcopy(datamodel_basetypes),
+                        },
+                    },
+                }
+            ],
+            'additionalItems': False,
+        },
+        'cmdinput': {
+            'type': 'object',
+            'properties': {
+                'form': {'type': 'string'},
+                'help': {'type': 'string'},
+            },
+            'additionalProperties': True,
+            'required': ['form'],
+        },
+        'configvartype': {
+            'anyOf': [
+                {'type': 'array', 'items': {'$ref': '#/definitions/configvartype'}},
+                {'type': 'string'},
+            ]
+        },
+        # deprecated
+        'cmdformhints': {
+            'type': 'object',
+            'properties': {
+                'input': {
+                    'type': 'array',
+                    'uniqueItems': True,
+                    'items': {
+                        'type': 'string',
+                    }
+                },
+                'output': {
+                    'type': 'array',
+                    'uniqueItems': True,
+                    'items': {
+                        'type': 'string',
+                    }
+                },
+                'nodedata': {
+                    'type': 'array',
+                    'uniqueItems': True,
+                    'items': {
+                        'type': 'array',
+                        'items': [
+                            {'type': 'string'},
+                            {'type': 'string'},
+                        ],
+                        'additionalItems': False,
+                    },
+                },
+            }
+        },
+        'require': {
+            'type': 'object',
+            'properties': {
+                'name': {'type': 'string'},
+                'version': {'type': 'string'},
+                'desc': {'type': 'string'},
+                'optional': {'type': 'boolean'},
+            },
+            'additionalItems': True,
+            'required': ('name', 'version'),
+        },
+        'conflict': {
+            'type': 'object',
+            'properties': {
+                'name': {'type': 'string'},
+                'version': {'type': 'string'},
+                'desc': {'type': 'string'},
+            },
+            'additionalItems': True,
+            'required': ('name',),
+        },
+    }
+}
+reqValidPkgdef = s_config.getJsValidator(_reqValidPkgdefSchema)
+
+_reqValidDdefSchema = {
+    'type': 'object',
+    'properties': {
+        'name': {'type': 'string'},
+        'storm': {'type': 'string'},
+        'view': {'type': 'string', 'pattern': s_config.re_iden},
+        'user': {'type': 'string', 'pattern': s_config.re_iden},
+        'iden': {'type': 'string', 'pattern': s_config.re_iden},
+        'enabled': {'type': 'boolean', 'default': True},
+        'stormopts': {
+            'oneOf': [
+                {'type': 'null'},
+                {'$ref': '#/definitions/stormopts'}
+            ]
+        }
+    },
+    'additionalProperties': True,
+    'required': ['iden', 'user', 'storm'],
+    'definitions': {
+        'stormopts': {
+            'type': 'object',
+            'properties': {
+                'repr': {'type': 'boolean'},
+                'path': {'type': 'string'},
+                'show': {'type': 'array', 'items': {'type': 'string'}}
+            },
+            'additionalProperties': True,
+        },
+    }
+}
+reqValidDdef = s_config.getJsValidator(_reqValidDdefSchema)

synapse/lib/snap.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+import sys
 import types
 import asyncio
 import logging
@@ -318,7 +319,7 @@ class ProtoNode:
 
         if prop.locked:
             mesg = f'Tagprop {name} is locked.'
-            return await self.ctx.snap._raiseOnStrict(s_exc.IsDeprLocked, mesg)
+            return await self.ctx.snap._raiseOnStrict(s_exc.IsDeprLocked, mesg, prop=name)
 
         try:
             norm, info = prop.type.norm(valu)
@@ -348,14 +349,14 @@ class ProtoNode:
 
         if prop.locked:
             mesg = f'Prop {prop.full} is locked due to deprecation.'
-            await self.ctx.snap._raiseOnStrict(s_exc.IsDeprLocked, mesg)
+            await self.ctx.snap._raiseOnStrict(s_exc.IsDeprLocked, mesg, prop=prop.full)
             return False
 
         if isinstance(prop.type, s_types.Array):
             arrayform = self.ctx.snap.core.model.form(prop.type.arraytype.name)
             if arrayform is not None and arrayform.locked:
                 mesg = f'Prop {prop.full} is locked due to deprecation.'
-                await self.ctx.snap._raiseOnStrict(s_exc.IsDeprLocked, mesg)
+                await self.ctx.snap._raiseOnStrict(s_exc.IsDeprLocked, mesg, prop=prop.full)
                 return False
 
         if norminfo is None:
@@ -375,7 +376,7 @@ class ProtoNode:
             ndefform = self.ctx.snap.core.model.form(valu[0])
             if ndefform.locked:
                 mesg = f'Prop {prop.full} is locked due to deprecation.'
-                await self.ctx.snap._raiseOnStrict(s_exc.IsDeprLocked, mesg)
+                await self.ctx.snap._raiseOnStrict(s_exc.IsDeprLocked, mesg, prop=prop.full)
                 return False
 
         curv = self.get(prop.name)
@@ -414,7 +415,8 @@ class ProtoNode:
         if propsubs is not None:
             for subname, subvalu in propsubs.items():
                 full = f'{prop.name}:{subname}'
-                if self.form.props.get(full) is not None:
+                subprop = self.form.props.get(full)
+                if subprop is not None and not subprop.locked:
                     await self.set(full, subvalu)
 
         propadds = norminfo.get('adds')
@@ -445,7 +447,8 @@ class ProtoNode:
         if propsubs is not None:
             for subname, subvalu in propsubs.items():
                 full = f'{prop.name}:{subname}'
-                if self.form.props.get(full) is not None:
+                subprop = self.form.props.get(full)
+                if subprop is not None and not subprop.locked:
                     ops.append(self.getSetOps(full, subvalu))
 
         propadds = norminfo.get('adds')
@@ -487,7 +490,7 @@ class SnapEditor:
 
         if form.locked:
             mesg = f'Form {form.full} is locked due to deprecation for valu={valu}.'
-            return await self.snap._raiseOnStrict(s_exc.IsDeprLocked, mesg)
+            return await self.snap._raiseOnStrict(s_exc.IsDeprLocked, mesg, prop=form.full)
 
         if norminfo is None:
             try:
@@ -1615,6 +1618,10 @@ class Snap(s_base.Base):
         return tagnode
 
     async def _raiseOnStrict(self, ctor, mesg, **info):
+        if __debug__:
+            if issubclass(ctor, s_exc.IsDeprLocked):
+                sys.audit('synapse.exc.IsDeprLocked', (mesg, info))
+
         if self.strict:
             raise ctor(mesg=mesg, **info)
         await self.warn(mesg)