feat: instance contextual layout fetching by Jondyr · Pull Request #1544 · Altinn/app-lib-dotnet

Jondyr · 2025-10-29T15:23:51Z

Description

Related PR: Altinn/app-frontend-react#3818

Adds new service ICustomLayoutForInstance, and endpoint in ResourcesController.
When used together with the featureFlag AddInstanceIdentifierToLayoutRequests, the frontend uses this new endpoint to fetch layouts. If the app implements ICustomLayoutForInstance this service is called instead of IAppResources, giving access to instance information when returning layouts.

Related Issue(s)

#{issue number}

Verification

Your code builds clean without any errors or warnings
Manual testing done (required)
Relevant automated test added (if you find this hard, leave it and we'll help out)
All tests run green

Documentation

User documentation is updated with a separate linked PR in altinn-studio-docs. (if applicable)

Summary by CodeRabbit

New Features
- Added endpoints to retrieve layouts and layout settings specific to individual instances
- Introduced feature flag to enable instance identifiers in layout requests
Improvements
- Enhanced null-handling behavior for data element conversions to prevent errors

coderabbitai · 2025-10-29T15:24:05Z

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

@coderabbitai resume to resume automatic reviews.
@coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

▶️ Resume reviews
🔍 Trigger review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 2d4c9129-c1a6-4398-a12d-2b5c2032fd93

📥 Commits

Reviewing files that changed from the base of the PR and between bffb111 and e90f9c8.

📒 Files selected for processing (2)

test/Altinn.App.Api.Tests/OpenApi/OpenApiSpecChangeDetection.SaveJsonSwagger.verified.json
test/Altinn.App.Api.Tests/PublicApiTests.PublicApi_ShouldNotChange_Unintentionally.verified.txt

✅ Files skipped from review due to trivial changes (1)

test/Altinn.App.Api.Tests/OpenApi/OpenApiSpecChangeDetection.SaveJsonSwagger.verified.json

🚧 Files skipped from review as they are similar to previous changes (1)

test/Altinn.App.Api.Tests/PublicApiTests.PublicApi_ShouldNotChange_Unintentionally.verified.txt

📝 Walkthrough

Walkthrough

This pull request introduces support for instance-specific custom layouts. It adds a new ICustomLayoutForInstance interface, integrates it into the ResourceController with two new endpoints that prefer custom implementations while falling back to default resources, introduces a corresponding feature flag, and extends test coverage with new test cases and verified snapshots.

Changes

Cohort / File(s)	Summary
API Endpoints for Instance Layouts `src/Altinn.App.Api/Controllers/ResourceController.cs`, `src/Altinn.App.Core/Internal/App/ICustomLayoutForInstance.cs`	Added `ICustomLayoutForInstance` interface with methods for retrieving custom layouts and layout settings per instance. Enhanced `ResourceController` with two new endpoints (`GetInstanceLayouts`, `GetInstanceLayoutSettings`) that accept instance context and prefer custom implementations via dependency injection, falling back to `IAppResources` when unavailable.
Feature Flag Integration `src/Altinn.App.Core/Features/FeatureFlags.cs`, `src/Altinn.App.Core/Internal/App/FrontendFeatures.cs`	Added new `AddInstanceIdentifierToLayoutRequests` feature flag constant and integrated runtime evaluation in `FrontendFeatures` to expose the flag's state in frontend configuration dictionary.
API Test Coverage `test/Altinn.App.Api.Tests/Controllers/ResourceController_CustomLayoutTests.cs`, `test/Altinn.App.Api.Tests/PublicApiTests.PublicApi_ShouldNotChange_Unintentionally.verified.txt`, `test/Altinn.App.Api.Tests/OpenApi/OpenApiSpecChangeDetection.SaveJsonSwagger.verified.json`	New test suite validating custom layout endpoint behavior with and without `ICustomLayoutForInstance` service registered. Public API surface and OpenAPI specification updated to reflect constructor signature change and two new instance-scoped endpoints.
Core Test Coverage `test/Altinn.App.Core.Tests/Internal/App/FrontendFeaturesTest.cs`, `test/Altinn.App.Core.Tests/Internal/App/AppMetadataTest.GetApplicationMetadata_deserialize_serialize_unmapped_properties.verified.txt`, `test/Altinn.App.Core.Tests/PublicApiTests.PublicApi_ShouldNotChange_Unintentionally.verified.txt`	Updated feature flag tests to verify `addInstanceIdentifierToLayoutRequests` presence in frontend features and public API surface, reflecting new constant in `FeatureFlags` and new `ICustomLayoutForInstance` interface.
Integration Test Snapshots `test/Altinn.App.Integration.Tests/CustomScopes/_snapshots/CustomScopesTests.Metadata_*_Metadata.verified.txt`, `test/Altinn.App.Integration.Tests/PartyTypesAllowed/_snapshots/SubunitOnlyAppTests.ApplicationMetadata_0.verified.txt`	Updated metadata snapshots for custom scopes and party types to include new instance-scoped layout and layout settings endpoints with appropriate authorization scope configuration, and reflected feature flag addition in application metadata.
Data Model Enhancement `src/Altinn.App.Core/Models/DataElementIdentifier.cs`	Improved null-handling behavior in implicit conversion operators: non-nullable conversion now throws `ArgumentNullException` on null input, and nullable conversion explicitly returns null instead of default instance.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 27.59% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The PR title 'feat: instance contextual layout fetching' directly summarizes the main change: introducing instance-aware layout fetching via new endpoints and the ICustomLayoutForInstance interface.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch feat/instance-contextual-layout-fetching

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Review rate limit: 0/1 reviews remaining, refill in 60 minutes.}

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

