Compare commits
9 Commits
phase-4-mo
...
phase-5-pu
| Author | SHA1 | Date | |
|---|---|---|---|
| 29837ea348 | |||
| ab9eb28826 | |||
| 19362eb404 | |||
| 6b584497a0 | |||
| ea4602ec15 | |||
| 392ab5ec87 | |||
| 26e97dfc81 | |||
| 0e1d8a3564 | |||
| ec1fe5ccea |
@@ -17,6 +17,7 @@
|
||||
| 1.6 | Phase 2 complete - QueryOperationService extracted |
|
||||
| 1.7 | Phase 3 complete - VersionOperationService extracted |
|
||||
| 1.8 | Phase 4 complete - ContentMoveOperationService extracted |
|
||||
| 1.9 | Phase 5 complete - ContentPublishOperationService extracted |
|
||||
|
||||
## Overview
|
||||
|
||||
@@ -396,7 +397,7 @@ Each phase MUST run tests before and after to verify no regressions.
|
||||
| 2 | Query Service | All ContentService*Tests | All pass | ✅ Complete |
|
||||
| 3 | Version Service | All ContentService*Tests | All pass | ✅ Complete |
|
||||
| 4 | Move Service | All ContentService*Tests + Sort/MoveToRecycleBin tests | All pass | ✅ Complete |
|
||||
| 5 | Publish Operation Service | All ContentService*Tests + Notification ordering tests | All pass | Pending |
|
||||
| 5 | Publish Operation Service | All ContentService*Tests + Notification ordering tests | All pass | ✅ Complete |
|
||||
| 6 | Permission Manager | All ContentService*Tests + Permission tests | All pass | Pending |
|
||||
| 7 | Blueprint Manager | All ContentService*Tests | All pass | Pending |
|
||||
| 8 | Facade | **Full test suite** | All pass | Pending |
|
||||
|
||||
@@ -0,0 +1,290 @@
|
||||
# Critical Implementation Review: Phase 4 - ContentMoveOperationService
|
||||
|
||||
**Plan File:** `2025-12-23-contentservice-refactor-phase4-implementation.md`
|
||||
**Review Date:** 2025-12-23
|
||||
**Reviewer:** Claude (Critical Implementation Review Skill)
|
||||
|
||||
---
|
||||
|
||||
## 1. Overall Assessment
|
||||
|
||||
The Phase 4 implementation plan is **well-structured and follows established patterns** from Phases 1-3. The extraction of Move, Copy, Sort, and Recycle Bin operations into `IContentMoveOperationService` follows the same architectural approach as `IContentCrudService` and `IContentVersionOperationService`.
|
||||
|
||||
**Strengths:**
|
||||
- Clear task breakdown with incremental commits
|
||||
- Interface design follows versioning policy and documentation standards
|
||||
- Preserves existing notification order and behavior
|
||||
- Appropriate decision to keep `MoveToRecycleBin` in the facade for orchestration
|
||||
- Good test coverage with both unit and integration tests
|
||||
- DeleteLocked has infinite loop protection (maxIterations guard)
|
||||
|
||||
**Major Concerns:**
|
||||
- **Nested scope issue in GetPermissions** - potential deadlock or unexpected behavior
|
||||
- **Copy method's navigationUpdates is computed but never used** - navigation cache may become stale
|
||||
- **Missing IContentCrudService.GetById(int) usage in Move** - uses wrong method signature
|
||||
|
||||
---
|
||||
|
||||
## 2. Critical Issues
|
||||
|
||||
### 2.1 Nested Scope with Lock in GetPermissions (Lines 699-706)
|
||||
|
||||
**Description:** The `GetPermissions` private method creates its own scope with a read lock while already inside an outer scope with a write lock in the `Copy` method.
|
||||
|
||||
```csharp
|
||||
// Inside Copy (line 601): scope.WriteLock(Constants.Locks.ContentTree);
|
||||
// ...
|
||||
// Line 699-706:
|
||||
private EntityPermissionCollection GetPermissions(IContent content)
|
||||
{
|
||||
using (ICoreScope scope = ScopeProvider.CreateCoreScope(autoComplete: true))
|
||||
{
|
||||
scope.ReadLock(Constants.Locks.ContentTree); // <-- Acquires lock inside nested scope
|
||||
return DocumentRepository.GetPermissionsForEntity(content.Id);
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**Why it matters:** While Umbraco's scoping generally supports nested scopes joining the parent transaction, creating a **new** scope inside a write-locked scope and acquiring a read lock can cause:
|
||||
- Potential deadlocks on some database providers
|
||||
- Unexpected transaction isolation behavior
|
||||
- The nested scope may complete independently if something fails
|
||||
|
||||
**Actionable Fix:** Refactor to accept the repository or scope as a parameter, or inline the repository call:
|
||||
|
||||
```csharp
|
||||
// Option 1: Inline in Copy method (preferred)
|
||||
EntityPermissionCollection currentPermissions = DocumentRepository.GetPermissionsForEntity(content.Id);
|
||||
currentPermissions.RemoveWhere(p => p.IsDefaultPermissions);
|
||||
|
||||
// Option 2: Pass scope to helper
|
||||
private EntityPermissionCollection GetPermissionsLocked(int contentId)
|
||||
{
|
||||
return DocumentRepository.GetPermissionsForEntity(contentId);
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 2.2 navigationUpdates Variable Computed But Never Used (Lines 585, 619, 676)
|
||||
|
||||
**Description:** The `Copy` method creates a `navigationUpdates` list and populates it with tuples of (copy key, parent key) for each copied item, but this data is never used.
|
||||
|
||||
```csharp
|
||||
var navigationUpdates = new List<Tuple<Guid, Guid?>>(); // Line 585
|
||||
// ...
|
||||
navigationUpdates.Add(Tuple.Create(copy.Key, _crudService.GetParent(copy)?.Key)); // Line 619
|
||||
// ...
|
||||
navigationUpdates.Add(Tuple.Create(descendantCopy.Key, _crudService.GetParent(descendantCopy)?.Key)); // Line 676
|
||||
// Method ends without using navigationUpdates
|
||||
```
|
||||
|
||||
**Why it matters:** The original ContentService uses these updates to refresh the in-memory navigation structure. Without this, the navigation cache (used for tree rendering, breadcrumbs, etc.) will become stale after copy operations, requiring a full cache rebuild.
|
||||
|
||||
**Actionable Fix:** Either:
|
||||
1. Publish the navigation updates via a notification/event, or
|
||||
2. Call the navigation update mechanism directly after the scope completes
|
||||
|
||||
Check the original ContentService to see how `navigationUpdates` is consumed and replicate that behavior.
|
||||
|
||||
---
|
||||
|
||||
### 2.3 Move Method Uses GetById with Wrong Type Check (Line 309)
|
||||
|
||||
**Description:** The Move method retrieves the parent using `_crudService.GetById(parentId)`, but the interface shows `GetById(Guid key)` signature.
|
||||
|
||||
```csharp
|
||||
IContent? parent = parentId == Constants.System.Root ? null : _crudService.GetById(parentId);
|
||||
```
|
||||
|
||||
**Why it matters:** Looking at `IContentCrudService`, the primary `GetById` method takes a `Guid`, not an `int`. There should be a `GetById(int id)` overload or the code needs to use `GetByIds(new[] { parentId }).FirstOrDefault()`.
|
||||
|
||||
**Actionable Fix:** Verify `IContentCrudService` has an `int` overload for `GetById`, or change to:
|
||||
|
||||
```csharp
|
||||
IContent? parent = parentId == Constants.System.Root
|
||||
? null
|
||||
: _crudService.GetByIds(new[] { parentId }).FirstOrDefault();
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 2.4 Copy Method Passes Incorrect parentKey to Descendant Notifications (Lines 658, 688)
|
||||
|
||||
**Description:** When copying descendants, the `parentKey` passed to `ContentCopyingNotification` and `ContentCopiedNotification` is the **original root parent's key**, not the **new copied parent's key**.
|
||||
|
||||
```csharp
|
||||
// Line 658 - descendant notification uses same parentKey as root copy
|
||||
if (scope.Notifications.PublishCancelable(new ContentCopyingNotification(
|
||||
descendant, descendantCopy, newParentId, parentKey, eventMessages)))
|
||||
// parentKey is from TryGetParentKey(parentId, ...) where parentId was the original param
|
||||
```
|
||||
|
||||
**Why it matters:** Notification handlers that rely on `parentKey` to identify the actual parent will receive incorrect data for descendants. This could cause:
|
||||
- Relations being created to wrong parent
|
||||
- Audit logs with incorrect parent references
|
||||
- Custom notification handlers failing
|
||||
|
||||
**Actionable Fix:** Get the parent key for each descendant's actual new parent:
|
||||
|
||||
```csharp
|
||||
TryGetParentKey(newParentId, out Guid? newParentKey);
|
||||
if (scope.Notifications.PublishCancelable(new ContentCopyingNotification(
|
||||
descendant, descendantCopy, newParentId, newParentKey, eventMessages)))
|
||||
```
|
||||
|
||||
**Note:** The original ContentService has the same issue, so this may be intentional behavior for backwards compatibility. Document this if preserving the behavior.
|
||||
|
||||
---
|
||||
|
||||
### 2.5 DeleteLocked Loop Invariant Check is Inside Loop (Lines 541-549)
|
||||
|
||||
**Description:** The check for empty batch is inside the loop, but the `total > 0` condition in the while already handles this. More critically, if `GetPagedDescendants` consistently returns empty for a non-zero total, the loop will run until maxIterations.
|
||||
|
||||
**Why it matters:** If there's a data inconsistency where `total` is non-zero but no descendants are returned, the method will spin through 10,000 iterations logging warnings before finally exiting. This could cause:
|
||||
- Long-running operations that time out
|
||||
- Excessive log spam
|
||||
- Database connection holding for extended periods
|
||||
|
||||
**Actionable Fix:** Break immediately when batch is empty, and reduce maxIterations or add a consecutive-empty-batch counter:
|
||||
|
||||
```csharp
|
||||
if (batch.Count == 0)
|
||||
{
|
||||
_logger.LogWarning(
|
||||
"GetPagedDescendants reported {Total} total but returned empty for content {ContentId}. Breaking loop.",
|
||||
total, content.Id);
|
||||
break; // Break immediately, don't continue iterating
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 3. Minor Issues & Improvements
|
||||
|
||||
### 3.1 ContentSettings Change Subscription Without Disposal
|
||||
|
||||
**Location:** Constructor (Line 284)
|
||||
|
||||
```csharp
|
||||
contentSettings.OnChange(settings => _contentSettings = settings);
|
||||
```
|
||||
|
||||
The `OnChange` subscription returns an `IDisposable` but it's not stored or disposed. For long-lived services, this is usually fine, but it's a minor resource leak.
|
||||
|
||||
**Suggestion:** Consider implementing `IDisposable` on the service or using a different pattern for options monitoring.
|
||||
|
||||
---
|
||||
|
||||
### 3.2 Magic Number for Page Size
|
||||
|
||||
**Location:** Multiple methods (Lines 386, 525, 634)
|
||||
|
||||
```csharp
|
||||
const int pageSize = 500;
|
||||
```
|
||||
|
||||
**Suggestion:** Extract to a private constant at class level for consistency and easier tuning:
|
||||
|
||||
```csharp
|
||||
private const int DefaultPageSize = 500;
|
||||
private const int MaxDeleteIterations = 10000;
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 3.3 Interface Method Region Names
|
||||
|
||||
**Location:** Interface definition (Lines 75-95, 95-138, etc.)
|
||||
|
||||
The interface uses `#region` blocks which are a code smell in interfaces. Regions hide the actual structure and make navigation harder.
|
||||
|
||||
**Suggestion:** Remove regions from the interface. They're more acceptable in implementation classes.
|
||||
|
||||
---
|
||||
|
||||
### 3.4 Sort Method Could Log Performance Metrics
|
||||
|
||||
**Location:** SortLocked method
|
||||
|
||||
For large sort operations, there's no logging to indicate how many items were actually modified.
|
||||
|
||||
**Suggestion:** Add debug logging:
|
||||
|
||||
```csharp
|
||||
_logger.LogDebug("Sort completed: {Modified}/{Total} items updated", saved.Count, itemsA.Length);
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 3.5 EmptyRecycleBinAsync Doesn't Use Async Pattern Throughout
|
||||
|
||||
**Location:** Line 431-432
|
||||
|
||||
```csharp
|
||||
public async Task<OperationResult> EmptyRecycleBinAsync(Guid userId)
|
||||
=> EmptyRecycleBin(await _userIdKeyResolver.GetAsync(userId));
|
||||
```
|
||||
|
||||
This is fine but inconsistent with newer patterns. The method is async only for the user resolution, then calls the synchronous method.
|
||||
|
||||
**Suggestion:** Leave as-is for consistency with existing Phase 1-3 patterns, or consider making the entire chain async in a future phase.
|
||||
|
||||
---
|
||||
|
||||
### 3.6 Unit Tests Could Verify Method Signatures More Strictly
|
||||
|
||||
**Location:** Task 5, Lines 1130-1141
|
||||
|
||||
The unit test `Interface_Has_Required_Method` uses reflection but doesn't validate return types.
|
||||
|
||||
**Suggestion:** Enhance tests to also verify return types:
|
||||
|
||||
```csharp
|
||||
Assert.That(method.ReturnType, Is.EqualTo(typeof(OperationResult)));
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 4. Questions for Clarification
|
||||
|
||||
### Q1: navigationUpdates Behavior
|
||||
Is the `navigationUpdates` variable intentionally unused, or should it trigger navigation cache updates? The original ContentService likely has logic for this that wasn't included in the extraction.
|
||||
|
||||
### Q2: IContentCrudService.GetById(int) Existence
|
||||
Does `IContentCrudService` have a `GetById(int id)` overload? The plan uses it on line 309 but only shows `GetById(Guid key)` in the interface excerpt.
|
||||
|
||||
### Q3: Nested Scope Behavior Intent
|
||||
Is the nested scope in `GetPermissions` intentional for isolation, or was it an oversight from copying the public method pattern?
|
||||
|
||||
### Q4: MoveToRecycleBin Special Case
|
||||
The plan's Move method handles `parentId == RecycleBinContent` specially but comments that it "should be called via facade". Given the facade intercepts this case, should the special handling in MoveOperationService be removed or kept for API completeness?
|
||||
|
||||
---
|
||||
|
||||
## 5. Final Recommendation
|
||||
|
||||
**Approve with Changes**
|
||||
|
||||
The plan is well-designed and follows established patterns. Before implementation:
|
||||
|
||||
### Must Fix (Critical):
|
||||
1. **Fix GetPermissions nested scope issue** - inline the repository call
|
||||
2. **Address navigationUpdates** - either use it or remove it (confirm original behavior first)
|
||||
3. **Verify IContentCrudService.GetById(int)** - ensure the method exists or use GetByIds
|
||||
4. **Fix parentKey for descendants in Copy** - or document if intentional
|
||||
|
||||
### Should Fix (Before Merge):
|
||||
5. **Improve DeleteLocked empty batch handling** - break immediately, don't just log
|
||||
|
||||
### Consider (Nice to Have):
|
||||
6. Extract page size constants
|
||||
7. Remove regions from interface
|
||||
8. Add performance logging to Sort
|
||||
|
||||
The plan is **ready for implementation after addressing the 4 critical issues**.
|
||||
|
||||
---
|
||||
|
||||
**Review Version:** 1
|
||||
**Status:** Approve with Changes
|
||||
@@ -0,0 +1,359 @@
|
||||
# Critical Implementation Review: Phase 4 - ContentMoveOperationService (v1.1)
|
||||
|
||||
**Plan File:** `2025-12-23-contentservice-refactor-phase4-implementation.md`
|
||||
**Plan Version:** 1.1
|
||||
**Review Date:** 2025-12-23
|
||||
**Reviewer:** Claude (Critical Implementation Review Skill)
|
||||
**Review Number:** 2
|
||||
|
||||
---
|
||||
|
||||
## 1. Overall Assessment
|
||||
|
||||
The v1.1 implementation plan has **successfully addressed the critical issues** identified in the first review. The plan is now in good shape for implementation.
|
||||
|
||||
**Strengths:**
|
||||
- All 4 critical issues from Review 1 have been addressed
|
||||
- Clear documentation of changes in the "Critical Review Response" section
|
||||
- Consistent patterns with Phases 1-3
|
||||
- Good notification preservation strategy
|
||||
- Comprehensive test coverage
|
||||
- Proper constant extraction for page size and iteration limits
|
||||
- Well-documented backwards compatibility decisions (parentKey in Copy)
|
||||
|
||||
**Remaining Concerns (Minor):**
|
||||
- One potential race condition in Sort operation
|
||||
- Missing validation in Copy for circular reference detection
|
||||
- Test isolation concern with static notification handlers
|
||||
|
||||
---
|
||||
|
||||
## 2. Critical Issues
|
||||
|
||||
### 2.1 RESOLVED: GetPermissions Nested Scope Issue
|
||||
|
||||
**Status:** ✅ Fixed correctly
|
||||
|
||||
The v1.1 plan now inlines the repository call directly within the existing scope:
|
||||
|
||||
```csharp
|
||||
// v1.1: Inlined GetPermissions to avoid nested scope issue (critical review 2.1)
|
||||
// The write lock is already held, so we can call the repository directly
|
||||
EntityPermissionCollection currentPermissions = DocumentRepository.GetPermissionsForEntity(content.Id);
|
||||
```
|
||||
|
||||
This is the correct fix. The comment explains the rationale.
|
||||
|
||||
---
|
||||
|
||||
### 2.2 RESOLVED: navigationUpdates Unused Variable
|
||||
|
||||
**Status:** ✅ Fixed correctly
|
||||
|
||||
The v1.1 plan removed the unused variable entirely and added documentation:
|
||||
|
||||
```csharp
|
||||
// v1.1: Removed unused navigationUpdates variable (critical review 2.2)
|
||||
// Navigation cache updates are handled by ContentTreeChangeNotification
|
||||
```
|
||||
|
||||
This is the correct approach. The `ContentTreeChangeNotification` with `TreeChangeTypes.RefreshBranch` is published at line 746-747, which triggers the cache refreshers.
|
||||
|
||||
---
|
||||
|
||||
### 2.3 RESOLVED: GetById(int) Method Signature
|
||||
|
||||
**Status:** ✅ Fixed correctly
|
||||
|
||||
The v1.1 plan uses the proper pattern:
|
||||
|
||||
```csharp
|
||||
// v1.1: Use GetByIds pattern since IContentCrudService.GetById takes Guid, not int
|
||||
IContent? parent = parentId == Constants.System.Root
|
||||
? null
|
||||
: _crudService.GetByIds(new[] { parentId }).FirstOrDefault();
|
||||
```
|
||||
|
||||
This matches how IContentCrudService works.
|
||||
|
||||
---
|
||||
|
||||
### 2.4 DOCUMENTED: parentKey for Descendants in Copy
|
||||
|
||||
**Status:** ✅ Documented as intentional
|
||||
|
||||
The v1.1 plan documents this as backwards-compatible behavior:
|
||||
|
||||
```csharp
|
||||
// v1.1: Note - parentKey is the original operation's target parent, not each descendant's
|
||||
// immediate parent. This matches original ContentService behavior for backwards compatibility
|
||||
// with existing notification handlers (see critical review 2.4).
|
||||
```
|
||||
|
||||
This is acceptable. The documentation makes the intentional decision clear to future maintainers.
|
||||
|
||||
---
|
||||
|
||||
### 2.5 RESOLVED: DeleteLocked Empty Batch Handling
|
||||
|
||||
**Status:** ✅ Fixed correctly
|
||||
|
||||
The v1.1 plan now breaks immediately when batch is empty:
|
||||
|
||||
```csharp
|
||||
// v1.1: Break immediately when batch is empty (fix from critical review 2.5)
|
||||
if (batch.Count == 0)
|
||||
{
|
||||
if (total > 0)
|
||||
{
|
||||
_logger.LogWarning(...);
|
||||
}
|
||||
break; // Break immediately, don't continue iterating
|
||||
}
|
||||
```
|
||||
|
||||
This prevents spinning through iterations when there's a data inconsistency.
|
||||
|
||||
---
|
||||
|
||||
## 3. New Issues Identified in v1.1
|
||||
|
||||
### 3.1 Sort Method Lacks Parent Consistency Validation (Medium Priority)
|
||||
|
||||
**Location:** Task 2, SortLocked method (lines 811-868)
|
||||
|
||||
**Description:** The Sort method accepts any collection of IContent items and assigns sequential sort orders, but doesn't validate that all items have the same parent.
|
||||
|
||||
```csharp
|
||||
public OperationResult Sort(IEnumerable<IContent> items, int userId = Constants.Security.SuperUserId)
|
||||
{
|
||||
// No validation that items share the same parent
|
||||
IContent[] itemsA = items.ToArray();
|
||||
// ...
|
||||
}
|
||||
```
|
||||
|
||||
**Why it matters:** If a caller accidentally passes content from different parents, the method will assign sort orders that don't make semantic sense. The items will have sort orders relative to each other but are in different containers.
|
||||
|
||||
**Impact:** Low - this is primarily an API misuse scenario, not a security or data corruption risk. The original ContentService has the same behavior.
|
||||
|
||||
**Suggested Fix (Nice-to-Have):**
|
||||
```csharp
|
||||
if (itemsA.Length > 0)
|
||||
{
|
||||
var firstParentId = itemsA[0].ParentId;
|
||||
if (itemsA.Any(c => c.ParentId != firstParentId))
|
||||
{
|
||||
throw new ArgumentException("All items must have the same parent.", nameof(items));
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**Recommendation:** Document this as expected API behavior rather than fix, for consistency with original implementation.
|
||||
|
||||
---
|
||||
|
||||
### 3.2 Copy Method Missing Circular Reference Check (Low Priority)
|
||||
|
||||
**Location:** Task 2, Copy method (line 642)
|
||||
|
||||
**Description:** The Copy method doesn't validate that you're not copying a node to one of its own descendants. While this shouldn't be possible via the UI, direct API usage could attempt it.
|
||||
|
||||
```csharp
|
||||
public IContent? Copy(IContent content, int parentId, bool relateToOriginal, bool recursive, int userId = ...)
|
||||
{
|
||||
// No check: is parentId a descendant of content.Id?
|
||||
}
|
||||
```
|
||||
|
||||
**Why it matters:** Attempting to copy a node recursively into its own subtree could create an infinite loop or stack overflow in the copy logic.
|
||||
|
||||
**Impact:** Low - the paging in GetPagedDescendants would eventually terminate, but the behavior would be confusing.
|
||||
|
||||
**Check Original:** Verify if the original ContentService has this check. If not, document as existing behavior.
|
||||
|
||||
---
|
||||
|
||||
### 3.3 Test Isolation with Static Notification Handlers (Low Priority)
|
||||
|
||||
**Location:** Task 6, Integration tests (lines 1685-1706)
|
||||
|
||||
**Description:** The test notification handler uses static `Action` delegates that are set/cleared in individual tests:
|
||||
|
||||
```csharp
|
||||
private class MoveNotificationHandler : ...
|
||||
{
|
||||
public static Action<ContentMovingNotification>? Moving { get; set; }
|
||||
// ...
|
||||
}
|
||||
```
|
||||
|
||||
**Why it matters:** If tests run in parallel (which NUnit supports), multiple tests modifying these static actions could interfere with each other, causing flaky test behavior.
|
||||
|
||||
**Impact:** Low - the tests use `UmbracoTestOptions.Database.NewSchemaPerTest` which typically runs tests sequentially per fixture.
|
||||
|
||||
**Suggested Fix:**
|
||||
```csharp
|
||||
// Add test fixture-level setup/teardown
|
||||
[TearDown]
|
||||
public void TearDown()
|
||||
{
|
||||
MoveNotificationHandler.Moving = null;
|
||||
MoveNotificationHandler.Moved = null;
|
||||
MoveNotificationHandler.Copying = null;
|
||||
MoveNotificationHandler.Copied = null;
|
||||
MoveNotificationHandler.Sorting = null;
|
||||
MoveNotificationHandler.Sorted = null;
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 3.4 PerformMoveLocked Path Calculation Edge Case (Low Priority)
|
||||
|
||||
**Location:** Task 2, PerformMoveLocked method (lines 442-446)
|
||||
|
||||
**Description:** The path calculation for descendants has a potential edge case when moving to the recycle bin:
|
||||
|
||||
```csharp
|
||||
paths[content.Id] =
|
||||
(parent == null
|
||||
? parentId == Constants.System.RecycleBinContent ? "-1,-20" : Constants.System.RootString
|
||||
: parent.Path) + "," + content.Id;
|
||||
```
|
||||
|
||||
**Why it matters:** The hardcoded `-1,-20` string assumes the recycle bin's path structure. If this ever changes, this code would break silently.
|
||||
|
||||
**Impact:** Very low - the recycle bin structure is fundamental and unlikely to change.
|
||||
|
||||
**Suggested Fix (Nice-to-Have):**
|
||||
```csharp
|
||||
// Use constant
|
||||
private const string RecycleBinPath = Constants.System.RecycleBinContentPathPrefix.TrimEnd(',');
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 4. Minor Issues & Improvements
|
||||
|
||||
### 4.1 Task 3 Missing Using Statement (Low Priority)
|
||||
|
||||
**Location:** Task 3, UmbracoBuilder.cs modification
|
||||
|
||||
The task says to add the service registration but doesn't mention adding a using statement if `ContentMoveOperationService` requires one. Verify the namespace is already imported.
|
||||
|
||||
---
|
||||
|
||||
### 4.2 Task 4 Cleanup List is Incomplete (Low Priority)
|
||||
|
||||
**Location:** Task 4, Step 5
|
||||
|
||||
The list of methods to remove mentions line numbers that may shift after editing. Also, there's an inline note about `TryGetParentKey` that should be resolved:
|
||||
|
||||
> Note: Keep `TryGetParentKey` as it's still used by `MoveToRecycleBin`. Actually, check if it's used elsewhere - may need to keep.
|
||||
|
||||
**Recommendation:** Clarify this before implementation - if `TryGetParentKey` is used by `MoveToRecycleBin`, it stays in ContentService.
|
||||
|
||||
---
|
||||
|
||||
### 4.3 EmptyRecycleBin Could Return OperationResult.Fail for Reference Constraint (Nice-to-Have)
|
||||
|
||||
**Location:** Task 2, EmptyRecycleBin method (lines 520-530)
|
||||
|
||||
When `DisableDeleteWhenReferenced` is true and items are skipped, the method still returns `Success`. There's no indication to the caller that some items weren't deleted.
|
||||
|
||||
```csharp
|
||||
if (_contentSettings.DisableDeleteWhenReferenced &&
|
||||
_relationService.IsRelated(content.Id, RelationDirectionFilter.Child))
|
||||
{
|
||||
continue; // Silently skips
|
||||
}
|
||||
```
|
||||
|
||||
**Suggestion:** Consider returning `OperationResult.Attempt` or similar to indicate partial success, or add the skipped items to the event messages.
|
||||
|
||||
---
|
||||
|
||||
### 4.4 Integration Test RecycleBinSmells Assumption (Minor)
|
||||
|
||||
**Location:** Task 6, line 1417
|
||||
|
||||
```csharp
|
||||
public void RecycleBinSmells_WhenEmpty_ReturnsFalse()
|
||||
{
|
||||
// Assert - depends on base class setup, but Trashed item should make it smell
|
||||
Assert.That(result, Is.True); // Trashed exists from base class
|
||||
}
|
||||
```
|
||||
|
||||
The test name says "WhenEmpty_ReturnsFalse" but the assertion is `Is.True`. The test should be renamed to match its actual behavior:
|
||||
|
||||
```csharp
|
||||
public void RecycleBinSmells_WhenTrashHasContent_ReturnsTrue()
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 5. Questions for Clarification
|
||||
|
||||
### Q1: ContentSettings OnChange Disposal
|
||||
The constructor subscribes to `contentSettings.OnChange()` but doesn't store the returned `IDisposable`. Is this pattern consistent with other services in the codebase? (Flagged in Review 1 as minor, not addressed in v1.1 response)
|
||||
|
||||
### Q2: Move to Recycle Bin Behavior
|
||||
Lines 359-360 handle `parentId == Constants.System.RecycleBinContent` specially but with a comment that it should be called via facade. Should this case throw an exception or warning log to discourage direct API usage?
|
||||
|
||||
### Q3: Relation Service Dependency
|
||||
The `EmptyRecycleBin` method uses `_relationService.IsRelated()`. Is this the same relation service used elsewhere, or should it be `IRelationService` (interface) for consistency?
|
||||
|
||||
---
|
||||
|
||||
## 6. Final Recommendation
|
||||
|
||||
**Approve as-is**
|
||||
|
||||
The v1.1 plan has successfully addressed all critical issues from the first review. The remaining issues identified in this review are all low priority:
|
||||
|
||||
| Issue | Priority | Recommendation |
|
||||
|-------|----------|----------------|
|
||||
| Sort parent validation | Medium | Document as existing behavior |
|
||||
| Copy circular reference check | Low | Verify original behavior, document |
|
||||
| Test static handlers | Low | Add TearDown method |
|
||||
| Path calculation constant | Very Low | Optional improvement |
|
||||
| Task instructions clarification | Low | Update before executing |
|
||||
| RecycleBin partial success | Nice-to-Have | Consider for future enhancement |
|
||||
| Test naming | Minor | Quick fix during implementation |
|
||||
|
||||
**The plan is ready for implementation.** The identified issues are either:
|
||||
1. Consistent with original ContentService behavior (by design)
|
||||
2. Test quality improvements that can be addressed during implementation
|
||||
3. Nice-to-have enhancements for future phases
|
||||
|
||||
### Implementation Checklist:
|
||||
- [ ] Verify `TryGetParentKey` usage in ContentService before removing methods
|
||||
- [ ] Rename `RecycleBinSmells_WhenEmpty_ReturnsFalse` test
|
||||
- [ ] Add `TearDown` method to integration tests for handler cleanup
|
||||
- [ ] Consider adding parent consistency check to Sort (optional)
|
||||
|
||||
---
|
||||
|
||||
**Review Version:** 2
|
||||
**Plan Version Reviewed:** 1.1
|
||||
**Status:** Approved
|
||||
|
||||
---
|
||||
|
||||
## Appendix: Review 1 Issues Status
|
||||
|
||||
| Issue ID | Description | Status in v1.1 |
|
||||
|----------|-------------|----------------|
|
||||
| 2.1 | GetPermissions nested scope | ✅ Fixed |
|
||||
| 2.2 | navigationUpdates unused | ✅ Fixed |
|
||||
| 2.3 | GetById(int) signature | ✅ Fixed |
|
||||
| 2.4 | parentKey for descendants | ✅ Documented |
|
||||
| 2.5 | DeleteLocked empty batch | ✅ Fixed |
|
||||
| 3.1 | ContentSettings disposal | ⚪ Not addressed (minor) |
|
||||
| 3.2 | Page size constants | ✅ Fixed |
|
||||
| 3.3 | Interface regions | ⚪ Kept (documented decision) |
|
||||
| 3.4 | Sort performance logging | ✅ Fixed |
|
||||
| 3.5 | EmptyRecycleBinAsync pattern | ⚪ Not addressed (minor) |
|
||||
| 3.6 | Unit test return types | ⚪ Not addressed (minor) |
|
||||
@@ -0,0 +1,54 @@
|
||||
# ContentService Refactoring Phase 4: Move Operation Service Implementation Plan - Completion Summary
|
||||
|
||||
### 1. Overview
|
||||
|
||||
The original plan specified extracting Move, Copy, Sort, and Recycle Bin operations from ContentService into a dedicated `IContentMoveOperationService`. The scope included creating an interface in Umbraco.Core, an implementation inheriting from `ContentServiceBase`, DI registration, ContentService delegation updates, unit tests, integration tests, test verification, design document updates, and git tagging.
|
||||
|
||||
**Overall Completion Status: FULLY COMPLETE**
|
||||
|
||||
All 9 tasks from the implementation plan have been successfully executed with all tests passing.
|
||||
|
||||
### 2. Completed Items
|
||||
|
||||
- **Task 1**: Created `IContentMoveOperationService.cs` interface with 10 methods covering Move, Copy, Sort, and Recycle Bin operations
|
||||
- **Task 2**: Created `ContentMoveOperationService.cs` implementation (~450 lines) inheriting from `ContentServiceBase`
|
||||
- **Task 3**: Registered service in DI container via `UmbracoBuilder.cs`
|
||||
- **Task 4**: Updated `ContentService.cs` to delegate Move/Copy/Sort operations to the new service
|
||||
- **Task 5**: Created unit tests (`ContentMoveOperationServiceInterfaceTests.cs`) verifying interface contract
|
||||
- **Task 6**: Created integration tests (`ContentMoveOperationServiceTests.cs`) with 19 tests covering all operations
|
||||
- **Task 7**: Ran full ContentService test suite - 220 passed, 2 skipped
|
||||
- **Task 8**: Updated design document marking Phase 4 as complete (revision 1.8)
|
||||
- **Task 9**: Created git tag `phase-4-move-extraction`
|
||||
|
||||
### 3. Partially Completed or Modified Items
|
||||
|
||||
- None. All tasks were completed as specified.
|
||||
|
||||
### 4. Omitted or Deferred Items
|
||||
|
||||
- None. All planned tasks were executed.
|
||||
|
||||
### 5. Discrepancy Explanations
|
||||
|
||||
No discrepancies exist between the plan and execution. The implementation incorporated all v1.1 critical review fixes as specified in the plan:
|
||||
|
||||
- GetPermissions nested scope issue - inlined repository call
|
||||
- navigationUpdates unused variable - removed entirely
|
||||
- GetById(int) method signature - changed to GetByIds pattern
|
||||
- parentKey for descendants in Copy - documented for backwards compatibility
|
||||
- DeleteLocked empty batch handling - break immediately when empty
|
||||
- Page size constants - extracted to class-level constants
|
||||
- Performance logging - added to Sort operation
|
||||
|
||||
### 6. Key Achievements
|
||||
|
||||
- **Full Test Coverage**: All 220 ContentService integration tests pass with no regressions
|
||||
- **Comprehensive New Tests**: 19 new integration tests specifically for ContentMoveOperationService
|
||||
- **Critical Review Incorporation**: All 8 issues from the critical review were addressed in the implementation
|
||||
- **Architectural Consistency**: Implementation follows established patterns from Phases 1-3
|
||||
- **Proper Orchestration Boundary**: `MoveToRecycleBin` correctly remains in ContentService facade for unpublish orchestration
|
||||
- **Git Milestone**: Phase 4 tag created for versioning (`phase-4-move-extraction`)
|
||||
|
||||
### 7. Final Assessment
|
||||
|
||||
The Phase 4 implementation fully meets the original plan's intent. The `IContentMoveOperationService` and `ContentMoveOperationService` were created with all specified methods (Move, Copy, Sort, EmptyRecycleBin, RecycleBinSmells, GetPagedContentInRecycleBin, EmptyRecycleBinAsync). ContentService now properly delegates to the new service while retaining `MoveToRecycleBin` for unpublish orchestration. All critical review fixes were incorporated. The test suite confirms behavioral equivalence with the original implementation. The design document and git repository are updated to reflect Phase 4 completion. The refactoring is now positioned to proceed to Phase 5 (Publish Operation Service).
|
||||
File diff suppressed because it is too large
Load Diff
@@ -302,6 +302,7 @@ namespace Umbraco.Cms.Core.DependencyInjection
|
||||
Services.AddUnique<IContentQueryOperationService, ContentQueryOperationService>();
|
||||
Services.AddUnique<IContentVersionOperationService, ContentVersionOperationService>();
|
||||
Services.AddUnique<IContentMoveOperationService, ContentMoveOperationService>();
|
||||
Services.AddUnique<IContentPublishOperationService, ContentPublishOperationService>();
|
||||
Services.AddUnique<IContentService>(sp =>
|
||||
new ContentService(
|
||||
sp.GetRequiredService<ICoreScopeProvider>(),
|
||||
@@ -324,7 +325,8 @@ namespace Umbraco.Cms.Core.DependencyInjection
|
||||
sp.GetRequiredService<IContentCrudService>(),
|
||||
sp.GetRequiredService<IContentQueryOperationService>(),
|
||||
sp.GetRequiredService<IContentVersionOperationService>(),
|
||||
sp.GetRequiredService<IContentMoveOperationService>()));
|
||||
sp.GetRequiredService<IContentMoveOperationService>(),
|
||||
sp.GetRequiredService<IContentPublishOperationService>()));
|
||||
Services.AddUnique<IContentBlueprintEditingService, ContentBlueprintEditingService>();
|
||||
Services.AddUnique<IContentEditingService, ContentEditingService>();
|
||||
Services.AddUnique<IContentPublishingService, ContentPublishingService>();
|
||||
|
||||
1758
src/Umbraco.Core/Services/ContentPublishOperationService.cs
Normal file
1758
src/Umbraco.Core/Services/ContentPublishOperationService.cs
Normal file
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
213
src/Umbraco.Core/Services/IContentPublishOperationService.cs
Normal file
213
src/Umbraco.Core/Services/IContentPublishOperationService.cs
Normal file
@@ -0,0 +1,213 @@
|
||||
// src/Umbraco.Core/Services/IContentPublishOperationService.cs
|
||||
using System.ComponentModel;
|
||||
using Umbraco.Cms.Core.Models;
|
||||
using Umbraco.Cms.Core.Persistence.Querying;
|
||||
|
||||
namespace Umbraco.Cms.Core.Services;
|
||||
|
||||
/// <summary>
|
||||
/// Service for content publishing operations (publish, unpublish, scheduled publishing, branch publishing).
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// <strong>Implementation Note:</strong> Do not implement this interface directly.
|
||||
/// Instead, inherit from <see cref="ContentServiceBase"/> which provides required
|
||||
/// infrastructure (scoping, repository access, auditing). Direct implementation
|
||||
/// without this base class will result in missing functionality.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// This interface is part of the ContentService refactoring initiative (Phase 5).
|
||||
/// It extracts publishing operations into a focused, testable service.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// <strong>Note:</strong> This interface is named IContentPublishOperationService to avoid
|
||||
/// collision with the existing IContentPublishingService which is an API-layer orchestrator.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// <strong>Versioning Policy:</strong> This interface follows additive-only changes.
|
||||
/// New methods may be added with default implementations. Existing methods will not
|
||||
/// be removed or have signatures changed without a 2 major version deprecation period.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
public interface IContentPublishOperationService : IService
|
||||
{
|
||||
#region Publishing
|
||||
|
||||
/// <summary>
|
||||
/// Publishes a document.
|
||||
/// </summary>
|
||||
/// <param name="content">The document to publish.</param>
|
||||
/// <param name="cultures">The cultures to publish. Use "*" for all cultures or specific culture codes.</param>
|
||||
/// <param name="userId">The identifier of the user performing the action.</param>
|
||||
/// <returns>The publish result indicating success or failure.</returns>
|
||||
/// <remarks>
|
||||
/// <para>When a culture is being published, it includes all varying values along with all invariant values.</para>
|
||||
/// <para>Wildcards (*) can be used as culture identifier to publish all cultures.</para>
|
||||
/// <para>An empty array (or a wildcard) can be passed for culture invariant content.</para>
|
||||
/// <para>Fires ContentPublishingNotification (cancellable) before publish and ContentPublishedNotification after.</para>
|
||||
/// </remarks>
|
||||
PublishResult Publish(IContent content, string[] cultures, int userId = Constants.Security.SuperUserId);
|
||||
|
||||
/// <summary>
|
||||
/// Publishes a document branch.
|
||||
/// </summary>
|
||||
/// <param name="content">The root document of the branch.</param>
|
||||
/// <param name="publishBranchFilter">Options for force publishing unpublished or re-publishing unchanged content.</param>
|
||||
/// <param name="cultures">The cultures to publish.</param>
|
||||
/// <param name="userId">The identifier of the user performing the operation.</param>
|
||||
/// <returns>Results for each document in the branch.</returns>
|
||||
/// <remarks>The root of the branch is always published, regardless of <paramref name="publishBranchFilter"/>.</remarks>
|
||||
IEnumerable<PublishResult> PublishBranch(IContent content, PublishBranchFilter publishBranchFilter, string[] cultures, int userId = Constants.Security.SuperUserId);
|
||||
|
||||
#endregion
|
||||
|
||||
#region Unpublishing
|
||||
|
||||
/// <summary>
|
||||
/// Unpublishes a document.
|
||||
/// </summary>
|
||||
/// <param name="content">The document to unpublish.</param>
|
||||
/// <param name="culture">The culture to unpublish, or "*" for all cultures.</param>
|
||||
/// <param name="userId">The identifier of the user performing the action.</param>
|
||||
/// <returns>The publish result indicating success or failure.</returns>
|
||||
/// <remarks>
|
||||
/// <para>By default, unpublishes the document as a whole, but it is possible to specify a culture.</para>
|
||||
/// <para>If the content type is variant, culture can be either '*' or an actual culture.</para>
|
||||
/// <para>If the content type is invariant, culture can be either '*' or null or empty.</para>
|
||||
/// <para>Fires ContentUnpublishingNotification (cancellable) before and ContentUnpublishedNotification after.</para>
|
||||
/// </remarks>
|
||||
PublishResult Unpublish(IContent content, string? culture = "*", int userId = Constants.Security.SuperUserId);
|
||||
|
||||
#endregion
|
||||
|
||||
#region Document Changes (Advanced API)
|
||||
|
||||
/// <summary>
|
||||
/// Commits pending document publishing/unpublishing changes.
|
||||
/// </summary>
|
||||
/// <param name="content">The document with pending publish state changes.</param>
|
||||
/// <param name="userId">The identifier of the user performing the action.</param>
|
||||
/// <param name="notificationState">Optional state dictionary for notification propagation across orchestrated operations.</param>
|
||||
/// <returns>The publish result indicating success or failure.</returns>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// <strong>This is an advanced API.</strong> Most consumers should use <see cref="Publish"/> or
|
||||
/// <see cref="Unpublish"/> instead.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// Call this after setting <see cref="IContent.PublishedState"/> to
|
||||
/// <see cref="PublishedState.Publishing"/> or <see cref="PublishedState.Unpublishing"/>.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// This method is exposed for orchestration scenarios where publish/unpublish must be coordinated
|
||||
/// with other operations (e.g., MoveToRecycleBin unpublishes before moving).
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
[EditorBrowsable(EditorBrowsableState.Advanced)]
|
||||
PublishResult CommitDocumentChanges(IContent content, int userId = Constants.Security.SuperUserId, IDictionary<string, object?>? notificationState = null);
|
||||
|
||||
#endregion
|
||||
|
||||
#region Scheduled Publishing
|
||||
|
||||
/// <summary>
|
||||
/// Publishes and unpublishes scheduled documents.
|
||||
/// </summary>
|
||||
/// <param name="date">The date to check schedules against.</param>
|
||||
/// <returns>Results for each processed document.</returns>
|
||||
IEnumerable<PublishResult> PerformScheduledPublish(DateTime date);
|
||||
|
||||
/// <summary>
|
||||
/// Gets documents having an expiration date before (lower than, or equal to) a specified date.
|
||||
/// </summary>
|
||||
/// <param name="date">The date to check against.</param>
|
||||
/// <returns>Documents scheduled for expiration.</returns>
|
||||
IEnumerable<IContent> GetContentForExpiration(DateTime date);
|
||||
|
||||
/// <summary>
|
||||
/// Gets documents having a release date before (lower than, or equal to) a specified date.
|
||||
/// </summary>
|
||||
/// <param name="date">The date to check against.</param>
|
||||
/// <returns>Documents scheduled for release.</returns>
|
||||
IEnumerable<IContent> GetContentForRelease(DateTime date);
|
||||
|
||||
#endregion
|
||||
|
||||
#region Schedule Management
|
||||
|
||||
/// <summary>
|
||||
/// Gets publish/unpublish schedule for a content node by integer id.
|
||||
/// </summary>
|
||||
/// <param name="contentId">Id of the content to load schedule for.</param>
|
||||
/// <returns>The content schedule collection.</returns>
|
||||
ContentScheduleCollection GetContentScheduleByContentId(int contentId);
|
||||
|
||||
/// <summary>
|
||||
/// Gets publish/unpublish schedule for a content node by GUID.
|
||||
/// </summary>
|
||||
/// <param name="contentId">Key of the content to load schedule for.</param>
|
||||
/// <returns>The content schedule collection.</returns>
|
||||
ContentScheduleCollection GetContentScheduleByContentId(Guid contentId);
|
||||
|
||||
/// <summary>
|
||||
/// Persists publish/unpublish schedule for a content node.
|
||||
/// </summary>
|
||||
/// <param name="content">The content item.</param>
|
||||
/// <param name="contentSchedule">The schedule to persist.</param>
|
||||
void PersistContentSchedule(IContent content, ContentScheduleCollection contentSchedule);
|
||||
|
||||
/// <summary>
|
||||
/// Gets a dictionary of content Ids and their matching content schedules.
|
||||
/// </summary>
|
||||
/// <param name="keys">The content keys.</param>
|
||||
/// <returns>A dictionary with nodeId and an IEnumerable of matching ContentSchedules.</returns>
|
||||
IDictionary<int, IEnumerable<ContentSchedule>> GetContentSchedulesByIds(Guid[] keys);
|
||||
|
||||
#endregion
|
||||
|
||||
#region Path Checks
|
||||
|
||||
/// <summary>
|
||||
/// Gets a value indicating whether a document is path-publishable.
|
||||
/// </summary>
|
||||
/// <param name="content">The content to check.</param>
|
||||
/// <returns>True if all ancestors are published.</returns>
|
||||
/// <remarks>A document is path-publishable when all its ancestors are published.</remarks>
|
||||
bool IsPathPublishable(IContent content);
|
||||
|
||||
/// <summary>
|
||||
/// Gets a value indicating whether a document is path-published.
|
||||
/// </summary>
|
||||
/// <param name="content">The content to check.</param>
|
||||
/// <returns>True if all ancestors and the document itself are published.</returns>
|
||||
/// <remarks>A document is path-published when all its ancestors, and the document itself, are published.</remarks>
|
||||
bool IsPathPublished(IContent? content);
|
||||
|
||||
#endregion
|
||||
|
||||
#region Workflow
|
||||
|
||||
/// <summary>
|
||||
/// Saves a document and raises the "sent to publication" events.
|
||||
/// </summary>
|
||||
/// <param name="content">The content to send to publication.</param>
|
||||
/// <param name="userId">The identifier of the user issuing the send to publication.</param>
|
||||
/// <returns>True if sending publication was successful otherwise false.</returns>
|
||||
/// <remarks>
|
||||
/// Fires ContentSendingToPublishNotification (cancellable) before and ContentSentToPublishNotification after.
|
||||
/// </remarks>
|
||||
bool SendToPublication(IContent? content, int userId = Constants.Security.SuperUserId);
|
||||
|
||||
#endregion
|
||||
|
||||
#region Published Content Queries
|
||||
|
||||
/// <summary>
|
||||
/// Gets published children of a parent content item.
|
||||
/// </summary>
|
||||
/// <param name="id">Id of the parent to retrieve children from.</param>
|
||||
/// <returns>Published child content items, ordered by sort order.</returns>
|
||||
IEnumerable<IContent> GetPublishedChildren(int id);
|
||||
|
||||
#endregion
|
||||
}
|
||||
@@ -804,6 +804,90 @@ internal sealed class ContentServiceRefactoringTests : UmbracoIntegrationTestWit
|
||||
|
||||
#endregion
|
||||
|
||||
#region Phase 5 - Publish Operation Tests
|
||||
|
||||
[Test]
|
||||
public void ContentPublishOperationService_Can_Be_Resolved_From_DI()
|
||||
{
|
||||
// Act
|
||||
var publishOperationService = GetRequiredService<IContentPublishOperationService>();
|
||||
|
||||
// Assert
|
||||
Assert.That(publishOperationService, Is.Not.Null);
|
||||
Assert.That(publishOperationService, Is.InstanceOf<ContentPublishOperationService>());
|
||||
}
|
||||
|
||||
[Test]
|
||||
public async Task Publish_Through_ContentService_Uses_PublishOperationService()
|
||||
{
|
||||
// Arrange
|
||||
var contentService = GetRequiredService<IContentService>();
|
||||
var contentTypeService = GetRequiredService<IContentTypeService>();
|
||||
|
||||
var contentType = new ContentTypeBuilder()
|
||||
.WithAlias("testPublishPage")
|
||||
.Build();
|
||||
await contentTypeService.SaveAsync(contentType, Constants.Security.SuperUserId);
|
||||
|
||||
var content = contentService.Create("Test Publish Page", Constants.System.Root, contentType.Alias);
|
||||
contentService.Save(content);
|
||||
|
||||
// Act
|
||||
var result = contentService.Publish(content, new[] { "*" });
|
||||
|
||||
// Assert
|
||||
Assert.That(result.Success, Is.True);
|
||||
Assert.That(content.Published, Is.True);
|
||||
}
|
||||
|
||||
[Test]
|
||||
public async Task Unpublish_Through_ContentService_Uses_PublishOperationService()
|
||||
{
|
||||
// Arrange
|
||||
var contentService = GetRequiredService<IContentService>();
|
||||
var contentTypeService = GetRequiredService<IContentTypeService>();
|
||||
|
||||
var contentType = new ContentTypeBuilder()
|
||||
.WithAlias("testUnpublishPage")
|
||||
.Build();
|
||||
await contentTypeService.SaveAsync(contentType, Constants.Security.SuperUserId);
|
||||
|
||||
var content = contentService.Create("Test Unpublish Page", Constants.System.Root, contentType.Alias);
|
||||
contentService.Save(content);
|
||||
contentService.Publish(content, new[] { "*" });
|
||||
|
||||
// Act
|
||||
var result = contentService.Unpublish(content);
|
||||
|
||||
// Assert
|
||||
Assert.That(result.Success, Is.True);
|
||||
Assert.That(content.Published, Is.False);
|
||||
}
|
||||
|
||||
[Test]
|
||||
public async Task IsPathPublishable_RootContent_ReturnsTrue()
|
||||
{
|
||||
// Arrange
|
||||
var contentService = GetRequiredService<IContentService>();
|
||||
var contentTypeService = GetRequiredService<IContentTypeService>();
|
||||
|
||||
var contentType = new ContentTypeBuilder()
|
||||
.WithAlias("testPathPage")
|
||||
.Build();
|
||||
await contentTypeService.SaveAsync(contentType, Constants.Security.SuperUserId);
|
||||
|
||||
var content = contentService.Create("Test Path Page", Constants.System.Root, contentType.Alias);
|
||||
contentService.Save(content);
|
||||
|
||||
// Act
|
||||
var result = contentService.IsPathPublishable(content);
|
||||
|
||||
// Assert
|
||||
Assert.That(result, Is.True);
|
||||
}
|
||||
|
||||
#endregion
|
||||
|
||||
/// <summary>
|
||||
/// Notification handler that tracks the order of notifications for test verification.
|
||||
/// </summary>
|
||||
|
||||
@@ -0,0 +1,169 @@
|
||||
using System.ComponentModel;
|
||||
using NUnit.Framework;
|
||||
using Umbraco.Cms.Core.Models;
|
||||
using Umbraco.Cms.Core.Services;
|
||||
|
||||
namespace Umbraco.Cms.Tests.UnitTests.Umbraco.Core.Services;
|
||||
|
||||
/// <summary>
|
||||
/// Contract tests for IContentPublishOperationService interface.
|
||||
/// These tests verify interface design and expected behaviors.
|
||||
/// </summary>
|
||||
[TestFixture]
|
||||
public class ContentPublishOperationServiceContractTests
|
||||
{
|
||||
[Test]
|
||||
public void IContentPublishOperationService_Inherits_From_IService()
|
||||
{
|
||||
// Assert
|
||||
Assert.That(typeof(IService).IsAssignableFrom(typeof(IContentPublishOperationService)), Is.True);
|
||||
}
|
||||
|
||||
[Test]
|
||||
public void Publish_Method_Exists_With_Expected_Signature()
|
||||
{
|
||||
// Arrange
|
||||
var methodInfo = typeof(IContentPublishOperationService).GetMethod(
|
||||
nameof(IContentPublishOperationService.Publish),
|
||||
new[] { typeof(IContent), typeof(string[]), typeof(int) });
|
||||
|
||||
// Assert
|
||||
Assert.That(methodInfo, Is.Not.Null);
|
||||
Assert.That(methodInfo!.ReturnType, Is.EqualTo(typeof(PublishResult)));
|
||||
}
|
||||
|
||||
[Test]
|
||||
public void Unpublish_Method_Exists_With_Expected_Signature()
|
||||
{
|
||||
// Arrange
|
||||
var methodInfo = typeof(IContentPublishOperationService).GetMethod(
|
||||
nameof(IContentPublishOperationService.Unpublish),
|
||||
new[] { typeof(IContent), typeof(string), typeof(int) });
|
||||
|
||||
// Assert
|
||||
Assert.That(methodInfo, Is.Not.Null);
|
||||
Assert.That(methodInfo!.ReturnType, Is.EqualTo(typeof(PublishResult)));
|
||||
}
|
||||
|
||||
[Test]
|
||||
public void PublishBranch_Method_Exists_With_Expected_Signature()
|
||||
{
|
||||
// Arrange
|
||||
var methodInfo = typeof(IContentPublishOperationService).GetMethod(
|
||||
nameof(IContentPublishOperationService.PublishBranch),
|
||||
new[] { typeof(IContent), typeof(PublishBranchFilter), typeof(string[]), typeof(int) });
|
||||
|
||||
// Assert
|
||||
Assert.That(methodInfo, Is.Not.Null);
|
||||
Assert.That(methodInfo!.ReturnType, Is.EqualTo(typeof(IEnumerable<PublishResult>)));
|
||||
}
|
||||
|
||||
[Test]
|
||||
public void PerformScheduledPublish_Method_Exists_With_Expected_Signature()
|
||||
{
|
||||
// Arrange
|
||||
var methodInfo = typeof(IContentPublishOperationService).GetMethod(
|
||||
nameof(IContentPublishOperationService.PerformScheduledPublish),
|
||||
new[] { typeof(DateTime) });
|
||||
|
||||
// Assert
|
||||
Assert.That(methodInfo, Is.Not.Null);
|
||||
Assert.That(methodInfo!.ReturnType, Is.EqualTo(typeof(IEnumerable<PublishResult>)));
|
||||
}
|
||||
|
||||
[Test]
|
||||
public void GetContentScheduleByContentId_IntOverload_Exists()
|
||||
{
|
||||
// Arrange
|
||||
var methodInfo = typeof(IContentPublishOperationService).GetMethod(
|
||||
nameof(IContentPublishOperationService.GetContentScheduleByContentId),
|
||||
new[] { typeof(int) });
|
||||
|
||||
// Assert
|
||||
Assert.That(methodInfo, Is.Not.Null);
|
||||
Assert.That(methodInfo!.ReturnType, Is.EqualTo(typeof(ContentScheduleCollection)));
|
||||
}
|
||||
|
||||
[Test]
|
||||
public void GetContentScheduleByContentId_GuidOverload_Exists()
|
||||
{
|
||||
// Arrange
|
||||
var methodInfo = typeof(IContentPublishOperationService).GetMethod(
|
||||
nameof(IContentPublishOperationService.GetContentScheduleByContentId),
|
||||
new[] { typeof(Guid) });
|
||||
|
||||
// Assert
|
||||
Assert.That(methodInfo, Is.Not.Null);
|
||||
Assert.That(methodInfo!.ReturnType, Is.EqualTo(typeof(ContentScheduleCollection)));
|
||||
}
|
||||
|
||||
[Test]
|
||||
public void IsPathPublishable_Method_Exists()
|
||||
{
|
||||
// Arrange
|
||||
var methodInfo = typeof(IContentPublishOperationService).GetMethod(
|
||||
nameof(IContentPublishOperationService.IsPathPublishable),
|
||||
new[] { typeof(IContent) });
|
||||
|
||||
// Assert
|
||||
Assert.That(methodInfo, Is.Not.Null);
|
||||
Assert.That(methodInfo!.ReturnType, Is.EqualTo(typeof(bool)));
|
||||
}
|
||||
|
||||
[Test]
|
||||
public void IsPathPublished_Method_Exists()
|
||||
{
|
||||
// Arrange
|
||||
var methodInfo = typeof(IContentPublishOperationService).GetMethod(
|
||||
nameof(IContentPublishOperationService.IsPathPublished),
|
||||
new[] { typeof(IContent) });
|
||||
|
||||
// Assert
|
||||
Assert.That(methodInfo, Is.Not.Null);
|
||||
Assert.That(methodInfo!.ReturnType, Is.EqualTo(typeof(bool)));
|
||||
}
|
||||
|
||||
[Test]
|
||||
public void SendToPublication_Method_Exists()
|
||||
{
|
||||
// Arrange
|
||||
var methodInfo = typeof(IContentPublishOperationService).GetMethod(
|
||||
nameof(IContentPublishOperationService.SendToPublication),
|
||||
new[] { typeof(IContent), typeof(int) });
|
||||
|
||||
// Assert
|
||||
Assert.That(methodInfo, Is.Not.Null);
|
||||
Assert.That(methodInfo!.ReturnType, Is.EqualTo(typeof(bool)));
|
||||
}
|
||||
|
||||
[Test]
|
||||
public void CommitDocumentChanges_Method_Exists_With_NotificationState_Parameter()
|
||||
{
|
||||
// Arrange - Critical Review Option A: Exposed for orchestration
|
||||
var methodInfo = typeof(IContentPublishOperationService).GetMethod(
|
||||
nameof(IContentPublishOperationService.CommitDocumentChanges),
|
||||
new[] { typeof(IContent), typeof(int), typeof(IDictionary<string, object?>) });
|
||||
|
||||
// Assert
|
||||
Assert.That(methodInfo, Is.Not.Null);
|
||||
Assert.That(methodInfo!.ReturnType, Is.EqualTo(typeof(PublishResult)));
|
||||
}
|
||||
|
||||
[Test]
|
||||
public void CommitDocumentChanges_Has_EditorBrowsable_Advanced_Attribute()
|
||||
{
|
||||
// Arrange - Should be hidden from IntelliSense by default
|
||||
var methodInfo = typeof(IContentPublishOperationService).GetMethod(
|
||||
nameof(IContentPublishOperationService.CommitDocumentChanges),
|
||||
new[] { typeof(IContent), typeof(int), typeof(IDictionary<string, object?>) });
|
||||
|
||||
// Act
|
||||
var attribute = methodInfo?.GetCustomAttributes(typeof(EditorBrowsableAttribute), false)
|
||||
.Cast<EditorBrowsableAttribute>()
|
||||
.FirstOrDefault();
|
||||
|
||||
// Assert
|
||||
Assert.That(attribute, Is.Not.Null);
|
||||
Assert.That(attribute!.State, Is.EqualTo(EditorBrowsableState.Advanced));
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user