8000 refactor(extensions/podman): handle notifications in specific class by simonrey1 · Pull Request #13301 · podman-desktop/podman-desktop · GitHub
[go: up one dir, main page]
Skip to content

refactor(extensions/podman): handle notifications in specific class #13301

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 3 commits into from
Jul 23, 2025
Merged

refactor(extensions/podman): handle notifications in specific class #13301

merged 3 commits into from
Jul 23, 2025

Conversation

simonrey1
Copy link
Contributor

What does this PR do?

This PR moves code specific to notification management in podman extension to the newly created class. This is too help keeping the extension file code short.

Screenshot / video of UI

What issues does this PR fix or reference?

Partial fixes of #13250

How to test this PR?

  • Tests are covering the bug fix or the new feature

@simonrey1
refactor(extensions/podman): handle notifications in specific class
80e581d 
Signed-off-by: Simon Rey <sfbrey+eqqe@gmail.com>
@coderabbitai coderabbitai
Copy link
Contributor
coderabbitai bot commented Jul 22, 2025 •
edited
Loading
📝 Walkthrough

Walkthrough

This change refactors the notification handling logic within the Podman extension by centralizing the disposal and state-resetting of setup notifications into a new disposeNotification() method in the ExtensionNotifications class. The update removes direct manipulation of the shouldNotifySetup flag and manual disposal of notification disposables from multiple locations, replacing them with calls to the new method. Additional changes include removing the notificationDisposable getter, updating the notification display logic to ensure notifications are only shown when appropriate, and adjusting related methods to use the new centralized approach. A new test case was added to verify that the notification flag resets correctly when Podman is uninstalled and reinstalled on Linux.

Estimated code review effort

2 (~20 minutes)

Possibly related PRs

Suggested labels

area/ci

Suggested reviewers

  • benoitf
  • cdrage
  • axel7083
  • gastoner

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

extensions/podman/packages/extension/src/extension.spec.ts

