Changeset 9645 for branches/OaaS/HeuristicLab.Services.Optimization.Billing

Timestamp:

06/19/13 15:25:31 (11 years ago)

Author:

spimming

Message:

#1888:

• Model classes implement new interface to track current state of entity
• Mark EntityState property as 'not mapped'
• Set hook to initialize entity as unchanged
• Extension method for DbContext to apply changes only on modified entity

Location:

branches/OaaS/HeuristicLab.Services.Optimization.Billing

Files:

• BillingEngine/BillingEngine.cs (modified) (4 diffs)
• Business/BillingService.cs (modified) (4 diffs)
• Business/MockupBillingService.cs (modified) (1 diff)
• DataAccess/BillingContext.cs (modified) (11 diffs)
• DataAccess/BillingDao.cs (modified) (10 diffs)
• HeuristicLab.Services.Optimization.Billing.csproj (modified) (1 diff)
• Interfaces/IObjectWithState.cs (added)
• Interfaces/IOptimizationBilling.cs (modified) (1 diff)
• Model/Model.cs (modified) (14 diffs)
• Utils (added)
• Utils/DbContextUtil.cs (added)
• Utils/StateUtil.cs (added)

branches/OaaS/HeuristicLab.Services.Optimization.Billing/BillingEngine/BillingEngine.cs

@@ -89 +89 @@
               usageCharges.Invoice = invoice;
               usageCharges.Product = billingService.GetProductByName("Oaas Usage Charges").First();
-              usageCharges.ProductPrice = -999.99;
+              usageCharges.ProductPrice = 999.99;
               usageCharges.Quantity = 1;
               invoice.InvoiceLines.Add(usageCharges);
@@ -102 +102 @@
               UpdateBillingState(order);
               billingService.UpdateOrder(order);
+              billingService.SaveInvoice(invoice);
             }
           }
@@ -120 +121 @@
       }
 
+      order.LastBillableDay = currentDate;
       DateTime nextBillingDay = CalculateNextBillingDate(order);
 
@@ -130 +132 @@
         order.NextBillableDay = nextBillingDay;
       }
+
+      order.EntityState = State.Modified;
     }
 

branches/OaaS/HeuristicLab.Services.Optimization.Billing/Business/BillingService.cs

@@ -42 +42 @@
       //TODO: Authentication
       //TODO: Enable Transaction
-      BillingDao.AddOrder(order);
+      BillingDao.InsertOrUpdateOrder(order);
     }
 
@@ -59 +59 @@
 
     public void UpdateOrder(Order order) {
-      throw new System.NotImplementedException();
+      //TODO: Authentication
+      //TODO: Enable Transaction
+      BillingDao.InsertOrUpdateOrder(order);
     }
 
@@ -75 +77 @@
       //TODO: Authentication
       //TODO: Enable Transaction
-      BillingDao.AddUser(user);
+      BillingDao.InsertOrUpdateUser(user);
     }
 
@@ -104 +106 @@
     }
 
+    public void SaveInvoice(Invoice invoice) {
+      //TODO: Authentication
+      //TODO: Enable Transaction
+      BillingDao.InsertOrUpdateInvoice(invoice);
+    }
+
     #endregion
   }

branches/OaaS/HeuristicLab.Services.Optimization.Billing/Business/MockupBillingService.cs

@@ -134 +134 @@
     }
 
+    public void SaveInvoice(Model.Invoice invoice) {
+      throw new NotImplementedException();
+    }
+
     #endregion
   }

branches/OaaS/HeuristicLab.Services.Optimization.Billing/DataAccess/BillingContext.cs

@@ -2 +2 @@
 using System.Collections.Generic;
 using System.Data.Entity;
+using System.Data.Entity.Infrastructure;
 using System.Data.Entity.ModelConfiguration;
 using System.Data.Entity.ModelConfiguration.Conventions;
+using HeuristicLab.Services.Optimization.Billing.Interfaces;
 using HeuristicLab.Services.Optimization.Billing.Model;
 
