refactor: clean architecture #260

BrycensRanch · 2025-07-12T00:00:16Z

Preface

SnapX is our cross-platform evolution of ShareX. While we’ve already removed the original WinForms UI code—a necessary step for making SnapX build and run beyond Windows—this left significant gaps in the core logic.

Much of SnapX.Core was historically intertwined with direct UI calls. Removing the WinForms layer exposed how deeply this coupling ran, leaving several core features incomplete or blocked because the business logic still assumed UI components were directly accessible.

Features like region-based screen OCR or triggering notifications are key examples. Previously, these relied on tightly integrated UI calls, which no longer exist. As a result, SnapX.Core couldn’t properly request UI-driven actions or surface user interactions.

This PR addresses that gap to ensure SnapX can move forward toward a stable cross-platform release.

Description of Change

This PR refactors SnapX.Core to decouple it cleanly from any UI dependencies. Instead of assuming direct calls to UI elements, the core now exposes well-defined interfaces and contracts for operations that require user interaction or visual feedback.

Key changes include:

Introduced abstractions in SnapX.Core for:
- Region selection (e.g. for OCR or screenshot capture)
- User notifications
- Error reporting dialogs
Updated existing features to call these abstractions rather than direct UI code
Prepared SnapX.Core so that SnapX.Avalonia (or any other UI) can handle UI responsibilities separately
Established a clearer separation of concerns between business logic and UI layers

This ensures that SnapX.Core can remain UI-agnostic while enabling frontends like Avalonia to implement platform-specific user interactions.

Possible Alternatives

We briefly considered patching core logic with conditionals to call Avalonia-specific methods directly. However, that approach would have reintroduced tight coupling between SnapX.Core and SnapX.Avalonia, defeating the purpose of modularizing the app for cross-platform support.

Another alternative was to postpone this refactoring and only address UI calls feature by feature. We decided against this, as it would have prolonged technical debt and slowed down the release schedule for upcoming versions.

Implementation Details

Core services now define events or interfaces instead of direct method calls to UI components.
SnapX.Avalonia subscribes to these events and handles the appropriate UI workflows (e.g. displaying dialogs, selecting regions).
Some legacy method stubs in SnapX.Core were removed or rewritten to fit this new architecture.
The refactoring ensures no runtime references to UI assemblies remain in SnapX.Core, preserving its portability.

Notes

This refactor paves the way for completing several previously blocked features, including region-based OCR and proper notification handling.

It’s expected to land as part of the upcoming bi-weekly v0.4.0 pre-release.

Additionally, I've fixed a lot of the types for the ApplicationConfig, that the unfinished types caused corruption.

Future work includes:

Fully implementing region selection in SnapX.Avalonia to match legacy ShareX capabilities
Completing missing integrations for other UI-driven features

Disclosure: This PR overview was auto-generated by ChatGPT. As an experiment to save developer time.

…ling Switched the log viewer from a polling mechanism to an observable pattern. The previous approach's constant 50ms checks were inefficient and consumed unnecessary CPU cycles. This change eliminates that fixed delay and constant polling overhead, allowing new log entries to appear instantly as they're generated.

Color still needs a string converter.

codefactor-io · 2025-07-12T00:00:32Z

SnapX.Avalonia/Views/Settings/Views/SettingsHomePageView.axaml.cs


 public partial class SettingsHomePageView : UserControl
 {
-    private SettingsHomePageViewVM ViewModel;


An opening brace should not be followed by a blank line.

Suggested change

private SettingsHomePageViewVM ViewModel;

codefactor-io · 2025-07-12T00:00:32Z

SnapX.Core/CLI/ExternalCLIManager.cs

+            return process.ExitCode;
        }

-        return -1;


A closing brace should not be preceded by a blank line.

Suggested change

return -1;

codefactor-io · 2025-07-12T00:00:32Z

SnapX.Core/ObservableSink.cs

