Excluding some fields in startup configuration

[salem84]

In startup.cs configure fields to exclude from displaying (e.g. sensible content)

[rebinqadirdev]

I like to take this issue could you assign to me !

[salem84]

I like to take this issue could you assign to me !

Hi @rebiiin, sure! Do you have any idea for developing it?

[rebinqadirdev]

Could you specify some of fields that not be display !!!

[salem84]

Initially when I wrote this issue, my idea was to create some options in startup configuration in order to hide any sensible fields (fields depend on developer preferences such as for example particular path or assembly information).
But now I think this method could be very complex and not feasible to apply.
Maybe it's better create a custom provider, inherited from standard provider and specify fields to hide.
A solution maybe override GetData method, calls initial base class method and then remove fields... So the source code changes are minimal and we can add this approach to documentation.
If you have any other idea, we can talk about it

[rebinqadirdev]

Hi,
I have an idea, I tried to add a new extension method then passed an array to the ApiEndpoint middleware so in the ApiEndpoint I changed the responseContent = JsonConvert.SerializeObject(versionInfo); to this one responseContent = JsonConvert.SerializeObject(versionInfo, Formatting.Indented, new JsonSerializerSettings { ContractResolver = new DynamicContractResolver(_versionInfoSetting.listofitems.ToArray()) }); but it wasn't successful for entire services I like to share here all the changes I have done

 services.AddVersionInfo()
                .With<ClrVersionProvider>().Exclude(option =>
                {
                    option.excluded = new string[] { "ProviderName", "Value" };
                }); 



public  static VersionInfoBuilder Exclude(this VersionInfoBuilder builder, Action<VersionInfoSettings> configureOptions = null)
        {
            var options = new VersionInfoSettings();


            configureOptions(options);

            builder.Services.AddScoped<IVersionInfoSetting>(factory =>
            {
                return new VersionInfoSettingService(options);
            });

            return builder;
        }



public async Task InvokeAsync(HttpContext context, IVersionInfoSetting _versionInfoSetting)
        {
            string responseContent = string.Empty;

            using (var scope = _serviceScopeFactory.CreateScope())
            {
                var infoHandler = scope.ServiceProvider.GetService<IInfoCollector>();
                var versionInfo = infoHandler.AggregateData() as FlatCollectorResult;

                responseContent = JsonConvert.SerializeObject(versionInfo, Formatting.Indented, new JsonSerializerSettings { 
                ContractResolver = new DynamicContractResolver(_versionInfoSetting.listofitems.ToArray()) });
               
            }

            context.Response.ContentType = Constants.DEFAULT_API_RESPONSE_CONTENT_TYPE;

            await context.Response.WriteAsync(responseContent);
        }





 public class DynamicContractResolver : DefaultContractResolver
    {
        private readonly string[] _Properties;

        public DynamicContractResolver(params string[] Properties)
        {
            this._Properties = Properties;
        }
         
        protected override IList<Newtonsoft.Json.Serialization.JsonProperty> CreateProperties(Type type, MemberSerialization 
                                        memberSerialization)
        {

            IList<Newtonsoft.Json.Serialization.JsonProperty> result = base.CreateProperties(type, memberSerialization);

            result  = result.Where(p => !this._Properties.Contains(p.PropertyName)).ToList();


            return result;
        }


        
    }

public interface IVersionInfoSetting
    {
        IEnumerable<string> listofitems { get; set; }
      
    }



public class VersionInfoSettings 
    {
        public IEnumerable<string> excluded { get; set; }
    }



 public class VersionInfoSettingService : IVersionInfoSetting
    {
        private readonly VersionInfoSettings _versionInfoSettings;

        public IEnumerable<string> listofitems { get;set; }
    

        public VersionInfoSettingService(VersionInfoSettings versionInfoSettings )
        {
            this._versionInfoSettings = versionInfoSettings;

            listofitems = _versionInfoSettings.excluded;
            
        }
    }

