Merge pull request #2275 from HicServices/task/confluence-service-worker

Task/confluence service worker

Author: rdteviotdale

CHANGELOG.md

@@ -4,6 +4,9 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [9.1.1] - Unreleased
+- Allow Atlassian service workers to write to Confluence from RDMP
+
 ## [9.1.0] - 2025-11-24
 - Fix bug with duplicate searchables
 - Improve UI for committing cohorts across projects

Rdmp.Core/CommandExecution/AtomicCommands/ExecuteCommandExportCataloguesToConfluence.cs

@@ -22,6 +22,8 @@ public class ExecuteCommandExportCataloguesToConfluence : BasicCommandExecution,
         private readonly string _apiKey;
         private readonly string _owner;
         private readonly string _description;
+        private readonly bool _isServiceAccount;
+        private readonly int? _rootPageParent;
         private readonly HttpClient _client = new();
         private readonly Dictionary<int, string> _cataloguePageLookups = [];
         private string rootParentId = null;
@@ -91,14 +93,16 @@ private class ConfluencePageResponse
             public ConfluencePageVersion version { get; set; }
         }
 
-        public ExecuteCommandExportCataloguesToConfluence(IBasicActivateItems activator, string subdomain, int spaceId, string apiKey, string owner, string description)
+        public ExecuteCommandExportCataloguesToConfluence(IBasicActivateItems activator, string subdomain, int spaceId, string apiKey, string owner, string description, bool isServiceaccount, int? rootPageParent = null)
         {
             _activator = activator;
             _subdomain = subdomain;
             _spaceId = spaceId;
             _apiKey = apiKey;
             _owner = owner;
             _description = description;
+            _isServiceAccount = isServiceaccount;
+            _rootPageParent = rootPageParent;
         }
 
         private static ConfluencePageResponse ResponseToConfluenceResponseObject(HttpResponseMessage response)
@@ -162,6 +166,10 @@ private void CreateContainerPage(ConfluencePageBuilder builder, string uri)
                 title = $"{_owner} Catalogues",
                 body = new ConfluencePageBody() { value = rootPageHTML }
             };
+            if (_rootPageParent != null)
+            {
+                request.parentId = _rootPageParent.ToString() ;
+            }
             HttpResponseMessage response = Task.Run(async () => await _client.PostAsJsonAsync(uri, request)).Result;
             if (response.StatusCode == System.Net.HttpStatusCode.OK)
             {
@@ -200,7 +208,7 @@ private void CreateCataloguePage(Catalogue catalogue, ConfluencePageBuilder buil
             var request = new ConfluencePagePostRequest()
             {
                 spaceId = _spaceId.ToString(),
-                title = catalogue.Name,
+                title = $"{catalogue.Name}{(catalogue.Acronym != null ? $" ({catalogue.Acronym})" : "")}",
                 parentId = rootParentId,
                 body = new ConfluencePageBody() { value = cataloguePageHTML }
             };
@@ -256,8 +264,7 @@ public override void Execute()
                 .Where(c => !c.IsDeprecated && !c.IsInternalDataset && !c.IsProjectSpecific(_activator.RepositoryLocator.DataExportRepository))
                 .ToList();
             var builder = new ConfluencePageBuilder(catalogues, _owner, _description, _subdomain);
-            var uri = $"https://{_subdomain}.atlassian.net/wiki/api/v2/pages";
-
+            var uri = _isServiceAccount ? $"https://api.atlassian.com/ex/confluence/{_subdomain}/api/v2/pages" : $"https://{_subdomain}.atlassian.net/wiki/api/v2/pages";
             CreateContainerPage(builder, uri);
             if (rootParentId != null)
             {

Rdmp.Core/Dataset/Confluence/ConfluencePageBuilder.cs

@@ -19,20 +19,21 @@ public class ConfluencePageBuilder
         private readonly string _repositoryName = "";
         private readonly string _repositoryDescription = "";
         private readonly string _subdomain = "";
-        public ConfluencePageBuilder(List<Catalogue> catalogues, string name,string description, string subdomain) { 
+        public ConfluencePageBuilder(List<Catalogue> catalogues, string name, string description, string subdomain)
+        {
             _catalogues = catalogues;
             _repositoryName = name;
             _repositoryDescription = description;
             _subdomain = subdomain;
         }
 
-        private string BuildCatalogueOverviewHTML(Catalogue catalogue,string pageId)
+        private string BuildCatalogueOverviewHTML(Catalogue catalogue, string pageId)
         {
             Console.WriteLine($"Building overview for catalogue '{catalogue.Name}'");
-            string name = pageId != null ?$"<a href='https://{_subdomain}.atlassian.net/wiki/{pageId}'>{catalogue.Name}</a>" : catalogue.Name;
+            string name = pageId != null ? $"<a href='https://{_subdomain}.atlassian.net/wiki{pageId}'>{catalogue.Name}</a>" : catalogue.Name;
 
             return $"""
-                <h2>{catalogue.Name}</h2>
+                <h2>{catalogue.Name}{(catalogue.Acronym != null ? $" ({catalogue.Acronym})" : "")}</h2>
                 <table>
                 <tr>
                     <th>
@@ -44,6 +45,9 @@ Dataset Name
                     <th>
                         Tags
                     </th>
+                    <th>
+                        Acronym
+                    </th>
                 </tr>
                 <tr>
                     <td>
@@ -53,21 +57,25 @@ Dataset Name
                         {catalogue.Description}
                     </td>
                     <td>
-                        {string.Join(", ",catalogue.Search_keywords)}
+                        {string.Join(", ", catalogue.Search_keywords)}
+                    </td>
+                    <td>
+                    {catalogue.Acronym}
                     </td>
                 </tr>
                 </table>
                 """;
         }
 
-        public string BuildContainerPage(Dictionary<int, string> cataloguePageLookup) {
+        public string BuildContainerPage(Dictionary<int, string> cataloguePageLookup)
+        {
             Console.WriteLine($"Building container page. Found {_catalogues.Count} catalogues.");
             return $"""
            
             <h2>{_repositoryName} Catalogues</h2>
             <p>{_repositoryDescription}</p>
             <p><ac:structured-macro ac:name='toc'/></p>
-            {string.Join("",_catalogues.Select(c => { cataloguePageLookup.TryGetValue(c.ID, out var pageId); return BuildCatalogueOverviewHTML(c, pageId); }))}
+            {string.Join("", _catalogues.Select(c => { cataloguePageLookup.TryGetValue(c.ID, out var pageId); return BuildCatalogueOverviewHTML(c, pageId); }))}
             """;
         }
 
@@ -230,7 +238,7 @@ Null Possible (Y/N)
                         Has Lookups
                     </th>
                 </tr>
-                {string.Join("",catalogue.CatalogueItems.Where(ci => ci.ExtractionInformation is not null).Select(ci => BuildDataVariableRecord(ci)))}
+                {string.Join("", catalogue.CatalogueItems.Where(ci => ci.ExtractionInformation is not null).Select(ci => BuildDataVariableRecord(ci)))}
             </table>
             """;
         }