Add support for passing a list of task ids to the pdf component for auto pdf.

Author: bjorntore

src/Altinn.App.Core/Internal/Pdf/IPdfService.cs

@@ -24,12 +24,14 @@ public interface IPdfService
     /// <param name="taskId">The task id for which the PDF is generated.</param>
     /// <param name="dataTypeId">The data type to use when storing the PDF.</param>
     /// <param name="fileNameTextResourceElementId">A text resource element id for the file name of the PDF. If no text resource is found, the literal value will be used. If null, a default file name will be used.</param>
+    /// <param name="autoGeneratePdfForTaskIds">Enable auto-pdf for a list of tasks. Will not respect pdfLayoutName on those tasks, but use the main layout-set of the given tasks and render the components in summary mode. This setting will be ignored if the PDF task has a pdf layout set defined.</param>
     /// <param name="ct">Cancellation token for when a request should be stopped before it's completed.</param>
     Task GenerateAndStorePdf(
         Instance instance,
         string taskId,
         string? dataTypeId,
         string? fileNameTextResourceElementId,
+        List<string>? autoGeneratePdfForTaskIds = null,
         CancellationToken ct = default
     ) => GenerateAndStorePdf(instance, taskId, ct);
 

src/Altinn.App.Core/Internal/Pdf/PdfService.cs