+
+    public void Emit(LogEvent logEvent)
+    {
+


An opening brace should not be followed by a blank line.

Suggested change

codefactor-io · 2025-07-12T00:00:32Z

SnapX.Core/SharpCapture/CaptureActiveWindow.cs

+    ICaptureService CaptureService)
+    : CaptureBase(MainWindowService, NotificationService, UploadManager, DelayService, LoggerService, CaptureService)
+{
+


An opening brace should not be followed by a blank line.

Suggested change

codefactor-io · 2025-07-12T00:00:32Z

SnapX.Core/Utils/Converters/StringCollectionToStringTypeConverter.cs

+        if (destinationType != typeof(string)) return base.ConvertTo(context, culture, value, destinationType) ?? throw new FormatException($"Cannot convert '{value}' to ImageSharp Color.");
+        var list = (List<string>)value;
+        return string.Join(", ", list);
+


A closing brace should not be preceded by a blank line.

Suggested change

codefactor-io · 2025-07-12T00:00:33Z

tests/Build.Tests/BuildTests.cs

+            Directory.Delete(testDir, recursive: true);
+        }
+    }
+


A closing brace should not be preceded by a blank line.

Suggested change

…hitecture # Conflicts: # SnapX.Avalonia/ViewModels/HomePageViewModel.cs

…bug runner

socket-security · 2025-07-12T17:04:37Z

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Diff	Package	Supply Chain Security	Vulnerability	Quality	Maintenance	License
	mimetypecore@2.0.4
	tunit@0.25.21
	tmds.dbus.sourcegenerator@0.0.21

View full report

It's not needed to remove anymore, the 6.2GiB from the Haskell runtime removal should be all that's needed?

…hitecture

codefactor-io · 2025-07-17T19:37:47Z

SnapX.Core/Utils/WebHelpers.cs


-        return await responseMessage.Content.ReadAsStringAsync();


A closing brace should not be preceded by a blank line.

Suggested change

return await responseMessage.Content.ReadAsStringAsync();

…hitecture # Conflicts: # SnapX.Core/SnapX.Core.csproj

…hitecture # Conflicts: # README.md # SnapX.Core/SnapX.cs

…ency

…ask updates - Now scales to a large amount of items without flickering. - Resolved missing symbol 'FindIndex' by introducing an extension method for AvaloniaList<T>. - Optimized recentTasks update logic: - Replaced full list clear/add with incremental mutation using RemoveAt and Insert. - Used reverse iteration for safe in-place removal of old items (`toRemove`). - Applied targeted replacement for items in `toUpdate` via FindIndex. - Prepended new items (`toAdd`) to maintain order and avoid unnecessary sorting. - Wrapped UI update logic in Dispatcher.UIThread.InvokeAsync to ensure thread safety. - Appended GetTask().ConfigureAwait(false) to ensure the continuation is offloaded from the UI thread, improving responsiveness and avoiding unnecessary context switches. These changes improve UI smoothness, avoid layout flicker, prevent unnecessary reallocation, and ensure the async flow is context-aware and lightweight.

codefactor-io · 2025-07-25T19:59:23Z

SnapX.Avalonia/ViewModels/HomePageViewModel.cs

+        List<int> toRemove;

-            newDesiredTasks = tasks
-                .OrderByDescending(item => item.task.Id)


Opening braces should not be preceded by blank line.

Suggested change

.OrderByDescending(item => item.task.Id)

codefactor-io · 2025-07-25T19:59:23Z

SnapX.Avalonia/ViewModels/HomePageViewModel.cs

