[NEW] Add users.requestDataDownload API endpoint (#14428)

* Add users.requestDataDownload API endpoint * Fix request data download endpoint
RocketChat · Oct 18, 2019 · 81a504d · 81a504d
1 parent bdf4811
commit 81a504d
Show file tree

Hide file tree

Showing 2 changed files with 54 additions and 0 deletions.
diff --git a/app/api/server/v1/users.js b/app/api/server/v1/users.js
@@ -671,3 +671,15 @@ API.v1.addRoute('users.presence', { authRequired: true }, {
 		});
 	},
 });
+
+API.v1.addRoute('users.requestDataDownload', { authRequired: true }, {
+	get() {
+		const { fullExport = false } = this.queryParams;
+		const result = Meteor.runAsUser(this.userId, () => Meteor.call('requestDataDownload', { fullExport: fullExport === 'true' }));
+
+		return API.v1.success({
+			requested: result.requested,
+			exportOperation: result.exportOperation,
+		});
+	},
+});
diff --git a/tests/end-to-end/api/01-users.js b/tests/end-to-end/api/01-users.js
@@ -1658,4 +1658,46 @@ describe('[Users]', function() {
 			});
 		});
 	});
+
+	describe('[/users.requestDataDownload]', () => {
+		it('should return the request data with fullExport false when no query parameter was send', (done) => {
+			request.get(api('users.requestDataDownload'))
+				.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('requested');
+					expect(res.body).to.have.property('exportOperation').and.to.be.an('object');
+					expect(res.body.exportOperation).to.have.property('fullExport', false);
+				})
+				.end(done);
+		});
+		it('should return the request data with fullExport false when the fullExport query parameter is false', (done) => {
+			request.get(api('users.requestDataDownload?fullExport=false'))
+				.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('requested');
+					expect(res.body).to.have.property('exportOperation').and.to.be.an('object');
+					expect(res.body.exportOperation).to.have.property('fullExport', false);
+				})
+				.end(done);
+		});
+		it('should return the request data with fullExport true when the fullExport query parameter is true', (done) => {
+			request.get(api('users.requestDataDownload?fullExport=true'))
+				.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('requested');
+					expect(res.body).to.have.property('exportOperation').and.to.be.an('object');
+					expect(res.body.exportOperation).to.have.property('fullExport', true);
+				})
+				.end(done);
+		});
+	});
 });