ADM-662: [frontend] add version in header #824

neomgb · 2023-12-18T02:48:42Z

Summary

add version in header

Before

Description

Screenshots
If applicable, add screenshots to help explain behavior of your code.

After

Description

Screenshots

Note

Null

codacy-production · 2023-12-18T02:48:47Z

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation	Diff coverage
✅ +0.00%	✅ 100.00%

Coverage variation details

	Coverable lines	Covered lines	Coverage
Common ancestor commit (`8edc996`)	4396	4396	100.00%
Head commit (`ce88770`)	4417 (+21)	4417 (+21)	100.00% (+0.00%)

Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: <coverage of head commit> - <coverage of common ancestor commit>

Diff coverage details

	Coverable lines	Covered lines	Diff coverage
Pull request (#824)	21	21	100.00%

Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: <covered lines added or modified>/<coverable lines added or modified> * 100%

See your quality gate settings Change summary preferences

_{You may notice some variations in coverage metrics with the latest Coverage engine update. For more details, visit the documentation}

github-actions · 2023-12-18T02:48:55Z

Hi @neomgb! 👋
Thank you for submitting a pull request! We appreciate your contribution and will review your changes as soon as possible.

Zxx-Ivy · 2023-12-18T03:00:50Z

.github/ISSUE_TEMPLATE/bug_report.yml

+    description: |
+      What version of our software are you running? There is two methods to get the current version:
+        1. you can see the version info at the top of the heartbeat pages
+        2. Add “api/v1/version”after the host address you visit the heartbeat


Please use English quotation marks

Zxx-Ivy · 2023-12-18T03:06:01Z

frontend/__tests__/src/layouts/Header.test.tsx

@@ -15,6 +24,34 @@ describe('Header', () => {
    expect(getByText(PROJECT_NAME)).toBeInTheDocument()
  })

+  it('should show version info when request succeed', async () => {
+    headerClient.getVersion = jest.fn().mockResolvedValueOnce('1.11')
+    let component: any


Please fix issues of github actions

Zxx-Ivy · 2023-12-18T03:06:19Z

frontend/__tests__/src/layouts/Header.test.tsx

+
+  it('should show version info when request failed', async () => {
+    headerClient.getVersion = jest.fn().mockResolvedValueOnce('')
+    let component: any


Zxx-Ivy · 2023-12-18T03:07:21Z

frontend/__tests__/src/layouts/Header.test.tsx

+    let component: any
+    await act(async () => {
+      component = render(
+        <BrowserRouter>


Maybe we can extract a function for those piece of lines

Zxx-Ivy · 2023-12-18T03:07:30Z

frontend/__tests__/src/layouts/Header.test.tsx

+    headerClient.getVersion = jest.fn().mockResolvedValueOnce('')
+    let component: any
+    await act(async () => {
+      component = render(


Maybe we can extract a function for those piece of lines

Zxx-Ivy · 2023-12-18T03:09:11Z

frontend/cypress/pages/home.ts

@@ -11,6 +11,10 @@ class Home {
    this.createANewProjectButton().click()
  }

+  checkVersion = () => {
+    cy.get('span[title="Heartbeat"]').parent().next().should('exist')


Please follow the POM pattern and avoid using assert at the page level

Zxx-Ivy · 2023-12-18T03:14:26Z

frontend/README.md

-  // fontSize: '0.88rem',
-  fontSize: '14px',
+export const StyledTypography = styled('div')({
+  width: '10rem',
 })
 ```


Maybe we can add a new one, e2e requires the use of POM's model

Zxx-Ivy · 2023-12-18T06:10:07Z

frontend/__tests__/src/layouts/Header.test.tsx

+  })
+
+  const setup = () =>
+    act(async () =>


Need to put "act" to assert block

guzhongren

PLZ update commit with the comments

suggestion: PLZ refactor code after coding. Ref to red green blue of the refactor

guzhongren · 2023-12-18T14:21:48Z

frontend/__tests__/src/layouts/Header.test.tsx

    expect(getByText(PROJECT_NAME)).toBeInTheDocument()
  })

+  it('should show version info when request succeed', async () => {
+    headerClient.getVersion = jest.fn().mockResolvedValueOnce('1.11')


@neomgb using 1.11 from fixtures.ts

guzhongren · 2023-12-18T14:22:05Z

frontend/__tests__/src/client/HeaderClient.test.ts

+  afterAll(() => server.close())
+
+  it('should get response when get header status 200', async () => {
+    const excepted = '1.11'


fixturet.ts

guzhongren · 2023-12-18T14:23:40Z

frontend/__tests__/src/layouts/Header.test.tsx

+    headerClient.getVersion = jest.fn().mockResolvedValueOnce('1.11')
+    const { getByText } = await act(async () => setup())
+
+    expect(getByText(/v1.11/)).toBeInTheDocument()


fixtures.ts

neomgb and others added 14 commits December 14, 2023 10:47

ADM-662: [frontend] feat: add version info

c6fd56a

ADM-621: [frontend] feat: add run e2e test readme

bfe1f89

ADM-651:[frontend] Do some refactorings for e2e.

7c8a06f

ADM-622: [frontend] feat: add fetch version logic

1b208e4

ADM-622: [frontend] feat: add version response dto

0816bfc

ADM-622: [frontend] test: add unit test for HeaderClient

d45e3cc

Merge branch 'main' into ADM-662

6e3a58f

ADM-662: [frontend] feat: modify issue template description

999284b

ADM-662: [frontend] test: add unit test for header component

069ed28

ADM-662: [frontend] test: remove warning

2f02fd3

ADM-662: [frontend] test: add 2e2 test for version

e1138af

ADM-662: [frontend] test: fix github actions error

49d7585

ADM-662: [frontend] refactor: move checkVersion into home

69eba36

ADM-662: [frontend] refactor: use try catch

d72e24b

neomgb requested a review from Zxx-Ivy December 18, 2023 02:49

Merge branch 'main' into ADM-662

f8f22ee

Zxx-Ivy reviewed Dec 18, 2023

View reviewed changes

lxuebing and others added 4 commits December 18, 2023 13:30

ADM-662: [frontend] refactor: POM

685a0cf

ADM-662: [frontend] feat: supplement readme

083a3e5

ADM-662: [frontend] feat: add example

8c3f268

ADM-662: [frontend] test: fix github warning, modify quote format

0d39479

Zxx-Ivy reviewed Dec 18, 2023

View reviewed changes

frontend/__tests__/src/layouts/Header.test.tsx Outdated

})

const setup = () =>

act(async () =>

Copy link

Zxx-Ivy Dec 18, 2023

Choose a reason for hiding this comment

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

Need to put "act" to assert block

neomgb added 2 commits December 18, 2023 14:21

ADM-662: [frontend] test: refact unit test

6aeea45

ADM-662: [frontend] test: refact unit test

ce88770

Zxx-Ivy approved these changes Dec 18, 2023

View reviewed changes

neomgb merged commit 3bf47ed into main Dec 18, 2023
41 checks passed

neomgb deleted the ADM-662 branch December 18, 2023 06:36

guzhongren reviewed Dec 18, 2023

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ADM-662: [frontend] add version in header #824

ADM-662: [frontend] add version in header #824

neomgb commented Dec 18, 2023

codacy-production bot commented Dec 18, 2023 •

edited

Loading

github-actions bot commented Dec 18, 2023

Zxx-Ivy Dec 18, 2023

Zxx-Ivy Dec 18, 2023

Zxx-Ivy Dec 18, 2023

Zxx-Ivy Dec 18, 2023

Zxx-Ivy Dec 18, 2023

Zxx-Ivy Dec 18, 2023

Zxx-Ivy Dec 18, 2023

Zxx-Ivy Dec 18, 2023

guzhongren left a comment

guzhongren Dec 18, 2023

guzhongren Dec 18, 2023

guzhongren Dec 18, 2023

ADM-662: [frontend] add version in header #824

ADM-662: [frontend] add version in header #824

Conversation

neomgb commented Dec 18, 2023

Summary

Before

After

Note

codacy-production bot commented Dec 18, 2023 • edited Loading

Coverage summary from Codacy

github-actions bot commented Dec 18, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

guzhongren left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codacy-production bot commented Dec 18, 2023 •

edited

Loading