refactor(core): extract MessageBox to separate UI package #590

JasonXuDeveloper · 2026-01-28T03:58:02Z

Summary

Make core lightweight by extracting MessageBox with an abstraction layer, keeping the framework non-invasive (无侵入式) for hot updates while allowing UI customization.

Changes

Add Prompt abstraction in core for user dialogs (delegate-based, thread-safe)
Create new jengine.ui package for UI utilities
Move MessageBox from core to ui package (namespace: JEngine.UI)
Update Bootstrap to use Prompt.ShowDialogAsync instead of MessageBox
Add PromptInitializer.cs that registers MessageBox as default
Add unit tests for MessageBox with test hooks (TestHandler, SimulateNoPrefab)
Update CI workflows for new UI package
HotUpdate code now uses Prompt.ShowDialogAsync (no direct UI/Util dependencies)

Package Structure

Package	Dependencies	Purpose
`jengine.core`	UniTask, Nino, YooAsset	Hot update only, with Prompt abstraction
`jengine.util`	None	General utilities
`jengine.ui`	UniTask, TMP	Optional UI utilities (MessageBox)

How It Works

Prompt.ShowDialogAsync must be defined before Bootstrap starts. Using [RuntimeInitializeOnLoadMethod(RuntimeInitializeLoadType.BeforeSceneLoad)] ensures this.

Default behavior (this repo):

This repo includes jengine.ui package and Assets/Scripts/PromptInitializer.cs which registers MessageBox by default:

[RuntimeInitializeOnLoadMethod(RuntimeInitializeLoadType.BeforeSceneLoad)]
private static void Initialize()
{
    Prompt.ShowDialogAsync = MessageBox.Show;
}

Custom implementation:

If you don't want to use our MessageBox, modify PromptInitializer.cs with your own dialog logic:

[RuntimeInitializeOnLoadMethod(RuntimeInitializeLoadType.BeforeSceneLoad)]
private static void Initialize()
{
    Prompt.ShowDialogAsync = async (title, content, ok, no) => {
        // Your custom dialog logic
        return await MyCustomDialog.Show(title, content, ok, no);
    };
}

Without any initializer:

If Prompt.ShowDialogAsync is not set, Bootstrap logs errors and returns false (safer default - operations requiring confirmation will not proceed).

Breaking Changes

MessageBox moved from JEngine.Core.Misc to JEngine.UI

Test plan

Build jengine.core - compiles without MessageBox dependency
Build jengine.ui - compiles with MessageBox
Unit tests pass (18 tests for MessageBox)
Test Bootstrap without initializer - logs errors and returns false
Test with MessageBox registered - dialogs work as before

🤖 Generated with Claude Code

Make core lightweight by extracting MessageBox with an abstraction layer: - Add Prompt abstraction in core for user dialogs (delegate-based) - Create new jengine.ui package for UI utilities - Move MessageBox from core to ui package (namespace: JEngine.UI) - Update Bootstrap to use Prompt.ShowDialogAsync instead of MessageBox - Add PromptInitializer.cs for easy UI integration Package structure after changes: - jengine.core: Independent hot update only, with Prompt abstraction - jengine.ui: Optional UI utilities (MessageBox) Users can customize prompt behavior by: 1. Using the default MessageBox via PromptInitializer 2. Implementing custom dialog providers This keeps core non-invasive (无侵入式) for hot updates while allowing UI customization through the optional ui package. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> Signed-off-by: JasonXuDeveloper - 傑 <jason@xgamedev.net>

github-actions · 2026-01-28T04:02:47Z

⚠️ Test execution was cancelled or encountered an error.

View workflow run

Click here to view the full workflow run

Copilot

Pull request overview

This PR refactors the MessageBox UI component out of the core JEngine framework into a separate optional jengine.ui package, introducing a Prompt abstraction layer to maintain loose coupling while allowing UI customization.

Changes:

Introduces Prompt abstraction in core package for dialog operations via delegate pattern
Extracts MessageBox from JEngine.Core.Misc to new jengine.ui package under JEngine.UI namespace
Updates Bootstrap to use Prompt.ShowDialogAsync instead of direct MessageBox calls
Adds comprehensive unit tests for MessageBox with Editor-only test hooks (TestHandler, SimulateNoPrefab)
Updates CI/CD workflows to support building and testing the new UI package

Reviewed changes

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

Show a summary per file

