Skip to content
New issue

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

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[NEW] REST API to use Spotlight #9509

Merged
merged 6 commits into from
Feb 15, 2018
Merged

[NEW] REST API to use Spotlight #9509

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
c8c239e
Add a new API to use spotlight method from Meteor
rafaelks Jan 25, 2018
8ab094a
Add new line at the end of the file
rafaelks Jan 26, 2018
bf85c6d
Create tests for Spotlight REST API
rafaelks Jan 26, 2018
39956cd
Few code adjustments
rafaelks Jan 26, 2018
47e0d05
Add docs to the method signature
rafaelks Jan 26, 2018
a5407af
small fix
MarcosSpessatto Feb 9, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/rocketchat-api/package.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,4 +44,5 @@ Package.onUse(function(api) {
api.addFiles('server/v1/settings.js', 'server');
api.addFiles('server/v1/stats.js', 'server');
api.addFiles('server/v1/users.js', 'server');
api.addFiles('server/v1/spotlight.js', 'server');
});
28 changes: 28 additions & 0 deletions packages/rocketchat-api/server/v1/spotlight.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
/**
This API returns the result of a query of rooms
and users, using Meteor's Spotlight method.

Method: GET
Route: api/v1/spotlight
Query params:
- query: The term to be searched.
*/
RocketChat.API.v1.addRoute('spotlight', { authRequired: true }, {
get() {
check(this.queryParams, {
query: String
});

const { query } = this.queryParams;

let result;
Meteor.runAsUser(this.userId, () =>
result = Meteor.call('spotlight', query, null, {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@MarcosSpessatto change to use result from Meteor.runAsUser return

rooms: true,
users: true
})
);
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@RocketChat/core For some reason, this method ALWAYS returns rooms empty. I tried debugging it already and it's entering the part of the code that queries per rooms, so I don't know what's going on. Here's the call example I'm using:

curl -X GET -H "X-Auth-Token: 6eWs4ECxUITYYoZ_bAYK5OE2srkxAepQqQA1cGGv3jK" -H "X-User-Id: hvzu8z6mHFigiXy6Y" http://localhost:3000/api/v1/spotlight?query=t

And I do have a room with the name of general and testing-public-channel. The users I'm trying also have all the permissions required to search by rooms: view-outside-room and view-c-room. Does someone have any idea what's going on?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The query must be a valid json object.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@graywolf336 What do you mean? It works for users... do you have an example of how it should be?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Never mind, I thought you was doing something else. Ignore my comment.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rafaelks If you call it via DDP it returns data for rooms?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rodrigok How can I do that?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Exactly as you wrote for the server side call, but from you browser (logged in)

Meteor.call('spotlight', 't', null, {
				rooms: true,
				users: true
			})

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Per our chat, the API is correct & it's not returning the objects because user already joined the rooms.


return RocketChat.API.v1.success(result);
}
});
40 changes: 40 additions & 0 deletions tests/end-to-end/api/11-spotlight.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
/* eslint-env mocha */
/* globals expect */

import {getCredentials, api, request, credentials } from '../../data/api-data.js';

describe('[Spotlight]', function() {
this.retries(0);

before(done => getCredentials(done));

describe('[/spotlight]', () => {
it('should fail when does not have query param', (done) => {
request.get(api('spotlight'))
.set(credentials)
.expect('Content-Type', 'application/json')
.expect(400)
.expect((res) => {
expect(res.body).to.have.property('success', false);
expect(res.body).to.have.property('error');
})
.end(done);
});

it('should return objects for a valid query param', (done) => {
request.get(api('spotlight'))
.query({
query: 'foobar'
})
.set(credentials)
.expect('Content-Type', 'application/json')
.expect(200)
.expect((res) => {
expect(res.body).to.have.property('success', true);
expect(res.body).to.have.property('users').that.have.lengthOf(0);
expect(res.body).to.have.property('rooms').that.have.lengthOf(0);
})
.end(done);
});
});
});