Fixup frontend

Author: gavinleroy

crates/aquascope/Cargo.toml

@@ -5,7 +5,7 @@ license = "MIT"
 edition = "2021"
 authors = [
   "Gavin Gray <[email protected]>",
-  "Will Crichton <[email protected]>"
+  "Will Crichton <[email protected]>",
 ]
 description = "Permissions analyzer for Rust code"
 repository = "https://github.com/cognitive-engineering-lab/aquascope"
@@ -26,10 +26,15 @@ ts-rs = "7"
 regex = "1"
 fluid-let = "1.0"
 fuzzy_match = "0.2.1"
-rustc_utils = {workspace = true, features = ["graphviz", "ts-rs", "serde", "test"]}
+rustc_utils = { workspace = true, features = [
+  "graphviz",
+  "ts-rs",
+  "serde",
+  "test",
+] }
 
 # interpret module
-miri = {git = "https://github.com/rust-lang/miri", rev = "afdbb080fe4b8e73838fffdbea8b290aa246f3d7"}
+miri = { git = "https://github.com/rust-lang/miri", rev = "afdbb080fe4b8e73838fffdbea8b290aa246f3d7" }
 aquascope_workspace_utils = { version = "0.3", path = "../aquascope_workspace_utils" }
 
 # testing utils

crates/aquascope/src/analysis/permissions/context.rs

