/// <summary>
/// Updates a subscription
/// </summary>
/// <param name="newSubscription">Subscription to update</param>
/// <returns>The updated subscription</returns>
public async Task <NotificationSubscription> UpdatedSubscriptionAsync(NotificationSubscriptionUpdateParameters updateParameters, string subscriptionId)
{
var client = await GetClientAsync <NotificationHttpClient>();
logger.LogInformation("UpdateSubscriptionAsync Id = {0}", subscriptionId);
var result = await client.UpdateSubscriptionAsync(updateParameters, subscriptionId);
return(result);
}
public NotificationSubscription CreateUpdateDeleteSubscription()
{
// Get the client
VssConnection connection = Context.Connection;
NotificationHttpClient notificationClient = connection.GetClient <NotificationHttpClient>();
//
// Part 1: create a subscription to get notified about certain pull request events
//
// Create parameters for the new subscription
NotificationSubscriptionCreateParameters createParams = new NotificationSubscriptionCreateParameters()
{
Description = "Someone is waiting on one of my pull requests",
Filter = new ExpressionFilter("ms.vss-code.git-pullrequest-event")
{
FilterModel = new ExpressionFilterModel()
{
Clauses = new ExpressionFilterClause[]
{
new ExpressionFilterClause()
{
FieldName = "Vote",
Operator = "Changes to",
Value = "Waiting for author",
LogicalOperator = "And"
},
new ExpressionFilterClause()
{
FieldName = "Created by",
Operator = "=",
Value = "[Me]",
LogicalOperator = "And"
}
}
}
},
Channel = new UserSubscriptionChannel()
};
// Scope to only events from one project
ProjectHttpClient projectClient = this.Context.Connection.GetClient <ProjectHttpClient>();
Guid projectId;
String projectName;
if (!this.Context.TryGetValue <String>("projectName", out projectName))
{
// Get the ID of the first project
projectId = projectClient.GetProjects().Result.First().Id;
}
else
{
// Get the ID of the specified project
projectId = projectClient.GetProject(projectName).Result.Id;
}
createParams.Scope = new SubscriptionScope()
{
Id = projectId
};
NotificationSubscription newSubscription = notificationClient.CreateSubscriptionAsync(createParams).Result;
String subscriptionId = newSubscription.Id;
Context.Log("New subscription created! ID: {0}", subscriptionId);
//
// Part 2: disable and delete the subscription
//
// Disable the new subscription
NotificationSubscriptionUpdateParameters updateParams = new NotificationSubscriptionUpdateParameters()
{
Status = SubscriptionStatus.Disabled
};
newSubscription = notificationClient.UpdateSubscriptionAsync(updateParams, subscriptionId).Result;
Context.Log("Is subscription disabled? {0}", newSubscription.Status < 0);
// Delete the subscription
notificationClient.DeleteSubscriptionAsync(subscriptionId).SyncResult();
// Try to get the subscription (should result in an exception)
try
{
newSubscription = notificationClient.GetSubscriptionAsync(subscriptionId, SubscriptionQueryFlags.IncludeFilterDetails).Result;
} catch (Exception e)
{
Context.Log("Unable to get the deleted subscription:" + e.Message);
}
// Try again (the default query flags says to return deleted subscriptions so this should work)
newSubscription = notificationClient.GetSubscriptionAsync(subscriptionId).Result;
return(newSubscription);
}
private async Task EnsureScheduledBuildFailSubscriptionExists(BuildDefinition pipeline, WebApiTeam team, bool persistChanges)
{
const string BuildFailureNotificationTag = "#AutomaticBuildFailureNotification";
var subscriptions = await service.GetSubscriptionsAsync(team.Id);
var subscription = subscriptions.FirstOrDefault(sub => sub.Description.Contains(BuildFailureNotificationTag));
logger.LogInformation("Team Is Subscribed TeamName = {0} PipelineId = {1}", team.Name, pipeline.Id);
string definitionName = $"\\{pipeline.Project.Name}\\{pipeline.Name}";
if (subscription == default)
{
var filterModel = new ExpressionFilterModel
{
Clauses = new ExpressionFilterClause[]
{
new ExpressionFilterClause {
Index = 1, LogicalOperator = "", FieldName = "Status", Operator = "=", Value = "Failed"
},
new ExpressionFilterClause {
Index = 2, LogicalOperator = "And", FieldName = "Definition name", Operator = "=", Value = definitionName
},
new ExpressionFilterClause {
Index = 3, LogicalOperator = "And", FieldName = "Build reason", Operator = "=", Value = "Scheduled"
}
}
};
var filter = new ExpressionFilter("ms.vss-build.build-completed-event", filterModel);
var identity = new IdentityRef
{
Id = team.Id.ToString(),
Url = team.IdentityUrl
};
var newSubscription = new NotificationSubscriptionCreateParameters
{
Channel = new UserSubscriptionChannel {
UseCustomAddress = false
},
Description = $"A build fails {BuildFailureNotificationTag}",
Filter = filter,
Scope = new SubscriptionScope {
Type = "none", Id = pipeline.Project.Id
},
Subscriber = identity,
};
logger.LogInformation("Creating Subscription PipelineId = {0}, TeamId = {1}", pipeline.Id, team.Id);
if (persistChanges)
{
subscription = await service.CreateSubscriptionAsync(newSubscription);
}
}
else
{
var filter = subscription.Filter as ExpressionFilter;
if (filter == null)
{
logger.LogWarning("Subscription expression is not correct for of team {0}", team.Name);
return;
}
var definitionClause = filter.FilterModel.Clauses.FirstOrDefault(c => c.FieldName == "Definition name");
if (definitionClause == null)
{
logger.LogWarning("Subscription doesn't have correct expression filters for of team {0}", team.Name);
return;
}
if (definitionClause.Value != definitionName)
{
definitionClause.Value = definitionName;
if (persistChanges)
{
var updateParameters = new NotificationSubscriptionUpdateParameters()
{
Channel = subscription.Channel,
Description = subscription.Description,
Filter = subscription.Filter,
Scope = subscription.Scope,
};
logger.LogInformation("Updating Subscription expression for team {0} with correct definition name {1}", team.Name, definitionName);
subscription = await service.UpdatedSubscriptionAsync(updateParameters, subscription.Id.ToString());
}
}
}
}
