feat: 14508/get code lists for org #14653

wrt95 · 2025-02-13T08:54:46Z

Description

Adding functionality to get code lists for org

Related Issue(s)

Create code list page in the organisation library #14508

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)

coderabbitai · 2025-02-13T08:54:54Z

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

codecov · 2025-02-13T08:55:08Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.74%. Comparing base (80d1abe) to head (592e096).
Report is 7 commits behind head on org-library-mvp.

Additional details and impacted files

@@               Coverage Diff                @@
##           org-library-mvp   #14653   +/-   ##
================================================
  Coverage            95.74%   95.74%           
================================================
  Files                 1919     1919           
  Lines                24954    24978   +24     
  Branches              2838     2839    +1     
================================================
+ Hits                 23891    23914   +23     
- Misses                 802      803    +1     
  Partials               261      261

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

ErlingHauan

Nice work!

ErlingHauan · 2025-02-14T10:44:51Z

frontend/dashboard/pages/OrgContentLibrary/OrgContentLibrary.tsx

+  const { data: codeListsResponseList, status: codeListDataListStatus } =
+    useOrgCodeListsQuery(selectedContext);


For API data transfer objects, we are using the type CodeListsResponse, so maybe we should name the variables to match that type?

Suggested change

const { data: codeListsResponseList, status: codeListDataListStatus } =

useOrgCodeListsQuery(selectedContext);

const { data: codeListsResponse, status: codeListResponseStatus } =

useOrgCodeListsQuery(selectedContext);

ErlingHauan · 2025-02-14T11:09:33Z

frontend/dashboard/pages/OrgContentLibrary/OrgContentLibrary.tsx

+type OrgContentLibraryWithContextAndDataProps = {
+  codeListsData: CodeListData[];
+};


Naming the variable codeListData might make people assume that it has the type CodeListData and not CodeListData[]. I suggest naming it CodeListDataList to avoid possible future confusion.

Suggested change

type OrgContentLibraryWithContextAndDataProps = {

codeListsData: CodeListData[];

};

type OrgContentLibraryWithContextAndDataProps = {

codeListsDataList: CodeListData[];

};

ErlingHauan · 2025-02-14T11:13:15Z

frontend/packages/shared/src/api/queries.ts

@@ -181,5 +181,5 @@ export const getProcessTaskType = (org: string, app: string, taskId: string) =>
 export const fetchBelongsToGiteaOrg = () => get(belongsToOrg());

 // Organisation library
-export const getCodeListsForOrg = async (org: string): Promise<CodeListsResponse> => Promise.resolve(codeListsResponse); // Todo: Replace with real API call when endpoint is ready. https://github.com/Altinn/altinn-studio/issues/14505
+export const getCodeListsForOrg = (org: string) => get<CodeListsResponse>(orgCodeListsPath(org));


Great that you saw this needed fixing 😄

Konrad-Simso · 2025-02-14T11:35:50Z

Hi o/

After testing locally and getting both the backend and frontend to work, I've come up with possible changes. I'll make a PR with the needed backend changes, and give a few solutions for frontend changes below.

The changes needed to backend can be found here: #14667

Possible solutions for our frontend

I suggest we implement solution 2, as it allows the component to handle codeListUsages as a nullable prop, while not setting a default value.

Solution 1

Set a default value for the prop codeListsUsages as empty list in CodeListPage.tsx.

Before

  codeListsUsages,

After

  codeListsUsages = [],

The example refers to line 39

Solution 2

Update getcodeListSourcedById in codeListPageUtils.ts as follows.
Before:

export const getCodeListSourcesById = (
  codeListsUsages: CodeListReference[],
  codeListTitle: string,
): CodeListIdSource[] => {
  const codeListUsages: CodeListReference | undefined = codeListsUsages.find(
    (codeListUsage) => codeListUsage.codeListId === codeListTitle,
  );
  return codeListUsages?.codeListIdSources ?? [];
};

After:

export const getCodeListSourcesById = (
  codeListsUsages: CodeListReference[] | undefined,
  codeListTitle: string,
): CodeListIdSource[] => {
  const codeListUsages: CodeListReference | undefined = codeListsUsages?.find(
    (codeListUsage) => codeListUsage.codeListId === codeListTitle,
  );
  return codeListUsages?.codeListIdSources ?? [];
};

TomasEng · 2025-02-14T12:19:14Z

I think it's a good idea to make codeListUsages optional, @Konrad-Simso. This property is tightly coupled to how the library is used on app level. Therefore I would actually consider removing it entirely. Is there any other reason for adding this than to know if the code list is deletable? We could replace it by an isDeletable property on code list level or something like that. Anyways, that's not a task for this pull request.

Konrad-Simso · 2025-02-14T12:21:01Z

It's a required change for this pull request to work. The frontend breaks without handling this nullable value in some way.

