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

Add HealthCheckCompletedNotification #15276

Conversation

erikjanwestendorp
Copy link
Contributor

@erikjanwestendorp erikjanwestendorp commented Nov 21, 2023

Prerequisites

  • I have added steps to test this contribution in the description below

Description

I was testing the Webhooks feature that has been added to Umbraco 13 and thought it would be nice if a webhook call could be made when one or more health checks are completed. To achieve this, a notification is needed. This PR introduces a HealthCheckCompletedNotification.

I intentionally created this PR in the v13 branch because it causes a breaking change due to modifications in the constructors of the HealthCheckController and the HealthCheckNotifierJob.

This PR can be tested by creating a notification and registering it in the Program.cs class like so:

using Umbraco.Cms.Core.Events;
using Umbraco.Cms.Core.Notifications;

namespace Umbraco.Cms.Web.UI.Notifications;

public class TestHealthCheckCompletedNotification : INotificationHandler<HealthCheckCompletedNotification>
{
    public void Handle(HealthCheckCompletedNotification notification)
    {
       // Do something
    }
}

Program.cs:

builder.CreateUmbracoBuilder()
    .AddBackOffice()
    .AddWebsite()
    .AddDeliveryApi()
    .AddComposers()
    .AddNotificationHandler<HealthCheckCompletedNotification, TestHealthCheckCompletedNotification>()
    .Build();

Copy link

github-actions bot commented Nov 21, 2023

Hi there @erikjanwestendorp, thank you for this contribution! 👍

While we wait for one of the Core Collaborators team to have a look at your work, we wanted to let you know about that we have a checklist for some of the things we will consider during review:

  • It's clear what problem this is solving, there's a connected issue or a description of what the changes do and how to test them
  • The automated tests all pass (see "Checks" tab on this PR)
  • The level of security for this contribution is the same or improved
  • The level of performance for this contribution is the same or improved
  • Avoids creating breaking changes; note that behavioral changes might also be perceived as breaking
  • If this is a new feature, Umbraco HQ provided guidance on the implementation beforehand
  • 💡 The contribution looks original and the contributor is presumably allowed to share it

Don't worry if you got something wrong. We like to think of a pull request as the start of a conversation, we're happy to provide guidance on improving your contribution.

If you realize that you might want to make some changes then you can do that by adding new commits to the branch you created for this work and pushing new commits. They should then automatically show up as updates to this pull request.

Thanks, from your friendly Umbraco GitHub bot 🤖 🙂

@nul800sebastiaan nul800sebastiaan merged commit c0e0e7b into umbraco:v13/dev Nov 30, 2023
14 of 15 checks passed
@nul800sebastiaan
Copy link
Member

This is great @erikjanwestendorp! 👍 And, while no longer breaking, we'll merge it for v13, and if you have a moment you could add a PR for the webhook as well, I just merged @warrenbuckley's huge PR #15161, so you could take his examples and add one more!

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

Successfully merging this pull request may close these issues.

3 participants