Consolidate configuration setup across repository (#685)

* Update use of configuration to consistently use .env file. Deprecate use of default.json. - Add new custom Rush command, 'copy:config', to copy a shared `.env` file to each directory necessary - Enhance the internal-tools copyConfig script to allow a custom path for `.env` file - Mark main IModelJsConfig class as deprecated
iTwin · Feb 10, 2021 · e2a2e97 · e2a2e97
1 parent 7aca9fa
commit e2a2e97
Show file tree

Hide file tree

Showing 78 changed files with 404 additions and 242 deletions.
diff --git a/clients/context-registry/package.json b/clients/context-registry/package.json
@@ -22,6 +22,7 @@
     "test:integration": "npm run webpackTests && npm run test:integration:chrome",
     "test:integration:chrome": "certa -r chrome --grep \"#integration\"",
     "test:integration:electron": "certa -r electron --grep \"#integration\"",
+    "copy:config": "internal-tools copy-config",
     "cover": ""
   },
   "keywords": [
@@ -54,6 +55,7 @@
     "@types/node": "10.14.1",
     "chai": "^4.1.2",
     "eslint": "^6.8.0",
+    "internal-tools": "0.0.0",
     "mocha": "^5.2.0",
     "nyc": "^14.0.0",
     "rimraf": "^3.0.2",
@@ -70,4 +72,4 @@
     ],
     "extends": "plugin:@bentley/imodeljs-recommended"
   }
-}
+}
diff --git a/clients/context-registry/src/test/utils/webpack.config.js b/clients/context-registry/src/test/utils/webpack.config.js
@@ -6,7 +6,7 @@
 const path = require("path");
 const glob = require("glob");
 const webpack = require("webpack");
-const raw = require("@bentley/config-loader/lib/IModelJsConfig").IModelJsConfig.init(true /*suppress error*/, true);
+require("@bentley/config-loader").loadEnv(path.join(__dirname, "..", "..", "..", ".env"));
 
 const clientsLib = path.resolve(__dirname, "../../../lib");
 
@@ -51,16 +51,14 @@ function createConfig(shouldInstrument) {
       // Makes some environment variables available to the JS code, for example:
       // if (process.env.NODE_ENV === "development") { ... }. See `./env.js`.
       new webpack.DefinePlugin({
-        "process.env": Object.keys(raw)
+        "process.env": Object.keys(process.env)
           .filter((key) => {
             return key.match(/^imjs_/i);
           })
           .reduce((env, key) => {
-            env[key] = JSON.stringify(raw[key]);
+            env[key] = JSON.stringify(process.env[key]);
             return env;
-          }, {
-            IMODELJS_CORE_DIRNAME: JSON.stringify(path.join(__dirname, "../..")),
-          }),
+          }, {}),
       })
     ]
   };

diff --git a/clients/extension/package.json b/clients/extension/package.json
@@ -22,6 +22,7 @@
     "test:integration:chrome": "certa -r chrome",
     "test:integration:electron": "certa -r electron",
     "test:integration:node": "certa -r node",
+    "copy:config": "internal-tools copy-config",
     "webpackTests": "webpack --config ./src/test/utils/webpack.config.js 1>&2"
   },
   "keywords": [
@@ -51,6 +52,7 @@
     "@types/node": "10.14.1",
     "chai": "^4.1.2",
     "eslint": "^6.8.0",
+    "internal-tools": "0.0.0",
     "mocha": "^5.2.0",
     "nyc": "^14.0.0",
     "rimraf": "^3.0.2",
@@ -67,4 +69,4 @@
     ],
     "extends": "plugin:@bentley/imodeljs-recommended"
   }
-}
+}
diff --git a/clients/extension/src/test/utils/webpack.config.js b/clients/extension/src/test/utils/webpack.config.js
@@ -6,7 +6,7 @@
 const path = require("path");
 const glob = require("glob");
 const webpack = require("webpack");
-const raw = require("@bentley/config-loader/lib/IModelJsConfig").IModelJsConfig.init(true /*suppress error*/, true);
+require("@bentley/config-loader").loadEnv(path.join(__dirname, "..", "..", "..", ".env"));
 
 const clientsLib = path.resolve(__dirname, "../../../lib");
 
