Refactor

Author: reakaleek

src/Elastic.Documentation.LinkIndex/ILinkIndexReader.cs

@@ -0,0 +1,14 @@
+// Licensed to Elasticsearch B.V under one or more agreements.
+// Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
+// See the LICENSE file in the project root for more information
+
+using Elastic.Documentation.Links;
+
+namespace Elastic.Documentation.LinkIndex;
+
+public interface ILinkIndexReader
+{
+	Task<LinkRegistry> GetRegistry(Cancel cancellationToken = default);
+	Task<RepositoryLinks> GetRepositoryLinks(string key, Cancel cancellationToken = default);
+	string RegistryUrl { get; }
+}

src/Elastic.Documentation.LinkIndex/ILinkIndexReaderWriter.cs

@@ -0,0 +1,7 @@
+// Licensed to Elasticsearch B.V under one or more agreements.
+// Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
+// See the LICENSE file in the project root for more information
+
+namespace Elastic.Documentation.LinkIndex;
+
+public interface ILinkIndexReaderWriter : ILinkIndexReader, ILinkIndexWriter;

src/Elastic.Documentation.LinkIndex/ILinkIndexWriter.cs

@@ -0,0 +1,12 @@
+// Licensed to Elasticsearch B.V under one or more agreements.
+// Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
+// See the LICENSE file in the project root for more information
+
+using Elastic.Documentation.Links;
+
+namespace Elastic.Documentation.LinkIndex;
+
+public interface ILinkIndexWriter
+{
+	Task SaveRegistry(LinkRegistry registry, Cancel cancellationToken = default);
+}

src/Elastic.Documentation.LinkIndex/LinkIndexProvider.cs

@@ -0,0 +1,56 @@
+// Licensed to Elasticsearch B.V under one or more agreements.
+// Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
+// See the LICENSE file in the project root for more information
+
+using System.Net;
+using Amazon.Runtime;
+using Amazon.S3;
+using Amazon.S3.Model;
+using Elastic.Documentation.Links;
+
+namespace Elastic.Documentation.LinkIndex;
+
+public class Aws3LinkIndexReader(IAmazonS3 s3Client, string bucketName = "elastic-docs-link-index", string registryKey = "link-index.json") : ILinkIndexReader
+{
+
+	// <summary>
+	// Using <see cref="AnonymousAWSCredentials"/> to access the link index
+	// allows to read from the link index without the need to provide AWS credentials.
+	// </summary>
+	public static Aws3LinkIndexReader CreateAnonymous()
+	{
+		var credentials = new AnonymousAWSCredentials();
+		var config = new AmazonS3Config
+		{
+			RegionEndpoint = Amazon.RegionEndpoint.USEast2
+		};
+		var s3Client = new AmazonS3Client(credentials, config);
+		return new AwsS3LinkIndexReaderWriter(s3Client);
+	}
+
+	public async Task<LinkRegistry> GetRegistry(Cancel cancellationToken = default)
+	{
+		var getObjectRequest = new GetObjectRequest
+		{
+			BucketName = bucketName,
+			Key = registryKey
+		};
+		var getObjectResponse = await s3Client.GetObjectAsync(getObjectRequest, cancellationToken);
+		await using var stream = getObjectResponse.ResponseStream;
+		var linkIndex = LinkRegistry.Deserialize(stream);
+		return linkIndex with { ETag = getObjectResponse.ETag };
+	}
+	public async Task<RepositoryLinks> GetRepositoryLinks(string key, Cancel cancellationToken)
+	{
+		var getObjectRequest = new GetObjectRequest
+		{
+			BucketName = bucketName,
+			Key = key
+		};
+		var getObjectResponse = await s3Client.GetObjectAsync(getObjectRequest, cancellationToken);
+		await using var stream = getObjectResponse.ResponseStream;
+		return RepositoryLinks.Deserialize(stream);
+	}
+
+	public string RegistryUrl { get; } = $"https://{bucketName}.s3.{s3Client.Config.RegionEndpoint.SystemName}.amazonaws.com/{registryKey}";
+}

