Skip to content

Add Maintainerr architecture overview#2817

Merged
enoch85 merged 12 commits into
developmentfrom
architecture-md
May 8, 2026
Merged

Add Maintainerr architecture overview#2817
enoch85 merged 12 commits into
developmentfrom
architecture-md

Conversation

@SmolSoftBoi

Copy link
Copy Markdown
Collaborator

Summary

  • Add a root ARCHITECTURE.md that maps the monorepo, runtime flow, core components, data stores, and external integrations.
  • Document the main ownership boundaries between apps/ui, apps/server, and packages/contracts, plus the media-server abstraction guardrails.
  • Include deployment, security, testing, and glossary sections with links to the existing feature docs.

Testing

  • Prettier formatting check passed for ARCHITECTURE.md.

@enoch85

This comment was marked as outdated.

@SmolSoftBoi

Copy link
Copy Markdown
Collaborator Author

You can't just think Codex here, you need the bigger picture.

So far the Agent changes you made here are in your favour. I don't use Codex and other devs use other things

Please revaluate this. I have nothing against adding it, but you need to take everything into account.

Thanks 🚀

The intent is for ARCHITECTURE.md to work like a general onboarding map for anyone reading the repo, whether they use no AI tools, an IDE, Claude, Codex, Copilot, Cursor, or other automation. Agent-specific guidance stays in AGENTS.md.

@SmolSoftBoi SmolSoftBoi marked this pull request as ready for review April 30, 2026 18:23
@SmolSoftBoi SmolSoftBoi requested a review from enoch85 as a code owner April 30, 2026 18:23
Copilot AI review requested due to automatic review settings May 1, 2026 20:14

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Adds a root-level architecture map for Maintainerr to help contributors quickly orient within the monorepo and understand runtime/data flows and ownership boundaries.

Changes:

  • Introduces ARCHITECTURE.md describing monorepo structure, core runtime flow, and primary modules.
  • Documents ownership boundaries across apps/ui, apps/server, and packages/contracts, including media-server abstraction guardrails.
  • Captures deployment/runtime notes, security/testing guidance, and links to existing feature docs.

@SmolSoftBoi SmolSoftBoi added the enhancement New feature or request label May 2, 2026

This comment was marked as outdated.

This comment was marked as resolved.

enoch85

This comment was marked as resolved.

This comment was marked as resolved.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 8 out of 8 changed files in this pull request and generated no new comments.

