Skip to content

Improve Mirage setup #2386

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 14 commits into from
Apr 2, 2020
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
2 changes: 2 additions & 0 deletions mirage/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ import * as Categories from './route-handlers/categories';
import * as Crates from './route-handlers/crates';
import * as DocsRS from './route-handlers/docs-rs';
import * as Keywords from './route-handlers/keywords';
import * as Me from './route-handlers/me';
import * as Summary from './route-handlers/summary';
import * as Teams from './route-handlers/teams';
import * as Users from './route-handlers/users';
Expand All @@ -11,6 +12,7 @@ export default function () {
Crates.register(this);
DocsRS.register(this);
Keywords.register(this);
Me.register(this);
Summary.register(this);
Teams.register(this);
Users.register(this);
Expand Down
18 changes: 18 additions & 0 deletions mirage/factories/api-token.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
import { Factory } from 'ember-cli-mirage';

export default Factory.extend({
createdAt: '2017-11-19T17:59:22',
lastUsedAt: null,
name: i => `API Token ${i + 1}`,
token: () => generateToken(),

afterCreate(model) {
if (!model.user) {
throw new Error('Missing `user` relationship on `api-token`');
}
},
});

function generateToken() {
return Math.random().toString().slice(2);
}
14 changes: 14 additions & 0 deletions mirage/factories/crate-ownership.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
import { Factory } from 'ember-cli-mirage';

export default Factory.extend({
emailNotifications: true,

afterCreate(model) {
if (!model.crate) {
throw new Error('Missing `crate` relationship on `crate-ownership`');
}
if (model.team && model.user) {
throw new Error('`team` and `user` on a `crate-ownership` are mutually exclusive');
}
},
});
9 changes: 9 additions & 0 deletions mirage/factories/mirage-session.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
import { Factory } from 'ember-cli-mirage';

export default Factory.extend({
afterCreate(session) {
if (!session.user) {
throw new Error('Missing `user` relationship');
}
},
});
13 changes: 13 additions & 0 deletions mirage/factories/user.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,22 @@ export default Factory.extend({
return dasherize(this.name);
},

email() {
return `${this.login}@crates.io`;
},

url() {
return `https://github.com/${this.login}`;
},

avatar: 'https://avatars1.githubusercontent.com/u/14631425?v=4',

emailVerified: null,
emailVerificationToken: null,

afterCreate(model) {
if (model.emailVerified === null) {
model.update({ emailVerified: !model.emailVerificationToken });
}
},
});
18 changes: 18 additions & 0 deletions mirage/fixtures/crate-ownerships.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
export default [
{
crateId: 'nanomsg',
teamId: 1,
},
{
crateId: 'nanomsg',
teamId: 303,
},
{
crateId: 'nanomsg',
userId: 2,
},
{
crateId: 'nanomsg',
userId: 303,
},
];
6 changes: 4 additions & 2 deletions mirage/models/api-token.js
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
import { Model } from 'ember-cli-mirage';
import { Model, belongsTo } from 'ember-cli-mirage';

export default Model.extend({});
export default Model.extend({
user: belongsTo(),
});
7 changes: 7 additions & 0 deletions mirage/models/crate-ownership.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
import { Model, belongsTo } from 'ember-cli-mirage';

export default Model.extend({
crate: belongsTo(),
team: belongsTo(),
user: belongsTo(),
});
2 changes: 0 additions & 2 deletions mirage/models/crate.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,5 @@ import { Model, hasMany } from 'ember-cli-mirage';
export default Model.extend({
categories: hasMany(),
keywords: hasMany(),
teamOwners: hasMany('team'),
versions: hasMany(),
userOwners: hasMany('user'),
});
13 changes: 13 additions & 0 deletions mirage/models/mirage-session.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
import { Model, belongsTo } from 'ember-cli-mirage';

