Merge pull request #53 from dolthub/taylor/save-db

Save connections

.dockerignore

@@ -26,4 +26,5 @@ images/
 **/*.test.tsx
 
 **/.yarn/cache
-**/.yarn/install-state.gz
+**/.yarn/install-state.gz
+**/store

Dockerfile

@@ -6,6 +6,8 @@ FROM --platform=linux/amd64 node:18.13.0-alpine3.17 as graphql-base
 FROM graphql-base AS graphql-deps
 WORKDIR /app/graphql-server
 
+VOLUME /app/graphql-server/store
+
 # Copy the package.json and yarn files
 COPY --chown=node:node graphql-server/.yarn ./.yarn
 COPY --chown=node:node graphql-server/yarn.lock graphql-server/package.json graphql-server/.yarnrc.yml ./

README.md

@@ -104,6 +104,15 @@ Navigate to http://localhost:3000 to enter your database information.
 You can find more in-depth instructions on
 [DockerHub](https://hub.docker.com/r/dolthub/dolt-workbench).
 
+### Saving connection information between runs
+
+If you want to save connection information between Docker runs, you can mount a local
+directory to the `store` directory in `/app/graphql-server` in the container.
+
+```
+% docker run -p 9002:9002 -p 3000:3000 -v ~/path/to/store:/app/graphql-server/store dolthub/dolt-workbench:latest
+```
+
 ## Getting started from source
 
 First, clone this repository.

graphql-server/.gitignore

@@ -45,3 +45,4 @@ lerna-debug.log*
 !.yarn/sdks
 !.yarn/versions
 node_modules
+store

graphql-server/schema.gql

@@ -94,6 +94,13 @@ type CommitList {
   list: [Commit!]!
 }
 
+type DatabaseConnection {
+  connectionUrl: String!
+  name: String!
+  hideDoltFeatures: Boolean
+  useSSL: Boolean
+}
+
 type DoltDatabaseDetails {
   isDolt: Boolean!
   hideDoltFeatures: Boolean!
@@ -266,7 +273,7 @@ type Query {
   defaultBranch(databaseName: String!): Branch
   commits(offset: Int, databaseName: String!, refName: String, afterCommitId: String, twoDot: Boolean, excludingCommitsFromRefName: String): CommitList!
   currentDatabase: String
-  hasDatabaseEnv: Boolean!
+  storedConnections: [DatabaseConnection!]!
   databases: [String!]!
   doltDatabaseDetails: DoltDatabaseDetails!
   diffStat(databaseName: String!, fromRefName: String!, toRefName: String!, refName: String, type: CommitDiffType, tableName: String): DiffStat!
@@ -317,7 +324,8 @@ enum DiffRowType {
 type Mutation {
   createBranch(databaseName: String!, newBranchName: String!, fromRefName: String!): Branch!
   deleteBranch(databaseName: String!, branchName: String!): Boolean!
-  addDatabaseConnection(url: String, useEnv: Boolean, hideDoltFeatures: Boolean, useSSL: Boolean): String
+  addDatabaseConnection(connectionUrl: String!, name: String!, hideDoltFeatures: Boolean, useSSL: Boolean): String
+  removeDatabaseConnection(name: String!): Boolean!
   createDatabase(databaseName: String!): Boolean!
   resetDatabase: Boolean!
   loadDataFile(tableName: String!, refName: String!, databaseName: String!, importOp: ImportOperation!, fileType: FileType!, file: Upload!, modifier: LoadDataModifier): Boolean!

graphql-server/src/app.module.ts

@@ -1,20 +1,20 @@
 import { ApolloDriver, ApolloDriverConfig } from "@nestjs/apollo";
 import { Module } from "@nestjs/common";
-import { ConfigModule } from "@nestjs/config";
 import { GraphQLModule } from "@nestjs/graphql";
 import { TerminusModule } from "@nestjs/terminus";
 import { DataSourceModule } from "./dataSources/dataSource.module";
+import { FileStoreModule } from "./fileStore/fileStore.module";
 import resolvers from "./resolvers";
 
 @Module({
   imports: [
-    ConfigModule.forRoot({ envFilePath: ".development.env" }),
     GraphQLModule.forRoot<ApolloDriverConfig>({
       autoSchemaFile: "schema.gql",
       context: ctx => ctx,
       driver: ApolloDriver,
     }),
     DataSourceModule,
+    FileStoreModule,
     TerminusModule,
   ],
   providers: resolvers,

graphql-server/src/databases/database.model.ts

@@ -0,0 +1,16 @@
+import { Field, ObjectType } from "@nestjs/graphql";
+
+@ObjectType()
+export class DatabaseConnection {
+  @Field()
+  connectionUrl: string;
+
+  @Field()
+  name: string;
+
+  @Field({ nullable: true })
+  hideDoltFeatures?: boolean;
+
+  @Field({ nullable: true })
+  useSSL?: boolean;
+}

graphql-server/src/databases/database.resolver.ts

@@ -1,4 +1,3 @@
-import { ConfigService } from "@nestjs/config";
 import {
   Args,
   ArgsType,
@@ -9,15 +8,17 @@ import {
   Resolver,
 } from "@nestjs/graphql";
 import { DataSourceService } from "../dataSources/dataSource.service";
+import { FileStoreService } from "../fileStore/fileStore.service";
 import { DBArgs } from "../utils/commonTypes";
+import { DatabaseConnection } from "./database.model";
 
 @ArgsType()
 class AddDatabaseConnectionArgs {
-  @Field({ nullable: true })
-  url?: string;
+  @Field()
+  connectionUrl: string;
 
-  @Field({ nullable: true })
-  useEnv?: boolean;
+  @Field()
+  name: string;
 
   @Field({ nullable: true })
   hideDoltFeatures?: boolean;
@@ -35,11 +36,17 @@ class DoltDatabaseDetails {
   hideDoltFeatures: boolean;
 }
 
-@Resolver()
+@ArgsType()
+class RemoveDatabaseConnectionArgs {
+  @Field()
+  name: string;
+}
+
+@Resolver(_of => DatabaseConnection)
 export class DatabaseResolver {
   constructor(
     private readonly dss: DataSourceService,
-    private readonly configService: ConfigService,
+    private readonly fileStoreService: FileStoreService,
   ) {}
 
   @Query(_returns => String, { nullable: true })
@@ -53,9 +60,9 @@ export class DatabaseResolver {
     }
   }
 
-  @Query(_returns => Boolean)
-  async hasDatabaseEnv(): Promise<boolean> {
-    return !!this.configService.get("DATABASE_URL");
+  @Query(_returns => [DatabaseConnection])
+  async storedConnections(): Promise<DatabaseConnection[]> {
+    return this.fileStoreService.getStore();
   }
 
   @Query(_returns => [String])
@@ -93,31 +100,31 @@ export class DatabaseResolver {
   async addDatabaseConnection(
     @Args() args: AddDatabaseConnectionArgs,
   ): Promise<string | undefined> {
-    if (args.useEnv) {
-      const url = this.configService.get("DATABASE_URL");
-      if (!url) throw new Error("DATABASE_URL not found in env");
-      const hideDoltFeatures = this.configService.get("HIDE_DOLT_FEATURES");
-      const useSSL = this.configService.get("USE_SSL");
-      await this.dss.addDS({
-        connectionUrl: url,
-        hideDoltFeatures: !!hideDoltFeatures && hideDoltFeatures === "true",
-        useSSL: useSSL !== undefined ? useSSL === "true" : true,
-      });
-    } else if (args.url) {
-      await this.dss.addDS({
-        connectionUrl: args.url,
-        hideDoltFeatures: !!args.hideDoltFeatures,
-        useSSL: !!args.useSSL,
-      });
-    } else {
-      throw new Error("database url not provided");
-    }
+    const workbenchConfig = {
+      connectionUrl: args.connectionUrl,
+      hideDoltFeatures: !!args.hideDoltFeatures,
+      useSSL: !!args.useSSL,
+    };
+    await this.dss.addDS(workbenchConfig);
+
+    this.fileStoreService.addItemToStore({
+      ...workbenchConfig,
+      name: args.name,
+    });
 
     const db = await this.currentDatabase();
     if (!db) return undefined;
     return db;
   }
 
+  @Mutation(_returns => Boolean)
+  async removeDatabaseConnection(
+    @Args() args: RemoveDatabaseConnectionArgs,
+  ): Promise<boolean> {
+    this.fileStoreService.removeItemFromStore(args.name);
+    return true;
+  }
+
   @Mutation(_returns => Boolean)
   async createDatabase(@Args() args: DBArgs): Promise<boolean> {
     const qr = this.dss.getQR();

graphql-server/src/fileStore/fileStore.module.ts

@@ -0,0 +1,5 @@
+import { Module } from "@nestjs/common";
+import { FileStoreService } from "./fileStore.service";
+
+@Module({ providers: [FileStoreService], exports: [FileStoreService] })
+export class FileStoreModule {}