Fix binary compatibility for IDataClient and IInstanceClient (#1711)

* Fix binary compatibility for IDataClient and IInstanceClient

Adding optional parameters to an interface method causes other packages that depend on Altinn.App.Core to break when calling the method that was changed

Also updated AGENTS with some hints
- Normal interfaces in Altinn.App.Core must be binary compatible within a major version so that users can have local pacages that still work (never remove a method)
- Interfaces marked with the `ImplementableByApps` attribute must not change.

* Fix AI suggestions and spelling

Author: ivarne

AGENTS.md

@@ -101,6 +101,9 @@ We have Architecture Decision Records in the `/doc/adr/` folder.
 - Uses **semantic versioning** with MinVer
 - Avoid breaking changes (we plan to release major versions yearly. Some breaking changes can be done inbetween but must be manually verified)
 - PR titles become release notes
+- Normal interfaces in Altinn.App.Core must be binary compatible within a major version so that users can have local packages that still work (never remove a method)
+- Interfaces marked with the `ImplementableByApps` attribute must not change.
+
 
 ### Platform Integrations
 The libraries integrate with:

src/Altinn.App.Api/Controllers/ActionsController.cs

@@ -99,7 +99,14 @@ public async Task<ActionResult<UserActionResponse>> Perform(
             );
         }
 
