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.

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

fix(alerts provider): make plugin props optional #1384

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions services/alerts/src/AlertsProvider.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@ import { makeAlertsManager } from './makeAlertsManager'
import type { Alert, AlertsManager } from './types'

export const AlertsProvider = ({
plugin,
parentAlertsAdd,
showAlertsInPlugin,
children,
plugin = false,
parentAlertsAdd = undefined,
Copy link
Contributor Author

Choose a reason for hiding this comment

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

It's certainly not necessary to provide these default values, not sure what our team thinks is good good practice here?
I like seeing default values, but that's personal / preference.

Copy link
Member

Choose a reason for hiding this comment

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

Do you also want to add a default false for showAlertsInPlugin?

showAlertsInPlugin = false,
}: {
plugin: boolean
parentAlertsAdd: any
showAlertsInPlugin: boolean
children: React.ReactNode
plugin?: boolean
Copy link
Member

Choose a reason for hiding this comment

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

plugin should actually always be defined as long as you are using an up-to-date version of app-platform (https://github.com/dhis2/app-platform/blob/master/shell/src/App.js#L43). I'm not sure if there's a scenario where we want to mark it as an optional in case you're trying to resolve to a higher-version of app-runtime while using an older version of app-platform?

parentAlertsAdd?: any
showAlertsInPlugin?: boolean
}): ReactElement => {
const [alerts, setAlerts] = useState<Alert[]>([])
const [alertsManager] = useState<AlertsManager>(() =>
Expand Down
Loading