feat: include lock token header in instance data mutations

src/Altinn.App.Core/Constants/General.cs

@@ -39,4 +39,9 @@ public static class General
     /// Header name for platform access token
     /// </summary>
     internal const string PlatformAccessTokenHeaderName = "PlatformAccessToken";
+
+    /// <summary>
+    /// Header name for instance lock token
+    /// </summary>
+    internal const string LockTokenHeaderName = "Altinn-Storage-Lock-Token";
 }

src/Altinn.App.Core/Extensions/HttpClientExtension.cs

@@ -15,6 +15,7 @@
     /// <param name="requestUri">The request Uri</param>
     /// <param name="content">The http content</param>
     /// <param name="platformAccessToken">The platformAccess tokens</param>
+    /// <param name="lockToken">The instance lock token</param>
     /// <param name="cancellationToken">The cancellation token</param>
     /// <returns>A HttpResponseMessage</returns>
     public static async Task<HttpResponseMessage> PostAsync(
@@ -23,10 +24,11 @@
         string requestUri,
         HttpContent? content,
         string? platformAccessToken = null,
+        string? lockToken = null,
         CancellationToken cancellationToken = default
     )
     {
         using HttpRequestMessage request = new(HttpMethod.Post, requestUri);
         request.Content = content;
 
         request.Headers.Authorization = new AuthenticationHeaderValue(
@@ -39,6 +41,11 @@
             request.Headers.Add(Constants.General.PlatformAccessTokenHeaderName, platformAccessToken);
         }
 
+        if (!string.IsNullOrEmpty(lockToken))
+        {
+            request.Headers.Add(Constants.General.LockTokenHeaderName, lockToken);
+        }
+
         return await httpClient.SendAsync(request, cancellationToken);
     }
 
@@ -50,6 +57,7 @@
     /// <param name="requestUri">The request Uri</param>
     /// <param name="content">The http content</param>
     /// <param name="platformAccessToken">The platformAccess tokens</param>
+    /// <param name="lockToken">The instance lock token</param>
     /// <param name="cancellationToken">The cancellation token</param>
     /// <returns>A HttpResponseMessage</returns>
     public static async Task<HttpResponseMessage> PutAsync(
@@ -58,6 +66,7 @@
         string requestUri,
         HttpContent? content,
         string? platformAccessToken = null,
+        string? lockToken = null,
         CancellationToken cancellationToken = default
     )
     {
@@ -74,6 +83,11 @@
             request.Headers.Add(Constants.General.PlatformAccessTokenHeaderName, platformAccessToken);
         }
 
+        if (!string.IsNullOrEmpty(lockToken))
+        {
+            request.Headers.Add(Constants.General.LockTokenHeaderName, lockToken);
+        }
+
         return await httpClient.SendAsync(request, cancellationToken);
     }
 
@@ -94,7 +108,7 @@
         CancellationToken cancellationToken = default
     )
     {
         using HttpRequestMessage request = new(HttpMethod.Get, requestUri);
 
         request.Headers.Authorization = new AuthenticationHeaderValue(
             Constants.AuthorizationSchemes.Bearer,
@@ -186,13 +200,15 @@
     /// <param name="authorizationToken">the authorization token (jwt)</param>
     /// <param name="requestUri">The request Uri</param>
     /// <param name="platformAccessToken">The platformAccess tokens</param>
+    /// <param name="lockToken">The instance lock token</param>
     /// <param name="cancellationToken">The cancellation token</param>
     /// <returns>A HttpResponseMessage</returns>
     public static async Task<HttpResponseMessage> DeleteAsync(
         this HttpClient httpClient,
         string authorizationToken,
         string requestUri,
         string? platformAccessToken = null,
+        string? lockToken = null,
         CancellationToken cancellationToken = default
     )
     {
@@ -208,6 +224,11 @@
             request.Headers.Add(Constants.General.PlatformAccessTokenHeaderName, platformAccessToken);
         }
 
+        if (!string.IsNullOrEmpty(lockToken))
+        {
+            request.Headers.Add(Constants.General.LockTokenHeaderName, lockToken);
+        }
+
         return await httpClient.SendAsync(request, cancellationToken);
     }
 }

