/synapse

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

Already on GitHub? Sign in to your account

Add new API appservice specific public room list #1676

Merged
merged 7 commits into from Dec 12, 2016

Conversation

Reviewers

@NegativeMjark NegativeMjark

Assignees

@NegativeMjark NegativeMjark

Labels
None yet
Projects
None yet
Milestone
No milestone
3 participants
@erikjohnston @NegativeMjark @lukebarnard1
@erikjohnston
Owner

erikjohnston commented Dec 6, 2016 • edited

This adds the following:

  • A instance_id field to each instance in the GET /thirdparty/protocols API
  • An API that allows ASes to publish rooms to their own dedicated lists, PUT /directory/list/appservice/$network_id/$room_id
  • Two extra params to POST /publicRooms, third_party_instance_id which returns rooms published to AS instance specific lists, and include_all_networks which if true returns all rooms that have been published to any list. By default it will only return rooms on the main, default list.

https://docs.google.com/document/d/12mVuOT7Qoa49L_PQAPjavoK9c2nalYEFOHxJOmH5j-w/edit?usp=sharing

erikjohnston added some commits Dec 6, 2016

@erikjohnston
Add new API appservice specific public room list

Some checks were not successful

3 errored, 3 failing, and 6 successful checks
@matrixbot
Sytest Dendron (Commit) — Build #1213 origin/erikj/room_list failed in 12 min
Details
@matrixbot
Sytest Postgres (Commit) — Build #2053 origin/erikj/room_list failed in 26 sec
Details
@matrixbot
Sytest SQLite (Commit) — Build #2097 origin/erikj/room_list failed in 6 min 27 sec
Details
@matrixbot
Sytest Dendron (Merged PR) — Build finished.
Details
@matrixbot
Sytest Postgres (Merged PR) — Build finished.
Details
@matrixbot
Sytest SQLite (Merged PR) — Build finished.
Details
@matrixbot
Flake8 + Packaging (Commit) — Build #2158 origin/erikj/room_list succeeded in 43 sec
Details
@matrixbot
Flake8 + Packaging (Merged PR) — Build finished.
Details
@matrixbot
Unit Tests (Commit) — Build #2182 origin/erikj/room_list succeeded in 3 min 35 sec
Details
@matrixbot
Unit Tests (Merged PR) — Build finished.
Details
continuous-integration/travis-ci/pr — The Travis CI build passed
Details
continuous-integration/travis-ci/push — The Travis CI build passed
Details
f32fb65
@erikjohnston
Don't include appservice id

All checks have passed

12 successful checks
@matrixbot
Flake8 + Packaging (Commit) — Build #2160 origin/erikj/room_list succeeded in 1 min 15 sec
Details
@matrixbot
Flake8 + Packaging (Merged PR) — Build finished.
Details
@matrixbot
Sytest Dendron (Commit) — Build #1215 origin/erikj/room_list succeeded in 12 min
Details
@matrixbot
Sytest Dendron (Merged PR) — Build finished.
Details
@matrixbot
Sytest Postgres (Commit) — Build #2055 origin/erikj/room_list succeeded in 9 min 5 sec
Details
@matrixbot
Sytest Postgres (Merged PR) — Build finished.
Details
@matrixbot
Sytest SQLite (Commit) — Build #2099 origin/erikj/room_list succeeded in 7 min 16 sec
Details
@matrixbot
Sytest SQLite (Merged PR) — Build finished.
Details
@matrixbot
Unit Tests (Commit) — Build #2184 origin/erikj/room_list succeeded in 3 min 7 sec
Details
@matrixbot
Unit Tests (Merged PR) — Build finished.
Details
continuous-integration/travis-ci/pr — The Travis CI build passed
Details
continuous-integration/travis-ci/push — The Travis CI build passed
Details
3727d66

@erikjohnston erikjohnston assigned NegativeMjark Dec 6, 2016

synapse/handlers/directory.py
+ def edit_published_appservice_room_list(self, appservice_id, network_id,
+ room_id, visibility):
+ """Edit the appservice/network specific public room list.
+ """
@NegativeMjark

NegativeMjark Dec 6, 2016

Contributor

Could we have some docstring for the parameters here?

synapse/storage/room.py
+ @defer.inlineCallbacks
+ def set_room_is_public_appservice(self, room_id, appservice_id, network_id,
+ is_public):
+ """Edit the appservice/network specific public room list.
@NegativeMjark

NegativeMjark Dec 6, 2016

Contributor

Could we have docstring for what the params are and what this does?

@erikjohnston

erikjohnston Dec 12, 2016

Owner

Done.

synapse/storage/schema/delta/39/appservice_room_list.sql
+ room_id TEXT NOT NULL
+);
+
+CREATE UNIQUE INDEX appservice_room_list_idx ON appservice_room_list(
@NegativeMjark

NegativeMjark Dec 6, 2016

Contributor

Maybe add comment on what this table is for?

synapse/handlers/room_list.py
+ appservice and network id to use an appservice specific one.
+ Setting to None returns all public rooms across all lists.
+ """
+ if search_filter or network_tuple is not (None, None):
# We explicitly don't bother caching searches.
@NegativeMjark

NegativeMjark Dec 6, 2016

Contributor

Does the comment need updating if we aren't caching the appservice lists as well?

@NegativeMjark
Contributor

NegativeMjark commented Dec 6, 2016

What is an appservice_id look like ooi?
@erikjohnston
Owner

erikjohnston commented Dec 6, 2016

What is an appservice_id look like ooi?

e.g. irc-freenode or 9666621b268e14d7b18b110073f07c6e955c60a8c8a5792fd810e9978d1931d7
@erikjohnston
Comments

Some checks were not successful

1 errored, 1 failing, and 10 successful checks
@matrixbot
Sytest Dendron (Commit) — Build #1216 origin/erikj/room_list failed in 12 min
Details
@matrixbot
Sytest Dendron (Merged PR) — Build finished.
Details
@matrixbot
Flake8 + Packaging (Commit) — Build #2161 origin/erikj/room_list succeeded in 49 sec
Details
@matrixbot
Flake8 + Packaging (Merged PR) — Build finished.
Details
@matrixbot
Sytest Postgres (Commit) — Build #2056 origin/erikj/room_list succeeded in 9 min 1 sec
Details
@matrixbot
Sytest Postgres (Merged PR) — Build finished.
Details
@matrixbot
Sytest SQLite (Commit) — Build #2100 origin/erikj/room_list succeeded in 8 min 18 sec
Details
@matrixbot
Sytest SQLite (Merged PR) — Build finished.
Details
@matrixbot
Unit Tests (Commit) — Build #2185 origin/erikj/room_list succeeded in 3 min 10 sec
Details
@matrixbot
Unit Tests (Merged PR) — Build finished.
Details
continuous-integration/travis-ci/pr — The Travis CI build passed
Details
continuous-integration/travis-ci/push — The Travis CI build passed
Details
2687af8

@erikjohnston erikjohnston referenced this pull request in matrix-org/sytest Dec 7, 2016

Merged

Test AS specific room lists #328

@erikjohnston
Owner

erikjohnston commented Dec 7, 2016

Now with added sytests matrix-org/sytest#328!
@erikjohnston
Docstring

Some checks were not successful

3 errored and 5 successful checks
@matrixbot
Sytest Dendron (Commit) — Build #1234 origin/erikj/room_list failed in 14 min
Details
@matrixbot
Sytest Postgres (Commit) — Build #2077 origin/erikj/room_list failed in 9 min 5 sec
Details
@matrixbot
Sytest SQLite (Commit) — Build #2120 origin/erikj/room_list failed in 7 min 41 sec
Details
@matrixbot
Sytest Dendron (Merged PR) — Build finished.
Details
@matrixbot
Sytest Postgres (Merged PR) — Build finished.
Details
@matrixbot
Sytest SQLite (Merged PR) — Build finished.
Details
continuous-integration/travis-ci/pr — The Travis CI build passed
Details
continuous-integration/travis-ci/push — The Travis CI build passed
Details
d45c984
@lukebarnard1
Contributor

lukebarnard1 commented Dec 12, 2016

Is it really instance_id? Because I can't see any sign of that in the code...
@erikjohnston
Owner

erikjohnston commented Dec 12, 2016

Woops, looks like its network_id https://github.com/matrix-org/synapse/pull/1676/files#diff-0dca1a8726bd4f8d341ea3373b1048ddR182
@erikjohnston
Owner

erikjohnston commented Dec 12, 2016

Will probably change it to network_id in the AS layer, and instance_id in the client layer, if that sounds good to you @lukebarnard1 ?

lukebarnard1 added a commit to matrix-org/matrix-js-sdk that referenced this pull request Dec 12, 2016

@lukebarnard1
Add setRoomDirectoryVisibilityAppService 
This is for setting the publicity of a room that is bridged to a 3rd party network. This change reflects the second bullet point of matrix-org/synapse#1676 (comment).

All checks have passed