@@ -51,16 +51,14 @@ function createConfig(shouldInstrument) {
       // Makes some environment variables available to the JS code, for example:
       // if (process.env.NODE_ENV === "development") { ... }. See `./env.js`.
       new webpack.DefinePlugin({
-        "process.env": Object.keys(raw)
+        "process.env": Object.keys(process.env)
           .filter((key) => {
             return key.match(/^imjs_/i);
           })
           .reduce((env, key) => {
-            env[key] = JSON.stringify(raw[key]);
+            env[key] = JSON.stringify(process.env[key]);
             return env;
-          }, {
-            IMODELJS_CORE_DIRNAME: JSON.stringify(path.join(__dirname, "../..")),
-          }),
+          }, {}),
       })
     ]
   };

diff --git a/clients/forms-data-management/package.json b/clients/forms-data-management/package.json
@@ -22,6 +22,7 @@
     "test:integration": "npm run webpackTests && npm run test:integration:chrome",
     "test:integration:chrome": "certa -r chrome --grep \"#integration\"",
     "test:integration:electron": "certa -r electron --grep \"#integration\"",
+    "copy:config": "internal-tools copy-config",
     "cover": ""
   },
   "keywords": [
@@ -53,6 +54,7 @@
     "@types/node": "10.14.1",
     "chai": "^4.1.2",
     "eslint": "^6.8.0",
+    "internal-tools": "0.0.0",
     "mocha": "^5.2.0",
     "nyc": "^14.0.0",
     "rimraf": "^3.0.2",
@@ -69,4 +71,4 @@
     ],
     "extends": "plugin:@bentley/imodeljs-recommended"
   }
-}
+}
diff --git a/clients/forms-data-management/src/test/TestConfig.ts b/clients/forms-data-management/src/test/TestConfig.ts
diff --git a/clients/forms-data-management/src/test/integration/FormDataManagementClient.test.ts b/clients/forms-data-management/src/test/integration/FormDataManagementClient.test.ts
@@ -2,33 +2,30 @@
 * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
 * See LICENSE.md in the project root for license terms and full copyright notice.
 *--------------------------------------------------------------------------------------------*/
-import * as chai from "chai";
+import { assert } from "chai";
 import { ContextRegistryClient, Project } from "@bentley/context-registry-client";
-import { AuthorizedClientRequestContext } from "@bentley/itwin-client";
+import { AccessToken, AuthorizedClientRequestContext } from "@bentley/itwin-client";
+import { getAccessTokenFromBackend, TestUsers } from "@bentley/oidc-signin-tool/lib/frontend";
 import { FormDataManagementClient, FormDefinition } from "../../FormDataManagementClient";
-import { TestConfig } from "../TestConfig";
 
 /* eslint-disable @typescript-eslint/naming-convention */
 
-chai.should();
-
 describe("FormDataManagementClient", () => {
   let requestContext: AuthorizedClientRequestContext;
   const formDataManagementClient: FormDataManagementClient = new FormDataManagementClient();
   let projectId: string;
 
   before(async function () {
-    if (TestConfig.enableMocks) return;
-    this.enableTimeouts(false);
-
-    requestContext = await TestConfig.getAuthorizedClientRequestContext();
+    const accessToken = await getAccessTokenFromBackend(TestUsers.super);
+    requestContext = new AuthorizedClientRequestContext((accessToken as any) as AccessToken);
 
     const contextRegistry = new ContextRegistryClient();
+    const projectName = "iModelJsIntegrationTest";
     const project: Project | undefined = await contextRegistry.getProject(requestContext, {
       $select: "*",
-      $filter: `Name+eq+'${TestConfig.projectName}'`,
+      $filter: `Name+eq+'${projectName}'`,
     });
-    chai.assert(project, `Project ${TestConfig.projectName} not found for user.`);
+    assert(project, `Project ${projectName} not found for user.`);
     projectId = project.wsgId;
   });
 
@@ -37,6 +34,6 @@ describe("FormDataManagementClient", () => {
       requestContext,
       projectId
     );
-    chai.assert(formDefinitions);
+    assert(formDefinitions);
   });
 });
