fix: override service path in context (closes #12)

Author: claustres

packages/feathers-distributed/README.md

@@ -8,6 +8,13 @@ __
 
 Detailed documentation is available at the following [link](https://kalisio.github.io/feathers-ekosystem/pacakges/feathers-distributed).
 
+In the tests four apps are actually created, each app has a distribution key corresponding to its index:
+- a gateway (index 0) with a local `users` service then a dynamically added local `custom` service with an additional `custom` event (`created`/`custom` events distributed)
+- a first app (index 1) without any local service but with the distributed gateway services
+- a second app (index 2) without any local service but with the distributed gateway services
+- a third app (index 3) with a local `no-events` service with an additional `custom` event (all events distributed) and with the distributed gateway services
+The `custom` service is exposed remotely on a new `custom-name` name.
+
 ## License
 
 Licensed under the [MIT license](LICENSE).

packages/feathers-distributed/src/register.js

@@ -63,7 +63,11 @@ export async function registerApplication (app, applicationDescriptor) {
       debug(`Dispatching ${event} remote service event on path ${object.path} in local app with uuid ${app.shortUuid} and key ${app.distributionKey}`, object, context)
       const servicePath = getServicePath(app, object)
       const service = getService(app, servicePath)
-      if (context) Object.assign(context, { service, app })
+      if (context) {
+        // We override the context path as the remote service might be registered on a different one.
+        // Otherwise the socket client will not receive the event as listening to the 'remote-path created' event and not the 'local-path created' event.
+        Object.assign(context, { path: servicePath, service, app })
+      }
       // Ensure we don't have any local service with the same name to avoid infinite looping
       if (service?.remote) service.emit(event, object, context)
     })

packages/feathers-distributed/test/index.test.js

@@ -1,7 +1,5 @@
 import { vi, beforeAll, afterAll, describe, it, expect } from 'vitest'
 import { setTimeout as sleep } from 'node:timers/promises'
-// FIXME
-// import util from 'node:util'
 import { authenticate } from '@feathersjs/authentication'
 import auth from '@feathersjs/authentication-client'
 import restClient from '@feathersjs/rest-client'
@@ -446,8 +444,6 @@ describe('feathers-distributed:main', () => {
     expect(name).toBe('Donald Doe')
   }, 5000)
 
-  /*
-  FIXME
   it('dispatch custom events and ignore the ones not configured for distribution', async () => {
     let createdCount = 0
     const updatedCount = 0
@@ -460,52 +456,56 @@ describe('feathers-distributed:main', () => {
       socketClientCustomServices[service2].removeAllListeners('updated')
       socketClientCustomServices[service1].removeAllListeners('custom')
     }
-    await new Promise((resolve, reject) => {
-      const checkIsDone = () => {
+    const testFunction = async (resolve, reject) => {
+      const checkIsDone = (data, context) => {
         if ((createdCount === 2) && (updatedCount === 0) && (customCount === 2)) {
           removeListeners()
           resolve()
         }
       }
-      customServices[service1].once('created', user => {
+      customServices[service1].once('created', (user, context) => {
         expect(user.id === 0).toBe(true)
         createdCount++
-        checkIsDone()
+        checkIsDone(user, context)
       })
-      customServices[service2].once('updated', () => {
+      customServices[service2].once('updated', (data, context) => {
         removeListeners()
         reject(new Error('updated should not be called'))
       })
       customServices[service1].once('custom', (data, context) => {
         expect(data.payload === 'Donald Doe').toBe(true)
-        expect(context.app === apps[service1]).toBe(true)
-        expect(context.service === customServices[service1]).toBe(true)
+        if (context) { // When not emitted from hook context might be missing
+          expect(context.app === apps[service1]).toBe(true)
+          expect(context.service === customServices[service1]).toBe(true)
+        }
         customCount++
-        checkIsDone()
+        checkIsDone(data, context)
       })
-      // FIXME: not called whatever the reason
-      socketClientCustomServices[service1].once('created', user => {
+      socketClientCustomServices[service1].once('created', (user, context) => {
         expect(user.id === 0).toBe(true)
         createdCount++
-        checkIsDone()
+        checkIsDone(user, context)
       })
       socketClientCustomServices[service2].once('updated', () => {
         removeListeners()
         reject(new Error('updated should not be called'))
       })
-      socketClientCustomServices[service1].once('custom', data => {
+      socketClientCustomServices[service1].once('custom', (data, context) => {
         expect(data.payload === 'Donald Doe').toBe(true)
         customCount++
-        checkIsDone()
+        checkIsDone(data, context)
       })
-      util.promisify(setTimeout)(5000)
-        .then(() => customServices[gateway].create({ name: 'Donald Doe' }))
-        .then(() => customServices[gateway].update(0, { name: 'Donald Dover' }))
-        .then(() => customServices[gateway].emit('custom', { payload: 'Donald Doe' }))
-        .catch(reject)
-    })
-  }, 40000)
-  */
+      try {
+        await sleep(5000)
+        await customServices[gateway].create({ name: 'Donald Doe' })
+        await customServices[gateway].update(0, { name: 'Donald Dover' })
+        await customServices[gateway].emit('custom', { payload: 'Donald Doe' })
+      } catch (error) {
+        reject(error)
+      }
+    }
+    await new Promise(testFunction)
+  }, 20000)
 
   it('not found request should return 404 on local service', async () => {
     const url = 'http://localhost:' + (baseListenPort + gateway) + '/xxx'