fix(config): don't allow nodeEnv in file + fix save to file

- save to file should now work and save to file one time (even if it's in a env.json file)
- removed nodeEnv from env.json schema because it's weird :-)

Author: thatkookooguy

env.schema.json

@@ -1 +1 @@
-{"properties":{"nodeEnv":{"description":"Tells which env file to use","type":"string","enum":["development","production","test","devcontainer"]},"port":{"description":"Set server port","type":"number"},"dbUrl":{"description":"DB connection URL. Expects a mongodb db for connections","format":"url","type":"string"},"webhookProxyUrl":{"description":"Used to create a custom repeatable smee webhook url instead of Generating a random one","format":"url","type":"string","pattern":"^https:\\/\\/(?:www\\.)?smee\\.io\\/[a-zA-Z0-9_-]+\\/?"},"webhookDestinationUrl":{"description":"proxy should sent events to this url for achievibit","pattern":"^([\\w]+)?(\\/[\\w-]+)*$","type":"string"},"saveToFile":{"description":"Create a file made out of the internal config. This is mostly for merging command line, environment, and file variables to a single instance","type":"boolean"}},"type":"object","required":["nodeEnv","port","webhookProxyUrl","webhookDestinationUrl","saveToFile"]}
+{"properties":{"port":{"description":"Set server port","type":"number"},"dbUrl":{"description":"DB connection URL. Expects a mongodb db for connections","format":"url","type":"string"},"webhookProxyUrl":{"description":"Used to create a custom repeatable smee webhook url instead of Generating a random one","format":"url","type":"string","pattern":"^https:\\/\\/(?:www\\.)?smee\\.io\\/[a-zA-Z0-9_-]+\\/?"},"webhookDestinationUrl":{"description":"proxy should sent events to this url for achievibit","pattern":"^([\\w]+)?(\\/[\\w-]+)*$","type":"string"},"saveToFile":{"description":"Create a file made out of the internal config. This is mostly for merging command line, environment, and file variables to a single instance","type":"boolean"}},"type":"object","required":["port","webhookProxyUrl","webhookDestinationUrl","saveToFile"]}

server/src/config/achievibit-config.model.ts

@@ -91,6 +91,14 @@ export class AchievibitConfig {
       }
     }).AchievibitConfig;
 
+    delete configJsonSchema.properties.nodeEnv;
+    configJsonSchema.required.splice(
+      configJsonSchema.required.indexOf('nodeEnv'),
+      1
+    );
+
+    // console.log(configJsonSchema);
+
     return configJsonSchema;
   }
 }

server/src/config/config.service.spec.ts

@@ -21,41 +21,31 @@ describe('ConfigService', () => {
       });
     });
 
