~ knotless Search/
↑↓ move↵ open⇧↵ all results

chadtmiller.com/knotless

git that lives in your Atmosphere account

knotless.dev
1 collaborator

knotless 0.17.0 Latest 2 packages, 1 image

1
10

knotless-serve answers Maven's repository layout for a repository's artifacts

Merged chadtmiller.com asked to merge into main from chadtmiller.com/knotless:serve/maven-registry
.changeset/maven-repository.mdnew+7−0
@@ -0,0 +1,7 @@
---
default: minor
---
# A repository's Maven artifacts can be published and resolved with Gradle
knotless-serve answers Maven's repository layout for each repository at `https://knotless.dev/maven/<did>/<repo key>/`, so Gradle's `maven-publish`, with your handle and an app password as its credentials, publishes an Android or Java library there, and a build that names the repository resolves it. A version is published once, snapshots are refused, and `knotless release yank` takes a version out of `maven-metadata.xml`.
crates/knotless/src/records.rs+22−0
@@ -1050,6 +1050,9 @@ pub struct ReleaseRecord {
/// package.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub swift: Option<SwiftPackage>,
/// What a Maven repository says of it, if it is a Maven artifact.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub maven: Option<MavenArtifact>,
/// Whether its owner yanked it: read from its
/// [`nsid::RELEASE_YANK`] record, and no part of this one.
#[serde(skip)]
@@ -1096,6 +1099,25 @@ pub struct SwiftManifest {
pub content: String,
}
/// A release as a Maven artifact's version: its files are those
/// `<artifact>-<version>[-<classifier>].<extension>` of its version's
/// directory, and its package's name is `<group>.<artifact>`.
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq)]
pub struct MavenArtifact {
pub group: String,
pub artifact: String,
/// Each file's other hashes, which Maven's clients read beside it.
pub hashes: Vec<MavenHashes>,
}
/// A file's SHA-1 and SHA-512, in lowercase hex, by its name.
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq)]
pub struct MavenHashes {
pub name: String,
pub sha1: String,
pub sha512: String,
}
/// That its owner yanked a release, keyed as the release is, which never
/// changes: deleting this undoes it.
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq)]
crates/knotless/src/release.rs+3−0
@@ -188,6 +188,7 @@ pub struct Made {
pub cargo: Option<records::CargoCrate>,
pub npm: Option<records::NpmPackage>,
pub swift: Option<records::SwiftPackage>,
pub maven: Option<records::MavenArtifact>,
}
/// Where a version of a package is to be published: a public repository,
@@ -255,6 +256,7 @@ impl Target {
cargo: made.cargo,
npm: made.npm,
swift: made.swift,
maven: made.maven,
yanked: false,
};
let typed = records::typed(nsid::RELEASE, &record);
@@ -505,6 +507,7 @@ mod tests {
cargo: None,
npm: None,
swift: None,
maven: None,
yanked: false,
}
}
crates/knotless-serve/src/web/cargo.rs+1−0
@@ -520,6 +520,7 @@ mod tests {
cargo,
npm: None,
swift: None,
maven: None,
yanked,
};
(String::new(), record)
crates/knotless-serve/src/web/maven.rsnew+828−0
828 lines changed: not loaded until asked for.
crates/knotless-serve/src/web/npm.rs+1−0
@@ -518,6 +518,7 @@ mod tests {
manifest: m.to_string(),
}),
swift: None,
maven: None,
yanked,
};
(String::new(), record)
crates/knotless-serve/src/web/releases.rs+1−0
@@ -329,6 +329,7 @@ mod tests {
cargo: None,
npm: None,
swift: None,
maven: None,
yanked: false,
};
(
crates/knotless-serve/src/web/steps.rs+1−0
@@ -271,6 +271,7 @@ mod tests {
cargo: None,
npm: None,
swift: None,
maven: None,
yanked: false,
};
(v.into(), record, Value::Null)
crates/knotless-serve/src/lib.rs+4−0
@@ -106,6 +106,9 @@ pub struct App {
/// Each repository's storage as last counted, kept until it moves
/// (`dev.knotless.getRepoStorage`).
pub(crate) counts: web::Counts,
/// What Maven publishes keep between their requests: the files of the
/// versions they upload, and their sessions (`web/maven.rs`).
pub(crate) maven: web::MavenStaging,
/// The last commit, by its rev, that wrote to each DID's repository
/// collections ([`first_of`]).
revs: Mutex<HashMap<String, String>>,
@@ -298,6 +301,7 @@ impl App {
viewed_last: Mutex::default(),
catching: Mutex::default(),
counts: web::Counts::default(),
maven: web::MavenStaging::default(),
revs: Mutex::default(),
watching: AtomicBool::new(false),
moves: Default::default(),
crates/knotless-serve/src/web.rs+6−0
@@ -58,6 +58,8 @@ mod gists;
mod items;
mod landing;
mod live;
mod maven;
pub(crate) use maven::Staging as MavenStaging;
mod notifications;
mod npm;
mod opening;
@@ -355,6 +357,10 @@ pub fn routes() -> Router<Arc<App>> {
"/swift/{did}/{key}/{scope}/{name}/{version}/Package.swift",
get(swift::manifest),
)
.route(
"/maven/{did}/{key}/{*path}",
get(maven::read).put(maven::write),
)
.route("/{authority}/{repo}/archive/{*rest}", get(archive::archive))
.merge(compressed)
.layer(middleware::from_fn(renamed))
crates/knotless-serve/tests/web.rs+239−0
@@ -4589,6 +4589,245 @@ fn a_swift_registry() {
assert_eq!(says(get("mona/nofile/1.0.0.zip")).0, 404);
}
#[test]
fn a_maven_repository() {
use base64::Engine;
use base64::engine::general_purpose::STANDARD;
use serde_json::json;
use sha2::Digest;
let site = serve(true);
let owner = person(account(), &site);
let handle = owner.account.handle.clone();
let url = owner.url("artifacts");
ok(&owner, &["repo", "create", &url]);
let work = owner.work("w", 1);
owner.git(&work, &["push", "-q", &url, "main"]);
let did = owner.account.did.clone();
let key = owner.record("dev.knotless.repo", "artifacts")["key"]
.as_str()
.unwrap()
.to_string();
let repo = format!("{}/maven/{did}/{key}", site.base);
let client = Client::new();
let basic = |user: &str, password: &str| {
format!("Basic {}", STANDARD.encode(format!("{user}:{password}")))
};
let owners = basic(&handle, &owner.account.password);
let says = |res: Response| (res.status().as_u16(), res.text().unwrap());
let get = |path: &str| says(client.get(format!("{repo}/{path}")).send().unwrap());
let put = |path: &str, auth: Option<&str>, body: &[u8]| {
let req = client.put(format!("{repo}/{path}")).body(body.to_vec());
let req = match auth {
Some(auth) => req.header("authorization", auth),
None => req,
};
says(req.send().unwrap())
};
let metadata = "com/example/lib/maven-metadata.xml";
wait_until(|| get(metadata).1.contains("no com.example:lib"));
// As Gradle publishes: each file and its hashes, then the metadata.
let sha1 = |b: &[u8]| format!("{:x}", sha1::Sha1::digest(b));
let sha256 = |b: &[u8]| format!("{:x}", sha2::Sha256::digest(b));
let sha512 = |b: &[u8]| format!("{:x}", sha2::Sha512::digest(b));
let publish = |version: &str| {
let dir = format!("com/example/lib/{version}");
let files = [
(format!("lib-{version}.aar"), format!("aar {version}")),
(
format!("lib-{version}.pom"),
format!("<project>{version}</project>"),
),
(
format!("lib-{version}.module"),
format!("{{\"v\": \"{version}\"}}"),
),
(
format!("lib-{version}-sources.jar"),
format!("sources {version}"),
),
];
for (name, content) in &files {
let bytes = content.as_bytes();
let path = format!("{dir}/{name}");
assert_eq!(put(&path, Some(&owners), bytes).0, 201, "{path}");
for (ext, hash) in [
(".sha1", sha1(bytes)),
(".sha256", sha256(bytes)),
(".sha512", sha512(bytes)),
(".md5", "x".into()),
] {
let (status, said) = put(&format!("{path}{ext}"), Some(&owners), hash.as_bytes());
assert_eq!(status, 201, "{path}{ext}: {said}");
}
}
let xml = format!(
"<metadata><versioning><versions><version>{version}</version></versions></versioning></metadata>"
);
assert_eq!(put(metadata, Some(&owners), xml.as_bytes()).0, 201);
for ext in [".sha1", ".sha256", ".sha512", ".md5"] {
assert_eq!(put(&format!("{metadata}{ext}"), Some(&owners), b"x").0, 201);
}
files
};
let (status, said) = put("com/example/lib/1.0.0/lib-1.0.0.pom", None, b"x");
assert!(status == 401 && said.contains("log in"), "{said}");
let unauthorized = client.put(format!("{repo}/{metadata}")).send().unwrap();
assert_eq!(
unauthorized.headers()["www-authenticate"],
"Basic realm=\"knotless\""
);
let files = publish("1.0.0");
let releases = owner.records("dev.knotless.release");
let (_, record) = releases
.iter()
.find(|(_, r)| r["version"] == "1.0.0")
.unwrap();
assert_eq!(record["package"], "com.example.lib");
assert_eq!(record["maven"]["group"], "com.example");
assert_eq!(record["maven"]["artifact"], "lib");
assert_eq!(record["files"].as_array().unwrap().len(), 4);
assert_eq!(record["maven"]["hashes"].as_array().unwrap().len(), 4);
publish("1.1.0");
// What a build reads: the metadata, each file, and their hashes.
let (status, xml) = get(metadata);
assert_eq!(status, 200);
assert!(
xml.contains("<latest>1.1.0</latest>") && xml.contains("<release>1.1.0</release>"),
"{xml}"
);
assert!(
xml.contains("<version>1.0.0</version>\n <version>1.1.0</version>"),
"{xml}"
);
assert_eq!(
get(&format!("{metadata}.sha1")),
(200, sha1(xml.as_bytes()))
);
assert_eq!(get(&format!("{metadata}.md5")).0, 404);
for (name, content) in &files {
let path = format!("com/example/lib/1.0.0/{name}");
assert_eq!(get(&path), (200, content.clone()));
let bytes = content.as_bytes();
assert_eq!(get(&format!("{path}.sha1")), (200, sha1(bytes)));
assert_eq!(get(&format!("{path}.sha256")), (200, sha256(bytes)));
assert_eq!(get(&format!("{path}.sha512")), (200, sha512(bytes)));
assert_eq!(get(&format!("{path}.md5")).0, 404);
}
let head = client
.head(format!("{repo}/com/example/lib/1.0.0/lib-1.0.0.pom"))
.send()
.unwrap();
assert_eq!(head.status(), 200);
assert_eq!(get("com/example/lib/9.0.0/lib-9.0.0.pom").0, 404);
assert_eq!(get("com/example/lib/1.0.0/lib-1.0.0.jar").0, 404);
assert_eq!(get("Com/example/lib/maven-metadata.xml").0, 404);
// A yank keeps it out of the metadata, and nothing else changes.
ok(
&owner,
&["release", "yank", &url, "com.example.lib", "1.1.0"],
);
wait_until(|| !get(metadata).1.contains("<version>1.1.0</version>"));
assert!(get(metadata).1.contains("<latest>1.0.0</latest>"));
assert_eq!(get("com/example/lib/1.1.0/lib-1.1.0.pom").0, 200);
// Refused: what is there, who may not, and what Gradle never sends.
let refused = |path: &str, auth: &str, body: &[u8], status: u16, why: &str| {
let (got, said) = put(path, Some(auth), body);
assert!(got == status && said.contains(why), "{path}: {got} {said}");
};
let new = "com/example/lib/2.0.0/lib-2.0.0.pom";
refused(
"com/example/lib/1.0.0/lib-1.0.0.pom",
&owners,
b"x",
409,
"published already",
);
refused(new, &basic(&handle, "wrong"), b"x", 403, "could not log in");
let stranger = account();
refused(
new,
&basic(&stranger.handle, &stranger.password),
b"x",
403,
"only ",
);
refused(
"com/example/lib/2.0.0-SNAPSHOT/lib-2.0.0-SNAPSHOT.pom",
&owners,
b"x",
400,
"snapshot",
);
refused(
"Com/example/lib/2.0.0/lib-2.0.0.pom",
&owners,
b"x",
400,
"Maven's layout",
);
refused(
"com/example/lib/2.0/lib-2.0.pom",
&owners,
b"x",
400,
"not a version",
);
refused(
"com/example/lib/2.0.0/other-2.0.0.pom",
&owners,
b"x",
400,
"classifier",
);
refused(new, &owners, b"", 400, "empty");
refused(&format!("{new}.sha1"), &owners, b"x", 404, "was uploaded");
assert_eq!(put(new, Some(&owners), b"pom").0, 201);
refused(&format!("{new}.sha1"), &owners, b"0000", 400, "is not its");
let lost = b"<versions><version>2.0.0</version><version>3.0.0</version></versions>";
refused(metadata, &owners, lost, 400, "3.0.0 was not uploaded here");
let versions = |package: &str| {
let releases = owner.records("dev.knotless.release");
releases
.into_iter()
.filter(|(_, r)| r["package"] == package)
.count()
};
assert_eq!(versions("com.example.lib"), 2);
let large = vec![b' '; (64 << 20) + 1];
refused(new, &owners, &large, 413, "at most");
let nokey = format!("{}/maven/{did}/nokey/{metadata}", site.base);
assert_eq!(says(client.get(&nokey).send().unwrap()).0, 404);
let nokey = client
.put(&nokey)
.header("authorization", &owners)
.send()
.unwrap();
assert_eq!(nokey.status(), 404);
// A record no publish here would make: a file whose bytes are not what
// it says, and no hashes beside it.
let blob = owner.upload_blob(b"x", "application/octet-stream");
let bad = json!({
"$type": "dev.knotless.release", "repo": key, "package": "com.example.bad", "version": "1.0.0",
"maven": {"group": "com.example", "artifact": "bad", "hashes": []},
"files": [{"name": "bad-1.0.0.pom", "size": 1, "sha256": "a".repeat(64), "parts": [{"blob": blob}]}],
"createdAt": "2026-11-22T00:00:00.000Z",
});
owner.put_record("dev.knotless.release", "bad", bad);
wait_until(|| get("com/example/bad/maven-metadata.xml").0 == 200);
assert_eq!(get("com/example/bad/1.0.0/bad-1.0.0.pom").0, 502);
assert_eq!(get("com/example/bad/1.0.0/bad-1.0.0.pom.sha1").0, 404);
assert_eq!(
get("com/example/bad/1.0.0/bad-1.0.0.pom.sha256"),
(200, "a".repeat(64))
);
}
#[test]
fn the_releases() {
let site = serve(true);
docs/design/packages.md+73−1
docs/reference/api.md+27−0
lexicons/dev/knotless/release.json+21−0