File	Description
UnityProject/Packages/packages-lock.json	Adds jengine.ui package dependency with UniTask
UnityProject/Packages/com.jasonxudeveloper.jengine.ui/package.json	Defines new UI package metadata and dependencies
UnityProject/Packages/com.jasonxudeveloper.jengine.ui/Runtime/MessageBox.cs	Moved MessageBox from core to UI package with namespace change and test hooks
UnityProject/Packages/com.jasonxudeveloper.jengine.ui/Runtime/JEngine.UI.asmdef	Assembly definition for UI package runtime code
UnityProject/Packages/com.jasonxudeveloper.jengine.ui/Tests/Editor/MessageBoxTests.cs	Comprehensive unit tests for MessageBox using test hooks
UnityProject/Packages/com.jasonxudeveloper.jengine.ui/Tests/Editor/JEngine.UI.Editor.Tests.asmdef	Test assembly definition referencing NUnit and UniTask
UnityProject/Packages/com.jasonxudeveloper.jengine.core/Runtime/Prompt.cs	New abstraction layer for dialogs using delegate pattern
UnityProject/Packages/com.jasonxudeveloper.jengine.core/Runtime/Bootstrap.cs	Updated to use Prompt.ShowDialogAsync instead of MessageBox
UnityProject/Assets/Scripts/PromptInitializer.cs	Sample initializer showing how to register MessageBox as dialog provider
UnityProject/Assets/HotUpdate/Code/EntryPoint.cs	Updates namespace import from JEngine.Core.Misc to JEngine.UI
UnityProject/Assets/HotUpdate/Code/HotUpdate.Code.asmdef	Adds assembly references for JEngine.Util and JEngine.UI
.github/workflows/release.yml	Adds UI package to release workflow with version management
.github/workflows/pr-tests.yml	Updates test workflow to include UI package coverage

Comments suppressed due to low confidence (2)

UnityProject/Packages/com.jasonxudeveloper.jengine.ui/Runtime/MessageBox.cs:226

The SimulateNoPrefab flag duplicates the prefab null check logic. When SimulateNoPrefab is true, it returns early with an error message that is identical to the real prefab null check at line 228-232. This creates code duplication and makes the test behavior different from the actual error path.

A cleaner approach would be to make SimulateNoPrefab affect the Prefab property getter (lines 91-104) to return null when simulating, rather than having a separate check. This would ensure tests exercise the exact same code path as production when the prefab is actually missing.
UnityProject/Packages/com.jasonxudeveloper.jengine.ui/Runtime/MessageBox.cs:240

The TestHandler is checked after prefab validation, which means tests will attempt to load the prefab from Resources even when using TestHandler. This creates unnecessary resource loading overhead in tests and may cause test failures if the prefab doesn't exist in the test environment.

The order should be reversed: check TestHandler first before attempting any prefab operations. This allows tests to completely bypass the UI infrastructure.

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

UnityProject/Packages/com.jasonxudeveloper.jengine.core/Runtime/Prompt.cs

UnityProject/Assets/Scripts/PromptInitializer.cs

UnityProject/Packages/com.jasonxudeveloper.jengine.core/Runtime/Prompt.cs

UnityProject/Packages/com.jasonxudeveloper.jengine.ui/package.json

.github/workflows/pr-tests.yml

UnityProject/Assets/HotUpdate/Code/HotUpdate.Code.asmdef

UnityProject/Assets/HotUpdate/Code/EntryPoint.cs

- Make ShowDialogAsync thread-safe with volatile backing field and Interlocked.Exchange - Improve XML documentation for Prompt class with usage examples - Change default behavior to log error and return false (safer default) - Add namespace to PromptInitializer (JEngine) - Add TextMeshPro dependency to jengine.ui package.json - Remove JEngine.UI dependency from HotUpdate.Code (use Prompt abstraction instead) - Update EntryPoint.cs to use Prompt.ShowDialogAsync instead of MessageBox.Show Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> Signed-off-by: JasonXuDeveloper - 傑 <jason@xgamedev.net>

