Where do I find a content node's ID?

Questions
1

I am trying to use the Content.GetById() command in a custom IContentFinder following the docs example. The example, and VS Intellisense, says to give it an int but I can’t find an actual int ID for the content node just a GUID. Where am I supposed to find this int ID from?

2

I think you should be able to pass the Guid of the content as well. If not, UmbracoContext.Content.GetById({guid}) should solve it definitly.

image

Greetings

3

The goal is to NOT use id’s anymore because they are usually not the same between environments. However, keys (guid) are almost guarantee to be unique, so that’s what we are using these days. You can’t see the id in the backoffice anymore, but you can see the guid.

There are a few things here and there that still want an int id, but it’s less and less common. So just use the key anywhere you can. GetById() also accepts a guid.

4

Int Id’s still used in the DB for primary keys.. as Guids aren’t suitable..

Wonder if UUIDv7 could be the answer to that?

How UUID v7 Works

UUID v7 consists of three segments: a 48-bit timestamp, a 12-bit random segment, and a 62-bit random segment.

  • The 48-bit timestamp represents the number of milliseconds since the Unix epoch.
  • The 12-bit random segment adds randomness to ensure uniqueness within the same millisecond,
  • while the 62-bit random segment ensures overall uniqueness, offering 122 bits of entropy.

This is particularly useful for databases where insertion order is important and can help in performance optimizations.

ET9 and UUIDv7

In .NET 9, UUIDv7 support was introduced which provides a way to generate ordered UUIDs based on timestamp. Developers can use the Guid.CreateVersion7() function to generate UUIDv7 with timestamp customization support.

Guid uuidV7 = Guid.CreateVersion7(); // Use DateTime.UtcNow
5

I don’t see how UUID relate to this issues or helps at all. Can you please clarify?

6

If I put the GUID raw or surounded by quotes it errors out with “Can’t convert from string to int”.

umbracoContext.Content.GetById("GUID");

