From 88b5fcd6e19c2de681eea40b8fa4bbfe033b9c4a Mon Sep 17 00:00:00 2001 From: Jordan Doyle Date: Thu, 16 Sep 2021 02:53:28 +0100 Subject: [PATCH] Read more data from publish metadata --- chartered-db/src/crates.rs | 41 +++++++++++++++++++++++++++++++++++------ chartered-db/src/schema.rs | 5 +++++ chartered-frontend/src/index.sass | 1 + chartered-git/src/main.rs | 2 +- chartered-types/src/cargo.rs | 9 +++++++++ migrations/2021-08-31-214501_create_crates_table/up.sql | 5 +++++ chartered-frontend/src/pages/SingleCrate.tsx | 288 ++++++++++++++++++++++++++++++++++++++++++-------------------------------------- chartered-web/src/endpoints/cargo_api/publish.rs | 13 +++---------- chartered-web/src/endpoints/web_api/crate_info.rs | 17 ++++++++++++++--- 9 files changed, 174 insertions(+), 207 deletions(-) diff --git a/chartered-db/src/crates.rs b/chartered-db/src/crates.rs index aa29fe9..5cf0abd 100644 --- a/chartered-db/src/crates.rs +++ a/chartered-db/src/crates.rs @@ -21,6 +21,14 @@ pub version: String, pub filesystem_object: String, pub yanked: bool, + // TODO: readme should be versioned in the db so we can just pass a reference rather + // than this massive blob for each version - or just update the readme for the whole + // crate and don't version it at all? we also need tags, etc too in a pivot table + pub readme: Option, + pub description: Option, + pub repository: Option, + pub homepage: Option, + pub documentation: Option, pub checksum: String, pub dependencies: CrateDependencies<'a>, pub features: CrateFeatures, @@ -29,14 +37,23 @@ impl<'a> CrateVersion<'a> { #[must_use] - pub fn into_cargo_format(self, crate_: &'a Crate) -> chartered_types::cargo::CrateVersion<'a> { - chartered_types::cargo::CrateVersion { - name: crate_.name.as_str().into(), - vers: self.version.into(), - deps: self.dependencies.0, - features: self.features.0, - links: self.links.map(Into::into), - } + pub fn into_cargo_format(self, crate_: &'a Crate) -> (chartered_types::cargo::CrateVersion<'a>, chartered_types::cargo::CrateVersionMetadata) { + ( + chartered_types::cargo::CrateVersion { + name: crate_.name.as_str().into(), + vers: self.version.into(), + deps: self.dependencies.0, + features: self.features.0, + links: self.links.map(Into::into), + }, + chartered_types::cargo::CrateVersionMetadata { + description: self.description, + readme: self.readme, + repository: self.repository, + homepage: self.homepage, + documentation: self.documentation, + } + ) } } @@ -163,10 +180,11 @@ file_identifier: chartered_fs::FileReference, file_checksum: String, given: chartered_types::cargo::CrateVersion<'static>, + metadata: chartered_types::cargo::CrateVersionMetadata, ) -> Result<()> { use crate::schema::crate_versions::dsl::{ checksum, crate_id, crate_versions, dependencies, features, filesystem_object, links, - version, + version, description, readme, repository, homepage, documentation, }; tokio::task::spawn_blocking(move || { @@ -181,6 +199,11 @@ dependencies.eq(CrateDependencies(given.deps)), features.eq(CrateFeatures(given.features)), links.eq(given.links), + description.eq(metadata.description), + readme.eq(metadata.readme), + repository.eq(metadata.repository), + homepage.eq(metadata.homepage), + documentation.eq(metadata.documentation), )) .execute(&conn)?; diff --git a/chartered-db/src/schema.rs b/chartered-db/src/schema.rs index 8657413..a80feeb 100644 --- a/chartered-db/src/schema.rs +++ a/chartered-db/src/schema.rs @@ -5,6 +5,11 @@ version -> Text, filesystem_object -> Text, yanked -> Bool, + readme -> Nullable, + description -> Nullable, + repository -> Nullable, + homepage -> Nullable, + documentation -> Nullable, checksum -> Text, dependencies -> Binary, features -> Binary, diff --git a/chartered-frontend/src/index.sass b/chartered-frontend/src/index.sass index 7238dad..24de3bd 100644 --- a/chartered-frontend/src/index.sass +++ a/chartered-frontend/src/index.sass @@ -1,5 +1,6 @@ $primary: #0d6efd $font-family-monospace: "Source Code Pro", SFMono-Regular, Menlo, Monaco, Consolas, "Liberation Mono", "Courier New", monospace +$enable-cssgrid: true @import "~bootstrap/scss/bootstrap.scss" @import "../node_modules/source-code-pro/source-code-pro.css" diff --git a/chartered-git/src/main.rs b/chartered-git/src/main.rs index 966f915..17c0862 100644 --- a/chartered-git/src/main.rs +++ a/chartered-git/src/main.rs @@ -365,7 +365,7 @@ for version in versions { let cksum = version.checksum.clone(); let yanked = version.yanked; - let version = version.into_cargo_format(&crate_def); + let (version, _) = version.into_cargo_format(&crate_def); let entry = CrateFileEntry { inner: &version, diff --git a/chartered-types/src/cargo.rs b/chartered-types/src/cargo.rs index 52e9148..820ca5f 100644 --- a/chartered-types/src/cargo.rs +++ a/chartered-types/src/cargo.rs @@ -29,6 +29,15 @@ } #[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq)] +pub struct CrateVersionMetadata { + pub description: Option, + pub readme: Option, + pub repository: Option, + pub homepage: Option, + pub documentation: Option, +} + +#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq)] pub struct CrateDependency<'a> { pub name: Cow<'a, str>, pub version_req: Cow<'a, str>, // needs to be: https://github.com/steveklabnik/semver#requirements diff --git a/migrations/2021-08-31-214501_create_crates_table/up.sql b/migrations/2021-08-31-214501_create_crates_table/up.sql index 57c59ca..b394131 100644 --- a/migrations/2021-08-31-214501_create_crates_table/up.sql +++ a/migrations/2021-08-31-214501_create_crates_table/up.sql @@ -9,6 +9,11 @@ version VARCHAR(255) NOT NULL, filesystem_object VARCHAR(255) NOT NULL, yanked BOOLEAN NOT NULL DEFAULT FALSE, + readme TEXT, + description VARCHAR(255), + repository VARCHAR(255), + homepage VARCHAR(255), + documentation VARCHAR(255), checksum VARCHAR(255) NOT NULL, dependencies BLOB NOT NULL, features BLOB NOT NULL, diff --git a/chartered-frontend/src/pages/SingleCrate.tsx b/chartered-frontend/src/pages/SingleCrate.tsx index baa128f..6beb4d2 100644 --- a/chartered-frontend/src/pages/SingleCrate.tsx +++ a/chartered-frontend/src/pages/SingleCrate.tsx @@ -5,7 +5,7 @@ import { Link } from "react-router-dom"; import { useAuth } from '../useAuth'; import Nav from "../sections/Nav"; -import { Box } from 'react-bootstrap-icons'; +import { Box, HouseDoor, Book, Building, PersonPlus } from 'react-bootstrap-icons'; import { useParams } from "react-router-dom"; import { authenticatedEndpoint } from '../util'; @@ -13,11 +13,14 @@ import ReactMarkdown from 'react-markdown'; import remarkGfm from 'remark-gfm'; +type Tab = 'readme' | 'versions' | 'members'; + export default function SingleCrate() { const auth = useAuth(); const { crate } = useParams(); const [crateInfo, setCrateInfo] = useState(null); + const [currentTab, setCurrentTab] = useState('readme'); useEffect(async () => { let res = await fetch(authenticatedEndpoint(auth, `crates/${crate}`)); @@ -30,167 +33,7 @@ } const crateVersion = crateInfo.versions[crateInfo.versions.length - 1]; - - const readme = ` -# Rand - -[![Test Status](https://github.com/rust-random/rand/workflows/Tests/badge.svg?event=push)](https://github.com/rust-random/rand/actions) -[![Crate](https://img.shields.io/crates/v/rand.svg)](https://crates.io/crates/rand) -[![Book](https://img.shields.io/badge/book-master-yellow.svg)](https://rust-random.github.io/book/) -[![API](https://img.shields.io/badge/api-master-yellow.svg)](https://rust-random.github.io/rand/rand) -[![API](https://docs.rs/rand/badge.svg)](https://docs.rs/rand) -[![Minimum rustc version](https://img.shields.io/badge/rustc-1.36+-lightgray.svg)](https://github.com/rust-random/rand#rust-version-requirements) - -A Rust library for random number generation, featuring: - -- Easy random value generation and usage via the [\`Rng\`](https://docs.rs/rand/*/rand/trait.Rng.html), - [\`SliceRandom\`](https://docs.rs/rand/*/rand/seq/trait.SliceRandom.html) and - [\`IteratorRandom\`](https://docs.rs/rand/*/rand/seq/trait.IteratorRandom.html) traits -- Secure seeding via the [\`getrandom\` crate](https://crates.io/crates/getrandom) - and fast, convenient generation via [\`thread_rng\`](https://docs.rs/rand/*/rand/fn.thread_rng.html) -- A modular design built over [\`rand_core\`](https://crates.io/crates/rand_core) - ([see the book](https://rust-random.github.io/book/crates.html)) -- Fast implementations of the best-in-class [cryptographic](https://rust-random.github.io/book/guide-rngs.html#cryptographically-secure-pseudo-random-number-generators-csprngs) and - [non-cryptographic](https://rust-random.github.io/book/guide-rngs.html#basic-pseudo-random-number-generators-prngs) generators -- A flexible [\`distributions\`](https://docs.rs/rand/*/rand/distributions/index.html) module -- Samplers for a large number of random number distributions via our own - [\`rand_distr\`](https://docs.rs/rand_distr) and via - the [\`statrs\`](https://docs.rs/statrs/0.13.0/statrs/) -- [Portably reproducible output](https://rust-random.github.io/book/portability.html) -- \`#[no_std]\` compatibility (partial) -- *Many* performance optimisations - -It's also worth pointing out what \`rand\` *is not*: - -- Small. Most low-level crates are small, but the higher-level \`rand\` and - \`rand_distr\` each contain a lot of functionality. -- Simple (implementation). We have a strong focus on correctness, speed and flexibility, but - not simplicity. If you prefer a small-and-simple library, there are - alternatives including [fastrand](https://crates.io/crates/fastrand) - and [oorandom](https://crates.io/crates/oorandom). -- Slow. We take performance seriously, with considerations also for set-up - time of new distributions, commonly-used parameters, and parameters of the - current sampler. - -Documentation: - -- [The Rust Rand Book](https://rust-random.github.io/book) -- [API reference (master branch)](https://rust-random.github.io/rand) -- [API reference (docs.rs)](https://docs.rs/rand) - - -## Usage - -Add this to your \`Cargo.toml\`: - -\`\`\`toml -[dependencies] -rand = "0.8.0" -\`\`\` - -To get started using Rand, see [The Book](https://rust-random.github.io/book). - - -## Versions - -Rand is *mature* (suitable for general usage, with infrequent breaking releases -which minimise breakage) but not yet at 1.0. We maintain compatibility with -pinned versions of the Rust compiler (see below). - -Current Rand versions are: - -- Version 0.7 was released in June 2019, moving most non-uniform distributions - to an external crate, moving \`from_entropy\` to \`SeedableRng\`, and many small - changes and fixes. -- Version 0.8 was released in December 2020 with many small changes. - -A detailed [changelog](CHANGELOG.md) is available for releases. - -When upgrading to the next minor series (especially 0.4 → 0.5), we recommend -reading the [Upgrade Guide](https://rust-random.github.io/book/update.html). - -Rand has not yet reached 1.0 implying some breaking changes may arrive in the -future ([SemVer](https://semver.org/) allows each 0.x.0 release to include -breaking changes), but is considered *mature*: breaking changes are minimised -and breaking releases are infrequent. - -Rand libs have inter-dependencies and make use of the -[semver trick](https://github.com/dtolnay/semver-trick/) in order to make traits -compatible across crate versions. (This is especially important for \`RngCore\` -and \`SeedableRng\`.) A few crate releases are thus compatibility shims, -depending on the *next* lib version (e.g. \`rand_core\` versions \`0.2.2\` and -\`0.3.1\`). This means, for example, that \`rand_core_0_4_0::SeedableRng\` and -\`rand_core_0_3_0::SeedableRng\` are distinct, incompatible traits, which can -cause build errors. Usually, running \`cargo update\` is enough to fix any issues. - -### Yanked versions - -Some versions of Rand crates have been yanked ("unreleased"). Where this occurs, -the crate's CHANGELOG *should* be updated with a rationale, and a search on the -issue tracker with the keyword \`yank\` *should* uncover the motivation. - -### Rust version requirements - -Since version 0.8, Rand requires **Rustc version 1.36 or greater**. -Rand 0.7 requires Rustc 1.32 or greater while versions 0.5 require Rustc 1.22 or -greater, and 0.4 and 0.3 (since approx. June 2017) require Rustc version 1.15 or -greater. Subsets of the Rand code may work with older Rust versions, but this is -not supported. - -Continuous Integration (CI) will always test the minimum supported Rustc version -(the MSRV). The current policy is that this can be updated in any -Rand release if required, but the change must be noted in the changelog. - -## Crate Features - -Rand is built with these features enabled by default: - -- \`std\` enables functionality dependent on the \`std\` lib -- \`alloc\` (implied by \`std\`) enables functionality requiring an allocator -- \`getrandom\` (implied by \`std\`) is an optional dependency providing the code - behind \`rngs::OsRng\` -- \`std_rng\` enables inclusion of \`StdRng\`, \`thread_rng\` and \`random\` - (the latter two *also* require that \`std\` be enabled) - -Optionally, the following dependencies can be enabled: -- \`log\` enables logging via the \`log\` crate\` crate - -Additionally, these features configure Rand: - -- \`small_rng\` enables inclusion of the \`SmallRng\` PRNG -- \`nightly\` enables some optimizations requiring nightly Rust -- \`simd_support\` (experimental) enables sampling of SIMD values - (uniformly random SIMD integers and floats), requiring nightly Rust -- \`min_const_gen\` enables generating random arrays of - any size using min-const-generics, requiring Rust ≥ 1.51. - -Note that nightly features are not stable and therefore not all library and -compiler versions will be compatible. This is especially true of Rand's -experimental \`simd_support\` feature. - -Rand supports limited functionality in \`no_std\` mode (enabled via -\`default-features = false\`). In this case, \`OsRng\` and \`from_entropy\` are -unavailable (unless \`getrandom\` is enabled), large parts of \`seq\` are -unavailable (unless \`alloc\` is enabled), and \`thread_rng\` and \`random\` are -unavailable. - -### WASM support - -The WASM target \`wasm32-unknown-unknown\` is not *automatically* supported by -\`rand\` or \`getrandom\`. To solve this, either use a different target such as -\`wasm32-wasi\` or add a direct dependency on \`getrandom\` with the \`js\` feature -(if the target supports JavaScript). See -[getrandom#WebAssembly support](https://docs.rs/getrandom/latest/getrandom/#webassembly-support). - -# License - -Rand is distributed under the terms of both the MIT license and the -Apache License (Version 2.0). - -See [LICENSE-APACHE](LICENSE-APACHE) and [LICENSE-MIT](LICENSE-MIT), and -[COPYRIGHT](COPYRIGHT) for details.`; - return (
-

