Local deployment on par with future prod #306

DmyMi · 2021-08-30T21:27:08Z

Disclaimer

Lots of changes, but more than half of them are due to moving files from one namespace to another.

This is a first set of changes. Rest will mostly include changes to compose files & nginx config.

Add api versioning (with backward compatibility so frontend can transition seamlessly) to easily support breaking changes to production later. As per MS Recommendations & example on the internet
Add reverse proxy configuration with optional base path as per MS Documentation. Depending on final deployment we will either have a single host & basepath or two virtual hosts & no basepath. This change allows to work with both approaches without changing any part of application except appsettings & some env variables.
Refactor delay in Program.cs and increased it to 5 seconds so that Identity won't spam SQL with requests on startup.
Add first iteration of Nginx config for local deployment in compose
Add Compose environment settings for local compose deployments.
Add local automated dev environment to simulate production. It works using a single set of tools & one command on MacOS (tested on Big Sur 11.5), Linux (tested on Ubuntu 20.04.3) & Windows 10 (but on Windows work means it doesn't ~50% of time, depending on Win10 build :) )
Add supplementary scripts (powershell & bash) to support local dev environment
Add first iteration of Readme & with aforementioned environment launch docs

h4wk13 · 2021-08-31T07:54:17Z

OutOfSchool/OutOfSchool.IdentityServer/Extensions/Startup/ReverseProxyExtensions.cs

+            services.Configure<ForwardedHeadersOptions>(options =>
+            {
+                options.ForwardedHeaders =
+                    ForwardedHeaders.XForwardedFor | ForwardedHeaders.XForwardedProto;


Should it be moved to appconfig.json smth like a 'ProxyConfig' section ?

h4wk13 · 2021-08-31T07:56:57Z

OutOfSchool/OutOfSchool.IdentityServer/Extensions/Startup/ReverseProxyExtensions.cs

+        /// </summary>
+        public static IApplicationBuilder UseProxy(this IApplicationBuilder app, IConfiguration configuration)
+        {
+            string basePath = configuration["REVERSE_PROXY_BASEPATH"];


Can we move REVERSE_PROXY_BASEPATH into the public constant of the configuration section ?

h4wk13 · 2021-08-31T07:58:42Z

OutOfSchool/OutOfSchool.IdentityServer/Program.cs

@@ -17,6 +17,8 @@ namespace OutOfSchool.IdentityServer
 {
    public class Program
    {
+        private static readonly int CHECK_CONNECTIVITY_DELAY = 5000;


we can use const instead of static readonly here.

h4wk13 · 2021-08-31T08:01:31Z

OutOfSchool/OutOfSchool.IdentityServer/Program.cs

                    Console.WriteLine("Waiting for db connection");
+                    Task.Delay(CHECK_CONNECTIVITY_DELAY).Wait();


Console.WriteLine("Waiting for db connection"); looks like logger.Trace
Also, should we add a timeout or cancellation for the wait mechanism ?

h4wk13 · 2021-08-31T08:05:59Z

OutOfSchool/OutOfSchool.IdentityServer/appsettings.Compose.json

@@ -0,0 +1,36 @@
+{
+  "ConnectionStrings": {
+    "DefaultConnection": "Server=sql-server; Database=Master;User Id=SA;Password=Oos-password1"


Why we are using internal main MSSQL database (Database=Master) for our project ?

will update this in next PR.

h4wk13 · 2021-08-31T08:37:24Z

OutOfSchool/OutOfSchool.WebApi/Extensions/Startup/SwaggerExtensions.cs

+                {
+                    string swaggerEndpoint;
+
+                    string basePath = configuration["REVERSE_PROXY_BASEPATH"];


I've seen REVERSE_PROXY_BASEPATH before, please move to const

h4wk13 · 2021-08-31T08:48:51Z

OutOfSchool/OutOfSchool.WebApi/OutOfSchool.WebApi.csproj

-    <PackageReference Include="Swashbuckle.AspNetCore.Swagger" Version="5.6.3" />
-    <PackageReference Include="Swashbuckle.AspNetCore.SwaggerGen" Version="5.6.3" />
-    <PackageReference Include="Swashbuckle.AspNetCore.SwaggerUI" Version="5.6.3" />
+    <PackageReference Include="Swashbuckle.AspNetCore.Swagger" Version="6.1.3" />


Should we have a document with all third party libraries we are using ?
e.g. output of the Get-Package | select Id, Version, LicenseUrl running from vs console

docker-compose.m1.yml

docker-compose.yml

docker-compose.local.yml

VadymLevkovskyi · 2021-09-01T12:41:06Z

OutOfSchool/OutOfSchool.WebApi/Controllers/V1/AddressController.cs

 {
    [ApiController]
+    [ApiVersion("1.0")]
+    [Route("api/v{version:apiVersion}/[controller]/[action]")]


Instead of changing each and every Controller couldn't routing be configured via Conventional routing ? (In Startup.Configure)

VadymLevkovskyi · 2021-09-01T12:45:20Z

OutOfSchool/OutOfSchool.WebApi/Controllers/V1/WorkshopController.cs

@@ -107,7 +109,7 @@ public async Task<IActionResult> GetByFilter([FromQuery] WorkshopFilter filter)
        {
            if (string.IsNullOrWhiteSpace(filter.City))
            {
-                filter.City = "���";
+                filter.City = "Київ";


"Київ" - should be Default_City constant introduced somewhere, but not in WorkshopController

sonarqubecloud · 2021-09-06T07:36:37Z

SonarCloud Quality Gate failed.

0 Bugs
0 Vulnerabilities
0 Security Hotspots
43 Code Smells

75.1% Coverage
0.0% Duplication

DmyMi requested review from SergeyNovitsky, h4wk13, Bogdan-Hasanov, P0linux, OlhaHoliak, VyacheslavDzhus, Yuliya-Fedorenko and VadymLevkovskyi August 30, 2021 21:27

h4wk13 approved these changes Aug 31, 2021

View reviewed changes

VadymLevkovskyi reviewed Sep 1, 2021

View reviewed changes

VyacheslavDzhus approved these changes Sep 3, 2021

View reviewed changes

VadymLevkovskyi approved these changes Sep 3, 2021

View reviewed changes

DmyMi added 17 commits September 6, 2021 10:23

bump terraform version

54f08ac

add environment variables to logger configuration

99a659f

remove unnecessary docker files

56295dd

fill .dockerignore

46805d2

add separate settings files for local compose

b8767dd

Bump Swagger version & add API Versioning package

dab59c5

move controllers to V1 namespace

a948674

Configure reverse proxy option for identity server

7aa4ef8

fix icons for reverse proxy

55b8a2b

add reverse proxy config and refactor swagger config for versioning

680faab

add local nginx config

6ad09ea

add readme template

a82f20b

add Vagrant dev deployment

7e1115b

add powershell scripts

0818ecb

add powershell script to remove local certs

5553dec

add bash to trust & remove the ssl cert

91eb7c9

add & remove certs macos

230c8e2

DmyMi added 19 commits September 6, 2021 10:23

fixed local trust issue on OSX

3a283bc

ssl update for powershell

cc930e0

bump CPU count

883b5f6

add first iteration of readme

fa553ac

Fix Kyiv UTF-8

6d3cd14

clear SAN todo

bcd0a23

backward compatibility

34956b9

fixed fckup

b6bddd8

clear todo

f6112eb

Fix workshop test using old namespace

b43db0a

Fix files encoding to pure UTF-8

dd277a7

add proxy and swagger typed config.

08217bf

remove extra empty line

85f9bc4

remove useless documentation

6ebdc39

add default version to fix backwards compatible routing

13735e7

removed extra newline

3986083

add defaults config section for different default strings in application

880bcbe

externalize swagger document security definitions

7d20366

fix workshop tests

d39e05f

DmyMi force-pushed the feature/compose_stack branch from ea5efb0 to d39e05f Compare September 6, 2021 07:29

DmyMi merged commit 2b1134a into develop Sep 6, 2021

DmyMi deleted the feature/compose_stack branch September 6, 2021 07:37

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Local deployment on par with future prod #306

Local deployment on par with future prod #306

DmyMi commented Aug 30, 2021

h4wk13 Aug 31, 2021

h4wk13 Aug 31, 2021

h4wk13 Aug 31, 2021

h4wk13 Aug 31, 2021

h4wk13 Aug 31, 2021

DmyMi Sep 2, 2021

h4wk13 Aug 31, 2021

h4wk13 Aug 31, 2021

VadymLevkovskyi Sep 1, 2021

VadymLevkovskyi Sep 1, 2021

sonarqubecloud bot commented Sep 6, 2021

		Console.WriteLine("Waiting for db connection");
		Task.Delay(CHECK_CONNECTIVITY_DELAY).Wait();

Local deployment on par with future prod #306

Local deployment on par with future prod #306

Conversation

DmyMi commented Aug 30, 2021

Disclaimer

Contents

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sonarqubecloud bot commented Sep 6, 2021