[NEW] REST API endpoint `rooms.favorite` to favorite and unfavorite rooms #10342

MarcosSpessatto · 2018-04-05T14:25:08Z

Add rooms.favorite endpoint to favorite and unfavorite room, and tests.
Closes #10317.

cardoso · 2018-04-05T16:13:36Z

packages/rocketchat-api/server/v1/rooms.js

+RocketChat.API.v1.addRoute('rooms.favorite/:roomId', { authRequired: true }, {
+	post() {
+		const { favorite } = this.bodyParams;
+		const { roomId } = this.urlParams;


Why is "roomId" in the url path and "favorite" in the body? Why not everything in the body? 🤔

Like:
https://rocket.chat/docs/developer-guides/rest-api/channels/invite/
https://rocket.chat/docs/developer-guides/rest-api/channels/leave/
...

I tried to follow what was instructed here, but we can put it in the body, no problem

If you'll notice the suggestion you linked to, both the roomId and the favoriting was in the query parameters and not the body or the url path.

graywolf336 · 2018-04-05T18:39:51Z

packages/rocketchat-api/server/v1/rooms.js

 	}
 });
+
+RocketChat.API.v1.addRoute('rooms.favorite/:roomId', { authRequired: true }, {


Let's convert this to be like the other v1 items, where the data is passed into it via the body params. This way it can be either the room name or the id and so we're not changing on people.

Fix rooms.favorite endpoint, change params from url to body.

graywolf336 · 2018-04-06T18:14:28Z

packages/rocketchat-api/server/v1/rooms.js

+
+RocketChat.API.v1.addRoute('rooms.favorite', { authRequired: true }, {
+	post() {
+		const { favorite, roomId } = this.bodyParams;


Let's make it so we also accept roomName like we do for channels. Like this method but allow it to accept any type of room and for features such as favorite, ensure they are part of that room (have a subscription). Especially since the toggleFavorite method doesn't check to ensure they have a subscription or are part of that room.

Rocket.Chat/packages/rocketchat-api/server/v1/channels.js

Lines 3 to 30 in a9aea36

//Returns the channel IF found otherwise it will return the failure of why it didn't. Check the `statusCode` property

function findChannelByIdOrName({ params, checkedArchived = true, returnUsernames = false }) {

if ((!params.roomId || !params.roomId.trim()) && (!params.roomName || !params.roomName.trim())) {

throw new Meteor.Error('error-roomid-param-not-provided', 'The parameter "roomId" or "roomName" is required');

}

const fields = { ...RocketChat.API.v1.defaultFieldsToExclude };

if (returnUsernames) {

delete fields.usernames;

}

let room;

if (params.roomId) {

room = RocketChat.models.Rooms.findOneById(params.roomId, { fields });

} else if (params.roomName) {

room = RocketChat.models.Rooms.findOneByName(params.roomName, { fields });

}

if (!room || room.t !== 'c') {

throw new Meteor.Error('error-room-not-found', 'The required "roomId" or "roomName" param provided does not match any channel');

}

if (checkedArchived && room.archived) {

throw new Meteor.Error('error-room-archived', `The channel, ${ room.name }, is archived`);

}

return room;

}

Add support to roomName param in rooms.favorite endpoint

graywolf336 · 2018-04-06T21:00:47Z

server/methods/toogleFavorite.js

+		const userSubscription = RocketChat.models.Subscriptions.findOneByRoomIdAndUserId(rid, Meteor.userId());
+		if (!userSubscription) {
+			throw new Meteor.Error('error-invalid-subscription',
+				'Invalid subscription',


I think a better error would be "you can't favorite" a room you aren't part of... I need to test, but before this change what happens when you try to favorite a room that you aren't part of?

The endpoint returns success, but no data is changed. =/

This is a good change. Let's keep it how it is but change the Invalid subscription to You must be part of a room to favorite it?

graywolf336

Change the message returned from the toggleFavorite method then it'll be good to go in my opinion. 👍

Change the error message when in toggleFavorite method

… feature/rest-favorite-room

Add more tests case, by roomId and roomName in /rooms.favorite endpoint

Add rooms.favorite endpoint to favorite and unfavorite room, and tests

4cbbcd0

MarcosSpessatto added feat: api feat: rest labels Apr 5, 2018

MarcosSpessatto added this to the 0.64.0 milestone Apr 5, 2018

MarcosSpessatto self-assigned this Apr 5, 2018

engelgabriel temporarily deployed to rocket-chat-pr-10342 April 5, 2018 14:25 Inactive

MarcosSpessatto mentioned this pull request Apr 5, 2018

[NEW] Add docs to REST rooms.favorite endpoint RocketChat/docs-old#670

Merged

cardoso reviewed Apr 5, 2018

View reviewed changes

graywolf336 suggested changes Apr 5, 2018

View reviewed changes

a168f83

Fix rooms.favorite endpoint, change params from url to body.

engelgabriel temporarily deployed to rocket-chat-pr-10342 April 6, 2018 18:02 Inactive

graywolf336 suggested changes Apr 6, 2018

View reviewed changes

90c239c

Add support to roomName param in rooms.favorite endpoint

engelgabriel temporarily deployed to rocket-chat-pr-10342 April 6, 2018 20:33 Inactive

graywolf336 reviewed Apr 6, 2018

View reviewed changes

graywolf336 suggested changes Apr 9, 2018

View reviewed changes

0f3ef7a

Change the error message when in toggleFavorite method

engelgabriel temporarily deployed to rocket-chat-pr-10342 April 10, 2018 13:39 Inactive

Marcos Defendi added 2 commits April 10, 2018 10:39

Change the error message in toggleFavorite method

7488028

Merge remote-tracking branch 'origin/feature/rest-favorite-room' into…

2c5842f

… feature/rest-favorite-room

engelgabriel temporarily deployed to rocket-chat-pr-10342 April 10, 2018 13:39 Inactive

Marcos Defendi added 2 commits April 10, 2018 17:33

3ba5af0

Add more tests case, by roomId and roomName in /rooms.favorite endpoint

Merge branch 'develop' into feature/rest-favorite-room

65d3771

engelgabriel deployed to rocket-chat-pr-10342 April 10, 2018 20:34 View deployment

graywolf336 approved these changes Apr 10, 2018

View reviewed changes

rodrigok changed the title ~~[NEW] REST API rooms.favorite endpoint to favorite and unfavorite room~~ [NEW] REST API endpoint rooms.favorite to favorite and unfavorite rooms Apr 17, 2018

rodrigok merged commit 1c2803c into develop Apr 17, 2018

rodrigok deleted the feature/rest-favorite-room branch April 17, 2018 17:45

rodrigok mentioned this pull request Apr 28, 2018

Release 0.64.0 #10613

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[NEW] REST API endpoint `rooms.favorite` to favorite and unfavorite rooms #10342

[NEW] REST API endpoint `rooms.favorite` to favorite and unfavorite rooms #10342

Uh oh!

MarcosSpessatto commented Apr 5, 2018

Uh oh!

cardoso Apr 5, 2018 •

edited

Loading

Uh oh!

MarcosSpessatto Apr 5, 2018

Uh oh!

graywolf336 Apr 5, 2018

Uh oh!

graywolf336 Apr 5, 2018

Uh oh!

graywolf336 Apr 6, 2018

Uh oh!

graywolf336 Apr 6, 2018

Uh oh!

MarcosSpessatto Apr 6, 2018

Uh oh!

graywolf336 Apr 9, 2018

Uh oh!

graywolf336 left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

	//Returns the channel IF found otherwise it will return the failure of why it didn't. Check the `statusCode` property
	function findChannelByIdOrName({ params, checkedArchived = true, returnUsernames = false }) {
	if ((!params.roomId \|\| !params.roomId.trim()) && (!params.roomName \|\| !params.roomName.trim())) {
	throw new Meteor.Error('error-roomid-param-not-provided', 'The parameter "roomId" or "roomName" is required');
	}

	const fields = { ...RocketChat.API.v1.defaultFieldsToExclude };
	if (returnUsernames) {
	delete fields.usernames;
	}

	let room;
	if (params.roomId) {
	room = RocketChat.models.Rooms.findOneById(params.roomId, { fields });
	} else if (params.roomName) {
	room = RocketChat.models.Rooms.findOneByName(params.roomName, { fields });
	}

	if (!room \|\| room.t !== 'c') {
	throw new Meteor.Error('error-room-not-found', 'The required "roomId" or "roomName" param provided does not match any channel');
	}

	if (checkedArchived && room.archived) {
	throw new Meteor.Error('error-room-archived', `The channel, ${ room.name }, is archived`);
	}

	return room;
	}

[NEW] REST API endpoint rooms.favorite to favorite and unfavorite rooms #10342

[NEW] REST API endpoint rooms.favorite to favorite and unfavorite rooms #10342

Uh oh!

Conversation

MarcosSpessatto commented Apr 5, 2018

Uh oh!

cardoso Apr 5, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

MarcosSpessatto Apr 5, 2018

Choose a reason for hiding this comment

Uh oh!

graywolf336 Apr 5, 2018

Choose a reason for hiding this comment

Uh oh!

graywolf336 Apr 5, 2018

Choose a reason for hiding this comment

Uh oh!

graywolf336 Apr 6, 2018

Choose a reason for hiding this comment

Uh oh!

graywolf336 Apr 6, 2018

Choose a reason for hiding this comment

Uh oh!

MarcosSpessatto Apr 6, 2018

Choose a reason for hiding this comment

Uh oh!

graywolf336 Apr 9, 2018

Choose a reason for hiding this comment

Uh oh!

graywolf336 left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

[NEW] REST API endpoint `rooms.favorite` to favorite and unfavorite rooms #10342

[NEW] REST API endpoint `rooms.favorite` to favorite and unfavorite rooms #10342

cardoso Apr 5, 2018 •

edited

Loading