- Use null-coalescing in getter instead of field initializer - Remove namespace from PromptInitializer (user-level code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> Signed-off-by: JasonXuDeveloper - 傑 <jason@xgamedev.net>

HotUpdate code should not directly depend on utility packages. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> Signed-off-by: JasonXuDeveloper - 傑 <jason@xgamedev.net>

github-actions

Auto-approved: Copilot review found no issues and Unity Tests passed (or were skipped for non-code changes).

github-actions

Auto-approved: Copilot review found no issues and Unity Tests passed (or were skipped for non-code changes).

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> Signed-off-by: JasonXuDeveloper - 傑 <jason@xgamedev.net>

New package should start at 0.0.0. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> Signed-off-by: JasonXuDeveloper - 傑 <jason@xgamedev.net>

github-actions

Auto-approved: Copilot review found no issues and Unity Tests passed (or were skipped for non-code changes).

- New packages should start at version 0.0.0 - Document naming convention and required files - Add ui scope to commit message conventions Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> Signed-off-by: JasonXuDeveloper - 傑 <jason@xgamedev.net>

Copilot

Pull request overview

Copilot reviewed 26 out of 26 changed files in this pull request and generated 5 comments.

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

UnityProject/Packages/com.jasonxudeveloper.jengine.core/Runtime/Prompt.cs

UnityProject/Assets/Scripts/PromptInitializer.cs

UnityProject/Packages/com.jasonxudeveloper.jengine.core/Runtime/Prompt.cs

.github/workflows/pr-tests.yml

github-actions · 2026-01-28T04:22:48Z

Unity Test Results

✅ EditMode: All tests passed
✅ PlayMode: All tests passed

Unity Version: 2022.3.55f1
Project Path: UnityProject

✅ All tests passed! The PR is ready for review.

View workflow run

Click here to view the full workflow run

Split verbose CLAUDE.md (295 lines) into focused files: - .claude/rules/commit-conventions.md - .claude/rules/package-creation.md - .claude/rules/coding-patterns.md Main CLAUDE.md now 84 lines with essential info only. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> Signed-off-by: JasonXuDeveloper - 傑 <jason@xgamedev.net>

@imports

- Add @imports to CLAUDE.md for .claude/rules/ files - Update copilot instructions to allow no-namespace code in Assets/Scripts/ - Add JEngine.UI namespace to instruction files Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> Signed-off-by: JasonXuDeveloper - 傑 <jason@xgamedev.net>

github-actions

Auto-approved: Copilot review found no issues and Unity Tests passed (or were skipped for non-code changes).

github-actions

Auto-approved: Copilot review found no issues and Unity Tests passed (or were skipped for non-code changes).

Copilot

Pull request overview

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

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

Copilot AI review requested due to automatic review settings January 28, 2026 03:58

github-actions bot added ci core tests editor labels Jan 28, 2026

Copilot started reviewing on behalf of JasonXuDeveloper January 28, 2026 03:58 View session

JasonXuDeveloper enabled auto-merge (squash) January 28, 2026 04:03

Copilot AI reviewed Jan 28, 2026

View reviewed changes

JasonXuDeveloper and others added 2 commits January 28, 2026 15:09

Copilot AI review requested due to automatic review settings January 28, 2026 04:14

Copilot started reviewing on behalf of JasonXuDeveloper January 28, 2026 04:15 View session

fix(core): remove JEngine.Util reference from HotUpdate.Code

0bcfa9c

HotUpdate code should not directly depend on utility packages. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> Signed-off-by: JasonXuDeveloper - 傑 <jason@xgamedev.net>

github-actions bot previously approved these changes Jan 28, 2026

View reviewed changes

JasonXuDeveloper dismissed github-actions[bot]’s stale review via 0bcfa9c January 28, 2026 04:17

github-actions bot previously approved these changes Jan 28, 2026

View reviewed changes

JasonXuDeveloper disabled auto-merge January 28, 2026 04:19

JasonXuDeveloper enabled auto-merge (squash) January 28, 2026 04:20

chore(ui): update packages-lock.json for TextMeshPro dependency

8627fb9

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> Signed-off-by: JasonXuDeveloper - 傑 <jason@xgamedev.net>

JasonXuDeveloper dismissed github-actions[bot]’s stale review via 8627fb9 January 28, 2026 04:20

chore(ui): set initial version to 0.0.0

97ee140

New package should start at 0.0.0. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> Signed-off-by: JasonXuDeveloper - 傑 <jason@xgamedev.net>

github-actions bot previously approved these changes Jan 28, 2026

View reviewed changes

JasonXuDeveloper dismissed github-actions[bot]’s stale review via 9682ac9 January 28, 2026 04:21

github-actions bot added the documentation Improvements or additions to documentation label Jan 28, 2026

Copilot AI reviewed Jan 28, 2026

View reviewed changes

github-actions bot previously approved these changes Jan 28, 2026

View reviewed changes

Copilot AI review requested due to automatic review settings January 28, 2026 04:26

JasonXuDeveloper dismissed github-actions[bot]’s stale review via d2fab2c January 28, 2026 04:26

Copilot started reviewing on behalf of JasonXuDeveloper January 28, 2026 04:26 View session

github-actions bot approved these changes Jan 28, 2026

View reviewed changes

Copilot AI reviewed Jan 28, 2026

View reviewed changes

JasonXuDeveloper merged commit 4c635ad into master Jan 28, 2026
24 checks passed

JasonXuDeveloper deleted the refactor/extract-messagebox-to-ui-package branch January 28, 2026 04:30

JasonXuDeveloper mentioned this pull request Jan 28, 2026

feat(ui): modernize editor UI with monochrome shadcn-style design system #591

Closed

6 tasks

refactor(core): extract MessageBox to separate UI package #590

refactor(core): extract MessageBox to separate UI package #590

Uh oh!

Conversation

JasonXuDeveloper commented Jan 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Changes

Package Structure

How It Works

Breaking Changes

Test plan

Uh oh!

github-actions bot commented Jan 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions bot left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions bot left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Jan 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Unity Test Results

Uh oh!

github-actions bot left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions bot left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

JasonXuDeveloper commented Jan 28, 2026 •

edited

Loading

github-actions bot commented Jan 28, 2026 •

edited

Loading

github-actions bot commented Jan 28, 2026 •

edited

Loading