Sync the package version when synchronizing an entire project

Author: dtdesign

ts/WoltLabSuite/Core/Acp/Ui/Devtools/Project/Sync.ts

@@ -4,6 +4,7 @@ import { AjaxCallbackSetup, AjaxResponseException } from "../../../../Ajax/Data"
 import { DialogCallbackSetup } from "../../../../Ui/Dialog/Data";
 import { dialogFactory } from "../../../../Component/Dialog";
 import { showDefaultSuccessSnackbar } from "WoltLabSuite/Core/Component/Snackbar";
+import { syncVersion } from "WoltLabSuite/Core/Api/DevtoolsProjects/SyncVersion";
 
 interface PipData {
   dependencies: string[];
@@ -37,6 +38,7 @@ class AcpUiDevtoolsProjectSync {
   private readonly pips: PipData[] = [];
   private readonly projectId: number;
   private queue: PendingPip[] = [];
+  #syncVersionAfterCompletion = false;
 
   constructor(projectId: number) {
     this.projectId = projectId;
@@ -162,6 +164,7 @@ class AcpUiDevtoolsProjectSync {
     }
 
     this.buttonSyncAll.classList.add("disabled");
+    this.#syncVersionAfterCompletion = true;
 
     this.queue = [];
     this.pips.forEach((pip) => {
@@ -174,9 +177,23 @@ class AcpUiDevtoolsProjectSync {
 
   private syncNext(): void {
     if (this.queue.length === 0) {
-      this.buttonSyncAll.classList.remove("disabled");
-
-      showDefaultSuccessSnackbar();
+      const showSuccess = () => {
+        this.buttonSyncAll.classList.remove("disabled");
+
+        showDefaultSuccessSnackbar();
+      };
+
+      if (this.#syncVersionAfterCompletion) {
+        void this.#syncPackageVersion()
+          .then(() => {
+            showSuccess();
+          })
+          .finally(() => {
+            this.#syncVersionAfterCompletion = false;
+          });
+      } else {
+        showSuccess();
+      }
 
       return;
     }
@@ -189,6 +206,10 @@ class AcpUiDevtoolsProjectSync {
     return `${pluginName}-${target}`;
   }
 
+  async #syncPackageVersion(): Promise<void> {
+    await syncVersion(this.projectId);
+  }
+
   _ajaxSuccess(data: AjaxResponse): void {
     const identifier = this.getButtonIdentifier(data.returnValues.pluginName, data.returnValues.target);
     this.buttons.get(identifier)!.disabled = false;

ts/WoltLabSuite/Core/Api/DevtoolsProjects/SyncVersion.ts

@@ -0,0 +1,19 @@
+/**
+ * Synchronizes the version of an installed package with the versio number in
+ * the `package.xml` of the project.
+ *
+ * @author    Alexander Ebert
+ * @copyright 2001-2025 WoltLab GmbH
+ * @license   GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
+ * @since     6.2
+ * @woltlabExcludeBundle all
+ */
+
+import { prepareRequest } from "WoltLabSuite/Core/Ajax/Backend";
+import { fromInfallibleApiRequest } from "../Result";
+
+export async function syncVersion(projectId: number): Promise<[]> {
+  return fromInfallibleApiRequest(() => {
+    return prepareRequest(`${window.WSC_RPC_API_URL}core/devtools-projects/${projectId}/sync-version`).post().fetchAsJson();
+  });
+}

wcfsetup/install/files/js/WoltLabSuite/Core/Acp/Ui/Devtools/Project/Sync.js

@@ -152,6 +152,7 @@ static function (\wcf\event\endpoint\ControllerCollecting $event) {
                 $event->register(new \wcf\system\endpoint\controller\core\comments\responses\RenderResponse());
                 $event->register(new \wcf\system\endpoint\controller\core\comments\responses\RenderResponses());
                 $event->register(new \wcf\system\endpoint\controller\core\comments\responses\UpdateResponse());
+                $event->register(new \wcf\system\endpoint\controller\core\devtoolsProjects\SyncVersion());
                 $event->register(new \wcf\system\endpoint\controller\core\exceptions\RenderException());
                 $event->register(new \wcf\system\endpoint\controller\core\gridViews\GetRows());
                 $event->register(new \wcf\system\endpoint\controller\core\gridViews\GetGridView());

wcfsetup/install/files/js/WoltLabSuite/Core/Api/DevtoolsProjects/SyncVersion.js

@@ -0,0 +1,68 @@
+<?php
+
+namespace wcf\system\endpoint\controller\core\devtoolsProjects;
+
+use Laminas\Diactoros\Response\JsonResponse;
+use Psr\Http\Message\ResponseInterface;
+use Psr\Http\Message\ServerRequestInterface;
+use wcf\data\devtools\project\DevtoolsProject;
+use wcf\data\package\Package;
+use wcf\data\package\PackageEditor;
+use wcf\http\Helper;
+use wcf\system\cache\builder\PackageCacheBuilder;
+use wcf\system\endpoint\IController;
+use wcf\system\endpoint\PostRequest;
+use wcf\system\exception\PermissionDeniedException;
+use wcf\system\exception\UserInputException;
+use wcf\system\WCF;
+
+/**
+ * Syncs the version of the installed package with the one provided by the
+ * package.xml in the project.
+ *
+ * @author      Alexander Ebert
+ * @copyright   2001-2025 WoltLab GmbH
+ * @license     GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
+ * @since       6.2
+ */
+#[PostRequest('/core/devtools-projects/{id:\d+}/sync-version')]
+final class SyncVersion implements IController
+{
+    #[\Override]
+    public function __invoke(ServerRequestInterface $request, array $variables): ResponseInterface
+    {
+        $project = Helper::fetchObjectFromRequestParameter($variables['id'], DevtoolsProject::class);
+
+        $this->assertProjectCanBeManaged();
+
+        $package = $project->getPackage();
+        if ($package === null) {
+            throw new UserInputException('projectID');
+        }
+
+        $this->syncVersion($project, $package);
+
+        return new JsonResponse([]);
+    }
+
+    private function syncVersion(DevtoolsProject $project, Package $package): void
+    {
+        $projectVersion = $project->getPackageArchive()->getPackageInfo('version');
+        if (Package::compareVersion($package->packageVersion, $projectVersion, '>=')) {
+            return;
+        }
+
+        (new PackageEditor($package))->update([
+            'packageVersion' => $projectVersion,
+        ]);
+
+        PackageCacheBuilder::getInstance()->reset();
+    }
+
+    private function assertProjectCanBeManaged(): void
+    {
+        if (!ENABLE_DEVELOPER_TOOLS || !WCF::getSession()->getPermission('admin.configuration.package.canInstallPackage')) {
+            throw new PermissionDeniedException();
+        }
+    }
+}