Don't require `end` on `/messages`#1265

Merged

S7evinK merged 4 commits intodevelopfrom

s7evink/spec-messages

Jun 30, 2022

Contributor

S7evinK commented Jun 28, 2022

As per the spec, the end key is not required if there are no more events for the user.

If no further events are available (either because we have reached the start of the timeline, or because the user does not have permission to see any more events), this property is omitted from the response.

S7evinK added 2 commits

June 28, 2022 12:37


          Don't require an "end" key

d8d4822


          Merge branch 'develop' of github.com:matrix-org/sytest into s7evink/s…

…pec-messages

S7evinK requested a review from a team as a code owner

June 28, 2022 10:40

Contributor

DMRobertson commented Jun 28, 2022

I think the spec's wording is actually stricter here: I think it's saying that end must be omitted if there are no more messages to retrieve.

Should we be asserting that end is not present in the json body?

Contributor Author

S7evinK commented Jun 28, 2022

Makes sense, yea.
Just tested that locally, Synapse isn't yet happy with that, though.

Member

richvdh commented Jun 28, 2022

I thought that recently got fixed in synapse.

Contributor

DMRobertson commented Jun 28, 2022

I thought that recently got fixed in synapse.

matrix-org/synapse#12903

Contributor Author

S7evinK commented Jun 28, 2022

Hm, what happens if the returned chunk count is less than the requested limit? Shouldn't that also result in end being omitted?
Or would that be this?

If so, we probably can't assert that end is actually missing in these tests, without extending the tests.


          Extend tests to verify "end" is missing, if there are no more events

1b316f7

richvdh approved these changes

View reviewed changes

Member

richvdh left a comment

lgtm otherwise

tests/10apidoc/34room-messages.pl Outdated

                        scalar @{ $body->{chunk} } > 0 or
                           die "Expected some messages but got none at all\n";
+                    })->then( sub {

Member

richvdh Jun 29, 2022

Suggested change

tests/10apidoc/34room-messages.pl Outdated

Comment on lines +174 to +175


		# With no params this does "forwards from END"; i.e. nothing useful

Member

richvdh Jun 29, 2022

I don't think this needs repeating here

Suggested change


	# With no params this does "forwards from END"; i.e. nothing useful

tests/10apidoc/34room-messages.pl Outdated

                           die "Expected some messages but got none at all\n";
+                    })->then( sub {
+                       # Do another call to /messages, this time we don't expect to receive a "end" key

Member

richvdh Jun 29, 2022

Suggested change

      
                     # Do another call to /messages, this time we don't expect to receive a "end" key
          
                     # Do another call to /messages. This time we don't expect to receive a "end" key

tests/10apidoc/34room-messages.pl Outdated

                     })->then( sub {
                        my ( $body ) = @_;
+                       # We should still get events and a "end" key, check it is actually there

Member

richvdh Jun 29, 2022

Suggested change

      
                     # We should still get events and a "end" key, check it is actually there
          
                     # We should still get events and a "end" key: check they are actually there

tests/10apidoc/34room-messages.pl Outdated

		log_if_fail "Body", $body;


		# We should still get events and a "end" key, check it is actually there

Member

richvdh Jun 29, 2022

Suggested change

      
                     # We should still get events and a "end" key, check it is actually there
          
                     # We should still get events and a "end" key: check they are actually there

tests/10apidoc/34room-messages.pl Outdated

                           die "Expected some messages but got none at all\n";
+                    })->then( sub {
+                       # Do another call to /messages, this time we don't expect to receive a "end" key

Member

richvdh Jun 29, 2022

Suggested change

      
                     # Do another call to /messages, this time we don't expect to receive a "end" key
          
                     # Do another call to /messages. This time we don't expect to receive a "end" key

tests/10apidoc/34room-messages.pl Outdated

Comment on lines +241 to +242


		# With no params this does "forwards from END"; i.e. nothing useful

Member

richvdh Jun 29, 2022

Suggested change


	# With no params this does "forwards from END"; i.e. nothing useful


          Update comments

6ccdc6b

S7evinK merged commit a94cd1d into develop

S7evinK deleted the s7evink/spec-messages branch

June 30, 2022 10:15

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet