ODataReadOnlySupport (#7218)

Add readOnlySqlReplica support for OData controllers.

Author: cristinamanum

src/NuGetGallery.Core/Entities/EntitiesContext.cs

@@ -53,7 +53,7 @@ public EntitiesContext(string connectionString, bool readOnly)
         public EntitiesContext(DbConnection connection, bool readOnly)
             : base(connection, contextOwnsConnection: true)
         {
-            ReadOnly = readOnly;
+           ReadOnly = readOnly;
         }
 
         public bool ReadOnly { get; private set; }
@@ -73,7 +73,7 @@ public EntitiesContext(DbConnection connection, bool readOnly)
         /// </summary>
         public DbSet<User> Users { get; set; }
 
-        DbSet<T> IEntitiesContext.Set<T>()
+        DbSet<T> IReadOnlyEntitiesContext.Set<T>()
         {
             return base.Set<T>();
         }

src/NuGetGallery.Core/Entities/IEntitiesContext.cs

@@ -1,17 +1,15 @@
 // Copyright (c) .NET Foundation. All rights reserved.
 // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
 
-using System;
 using System.Data.Entity;
 using System.Threading.Tasks;
 using NuGet.Services.Entities;
 
 namespace NuGetGallery
 {
-    public interface IEntitiesContext : IDisposable
+    public interface IEntitiesContext : IReadOnlyEntitiesContext
     {
         DbSet<Certificate> Certificates { get; set; }
-        DbSet<Package> Packages { get; set; }
         DbSet<PackageDeprecation> Deprecations { get; set; }
         DbSet<PackageRegistration> PackageRegistrations { get; set; }
         DbSet<Credential> Credentials { get; set; }
@@ -23,9 +21,7 @@ public interface IEntitiesContext : IDisposable
         DbSet<SymbolPackage> SymbolPackages { get; set; }
 
         Task<int> SaveChangesAsync();
-        DbSet<T> Set<T>() where T : class;
         void DeleteOnCommit<T>(T entity) where T : class;
-        void SetCommandTimeout(int? seconds);
         IDatabase GetDatabase();
     }
 }

src/NuGetGallery.Core/Entities/IEntityRepository.cs

@@ -2,19 +2,17 @@
 // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
 
 using System.Collections.Generic;
-using System.Linq;
 using System.Threading.Tasks;
 
 namespace NuGetGallery
 {
-    public interface IEntityRepository<T>
+    public interface IEntityRepository<T> : IReadOnlyEntityRepository<T>
         where T : class, new()
     {
         Task CommitChangesAsync();
         void InsertOnCommit(T entity);
         void InsertOnCommit(IEnumerable<T> entities);
         void DeleteOnCommit(T entity);
         void DeleteOnCommit(IEnumerable<T> entities);
-        IQueryable<T> GetAll();
     }
 }

src/NuGetGallery.Core/Entities/IReadOnlyEntitiesContext.cs

@@ -0,0 +1,18 @@
+// Copyright (c) .NET Foundation. All rights reserved.
+// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
+
+using System;
+using System.Data.Entity;
+using NuGet.Services.Entities;
+
+namespace NuGetGallery
+{
+    public interface IReadOnlyEntitiesContext : IDisposable
+    {
+        DbSet<Package> Packages { get; set; }
+
+        DbSet<T> Set<T>() where T : class;
+
+        void SetCommandTimeout(int? seconds);
+    }
+}

src/NuGetGallery.Core/Entities/IReadOnlyEntityRepository.cs

@@ -0,0 +1,13 @@
+// Copyright (c) .NET Foundation. All rights reserved.
+// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
+
+using System.Linq;
+
+namespace NuGetGallery
+{
+    public interface IReadOnlyEntityRepository<T>
+        where T : class, new()
+    {
+        IQueryable<T> GetAll();
+    }
+}

src/NuGetGallery.Core/Entities/ReadOnlyEntitiesContext.cs

@@ -0,0 +1,48 @@
+// Copyright (c) .NET Foundation. All rights reserved.
+// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
+
+using System;
+using System.Data.Common;
+using System.Data.Entity;
+using System.Linq;
+using NuGet.Services.Entities;
+
+namespace NuGetGallery
+{
+    public class ReadOnlyEntitiesContext : IReadOnlyEntitiesContext
+    {
+        private readonly EntitiesContext _entitiesContext; 
+        
+        public ReadOnlyEntitiesContext(DbConnection connection)
+        { 
+            _entitiesContext = new EntitiesContext(connection, readOnly: true);
+        }
+
+        public DbSet<Package> Packages
+        {
+            get
+            {
+                return _entitiesContext.Packages;
+            }
+            set
+            {
+                _entitiesContext.Packages = value;
+            }
+        }
+
+        DbSet<T> IReadOnlyEntitiesContext.Set<T>()
+        {
+            return _entitiesContext.Set<T>();
+        }
+
+        public void SetCommandTimeout(int? seconds)
+        {
+            _entitiesContext.SetCommandTimeout(seconds);
+        }
+
+        public void Dispose()
+        {
+            _entitiesContext.Dispose();
+        }
+    }
+}

src/NuGetGallery.Core/Entities/ReadOnlyEntityRepository.cs

@@ -0,0 +1,23 @@
+// Copyright (c) .NET Foundation. All rights reserved.
+// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
+
+using System.Linq;
+
+namespace NuGetGallery
+{
+    public class ReadOnlyEntityRepository<T> : IReadOnlyEntityRepository<T>
+        where T : class, new()
+    {
+        private readonly IReadOnlyEntitiesContext _readOnlyEntitiesContext;
+
+        public ReadOnlyEntityRepository(IReadOnlyEntitiesContext readOnlyEntitiesContext)
+        {
+            _readOnlyEntitiesContext = readOnlyEntitiesContext;
+        }
+
+        public IQueryable<T> GetAll()
+        {
+            return _readOnlyEntitiesContext.Set<T>();
+        }
+    }
+}

src/NuGetGallery.Core/IAppConfiguration.cs

@@ -170,6 +170,11 @@ public interface IAppConfiguration : IMessageServiceConfiguration
         /// </summary>
         string SqlConnectionString { get; set; }
 
+        /// <summary>
+        /// Gets the SQL Connection string used to connect to the read only replica of the database
+        /// </summary>
+        string SqlReadOnlyReplicaConnectionString { get; set; }
+
         /// <summary>
         /// Gets the SQL Connection string used to connect to the database for support requests
         /// </summary>

src/NuGetGallery.Core/NuGetGallery.Core.csproj

@@ -119,6 +119,9 @@
     <Compile Include="DisposableAction.cs" />
     <Compile Include="Entities\DatabaseWrapper.cs" />
     <Compile Include="Entities\DbContextTransactionWrapper.cs" />
+    <Compile Include="Entities\ReadOnlyEntitiesContext.cs" />
+    <Compile Include="Entities\IReadOnlyEntitiesContext.cs" />
+    <Compile Include="Entities\ReadOnlyEntityRepository.cs" />
     <Compile Include="Entities\IDatabase.cs" />
     <Compile Include="Entities\IDbContextTransaction.cs" />
     <Compile Include="Entities\EntitiesConfiguration.cs" />
@@ -130,6 +133,7 @@
     <Compile Include="Entities\IEntitiesContext.cs" />
     <Compile Include="Entities\Interception\IObjectMaterializedInterceptor.cs" />
     <Compile Include="Entities\IEntityRepository.cs" />
+    <Compile Include="Entities\IReadOnlyEntityRepository.cs" />
     <Compile Include="Entities\ReadOnlyModeException.cs" />
     <Compile Include="Entities\SuspendDbExecutionStrategy.cs" />
     <Compile Include="Extensions\DiagnosticsSourceExtensions.cs" />

src/NuGetGallery.Services/Configuration/AppConfiguration.cs

@@ -149,6 +149,13 @@ public class AppConfiguration : IAppConfiguration
         [DefaultValue("NuGetGallery")]
         public string SqlConnectionString { get; set; }
 
+        /// <summary>
+        /// Gets the SQL Connection string used to connect to the database read only replica.
+        /// </summary>
+        [DisplayName("SqlServerReadOnlyReplica")]
+        [DefaultValue(null)]
+        public string SqlReadOnlyReplicaConnectionString { get; set; }
+
         /// <summary>
         /// Gets the SQL Connection string used to connect to the database for support requests
         /// </summary>