Merge pull request #1127 from spotify/rugvip/config

packages/cli,core-api: move config reading and loading into separate packages

packages/cli/package.json

@@ -29,6 +29,8 @@
     "backstage-cli": "bin/backstage-cli"
   },
   "dependencies": {
+    "@backstage/config": "^0.1.1-alpha.6",
+    "@backstage/config-loader": "^0.1.1-alpha.6",
     "@hot-loader/react-dom": "^16.13.0",
     "@lerna/package-graph": "^3.18.5",
     "@lerna/project": "^3.18.0",

packages/cli/src/commands/app/build.ts

@@ -16,7 +16,7 @@
 
 import { buildBundle } from '../../lib/bundler';
 import { Command } from 'commander';
-import { loadConfig } from '../../lib/app-config';
+import { loadConfig } from '@backstage/config-loader';
 
 export default async (cmd: Command) => {
   await buildBundle({

packages/cli/src/commands/app/serve.ts

@@ -16,7 +16,7 @@
 
 import { Command } from 'commander';
 import { serveBundle } from '../../lib/bundler';
-import { loadConfig } from '../../lib/app-config';
+import { loadConfig } from '@backstage/config-loader';
 
 export default async (cmd: Command) => {
   const waitForExit = await serveBundle({

packages/cli/src/commands/plugin/serve.ts

@@ -16,7 +16,7 @@
 
 import { Command } from 'commander';
 import { serveBundle } from '../../lib/bundler';
-import { loadConfig } from '../../lib/app-config';
+import { loadConfig } from '@backstage/config-loader';
 
 export default async (cmd: Command) => {
   const waitForExit = await serveBundle({

packages/cli/src/lib/app-config/index.ts

@@ -1,18 +0,0 @@
-/*
- * Copyright 2020 Spotify AB
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-export type { AppConfig } from './types';
-export { loadConfig } from './loaders';

packages/cli/src/lib/app-config/loaders.ts

@@ -1,41 +0,0 @@
-/*
- * Copyright 2020 Spotify AB
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-import { AppConfig } from './types';
-import fs from 'fs-extra';
-import yaml from 'yaml';
-import { paths } from '../paths';
-
-type LoadConfigOptions = {
-  // Config path, defaults to app-config.yaml in project root
-  configPath?: string;
-};
-
-export async function loadConfig(
-  options: LoadConfigOptions = {},
-): Promise<AppConfig[]> {
-  // TODO: We'll want this to be a bit more elaborate, probably adding configs for
-  //       specific env, and maybe local config for plugins.
-  const { configPath = paths.resolveTargetRoot('app-config.yaml') } = options;
-
-  try {
-    const configYaml = await fs.readFile(configPath, 'utf8');
-    const config = yaml.parse(configYaml);
-    return [config];
-  } catch (error) {
-    throw new Error(`Failed to read static configuration file, ${error}`);
-  }
-}

packages/cli/src/lib/app-config/types.ts

@@ -1,17 +0,0 @@
-/*
- * Copyright 2020 Spotify AB
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-export type AppConfig = any;

packages/cli/src/lib/bundler/types.ts

@@ -14,8 +14,8 @@
  * limitations under the License.
  */
 
+import { AppConfig } from '@backstage/config';
 import { BundlingPathsOptions } from './paths';
-import { AppConfig } from '../app-config';
 
 export type BundlingOptions = {
   checksEnabled: boolean;

packages/cli/src/lib/paths.ts

@@ -57,8 +57,7 @@ export function findRootPath(topPath: string): string {
     const exists = fs.pathExistsSync(packagePath);
     if (exists) {
       try {
-        const contents = fs.readFileSync(packagePath, 'utf8');
-        const data = JSON.parse(contents);
+        const data = fs.readJsonSync(packagePath);
         if (data.name === 'root' || data.name.includes('backstage-e2e')) {
           return path;
         }

packages/cli/src/lib/tasks.ts

@@ -111,6 +111,8 @@ export async function templatingTask(
 // List of local packages that we need to modify as a part of an E2E test
 const PATCH_PACKAGES = [
   'cli',
+  'config',
+  'config-loader',
   'core',
   'core-api',
   'dev-utils',
@@ -193,6 +195,11 @@ export async function installWithLocalDeps(dir: string) {
           delete depJson['main:src'];
           depJson.types = 'dist/index.d.ts';
 
+          // Ugly hack until backend packages can point straight to source
+          if (name === 'config' || name === 'config-loader') {
+            depJson.main = 'dist/index.cjs.js';
+          }
+
           await fs
             .writeJSON(depJsonPath, depJson, { encoding: 'utf8', spaces: 2 })
             .catch(error => {