💣 flavour-specific options functionality done (... and let's see later on if it works)

nop77svk · nop77svk · commit c569239fc6ac · 2024-02-05T23:22:21.000+01:00
diff --git a/jwl.core/AppConfigFactory.cs b/jwl.core/AppConfigFactory.cs
@@ -67,13 +67,22 @@ public static AppConfig ReadConfig()
 
             result!.JiraServer.FlavourOptions = flavour switch
             {
+                JiraServerFlavour.Vanilla => flavourConfig.Get<VanillaJiraFlavourOptions>(opt =>
+                {
+                    opt.BindNonPublicProperties = false;
+                    opt.ErrorOnUnknownConfiguration = true;
+                }),
+                JiraServerFlavour.TempoTimeSheets => flavourConfig.Get<TempoTimesheetsFlavourOptions>(opt =>
+                {
+                    opt.BindNonPublicProperties = false;
+                    opt.ErrorOnUnknownConfiguration = true;
+                }),
                 JiraServerFlavour.ICTime => flavourConfig.Get<ICTimeFlavourOptions>(opt =>
                 {
                     opt.BindNonPublicProperties = false;
                     opt.ErrorOnUnknownConfiguration = true;
                 }),
-                JiraServerFlavour.Vanilla or JiraServerFlavour.TempoTimeSheets => null,
-                _ => throw new ArgumentOutOfRangeException(nameof(result.JiraServer.Flavour))
+                _ => throw new ArgumentOutOfRangeException(nameof(result.JiraServer.Flavour), $"Don't know how to read flavour {flavour} specific options config")
             };
         }
 
diff --git a/jwl.jira/Flavours/IFlavourOptions.cs b/jwl.jira/Flavours/IFlavourOptions.cs
@@ -3,6 +3,4 @@
 public interface IFlavourOptions
 {
     string PluginBaseUri { get; init; }
-    string DateFormat { get; init; }
-    string TimeSpanFormat { get; init; }
 }
diff --git a/jwl.jira/Flavours/JiraWithICTimePluginApi.cs b/jwl.jira/Flavours/JiraWithICTimePluginApi.cs
@@ -1,24 +1,19 @@
 ﻿namespace jwl.jira;
 
-using System.Diagnostics;
 using System.Globalization;
-using System.Net.Http.Json;
-using System.Xml.Linq;
 using System.Xml.Serialization;
 using jwl.infra;
 using jwl.jira.api.rest.request;
 using jwl.jira.Flavours;
 using jwl.wadl;
 
 // https://interconcept.atlassian.net/wiki/spaces/ICTIME/pages/31686672/API
