feat: adds test webpack project with two app-config sources, one being static

joelgallant · joelgallant · commit 56de0223f040 · 2021-02-25T19:18:41.000-07:00
diff --git a/.github/workflows/cypress.yml b/.github/workflows/cypress.yml
@@ -58,4 +58,12 @@ jobs:
         start: yarn serve -l 8992 ./dist
       env:
         CYPRESS_RECORD_KEY: ${{ secrets.CYPRESS_RECORD_KEY }}
-
+    - uses: cypress-io/github-action@v2
+      with:
+        group: app-config-two-app-config-sources
+        working-directory: tests/webpack-projects/two-app-config-sources
+        install: false
+        record: true
+        start: yarn serve -l 8993 ./dist
+      env:
+        CYPRESS_RECORD_KEY: ${{ secrets.CYPRESS_RECORD_KEY }}
diff --git a/tests/webpack-projects/two-app-config-sources/.app-config.meta.yml b/tests/webpack-projects/two-app-config-sources/.app-config.meta.yml
@@ -0,0 +1,2 @@
+generate:
+  - file: './src/@types/lcdev__app-config/index.d.ts'
diff --git a/tests/webpack-projects/two-app-config-sources/.app-config.schema.yml b/tests/webpack-projects/two-app-config-sources/.app-config.schema.yml
@@ -0,0 +1,7 @@
+type: object
+additionalProperties: false
+
+required: []
+properties:
+  bar:
+    type: string
diff --git a/tests/webpack-projects/two-app-config-sources/.app-config.yml b/tests/webpack-projects/two-app-config-sources/.app-config.yml
@@ -0,0 +1 @@
+bar: 'this is bar'
diff --git a/tests/webpack-projects/two-app-config-sources/app-config-static.schema.yml b/tests/webpack-projects/two-app-config-sources/app-config-static.schema.yml
@@ -0,0 +1,7 @@
+type: object
+additionalProperties: false
+
+required: []
+properties:
+  foo:
+    type: string
diff --git a/tests/webpack-projects/two-app-config-sources/app-config-static.yml b/tests/webpack-projects/two-app-config-sources/app-config-static.yml
@@ -0,0 +1 @@
+foo: 'this is foo'
diff --git a/tests/webpack-projects/two-app-config-sources/cypress.json b/tests/webpack-projects/two-app-config-sources/cypress.json
@@ -0,0 +1,4 @@
+{
+  "projectId": "fm6zcy",
+  "baseUrl": "http://localhost:8993"
+}
diff --git a/tests/webpack-projects/two-app-config-sources/cypress/integration/main.spec.ts b/tests/webpack-projects/two-app-config-sources/cypress/integration/main.spec.ts
@@ -0,0 +1,8 @@
+describe('Config Loading', () => {
+  it('should render both configurations', () => {
+    cy.visit('/');
+
+    cy.get('body').should('contain', `{\n  "foo": "this is foo"\n}`);
+    cy.get('body').should('contain', `{\n  "bar": "this is bar"\n}`);
+  });
+});
diff --git a/tests/webpack-projects/two-app-config-sources/cypress/plugins/index.js b/tests/webpack-projects/two-app-config-sources/cypress/plugins/index.js
@@ -0,0 +1,2 @@
+module.exports = (on, config) => {
+}
diff --git a/tests/webpack-projects/two-app-config-sources/cypress/support/commands.js b/tests/webpack-projects/two-app-config-sources/cypress/support/commands.js
@@ -0,0 +1,25 @@
+// ***********************************************
+// This example commands.js shows you how to
+// create various custom commands and overwrite
+// existing commands.
+//
+// For more comprehensive examples of custom
+// commands please read more here:
+// https://on.cypress.io/custom-commands
+// ***********************************************
+//
+//
+// -- This is a parent command --
+// Cypress.Commands.add("login", (email, password) => { ... })
+//
+//
+// -- This is a child command --
+// Cypress.Commands.add("drag", { prevSubject: 'element'}, (subject, options) => { ... })
+//
+//
+// -- This is a dual command --
+// Cypress.Commands.add("dismiss", { prevSubject: 'optional'}, (subject, options) => { ... })
+//
+//
+// -- This will overwrite an existing command --
+// Cypress.Commands.overwrite("visit", (originalFn, url, options) => { ... })
diff --git a/tests/webpack-projects/two-app-config-sources/cypress/support/index.js b/tests/webpack-projects/two-app-config-sources/cypress/support/index.js
@@ -0,0 +1,20 @@
+// ***********************************************************
+// This example support/index.js is processed and
+// loaded automatically before your test files.
+//
+// This is a great place to put global configuration and
+// behavior that modifies Cypress.
+//
+// You can change the location of this file or turn off
+// automatically serving support files with the
+// 'supportFile' configuration option.
+//
+// You can read more here:
+// https://on.cypress.io/configuration
+// ***********************************************************
+
+// Import commands.js using ES2015 syntax:
+import './commands'
+
+// Alternatively you can use CommonJS syntax:
+// require('./commands')
diff --git a/tests/webpack-projects/two-app-config-sources/cypress/tsconfig.json b/tests/webpack-projects/two-app-config-sources/cypress/tsconfig.json
@@ -0,0 +1,11 @@
+{
+  "extends": "../tsconfig.json",
+  "compilerOptions": {
+    "noEmit": true,
+    "types": ["cypress"]
+  },
+  "include": [
+    "../node_modules/cypress",
+    "./*/*.ts"
+  ]
+}
diff --git a/tests/webpack-projects/two-app-config-sources/package.json b/tests/webpack-projects/two-app-config-sources/package.json
@@ -0,0 +1,28 @@
+{
+  "name": "@app-config/test-two-app-config-sources",
+  "version": "0.0.0",
+  "license": "MPL-2.0",
+  "private": true,
+  "main": "dist/main.js",
+  "scripts": {
+    "dev": "cross-env NODE_ENV=development webpack-dev-server",
+    "build": "cross-env NODE_ENV=production webpack --mode production",
+    "clean": "rm -rf ./dist"
+  },
+  "dependencies": {
+    "@app-config/main": "2"
+  },
+  "devDependencies": {
+    "@app-config/webpack": "2",
+    "@lcdev/tsconfig": "0.2",
+    "cross-env": "7",
+    "cypress": "6",
+    "html-webpack-plugin": "4",
+    "serve": "11",
+    "ts-loader": "8",
+    "typescript": "4",
+    "webpack": "4",
+    "webpack-cli": "3",
+    "webpack-dev-server": "^3.2"
+  }
+}
diff --git a/tests/webpack-projects/two-app-config-sources/src/index.ts b/tests/webpack-projects/two-app-config-sources/src/index.ts
@@ -0,0 +1,9 @@
+// @ts-ignore
+import { config as dynamicConfig } from '@app-config/main';
+// @ts-ignore
+import { config as staticConfig } from 'app-config-static';
+
+document.body.innerHTML = `<pre>
+${JSON.stringify(dynamicConfig, null, 2)}
+${JSON.stringify(staticConfig, null, 2)}
+</pre>`;
diff --git a/tests/webpack-projects/two-app-config-sources/tsconfig.json b/tests/webpack-projects/two-app-config-sources/tsconfig.json
@@ -0,0 +1,16 @@
+{
+  "extends": "@lcdev/tsconfig",
+  "compilerOptions": {
+    "rootDir": "./src",
+    "outDir": "./dist",
+    "module": "es2020",
+    "target": "es2020",
+    "lib": ["dom"]
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules"],
+  "references": [
+    { "path": "../../../app-config-main" },
+    { "path": "../../../app-config-webpack" }
+  ]
+}
diff --git a/tests/webpack-projects/two-app-config-sources/webpack.config.js b/tests/webpack-projects/two-app-config-sources/webpack.config.js
@@ -0,0 +1,60 @@
+const path = require('path');
+const HtmlPlugin = require('html-webpack-plugin');
+const { default: AppConfigPlugin } = require('@app-config/webpack');
+
+// Important parts are in module->rules (the AppConfigPlugin.loader), and plugins
+// AppConfigPlugin relies on HtmlPlugin (html-webpack-plugin), when using headerInjection
+
+module.exports = {
+  entry: './src/index.ts',
+  output: {
+    publicPath: '/',
+    filename: 'main.js',
+    path: path.resolve(__dirname, 'dist'),
+  },
+  module: {
+    rules: [
+      {
+        test: /\.tsx?$/,
+        use: 'ts-loader',
+        exclude: /node_modules/,
+      },
+      {
+        test: /app-config-static/,
+        use: {
+          loader: AppConfigPlugin.loader,
+          options: {
+            noGlobal: true,
+            loading: {
+              fileNameBase: 'app-config-static',
+            },
+          },
+        },
+      },
+      {
+        test: AppConfigPlugin.regex,
+        use: { loader: AppConfigPlugin.loader, options: { headerInjection: true } },
+      },
+    ],
+  },
+  plugins: [
+    new HtmlPlugin(),
+    new AppConfigPlugin({ headerInjection: true }),
+    new AppConfigPlugin({
+      noGlobal: true,
+      intercept: /app-config-static/,
+      loading: {
+        fileNameBase: 'app-config-static',
+      },
+      schemaLoading: {
+        fileNameBase: 'app-config-static.schema',
+      },
+    }),
+  ],
+  devServer: {
+    host: '0.0.0.0',
+    port: 8993,
+    disableHostCheck: true,
+    historyApiFallback: true,
+  },
+};

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+generate:`
	`2`	`+ - file: './src/@types/lcdev__app-config/index.d.ts'`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +{
 +  "projectId": "fm6zcy",
 +  "baseUrl": "http://localhost:8993"
 +}
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+module.exports = (on, config) => {`
	`2`	`+}`