Using camel case adds id property to JSON document

[marcuslindblom]

I think the id property shouldn't exist in the JSON document but when I use camel case in my db it is always present. Is this a bug?

You can check this test out.

namespace Test
{
  public class IdentityPropertyNameCamelCaseTest : RavenTestDriver
  {
    private readonly ITestOutputHelper output;
    public IdentityPropertyNameCamelCaseTest(ITestOutputHelper output)
    {
      this.output = output;
    }
    protected override void PreInitialize(IDocumentStore documentStore)
    {
      documentStore.Conventions.Serialization = new NewtonsoftJsonSerializationConventions
      {
        CustomizeJsonSerializer = (serializer) =>
        {
          serializer.ContractResolver = new CamelCasePropertyNamesContractResolver();
        }
      };
      documentStore.Conventions.PropertyNameConverter = mi => $"{Char.ToLower(mi.Name[0])}{mi.Name.Substring(1)}";
      documentStore.Conventions.ShouldApplyPropertyNameConverter = info => true;
    }

    [Fact]
    public void ShouldGetUserResultOnQuery() {
      using (var store = GetDocumentStore())
      {
        using (var session = store.OpenSession())
        {
          var user = new MyUser {
            UserName = "john"
          };

          session.Store(user, "users/1");
          session.SaveChanges();
        }

        WaitForUserToContinueTheTest(store); //Sometimes we want to debug the test itself, this redirect us to the studio

        using (var session = store.OpenSession())
        {
          var user = session.Query<MyUser>().Where(u => u.UserName == "john").FirstOrDefault();
          Assert.NotNull(user);
        }
      }
    }

  public class MyUser : MyUserBaseClass {}
  public class MyUserBaseClass {
    public string Id {get;set;}
    public string UserName {get;set;}
  }
}

[ayende]

You are not seeing the document id convention, so we can't tell what is it.
FindIdentityProperty

[marcuslindblom]

Adding this documentStore.Conventions.FindIdentityProperty = info => info.Name == "id"; to my convention adds the property id with the value of null. I have included a failing test.

The id is not set when using StoryAsync nor when I get the entity from the store.

namespace Test
{
  public class IdentityPropertyNameCamelCaseTest : RavenTestDriver
  {
    private readonly ITestOutputHelper output;
    public IdentityPropertyNameCamelCaseTest(ITestOutputHelper output)
    {
      this.output = output;
    }
    protected override void PreInitialize(IDocumentStore documentStore)
    {
      documentStore.Conventions.Serialization = new NewtonsoftJsonSerializationConventions
      {
        CustomizeJsonSerializer = (serializer) =>
        {
          serializer.ContractResolver = new CamelCasePropertyNamesContractResolver();
        }
      };
      documentStore.Conventions.PropertyNameConverter = mi => $"{Char.ToLower(mi.Name[0])}{mi.Name.Substring(1)}";
      documentStore.Conventions.ShouldApplyPropertyNameConverter = info => true;
      documentStore.Conventions.FindIdentityProperty = info => info.Name == "id";
    }

    [Fact]
    public void ShouldGetUserResultOnQuery() {
      using (var store = GetDocumentStore())
      {
        using (var session = store.OpenSession())
        {
          var user = new MyUser {
            UserName = "john"
          };

          session.Store(user, "users/1");
          session.SaveChanges();
        }

        // WaitForUserToContinueTheTest(store);

        using (var session = store.OpenSession())
        {
          var user = session.Query<MyUser>().Where(u => u.UserName == "john").FirstOrDefault();
          Assert.NotNull(user);
          Assert.NotNull(user.Id);
        }
      }
    }

  public class MyUser : MyUserBaseClass {}
  public class MyUserBaseClass {
    public string Id {get;set;}
    public string UserName {get;set;}
  }
}

[marcuslindblom]

@ayende is this an issue or am I doing something wrong here?

[garayx]

it seems like we clear the Id property from json by using the property name which is starting with big letter.
https://issues.hibernatingrhinos.com/issue/RavenDB-20566

[marcuslindblom]

@garayx This seems to work great when using a C# class or record but if the object is a JObject with an id property it is not cleared. Is this a bug or do you recommend to me to remove the id property my self before storing?
This is a small sample

var obj = new JObject();
obj["userName"] = "john";
obj["lastLogin"] = DateTime.Now;
obj["id"] = "users/1";

session.Store(obj);
session.SaveChanges();

[ayende]

If you are using JObject directly, the serializer is just not involved.
If you want to modify the JObect as it is persisted, the is the BeforeStore event that gives you access to it.