-// https://interconcept.atlassian.net/wiki/spaces/ICBIZ/pages/34701333/REST+Services
 public class JiraWithICTimePluginApi
     : IJiraClient
 {
     public string UserName { get; }
     public api.rest.common.JiraUserInfo UserInfo => _vanillaJiraApi.UserInfo;
 
-    public string PluginBaseUri { get; } = "rest/ictime/1.0";
     public Lazy<Dictionary<string, wadl.ComposedWadlMethodDefinition>> Endpoints =>
         new Lazy<Dictionary<string, ComposedWadlMethodDefinition>>(() => this.GetWADL().Result
             .AsEnumerable()
@@ -42,7 +37,7 @@ public JiraWithICTimePluginApi(HttpClient httpClient, string userName, ICTimeFla
         _httpClient = httpClient;
         UserName = userName;
         _flavourOptions = flavourOptions ?? _defaultFlavourOptions;
-        _vanillaJiraApi = new VanillaJiraClient(httpClient, userName);
+        _vanillaJiraApi = new VanillaJiraClient(httpClient, userName, null);
     }
 
     public async Task<WorkLogType[]> GetAvailableActivities(string issueKey)
@@ -213,7 +208,7 @@ public async Task UpdateWorkLog(string issueKey, long worklogId, DateOnly day, i
 
     private async Task<WadlApplication> GetWADL()
     {
-        Uri uri = new Uri($"{PluginBaseUri}/application.wadl", UriKind.Relative);
+        Uri uri = new Uri($"{_flavourOptions.PluginBaseUri}/application.wadl", UriKind.Relative);
         using Stream response = await _httpClient.GetStreamAsync(uri);
         if (response == null || response.Length <= 0)
             throw new HttpRequestException($"Empty content received from ${uri}");
diff --git a/jwl.jira/Flavours/JiraWithTempoPluginApi.cs b/jwl.jira/Flavours/JiraWithTempoPluginApi.cs
@@ -2,6 +2,7 @@ namespace jwl.jira;
 using System.Net.Http.Json;
 using jwl.infra;
 using jwl.jira.api.rest.common;
+using jwl.jira.Flavours;
 using NoP77svk.Linq;
 
 // https://www.tempo.io/server-api-documentation/timesheets
@@ -11,21 +12,23 @@ public class JiraWithTempoPluginApi
     private const string WorklogTypeAttributeKey = @"_WorklogType_";
 
     private readonly HttpClient _httpClient;
+    private readonly TempoTimesheetsFlavourOptions _flavourOptions;
     private readonly VanillaJiraClient _vanillaJiraApi;
 
     public string UserName { get; }
     public api.rest.common.JiraUserInfo UserInfo => _vanillaJiraApi.UserInfo;
 
-    public JiraWithTempoPluginApi(HttpClient httpClient, string userName)
+    public JiraWithTempoPluginApi(HttpClient httpClient, string userName, TempoTimesheetsFlavourOptions? flavourOptions)
     {
         _httpClient = httpClient;
         UserName = userName;
-        _vanillaJiraApi = new VanillaJiraClient(httpClient, userName);
+        _flavourOptions = flavourOptions ?? new TempoTimesheetsFlavourOptions();
+        _vanillaJiraApi = new VanillaJiraClient(httpClient, userName, null);
     }
 
     public async Task<api.rest.response.TempoWorklogAttributeDefinition[]> GetWorklogAttributeDefinitions()
     {
-        return await _httpClient.GetAsJsonAsync<api.rest.response.TempoWorklogAttributeDefinition[]>(@"rest/tempo-core/1/work-attribute");
+        return await _httpClient.GetAsJsonAsync<api.rest.response.TempoWorklogAttributeDefinition[]>($"{_flavourOptions.PluginCoreUri}/work-attribute");
     }
 
     public async Task<WorkLogType[]> GetAvailableActivities(string issueKey)
@@ -77,7 +80,7 @@ public async Task<WorkLog[]> GetIssueWorkLogs(DateOnly from, DateOnly to, IEnume
             IssueKey = issueKeys?.ToArray(),
             UserKey = new string[] { userKey }
         };
-        var response = await _httpClient.PostAsJsonAsync(@"rest/tempo-timesheets/4/worklogs/search", request);
+        var response = await _httpClient.PostAsJsonAsync($"{_flavourOptions.PluginBaseUri}/worklogs/search", request);
         var tempoWorkLogs = await HttpClientJsonExt.DeserializeJsonStreamAsync<api.rest.response.TempoWorklog[]>(await response.Content.ReadAsStreamAsync());
 
         var result = tempoWorkLogs
@@ -129,15 +132,15 @@ public async Task AddWorkLogPeriod(string issueKey, DateOnly dayFrom, DateOnly d
             }
         };
 
-        HttpResponseMessage response = await _httpClient.PostAsJsonAsync(@"rest/tempo-timesheets/4/worklogs", request);
+        HttpResponseMessage response = await _httpClient.PostAsJsonAsync($"{_flavourOptions.PluginBaseUri}/worklogs", request);
         await VanillaJiraClient.CheckHttpResponseForErrorMessages(response);
     }
 
     public async Task DeleteWorkLog(long issueId, long worklogId, bool notifyUsers = false)
     {
         UriBuilder uriBuilder = new UriBuilder()
         {
-            Path = new UriPathBuilder(@"rest/tempo-timesheets/4/worklogs")
+            Path = new UriPathBuilder($"{_flavourOptions.PluginBaseUri}/worklogs")
                 .Add(worklogId.ToString())
         };
 
@@ -154,7 +157,7 @@ private async Task UpdateWorklogPeriod(string issueKey, long worklogId, DateOnly
     {
         UriBuilder uriBuilder = new UriBuilder()
         {
-            Path = new UriPathBuilder(@"rest/tempo-timesheets/4/worklogs")
+            Path = new UriPathBuilder($"{_flavourOptions.PluginBaseUri}/worklogs")
                 .Add(worklogId.ToString())
         };
         var request = new api.rest.request.TempoUpdateWorklog()
diff --git a/jwl.jira/Flavours/ServerApiFactory.cs b/jwl.jira/Flavours/ServerApiFactory.cs
@@ -2,33 +2,36 @@
 
 public static class ServerApiFactory
 {
-    public static IJiraClient CreateApi(HttpClient httpClient, string userName, JiraServerFlavour serverClass, object? flavourOptions)
+    public static IJiraClient CreateApi(HttpClient httpClient, string userName, JiraServerFlavour serverFlavour, IFlavourOptions? flavourOptions)
     {
-        return serverClass switch
+        try
         {
-            JiraServerFlavour.Vanilla => new VanillaJiraClient(httpClient, userName),
-            JiraServerFlavour.TempoTimeSheets => new JiraWithTempoPluginApi(httpClient, userName),
-            JiraServerFlavour.ICTime => new JiraWithICTimePluginApi(
-                httpClient,
-                userName,
-                flavourOptions is ICTimeFlavourOptions opt ? opt : throw new ArgumentOutOfRangeException(nameof(flavourOptions), "Unexpected flavour options class")
-            ),
-            _ => throw new NotImplementedException($"Jira server class {nameof(serverClass)} not yet implemented")
-        };
+            return serverFlavour switch
+            {
+                JiraServerFlavour.Vanilla => new VanillaJiraClient(httpClient, userName, (VanillaJiraFlavourOptions?)flavourOptions),
+                JiraServerFlavour.TempoTimeSheets => new JiraWithTempoPluginApi(httpClient, userName, (TempoTimesheetsFlavourOptions?)flavourOptions),
+                JiraServerFlavour.ICTime => new JiraWithICTimePluginApi(httpClient, userName, (ICTimeFlavourOptions?)flavourOptions),
+                _ => throw new NotImplementedException($"Jira server flavour {nameof(serverFlavour)} not yet implemented")
+            };
+        }
+        catch (InvalidCastException ex)
+        {
+            throw new ArgumentOutOfRangeException($"Don't know how to instantiate client API for flavour {serverFlavour}", ex);
+        }
     }
 
-    public static JiraServerFlavour? DecodeServerClass(string? serverClass)
+    public static JiraServerFlavour? DecodeServerClass(string? serverFlavour)
     {
         JiraServerFlavour? result;
 
-        if (string.IsNullOrEmpty(serverClass))
+        if (string.IsNullOrEmpty(serverFlavour))
             result = null;
-        else if (int.TryParse(serverClass, out int serverClassIntId))
-            result = (JiraServerFlavour)serverClassIntId;
-        else if (Enum.TryParse(serverClass, true, out JiraServerFlavour serverClassEnumId))
-            result = serverClassEnumId;
+        else if (int.TryParse(serverFlavour, out int serverFlavourIntId))
+            result = (JiraServerFlavour)serverFlavourIntId;
+        else if (Enum.TryParse(serverFlavour, true, out JiraServerFlavour serverFlavourEnumId))
+            result = serverFlavourEnumId;
         else
-            throw new ArgumentOutOfRangeException(nameof(serverClass), serverClass, "Invalid server class configured");
+            throw new ArgumentOutOfRangeException(nameof(serverFlavour), serverFlavour, "Invalid server flavour configured");
 
         return result;
     }
diff --git a/jwl.jira/Flavours/TempoTimesheetsFlavourOptions.cs b/jwl.jira/Flavours/TempoTimesheetsFlavourOptions.cs
@@ -0,0 +1,8 @@
+﻿namespace jwl.jira.Flavours;
+
+public class TempoTimesheetsFlavourOptions
+    : IFlavourOptions
+{
+    public string PluginBaseUri { get; init; } = @"rest/tempo-timesheets/4";
+    public string PluginCoreUri { get; init; } = @"rest/tempo-core/1";
+}
diff --git a/jwl.jira/Flavours/VanillaJiraClient.cs b/jwl.jira/Flavours/VanillaJiraClient.cs
@@ -6,6 +6,7 @@ namespace jwl.jira;
 using System.Text;
 using jwl.infra;
 using jwl.jira.api.rest.response;
+using jwl.jira.Flavours;
 
 public class VanillaJiraClient
     : IJiraClient
@@ -15,12 +16,14 @@ public class VanillaJiraClient
 
     private readonly HttpClient _httpClient;
     private readonly Lazy<jwl.jira.api.rest.common.JiraUserInfo> _lazyUserInfo;
+    private readonly VanillaJiraFlavourOptions _flavourOptions;
 
-    public VanillaJiraClient(HttpClient httpClient, string userName)
+    public VanillaJiraClient(HttpClient httpClient, string userName, VanillaJiraFlavourOptions? flavourOptions)
     {
         _httpClient = httpClient;
         UserName = userName;
         _lazyUserInfo = new Lazy<api.rest.common.JiraUserInfo>(() => GetUserInfo().Result);
+        _flavourOptions = flavourOptions ?? new VanillaJiraFlavourOptions();
     }
 
     public static async Task CheckHttpResponseForErrorMessages(HttpResponseMessage responseMessage)
@@ -60,7 +63,7 @@ public async Task<WorkLog[]> GetIssueWorkLogs(DateOnly from, DateOnly to, string
     {
         UriBuilder uriBuilder = new UriBuilder()
         {
-            Path = new UriPathBuilder(@"rest/api/2/issue")
+            Path = new UriPathBuilder($"{_flavourOptions.PluginBaseUri}/issue")
                 .Add(issueKey)
                 .Add(@"worklog")
         };
@@ -111,7 +114,7 @@ public async Task AddWorkLog(string issueKey, DateOnly day, int timeSpentSeconds
     {
         UriBuilder uriBuilder = new UriBuilder()
         {
-            Path = new UriPathBuilder(@"rest/api/2/issue")
+            Path = new UriPathBuilder($"{_flavourOptions.PluginBaseUri}/issue")
                 .Add(issueKey)
                 .Add(@"worklog")
         };
@@ -158,7 +161,7 @@ public async Task DeleteWorkLog(long issueId, long worklogId, bool notifyUsers =
     {
         UriBuilder uriBuilder = new UriBuilder()
         {
-            Path = new UriPathBuilder(@"rest/api/2/issue")
+            Path = new UriPathBuilder($"{_flavourOptions.PluginBaseUri}/issue")
                 .Add(issueId.ToString())
                 .Add(@"worklog")
                 .Add(worklogId.ToString()),
@@ -174,7 +177,7 @@ public async Task UpdateWorkLog(string issueKey, long worklogId, DateOnly day, i
     {
         UriBuilder uriBuilder = new UriBuilder()
         {
-            Path = new UriPathBuilder(@"rest/api/2/issue")
+            Path = new UriPathBuilder($"{_flavourOptions.PluginBaseUri}/issue")
                 .Add(issueKey)
                 .Add(@"worklog")
                 .Add(worklogId.ToString())
@@ -197,7 +200,7 @@ public async Task UpdateWorkLog(string issueKey, long worklogId, DateOnly day, i
     {
         UriBuilder uriBuilder = new UriBuilder()
         {
-            Path = @"rest/api/2/user",
+            Path = $"{_flavourOptions.PluginBaseUri}/user",
             Query = new UriQueryBuilder()
                 .Add(@"username", UserName)
         };
diff --git a/jwl.jira/Flavours/VanillaJiraFlavourOptions.cs b/jwl.jira/Flavours/VanillaJiraFlavourOptions.cs
@@ -0,0 +1,7 @@
+﻿namespace jwl.jira.Flavours;
+
+public class VanillaJiraFlavourOptions
+    : IFlavourOptions
+{
+    public string PluginBaseUri { get; init; } = @"rest/api/2";
+}

Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,4 @@`
`3`	`3`	`public interface IFlavourOptions`
`4`	`4`	`{`
`5`	`5`	`string PluginBaseUri { get; init; }`
`6`		`- string DateFormat { get; init; }`
`7`		`- string TimeSpanFormat { get; init; }`
`8`	`6`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,7 @@ namespace jwl.jira;`
`6`	`6`	`using System.Text;`
`7`	`7`	`using jwl.infra;`
`8`	`8`	`using jwl.jira.api.rest.response;`
	`9`	`+using jwl.jira.Flavours;`
`9`	`10`
`10`	`11`	`public class VanillaJiraClient`
`11`	`12`	`: IJiraClient`
`@@ -15,12 +16,14 @@ public class VanillaJiraClient`
`15`	`16`
`16`	`17`	`private readonly HttpClient _httpClient;`
`17`	`18`	`private readonly Lazy<jwl.jira.api.rest.common.JiraUserInfo> _lazyUserInfo;`
	`19`	`+ private readonly VanillaJiraFlavourOptions _flavourOptions;`
`18`	`20`
`19`		`- public VanillaJiraClient(HttpClient httpClient, string userName)`
	`21`	`+ public VanillaJiraClient(HttpClient httpClient, string userName, VanillaJiraFlavourOptions? flavourOptions)`
`20`	`22`	`{`
`21`	`23`	`_httpClient = httpClient;`
`22`	`24`	`UserName = userName;`
`23`	`25`	`_lazyUserInfo = new Lazy<api.rest.common.JiraUserInfo>(() => GetUserInfo().Result);`
	`26`	`+ _flavourOptions = flavourOptions ?? new VanillaJiraFlavourOptions();`
`24`	`27`	`}`
`25`	`28`
`26`	`29`	`public static async Task CheckHttpResponseForErrorMessages(HttpResponseMessage responseMessage)`
`@@ -60,7 +63,7 @@ public async Task<WorkLog[]> GetIssueWorkLogs(DateOnly from, DateOnly to, string`
`60`	`63`	`{`
`61`	`64`	`UriBuilder uriBuilder = new UriBuilder()`
`62`	`65`	`{`
`63`		`- Path = new UriPathBuilder(@"rest/api/2/issue")`
	`66`	`+ Path = new UriPathBuilder($"{_flavourOptions.PluginBaseUri}/issue")`
`64`	`67`	`.Add(issueKey)`
`65`	`68`	`.Add(@"worklog")`
`66`	`69`	`};`
`@@ -111,7 +114,7 @@ public async Task AddWorkLog(string issueKey, DateOnly day, int timeSpentSeconds`
`111`	`114`	`{`
`112`	`115`	`UriBuilder uriBuilder = new UriBuilder()`
`113`	`116`	`{`
`114`		`- Path = new UriPathBuilder(@"rest/api/2/issue")`
	`117`	`+ Path = new UriPathBuilder($"{_flavourOptions.PluginBaseUri}/issue")`
`115`	`118`	`.Add(issueKey)`
`116`	`119`	`.Add(@"worklog")`
`117`	`120`	`};`
`@@ -158,7 +161,7 @@ public async Task DeleteWorkLog(long issueId, long worklogId, bool notifyUsers =`
`158`	`161`	`{`
`159`	`162`	`UriBuilder uriBuilder = new UriBuilder()`
`160`	`163`	`{`
`161`		`- Path = new UriPathBuilder(@"rest/api/2/issue")`
	`164`	`+ Path = new UriPathBuilder($"{_flavourOptions.PluginBaseUri}/issue")`
`162`	`165`	`.Add(issueId.ToString())`
`163`	`166`	`.Add(@"worklog")`
`164`	`167`	`.Add(worklogId.ToString()),`
`@@ -174,7 +177,7 @@ public async Task UpdateWorkLog(string issueKey, long worklogId, DateOnly day, i`
`174`	`177`	`{`
`175`	`178`	`UriBuilder uriBuilder = new UriBuilder()`
`176`	`179`	`{`
`177`		`- Path = new UriPathBuilder(@"rest/api/2/issue")`
	`180`	`+ Path = new UriPathBuilder($"{_flavourOptions.PluginBaseUri}/issue")`
`178`	`181`	`.Add(issueKey)`
`179`	`182`	`.Add(@"worklog")`
`180`	`183`	`.Add(worklogId.ToString())`
`@@ -197,7 +200,7 @@ public async Task UpdateWorkLog(string issueKey, long worklogId, DateOnly day, i`
`197`	`200`	`{`
`198`	`201`	`UriBuilder uriBuilder = new UriBuilder()`
`199`	`202`	`{`
`200`		`- Path = @"rest/api/2/user",`
	`203`	`+ Path = $"{_flavourOptions.PluginBaseUri}/user",`
`201`	`204`	`Query = new UriQueryBuilder()`
`202`	`205`	`.Add(@"username", UserName)`
`203`	`206`	`};`