ivarne

Siden dette er en applikasjons konfigurasjon for frontend, så ville jeg droppet FeatureManager og heller bare bedt brukerene gå direkte til appsettings.json og legge til "FrontendSettings": {"AddInstanceIdentifierToLayoutRequests": true} uten at det krever noe videre konfigurasjon i backend.

JamalAlabdullah

👍

Jondyr · 2026-01-28T12:38:57Z

/publish

github-actions · 2026-01-28T12:39:08Z

PR release:

⚙️ Building...
✅ Done!

…e returns `null`

Jondyr · 2026-01-29T08:32:21Z

/publish

github-actions · 2026-01-29T08:32:33Z

PR release:

⚙️ Building...
✅ Done!

coderabbitai

Actionable comments posted: 1

🤖 Fix all issues with AI agents

In `@src/Altinn.App.Core/Features/FeatureFlags.cs`:
- Around line 16-21: The XML summary for the public constant
AddInstanceIdentifierToLayoutRequests contains a TODO; replace it with a
concise, concrete summary describing the flag's behavior (e.g., that enabling
this feature changes the backend layout endpoint to include the instance
identifier in requests), update the <summary> tag text accordingly so generated
API docs are complete, and ensure wording is clear and present-tense without
TODO markers.

🧹 Nitpick comments (2)

src/Altinn.App.Api/Controllers/ResourceController.cs (2)
22-25: Consider injecting AppImplementationFactory directly.

Using IServiceProvider.GetRequiredService<T>() in the constructor is a service locator pattern. Prefer direct constructor injection for better testability and clearer dependencies.
♻️ Proposed refactor
-    /// <param name="serviceProvider">The service provider</param>
-    public ResourceController(IAppResources appResourcesService, IServiceProvider serviceProvider)
+    /// <param name="appImplementationFactory">The app implementation factory</param>
+    public ResourceController(IAppResources appResourcesService, AppImplementationFactory appImplementationFactory)
     {
         _appResourceService = appResourcesService;
-        _appImplementationFactory = serviceProvider.GetRequiredService<AppImplementationFactory>();
+        _appImplementationFactory = appImplementationFactory;
     }
90-90: Consider adding GUID route constraint for consistency and early validation.

The route uses {instanceId} as a string, but existing instance endpoints in this codebase use {instanceGuid:guid} with a GUID constraint. Adding the constraint would reject invalid GUIDs at the routing level (returning 404) and maintain consistency with other instance-scoped endpoints.
♻️ Proposed change
-    [Route("{org}/{app}/instances/{instanceOwnerPartyId:int}/{instanceId}/layouts/{layoutSetId}")]
+    [Route("{org}/{app}/instances/{instanceOwnerPartyId:int}/{instanceGuid:guid}/layouts/{layoutSetId}")]
Note: This would also require renaming the parameter in the method signature from instanceId to instanceGuid and updating the XML documentation accordingly.

coderabbitai · 2026-01-29T08:36:46Z

