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

feat: show version debug info and update notification in profile menu [LIBS-176] [LIBS-344] #1153

Merged
merged 31 commits into from
Oct 3, 2022
Merged

feat: show version debug info and update notification in profile menu [LIBS-176] [LIBS-344] #1153

merged 31 commits into from
Oct 3, 2022

Conversation

amcgee
Copy link
Member

@amcgee amcgee commented Sep 22, 2022 •
edited
Loading

Implements LIBS-176
Implements LIBS-344

Requires dhis2/app-runtime#1252
Blocks dhis2/app-platform#748

Builds on #795 (credit to @Mohammer5) and the previous update notification flow in app-platform (credit to @KaiVandivier)

Description

This implements two features

  1. Debug info (DHIS2 and application versions) in headerbar
  2. Update Available notification

It also moves to using useConfig for the app name (rather than a prop) but maintains backwards compatibility.

Builds on and supersedes the good work by @Mohammer5 in #795

Known issues

  • Haven't yet fixed Cypress tests, they should be much simpler than in feat(headerbar): display instance's & app's info in profile menu - LIBS-176 #795 because we don't load the systemInfo data dynamically.
  • Styling might need some improvements
  • We eventually would like to either (1) show a tooltip indicating that a click on debug MenuItem will copy to clipboard or (2) show a dialog with extended debug info and an explicit copy action

Checklist

  • [ ] API docs are generated (no API docs for HeaderBar, currently)
  • Tests were added
  • Storybook demos were added

All points above should be relevant for feature PRs. For bugfixes, some points might not be relevant. In that case, just check them anyway to signal the work is done.

Screenshots

Screen Shot 2022-09-26 at 13 17 32

https://user-images.githubusercontent.com/947888/192796030-948971a6-cdda-4be6-b5cc-447a697e3b09.mov
(note that some small details have changed since this video was taken)

Mohammer5 and others added 16 commits November 23, 2021 11:18
@Mohammer5
refactor(headerbar profile): use functional component instead of class
4e5a2fa
@Mohammer5
feat(headerbar): add instance- & app-infos to profile menu
6185b5d
@Mohammer5
docs(headerbar): add story with instance- & app-infos in profile menu
42db34e
@Mohammer5
refactor(headerbar use instance info): simplify hook
6c0b8c0
@Mohammer5
refactor(headerbar instance infos): adjust styles according to sugges…
400b810 
…tions in PR
@Mohammer5
chore: fix linter issues
b54ddb9
@Mohammer5
test(header bar): add tests for "useInstanceInfo" & "useOnDocClick" h…
c299272 
…ooks
@Mohammer5
fix(profile menu): remove comma between app name and app version
1de06c6
@Mohammer5
fix(profile menu): remove hover style from instance and app info menu…
0a83b93 
… item
@Mohammer5
refactor(headerbar instance infos): omit "version" word in instance info
21532f1
@Mohammer5
refactor(instance and app infos): make user-selectable & add data-tes…
cfbd4f1 
…t props
@Mohammer5
test(instance and app infos): add cypress tests
434c04d
@Mohammer5
chore(linter and prettier): fix issues
5237b5c
@amcgee
Merge remote-tracking branch 'origin/master' into LIBS-176
054eaa2
@amcgee
feat: use context to fetch version info, add copy action
b712041
@amcgee
feat: support update notification in profile menu
bf95076
@amcgee amcgee marked this pull request as draft September 22, 2022 18:35
@dhis2-bot
Copy link
Contributor

dhis2-bot commented Sep 22, 2022 •
edited
Loading

🚀 Deployed on https://pr-1153--dhis2-ui.netlify.app

@dhis2-bot dhis2-bot temporarily deployed to netlify September 22, 2022 18:41 Inactive
@amcgee amcgee mentioned this pull request Sep 22, 2022
Merged
@dhis2-bot dhis2-bot temporarily deployed to netlify September 22, 2022 19:43 Inactive
@cypress
Copy link

cypress bot commented Sep 22, 2022 •
edited
Loading


Test summary

566 • 0 • 0 • 0

Run details
Project ui
Status Passed
Commit 7cbbdb9
Started Oct 3, 2022 12:33 PM
Ended Oct 3, 2022 12:42 PM
Duration 09:03 💡
OS Linux Ubuntu - 20.04
Browser Electron 94

View run in Cypress Dashboard ➡️