3 successful checks
@matrixbot
JavascriptSDK — Build #1409 origin/luke/feature-AS-room-publication succeeded in 2 min 3 sec
Details
continuous-integration/travis-ci/pr — The Travis CI build passed
Details
continuous-integration/travis-ci/push — The Travis CI build passed
Details
742d942

This was referenced Dec 12, 2016

Merged
Merged

erikjohnston added some commits Dec 12, 2016

@erikjohnston
Notify replication. Use correct network_id
631376e
@erikjohnston
Add cache to get_public_room_ids_at_stream_id

Some checks were not successful

3 errored, 1 failing, and 4 successful checks
@matrixbot
Sytest Dendron (Commit) — Build #1240 origin/erikj/room_list failed in 17 min
Details
@matrixbot
Sytest Postgres (Commit) — Build #2081 origin/erikj/room_list failed in 8 min 4 sec
Details
@matrixbot
Sytest SQLite (Commit) — Build #2124 origin/erikj/room_list failed in 7 min 20 sec
Details
@matrixbot
Sytest Dendron (Merged PR) — Build finished.
Details
@matrixbot
Sytest Postgres (Merged PR) — Build finished.
Details
@matrixbot
Sytest SQLite (Merged PR) — Build finished.
Details
continuous-integration/travis-ci/pr — The Travis CI build passed
Details
continuous-integration/travis-ci/push — The Travis CI build passed
Details
09cbcb7
@erikjohnston
Rename network_id to instance_id on client side

Some checks were not successful

1 errored and 7 successful checks
@matrixbot
Sytest Dendron (Commit) — Build #1242 origin/erikj/room_list failed in 1 min 8 sec
Details
@matrixbot
Sytest Dendron (Merged PR) — Build finished.
Details
@matrixbot
Sytest Postgres (Commit) — Build #2083 origin/erikj/room_list succeeded in 7 min 5 sec
Details
@matrixbot
Sytest Postgres (Merged PR) — Build finished.
Details
@matrixbot
Sytest SQLite (Commit) — Build #2126 origin/erikj/room_list succeeded in 6 min 40 sec
Details
@matrixbot
Sytest SQLite (Merged PR) — Build finished.
Details
continuous-integration/travis-ci/pr — The Travis CI build passed
Details
continuous-integration/travis-ci/push — The Travis CI build passed
Details
2bf5a47
@erikjohnston
Owner

erikjohnston commented Dec 12, 2016

@matrixbot retest this please

@erikjohnston erikjohnston merged commit 1574b83 into develop Dec 12, 2016
7 of 8 checks passed

7 of 8 checks passed

Sytest Dendron (Commit) Build #1242 origin/erikj/room_list failed in 1 min 8 sec
Details
Sytest Dendron (Merged PR) Build finished.
Details
Sytest Postgres (Commit) Build #2083 origin/erikj/room_list succeeded in 7 min 5 sec
Details
Sytest Postgres (Merged PR) Build finished.
Details
Sytest SQLite (Commit) Build #2126 origin/erikj/room_list succeeded in 6 min 40 sec
Details
Sytest SQLite (Merged PR) Build finished.
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
continuous-integration/travis-ci/push The Travis CI build passed
Details

dbkr added a commit to vector-im/riot-web that referenced this pull request Dec 14, 2016

@dbkr
Support room dir 3rd party network filtering 
As per matrix-org/synapse#1676

The existing local config system still exists and is used for
remote home server directories (since /thirdparty/protocols
doesn't support listing remote home servers, and also because
people are using it).

All checks have passed

4 successful checks
@matrixbot
VectorWebBranches — Build #519 origin/dbkr/third_party_filter succeeded in 6 min 21 sec
Details
continuous-integration/travis-ci/pr — The Travis CI build passed
Details
continuous-integration/travis-ci/push — The Travis CI build passed
Details
@matrixbot
default — Build finished.
Details
f5bd8ab

@dbkr dbkr referenced this pull request in vector-im/riot-web Dec 14, 2016

Merged

Support room dir 3rd party network filtering #2747

Half-Shot added a commit to Half-Shot/vector-web that referenced this pull request Feb 9, 2017

@dbkr @Half-Shot
Support room dir 3rd party network filtering 
As per matrix-org/synapse#1676

The existing local config system still exists and is used for
remote home server directories (since /thirdparty/protocols
doesn't support listing remote home servers, and also because
people are using it).
5b93c67

@erikjohnston erikjohnston referenced this pull request in matrix-org/matrix-doc Mar 29, 2017

Open

Spec per AS publicRooms list #869

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