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

Conversation

Mohammer5
Copy link
Contributor

While moving the instance manager FE from CRA to Vite, I encountered one type issue in this repository:

The AlertsProvider's plugin props aren't optional

@Mohammer5 Mohammer5 requested a review from tomzemp July 15, 2024 09:29
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?

Copy link
Member

@tomzemp tomzemp left a comment

Choose a reason for hiding this comment

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

Left some comments for your consideration, but looks good 🙏

children,
plugin = false,
parentAlertsAdd = undefined,
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?

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?

Copy link

sonarcloud bot commented Nov 25, 2024

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants