Support IMutableNavigation.SetJsonPropertyName/IReadOnlyNavigation.GetJsonPropertyName - CosmosDB Provider

[georgechond94]

I am setting the json property names for all the non-shadow properties in my model as such:

var scalarProperties = builder.Model.GetEntityTypes()
                .SelectMany(et => et.GetProperties().Where(p => !p.IsShadowProperty()).ToList());

foreach (var mutableProperty in scalarProperties)
{
    var str = mutableProperty.GetJsonPropertyName();
    mutableProperty.SetJsonPropertyName(char.ToLowerInvariant(str[0]) + str[1..]);
}

The above works well for scalar properties, although the same functionality is not there for navigation properties:

var navigationProperties = builder.Model.GetEntityTypes()
                .SelectMany(et => et.GetNavigations().Where(p => !p.IsShadowProperty()).ToList());

foreach (var mutableNavigation in navigationProperties)
{
    var str = mutableNavigation.GetJsonPropertyName(); // doesn't exist
    mutableNavigation.SetJsonPropertyName(char.ToLowerInvariant(str[0]) + str[1..]); // doesn't exist
}

I tried setting the CosmosAnnotationNames.PropertyName annotation explicitly but it seems that it's being ignored for the IMutableNavigation objects.

public static void SetJsonPropertyName(IMutableNavigation navigation, string? name)
    => navigation.SetOrRemoveAnnotation(CosmosAnnotationNames.PropertyName, name);

Any reason why this is not supported?

Thanks!

[georgechond94]

Here is how a document looks like:

{
    "id": "Idf40a006c-f8e8-47e7-804f-3ca9bc890d91",
// scalar properties are named correctly.
    "name": "Name1aa46385-77a1-4a16-ac6b-b4d07eefe02d",
    "_etag": "\"00000000-0000-0000-1774-f210fcf501d8\"",
// navigation properties still have the default names
    "Slot": {
        "capacity": 10,
        "Products": [
            {
                "productTypeId": "ProductTypeIdc571369b-89ba-443a-a7e2-686cbf5021c0",
                "productVolume": 1
            }
        ]
    },
    "_rid": "XjEOAJc-lqsGAAAAAAAAAA==",
    "_self": "dbs/XjEOAA==/colls/XjEOAJc-lqs=/docs/XjEOAJc-lqsGAAAAAAAAAA==/",
    "_attachments": "attachments/",
    "_ts": 1643724405
}

[AndriySvyryd]

Try navigation.TargetEntityType.SetContainingPropertyName()

[georgechond94]

Hi @AndriySvyryd, thanks for your reply, that works as expected!

Question: do you think it makes sense to align that part a bit so these extension methods exist for both INavigation & IProperty?

I tried to implement that as my first contribution to efcore here: georgechond94@719ebf0
It works as expected and there are no failing tests.

Let me know if that change is welcome, if yes, I will go on with creating some tests & a PR.

[AndriySvyryd]

I don't think it improves the experience that much. Hopefully #15258 will make it unnecessary to use the methods on IMutable* interfaces

[georgechond94]

clear, thanks!