CU-86drumcht - Implement NeonEventListener tests

[luc10921]

No description provided.

[melanke]

Task linked: CU-86drumcht Implement NeonEventListener tests

[github-actions]

Coverage Report

Commit: e35bcc1
Base: main@ea06b86

Type	This PR
Total Statements Coverage	93.58%
Total Branches Coverage	81.38%
Total Functions Coverage	93.82%
Total Lines Coverage	94.93%

Details (changed files)

File	Statements	Branches	Functions	Lines

Details (all files)

File	Statements	Branches	Functions	Lines
packages/neon-dappkit/src/NeonEventListener.ts	97.95%	71.42%	100%	97.91%
packages/neon-dappkit/src/NeonInvoker.ts	87.2%	85.29%	88.46%	90.43%
packages/neon-dappkit/src/NeonParser.ts	95.74%	94.92%	96.29%	96.7%
packages/neon-dappkit/src/NeonSigner.ts	95.65%	44.44%	92.3%	95.65%
packages/neon-dappkit/src/index.ts	100%	100%	100%	100%

[melanke]

I think there is a better way to work with callbacks on mocha.

You could create a Promise that is resolved on the callback. So instead of having the "called" control variable, you would simply await for the promise inside the test and mocha would work perfectly. Something like this:

it('adds an eventListener', async () => {
    const eventName = 'Transfer'
    
    const eventPromise = new Promise((resolve) => {
      const callBack: Neo3EventListenerCallback = (notification: Neo3EventWithState) => {
        resolve(notification)

        eventListener.removeAllEventListenersOfEvent(gasScriptHash, eventName)
      }

      eventListener.addEventListener(gasScriptHash, eventName, callBack)
    })

    const sender = accountWithGas
    const receiver = new wallet.Account()

    const neoInvoker = await NeonInvoker.init({ rpcAddress, account: sender })

    const txId = await neoInvoker.invokeFunction(transferInvocation(sender, receiver, '100'))
    assert(txId, 'Transaction ID should be returned')

    const notification = await eventPromise
    
    assert(notification.contract === gasScriptHash, 'Notification should be sent by NeoToken')
    assert(notification.eventname === eventName, `Notification should be ${eventName}`)
    assert(notification.state !== undefined, 'Notification should return value')
    assert(TypeChecker.isStackTypeArray(notification.state), 'Notification value should be an array')
  })