src/Altinn.App.Core/Extensions/ServiceCollectionExtensions.cs

@@ -116,7 +116,7 @@
         services.AddHttpClient<IText, TextClient>();
 #pragma warning restore CS0618 // Type or member is obsolete
         services.AddHttpClient<IProcessClient, ProcessClient>();
-        services.AddHttpClient<InstanceLockClient>();
+        services.AddSingleton<InstanceLockClient>();
         services.AddHttpClient<IPersonClient, PersonClient>();
         services.AddHttpClient<IAccessManagementClient, AccessManagementClient>();
 
@@ -263,7 +263,7 @@
         services.AddTransient<IEventHandlerResolver, EventHandlerResolver>();
         services.TryAddSingleton<IEventSecretCodeProvider, KeyVaultEventSecretCodeProvider>();
 
         // TODO: Event subs could be handled by the new automatic Maskinporten auth, once implemented.
         // The event subscription client depends upon a Maskinporten message handler being
         // added to the client during setup. As of now this needs to be done in the apps
         // if subscription is to be added. This registration is to prevent the DI container
@@ -370,7 +370,7 @@
         services.AddTransient<IAbandonTaskEventHandler, AbandonTaskEventHandler>();
         services.AddTransient<IEndEventEventHandler, EndEventEventHandler>();
 
-        services.AddScoped<IInstanceLocker, InstanceLocker>();
+        services.AddSingleton<IInstanceLocker, InstanceLocker>();
 
         // Process tasks
         services.AddTransient<IProcessTask, DataProcessTask>();

src/Altinn.App.Core/Features/Telemetry/Telemetry.InstanceLockClient.cs

@@ -21,4 +21,14 @@ partial class Telemetry
 
         return activity;
     }
+
+    internal Activity? StartUpdateInstanceLockActivity(Guid instanceGuid, int instanceOwnerPartyId, TimeSpan ttl)
+    {
+        var activity = ActivitySource.StartActivity("UpdateInstanceLock");
+        activity?.SetInstanceId(instanceGuid);
+        activity?.SetInstanceOwnerPartyId(instanceOwnerPartyId);
+        activity?.SetTag("lock.ttl_seconds", (int)ttl.TotalSeconds);
+
+        return activity;
+    }
 }

src/Altinn.App.Core/Infrastructure/Clients/Storage/DataClient.cs

@@ -12,6 +12,7 @@
 using Altinn.App.Core.Internal.App;
 using Altinn.App.Core.Internal.Auth;
 using Altinn.App.Core.Internal.Data;
+using Altinn.App.Core.Internal.InstanceLocking;
 using Altinn.App.Core.Models;
 using Altinn.Platform.Storage.Interface.Models;
 using Microsoft.AspNetCore.Http;
@@ -34,6 +35,7 @@
     private readonly ModelSerializationService _modelSerializationService;
     private readonly Telemetry? _telemetry;
     private readonly HttpClient _client;
+    private readonly IInstanceLocker _instanceLocker;
 
     private readonly AuthenticationMethod _defaultAuthenticationMethod = StorageAuthenticationMethod.CurrentUser();
 
@@ -52,6 +54,7 @@
         _platformSettings = serviceProvider.GetRequiredService<IOptions<PlatformSettings>>().Value;
         _logger = serviceProvider.GetRequiredService<ILogger<DataClient>>();
         _telemetry = serviceProvider.GetService<Telemetry>();
+        _instanceLocker = serviceProvider.GetRequiredService<IInstanceLocker>();
 
         httpClient.BaseAddress = new Uri(_platformSettings.ApiStorageEndpoint);
         httpClient.DefaultRequestHeaders.Add(General.SubscriptionKeyHeaderName, _platformSettings.SubscriptionKey);
@@ -62,7 +65,7 @@
     }
 
     /// <inheritdoc />
     [Obsolete("Use InsertFormData with Instance parameter instead")]
     public async Task<DataElement> InsertFormData<T>(
         T dataToSerialize,
         Guid instanceGuid,
@@ -116,7 +119,7 @@
     }
 
     /// <inheritdoc />
     [Obsolete("Use the UpdateFormData method with Instance parameter instead")]
     public async Task<DataElement> UpdateData<T>(
         T dataToSerialize,
         Guid instanceGuid,
@@ -166,6 +169,7 @@
             token,
             apiUrl,
             streamContent,
+            lockToken: _instanceLocker.CurrentLockToken,
             cancellationToken: cts.Token
         );
 
@@ -240,7 +244,7 @@
 
         if (response.StatusCode == HttpStatusCode.NotFound)
         {
             // ! TODO: Remove null return in v9 and throw exception instead
             return null!;
         }
 
@@ -287,7 +291,7 @@
     }
 
     /// <inheritdoc />
     [Obsolete("Use the overload with Instance parameter instead")]
     public async Task<object> GetFormData(
         Guid instanceGuid,
         Type type,
@@ -491,7 +495,12 @@
             cancellationToken: cts.Token
         );
 
-        HttpResponseMessage response = await _client.DeleteAsync(token, apiUrl, cancellationToken: cts.Token);
+        HttpResponseMessage response = await _client.DeleteAsync(
+            token,
+            apiUrl,
+            lockToken: _instanceLocker.CurrentLockToken,
+            cancellationToken: cts.Token
+        );
 
         if (response.IsSuccessStatusCode)
         {
@@ -505,7 +514,7 @@
     }
 
     /// <inheritdoc />
     [Obsolete("The overload that takes a HttpRequest is deprecated, use the overload that takes a Stream instead")]
     public async Task<DataElement> InsertBinaryData(
         string org,
         string app,
@@ -529,7 +538,13 @@
         );
 
         StreamContent content = request.CreateContentStream();
-        HttpResponseMessage response = await _client.PostAsync(token, apiUrl, content, cancellationToken: cts.Token);
+        HttpResponseMessage response = await _client.PostAsync(
+            token,
+            apiUrl,
+            content,
+            lockToken: _instanceLocker.CurrentLockToken,
+            cancellationToken: cts.Token
+        );
 
         if (response.IsSuccessStatusCode)
         {
@@ -582,7 +597,13 @@
             };
         }
 
-        HttpResponseMessage response = await _client.PostAsync(token, apiUrl, content, cancellationToken: cts.Token);
+        HttpResponseMessage response = await _client.PostAsync(
+            token,
+            apiUrl,
+            content,
+            lockToken: _instanceLocker.CurrentLockToken,
+            cancellationToken: cts.Token
+        );
 
         if (response.IsSuccessStatusCode)
         {
@@ -603,7 +624,7 @@
     }
 
     /// <inheritdoc />
     [Obsolete("The overload that takes a HttpRequest is deprecated, use the overload that takes a Stream instead")]
     public async Task<DataElement> UpdateBinaryData(
         string org,
         string app,
@@ -627,7 +648,13 @@
 
         StreamContent content = request.CreateContentStream();
 
-        HttpResponseMessage response = await _client.PutAsync(token, apiUrl, content, cancellationToken: cts.Token);
+        HttpResponseMessage response = await _client.PutAsync(
+            token,
+            apiUrl,
+            content,
+            lockToken: _instanceLocker.CurrentLockToken,
+            cancellationToken: cts.Token
+        );
 
         if (response.IsSuccessStatusCode)
         {
@@ -676,7 +703,13 @@
             };
         }
 