Oops! Something went wrong! :(

ESLint: 9.31.0

Error [ERR_MODULE_NOT_FOUND]: Cannot find package 'svelte-eslint-parser' imported from /eslint.config.mjs
at Object.getPackageJSONURL (node:internal/modules/package_json_reader:255:9)
at packageResolve (node:internal/modules/esm/resolve:767:81)
at moduleResolve (node:internal/modules/esm/resolve:853:18)
at defaultResolve (node:internal/modules/esm/resolve:983:11)
at ModuleLoader.defaultResolve (node:internal/modules/esm/loader:801:12)
at #cachedDefaultResolve (node:internal/modules/esm/loader:725:25)
at ModuleLoader.resolve (node:internal/modules/esm/loader:708:38)
at ModuleLoader.getModuleJobForImport (node:internal/modules/esm/loader:309:38)
at #link (node:internal/modules/esm/module_job:202:49)

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c5d7df1 and 9cf4bd6.

📒 Files selected for processing (1)
  • extensions/podman/packages/extension/src/extension.spec.ts (1 hunks)
🧠 Learnings (1)
extensions/podman/packages/extension/src/extension.spec.ts (1)

Learnt from: benoitf
PR: #13043
File: packages/main/src/plugin/color-registry-inject.spec.ts:33-35
Timestamp: 2025-07-02T08:26:44.201Z
Learning: In test files for Podman Desktop, benoitf prefers partial mocking over complete mocking. Partial mocks that only implement the methods actually used in the test are sufficient and preferred over creating complete mock objects.

🧬 Code Graph Analysis (1)
extensions/podman/packages/extension/src/extension.spec.ts (1)
packages/extension-api/src/extension-api.d.ts (1)
  • RunResult (4387-4402)
🧰 Additional context used
🧠 Learnings (1)
extensions/podman/packages/extension/src/extension.spec.ts (1)

Learnt from: benoitf
PR: #13043
File: packages/main/src/plugin/color-registry-inject.spec.ts:33-35
Timestamp: 2025-07-02T08:26:44.201Z
Learning: In test files for Podman Desktop, benoitf prefers partial mocking over complete mocking. Partial mocks that only implement the methods actually used in the test are sufficient and preferred over creating complete mock objects.

🧬 Code Graph Analysis (1)
extensions/podman/packages/extension/src/extension.spec.ts (1)
packages/extension-api/src/extension-api.d.ts (1)
  • RunResult (4387-4402)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (11)
  • GitHub Check: smoke e2e tests (development)
  • GitHub Check: smoke e2e tests (production)
  • GitHub Check: unit tests / macos-15
  • GitHub Check: unit tests / ubuntu-24.04
  • GitHub Check: unit tests / windows-2025
  • GitHub Check: build website
  • GitHub Check: macOS
  • GitHub Check: Linux
  • GitHub Check: Windows
  • GitHub Check: linter, formatters
  • GitHub Check: typecheck
🔇 Additional comments (1)
extensions/podman/packages/extension/src/extension.spec.ts (1)

3524-3547: LGTM! Test correctly validates notification flag reset behavior.

This new test case effectively validates the core functionality introduced in this PR - ensuring that setup notifications can be shown again when Podman is uninstalled after being previously installed. The test structure is well-designed:

  1. Initial state validation: Confirms notification shows when Podman is not installed
  2. Installation simulation: Mocks podman version command to simulate installation
  3. Uninstallation simulation: Removes the mock to simulate Podman being unavailable again
  4. Flag reset validation: Verifies the notification appears a second time

The test assertions are precise, checking both the call count and the specific notification content. This directly supports the PR's goal of centralizing notification disposal and state-resetting logic in the ExtensionNotifications.disposeNotification() method.

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply 8000 to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@simonrey1
refactor(extensions/podman): handle notifications in specific class
c5d7df1 
Signed-off-by: Simon Rey <sfbrey+eqqe@gmail.com>
@simonrey1 simonrey1 marked this pull request as ready for review July 22, 2025 14:56
@simonrey1 simonrey1 requested review from benoitf and a team as code owners July 22, 2025 14:56
@simonrey1 simonrey1 requested review from dgolovin and SoniaSandler and removed request for a team July 22, 2025 14:56
sourcery-ai[bot]
sourcery-ai bot reviewed Jul 22, 2025
View reviewed changes
Copy link
Contributor
@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @eqqe - I've reviewed your changes and they look great!

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@codecov Codecov
Copy link
codecov bot commented Jul 22, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

📢 Thoughts on this report? Let us know!

cdrage
cdrage requested changes Jul 22, 2025
View reviewed changes
Copy link
Contributor
@cdrage cdrage left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMO this part of the code is easily broken since we've had issues in the past with notifications not disposing correctly.

The code LGTM, but I'd feel more comfortable if tests were added since the logic of shouldNotifySetup has been moved around.

@simonrey1
Copy link
Contributor Author
simonrey1 commented Jul 23, 2025 •
edited
Loading

@cdrage thanks for your review! I already added some tests in previous sub issues associated PRs:

#13144 -> https://github.com/podman-desktop/podman-desktop/pull/13140/files
#13147 -> https://github.com/podman-desktop/podman-desktop/pull/13172/files

Let me know if you think it still misses coverage on a set of lines?

Edit: looking at https://app.codecov.io/gh/podman-desktop/podman-desktop/blob/main/extensions%2Fpodman%2Fpackages%2Fextension%2Fsrc%2Fextension.ts, it seems that lines

  • 223-223 already covered
  • 713-715 already covered
  • 729 changed were not covered -> added a test in this PR (d8240504cd2c1edaf0b5a1dfcb999153f3137af6)
  • 1261 already covered
  • 2263 already covered

@simonrey1
test(extensions/podman): check notification showed again when podman …
9cf4bd6 
…uninstalled on Linux

Signed-off-by: Simon Rey <sfbrey+eqqe@gmail.com>
cdrage
cdrage approved these changes Jul 23, 2025
View reviewed changes
Copy link
Contributor
@cdrage cdrage left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

Tested on macOS m1 and functionality still worked.

LGTM.

@simonrey1 simonrey1 merged commit 2a942f5 into podman-desktop:main Jul 23, 2025
21 checks passed
@simonrey1 simonrey1 deleted the fix-13250 branch July 23, 2025 11:56
@podman-desktop-bot podman-desktop-bot added this to the 1.21.0 milestone Jul 23, 2025
This was referenced Oct 2, 2025
Closed
Closed
Merged
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sourcery-ai sourcery-ai[bot] sourcery-ai[bot] left review comments

@cdrage cdrage cdrage approved these changes

@benoitf benoitf Awaiting requested review from benoitf benoitf is a code owner

@dgolovin dgolovin Awaiting requested review from dgolovin dgolovin is a code owner automatically assigned from podman-desktop/reviewers

@SoniaSandler SoniaSandler Awaiting requested review from SoniaSandler SoniaSandler is a code owner automatically assigned from podman-desktop/reviewers

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
1.21.0
Development

Successfully merging this pull request may close these issues.
3 participants
@simonrey1 @cdrage @podman-desktop-bot
0