LPD-69423 highlight sidebar menu correctly

[robertoDiaz]

No description provided.

[gemini-code-assist]

Summary of Changes

Hello @robertoDiaz, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request addresses an issue where the sidebar menu was not correctly highlighting the active item. It introduces a new test case to validate the highlighting logic for asset libraries and refines utility methods to ensure accurate retrieval of group IDs and depot entries from various object types, including ObjectEntryFolder. These changes collectively improve the accuracy and robustness of UI state management, particularly for navigation within spaces and asset libraries.

Highlights

• Enhanced Sidebar Menu Highlighting Logic: Introduced new logic and a dedicated test case to correctly identify and mark the active asset library in a sidebar menu, ensuring the UI accurately reflects the user's current selection.
• Improved Group ID and Depot Entry Retrieval: Updated InfoItemUtil to handle ObjectEntryFolder objects when determining the group ID and to fetch DepotEntry more reliably, enhancing data retrieval for related entities.
• New Integration Test for Props: Added testGetProps to ViewSpacesSectionDisplayContextTest to validate the correct behavior of the getProps method, specifically its ability to set the 'active' flag for asset libraries within the JSON response.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

The pull request involves changes to the ViewSpacesSectionDisplayContextTest.java and InfoItemUtil.java files. The changes include adding new imports, a new test method testGetProps, and modifications to the getDepotEntryId and getGroupId methods in InfoItemUtil.java. The new test method tests the retrieval of properties, specifically focusing on asset libraries and their active status. The modifications in InfoItemUtil.java enhance the logic for retrieving DepotEntry and GroupId based on the request object.

[gemini-code-assist]

The fetchGroupDepotEntry method is used without proper error handling. If fetchGroupDepotEntry returns null, the code will continue without a valid depotEntry, potentially leading to a NullPointerException later on. It's crucial to handle the case where no DepotEntry is found for the group.

Consider adding a check for null after calling fetchGroupDepotEntry and either logging an error or throwing an exception to prevent further execution with invalid data.

        if (depotEntry == null) {
            depotEntry = DepotEntryLocalServiceUtil.fetchGroupDepotEntry(
                getGroupId(httpServletRequest));

            if (depotEntry == null) {
                // Log an error or throw an exception
                // Example: 
                // throw new Exception("No DepotEntry found for group " + getGroupId(httpServletRequest));
                return 0; // Or throw an exception
            }
        }

[gemini-code-assist]

The test method testGetProps lacks proper cleanup after execution. Specifically, the ObjectEntryFolder created within the test is not deleted, which can lead to data pollution and potential interference with other tests. This can cause intermittent test failures and make the test suite unreliable.

Consider adding code to delete the created ObjectEntryFolder in a finally block or using a @After annotated method to ensure cleanup even if the test fails.

    @Test
    public void testGetProps() throws Exception {
        AssetLibrary assetLibrary1 = _addAssetLibrary();

        _addAssetLibrary();

        DepotEntry depotEntry = _depotEntryLocalService.getDepotEntry(
            assetLibrary1.getId());

        ObjectEntryFolder objectEntryFolder = null;

        try {
            objectEntryFolder =
                _objectEntryFolderLocalService.addObjectEntryFolder(
                    null, depotEntry.getGroupId(), TestPropsValues.getUserId(),
                    ObjectEntryFolderConstants.
                        PARENT_OBJECT_ENTRY_FOLDER_ID_DEFAULT,
                    RandomTestUtil.randomString(),
                    HashMapBuilder.put(
                        LocaleUtil.getDefault(), StringUtil.randomString()
                    ).build(),
                    StringUtil.randomString(),
                    ServiceContextTestUtil.getServiceContext());

            Map<String, Object> props = ReflectionTestUtil.invoke(
                _getViewSpacesDisplayContext(
                    getMockHttpServletRequest(objectEntryFolder)),
                "getProps", new Class<?>[0]);

            Assert.assertNotNull(props);

            JSONArray assetLibrariesJSONArray = (JSONArray)props.get(
                "assetLibraries");

            for (int i = 0; i < assetLibrariesJSONArray.length(); i++) {
                JSONObject assetLibraryJSONObject =
                    assetLibrariesJSONArray.getJSONObject(i);

                if (Objects.equals(
                        assetLibraryJSONObject.get("id"), assetLibrary1.getId())) {

                    Assert.assertTrue(assetLibraryJSONObject.getBoolean("active"));
                }
                else {
                    Assert.assertFalse(assetLibraryJSONObject.getBoolean("active"));
                }
            }
        } finally {
            if (objectEntryFolder != null) {
                _objectEntryFolderLocalService.deleteObjectEntryFolder(objectEntryFolder);
            }
        }
    }