Skip to content

armgit / ente

Public Imported from GitHub
0

πŸ’š End-to-end encrypted cloud for everything.

[rust] Enforce dependency direction (#14301)

Manav Rathi87b99743173a
diff --git a/rust/checks/dependency-boundaries/check.mjs b/rust/checks/dependency-boundaries/check.mjs
index 93d019edfe..944e3461ba 100644
--- a/rust/checks/dependency-boundaries/check.mjs
+++ b/rust/checks/dependency-boundaries/check.mjs
@@ -18,7 +18,9 @@ const metadata = JSON.parse(
),
);
const root = resolve(metadata.workspace_root, "..");
+const apps = resolve(root, "rust/apps");
const bindings = resolve(root, "rust/bindings");
+const crates = resolve(root, "rust/crates");
const framework =
/^(?:wasm-bindgen(?:-.*)?|js-sys|web-sys|serde-wasm-bindgen|tsify(?:-.*)?|flutter_rust_bridge(?:_.*)?|uniffi(?:_.*)?|napi(?:-.*)?)$/;
const pathFromRoot = (path) => relative(root, path).split(sep).join("/");
@@ -56,6 +58,25 @@ if (!domain.length) {
for (const pkg of domain) {
const manifest = pathFromRoot(pkg.manifest_path);
for (const dependency of pkg.dependencies) {
+ if (inside(apps, dependency.path)) {
+ console.error(
+ `${manifest}: dependency ${JSON.stringify(dependency.name)} crosses the Rust app boundary`,
+ );
+ process.exitCode = 1;
+ }
+ if (
+ manifest === "rust/crates/core/Cargo.toml" &&
+ inside(crates, dependency.path) &&
+ !(
+ dependency.kind === "dev" &&
+ dependency.path === resolve(crates, "test-support")
+ )
+ ) {
+ console.error(
+ `${manifest}: ente-core must not depend on other domain crates (${dependency.name})`,
+ );
+ process.exitCode = 1;
+ }
if (
!framework.test(dependency.name) &&
!inside(bindings, dependency.path)
diff --git a/rust/checks/dependency-boundaries/test.mjs b/rust/checks/dependency-boundaries/test.mjs
index 87bc9f59cf..834adb16b7 100644
--- a/rust/checks/dependency-boundaries/test.mjs
+++ b/rust/checks/dependency-boundaries/test.mjs
@@ -31,10 +31,57 @@ for (const framework of [
);
}
-result = run({ binding: true });
+result = run({
+ localDependency: "bindings/wasm/lib",
+ dependencyKind: "dependencies",
+});
assert.equal(result.status, 1, result.stderr);
assert.match(result.stderr, /dependency "ente-binding" crosses/);
+for (const dependencyKind of [
+ "dependencies",
+ "dev-dependencies",
+ "build-dependencies",
+ `target.'cfg(target_arch = "wasm32")'.dependencies`,
+]) {
+ result = run({ localDependency: "apps/cli", dependencyKind });
+ assert.equal(result.status, 1, result.stderr);
+ assert.match(result.stderr, /crosses the Rust app boundary/);
+
+ result = run({
+ domainName: "core",
+ localDependency: "crates/product",
+ dependencyKind,
+ });
+ assert.equal(result.status, 1, result.stderr);
+ assert.match(
+ result.stderr,
+ /ente-core must not depend on other domain crates/,
+ );
+}
+
+result = run({ localDependency: "crates/product" });
+assert.equal(result.status, 0, result.stderr);
+
+for (const [dependencyKind, status] of [
+ ["dependencies", 1],
+ ["dev-dependencies", 0],
+ ["build-dependencies", 1],
+ [`target.'cfg(target_arch = "wasm32")'.dev-dependencies`, 0],
+]) {
+ result = run({
+ domainName: "core",
+ localDependency: "crates/test-support",
+ dependencyKind,
+ });
+ assert.equal(result.status, status, result.stderr);
+ if (status === 1)
+ assert.match(
+ result.stderr,
+ /ente-core must not depend on other domain crates/,
+ );
+}
+
result = run({
source: '// wasm_bindgen::JsValue is isolated here.\npub const NOTE: &str = "uniffi::export";\n',
});
@@ -112,7 +159,7 @@ assert.equal(result.stderr, "");
function run({
source = "pub fn domain() {}\n",
framework,
- binding = false,
+ localDependency,
empty = false,
unregistered = false,
deleted = false,
@@ -129,6 +176,15 @@ function run({
} else {
const members = [`crates/${domainName}`, "bindings/wasm/lib"];
if (framework) members.push("vendor/framework");
+ if (localDependency && !members.includes(localDependency)) {
+ members.push(localDependency);
+ write(
+ root,
+ `rust/${localDependency}/Cargo.toml`,
+ packageToml("other"),
+ );
+ write(root, `rust/${localDependency}/src/lib.rs`, "");
+ }
write(
root,
"rust/Cargo.toml",
@@ -136,8 +192,8 @@ function run({
);
const dependencies = framework
? `\n[${dependencyKind}]\nbinding = { package = ${JSON.stringify(framework)}, path = "../../vendor/framework" }\n`
- : binding
- ? '\n[dependencies]\nbinding = { package = "ente-binding", path = "../../bindings/wasm/lib" }\n'
+ : localDependency
+ ? `\n[${dependencyKind}]\nlocal = { package = "${localDependency === "bindings/wasm/lib" ? "ente-binding" : "other"}", path = "../../${localDependency}" }\n`
: "";
write(
root,