+    // TODO: write a better summary here
+    /// <summary>
+    /// Enabling this feature changes backend endpoint used for layouts to
+    /// add instance identifier.
+    /// </summary>
+    public const string AddInstanceIdentifierToLayoutRequests = "AddInstanceIdentifierToLayoutRequests";


⚠️ Potential issue | 🟡 Minor

Replace the TODO with a concrete summary before release.

Leaving a TODO in a public API constant’s XML doc makes the documentation incomplete and leaks into generated docs.

📝 Suggested update

- // TODO: write a better summary here - /// <summary> - /// Enabling this feature changes backend endpoint used for layouts to - /// add instance identifier. - /// </summary> + /// <summary> + /// When enabled, layout fetches use instance-scoped endpoints so layout requests + /// include the instance identifier. + /// </summary> public const string AddInstanceIdentifierToLayoutRequests = "AddInstanceIdentifierToLayoutRequests";

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

// TODO: write a better summary here

/// <summary>

/// Enabling this feature changes backend endpoint used for layouts to

/// add instance identifier.

/// </summary>

public const string AddInstanceIdentifierToLayoutRequests = "AddInstanceIdentifierToLayoutRequests";

/// <summary>

/// When enabled, layout fetches use instance-scoped endpoints so layout requests

/// include the instance identifier.

/// </summary>

public const string AddInstanceIdentifierToLayoutRequests = "AddInstanceIdentifierToLayoutRequests";

🤖 Prompt for AI Agents

In `@src/Altinn.App.Core/Features/FeatureFlags.cs` around lines 16 - 21, The XML summary for the public constant AddInstanceIdentifierToLayoutRequests contains a TODO; replace it with a concise, concrete summary describing the flag's behavior (e.g., that enabling this feature changes the backend layout endpoint to include the instance identifier in requests), update the <summary> tag text accordingly so generated API docs are complete, and ensure wording is clear and present-tense without TODO markers.

…tifier safer.

bjorntore · 2026-01-29T10:24:40Z

/publish

github-actions · 2026-01-29T10:24:53Z

PR release:

⚙️ Building...
✅ Done!

(cherry picked from commit cea36ab)

sonarqubecloud · 2026-01-29T12:49:48Z

Quality Gate passed

Issues
4 New issues
0 Accepted issues

Measures
0 Security Hotspots
92.6% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

sonarqubecloud · 2026-04-29T08:07:29Z

Quality Gate passed

Issues
4 New issues
0 Accepted issues

Measures
0 Security Hotspots
92.6% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

Jondyr changed the title ~~Feat/instance contextual layout fetching~~ feat: instance contextual layout fetching Oct 29, 2025

Jondyr force-pushed the feat/instance-contextual-layout-fetching branch from 03c5d90 to 1f10c35 Compare October 30, 2025 06:39

Jondyr added feature Label Pull requests with new features. Used when generation releasenotes backport-ignore This PR is a new feature and should not be cherry-picked onto release branches squad/utforming Issues that belongs to the named squad. labels Oct 30, 2025

Jondyr force-pushed the feat/instance-contextual-layout-fetching branch 2 times, most recently from e8df578 to e56150a Compare October 30, 2025 07:14

Jondyr mentioned this pull request Oct 30, 2025

feat: instance contextual layout fetching Altinn/app-frontend-react#3818

Merged

19 tasks

Jondyr linked an issue Oct 30, 2025 that may be closed by this pull request

Add Instance contextual layout fetching/resource interface Altinn/altinn-studio#16781

Open

4 tasks

Jondyr force-pushed the feat/instance-contextual-layout-fetching branch 2 times, most recently from 21399d0 to 3dffd17 Compare November 6, 2025 10:24

ivarne approved these changes Nov 6, 2025

View reviewed changes

Jondyr added 4 commits November 10, 2025 09:23

add feature flag

5ce876f

add service using AsyncLocal for instance context across request

3218e40

Use optional service for custom layouts if implemented by app

ca3b07d

add xml comments

271ca38

Jondyr force-pushed the feat/instance-contextual-layout-fetching branch from 3dffd17 to 271ca38 Compare November 10, 2025 08:23

github-advanced-security AI found potential problems Nov 10, 2025

View reviewed changes

Comment thread test/Altinn.App.Api.Tests/Controllers/ResourceController_CustomLayoutTests.cs Fixed

Comment thread test/Altinn.App.Api.Tests/Controllers/ResourceController_CustomLayoutTests.cs Fixed

add tests

301807c