@@ -72,7 +72,7 @@ public async Task GenerateAndStorePdf(Instance instance, string taskId, Cancella
     {
         using var activity = _telemetry?.StartGenerateAndStorePdfActivity(instance, taskId);
 
-        await GenerateAndStorePdfInternal(instance, taskId, null, null, ct);
+        await GenerateAndStorePdfInternal(instance, taskId, null, null, null, ct);
     }
 
     /// <inheritdoc/>
@@ -81,12 +81,20 @@ public async Task GenerateAndStorePdf(
         string taskId,
         string? dataTypeId,
         string? fileNameTextResourceElementId,
+        List<string>? autoGeneratePdfForTaskIds = null,
         CancellationToken ct = default
     )
     {
         using var activity = _telemetry?.StartGenerateAndStorePdfActivity(instance, taskId);
 
-        await GenerateAndStorePdfInternal(instance, taskId, dataTypeId, fileNameTextResourceElementId, ct);
+        await GenerateAndStorePdfInternal(
+            instance,
+            taskId,
+            dataTypeId,
+            fileNameTextResourceElementId,
+            autoGeneratePdfForTaskIds,
+            ct
+        );
     }
 
     /// <inheritdoc/>
@@ -102,7 +110,7 @@ public async Task<Stream> GeneratePdf(Instance instance, string taskId, bool isP
 
         TextResource? textResource = await GetTextResource(instance, language);
 
-        return await GeneratePdfContent(instance, language, isPreview, textResource, ct);
+        return await GeneratePdfContent(instance, language, isPreview, textResource, null, ct);
     }
 
     /// <inheritdoc/>
@@ -116,6 +124,7 @@ private async Task GenerateAndStorePdfInternal(
         string taskId,
         string? dataTypeId,
         string? fileNameTextResourceElementId,
+        List<string>? autoGeneratePdfForTaskIds = null,
         CancellationToken ct = default
     )
     {
@@ -127,7 +136,14 @@ private async Task GenerateAndStorePdfInternal(
 
         TextResource? textResource = await GetTextResource(instance, language);
 
-        await using Stream pdfContent = await GeneratePdfContent(instance, language, false, textResource, ct);
+        await using Stream pdfContent = await GeneratePdfContent(
+            instance,
+            language,
+            false,
+            textResource,
+            autoGeneratePdfForTaskIds,
+            ct
+        );
 
         string fileName = GetFileName(instance, textResource, fileNameTextResourceElementId);
         await _dataClient.InsertBinaryData(
@@ -146,6 +162,7 @@ private async Task<Stream> GeneratePdfContent(
         string language,
         bool isPreview,
         TextResource? textResource,
+        List<string>? autoGeneratePdfForTaskIds,
         CancellationToken ct
     )
     {
@@ -154,7 +171,11 @@ CancellationToken ct
             .AppPdfPagePathTemplate.ToLowerInvariant()
             .Replace("{instanceid}", instance.Id);
 
-        Uri uri = BuildUri(baseUrl, pagePath, language);
+        List<KeyValuePair<string, string>> autoPdfTaskIdsQueryParams = CreateAutoPdfTaskIdsQueryParams(
+            autoGeneratePdfForTaskIds
+        );
+
+        Uri uri = BuildUri(baseUrl, pagePath, language, autoPdfTaskIdsQueryParams);
 
         bool displayFooter = _pdfGeneratorSettings.DisplayFooter;
 
@@ -174,7 +195,12 @@ CancellationToken ct
         return pdfContent;
     }
 
-    private static Uri BuildUri(string baseUrl, string pagePath, string language)
+    private static Uri BuildUri(
+        string baseUrl,
+        string pagePath,
+        string language,
+        List<KeyValuePair<string, string>>? additionalQueryParams = null
+    )
     {
         // Uses string manipulation instead of UriBuilder, since UriBuilder messes up
         // query parameters in combination with hash fragments in the url.
@@ -188,6 +214,14 @@ private static Uri BuildUri(string baseUrl, string pagePath, string language)
             url += $"?lang={language}";
         }
 
+        if (additionalQueryParams != null)
+        {
+            foreach (KeyValuePair<string, string> param in additionalQueryParams)
+            {
+                url += $"&{param.Key}={param.Value}";
+            }
+        }
+
         return new Uri(url);
     }
 
@@ -365,4 +399,21 @@ private string GetFooterContent(Instance instance, TextResource? textResource)
             </div>";
         return footerTemplate;
     }
+
+    private static List<KeyValuePair<string, string>> CreateAutoPdfTaskIdsQueryParams(
+        List<string>? autoGeneratePdfForTaskIds
+    )
+    {
+        List<KeyValuePair<string, string>> additionalQueryParams = [];
+        // Create query param array for autoGeneratePdfForTaskIds if provided, task=1&task=2 etc.
+        if (autoGeneratePdfForTaskIds != null && autoGeneratePdfForTaskIds.Count != 0)
+        {
+            foreach (string taskId in autoGeneratePdfForTaskIds)
+            {
+                additionalQueryParams.Add(new KeyValuePair<string, string>("task", taskId));
+            }
+        }
+
+        return additionalQueryParams;
+    }
 }

src/Altinn.App.Core/Internal/Process/Elements/AltinnExtensionProperties/AltinnPdfConfiguration.cs

@@ -19,13 +19,24 @@ public sealed class AltinnPdfConfiguration
     [XmlElement("filename", Namespace = "http://altinn.no/process")]
     public string? Filename { get; set; }
 
+    /// <summary>
+    /// Enable auto-pdf for a list of tasks. Will not respect pdfLayoutName on those tasks, but use the main layout-set of the given tasks and render the components in summary mode. This setting will be ignored if the PDF task has a pdf layout set defined.
+    /// </summary>
+    [XmlArray(ElementName = "autoPdfTaskIds", Namespace = "http://altinn.no/process", IsNullable = true)]
+    [XmlArrayItem(ElementName = "taskId", Namespace = "http://altinn.no/process")]
+    public List<string>? AutoPdfTaskIds { get; set; } = [];
+
     internal ValidAltinnPdfConfiguration Validate()
     {
         string? normalizedDataTypeId = string.IsNullOrWhiteSpace(DataTypeId) ? null : DataTypeId.Trim();
         string? normalizedFilename = string.IsNullOrWhiteSpace(Filename) ? null : Filename.Trim();
 
-        return new ValidAltinnPdfConfiguration(normalizedDataTypeId, normalizedFilename);
+        return new ValidAltinnPdfConfiguration(normalizedDataTypeId, normalizedFilename, AutoPdfTaskIds);
     }
 }
 
-internal readonly record struct ValidAltinnPdfConfiguration(string? DataTypeId, string? Filename);
+internal readonly record struct ValidAltinnPdfConfiguration(
+    string? DataTypeId,
+    string? Filename,
+    List<string>? AutoPdfTaskIds
+);

src/Altinn.App.Core/Internal/Process/ProcessTasks/ServiceTasks/PdfServiceTask.cs

@@ -43,6 +43,7 @@ await _pdfService.GenerateAndStorePdf(
             taskId,
             config.DataTypeId,
             config.Filename,
+            config.AutoPdfTaskIds,
             context.CancellationToken
         );
 

