// <inheritdoc />
public async Task <SiteExtensionInfo> GetLocalExtension(string id, bool checkLatest = true)
{
ITracer tracer = _traceFactory.GetTracer();
UIPackageMetadata package = null;
using (tracer.Step("Now querying from local repo for package '{0}'.", id))
{
package = await _localRepository.GetLatestPackageByIdFromSrcRepo(id);
}
if (package == null)
{
tracer.Trace("No package found from local repo with id: {0}.", id);
return(null);
}
SiteExtensionInfo info;
using (tracer.Step("Converting NuGet object to SiteExtensionInfo"))
{
info = await ConvertLocalPackageToSiteExtensionInfo(package, checkLatest, tracer : tracer);
}
SiteExtensionStatus armSettings = new SiteExtensionStatus(_environment.SiteExtensionSettingsPath, id, tracer);
armSettings.FillSiteExtensionInfo(info);
return(info);
}
// <inheritdoc />
public async Task <SiteExtensionInfo> GetLocalExtension(string id, bool checkLatest = true)
{
ITracer tracer = _traceFactory.GetTracer();
SiteExtensionInfo info = GetPreInstalledExtension(id);
if (info != null && info.ExtensionUrl != null)
{
tracer.Trace("Pre-installed site extension found: {0}", id);
}
else
{
UIPackageMetadata package = null;
using (tracer.Step("{0} is not a pre-installed package. Now querying from local repo.", id))
{
package = await _localRepository.GetLatestPackageById(id);
}
if (package == null)
{
tracer.Trace("No package found from local repo with id: {0}.", id);
return(null);
}
using (tracer.Step("Converting NuGet object to SiteExtensionInfo"))
{
info = await ConvertLocalPackageToSiteExtensionInfo(package, checkLatest, tracer : tracer);
}
}
SiteExtensionStatus armSettings = new SiteExtensionStatus(_environment.SiteExtensionSettingsPath, id, tracer);
armSettings.FillSiteExtensionInfo(info);
return(info);
}
public async Task <IEnumerable <SiteExtensionInfo> > GetLocalExtensions(string filter, bool checkLatest)
{
ITracer tracer = _traceFactory.GetTracer();
IEnumerable <SiteExtensionInfo> preInstalledExtensions = GetPreInstalledExtensions(filter, showEnabledOnly: true);
IEnumerable <UIPackageMetadata> searchResult = null;
List <SiteExtensionInfo> siteExtensionInfos = new List <SiteExtensionInfo>();
foreach (var item in preInstalledExtensions)
{
SiteExtensionStatus armSettings = new SiteExtensionStatus(_environment.SiteExtensionSettingsPath, item.Id, tracer);
armSettings.FillSiteExtensionInfo(item, defaultProvisionState: Constants.SiteExtensionProvisioningStateSucceeded);
}
using (tracer.Step("Search packages locally with filter: {0}", filter))
{
searchResult = await _localRepository.Search(filter);
siteExtensionInfos = await ConvertNuGetPackagesToSiteExtensionInfos(
searchResult,
async (uiPackage) =>
{
SiteExtensionInfo info = await ConvertLocalPackageToSiteExtensionInfo(uiPackage, checkLatest, tracer);
SiteExtensionStatus armSettings = new SiteExtensionStatus(_environment.SiteExtensionSettingsPath, info.Id, tracer);
armSettings.FillSiteExtensionInfo(info, defaultProvisionState: Constants.SiteExtensionProvisioningStateSucceeded);
return(info);
});
}
return(preInstalledExtensions.Concat(siteExtensionInfos));
}
private async Task <SiteExtensionInfo> InstallExtensionCore(string id, SiteExtensionInfo requestInfo, ITracer tracer)
{
var version = requestInfo.Version;
var feedUrl = requestInfo.FeedUrl;
var type = requestInfo.Type;
var installationArgs = requestInfo.InstallationArgs;
var packageUri = requestInfo.PackageUri;
try
{
using (tracer.Step("Installing '{0}' version '{1}' from '{2}'", id, version, StringUtils.ObfuscatePath(!string.IsNullOrEmpty(packageUri) ? packageUri : feedUrl)))
{
var installationLock = SiteExtensionInstallationLock.CreateLock(_environment.SiteExtensionSettingsPath, id, enableAsync: true);
// hold on to lock till action complete (success or fail)
return(await installationLock.LockOperationAsync <SiteExtensionInfo>(async() =>
{
return await TryInstallExtension(id, requestInfo, tracer);
}, "Installing SiteExtension", TimeSpan.Zero));
}
}
catch (Exception ex)
{
_analytics.UnexpectedException(
ex,
method: "PUT",
path: string.Format(CultureInfo.InvariantCulture, "/api/siteextensions/{0}", id),
result: Constants.SiteExtensionProvisioningStateFailed,
message: string.Format(CultureInfo.InvariantCulture, "{{\"version\": {0}, \"feed_url\": {1}}}", version, feedUrl),
trace: false);
// handle unexpected exception
tracer.TraceError(ex);
var info = new SiteExtensionInfo();
info.Id = id;
SiteExtensionStatus armStatus = new SiteExtensionStatus(_environment.SiteExtensionSettingsPath, id, tracer);
armStatus.Operation = Constants.SiteExtensionOperationInstall;
armStatus.ProvisioningState = Constants.SiteExtensionProvisioningStateFailed;
armStatus.Status = HttpStatusCode.BadRequest;
armStatus.FillSiteExtensionInfo(info);
tracer.Trace("Update arm settings for {0} installation. Status: {1}", id, armStatus.Status);
return(info);
}
}
// <inheritdoc />
public async Task <SiteExtensionInfo> GetLocalExtension(string id, bool checkLatest = true)
{
SiteExtensionInfo info;
ITracer tracer = _traceFactory.GetTracer();
using (tracer.Step("Now querying from local repo for package '{0}'.", id))
{
info = (await GetLocalExtensions(id)).FirstOrDefault();
}
if (info == null)
{
tracer.Trace("No package found from local repo with id: {0}.", id);
return(null);
}
SiteExtensionStatus armSettings = new SiteExtensionStatus(_environment.SiteExtensionSettingsPath, id, tracer);
armSettings.FillSiteExtensionInfo(info);
return(info);
}
/// <summary>
/// Gets and returns metadata for the locally installed site extension
/// </summary>
/// <param name="filter"></param>
/// <param name="checkLatest"></param>
/// <returns></returns>
public async Task <IEnumerable <SiteExtensionInfo> > GetLocalExtensions(string filter, bool checkLatest = true)
{
ITracer tracer = _traceFactory.GetTracer();
IEnumerable <SiteExtensionInfo> siteExtensionInfos;
using (tracer.Step("Search packages locally with filter: {0}", filter))
{
siteExtensionInfos = await FeedExtensionsV2.SearchLocalRepo(_rootPath, filter);
}
using (tracer.Step("Adding local metadata to site extensions"))
{
foreach (var ext in siteExtensionInfos)
{
await SetLocalInfo(ext);
SiteExtensionStatus armSettings = new SiteExtensionStatus(_environment.SiteExtensionSettingsPath, ext.Id, tracer);
armSettings.FillSiteExtensionInfo(ext, defaultProvisionState: Constants.SiteExtensionProvisioningStateSucceeded);
}
}
return(siteExtensionInfos);
}
// <inheritdoc />
public async Task <SiteExtensionInfo> InstallExtension(string id, string version, string feedUrl, SiteExtensionInfo.SiteExtensionType type, ITracer tracer)
{
try
{
var installationLock = SiteExtensionInstallationLock.CreateLock(_environment.SiteExtensionSettingsPath, id, enableAsync: true);
// hold on to lock till action complete (success or fail)
return(await installationLock.LockOperationAsync <SiteExtensionInfo>(async() =>
{
return await TryInstallExtension(id, version, feedUrl, type, tracer);
}, TimeSpan.Zero));
}
catch (Exception ex)
{
_analytics.UnexpectedException(
ex,
method: "PUT",
path: string.Format(CultureInfo.InvariantCulture, "/api/siteextensions/{0}", id),
result: Constants.SiteExtensionProvisioningStateFailed,
message: string.Format(CultureInfo.InvariantCulture, "{{\"version\": {0}, \"feed_url\": {1}}}", version, feedUrl),
trace: false);
// handle unexpected exception
tracer.TraceError(ex);
var info = new SiteExtensionInfo();
info.Id = id;
SiteExtensionStatus armStatus = new SiteExtensionStatus(_environment.SiteExtensionSettingsPath, id, tracer);
armStatus.Operation = Constants.SiteExtensionOperationInstall;
armStatus.ProvisioningState = Constants.SiteExtensionProvisioningStateFailed;
armStatus.Status = HttpStatusCode.BadRequest;
armStatus.FillSiteExtensionInfo(info);
tracer.Trace("Update arm settings for {0} installation. Status: {1}", id, armStatus.Status);
return(info);
}
}
// <inheritdoc />
public async Task<SiteExtensionInfo> InstallExtension(string id, string version, string feedUrl, SiteExtensionInfo.SiteExtensionType type, ITracer tracer)
{
try
{
using (tracer.Step("Installing '{0}' version '{1}' from '{2}'", id, version, feedUrl))
{
var installationLock = SiteExtensionInstallationLock.CreateLock(_environment.SiteExtensionSettingsPath, id, enableAsync: true);
// hold on to lock till action complete (success or fail)
return await installationLock.LockOperationAsync<SiteExtensionInfo>(async () =>
{
return await TryInstallExtension(id, version, feedUrl, type, tracer);
}, "Installing SiteExtension", TimeSpan.Zero);
}
}
catch (Exception ex)
{
_analytics.UnexpectedException(
ex,
method: "PUT",
path: string.Format(CultureInfo.InvariantCulture, "/api/siteextensions/{0}", id),
result: Constants.SiteExtensionProvisioningStateFailed,
message: string.Format(CultureInfo.InvariantCulture, "{{\"version\": {0}, \"feed_url\": {1}}}", version, feedUrl),
trace: false);
// handle unexpected exception
tracer.TraceError(ex);
var info = new SiteExtensionInfo();
info.Id = id;
SiteExtensionStatus armStatus = new SiteExtensionStatus(_environment.SiteExtensionSettingsPath, id, tracer);
armStatus.Operation = Constants.SiteExtensionOperationInstall;
armStatus.ProvisioningState = Constants.SiteExtensionProvisioningStateFailed;
armStatus.Status = HttpStatusCode.BadRequest;
armStatus.FillSiteExtensionInfo(info);
tracer.Trace("Update arm settings for {0} installation. Status: {1}", id, armStatus.Status);
return info;
}
}
// <inheritdoc />
public async Task<SiteExtensionInfo> GetLocalExtension(string id, bool checkLatest = true)
{
ITracer tracer = _traceFactory.GetTracer();
SiteExtensionInfo info = GetPreInstalledExtension(id);
if (info != null && info.ExtensionUrl != null)
{
tracer.Trace("Pre-installed site extension found: {0}", id);
}
else
{
UIPackageMetadata package = null;
using (tracer.Step("{0} is not a pre-installed package. Now querying from local repo.", id))
{
package = await _localRepository.GetLatestPackageById(id);
}
if (package == null)
{
tracer.Trace("No package found from local repo with id: {0}.", id);
return null;
}
using (tracer.Step("Converting NuGet object to SiteExtensionInfo"))
{
info = await ConvertLocalPackageToSiteExtensionInfo(package, checkLatest, tracer: tracer);
}
}
SiteExtensionStatus armSettings = new SiteExtensionStatus(_environment.SiteExtensionSettingsPath, id, tracer);
armSettings.FillSiteExtensionInfo(info);
return info;
}
public async Task<IEnumerable<SiteExtensionInfo>> GetLocalExtensions(string filter, bool checkLatest)
{
ITracer tracer = _traceFactory.GetTracer();
IEnumerable<SiteExtensionInfo> preInstalledExtensions = GetPreInstalledExtensions(filter, showEnabledOnly: true);
IEnumerable<UIPackageMetadata> searchResult = null;
List<SiteExtensionInfo> siteExtensionInfos = new List<SiteExtensionInfo>();
foreach (var item in preInstalledExtensions)
{
SiteExtensionStatus armSettings = new SiteExtensionStatus(_environment.SiteExtensionSettingsPath, item.Id, tracer);
armSettings.FillSiteExtensionInfo(item, defaultProvisionState: Constants.SiteExtensionProvisioningStateSucceeded);
}
using (tracer.Step("Search packages locally with filter: {0}", filter))
{
searchResult = await _localRepository.Search(filter);
siteExtensionInfos = await ConvertNuGetPackagesToSiteExtensionInfos(
searchResult,
async (uiPackage) =>
{
SiteExtensionInfo info = await ConvertLocalPackageToSiteExtensionInfo(uiPackage, checkLatest, tracer);
SiteExtensionStatus armSettings = new SiteExtensionStatus(_environment.SiteExtensionSettingsPath, info.Id, tracer);
armSettings.FillSiteExtensionInfo(info, defaultProvisionState: Constants.SiteExtensionProvisioningStateSucceeded);
return info;
});
}
return preInstalledExtensions.Concat(siteExtensionInfos);
}
// <inheritdoc />
public async Task<SiteExtensionInfo> GetLocalExtension(string id, bool checkLatest = true)
{
ITracer tracer = _traceFactory.GetTracer();
UIPackageMetadata package = null;
using (tracer.Step("Now querying from local repo for package '{0}'.", id))
{
package = await _localRepository.GetLatestPackageById(id);
}
if (package == null)
{
tracer.Trace("No package found from local repo with id: {0}.", id);
return null;
}
SiteExtensionInfo info;
using (tracer.Step("Converting NuGet object to SiteExtensionInfo"))
{
info = await ConvertLocalPackageToSiteExtensionInfo(package, checkLatest, tracer: tracer);
}
SiteExtensionStatus armSettings = new SiteExtensionStatus(_environment.SiteExtensionSettingsPath, id, tracer);
armSettings.FillSiteExtensionInfo(info);
return info;
}
public async Task<HttpResponseMessage> GetLocalExtension(string id, bool checkLatest = true)
{
var tracer = _traceFactory.GetTracer();
SiteExtensionInfo extension = null;
HttpResponseMessage responseMessage = null;
if (ArmUtils.IsArmRequest(Request))
{
tracer.Trace("Incoming GetLocalExtension is arm request.");
SiteExtensionStatus armSettings = new SiteExtensionStatus(_environment.SiteExtensionSettingsPath, id, tracer);
if (string.Equals(Constants.SiteExtensionOperationInstall, armSettings.Operation, StringComparison.OrdinalIgnoreCase))
{
bool isInstallationLockHeld = IsInstallationLockHeldSafeCheck(id);
if (!isInstallationLockHeld
&& string.Equals(Constants.SiteExtensionProvisioningStateSucceeded, armSettings.ProvisioningState, StringComparison.OrdinalIgnoreCase))
{
tracer.Trace("Package {0} was just installed.", id);
extension = await _manager.GetLocalExtension(id, checkLatest);
if (extension == null)
{
using (tracer.Step("Status indicate {0} installed, but not able to find it from local repo.", id))
{
// should NOT happen
extension = new SiteExtensionInfo { Id = id };
responseMessage = Request.CreateResponse(HttpStatusCode.NotFound);
// package is gone, remove setting file
await armSettings.RemoveStatus();
}
}
else
{
if (SiteExtensionInstallationLock.IsAnyPendingLock(_environment.SiteExtensionSettingsPath, tracer))
{
using (tracer.Step("{0} finsihed installation. But there is other installation on-going, fake the status to be Created, so that we can restart once for all.", id))
{
// if there is other pending installation, fake the status
extension.ProvisioningState = Constants.SiteExtensionProvisioningStateCreated;
responseMessage = Request.CreateResponse(HttpStatusCode.Created, ArmUtils.AddEnvelopeOnArmRequest<SiteExtensionInfo>(extension, Request));
}
}
else
{
// it is important to call "SiteExtensionStatus.IsAnyInstallationRequireRestart" before "UpdateArmSettingsForSuccessInstallation"
// since "IsAnyInstallationRequireRestart" is depending on properties inside site extension status files
// while "UpdateArmSettingsForSuccessInstallation" will override some of the values
bool requireRestart = SiteExtensionStatus.IsAnyInstallationRequireRestart(_environment.SiteExtensionSettingsPath, _siteExtensionRoot, tracer, _analytics);
// clear operation, since opeation is done
if (UpdateArmSettingsForSuccessInstallation())
{
using (tracer.Step("{0} finsihed installation and batch update lock aquired. Will notify Antares GEO to restart website.", id))
{
responseMessage = Request.CreateResponse(armSettings.Status, ArmUtils.AddEnvelopeOnArmRequest<SiteExtensionInfo>(extension, Request));
// Notify GEO to restart website if necessary
if (requireRestart)
{
responseMessage.Headers.Add(Constants.SiteOperationHeaderKey, Constants.SiteOperationRestart);
}
}
}
else
{
tracer.Trace("Not able to aquire batch update lock, there must be another batch update on-going. return Created status to user to let them poll again.");
responseMessage = Request.CreateResponse(HttpStatusCode.Created, ArmUtils.AddEnvelopeOnArmRequest<SiteExtensionInfo>(extension, Request));
}
}
}
}
else if (!isInstallationLockHeld && !armSettings.IsTerminalStatus())
{
// no background thread is working on instalation
// app-pool must be recycled
using (tracer.Step("{0} installation cancelled, background thread must be dead.", id))
{
extension = new SiteExtensionInfo { Id = id };
extension.ProvisioningState = Constants.SiteExtensionProvisioningStateCanceled;
responseMessage = Request.CreateResponse(HttpStatusCode.OK, ArmUtils.AddEnvelopeOnArmRequest<SiteExtensionInfo>(extension, Request));
}
}
else
{
// on-going or failed, return status from setting
using (tracer.Step("Installation {0}", armSettings.Status))
{
extension = new SiteExtensionInfo { Id = id };
armSettings.FillSiteExtensionInfo(extension);
responseMessage = Request.CreateResponse(armSettings.Status, ArmUtils.AddEnvelopeOnArmRequest<SiteExtensionInfo>(extension, Request));
}
}
}
// normal GET request
if (responseMessage == null)
{
using (tracer.Step("ARM get : {0}", id))
{
extension = await _manager.GetLocalExtension(id, checkLatest);
}
if (extension == null)
{
extension = new SiteExtensionInfo { Id = id };
responseMessage = Request.CreateResponse(HttpStatusCode.NotFound);
}
else
{
armSettings.FillSiteExtensionInfo(extension);
responseMessage = Request.CreateResponse(HttpStatusCode.OK, ArmUtils.AddEnvelopeOnArmRequest<SiteExtensionInfo>(extension, Request));
}
}
}
else
{
using (tracer.Step("Get: {0}, is not a ARM request.", id))
{
extension = await _manager.GetLocalExtension(id, checkLatest);
}
if (extension == null)
{
throw new HttpResponseException(Request.CreateErrorResponse(HttpStatusCode.NotFound, id));
}
responseMessage = Request.CreateResponse(HttpStatusCode.OK, extension);
}
return responseMessage;
}
private async Task<SiteExtensionInfo> InitInstallSiteExtension(string id, SiteExtensionInfo.SiteExtensionType type)
{
SiteExtensionStatus settings = new SiteExtensionStatus(_environment.SiteExtensionSettingsPath, id, _traceFactory.GetTracer());
settings.ProvisioningState = Constants.SiteExtensionProvisioningStateCreated;
settings.Operation = Constants.SiteExtensionOperationInstall;
settings.Status = HttpStatusCode.Created;
settings.Type = type;
settings.Comment = null;
SiteExtensionInfo info = new SiteExtensionInfo();
info.Id = id;
settings.FillSiteExtensionInfo(info);
return await Task.FromResult(info);
}