refactor: migrate to new application config #1633

emmenko · 2020-07-15T10:16:00Z

This PR is based off #1626 and migrates the appkit codebase to use the new application config.

changeset-bot · 2020-07-15T10:16:03Z

🦋 Changeset is good to go

Latest commit: 16be1ab

We got this.

This PR includes changesets to release 8 packages

Name	Type
merchant-center-application-template-starter	Minor
@commercetools-frontend/application-config	Minor
@commercetools-frontend/application-shell	Minor
@commercetools-frontend/mc-html-template	Minor
@commercetools-frontend/mc-http-server	Minor
@commercetools-frontend/mc-scripts	Minor
playground	Minor
@commercetools-local/visual-testing-app	Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

vercel · 2020-07-15T10:16:05Z

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/commercetools/merchant-center-application-kit/9e1pcgf3n
✅ Preview: https://merchant-center-application-kit-git-nm-migrate-app-config.commercetools.vercel.app

emmenko · 2020-07-15T10:17:08Z

packages/application-config/src/index.ts

@@ -1,2 +1 @@
 export { default as processConfig } from './process-config';
-export { default as validateConfig } from './validate-config';


Not necessary to expose it

emmenko · 2020-07-15T10:17:36Z

packages/application-config/src/load-deprecated-config.ts