The result of version api before add the Exclude extension method to AddVersionInfo services in configuration method (DI)

{
  "Results": [
    {
      "ProviderName": "ClrVersionProvider",
      "Key": "RuntimeInformation.FrameworkDescription",
      "Value": ".NET 5.0.10"
    },
    {
      "ProviderName": "ClrVersionProvider",
      "Key": "RuntimeInformation.OsDescription",
      "Value": "Microsoft Windows 10.0.19043"
    },
    {
      "ProviderName": "ClrVersionProvider",
      "Key": "RuntimeInformation.OsArchitecture",
      "Value": "X64"
    },
    {
      "ProviderName": "ClrVersionProvider",
      "Key": "RuntimeInformation.ProcessArchitecture",
      "Value": "X64"
    },
    {
      "ProviderName": "ClrVersionProvider",
      "Key": "RuntimeInformation.RuntimeIdentifier",
      "Value": "win10-x64"
    },
    {
      "ProviderName": "ClrVersionProvider",
      "Key": "Environment.DotNetVersion",
      "Value": "5.0.10"
    }
  ],
  "Count": 6
}

then the result after added both (ProviderName and Value) to the Exclude method

{
  "Results": [
    {
      "Key": "RuntimeInformation.FrameworkDescription"
    },
    {
      "Key": "RuntimeInformation.OsDescription"
    },
    {
      "Key": "RuntimeInformation.OsArchitecture"
    },
    {
      "Key": "RuntimeInformation.ProcessArchitecture"
    },
    {
      "Key": "RuntimeInformation.RuntimeIdentifier"
    },
    {
      "Key": "Environment.DotNetVersion"
    }
  ],
  "Count": 6
}

I hope this idea will help if possible

[salem84]

Thanks @rebiiin, I like your approach and I think we can work on it (do you have a fork repository about it?).
Moreover I think we can also simplify this process... I try to explain better... my initial idea was to hide some fields (entire row) in output, for example when a field is sensible or irrelevant:

{
  "Results": [
    {
      "ProviderName": "ClrVersionProvider",
      "Key": "RuntimeInformation.FrameworkDescription",
      "Value": ".NET 5.0.10"
    },
    {
      "ProviderName": "ClrVersionProvider",
      "Key": "RuntimeInformation.OsDescription",
      "Value": "Microsoft Windows 10.0.19043"
    },
    {
      "ProviderName": "ClrVersionProvider",
      "Key": "RuntimeInformation.OsArchitecture",
      "Value": "X64"
    },
    {
      "ProviderName": "ClrVersionProvider",
      "Key": "RuntimeInformation.ProcessArchitecture",
      "Value": "X64"
    },
    {
      "ProviderName": "ClrVersionProvider",
      "Key": "RuntimeInformation.RuntimeIdentifier",
      "Value": "win10-x64"
    },
    {
      "ProviderName": "ClrVersionProvider",
      "Key": "Environment.DotNetVersion",
      "Value": "5.0.10"
    }
  ],
  "Count": 6
}

become

{
  "Results": [
    {
      "ProviderName": "ClrVersionProvider",
      "Key": "Environment.DotNetVersion",
      "Value": "5.0.10"
    }
  ],
  "Count": 1
}

when you pass a filter option (as you describe)

services.AddVersionInfo()
                .With<ClrVersionProvider>().Exclude(option =>
                {
                    option.Excluded = new string[] { "RuntimeInformation.*" };
                }); 

Initially we could also simplify all and don't consider wildcard patterns.
What do you think?

[rebinqadirdev]

I got your idea very well I think we can omit the Exclude extension method, I didn't fork the repo just I cloned directly I will work on it according to your idea.

[rebinqadirdev]

I have fixed this issue in another way can I send the PR ?

[salem84]

Hi, sure and we take a look!
I have also found this method FileSystemName.MatchesSimpleExpression that could be useful

[rebinqadirdev]

I want to use that method for the next PR It would helps us to simplify the configuration.