Improve Embedded DB UX (#31)

Author: parkerduckworth

src/embedded/index.ts

@@ -24,12 +24,10 @@ export class EmbeddedOptions {
   persistenceDataPath: string;
   host: string;
   port: number;
-  clusterHostname: string;
   version: string;
   env: NodeJS.ProcessEnv;
 
   constructor(cfg?: EmbeddedOptionsConfig) {
-    this.clusterHostname = 'embedded';
     this.host = (cfg && cfg.host) || '127.0.0.1';
     this.port = (cfg && cfg.port) || 6666;
     this.version = this.parseVersion(cfg);
@@ -44,15 +42,16 @@ export class EmbeddedOptions {
     }
 
     const env: NodeJS.ProcessEnv = {
-      ...process.env,
       AUTHENTICATION_ANONYMOUS_ACCESS_ENABLED: 'true',
       QUERY_DEFAULTS_LIMIT: '20',
       PERSISTENCE_DATA_PATH: this.persistenceDataPath,
-      CLUSTER_HOSTNAME: this.clusterHostname,
+      CLUSTER_HOSTNAME: `Embedded_at_${this.port}`,
       DEFAULT_VECTORIZER_MODULE: 'none',
       ENABLE_MODULES:
         'text2vec-openai,text2vec-cohere,text2vec-huggingface,' +
         'ref2vec-centroid,generative-openai,qna-openai',
+      // Any above defaults can be overridden with export env vars
+      ...process.env,
     };
 
     if (cfg && cfg.env) {

src/embedded/journey.test.ts

@@ -12,7 +12,7 @@ describe('embedded', () => {
     expect(opt.persistenceDataPath).toEqual(join(homedir(), '.local/share/weaviate'));
     expect(opt.host).toEqual('127.0.0.1');
     expect(opt.port).toEqual(6666);
-    expect(opt.clusterHostname).toEqual('embedded');
+    expect(opt.env).toHaveProperty('CLUSTER_HOSTNAME', 'Embedded_at_6666');
   });
 
   it('creates EmbeddedOptions with custom options', () => {
@@ -33,10 +33,17 @@ describe('embedded', () => {
     expect(opt.env).toHaveProperty('ENABLE_MODULES', 'text2vec-contextionary');
     expect(opt.env).toHaveProperty('CONTEXTIONARY_URL', 'contextionary:9999');
     expect(opt.env).toHaveProperty('QUERY_DEFAULTS_LIMIT', 100);
+    expect(opt.env).toHaveProperty('CLUSTER_HOSTNAME', 'Embedded_at_7777');
     expect(opt.host).toEqual('somehost.com');
     expect(opt.port).toEqual(7777);
   });
 
+  it('overrides default env vars with inherited exported ones', () => {
+    process.env.CLUSTER_HOSTNAME = 'custom-hostname';
+    const opt = new EmbeddedOptions();
+    expect(opt.env).toHaveProperty('CLUSTER_HOSTNAME', 'custom-hostname');
+  });
+
   it('failed to create EmbeddedOptions with invalid version', () => {
     return expect(() => {
       const opt = new EmbeddedOptions({