src/Elastic.Documentation.LinkIndex/LinkIndexReader.cs

@@ -0,0 +1,41 @@
+// Licensed to Elasticsearch B.V under one or more agreements.
+// Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
+// See the LICENSE file in the project root for more information
+
+using System.Net;
+using Amazon.Runtime;
+using Amazon.S3;
+using Amazon.S3.Model;
+using Elastic.Documentation.Links;
+
+namespace Elastic.Documentation.LinkIndex;
+
+public class AwsS3LinkIndexReaderWriter(
+	IAmazonS3 s3Client,
+	string bucketName = "elastic-docs-link-index",
+	string registryKey = "link-index.json"
+) : Aws3LinkIndexReader(s3Client, bucketName, registryKey), ILinkIndexReaderWriter
+{
+	private readonly IAmazonS3 _s3Client = s3Client;
+	private readonly string _bucketName = bucketName;
+	private readonly string _registryKey = registryKey;
+
+	public async Task SaveRegistry(LinkRegistry registry, Cancel cancellationToken = default)
+	{
+		if (registry.ETag == null)
+			// The ETag should not be null if the LinkReferenceRegistry was retrieved from GetLinkIndex()
+			throw new InvalidOperationException($"{nameof(LinkRegistry)}.{nameof(registry.ETag)} cannot be null");
+		var json = LinkRegistry.Serialize(registry);
+		var putObjectRequest = new PutObjectRequest
+		{
+			BucketName = _bucketName,
+			Key = _registryKey,
+			ContentBody = json,
+			ContentType = "application/json",
+			IfMatch = registry.ETag // Only update if the ETag matches. Meaning the object has not been changed in the meantime.
+		};
+		var putResponse = await _s3Client.PutObjectAsync(putObjectRequest, cancellationToken);
+		if (putResponse.HttpStatusCode != HttpStatusCode.OK)
+			throw new Exception($"Unable to save {nameof(LinkRegistry)} to s3://{_bucketName}/{_registryKey}");
+	}
+}

src/Elastic.Documentation.LinkIndex/LinkIndexReaderWriter.cs

@@ -8,7 +8,7 @@
 
 namespace Elastic.Documentation.Links;
 
-public record LinkReferenceRegistry
+public record LinkRegistry
 {
 	/// Map of branch to <see cref="LinkRegistryEntry"/>
 	[JsonPropertyName("repositories")]
@@ -17,7 +17,7 @@ public record LinkReferenceRegistry
 	[JsonIgnore]
 	public string? ETag { get; init; }
 
-	public LinkReferenceRegistry WithLinkRegistryEntry(LinkRegistryEntry entry)
+	public LinkRegistry WithLinkRegistryEntry(LinkRegistryEntry entry)
 	{
 		var copiedRepositories = new Dictionary<string, Dictionary<string, LinkRegistryEntry>>(Repositories);
 		var repository = entry.Repository;
@@ -48,14 +48,14 @@ public LinkReferenceRegistry WithLinkRegistryEntry(LinkRegistryEntry entry)
 		return this with { Repositories = copiedRepositories };
 	}
 
-	public static LinkReferenceRegistry Deserialize(Stream json) =>
-		JsonSerializer.Deserialize(json, SourceGenerationContext.Default.LinkReferenceRegistry)!;
+	public static LinkRegistry Deserialize(Stream json) =>
+		JsonSerializer.Deserialize(json, SourceGenerationContext.Default.LinkRegistry)!;
 
-	public static LinkReferenceRegistry Deserialize(string json) =>
-		JsonSerializer.Deserialize(json, SourceGenerationContext.Default.LinkReferenceRegistry)!;
+	public static LinkRegistry Deserialize(string json) =>
+		JsonSerializer.Deserialize(json, SourceGenerationContext.Default.LinkRegistry)!;
 
-	public static string Serialize(LinkReferenceRegistry referenceRegistry) =>
-		JsonSerializer.Serialize(referenceRegistry, SourceGenerationContext.Default.LinkReferenceRegistry);
+	public static string Serialize(LinkRegistry registry) =>
+		JsonSerializer.Serialize(registry, SourceGenerationContext.Default.LinkRegistry);
 }
 
 public record LinkRegistryEntry

