Add preview dialog for package actions by RRosio · Pull Request #402 · mamba-org/gator

RRosio · 2026-03-26T02:44:12Z

Adding a dialog allowing users to preview the package changes when running a package action. Uses conda's --dry-run flag.

TODO:

Do not request confirmation if only upcoming changes are the requested changes
Single separate table for package changes, with the change identified through a badge
Add the changes preview to the 'Remove' button
Show solver error in UI, already in response
Normalize package change preview error dialog/notification for Batch and Direct modes
Tests

github-actions · 2026-03-26T02:44:21Z

👈 Launch a binder notebook on the branch RRosio/gator/dry-run-preview

… with toast notification

…y-run

Copilot

Pull request overview

Adds a package-change preview dialog backed by conda/mamba --dry-run --json, so users can review solver side-effects before applying install/update/remove actions.

Changes:

Introduces a new UI dialog (CondaPkgPreview) to display LINK/UNLINK/FETCH transaction diffs with requested-vs-dependency separation.
Adds a new backend REST endpoint (PATCH /environments/<env>/packages/preview) and EnvManager dry-run preview implementation with has_side_effects.
Wires preview into existing package actions (apply changes, delete package(s), update package) and improves HTTP error-body formatting.

Reviewed changes

Copilot reviewed 10 out of 11 changed files in this pull request and generated 7 comments.

Show a summary per file

File	Description
packages/common/src/tokens.ts	Adds shared types + package manager API for dry-run preview results.
packages/common/src/services.ts	Implements `dry_run_preview` client call and improves requestServer error parsing.
packages/common/src/packageActions.ts	Integrates preview dialog into package apply/delete/update flows.
packages/common/src/components/CondaPkgPreview.tsx	New preview dialog + transaction diff rendering UI.
packages/common/src/components/CondaPkgPanel.tsx	Minor comment tweak related to package action cancellation handling.
mamba_gator/handlers.py	Adds preview endpoint handler and registers the route.
mamba_gator/envmanager.py	Implements dry-run preview execution + normalization + side-effect detection.
mamba_gator/tests/test_manager.py	Adds unit tests for preview normalization + consolidation logic.
mamba_gator/tests/test_api.py	Adds API tests for the preview task endpoint.
docs/source/user-guide/features.md	Documents the new “Preview Package Changes” feature.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-04-04T02:10:55Z

packages/common/src/services.ts

+    environment?: string
+  ): Promise<Conda.IPreviewTransactionActions> {
+    const theEnvironment = environment || this.environment;
+    console.log('packages are: ', packages);


Remove the leftover console logging of package names; this will spam the browser console during normal usage and may leak user/environment details. Use the existing logger/debug facilities if you need diagnostics, or gate behind a debug flag.

Suggested change

console.log('packages are: ', packages);

Copilot · 2026-04-04T02:10:55Z

packages/common/src/packageActions.ts

+      type: 'success',
+      autoClose: 2000
+    });
+    Notification.dismiss(toastId);


In the no-side-effects path, the toast is updated to success and then immediately dismissed, so the user likely never sees the message (in contrast to other actions in this repo that rely on autoClose without dismissing). Consider removing the immediate dismiss and letting autoClose handle it, or only dismiss after a timeout.

Suggested change

Notification.dismiss(toastId);

Copilot · 2026-04-04T02:10:55Z

packages/common/src/packageActions.ts

+  const confirmed = await openPackagePreviewDialog({
+    title: 'Preview package changes',
+    jobs: previewJob,
+    acceptLabel: 'Apply'
+  });


The preview dialog accept button is always labeled "Apply" via dryRunPreview, but this helper is also used for delete/remove flows (e.g., deletePackage/deletePackages). That label is misleading for destructive actions; consider making acceptLabel configurable (default "Apply") and passing "Delete"/"Remove" from callers.

Copilot · 2026-04-04T02:10:56Z

packages/common/src/components/CondaPkgPreview.tsx

+    r.build_string !== null
+      ? String(r.build_string)
+      : r.build !== null


sanitizePreviewPackageRow treats undefined build_string/build as non-null, which will coerce to the literal string "undefined" and leak into comparisons/UI. Update the null checks to treat both null and undefined as absent (and only stringify when the value is actually present).

Suggested change

r.build_string !== null

? String(r.build_string)

: r.build !== null

r.build_string !== undefined && r.build_string !== null

? String(r.build_string)

: r.build !== undefined && r.build !== null

Copilot · 2026-04-04T02:10:56Z

packages/common/src/components/CondaPkgPanel.tsx

    }

-    // TODO: Handle the case where the user cancels the update: show a notification here rather than in the packageActions.ts file
+    // TODO: Handle the case where the user cancels the update: show a notification here rather than in the packageActions.tsx file