-        HttpResponseMessage response = await _client.PutAsync(token, apiUrl, content, cancellationToken: cts.Token);
+        HttpResponseMessage response = await _client.PutAsync(
+            token,
+            apiUrl,
+            content,
+            lockToken: _instanceLocker.CurrentLockToken,
+            cancellationToken: cts.Token
+        );
         _logger.LogInformation("Update binary data result: {ResultCode}", response.StatusCode);
         if (response.IsSuccessStatusCode)
         {
@@ -707,7 +740,13 @@
         );
 
         StringContent jsonString = new(JsonConvert.SerializeObject(dataElement), Encoding.UTF8, "application/json");
-        HttpResponseMessage response = await _client.PutAsync(token, apiUrl, jsonString, cancellationToken: cts.Token);
+        HttpResponseMessage response = await _client.PutAsync(
+            token,
+            apiUrl,
+            jsonString,
+            lockToken: _instanceLocker.CurrentLockToken,
+            cancellationToken: cts.Token
+        );
 
         if (response.IsSuccessStatusCode)
         {
@@ -750,6 +789,7 @@
             apiUrl,
             content: null,
             platformAccessToken: null,
+            lockToken: _instanceLocker.CurrentLockToken,
             cts.Token
         );
         if (response.IsSuccessStatusCode)
@@ -792,7 +832,12 @@
             instanceIdentifier,
             apiUrl
         );
