Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix/update-filter-spec #203

Merged
merged 18 commits into from Oct 10, 2020
Merged

fix/update-filter-spec #203

merged 18 commits into from Oct 10, 2020

Conversation

decanus
Copy link
Contributor

@decanus decanus commented Oct 2, 2020

Some fixes to the spec, syncing it with some of the dev work that happened. Additionally claryfing some todos and moving it into draft.

closes #201

@decanus decanus requested a review from oskarth October 2, 2020 14:01
Copy link
Member

@oskarth oskarth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A bunch of stuff missing #201

For one, we probably don't want the TODOs in plain text

@decanus decanus requested a review from oskarth October 5, 2020 13:05
specs/waku/v2/waku-filter.md Outdated Show resolved Hide resolved
specs/waku/v2/waku-filter.md Outdated Show resolved Hide resolved
specs/waku/v2/waku-filter.md Outdated Show resolved Hide resolved
specs/waku/v2/waku-filter.md Outdated Show resolved Hide resolved
specs/waku/v2/waku-filter.md Outdated Show resolved Hide resolved
specs/waku/v2/waku-filter.md Show resolved Hide resolved
@oskarth
Copy link
Member

oskarth commented Oct 6, 2020

@decanus please link the issue this is addressing

@decanus
Copy link
Contributor Author

decanus commented Oct 6, 2020

@oskarth created issues:

Unsubscribe was already an issue therefore ignored.

// space for optional request id
repeated ContentFilter contentFilters = 2;
optional string topic = 3;
string topic = 1;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the WakuRelay pubsub topic right?

I understand why you add it, but I'm still wondering whether we need that additional flexibility.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Because the topics might be different. We discussed this in a call I believe, essentially a filter is made up of pubsub topic and content filter. Omitting this would lead to a lot of unspecified behavior, especially as we move to multiple pubsub topics I believe.


TODO Specify mechanism for telling it won't honor (normal-no service-spam case)
The `request_id` MUST be a uniquely generated string. When a `MessagePush` is sent
the `request_id` MUST match the `request_id` of the `FilterRequest` whose filters
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What stops a node from sending messages with invalid contentTopics but correct request_id? Don't we still have to check the contentTopics?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kdeme I guess yeah

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there still a use for this if we have to check all topics anyhow?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kdeme wdym? the requestId? I think so yes. It seems like its pretty standard across our protocols now so even if just for that we should probably keep it.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't mean for having a requestId. I mean specifically for returning that requestId in the MessagePush

specs/waku/v2/waku-filter.md Outdated Show resolved Hide resolved
@decanus decanus requested a review from oskarth October 6, 2020 22:11
@decanus decanus requested a review from oskarth October 9, 2020 13:57
@decanus
Copy link
Contributor Author

decanus commented Oct 9, 2020

@oskarth I think this is ready to merge now/


# Abstract

Filter spec.
`WakuFilter` is a protocol that enables subscribing to messages that a peer receives. This is a more lightweight version of `WakuRelay` specifically designed for bandwidth restricted devices. This is due to the fact that light nodes subscribe to full-nodes and only receive the messages they desire.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

honestly I don't think this addresses the feedback I gave before, it still isn't very clear what this is or how it works. But let's move on...

@oskarth
Copy link
Member

oskarth commented Oct 10, 2020

It isn't clear to me if #201 (comment) was addressed or not.

The abstract needs work but we can do this later separately.

# Changelog

2.0.0-beta1
Initial draft version. Released 2020-10-05 <!-- @TODO LINK -->
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this need to be bumped

@decanus
Copy link
Contributor Author

decanus commented Oct 10, 2020

@oskarth yes its been done, but I am not quite sure how to make it clear in a spec that a cluster node was updated.

@decanus decanus merged commit 31857c7 into master Oct 10, 2020
@decanus decanus deleted the fix/update-filter-spec branch October 10, 2020 10:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Get filter protocol to draft state
3 participants