Skip to content

Improve notifications onboarding #2171

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

Merged
mateumiralles merged 4 commits into from
May 27, 2025
Merged

Improve notifications onboarding #2171

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
24cbb4b
onboarding installs notis pkg
mateumiralles May 26, 2025
db36e96
keeping track of installation
mateumiralles May 26, 2025
1930893
fix notifications pkg calls
mateumiralles May 26, 2025
189229f
typo
mateumiralles May 27, 2025
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
6 changes: 4 additions & 2 deletions packages/admin-ui/src/components/welcome/BottomButtons.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,16 @@ export default function BottomButtons({
backTag = "Back",
nextTag = "Next",
backVariant = "outline-secondary",
nextVariant = "dappnode"
nextVariant = "dappnode",
nextDisabled = false
}: {
onBack?: () => void;
onNext?: () => void;
backTag?: string;
nextTag?: string;
backVariant?: ButtonVariant;
nextVariant?: ButtonVariant;
nextDisabled?: boolean;
}) {
return (
<div className="bottom-buttons">
Expand All @@ -24,7 +26,7 @@ export default function BottomButtons({
</Button>
)}
{onNext && (
<Button onClick={onNext} variant={nextVariant} className="next">
<Button onClick={onNext} variant={nextVariant} className="next" disabled={nextDisabled}>
{nextTag}
</Button>
)}
Expand Down
100 changes: 80 additions & 20 deletions packages/admin-ui/src/components/welcome/features/EnableNotifications.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,59 @@ import { notificationsDnpName } from "params.js";
import { withToast } from "components/toast/Toast";
import { continueIfCalleDisconnected } from "api/utils";

import Loading from "components/Loading";
import { prettyDnpName } from "utils/format";

export default function EnableNotifications({ onBack, onNext }: { onBack?: () => void; onNext: () => void }) {
const [notificationsDisabled, setNotificationsDisabled] = useState<boolean>(false);
const [notificationsNotInstalled, setNotificationsNotInstalled] = useState<boolean>(false);
const [isNotificationsInstalling, setIsNotificationsInstalling] = useState<boolean>(false);

const notificationsDnp = useApi.packageGet({ dnpName: notificationsDnpName });
const dnps = useApi.packagesGet();
useEffect(() => {
if (dnps.data) {
setNotificationsNotInstalled(dnps.data.find((dnp) => dnp.dnpName === notificationsDnpName) === undefined);
}
}, [dnps.data]);

useEffect(() => {
async function installNotificationsPkg() {
try {
setIsNotificationsInstalling(true);
await withToast(
continueIfCalleDisconnected(
() =>
api.packageInstall({
name: notificationsDnpName,
// TODO: Delete the version once the notifications package is released
version: "/ipfs/QmUMZfGt15CE8yifCAbeUybm75qUxAe1SucnqsbGjGEiKn",
options: {
BYPASS_SIGNED_RESTRICTION: true
}
}),
notificationsDnpName
),
{
message: `Installing ${prettyDnpName(notificationsDnpName)}...`,
onSuccess: `Installed ${prettyDnpName(notificationsDnpName)}`
}
);
} catch (error) {
console.error(`Error while installing notifications package: ${error}`);
setIsNotificationsInstalling(false);
return;
} finally {
setIsNotificationsInstalling(false);
notificationsDnp.revalidate();
}
}

if (notificationsNotInstalled) {
installNotificationsPkg();
}
}, [notificationsNotInstalled]);

const notificationsDnp = useApi.packageGet({ dnpName: notificationsDnpName });
useEffect(() => {
if (notificationsDnp.data) {
const isStopped = notificationsDnp.data.containers.some((c) => c.state !== "running");
Expand Down Expand Up @@ -54,27 +102,39 @@ export default function EnableNotifications({ onBack, onNext }: { onBack?: () =>
We're transitioning to a new and improved in-app Notifications experience, designed to be more reliable,
configurable and scalable.
</div>
<SubTitle>Enable new notifications</SubTitle>
<Switch
checked={!notificationsDisabled}
disabled={notificationsDnp.isValidating}
onToggle={() => {
startStopNotifications();
}}
/>
<br />
<br />
<p>
This notifications may alert you to critical issues if they arise. Disabling them could result in missing
critical notifications
</p>
<p>
Learn more about notifications package and how to configure it in the{" "}
<a href={docsUrl.notificationsOverview} {...externalUrlProps}>Dappnode's documentation</a>
</p>
{notificationsNotInstalled ? (
isNotificationsInstalling ? (
<Loading steps={["Installing notifications package"]} />
) : (
notificationsDnp.error && <SubTitle>Error while installing notifications package</SubTitle>
)
) : (
<>
<SubTitle>Enable new notifications</SubTitle>
<Switch
checked={!notificationsDisabled}
disabled={notificationsDnp.isValidating}
onToggle={() => {
startStopNotifications();
}}
/>
<br />
<br />
<p>
This notifications may alert you to critical issues if they arise. Disabling them could result in missing
critical notifications
</p>
<p>
Learn more about notifications package and how to configure it in the{" "}
<a href={docsUrl.notificationsOverview} {...externalUrlProps}>
Dappnode's documentation
</a>
</p>
</>
)}
</div>

<BottomButtons onBack={onBack} onNext={() => onNext()} />
<BottomButtons onBack={onBack} onNext={() => onNext()} nextDisabled={isNotificationsInstalling} />
<br />
<br />
</div>
Expand Down
Loading