Feat/265 url param instantiation #2951

adamhaeger · 2025-01-28T07:18:14Z

Description

Allows users to configure query params that will prefill the datamodel.

Depends on this backend PR: Altinn/app-lib-dotnet#1068

Query params will prefill datamodel according to this flow diagram:

Related Issue(s)

closes Support instantiation based on url params #265

Verification/QA

Manual functionality testing
- I have tested these changes manually
- Creator of the original issue (or service owner) has been contacted for manual testing (or will be contacted when released in alpha)
- No testing done/necessary
Automated tests
- Unit test(s) have been added/updated
- Cypress E2E test(s) have been added/updated
- No automatic tests are needed here (no functional changes/additions)
- I want someone to help me make some tests
UU/WCAG (follow these guidelines until we have our own)
- I have tested with a screen reader/keyboard navigation/automated wcag validator
- No testing done/necessary (no DOM/visual changes)
- I want someone to help me perform accessibility testing
User documentation @ altinn-studio-docs
- Has been added/updated
- No functionality has been changed/added, so no documentation is needed
- I will do that later/have created an issue
Support in Altinn Studio
- Issue(s) created for support in Studio
- This change/feature does not require any changes to Altinn Studio
Sprint board
- The original issue (or this PR itself) has been added to the Team Apps project and to the current sprint board
- I don't have permissions to do that, please help me out
Labels
- I have added a kind/* label to this PR for proper release notes grouping
- I don't have permissions to add labels, please help me out

src/features/datamodel/DataModelsProvider.tsx

…rvice provider

adamhaeger · 2025-01-31T09:45:00Z

/publish

github-actions · 2025-01-31T09:45:15Z

PR release:

<link rel="stylesheet" type="text/css" href="https://altinncdn.no/toolkits/altinn-app-frontend/4.15.2-pr.426.265-url-param-instantiation.ab6c6920/altinn-app-frontend.css">
<script src="https://altinncdn.no/toolkits/altinn-app-frontend/4.15.2-pr.426.265-url-param-instantiation.ab6c6920/altinn-app-frontend.js"></script>

⚙️ Building...
✅ Done!

adamhaeger · 2025-01-31T13:50:30Z

/publish

github-actions · 2025-01-31T13:50:45Z

PR release:

<link rel="stylesheet" type="text/css" href="https://altinncdn.no/toolkits/altinn-app-frontend/4.15.2-pr.430.265-url-param-instantiation.0353aad7/altinn-app-frontend.css">
<script src="https://altinncdn.no/toolkits/altinn-app-frontend/4.15.2-pr.430.265-url-param-instantiation.0353aad7/altinn-app-frontend.js"></script>

⚙️ Building...
✅ Done!

test/e2e/integration/stateless-app/instantiate-from-query-params.ts

sonarqubecloud · 2025-02-05T07:27:24Z

Quality Gate failed

Failed conditions
21.8% Coverage on New Code (required ≥ 45%)
16.67% Condition Coverage on New Code (required ≥ 45%)

See analysis details on SonarQube Cloud

olemartinorg · 2025-02-07T09:38:13Z

src/features/datamodel/useBindingSchema.tsx

 }: DataModelDeps & DataModelProps) {
+  if (prefillFromQueryParams && isStateless && !isAnonymous && dataType) {


I don't see why we should limit this not to work for anonymous stateless? 🤔

olemartinorg · 2025-02-07T09:41:48Z

src/utils/urls/appUrlHelper.ts

+  includeRowIds: boolean,
+  prefillFromQueryParams: string,
+) =>
+  `${appPath}/v1/data?dataType=${dataType}&includeRowId=${includeRowIds.toString()}&prefill=${prefillFromQueryParams}`;


So you're passing prefill to the backend so that backend fills that into the model when first reading it? That's not quite what I expected here - I thought we talked about sending the first request as a POST with the prefill data in it, not sending a GET with prefill data for the backend to figure out. This works, I guess, but it adds complexity when we could have done this with existing APIs already (but then via POST).

Uuuhm well wouldnt that require a new implementation instead of adding to what already happens?

Wouldnt that add even more complexity?

Either way I think it makes sense to remove the GET /data endpoint altogether in this task: #2065 as the GET and POST do more or less the same thing, so could merge this and fix it as part of that I guess.

Or did you mean that we just do a setValue or something? We also have to let TE run validation code of the queryparam values so that would have to hook into it somehow also, see line 132 here: https://github.com/Altinn/app-lib-dotnet/pull/1068/files#diff-57722a0d58a9aa420ee547af44fab41e404a5a7fb409e39c6e749569410644fd

Aha! Yep, I think it makes sense to never call the GET endpoint at all, and just start off by POSTing an empty object (or one with prefill) in stateless. Might want to double-check that with Ivar as well, but I think that would work.

So to summarise:

Stateless currently create the initial data model with a call to GET, and does subsequent updates with POST

We think that the initial data model can be an empty object {} and then we can use POST all the time.

One disadvantage is that this means that backend can only have one hook, instead of initialize and update. It can run initialisation on update, if it sets {"isInitalized": true}, so I think we can accept that for future extensibility.

Seems like for some reason we do prefill on both POST and GET,

https://github.com/Altinn/app-lib-dotnet/blob/main/src/Altinn.App.Api/Controllers/StatelessDataController.cs#L131

https://github.com/Altinn/app-lib-dotnet/blob/main/src/Altinn.App.Api/Controllers/StatelessDataController.cs#L257

After a huddle we have decided it makes sense to switch to using the POST endpoint and deprecate the GET endpoint.

adamhaeger added 7 commits January 22, 2025 17:17

including params in create instance prefill data

5152d14

wip

009b2c8

Merge branch 'main' into feat/265-url-param-instantiation

6ee5bbf

wip

fac816b

Merge branch 'main' into feat/265-url-param-instantiation

1975320

wip

04e9416

wip

19dcbd2

adamhaeger added the kind/feature-request New feature or request label Jan 28, 2025

adamhaeger added 2 commits January 28, 2025 08:21

clean

c2576e8

clean

609f101

adamhaeger mentioned this pull request Jan 28, 2025

Feat/265 url param instantiation Altinn/app-lib-dotnet#1068

Open

5 tasks

update selector for test

66270dc

adamhaeger added the kind/product-feature Pull requests containing new features label Jan 30, 2025

olemartinorg reviewed Jan 30, 2025

View reviewed changes

src/features/datamodel/DataModelsProvider.tsx Outdated Show resolved Hide resolved

adamhaeger added 3 commits January 30, 2025 16:17

added appId to know mix prefill data from different apps from same se…

4b21755

…rvice provider

parsing expires

eedbc8f

deleting query param after its read

ab6c692

adamhaeger added 2 commits January 31, 2025 13:31

deleting local storage when read

7f2afd0

Merge branch 'main' into feat/265-url-param-instantiation

0353aad

adamhaeger marked this pull request as ready for review January 31, 2025 13:48

adamhaeger added 2 commits January 31, 2025 15:13

e2e test updated

8aadf3e

fixed wrong base url in test

1fe8913

github-advanced-security bot found potential problems Jan 31, 2025

View reviewed changes

test/e2e/integration/stateless-app/instantiate-from-query-params.ts Fixed Show fixed Hide fixed

minor clean

b9a52f5

adamhaeger mentioned this pull request Feb 3, 2025

Added query parameters definition to prefill.schema.v1.json Altinn/altinn-cdn#196

Open

4 tasks

sending prefill to backend, changed from expires to created

9067acc

adamhaeger added 2 commits February 4, 2025 12:15

minor clean

28c4ad4

clean

f5614f8

olemartinorg approved these changes Feb 7, 2025

View reviewed changes

adamhaeger mentioned this pull request Feb 10, 2025

added docs for prefilling by query params Altinn/altinn-studio-docs#1998

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feat/265 url param instantiation #2951

Feat/265 url param instantiation #2951

adamhaeger commented Jan 28, 2025 •

edited

Loading

adamhaeger commented Jan 31, 2025

github-actions bot commented Jan 31, 2025 •

edited

Loading

adamhaeger commented Jan 31, 2025

github-actions bot commented Jan 31, 2025 •

edited

Loading

sonarqubecloud bot commented Feb 5, 2025

olemartinorg Feb 7, 2025

olemartinorg Feb 7, 2025

adamhaeger Feb 7, 2025

adamhaeger Feb 7, 2025 •

edited

Loading

olemartinorg Feb 10, 2025

ivarne Feb 10, 2025 •

edited

Loading

adamhaeger Feb 10, 2025 •

edited

Loading

		}: DataModelDeps & DataModelProps) {
		if (prefillFromQueryParams && isStateless && !isAnonymous && dataType) {

Feat/265 url param instantiation #2951

Are you sure you want to change the base?

Feat/265 url param instantiation #2951

Conversation

adamhaeger commented Jan 28, 2025 • edited Loading

Description

Related Issue(s)

Verification/QA

adamhaeger commented Jan 31, 2025

github-actions bot commented Jan 31, 2025 • edited Loading

PR release:

adamhaeger commented Jan 31, 2025

github-actions bot commented Jan 31, 2025 • edited Loading

PR release:

sonarqubecloud bot commented Feb 5, 2025

Quality Gate failed

olemartinorg Feb 7, 2025

Choose a reason for hiding this comment

olemartinorg Feb 7, 2025

Choose a reason for hiding this comment

adamhaeger Feb 7, 2025

Choose a reason for hiding this comment

adamhaeger Feb 7, 2025 • edited Loading

Choose a reason for hiding this comment

olemartinorg Feb 10, 2025

Choose a reason for hiding this comment

ivarne Feb 10, 2025 • edited Loading

Choose a reason for hiding this comment

adamhaeger Feb 10, 2025 • edited Loading

Choose a reason for hiding this comment

adamhaeger commented Jan 28, 2025 •

edited

Loading

github-actions bot commented Jan 31, 2025 •

edited

Loading

github-actions bot commented Jan 31, 2025 •

edited

Loading

adamhaeger Feb 7, 2025 •

edited

Loading

ivarne Feb 10, 2025 •

edited

Loading

adamhaeger Feb 10, 2025 •

edited

Loading