Notify Administrators when there is a new version of Praise out #522
Conversation
packages/frontend/.env.template
Outdated
| REACT_APP_VERSION=$npm_package_version | ||
|
|
||
| # Github repo info | ||
| GITHUB_REPO_OWNER=commons-stack |
There was a problem hiding this comment.
These need to begin with REACT_APP.
| import { Nav } from '@/navigation/Nav'; | ||
| import { AuthenticatedRoutes } from '@/navigation/AuthenticatedRoutes'; | ||
|
|
||
| export const AuthenticatedLayout = (): JSX.Element | null => { | ||
| const [sidebarOpen, setSidebarOpen] = useState(false); | ||
| const siteNameSetting = useRecoilValue(SingleSetting('NAME')); | ||
| const activeUserRoles = useRecoilValue(ActiveUserRoles); | ||
| const isAdmin = useRecoilValue(HasRole(ROLE_ADMIN)); | ||
|
|
||
| const githubVersion = useGithubVersionQuery().substring(1); |
There was a problem hiding this comment.
Consider moving the version handling logic to the hook as well to make the setup more clear and clean. Hook could then be named usePraiseAppVersion and return an object in the format:
{
current: "v0.9.0",
latest: "v0.10.0",
newVersionAvailable: true
}
|
|
||
| const githubVersion = useGithubVersionQuery().substring(1); | ||
| const currentVersion = process.env.REACT_APP_VERSION; | ||
| const isNewVersion = githubVersion !== currentVersion; |
There was a problem hiding this comment.
New version is available when githubVersion > currentVersion.
packages/frontend/src/model/api.ts
Outdated
| /** | ||
| * External GET request | ||
| */ | ||
| export const ExternalGet = selectorFamily< |
There was a problem hiding this comment.
This code is not related to the api. Move to separate file.
| @@ -151,3 +151,28 @@ export const useSetSetting = (): useSetSettingReturn => { | |||
|
|
|||
| return { setSetting }; | |||
| }; | |||
|
|
|||
| export const GithubVersionQuery = selector({ | |||
There was a problem hiding this comment.
This code is not related to settings. Move to separate file.
| }, | ||
| }); | ||
|
|
||
| interface IGithubResponse { |
There was a problem hiding this comment.
We are not using a leading I in interface naming.
packages/frontend/src/utils/api.ts
Outdated
| * Client for external requests. | ||
| * @returns | ||
| */ | ||
| export const makeClient = (): AxiosInstance => { |
There was a problem hiding this comment.
This code is not related to the api. Move to separate file.
|
Here is a wireframe for the message layout:
Release notes links to the GitHub release notes page. For example: https://github.com/commons-stack/praise/releases/tag/v0.10.0 |
There was a problem hiding this comment.
Nice!
I made some small changes:
- Moved things not related to either the api or GitHub/version numbers to the file
axios.ts. We might use those functions for other purposes later on. - Deleted
useGithubVersionQuerysince it is basically only passing on the response. NowusePraiseAppVersioncallsuseRecoilValue(GithubVersionQuery)directly - Added check
isResponseOk(response) - Simplified styles of sticky message at top of screen. No need for
flexetc since content is a simple text paragraph - Added the current version number as a fixed bottom right on all screens.
Resolves #493