This comment has been generated by cypress-bot as a result of this project's GitHub integration settings. You can manage this integration in this project's settings in the Cypress Dashboard

@amcgee amcgee mentioned this pull request Sep 22, 2022
Closed
5 tasks
@dhis2-bot dhis2-bot temporarily deployed to netlify September 22, 2022 20:37 Inactive
@dhis2-bot dhis2-bot temporarily deployed to netlify September 22, 2022 20:56 Inactive
@dhis2-bot dhis2-bot temporarily deployed to netlify September 26, 2022 11:33 Inactive
@amcgee amcgee changed the base branch from master to beta September 26, 2022 13:53
@amcgee amcgee marked this pull request as ready for review September 26, 2022 13:56
@amcgee
Copy link
Member Author

amcgee commented Sep 26, 2022

I'm going to go ahead and merge this to beta for testing in-situ

@dhis2-bot dhis2-bot temporarily deployed to netlify September 26, 2022 14:04 Inactive
@dhis2-bot dhis2-bot temporarily deployed to netlify September 28, 2022 13:49 Inactive
@dhis2-bot dhis2-bot temporarily deployed to netlify September 28, 2022 14:32 Inactive
@dhis2-bot dhis2-bot temporarily deployed to netlify October 3, 2022 12:04 Inactive
@amcgee
Copy link
Member Author

amcgee commented Oct 3, 2022

Updated for all the various edge cases - a bit silly when we don't expect these to happen, but now they're covered (and tested in Cypress)

Normal:
Screen Shot 2022-10-03 at 14 06 12

App version unknown:
Screen Shot 2022-10-03 at 13 57 34

Instance version unknown:
Screen Shot 2022-10-03 at 13 57 23

App name unknown:
Screen Shot 2022-10-03 at 14 03 49

App name and version unknown:
Screen Shot 2022-10-03 at 13 57 29

Update available:
Screen Shot 2022-10-03 at 13 57 54

Update available with app name unknown:
Screen Shot 2022-10-03 at 13 57 44

@amcgee
Copy link
Member Author

amcgee commented Oct 3, 2022

When tests pass I'm going to merge this to beta for testing in-situ

@dhis2-bot dhis2-bot temporarily deployed to netlify October 3, 2022 12:27 Inactive
@amcgee
Copy link
Member Author

amcgee commented Oct 3, 2022

@cooper-joe should we de-duplicate the DHIS2 2.x ? Probably fine for now, but a bit redundant (always our problem here)

@amcgee amcgee merged commit 9e23f18 into beta Oct 3, 2022
@amcgee amcgee deleted the LIBS-344 branch October 3, 2022 12:46
@dhis2-bot dhis2-bot temporarily deployed to netlify October 3, 2022 13:10 Inactive
dhis2-bot added a commit that referenced this pull request Oct 3, 2022
@dhis2-bot
chore(release): cut 8.5.0-beta.1 [skip release]
62400b2 
# [8.5.0-beta.1](v8.4.16...v8.5.0-beta.1) (2022-10-03)

### Features

* show version debug info and update notification in profile menu [LIBS-176] [LIBS-344] ([#1153](#1153)) ([9e23f18](9e23f18))
@dhis2-bot
Copy link
Contributor

🎉 This PR is included in version 8.5.0-beta.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

@cooper-joe
Copy link
Member

@cooper-joe should we de-duplicate the DHIS2 2.x ? Probably fine for now, but a bit redundant (always our problem here)

Yeah I think it's fine for now. There doesn't seem to be an agreed format (I see both DHIS2 2.x and DHIS 2.x all over our website), so I think for clarity let's keep as is 👍.

dhis2-bot added a commit that referenced this pull request Oct 6, 2022
@dhis2-bot
chore(release): cut 8.5.0 [skip release]
5567d49 
# [8.5.0](v8.4.17...v8.5.0) (2022-10-06)

### Features

* show version debug info and update notification in profile menu [LIBS-176] [LIBS-344] ([#1153](#1153)) ([9e23f18](9e23f18))
@dhis2-bot
Copy link
Contributor

🎉 This PR is included in version 8.5.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

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

@Mohammer5 Mohammer5 Mohammer5 left review comments

@KaiVandivier KaiVandivier KaiVandivier left review comments

@cooper-joe cooper-joe Awaiting requested review from cooper-joe

Assignees
No one assigned
Labels
released on @beta released
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@amcgee @dhis2-bot @cooper-joe @Mohammer5 @KaiVandivier