test/Altinn.App.Core.Tests/Internal/Pdf/PdfServiceTests.cs

@@ -299,6 +299,59 @@ public void GetOverridenLanguage_NoLanguageInQuery_ShouldReturnNull()
         language.Should().BeNull();
     }
 
+    [Fact]
+    public async Task GenerateAndStorePdf_WithAutoGeneratePdfForTaskIds_ShouldIncludeTaskIdsInUri()
+    {
+        // Arrange
+        var autoGeneratePdfForTaskIds = new List<string> { "Task_1", "Task_2", "Task_3" };
+
+        _pdfGeneratorClient.Setup(s =>
+            s.GeneratePdf(It.IsAny<Uri>(), It.IsAny<string?>(), It.IsAny<CancellationToken>())
+        );
+        _generalSettingsOptions.Value.ExternalAppBaseUrl = "https://{org}.apps.{hostName}/{org}/{app}";
+
+        var target = SetupPdfService(
+            pdfGeneratorClient: _pdfGeneratorClient,
+            generalSettingsOptions: _generalSettingsOptions
+        );
+
+        Instance instance = new()
+        {
+            Id = $"509378/{Guid.NewGuid()}",
+            AppId = "digdir/not-really-an-app",
+            Org = "digdir",
+        };
+
+        // Act
+        await target.GenerateAndStorePdf(
+            instance,
+            "Task_PDF",
+            null,
+            null,
+            autoGeneratePdfForTaskIds,
+            CancellationToken.None
+        );
+
+        // Assert
+        _pdfGeneratorClient.Verify(
+            s =>
+                s.GeneratePdf(
+                    It.Is<Uri>(u =>
+                        u.Scheme == "https"
+                        && u.Host == $"{instance.Org}.apps.{HostName}"
+                        && u.AbsoluteUri.Contains(instance.AppId)
+                        && u.AbsoluteUri.Contains(instance.Id)
+                        && u.AbsoluteUri.Contains("task=Task_1")
+                        && u.AbsoluteUri.Contains("task=Task_2")
+                        && u.AbsoluteUri.Contains("task=Task_3")
+                    ),
+                    It.Is<string?>(s => s == null),
+                    It.IsAny<CancellationToken>()
+                ),
+            Times.Once
+        );
+    }
+
     private PdfService SetupPdfService(
         Mock<IAppResources>? appResources = null,
         Mock<IDataClient>? dataClient = null,

test/Altinn.App.Core.Tests/Internal/Process/ServiceTasks/PdfServiceTaskTests.cs

@@ -58,9 +58,48 @@ public async Task Execute_Should_Call_GenerateAndStorePdf()
                     instance.Process.CurrentTask.ElementId,
                     null,
                     FileName,
+                    It.IsAny<List<string>?>(),
                     It.IsAny<CancellationToken>()
                 ),
             Times.Once
         );
     }
+
+    [Fact]
+    public async Task Execute_Should_Pass_AutoPdfTaskIds_To_PdfService()
+    {
+        // Arrange
+        var taskIds = new List<string> { "Task_1", "Task_2", "Task_3" };
+
+        _processReaderMock
+            .Setup(x => x.GetAltinnTaskExtension("pdfTask"))
+            .Returns(
+                new AltinnTaskExtension
+                {
+                    TaskType = "pdf",
+                    PdfConfiguration = new AltinnPdfConfiguration { Filename = "test.pdf", AutoPdfTaskIds = taskIds },
+                }
+            );
+
+        var instance = new Instance
+        {
+            Process = new ProcessState { CurrentTask = new ProcessElementInfo { ElementId = "pdfTask" } },
+        };
+
+        var instanceMutatorMock = new Mock<IInstanceDataMutator>();
+        instanceMutatorMock.Setup(x => x.Instance).Returns(instance);
+
+        var parameters = new ServiceTaskContext { InstanceDataMutator = instanceMutatorMock.Object };
+
+        var serviceTask = new PdfServiceTask(_pdfServiceMock.Object, _processReaderMock.Object, _loggerMock.Object);
+
+        // Act
+        await serviceTask.Execute(parameters);
+
+        // Assert
+        _pdfServiceMock.Verify(
+            x => x.GenerateAndStorePdf(instance, "pdfTask", null, "test.pdf", taskIds, It.IsAny<CancellationToken>()),
+            Times.Once
+        );
+    }
 }