@SmolSoftBoi SmolSoftBoi requested a review from enoch85 May 6, 2026 22:02
@enoch85 enoch85 enabled auto-merge (squash) May 8, 2026 15:25
@enoch85 enoch85 merged commit 9c89e3b into development May 8, 2026
13 checks passed
@enoch85 enoch85 deleted the architecture-md branch May 8, 2026 15:29
maintainerr-automation Bot added a commit that referenced this pull request May 8, 2026
* feat(storage-metrics): split potential reclaim into movie/show/season/episode panels (#2854)

* fix(collections): credit reclaimed bytes when sizeBytes is not yet cached (#2855)

* Feature/plex collection sort (#2856)

* feat: implement plex adapter collection sorting logic

* feat: apply collection sort orchestration in collections service

* feat: add collection items sort dropdown to rule form

* feat: complete UI and full stack implementation for collection sorting

* fix(collections): address review feedback for collection sort

- Generate proper TypeORM migration for mediaServerSort column
  (previous PR shipped the entity change without one — upgrades would
  fail on the missing column).
- Extend collection sort comparator for addDate and releaseDate; the
  UI offered seven sort options but four (addDate.{asc,desc},
  releaseDate.{asc,desc}) fell through to the default branch and
  silently preserved input order.
- Replace fake MediaServerCollectionSort union with a real template
  literal (\${CollectionMediaSortField}.\${MediaSortOrder}); add
  parseCollectionSortKey helper and remove \`as any\` casts.
- Add smart-collection guard before reorder (Plex rejects move on
  smart) and membership-changed gate so we only push order to Plex
  when newMedia.length > 0.
- Filter items with missing metadata before sorting; replace the
  \`mediaData!\` non-null assertion.
- Move MEDIA_SERVER_FEATURES + supportsFeature into contracts and gate
  the UI dropdown via supportsFeature(COLLECTION_SORT) so the feature
  becomes available automatically if Jellyfin ever gains a boxset
  reorder API.
- Add ICollection.mediaServerSort field; tighten zod-to-payload
  parsing in AddModal.
- Revert unrelated edits introduced by this PR (rules.service return
  values, scheduler defensive guards, cosmetic setContext changes).
- Tests: setCollectionCustomSort and moveCollectionItem URL shapes,
  PlexAdapter.reorderCollectionItems orchestration, JellyfinAdapter
  feature flag and reorder rejection.

---------

Co-authored-by: Steven Seitz <steven.seitz@omron.com>
Co-authored-by: enoch85 <mailto@danielhansson.nu>

* fix(collections): apply collection sort on save, harden Plex reorder (#2860)

- Apply the collection sort immediately when a rule group is saved with
  a newly enabled or changed sort value, so users no longer see a
  configured sort that hasn't been pushed to Plex until a later add
  cycle. Previous behaviour gated the push on `newMedia.length > 0`,
  which left save-time changes unapplied indefinitely.

- Continue past per-item move failures in the Plex adapter
  reorderCollectionItems loop. A single rejected move no longer aborts
  subsequent moves; failures are accumulated and logged in a summary
  warning so the rest of the collection still gets ordered.

- Short-circuit the Plex reorder when the collection is already in the
  requested order. The adapter reads current child IDs first via
  PlexApiService.getCollectionChildren and returns early when they
  match `orderedItemIds`, skipping both the prefs PUT and every move
  PUT. The membership-changed gate in addToCollectionInternal is kept
  as a coarse pre-filter; the adapter check is the safety net.

- Reuse the existing `case 'title':` branch in compareMediaItemsBySort
  as a tiebreaker for airDate / rating / watchCount / deleteSoonest, so
  items sharing the same primary value fall back to alphabetical
  ordering. Status sorts (manual / excluded) intentionally skip the
  fallback to preserve their partition contract. Affects every
  consumer of the comparator (Maintainerr UI overview/library/
  collection display and the Plex collection-sort push) so on-disk
  Plex order matches what users see in Maintainerr for the same key.

Tests: new sort-utils.spec covering the timelordx tiebreaker scenario,
updated plex-adapter.service.spec for short-circuit and per-item
failure paths, and rules.service.updateRules.spec covering the
save-time apply transition.

* fix(metadata): align Jellyfin retry id check with pre-filter (#2853)

The metadata refresh retry path validated the verified id with
isBlankMediaServerId, while the pre-filter used shouldRefreshMetadataItemId.
When getMetadata returned an item with the Jellyfin empty GUID
(00000000-0000-0000-0000-000000000000), the asymmetric check let the
retry call refreshItemMetadata with that id, producing the
"Guid can't be empty" spam in Jellyfin's ProviderManager queue.

Use the same predicate in both places so foreign-shaped and empty-GUID
ids are rejected consistently before any refresh request is issued.

* Add Maintainerr architecture overview (#2817)

---------

Co-authored-by: enoch85 <mailto@danielhansson.nu>
Co-authored-by: 00Scooby <72069678+00Scooby@users.noreply.github.com>
Co-authored-by: Steven Seitz <steven.seitz@omron.com>
Co-authored-by: maintainerr-automation[bot] <261505141+maintainerr-automation[bot]@users.noreply.github.com>
Co-authored-by: Kristian Matthews-Kennington <kristian@matthews-kennington.com>
@maintainerr-automation

Copy link
Copy Markdown
Contributor

🎉 This PR is included in version 3.11.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

@enoch85 enoch85 added this to the 3.11.0 milestone May 12, 2026
doonga pushed a commit to greyrock-labs/home-ops that referenced this pull request May 13, 2026
…11.1 ) (#29)

This PR contains the following updates:

| Package | Update | Change |
|---|---|---|
| [ghcr.io/maintainerr/maintainerr](https://github.com/Maintainerr/Maintainerr) | minor | `3.10.1` → `3.11.1` |

---

### Release Notes

<details>
<summary>Maintainerr/Maintainerr (ghcr.io/maintainerr/maintainerr)</summary>

### [`v3.11.1`](https://github.com/Maintainerr/Maintainerr/blob/HEAD/CHANGELOG.md#3111-2026-05-12)

[Compare Source](Maintainerr/Maintainerr@v3.11.0...v3.11.1)

#### Highlights

- Fixed an issue where Jellyfin libraries with "Group films into collections" enabled caused BoxSet members to incorrectly toggle in and out of rule results ([#&#8203;2870](Maintainerr/Maintainerr#2870)).
- Improved error message for invalid Plex library section IDs to better guide users in resolving configuration issues ([#&#8203;2883](Maintainerr/Maintainerr#2883)).
- Enhanced custom collection UX by renaming tags for clarity and adding tooltips to explain collection handling options ([#&#8203;2882](Maintainerr/Maintainerr#2882)).

#### Fixes

- Validated Jellyfin IDs before refresh to prevent errors ([#&#8203;2853](Maintainerr/Maintainerr#2853)).
- Improved error message when Plex library section ID is invalid ([#&#8203;2883](Maintainerr/Maintainerr#2883)).
- Resolved Jellyfin collection add/remove loop for BoxSet items ([#&#8203;2870](Maintainerr/Maintainerr#2870)).
- Clarified custom collection terminology and added warnings for disabling collection handling ([#&#8203;2882](Maintainerr/Maintainerr#2882)).
- Added explicit token permissions to the Fider move job to address CodeQL findings.
- Added environment gate to mitigate TOCTOU vulnerability in the release\_pr workflow ([#&#8203;2879](Maintainerr/Maintainerr#2879)).
- Addressed transitive dependency vulnerabilities by adding Yarn resolutions for specific packages ([#&#8203;2881](Maintainerr/Maintainerr#2881)).

#### Dependencies

- Updated 10 dependencies, including notable packages: vite, typeorm, and [@&#8203;typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/eslint-plugin).

#### New Contributors

- [@&#8203;blixten85](https://github.com/blixten85) made their first contribution in [#&#8203;2881](Maintainerr/Maintainerr#2881)

### [`v3.11.0`](https://github.com/Maintainerr/Maintainerr/blob/HEAD/CHANGELOG.md#3110-2026-05-11)

[Compare Source](Maintainerr/Maintainerr@v3.10.2...v3.11.0)

#### Highlights

- Added support for force-processing overlays and gated reset operations against concurrent processing runs ([#&#8203;2827](Maintainerr/Maintainerr#2827)).
- Improved collection sorting: collections now apply sort order on save and synchronize with the media server ([#&#8203;2860](Maintainerr/Maintainerr#2860)).
- Enhanced storage metrics: potential reclaimable storage is now split into movie, show, season, and episode panels ([#&#8203;2854](Maintainerr/Maintainerr#2854)).

#### Breaking Changes

- None.

#### Features

- Added force-processing support for overlay operations and gated reset operations against concurrent processing runs ([#&#8203;2827](Maintainerr/Maintainerr#2827)).
- Improved storage metrics by splitting potential reclaimable storage into movie, show, season, and episode panels ([#&#8203;2854](Maintainerr/Maintainerr#2854)).

#### Fixes

- Fixed collection sorting to apply on save and synchronize with the media server ([#&#8203;2860](Maintainerr/Maintainerr#2860)).
- Resolved issue where excluding a single episode incorrectly excluded all episodes of the same show ([#&#8203;2867](Maintainerr/Maintainerr#2867)).
- Fixed storage metrics to merge shared volumes across hosts when byte-exact ([#&#8203;2852](Maintainerr/Maintainerr#2852)).
- Fixed Jellyfin retry ID check to align with pre-filter logic ([#&#8203;2853](Maintainerr/Maintainerr#2853)).
- Addressed issue where reclaimed bytes were not credited when `sizeBytes` was not yet cached ([#&#8203;2855](Maintainerr/Maintainerr#2855)).

#### Performance

- None.

#### Database migrations

- Added a new `mediaServerSort` column to the `collection` table to support media server-specific sorting.

#### Internal

- Added typed TanStack Query test helpers and migrated UI spec mocks to use typed builders ([#&#8203;2863](Maintainerr/Maintainerr#2863)).
- Added an architecture overview document detailing the monorepo structure, runtime flow, and core components ([#&#8203;2817](Maintainerr/Maintainerr#2817)).

#### Dependencies

- Updated 5 dependencies, including notable updates to TypeScript and typescript-eslint.

### [`v3.10.2`](https://github.com/Maintainerr/Maintainerr/blob/HEAD/CHANGELOG.md#3102-2026-05-08)

[Compare Source](Maintainerr/Maintainerr@v3.10.1...v3.10.2)

#### Highlights

- Fixed incorrect version comparison logic that caused update notifications to fail for multi-digit version segments ([#&#8203;2838](Maintainerr/Maintainerr#2838)).
- Improved storage metrics by deduplicating reclaimable bytes and adding per-type cleanup byte counters ([#&#8203;2833](Maintainerr/Maintainerr#2833)).

</details>

---

### Configuration

📅 **Schedule**: (in timezone America/New_York)

- Branch creation
  - At any time (no schedule defined)
- Automerge
  - At any time (no schedule defined)

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about these updates again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box

---

This PR has been generated by [Mend Renovate](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiI0My4xNjAuNyIsInVwZGF0ZWRJblZlciI6IjQzLjE2MC43IiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6WyJyZW5vdmF0ZS9jb250YWluZXIiLCJ0eXBlL21pbm9yIl19-->

Reviewed-on: https://git.greyrock.io/greyrock-labs/home-ops/pulls/29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request released

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants