Skip to content

feat: show only assets in album - #690

Open
gvolpe wants to merge 2 commits into
immichFrame:mainfrom
gvolpe:feat/show-only-assets-in-album
Open

feat: show only assets in album#690
gvolpe wants to merge 2 commits into
immichFrame:mainfrom
gvolpe:feat/show-only-assets-in-album

Conversation

@gvolpe

@gvolpe gvolpe commented Aug 11, 2026

Copy link
Copy Markdown

closes #689

I'm using this version in my local server and it seems to work as expected 🚀

Note: it was implemented by Codex, and reviewed and tested by myself. The implementation seems quite trivial.

Summary by CodeRabbit

  • New Features

    • Added an option to display only assets found in albums.
    • When enabled, assets from all albums are included while excluded albums remain filtered.
    • Duplicate assets shared across multiple albums are shown only once.
    • The setting is disabled by default and takes precedence over other asset sources.
  • Documentation

    • Added configuration guidance for the new album-based filtering option.

@coderabbitai

coderabbitai Bot commented Aug 11, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 9d626fab-e538-4951-80b5-c03caf9ec00e

📥 Commits

Reviewing files that changed from the base of the PR and between bae3696 and cefb7a7.

📒 Files selected for processing (1)
  • docs/docs/getting-started/configurationV1.md

📝 Walkthrough

Walkthrough

Adds ShowOnlyAssetsInAlbums account configuration. When enabled, the application uses AlbumAssetsPool, loads assets from all albums, and removes duplicate assets. Configuration resources, tests, and documentation cover the new behavior.

Changes

Album asset filtering

Layer / File(s) Summary
Settings and pool selection
ImmichFrame.Core/Interfaces/IServerSettings.cs, ImmichFrame.WebApi/Models/ServerSettings.cs, ImmichFrame.WebApi/Helpers/Config/ServerSettingsV1.cs, ImmichFrame.Core/Logic/PooledImmichFrameLogic.cs
Adds ShowOnlyAssetsInAlbums to account settings and selects AlbumAssetsPool when enabled.
Album loading and deduplication
ImmichFrame.Core/Logic/Pool/AlbumAssetsPool.cs, ImmichFrame.Core.Tests/Logic/Pool/AlbumAssetsPoolTests.cs
Resolves album IDs, loads assets from all albums when configured, deduplicates assets by ID, and tests both behaviors.
Configuration fixtures and documentation
ImmichFrame.WebApi.Tests/Resources/*, docs/docs/getting-started/configuration.md, docs/docs/getting-started/configurationV1.md
Enables the setting in test resources and documents its default and ExcludedAlbums behavior.

Estimated code review effort: 3 (Moderate) | ~20 minutes

Sequence Diagram(s)

sequenceDiagram
  participant ServerSettings
  participant PooledImmichFrameLogic
  participant AlbumAssetsPool
  participant Immich
  ServerSettings->>PooledImmichFrameLogic: provide ShowOnlyAssetsInAlbums
  PooledImmichFrameLogic->>AlbumAssetsPool: create album-only pool
  AlbumAssetsPool->>Immich: request album IDs
  Immich-->>AlbumAssetsPool: return album IDs
  AlbumAssetsPool->>Immich: request assets for each album
  Immich-->>AlbumAssetsPool: return album assets
  AlbumAssetsPool-->>PooledImmichFrameLogic: return deduplicated assets
Loading

Possibly related PRs

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly describes the main feature: showing only assets that belong to albums.
Linked Issues check ✅ Passed The changes implement the requested setting, include assets from all albums, preserve ExcludedAlbums filtering, and add tests and documentation [#689].
Out of Scope Changes check ✅ Passed All code, configuration, test, and documentation changes support the album-only asset filtering feature.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/docs/getting-started/configurationV1.md`:
- Line 21: Update the ShowOnlyAssetsInAlbums description in the V1 configuration
table to state that enabling it selects assets from all albums and ignores the
Albums setting, while ExcludedAlbums continues to apply.
🪄 Autofix

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 481688bf-ab17-41f2-8f8b-5005b226df39

📥 Commits

Reviewing files that changed from the base of the PR and between 319affe and bae3696.

📒 Files selected for processing (12)
  • ImmichFrame.Core.Tests/Logic/Pool/AlbumAssetsPoolTests.cs
  • ImmichFrame.Core/Interfaces/IServerSettings.cs
  • ImmichFrame.Core/Logic/Pool/AlbumAssetsPool.cs
  • ImmichFrame.Core/Logic/PooledImmichFrameLogic.cs
  • ImmichFrame.WebApi.Tests/Resources/TestV1.json
  • ImmichFrame.WebApi.Tests/Resources/TestV2.json
  • ImmichFrame.WebApi.Tests/Resources/TestV2.yml
  • ImmichFrame.WebApi.Tests/Resources/TestV2_NoGeneral.json
  • ImmichFrame.WebApi/Helpers/Config/ServerSettingsV1.cs
  • ImmichFrame.WebApi/Models/ServerSettings.cs
  • docs/docs/getting-started/configuration.md
  • docs/docs/getting-started/configurationV1.md

Comment thread docs/docs/getting-started/configurationV1.md Outdated
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Only show assets that belong to an album

1 participant