feat: adding filter data admin endpoint (REST)

[gabrielmer]

Description

Adding admin REST endpoint to retrieve the serving node's subscriber filter clients and their subscribed pubsub and content topics.

Endpoint: GET /admin/v1/filter/subscriptions

Changes

• mounted endpoint to retrieve filter subscriber data
• added unit test verifying its proper functioning
• updated openapi.yaml documentation

Issue

closes #2290

[github-actions]

You can find the image built from this PR at

quay.io/wakuorg/nwaku-pr:2314

Built from 9e568f7

[Ivansete-status]

Wonderful PR! Thanks for it! 💯
nitpick: I wonder if we could add more test cases and not only the "happy path" :D

[gabrielmer]

Wonderful PR! Thanks for it! 💯 nitpick: I wonder if we could add more test cases and not only the "happy path" :D

Oh yess, my bad! Copied from another endpoint, adapted it for this case and forgot about adding more 😳
Will add more comprehensive tests now! Thanks for the remark! 🤩

[NagyZoltanPeter]

Thanks for it, will be great for debugging as well.

[chaitanyaprem]

Reviewed only the API details and left a minor comment.
LGTM once that is addressed.

[SionoiS]

LGTM Thank you!

I would add an error when filter is not mounted but it's ok for now.

[gabrielmer]

LGTM Thank you!

I would add an error when filter is not mounted but it's ok for now.

Yes! I was 50-50 whether to return an error stating that filter isn't mounted or to return an empty array of subscribers in that case. I followed the second option just to be consistent with the approach of installAdminV1GetPeersHandler.

But I do agree that returning an error stating that the protocol is not even mounted is more informative. @Ivansete-status @NagyZoltanPeter, what do you think?

[NagyZoltanPeter]

LGTM Thank you!
I would add an error when filter is not mounted but it's ok for now.

Yes! I was 50-50 whether to return an error stating that filter isn't mounted or to return an empty array of subscribers in that case. I followed the second option just to be consistent with the approach of installAdminV1GetPeersHandler.

But I do agree that returning an error stating that the protocol is not even mounted is more informative. @Ivansete-status @NagyZoltanPeter, what do you think?

My first thought is to return with error and correct explanation. Due this admin endpoint is strictly depends on Filter service to be mounted. Otherwise it has no meaning. Emtpy array would mean to me there is no subscriptions and Filter service is running.

[SionoiS]

LGTM Thanks!

[SionoiS]

Can be remove since it's checked above

[gabrielmer]

Oh yes! Was supposed to remove it but for sure got distracted and forgot 😶

Will fix it now, thanks so much!

[NagyZoltanPeter]

It's great!
Just to note to myself, I need to touch here as soon it gets merged - surely before my rework on managing filter subscriptions. that makes filter subscription structure upside-down. :-)