+// For backwards compatibility, we still support the `env.json` and `headers.json` files.
+// TODO: remove in `v17`.
+const loadDeprecatedConfig = (


This is the part where we load the env.json and headers.json for backwards compatibility

emmenko · 2020-07-15T10:18:55Z

packages/application-config/src/process-config.ts

+  if (!loadedAppConfig && deprecatedOptions) {
+    console.warn(
+      `No custom application config found, attempting to load the config from env.json and headers.json.`
+    );
+    const loadedDeprecatedAppConfig = loadDeprecatedConfig(deprecatedOptions);
+    if (!loadedDeprecatedAppConfig) {
+      throw new Error(`No configuration for the Custom Application found.`);
+    }
+    // Return the legacy config as-is, no need to transform it.
+    return loadedDeprecatedAppConfig;
+  }


This is the logic where we try to load the deprecated files, in case the new config file was not found.

If you have other suggestions for implementing this logic, please let me know.

emmenko · 2020-07-15T10:20:25Z

...s/application-shell/src/components/redirect-to-project-create/redirect-to-project-create.tsx

-      <Text.Headline as="h3">Please create a project!</Text.Headline>
-      <Text.Body>
-        You are using the Merchant Center in development mode - it is not served
-        by a proxy (`env.json`). Moreover, you do not have any projects yet. As


Since this message was referring to the env.json, I took the liberty to improve the UI a bit, as well as to adjust the information message.

Note that this message only appears in development, when the user has no projects.

emmenko · 2020-07-15T10:21:13Z

packages/mc-html-template/README.md


-#### `loadEnv(configPath: String): Object`


The loadEnv export has been removed. I don't think we need to consider it a breaking change, as it's like an internal API.

emmenko · 2020-07-15T10:21:41Z

packages/mc-html-template/README.md

-More information about required values and references can be found in the [Runtime Configuration
-](https://docs.commercetools.com/custom-applications/deployment/runtime-configuration) documentation of Custom Applications.
-
-#### `loadHeaders(env: Object, { headersPath: String, cspPath?: String }): Object`


Same here, the loadHeaders export has been removed. I don't think we need to consider it a breaking change, as it's like an internal API.

It is becomes we can re-add it silently if somebody asks for it.

emmenko · 2020-07-15T10:22:21Z

packages/mc-html-template/README.md

-](https://docs.commercetools.com/custom-applications/deployment/runtime-configuration) documentation of Custom Applications.
-
-#### `loadHeaders(env: Object, { headersPath: String, cspPath?: String }): Object`
+#### `processHeaders(applicationConfig: Object, { env: Object, headers: Object }): Object`


The processHeaders is the new export, which is basically the same as the loadHeaders, only with different arguments.

tdeekens

Not much to add. I read it all but I think this is pretty good! :)

tdeekens · 2020-07-15T13:26:22Z

packages/mc-html-template/README.md

-More information about required values and references can be found in the [Runtime Configuration
-](https://docs.commercetools.com/custom-applications/deployment/runtime-configuration) documentation of Custom Applications.
-
-#### `loadHeaders(env: Object, { headersPath: String, cspPath?: String }): Object`


It is becomes we can re-add it silently if somebody asks for it.

mohib0306

Thanks. Just left a few small comments

packages/application-config/src/load-deprecated-config.ts

mohib0306 · 2020-07-16T07:02:21Z

packages/application-config/src/load-deprecated-config.ts

+  cspPath?: string;
+};
+
+// List the required fields of `env.json`


env.json should be created by the users by themselves and no longer part of the repo. Right?

I'm not 100% sure what you mean here but in general we want to start using the new config file (as we do now). I also need to update the documentation and write a release note (separate PR).
People can still use the env.json file, as long as it's supported. For example, in the next major version v17 we can drop support for that.

Does this answer your question?

yes. That answers the question

packages/application-config/test/process-config.spec.js

* feat: add new package for managing application config * refactor(config): improve JSON schema * refactor: further refine JSON schema * refactor(config): add more text examples * refactor(config): reimplement schema, add basic utility functions * refactor(config): remove navbarMenu from schema, implement main build-config function * refactor(config): use TS, improve schema * chore(config): command typo * test(config): for processing config * chore: ignore build folder * fix(config): ignore prettier for generated schema.ts * refactor(config): rename types * refactor(config): simplify env var interpolation using JSON.parse * fix: version script to support build and dist folders * test(config): improve tests setup * test(config): more validation tests * refactor(config): attempt to read revision * chore(config): keep the package private * docs: improve wording Co-authored-by: Tobias Deekens <tobias.deekens@commercetools.com> * refactor(config): rename var * refactor(config): rename config file to custom-application-config * test(config): use inline snapshots for better readability * fix(config): validation order of cloud identifier * refactor(config): do not use async/await * refactor: migrate to new application config (#1633) * refactor: use new application config package to process env and headers * chore: include application config package in changeset config * refactor(config): fall back to load deprecated config * refactor: migrate codebase to use new application config * refactor: migrate leftovers * docs: document migration to the new config * test: fix import * test(config): for deprecated config files * fix(vrt): build app for dev mode * fix(ci): remove unnecessary step * refactor(config): address feedback Co-authored-by: Tobias Deekens <tobias.deekens@commercetools.com>

emmenko added 6 commits July 15, 2020 10:29

refactor: use new application config package to process env and headers

c076e03

chore: include application config package in changeset config

4c52a1f

refactor(config): fall back to load deprecated config

939d38c

refactor: migrate codebase to use new application config

8066fba

refactor: migrate leftovers

ea48e04

docs: document migration to the new config

e917f40

emmenko commented Jul 15, 2020

View reviewed changes

emmenko mentioned this pull request Jul 15, 2020

feat: add new package for managing application config #1626

Merged

test: fix import

a62eba8

vercel bot temporarily deployed to Preview July 15, 2020 10:29 Inactive

vercel bot temporarily deployed to Preview July 15, 2020 12:37 Inactive

test(config): for deprecated config files

90c55fa

emmenko force-pushed the nm-migrate-app-config branch from 880022f to 90c55fa Compare July 15, 2020 12:37

vercel bot temporarily deployed to Preview July 15, 2020 12:38 Inactive

emmenko marked this pull request as ready for review July 15, 2020 12:45

emmenko requested review from tdeekens and mohib0306 July 15, 2020 12:45

tdeekens approved these changes Jul 15, 2020

View reviewed changes

fix(vrt): build app for dev mode

5e0c37f

vercel bot temporarily deployed to Preview July 15, 2020 14:41 Inactive

fix(ci): remove unnecessary step

2654cb9

emmenko force-pushed the nm-migrate-app-config branch from b5edab8 to 2654cb9 Compare July 15, 2020 16:25

vercel bot temporarily deployed to Preview July 15, 2020 16:25 Inactive

mohib0306 reviewed Jul 16, 2020

View reviewed changes

refactor(config): address feedback

16be1ab

vercel bot temporarily deployed to Preview July 16, 2020 07:28 Inactive

mohib0306 approved these changes Jul 16, 2020

View reviewed changes

emmenko merged commit 6e41e67 into nm-app-config-json-schema Jul 16, 2020

emmenko deleted the nm-migrate-app-config branch July 16, 2020 08:11

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor: migrate to new application config #1633

refactor: migrate to new application config #1633

emmenko commented Jul 15, 2020

changeset-bot bot commented Jul 15, 2020 •

edited

Loading

vercel bot commented Jul 15, 2020 •

edited

Loading

emmenko Jul 15, 2020

emmenko Jul 15, 2020

emmenko Jul 15, 2020

emmenko Jul 15, 2020

emmenko Jul 15, 2020

emmenko Jul 15, 2020

tdeekens Jul 15, 2020

emmenko Jul 15, 2020

tdeekens left a comment

tdeekens Jul 15, 2020

mohib0306 left a comment

mohib0306 Jul 16, 2020

emmenko Jul 16, 2020

mohib0306 Jul 16, 2020

		@@ -1,2 +1 @@
		export { default as processConfig } from './process-config';
		export { default as validateConfig } from './validate-config';

refactor: migrate to new application config #1633

refactor: migrate to new application config #1633

Conversation

emmenko commented Jul 15, 2020

changeset-bot bot commented Jul 15, 2020 • edited Loading

🦋 Changeset is good to go

vercel bot commented Jul 15, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tdeekens left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mohib0306 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

changeset-bot bot commented Jul 15, 2020 •

edited

Loading

vercel bot commented Jul 15, 2020 •

edited

Loading