@@ -28 +30 @@
     public BillingContext(string connectionString)
       : base(connectionString) {
+
+      Database.SetInitializer(new HeuristicLab.Services.Optimization.Billing.DataAccess.BillingContext.BillingContextInitiliazer());
+
+      // Hook up event to mark existing entities as Unchanged
+      ((IObjectContextAdapter)this).ObjectContext.ObjectMaterialized += (sender, args) => {
+        var entity = args.Entity as IObjectWithState;
+        if (entity != null) {
+          entity.EntityState = State.Unchanged;
+        }
+      };
+
       this.Configuration.LazyLoadingEnabled = false;
       this.Configuration.ProxyCreationEnabled = false;
@@ -33 +46 @@
 
     protected override void OnModelCreating(DbModelBuilder modelBuilder) {
+      modelBuilder.Configurations.Add(new ContactInformationConfiguration());
+      modelBuilder.Configurations.Add(new PaymentInformationConfiguration());
+      modelBuilder.Configurations.Add(new ProductConfiguration());
       modelBuilder.Configurations.Add(new OrderConfiguration());
       modelBuilder.Configurations.Add(new OrderLineConfiguration());
@@ -47 +63 @@
     #region EntityTypeConfigurations
 
+    private class ContactInformationConfiguration : EntityTypeConfiguration<ContactInformation> {
+      internal ContactInformationConfiguration() {
+        this.Ignore(ci => ci.EntityState);
+      }
+    }
+
+    private class PaymentInformationConfiguration : EntityTypeConfiguration<PaymentInformation> {
+      internal PaymentInformationConfiguration() {
+        this.Ignore(pi => pi.EntityState);
+      }
+    }
+
+    private class ProductConfiguration : EntityTypeConfiguration<Product> {
+      internal ProductConfiguration() {
+        this.Ignore(p => p.EntityState);
+      }
+    }
+
     private class OrderConfiguration : EntityTypeConfiguration<Order> {
       internal OrderConfiguration() {
+        this.Ignore(o => o.EntityState);
         this.HasRequired(o => o.User).WithMany().HasForeignKey(o => o.UserId);
         // TODO: OrderState?
@@ -56 +91 @@
     private class OrderLineConfiguration : EntityTypeConfiguration<OrderLine> {
       internal OrderLineConfiguration() {
+        this.Ignore(ol => ol.EntityState);
         this.HasRequired(ol => ol.Order).WithMany(o => o.OrderLines).HasForeignKey(ol => ol.OrderId).WillCascadeOnDelete(true);
         this.HasRequired(ol => ol.Product).WithMany().HasForeignKey(ol => ol.ProductId);
@@ -63 +99 @@
     private class InvoiceConfiguration : EntityTypeConfiguration<Invoice> {
       internal InvoiceConfiguration() {
+        this.Ignore(i => i.EntityState);
         this.HasRequired(i => i.User).WithMany().HasForeignKey(i => i.UserId);
         this.HasRequired(i => i.Order).WithMany(o => o.Invoices).HasForeignKey(i => i.OrderId);
@@ -70 +107 @@
     private class InvoiceLineConfiguration : EntityTypeConfiguration<InvoiceLine> {
       internal InvoiceLineConfiguration() {
+        this.Ignore(i => i.EntityState);
         this.HasRequired(il => il.Invoice).WithMany(i => i.InvoiceLines).HasForeignKey(il => il.InvoiceId).WillCascadeOnDelete(true);
         this.HasRequired(il => il.Product).WithMany().HasForeignKey(il => il.ProductId);
@@ -77 +115 @@
     private class UsageRecordConfiguration : EntityTypeConfiguration<UsageRecord> {
       internal UsageRecordConfiguration() {
+        this.Ignore(ur => ur.EntityState);
         this.HasRequired(ur => ur.User).WithMany().HasForeignKey(ur => ur.UserId);
         this.HasRequired(ur => ur.Product).WithMany().HasForeignKey(ur => ur.ProductId);
@@ -84 +123 @@
     private class UserConfiguration : EntityTypeConfiguration<User> {
       internal UserConfiguration() {
+        this.Ignore(u => u.EntityState);
         this.HasMany(u => u.PaymentInformation).WithRequired(pi => pi.User).HasForeignKey(pi => pi.UserId);
         this.HasRequired(u => u.ContactInformation).WithMany().HasForeignKey(u => u.ContactInformationId);
@@ -166 +206 @@
           BillingPeriod = BillingPeriod.Monthly,
         };
+
         OrderLine ol1 = new OrderLine() {
           Order = o1,
@@ -172 +213 @@
           Quantity = 1
         };
+
         o1 = context.Orders.Add(o1);
         ol1 = context.OrderLines.Add(ol1);

branches/OaaS/HeuristicLab.Services.Optimization.Billing/DataAccess/BillingDao.cs

@@ -2 +2 @@
 using System;
 using System.Collections.Generic;
+using System.Data;
 using System.Data.Entity;
 using System.Linq;
 using System.Linq.Expressions;
 using HeuristicLab.Services.Optimization.Billing.Model;
+using HeuristicLab.Services.Optimization.Billing.Utils;
 namespace HeuristicLab.Services.Optimization.Billing.DataAccess {
   public class BillingDao {
@@ -16 +18 @@
     }
 
-    private delegate T ExecuteWithContextDelegate<T>(BillingContext context);
-    private delegate void ExecuteWithContextDelegate(BillingContext context);
-
-    private void ExecuteWithContext(ExecuteWithContextDelegate call) {
-      BillingContext context = null;
-      try {
-        using (context = CreateContext()) {
-          call(context);
-        }
-      }
-      finally {
-        if (context.Database.Connection.State == System.Data.ConnectionState.Open) {
-          context.Database.Connection.Close();
-        }
-      }
-    }
-
-    private T ExecuteWithContext<T>(ExecuteWithContextDelegate<T> call) {
-      BillingContext context = null;
-      try {
-        using (context = CreateContext()) {
-          T result = call(context);
-          return result;
-        }
-      }
-      finally {
-        if (context.Database.Connection.State == System.Data.ConnectionState.Open) {
-          context.Database.Connection.Close();
-        }
-      }
-    }
-
     #endregion
 
@@ -53 +23 @@
 
     public Product FindProductById(long id) {
-      return ExecuteWithContext<Product>((context) => {
+      using (var context = CreateContext()) {
         return context.Products.FirstOrDefault(prod => prod.ProductId == id);
-      });
+      }
     }
 
@@ -72 +42 @@
     }
 
-    public void AddProduct(Product entity) {
-      ExecuteWithContext((context) => {
-        context.Products.Add(entity);
+    public void InsertOrUpdateProduct(Product entity) {
+      using (var context = CreateContext()) {
+        throw new NotImplementedException();
+      }
+    }
+
+    void DeleteProduct(Product entity) {
+      using (var context = CreateContext()) {
+        throw new NotImplementedException();
+      }
+    }
+
+    #endregion
+
+    #region Order Methods
+
+    public void InsertOrUpdateOrder(Order entity) {
+      using (var context = CreateContext()) {
+        context.Orders.Add(entity);
+        context.ApplyStateChanges();
         context.SaveChanges();
-      });
-    }
-
-    public void UpdateProduct(Product entity) {
-      ExecuteWithContext((context) => {
-        context.Products.Attach(entity);
-        context.Entry(entity).State = System.Data.EntityState.Modified;
-        context.SaveChanges();
-      });
-    }
-
-    void DeleteProduct(Product entity) {
-      ExecuteWithContext((context) => {
-        context.Products.Remove(entity);
-      });
-    }
-
-    #endregion
-
-    #region Order Methods
-
-    public void AddOrder(Order order) {
-      ExecuteWithContext((context) => {
-        context.Orders.Add(order);
-        context.SaveChanges();
-      });
+      }
     }
 
@@ -122 +84 @@
 
     public OrderLine FindOrderLineById(long id) {
-      return ExecuteWithContext<OrderLine>((context) => {
+      using (var context = CreateContext()) {
         return context.OrderLines.FirstOrDefault(ol => ol.OrderLineId == id);
-      });
+      }
     }
 
@@ -141 +103 @@
     }
 
-    public void AddOrderLine(OrderLine entity) {
-      ExecuteWithContext((context) => {
-        context.OrderLines.Add(entity);
-        context.SaveChanges();
-      });
-    }
-
-    public void UpdateOrderLine(OrderLine entity) {
-      ExecuteWithContext((context) => {
-        context.OrderLines.Attach(entity);
-        context.Entry(entity).State = System.Data.EntityState.Modified;
-        context.SaveChanges();
-      });
+    public void InsertOrUpdateOrderLine(OrderLine entity) {
+      using (var context = CreateContext()) {
+        throw new NotImplementedException();
+      }
     }
 
     void DeleteOrderLine(OrderLine entity) {
-      ExecuteWithContext((context) => {
-        context.OrderLines.Remove(entity);
-      });
+      using (var context = CreateContext()) {
+        throw new NotImplementedException();
+      }
     }
 
@@ -167 +120 @@
 
     public User FindUserById(long id) {
-      return ExecuteWithContext<User>((context) => {
+      using (var context = CreateContext()) {
         return context.Users.FirstOrDefault(user => user.UserId == id);
-      });
+      }
     }
 
@@ -186 +139 @@
     }
 
-    public void AddUser(User entity) {
-      ExecuteWithContext((context) => {
-        context.Users.Add(entity);
-        context.SaveChanges();
-      });
-    }
-
-    public void UpdateUser(User entity) {
-      ExecuteWithContext((context) => {
-        context.Users.Attach(entity);
-        context.Entry(entity).State = System.Data.EntityState.Modified;
-        context.SaveChanges();
-      });
+    public void InsertOrUpdateUser(User entity) {
+      using (var context = CreateContext()) {
+        throw new NotImplementedException();
+      }
     }
 
     void DeleteUser(User entity) {
-      ExecuteWithContext((context) => {
-        context.Users.Remove(entity);
-      });
+      using (var context = CreateContext()) {
+        throw new NotImplementedException();
+      }
     }
 
@@ -212 +156 @@
 
     public UsageRecord FindUsageRecordById(long id) {
-      return ExecuteWithContext<UsageRecord>((context) => {
+      using (var context = CreateContext()) {
         return context.UsageRecords.FirstOrDefault(prod => prod.ProductId == id);
-      });
+      }
     }
 
@@ -231 +175 @@
     }
 
-    public void AddUsageRecord(UsageRecord entity) {
-      ExecuteWithContext((context) => {
-        context.UsageRecords.Add(entity);
+    public void InsertOrUpdateUsageRecord(UsageRecord entity) {
+      using (var context = CreateContext()) {
+        throw new NotImplementedException();
+      }
+    }
+
+    void DeleteUsageRecord(UsageRecord entity) {
+      using (var context = CreateContext()) {
+        throw new NotImplementedException();
+      }
+    }
+
+    #endregion
+
+    #region Invoice Methods
+
+    public void InsertOrUpdateInvoice(Invoice entity) {
+      using (var context = CreateContext()) {
+        context.Invoices.Add(entity);
+        context.ApplyStateChanges();
         context.SaveChanges();
-      });
-    }
-
-    public void UpdateUsageRecord(UsageRecord entity) {
-      ExecuteWithContext((context) => {
-        context.UsageRecords.Attach(entity);
-        context.Entry(entity).State = System.Data.EntityState.Modified;
-        context.SaveChanges();
-      });
-    }
-
-    void DeleteUsageRecord(UsageRecord entity) {
-      ExecuteWithContext((context) => {
-        context.UsageRecords.Remove(entity);
-      });
-    }
-
-    #endregion
-
-    #region Invoice Methods
-
-    public void AddInvoice(Invoice entity) {
-      ExecuteWithContext((context) => {
-        context.Invoices.Add(entity);
-        context.SaveChanges();
-      });
+      }
     }
 

branches/OaaS/HeuristicLab.Services.Optimization.Billing/HeuristicLab.Services.Optimization.Billing.csproj

@@ -59 +59 @@
     <Compile Include="Interfaces\IGenericDao.cs" />
     <Compile Include="Interfaces\IInvoiceFormattingEngine.cs" />
+    <Compile Include="Interfaces\IObjectWithState.cs" />
     <Compile Include="Interfaces\IOptimizationBilling.cs" />
     <Compile Include="Business\MockupBillingService.cs" />
     <Compile Include="Model\Model.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />
+    <Compile Include="Utils\DbContextUtil.cs" />
+    <Compile Include="Utils\StateUtil.cs" />
   </ItemGroup>
   <ItemGroup>

branches/OaaS/HeuristicLab.Services.Optimization.Billing/Interfaces/IOptimizationBilling.cs

@@ -23 +23 @@
 
     IList<Invoice> GetInvoices(string userName);
+    void SaveInvoice(Invoice invoice);
 
     User GetUser(string userName);

branches/OaaS/HeuristicLab.Services.Optimization.Billing/Model/Model.cs

@@ -2 +2 @@
 using System;
 using System.Collections.Generic;
+using HeuristicLab.Services.Optimization.Billing.Interfaces;
 namespace HeuristicLab.Services.Optimization.Billing.Model {
 
@@ -14 +15 @@
    */
 
-  public class ContactInformation {
+  public class ContactInformation : IObjectWithState {
     public long ContactInformationId { get; set; }
     public string OrganizationName { get; set; }
@@ -24 +25 @@
     public string FirstName { get; set; }
     public string Email { get; set; }
+
+    // Property is not mapped
+    // It is used to track state (disconnected entities)
+    public State EntityState { get; set; }
   }
 
-  public class PaymentInformation {
+  public class PaymentInformation : IObjectWithState {
     public long PaymentInformationId { get; set; }
     public long UserId { get; set; }
@@ -39 +44 @@
       set { PaymentMethodValue = (int)value; }
     }
+
+    public State EntityState { get; set; }
   }
 
@@ -60 +67 @@
   }
 
-  public class Product {
+  public class Product : IObjectWithState {
     public long ProductId { get; set; }
     public string Name { get; set; }
@@ -66 +73 @@
     public string ProductType { get; set; }
     public double Price { get; set; }
+
+    public State EntityState { get; set; }
   }
 
-  public class User {
+  public class User : IObjectWithState {
     public long UserId { get; set; }
     public long ContactInformationId { get; set; }
@@ -75 +84 @@
     public virtual IList<PaymentInformation> PaymentInformation { get; set; }
     public virtual ContactInformation ContactInformation { get; set; }
+
+    public State EntityState { get; set; }
   }
 
@@ -85 +96 @@
   }
 
-  public class Order {
+  public class Order : IObjectWithState {
     public long OrderId { get; set; }
     public long UserId { get; set; }
@@ -112 +123 @@
       set { BillingPeriodValue = (int)value; }
     }
+
+    public State EntityState { get; set; }
   }
 
-  public class OrderLine {
+  public class OrderLine : IObjectWithState {
     public long OrderLineId { get; set; }
     public long OrderId { get; set; }
@@ -123 +136 @@
     public virtual Order Order { get; set; }
     public virtual Product Product { get; set; }
+
+    public State EntityState { get; set; }
   }
 
@@ -129 +144 @@
   }
 
-  public class Invoice {
+  public class Invoice : IObjectWithState {
     public long InvoiceId { get; set; }
     public long UserId { get; set; }
@@ -148 +163 @@
       set { StatusValue = (int)value; }
     }
+
+    public State EntityState { get; set; }
   }
 
-  public class InvoiceLine {
+  public class InvoiceLine : IObjectWithState {
     public long InvoiceLineId { get; set; }
     public long InvoiceId { get; set; }
@@ -159 +176 @@
     public virtual Invoice Invoice { get; set; }
     public virtual Product Product { get; set; }
+
+    public State EntityState { get; set; }
   }
 
-  public class UsageRecord {
+  public class UsageRecord : IObjectWithState {
     public long UsageRecordId { get; set; }
     public long UserId { get; set; }
@@ -172 +191 @@
     public virtual User User { get; set; }
     public virtual Product Product { get; set; }
+
+    public State EntityState { get; set; }
   }
 }