Acccess CreateTreeNode in TreeNodesRenderingNotification

[bjarnef]

In Umbraco v8 with TreeControllerBase.TreeNodesRendering event we had access to CreateTreeNode() method, which was available via sender:

void TreeControllerBase_TreeNodesRendering(TreeControllerBase sender, TreeNodesRenderingEventArgs e)
{
    if (sender.TreeAlias == Vendr.Core.Constants.System.ProductAlias && e.QueryStrings["nodeType"] == Vendr.Core.Constants.Entities.EntityTypes.Store)
    {
        var mainRoute = Vendr.Umbraco.Constants.Sections.Commerce + "/" + Constants.System.ProductAlias;

        var storeId = e.QueryStrings["id"];
        var id = Constants.Trees.Reviews.Id;

        var reviewsNode = sender.CreateTreeNode(id, storeId, e.QueryStrings, "Reviews", Constants.Trees.Reviews.Icon, false, $"{mainRoute}/review-list/{storeId}");

        reviewsNode.Path = $"-1,{storeId},{id}";
        reviewsNode.NodeType = Constants.Trees.Reviews.NodeType;

        reviewsNode.AdditionalData.Add("storeId", storeId);
        reviewsNode.AdditionalData.Add("tree", Vendr.Umbraco.Constants.Trees.Stores.Alias);
        reviewsNode.AdditionalData.Add("application", Vendr.Umbraco.Constants.Sections.Commerce);

        var optNodeIndex = e.Nodes.FindIndex(x => x.NodeType == "Options");
        var index = optNodeIndex >= 0 ? optNodeIndex : e.Nodes.Count;

        e.Nodes.Insert(index, reviewsNode);
    }
}

This seems no longer to be the case with TreeNodesRenderingNotification notification in v9:

public class ReviewsTreeNodesNotification : INotificationHandler<TreeNodesRenderingNotification>
{
    private readonly UmbracoApiControllerTypeCollection _apiControllers;
    private readonly IUrlHelper _urlHelper;

    public ReviewsTreeNodesNotification(
        UmbracoApiControllerTypeCollection apiControllers,
        IUrlHelper urlHelper)
    {
        _apiControllers = apiControllers;
        _urlHelper = urlHelper;
    }

    public void Handle(TreeNodesRenderingNotification notification)
    {
        if (notification.TreeAlias == Vendr.Core.Constants.System.ProductAlias
            && notification.QueryString["nodeType"] == Vendr.Core.Constants.Entities.EntityTypes.Store)
        {
            var mainRoute = Vendr.Umbraco.Constants.Sections.Commerce + "/" + Constants.System.ProductAlias;

            var storeId = notification.QueryString["id"];
            var id = Constants.Trees.Reviews.Id;

            //var reviewsNode = CreateTreeNode(id, storeId, notification.QueryString, "Reviews", Constants.Trees.Reviews.Icon, false, $"{mainRoute}/review-list/{storeId}");

            string jsonUrl = _urlHelper.GetTreeUrl(_apiControllers, notification.GetType(), id, notification.QueryString);
            string menuUrl = _urlHelper.GetMenuUrl(_apiControllers, notification.GetType(), id, notification.QueryString);
            
            var reviewsNode = new TreeNode(id, storeId, jsonUrl, menuUrl)
            {
                Icon = Constants.Trees.Reviews.Icon,
                HasChildren = false,
                Name = "Reviews",
                Path = $"-1,{storeId},{id}",
                RoutePath = $"{mainRoute}/review-list/{storeId}",
                NodeType = Constants.Trees.Reviews.NodeType
            };

            reviewsNode.AdditionalData.Add("storeId", storeId);
            reviewsNode.AdditionalData.Add("tree", Vendr.Umbraco.Constants.Trees.Stores.Alias);
            reviewsNode.AdditionalData.Add("application", Vendr.Umbraco.Constants.Sections.Commerce);

            var optNodeIndex = notification.Nodes.FindIndex(x => x.NodeType == "Options");
            var index = optNodeIndex >= 0 ? optNodeIndex : notification.Nodes.Count;

            notification.Nodes.Insert(index, reviewsNode);
        }
    }
}

Instead we need to inject UmbracoApiControllerTypeCollection and IUrlHelper which has two extension methods GetTreeUrl() and GetMenuUrl().
https://github.com/umbraco/Umbraco-CMS/blob/v9/contrib/src/Umbraco.Web.BackOffice/Trees/UrlHelperExtensions.cs#L44-L65

It would be great if we could access the CreateTreeNode() and maybe also CreateRootNode() like when creating a regular TreeController, which inherit these methods from TreeControllerBase:
https://github.com/umbraco/Umbraco-CMS/blob/v9/contrib/src/Umbraco.Web.BackOffice/Trees/TreeControllerBase.cs#L204-L218

In the example above it inject a tree node inject the existing Vendr tree.

Could we either inject a service or inherit these methods ... or access these from TreeNodesRenderingNotification parameter?

[bjarnef]

It seems when using IUrlHelper I get this error on startup:

If I register IUrlHelper like suggested in https://stackoverflow.com/a/54858702/1693918 the application is starting:

