Upgrade: Deprecates Mangement API controller for defunct our.umbraco.com version checker (#21011)

* fix: deprecates the upgrade checker

* fix: removes any deprecated UI that no longer has a function for upgrade checks in the backoffice

* chore: generates new api types

* chore: deprecates types

* chore: returns direct task

* docs: explains deprecation

* chore: deprecated model

---------

Co-authored-by: leekelleher <leekelleher@gmail.com>

Author: iOvergaard

src/Umbraco.Cms.Api.Management/Controllers/Server/UpgradeCheckServerController.cs

@@ -13,6 +13,7 @@ namespace Umbraco.Cms.Api.Management.Controllers.Server;
 
 [ApiVersion("1.0")]
 [Authorize(Policy = AuthorizationPolicies.RequireAdminAccess)]
+[Obsolete("Upgrade checks are no longer supported and this controller will be removed in Umbraco 19.")]
 public class UpgradeCheckServerController : ServerControllerBase
 {
     private readonly IUpgradeService _upgradeService;
@@ -27,6 +28,7 @@ public UpgradeCheckServerController(IUpgradeService upgradeService, IUmbracoVers
     [HttpGet("upgrade-check")]
     [MapToApiVersion("1.0")]
     [ProducesResponseType(typeof(UpgradeCheckResponseModel), StatusCodes.Status200OK)]
+    [Obsolete("Upgrade checks are no longer supported and this endpoint will be removed in Umbraco 19.")]
     public async Task<IActionResult> UpgradeCheck(CancellationToken cancellationToken)
     {
         UpgradeResult upgradeResult = await _upgradeService.CheckUpgrade(_umbracoVersion.SemanticVersion);

src/Umbraco.Cms.Api.Management/OpenApi.json

@@ -27854,6 +27854,7 @@
             "description": "The authenticated user does not have access to this resource"
           }
         },
+        "deprecated": true,
         "security": [
           {
             "Backoffice-User": [ ]

src/Umbraco.Cms.Api.Management/ViewModels/Server/UpgradeCheckResponseModel.cs

@@ -1,5 +1,6 @@
-namespace Umbraco.Cms.Api.Management.ViewModels.Server;
+namespace Umbraco.Cms.Api.Management.ViewModels.Server;
 
+[Obsolete("Upgrade checks are no longer supported and this model will be removed in Umbraco 19.")]
 public class UpgradeCheckResponseModel
 {
     public required string Type { get; init; }

src/Umbraco.Core/Persistence/Repositories/IUpgradeCheckRepository.cs

@@ -2,7 +2,9 @@
 
 namespace Umbraco.Cms.Core.Persistence.Repositories;
 
+[Obsolete("Upgrade checks are no longer supported and this interface will be removed in Umbraco 19.")]
 public interface IUpgradeCheckRepository
 {
+    [Obsolete("This method no longer has any function and will be removed in Umbraco 19.")]
     Task<UpgradeResult> CheckUpgradeAsync(SemVersion version);
 }

src/Umbraco.Core/Persistence/Repositories/UpgradeCheckRepository.cs

@@ -1,54 +1,16 @@
-using System.Text;
 using Umbraco.Cms.Core.Semver;
 using Umbraco.Cms.Core.Serialization;
 
 namespace Umbraco.Cms.Core.Persistence.Repositories;
 
+[Obsolete("Upgrade checks are no longer supported and this repository will be removed in Umbraco 19.")]
 public class UpgradeCheckRepository : IUpgradeCheckRepository
 {
-    private const string RestApiUpgradeChecklUrl = "https://our.umbraco.com/umbraco/api/UpgradeCheck/CheckUpgrade";
-    private static HttpClient? _httpClient;
-    private readonly IJsonSerializer _jsonSerializer;
-
-    public UpgradeCheckRepository(IJsonSerializer jsonSerializer) => _jsonSerializer = jsonSerializer;
-
-    public async Task<UpgradeResult> CheckUpgradeAsync(SemVersion version)
+    public UpgradeCheckRepository(IJsonSerializer jsonSerializer)
     {
-        try
-        {
-            _httpClient ??= new HttpClient { Timeout = TimeSpan.FromSeconds(1) };
-
-            using var content = new StringContent(_jsonSerializer.Serialize(new CheckUpgradeDto(version)), Encoding.UTF8, "application/json");
 
-            using HttpResponseMessage task = await _httpClient.PostAsync(RestApiUpgradeChecklUrl, content);
-            var json = await task.Content.ReadAsStringAsync();
-            UpgradeResult? result = _jsonSerializer.Deserialize<UpgradeResult>(json);
-
-            return result ?? new UpgradeResult("None", string.Empty, string.Empty);
-        }
-        catch (HttpRequestException)
-        {
-            // this occurs if the server for Our is down or cannot be reached
-            return new UpgradeResult("None", string.Empty, string.Empty);
-        }
     }
 
-    private sealed class CheckUpgradeDto
-    {
-        public CheckUpgradeDto(SemVersion version)
-        {
-            VersionMajor = version.Major;
-            VersionMinor = version.Minor;
-            VersionPatch = version.Patch;
-            VersionComment = version.Prerelease;
-        }
-
-        public int VersionMajor { get; }
-
-        public int VersionMinor { get; }
-
-        public int VersionPatch { get; }
-
-        public string VersionComment { get; }
-    }
+    [Obsolete("This method no longer has any function and will be removed in Umbraco 19.")]
+    public Task<UpgradeResult> CheckUpgradeAsync(SemVersion version) => Task.FromResult(new UpgradeResult("None", string.Empty, string.Empty));
 }

src/Umbraco.Core/Services/IUpgradeService.cs

@@ -2,7 +2,9 @@
 
 namespace Umbraco.Cms.Core.Services;
 
+[Obsolete("Upgrade checks are no longer supported and this service will be removed in Umbraco 19.")]
 public interface IUpgradeService
 {
+    [Obsolete("This method no longer has any function and will be removed in Umbraco 19.")]
     Task<UpgradeResult> CheckUpgrade(SemVersion version);
 }

src/Umbraco.Core/Services/UpgradeService.cs

@@ -3,6 +3,7 @@
 
 namespace Umbraco.Cms.Core.Services;
 
+[Obsolete("Upgrade checks are no longer supported and this service will be removed in Umbraco 19.")]
 public class UpgradeService : IUpgradeService
 {
     private readonly IUpgradeCheckRepository _upgradeCheckRepository;

src/Umbraco.Web.UI.Client/src/apps/backoffice/components/backoffice-header-logo.element.ts

@@ -1,11 +1,9 @@
 import { UMB_BACKOFFICE_CONTEXT } from '../backoffice.context.js';
-import { css, html, customElement, state } from '@umbraco-cms/backoffice/external/lit';
-import { isCurrentUserAnAdmin } from '@umbraco-cms/backoffice/current-user';
+import { css, html, customElement, state, nothing } from '@umbraco-cms/backoffice/external/lit';
 import { UmbLitElement } from '@umbraco-cms/backoffice/lit-element';
 import { UmbTextStyles } from '@umbraco-cms/backoffice/style';
 import { UMB_MODAL_MANAGER_CONTEXT } from '@umbraco-cms/backoffice/modal';
-import { UMB_NEWVERSION_MODAL, UMB_SYSINFO_MODAL } from '@umbraco-cms/backoffice/sysinfo';
-import type { UmbServerUpgradeCheck } from '@umbraco-cms/backoffice/sysinfo';
+import { UMB_SYSINFO_MODAL } from '@umbraco-cms/backoffice/sysinfo';
 
 /**
  * The backoffice header logo element.
@@ -22,14 +20,6 @@ export class UmbBackofficeHeaderLogoElement extends UmbLitElement {
 	@state()
 	private _version?: string;
 
-	@state()
-	private _isUserAdmin = false;
-
-	@state()
-	private _serverUpgradeCheck: UmbServerUpgradeCheck | null = null;
-
-	#backofficeContext?: typeof UMB_BACKOFFICE_CONTEXT.TYPE;
-
 	constructor() {
 		super();
 
@@ -42,23 +32,9 @@ export class UmbBackofficeHeaderLogoElement extends UmbLitElement {
 				},
 				'_observeVersion',
 			);
-
-			this.#backofficeContext = context;
 		});
 	}
 
-	protected override firstUpdated() {
-		this.#isAdmin();
-	}
-
-	async #isAdmin() {
-		this._isUserAdmin = await isCurrentUserAnAdmin(this);
-
-		if (this._isUserAdmin) {
-			this._serverUpgradeCheck = this.#backofficeContext ? await this.#backofficeContext.serverUpgradeCheck() : null;
-		}
-	}
-
 	override render() {
 		return html`
 			<uui-button
@@ -73,14 +49,7 @@ export class UmbBackofficeHeaderLogoElement extends UmbLitElement {
 				<umb-popover-layout>
 					<div id="modal">
 						<umb-app-logo id="logo" logo-type="logo"></umb-app-logo>
-						<span>${this._version}</span>
-
-						${this._serverUpgradeCheck
-							? html`<uui-button
-									@click=${this.#openNewVersion}
-									color="positive"
-									label=${this.localize.term('general_newVersionAvailable')}></uui-button>`
-							: ''}
+						<span>${this._version ?? nothing}</span>
 
 						<a href="https://umbraco.com" target="_blank" rel="noopener">Umbraco.com</a>
 
@@ -103,21 +72,6 @@ export class UmbBackofficeHeaderLogoElement extends UmbLitElement {
 			.catch(() => {});
 	}
 
-	async #openNewVersion() {
-		if (!this._serverUpgradeCheck) return;
-		const modalManager = await this.getContext(UMB_MODAL_MANAGER_CONTEXT);
-		if (!modalManager) return;
-		modalManager
-			.open(this, UMB_NEWVERSION_MODAL, {
-				data: {
-					comment: this._serverUpgradeCheck.comment,
-					downloadUrl: this._serverUpgradeCheck.url,
-				},
-			})
-			.onSubmit()
-			.catch(() => {});
-	}
-
 	static override styles = [
 		UmbTextStyles,
 		css`

src/Umbraco.Web.UI.Client/src/assets/lang/da.ts

@@ -995,7 +995,6 @@ export default {
 		lastUpdated: 'Sidst opdateret',
 		skipToMenu: 'Spring til menu',
 		skipToContent: 'Spring til indhold',
-		newVersionAvailable: 'Ny version tilgængelig',
 		duration: (duration: string, date: Date | string, now: Date | string) => {
 			if (new Date(date).getTime() < new Date(now).getTime()) return `for ${duration} siden`;
 			return `om ${duration}`;

src/Umbraco.Web.UI.Client/src/assets/lang/de.ts

@@ -900,7 +900,6 @@ export default {
 		header: 'Kopf',
 		systemField: 'System Feld',
 		lastUpdated: 'Zuletzt geändert',
-		newVersionAvailable: 'Neue Version verfügbar',
 	},
 	colors: {
 		black: 'Schwarz',