Remove undocumented room_alias key from /createRoom response

[thezaidbintariq]

Pull Request Checklist

• Pull request is based on the develop branch
• Pull request includes a changelog file. The entry should:
  • Be a short description of your change which makes sense to users. "Fixed a bug that prevented receiving messages from other servers." instead of "Moved X method from EventStore to EventWorkerStore.".
  • Use markdown where necessary, mostly for code blocks.
  • End with either a period (.) or an exclamation mark (!).
  • Start with a capital letter.
  • Feel free to credit yourself, by adding a sentence "Contributed by @github_username." or "Contributed by [Your Name]." to the end of the entry.
• Pull request includes a sign off
• Code style is correct
  (run the linters)

Fixes #10321

[clokep]

@thezaidbintariq Could you please sign-off on your contribution?

[clokep]

Suggested change

	Removed if room_alias:
	result["room_alias"] = room_alias.to_string()
	from synapse/synapse/handlers/room.py
	Contributed by @thezaidbintariq.
	Remove undocumented `room_alias` key from `/createRoom` response. Contributed by @thezaidbintariq.

[thezaidbintariq]

Signed-off-by: Zaid Bin Tariq [email protected]

[thezaidbintariq]

Signed-off-by: Zaid Bin Tariq [email protected]

[thezaidbintariq]

@clokep did I sign-off correctly?

[anoadragon453]

@thezaidbintariq Your sign-off is correct 👍

It would be good for someone to shout in the Matrix Client Developers Room about this change before including it in a release of Synapse - just to ensure that no client desperately relies on this (unspecced) field.

[thezaidbintariq]

@anoadragon453 can you merge the PR?

[clokep]

It would be good for someone to shout in the Matrix Client Developers Room about this change before including it in a release of Synapse - just to ensure that no client desperately relies on this (unspecced) field.

This was done at https://matrix.to/#/!XXSJTvRPInupfUgQVb:matrix.org/$xxmBTJfTuP2icgn0X2xfDsygfUR3JbsFYQAMBE1eMPs?via=pixie.town&via=matrix.org&via=element.io

[anoadragon453]

It would be good for someone to shout in the Matrix Client Developers Room about this change before including it in a release of Synapse - just to ensure that no client desperately relies on this (unspecced) field.

This was done at matrix.to/#/!XXSJTvRPInupfUgQVb:matrix.org/$xxmBTJfTuP2icgn0X2xfDsygfUR3JbsFYQAMBE1eMPs?via=pixie.town&via=matrix.org&via=element.io

I bumped the question as nobody had responded yet.

[clokep]

This is failing due to complement requiring the room_alias field, it lokos like this was removed from matrix-org/sytest#1216, but never ported to complement, see https://github.com/matrix-org/complement/blob/4418d2c05009cb0754403a9a8565b8b701633a5b/tests/csapi/apidoc_room_create_test.go#L39

[DMRobertson]

This is failing due to complement requiring the room_alias field, it lokos like this was removed from matrix-org/sytest#1216, but never ported to complement, see https://github.com/matrix-org/complement/blob/4418d2c05009cb0754403a9a8565b8b701633a5b/tests/csapi/apidoc_room_create_test.go#L39

I have opened matrix-org/complement#616 for this.

[DMRobertson]

It looks like this makes a backwards-incompatible change to the module API too:

synapse/synapse/module_api/__init__.py

Line 1586 in 7e8d455

return room_id_and_alias["room_id"], room_id_and_alias.get("room_alias", None)

Will need to

• update the tests
• change the module API to be backwards compatible (probably not too bad), or else announcing a breaking change

[DMRobertson]

(I am happy to take this over, to get this across the line)

[DMRobertson]

Complement should now pass now that matrix-org/complement#616 has landed

[DMRobertson]

Hmm. On reflection it looks like there's a bit more internal plumbing to be done here than we'd anticipated. I'm going to have a go at this in #15093.

[DMRobertson]

Hmm. On reflection it looks like there's a bit more internal plumbing to be done here than we'd anticipated. I'm going to have a go at this in #15093.

This has just merged. Thank you for your efforts looking into this.