This TODO references packageActions.tsx, but the file is packageActions.ts. Please correct the filename in the comment to avoid confusion when someone searches for it later.

Suggested change

// TODO: Handle the case where the user cancels the update: show a notification here rather than in the packageActions.tsx file

// TODO: Handle the case where the user cancels the update: show a notification here rather than in the packageActions.ts file

Copilot · 2026-04-04T02:10:56Z

mamba_gator/envmanager.py

+        if "error" not in result:
+            requested_set = {p.split('=')[0] for p in packages}
+            plan_names = {
+                x.get("name", "").strip().lower()
+                for x in result.get("LINK", []) + result.get("UNLINK", [])
+            }
+            result["has_side_effects"] = not plan_names.issubset(requested_set)


has_side_effects can be miscomputed because requested_set is derived via p.split('=')[0], which fails for common conda specs like "python>=3.10", "python!=3.14.0", or channel-qualified specs. This will cause unnecessary preview dialogs (or incorrect auto-apply decisions). Parse the base package name more robustly (e.g., split on comparison operators and trim, and normalize case to match plan_names).

Copilot · 2026-04-04T02:10:56Z

docs/source/user-guide/features.md

+When applying changes, users see a pop-up dialog that provides a summary of the side-effects
+to packages in an environment based on the requested changes. If there are no additional changes
+to packages in the environment, other than the requested changes, the dialog is not displayed.
+The preview dialog provides a summary count of packages removed, installed and changed, as well 
+as a section with the requested package changed followed by a list of the additional packages 
+changes with more details about those changes. Based on the preview, users can continue to apply
+those changes or cancel the operation.


Documentation text has grammar issues and trailing whitespace (e.g., "as well ", "requested package changed", "additional packages changes"). Please fix wording and remove trailing spaces so the user guide renders cleanly.

Suggested change

When applying changes, users see a pop-up dialog that provides a summary of the side-effects

to packages in an environment based on the requested changes. If there are no additional changes

to packages in the environment, other than the requested changes, the dialog is not displayed.

The preview dialog provides a summary count of packages removed, installed and changed, as well

as a section with the requested package changed followed by a list of the additional packages

changes with more details about those changes. Based on the preview, users can continue to apply

those changes or cancel the operation.

When applying changes, users see a pop-up dialog that provides a summary of the side effects

on packages in an environment based on the requested changes. If there are no additional changes

to packages in the environment other than the requested changes, the dialog is not displayed.

The preview dialog provides a summary count of packages removed, installed, and changed, as well

as a section showing the requested package changes followed by a list of changes to additional

packages, with more details about those changes. Based on the preview, users can continue to apply

the changes or cancel the operation.

initial add preview dialog for package actions

d787950

RRosio self-assigned this Mar 26, 2026

RRosio added the enhancement New feature or request label Mar 26, 2026

RRosio added 10 commits March 26, 2026 18:31

skip preview dialog when no side effects, display in progress dry-run…

eb2219c

… with toast notification

lint

209c731

dismiss toast on successful dry-run; display toast error on failed dr…

22a7748

…y-run

add error message details

76d2328

apply lint

e57500f

clean up comments

aa9abd5

update UI design

3fba5e8

fix double scroll bar

40ab430

Add documentation for preview package changes

db78f86

clean up debug logs

ff6e600

RRosio force-pushed the dry-run-preview branch from 365b839 to 5716a3a Compare April 4, 2026 00:06

add tests

5716a3a

RRosio requested a review from Copilot April 4, 2026 02:05

Copilot started reviewing on behalf of RRosio April 4, 2026 02:06 View session

Copilot AI reviewed Apr 4, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add preview dialog for package actions#402

Add preview dialog for package actions#402
RRosio wants to merge 12 commits intomamba-org:mainfrom
RRosio:dry-run-preview

RRosio commented Mar 26, 2026 •

edited

Loading

Uh oh!

github-actions bot commented Mar 26, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Apr 4, 2026

Uh oh!

Copilot AI Apr 4, 2026

Uh oh!

Copilot AI Apr 4, 2026

Uh oh!

Copilot AI Apr 4, 2026

Uh oh!

Copilot AI Apr 4, 2026

Uh oh!

Copilot AI Apr 4, 2026

Uh oh!

Copilot AI Apr 4, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	// TODO: Handle the case where the user cancels the update: show a notification here rather than in the packageActions.tsx file
	// TODO: Handle the case where the user cancels the update: show a notification here rather than in the packageActions.ts file

Conversation

RRosio commented Mar 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Mar 26, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Apr 4, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 4, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 4, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 4, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 4, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 4, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 4, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

RRosio commented Mar 26, 2026 •

edited

Loading