avanade / beef Goto Github PK

It looks like if I change the Entities xml file to create an entity of something other than person, the args, code, validators code and test project still are generated with the default person model.

Note: I changed the entity, the operation, and the args, and the ref data.

Am I missing something?

Expected behavirour:

When an error happens, a $lastexitcode should be returned and error message should be written to stdErr. At the moment it returns 0 when it succeeds or errors.

Extra background:

This will allow running code gen in automated builds to check for things like:

• Changes to xml files have been committed without committing generated files.
• Changes to database were made without re-generating stored procedures.

Occurs in version: 3.1.20

How to reproduce:
In Powershell:

PS>dotnet run all --expectNoChanges 
...
  Template: EntityGrpcServiceAgent_cs.xml (Common/Grpc/ServiceAgents)
   [Files: Unchanged = 0, Updated = 0, Created = 0]
An unexpected exception occurred during the 'Run' phase: Unexpected changes detected; one or more files were created and/or updated. Exception: Beef.CodeGen.CodeGenException: Unexpected changes detected; one or more files were created and/or updated.
   at Beef.CodeGen.CodeGenExecutor.OnRunAsync(ExecutorRunArgs args)
   at Beef.Executors.ExecutorBase.RunAsync(ExecutorRunArgs args)
Executor '0e879bbc-8ef7-4841-ac24-f20d0329fe0e' stop as a result of an unhandled exception: Unexpected changes detected; one or more files were created and/or updated. Exception: Beef.CodeGen.CodeGenException: Unexpected changes detected; one or more files were created and/or updated.
   at Beef.CodeGen.CodeGenExecutor.OnRunAsync(ExecutorRunArgs args)
   at Beef.Executors.ExecutorBase.RunAsync(ExecutorRunArgs args)
   at Beef.Executors.ExecutionManager.<>c__DisplayClass17_1.<<Create>b__2>d.MoveNext()
--- End of stack trace from previous location where exception was thrown ---
   at Beef.Executors.Executor.<>c__DisplayClass34_0.<<RunWrapperAsync>b__0>d.MoveNext()

PS> $lastexitcode
0

or

bring database down and run:
dotnet run database

E.g. AddGeneratedDataSvcServices, AddGeneratedManagerServices, AddGeneratedDataServices.

Scenario -
None of the entities defined in codegen XML have managers, or data or dataSvc layers. In our particular case code gen in the project was only used to define entity properties, without any operations.

Extensions are generated with empty bodies, e.g.

public static IServiceCollection AddGeneratedManagerServices(this IServiceCollection services)
{
}

Since the methods are expected to return IServiceCollection, this causes compilation error.

In this instance it should probably just return IServiceCollection that was passed in.

Bit of an unusual scenario but we have a get endpoint that does not have parameters.

This entity xml:

  <Entity Name="Staging" WebApiRoutePrefix="api/v1/staging">
    <Property Name="Id" Type="string" />
    <Property Name="Uri" Type="string" />
    <Property Name="Token" Type="string" />

    <Operation Name="Get" OperationType="Get" AutoImplement="None" />
  </Entity>

Generates fine except for the partial function hooks, they generate with a missing comma.

In StagingManager:

private readonly Func<Staging?Task>? _getOnAfterAsync;

In StagingDataSvc:

private static readonly Func<Staging?Task>? _getOnAfterAsync;

The generated code has to be modified before it can compile.

Steps to reproduce

1. clone the repo
2. execute:

 ~/projects/Beef/samples/Demo/Beef.Demo.Database     master  
   dotnet run all

Expected:
DB updated with schema and ref data

Actual:
Error:
The directory '.\..' does not exist.

Analysis:
Path reference does not work on OSX:
/Beef/tools/Beef.CodeGen.Core/CodeGenConsoleWrapper.cs

string outDir = ".\\.."

Replacing outDir with ./.. solves the issue on OSX.

@chullybun - is there a way to override that param?
passing -o causes this error "Unrecognized option '-o'"

I have also created a pull request for this one, when being called in parallel, for example when a generated ReferenceDataProvider executes:

Parallel.ForEach(types, (type, state) => { var x = this[type]; });

a second thread can get past the initial key check in GetContext while the first thread is still waiting for a connection to open resulting in an attempt to add the key twice.

The pull request just contains a lock around this code.

Where specifying only a single CdcJoin that is not CDC-related; for example Type is Left then the XxxData class has an errant , character output.

<Cdc Name="Xxx" ExcludeColumns="CreateUser, CreateDate, LastUpdateUser, LastUpdateDate">
  <CdcJoin Name="XxxType" Type="Left" IncludeColumns="XxxTypeCode">
    <CdcJoinOn Name="XxxTypeId" />
  </CdcJoin>
</Cdc>

Also, the AddBeefLoggerEventPublisher is adding the service as a singleton, versus scoped. This is causing the CDC background services to fail.

