Merge pull request #1527 from wwelling/1522-preboot-config

[Issue 1522] Afford disable preboot for production

README.md

@@ -101,7 +101,7 @@ Installing
 
 ### Configuring
 
-Default configuration file is located in `config/` folder.
+Default runtime configuration file is located in `config/` folder. These configurations can be changed without rebuilding the distribution.
 
 To override the default configuration values, create local files that override the parameters you need to change. You can use `config.example.yml` as a starting point.
 
@@ -167,6 +167,22 @@ These configuration sources are collected **at run time**, and written to `dist/
 
 The configuration file can be externalized by using environment variable `DSPACE_APP_CONFIG_PATH`.
 
+#### Buildtime Configuring
+
+Buildtime configuration must defined before build in order to include in transpiled JavaScript. This is primarily for the server. These settings can be found under `src/environment/` folder.
+
+To override the default configuration values for development, create local file that override the build time parameters you need to change.
+
+-	Create a new `environment.(dev or development).ts` file in `src/environment/` for a `development` environment;
+
+If needing to update default configurations values for production, update local file that override the build time parameters you need to change.
+
+-	Update `environment.production.ts` file in `src/environment/` for a `production` environment;
+
+The environment object is provided for use as import in code and is extended with he runtime configuration on bootstrap of the application.
+
+> Take caution moving runtime configs into the buildtime configuration. They will be overwritten by what is defined in the runtime config on bootstrap.
+
 #### Using environment variables in code
 To use environment variables in a UI component, use:
 
@@ -183,7 +199,6 @@ or
 import { environment } from '../environment.ts';
 ```
 
-
 Running the app
 ---------------
 

src/config/app-config.interface.ts

@@ -3,7 +3,6 @@ import { makeStateKey } from '@angular/platform-browser';
 import { Config } from './config.interface';
 import { ServerConfig } from './server-config.interface';
 import { CacheConfig } from './cache-config.interface';
-import { UniversalConfig } from './universal-config.interface';
 import { INotificationBoardOptions } from './notifications-config.interfaces';
 import { SubmissionConfig } from './submission-config.interface';
 import { FormConfig } from './form-config.interfaces';
@@ -25,7 +24,6 @@ interface AppConfig extends Config {
   form: FormConfig;
   notifications: INotificationBoardOptions;
   submission: SubmissionConfig;
-  universal: UniversalConfig;
   debug: boolean;
   defaultLanguage: string;
   languages: LangConfig[];

src/config/build-config.interface.ts

@@ -0,0 +1,6 @@
+import { AppConfig } from './app-config.interface';
+import { UniversalConfig } from './universal-config.interface';
+
+export interface BuildConfig extends AppConfig {
+  universal: UniversalConfig;
+}

src/config/default-app-config.ts

@@ -14,18 +14,10 @@ import { ServerConfig } from './server-config.interface';
 import { SubmissionConfig } from './submission-config.interface';
 import { ThemeConfig } from './theme.model';
 import { UIServerConfig } from './ui-server-config.interface';
-import { UniversalConfig } from './universal-config.interface';
 
 export class DefaultAppConfig implements AppConfig {
   production = false;
 
-  // Angular Universal settings
-  universal: UniversalConfig = {
-    preboot: true,
-    async: true,
-    time: false
-  };
-
   // NOTE: will log all redux actions and transfers in console
   debug = false;
 

src/environments/.gitignore

@@ -0,0 +1,5 @@
+environment.*.ts
+
+!environment.production.ts
+!environment.test.ts
+!environment.ts

src/environments/environment.production.ts

@@ -1,6 +1,6 @@
-import { AppConfig } from '../config/app-config.interface';
+import { BuildConfig } from '../config/build-config.interface';
 
-export const environment: Partial<AppConfig> = {
+export const environment: Partial<BuildConfig> = {
   production: true,
 
   // Angular Universal settings

src/environments/environment.test.ts

@@ -1,9 +1,9 @@
 // This configuration is only used for unit tests, end-to-end tests use environment.production.ts
+import { BuildConfig } from 'src/config/build-config.interface';
 import { RestRequestMethod } from '../app/core/data/rest-request-method';
 import { NotificationAnimationsType } from '../app/shared/notifications/models/notification-animations-type';
-import { AppConfig } from '../config/app-config.interface';
 
-export const environment: AppConfig = {
+export const environment: BuildConfig = {
   production: false,
 
   // Angular Universal settings

src/environments/environment.ts

@@ -3,9 +3,9 @@
 // `ng test --configuration test` replaces `environment.ts` with `environment.test.ts`.
 // The list of file replacements can be found in `angular.json`.
 
-import { AppConfig } from '../config/app-config.interface';
+import { BuildConfig } from '../config/build-config.interface';
 
-export const environment: Partial<AppConfig> = {
+export const environment: Partial<BuildConfig> = {
   production: false,
 
   // Angular Universal settings

src/main.browser.ts

@@ -30,7 +30,9 @@ const main = () => {
 
   if (environment.production) {
     enableProdMode();
+  }
 
+  if (hasValue(environment.universal) && environment.universal.preboot) {
     return bootstrap();
   } else {
 
@@ -47,7 +49,7 @@ const main = () => {
 };
 
 // support async tag or hmr
-if (hasValue(environment.universal) && environment.universal.preboot === false) {
+if (hasValue(environment.universal) && !environment.universal.preboot) {
   main();
 } else {
   document.addEventListener('DOMContentLoaded', main);