-    afterEach(async (done) => {
+    afterEach(() => {
       configService.closeEvents();
-
-      done();
     });
 
-    it('should be defined', async (done) => {
+    it('should be defined', () => {
       expect(configService).toBeDefined();
-
-      done();
     });
 
     it('should return the same instance if initiated without an input',
-    async (done) => {
+    () => {
       expect(new ConfigService()).toBe(configService);
-
-      done();
     });
 
-    it('should create a new instance when passed an override', async (done) => {
+    it('should create a new instance when passed an override', () => {
       expect(new ConfigService({} as AchievibitConfig)).not.toBe(configService);
-
-      done();
     });
 
     it('should set default values to everything that needs one',
-    async (done) => {
+    () => {
       expect(configService.toPlainObject()).toMatchSnapshot();
-
-      done();
     });
   });
 
   describe('Smee & Events', () => {
-    it('should NOT initial smee and events on production', async (done) => {
+    it('should NOT initial smee and events on production', () => {
       const productionService = new ConfigService({
         nodeEnv: 'production'
       });
@@ -64,11 +54,9 @@ describe('ConfigService', () => {
       expect(productionService.events).toBeUndefined();
 
       productionService.closeEvents();
-
-      done();
     });
 
-    it('should initial smee and events on development', async (done) => {
+    it('should initial smee and events on development', () => {
       const productionService = new ConfigService({
         nodeEnv: 'development'
       });
@@ -77,8 +65,6 @@ describe('ConfigService', () => {
       expect(productionService.events).toBeDefined();
 
       productionService.closeEvents();
-
-      done();
     });
   });
 
@@ -91,19 +77,17 @@ describe('ConfigService', () => {
 
       chain(NODE_ENVIRONMENT_OPTIONS)
         .forEach((nodeEnv: string) => {
-          it(`should ACCEPT ${ nodeEnv }`, async (done) => {
+          it(`should ACCEPT ${ nodeEnv }`, () => {
             const serviceWrapper = () => new ConfigService({ nodeEnv });
 
             expect(serviceWrapper().toPlainObject).toBeDefined();
 
             serviceWrapper().closeEvents();
-
-            done();
           });
         })
         .value();
 
-      it('should REJECT other values', async (done) => {
+      it('should REJECT other values', () => {
 
         const nodeEnv = 'value_not_allowed';
 
@@ -119,23 +103,19 @@ describe('ConfigService', () => {
 
         expect(wrongEnvType).toThrowError(ConfigValidationError);
         expect(wrongEnvType).toThrowErrorMatchingSnapshot();
-
-        done();
       });
 
     });
 
     describe('port', () => {
-      it('should ACCEPT numbers', async (done) => {
+      it('should ACCEPT numbers', () => {
         const port = DtoMockGenerator.integer();
         const service = new ConfigService({ port });
 
         expect(service.port).toBe(port);
-
-        done();
       });
 
-      it('should REJECT values other than numbers', async (done) => {
+      it('should REJECT values other than numbers', () => {
         const stringPort = () => new (ConfigService as any)({ port: 'hello' });
         const ObjectPort = () => new (ConfigService as any)({ port: {} });
 
@@ -144,34 +124,28 @@ describe('ConfigService', () => {
 
         expect(ObjectPort).toThrowError(ConfigValidationError);
         expect(ObjectPort).toThrowErrorMatchingSnapshot();
-
-        done();
       });
 
     });
 
     describe('dbUrl', () => {
-      it('should ACCEPT empty value', async (done) => {
+      it('should ACCEPT empty value', () => {
         const service = new ConfigService({ dbUrl: undefined });
 
         expect(service.dbUrl).toBeUndefined();
 
         service.closeEvents();
-
-        done();
       });
 
-      it('should ACCEPT localhost mongodb URL', async (done) => {
+      it('should ACCEPT localhost mongodb URL', () => {
         const localMongodbUrl = 'mongodb://localhost:27017';
 
         const configService = new ConfigService({ dbUrl: localMongodbUrl });
 
         expect(configService.dbUrl).toBe(localMongodbUrl);
-
-        done();
       });
 
-      it('should ACCEPT valid mongodb URLS', async (done) => {
+      it('should ACCEPT valid mongodb URLS', () => {
         const mongodbProtocolUrls =
           times(10, () => DtoMockGenerator.mongodbUrl());
 
@@ -182,28 +156,22 @@ describe('ConfigService', () => {
             expect(configService.dbUrl).toBe(mongodbUrl);
           })
           .value();
-
-        done();
       });
 
-      it('should REJECT non-mongodb URLS', async (done) => {
+      it('should REJECT non-mongodb URLS', () => {
         const invalidUrl =
           () => new ConfigService({ dbUrl: 'https://google.com/' });
 
         expect(invalidUrl).toThrowError(ConfigValidationError);
         expect(invalidUrl).toThrowErrorMatchingSnapshot();
-
-        done();
       });
     });
 
     describe('webhookProxyUrl', () => {
-      it('should ACCEPT smee.io URLS', async (done) => {
+      it('should ACCEPT smee.io URLS', () => {
         const smeeProtocolUrls =
           times(10, () => DtoMockGenerator.randexp(SMEE_IO_REGEX).gen());
 
-        console.log(smeeProtocolUrls);
-
         chain(smeeProtocolUrls)
           .keyBy()
           .mapValues((smeeProtocolUrl) => new ConfigService({
@@ -214,28 +182,22 @@ describe('ConfigService', () => {
             expect(configService.webhookProxyUrl).toBe(smeeProtocolUrl);
           })
           .value();
-
-        done();
       });
 
-      it('should REJECT non-smee URLS', async (done) => {
+      it('should REJECT non-smee URLS', () => {
         const invalidUrl =
           () => new ConfigService({ webhookProxyUrl: 'https://google.com/' });
 
         expect(invalidUrl).toThrowError(ConfigValidationError);
         expect(invalidUrl).toThrowErrorMatchingSnapshot();
-
-        done();
       });
 
-      it('should REJECT non-URLS', async (done) => {
+      it('should REJECT non-URLS', () => {
         const invalidUrl =
           () => new ConfigService({ webhookProxyUrl: 'hello world' });
 
         expect(invalidUrl).toThrowError(ConfigValidationError);
         expect(invalidUrl).toThrowErrorMatchingSnapshot();
-
-        done();
       });
     });
   });

server/src/config/config.service.ts

@@ -113,7 +113,7 @@ export class ConfigService extends AchievibitConfig {
       events = undefined;
     }
 
-    if (this.saveToFile) {
+    if (config.saveToFile) {
       writeJson(configFilePath, classToPlain(this), { spaces: 2 });
     }