src/Elastic.Documentation/Links/LinkReferenceRegistry.cs renamed to src/Elastic.Documentation/Links/LinkRegistry.cs

@@ -39,7 +39,7 @@ public record LinkRedirect : LinkSingleRedirect
 	public LinkSingleRedirect[]? Many { get; init; }
 }
 
-public record LinkReference
+public record RepositoryLinks
 {
 	[JsonPropertyName("origin")]
 	public required GitCheckoutInformation Origin { get; init; }
@@ -61,12 +61,12 @@ public record LinkReference
 	public static string SerializeRedirects(Dictionary<string, LinkRedirect>? redirects) =>
 		JsonSerializer.Serialize(redirects, SourceGenerationContext.Default.DictionaryStringLinkRedirect);
 
-	public static LinkReference Deserialize(Stream json) =>
-		JsonSerializer.Deserialize(json, SourceGenerationContext.Default.LinkReference)!;
+	public static RepositoryLinks Deserialize(Stream json) =>
+		JsonSerializer.Deserialize(json, SourceGenerationContext.Default.RepositoryLinks)!;
 
-	public static LinkReference Deserialize(string json) =>
-		JsonSerializer.Deserialize(json, SourceGenerationContext.Default.LinkReference)!;
+	public static RepositoryLinks Deserialize(string json) =>
+		JsonSerializer.Deserialize(json, SourceGenerationContext.Default.RepositoryLinks)!;
 
-	public static string Serialize(LinkReference reference) =>
-		JsonSerializer.Serialize(reference, SourceGenerationContext.Default.LinkReference);
+	public static string Serialize(RepositoryLinks reference) =>
+		JsonSerializer.Serialize(reference, SourceGenerationContext.Default.RepositoryLinks);
 }

src/Elastic.Documentation/Links/LinkReference.cs renamed to src/Elastic.Documentation/Links/RepositoryLinks.cs

@@ -12,8 +12,8 @@ namespace Elastic.Documentation.Serialization;
 
 [JsonSourceGenerationOptions(WriteIndented = true, UseStringEnumConverter = true)]
 [JsonSerializable(typeof(GenerationState))]
-[JsonSerializable(typeof(LinkReference))]
+[JsonSerializable(typeof(RepositoryLinks))]
 [JsonSerializable(typeof(GitCheckoutInformation))]
-[JsonSerializable(typeof(LinkReferenceRegistry))]
+[JsonSerializable(typeof(LinkRegistry))]
 [JsonSerializable(typeof(LinkRegistryEntry))]
 public sealed partial class SourceGenerationContext : JsonSerializerContext;

src/Elastic.Documentation/Serialization/SourceGenerationContext.cs

@@ -276,11 +276,11 @@ private bool CompilationNotNeeded(GenerationState? generationState, out HashSet<
 		return false;
 	}
 
-	private async Task<LinkReference> GenerateLinkReference(Cancel ctx)
+	private async Task<RepositoryLinks> GenerateLinkReference(Cancel ctx)
 	{
 		var file = DocumentationSet.LinkReferenceFile;
 		var state = DocumentationSet.CreateLinkReference();
-		var bytes = JsonSerializer.SerializeToUtf8Bytes(state, SourceGenerationContext.Default.LinkReference);
+		var bytes = JsonSerializer.SerializeToUtf8Bytes(state, SourceGenerationContext.Default.RepositoryLinks);
 		await DocumentationSet.OutputDirectory.FileSystem.File.WriteAllBytesAsync(file.FullName, bytes, ctx);
 		return state;
 	}