Hi team, I work with Dan and Marko.

I'm looking to make some contrib PRs to this amazing framework. The first PR I was looking to make is for an extension methods lib for the CodeGen config.

What I mean is, I find the config using YAML and XML strange, and I am wishing to provide a Fluent API style config setup as you find with things like EF fluent API, or LINQ etc.

Are you open to this idea? And, before I start, do you think it would work?

I ask this because there must have been a very good reason why you opted to used YAML, XML as means of defining the Entity configuration for GodeGen and DatabaseGen. Can you see any reason why this feature I am proposing to submit as PR would not work?

In addition to the FluentApi feature, I am planning on building a PostGres implementation as well on the DatabaseGen. I realize the majority of users of Beef would typically use SQL Server, but for personal reasons I feel a PostGres plugin/feature would also be a nice addition.

With these kind of features, would you prefer these be submitted, or would you prefer I create a FORK and implement there, and provide a means for you to properly evaluate first?

Final comments... Beef is Amazing! I look forward to making meaningful contributions to this next level framework. To Eric, you are an elite programmer mate. I learnt a lot reading your code and look forward to learning a lot more. Beef is honestly something I have been looking for a long time, and I'm glad I finally found it.

Cheers

Example:

<Entity Name="SiteComponentDeployment" Text="Desired State of Components"  Collection="true" CollectionResult="true" AutoImplement="Database" DatabaseSchema="dbo">
    <Property Name="DeploymentId" Type="Guid" />
    <Property Name="TenantId" Type="Guid" />
    <Property Name="ComponentType" Type="string" />
    <Property Name="ComponentVersion" Type="string" />
    <Property Name="LastKnownState" Type="string" />
    <Property Name="DesiredState" Type="string" />
    
    <Operation Name="Create" OperationType="Create" AutoImplement="None" Validator="SiteComponentDeploymentValidator" EventPublish="false" ExcludeWebApiAgent="true" ExcludeWebApi="true" />
</Entity>

Entity above doesn't have a property that is specified as UniqueKey and Create operation has EventPublish="false".

Generated DataSvc code:

public Task<SiteComponentDeployment> CreateAsync(SiteComponentDeployment value)
{
	return DataSvcInvoker.Current.InvokeAsync(this, async () =>
	{
		var __result = await _data.CreateAsync(Check.NotNull(value, nameof(value))).ConfigureAwait(false);
		await _evtPub.PublishValueAsync(__result, $"System.SiteComponentDeployment.", "Create").ConfigureAwait(false);
		_cache.SetValue(__result.UniqueKey, __result);
		return __result;
	});
}

It shouldn't invoke publisher via _evtPub.PublishValueAsync. Checked against code generated with previous Beef version and publishing wasn't there.

Also, given that no property is set as UniqueKey, should it have _cache.SetValue(__result.UniqueKey, __result);? I can set UniqueKey on a property, as I think it should be there - this is someone else's code that I'm upgrading.

I received this issue when trying to build the solution for the first time.

Fix: I was running both Visual Studio 2017 and Visual Studio 2019 on my dev PC. I got this error using 2017 but when I switched to Visual Studio 2019 the error went away

Code Gen Code

<Operation Name="Delete" OperationType="Delete" UniqueKey="true" AutoImplement="None" WebApiRoute="{id}" WebApiStatus="Accepted" EventSubject="Reservation">
      <Parameter Name="Id" Type="Guid" IsMandatory="true" />
</Operation>

Generates the following datasvc

public Task DeleteAsync(Guid id)
 {
        return DataSvcInvoker.Current.InvokeAsync(this, async () =>
        {
            await _data.DeleteAsync(id).ConfigureAwait(false);
            await _evtPub.PublishAsync($"Reservation", "", id).ConfigureAwait(false);
            _cache.Remove<Reservation>(new UniqueKey(id));
        });
}

The action string is empty, this only happens when the EventSubject property is set. If the EventSubject is not present, it will set the action to the value of WebApiOperationType or OperationType as expected.

The above code gen did work with previous versions of beef.

Beef Version: V4.1.4

We've noticed on a number of occasions that we can seemingly forget to commit changes to codegen files and still have a functioning build.
In what is thought to be a small improvement, we'd like to run the codegen as part of our build pipeline expecting no changes to be generated. In the off chance we have missed something the codegen would say "sorry, expected no changes and there were changes" providing fast feedback to the dev on what they'd missed.
A sample of what this extension to the codegen might look like can be found here: master...evanon:master
Feedback welcome

If an operation parameter type contains escapable xml characters such as in generic types like List<string> then the handlebars template will escape these characters giving the non-compilable List<string> whenever the parameter type config value is surrounded by two braces {{ParameterType}} instead of three {{{ParameterType}}}. This only occurs in the minority of cases and is corrected by: #78

