Skip to content

SLVUU-129: Fix Application Layouts Data Contract#135

Open
pling-scottlogic wants to merge 15 commits into
mainfrom
SLVUU-129-settings-in-dto
Open

SLVUU-129: Fix Application Layouts Data Contract#135
pling-scottlogic wants to merge 15 commits into
mainfrom
SLVUU-129-settings-in-dto

Conversation

@pling-scottlogic

@pling-scottlogic pling-scottlogic commented Jan 9, 2024

Copy link
Copy Markdown

Description

Fixes the data contract for the application-layouts resource on the layout server. Also introduces end-to-end Cypress tests to ensure the data contract holds.

Change List

  • Backend:
    • Replace ApplicationLayoutDto with ObjectNode to allow for arbitrary JSON structure
    • Rename "definition" fields to match the frontend model
    • Synchronise default application layout JSON with local equivalent
    • Adjust server tests to reflect changes
  • Frontend:
    • Replace GetApplicationResponseDto with ApplicationJSON
    • Add Cypress tests to ensure API contract does not get violated
    • Add api.utils.ts to abstract API calls for testing
    • Rename field on ApplicationJSON interface
  • CI/CD
    • Add script to run layout server
    • Run layout server script as part of Cypress setup

Testing

Changes manually tested using the remote implementation from both showcase and sample app.

@pling-scottlogic pling-scottlogic self-assigned this Jan 9, 2024
@pling-scottlogic pling-scottlogic linked an issue Jan 9, 2024 that may be closed by this pull request
@pling-scottlogic pling-scottlogic force-pushed the SLVUU-129-settings-in-dto branch from cde0416 to 92c70c6 Compare January 10, 2024 09:39
@vferraro-scottlogic vferraro-scottlogic added this to the Layout Management milestone Jan 10, 2024
@pling-scottlogic pling-scottlogic force-pushed the SLVUU-129-settings-in-dto branch from 611c021 to fe2ef9c Compare January 10, 2024 14:41
@pling-scottlogic pling-scottlogic marked this pull request as ready for review January 10, 2024 14:50
start: npm run showcase:preview
wait-on: "http://localhost:4173"
start: npm run showcase:preview, npm run layout-server
wait-on: http://localhost:4173, http://localhost:8081/api/swagger-ui/index.html

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure if the Swagger page is most appropriate for checking the API status. We could use one of our GET endpoints, or implement a separate endpoint just for status checking.

@vferraro-scottlogic vferraro-scottlogic left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good for most part just a question and a couple of suggestions for possible improvements

Comment thread vuu-ui/cypress/e2e/layout-management/api/user-layouts.cy.ts Outdated
Comment thread vuu-ui/cypress/e2e/layout-management/api/user-layouts.cy.ts Outdated
Comment thread vuu-ui/cypress/e2e/layout-management/api/user-layouts.cy.ts Outdated
Comment thread vuu-ui/cypress/e2e/layout-management/api/api.utils.ts Outdated
Comment thread vuu-ui/cypress/e2e/layout-management/api/api.utils.ts
@pling-scottlogic pling-scottlogic force-pushed the SLVUU-129-settings-in-dto branch from dcc04bc to 49f8545 Compare January 11, 2024 14:56
@pling-scottlogic

Copy link
Copy Markdown
Author

PR raised to Finos

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

add applicationLayout settings to ApplicationLayoutDto

3 participants