fix(server): use env vars, add fake phone home, integration tests

niledatabase · Apr 1, 2024 · 1cddfd6 · 1cddfd6
1 parent ad0d56b
commit 1cddfd6
Show file tree

Hide file tree

Showing 21 changed files with 504 additions and 1,659 deletions.
diff --git a/lib/nile/CHANGELOG.md b/lib/nile/CHANGELOG.md
diff --git a/lib/nile/package.json b/lib/nile/package.json
diff --git a/packages/server/.gitignore b/packages/server/.gitignore
@@ -1 +1,2 @@
-dist
+dist
+*.env*
diff --git a/packages/server/README.md b/packages/server/README.md
@@ -4,20 +4,59 @@ Consolidates the API and DB for working with Nile.
 
 ## Usage
 
+### With configuration object
+
 ```ts
 import Server from '@niledatabase/server';
 
 const nile = Server({
-  databaseId: String(process.env.NILE_DATABASE),
-  db: {
-    connection: {
-      user: process.env.NILE_USER,
-      password: process.env.NILE_PASSWORD,
-    },
-  },
+  user: 'username',
+  password: 'password',
 });
 
-await nile.api.createTenant({name: 'name'})
+await nile.api.createTenant({ name: 'name' })
 
 await nile.db.("todo").withTenant('tenant-id');
 ```
+
+### With env vars
+
+```bash
+NILEDB_USER=username
+NILEDB_PASSWORD=password
+```
+
+```ts
+import Server from '@niledatabase/server';
+
+const nile = Server();
+
+await nile.api.createTenant({ name: 'name' })
+
+await nile.db.("todo").withTenant('tenant-id');
+```
+
+## Phone home
+
+In addition to `user` and `password`, a fully configured SDK must also have values for `db.connection.host`, `databaseName`, and `databaseId`. If the values are not provided in either the `.env` file or the instance configuration, the SDK will automatically phone home to configure itself. For production, it is recommended to set those values.
+
+## Configuration
+
+Configuration passed to `Server` takes precedence over `.env` vars.
+
+| Property           | Type          | .env var        | Description                                                                          |
+| ------------------ | ------------- | --------------- | ------------------------------------------------------------------------------------ |
+| databaseId         | `string`      | NILEDB_ID       | ID of the database.                                                                  |
+| username           | `string`      | NILEDB_USER     | Username for database authentication.                                                |
+| password           | `string`      | NILEDB_PASSWORD | Password for database authentication.                                                |
+| databaseName       | `string`      | NILEDB_NAME     | Name of the database.                                                                |
+| tenantId           | `string`      | NILEDB_TENANT   | ID of the tenant associated.                                                         |
+| userId             | `string`      |                 | ID of the user associated.                                                           |
+| db                 | `Knex.Config` |                 | Configuration object for [knex.js](https://knexjs.org/guide/#configuration-options). |
+| db.connection.host | `string`      | NILEDB_HOST     | The host of the database. Default is `db.thenile.dev`.                               |
+| db.connection.port | `number`      | NILEDB_PORT     | The port of the database. Default is `5432`.                                         |
+| api                | `object`      |                 | Configuration object for API settings.                                               |
+| api.basePath       | `string`      | NILEDB_API      | Base host for API for a specific region. Default is `api.thenile.dev`.               |
+| api.cookieKey      | `string`      |                 | Key for API cookie. Default is `token`.                                              |
+| api.token          | `string`      | NILEDB_TOKEN    | Token for API authentication. Mostly for debugging.                                  |
+| debug              | `boolean`     |                 | Flag for enabling debug mode.                                                        |
diff --git a/packages/server/jest.config.js b/packages/server/jest.config.js
@@ -1,11 +1,9 @@
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+require('dotenv').config();
+
 module.exports = {
   preset: 'ts-jest',
   testEnvironment: 'node',
 };
 
-process.env.USER = '';
-process.env.PASSWORD = '';
-process.env.WORKSPACE = '';
-process.env.DATABASE = '';
-process.env.USER_ID = '';
 process.env.NODE_ENV = 'TEST';
diff --git a/packages/server/package.json b/packages/server/package.json
@@ -47,6 +47,7 @@
     "@apidevtools/swagger-cli": "^4.0.4",
     "@babel/core": "^7.23.3",
     "@types/jest": "^29.5.9",
+    "@types/sync-fetch": "^0",
     "@typescript-eslint/parser": "^5.62.0",
     "babel-loader": "^9.1.3",
     "dts-cli": "^2.0.3",
@@ -63,8 +64,11 @@
   },
   "dependencies": {
     "@niledatabase/js": "^2.0.0",
+    "dotenv": "^16.4.5",
+    "install": "^0.13.0",
     "jose": "^4.15.4",
     "knex": "^2.5.1",
-    "pg": "^8.11.3"
+    "pg": "^8.11.3",
+    "sync-fetch": "^0.5.2"
   }
 }