I am trying to validate that a collection of objects does not contain duplicates, i.e., if collection A has objects with properties x,y,z, that for any members in the collection e.g. a,b,c, that no duplicates exist, i.e. a.x==b.x && a.y==b.y && a.z==b.z or the same for any other element comparison. Is there a simple way to do this within the validator? I currently have a validator property like Property(x => x.Items).Collection( item: new CollectionRuleItem<MyElementCollection>(MyElementCollectionValidator.Default), minCount: 0, maxCount: 100); but can't seem to find a "noDuplicates" or similar. Any assistance here would be much appreciated.

It would be helpful if possible to enhance the generation of the WebApiCoreContollers to allow for overloads to be set on the Authorise Attribute. Currently at the controller level the only options available are "Authorize" and "AllowAnonymous".

The only available work around I've found is at an Operation level where you can set the authorised attribute as any string ("Authorize(Policy = "BearerB2C")") for example and it will be substituted in.

If similar functionality was available at the controller level that would be ideal, otherwise if we don't want it that open, allowing custom "Policy" and "AuthenticationSchemes" overloads to be set would be a good alternative.

The code-gen is invalid where the table contains a primary key column that is not considered identity (being self-generating). Also, always outputting RowVersion logic even where the table does not support.

Hi,
Have regenerated our entity code and the following capitalisation of 'false' has appeared in a few places:

        public override bool IsInitial
        {
            get
            {
                return False;
            }
        }

This occurs whenever the entity attribute IsInitialOverride="false" is used.

To support date sensitive testing provide a means to inject a specific datetime to use.

This issue is to collaborate on making changes to Beef to introduce Dependency Injection (DI) as presented by @edjo23 within his POC. This POC also has suggestions around changing Beef to leverage Handlebars.NET which will managed separately to this change.

This is an initial pass of DI to be used for the generated components only at this stage, being the following:

• XxxController - constructor change for IXxxManager.
• XxxManager - constructor changes for IXxxDataSvc.
• XxxDataSvc - constructor changes for IXxxData, will no longer be static, and will introduce new IXxxDataSvc.

As identified by @edjo23 there can only be a single public constructor, so there needs to be a way to configure this, so the following attributes will be added to the Entity XML:

• ControllerConstructor="Public|Private|Protected" - (defaults to Public).
• ManagerConstructor="Public|Private|Protected" - (defaults to Public).
• DataSvcConstructor="Public|Private|Protected" - (defaults to Public).
• DataConstructor="Public|Private|Protected" - (defaults to Public).

During discussions @edjo23 suggested a further option to limit the output of the generated extensions code and have the developers explicitly opt-in where required to reduce unnecessary code bloat. This will be all or nothing for the class, not per operation. The following attributes will be added to the Entity XML for those classes that support extensions:

• ManagerExtensions="true|false" - defaults to false.
• DataSvcsExtensions="true|false" - defaults to false.
• DataExtensions="true|false" - defaults to false.

There will be a new ServiceCollectionExtensions class generated for (within the appropriate solution hierarchy) to invoke the IServiceCollection.AddTransient as follows:

• Api - ./Controllers/ServiceCollectionExtensions.cs - method AddGeneratedControllerServices
• Business - ./Generated/ServiceCollectionExtensions.cs - method AddGeneratedManagerServices
• Business - ./DataSvcs/Generated/ServiceCollectionExtensions.cs - method AddGeneratedDataSvcsServices
• Business - ./Data/Generated/ServiceCollectionExtensions.cs - method AddGeneratedDataServices

Additional changes to be considered:

• The Api changes above need to occur for the gRPC components also.
• The API startup.cs will need to be refactored to support DI (including solution templates).
• The testing and mocking will need to be revisited to work with DI.

Please provide feedback and thoughts. A new branch will be created next week to begin work.

Thanks...

I have hit a issue when generating entities with XML escape codes in a properties annotation value. Any escape codes entered for an annotation don't correctly generate. Previously in beef v3 the escape codes would generate code with the value that the escape code was for. Since upgrading to v4, this no longer seems to work. Is this a configuration issue with the code gen file or new intended behaviour?

As an example if I have this code in the codegen file:
<Property Name="MyObject" Type="int" Annotation1="[XmlElement(&quot;MYOBJECT&quot;)]"/>

It generates:
[XmlElement("MYOBJECT")]

I expected it to actually generate:
[XmlElement("MYOBJECT")]

Beef Version: V4.1.4

... is not consistent in formatting. Any . character in the name must be replaced with a _ to be considered valid in Linux. Also, it is more consistent/logical to split the company and appname using an underscore.

Good afternoon from Hamilton, NZ.

I have the latest source up to and including the fix for issue #99

The problem I have found has an example in the Beef.Demo sample code. In Beef.Demo.xml the Product entity has AutoInferImplements set to true and an "Id" field of type int:

<Entity Name="Product" Text="Product" Collection="true" CollectionResult="true" AutoInferImplements="false" WebApiRoutePrefix="api/v1/products" DataSvcCaching="false" AutoImplement="OData" ODataName="TestOData" ODataEntity="Model.Product" ODataCollectionName="Products">
    <Property Name="Id" Text="{{Product}} identifier" Type="int" Immutable="true" UniqueKey="true" DataName="ID" EmitDefaultValue="true" />

However, in the generated code in Entities\Generated\Product.cs the class definition still expects the implementation of IIntIdentifier:

public partial class Product : EntityBase, IIntIdentifier, IUniqueKey, IEquatable<Product>

Looking in \tools\Beef.CodeGen.Core\Config\Entity\EntityConfig.cs we see:

        private void InferImplements()
        {
            if (ImplementsAutoInfer.HasValue && !ImplementsAutoInfer.Value)
                return;

and then

                var iid = id.Type switch
                {
                    "Guid" => "IGuidIdentifier",
                    "int" => "IIntIdentifier",

I think something is happening in the xml->yaml->json translation. Maybe do do with here:
(ConfigType.Entity, ConfigurationEntity.Entity, "AutoInferImplements", "implementsAutoInfer"),
and/or here:

        [JsonProperty("autoInferImplements", DefaultValueHandling = DefaultValueHandling.Ignore)]
        [PropertySchema("Entity", Title = "Indicates whether to automatically infer the interface implements for the entity from the properties declared.",
            Description = "Will attempt to infer the following: `IGuidIdentifier`, `IIntIdentifier`, `IStringIdentifier`, `IETag` and `IChangeLog`. Defaults to `true`.")]
        public bool? ImplementsAutoInfer { get; set; }

Cheers,
Damian.

Ran into an issue with integration tests, correlation id and event publishing.
When I have a test that uses an agent tester, execution context correlation id gets set as expected and everything works ok.
If i try to run a test that doesn't use agent tester and directly calls manager or data method, execution context correlation id value is null. If that method also publishes an event, it throws an exception "The ExecutionContext.CorrelationId must be set for the ExpectEventPublisher to function conrrectly."
Is this intended behaviour?
I can get around the exception by explicitly setting correlation id value in test, but this is possibly not the right way to do it. Doco says not to set correlation id directly, as its set by the framework.

@ostat raised an issue via a pull request related to the SlidingCachePolicy not functioning correctly after first expiry; is resulting in a get on each usage after said first expiry - i.e. cache does not cache after first expiry. This was observed in ReferenceDataCache and further validated in ReferenceDataMultiTenantCache.

When genning ref data with additional properties, e.g.

<Entity Name="MyRefDataEntity" RefDataType="Guid" Collection="true" WebApiRoutePrefix="api/v1/ref/myRefDataEntity" AutoImplement="Database" DatabaseSchema="Ref" ConstType="string" >
    <Property Name="MyProperty" Type="bool" />
</Entity>

Gen'd method for the entity's GetAllAsync produces the following code for getting the property value

item.MyProperty= dr.GetValue<bool>("MyProperty").ConfigureAwait(false);

After code gen is ran, compile fails due to ConfigureAwait(false).

ConfigureAwait(false) is added there via line 154 in ReferenceDataData_cs.xml.

As the Validators can invoke the likes of Manager components which leverage Dependency Injection (DI) the Validators also need to support. As these components can be long running and have an asynchronous requirement the Validators should also support async.

https://devblogs.microsoft.com/dotnet/embracing-nullable-reference-types/

Beef.Database.Core is throwing an exception that sp_MSforeachtable is not found; this is an undocumented stored procedure in the Master database.

The EventPublisherBase has recently changed to throw No further events can be published (queued) once they have been sent. or Published (queued) events can only be sent once.; however, there are scenarios where this is valid and should be allowed.

Hi. We are in the process of upgrading our Beef packages to version 3 packages. After upgrading we have hit an issue with a change to the generated code for the ReferenceDataProvider.

This maybe a follow on from issue #41.

This generated code for the ReferenceDataProvider, that uses Parallel.ForEach:

        public override Task PrefetchAsync(params string[] names)
        {
            var types = new List<Type>();
            if (names == null)
            {
                types.AddRange(GetAllTypes());
            }
            else
            {
                foreach (string name in names.Distinct())
                {
                    switch (name)
                    {
                        case var n when string.Compare(n, nameof(RefDataNamespace.RefDataA), StringComparison.InvariantCultureIgnoreCase) == 0: types.Add(typeof(RefDataNamespace.RefDataA)); break;
                        // Removed 10 case statements for beverity
                    }
                }
            }

            Parallel.ForEach(types, (type, state) => { var x = this[type]; });
            return Task.CompletedTask;
        }

In this test:

        [Test]
        [AgentTester(TestUser.Admin)]
        public void GetNamed_All()
        {
            var names = ReferenceData.Current.GetAllTypes().Select(x => x.Name).ToArray();

            var r = AgentTester.Create<ReferenceDataAgent>()
                .ExpectStatusCode(HttpStatusCode.OK)
                .Run((a) => a.Agent.GetNamedAsync(names));

            Assert.NotNull(r.Content);
            Assert.AreEqual(JObject.Parse("{ \"content\":" + r.Content + "}")["content"].Children().Count(), names.Length);
        }

Throws this exception:

An unexpected internal server error has occurred. Exception: System.AggregateException: One or more errors occurred. (Invalid operation. The connection is closed.) (Invalid operation. The connection is closed.)
 ---> System.InvalidOperationException: Invalid operation. The connection is closed.
   at Microsoft.Data.SqlClient.SqlCommand.<>c.<ExecuteDbDataReaderAsync>b__164_0(Task`1 result)
   at System.Threading.Tasks.ContinuationResultTaskFromResultTask`2.InnerInvoke()
   at System.Threading.Tasks.Task.<>c.<.cctor>b__274_0(Object obj)
   at System.Threading.ExecutionContext.RunInternal(ExecutionContext executionContext, ContextCallback callback, Object state)
--- End of stack trace from previous location where exception was thrown ---
   at System.Threading.ExecutionContext.RunInternal(ExecutionContext executionContext, ContextCallback callback, Object state)
   at System.Threading.Tasks.Task.ExecuteWithThreadLocal(Task& currentTaskSlot, Thread threadPoolThread)
--- End of stack trace from previous location where exception was thrown ---
   at Beef.Data.Database.DatabaseCommand.<>c__DisplayClass34_0.<<DbDataReaderWrapperNoResultAsync>b__0>d.MoveNext()
--- End of stack trace from previous location where exception was thrown ---
   at Beef.Data.Database.DatabaseInvoker.WrapInvokeAsync(Object caller, Func`1 func, DatabaseBase param, String memberName, String filePath, Int32 lineNumber)
   at Polly.AsyncPolicy.<>c__DisplayClass40_0.<<ImplementationAsync>b__0>d.MoveNext()

If we modify the generated code to iterate the types in sequence then this works as expected and our test passes.

Entity definition has DataSvcCaching="false"

<Entity Name="User" Text="User" WebApiRoutePrefix="api/v1" Collection="true" CollectionResult="true" AutoImplement="Database" DatabaseSchema="dbo" DataSvcCaching="false">

Operation example:

<Operation Name="Get" WebApiAuthorize="AllowAnonymous" Text="Gets the specified {{User}} record" OperationType="Get" UniqueKey="true" AutoImplement="Database" WebApiRoute="user/{id}"/>

Generated code still uses _cache, e.g.

public Task<User?> GetAsync(Guid id)
        {
            return DataSvcInvoker.Current.InvokeAsync(this, async () =>
            {
                var __key = new UniqueKey(id);
                if (_cache.TryGetValue(__key, out User? __val))
                    return __val;

                var __result = await _data.GetAsync(id).ConfigureAwait(false);
                _cache.SetValue(__key, __result);
                return __result;
            });
        }

but since there is no

using Beef.Caching;

and

private readonly IRequestCache _cache;

in generated code, it causes compilation error.

https://github.com/Avanade/Beef/blob/master/src/Beef.Data.Database/DatabaseRecord.cs

A call to GetValue such as:

myDataRecord.GetValue<MyEnum?>("MyFieldName");

Gives the error:

System.InvalidCastException : Invalid cast from 'System.Byte' to 'MyEnum'.

It seems that typeof(T).IsEnum returns false if T is a Nullable Enum. However, in GetValue the variable nt is set to the underlying type and nt.IsEnum returns true

We've got a domain named XYZ.System.
Data classes have SuppressMessage attribute is fully qualified, System.Diagnostics.CodeAnalysis.SuppressMessage.
This causes compiler error "The type or namespace name 'Diagnostics' does not exist in the namespace 'XYZ.System'".
Changing it global::System.Diagnostics.CodeAnalysis.SuppressMessage would resolve this issue.

Database access is using synchronous operations versus the preferred asynchronous operations; this should result in a performance and scalability improvement.

Previously when the Codegen WebApiAuthorize attribute was not provided, it didn't set the authorised on the controller class. This allowed us to override individual methods to specify different policies at the method level. Now it appears that if no value is provided the "AllowAnonymous" attribute is appended to the class which bypasses any policy authorisation at the method level. This opens up all the methods within the class to unauthorised access.

It is generally accepted that an API should update the HTTP Location header on the response when returning an HTTP status code of 201 (this is the default when performing a create) or 202. Beef will be extended to enable support.

For an Operation (within the code generation configuration) a new WebApiLocation property is added. This will allow the specification of the Relative URI. The uses similar formatting to the WebApiRoute. The response value is accessed using r. notation to access underlying properties; for example {r.Id} or person/{r.Id}. The Entity.WebApiRoutePrefix will be prepended automatically; however, to disable set the first character to !, e.g. !person/{r.Id}. The URI can be inferred from another Operation by using a lookup ^; for example ^Get indicates to infer from the named Get operation (where only ^ is specified this is shorthand for ^Get as this is the most common value). The Location URI will ensure the first character is a / so it acts a relative URL absolute path.

For the CodeGeneration and Entity configuration a new WebApiAutoLocation property is added. This indicates whether the HTTP Response Location Header route (Operation.WebApiLocation) is automatically inferred. This will automatically set the Operation.WebApiLocation for an Operation named Create where there is a corresponding named Get.

The code that will be generated will look similar to the following:

[HttpPost("")]
[ProducesResponseType(typeof(Person), (int)HttpStatusCode.Created)]
public IActionResult Create([FromBody] Person value)
{
    return new WebApiPost<Person>(this, () => _manager.CreateAsync(WebApiActionBase.Value(value)),
        operationType: OperationType.Create, statusCode: HttpStatusCode.Created, alternateStatusCode: null, locationUri: (r) => new Uri($"/api/v1/persons/{r.Id}", UriKind.Relative));
}

The HTTP response will then include the relative Location header similar to: /api/v1/persons/8e5d038d-fa88-eb11-a1bf-4074e091b64d.

The optional Action<HttpContext, ExecutionContext> passed to the WebApiExecutionContextMiddleware should be changed to Func<HttpContext, ExecutionContext, Task> to enable asynchronous invocation.

Hi, we would like to enforce all of our date times to be UTC regardless of local time zone. I see we can do this by setting the DateTimeTransform on all dates but was wondering if there was a easy way to make DateTimeUtc the default.

If not can I request this as a feature enhancement, thanks.

what do you think about it? any plans? hints, tips?

When trying to code gen an entity without any properties (only has operations), GetHashCode() is not generated fully and causes compile error. Missing a return and closing }. It comes out as:

public override int GetHashCode()
        {
            var hash = new HashCode();
        #region ICopyFrom

If a property is added to the entity and re-gen'd, the method is generated correctly, e.g.

public override int GetHashCode()
        {
            var hash = new HashCode();
            hash.Add(TestProp);
            return base.GetHashCode() ^ hash.ToHashCode();
        }

Looks like beef is expecting tables to have "CreatedDate" whereas a common column name for audit is "CreatedAt".

Here's the schema:

CREATE TABLE [dbo].[Contact]
(
        ID INT IDENTITY NOT NULL,
        FIRSTNAME NVARCHAR(255) NOT NULL,
        LASTNAME NVARCHAR(255) NOT NULL,
        DOB DATE NULL,
        GENDER CHAR(1) NULL,
        EYECOLOR NVARCHAR(150) NULL,
        EMAIL NVARCHAR(255) NULL,
        PHONENUMBER NVARCHAR(15) NULL,
        [CreatedAt] [date] NOT NULL DEFAULT GETUTCDATE(),
        [UpdatedAt] [date] NULL,
        [CreatedBy] [nvarchar](100) NULL,
        [UpdatedBy] [nvarchar](100) NULL
) ON [PRIMARY]
GO
ALTER TABLE [dbo].[Contact] ADD  CONSTRAINT [Contact_PK] PRIMARY KEY CLUSTERED 
(
	[ID] ASC
)WITH (STATISTICS_NORECOMPUTE = OFF, IGNORE_DUP_KEY = OFF, ONLINE = OFF) ON [PRIMARY]

and here's the stored procedure that was generated:

CREATE PROCEDURE [dbo].[spContactCreate]
   @ID AS INT = NULL OUTPUT
  ,@FIRSTNAME AS NVARCHAR(255)
  ,@LASTNAME AS NVARCHAR(255)
  ,@DOB AS DATE NULL = NULL
  ,@GENDER AS CHAR(1) NULL = NULL
  ,@EYECOLOR AS NVARCHAR(150) NULL = NULL
  ,@EMAIL AS NVARCHAR(255) NULL = NULL
  ,@PHONENUMBER AS NVARCHAR(15) NULL = NULL
  ,@CreatedAt AS DATE
  ,@UpdatedAt AS DATE NULL = NULL
  ,@CreatedBy AS NVARCHAR(100) NULL = NULL
  ,@ReselectRecord AS BIT = 0
AS
BEGIN
  /*
   * This file is automatically generated; any changes will be lost. 
   */
 
  SET NOCOUNT ON;
  
  BEGIN TRY
    -- Wrap in a transaction.
    BEGIN TRANSACTION

    -- Set audit details.
    EXEC @CreatedDate = fnGetTimestamp @CreatedDate
    EXEC @CreatedBy = fnGetUsername @CreatedBy

    DECLARE @InsertedIdentity TABLE([ID] INT)

    -- Create the record.
    INSERT INTO [dbo].[Contact] (
        [FIRSTNAME]
       ,[LASTNAME]
       ,[DOB]
       ,[GENDER]
       ,[EYECOLOR]
       ,[EMAIL]
       ,[PHONENUMBER]
       ,[CreatedAt]
       ,[UpdatedAt]
       ,[CreatedBy]
    )
    OUTPUT inserted.ID INTO @InsertedIdentity
    VALUES (
        @FIRSTNAME
       ,@LASTNAME
       ,@DOB
       ,@GENDER
       ,@EYECOLOR
       ,@EMAIL
       ,@PHONENUMBER
       ,@CreatedAt
       ,@UpdatedAt
       ,@CreatedBy
    )

    -- Get the inserted identity.
    SELECT @ID = [ID] FROM @InsertedIdentity

    -- Commit the transaction.
    COMMIT TRANSACTION
  END TRY
  BEGIN CATCH
    -- Rollback transaction and rethrow error.
    IF @@TRANCOUNT > 0
      ROLLBACK TRANSACTION;

    THROW;
  END CATCH
  
  -- Reselect record.
  IF @ReselectRecord = 1
  BEGIN
    EXEC [dbo].[spContactGet] @ID
  END
END

Error reported by MSSQL:

Execution failed with: Must declare the scalar variable "@CreatedDate".

Hi,
I'm trying to use a Beef Validation element for checking minimum and maximum counts in Collections. See https://github.com/Avanade/Beef/blob/master/docs/Beef-Validation.md but i don't seem to have access to the properties it mentions here. (see under Rules--> CollectionRule --> MinCount, MaxCount)
I would expect the syntax to chain like this Property(x => x.Items).Collection(item: new CollectionRuleItem<MyItemField>(MyItemFieldValidator.Default)).MaxCount(100); but the MaxCount property isn't being recognised. Am I using the syntax correctly? Are there any sample code available where one is trying to restrict the size of a collection to at least some MinCount value and no more than MaxCount items in the collection ?

There is a bug in https://github.com/Avanade/Beef/blob/master/tools/Beef.Database.Core/Schema/dbo/Functions/fnGetUsername.sql

It uses convert function incorrectly to read username from session context.

SET @Username = CONVERT(nvarchar, SESSION_CONTEXT(N'Username'));

Username is defined a varchar of length 50 in function:
DECLARE @Username nvarchar(50)

But above usage of Convert shall only use 30 characters by default. It needs to be changed to:
SET @Username = CONVERT(nvarchar(50), SESSION_CONTEXT(N'Username'));

It is documented in Microsoft docs here

What is wrong?

When an entity does not implement IEtag, given 2 different calls that produce the same collection, CreateJsonResultAndETag( ) function from Beef.AspNetCore.WebApi.WebApiActionBase class returns different ETag values when API is called with ExcludeFields and returns the same ETag when API is called without ExcludeFields.

What is expected?

EDIT:
Expected to return the same ETag for the collection when entity does not implement IETag and returns a calculated ETag when entity implements IETag.

or

WebApiGet<TResult, TColl, TEntity> should not call CreateJsonResultAndETag( ) and should not set ETag header when items from a Collection do not implement IETag.

How to reproduce:

codegen xml:

<Entity Name="Contact" Collection="true" CollectionResult="true" WebApiRoutePrefix="api/v1/contacts" 
          AutoImplement="Database" Implements="Changelog">
    <Property Name="Id" Type="Guid" UniqueKey="true"/>
    <Property Name="Name" Type="string" DataName="ContactTypeCode" />
 <Operation Name="GetByArgs" OperationType="GetColl" PagingArgs="true">
      <Parameter Name="search" Type="string"/>
    </Operation>
</Entity>

unit test:

Assume the database has 2 contacts: "Mary Flower" and "Mary Smith".

[Test]
        public void A152_GetByArgs_CheckETagWithoutAddingPatient_WithExcludeFields()  
        {

            var contactArgs = "Mary" ;
            var pagingArgs = new Beef.Entities.PagingArgs { IsGetCount = true };
            var webReqOptions = new Beef.WebApi.WebApiRequestOptions().Exclude("changeLog");

            var originalEtag = AgentTester.Create<ContactAgent, ContactCollectionResult>()
                .ExpectStatusCode(HttpStatusCode.OK)
                .Run((a) => a.Agent.GetByArgsAsync(contactArgs, pagingArgs, webReqOptions)).Response.Headers.ETag;

 /****

Update contact name to "Mary Anne"

(details hidden for brevity)
******/


            var newEtag = AgentTester.Create<ContactAgent, ContactCollectionResult>()
                .ExpectStatusCode(HttpStatusCode.OK)
                .Run((a) => a.Agent.GetByArgsAsync(contactArgs, pagingArgs, webReqOptions)).Response.Headers.ETag;

//This test passes
            Assert.AreNotEqual(originalEtag, newEtag, "ETag should not be the same after an update.");
        }

        [Test]
        public void A153_GetByArgs_CheckETagWithoutAddingPatient_WithAllFields()
        {
            var contactArgs = "Mary" ;
            var pagingArgs = new Beef.Entities.PagingArgs { IsGetCount = true };
 
            var originalEtag = AgentTester.Create<ContactAgent, ContactCollectionResult>()
                .ExpectStatusCode(HttpStatusCode.OK)
                .Run((a) => a.Agent.GetByArgsAsync(contactArgs, pagingArgs)).Response.Headers.ETag;
 /****

Update contact name to "Mary Anne"

(details hidden for brevity)
******/
            var newEtag = AgentTester.Create<ContactAgent, ContactCollectionResult>()
                .ExpectStatusCode(HttpStatusCode.OK)
                .Run((a) => a.Agent.GetByArgsAsync(contactArgs, pagingArgs)).Response.Headers.ETag;

//This test fails
            Assert.AreNotEqual(originalEtag, newEtag, "ETag should not be the same after an update.");
        }

There is an issue with a Patch operation where a call in the business manager Update method is being made to the Get method to get the current state. This is being done so that the current state can be compared to the requested update state for some validation. What we are finding is that the object being returned by the Get method is the same object as passed to the Update method.

Hi, the last update has introduced an issue in the generated Data Service class. The following generated code throws a null reference exception when the result from the data operation is null.

        public static Task<Tenant> GetByHostNameAsync(string? hostName)
        {
            return DataSvcInvoker.Default.InvokeAsync(typeof(TenantDataSvc), async () => 
            {
                var __result = await Factory.Create<ITenantData>().GetByHostNameAsync(hostName).ConfigureAwait(false);
                ExecutionContext.Current.CacheSet(__result.UniqueKey, __result);
                if (_getByHostNameOnAfterAsync != null) await _getByHostNameOnAfterAsync(__result, hostName).ConfigureAwait(false);
                return __result;
            });
        }

This is generated using:

  <Entity Name="Tenant" Text="Tenant configuration" Implements="IETag, IChangeLog, ITenant" Collection="true" WebApiRoutePrefix="api/v1/tenants" CollectionResult="true" 
          AutoImplement="Database" DatabaseSchema="dbo">
    ...
    <Operation Name="GetByHostName" OperationType="Custom" ReturnType="Tenant" WebApiRoute="hostName/{hostName}" WebApiMethod="HttpGet">
      <Parameter Name="HostName" Type="string" />
    </Operation>
  </Entity>

I think this is due to the change to line 481 - https://github.com/Avanade/Beef/blame/master/tools/Beef.CodeGen.Core/Templates/EntityDataSvc_cs.xml#L481

ExecutionContext.Current.CacheSet<{{Operation.ReturnType}}>(__result?.UniqueKey ?? UniqueKey.Empty, __result);

has been changed to:

ExecutionContext.Current.CacheSet(__result.UniqueKey, __result);

When generating an entity with a reference data collection the property set contains value?.ToSidList() ?? null; the ?? null is redundant and can be removed.

.NET 2.x are not longer supported, Beef must be upgraded to .NET 3.1.

In prior version to handlebars the WebApiAuthorize codegen attribute would use the specified value even though defined as a boolean which allowed values such as Authorize(Policy = "XXX"). This behaviour was lost; but turns out is required.

When DataSvcCustom="true" is set on an operation,

private static readonly Func<Entity, Task> _createOnAfterAsync; 

is removed from generated DataSvc class, but is still used in the generated method, e.g.

public static Task CreateAsync(Entity value)
{
	return DataSvcInvoker.Default.InvokeAsync(typeof(EntityDataSvc), async () => 
	{
		await CreateOnImplementationAsync(value);
		if (_createOnAfterAsync != null) await _createOnAfterAsync(value);
	});
}

This results in _createOnAfterAsync having to be declared in custom partial DataSvc class.

_createOnAfterAsync declaration should either stay in code gen'd DataSvc file, or remove

if (_createOnAfterAsync != null) await _createOnAfterAsync(value);

from code gen'd method and let it be added in custom DataSvc method implementation if needed.

Operation definition for the above scenario:

<Operation Name="Create" OperationType="Custom" AutoImplement="None" WebApiMethod="HttpPost" ValueType="Reservation" WebApiStatus="Accepted" DataSvcCustom="true">