Skip to content

User's data normalization #671

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

Open
jjpaulino wants to merge 5 commits into
base: master
Choose a base branch
from
+47 −16
Open

User's data normalization #671

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
375bcc5
Change user of page metadata from object to id string
Jun 27, 2019
8d54790
Modify bootstrap function
jjpaulino Jul 9, 2019
a66c511
Add tests
jjpaulino Jul 11, 2019
75d45f3
Merge branch 'master' of https://github.com/clay/amphora into user-no…
jjpaulino Jul 11, 2019
96a94fd
Merge branch 'master' into user-normalization
manuelurenah Jul 31, 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
4 changes: 2 additions & 2 deletions lib/bootstrap.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ const path = require('path'),
dbOps = require('./services/db-operations'),
siteService = require('./services/sites'),
references = require('./services/references'),
{ createUserUri } = require('./services/metadata'),
highland = require('highland'),
{ encode } = require('./services/buffer'),
locals = require('./locals');
var log = require('./services/logger').setup({
file: __filename,
Expand Down Expand Up @@ -221,7 +221,7 @@ function load(data, site) {
).then(_.flatten);
});
promisePagesOps = saveObjects(`${prefix}/_pages/`, compData._pages, (name, item) => [getPutOperation(name, item)]);
promiseUsersOps = saveObjects('', compData._users, (name, item) => [getPutOperation(`/_users/${encode(`${item.username}@${item.provider}`)}`, item)]);
promiseUsersOps = saveObjects('', compData._users, (name, item) => [getPutOperation(`/_users/${createUserUri(item)}`, item)]);

/* eslint max-params: ["error", 5] */
return bluebird.join(promiseComponentsOps, promisePagesOps, promiseUrisOps, promiseListsOps, promiseUsersOps, function (componentsOps, pagesOps, urisOps, listsOps, userOps) {
Expand Down
38 changes: 25 additions & 13 deletions lib/services/metadata.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,23 @@

const _ = require('lodash'),
bus = require('./bus'),
{ encode } = require('./buffer'),
{ replaceVersion } = require('clayutils'),
sitesService = require('./sites');
var db = require('./db');

/**
* Creates the id for a user
*
* @param {Object} user
* @param {string} user.username
* @param {string} user.provider
* @returns {string}
*/
function createUserUri({ username = '', provider = '' }) {
return encode(`${username}@${provider}`);
}

/**
* Either return the user object or
* the system for a specific action
Expand All @@ -14,18 +27,15 @@ var db = require('./db');
* @returns {Object}
*/
function userOrRobot(user) {
if (user && _.get(user, 'username') && _.get(user, 'provider')) {
return user;
} else {
// no actual user, this was an api key
return {
username: 'robot',
provider: 'clay',
imageUrl: 'clay-avatar', // kiln will supply a clay avatar
name: 'Clay',
auth: 'admin'
};
}
const { username, provider } = user && _.get(user, 'username') && _.get(user, 'provider')
? user
: { username: 'robot', provider: 'clay' };

return {
id: createUserUri({ username, provider }),
username,
provider
};
}

/**
Expand Down Expand Up @@ -71,7 +81,7 @@ function createPage(ref, user) {
title: '',
authors: [],
users,
history: [{action: 'create', timestamp: NOW, users }],
history: [{ action: 'create', timestamp: NOW, users }],
siteSlug: sitesService.getSiteFromPrefix(ref.substring(0, ref.indexOf('/_pages'))).slug
};

Expand Down Expand Up @@ -283,6 +293,8 @@ module.exports.publishLayout = publishLayout;
module.exports.unpublishPage = unpublishPage;
module.exports.userOrRobot = userOrRobot;
module.exports.checkProps = checkProps;
module.exports.createUserUri = createUserUri;

// For testing
module.exports.userOrRobot = userOrRobot;
module.exports.setDb = mock => db = mock;
19 changes: 19 additions & 0 deletions lib/services/metadata.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -257,6 +257,25 @@ describe(_.startCase(filename), function () {
expect(resp).to.eql(errMsg);
});
});
});

describe('userOrRobot', function () {
const fn = lib[this.title];

it('should return the user object', function () {
const username = 'pizza@everyday',
provider = 'doesntmatter',
userOrRobot = fn({ username, provider }),
expectedValue = { id: 'cGl6emFAZXZlcnlkYXlAZG9lc250bWF0dGVy', username, provider };

expect(userOrRobot).to.eql(expectedValue);
});

it('should return the system user (robot) object', function () {
const userOrRobot = fn(),
expectedValue = { id: 'cm9ib3RAY2xheQ==', username: 'robot', provider: 'clay' };

expect(userOrRobot).to.eql(expectedValue);
});
});
});
2 changes: 1 addition & 1 deletion package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.