Making download publishers more resilient.

Author: gfraiteur

src/PostSharp.Engineering.BuildTools/Build/Publishing/DocumentationPublisher.cs

@@ -1,13 +1,31 @@
 // Copyright (c) SharpCrafters s.r.o. See the LICENSE.md file in the root directory of this repository root for details.
 
 using JetBrains.Annotations;
+using System;
 using System.Collections.Generic;
+using System.Linq;
 
 namespace PostSharp.Engineering.BuildTools.Build.Publishing;
 
 [PublicAPI]
-public class DocumentationPublisher : InvalidatingS3Publisher
+public class DocumentationPublisher : S3Publisher
 {
+    private readonly string _documentationUrl;
+
     public DocumentationPublisher( IReadOnlyCollection<S3PublisherConfiguration> configurations, string documentationUrl )
-        : base( configurations, $"{documentationUrl}_api/invalidate?%{EnvironmentVariableNames.DocInvalidationKey}%" ) { }
+        : base( configurations )
+    {
+        this._documentationUrl = documentationUrl;
+    }
+
+    private string InvalidateUrl => $"{this._documentationUrl}_api/invalidate?%{EnvironmentVariableNames.DocInvalidationKey}%";
+
+    public override void AddDependencies( List<Publisher> publishers, int currentIndex )
+    {
+        if ( !publishers.Skip( currentIndex )
+                .Any( p => p is HttpGetPublisher invalidator && invalidator.Url.StartsWith( this._documentationUrl, StringComparison.Ordinal ) ) )
+        {
+            publishers.Add( new HttpGetPublisher( this.InvalidateUrl ) );
+        }
+    }
 }

src/PostSharp.Engineering.BuildTools/Build/Publishing/Downloads/DownloadPublisher.cs

@@ -1,14 +1,27 @@
 // Copyright (c) SharpCrafters s.r.o. See the LICENSE.md file in the root directory of this repository root for details.
 
 using JetBrains.Annotations;
+using System;
 using System.Collections.Generic;
+using System.Linq;
 
 namespace PostSharp.Engineering.BuildTools.Build.Publishing.Downloads;
 
 [PublicAPI]
-public class DownloadPublisher : InvalidatingS3Publisher
+public class DownloadPublisher : S3Publisher
 {
-    public DownloadPublisher( IReadOnlyCollection<S3PublisherConfiguration> configurations ) : base(
-        configurations,
-        $"https://www.postsharp.net/download/Refresh.ashx?p=%{EnvironmentVariableNames.DownloadsInvalidationKey}%" ) { }
+    public DownloadPublisher( IReadOnlyCollection<S3PublisherConfiguration> configurations ) : base( configurations ) { }
+
+    private static string InvalidationUrl => $"https://www.postsharp.net/download/Refresh.ashx?p=%{EnvironmentVariableNames.DownloadsInvalidationKey}%";
+
+    public override void AddDependencies( List<Publisher> publishers, int currentIndex )
+    {
+        var invalidationUrl = InvalidationUrl;
+
+        if ( !publishers.Skip( currentIndex )
+                .Any( p => p is HttpGetPublisher invalidator && invalidator.Url.Equals( invalidationUrl, StringComparison.Ordinal ) ) )
+        {
+            publishers.Add( new HttpGetPublisher( invalidationUrl ) );
+        }
+    }
 }

src/PostSharp.Engineering.BuildTools/Build/Publishing/InvalidateDownloadsPublisher.cs

@@ -0,0 +1,57 @@
+// Copyright (c) SharpCrafters s.r.o. See the LICENSE.md file in the root directory of this repository root for details.
+
+using PostSharp.Engineering.BuildTools.Build.Model;
+using PostSharp.Engineering.BuildTools.Utilities;
+using System;
+using System.Net;
+using System.Net.Http;
+
+namespace PostSharp.Engineering.BuildTools.Build.Publishing;
+
+public class HttpGetPublisher : Publisher
+{
+    public string Url { get; }
+
+    public HttpGetPublisher( string url )
+    {
+        this.Url = url;
+    }
+
+    protected override bool Publish(
+        BuildContext context,
+        PublishSettings settings,
+        (string Private, string Public) directories,
+        BuildConfigurationInfo configuration,
+        BuildArguments buildArguments,
+        bool isPublic,
+        ref bool hasTarget )
+    {
+        if ( settings.Dry )
+        {
+            return true;
+        }
+
+        try
+        {
+            var url = Environment.ExpandEnvironmentVariables( this.Url );
+            using var httpClient = new HttpClient();
+            var invalidationResponse = httpClient.GetAsync( url ).GetAwaiter().GetResult();
+
+            if ( invalidationResponse.StatusCode != HttpStatusCode.OK )
+            {
+                context.Console.WriteError(
+                    $"Failed to invalidate {this.Url}: {invalidationResponse.StatusCode} {invalidationResponse.ReasonPhrase} / {invalidationResponse.Content.ReadAsString()}" );
+
+                return false;
+            }
+        }
+        catch ( Exception e )
+        {
+            context.Console.WriteError( $"Failed to invalidate {this.Url}: {e.Message}" );
+
+            return false;
+        }
+
+        return true;
+    }
+}

src/PostSharp.Engineering.BuildTools/Build/Publishing/InvalidatingS3Publisher.cs

@@ -3,6 +3,7 @@
 using JetBrains.Annotations;
 using PostSharp.Engineering.BuildTools.Build.Model;
 using PostSharp.Engineering.BuildTools.Docker;
+using System;
 using System.Collections.Generic;
 using System.Linq;
 
@@ -23,6 +24,8 @@ public abstract class Publisher : IBuildComponent
 
         IEnumerable<IBuildComponent> IBuildComponent.Children => [];
 
+        public virtual void AddDependencies( List<Publisher> publishers, int currentIndex ) { }
+
         protected abstract bool Publish(
             BuildContext context,
             PublishSettings settings,
@@ -41,13 +44,18 @@ public static bool PublishDirectory(
             bool isPublic,
             ref bool hasTarget )
         {
-            var publishers = isPublic ? configuration.PublicPublishers : configuration.PrivatePublishers;
+            var publishers = isPublic ? configuration.PublicPublishers?.ToList() : configuration.PrivatePublishers?.ToList();
 
-            if ( publishers is not { Length: > 0 } )
+            if ( publishers == null || publishers.Count == 0 )
             {
                 return true;
             }
 
+            for ( var i = 0; i < publishers.Count; i++ )
+            {
+                publishers[i].AddDependencies( publishers, i );
+            }
+
             var publishingSucceeded = true;
 
             foreach ( var publisher in publishers )
@@ -62,15 +70,23 @@ public static bool PublishDirectory(
 
                 context.Console.WriteHeading( $"Publishing with {publisher.GetType().Name}" );
 
-                if ( !publisher.Publish(
-                        context,
-                        settings,
-                        directories,
-                        configuration,
-                        buildArguments,
-                        isPublic,
-                        ref hasTarget ) )
+                try
+                {
+                    if ( !publisher.Publish(
+                            context,
+                            settings,
+                            directories,
+                            configuration,
+                            buildArguments,
+                            isPublic,
+                            ref hasTarget ) )
+                    {
+                        publishingSucceeded = false;
+                    }
+                }
+                catch ( Exception e )
                 {
+                    context.Console.WriteError( $"Publisher '' failed with {e.GetType().Name}: {e}" );
                     publishingSucceeded = false;
                 }
             }