+        // Warning: Computations on the UIThread are precious.
        await Dispatcher.UIThread.InvokeAsync(() =>
        {
-            if (newDesiredTasks.Count > 50_000)


An opening brace should not be followed by a blank line.

Suggested change

if (newDesiredTasks.Count > 50_000)

What does it mean? There is no line?

…hitecture

codefactor-io · 2025-08-03T18:01:05Z

SnapX.Core/SettingManager.cs

-                TypeInfoResolver = SettingsContext.Default
+                TypeInfoResolver = SettingsContext.Default,
+                Converters = { new JsonStringEnumConverter() }
+


A closing brace should not be preceded by a blank line.

Suggested change

ok-coder1 · 2025-08-03T18:03:14Z

Why does this always send reviews like this every big PR?

BrycensRanch · 2025-08-03T18:20:35Z

Why does this always send reviews like this every big PR?

That's because the CodeFactor bot is meant to improve code quality, but unfortunately, all it's done is add noise.

…hitecture # Conflicts: # SnapX.CLI/Program.cs # SnapX.Core/SnapX.Core.csproj

…hitecture # Conflicts: # SnapX.Avalonia/Views/HomePageView.axaml # SnapX.Avalonia/Views/HomePageView.axaml.cs

ok-coder1 · 2025-08-13T10:44:35Z

Just why.

Disclosure: This PR overview was auto-generated by ChatGPT. As an experiment to save developer time.

BrycensRanch · 2025-08-14T20:04:02Z

Just why.

Disclosure: This PR overview was auto-generated by ChatGPT. As an experiment to save developer time.

I understand the reaction 😅. As someone curious & technologically adventurous, I’m always exploring ways to streamline workflows, and this was an experiment to see if auto-generating PR overviews could save time.

Disclosure: This PR reply was also auto-generated by ChatGPT. Experiment ongoing.

github-actions · 2025-11-13T03:04:17Z

This PR is being marked as stale due to inactivity.

BrycensRanch · 2025-11-13T03:57:03Z

Nuhuh.

ok-coder1 · 2025-11-13T14:37:25Z

💀 What an insane reply.

BrycensRanch added 12 commits July 7, 2025 23:04

refactor(Core): merge ScreenCapture directory into SharpCapture

c0ff0ca

refactor: move ViewModels to SnapX.CommonUI

51692c7

refactor(build): use clean architecture

c3d4130

chore(Avalonia): acknowledge CommonUI namespaces

5107aab

test(build): initial tests

f1be889

feat(Avalonia): allow Avalonia to be controlled by settings

29136bb

fix(Core): use proper types for ApplicationConfig

8581290

Color still needs a string converter.

chore(Core): move all ScreenCapture classes to SharpCapture namespace

857f67a

chore: allow tests to access internals

f9e1d67

style(Core): run dotnet format

6838f4e

refactor: introduce new interfaces

0ccf8b6

github-actions bot added documentation Improvements or additions to documentation packaging Application packaging ie (RPM, deb, PKGBUILD) Avalonia Related to SnapX.Avalonia Core Related to SnapX.Core build Related to building labels Jul 12, 2025

codefactor-io bot reviewed Jul 12, 2025

View reviewed changes

BrycensRanch changed the title ~~refactor/clean-architecture~~ refactor: clean architecture Jul 12, 2025

BrycensRanch marked this pull request as draft July 12, 2025 00:01

Merge remote-tracking branch 'origin/develop' into refactor/clean-arc…

0615293

…hitecture # Conflicts: # SnapX.Avalonia/ViewModels/HomePageViewModel.cs

github-actions bot removed the packaging Application packaging ie (RPM, deb, PKGBUILD) label Jul 12, 2025

ci(build): only remove Android & Haskell for space on Ubuntu 24.04 De…

e5770b0

…bug runner

github-actions bot added the actions GitHub Actions label Jul 12, 2025

chore(Core): bring Windows API up to speed

2e12a11

BrycensRanch added 4 commits July 14, 2025 12:14

ci(build): do not remove Android runtime

2f6137e

It's not needed to remove anymore, the 6.2GiB from the Haskell runtime removal should be all that's needed?

fix(Avalonia): historyItem copy on homepage sometimes failing

f413df4

Merge remote-tracking branch 'origin/develop' into refactor/clean-arc…

8341788

…hitecture

Merge remote-tracking branch 'origin/develop' into refactor/clean-arc…

c30ea45

…hitecture

Merge remote-tracking branch 'origin/develop' into refactor/clean-arc…

d090d5d

…hitecture

codefactor-io bot reviewed Jul 17, 2025

View reviewed changes

Merge remote-tracking branch 'origin/develop' into refactor/clean-arc…

3c6f6d2

…hitecture # Conflicts: # SnapX.Core/SnapX.Core.csproj

github-actions bot added the macOS Relating to macOS label Jul 18, 2025

BrycensRanch added 8 commits July 20, 2025 11:03

build: use MimeTypeCore instead of MimeTypes dependency

f35e4b7

chore: use WaylandSharp instead of WaylandSharper

03980ef

chore: make sure ALL classes use MimeTypeCore

4f0a1ec

Merge remote-tracking branch 'origin/develop' into refactor/clean-arc…

8110097

…hitecture # Conflicts: # README.md # SnapX.Core/SnapX.cs

fix(Core): add optimized parameters for SQLite

b01dcd9

chore: remove debug statements from UI loop

4466255

build(Core): make sure WaylandSharper is a explicit source gen depend…

c80184b

…ency

codefactor-io bot reviewed Jul 25, 2025

View reviewed changes

BrycensRanch added 3 commits July 30, 2025 07:51

style: run dotnet format

0d9d029

fix(Core): use json string enum converters for settings

45a5786

Merge remote-tracking branch 'origin/develop' into refactor/clean-arc…

02a26e5

…hitecture

codefactor-io bot reviewed Aug 3, 2025

View reviewed changes

BrycensRanch added 3 commits August 4, 2025 15:55

Merge remote-tracking branch 'origin/develop' into refactor/clean-arc…

a67e225

…hitecture # Conflicts: # SnapX.CLI/Program.cs # SnapX.Core/SnapX.Core.csproj

fix(Avalonia): use HardwareAccelerated setting

6366c1a

Merge remote-tracking branch 'origin/develop' into refactor/clean-arc…

c716116

…hitecture # Conflicts: # SnapX.Avalonia/Views/HomePageView.axaml # SnapX.Avalonia/Views/HomePageView.axaml.cs

chore(Avalonia): use default Avalonia rendering on Windows

461d4c6

github-actions bot added the stale Inactive label Nov 13, 2025

BrycensRanch removed the stale Inactive label Nov 13, 2025

Uh oh!

refactor: clean architecture #260

Are you sure you want to change the base?

refactor: clean architecture #260

Uh oh!

Conversation

BrycensRanch commented Jul 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Preface

Description of Change

Possible Alternatives

Implementation Details

Notes

Uh oh!

codefactor-io bot Jul 12, 2025

Choose a reason for hiding this comment

Uh oh!

codefactor-io bot Jul 12, 2025

Choose a reason for hiding this comment

Uh oh!

codefactor-io bot Jul 12, 2025

Choose a reason for hiding this comment

Uh oh!

codefactor-io bot Jul 12, 2025

Choose a reason for hiding this comment

Uh oh!

codefactor-io bot Jul 12, 2025

Choose a reason for hiding this comment

Uh oh!

codefactor-io bot Jul 12, 2025

Choose a reason for hiding this comment

Uh oh!

socket-security bot commented Jul 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codefactor-io bot Jul 17, 2025

Choose a reason for hiding this comment

Uh oh!

codefactor-io bot Jul 25, 2025

Choose a reason for hiding this comment

Uh oh!

codefactor-io bot Jul 25, 2025

Choose a reason for hiding this comment

Uh oh!

ok-coder1 Aug 13, 2025

Choose a reason for hiding this comment

Uh oh!

codefactor-io bot Aug 3, 2025

Choose a reason for hiding this comment

Uh oh!

ok-coder1 commented Aug 3, 2025 via email

Uh oh!

BrycensRanch commented Aug 3, 2025

Uh oh!

ok-coder1 commented Aug 13, 2025

Uh oh!

BrycensRanch commented Aug 14, 2025

Uh oh!

github-actions bot commented Nov 13, 2025

Uh oh!

BrycensRanch commented Nov 13, 2025

Uh oh!

ok-coder1 commented Nov 13, 2025 via email

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

BrycensRanch commented Jul 12, 2025 •

edited

Loading

socket-security bot commented Jul 12, 2025 •

edited

Loading