Merge pull request #179 from launchcodedev/do-not-load-config

joelgallant · web-flow · commit 7c672f3ba627 · 2022-01-01T11:45:13.000-07:00
Adds a doNotLoadConfig option in bundler packages
diff --git a/app-config-esbuild/package.json b/app-config-esbuild/package.json
@@ -31,6 +31,7 @@
   },
   "dependencies": {
     "@app-config/config": "^2.8.2",
+    "@app-config/schema": "^2.8.2",
     "@app-config/utils": "^2.8.2"
   },
   "devDependencies": {
diff --git a/app-config-esbuild/src/__snapshots__/index.test.ts.snap b/app-config-esbuild/src/__snapshots__/index.test.ts.snap
@@ -14,3 +14,13 @@ exports[`loads validation function 1`] = `
 "(()=>{var n=(typeof window==\\"undefined\\"?globalThis:window)||{},v={foo:\\"bar\\"},m=n._appConfig||v;(typeof n._appConfig==\\"undefined\\"||!Object.isFrozen(n._appConfig))&&(n._appConfig=m);function P(){let p={};return function(s){\\"use strict\\";s.exports=i,s.exports.default=i;var b={type:\\"object\\",additionalProperties:!1,properties:{foo:{type:\\"string\\"}},$schema:\\"http://json-schema.org/draft-07/schema#\\"};function i(o,t){\\"use strict\\";if(t)var a=t.dataPath,g=t.parentData,h=t.parentDataProperty,y=t.rootData;else var a=\\"\\",g=void 0,h=void 0,y=o;var e=null,r=0;if(o&&typeof o==\\"object\\"&&!Array.isArray(o)){for(var f in o)if(f!==\\"foo\\"){var d={keyword:\\"additionalProperties\\",dataPath:a,schemaPath:\\"#/additionalProperties\\",params:{additionalProperty:f},message:\\"should NOT have additional properties\\"};e===null?e=[d]:e.push(d),r++}if(o.foo!==void 0&&typeof o.foo!=\\"string\\"){var l={keyword:\\"type\\",dataPath:a+\\"/foo\\",schemaPath:\\"#/properties/foo/type\\",params:{type:\\"string\\"},message:\\"should be string\\"};e===null?e=[l]:e.push(l),r++}}else{var c={keyword:\\"type\\",dataPath:a,schemaPath:\\"#/type\\",params:{type:\\"object\\"},message:\\"should be object\\"};e===null?e=[c]:e.push(c),r++}return i.errors=e,r===0}}(p),p.exports}var u=P();u({foo:12});})();
 "
 `;
+
+exports[`loads with noBundledConfig 1`] = `
+"(()=>{var v=(typeof window==\\"undefined\\"?globalThis:window)||{},i=v._appConfig;if(typeof i==\\"undefined\\")throw new Error(\\"Config is not loaded in _appConfig\\");function m(){let s={};return function(p){\\"use strict\\";p.exports=n,p.exports.default=n;var P={type:\\"object\\",additionalProperties:!1,properties:{foo:{type:\\"string\\"}},$schema:\\"http://json-schema.org/draft-07/schema#\\"};function n(o,t){\\"use strict\\";if(t)var r=t.dataPath,h=t.parentData,g=t.parentDataProperty,y=t.rootData;else var r=\\"\\",h=void 0,g=void 0,y=o;var e=null,a=0;if(o&&typeof o==\\"object\\"&&!Array.isArray(o)){for(var f in o)if(f!==\\"foo\\"){var d={keyword:\\"additionalProperties\\",dataPath:r,schemaPath:\\"#/additionalProperties\\",params:{additionalProperty:f},message:\\"should NOT have additional properties\\"};e===null?e=[d]:e.push(d),a++}if(o.foo!==void 0&&typeof o.foo!=\\"string\\"){var l={keyword:\\"type\\",dataPath:r+\\"/foo\\",schemaPath:\\"#/properties/foo/type\\",params:{type:\\"string\\"},message:\\"should be string\\"};e===null?e=[l]:e.push(l),a++}}else{var u={keyword:\\"type\\",dataPath:r,schemaPath:\\"#/type\\",params:{type:\\"object\\"},message:\\"should be object\\"};e===null?e=[u]:e.push(u),a++}return n.errors=e,a===0}}(s),s.exports}var c=m();c(i);})();
+"
+`;
+
+exports[`loads with noBundledConfig and no validation function 1`] = `
+"(()=>{var o=(typeof window==\\"undefined\\"?globalThis:window)||{},n=o._appConfig;if(typeof n==\\"undefined\\")throw new Error(\\"Config is not loaded in _appConfig\\");console.log(n);})();
+"
+`;
diff --git a/app-config-esbuild/src/index.test.ts b/app-config-esbuild/src/index.test.ts
@@ -121,3 +121,67 @@ it('loads currentEnvironment', () =>
       expect(res.outputFiles[0].text).toMatchSnapshot();
     },
   ));