public static IUmbracoBuilder AddVendrReviews(this IUmbracoBuilder builder, Action<VendrReviewsSettings> defaultOptions = default)
{
    // Register configuration
    var options = builder.Services.AddOptions<VendrReviewsSettings>()
        .Bind(builder.Config.GetSection(Constants.System.ProductName));

    if (defaultOptions != default)
        options.Configure(defaultOptions);

    options.ValidateDataAnnotations();

    builder.Services.AddScoped<IUrlHelper>(factory =>
    {
        var actionContext = factory.GetService<IActionContextAccessor>()
                                   .ActionContext;
        return new UrlHelper(actionContext);
    });

    builder.Services.AddHttpContextAccessor();

    // Register services
    builder.Services.AddTransient<IReviewRepositoryFactory, ReviewRepositoryFactory>();
    builder.Services.AddSingleton<IReviewService, ReviewService>();
    builder.Services.AddSingleton<VendrReviewsApi>();

    // Register event handlers
    builder.AddNotificationHandler<TreeNodesRenderingNotification, ReviewsTreeNodesNotification>();

    // Register component
    builder.Components()
        .Append<VendrReviewsComponent>();

    return builder;
}

But then cause error when logging into backoffice:

@bergmania is there something we should register to use IUrlHelper to use the GetTreeUrl() and GetMenu() extensions?

[bjarnef]

It found a similar example here:
Dotnet-Boxed/Framework#18 (comment)

services.AddScoped<IUrlHelper>(factory =>
{
       var actionContext = factory.GetService<IActionContextAccessor>().ActionContext;
       return new UrlHelper(actionContext);
});

[bjarnef]

This inject IActionContextAccessor which seems to create the tree node. although not correct and with some errors.
I guess it is missing something in the action context.

public class ReviewsTreeNodesNotification : INotificationHandler<TreeNodesRenderingNotification>
{
    private readonly UmbracoApiControllerTypeCollection _apiControllers;
    private readonly IActionContextAccessor _actionContextAccessor;
    //private readonly IUrlHelper _urlHelper;

    public ReviewsTreeNodesNotification(
        UmbracoApiControllerTypeCollection apiControllers,
        IActionContextAccessor actionContextAccessor
        //IUrlHelper urlHelper
        )
    {
        _apiControllers = apiControllers;
        _actionContextAccessor = actionContextAccessor;
        //_urlHelper = urlHelper;
    }

    public void Handle(TreeNodesRenderingNotification notification)
    {
        if (notification.TreeAlias == Vendr.Core.Constants.System.ProductAlias
            && notification.QueryString["nodeType"] == Vendr.Core.Constants.Entities.EntityTypes.Store)
        {
            var mainRoute = Vendr.Umbraco.Constants.Sections.Commerce + "/" + Constants.System.ProductAlias;

            var storeId = notification.QueryString["id"];
            var id = Constants.Trees.Reviews.Id;

            //var reviewsNode = CreateTreeNode(id, storeId, notification.QueryString, "Reviews", Constants.Trees.Reviews.Icon, false, $"{mainRoute}/review-list/{storeId}");

            var urlHelper = new Microsoft.AspNetCore.Mvc.Routing.UrlHelper(_actionContextAccessor.ActionContext);

            string jsonUrl = urlHelper.GetTreeUrl(_apiControllers, notification.GetType(), id, notification.QueryString);
            string menuUrl = urlHelper.GetMenuUrl(_apiControllers, notification.GetType(), id, notification.QueryString);
            
            var reviewsNode = new TreeNode(id, storeId, jsonUrl, menuUrl)
            {
                Icon = Constants.Trees.Reviews.Icon,
                HasChildren = false,
                Name = "Reviews",
                Path = $"-1,{storeId},{id}",
                RoutePath = $"{mainRoute}/review-list/{storeId}",
                NodeType = Constants.Trees.Reviews.NodeType
            };

            reviewsNode.AdditionalData.Add("storeId", storeId);
            reviewsNode.AdditionalData.Add("tree", Vendr.Umbraco.Constants.Trees.Stores.Alias);
            reviewsNode.AdditionalData.Add("application", Vendr.Umbraco.Constants.Sections.Commerce);

            var optNodeIndex = notification.Nodes.FindIndex(x => x.NodeType == "Options");
            var index = optNodeIndex >= 0 ? optNodeIndex : notification.Nodes.Count;

            notification.Nodes.Insert(index, reviewsNode);
        }
    }
}

Maybe there's a workaround to get an existing tree (in this case Vendr tree).

[bjarnef]

Okay, the mainRoute was correct as it was, but apparently I missed to copy the package.manifest to the Vendr demo store, where I tested this. Now it looks like this:

[bjarnef]

Maybe it is missing something, which is handled in TreeControllerBase or something might has changed regarding TreeGroup from v8 to v9?

[bergmania]

Not sure, there shouldn't be changes as far as Im aware.. And couldn't find differences when I just briefly compared the tree implementations in v8 and v9

[bjarnef]

Just a guess, could the UrlHelper or ActionContext be missing any route data here, which TreeControllerBase handle?

[bjarnef]

@bergmania okay, so this in weird. In seems TreeUse.None instead of TreeUse.Main works.

However v1 of Vendr Review did use TreeUse.Main, so strange this is different in v9.
From the comment I would have though the TreeUse.None should be used if you didn't want to render the tree, hide the tree or maybe not had a view for the tree like the "Options" tree menu in Vendr.