Edit:
I agree with letting codeListUsages be an optional prop. But without setting it to an empty array we will meet issues in the method getCodeListSourcesById

TomasEng · 2025-02-14T12:23:15Z

Sure, we can make it nullable now. I meant that we should wait with the other considerations I mentioned.

Konrad-Simso · 2025-02-14T12:25:21Z

Is the prop not already nullable? This change handles the null/undefined prop. I'm ok with it being done in a different PR

Konrad-Simso · 2025-02-14T13:43:15Z

Changes mentioned in my comments have been moved out into a different PR #14670

wrt95 · 2025-02-14T13:45:59Z

Great comments! 😄
It now works as expected 🚀

feat: 14508/get code lists for org

36b68aa

wrt95 marked this pull request as draft February 13, 2025 08:54

github-actions bot added area/dashboard Area: Related to the dashboard application solution/studio/designer Issues related to the Altinn Studio Designer solution. frontend labels Feb 13, 2025

fix: Fixing merge conflict

95edc0e

wrt95 mentioned this pull request Feb 13, 2025

Create code list page in the organisation library #14508

Closed

Merge branch 'org-library-mvp' into feat--14508/get-code-lists-for-org

6814e83

wrt95 marked this pull request as ready for review February 14, 2025 07:54

wrt95 added team/studio-domain2 team/studio-domain1 and removed team/studio-domain2 labels Feb 14, 2025

ErlingHauan self-assigned this Feb 14, 2025

ErlingHauan reviewed Feb 14, 2025

View reviewed changes

ErlingHauan assigned wrt95 and unassigned ErlingHauan Feb 14, 2025

fix: Fixing comments from PR

37db8ac

wrt95 assigned ErlingHauan and unassigned wrt95 Feb 14, 2025

wrt95 requested a review from ErlingHauan February 14, 2025 13:40

Merge branch 'org-library-mvp' into feat--14508/get-code-lists-for-org

592e096

ErlingHauan approved these changes Feb 14, 2025

View reviewed changes

ErlingHauan removed their assignment Feb 14, 2025

ErlingHauan added the skip-manual-testing PRs that do not need to be tested manually label Feb 14, 2025

github-actions bot approved these changes Feb 14, 2025

View reviewed changes

ErlingHauan merged commit 3e9eb01 into org-library-mvp Feb 14, 2025
9 checks passed

ErlingHauan deleted the feat--14508/get-code-lists-for-org branch February 14, 2025 13:54

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: 14508/get code lists for org #14653

feat: 14508/get code lists for org #14653

wrt95 commented Feb 13, 2025 •

edited

Loading

coderabbitai bot commented Feb 13, 2025 •

edited

Loading

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

codecov bot commented Feb 13, 2025 •

edited

Loading

ErlingHauan left a comment

ErlingHauan Feb 14, 2025

ErlingHauan Feb 14, 2025

ErlingHauan Feb 14, 2025

Konrad-Simso commented Feb 14, 2025 •

edited

Loading

TomasEng commented Feb 14, 2025

Konrad-Simso commented Feb 14, 2025 •

edited

Loading

TomasEng commented Feb 14, 2025

Konrad-Simso commented Feb 14, 2025 •

edited

Loading

Konrad-Simso commented Feb 14, 2025

wrt95 commented Feb 14, 2025

		const { data: codeListsResponseList, status: codeListDataListStatus } =
		useOrgCodeListsQuery(selectedContext);

feat: 14508/get code lists for org #14653

feat: 14508/get code lists for org #14653

Conversation

wrt95 commented Feb 13, 2025 • edited Loading

Description

Related Issue(s)

Verification

coderabbitai bot commented Feb 13, 2025 • edited Loading

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

codecov bot commented Feb 13, 2025 • edited Loading

Codecov Report

ErlingHauan left a comment

Choose a reason for hiding this comment

ErlingHauan Feb 14, 2025

Choose a reason for hiding this comment

ErlingHauan Feb 14, 2025

Choose a reason for hiding this comment

ErlingHauan Feb 14, 2025

Choose a reason for hiding this comment

Konrad-Simso commented Feb 14, 2025 • edited Loading

Possible solutions for our frontend

Solution 1

Solution 2

TomasEng commented Feb 14, 2025

Konrad-Simso commented Feb 14, 2025 • edited Loading

TomasEng commented Feb 14, 2025

Konrad-Simso commented Feb 14, 2025 • edited Loading

Konrad-Simso commented Feb 14, 2025

wrt95 commented Feb 14, 2025

wrt95 commented Feb 13, 2025 •

edited

Loading

coderabbitai bot commented Feb 13, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

codecov bot commented Feb 13, 2025 •

edited

Loading

Konrad-Simso commented Feb 14, 2025 •

edited

Loading

Konrad-Simso commented Feb 14, 2025 •

edited

Loading

Konrad-Simso commented Feb 14, 2025 •

edited

Loading