+
+it('loads with noBundledConfig', () =>
+  withTempFiles(
+    {
+      '.app-config.schema.yml': `
+        type: object
+        additionalProperties: false
+        properties:
+          foo: { type: string }
+      `,
+      'a.js': `
+        import { config, validateConfig } from '@app-config/main';
+
+        validateConfig(config);
+      `,
+    },
+    async (inDir) => {
+      const res = await build({
+        entryPoints: [inDir('a.js')],
+        plugins: [
+          createPlugin({ schemaLoadingOptions: { directory: inDir('.') }, noBundledConfig: true }),
+        ],
+        bundle: true,
+        minify: true,
+        write: false,
+      });
+
+      expect(res.outputFiles[0].text).toMatchSnapshot();
+    },
+  ));
+
+it('loads with noBundledConfig and no validation function', () =>
+  withTempFiles(
+    {
+      '.app-config.schema.yml': `
+        type: object
+        additionalProperties: false
+        properties:
+          foo: { type: string }
+      `,
+      'a.js': `
+        import { config } from '@app-config/main';
+
+        console.log(config);
+      `,
+    },
+    async (inDir) => {
+      const res = await build({
+        entryPoints: [inDir('a.js')],
+        plugins: [
+          createPlugin({
+            schemaLoadingOptions: { directory: inDir('.') },
+            noBundledConfig: true,
+            injectValidationFunction: false,
+          }),
+        ],
+        bundle: true,
+        minify: true,
+        write: false,
+      });
+
+      expect(res.outputFiles[0].text).toMatchSnapshot();
+    },
+  ));
diff --git a/app-config-esbuild/src/index.ts b/app-config-esbuild/src/index.ts
@@ -2,20 +2,22 @@ import type { Plugin } from 'esbuild';
 import path from 'path';
 import { ConfigLoadingOptions, loadValidatedConfig } from '@app-config/config';
 import { appConfigImportRegex, generateModuleText, packageNameRegex } from '@app-config/utils';