-        HttpResponseMessage response = await _client.DeleteAsync(token, apiUrl, cancellationToken: cts.Token);
+        HttpResponseMessage response = await _client.DeleteAsync(
+            token,
+            apiUrl,
+            lockToken: _instanceLocker.CurrentLockToken,
+            cancellationToken: cts.Token
+        );
         if (response.IsSuccessStatusCode)
         {
             // ! TODO: this null-forgiving operator should be fixed/removed for the next major release

src/Altinn.App.Core/Infrastructure/Clients/Storage/InstanceLockClient.cs

@@ -8,37 +8,27 @@
 using Altinn.App.Core.Helpers;
 using Altinn.App.Core.Internal.Auth;
 using Altinn.Platform.Storage.Interface.Models;
-using Microsoft.Extensions.Logging;
 using Microsoft.Extensions.Options;
 
 namespace Altinn.App.Core.Infrastructure.Clients.Storage;
 
-internal sealed class InstanceLockClient
+internal sealed class InstanceLockClient(
+    IOptionsMonitor<PlatformSettings> _platformSettings,
+    IAuthenticationTokenResolver _authenticationTokenResolver,
+    IHttpClientFactory _httpClientFactory,
+    Telemetry? _telemetry = null
+)
 {
-    private readonly ILogger<InstanceLockClient> _logger;
-    private readonly HttpClient _client;
-    private readonly Telemetry? _telemetry;
-    private readonly IAuthenticationTokenResolver _authenticationTokenResolver;
-
     private readonly AuthenticationMethod _defaultAuthenticationMethod = StorageAuthenticationMethod.CurrentUser();
 
-    private const string LockTokenHeaderName = "Altinn-Storage-Lock-Token";
-
-    public InstanceLockClient(
-        IOptions<PlatformSettings> platformSettings,
-        ILogger<InstanceLockClient> logger,
-        IAuthenticationTokenResolver authenticationTokenResolver,
-        HttpClient httpClient,
-        Telemetry? telemetry = null
-    )
+    private HttpClient CreateHttpClient()
     {
-        _logger = logger;
-        _authenticationTokenResolver = authenticationTokenResolver;
-        httpClient.BaseAddress = new Uri(platformSettings.Value.ApiStorageEndpoint);
-        httpClient.DefaultRequestHeaders.Add(General.SubscriptionKeyHeaderName, platformSettings.Value.SubscriptionKey);
+        var settings = _platformSettings.CurrentValue;
+        var httpClient = _httpClientFactory.CreateClient();
+        httpClient.BaseAddress = new Uri(settings.ApiStorageEndpoint);
+        httpClient.DefaultRequestHeaders.Add(General.SubscriptionKeyHeaderName, settings.SubscriptionKey);
         httpClient.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));
-        _client = httpClient;
-        _telemetry = telemetry;
+        return httpClient;
     }
 
     public async Task<string> AcquireInstanceLock(
@@ -60,7 +50,8 @@ public async Task<string> AcquireInstanceLock(
         var request = new InstanceLockRequest { TtlSeconds = (int)expiration.TotalSeconds };
         var content = JsonContent.Create(request);
 
-        using var response = await _client.PostAsync(token, apiUrl, content, cancellationToken: cancellationToken);
+        using var client = CreateHttpClient();
+        using var response = await client.PostAsync(token, apiUrl, content, cancellationToken: cancellationToken);
 
         if (!response.IsSuccessStatusCode)
         {
@@ -77,7 +68,7 @@ public async Task<string> AcquireInstanceLock(
         }
         catch (Exception e) when (e is JsonException || e is InvalidOperationException)
         {
-            _logger.LogError(e, "Error reading response from the lock acquisition endpoint.");
+            activity?.Errored(e, "Error reading response from the lock acquisition endpoint.");
         }
 
         if (string.IsNullOrEmpty(lockToken))
@@ -91,17 +82,18 @@ public async Task<string> AcquireInstanceLock(
         return lockToken;
     }
 
-    public async Task ReleaseInstanceLock(
+    public async Task UpdateInstanceLock(
         Guid instanceGuid,
         int instanceOwnerPartyId,
         string lockToken,
+        TimeSpan ttl,
         StorageAuthenticationMethod? authenticationMethod = null,
         CancellationToken cancellationToken = default
     )
     {
-        using var activity = _telemetry?.StartReleaseInstanceLockActivity(instanceGuid, instanceOwnerPartyId);
+        using var activity = _telemetry?.StartUpdateInstanceLockActivity(instanceGuid, instanceOwnerPartyId, ttl);
         string apiUrl = $"instances/{instanceOwnerPartyId}/{instanceGuid}/lock";
-        var instanceLockRequest = new InstanceLockRequest { TtlSeconds = 0 };
+        var instanceLockRequest = new InstanceLockRequest { TtlSeconds = (int)ttl.TotalSeconds };
 
         var userToken = await _authenticationTokenResolver.GetAccessToken(
             authenticationMethod ?? _defaultAuthenticationMethod,
@@ -111,9 +103,10 @@ public async Task ReleaseInstanceLock(
         using HttpRequestMessage request = new(HttpMethod.Patch, apiUrl);
         request.Content = JsonContent.Create(instanceLockRequest);
         request.Headers.Authorization = new AuthenticationHeaderValue(AuthorizationSchemes.Bearer, userToken);
-        request.Headers.Add(LockTokenHeaderName, lockToken);
+        request.Headers.Add(General.LockTokenHeaderName, lockToken);
 
-        using var response = await _client.SendAsync(request, cancellationToken);
+        using var client = CreateHttpClient();
+        using var response = await client.SendAsync(request, cancellationToken);
 
         if (!response.IsSuccessStatusCode)
         {

src/Altinn.App.Core/Internal/InstanceLocking/IInstanceLock.cs

@@ -0,0 +1,8 @@
+namespace Altinn.App.Core.Internal.InstanceLocking;
+
+internal interface IInstanceLock : IAsyncDisposable
+{
+    Task Lock(TimeSpan? ttl = null);
+
+    Task UpdateTtl(TimeSpan ttl);
+}

src/Altinn.App.Core/Internal/InstanceLocking/IInstanceLocker.cs

@@ -1,8 +1,12 @@
 namespace Altinn.App.Core.Internal.InstanceLocking;
 
-internal interface IInstanceLocker : IAsyncDisposable
+internal interface IInstanceLocker
 {
-    ValueTask LockAsync();
+    IInstanceLock InitLock();
 
-    ValueTask LockAsync(TimeSpan ttl);
+    Task<IInstanceLock> Lock();
+
+    Task<IInstanceLock> Lock(TimeSpan ttl);
+
+    string? CurrentLockToken { get; }
 }