-        Instance instance = await _instanceClient.GetInstance(app, org, instanceOwnerPartyId, instanceGuid);
+        Instance instance = await _instanceClient.GetInstance(
+            app,
+            org,
+            instanceOwnerPartyId,
+            instanceGuid,
+            authenticationMethod: null,
+            CancellationToken.None
+        );
         if (instance?.Process is null)
         {
             return Conflict($"Process is not started.");

src/Altinn.App.Api/Controllers/DataController.cs

@@ -900,14 +900,26 @@ private async Task<ActionResult> GetBinaryData(
         DataElement dataElement
     )
     {
-        Stream dataStream = await _dataClient.GetBinaryData(instanceOwnerPartyId, instanceGuid, dataGuid);
+        Stream dataStream = await _dataClient.GetBinaryData(
+            instanceOwnerPartyId,
+            instanceGuid,
+            dataGuid,
+            authenticationMethod: null,
+            CancellationToken.None
+        );
 
         if (dataStream is not null)
         {
             string? userOrgClaim = User.GetOrg();
             if (userOrgClaim is null || !org.Equals(userOrgClaim, StringComparison.OrdinalIgnoreCase))
             {
-                await _instanceClient.UpdateReadStatus(instanceOwnerPartyId, instanceGuid, "read");
+                await _instanceClient.UpdateReadStatus(
+                    instanceOwnerPartyId,
+                    instanceGuid,
+                    "read",
+                    authenticationMethod: null,
+                    CancellationToken.None
+                );
             }
 
             return File(dataStream, dataElement.ContentType, dataElement.Filename);
@@ -940,7 +952,12 @@ private async Task<ActionResult> GetFormData(
     )
     {
         // Get Form Data from data service. Assumes that the data element is form data.
-        object appModel = await _dataClient.GetFormData(instance, dataElement);
+        object appModel = await _dataClient.GetFormData(
+            instance,
+            dataElement,
+            authenticationMethod: null,
+            CancellationToken.None
+        );
 
         if (appModel is null)
         {
@@ -971,7 +988,13 @@ private async Task<ActionResult> GetFormData(
         {
             try
             {
-                await _dataClient.UpdateFormData(instance, appModel, dataElement);
+                await _dataClient.UpdateFormData(
+                    instance,
+                    appModel,
+                    dataElement,
+                    authenticationMethod: null,
+                    CancellationToken.None
+                );
             }
             catch (PlatformHttpException e) when (e.Response.StatusCode is HttpStatusCode.Forbidden)
             {
@@ -989,7 +1012,13 @@ private async Task<ActionResult> GetFormData(
         string? userOrgClaim = User.GetOrg();
         if (userOrgClaim is null || !org.Equals(userOrgClaim, StringComparison.OrdinalIgnoreCase))
         {
-            await _instanceClient.UpdateReadStatus(instanceOwnerId, instanceGuid, "read");
+            await _instanceClient.UpdateReadStatus(
+                instanceOwnerId,
+                instanceGuid,
+                "read",
+                authenticationMethod: null,
+                CancellationToken.None
+            );
         }
 
         return Ok(appModel);
@@ -1051,7 +1080,9 @@ await GetErrorDetails(
             Request.ContentType,
             contentDispositionHeader.FileName.ToString(),
             dataGuid,
-            new MemoryAsStream(bytes)
+            new MemoryAsStream(bytes),
+            authenticationMethod: null,
+            CancellationToken.None
         );
 
         SelfLinkHelper.SetDataAppSelfLinks(instanceOwnerPartyId, instanceGuid, dataElement, Request);
@@ -1166,7 +1197,14 @@ private async Task<
     {
         try
         {
-            var instance = await _instanceClient.GetInstance(app, org, instanceOwnerPartyId, instanceGuid);
+            var instance = await _instanceClient.GetInstance(
+                app,
+                org,
+                instanceOwnerPartyId,
+                instanceGuid,
+                authenticationMethod: null,
+                CancellationToken.None
+            );
             if (instance is null)
             {
                 return new ProblemDetails()
@@ -1228,7 +1266,14 @@ IEnumerable<Guid> dataElementGuids
         try
         {
             var application = await _appMetadata.GetApplicationMetadata();
-            var instance = await _instanceClient.GetInstance(app, org, instanceOwnerPartyId, instanceGuid);
+            var instance = await _instanceClient.GetInstance(
+                app,
+                org,
+                instanceOwnerPartyId,
+                instanceGuid,
+                authenticationMethod: null,
+                CancellationToken.None
+            );
             if (instance is null)
             {
                 return new ProblemDetails()
@@ -1292,7 +1337,14 @@ private async Task<
     {
         try
         {
-            var instance = await _instanceClient.GetInstance(app, org, instanceOwnerPartyId, instanceGuid);
+            var instance = await _instanceClient.GetInstance(
+                app,
+                org,
+                instanceOwnerPartyId,
+                instanceGuid,
+                authenticationMethod: null,
+                CancellationToken.None
+            );
             if (instance is null)
             {
                 return new ProblemDetails()

src/Altinn.App.Api/Controllers/DataTagsController.cs

@@ -68,7 +68,14 @@ public async Task<ActionResult<TagsList>> Get(
         [FromRoute] Guid dataGuid
     )
     {
-        Instance instance = await _instanceClient.GetInstance(app, org, instanceOwnerPartyId, instanceGuid);
+        Instance instance = await _instanceClient.GetInstance(
+            app,
+            org,
+            instanceOwnerPartyId,
+            instanceGuid,
+            authenticationMethod: null,
+            CancellationToken.None
+        );
         if (instance is null)
         {
             return Problem(
@@ -127,7 +134,14 @@ [FromBody] string tag
             );
         }
 
-        Instance instance = await _instanceClient.GetInstance(app, org, instanceOwnerPartyId, instanceGuid);
+        Instance instance = await _instanceClient.GetInstance(
+            app,
+            org,
+            instanceOwnerPartyId,
+            instanceGuid,
+            authenticationMethod: null,
+            CancellationToken.None
+        );
         if (instance is null)
         {
             return Problem(
@@ -153,7 +167,12 @@ [FromBody] string tag
         if (!dataElement.Tags.Contains(tag))
         {
             dataElement.Tags.Add(tag);
-            dataElement = await _dataClient.Update(instance, dataElement);
+            dataElement = await _dataClient.Update(
+                instance,
+                dataElement,
+                authenticationMethod: null,
+                CancellationToken.None
+            );
         }
 
         TagsList tagsList = new() { Tags = dataElement.Tags };
@@ -191,7 +210,14 @@ public async Task<ActionResult> Delete(
         [FromRoute] string tag
     )
     {
-        Instance instance = await _instanceClient.GetInstance(app, org, instanceOwnerPartyId, instanceGuid);
+        Instance instance = await _instanceClient.GetInstance(
+            app,
+            org,
+            instanceOwnerPartyId,
+            instanceGuid,
+            authenticationMethod: null,
+            CancellationToken.None
+        );
         if (instance is null)
         {
             return Problem(
@@ -216,7 +242,7 @@ [FromRoute] string tag
 
         if (dataElement.Tags.Remove(tag))
         {
-            await _dataClient.Update(instance, dataElement);
+            await _dataClient.Update(instance, dataElement, authenticationMethod: null, CancellationToken.None);
         }
 
         return NoContent();
@@ -260,7 +286,14 @@ public async Task<ActionResult<SetTagsResponse>> SetTags(
             );
         }
 
-        Instance instance = await _instanceClient.GetInstance(app, org, instanceOwnerPartyId, instanceGuid);
+        Instance instance = await _instanceClient.GetInstance(
+            app,
+            org,
+            instanceOwnerPartyId,
+            instanceGuid,
+            authenticationMethod: null,
+            CancellationToken.None
+        );
         if (instance is null)
         {
             return Problem(
@@ -285,7 +318,12 @@ public async Task<ActionResult<SetTagsResponse>> SetTags(
 
         // Set dataElement tags to be the new tags
         dataElement.Tags = [.. tags.Distinct(StringComparer.Ordinal)];
-        var updatedElement = await _dataClient.Update(instance, dataElement);
+        var updatedElement = await _dataClient.Update(
+            instance,
+            dataElement,
+            authenticationMethod: null,
+            CancellationToken.None
+        );
         if (updatedElement is null)
         {
             return Problem(

src/Altinn.App.Api/Controllers/FileScanController.cs

@@ -43,7 +43,14 @@ public async Task<ActionResult<InstanceFileScanResult>> GetFileScanResults(
         [FromRoute] Guid instanceGuid
     )
     {
-        Instance instance = await _instanceClient.GetInstance(app, org, instanceOwnerPartyId, instanceGuid);
+        Instance instance = await _instanceClient.GetInstance(
+            app,
+            org,
+            instanceOwnerPartyId,
+            instanceGuid,
+            authenticationMethod: null,
+            CancellationToken.None
+        );
         if (instance == null)
         {
             return NotFound();