feat(mirage): implement additional mock route handlers #1092

tthvo · 2023-08-22T04:12:42Z

Welcome to Cryostat! 👋

Before contributing, make sure you have:

Read the contributing guidelines
Linked a relevant issue which this PR resolves
Linked any other relevant issues, PR's, or documentation, if any
Resolved all conflicts, if any
Rebased your branch PR on top of the latest upstream main branch
Attached at least one of the following labels to the PR: [chore, ci, docs, feat, fix, test]
Signed all commits using a GPG signature

To recreate commits with GPG signature git fetch upstream && git rebase --force --gpg-sign upstream/main

Related to #1039

Description of the change:

Improvement to Mirage api/v2.1/discovery route handler to ensure Realm group is shown.
- Without these changes, realm group is not showed.
- Also, creating a custom target will cause the other existing target to not be showed in graph view. List view works fine.
Fixed FormData handler. Mirage JS will fake parse the FormData (i.e. FormData object instead of string is returned when accessing body).
- Previously, creating a recording or custom target will throw errors.
- Original code on cryostat.github.io did this correctly.
- Perhaps, some final commits in feat(dev): mock API server with miragejs #1039 accidentally added the JSON.parse that caused the issue.

Motivation for the change:

Overall mock API improvement and bug fixes.

github-actions · 2023-08-22T04:18:52Z

Test image available:

CRYOSTAT_IMAGE=ghcr.io/cryostatio/cryostat-web:pr-1092-27765b013c57e72924484926a1bbbe15eedeedba sh smoketest.sh

tthvo · 2023-08-22T10:23:47Z

src/mirage/factories.ts

andrewazores

Looks good, I will let @mwangggg and @aali309 have a look and ask some questions about what all this is before merging.

maxcao13

LGTM, original bugs are fixed! :)

Signed-off-by: Thuan Vo <thvo@redhat.com>

github-actions · 2023-08-22T15:32:11Z

Test image available:

CRYOSTAT_IMAGE=ghcr.io/cryostatio/cryostat-web:pr-1092-84877b89a07eb869278af97eae48f7ccd42f0947 sh smoketest.sh

tthvo · 2023-08-22T15:39:52Z

Looks good, I will let @mwangggg and @aali309 have a look and ask some questions about what all this is before merging.

References

We use MirageJS to intercept network requests and mock API response: https://miragejs.com/docs/getting-started/introduction/

We also use mock-socket to mock the notification socket: https://www.npmjs.com/package/mock-socket.

How its build

There is a directory src/mirage that contains all codes for mocking. These are isolated from the rest of the application code. Webpack will include it as a chunk in web asset and ensures it is executed before actual application code.

https://webpack.js.org/concepts/entry-points/

How to run/test

To run a dev server with mirage, run yarn start:dev:preview.

To build production asset with mirage, run yarn build:preview:notests.

And optionally, server the content locally cd dist && npx browser-sync start --server.
But mostly, we publish these asset to surge.sh for public access: https://cryostatio-cryostat-web-main.surge.sh/

maxcao13 · 2023-08-22T16:36:49Z

References

We use MirageJS to intercept network requests and mock API response: https://miragejs.com/docs/getting-started/introduction/
...

Knowledge hub content :)

maxcao13

Actually there is still some functionality that is broken, notably: ARCHIVE recordings and STOP recordings (both part of a PATCH endpoint). Again because of JSON.parse.

tthvo · 2023-08-22T21:03:35Z

Ahh yess! Missed that in the commits. Added now ^^

tthvo · 2023-08-22T21:09:07Z

Tho, rules cannot be created because we need the matchExpression handler. I will add this.

github-actions · 2023-08-22T21:10:31Z

Test image available:

CRYOSTAT_IMAGE=ghcr.io/cryostatio/cryostat-web:pr-1092-d823e54935e993a65a0ebfa4da6ab863b5d0f90c sh smoketest.sh

github-actions · 2023-08-22T21:58:04Z

Test image available:

CRYOSTAT_IMAGE=ghcr.io/cryostatio/cryostat-web:pr-1092-90d928aa130123f9e0f8eb4e66f45efe02d18869 sh smoketest.sh

tthvo · 2023-08-22T22:09:15Z

Ready to review again! Added some missing route handlers to complete the rule functionalities.

github-actions · 2023-08-22T22:13:19Z

Test image available:

CRYOSTAT_IMAGE=ghcr.io/cryostatio/cryostat-web:pr-1092-3ab6fa26c57201260eb6f59e65d4af29d63a622c sh smoketest.sh

github-actions · 2023-08-24T21:14:13Z

Test image available:

CRYOSTAT_IMAGE=ghcr.io/cryostatio/cryostat-web:pr-1092-81fd48806d35ee92b6f4ef38c56dd9b07d619173 sh smoketest.sh

(cherry picked from commit c185969) # Conflicts: # src/mirage/factories.ts # src/mirage/index.ts

(cherry picked from commit c185969)

