Custom service method completes but clients never receive a real-time event

Answer the exact question first

1. Is calling context.service.emit() the officially supported pattern for custom methods in v5?
Yes. In v5 only the standard CRUD methods emit events automatically. A custom method must explicitly call context.service.emit(eventName, result) (or do it in an after‑hook that has access to context.result). A wrapper patch is unnecessary unless you want to keep the same CRUD semantics.

2. Where should the emit happen – inside the method or an after‑hook?
Inside the method body, right after the business logic succeeds. The hook context does not have the method’s return value unless you manually pass it, and emitting in a hook would delay the event until after the hook chain, which can hide errors from the client.

3. Do custom events propagate across a multi‑server setup the same way?
Yes, provided the event name is registered in the service’s events array (or via service.publish()) and you emit it with context.service.emit(). Feathers‑socketio will then publish the event to all connected nodes through the configured pub/sub (Redis, etc.). No extra configuration is required beyond what you already use for standard events.

Likely explanation & confirmed facts

• Only CRUD methods auto‑emit; custom methods need explicit emission.
• Emission must use the same name that is registered in the service’s events list.
• Emitting inside the method guarantees the correct result is sent and the event is fired before any hook errors.
• Multi‑node propagation works the same as for CRUD events once the event is registered.

Steps to fix the issue

1. Register the event name in the service definition:

   app.use('/orders', ordersService);
   const orders = app.service('orders');
   orders.events = ['orderApproved']; // or orders.publish(...)
   

2. Emit the event inside the custom method:

   async function approveOrder(context) {
     const result = await businessLogic(context);
     // Emit after successful completion
     context.service.emit('orderApproved', result);
     return result;
   }
   

3. Ensure your publish configuration (e.g., Redis adapter) is active so the event is forwarded to other nodes. No extra code is needed beyond what you use for standard events.

Diagnostic question

Did you add the custom event name (e.g., orderApproved) to the service’s events array? If it’s missing, the event will never reach clients, regardless of the emit call.