@@ -385,7 +385,7 @@ impl<'tcx> PermissionsCtxt<'tcx> {
       loan_read_refined,
       loan_write_refined,
     ) {
-      (Some(..), Some(key)) => LoanRefined::Read { key },
+      (Some(key), Some(..)) => LoanRefined::Read { key },
       (None, Some(key)) => LoanRefined::Write { key },
       (Some(..), None) => {
         unreachable!("If read permissions are lost at a point, write permissions are also lost.")

crates/aquascope/src/analysis/stepper/mod.rs

@@ -171,14 +171,18 @@ impl std::fmt::Debug for PermissionsDiff {
   }
 }
 
-#[derive(Copy, Clone, Serialize, TS, PartialEq, Eq, Hash)]
+#[derive(Copy, Clone, PartialEq, Eq, Hash, Serialize, TS)]
 #[ts(export)]
 pub struct PermissionsDataDiff {
   pub is_live: ValueStep<bool>,
   pub type_droppable: ValueStep<bool>,
   pub type_writeable: ValueStep<bool>,
   pub path_moved: ValueStep<MoveKey>,
   pub path_uninitialized: ValueStep<bool>,
+  // NOTE the specific (_(read|write)_) versions are used *only* for
+  // internal testing to keep snapshots the same as they were before. The
+  // `loan_refined` field is sent to the frontend because we only care
+  // if something is "refined," doesn't matter if it read|write refined.
   pub loan_read_refined: ValueStep<LoanKey>,
   pub loan_write_refined: ValueStep<LoanKey>,
   pub loan_drop_refined: ValueStep<LoanKey>,

crates/aquascope/src/test_utils.rs

@@ -489,7 +489,6 @@ pub fn compile_normal(
   )
 }
 
-#[allow(unused_must_use)]
 pub fn compile(
   input: impl Into<String>,
   args: &str,
@@ -507,6 +506,7 @@ pub fn compile(
 
   // Explicitly ignore the unused return value. Many test cases are intended
   // to fail compilation, but the analysis results should still be sound.
+  #[allow(unused_must_use)]
   rustc_driver::catch_fatal_errors(|| {
     let mut compiler = rustc_driver::RunCompiler::new(&args, &mut callbacks);
     compiler.set_file_loader(Some(Box::new(StringLoader(input.into()))));
@@ -532,10 +532,10 @@ where
     });
   }
 
-  fn after_analysis<'tcx>(
+  fn after_analysis(
     &mut self,
     _compiler: &rustc_interface::interface::Compiler,
-    tcx: TyCtxt<'tcx>,
+    tcx: TyCtxt,
   ) -> rustc_driver::Compilation {
     errors::initialize_error_tracking();
 

frontend/packages/aquascope-editor/src/editor-utils/boundaries.tsx

@@ -7,6 +7,8 @@ import ReactDOM from "react-dom/client";
 import type {
   AnalysisFacts,
   BoundariesAnnotations,
+  LoanKey,
+  LoanRefined,
   PermissionsBoundary
 } from "../types.js";
 import {
@@ -52,6 +54,12 @@ let PermChar = ({ content, names, act, showit, hideit }: PermCharProps) => {
   );
 };
 
+const refiningLoan = (l: LoanRefined<LoanKey>) => {
+  if (l === "None") return;
+  else if ("Read" in l) return l.Read.key;
+  else return l.Write.key;
+};
+
 let PermStack = ({
   facts,
   boundary
@@ -68,11 +76,11 @@ let PermStack = ({
       exp: boundary.expected.read,
       act: boundary.actual.read,
       showit: () => {
-        showLoanRegion(facts, data.loan_read_refined, ["read"]);
+        showLoanRegion(facts, refiningLoan(data.loan_refined), ["read"]);
         showMoveRegion(facts, data.path_moved, ["read"]);
       },
       hideit: () => {
-        hideLoanRegion(facts, data.loan_read_refined, ["read"]);
+        hideLoanRegion(facts, refiningLoan(data.loan_refined), ["read"]);
         hideMoveRegion(facts, data.path_moved, ["read"]);
       }
     },
@@ -82,11 +90,11 @@ let PermStack = ({
       exp: boundary.expected.write,
       act: boundary.actual.write,
       showit: () => {
-        showLoanRegion(facts, data.loan_write_refined, ["write"]);
+        showLoanRegion(facts, refiningLoan(data.loan_refined), ["write"]);
         showMoveRegion(facts, data.path_moved, ["write"]);
       },
       hideit: () => {
-        hideLoanRegion(facts, data.loan_write_refined, ["write"]);
+        hideLoanRegion(facts, refiningLoan(data.loan_refined), ["write"]);
         hideMoveRegion(facts, data.path_moved, ["write"]);
       }
     },

frontend/packages/aquascope-editor/src/editor-utils/stepper.tsx

@@ -116,24 +116,24 @@ let PermDiffRow = ({
   diffs: PermissionsDataDiff;
   facts: AnalysisFacts;
 }) => {
-  interface VisualFact<K extends keyof PermissionsDataDiff> {
+  type VisualPermissionFields = Omit<
+    Omit<PermissionsDataDiff, "loan_read_refined">,
+    "loan_write_refined"
+  > & {
+    loan_refined: ValueStep<LoanKey>;
+  };
+  interface VisualFact<K extends keyof VisualPermissionFields> {
     fact: K;
     states: VisualFactState<K>[];
   }
 
-  interface VisualFactState<K extends keyof PermissionsDataDiff> {
-    value: PermissionsDataDiff[K];
+  interface VisualFactState<K extends keyof VisualPermissionFields> {
+    value: VisualPermissionFields[K];
     icon: string;
     desc: string;
   }
 
-  type Facts =
-    | "is_live"
-    | "path_moved"
-    | "path_uninitialized"
-    | "loan_write_refined"
-    | "loan_refined"
-    | "loan_read_refined";
+  type Facts = "is_live" | "path_moved" | "path_uninitialized" | "loan_refined";
 
   // There is a sort of hierarchy to the changing permissions:
   // We first prioritize "moves" and "borrows" (permission refinements),
@@ -188,10 +188,18 @@ let PermDiffRow = ({
     }
   ];
 
+  let elaboratedDiffs = {
+    loan_refined:
+      "None" in diffs.loan_write_refined
+        ? diffs.loan_read_refined
+        : diffs.loan_write_refined,
+    ...diffs
+  };
+
   let icos = [];
   for (let { fact, states } of visualFacts) {
     for (let { value, icon, desc } of states) {
-      if (_.isEqual(diffs[fact].type, value.type)) {
+      if (_.isEqual(elaboratedDiffs[fact].type, value.type)) {
         icos.push(
           <span className="perm-step-icon">
             <i
@@ -200,8 +208,6 @@ let PermDiffRow = ({
             />
           </span>
         );
-      } else {
-        // console.log("unequal: ", diffs[fact].type, value.type);
       }
     }
   }

frontend/packages/aquascope-editor/src/types.ts

@@ -16,6 +16,7 @@ export { ValueStep } from "./bindings/ValueStep";
 export { LoanKey } from "./bindings/LoanKey";
 export { LoanPoints } from "./bindings/LoanPoints";
 export { LoanRegions } from "./bindings/LoanRegions";
+export { LoanRefined } from "./bindings/LoanRefined";
 
 export { MoveKey } from "./bindings/MoveKey";
 export { MovePoints } from "./bindings/MovePoints";