The solution is broken into 2 parts:
AreaCreatedSubscriber
This is ISubscriber that watches for StructureChangedNotification events and queues a one time job to create the queries.The reason I queued a job instead of just doing the work in this plugin was that when creating the query TFS was throwing an exception on validation (TF51011: The specified area path does not exist.) It seems that there is a slight delay between adding areas and them becoming valid for use in queries. I thought it was a caching issue but even when explicitly clearing the cache on the workitemstore it still happens, I found a post (New Area Path values are not available in work items) that suggested that tfs subscribes to its own events which then triggers a process of making the area available. This meant I needed to delay the creation of the queries until after all the events had completed, hence the job queue.
Also it is fairly good practice to push any event semi long running tasks into a job as it can delay actions for end users.
This gets installed to c:\Program Files\Microsoft Team Foundation Server 11.0\Application Tier\Web Services\bin\Plugins
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| public class AreaCreatedSubscriber : ISubscriber | |
| { | |
| public string Name | |
| { | |
| get { return "Create Default Queries"; } | |
| } | |
| public SubscriberPriority Priority | |
| { | |
| get { return SubscriberPriority.Normal; } | |
| } | |
| public EventNotificationStatus ProcessEvent(TeamFoundationRequestContext requestContext, NotificationType notificationType, object notificationEventArgs, out int statusCode, out string statusMessage, out Microsoft.TeamFoundation.Common.ExceptionPropertyCollection properties) | |
| { | |
| statusMessage = string.Empty; | |
| statusCode = 0; | |
| properties = null; | |
| try | |
| { | |
| if (notificationType == NotificationType.Notification) | |
| { | |
| var eventArgs = notificationEventArgs as StructureChangedNotification; | |
| if (eventArgs != null) | |
| { | |
| ICommonStructureService commonStructureService = requestContext.GetService<CommonStructureService>(); | |
| var changedNodes = commonStructureService.GetChangedNodes(requestContext, eventArgs.SequenceId - 1); | |
| XDocument xml = XDocument.Parse(changedNodes); | |
| XElement changedNode = (from XElement n in xml.Descendants("StructureElement") select n).First(); | |
| if (changedNode.Attributes("Deleted").First().Value.ToString() == true.ToString()) | |
| return EventNotificationStatus.ActionPermitted; | |
| string nodeId = changedNode.Attributes("Id").First().Value.ToString(); | |
| var node = commonStructureService.GetNode(requestContext, nodeId); | |
| if (node.StructureType != StructureType.ProjectModelHierarchy) | |
| return EventNotificationStatus.ActionPermitted; | |
| var reader = XmlReader.Create(new StringReader("<AreaPath>" + node.Path + "</AreaPath>")); | |
| var xmlData = new XmlDocument().ReadNode(reader); | |
| // Handle the notification by queueing the information we need for a job | |
| var jobService = requestContext.GetService<TeamFoundationJobService>(); | |
| jobService.QueueOneTimeJob(requestContext, "Create Default Queries", typeof(CreateDefaultQueriesJob).ToString(), xmlData, false); | |
| } | |
| } | |
| } | |
| catch (Exception e) | |
| { | |
| statusMessage = e.Message; | |
| } | |
| return EventNotificationStatus.ActionPermitted; | |
| } | |
| public Type[] SubscribedTypes() | |
| { | |
| return new[] { typeof(StructureChangedNotification) }; | |
| } | |
| } |
CreateDefaultQueriesJob
The second part is the actual job, its also fairly simple (although crudely written). It reads the Area path out of the event data and creates a folder hierarchy for the queries to live in. It then checks if the queries already exist and if not creates them.This job should probably be extended/cleanedup to read the queries from an external source, whether it be a WIQL file on the disk, some metadata stored on the team project, or just a special folder in source control.
This is installed into c:\Program Files\Microsoft Team Foundation Server 11.0\Application Tier\TFSJobAgent\plugins
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| public class CreateDefaultQueriesJob : ITeamFoundationJobExtension | |
| { | |
| public TeamFoundationJobExecutionResult Run(TeamFoundationRequestContext requestContext, TeamFoundationJobDefinition jobDefinition, DateTime queueTime, out string resultMessage) | |
| { | |
| resultMessage = ""; | |
| try | |
| { | |
| TeamFoundationLocationService service = requestContext.GetService<TeamFoundationLocationService>(); | |
| Uri selfReferenceUri = service.GetSelfReferenceUri(requestContext, service.GetDefaultAccessMapping(requestContext)); | |
| TfsTeamProjectCollection tfsTeamProjectCollection = new TfsTeamProjectCollection(selfReferenceUri); | |
| var workitemStore = tfsTeamProjectCollection.GetService<WorkItemStore>(); | |
| var jobDataXmlNode = jobDefinition.Data; | |
| // Expects node like <WorkItem>31</WorkItem> | |
| var areaPath = (from wi in XDocument.Parse(jobDataXmlNode.OuterXml).Elements() select wi.Value).First(); | |
| var nodes = areaPath.Split(new[] { '\\' }, StringSplitOptions.RemoveEmptyEntries); | |
| var queryHierarchy = workitemStore.Projects[nodes[0]].QueryHierarchy; | |
| QueryFolder currentLocation = queryHierarchy.FirstOrDefault(i => i.Name == "Shared Queries") as QueryFolder; | |
| foreach (var path in nodes.Skip(2)) | |
| { | |
| if (currentLocation.FirstOrDefault(i => i.Name == path) as QueryFolder != null) | |
| { | |
| currentLocation = currentLocation.FirstOrDefault(i => i.Name == path) as QueryFolder; | |
| } | |
| else | |
| { | |
| var folder = new QueryFolder(path); | |
| currentLocation.Add(folder); | |
| currentLocation = folder; | |
| queryHierarchy.Save(); | |
| } | |
| } | |
| queryHierarchy.Project.Store.RefreshCache(); | |
| if (currentLocation.FirstOrDefault(i => i.Name == "Open Bugs") == null) | |
| { | |
| var query = new QueryDefinition("Open Bugs", string.Format("SELECT [System.Id], [System.Title], [System.AssignedTo], [System.State], [Microsoft.VSTS.Common.Priority] FROM WorkItems WHERE [System.TeamProject] = @project and [System.WorkItemType] = 'Bug' and [System.State] = 'Open' and [System.AreaPath] under '{0}' ORDER BY [System.Id]", areaPath.Substring(1).Replace("\\Area", ""))); | |
| currentLocation.Add(query); | |
| } | |
| if (currentLocation.FirstOrDefault(i => i.Name == "Closed Bugs") == null) | |
| { | |
| var query = new QueryDefinition("Closed Bugs", string.Format("SELECT [System.Id], [System.Title], [System.AssignedTo], [System.State], [Microsoft.VSTS.Common.Priority] FROM WorkItems WHERE [System.TeamProject] = @project and [System.WorkItemType] = 'Bug' and [System.State] = 'Closed' and [System.AreaPath] under '{0}' ORDER BY [System.Id]", areaPath.Substring(1).Replace("\\Area", ""))); | |
| currentLocation.Add(query); | |
| } | |
| queryHierarchy.Save(); | |
| } | |
| catch (RequestCanceledException) | |
| { | |
| return TeamFoundationJobExecutionResult.Stopped; | |
| } | |
| catch (Exception exception) | |
| { | |
| resultMessage = exception.ToString(); | |
| return TeamFoundationJobExecutionResult.Failed; | |
| } | |
| return TeamFoundationJobExecutionResult.Succeeded; | |
| } | |
| } |
Debugging
I had a bunch of issues trying to get this to work.Firstly the TF51011 error - folders were appearing in the shared queries so I knew the plugin was doing something, luckily the exception was being logged to the event logs so it was really easy to find.
After moving the logic to a one time job I tried testing it only to find nothing happened. No folders created and nothing logged in the event logs. I figured that the event was still being fired so it was probably queueing the job, after a quick google I came across a blog article from Martin Hinshelwood debugging the TFS Active directory sync job this gave me a bunch of helpful debugging tips.
This lead me to the tfs project collection database
SELECT * FROM [Tfs_Enlighten].[dbo].[tbl_JobDefinition] where ExtensionName like '%CreateDefaultQueriesJob'
Returned rows but they weren't much help, jobs were being queued but I had no idea about if they were successful or not. I eventually discovered another table in the tfs_configuration database which contained the jobHistory
select * from tfs_configuration.dbo.tbl_JobHistory where jobid in (SELECT [JobId] FROM [Tfs_Enlighten].[dbo].[tbl_JobDefinition] where ExtensionName like '%CreateDefaultQueriesJob')
Also had one row for every time I queued the job, with the status result of 6, this time I needed to do some diving with ILSpy, which lead me to this enum
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| namespace Microsoft.TeamFoundation.Framework.Common | |
| { | |
| public enum TeamFoundationJobResult | |
| { | |
| None = -1, | |
| Succeeded, | |
| PartiallySucceeded, | |
| Failed, | |
| Stopped, | |
| Killed, | |
| Blocked, | |
| ExtensionNotFound, | |
| Inactive, | |
| Disabled, | |
| JobInitializationError | |
| } | |
| } |
ExtensionNotFound = 6 - TFS couldn't find my job! I double and triple checked all my code, and started diving through the JobRunner code in TFS trying to figure out why it wasn't loading. I noticed a few hints of MEF in the code so tried adding an [Export] attribute to the class, still no luck. Enabling the trace log by editing c:\Program Files\Microsoft Team Foundation Server 11.0\Application Tier\TFSJobAgent\TfsJobAgent.exe.config I started seeing a curious exception about a plugin being added to a dictionary twice.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Detailed Message: There was an error during job agent execution. The operation will be retried. Similar errors in the next five minutes may not be logged. | |
| Exception Message: An item with the same key has already been added. (type ArgumentException) | |
| Exception Stack Trace: at System.Collections.Generic.Dictionary`2.Insert(TKey key, TValue value, Boolean add) | |
| at Microsoft.TeamFoundation.Framework.Server.TeamFoundationExtensionUtility.LoadExtensionTypeMap[T](String pluginDirectory) | |
| at Microsoft.TeamFoundation.Framework.Server.JobApplication.SetupInternal() | |
| at Microsoft.TeamFoundation.Framework.Server.JobServiceUtil.RetryOperationsUntilSuccessful(RetryOperations operations, Int32 maxTries, Int32& delayOnExceptionSeconds) |
Especially interesting as it appears to check if the plugin is already registered in the dictionary before adding it, which makes me think they have a threading bug.
After removing the [Export] attribute and restarting the tfs job service a few times it seemed to come right.
Update: Apparently there's some new web access interfaces to view the status of TFS Jobs (and more), may have meant less database diving had I known at the time
