@xyo-network/sentinel-memory 4.3.0 → 5.0.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/sentinel-memory",
-  "version": "4.3.0",
+  "version": "5.0.1",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -28,35 +28,40 @@
   },
   "module": "dist/neutral/index.mjs",
   "types": "dist/neutral/index.d.ts",
+  "files": [
+    "dist",
+    "src"
+  ],
   "dependencies": {
-    "@xylabs/assert": "^4.15.0",
-    "@xylabs/base": "^4.15.0",
-    "@xylabs/forget": "^4.15.0",
-    "@xylabs/promise": "^4.15.0",
-    "@xylabs/telemetry": "^4.15.0",
-    "@xylabs/typeof": "^4.15.0",
-    "@xyo-network/diviner-model": "^4.3.0",
-    "@xyo-network/module-model": "^4.3.0",
-    "@xyo-network/payload-builder": "^4.3.0",
-    "@xyo-network/payload-model": "^4.3.0",
-    "@xyo-network/payload-wrapper": "^4.3.0",
-    "@xyo-network/sentinel-abstract": "^4.3.0",
-    "@xyo-network/sentinel-model": "^4.3.0",
-    "@xyo-network/witness-model": "^4.3.0"
+    "@xylabs/assert": "~5.0.3",
+    "@xylabs/base": "~5.0.3",
+    "@xylabs/forget": "~5.0.3",
+    "@xylabs/promise": "~5.0.3",
+    "@xylabs/telemetry": "~5.0.3",
+    "@xylabs/typeof": "~5.0.3",
+    "@xyo-network/diviner-model": "~5.0.1",
+    "@xyo-network/module-model": "~5.0.1",
+    "@xyo-network/payload-builder": "~5.0.1",
+    "@xyo-network/payload-model": "~5.0.1",
+    "@xyo-network/payload-wrapper": "~5.0.1",
+    "@xyo-network/sentinel-abstract": "~5.0.1",
+    "@xyo-network/sentinel-model": "~5.0.1",
+    "@xyo-network/witness-model": "~5.0.1"
   },
   "devDependencies": {
-    "@xylabs/delay": "^4.15.0",
-    "@xylabs/hex": "^4.15.0",
-    "@xylabs/ts-scripts-yarn3": "^7.0.1",
-    "@xylabs/tsconfig": "^7.0.1",
-    "@xylabs/vitest-extended": "^4.15.0",
-    "@xyo-network/abstract-witness": "^4.3.0",
-    "@xyo-network/archivist-memory": "^4.3.0",
-    "@xyo-network/id-payload-plugin": "^4.3.0",
-    "@xyo-network/node-memory": "^4.3.0",
-    "@xyo-network/witness-adhoc": "^4.3.0",
-    "typescript": "^5.8.3",
-    "vitest": "^3.2.4"
+    "@xylabs/creatable": "~5.0.3",
+    "@xylabs/delay": "~5.0.3",
+    "@xylabs/hex": "~5.0.3",
+    "@xylabs/ts-scripts-yarn3": "~7.1.0",
+    "@xylabs/tsconfig": "~7.1.0",
+    "@xylabs/vitest-extended": "~5.0.3",
+    "@xyo-network/abstract-witness": "~5.0.1",
+    "@xyo-network/archivist-memory": "~5.0.1",
+    "@xyo-network/id-payload-plugin": "~5.0.1",
+    "@xyo-network/node-memory": "~5.0.1",
+    "@xyo-network/witness-adhoc": "~5.0.1",
+    "typescript": "~5.9.2",
+    "vitest": "~3.2.4"
   },
   "publishConfig": {
     "access": "public"

package/src/spec/Sentinel.resolve.spec.ts

@@ -0,0 +1,70 @@
+import '@xylabs/vitest-extended'
+
+import type { CreatableName } from '@xylabs/creatable'
+import { MemoryArchivist } from '@xyo-network/archivist-memory'
+import { MemoryNode } from '@xyo-network/node-memory'
+import { PayloadSchema } from '@xyo-network/payload-model'
+import type { ReportEndEventArgs, SentinelConfig } from '@xyo-network/sentinel-model'
+import { SentinelConfigSchema } from '@xyo-network/sentinel-model'
+import { AdhocWitness, AdhocWitnessConfigSchema } from '@xyo-network/witness-adhoc'
+import {
+  describe, expect, test,
+} from 'vitest'
+
+import type { MemorySentinelParams } from '../MemorySentinel.ts'
+import { MemorySentinel } from '../MemorySentinel.ts'
+
+/**
+ * @group sentinel
+ * @group module
+ */
+
+describe('Sentinel', () => {
+  test('report [resolve]', async () => {
+    const paramsA = {
+      config: {
+        payload: { nonce: Math.floor(Math.random() * 9_999_999), schema: 'network.xyo.test' },
+        schema: AdhocWitnessConfigSchema,
+        targetSchema: PayloadSchema,
+      },
+    }
+    const paramsB = {
+      config: {
+        payload: { nonce: Math.floor(Math.random() * 9_999_999), schema: 'network.xyo.test' },
+        schema: AdhocWitnessConfigSchema,
+        targetSchema: PayloadSchema,
+      },
+    }
+    const witnessA = (await AdhocWitness.create({ ...paramsA, account: 'random' })) as AdhocWitness
+    const witnessB = (await AdhocWitness.create({ ...paramsB, account: 'random' })) as AdhocWitness
+    const archivistA = await MemoryArchivist.create({ account: 'random' })
+    const archivistB = await MemoryArchivist.create({ account: 'random' })
+
+    const node = await MemoryNode.create({ account: 'random' })
+    await Promise.all(
+      [witnessA, witnessB, archivistA, archivistB].map(async (mod) => {
+        await node.register(mod)
+        await node.attach(mod.address)
+      }),
+    )
+    const params: MemorySentinelParams<SentinelConfig> = {
+      name: 'test-sentinel' as CreatableName,
+      account: 'random',
+      config: {
+        archiving: { archivists: [archivistA.address, archivistB.address] },
+        schema: SentinelConfigSchema,
+        synchronous: true,
+        tasks: [{ mod: witnessA.address }, { mod: witnessB.address }],
+      },
+    }
+    const sentinel = await MemorySentinel.create(params)
+    sentinel.on('reportEnd', (args) => {
+      const { outPayloads } = args as ReportEndEventArgs
+      expect(outPayloads?.length).toBe(2)
+    })
+    await node.register(sentinel)
+    await node.attach(sentinel.address)
+    const result = await sentinel.report()
+    expect(result?.length).toBe(3)
+  })
+})

package/src/spec/SentinelIntervalAutomationWrapper.spec.ts

@@ -0,0 +1,54 @@
+import '@xylabs/vitest-extended'
+
+import { SentinelIntervalAutomationSchema } from '@xyo-network/sentinel-model'
+import {
+  describe, expect, it,
+} from 'vitest'
+
+import { SentinelIntervalAutomationWrapper } from '../SentinelIntervalAutomationWrapper.ts'
+
+/*
+ * @group sentinel
+ */
+describe('SentinelIntervalAutomationWrapper', () => {
+  const frequency = 1
+  const frequencyUnits = 'second'
+  const schema = SentinelIntervalAutomationSchema
+  const type = 'interval'
+  const start = 0
+  describe('next', () => {
+    it('when more remains', () => {
+      const remaining = 2
+      const input = {
+        frequency, frequencyUnits, remaining, schema, start, type,
+      } as const
+      const sut = new SentinelIntervalAutomationWrapper(input)
+      const actual = sut.next().payload
+      expect(actual).toEqual({
+        ...input, remaining: 1, start: expect.any(Number),
+      })
+    })
+    it('with one remaining', () => {
+      const remaining = 1
+      const input = {
+        frequency, frequencyUnits, remaining, schema, start, type,
+      } as const
+      const sut = new SentinelIntervalAutomationWrapper(input)
+      const actual = sut.next().payload
+      expect(actual).toEqual({
+        ...input, remaining: 0, start: Number.POSITIVE_INFINITY,
+      })
+    })
+    it('with zero remaining', () => {
+      const remaining = 0
+      const input = {
+        frequency, frequencyUnits, remaining, schema, start, type,
+      } as const
+      const sut = new SentinelIntervalAutomationWrapper(input)
+      const actual = sut.next().payload
+      expect(actual).toEqual({
+        ...input, remaining: 0, start: Number.POSITIVE_INFINITY,
+      })
+    })
+  })
+})

package/src/spec/SentinelRunner.spec.ts

@@ -0,0 +1,95 @@
+import '@xylabs/vitest-extended'
+
+import { delay } from '@xylabs/delay'
+import type { AbstractWitness } from '@xyo-network/abstract-witness'
+import { IdSchema } from '@xyo-network/id-payload-plugin'
+import { MemoryNode } from '@xyo-network/node-memory'
+import type {
+  SentinelConfig,
+  SentinelIntervalAutomationPayload,
+} from '@xyo-network/sentinel-model'
+import {
+  SentinelConfigSchema,
+  SentinelIntervalAutomationSchema,
+} from '@xyo-network/sentinel-model'
+import type { AdhocWitnessConfig } from '@xyo-network/witness-adhoc'
+import { AdhocWitness, AdhocWitnessConfigSchema } from '@xyo-network/witness-adhoc'
+import {
+  beforeEach,
+  describe, expect, it,
+} from 'vitest'
+
+import { MemorySentinel } from '../MemorySentinel.ts'
+import type { OnSentinelRunnerTriggerResult } from '../SentinelRunner.ts'
+import { SentinelRunner } from '../SentinelRunner.ts'
+
+/**
+ * @group sentinel
+ * @group module
+ */
+
+describe('SentinelRunner', () => {
+  let sentinel: MemorySentinel
+  let config: SentinelConfig
+
+  beforeEach(async () => {
+    const node = (await MemoryNode.create({ account: 'random' })) as MemoryNode
+    const witnessModules: AbstractWitness[] = [
+      await AdhocWitness.create({
+        account: 'random',
+        config: { payload: { id: 1, schema: 'network.xyo.id' }, schema: AdhocWitnessConfigSchema } as AdhocWitnessConfig,
+      }),
+    ]
+    const witnesses = await Promise.all(
+      witnessModules.map(async (witness) => {
+        await node.register(witness)
+        await node.attach(witness.address)
+        return witness.address
+      }),
+    )
+
+    config = {
+      schema: SentinelConfigSchema,
+      synchronous: true,
+      tasks: witnesses.map(mod => ({ mod })),
+    }
+
+    sentinel = (await MemorySentinel.create({ account: 'random', config })) as MemorySentinel
+    await node.register(sentinel)
+    await node.attach(sentinel.address)
+  })
+
+  it('should output interval results', async () => {
+    let triggered = false
+    let timeoutCount = 100
+    const intervalAutomation: SentinelIntervalAutomationPayload = {
+      frequency: 1,
+      frequencyUnits: 'second',
+      remaining: 1,
+      schema: SentinelIntervalAutomationSchema,
+      start: Date.now() - 1,
+      type: 'interval',
+    }
+    const onTriggerResult: OnSentinelRunnerTriggerResult = (results) => {
+      triggered = true
+      expect(results.length).toBe(2)
+      expect(results[1]?.schema).toBe(IdSchema)
+    }
+
+    const runner = new SentinelRunner({
+      sentinel, automations: [intervalAutomation], onTriggerResult,
+    })
+    runner.start()
+    while (timeoutCount) {
+      if (triggered) {
+        runner.stop()
+        return
+      }
+      timeoutCount--
+      await delay(100)
+    }
+    // should never get here if succeeded
+    expect(false).toBe(true)
+    runner.stop()
+  })
+})

package/xy.config.ts

@@ -1,10 +0,0 @@
-import type { XyTsupConfig } from '@xylabs/ts-scripts-yarn3'
-const config: XyTsupConfig = {
-  compile: {
-    browser: {},
-    neutral: { src: true },
-    node: {},
-  },
-}
-
-export default config