… (#1100) * feat(mirage): implement additional mock route handlers (#1092) (cherry picked from commit c185969) * fixup --------- Co-authored-by: Thuan Vo <thvo@redhat.com> Co-authored-by: Andrew Azores <aazores@redhat.com>

tthvo added fix feat New feature or request labels Aug 22, 2023

tthvo requested review from andrewazores and maxcao13 August 22, 2023 04:12

mergify bot added the safe-to-test label Aug 22, 2023

tthvo requested a review from aali309 August 22, 2023 04:16

andrewazores reviewed Aug 22, 2023

View reviewed changes

src/mirage/factories.ts Outdated Show resolved Hide resolved

andrewazores reviewed Aug 22, 2023

View reviewed changes

maxcao13 previously approved these changes Aug 22, 2023

View reviewed changes

tthvo dismissed maxcao13’s stale review via ef41a72 August 22, 2023 15:22

Thuan Vo added 2 commits August 22, 2023 08:24

feat(mirage): improve discovery route response and fix FormData handler

d0673a0

Signed-off-by: Thuan Vo <thvo@redhat.com>

chore(mirage): use fake values

84877b8

tthvo force-pushed the mirage branch from ef41a72 to 84877b8 Compare August 22, 2023 15:25

maxcao13 reviewed Aug 22, 2023

View reviewed changes

fix(mirage): fix patch route handers

d823e54

tthvo changed the title ~~feat(mirage): improve discovery route response and fix FormData handler~~ feat(mirage): implement additional mock route handlers Aug 22, 2023

Thuan Vo added 2 commits August 22, 2023 14:51

feat(mirage): additional mocks for rules and matchExpressions

90d928a

fix(mirage): fix recording metadata

3ab6fa2

tthvo requested a review from mwangggg August 22, 2023 22:22

andrewazores previously approved these changes Aug 23, 2023

View reviewed changes

fix(mirage): fix broken delete actions

81fd488

tthvo dismissed andrewazores’s stale review via 81fd488 August 24, 2023 21:07

andrewazores approved these changes Aug 24, 2023

View reviewed changes

maxcao13 mentioned this pull request Aug 24, 2023

chore(itests): add more integration tests and fix CI integration #1062

Merged

7 tasks

andrewazores merged commit c185969 into cryostatio:main Aug 24, 2023

tthvo deleted the mirage branch August 24, 2023 21:25

andrewazores mentioned this pull request Aug 30, 2023

feat(ci): allow preview deployment on release branches #1047

Merged

7 tasks

andrewazores added the backport label Aug 31, 2023

mergify bot pushed a commit that referenced this pull request Aug 31, 2023

feat(mirage): implement additional mock route handlers (#1092)

306ceb1

(cherry picked from commit c185969) # Conflicts: # src/mirage/factories.ts # src/mirage/index.ts

mergify bot mentioned this pull request Aug 31, 2023

feat(mirage): implement additional mock route handlers (backport #1092) #1100

Merged

andrewazores pushed a commit that referenced this pull request Aug 31, 2023

feat(mirage): implement additional mock route handlers (#1092)

e969116

(cherry picked from commit c185969)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(mirage): implement additional mock route handlers #1092

feat(mirage): implement additional mock route handlers #1092

tthvo commented Aug 22, 2023 •

edited

Loading

github-actions bot commented Aug 22, 2023

tthvo commented Aug 22, 2023

andrewazores left a comment

maxcao13 left a comment

github-actions bot commented Aug 22, 2023

tthvo commented Aug 22, 2023 •

edited

Loading

maxcao13 commented Aug 22, 2023

maxcao13 left a comment •

edited

Loading

tthvo commented Aug 22, 2023

tthvo commented Aug 22, 2023

github-actions bot commented Aug 22, 2023

github-actions bot commented Aug 22, 2023

tthvo commented Aug 22, 2023

github-actions bot commented Aug 22, 2023

github-actions bot commented Aug 24, 2023

feat(mirage): implement additional mock route handlers #1092

feat(mirage): implement additional mock route handlers #1092

Conversation

tthvo commented Aug 22, 2023 • edited Loading

Welcome to Cryostat! 👋

Before contributing, make sure you have:

Description of the change:

Motivation for the change:

github-actions bot commented Aug 22, 2023

tthvo commented Aug 22, 2023

andrewazores left a comment

Choose a reason for hiding this comment

maxcao13 left a comment

Choose a reason for hiding this comment

github-actions bot commented Aug 22, 2023

tthvo commented Aug 22, 2023 • edited Loading

maxcao13 commented Aug 22, 2023

maxcao13 left a comment • edited Loading

Choose a reason for hiding this comment

tthvo commented Aug 22, 2023

tthvo commented Aug 22, 2023

github-actions bot commented Aug 22, 2023

github-actions bot commented Aug 22, 2023

tthvo commented Aug 22, 2023

github-actions bot commented Aug 22, 2023

github-actions bot commented Aug 24, 2023

tthvo commented Aug 22, 2023 •

edited

Loading

tthvo commented Aug 22, 2023 •

edited

Loading

maxcao13 left a comment •

edited

Loading