[Breaking] refactor: drop mc-http-server, make --use-local-assets the default behavior #1787

emmenko · 2020-10-06T15:14:03Z

TL;DR: The usage of the --use-local-assets flag is confusing and it turns out that this is what you need 99% of the time so we should make it the default behavior.
I also suggest to remove the mc-http-server. I don't see a reason to keep maintaining and having it. People can run compile-html first, then serve the static files however they would like to.

changeset-bot · 2020-10-06T15:14:07Z

🦋 Changeset detected

Latest commit: 8faf3b3

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 20 packages

Name	Type
@commercetools-frontend/application-config	Major
@commercetools-frontend/application-shell	Major
@commercetools-frontend/mc-html-template	Major
@commercetools-frontend/mc-scripts	Major
merchant-center-application-template-starter	Major
@commercetools-frontend/application-shell-connectors	Major
@commercetools-website/custom-applications	Major
@commercetools-frontend/mc-dev-authentication	Major
playground	Major
@commercetools-local/visual-testing-app	Major
@commercetools-backend/loggers	Major
@commercetools-frontend/application-components	Major
@commercetools-frontend/i18n	Major
@commercetools-frontend/jest-preset-mc-app	Major
@commercetools-frontend/react-notifications	Major
@commercetools-frontend/sdk	Major
@commercetools-frontend/sentry	Major
@commercetools-website/components-playground	Patch
@commercetools-frontend/permissions	Major
@commercetools-frontend/l10n	Major

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-10-06T15:14:07Z

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/c6ghb31ei
✅ Preview: https://merchant-center-appli-git-nm-no-http-server-no-use-local-0bea06.commercetools.vercel.app

tdeekens

Thanks. Wondering if we should provide potential security fixes and e.g. dependency updates for the mc-http-server for a bit longer?

emmenko · 2020-10-06T15:23:20Z

Wondering if we should provide potential security fixes and e.g. dependency updates for the mc-http-server for a bit longer?

Hmm you mean in the Docker image?

tdeekens · 2020-10-06T15:24:04Z

Hmm you mean in the Docker image?

Yes, or is it pretty much shallow?

emmenko · 2020-10-06T15:26:43Z