diff --git a/clients/forms-data-management/src/test/utils/webpack.config.js b/clients/forms-data-management/src/test/utils/webpack.config.js
@@ -6,7 +6,7 @@
 const path = require("path");
 const glob = require("glob");
 const webpack = require("webpack");
-const raw = require("@bentley/config-loader/lib/IModelJsConfig").IModelJsConfig.init(true /*suppress error*/, true);
+require("@bentley/config-loader").loadEnv(path.join(__dirname, "..", "..", "..", ".env"));
 
 const clientsLib = path.resolve(__dirname, "../../../lib");
 
@@ -48,16 +48,14 @@ function createConfig(shouldInstrument) {
       // Makes some environment variables available to the JS code, for example:
       // if (process.env.NODE_ENV === "development") { ... }. See `./env.js`.
       new webpack.DefinePlugin({
-        "process.env": Object.keys(raw)
+        "process.env": Object.keys(process.env)
           .filter((key) => {
             return key.match(/^imjs_/i);
           })
           .reduce((env, key) => {
-            env[key] = JSON.stringify(raw[key]);
+            env[key] = JSON.stringify(process.env[key]);
             return env;
-          }, {
-            IMODELJS_CORE_DIRNAME: JSON.stringify(path.join(__dirname, "../..")),
-          }),
+          }, {}),
       })
     ]
   };

diff --git a/clients/product-settings/package.json b/clients/product-settings/package.json
@@ -22,6 +22,7 @@
     "test:integration": "npm run webpackTests && npm run test:integration:chrome",
     "test:integration:chrome": "certa -r chrome --grep \"#integration\"",
     "test:integration:electron": "certa -r electron --grep \"#integration\"",
+    "copy:config": "internal-tools copy-config",
     "webpackTests": "webpack --config ./src/test/utils/webpack.config.js 1>&2"
   },
   "keywords": [
@@ -52,6 +53,7 @@
     "@types/node": "10.14.1",
     "chai": "^4.1.2",
     "eslint": "^6.8.0",
+    "internal-tools": "0.0.0",
     "mocha": "^5.2.0",
     "nyc": "^14.0.0",
     "rimraf": "^3.0.2",
@@ -68,4 +70,4 @@
     ],
     "extends": "plugin:@bentley/imodeljs-recommended"
   }
-}
+}
diff --git a/clients/product-settings/src/test/utils/webpack.config.js b/clients/product-settings/src/test/utils/webpack.config.js
@@ -6,7 +6,7 @@
 const path = require("path");
 const glob = require("glob");
 const webpack = require("webpack");
-const raw = require("@bentley/config-loader/lib/IModelJsConfig").IModelJsConfig.init(true /*suppress error*/, true);
+require("@bentley/config-loader").loadEnv(path.join(__dirname, "..", ".."));
 
 const clientsLib = path.resolve(__dirname, "../../../lib");
 
@@ -51,16 +51,14 @@ function createConfig(shouldInstrument) {
       // Makes some environment variables available to the JS code, for example:
       // if (process.env.NODE_ENV === "development") { ... }. See `./env.js`.
       new webpack.DefinePlugin({
-        "process.env": Object.keys(raw)
+        "process.env": Object.keys(process.env)
           .filter((key) => {
             return key.match(/^imjs_/i);
           })
           .reduce((env, key) => {
-            env[key] = JSON.stringify(raw[key]);
+            env[key] = JSON.stringify(process.env[key]);
             return env;
-          }, {
-            IMODELJS_CORE_DIRNAME: JSON.stringify(path.join(__dirname, "../..")),
-          }),
+          }, {}),
       })
     ]
   };

diff --git a/clients/projectshare/package.json b/clients/projectshare/package.json
@@ -22,6 +22,7 @@
     "test:integration": "npm run webpackTests && npm run test:integration:chrome",
     "test:integration:chrome": "certa -r chrome --grep \"#integration\"",
     "test:integration:electron": "certa -r electron --grep \"#integration\"",
