From 339991bfc382af3a6bbee453fde2ce74b7301026 Mon Sep 17 00:00:00 2001 From: "Carol (Nichols || Goulding)" Date: Thu, 18 Dec 2025 16:06:59 -0500 Subject: [PATCH] Add a link to browse crate source on docs.rs Don't show the link if there aren't any docs.rs builds as clicking on the link won't work then, but do still show the source link even if a non-docs.rs documentation link has been specified to enable review of the source exactly as crates.io serves it. --- app/components/crate-sidebar.gjs | 6 +- app/models/version.js | 26 +++- e2e/routes/crate/version/source-link.spec.ts | 113 ++++++++++++++++++ .../routes/crate/version/source-link-test.js | 87 ++++++++++++++ 4 files changed, 229 insertions(+), 3 deletions(-) create mode 100644 e2e/routes/crate/version/source-link.spec.ts create mode 100644 tests/routes/crate/version/source-link-test.js diff --git a/app/components/crate-sidebar.gjs b/app/components/crate-sidebar.gjs index 5de1723a116..2f691091bc0 100644 --- a/app/components/crate-sidebar.gjs +++ b/app/components/crate-sidebar.gjs @@ -162,7 +162,7 @@ export default class CrateSidebar extends Component { {{/unless}} - {{#if (or this.showHomepage @version.documentationLink @crate.repository)}} + {{#if (or this.showHomepage @version.documentationLink @version.sourceLink @crate.repository)}}
{{#if this.showHomepage}} @@ -172,6 +172,10 @@ export default class CrateSidebar extends Component { {{/if}} + {{#if @version.sourceLink}} + + {{/if}} + {{#if @crate.repository}} {{/if}} diff --git a/app/models/version.js b/app/models/version.js index 29ca11b2177..05d4f6240f2 100644 --- a/app/models/version.js +++ b/app/models/version.js @@ -195,9 +195,12 @@ export default class Version extends Model { return await ajax(`https://docs.rs/crate/${this.crateName}/=${this.num}/status.json`); }); + get docsRsResponse() { + return this.loadDocsStatusTask.lastSuccessful; + } + get hasDocsRsLink() { - let docsStatus = this.loadDocsStatusTask.lastSuccessful?.value; - return docsStatus?.doc_status === true; + return this.docsRsResponse?.value?.doc_status === true; } get docsRsLink() { @@ -228,6 +231,25 @@ export default class Version extends Model { return null; } + get docsRsSourceLink() { + if (this.docsRsResponse) { + return `https://docs.rs/crate/${this.crateName}/${this.num}/source/`; + } + } + + get sourceLink() { + // Return a link to docs.rs if we get any successful response from docs.rs, so that we show + // the source link regardless of this crate being a library or binary, regardless of whether + // the docs built successfully, regardless of whether the build is queued or completed, and + // regardless of whether a documentation link is specified. + let { docsRsSourceLink } = this; + if (docsRsSourceLink) { + return docsRsSourceLink; + } + + return null; + } + yankTask = keepLatestTask(async () => { let data = { version: { yanked: true } }; let payload = await waitForPromise(apiAction(this, { method: 'PATCH', data })); diff --git a/e2e/routes/crate/version/source-link.spec.ts b/e2e/routes/crate/version/source-link.spec.ts new file mode 100644 index 00000000000..c636e661bcd --- /dev/null +++ b/e2e/routes/crate/version/source-link.spec.ts @@ -0,0 +1,113 @@ +import { expect, test } from '@/e2e/helper'; +import { http, HttpResponse } from 'msw'; + +test.describe('Route | crate.version | source link', { tag: '@routes' }, () => { + test('show docs.rs source link even if non-docs.rs documentation link is specified', async ({ page, msw }) => { + let crate = await msw.db.crate.create({ name: 'foo', documentation: 'https://foo.io/docs' }); + await msw.db.version.create({ crate, num: '1.0.0' }); + + let response = HttpResponse.json({ + doc_status: false, + version: '1.0.0', + }); + msw.worker.use(http.get('https://docs.rs/crate/:crate/:version/status.json', () => response)); + + await page.goto('/crates/foo'); + await expect(page.locator('[data-test-source-link] a')).toHaveAttribute( + 'href', + 'https://docs.rs/crate/foo/1.0.0/source/', + ); + }); + + test('show no source link if there are no related docs.rs builds', async ({ page, msw }) => { + let crate = await msw.db.crate.create({ name: 'foo' }); + await msw.db.version.create({ crate, num: '1.0.0' }); + + let error = HttpResponse.text('not found', { status: 404 }); + msw.worker.use(http.get('https://docs.rs/crate/:crate/:version/status.json', () => error)); + + await page.goto('/crates/foo'); + await expect(page.getByRole('link', { name: 'crates.io', exact: true })).toHaveCount(1); + + await expect(page.locator('[data-test-source-link] a')).toHaveCount(0); + }); + + test('show source link if `documentation` is unspecified and there are related docs.rs builds', async ({ + page, + msw, + }) => { + let crate = await msw.db.crate.create({ name: 'foo' }); + await msw.db.version.create({ crate, num: '1.0.0' }); + + let response = HttpResponse.json({ + doc_status: true, + version: '1.0.0', + }); + msw.worker.use(http.get('https://docs.rs/crate/:crate/:version/status.json', () => response)); + + await page.goto('/crates/foo'); + await expect(page.locator('[data-test-source-link] a')).toHaveAttribute( + 'href', + 'https://docs.rs/crate/foo/1.0.0/source/', + ); + }); + + test('show no source link if `documentation` points to docs.rs and there are no related docs.rs builds', async ({ + page, + msw, + }) => { + let crate = await msw.db.crate.create({ name: 'foo', documentation: 'https://docs.rs/foo/0.6.2' }); + await msw.db.version.create({ crate, num: '1.0.0' }); + + let error = HttpResponse.text('not found', { status: 404 }); + msw.worker.use(http.get('https://docs.rs/crate/:crate/:version/status.json', () => error)); + + await page.goto('/crates/foo'); + await expect(page.locator('[data-test-source-link] a')).toHaveCount(0); + }); + + test('show source link if `documentation` points to docs.rs and there are related docs.rs builds', async ({ + page, + msw, + }) => { + let crate = await msw.db.crate.create({ name: 'foo', documentation: 'https://docs.rs/foo/0.6.2' }); + await msw.db.version.create({ crate, num: '1.0.0' }); + + let response = HttpResponse.json({ + doc_status: true, + version: '1.0.0', + }); + msw.worker.use(http.get('https://docs.rs/crate/:crate/:version/status.json', () => response)); + + await page.goto('/crates/foo'); + await expect(page.locator('[data-test-source-link] a')).toHaveAttribute( + 'href', + 'https://docs.rs/crate/foo/1.0.0/source/', + ); + }); + + test('ajax errors are ignored, but show no source link', async ({ page, msw }) => { + let crate = await msw.db.crate.create({ name: 'foo', documentation: 'https://docs.rs/foo/0.6.2' }); + await msw.db.version.create({ crate, num: '1.0.0' }); + + let error = HttpResponse.text('error', { status: 500 }); + msw.worker.use(http.get('https://docs.rs/crate/:crate/:version/status.json', () => error)); + + await page.goto('/crates/foo'); + await expect(page.locator('[data-test-source-link] a')).toHaveCount(0); + }); + + test('empty docs.rs responses are ignored, still show source link', async ({ page, msw }) => { + let crate = await msw.db.crate.create({ name: 'foo', documentation: 'https://docs.rs/foo/0.6.2' }); + await msw.db.version.create({ crate, num: '0.6.2' }); + + let response = HttpResponse.json({}); + msw.worker.use(http.get('https://docs.rs/crate/:crate/:version/status.json', () => response)); + + await page.goto('/crates/foo'); + await expect(page.locator('[data-test-source-link] a')).toHaveAttribute( + 'href', + 'https://docs.rs/crate/foo/0.6.2/source/', + ); + }); +}); diff --git a/tests/routes/crate/version/source-link-test.js b/tests/routes/crate/version/source-link-test.js new file mode 100644 index 00000000000..d1f631c0eb7 --- /dev/null +++ b/tests/routes/crate/version/source-link-test.js @@ -0,0 +1,87 @@ +import { visit } from '@ember/test-helpers'; +import { module, test } from 'qunit'; + +import { http, HttpResponse } from 'msw'; + +import { setupApplicationTest } from 'crates-io/tests/helpers'; + +module('Route | crate.version | source link', function (hooks) { + setupApplicationTest(hooks); + + test('shows docs.rs source link even if non-docs.rs documentation link is specified', async function (assert) { + let crate = await this.db.crate.create({ name: 'foo', documentation: 'https://foo.io/docs' }); + await this.db.version.create({ crate, num: '1.0.0' }); + + let response = HttpResponse.json({ doc_status: false, version: '1.0.0' }); + this.worker.use(http.get('https://docs.rs/crate/:crate/:version/status.json', () => response)); + + await visit('/crates/foo'); + assert.dom('[data-test-source-link] a').hasAttribute('href', 'https://docs.rs/crate/foo/1.0.0/source/'); + }); + + test('show no source link if there are no related docs.rs builds', async function (assert) { + let crate = await this.db.crate.create({ name: 'foo' }); + await this.db.version.create({ crate, num: '1.0.0' }); + + let error = HttpResponse.text('not found', { status: 404 }); + this.worker.use(http.get('https://docs.rs/crate/:crate/:version/status.json', () => error)); + + await visit('/crates/foo'); + assert.dom('[data-test-source-link] a').doesNotExist(); + }); + + test('show source link if `documentation` is unspecified and there are related docs.rs builds', async function (assert) { + let crate = await this.db.crate.create({ name: 'foo' }); + await this.db.version.create({ crate, num: '1.0.0' }); + + let response = HttpResponse.json({ doc_status: true, version: '1.0.0' }); + this.worker.use(http.get('https://docs.rs/crate/:crate/:version/status.json', () => response)); + + await visit('/crates/foo'); + assert.dom('[data-test-source-link] a').hasAttribute('href', 'https://docs.rs/crate/foo/1.0.0/source/'); + }); + + test('show no source link if `documentation` points to docs.rs and there are no related docs.rs builds', async function (assert) { + let crate = await this.db.crate.create({ name: 'foo', documentation: 'https://docs.rs/foo/0.6.2' }); + await this.db.version.create({ crate, num: '1.0.0' }); + + let error = HttpResponse.text('not found', { status: 404 }); + this.worker.use(http.get('https://docs.rs/crate/:crate/:version/status.json', () => error)); + + await visit('/crates/foo'); + assert.dom('[data-test-source-link] a').doesNotExist(); + }); + + test('show source link if `documentation` points to docs.rs and there is a successful docs.rs response', async function (assert) { + let crate = await this.db.crate.create({ name: 'foo', documentation: 'https://docs.rs/foo/0.6.2' }); + await this.db.version.create({ crate, num: '1.0.0' }); + + let response = HttpResponse.json({ doc_status: false, version: '1.0.0' }); + this.worker.use(http.get('https://docs.rs/crate/:crate/:version/status.json', () => response)); + + await visit('/crates/foo'); + assert.dom('[data-test-source-link] a').hasAttribute('href', 'https://docs.rs/crate/foo/1.0.0/source/'); + }); + + test('ajax errors are ignored, but show no source link', async function (assert) { + let crate = await this.db.crate.create({ name: 'foo', documentation: 'https://docs.rs/foo/0.6.2' }); + await this.db.version.create({ crate, num: '1.0.0' }); + + let error = HttpResponse.text('error', { status: 500 }); + this.worker.use(http.get('https://docs.rs/crate/:crate/:version/status.json', () => error)); + + await visit('/crates/foo'); + assert.dom('[data-test-source-link] a').doesNotExist(); + }); + + test('empty docs.rs responses are ignored, still show source link', async function (assert) { + let crate = await this.db.crate.create({ name: 'foo', documentation: 'https://docs.rs/foo/0.6.2' }); + await this.db.version.create({ crate, num: '0.6.2' }); + + let response = HttpResponse.json({}); + this.worker.use(http.get('https://docs.rs/crate/:crate/:version/status.json', () => response)); + + await visit('/crates/foo'); + assert.dom('[data-test-source-link] a').hasAttribute('href', 'https://docs.rs/crate/foo/0.6.2/source/'); + }); +});