where umracoContext is the result of `_umbracoContextAccessor.TryGetUmbracoContext(out var umbracoContext)’

Am I using the wrong context here?

7

Hi @Eaglef90

The IPublishedContentCache has an overload that accepts an int or a Guid:

You can’t pass the GUID as a string, it needs to be an actual Guid type, created using Guid.Parse() or Guid.TryParse().

As @Luuk says, don’t use the IDs and I would go as far to say don’t hard-code any IDs (ints or GUIDS), get them from appSettings if possible, or better still traverse the published content cache to get the node you need that way (if you know where it resides and does not result in lots of lookups).

Justin

8

I have not really dealt with GUIDs before so I was not awayre of the Guid.Parse() command thanks.

You also have a good point on the “don’t hard-code”, it made me realize this is a muti-site install and some sites will have there own news sections so if I hard-code this one ID that will mess them up. Now to figure out how to find the right news node while in my IContentFinder

9

A few suggestions:

  • You get the first node of type ‘news overview’ it finds under the root of the current site.
  • You create a picker somewhere where you pick the ‘correct’ newsoverview. Especially useful if you have multiple newsoverviews
10

I was able to build out code to grab the request’s hostname and pull the root node matching it then I pulled the news page under that node. I is all working on the routing end. Now it is time to build the template out to deal with everything for display

11

If you are already in a ‘routed request’ (and I think the ContentFinder would qualify) and you have a umbraco context available, you can get the root node’ where the cultures and hostnames are set on like this:

var rootId = umbracoContext.PublishedRequest?.Domain?.ContentId;

Manually getting the hostname from the request and matching should not be necessary.

12

That is almost the exact line of code I use. This is the final code I ended up with that works. How effecant is it? Probibly not at all since I am not used to working this deep but it works and I did it without AI (well the regex generator site I used might have used AI to make the regex for me) and I am proud of it. I did have to bug you all a bunch but I am learning.

    public sealed partial class NewsArchiveContentFinder(IUmbracoContextAccessor umbracoContextAccessor, IDocumentUrlService documentUrlService) : IContentFinder
    {
        [GeneratedRegex(@"\A/news/(?<year>[0-9]{4})/(?<month>0[1-9]|1[0-2])/?\z", RegexOptions.CultureInvariant | RegexOptions.ExplicitCapture | RegexOptions.IgnoreCase)]
        private static partial Regex NewsArchivePathRegex { get; }

        public Task<bool> TryFindContent(IPublishedRequestBuilder request)
        {
            var match = NewsArchivePathRegex.Match(request.Uri.GetAbsolutePathDecoded());
            if (!match.Success || !umbracoContextAccessor.TryGetUmbracoContext(out var umbracoContext)) return Task.FromResult(false);
            var year = int.Parse(match.Groups["year"].ValueSpan);
            var month = int.Parse(match.Groups["month"].ValueSpan);
            var rootNodeID = request.Domain?.ContentId;
            if (rootNodeID is null) return Task.FromResult(false);
            var rootNode = umbracoContext.Content.GetById(rootNodeID.Value);
            var newsNodeID = rootNode.FirstChild<NewsHomePage>().Key;
            var content = umbracoContext.Content.GetById(newsNodeID);
            if (content is null) return Task.FromResult(false);
            request.SetPublishedContent(content);
            return Task.FromResult(true);
        }
    }
}
13

I personally think that not using AI is not something to be necessarily ‘proud’ about. What I am proud about, is that you want to understand what you are doing and that is the right way to go about it.

But I personally think you should AI to do your research and to find the services that you can use most effectively. The question whether this is ‘effecient’ is something that AI can anwer really well. So I think that as long as you don’t just use anything that AI tells you, but use it as a research and verification tool, you should be fine.

I have 20+ years of development experience and Claude for instance is exceptionally well in following the source code of Umbraco and telling me if what I do is good or bad for performance of if it has any side effects. Especially scoping and transactions is a horror in Umbraco to understand well.

I did let Claude analyze your code sample and it give me this:

Good things first: [GeneratedRegex] on a partial property is a nice choice.
The regex is built at compile time, so it is fast. A content finder runs on
every request that does not match a page, so speed matters here. You also check
the regex before you use UmbracoContext. That is the right order.

Three things I would fix:

1. Two places can throw a NullReferenceException

GetById() returns IPublishedContent? and FirstChild<NewsHomePage>()
returns T?. Both can be null. So .Key can throw.

This is worse than it looks. If a content finder throws, Umbraco does not try
the next finder. The visitor gets a 500 error page.

When can they be null? The root node is null if it is not published (a domain
stays on a node even after you unpublish it). The child is null if nobody made
a NewsHomePage yet.

Turn on nullable reference types. The compiler will show you both problems.

2. year and month are read, but never used

You parse them into variables and then do nothing with them. So /news/2024/05
and /news/1999/01 show exactly the same page.

Two problems:

  • The template cannot know which month the visitor asked for.
  • Every year/month combination is a working URL with the same content. Google
    sees this as duplicate content. There is also no 404 for a month with no news.

Save the period in HttpContext.Items (or in a small scoped service) so your
view model can read it.

3. It stops working when a domain has a path

request.Uri.GetAbsolutePathDecoded() gives you the complete path. If you use
domains like example.com/en, then the path is /en/news/2024/05. Your regex
starts with \A/news/, so it never matches.

Fix it like this:

var path = request.Domain is not null
    ? DomainUtilities.PathRelativeToDomain(request.Domain.Uri, request.AbsolutePathDecoded)
    : request.AbsolutePathDecoded;

Also: when request.Domain is null, your code returns false. So the finder does
nothing on a site without hostnames. Better to use the first root node instead.

Smaller things

  • request.AbsolutePathDecoded already exists on IPublishedRequestBuilder.
    It is calculated one time in the constructor. So you do not need to decode
    the URI again on every request.
  • FirstChild() already gave you the node. Reading .Key and then calling
    GetById() asks the cache for the same node a second time. You can delete
    those two lines and use the node directly.
  • IDocumentUrlService is injected, but you never use it.
  • FirstChild<T>() is the “friendly” version. It gets its services from
    StaticServiceProvider. That is fine in a view. But your class already uses
    constructor injection, so inject IDocumentNavigationQueryService and
    IPublishedStatusFilteringService and pass them yourself.
  • Give request.Culture to FirstChild. Umbraco sets the culture from the
    domain before the finders run, so the value is ready for you.
  • The /? in your regex does nothing. The Uri on the builder never has a
    trailing slash.
  • Rename rootNodeID to rootNodeId, and give int.Parse a
    CultureInfo.InvariantCulture, or the analyzer will warn you (CA1305).

So an updated code example is this:

public sealed partial class NewsArchiveContentFinder(
    IUmbracoContextAccessor umbracoContextAccessor,
    IDocumentNavigationQueryService navigationQueryService,
    IPublishedStatusFilteringService publishedStatusFilteringService,
    IHttpContextAccessor httpContextAccessor) : IContentFinder
{
    public const string PeriodKey = "NewsArchivePeriod";

    [GeneratedRegex(@"\A/news/(?<year>[0-9]{4})/(?<month>0[1-9]|1[0-2])\z",
        RegexOptions.CultureInvariant | RegexOptions.ExplicitCapture | RegexOptions.IgnoreCase)]
    private static partial Regex NewsArchivePathRegex { get; }

    public Task<bool> TryFindContent(IPublishedRequestBuilder request)
        => Task.FromResult(TryFind(request));

    private bool TryFind(IPublishedRequestBuilder request)
    {
        if (!umbracoContextAccessor.TryGetUmbracoContext(out IUmbracoContext? umbracoContext))
        {
            return false;
        }

        // A domain can include a path (example.com/en), so match without that part.
        var path = request.Domain is not null
            ? DomainUtilities.PathRelativeToDomain(request.Domain.Uri, request.AbsolutePathDecoded)
            : request.AbsolutePathDecoded;

        Match match = NewsArchivePathRegex.Match(path);
        if (!match.Success)
        {
            return false;
        }

        IPublishedContent? siteRoot = request.Domain is not null
            ? umbracoContext.Content.GetById(umbracoContext.InPreviewMode, request.Domain.ContentId)
            : FirstRoot(umbracoContext);

        NewsHomePage? newsHome = siteRoot?.FirstChild<NewsHomePage>(
            navigationQueryService, publishedStatusFilteringService, request.Culture);

        if (newsHome is null)
        {
            return false;
        }

        var period = new DateOnly(
            int.Parse(match.Groups["year"].ValueSpan, CultureInfo.InvariantCulture),
            int.Parse(match.Groups["month"].ValueSpan, CultureInfo.InvariantCulture),
            1);

        if (httpContextAccessor.HttpContext is { } httpContext)
        {
            httpContext.Items[PeriodKey] = period;
        }

        request.SetPublishedContent(newsHome);
        return true;
    }

    private IPublishedContent? FirstRoot(IUmbracoContext umbracoContext)
        => navigationQueryService.TryGetRootKeys(out IEnumerable<Guid> rootKeys)
            ? rootKeys
                .Select(key => umbracoContext.Content.GetById(umbracoContext.InPreviewMode, key))
                .FirstOrDefault(content => content is not null)
            : null;
}