PrimaryEntityId getting set to Guid.Empty when context is being obtained in the Plugin

[vijayrit]

Hi all,

I have a use case where I have to check if the primaryentityid being passed in the context is Guid.Empty or not.

I have written the following test case where I mock the primaryentityid as follows:
`var PluginContext = fakeContext.GetDefaultPluginContext();

        PluginContext.Stage = 10;
        PluginContext.MessageName = "Retrieve";
        PluginContext.BusinessUnitId = Guid.NewGuid();
        PluginContext.CorrelationId = Guid.NewGuid();
        PluginContext.UserId = Guid.NewGuid();
        PluginContext.PrimaryEntityId = Guid.NewGuid();
        PluginContext.PrimaryEntityName = `"isp_userprovision";`

But when I am trying to compare it in the Plugin code I found that it is being set to Guid.Empty

Has someone faced this issue previously? If yes, can you please help me with the solution.

[BetimBeja]

Hello @vijayrit
PrimaryEntityId gets read from the Target entity:

fake-xrm-easy/FakeXrmEasy.Shared/XrmFakedContext.Plugins.cs

Lines 78 to 88 in f294b9a

	if (ctx.InputParameters["Target"] is Entity)
	{
	var target = (Entity)ctx.InputParameters["Target"];
	A.CallTo(() => context.PrimaryEntityId).ReturnsLazily(() => target.Id);
	A.CallTo(() => context.PrimaryEntityName).ReturnsLazily(() => target.LogicalName);
	}
	else if (ctx.InputParameters["Target"] is EntityReference)
	{
	var target = (EntityReference)ctx.InputParameters["Target"];
	A.CallTo(() => context.PrimaryEntityId).ReturnsLazily(() => target.Id);
	A.CallTo(() => context.PrimaryEntityName).ReturnsLazily(() => target.LogicalName);

[jordimontana82]

Yes, this has caused a bit of confusion. When you execute the plugin with the target as a parameter, it'll use the properties of the target as Betim said above, otherwise, you would need to use the method overload that receives the plugin context method instead.

[vijayrit]

Hi Jordi we are using this method. But we are passing a fakedexecutioncontext for the same. A sample code snippet for reference.

public void NegativeScenario()
        {
            var fakeContext = new XrmFakedContext();
            

            var PluginContext = fakeContext.GetDefaultPluginContext();

            var id = Guid.NewGuid();

            // Define Input Parameter
            var inputParameter = new ParameterCollection();


            PluginContext.Stage = 10;
            PluginContext.MessageName = "Retrieve";
            PluginContext.BusinessUnitId = Guid.NewGuid();
            PluginContext.CorrelationId = Guid.NewGuid();
            PluginContext.UserId = Guid.NewGuid();
            PluginContext.PrimaryEntityId = id;
            PluginContext.PrimaryEntityName = "primary entity";

            PluginContext.InputParameters = inputParameter;

            //test data mocked here. Removed for brevity.       
            
            inputParameter.Add("Target", useraccessrecord);

            fakeContext.ExecutePluginWith<UserProvisionDataProvider>(PluginContext);

        }

[BetimBeja]

You have inputParameter.Add("Target", useraccessrecord);.
Why do you want to override PluginContext.PrimaryEntityId = id; and PluginContext.PrimaryEntityName = "primary entity"; you should use PluginContext.PrimaryEntityId = useraccessrecord.Id and PluginContext.PrimaryEntityName= useraccessrecord.LogicalName

[jordimontana82]

+1 above. @vijayrit If you want to pass the Target, then use ExecutePluginWithTarget instead. The ExecutePluginWith method was introduced if you had to access other properties of the context only. Why would you want to pass a Target with a different entity logical name than context.PrimaryEntityName?

[vijayrit]

Ok, thanks for the information Jordi and Betim.

This helps clarify the question. On the same note, is there a documentation of which function to use when, as this would be very helpful in leveraging the full benefits of the Nuget?

[jordimontana82]

Thanks, these methods were described here: https://dynamicsvalue.com/get-started/plugins

As part of the v2 release we'll publish an updated docs page. In the meantime, the page above and the repo itself is the best documentation we have so far...