Btw, the current HTTP server version is actually broken (if you don't use the --use-local-assets and you use the Docker image). It's broken because the application config should be automatically loaded, but there is no application config in the Docker image, unless you mount your local project folder.

Given that we haven't had any bug report for the past months, I would assume that nobody is using that anyway.

tdeekens · 2020-10-06T15:33:01Z

Btw, the current HTTP server version is actually broken (if you don't use the --use-local-assets and you use the Docker image). It's broken because the application config should be automatically loaded, but there is no application config in the Docker image, unless you mount your local project folder.

Given that we haven't had any bug report for the past months, I would assume that nobody is using that anyway.

I don't think the conclusion of something broken should be to remove it entirely. I am open to remove the mc-http-server it it's not used widely but not using that argument. I would assume that most Custom Applications didn't migrate to the new application config. Would that be maybe a fair assumption why there are few bug tickets?

emmenko · 2020-10-06T15:37:47Z

Yes and no. We can fix it (which is what I tried to do in the last hour) but doing so requires some (breaking) changes regardless (because of the way the application config is loaded). So I'd rather encourage people to use something else, or use another approach.

tdeekens

Okay then. The old versions used will continue to work if running. I guess we will educate people in the release notes how to migrate. Thanks.

adnasa

I'm open to removing the mc-http-server, just wasn't expecting to initiate this discussion over a PR.

If it is a breaking change regardless, then sure we can remove it.
We'll have to make sure to provide a migration path.

emmenko · 2020-10-06T17:32:03Z

My initial intention was not to remove it obviously. But by looking at what needs to be done it's just not really worth the effort. Hence the suggestion that we simply remove the package.

We'll provide proper documentation to migrate of course.

…havior

emmenko · 2020-10-06T18:06:14Z

application-templates/starter/package.json

@@ -6,7 +6,8 @@
  "scripts": {
    "build": "mc-scripts build",
    "start": "dotenv -- mc-scripts start",
-    "start:prod:local": "NODE_ENV=production MC_APP_ENV=development dotenv -- mc-http-server --use-local-assets",
+    "compile-html": "NODE_ENV=production dotenv -- mc-scripts compile-html",
+    "start:prod:local": "NODE_ENV=production MC_APP_ENV=development dotenv -- mc-scripts compile-html && NODE_ENV=production npx serve -l 3001 public",


To run it locally in production mode, we can do it like this: compile it first, then serve the static file using serve (or any other static server CLI).

emmenko · 2020-10-06T18:06:36Z

application-templates/starter/package.json

@@ -6,7 +6,8 @@
  "scripts": {
    "build": "mc-scripts build",
    "start": "dotenv -- mc-scripts start",
-    "start:prod:local": "NODE_ENV=production MC_APP_ENV=development dotenv -- mc-http-server --use-local-assets",
+    "compile-html": "NODE_ENV=production dotenv -- mc-scripts compile-html",


This is just added for convenience.

emmenko · 2020-10-06T19:05:46Z

application-templates/starter/package.json

@@ -6,7 +6,9 @@
  "scripts": {
    "build": "mc-scripts build",
    "start": "dotenv -- mc-scripts start",
-    "start:prod:local": "NODE_ENV=production MC_APP_ENV=development dotenv -- mc-http-server --use-local-assets",
+    "compile-html": "NODE_ENV=production dotenv -- mc-scripts compile-html",
+    "compile-html:local": "NODE_ENV=production MC_APP_ENV=development dotenv -- mc-scripts compile-html --transformer @commercetools-frontend/mc-dev-authentication/transformer-local.js",


This is turning out to be pretty nice. The mc-dev-authentication package now implements a transformer-local.js that compiles and copies the login/logout routes to the public folder of the application.

This way, everything is still static and we can start the app in production mode locally.

What is also nice is that we can reference npm packages/modules.

--transformer @commercetools-frontend/mc-dev-authentication/transformer-local.js

This is also a bit related to #1733.
We can have a package with pre-configured transformers, which people can also simply copy or extend.

…e with login and logout dev pages

emmenko · 2020-10-06T19:10:54Z

website/src/releases/2020-10/migrating-to-v17.mdx

@@ -1,19 +1,16 @@
 ---
 date: 2020-10-12
-title: Migrating to the new Apollo Client 3.0
+title: Migrating to v17


I've renamed the release note, as it's about migrating to v17 now (which of course includes the apollo v3 migration).

tdeekens

Really nice. The transform local is nice. Feels like it removes concepts and keeps things more concise.

Maybe we should add a note to the application config page that it doesn’t work with the http-server which was deprecated in v17. Just a thought.

…custom application locally

emmenko · 2020-10-07T12:02:47Z

.changeset/poor-avocados-act.md

+  mc-scripts compile-html \
+  --transformer @commercetools-frontend/mc-dev-authentication/transformer-local.js
+
+mc-scripts serve


I forgot that we need to serve the files as a SPA.
The serve package has a --single option that does that but then we loose the routes for the login/logout pages.

Therefore I decided to add a new serve command to mc-scripts, so that we can customize the rewrite routes.
A serve command is something that is also used in other tools, like Gatsby.

In our case the mc-scripts serve command starts an HTTP server to serve the files in the public folder. The main use case for this is to start the Custom Application locally to test the production bundles.

tdeekens · 2020-10-07T12:14:05Z

packages/mc-scripts/src/serve.js

+const server = http.createServer((request, response) => {
+  // You pass two more arguments for config and middleware
+  // More details here: https://github.com/vercel/serve-handler#options
+  return serveHandler(request, response, {


… default behavior (#1787) * refactor: drop mc-http-server, make --use-local-assets the default behavior * fix: ports * docs: remove references to http-server * docs: keep old pages path but link to other documents * docs: changeset * fix: use transformer-local for starting app locally in production mode with login and logout dev pages * fix(website): links * refactor: add mc-scripts serve command to serve the production-built custom application locally * chore: remove refs to mc-http-server

…f @formatjs/cli command (#1790) * [Breaking] Migrate packages to new @apollo/client (#1677) * refactor: migrate to new @apollo/client package * docs: breaking changes * fix: remove es6 import of apollo version * fix(apollo/cache): define type policies, remove unused key fields from product queries * feat: expose apollo hooks with context type bound to MC * docs: draft release notes for migrating to new apollo client * docs(website): divider for release notes content * refactor: remove unused type * fix: tests and build * fix: unused import * fix: test * test: fix leftovers * fix(website): text style workaround * chore: update @graphql-codegen/add to v2 * chore: rebase leftovers * docs(apollo-3): improve description on request context * docs: improve wording * refactor: use apollo-link-logger package * refactor(app-shell): allow to configure the apollo client (and cache) * test: fix assertions * fix: links * fix: prettier Co-authored-by: Adnan Asani <adnasa@users.noreply.github.com> * [Breaking] refactor: drop mc-http-server, make --use-local-assets the default behavior (#1787) * refactor: drop mc-http-server, make --use-local-assets the default behavior * fix: ports * docs: remove references to http-server * docs: keep old pages path but link to other documents * docs: changeset * fix: use transformer-local for starting app locally in production mode with login and logout dev pages * fix(website): links * refactor: add mc-scripts serve command to serve the production-built custom application locally * chore: remove refs to mc-http-server * refactor: remove mc-scripts extract-intl, document usage of @formatjs/cli command Co-authored-by: Adnan Asani <adnasa@users.noreply.github.com>

… default behavior (#1787) * refactor: drop mc-http-server, make --use-local-assets the default behavior * fix: ports * docs: remove references to http-server * docs: keep old pages path but link to other documents * docs: changeset * fix: use transformer-local for starting app locally in production mode with login and logout dev pages * fix(website): links * refactor: add mc-scripts serve command to serve the production-built custom application locally * chore: remove refs to mc-http-server

…f @formatjs/cli command (#1790) * [Breaking] Migrate packages to new @apollo/client (#1677) * refactor: migrate to new @apollo/client package * docs: breaking changes * fix: remove es6 import of apollo version * fix(apollo/cache): define type policies, remove unused key fields from product queries * feat: expose apollo hooks with context type bound to MC * docs: draft release notes for migrating to new apollo client * docs(website): divider for release notes content * refactor: remove unused type * fix: tests and build * fix: unused import * fix: test * test: fix leftovers * fix(website): text style workaround * chore: update @graphql-codegen/add to v2 * chore: rebase leftovers * docs(apollo-3): improve description on request context * docs: improve wording * refactor: use apollo-link-logger package * refactor(app-shell): allow to configure the apollo client (and cache) * test: fix assertions * fix: links * fix: prettier Co-authored-by: Adnan Asani <adnasa@users.noreply.github.com> * [Breaking] refactor: drop mc-http-server, make --use-local-assets the default behavior (#1787) * refactor: drop mc-http-server, make --use-local-assets the default behavior * fix: ports * docs: remove references to http-server * docs: keep old pages path but link to other documents * docs: changeset * fix: use transformer-local for starting app locally in production mode with login and logout dev pages * fix(website): links * refactor: add mc-scripts serve command to serve the production-built custom application locally * chore: remove refs to mc-http-server * refactor: remove mc-scripts extract-intl, document usage of @formatjs/cli command Co-authored-by: Adnan Asani <adnasa@users.noreply.github.com>

… default behavior (#1787) * refactor: drop mc-http-server, make --use-local-assets the default behavior * fix: ports * docs: remove references to http-server * docs: keep old pages path but link to other documents * docs: changeset * fix: use transformer-local for starting app locally in production mode with login and logout dev pages * fix(website): links * refactor: add mc-scripts serve command to serve the production-built custom application locally * chore: remove refs to mc-http-server

…f @formatjs/cli command (#1790) * [Breaking] Migrate packages to new @apollo/client (#1677) * refactor: migrate to new @apollo/client package * docs: breaking changes * fix: remove es6 import of apollo version * fix(apollo/cache): define type policies, remove unused key fields from product queries * feat: expose apollo hooks with context type bound to MC * docs: draft release notes for migrating to new apollo client * docs(website): divider for release notes content * refactor: remove unused type * fix: tests and build * fix: unused import * fix: test * test: fix leftovers * fix(website): text style workaround * chore: update @graphql-codegen/add to v2 * chore: rebase leftovers * docs(apollo-3): improve description on request context * docs: improve wording * refactor: use apollo-link-logger package * refactor(app-shell): allow to configure the apollo client (and cache) * test: fix assertions * fix: links * fix: prettier Co-authored-by: Adnan Asani <adnasa@users.noreply.github.com> * [Breaking] refactor: drop mc-http-server, make --use-local-assets the default behavior (#1787) * refactor: drop mc-http-server, make --use-local-assets the default behavior * fix: ports * docs: remove references to http-server * docs: keep old pages path but link to other documents * docs: changeset * fix: use transformer-local for starting app locally in production mode with login and logout dev pages * fix(website): links * refactor: add mc-scripts serve command to serve the production-built custom application locally * chore: remove refs to mc-http-server * refactor: remove mc-scripts extract-intl, document usage of @formatjs/cli command Co-authored-by: Adnan Asani <adnasa@users.noreply.github.com>

… default behavior (#1787) * refactor: drop mc-http-server, make --use-local-assets the default behavior * fix: ports * docs: remove references to http-server * docs: keep old pages path but link to other documents * docs: changeset * fix: use transformer-local for starting app locally in production mode with login and logout dev pages * fix(website): links * refactor: add mc-scripts serve command to serve the production-built custom application locally * chore: remove refs to mc-http-server

…f @formatjs/cli command (#1790) * [Breaking] Migrate packages to new @apollo/client (#1677) * refactor: migrate to new @apollo/client package * docs: breaking changes * fix: remove es6 import of apollo version * fix(apollo/cache): define type policies, remove unused key fields from product queries * feat: expose apollo hooks with context type bound to MC * docs: draft release notes for migrating to new apollo client * docs(website): divider for release notes content * refactor: remove unused type * fix: tests and build * fix: unused import * fix: test * test: fix leftovers * fix(website): text style workaround * chore: update @graphql-codegen/add to v2 * chore: rebase leftovers * docs(apollo-3): improve description on request context * docs: improve wording * refactor: use apollo-link-logger package * refactor(app-shell): allow to configure the apollo client (and cache) * test: fix assertions * fix: links * fix: prettier Co-authored-by: Adnan Asani <adnasa@users.noreply.github.com> * [Breaking] refactor: drop mc-http-server, make --use-local-assets the default behavior (#1787) * refactor: drop mc-http-server, make --use-local-assets the default behavior * fix: ports * docs: remove references to http-server * docs: keep old pages path but link to other documents * docs: changeset * fix: use transformer-local for starting app locally in production mode with login and logout dev pages * fix(website): links * refactor: add mc-scripts serve command to serve the production-built custom application locally * chore: remove refs to mc-http-server * refactor: remove mc-scripts extract-intl, document usage of @formatjs/cli command Co-authored-by: Adnan Asani <adnasa@users.noreply.github.com>

tdeekens reviewed Oct 6, 2020

View reviewed changes

emmenko mentioned this pull request Oct 6, 2020

Upcoming breaking changes (v17) #1769

Closed

7 tasks

emmenko added 💥 Type: Breaking Change 🚧 Status: WIP Work in progress labels Oct 6, 2020

tdeekens approved these changes Oct 6, 2020

View reviewed changes

adnasa reviewed Oct 6, 2020

View reviewed changes

refactor: drop mc-http-server, make --use-local-assets the default be…

0e4b50c

…havior

adnasa approved these changes Oct 6, 2020

View reviewed changes

emmenko added 3 commits October 6, 2020 19:39

fix: ports

7a49f10

docs: remove references to http-server

d0a04ec

docs: keep old pages path but link to other documents

bd5e232

emmenko force-pushed the nm-no-http-server-no-use-local-assets branch from 6bbad53 to bd5e232 Compare October 6, 2020 18:04

vercel bot had a problem deploying to Preview October 6, 2020 18:04 Failure

emmenko commented Oct 6, 2020

View reviewed changes

docs: changeset

1f178b2

vercel bot had a problem deploying to Preview October 6, 2020 18:17 Failure

vercel bot temporarily deployed to Preview October 6, 2020 19:04 Inactive

emmenko commented Oct 6, 2020

View reviewed changes

fix: use transformer-local for starting app locally in production mod…

09d74f7

…e with login and logout dev pages

emmenko force-pushed the nm-no-http-server-no-use-local-assets branch from e7c72af to 09d74f7 Compare October 6, 2020 19:06

vercel bot had a problem deploying to Preview October 6, 2020 19:06 Failure

emmenko commented Oct 6, 2020

View reviewed changes

fix(website): links

514e619

vercel bot temporarily deployed to Preview October 6, 2020 19:15 Inactive

tdeekens approved these changes Oct 6, 2020

View reviewed changes

refactor: add mc-scripts serve command to serve the production-built …

13b9f67

…custom application locally

vercel bot temporarily deployed to Preview October 7, 2020 11:59 Inactive

emmenko commented Oct 7, 2020

View reviewed changes

tdeekens reviewed Oct 7, 2020

View reviewed changes

emmenko marked this pull request as ready for review October 7, 2020 13:02

chore: remove refs to mc-http-server

8faf3b3

vercel bot temporarily deployed to Preview October 7, 2020 13:20 Inactive

emmenko merged commit c475804 into v17 Oct 7, 2020

emmenko deleted the nm-no-http-server-no-use-local-assets branch October 7, 2020 13:54

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Breaking] refactor: drop mc-http-server, make --use-local-assets the default behavior #1787

[Breaking] refactor: drop mc-http-server, make --use-local-assets the default behavior #1787

emmenko commented Oct 6, 2020

changeset-bot bot commented Oct 6, 2020 •

edited

Loading

vercel bot commented Oct 6, 2020 •

edited

Loading

tdeekens left a comment

emmenko commented Oct 6, 2020

tdeekens commented Oct 6, 2020

emmenko commented Oct 6, 2020

tdeekens commented Oct 6, 2020

emmenko commented Oct 6, 2020

tdeekens left a comment

adnasa left a comment

emmenko commented Oct 6, 2020

emmenko Oct 6, 2020

emmenko Oct 6, 2020

emmenko Oct 6, 2020

emmenko Oct 6, 2020

emmenko Oct 6, 2020

emmenko Oct 6, 2020

tdeekens left a comment

emmenko Oct 7, 2020

tdeekens Oct 7, 2020

[Breaking] refactor: drop mc-http-server, make --use-local-assets the default behavior #1787

[Breaking] refactor: drop mc-http-server, make --use-local-assets the default behavior #1787

Conversation

emmenko commented Oct 6, 2020

changeset-bot bot commented Oct 6, 2020 • edited Loading

🦋 Changeset detected

vercel bot commented Oct 6, 2020 • edited Loading

tdeekens left a comment

Choose a reason for hiding this comment

emmenko commented Oct 6, 2020

tdeekens commented Oct 6, 2020

emmenko commented Oct 6, 2020

tdeekens commented Oct 6, 2020

emmenko commented Oct 6, 2020

tdeekens left a comment

Choose a reason for hiding this comment

adnasa left a comment

Choose a reason for hiding this comment

emmenko commented Oct 6, 2020

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

Choose a reason for hiding this comment

changeset-bot bot commented Oct 6, 2020 •

edited

Loading

vercel bot commented Oct 6, 2020 •

edited

Loading