Jondyr force-pushed the feat/instance-contextual-layout-fetching branch from f307242 to 301807c Compare November 10, 2025 10:17

Jondyr added this to Team Altinn Studio Nov 10, 2025

Jondyr moved this to 👷 In progress in Team Altinn Studio Nov 10, 2025

Jondyr self-assigned this Nov 10, 2025

Jondyr added the squad/data Issues that belongs to the named squad. label Nov 10, 2025

add spec verification file

733ec02

Jondyr force-pushed the feat/instance-contextual-layout-fetching branch from 69d0c68 to 733ec02 Compare November 10, 2025 11:53

Jondyr moved this from 👷 In progress to 🔎 In review in Team Altinn Studio Nov 10, 2025

Jondyr removed their assignment Nov 10, 2025

Jondyr marked this pull request as ready for review November 10, 2025 12:36

Jondyr force-pushed the feat/instance-contextual-layout-fetching branch from 1b4246a to 9fb5195 Compare December 17, 2025 10:45

feat: add layout settings endpoint to ICustomLayoutForInstance interface

0bfe1ba

Jondyr force-pushed the feat/instance-contextual-layout-fetching branch from 9fb5195 to 0bfe1ba Compare December 17, 2025 10:54

Merge branch 'main' into feat/instance-contextual-layout-fetching

6adad98

JamalAlabdullah moved this from 🔎 In review to 🧪 Test in Team Altinn Studio Dec 18, 2025

JamalAlabdullah self-assigned this Dec 18, 2025

JamalAlabdullah approved these changes Dec 18, 2025

View reviewed changes

JamalAlabdullah assigned Jondyr and unassigned JamalAlabdullah Dec 18, 2025

Jondyr force-pushed the feat/instance-contextual-layout-fetching branch from b443d20 to 668ffdc Compare January 16, 2026 09:13

Jondyr enabled auto-merge (squash) January 16, 2026 09:44

JamalAlabdullah and others added 2 commits January 29, 2026 09:32

Merge branch 'main' into feat/instance-contextual-layout-fetching

f6c3740

feat: fallback to regular layoutset/layoutsettings if custom interfac…

33b9d3f

…e returns `null`

Jondyr force-pushed the feat/instance-contextual-layout-fetching branch from ca5dfe8 to 33b9d3f Compare January 29, 2026 08:32

coderabbitai Bot reviewed Jan 29, 2026

View reviewed changes

Fix PdfService file name logic. Make null handling in DataElementIden…

bffb111

…tifier safer.

github-advanced-security AI found potential problems Jan 29, 2026

View reviewed changes

Comment thread test/Altinn.App.Core.Tests/Models/DataElementIdentifierTests.cs Fixed

bjorntore added 2 commits January 29, 2026 11:30

change namespace in test

171de8c

(cherry picked from commit cea36ab)

Merge branch 'main' into feat/instance-contextual-layout-fetching.

f6c572c

Jondyr moved this from 🧪 Test to ⚠️ Blocked in Team Altinn Studio Feb 11, 2026

Jondyr removed this from Team Altinn Studio Feb 25, 2026

Merge branch 'main' into feat/instance-contextual-layout-fetching

e90f9c8

Conversation

Jondyr commented Oct 29, 2025 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Related Issue(s)

Verification

Documentation

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented Oct 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviews paused

Walkthrough

Changes

Estimated code review effort

❌ Failed checks (1 warning)

Uh oh!

ivarne left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

JamalAlabdullah left a comment

Choose a reason for hiding this comment

Uh oh!

Jondyr commented Jan 28, 2026

Uh oh!

github-actions Bot commented Jan 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR release:

Uh oh!

Jondyr commented Jan 29, 2026

Uh oh!

github-actions Bot commented Jan 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR release:

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

coderabbitai Bot Jan 29, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

bjorntore commented Jan 29, 2026

Uh oh!

github-actions Bot commented Jan 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR release:

Uh oh!

sonarqubecloud Bot commented Jan 29, 2026

Quality Gate passed

Uh oh!

sonarqubecloud Bot commented Apr 29, 2026

Quality Gate passed

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Jondyr commented Oct 29, 2025 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Oct 29, 2025 •

edited

Loading

github-actions Bot commented Jan 28, 2026 •

edited

Loading

github-actions Bot commented Jan 29, 2026 •

edited

Loading

github-actions Bot commented Jan 29, 2026 •

edited

Loading