/**
* This is a mirage-only model, that is used to keep track of the current
* session and the associated `user` model, because in route handlers we don't
* have access to the cookie data that the actual API is using for these things.
*
* This mock implementation means that there can only ever exist one
* session at a time.
*/
export default Model.extend({
user: belongsTo(),
});
32 changes: 18 additions & 14 deletions mirage/route-handlers/crates.js
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,12 @@ export function register(server) {

if (request.queryParams.user_id) {
let userId = parseInt(request.queryParams.user_id, 10);
crates = crates.filter(crate => (crate._owner_users || []).indexOf(userId) !== -1);
crates = crates.filter(crate => schema.crateOwnerships.findBy({ crateId: crate.id, userId }));
}

if (request.queryParams.team_id) {
let teamId = parseInt(request.queryParams.team_id, 10);
crates = crates.filter(crate => (crate._owner_teams || []).indexOf(teamId) !== -1);
crates = crates.filter(crate => schema.crateOwnerships.findBy({ crateId: crate.id, teamId }));
}

if (request.queryParams.sort === 'alpha') {
Expand Down Expand Up @@ -99,27 +99,31 @@ export function register(server) {
let crate = schema.crates.find(crateId);
if (!crate) return notFound();

let response = this.serialize(crate.userOwners);
let ownerships = schema.crateOwnerships.where({ crateId }).filter(it => it.userId).models;

response.users.forEach(user => {
user.kind = 'user';
});

return response;
return {
users: ownerships.map(it => {
let json = this.serialize(it.user, 'user').user;
json.kind = 'user';
return json;
}),
};
});

server.get('/api/v1/crates/:crate_id/owner_team', function (schema, request) {
let crateId = request.params.crate_id;
let crate = schema.crates.find(crateId);
if (!crate) return notFound();

let response = this.serialize(crate.teamOwners);
let ownerships = schema.crateOwnerships.where({ crateId }).filter(it => it.teamId).models;

response.teams.forEach(team => {
team.kind = 'team';
});

return response;
return {
teams: ownerships.map(it => {
let json = this.serialize(it.team, 'team').team;
json.kind = 'team';
return json;
}),
};
});

server.get('/api/v1/crates/:crate_id/reverse_dependencies', function (schema, request) {
Expand Down
74 changes: 74 additions & 0 deletions mirage/route-handlers/me.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
import { Response } from 'ember-cli-mirage';

import { getSession } from '../utils/session';

export function register(server) {
server.get('/api/v1/me', function (schema) {
let { user } = getSession(schema);
if (!user) {
return new Response(403, {}, { errors: [{ detail: 'must be logged in to perform that action' }] });
}

let ownerships = schema.crateOwnerships.where({ userId: user.id }).models;

let json = this.serialize(user);

json.owned_crates = ownerships.map(ownership => ({
id: ownership.crate.id,
name: ownership.crate.name,
email_notifications: ownership.emailNotifications,
}));

return json;
});

server.get('/api/v1/me/tokens', function (schema) {
let { user } = getSession(schema);
if (!user) {
return new Response(403, {}, { errors: [{ detail: 'must be logged in to perform that action' }] });
}

return schema.apiTokens.where({ userId: user.id }).sort((a, b) => Number(b.id) - Number(a.id));
});

server.put('/api/v1/me/tokens', function (schema) {
let { user } = getSession(schema);
if (!user) {
return new Response(403, {}, { errors: [{ detail: 'must be logged in to perform that action' }] });
}

let { name } = this.normalizedRequestAttrs('api-token');
let token = server.create('api-token', { user, name, createdAt: new Date().toISOString() });

let json = this.serialize(token);
json.api_token.revoked = false;
json.api_token.token = token.token;
return json;
});

server.delete('/api/v1/me/tokens/:tokenId', function (schema, request) {
let { user } = getSession(schema);
if (!user) {
return new Response(403, {}, { errors: [{ detail: 'must be logged in to perform that action' }] });
}

let { tokenId } = request.params;
let token = schema.apiTokens.findBy({ id: tokenId, userId: user.id });
if (token) token.destroy();

return {};
});

server.put('/api/v1/confirm/:token', (schema, request) => {
let { token } = request.params;

let user = schema.users.findBy({ emailVerificationToken: token });
if (!user) {
return new Response(400, {}, { errors: [{ detail: 'Email belonging to token not found.' }] });
}

user.update({ emailVerified: true, emailVerificationToken: null });

return { ok: true };
});
}
29 changes: 29 additions & 0 deletions mirage/serializers/api-token.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
import BaseSerializer from './application';

export default BaseSerializer.extend({
getHashForResource() {
let [hash, addToIncludes] = BaseSerializer.prototype.getHashForResource.apply(this, arguments);

if (Array.isArray(hash)) {
for (let resource of hash) {
this._adjust(resource);
}
} else {
this._adjust(hash);
}

return [hash, addToIncludes];
},

_adjust(hash) {
hash.id = Number(hash.id);
if (hash.created_at) {
hash.created_at = new Date(hash.created_at).toISOString();
}
if (hash.last_used_at) {
hash.last_used_at = new Date(hash.last_used_at).toISOString();
}
delete hash.token;
delete hash.user_id;
},
});
21 changes: 21 additions & 0 deletions mirage/serializers/team.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
import BaseSerializer from './application';

export default BaseSerializer.extend({
getHashForResource() {
let [hash, addToIncludes] = BaseSerializer.prototype.getHashForResource.apply(this, arguments);

if (Array.isArray(hash)) {
for (let resource of hash) {
this._adjust(resource);
}
} else {
this._adjust(hash);
}

return [hash, addToIncludes];
},

_adjust(hash) {
hash.id = Number(hash.id);
},
});
32 changes: 32 additions & 0 deletions mirage/serializers/user.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
import BaseSerializer from './application';

export default BaseSerializer.extend({
getHashForResource() {
let [hash, addToIncludes] = BaseSerializer.prototype.getHashForResource.apply(this, arguments);

let removePrivateData = this.request.url !== '/api/v1/me';

if (Array.isArray(hash)) {
for (let resource of hash) {
this._adjust(resource, { removePrivateData });
}
} else {
this._adjust(hash, { removePrivateData });
}

return [hash, addToIncludes];
},

_adjust(hash, { removePrivateData }) {
hash.id = Number(hash.id);

if (removePrivateData) {
delete hash.email;
delete hash.email_verified;
} else {
hash.email_verification_sent = hash.email_verified || Boolean(hash.email_verification_token);
}

delete hash.email_verification_token;
},
});
9 changes: 9 additions & 0 deletions mirage/utils/session.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
export function getSession(schema) {
let session = schema.mirageSessions.first();
if (!session || Date.parse(session.expires) < Date.now()) {
return {};
}

let user = schema.users.find(session.userId);
return { session, user };
}
Loading