+    "copy:config": "internal-tools copy-config",
     "webpackTests": "webpack --config ./src/test/utils/webpack.config.js 1>&2"
   },
   "keywords": [
@@ -52,6 +53,7 @@
     "@types/node": "10.14.1",
     "chai": "^4.1.2",
     "eslint": "^6.8.0",
+    "internal-tools": "0.0.0",
     "mocha": "^5.2.0",
     "nyc": "^14.0.0",
     "rimraf": "^3.0.2",
@@ -68,4 +70,4 @@
     ],
     "extends": "plugin:@bentley/imodeljs-recommended"
   }
-}
+}
diff --git a/clients/projectshare/src/test/utils/webpack.config.js b/clients/projectshare/src/test/utils/webpack.config.js
@@ -6,7 +6,7 @@
 const path = require("path");
 const glob = require("glob");
 const webpack = require("webpack");
-const raw = require("@bentley/config-loader/lib/IModelJsConfig").IModelJsConfig.init(true /*suppress error*/, true);
+require("@bentley/config-loader").loadEnv(path.join(__dirname, "..", "..", "..", ".env"));
 
 const clientsLib = path.resolve(__dirname, "../../../lib");
 
@@ -51,16 +51,14 @@ function createConfig(shouldInstrument) {
       // Makes some environment variables available to the JS code, for example:
       // if (process.env.NODE_ENV === "development") { ... }. See `./env.js`.
       new webpack.DefinePlugin({
-        "process.env": Object.keys(raw)
+        "process.env": Object.keys(process.env)
           .filter((key) => {
             return key.match(/^imjs_/i);
           })
           .reduce((env, key) => {
-            env[key] = JSON.stringify(raw[key]);
+            env[key] = JSON.stringify(process.env[key]);
             return env;
-          }, {
-            IMODELJS_CORE_DIRNAME: JSON.stringify(path.join(__dirname, "../..")),
-          }),
+          }, {}),
       })
     ]
   };

diff --git a/clients/rbac/package.json b/clients/rbac/package.json
@@ -22,6 +22,7 @@
     "test:integration": "npm run webpackTests && npm run test:integration:chrome",
     "test:integration:chrome": "certa -r chrome --grep \"#integration\"",
     "test:integration:electron": "certa -r electron --grep \"#integration\"",
+    "copy:config": "internal-tools copy-config",
     "webpackTests": "webpack --config ./src/test/utils/webpack.config.js 1>&2"
   },
   "keywords": [
@@ -53,6 +54,7 @@
     "@types/node": "10.14.1",
     "chai": "^4.1.2",
     "eslint": "^6.8.0",
+    "internal-tools": "0.0.0",
     "mocha": "^5.2.0",
     "nyc": "^14.0.0",
     "rimraf": "^3.0.2",
@@ -69,4 +71,4 @@
     ],
     "extends": "plugin:@bentley/imodeljs-recommended"
   }
-}
+}
diff --git a/clients/rbac/src/test/utils/webpack.config.js b/clients/rbac/src/test/utils/webpack.config.js
@@ -6,7 +6,7 @@
 const path = require("path");
 const glob = require("glob");
 const webpack = require("webpack");
-const raw = require("@bentley/config-loader/lib/IModelJsConfig").IModelJsConfig.init(true /*suppress error*/, true);
+require("@bentley/config-loader").loadEnv(path.join(__dirname, "..", "..", "..", ".env"));
 
 const clientsLib = path.resolve(__dirname, "../../../lib");
 
@@ -51,16 +51,14 @@ function createConfig(shouldInstrument) {
       // Makes some environment variables available to the JS code, for example:
       // if (process.env.NODE_ENV === "development") { ... }. See `./env.js`.
       new webpack.DefinePlugin({
-        "process.env": Object.keys(raw)
+        "process.env": Object.keys(process.env)
           .filter((key) => {
             return key.match(/^imjs_/i);
           })
           .reduce((env, key) => {
-            env[key] = JSON.stringify(raw[key]);
+            env[key] = JSON.stringify(process.env[key]);
             return env;
-          }, {
-            IMODELJS_CORE_DIRNAME: JSON.stringify(path.join(__dirname, "../..")),
-          }),
+          }, {}),
       })
     ]
   };