Zongsoft.Upgrading.Web 0.1.0

Zongsoft.Upgrading.Web

English | 简体中文

Overview

Zongsoft.Upgrading.Web is the Web-side package manager for the Zongsoft automatic upgrading system.

It stores application and release metadata, hosts package files through the configured Zongsoft file-system storage, exposes management services for releases and instances, and provides the discovery endpoint used by the client upgrader.

Responsibilities

• Manage applications, editions, releases, release properties, release executors, and release publishing state.
• Import .manifest files generated by dotnet-upgrade pack.
• Upload package files for existing releases and write back file path, size, and checksum.
• Serve release discovery requests from Zongsoft.Upgrading.Upgrader.
• Filter releases by application name, edition, platform, architecture, visibility, published status, deprecation status, version range, package path, and package size.
• Run optional evaluator logic before returning a release to a specific application instance.

Installation

Install the NuGet package into a Zongsoft Web application:

dotnet add package Zongsoft.Upgrading.Web

The package includes plugin, option, deploy, and data-mapping artifacts:

• Zongsoft.Upgrading.Web.plugin
• Zongsoft.Upgrading.Web.option
• Zongsoft.Upgrading.Web.deploy
• Zongsoft.Upgrading.mapping

The plugin depends on:

• Zongsoft.Data
• Zongsoft.Data.SQLite

Configuration

The default option file declares release storage and the Upgrading database connection:

<options>
	<option path="/Upgrading/Settings">
		<setting setting.name="server" value="storage=zfs.s3:/upgrading/releases" />
	</option>

	<option path="/Data">
		<connectionSettings>
			<connectionSetting connectionSetting.name="Upgrading" driver="SQLite"
			                   value="Database=zongsoft.upgrading.db;PRAGMA:optimize;PRAGMA:journal_mode=WAL;PRAGMA:synchronous=normal;PRAGMA:temp_store=memory;" />
		</connectionSettings>
	</option>
</options>

Discovery API

The client upgrader calls the Upgrader controller in the Upgrading area:

GET /Upgrading/Upgrader/{name}/{edition?}?Platform=Windows&Architecture=X64&CurrentlyVersion=1.0.0

The response is an XML release stream that the client upgrader can parse with the shared Release reader.

Evaluators

Evaluators allow the server to decide whether a release is suitable for a specific request. A release can specify an evaluator name and evaluator settings. When a matching evaluator is registered in Module.Current.Evaluators, the Web module calls it with:

• application name;
• evaluator settings;
• request query parameters;
• request headers.

Only releases whose evaluator returns true are returned to the upgrader.

Registered evaluators can be inspected through:

GET /Upgrading/Upgrader/Evaluators

Release Management

The Releases controller extends the Zongsoft service controller conventions and adds two upgrade-specific operations:

The package storage path is generated from release identity:

{storage}/{lowercase-release-name}/{release-name}[-edition]@{version}_{runtime}

For example:

zfs.s3:/upgrading/releases/zongsoft.daemon/Zongsoft.Daemon-stable@1.1.0_win-x64

Release Filtering

A release is returned to the upgrader only when it is:

• visible;
• published;
• not deprecated;
• matching the requested application name;
• matching platform and architecture;
• matching the requested edition, or edition-less when the request edition is empty or _;
• newer than CurrentlyVersion, when provided;
• not newer than UpgradingVersion, when provided;
• associated with an existing package file path;
• associated with a positive package size.

Typical Workflow

1. Use Zongsoft.Tools.Upgrader to pack an application release.
2. Import the generated .manifest file into the Web package manager.
3. Upload the matching package file for the imported release.
4. Mark the release as visible and published through the management API or data service.
5. Configure client applications to use the Web channel with the /Upgrading/Upgrader endpoint.

Notes

• The storage setting should point to a file-system provider accessible by the Web application.
• Package upload updates checksum from the stored file, so manually changed package files should be re-uploaded or recalculated.
• Evaluators receive both query parameters and headers, making them suitable for staged rollout, instance targeting, or hardware-bound licensing policies.

License

This project is licensed under the MIT license.