Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

register: Ensure future client_capabilities fields are optional. 

The `notification_settings_null` field of the `client_capabilities`
parameter is, apparently unintentionally, required.

This is mostly harmless. However, if any _future_ fields are made
required, all existing clients using this parameter will break, and it
will be needlessly difficult for new clients to specify new
capabilities in a backwards-compatible way.

Attempt to stave that possibility off with warnings.

(No functional changes.)
This commit is contained in:
Ray Kraesig 2020-01-31 11:23:34 -08:00 committed by Tim Abbott
parent df6b90db3c
commit d7b900ca52
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
zerver/views/events_register.py
View File

@ -30,7 +30,12 @@ def events_register_backend(
all_public_streams: Optional[bool]=REQ(default=None, validator=check_bool), all_public_streams: Optional[bool]=REQ(default=None, validator=check_bool),
include_subscribers: bool=REQ(default=False, validator=check_bool), include_subscribers: bool=REQ(default=False, validator=check_bool),
client_capabilities: Optional[Dict[str, bool]]=REQ(validator=check_dict([ client_capabilities: Optional[Dict[str, bool]]=REQ(validator=check_dict([
# This field was accidentally made required when it was added in v2.0.0-781;
# this was not realized until after the release of Zulip 2.1.2. (It remains
# required to help ensure backwards compatibility of client code.)
("notification_settings_null", check_bool), ("notification_settings_null", check_bool),
], [
# Any new fields of `client_capabilities` should be optional. Add them here.
]), default=None, documentation_pending=True), ]), default=None, documentation_pending=True),
event_types: Optional[Iterable[str]]=REQ(validator=check_list(check_string), default=None), event_types: Optional[Iterable[str]]=REQ(validator=check_list(check_string), default=None),
fetch_event_types: Optional[Iterable[str]]=REQ(validator=check_list(check_string), default=None), fetch_event_types: Optional[Iterable[str]]=REQ(validator=check_list(check_string), default=None),