Skip to content

Move docs.rs link code from controller to version model #3216

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 3 commits into from
Feb 1, 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
30 changes: 0 additions & 30 deletions app/controllers/crate/version.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ import { inject as service } from '@ember/service';
import { task } from 'ember-concurrency';
import moment from 'moment';

import ajax from '../../utils/ajax';

const NUM_VERSIONS = 5;

export default class CrateVersionController extends Controller {
Expand Down Expand Up @@ -125,32 +123,4 @@ export default class CrateVersionController extends Controller {
return readme;
})
loadReadmeTask;

@computed('crate.{documentation,name}', 'currentVersion.num', 'loadDocsBuildsTask.lastSuccessful.value')
get documentationLink() {
// if this is *not* a docs.rs link we'll return it directly
if (this.crate.documentation && !this.crate.documentation.startsWith('https://docs.rs/')) {
return this.crate.documentation;
}

// if we know about a successful docs.rs build, we'll return a link to that
if (this.loadDocsBuildsTask.lastSuccessful) {
let docsBuilds = this.loadDocsBuildsTask.lastSuccessful.value;
if (docsBuilds.length !== 0 && docsBuilds[0].build_status === true) {
return `https://docs.rs/${this.crate.name}/${this.currentVersion.num}`;
}
}

// finally, we'll return the specified documentation link, whatever it is
if (this.crate.documentation) {
return this.crate.documentation;
}

return null;
}

@task(function* () {
return yield ajax(`https://docs.rs/crate/${this.crate.name}/${this.currentVersion.num}/builds.json`);
})
loadDocsBuildsTask;
}
41 changes: 41 additions & 0 deletions app/models/version.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ import { alias } from '@ember/object/computed';

import { task } from 'ember-concurrency';

import ajax from '../utils/ajax';

export default class Version extends Model {
@attr num;
@attr dl_path;
Expand Down Expand Up @@ -63,6 +65,45 @@ export default class Version extends Model {
}).keepLatest())
loadReadmeTask;

@task(function* () {
return yield ajax(`https://docs.rs/crate/${this.crateName}/${this.num}/builds.json`);
})
loadDocsBuildsTask;

@computed('loadDocsBuildsTask.lastSuccessful.value')
get hasDocsRsLink() {
let docsBuilds = this.loadDocsBuildsTask.lastSuccessful?.value;
return docsBuilds && docsBuilds.length !== 0 && docsBuilds[0].build_status === true;
}

get docsRsLink() {
if (this.hasDocsRsLink) {
return `https://docs.rs/${this.crateName}/${this.num}`;
}
}

get documentationLink() {
let crateDocsLink = this.crate.documentation;

// if this is *not* a docs.rs link we'll return it directly
if (crateDocsLink && !crateDocsLink.startsWith('https://docs.rs/')) {
return crateDocsLink;
}

// if we know about a successful docs.rs build, we'll return a link to that
let { docsRsLink } = this;
if (docsRsLink) {
return docsRsLink;
}

// finally, we'll return the specified documentation link, whatever it is
if (crateDocsLink) {
return crateDocsLink;
}

return null;
}

@(task(function* () {
let response = yield fetch(`/api/v1/crates/${this.crate.id}/${this.num}/yank`, { method: 'DELETE' });
if (!response.ok) {
Expand Down
4 changes: 2 additions & 2 deletions app/routes/crate/version.js
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,9 @@ export default class VersionRoute extends Route {
// ignored
});

let { crate } = model;
let { crate, version } = model;
if (!crate.documentation || crate.documentation.startsWith('https://docs.rs/')) {
controller.loadDocsBuildsTask.perform().catch(error => {
version.loadDocsBuildsTask.perform().catch(error => {
// report unexpected errors to Sentry and ignore `ajax()` errors
if (!(error instanceof AjaxError)) {
Sentry.captureException(error);
Expand Down
4 changes: 2 additions & 2 deletions app/templates/crate/version.hbs
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@
{{#if this.crate.mailing_list}}
<li><a href="{{this.crate.mailing_list}}">Mailing list</a></li>
{{/if}}
{{#if this.documentationLink}}
<li><a href="{{this.documentationLink}}" data-test-docs-link>Documentation</a></li>
{{#if this.currentVersion.documentationLink}}
<li><a href="{{this.currentVersion.documentationLink}}" data-test-docs-link>Documentation</a></li>
{{/if}}
{{#if this.crate.repository}}
<li><a href="{{this.crate.repository}}">Repository</a></li>
Expand Down