From 0b1e85ecb762130965430bc4bc834e6d00a91060 Mon Sep 17 00:00:00 2001 From: Alex Hyett Date: Wed, 20 Sep 2023 12:14:09 +0100 Subject: [PATCH] Add idempotency code --- .gitignore | 477 +++++++++++++++++++++++++++++++ Controllers/PaymentController.cs | 82 ++++++ DTOs/PaymentRequest.cs | 15 + DTOs/PaymentResponse.cs | 13 + Idempotency.csproj | 13 + Idempotency.sln | 22 ++ Program.cs | 26 ++ README.md | 47 ++- Startup.cs | 50 ++++ appsettings.Development.json | 9 + appsettings.json | 10 + docker-compose.yml | 13 + 12 files changed, 775 insertions(+), 2 deletions(-) create mode 100644 .gitignore create mode 100644 Controllers/PaymentController.cs create mode 100644 DTOs/PaymentRequest.cs create mode 100644 DTOs/PaymentResponse.cs create mode 100644 Idempotency.csproj create mode 100644 Idempotency.sln create mode 100644 Program.cs create mode 100644 Startup.cs create mode 100644 appsettings.Development.json create mode 100644 appsettings.json create mode 100644 docker-compose.yml diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..9965de2 --- /dev/null +++ b/.gitignore @@ -0,0 +1,477 @@ +## Ignore Visual Studio temporary files, build results, and +## files generated by popular Visual Studio add-ons. +## +## Get latest from https://github.com/github/gitignore/blob/main/VisualStudio.gitignore + +# User-specific files +*.rsuser +*.suo +*.user +*.userosscache +*.sln.docstates + +# User-specific files (MonoDevelop/Xamarin Studio) +*.userprefs + +# Mono auto generated files +mono_crash.* + +# Build results +[Dd]ebug/ +[Dd]ebugPublic/ +[Rr]elease/ +[Rr]eleases/ +x64/ +x86/ +[Ww][Ii][Nn]32/ +[Aa][Rr][Mm]/ +[Aa][Rr][Mm]64/ +bld/ +[Bb]in/ +[Oo]bj/ +[Ll]og/ +[Ll]ogs/ + +# Visual Studio 2015/2017 cache/options directory +.vs/ +# Uncomment if you have tasks that create the project's static files in wwwroot +#wwwroot/ + +# Visual Studio 2017 auto generated files +Generated\ Files/ + +# MSTest test Results +[Tt]est[Rr]esult*/ +[Bb]uild[Ll]og.* + +# NUnit +*.VisualState.xml +TestResult.xml +nunit-*.xml + +# Build Results of an ATL Project +[Dd]ebugPS/ +[Rr]eleasePS/ +dlldata.c + +# Benchmark Results +BenchmarkDotNet.Artifacts/ + +# .NET +project.lock.json +project.fragment.lock.json +artifacts/ + +# Tye +.tye/ + +# ASP.NET Scaffolding +ScaffoldingReadMe.txt + +# StyleCop +StyleCopReport.xml + +# Files built by Visual Studio +*_i.c +*_p.c +*_h.h +*.ilk +*.meta +*.obj +*.iobj +*.pch +*.pdb +*.ipdb +*.pgc +*.pgd +*.rsp +*.sbr +*.tlb +*.tli +*.tlh +*.tmp +*.tmp_proj +*_wpftmp.csproj +*.log +*.tlog +*.vspscc +*.vssscc +.builds +*.pidb +*.svclog +*.scc + +# Chutzpah Test files +_Chutzpah* + +# Visual C++ cache files +ipch/ +*.aps +*.ncb +*.opendb +*.opensdf +*.sdf +*.cachefile +*.VC.db +*.VC.VC.opendb + +# Visual Studio profiler +*.psess +*.vsp +*.vspx +*.sap + +# Visual Studio Trace Files +*.e2e + +# TFS 2012 Local Workspace +$tf/ + +# Guidance Automation Toolkit +*.gpState + +# ReSharper is a .NET coding add-in +_ReSharper*/ +*.[Rr]e[Ss]harper +*.DotSettings.user + +# TeamCity is a build add-in +_TeamCity* + +# DotCover is a Code Coverage Tool +*.dotCover + +# AxoCover is a Code Coverage Tool +.axoCover/* +!.axoCover/settings.json + +# Coverlet is a free, cross platform Code Coverage Tool +coverage*.json +coverage*.xml +coverage*.info + +# Visual Studio code coverage results +*.coverage +*.coveragexml + +# NCrunch +_NCrunch_* +.*crunch*.local.xml +nCrunchTemp_* + +# MightyMoose +*.mm.* +AutoTest.Net/ + +# Web workbench (sass) +.sass-cache/ + +# Installshield output folder +[Ee]xpress/ + +# DocProject is a documentation generator add-in +DocProject/buildhelp/ +DocProject/Help/*.HxT +DocProject/Help/*.HxC +DocProject/Help/*.hhc +DocProject/Help/*.hhk +DocProject/Help/*.hhp +DocProject/Help/Html2 +DocProject/Help/html + +# Click-Once directory +publish/ + +# Publish Web Output +*.[Pp]ublish.xml +*.azurePubxml +# Note: Comment the next line if you want to checkin your web deploy settings, +# but database connection strings (with potential passwords) will be unencrypted +*.pubxml +*.publishproj + +# Microsoft Azure Web App publish settings. Comment the next line if you want to +# checkin your Azure Web App publish settings, but sensitive information contained +# in these scripts will be unencrypted +PublishScripts/ + +# NuGet Packages +*.nupkg +# NuGet Symbol Packages +*.snupkg +# The packages folder can be ignored because of Package Restore +**/[Pp]ackages/* +# except build/, which is used as an MSBuild target. +!**/[Pp]ackages/build/ +# Uncomment if necessary however generally it will be regenerated when needed +#!**/[Pp]ackages/repositories.config +# NuGet v3's project.json files produces more ignorable files +*.nuget.props +*.nuget.targets + +# Microsoft Azure Build Output +csx/ +*.build.csdef + +# Microsoft Azure Emulator +ecf/ +rcf/ + +# Windows Store app package directories and files +AppPackages/ +BundleArtifacts/ +Package.StoreAssociation.xml +_pkginfo.txt +*.appx +*.appxbundle +*.appxupload + +# Visual Studio cache files +# files ending in .cache can be ignored +*.[Cc]ache +# but keep track of directories ending in .cache +!?*.[Cc]ache/ + +# Others +ClientBin/ +~$* +*~ +*.dbmdl +*.dbproj.schemaview +*.jfm +*.pfx +*.publishsettings +orleans.codegen.cs + +# Including strong name files can present a security risk +# (https://github.com/github/gitignore/pull/2483#issue-259490424) +#*.snk + +# Since there are multiple workflows, uncomment next line to ignore bower_components +# (https://github.com/github/gitignore/pull/1529#issuecomment-104372622) +#bower_components/ + +# RIA/Silverlight projects +Generated_Code/ + +# Backup & report files from converting an old project file +# to a newer Visual Studio version. Backup files are not needed, +# because we have git ;-) +_UpgradeReport_Files/ +Backup*/ +UpgradeLog*.XML +UpgradeLog*.htm +ServiceFabricBackup/ +*.rptproj.bak + +# SQL Server files +*.mdf +*.ldf +*.ndf + +# Business Intelligence projects +*.rdl.data +*.bim.layout +*.bim_*.settings +*.rptproj.rsuser +*- [Bb]ackup.rdl +*- [Bb]ackup ([0-9]).rdl +*- [Bb]ackup ([0-9][0-9]).rdl + +# Microsoft Fakes +FakesAssemblies/ + +# GhostDoc plugin setting file +*.GhostDoc.xml + +# Node.js Tools for Visual Studio +.ntvs_analysis.dat +node_modules/ + +# Visual Studio 6 build log +*.plg + +# Visual Studio 6 workspace options file +*.opt + +# Visual Studio 6 auto-generated workspace file (contains which files were open etc.) +*.vbw + +# Visual Studio 6 auto-generated project file (contains which files were open etc.) +*.vbp + +# Visual Studio 6 workspace and project file (working project files containing files to include in project) +*.dsw +*.dsp + +# Visual Studio 6 technical files +*.ncb +*.aps + +# Visual Studio LightSwitch build output +**/*.HTMLClient/GeneratedArtifacts +**/*.DesktopClient/GeneratedArtifacts +**/*.DesktopClient/ModelManifest.xml +**/*.Server/GeneratedArtifacts +**/*.Server/ModelManifest.xml +_Pvt_Extensions + +# Paket dependency manager +.paket/paket.exe +paket-files/ + +# FAKE - F# Make +.fake/ + +# CodeRush personal settings +.cr/personal + +# Python Tools for Visual Studio (PTVS) +__pycache__/ +*.pyc + +# Cake - Uncomment if you are using it +# tools/** +# !tools/packages.config + +# Tabs Studio +*.tss + +# Telerik's JustMock configuration file +*.jmconfig + +# BizTalk build output +*.btp.cs +*.btm.cs +*.odx.cs +*.xsd.cs + +# OpenCover UI analysis results +OpenCover/ + +# Azure Stream Analytics local run output +ASALocalRun/ + +# MSBuild Binary and Structured Log +*.binlog + +# NVidia Nsight GPU debugger configuration file +*.nvuser + +# MFractors (Xamarin productivity tool) working folder +.mfractor/ + +# Local History for Visual Studio +.localhistory/ + +# Visual Studio History (VSHistory) files +.vshistory/ + +# BeatPulse healthcheck temp database +healthchecksdb + +# Backup folder for Package Reference Convert tool in Visual Studio 2017 +MigrationBackup/ + +# Ionide (cross platform F# VS Code tools) working folder +.ionide/ + +# Fody - auto-generated XML schema +FodyWeavers.xsd + +# VS Code files for those working on multiple tools +.vscode/* +!.vscode/settings.json +!.vscode/tasks.json +!.vscode/launch.json +!.vscode/extensions.json +*.code-workspace + +# Local History for Visual Studio Code +.history/ + +# Windows Installer files from build outputs +*.cab +*.msi +*.msix +*.msm +*.msp + +# JetBrains Rider +*.sln.iml + +## +## Visual studio for Mac +## + + +# globs +Makefile.in +*.userprefs +*.usertasks +config.make +config.status +aclocal.m4 +install-sh +autom4te.cache/ +*.tar.gz +tarballs/ +test-results/ + +# Mac bundle stuff +*.dmg +*.app + +# content below from: https://github.com/github/gitignore/blob/master/Global/macOS.gitignore +# General +.DS_Store +.AppleDouble +.LSOverride + +# Icon must end with two \r +Icon + + +# Thumbnails +._* + +# Files that might appear in the root of a volume +.DocumentRevisions-V100 +.fseventsd +.Spotlight-V100 +.TemporaryItems +.Trashes +.VolumeIcon.icns +.com.apple.timemachine.donotpresent + +# Directories potentially created on remote AFP share +.AppleDB +.AppleDesktop +Network Trash Folder +Temporary Items +.apdisk + +# content below from: https://github.com/github/gitignore/blob/master/Global/Windows.gitignore +# Windows thumbnail cache files +Thumbs.db +ehthumbs.db +ehthumbs_vista.db + +# Dump file +*.stackdump + +# Folder config file +[Dd]esktop.ini + +# Recycle Bin used on file shares +$RECYCLE.BIN/ + +# Windows Installer files +*.cab +*.msi +*.msix +*.msm +*.msp + +# Windows shortcuts +*.lnk diff --git a/Controllers/PaymentController.cs b/Controllers/PaymentController.cs new file mode 100644 index 0000000..48f3b8a --- /dev/null +++ b/Controllers/PaymentController.cs @@ -0,0 +1,82 @@ +using System; +using Microsoft.AspNetCore.Mvc; +using IdempotentAPI.Filters; +using Idempotency.DTOs; +using Microsoft.Extensions.Caching.Distributed; +using System.Text; +using Newtonsoft.Json; + +namespace Idempotency.Controllers +{ + [ApiController] + [Route("[controller]")] + [Consumes("application/json")] + [Produces("application/json")] + [Idempotent] + public class PaymentController : ControllerBase + { + + private readonly IDistributedCache _db; + + public PaymentController(IDistributedCache db) + { + _db = db ?? throw new ArgumentNullException(nameof(db)); + } + + [HttpGet("{id}")] + public IActionResult Get(string id) + { + if (string.IsNullOrWhiteSpace(id)) + return BadRequest($"The id should not be null"); + + var response = GetPayment(id); + + return Ok(response); + } + + [HttpPost] + public IActionResult Post([FromBody] PaymentRequest request) + { + if (request is null) + return BadRequest($"The request should not be null"); + + if (request.CardNumber.Length != 16) + return BadRequest("The card number should be 16 characters"); + + var id = Guid.NewGuid().ToString(); + + var response = new PaymentResponse + { + Id = id.ToString(), + Amount = request.Amount, + Currency = request.Currency, + CardNumber = request.CardNumber.Substring(12, 4).PadLeft(16, '*'), + Created = DateTime.UtcNow + }; + + SavePayment(id, response); + + return Ok(response); + } + + private void SavePayment(string id, PaymentResponse payment) + { + var options = new DistributedCacheEntryOptions(); + + // I am using the cache as a makeshift database here. + // Obviously in a real system you would be saving this to an actual database. + var data = Encoding.UTF8.GetBytes(JsonConvert.SerializeObject(payment)); + _db.Set(id, data, options); + } + + private PaymentResponse GetPayment(string id) + { + var data = _db.Get(id); + + if (data is null) + return null; + + return JsonConvert.DeserializeObject(Encoding.UTF8.GetString(data)); + } + } +} diff --git a/DTOs/PaymentRequest.cs b/DTOs/PaymentRequest.cs new file mode 100644 index 0000000..9dbe1f8 --- /dev/null +++ b/DTOs/PaymentRequest.cs @@ -0,0 +1,15 @@ +using System; + +namespace Idempotency.DTOs; + +[Serializable] +public class PaymentRequest +{ + public long Amount { get; set; } + public string Currency { get; set; } + public string CardNumber { get; set; } + public string CVV { get; set; } + public string ExpiryYear { get; set; } + public string ExpiryMonth { get; set; } +} + diff --git a/DTOs/PaymentResponse.cs b/DTOs/PaymentResponse.cs new file mode 100644 index 0000000..bea695a --- /dev/null +++ b/DTOs/PaymentResponse.cs @@ -0,0 +1,13 @@ +using System; + +namespace Idempotency.DTOs; + +[Serializable] +public class PaymentResponse +{ + public string Id { get; set; } + public long Amount { get; set; } + public string Currency { get; set; } + public string CardNumber { get; set; } + public DateTime Created { get; set; } +} \ No newline at end of file diff --git a/Idempotency.csproj b/Idempotency.csproj new file mode 100644 index 0000000..5eea57f --- /dev/null +++ b/Idempotency.csproj @@ -0,0 +1,13 @@ + + + + net7.0 + + + + + + + + + \ No newline at end of file diff --git a/Idempotency.sln b/Idempotency.sln new file mode 100644 index 0000000..ba5f7c1 --- /dev/null +++ b/Idempotency.sln @@ -0,0 +1,22 @@ + +Microsoft Visual Studio Solution File, Format Version 12.00 +# Visual Studio Version 17 +VisualStudioVersion = 17.0.31903.59 +MinimumVisualStudioVersion = 10.0.40219.1 +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Idempotency", "Idempotency.csproj", "{25C5726C-1FD2-41D0-9229-12DAD1BE03A3}" +EndProject +Global + GlobalSection(SolutionConfigurationPlatforms) = preSolution + Debug|Any CPU = Debug|Any CPU + Release|Any CPU = Release|Any CPU + EndGlobalSection + GlobalSection(SolutionProperties) = preSolution + HideSolutionNode = FALSE + EndGlobalSection + GlobalSection(ProjectConfigurationPlatforms) = postSolution + {25C5726C-1FD2-41D0-9229-12DAD1BE03A3}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {25C5726C-1FD2-41D0-9229-12DAD1BE03A3}.Debug|Any CPU.Build.0 = Debug|Any CPU + {25C5726C-1FD2-41D0-9229-12DAD1BE03A3}.Release|Any CPU.ActiveCfg = Release|Any CPU + {25C5726C-1FD2-41D0-9229-12DAD1BE03A3}.Release|Any CPU.Build.0 = Release|Any CPU + EndGlobalSection +EndGlobal diff --git a/Program.cs b/Program.cs new file mode 100644 index 0000000..f61cdc9 --- /dev/null +++ b/Program.cs @@ -0,0 +1,26 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Threading.Tasks; +using Microsoft.AspNetCore.Hosting; +using Microsoft.Extensions.Configuration; +using Microsoft.Extensions.Hosting; +using Microsoft.Extensions.Logging; + +namespace Idempotency +{ + public class Program + { + public static void Main(string[] args) + { + CreateHostBuilder(args).Build().Run(); + } + + public static IHostBuilder CreateHostBuilder(string[] args) => + Host.CreateDefaultBuilder(args) + .ConfigureWebHostDefaults(webBuilder => + { + webBuilder.UseStartup(); + }); + } +} diff --git a/README.md b/README.md index 316f1f4..26f18f9 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,45 @@ -# idempotency -An example API showing Idempotency using Redis +# Idempotency - What is it and How to Implement It +An example API showing Idempotency using Redis. + +This is the code that is shown in my video "Idempotency - What is it and How to Implement It". + +To run this project you need to do the following: + +1. Run `docker-compose up` to start the Redis container. +2. Run `dotnet run` to start the API. + +You can then send requests like the following: + +```sh +curl --location 'http://localhost:5000/payment/' \ +--header 'IdempotencyKey: A222EB7F-E861-420F-B010-0EDDD29C935E' \ +--header 'Content-Type: application/json' \ +--data '{ + "amount": 1200, + "currency": "USD", + "cardNumber": "4122916040150031", + "cvv": "123", + "expiryYear": "2023", + "expiryMonth": "01" +}' +``` + +If you send this request through multiple times you will get the same response. + +Such as: + +```json +{ + "id": "e5c68b39-b534-47c1-a672-a6f8c1fd18f6", + "amount": 1200, + "currency": "USD", + "cardNumber": "************0031", + "created": "2023-09-20T11:08:34.028706Z" +} +``` + +You can also retrieve payments using GET and the ID: +```sh +curl --location 'http://localhost:5000/payment/e5c68b39-b534-47c1-a672-a6f8c1fd18f6' +``` + diff --git a/Startup.cs b/Startup.cs new file mode 100644 index 0000000..a056b10 --- /dev/null +++ b/Startup.cs @@ -0,0 +1,50 @@ +using IdempotentAPI.Cache.DistributedCache.Extensions.DependencyInjection; +using IdempotentAPI.Extensions.DependencyInjection; +using Microsoft.AspNetCore.Builder; +using Microsoft.AspNetCore.Hosting; +using Microsoft.Extensions.Configuration; +using Microsoft.Extensions.DependencyInjection; +using Microsoft.Extensions.Hosting; + +namespace Idempotency +{ + public class Startup + { + public Startup(IConfiguration configuration) + { + Configuration = configuration; + } + + public IConfiguration Configuration { get; } + + public void ConfigureServices(IServiceCollection services) + { + services.AddDistributedRedisCache(options => + { + options.Configuration = "localhost:6379"; + options.InstanceName = "Redis"; + }); + + services.AddIdempotentAPI(); + services.AddIdempotentAPIUsingDistributedCache(); + services.AddControllers(); + } + + public void Configure(IApplicationBuilder app, IWebHostEnvironment env) + { + if (env.IsDevelopment()) + { + app.UseDeveloperExceptionPage(); + } + + app.UseHttpsRedirection(); + app.UseRouting(); + app.UseAuthorization(); + + app.UseEndpoints(endpoints => + { + endpoints.MapControllers(); + }); + } + } +} diff --git a/appsettings.Development.json b/appsettings.Development.json new file mode 100644 index 0000000..8983e0f --- /dev/null +++ b/appsettings.Development.json @@ -0,0 +1,9 @@ +{ + "Logging": { + "LogLevel": { + "Default": "Information", + "Microsoft": "Warning", + "Microsoft.Hosting.Lifetime": "Information" + } + } +} diff --git a/appsettings.json b/appsettings.json new file mode 100644 index 0000000..d9d9a9b --- /dev/null +++ b/appsettings.json @@ -0,0 +1,10 @@ +{ + "Logging": { + "LogLevel": { + "Default": "Information", + "Microsoft": "Warning", + "Microsoft.Hosting.Lifetime": "Information" + } + }, + "AllowedHosts": "*" +} diff --git a/docker-compose.yml b/docker-compose.yml new file mode 100644 index 0000000..68a2581 --- /dev/null +++ b/docker-compose.yml @@ -0,0 +1,13 @@ +version: '3.8' +services: + cache: + image: redis:latest + restart: always + ports: + - '6379:6379' + command: redis-server --save 20 1 --loglevel warning + volumes: + - cache:/data +volumes: + cache: + driver: local \ No newline at end of file