[NoQA] [Dashboard] - github action to feed graphite with reassure data #36480

rinej · 2024-02-14T14:09:51Z

Details

We need to parse reassure output file and make the call to the graphite server with the reassure data. The action should be triggered after merging to master.

The flow for collecting the reassure data:

Run the reassure tests after merge to main
Parse output.json to create the string accepted by graphite
Make call to graphite server with the created string

Then we should be able to access the data in grafana using graphite plugin

Fixed Issues

$ #29274
PROPOSAL: #29274 (comment)

Tests

Verify that no errors appear in the JS console

Offline tests

QA Steps

Verify that no errors appear in the JS console

PR Author Checklist

I linked the correct issue in the ### Fixed Issues section above
I wrote clear testing steps that cover the changes made in this PR
- I added steps for local testing in the Tests section
- I added steps for the expected offline behavior in the Offline steps section
- I added steps for Staging and/or Production testing in the QA steps section
- I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
- I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
I included screenshots or videos for tests on all platforms
I ran the tests on all platforms & verified they passed on:
- Android: Native
- Android: mWeb Chrome
- iOS: Native
- iOS: mWeb Safari
- MacOS: Chrome / Safari
- MacOS: Desktop
I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
I followed proper code patterns (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
- I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
  - If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I followed the guidelines as stated in the Review Guidelines
I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
I verified that if a function's arguments changed that all usages have also been updated correctly
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
If the PR modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label so the design team can review the changes.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

rinej · 2024-02-14T15:41:56Z

.github/workflows/reassurePerformanceTests.yml

+      - name: Send graphite data
+        # run only when merged to master
+        if: github.event.pull_request.merged == true && github.event.pull_request.base.ref == 'main'
+        run: echo -e "${{ steps.saveGraphiteString.outputs.GRAPHITE_STRING }}" | nc "$GRAPHITE_SERVER" "$GRAPHITE_PORT"


"$GRAPHITE_SERVER" "$GRAPHITE_PORT" - will need to be provided and set as github env variables

TMisiukiewicz · 2024-02-16T07:42:07Z

.github/actions/javascript/getGraphiteString/getGraphiteString.js

+    // Prefix path to the graphite metric
+    const GRAPHITE_PATH = 'bucket1.reassure';
+
+    const regressionOutput = JSON.parse(fs.readFileSync('.reassure/output.json', 'utf8'));


i think it'd be good to try/catch this as JSON.parse might throw an error if the passed argument is not valid

thanks! Added the error handling

melvin-bot · 2024-02-16T12:43:09Z

@mananjadhav @mountiny One of you needs to copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

mananjadhav · 2024-02-16T13:21:24Z

@mountiny does this need C+ review? Guessing not.

mountiny

Looking good, lets get @johnmlee101 👀 on this for help connecting the dots

.github/workflows/reassurePerformanceTests.yml

.github/actions/javascript/getGraphiteString/getGraphiteString.js

johnmlee101

Reviewing but so far looks good! I'm going to modify our backend to support this but this should be very useful!

johnmlee101

I'm creating an instance ubuntu-latest-reassure-tests to use. If you want to switch over

runs-on: ubuntu-latest

to that.

johnmlee101 · 2024-02-20T17:52:19Z

Our back-end change is being reviewed right now!

rinej · 2024-02-21T16:45:51Z

@johnmlee101 I modified the machine name, thanks!
I also did the same change in our testing PR:
#37019

rinej · 2024-03-01T14:44:51Z

I added the changes according to discussion here: https://callstack-hq.slack.com/archives/C05LX9D6E07/p1708617316460239

The flow was tested using testing branch and merged here: #37298

mountiny

Couple NABs I dont think we have to hold on those

mountiny · 2024-03-04T17:37:53Z

.github/actions/javascript/getGraphiteString/getGraphiteString.js

+    const graphiteString = reassureTests
+        .map((test) => {
+            const current = test.current;
+            // Graphite doesn't accept metrics name with space, we replace spaces with "-"


Suggested change

// Graphite doesn't accept metrics name with space, we replace spaces with "-"

// Graphite doesn't accept metrics name with space, we replace spaces with "-"

mountiny · 2024-03-04T17:38:00Z

.github/actions/javascript/getGraphiteString/getGraphiteString.js

+            const current = test.current;
+            // Graphite doesn't accept metrics name with space, we replace spaces with "-"
+            const formattedName = current.name.split(' ').join('-');
+


Suggested change

mountiny · 2024-03-04T17:38:32Z

Reviewer Checklist

I have verified the author checklist is complete (all boxes are checked off).
I verified the correct issue is linked in the ### Fixed Issues section above
I verified testing steps are clear and they cover the changes made in this PR
- I verified the steps for local testing are in the Tests section
- I verified the steps for Staging and/or Production testing are in the QA steps section
- I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
I checked that screenshots or videos are included for tests on all platforms
I included screenshots or videos for tests on all platforms
I verified tests pass on all platforms & I tested again on:
- Android: Native
- Android: mWeb Chrome
- iOS: Native
- iOS: mWeb Safari
- MacOS: Chrome / Safari
- MacOS: Desktop
If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
I verified proper code patterns were followed (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
- I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I verified that this PR follows the guidelines as stated in the Review Guidelines
I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG)
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
If the PR modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label so the design team can review the changes.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

OSBotify · 2024-03-04T17:45:30Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

OSBotify · 2024-03-04T21:03:05Z

🚀 Deployed to staging by https://github.com/mountiny in version: 1.4.47-0 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	failure ❌
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

OSBotify · 2024-03-06T21:52:07Z

🚀 Deployed to production by https://github.com/roryabraham in version: 1.4.47-10 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

rinej added 7 commits February 14, 2024 14:47

feat: add gh action to send graphite reassure data

af6920a

feat: add reassure output parser to graphite string

292eedc

format: fix lint and prettier

81b252a

chore: rebuild gh actions

810d3ab

chore: build gh actions

32ed6d6

fix: add typing for outputs

738defb

fix: fix spelling

14de88f

rinej commented Feb 14, 2024

View reviewed changes

TMisiukiewicz reviewed Feb 16, 2024

View reviewed changes

rinej added 2 commits February 16, 2024 11:52

feat: add error handling for parsing json

c831a60

chore: rebuild actions

afc2e58

rinej requested a review from TMisiukiewicz February 16, 2024 11:20

rinej marked this pull request as ready for review February 16, 2024 12:43

rinej requested a review from a team as a code owner February 16, 2024 12:43

melvin-bot bot requested review from mananjadhav and mountiny and removed request for a team and TMisiukiewicz February 16, 2024 12:43

rinej mentioned this pull request Feb 16, 2024

[HOLD for payment 2024-03-26] [HOLD for payment 2024-03-20] [HOLD for payment 2024-03-13] Investigate a dashboard tool to monitor app performance improvement/degradation after deploys #29274

Closed

mountiny assigned rinej Feb 16, 2024

mountiny reviewed Feb 16, 2024

View reviewed changes

mountiny requested a review from johnmlee101 February 16, 2024 13:21

johnmlee101 reviewed Feb 16, 2024

View reviewed changes

rinej added 4 commits February 20, 2024 11:32

chore: fix some comments

e1d5297

Merge branch 'main' into feature/29274/dashboard-feed-data

a7985c7

Merge branch 'main' into feature/29274/dashboard-feed-data

45827da

chore: rebuild gh actions, run prettier

438594d

rinej requested a review from mountiny February 20, 2024 11:17

rinej requested a review from johnmlee101 February 20, 2024 11:17

johnmlee101 suggested changes Feb 20, 2024

View reviewed changes

chore: change the action runs-on

2ebcd6b

rinej mentioned this pull request Feb 22, 2024

Dashboard feed data/testing #37019

Merged

50 tasks

chore: add ubuntu-latest-reassure-tests to the action lint

8de9aab

rinej mentioned this pull request Feb 27, 2024

[Testing GH action] - Feeding dashboard with reassure data #37298

Merged

50 tasks

rinej added 4 commits March 1, 2024 13:20

feat: add env variables, adjust graphite path

7e26633

Merge branch 'main' into feature/29274/dashboard-feed-data

7c17b52

Merge branch 'main' into feature/29274/dashboard-feed-data

e59673b

chore: rebuild gh actions

158effd

rinej requested a review from johnmlee101 March 1, 2024 13:09

johnmlee101 approved these changes Mar 1, 2024

View reviewed changes

mountiny approved these changes Mar 4, 2024

View reviewed changes

mountiny merged commit afb4a51 into Expensify:main Mar 4, 2024
17 of 19 checks passed

mountiny changed the title ~~[Dashboard] - github action to feed graphite with reassure data~~ [NoQA] [Dashboard] - github action to feed graphite with reassure data Mar 4, 2024

github-actions bot mentioned this pull request Mar 4, 2024

Deploy Checklist: New Expensify 2024-03-04 #37698

Closed

97 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[NoQA] [Dashboard] - github action to feed graphite with reassure data #36480

[NoQA] [Dashboard] - github action to feed graphite with reassure data #36480

rinej commented Feb 14, 2024 •

edited

Loading

rinej Feb 14, 2024

TMisiukiewicz Feb 16, 2024

rinej Feb 16, 2024

melvin-bot bot commented Feb 16, 2024

mananjadhav commented Feb 16, 2024 •

edited

Loading

mountiny left a comment

johnmlee101 left a comment

johnmlee101 left a comment

johnmlee101 commented Feb 20, 2024

rinej commented Feb 21, 2024

rinej commented Mar 1, 2024 •

edited

Loading

mountiny left a comment

mountiny Mar 4, 2024

mountiny Mar 4, 2024

mountiny commented Mar 4, 2024 •

edited

Loading

OSBotify commented Mar 4, 2024

OSBotify commented Mar 4, 2024

OSBotify commented Mar 6, 2024

	// Graphite doesn't accept metrics name with space, we replace spaces with "-"

	// Graphite doesn't accept metrics name with space, we replace spaces with "-"

[NoQA] [Dashboard] - github action to feed graphite with reassure data #36480

[NoQA] [Dashboard] - github action to feed graphite with reassure data #36480

Conversation

rinej commented Feb 14, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

rinej Feb 14, 2024

Choose a reason for hiding this comment

TMisiukiewicz Feb 16, 2024

Choose a reason for hiding this comment

rinej Feb 16, 2024

Choose a reason for hiding this comment

melvin-bot bot commented Feb 16, 2024

mananjadhav commented Feb 16, 2024 • edited Loading

mountiny left a comment

Choose a reason for hiding this comment

johnmlee101 left a comment

Choose a reason for hiding this comment

johnmlee101 left a comment

Choose a reason for hiding this comment

johnmlee101 commented Feb 20, 2024

rinej commented Feb 21, 2024

rinej commented Mar 1, 2024 • edited Loading

mountiny left a comment

Choose a reason for hiding this comment

mountiny Mar 4, 2024

Choose a reason for hiding this comment

mountiny Mar 4, 2024

Choose a reason for hiding this comment

mountiny commented Mar 4, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

OSBotify commented Mar 4, 2024

OSBotify commented Mar 4, 2024

OSBotify commented Mar 6, 2024

rinej commented Feb 14, 2024 •

edited

Loading

mananjadhav commented Feb 16, 2024 •

edited

Loading

rinej commented Mar 1, 2024 •

edited

Loading

mountiny commented Mar 4, 2024 •

edited

Loading