Skip to content

mirage: Untangle crate.id and crate.name #3698

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

Merged
merged 1 commit into from
Jun 14, 2021
Merged

mirage: Untangle crate.id and crate.name #3698

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 0 additions & 4 deletions mirage/factories/crate.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,6 @@ import { Factory } from 'ember-cli-mirage';
export default Factory.extend({
name: i => `crate-${i}`,

id() {
return this.name;
},

description() {
return `This is the description for the crate called "${this.name}"`;
},
Expand Down
132 changes: 69 additions & 63 deletions mirage/route-handlers/crates.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,12 @@ export function list(schema, request) {

if (request.queryParams.letter) {
let letter = request.queryParams.letter.toLowerCase();
crates = crates.filter(crate => crate.id[0].toLowerCase() === letter);
crates = crates.filter(crate => crate.name[0].toLowerCase() === letter);
}

if (request.queryParams.q) {
let q = request.queryParams.q.toLowerCase();
crates = crates.filter(crate => crate.id.toLowerCase().includes(q));
crates = crates.filter(crate => crate.name.toLowerCase().includes(q));
}

if (request.queryParams.user_id) {
Expand All @@ -39,7 +39,7 @@ export function list(schema, request) {

let { ids } = request.queryParams;
if (ids) {
crates = crates.filter(crate => ids.includes(crate.id));
crates = crates.filter(crate => ids.includes(crate.name));
}

if (request.queryParams.sort === 'alpha') {
Expand All @@ -52,9 +52,9 @@ export function list(schema, request) {
export function register(server) {
server.get('/api/v1/crates', list);

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

return {
Expand All @@ -65,14 +65,14 @@ export function register(server) {
};
});

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

let { crateId } = request.params;
let crate = schema.crates.find(crateId);
let { name } = request.params;
let crate = schema.crates.findBy({ name });
if (!crate) {
return new Response(404, {}, { errors: [{ detail: 'Not Found' }] });
}
Expand All @@ -82,14 +82,14 @@ export function register(server) {
return { following };
});

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

let { crateId } = request.params;
let crate = schema.crates.find(crateId);
let { name } = request.params;
let crate = schema.crates.findBy({ name });
if (!crate) {
return new Response(404, {}, { errors: [{ detail: 'Not Found' }] });
}
Expand All @@ -100,14 +100,14 @@ export function register(server) {
return { ok: true };
});

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

let { crateId } = request.params;
let crate = schema.crates.find(crateId);
let { name } = request.params;
let crate = schema.crates.findBy({ name });
if (!crate) {
return new Response(404, {}, { errors: [{ detail: 'Not Found' }] });
}
Expand All @@ -118,56 +118,56 @@ export function register(server) {
return { ok: true };
});

server.get('/api/v1/crates/:crate_id/versions', (schema, request) => {
let crateId = request.params.crate_id;
let crate = schema.crates.find(crateId);
server.get('/api/v1/crates/:name/versions', (schema, request) => {
let { name } = request.params;
let crate = schema.crates.findBy({ name });
if (!crate) return notFound();

return crate.versions.sort((a, b) => compareIsoDates(b.created_at, a.created_at));
});

server.get('/api/v1/crates/:crate_id/:version_num/authors', (schema, request) => {
let crateId = request.params.crate_id;
let crate = schema.crates.find(crateId);
server.get('/api/v1/crates/:name/:version_num/authors', (schema, request) => {
let { name } = request.params;
let crate = schema.crates.findBy({ name });
if (!crate) return notFound();

let num = request.params.version_num;
let version = schema.versions.findBy({ crateId, num });
if (!version) return { errors: [{ detail: `crate \`${crateId}\` does not have a version \`${num}\`` }] };
let version = schema.versions.findBy({ crateId: crate.id, num });
if (!version) return { errors: [{ detail: `crate \`${crate.name}\` does not have a version \`${num}\`` }] };

return { meta: { names: [] }, users: [] };
});

server.get('/api/v1/crates/:crate_id/:version_num/dependencies', (schema, request) => {
let crateId = request.params.crate_id;
let crate = schema.crates.find(crateId);
server.get('/api/v1/crates/:name/:version_num/dependencies', (schema, request) => {
let { name } = request.params;
let crate = schema.crates.findBy({ name });
if (!crate) return notFound();

let num = request.params.version_num;
let version = schema.versions.findBy({ crateId, num });
if (!version) return { errors: [{ detail: `crate \`${crateId}\` does not have a version \`${num}\`` }] };
let version = schema.versions.findBy({ crateId: crate.id, num });
if (!version) return { errors: [{ detail: `crate \`${crate.name}\` does not have a version \`${num}\`` }] };

return schema.dependencies.where({ versionId: version.id });
});

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

let versionNum = request.params.version_num;
let version = schema.versions.findBy({ crateId, num: versionNum });
if (!version) return { errors: [{ detail: `crate \`${crateId}\` does not have a version \`${versionNum}\`` }] };
let version = schema.versions.findBy({ crateId: crate.id, num: versionNum });
if (!version) return { errors: [{ detail: `crate \`${crate.name}\` does not have a version \`${versionNum}\`` }] };

return schema.versionDownloads.where({ versionId: version.id });
});

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

let ownerships = schema.crateOwnerships.where({ crateId }).filter(it => it.userId).models;
let ownerships = schema.crateOwnerships.where({ crateId: crate.id }).filter(it => it.userId).models;

return {
users: ownerships.map(it => {
Expand All @@ -178,12 +178,12 @@ export function register(server) {
};
});

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

let ownerships = schema.crateOwnerships.where({ crateId }).filter(it => it.teamId).models;
let ownerships = schema.crateOwnerships.where({ crateId: crate.id }).filter(it => it.teamId).models;

return {
teams: ownerships.map(it => {
Expand All @@ -194,14 +194,14 @@ export function register(server) {
};
});

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

let { start, end } = pageParams(request);

let allDependencies = schema.dependencies.where({ crateId: crateId });
let allDependencies = schema.dependencies.where({ crateId: crate.id });
let dependencies = allDependencies.slice(start, end);
let total = allDependencies.length;

Expand All @@ -214,19 +214,19 @@ export function register(server) {
};
});

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

let versionDownloads = schema.versionDownloads.all().filter(it => it.version.crateId === crateId);
let versionDownloads = schema.versionDownloads.all().filter(it => it.version.crateId === crate.id);

return withMeta(this.serialize(versionDownloads), { extra_downloads: crate._extra_downloads });
});

server.put('/api/v1/crates/:crate_id/owners', (schema, request) => {
const crateId = request.params.crate_id;
const crate = schema.crates.find(crateId);
server.put('/api/v1/crates/:name/owners', (schema, request) => {
let { name } = request.params;
let crate = schema.crates.findBy({ name });

if (!crate) {
return notFound();
Expand All @@ -243,9 +243,9 @@ export function register(server) {
return { ok: true };
});

server.delete('/api/v1/crates/:crate_id/owners', (schema, request) => {
const crateId = request.params.crate_id;
const crate = schema.crates.find(crateId);
server.delete('/api/v1/crates/:name/owners', (schema, request) => {
let { name } = request.params;
let crate = schema.crates.findBy({ name });

if (!crate) {
return notFound();
Expand All @@ -262,23 +262,29 @@ export function register(server) {
return { ok: true, msg: 'owners successfully removed' };
});

server.delete('/api/v1/crates/:crate_id/:version/yank', (schema, request) => {
const crateId = request.params.crate_id;
const versionNum = request.params.version;
server.delete('/api/v1/crates/:name/:version/yank', (schema, request) => {
const { name, version: versionNum } = request.params;
const crate = schema.crates.findBy({ name });
if (!crate) {
return notFound();
}

const version = schema.versions.findBy({ crateId, num: versionNum });
const version = schema.versions.findBy({ crateId: crate.id, num: versionNum });
if (!version) {
return notFound();
}

return {};
});

server.put('/api/v1/crates/:crate_id/:version/unyank', (schema, request) => {
const crateId = request.params.crate_id;
const versionNum = request.params.version;
server.put('/api/v1/crates/:name/:version/unyank', (schema, request) => {
const { name, version: versionNum } = request.params;
const crate = schema.crates.findBy({ name });
if (!crate) {
return notFound();
}

const version = schema.versions.findBy({ crateId, num: versionNum });
const version = schema.versions.findBy({ crateId: crate.id, num: versionNum });
if (!version) {
return notFound();
}
Expand Down
14 changes: 8 additions & 6 deletions mirage/serializers/crate.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,11 @@ export default BaseSerializer.extend({

links(crate) {
return {
owner_user: `/api/v1/crates/${crate.id}/owner_user`,
owner_team: `/api/v1/crates/${crate.id}/owner_team`,
reverse_dependencies: `/api/v1/crates/${crate.id}/reverse_dependencies`,
version_downloads: `/api/v1/crates/${crate.id}/downloads`,
versions: `/api/v1/crates/${crate.id}/versions`,
owner_user: `/api/v1/crates/${crate.name}/owner_user`,
owner_team: `/api/v1/crates/${crate.name}/owner_team`,
reverse_dependencies: `/api/v1/crates/${crate.name}/reverse_dependencies`,
version_downloads: `/api/v1/crates/${crate.name}/downloads`,
versions: `/api/v1/crates/${crate.name}/versions`,
};
},

Expand All @@ -52,7 +52,7 @@ export default BaseSerializer.extend({

_adjust(hash) {
let versions = this.schema.versions.where({ crateId: hash.id });
assert(`crate \`${hash.id}\` has no associated versions`, versions.length !== 0);
assert(`crate \`${hash.name}\` has no associated versions`, versions.length !== 0);
versions = versions.filter(it => !it.yanked);

let versionNums = versions.models.map(it => it.num);
Expand All @@ -63,6 +63,8 @@ export default BaseSerializer.extend({
let newestVersions = versions.models.sort((a, b) => compareIsoDates(b.updated_at, a.updated_at));
hash.newest_version = newestVersions[0]?.num ?? '0.0.0';

hash.id = hash.name;

hash.categories = hash.category_ids;
delete hash.category_ids;

Expand Down
22 changes: 22 additions & 0 deletions mirage/serializers/dependency.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
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) {
let crate = this.schema.crates.find(hash.crate_id);
hash.crate_id = crate.name;
},
});
10 changes: 6 additions & 4 deletions mirage/serializers/version.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ export default BaseSerializer.extend({

links(version) {
return {
dependencies: `/api/v1/crates/${version.crateId}/${version.num}/dependencies`,
version_downloads: `/api/v1/crates/${version.crateId}/${version.num}/downloads`,
dependencies: `/api/v1/crates/${version.crate.name}/${version.num}/dependencies`,
version_downloads: `/api/v1/crates/${version.crate.name}/${version.num}/downloads`,
};
},

Expand All @@ -43,8 +43,10 @@ export default BaseSerializer.extend({
},

_adjust(hash, includes) {
hash.dl_path = `/api/v1/crates/${hash.crate_id}/${hash.num}/download`;
hash.crate = hash.crate_id;
let crate = this.schema.crates.find(hash.crate_id);

hash.dl_path = `/api/v1/crates/${crate.name}/${hash.num}/download`;
hash.crate = crate.name;

if (hash.published_by_id) {
let user = includes.find(it => it.modelName === 'user' && it.id === hash.published_by_id);
Expand Down
Loading