Skip to content

Revert "feat: use v5 api to save traits" #325

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.

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

Merged
merged 1 commit into from
Dec 13, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 4 additions & 0 deletions __tests__/actions/profile.js
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ const linkedAccounts = [{

// Mock services
const mockMembersService = {
getPresignedUrl: jest.fn().mockReturnValue(Promise.resolve()),
uploadFileToS3: jest.fn().mockReturnValue(Promise.resolve()),
updateMemberPhoto: jest.fn().mockReturnValue(Promise.resolve('url-of-photo')),
updateMemberProfile: jest.fn().mockReturnValue(Promise.resolve(profile)),
addSkill: jest.fn().mockReturnValue(Promise.resolve({ skills: [skill] })),
Expand Down Expand Up @@ -45,6 +47,8 @@ test('Module exports', () => expect(actions).toMatchSnapshot());
test('profile.uploadPhotoDone', async () => {
const actionResult = await redux.resolveAction(actions.profile.uploadPhotoDone(handle, tokenV3));
expect(actionResult).toMatchSnapshot();
expect(mockMembersService.getPresignedUrl).toBeCalled();
expect(mockMembersService.uploadFileToS3).toBeCalled();
expect(mockMembersService.updateMemberPhoto).toBeCalled();
});

Expand Down
40 changes: 34 additions & 6 deletions docs/services.members.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,9 @@ members via API V3.
* [.addSkill(handle, skillTagId)](#module_services.members..MembersService+addSkill) ⇒ <code>Promise</code>
* [.hideSkill(handle, skillTagId)](#module_services.members..MembersService+hideSkill) ⇒ <code>Promise</code>
* [.updateMemberProfile(profile)](#module_services.members..MembersService+updateMemberProfile) ⇒ <code>Promise</code>
* [.updateMemberPhoto(userHandle, file)](#module_services.members..MembersService+updateMemberPhoto) ⇒ <code>Promise</code>
* [.getPresignedUrl(userHandle, file)](#module_services.members..MembersService+getPresignedUrl) ⇒ <code>Promise</code>
* [.updateMemberPhoto(S3Response)](#module_services.members..MembersService+updateMemberPhoto) ⇒ <code>Promise</code>
* [.uploadFileToS3(presignedUrlResponse)](#module_services.members..MembersService+uploadFileToS3) ⇒ <code>Promise</code>
* [.verifyMemberNewEmail(handle, emailVerifyToken)](#module_services.members..MembersService+verifyMemberNewEmail) ⇒ <code>Promise</code>

<a name="module_services.members.getService"></a>
Expand Down Expand Up @@ -63,7 +65,9 @@ Service class.
* [.addSkill(handle, skillTagId)](#module_services.members..MembersService+addSkill) ⇒ <code>Promise</code>
* [.hideSkill(handle, skillTagId)](#module_services.members..MembersService+hideSkill) ⇒ <code>Promise</code>
* [.updateMemberProfile(profile)](#module_services.members..MembersService+updateMemberProfile) ⇒ <code>Promise</code>
* [.updateMemberPhoto(userHandle, file)](#module_services.members..MembersService+updateMemberPhoto) ⇒ <code>Promise</code>
* [.getPresignedUrl(userHandle, file)](#module_services.members..MembersService+getPresignedUrl) ⇒ <code>Promise</code>
* [.updateMemberPhoto(S3Response)](#module_services.members..MembersService+updateMemberPhoto) ⇒ <code>Promise</code>
* [.uploadFileToS3(presignedUrlResponse)](#module_services.members..MembersService+uploadFileToS3) ⇒ <code>Promise</code>
* [.verifyMemberNewEmail(handle, emailVerifyToken)](#module_services.members..MembersService+verifyMemberNewEmail) ⇒ <code>Promise</code>

<a name="new_module_services.members..MembersService_new"></a>
Expand Down Expand Up @@ -252,18 +256,42 @@ Updates member profile.
| --- | --- | --- |
| profile | <code>Object</code> | The profile to update. |

<a name="module_services.members..MembersService+updateMemberPhoto"></a>
<a name="module_services.members..MembersService+getPresignedUrl"></a>

#### membersService.updateMemberPhoto(userHandle, file) ⇒ <code>Promise</code>
Uploads and updates member photo.
#### membersService.getPresignedUrl(userHandle, file) ⇒ <code>Promise</code>
Gets presigned url for member photo file.

**Kind**: instance method of [<code>MembersService</code>](#module_services.members..MembersService)
**Returns**: <code>Promise</code> - Resolves to the api response content

| Param | Type | Description |
| --- | --- | --- |
| userHandle | <code>String</code> | The user handle |
| file | <code>File</code> | The file to be uploaded |
| file | <code>File</code> | The file to get its presigned url |

<a name="module_services.members..MembersService+updateMemberPhoto"></a>

#### membersService.updateMemberPhoto(S3Response) ⇒ <code>Promise</code>
Updates member photo.

**Kind**: instance method of [<code>MembersService</code>](#module_services.members..MembersService)
**Returns**: <code>Promise</code> - Resolves to the api response content

| Param | Type | Description |
| --- | --- | --- |
| S3Response | <code>Object</code> | The response from uploadFileToS3() function. |

<a name="module_services.members..MembersService+uploadFileToS3"></a>

#### membersService.uploadFileToS3(presignedUrlResponse) ⇒ <code>Promise</code>
Uploads file to S3.

**Kind**: instance method of [<code>MembersService</code>](#module_services.members..MembersService)
**Returns**: <code>Promise</code> - Resolves to the api response content

| Param | Type | Description |
| --- | --- | --- |
| presignedUrlResponse | <code>Object</code> | The presigned url response from getPresignedUrl() function. |

<a name="module_services.members..MembersService+verifyMemberNewEmail"></a>

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
"lint:js": "./node_modules/.bin/eslint --ext .js,.jsx .",
"test": "npm run lint && npm run jest"
},
"version": "1.2.3",
"version": "1.2.2",
"dependencies": {
"auth0-js": "^6.8.4",
"config": "^3.2.0",
Expand Down
4 changes: 3 additions & 1 deletion src/actions/profile.js
Original file line number Diff line number Diff line change
Expand Up @@ -216,7 +216,9 @@ function uploadPhotoInit() {}
*/
function uploadPhotoDone(handle, tokenV3, file) {
const service = getMembersService(tokenV3);
return service.updateMemberPhoto(handle, file)
return service.getPresignedUrl(handle, file)
.then(res => service.uploadFileToS3(res))
.then(res => service.updateMemberPhoto(res))
.then(photoURL => ({ handle, photoURL }));
}

Expand Down
78 changes: 64 additions & 14 deletions src/services/members.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,11 @@
* members via API V3.
*/

/* global FormData */
/* global XMLHttpRequest */
import _ from 'lodash';
import qs from 'qs';
import { decodeToken } from '@topcoder-platform/tc-auth-lib';
import logger from '../utils/logger';
import { getApiResponsePayload, handleApiResponse } from '../utils/tc';
import { getApi } from './api';

Expand Down Expand Up @@ -238,23 +239,72 @@ class MembersService {
}

/**
* Updates member photo.
* Gets presigned url for member photo file.
* @param {String} userHandle The user handle
* @param {File} file The photo to upload
* @param {File} file The file to get its presigned url
* @return {Promise} Resolves to the api response content
*/
async updateMemberPhoto(userHandle, file) {
const formData = new FormData();
formData.append('photo', file);
const res = await this.private.apiV5.fetch(`/members/${userHandle}/photo`, {
method: 'POST',
headers: {
'Content-Type': null,
},
body: formData,
async getPresignedUrl(userHandle, file) {
const res = await this.private.api.postJson(`/members/${userHandle}/photoUploadUrl`, { param: { contentType: file.type } });
const payload = await getApiResponsePayload(res);

return {
preSignedURL: payload.preSignedURL,
token: payload.token,
file,
userHandle,
};
}

/**
* Updates member photo.
* @param {Object} S3Response The response from uploadFileToS3() function.
* @return {Promise} Resolves to the api response content
*/
async updateMemberPhoto(S3Response) {
const res = await this.private.api.putJson(`/members/${S3Response.userHandle}/photo`, { param: S3Response.body });
return getApiResponsePayload(res);
}

/**
* Uploads file to S3.
* @param {Object} presignedUrlResponse The presigned url response from
* getPresignedUrl() function.
* @return {Promise} Resolves to the api response content
*/
uploadFileToS3(presignedUrlResponse) {
_.noop(this);
return new Promise((resolve, reject) => {
const xhr = new XMLHttpRequest();

xhr.open('PUT', presignedUrlResponse.preSignedURL, true);
xhr.setRequestHeader('Content-Type', presignedUrlResponse.file.type);

xhr.onreadystatechange = () => {
const { status } = xhr;
if (((status >= 200 && status < 300) || status === 304) && xhr.readyState === 4) {
resolve({
userHandle: presignedUrlResponse.userHandle,
body: {
token: presignedUrlResponse.token,
contentType: presignedUrlResponse.file.type,
},
});
} else if (status >= 400) {
const err = new Error('Could not upload image to S3');
err.status = status;
reject(err);
}
};

xhr.onerror = (err) => {
logger.error('Could not upload image to S3', err);

reject(err);
};

xhr.send(presignedUrlResponse.file);
});
return handleApiResponse(res)
.then(({ photoURL }) => photoURL);
}

/**
Expand Down
44 changes: 24 additions & 20 deletions src/services/user-traits.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* via API V3.
*/
import toCapitalCase from 'to-capital-case';
import { handleApiResponse } from '../utils/tc';
import { getApiResponsePayload } from '../utils/tc';
import { getApi } from './api';

/**
Expand All @@ -16,7 +16,7 @@ class UserTraitsService {
*/
constructor(tokenV3) {
this.private = {
api: getApi('V5', tokenV3),
api: getApi('V3', tokenV3),
tokenV3,
};
}
Expand All @@ -29,7 +29,7 @@ class UserTraitsService {
async getAllUserTraits(handle) {
// FIXME: Remove the .toLowerCase() when the API is fixed to ignore the case in the route params
const res = await this.private.api.get(`/members/${handle.toLowerCase()}/traits`);
return handleApiResponse(res);
return getApiResponsePayload(res);
}

/**
Expand All @@ -40,16 +40,18 @@ class UserTraitsService {
* @return {Promise} Resolves to the member traits.
*/
async addUserTrait(handle, traitId, data) {
const body = [{
traitId,
categoryName: toCapitalCase(traitId),
traits: {
data,
},
}];
const body = {
param: [{
traitId,
categoryName: toCapitalCase(traitId),
traits: {
data,
},
}],
};

const res = await this.private.api.postJson(`/members/${handle}/traits`, body);
return handleApiResponse(res);
return getApiResponsePayload(res);
}

/**
Expand All @@ -60,16 +62,18 @@ class UserTraitsService {
* @return {Promise} Resolves to the member traits.
*/
async updateUserTrait(handle, traitId, data) {
const body = [{
traitId,
categoryName: toCapitalCase(traitId),
traits: {
data,
},
}];
const body = {
param: [{
traitId,
categoryName: toCapitalCase(traitId),
traits: {
data,
},
}],
};

const res = await this.private.api.putJson(`/members/${handle}/traits`, body);
return handleApiResponse(res);
return getApiResponsePayload(res);
}

/**
Expand All @@ -80,7 +84,7 @@ class UserTraitsService {
*/
async deleteUserTrait(handle, traitId) {
const res = await this.private.api.delete(`/members/${handle}/traits?traitIds=${traitId}`);
return handleApiResponse(res);
return getApiResponsePayload(res);
}
}

Expand Down
3 changes: 1 addition & 2 deletions src/utils/tc.js
Original file line number Diff line number Diff line change
Expand Up @@ -87,8 +87,7 @@ export async function getApiResponsePayload(res, shouldThrowError = true) {
*/
export function handleApiResponse(response) {
if (!response.ok) throw new Error(response.statusText);
return response.json()
.catch(() => null);
return response.json();
}

/**
Expand Down