Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

SLVUU-129: Fix Application Layouts Data Contract #135

Open
wants to merge 15 commits into
base: main
Choose a base branch
from
Open

SLVUU-129: Fix Application Layouts Data Contract #135

wants to merge 15 commits into from

Conversation

pling-scottlogic
Copy link

@pling-scottlogic pling-scottlogic commented Jan 9, 2024 •
edited
Loading

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
add applicationLayout settings to ApplicationLayoutDto #129
Open
@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
pling-scottlogic
pling-scottlogic commented Jan 10, 2024
View reviewed changes
.github/workflows/test-ui.yml
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
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 reviewed Jan 10, 2024
View reviewed changes
Copy link

@vferraro-scottlogic vferraro-scottlogic left a comment

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

vuu-ui/cypress/e2e/layout-management/api/user-layouts.cy.ts Outdated Show resolved Hide resolved
vuu-ui/cypress/e2e/layout-management/api/user-layouts.cy.ts Outdated Show resolved Hide resolved
vuu-ui/cypress/e2e/layout-management/api/user-layouts.cy.ts Outdated Show resolved Hide resolved
vuu-ui/cypress/e2e/layout-management/api/api.utils.ts Outdated Show resolved Hide resolved
vuu-ui/cypress/e2e/layout-management/api/api.utils.ts Show resolved Hide resolved
cfisher-scottlogic and others added 15 commits January 11, 2024 14:48
@cfisher-scottlogic @pling-scottlogic
SLVUU-129: Create e2e Layout Server API contract tests (USER LAYOUTS)
2ea7e73
@cfisher-scottlogic @pling-scottlogic
SLVUU-129: Create e2e Layout Server API contract tests (APPLICATION L…
363263a 
…AYOUTS)
@cfisher-scottlogic @pling-scottlogic
SLVUU-129: Convert fetch() to cy.request() for all tests
c63838c 
- Removes the anti-pattern of async/await (Cypress does not work well with promises)
@cfisher-scottlogic @pling-scottlogic
SLVUU-129: Make server contract for an 'application layout' generic
68251ea
@cfisher-scottlogic @pling-scottlogic
SLVUU-129: Move unused performance related tests to new directory
74ed316
@pling-scottlogic
SLVUU-129: Fix tests
6879fee
@pling-scottlogic
SLVUU-129: Add settings to ApplicationLayoutDto
28979ab
@pling-scottlogic
SLVUU-129: Update API tests to account for settings
486b6e8
@pling-scottlogic
SLVUU-129: Sync remote default application layout with local
642b1f6
@pling-scottlogic
SLVUU-129: Update documentation on controller
a622447
@pling-scottlogic
SLVUU-129: Incorporate app layout and settings into single ObjectNode
f3edd2a
@pling-scottlogic
SLVUU-129: Tidy up tests
068b414
@pling-scottlogic
SLVUU-129: Fix type checks
7bcb6bd
@pling-scottlogic
SLVUU-129: Run layout server for e2e tests
f5fde90
@pling-scottlogic
SLVUU-129: Refactor URL constants
49f8545
@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
Author

PR raised to Finos

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

@vferraro-scottlogic vferraro-scottlogic vferraro-scottlogic approved these changes

Assignees

@pling-scottlogic pling-scottlogic

Labels
None yet
Projects
None yet
Milestone
Layout Management
Development

Successfully merging this pull request may close these issues.

add applicationLayout settings to ApplicationLayoutDto
3 participants
@pling-scottlogic @vferraro-scottlogic @cfisher-scottlogic