Merge pull request #168 from dolthub/taylor/user-header

Pass through user headers from reverse proxy for commit author

Author: tbantle22

docker/README.md

@@ -190,6 +190,46 @@ Or you can run a Dolt SQL server for an existing database on your local machine:
 
 When you enter your database configuration from the UI, you can use `my-doltdb` as the host name to connect to the database running in that container.
 
+## Using a reverse proxy
+
+In some circumstances you may want to add a reverse proxy in front of the Dolt Workbench
+for authentication or other purposes. If you'd like to use the authenticated user from the
+proxy as the author for commits or tags, you can pass through the user headers.
+
+For example, given this [NGINX](https://www.nginx.com/) configuration that implements basic authentication:
+
+```conf
+events {}
+
+http {
+  server {
+    listen 80;
+    server_name localhost;
+
+    location / {
+      auth_basic "Restricted Access";
+      auth_basic_user_file /etc/nginx/.htpasswd;
+
+      proxy_pass http://workbench:3000;
+      proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+      proxy_set_header Host $host;
+      proxy_set_header X-Forwarded-Proto $scheme;
+      proxy_set_header X-Forwarded-User $remote_user;
+      proxy_set_header X-Forwarded-Email [email protected];
+    }
+  }
+}
+```
+
+The `X-Forwarded-User` and `X-Forwarded-Email` headers are passed through to the workbench
+and can used as the
+[author](https://docs.dolthub.com/sql-reference/version-control/dolt-sql-procedures#options-6)
+when creating a commit. Simply check the "Use name and email from headers as commit
+author" checkbox. The commit will be created with the user and email.
+
+You can also utilize this checkbox when creating releases and merging pull requests. If
+the headers are not properly configured the checkbox will be disabled.
+
 ## Contact
 
 You can reach us on [Discord](https://discord.com/invite/RFwfYpu) or [file a GitHub issue](https://github.com/dolthub/dolt-workbench/issues).

docker/examples/nginx-reverse-proxy/.htpasswd

@@ -0,0 +1 @@
+taylor:$apr1$0jAEdtKz$bijebRrD5MD9MR0buo6eH1

docker/examples/nginx-reverse-proxy/README.md

@@ -0,0 +1,12 @@
+# nginx-reverse-proxy
+
+Adds a reverse proxy in front of the Dolt Workbench that implements basic authentication.
+It passes through user headers that can be used by the workbench as the author of commits
+and tags.
+
+## Getting started
+
+```
+% docker compose build
+% docker compose up
+```

docker/examples/nginx-reverse-proxy/docker-compose.yml

@@ -0,0 +1,19 @@
+services:
+  combined:
+    build:
+      context: ../../../
+      dockerfile: docker/Dockerfile
+    ports:
+      - 3000:3000
+      - 9002:9002
+    image: docker.io/dolthub/dolt-workbench:latest
+
+  proxy:
+    image: nginx:latest
+    ports:
+      - "80:80"
+    volumes:
+      - ./nginx.conf:/etc/nginx/nginx.conf:ro
+      - ./.htpasswd:/etc/nginx/.htpasswd:ro
+    depends_on:
+      - combined

docker/examples/nginx-reverse-proxy/nginx.conf

@@ -0,0 +1,20 @@
+events {}
+
+http {
+  server {
+    listen 80;
+    server_name localhost;
+
+    location / {
+      auth_basic "Restricted Access";
+      auth_basic_user_file /etc/nginx/.htpasswd;
+
+      proxy_pass http://combined:3000;
+      proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+      proxy_set_header Host $host;
+      proxy_set_header X-Forwarded-Proto $scheme;
+      proxy_set_header X-Forwarded-User $remote_user;
+      proxy_set_header X-Forwarded-Email $remote_user@dolthub.com; 
+    }
+  }
+}

graphql-server/schema.gql

@@ -346,8 +346,8 @@ type Mutation {
   createSchema(schemaName: String!): Boolean!
   resetDatabase: Boolean!
   loadDataFile(tableName: String!, refName: String!, databaseName: String!, importOp: ImportOperation!, fileType: FileType!, file: Upload!, modifier: LoadDataModifier): Boolean!
-  mergePull(databaseName: String!, fromBranchName: String!, toBranchName: String!): Boolean!
-  createTag(tagName: String!, databaseName: String!, message: String, fromRefName: String!): String!
+  mergePull(fromBranchName: String!, toBranchName: String!, databaseName: String!, author: AuthorInfo): Boolean!
+  createTag(tagName: String!, databaseName: String!, message: String, fromRefName: String!, author: AuthorInfo): String!
   deleteTag(databaseName: String!, tagName: String!): Boolean!
 }
 
@@ -366,4 +366,9 @@ scalar Upload
 enum LoadDataModifier {
   Ignore
   Replace
+}
+
+input AuthorInfo {
+  name: String!
+  email: String!
 }

graphql-server/src/app.module.ts

@@ -3,6 +3,7 @@ import { Module } from "@nestjs/common";
 import { ConfigModule } from "@nestjs/config";
 import { GraphQLModule } from "@nestjs/graphql";
 import { TerminusModule } from "@nestjs/terminus";
+import { ConnectionProvider } from "./connections/connection.provider";
 import { DataStoreModule } from "./dataStore/dataStore.module";
 import { FileStoreModule } from "./fileStore/fileStore.module";
 import resolvers from "./resolvers";
@@ -19,6 +20,6 @@ import resolvers from "./resolvers";
     ConfigModule.forRoot({ isGlobal: true }),
     DataStoreModule,
   ],
-  providers: resolvers,
+  providers: [ConnectionProvider, ...resolvers],
 })
 export class AppModule {}

