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] Add support to updatedSince parameter in emoji-custom.list and deprecated old endpoint #13510

Merged
merged 7 commits into from
Apr 6, 2019
Merged

[NEW] Add support to updatedSince parameter in emoji-custom.list and deprecated old endpoint #13510

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
279af10
Add support to updatedSince parameter in emoji-custom.list and deprec…
MarcosSpessatto Feb 18, 2019
d7b09e8
Merge branch 'develop' into rest-emoji-custom-date-support
MarcosSpessatto Mar 13, 2019
e1f5a76
Remove changes in DDP method, move it to the endpoint logic
MarcosSpessatto Mar 14, 2019
1f1d785
Merge branch 'develop' into rest-emoji-custom-date-support
MarcosSpessatto Mar 15, 2019
f27f332
Fix wrong query, and add tests cases more efficient
MarcosSpessatto Mar 15, 2019
8aaddd4
Update emoji-custom.js
rodrigok Apr 6, 2019
fdadc45
Merge branch 'develop' into rest-emoji-custom-date-support
rodrigok Apr 6, 2019
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
40 changes: 39 additions & 1 deletion app/api/server/v1/emoji-custom.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,50 @@ import { EmojiCustom } from '/app/models';
import { API } from '../api';
import Busboy from 'busboy';

// DEPRECATED
// Will be removed after v1.12.0
API.v1.addRoute('emoji-custom', { authRequired: true }, {
get() {
const warningMessage = 'The endpoint "emoji-custom" is deprecated and will be removed after version v1.12.0';
console.warn(warningMessage);
const { query } = this.parseJsonQuery();
const emojis = Meteor.call('listEmojiCustom', query);

return API.v1.success({ emojis });
return API.v1.success(this.deprecationWarning({
endpoint: 'emoji-custom',
versionWillBeRemove: '1.12.0',
response: {
emojis,
},
}));
},
});

API.v1.addRoute('emoji-custom.list', { authRequired: true }, {
get() {
const { query } = this.parseJsonQuery();
const { updatedSince } = this.queryParams;
let updatedSinceDate;
if (updatedSince) {
if (isNaN(Date.parse(updatedSince))) {
throw new Meteor.Error('error-roomId-param-invalid', 'The "updatedSince" query parameter must be a valid date.');
} else {
updatedSinceDate = new Date(updatedSince);
}
return API.v1.success({
emojis: {
update: EmojiCustom.find(query, { _updatedAt: { $gt: updatedSinceDate } }).fetch(),
rodrigok marked this conversation as resolved.
Show resolved Hide resolved
remove: EmojiCustom.trashFindDeletedAfter(updatedSinceDate).fetch(),
},
});
}

return API.v1.success({
emojis: {
update: EmojiCustom.find(query).fetch(),
remove: [],
},
});
},
});

Expand Down
63 changes: 62 additions & 1 deletion tests/end-to-end/api/12-emoji-custom.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@ describe('[EmojiCustom]', function() {
this.retries(0);

before((done) => getCredentials(done));

// DEPRECATED
// Will be removed after v1.12.0
describe('[/emoji-custom]', () => {
it('should return emojis', (done) => {
request.get(api('emoji-custom'))
Expand All @@ -29,6 +30,66 @@ describe('[EmojiCustom]', function() {
});
});

describe('[/emoji-custom.list]', () => {
it('should return emojis', (done) => {
request.get(api('emoji-custom.list'))
.set(credentials)
.expect(200)
.expect((res) => {
expect(res.body).to.have.property('emojis').and.to.be.a('object');
expect(res.body.emojis).to.have.property('update').and.to.be.a('array');
expect(res.body.emojis).to.have.property('remove').and.to.be.a('array');
})
.end(done);
});
it('should return emojis when use "query" query parameter', (done) => {
request.get(api('emoji-custom.list?query={"_updatedAt": {"$gt": { "$date": "2018-11-27T13:52:01Z" } }}'))
.set(credentials)
.expect(200)
.expect((res) => {
expect(res.body).to.have.property('success', true);
expect(res.body).to.have.property('emojis').and.to.be.a('object');
expect(res.body.emojis).to.have.property('update').and.to.be.a('array');
expect(res.body.emojis).to.have.property('remove').and.to.be.a('array');
})
.end(done);
});
it('should return emojis when use "updateSince" query parameter', (done) => {
request.get(api('emoji-custom.list?updatedSince=2019-02-25T15:08:17.248Z'))
.set(credentials)
.expect(200)
.expect((res) => {
expect(res.body).to.have.property('success', true);
expect(res.body).to.have.property('emojis').and.to.be.a('object');
expect(res.body.emojis).to.have.property('update').and.to.be.a('array');
expect(res.body.emojis).to.have.property('remove').and.to.be.a('array');
})
.end(done);
});
it('should return emojis when use both, "updateSince" and "query" query parameter', (done) => {
request.get(api('emoji-custom.list?query={"_updatedAt": {"$gt": { "$date": "2018-11-27T13:52:01Z" } }}&updatedSince=2019-02-25T15:08:17.248Z'))
.set(credentials)
.expect(200)
.expect((res) => {
expect(res.body).to.have.property('success', true);
expect(res.body).to.have.property('emojis').and.to.be.a('object');
expect(res.body.emojis).to.have.property('update').and.to.be.a('array');
expect(res.body.emojis).to.have.property('remove').and.to.be.a('array');
})
.end(done);
});
it('should return an error when the "updateSince" query parameter is a invalid date', (done) => {
request.get(api('emoji-custom.list?updatedSince=invalid-date'))
.set(credentials)
.expect(400)
.expect((res) => {
expect(res.body).to.have.property('success', false);
expect(res.body.errorType).to.be.equal('error-roomId-param-invalid');
})
.end(done);
});
});

describe('[/emoji-custom.create]', () => {
it('should create new custom emoji', (done) => {
request.post(api('emoji-custom.create'))
Expand Down