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

🌟 Added console helpers to debug the app state #2259 #2271

Merged
merged 4 commits into from
Jun 13, 2022
Merged

🌟 Added console helpers to debug the app state #2259 #2271

merged 4 commits into from
Jun 13, 2022

Conversation

rezk2ll
Copy link
Member

@rezk2ll rezk2ll commented Jun 10, 2022 •
edited
Loading

Description

  • adds the ability to debug the application recoil state
  • added get method to inspect the value a given atom key
  • added getAllAtoms to inspect the value of all the atoms
  • added dumpStateSnapshot to dump the current state into a json file

Related Issue

#2259

Motivation and Context

  • help developers and QA to debug the app

How Has This Been Tested?

  • locally

Screenshots (if appropriate):

demo-debug-state.mp4

image

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added the Signed-off-by statement at the end of my commit message.

@rezk2ll rezk2ll linked an issue Jun 10, 2022 that may be closed by this pull request
Find a way to debug the recoiljs state easily from the browser console #2259
Closed
@rezk2ll rezk2ll requested a review from RomaricMourgues June 10, 2022 14:46
@rezk2ll rezk2ll changed the title 🌟 Added console helpers to debug the app state in DEV mode ( #2259 ) 🌟 Added console helpers to debug the app state in DEV mode #2259 Jun 10, 2022
@RomaricMourgues
Copy link
Contributor

Thats seems super nice ! Could you put this to this documentation : https://www.notion.so/linagora/Frontend-Documentation-1cf000d07ef1495fb4c7ac38d832455d and reference it in https://www.notion.so/linagora/Troubleshooting-7d7162c019974c519d055123715949c1 ?

RomaricMourgues
RomaricMourgues suggested changes Jun 10, 2022
View reviewed changes
Copy link
Contributor

@RomaricMourgues RomaricMourgues left a comment

Choose a reason for hiding this comment

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

Small changes requested to use a hook instead and use production

twake/frontend/src/app/components/debug/debug-state.tsx Outdated Show resolved Hide resolved
twake/frontend/src/app/components/debug/debug-state.tsx Outdated Show resolved Hide resolved
@rezk2ll rezk2ll force-pushed the #2259 branch 2 times, most recently from fe5fa4b to 819dcdf Compare June 13, 2022 08:36
@rezk2ll rezk2ll requested a review from RomaricMourgues June 13, 2022 08:36
@rezk2ll rezk2ll changed the title 🌟 Added console helpers to debug the app state in DEV mode #2259 🌟 Added console helpers to debug the app state #2259 Jun 13, 2022
@RomaricMourgues RomaricMourgues merged commit 19095aa into linagora:develop Jun 13, 2022
@RomaricMourgues RomaricMourgues added the qa:ready When a PR is ready to go to QA label Jun 13, 2022
RomaricMourgues pushed a commit that referenced this pull request Jun 13, 2022
@rezk2ll
👨‍💻 Added console helpers to debug the app state #2259 (#2271)
d4422cf 
* 🌟 Added console helper functions to debug the application state in dev mode

* 🌟 Added localstorage to the file dump

* 🌟 Added custom hook to debug recoil state

* 🛠 moved code to 1 single file
@github-actions github-actions bot removed qa:ready When a PR is ready to go to QA staging:develop labels Jun 13, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@RomaricMourgues RomaricMourgues RomaricMourgues approved these changes

Assignees
No one assigned
Labels
staging:main
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Find a way to debug the recoiljs state easily from the browser console
3 participants
@rezk2ll @RomaricMourgues @shepilov