graphql-server/src/branches/branch.resolver.ts

@@ -8,7 +8,7 @@ import {
   ResolveField,
   Resolver,
 } from "@nestjs/graphql";
-import { ConnectionResolver } from "../connections/connection.resolver";
+import { ConnectionProvider } from "../connections/connection.provider";
 import { RawRow } from "../queryFactory/types";
 import { Table } from "../tables/table.model";
 import { TableResolver } from "../tables/table.resolver";
@@ -53,7 +53,7 @@ class ListBranchesArgs extends DBArgsWithOffset {
 @Resolver(_of => Branch)
 export class BranchResolver {
   constructor(
-    private readonly conn: ConnectionResolver,
+    private readonly conn: ConnectionProvider,
     private readonly tableResolver: TableResolver,
   ) {}
 

graphql-server/src/commits/commit.resolver.ts

@@ -1,5 +1,5 @@
 import { Args, ArgsType, Field, Query, Resolver } from "@nestjs/graphql";
-import { ConnectionResolver } from "../connections/connection.resolver";
+import { ConnectionProvider } from "../connections/connection.provider";
 import { RawRow } from "../queryFactory/types";
 import { ROW_LIMIT, getNextOffset } from "../utils";
 import { DBArgsWithOffset } from "../utils/commonTypes";
@@ -23,7 +23,7 @@ export class ListCommitsArgs extends DBArgsWithOffset {
 
 @Resolver(_of => Commit)
 export class CommitResolver {
-  constructor(private readonly conn: ConnectionResolver) {}
+  constructor(private readonly conn: ConnectionProvider) {}
 
   @Query(_returns => CommitList)
   async commits(

graphql-server/src/connections/connection.resolver.ts renamed to graphql-server/src/connections/connection.provider.ts

@@ -1,4 +1,4 @@
-import { Resolver } from "@nestjs/graphql";
+import { Injectable } from "@nestjs/common";
 import * as mysql from "mysql2/promise";
 import { DataSource } from "typeorm";
 import { DatabaseType } from "../databases/database.enum";
@@ -19,8 +19,8 @@ export class WorkbenchConfig {
   schema?: string; // Postgres only
 }
 
-@Resolver()
-export class ConnectionResolver {
+@Injectable()
+export class ConnectionProvider {
   private ds: DataSource | undefined;
 
   private qf: QueryFactory | undefined;