From 8bfcf0faf4e47a964a2d3bf0554eb878ee22eb5e Mon Sep 17 00:00:00 2001 From: Philipp Meier Date: Sat, 25 Feb 2023 19:10:43 +0100 Subject: [PATCH] First commit --- .github/workflows/dotnet.yml | 25 ++ .gitignore | 452 +++++++++++++++++++++++++++++++ Dockerfile | 20 ++ LICENSE | 21 ++ README.md | 21 ++ docker-compose.yml | 18 ++ src/Program.cs | 51 ++++ src/appsettings.Development.json | 9 + src/appsettings.json | 9 + src/tile-server.csproj | 14 + test/index.html | 31 +++ test/k6.js | 23 ++ 12 files changed, 694 insertions(+) create mode 100644 .github/workflows/dotnet.yml create mode 100644 .gitignore create mode 100644 Dockerfile create mode 100644 LICENSE create mode 100644 README.md create mode 100644 docker-compose.yml create mode 100644 src/Program.cs create mode 100644 src/appsettings.Development.json create mode 100644 src/appsettings.json create mode 100644 src/tile-server.csproj create mode 100644 test/index.html create mode 100644 test/k6.js diff --git a/.github/workflows/dotnet.yml b/.github/workflows/dotnet.yml new file mode 100644 index 0000000..be19f77 --- /dev/null +++ b/.github/workflows/dotnet.yml @@ -0,0 +1,25 @@ +name: CI + +on: + push: + branches: [ "main" ] + pull_request: + branches: [ "main" ] + +jobs: + build: + + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v3 + - name: Setup .NET + uses: actions/setup-dotnet@v3 + with: + dotnet-version: 6.0.x + - name: Restore dependencies + run: dotnet restore ./src + - name: Build + run: dotnet build ./src --no-restore + - name: Test + run: dotnet test ./src --no-build --verbosity normal diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..8f0a9e9 --- /dev/null +++ b/.gitignore @@ -0,0 +1,452 @@ +## 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/master/VisualStudio.gitignore + +# User-specific files +*.rsuser *.suo +*.user +*.userosscache +*.sln.docstates +Properties +data/map_data.mbtiles + +# 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 Core +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 +*.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 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/ + +# 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 + +## +## 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 + +# JetBrains Rider +.idea/ +*.sln.iml + +## +## Visual Studio Code +## +.vscode/* +!.vscode/settings.json +!.vscode/tasks.json +!.vscode/launch.json +!.vscode/extensions.json diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..d74e342 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,20 @@ +FROM mcr.microsoft.com/dotnet/aspnet:6.0 AS base +WORKDIR /app +EXPOSE 80 +EXPOSE 443 + +FROM mcr.microsoft.com/dotnet/sdk:6.0 AS build +WORKDIR /src +COPY ["src/tile-server.csproj", "./"] +RUN dotnet restore "tile-server.csproj" +COPY ./src . +WORKDIR "/src/" +RUN dotnet build "tile-server.csproj" -c Release -o /app/build + +FROM build AS publish +RUN dotnet publish "tile-server.csproj" -c Release -o /app/publish + +FROM base AS final +WORKDIR /app +COPY --from=publish /app/publish . +ENTRYPOINT ["dotnet", "tile-server.dll"] \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..8198dac --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2023 Philipp Meier + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..ade89f5 --- /dev/null +++ b/README.md @@ -0,0 +1,21 @@ +# tile-server +[![CI](https://github.com/philipp-meier/tile-server/actions/workflows/dotnet.yml/badge.svg)](https://github.com/philipp-meier/tile-server/actions/workflows/dotnet.yml) +[![MIT License](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/philipp-meier/tile-server/blob/main/LICENSE) +Simple tile server for `.mbtiles`-files written in C# with minimal APIs. + +## Setup +1. Place your .mbtiles file in the `./data` directory (`mkdir data`) and rename it to `map_data.mbtiles`. +2. Generate a (trusted) https certificate and place it in the `https` folder: +`dotnet dev-certs https -ep ./https/aspnetapp.pfx -p ` +`dotnet dev-certs https --trust` +3. Enter your chosen https certificate password in the `docker-compose.yml` environment variable. +4. Build the tile server with `docker compose build`. +5. Run the server with `docker compose up`. +6. Open the `./test/index.html` to see a leaflet-demo. +7. _[Optional]_ Enter the container with `docker exec -it tile-server-app-1 bash`. + +## Stress testing +Install [k6](https://k6.io/docs/get-started/installation/) by Grafana Labs and run the following command: `k6 run test/k6.js` + +## Used mbtiles file: +https://ftp.gwdg.de/pub/misc/openstreetmap/openandromaps/world/OAM-World-1-8-min-J80.mbtiles diff --git a/docker-compose.yml b/docker-compose.yml new file mode 100644 index 0000000..ad5c346 --- /dev/null +++ b/docker-compose.yml @@ -0,0 +1,18 @@ +version: '3.4' + +services: + app: + build: + context: . + dockerfile: Dockerfile + ports: + - "127.0.0.1:80:80" + - "127.0.0.1:443:443" + environment: + - ASPNETCORE_ENVIRONMENT=Production + - ASPNETCORE_URLS=https://+:443;http://+:80 + - ASPNETCORE_Kestrel__Certificates__Default__Password= + - ASPNETCORE_Kestrel__Certificates__Default__Path=/https/aspnetapp.pfx + volumes: + - ./data:/app/data + - ./https:/https diff --git a/src/Program.cs b/src/Program.cs new file mode 100644 index 0000000..84edc16 --- /dev/null +++ b/src/Program.cs @@ -0,0 +1,51 @@ +using System.Threading.Tasks; +using Microsoft.AspNetCore.Http; +using Microsoft.Data.Sqlite; + +var builder = WebApplication.CreateBuilder(args); + +var mbtilesPath = Path.Combine(Directory.GetCurrentDirectory(), "data", "map_data.mbtiles"); +if (!File.Exists(mbtilesPath)) + throw new FileNotFoundException(mbtilesPath); + +var connStr = new SqliteConnectionStringBuilder { + Mode = SqliteOpenMode.ReadOnly, + DataSource = mbtilesPath +}; +builder.Services.AddScoped(_ => new SqliteConnection(connStr.ToString())); + +var app = builder.Build(); + +// Configure the HTTP request pipeline. +if (!app.Environment.IsDevelopment()) +{ + // The default HSTS value is 30 days. You may want to change this for production scenarios, see https://aka.ms/aspnetcore-hsts. + app.UseHsts(); +} + +app.MapGet("/{z:int}/{x:int}/{y:int}.png", async (HttpContext context, SqliteConnection db, int z, int x, int y) => { + context.Response.Headers.Add("Cache-Control", "max-age=58362, stale-while-revalidate=604800, stale-if-error=604800"); + + await db.OpenAsync(); + using (var command = db.CreateCommand()) { + command.CommandText = + @" + SELECT tile_data + FROM tiles + WHERE zoom_level = $z AND tile_column = $x AND tile_row = $y + "; + command.Parameters.AddWithValue("$z", z); + command.Parameters.AddWithValue("$x", x); + command.Parameters.AddWithValue("$y", y); + + using (var reader = await command.ExecuteReaderAsync()) { + if (await reader.ReadAsync() && reader["tile_data"] is byte[] tileData) + return Results.File(tileData, contentType: "image/png"); + else + return Results.NoContent(); + } + } +}); + +app.UseHttpsRedirection(); +app.Run(); diff --git a/src/appsettings.Development.json b/src/appsettings.Development.json new file mode 100644 index 0000000..770d3e9 --- /dev/null +++ b/src/appsettings.Development.json @@ -0,0 +1,9 @@ +{ + "DetailedErrors": true, + "Logging": { + "LogLevel": { + "Default": "Information", + "Microsoft.AspNetCore": "Warning" + } + } +} diff --git a/src/appsettings.json b/src/appsettings.json new file mode 100644 index 0000000..10f68b8 --- /dev/null +++ b/src/appsettings.json @@ -0,0 +1,9 @@ +{ + "Logging": { + "LogLevel": { + "Default": "Information", + "Microsoft.AspNetCore": "Warning" + } + }, + "AllowedHosts": "*" +} diff --git a/src/tile-server.csproj b/src/tile-server.csproj new file mode 100644 index 0000000..6a80f98 --- /dev/null +++ b/src/tile-server.csproj @@ -0,0 +1,14 @@ + + + + net6.0 + enable + enable + tile_server + + + + + + + diff --git a/test/index.html b/test/index.html new file mode 100644 index 0000000..35ff5ed --- /dev/null +++ b/test/index.html @@ -0,0 +1,31 @@ + + + + tile-server | Leaflet test + + + + + + + +
+ + + + \ No newline at end of file diff --git a/test/k6.js b/test/k6.js new file mode 100644 index 0000000..2e45d84 --- /dev/null +++ b/test/k6.js @@ -0,0 +1,23 @@ +import http from "k6/http"; + +export let options = { + insecureSkipTLSVerify: true, + scenarios: { + stress: { + executor: "ramping-arrival-rate", + preAllocatedVUs: 500, + timeUnit: "1s", + stages: [ + { duration: "30s", target: 10 }, + { duration: "1m", target: 20 }, + { duration: "1m", target: 30 }, + { duration: "30s", target: 40 }, + { duration: "30s", target: 0 } // Recovery stage. + ] + } + } +}; + +export default function() { + http.get("https://localhost/5/15/19.png"); +} \ No newline at end of file