Adding version check to startup #2567
Conversation
JerryNixon
requested review from
Aniruddh25,
aaronburtle,
abhishekkumams,
RubenCerna2079,
ravishetye,
rohkhann,
neeraj-sharma2592,
sourabh1007 and
sezal98
as code owners
src/Service/Program.cs
Outdated
| @@ -27,6 +27,13 @@ public class Program | |||
|
|
|||
| public static void Main(string[] args) | |||
| { | |||
| // Compare current version of DAB with latest (non-rc) version in NuGet. | |||
There was a problem hiding this comment.
Would this change work for the docker scenario too?
There was a problem hiding this comment.
We'd need to test to be sure. My gut says no.
There was a problem hiding this comment.
If it fails to reach NuGet it does not emit a warning.
src/Service/Program.cs
Outdated
| @@ -27,6 +28,13 @@ public class Program | |||
|
|
|||
| public static void Main(string[] args) | |||
| { | |||
| // Compare current version of DAB with latest (non-rc) version in NuGet. | |||
| VersionChecker.GetVersions(out string? latestVersion, out string? currentVersion); | |||
| if (!string.IsNullOrEmpty(latestVersion) && latestVersion != currentVersion) | |||
There was a problem hiding this comment.
what if people clone the repo, their currentVersion might be > latestVersion. Saying newer version is available doesn't make sense in that scenario, we should check for latestVersion > currentVersion
| latestVersion = FetchLatestNuGetVersion(); | ||
| currentVersion = GetCurrentVersionFromAssembly(Assembly.GetCallingAssembly()); | ||
| nugetVersion = FetchLatestNuGetVersion(); | ||
| localVersion = ProductInfo.GetProductVersion(false); |
There was a problem hiding this comment.
nit: name the argument that is passed to GetProductVersion with value false for better readability..
| currentVersion = GetCurrentVersionFromAssembly(Assembly.GetCallingAssembly()); | ||
| nugetVersion = FetchLatestNuGetVersion(); | ||
| localVersion = ProductInfo.GetProductVersion(false); | ||
| return string.IsNullOrEmpty(nugetVersion) || nugetVersion == localVersion; |
There was a problem hiding this comment.
What if the localVersion is > than the nugetVersion? Could happen when people clone our repo and we are in the process of developing 1.5, But nuget version will be 1.4 in that timeframe.
| public class VersionCheckTests | ||
| { | ||
| [TestMethod] | ||
| public void GetVersions_LatestVersionNotNull() |
There was a problem hiding this comment.
| public void GetVersions_LatestVersionNotNull() | |
| public void GetVersions_NugetVersionNotNull() |
Closes #3292
Why make this change?
It is easy to continue running an outdated version of Data API builder after a newer version has been released to NuGet. This PR updates the startup process, checking the current version against the latest version available on NuGet.
What is this change?
Azure.DataApiBuilder.Product.VersionChecker.Program.Main().How was this tested?
Sample Request(s)