diff --git a/packages/server/src/Server.test.ts b/packages/server/src/Server.test.ts
@@ -1,17 +1,18 @@
 import Nile from './Server';
 
 describe('server', () => {
-  it('has reasonable defaults', () => {
+  fit('has reasonable defaults', () => {
     const config = {
       databaseId: 'databaseId',
+      databaseName: 'databaseName',
       username: 'username',
       password: 'password',
     };
     const server = Nile(config);
     expect(server.config.db.connection).toEqual({
       host: 'db.thenile.dev',
       port: 5432,
-      database: 'databaseId',
+      database: 'databaseName',
       user: 'username',
       password: 'password',
     });

diff --git a/packages/server/src/Server.ts b/packages/server/src/Server.ts
@@ -1,4 +1,4 @@
-import { InstanceConfig, PgConnectionConfig, ServerConfig } from './types';
+import { InstanceConfig, ServerConfig } from './types';
 import { Config } from './utils/Config';
 import Auth from './auth';
 import Users from './users';
@@ -34,7 +34,7 @@ class Server {
   private servers: Map<string, Server>;
 
   constructor(config?: ServerConfig) {
-    this.config = new Config(config);
+    this.config = new Config(config as ServerConfig, true);
     this.servers = new Map();
     const [api] = init(this.config);
     this.api = api;
@@ -43,22 +43,23 @@ class Server {
     watchTenantId((tenantId) => {
       this.tenantId = tenantId;
     });
+
     watchUserId((userId) => {
       this.userId = userId;
     });
+
     watchToken((token) => {
       this.token = token;
     });
   }
 
   setConfig(cfg: Config) {
-    this.config = new Config(cfg);
+    this.config = new Config(cfg, false);
   }
 
   set databaseId(val: string | void) {
     if (val) {
       this.config.databaseId = val;
-      (this.config.db.connection as PgConnectionConfig).database = val;
       this.api.auth.databaseId = val;
       this.api.users.databaseId = val;
       this.api.tenants.databaseId = val;
@@ -133,7 +134,7 @@ class Server {
 
     if (existing) {
       // be sure the config is up to date
-      const updatedConfig = new Config(_config);
+      const updatedConfig = new Config(_config, false);
       existing.setConfig(updatedConfig);
       // propagage special config items
       existing.tenantId = updatedConfig.tenantId;
@@ -149,8 +150,8 @@ class Server {
 }
 
 // export default Server;
-export default function Nile(config: ServerConfig) {
+export default function Nile(config?: ServerConfig) {
   const server = new Server(config);
-  server.setConfig(new Config(config as ServerConfig));
+  // server.setConfig(new Config(config as ServerConfig, false));
   return server;
 }
diff --git a/packages/server/src/auth/auth.test.ts b/packages/server/src/auth/auth.test.ts
@@ -8,7 +8,9 @@ const baseConfig = [
   'api',
   'createProvider',
   'databaseId',
+  'databaseName',
   'db',
+  'debug',
   'getSSOCallbackUrl',
   'listProviders',
   'listTenantProviders',

diff --git a/packages/server/src/db/db.test.ts b/packages/server/src/db/db.test.ts
@@ -5,8 +5,10 @@ describe('db', () => {
   it('has expected properties', () => {
     const db = new NileDB({
       databaseId: 'databaseId',
+      databaseName: 'databaseName',
       username: 'username',
       password: 'password',
+      debug: false,
       db: {
         connection: { port: 4433 },
       },

diff --git a/packages/server/src/tenants/tenants.test.ts b/packages/server/src/tenants/tenants.test.ts
@@ -9,7 +9,9 @@ const baseConfig = [
   'createTenant',
   'getTenant',
   'db',
+  'debug',
   'databaseId',
+  'databaseName',
   'username',
   'password',
 ];

diff --git a/packages/server/src/types.ts b/packages/server/src/types.ts
@@ -12,11 +12,13 @@ export type Opts = {
 };
 
 export type ServerConfig = {
-  databaseId: string;
-  username: string;
-  password: string;
+  databaseId?: string;
+  username?: string;
+  password?: string;
+  databaseName?: string;
   tenantId?: string | null | undefined;
   userId?: string | null | undefined;
+  debug?: boolean;
   db?: Knex.Config;
   api?: {
     basePath?: string;
@@ -31,6 +33,7 @@ export type InstanceConfig = {
   password: string;
   tenantId?: string | null | undefined;
   userId?: string | null | undefined;
+  debug?: boolean;
   db?: Knex.Config;
   api?: {
     basePath?: string;

diff --git a/packages/server/src/users/users.test.ts b/packages/server/src/users/users.test.ts
@@ -12,6 +12,8 @@ const baseConfig = [
   'listTenantUsers',
   'listUsers',
   'me',
+  'databaseName',
+  'debug',
   'updateUser',
   'username',
   'password',