Random number generators and other randomness functionality.

+

{crateVersion.description}

@@ -217,7 +60,9 @@ @@ -229,35 +74,31 @@
- - ) : ( - - {children} - - ) - } - }} /> + {currentTab == 'readme' ? : <>} + {currentTab == 'versions' ? <>Versions : <>} + {currentTab == 'members' ? : <>}
@@ -270,7 +111,7 @@
    {crateVersion.deps.map(dep => ( -
  • {dep.name} = "{dep.version_req}"
    • +
  • {dep.name} = "{dep.version_req}"
    • ))}
@@ -290,5 +131,84 @@ + ); +} + +function ReadMe(props: { crateInfo: any }) { + return ( + + ) : ( + + {children} + + ) + } + }} /> ); } + +function Members(props: { crateInfo: any }) { + return
+
+ + +
+ Johnny Davidson (that's you!)
+ Owner +
+
+ +
+ + +
+ Will Woodwood
+ +
+
+ +
+ + +
+ Ben Dover
+ +
+
+ +
+ + +
+ Eline Dover
+ +
+
+ +
+ +
+
; +}diff --git a/chartered-web/src/endpoints/cargo_api/publish.rs b/chartered-web/src/endpoints/cargo_api/publish.rs index 4b274d7..845ebf8 100644 --- a/chartered-web/src/endpoints/cargo_api/publish.rs +++ a/chartered-web/src/endpoints/cargo_api/publish.rs @@ -79,6 +79,7 @@ file_ref, hex::encode(Sha256::digest(crate_bytes)), metadata.inner.into_owned(), + metadata.meta, ) .await?; @@ -106,14 +107,6 @@ #[serde(borrow)] authors: Vec>, #[serde(borrow)] - description: Option>, - #[serde(borrow)] - documentation: Option>, - #[serde(borrow)] - homepage: Option>, - #[serde(borrow)] - readme: Option>, - #[serde(borrow)] readme_file: Option>, #[serde(borrow)] keywords: Vec>, @@ -123,8 +116,8 @@ license: Option>, #[serde(borrow)] license_file: Option>, - #[serde(borrow)] - repository: Option>, + #[serde(flatten)] + meta: chartered_types::cargo::CrateVersionMetadata, #[serde(flatten)] inner: chartered_types::cargo::CrateVersion<'a>, } diff --git a/chartered-web/src/endpoints/web_api/crate_info.rs b/chartered-web/src/endpoints/web_api/crate_info.rs index 5242483..8933fe0 100644 --- a/chartered-web/src/endpoints/web_api/crate_info.rs +++ a/chartered-web/src/endpoints/web_api/crate_info.rs @@ -1,10 +1,10 @@ use axum::{extract, Json}; use chartered_db::{ crates::Crate, users::{User, UserCratePermissionValue as Permission}, ConnectionPool, }; -use chartered_types::cargo::CrateVersion; +use chartered_types::cargo::{CrateVersion, CrateVersionMetadata}; use serde::Serialize; use std::sync::Arc; use thiserror::Error; @@ -48,12 +48,23 @@ Ok(Json(Response { versions: versions .into_iter() - .map(|v| v.into_cargo_format(&crate_).into_owned()) + .map(|v| { + let (inner, meta) = v.into_cargo_format(&crate_); + ResponseVersion { inner: inner.into_owned(), meta } + }) .collect(), })) } #[derive(Serialize)] +pub struct ResponseVersion { + #[serde(flatten)] + meta: CrateVersionMetadata, + #[serde(flatten)] + inner: CrateVersion<'static>, +} + +#[derive(Serialize)] pub struct Response { - versions: Vec>, + versions: Vec, } -- rgit 0.1.3