-import type { SchemaLoadingOptions } from '@app-config/schema';
+import { loadSchema, SchemaLoadingOptions } from '@app-config/schema';
 
 export interface Options {
   useGlobalNamespace?: boolean;
   loadingOptions?: ConfigLoadingOptions;
   schemaLoadingOptions?: SchemaLoadingOptions;
   injectValidationFunction?: boolean;
+  noBundledConfig?: boolean;
 }
 
 export const createPlugin = ({
   useGlobalNamespace = true,
   loadingOptions,
   schemaLoadingOptions,
   injectValidationFunction = true,
+  noBundledConfig = false,
 }: Options = {}): Plugin => ({
   name: '@app-config/esbuild',
   setup(build) {
@@ -30,6 +32,24 @@ export const createPlugin = ({
     }));
 
     build.onLoad({ filter: /.*/, namespace: '@app-config/esbuild' }, async () => {
+      if (noBundledConfig) {
+        const { validationFunctionCode } = await loadSchema(schemaLoadingOptions);
+
+        const code = generateModuleText(undefined, {
+          environment: undefined,
+          useGlobalNamespace: true,
+          validationFunctionCode: injectValidationFunction ? validationFunctionCode : undefined,
+          esmValidationCode: true,
+        });
+
+        return {
+          loader: 'js',
+          contents: code,
+          resolveDir: path.parse(process.cwd()).root,
+          watchFiles: [],
+        };
+      }
+
       const { fullConfig, environment, validationFunctionCode, filePaths } =
         await loadValidatedConfig(loadingOptions, schemaLoadingOptions);
 
diff --git a/app-config-esbuild/tsconfig.json b/app-config-esbuild/tsconfig.json
@@ -8,6 +8,7 @@
   "exclude": ["node_modules"],
   "references": [
     { "path": "../app-config-config" },
+    { "path": "../app-config-schema" },
     { "path": "../app-config-node" },
     { "path": "../app-config-utils" },
     { "path": "../app-config-test-utils" }
diff --git a/app-config-rollup/package.json b/app-config-rollup/package.json
@@ -35,6 +35,7 @@
   },
   "dependencies": {
     "@app-config/config": "^2.8.2",
+    "@app-config/schema": "^2.8.2",
     "@app-config/utils": "^2.8.2"
   },
   "peerDependencies": {},
diff --git a/app-config-rollup/src/index.ts b/app-config-rollup/src/index.ts
@@ -1,13 +1,14 @@
 import type { Plugin } from 'rollup';
 import { appConfigImportRegex, generateModuleText, packageNameRegex } from '@app-config/utils';
 import { ConfigLoadingOptions, loadValidatedConfig } from '@app-config/config';
-import type { SchemaLoadingOptions } from '@app-config/schema';
+import { loadSchema, SchemaLoadingOptions } from '@app-config/schema';
 
 export interface Options {
   useGlobalNamespace?: boolean;
   loadingOptions?: ConfigLoadingOptions;
   schemaLoadingOptions?: SchemaLoadingOptions;
   injectValidationFunction?: boolean;
+  noBundledConfig?: boolean;
 
   /** @deprecated use useGlobalNamespace instead */
   readGlobal?: boolean;
@@ -48,11 +49,23 @@ async function loadConfig(
     loadingOptions,
     schemaLoadingOptions,
     injectValidationFunction = true,
+    noBundledConfig,
     useGlobalNamespace,
     readGlobal,
   }: Options,
   currentFilePaths: string[],
 ) {
+  if (noBundledConfig) {
+    const { validationFunctionCode } = await loadSchema(schemaLoadingOptions);
+
+    return generateModuleText(undefined, {
+      environment: undefined,
+      useGlobalNamespace: true,
+      validationFunctionCode: injectValidationFunction ? validationFunctionCode : undefined,
+      esmValidationCode: true,
+    });
+  }
+
   const { fullConfig, environment, validationFunctionCode, filePaths } = await loadValidatedConfig(
     loadingOptions,
     schemaLoadingOptions,
diff --git a/app-config-rollup/tsconfig.json b/app-config-rollup/tsconfig.json
@@ -8,6 +8,7 @@
   "exclude": ["node_modules"],
   "references": [
     { "path": "../app-config-config" },
+    { "path": "../app-config-schema" },
     { "path": "../app-config-utils" },
     { "path": "../app-config-test-utils" }
   ]
diff --git a/app-config-utils/src/__snapshots__/index.test.ts.snap b/app-config-utils/src/__snapshots__/index.test.ts.snap
@@ -77,6 +77,25 @@ exports[`generateModuleText creates config module with global namespace 1`] = `
     "
 `;
 
+exports[`generateModuleText creates config module with noBundledConfig 1`] = `
+"
+      const globalNamespace = (typeof window === 'undefined' ? globalThis : window) || {};
+
+      const config = globalNamespace._appConfig;
+
+      if (typeof config === 'undefined') {
+        throw new Error('Config is not loaded in _appConfig');
+      }
+
+      export { config };
+      export default config;
+    
+      export function currentEnvironment() {
+        return globalNamespace._appConfigEnvironment || \\"test\\";
+      }
+    "
+`;
+
 exports[`generateModuleText creates config module with validation function 1`] = `
 "
       const globalNamespace = (typeof window === 'undefined' ? globalThis : window) || {};
diff --git a/app-config-utils/src/index.test.ts b/app-config-utils/src/index.test.ts
@@ -59,6 +59,17 @@ describe('generateModuleText', () => {
     ).toMatchSnapshot();
   });
 
+  it('creates config module with noBundledConfig', () => {
+    expect(
+      generateModuleText(undefined, {
+        environment: 'test',
+        useGlobalNamespace: true,
+        esmValidationCode: false,
+        validationFunctionCode: undefined,
+      }),
+    ).toMatchSnapshot();
+  });
+
   it('creates config module with validation function', () => {
     expect(
       generateModuleText(
diff --git a/app-config-utils/src/index.ts b/app-config-utils/src/index.ts
@@ -29,7 +29,7 @@ export function isPrimitive(obj: Json): obj is JsonPrimitive {
 }
 
 export function generateModuleText(
-  fullConfig: Json,
+  fullConfig: Json | undefined,
   {
     environment,
     useGlobalNamespace,
@@ -45,11 +45,25 @@ export function generateModuleText(
 ): string {
   const privateName = '_appConfig';
   const privateEnvName = '_appConfigEnvironment';
-  const config = JSON.stringify(fullConfig);
 
   let generatedText = '';
 
-  if (useGlobalNamespace) {
+  if (fullConfig === undefined) {
+    generatedText += `
+      const globalNamespace = (typeof window === 'undefined' ? globalThis : window) || {};
+
+      const config = globalNamespace.${privateName};
+
+      if (typeof config === 'undefined') {
+        throw new Error('Config is not loaded in ${privateName}');
+      }
+
+      export { config };
+      export default config;
+    `;
+  } else if (useGlobalNamespace) {
+    const config = JSON.stringify(fullConfig);
+
     generatedText += `
       const globalNamespace = (typeof window === 'undefined' ? globalThis : window) || {};
 
@@ -70,6 +84,8 @@ export function generateModuleText(
       export default config;
     `;
   } else {
+    const config = JSON.stringify(fullConfig);
+
     generatedText += `
       const config = ${config};
 
diff --git a/app-config-webpack/package.json b/app-config-webpack/package.json
@@ -32,6 +32,7 @@
   },
   "dependencies": {
     "@app-config/config": "^2.8.2",
+    "@app-config/schema": "^2.8.2",
     "@app-config/utils": "^2.8.2",
     "loader-utils": "2"
   },
diff --git a/app-config-webpack/src/index.test.ts b/app-config-webpack/src/index.test.ts
@@ -284,6 +284,28 @@ describe('frontend-webpack-project example', () => {
       });
     });
   });
+
+  it('builds the project with noBundledConfig', async () => {
+    process.env.APP_CONFIG = 'null';
+    process.env.APP_CONFIG_ENV = 'test';
+
+    await new Promise<void>((done, reject) => {
+      webpack([createOptions({ noBundledConfig: true })], (err, stats) => {
+        if (err) return reject(err);
+        if (!stats) return reject(new Error('no stats'));
+        if (stats.hasErrors()) reject(stats.toString());
+
+        const { children } = stats.toJson({ source: true });
+        const [{ modules = [] }] = children || [];
+
+        expect(
+          modules.some(({ source }) => source?.includes('Config is not loaded in _appConfig')),
+        ).toBe(true);
+
+        done();
+      });
+    });
+  });
 });
 
 describe('regex', () => {
diff --git a/app-config-webpack/src/index.ts b/app-config-webpack/src/index.ts
@@ -15,6 +15,7 @@ export interface Options {
   schemaLoadingOptions?: SchemaLoadingOptions;
   intercept?: RegExp;
   injectValidationFunction?: boolean;
+  noBundledConfig?: boolean;
 
   /** @deprecated use useGlobalNamespace instead */
   noGlobal?: boolean;
@@ -30,6 +31,7 @@ export default class AppConfigPlugin implements Options {
   loadingOptions?: ConfigLoadingOptions;
   schemaLoadingOptions?: SchemaLoadingOptions;
   injectValidationFunction: boolean;
+  noBundledConfig: boolean;
   intercept: RegExp;
 
   constructor(options: Options = {}) {
@@ -38,6 +40,7 @@ export default class AppConfigPlugin implements Options {
     this.loadingOptions = options.loadingOptions ?? options.loading;
     this.schemaLoadingOptions = options.schemaLoadingOptions ?? options.schemaLoading;
     this.injectValidationFunction = options.injectValidationFunction ?? true;
+    this.noBundledConfig = options.noBundledConfig ?? false;
     this.intercept = options.intercept ?? AppConfigPlugin.regex;
   }
 
@@ -66,6 +69,7 @@ export default class AppConfigPlugin implements Options {
               loadingOptions: this.loadingOptions,
               schemaLoadingOptions: this.schemaLoadingOptions,
               injectValidationFunction: this.injectValidationFunction,
+              noBundledConfig: this.noBundledConfig,
 
               // deprecated options
               noGlobal: !this.useGlobalNamespace,
diff --git a/app-config-webpack/src/loader.ts b/app-config-webpack/src/loader.ts
@@ -1,6 +1,7 @@
 import { getOptions, parseQuery } from 'loader-utils';
 import { loadValidatedConfig } from '@app-config/config';
 import { generateModuleText, packageNameRegex } from '@app-config/utils';
+import { loadSchema } from '@app-config/schema';
 import type { Options } from './index';
 
 type LoaderContext = Parameters<typeof getOptions>[0];
@@ -19,6 +20,29 @@ const loader = function AppConfigLoader(this: Loader) {
   const loadingOptions = options.loadingOptions ?? options.loading ?? {};
   const schemaLoadingOptions = options.schemaLoadingOptions ?? options.schemaLoading;
   const injectValidationFunction = options.injectValidationFunction ?? true;
+  const noBundledConfig = options.noBundledConfig ?? false;
+
+  if (noBundledConfig) {
+    loadSchema(schemaLoadingOptions)
+      .then(({ validationFunctionCode }) => {
+        callback(
+          null,
+          generateModuleText(undefined, {
+            environment: undefined,
+            useGlobalNamespace: true,
+            validationFunctionCode: injectValidationFunction ? validationFunctionCode : undefined,
+            esmValidationCode: false,
+          }),
+        );
+      })
+      .catch((err) => {
+        this.emitWarning(new Error(`There was an error when trying to load @app-config`));
+
+        callback(err);
+      });
+
+    return;
+  }
 
   loadValidatedConfig(loadingOptions, schemaLoadingOptions)
     .then(({ fullConfig, environment, filePaths, validationFunctionCode }) => {
diff --git a/app-config-webpack/tsconfig.json b/app-config-webpack/tsconfig.json

Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,7 @@`
`8`	`8`	`"exclude": ["node_modules"],`
`9`	`9`	`"references": [`
`10`	`10`	`{ "path": "../app-config-config" },`
	`11`	`+ { "path": "../app-config-schema" },`
`11`	`12`	`{ "path": "../app-config-utils" },`
`12`	`13`	`{ "path": "../app-config-test-utils" }`
`13`	`14`	`]`