Merge pull request #382 from reactioncommerce/fix-378-aldeed-node-modules-conflicts

chore: refactor Docker node_modules linking

Author: nnnnat

.circleci/config.yml

@@ -189,9 +189,8 @@ jobs:
               --env-file docker-cache/.env \
               -e "SNYK_TOKEN=$SNYK_TOKEN" \
               --name reactionapp_web_1 \
-              -w /usr/local/src \
               "$DOCKER_REPOSITORY:$CIRCLE_SHA1" \
-              sh -c "cp reaction-app/package.json ./ && cp reaction-app/.snyk ./ && snyk test"
+              sh -c "snyk test"
 
   publish-npm-package:
     docker:

.reaction/yarnrc-docker.template

@@ -11,5 +11,4 @@ yarn-offline-mirror-pruning true
 
 --install.cache-folder /home/node/.cache/yarn
 --install.ignore-scripts true
---install.modules-folder /usr/local/src/node_modules
 --install.prefer-offline true

Dockerfile

@@ -27,7 +27,7 @@ ARG GIT_SHA1
 ARG LICENSE
 
 ENV APP_SOURCE_DIR=/usr/local/src/reaction-app \
-    PATH=$PATH:/usr/local/src/node_modules/.bin
+    PATH=$PATH:/usr/local/src/reaction-app/node_modules/.bin
 
 LABEL maintainer="Reaction Commerce <[email protected]>" \
       com.reactioncommerce.build-date=$BUILD_DATE \
@@ -57,11 +57,18 @@ LABEL maintainer="Reaction Commerce <[email protected]>" \
 # Because Docker Compose uses a volume for node_modules and volumes are owned
 # by root by default, we have to initially create node_modules here with correct owner.
 # Without this Yarn cannot write packages into node_modules later, when running in a container.
-RUN mkdir -p "/usr/local/src/node_modules" && chown node "/usr/local/src" && chown node "/usr/local/src/node_modules"
-RUN mkdir -p "/usr/local/src/reaction-app/node_modules" && chown node "/usr/local/src/reaction-app" && chown node "/usr/local/src/reaction-app/node_modules"
+RUN mkdir -p "/usr/local/src/reaction-app/node_modules"
+RUN mkdir -p "/usr/local/src/reaction-app/package/node_modules"
+RUN chown node "/usr/local/src"
+RUN chown node "/usr/local/src/reaction-app"
+RUN chown node "/usr/local/src/reaction-app/node_modules"
+RUN chown node "/usr/local/src/reaction-app/package/node_modules"
 
-WORKDIR $APP_SOURCE_DIR/..
-COPY --chown=node package.json yarn.lock $APP_SOURCE_DIR/../
+WORKDIR $APP_SOURCE_DIR
+
+# Note that the two node_modules directories will not be copied during
+# this due to being listed in the `.dockerignore` file.
+COPY --chown=node . $APP_SOURCE_DIR
 
 # Build the dependencies into the Docker image in a cacheable way. Dependencies
 # are only rebuilt when package.json or yarn.lock is modified.
@@ -75,13 +82,20 @@ RUN set -ex; \
       --frozen-lockfile \
       --ignore-scripts \
       --no-cache; \
+    cd package && yarn install \
+      --frozen-lockfile \
+      --ignore-scripts \
+      --no-cache; \
   elif [ "$BUILD_ENV" = "test" ]; then \
     yarn install \
       --frozen-lockfile \
       --ignore-scripts \
       --no-cache; \
-  fi; \
-  rm package.json yarn.lock
+    cd package && yarn install \
+      --frozen-lockfile \
+      --ignore-scripts \
+      --no-cache; \
+  fi;
 
 # For development, we will yarn install on each container start.
 # This ensures that we use our Docker development .yarnrc config
@@ -95,15 +109,6 @@ RUN set -ex; \
 # we already ran yarn install above, it doesn't matter.
 COPY --chown=node ./.reaction/yarnrc-docker.template /home/node/.yarnrc
 
-WORKDIR $APP_SOURCE_DIR
-COPY --chown=node . $APP_SOURCE_DIR
-
-RUN set -ex; \
-    cd package && yarn install \
-      --frozen-lockfile \
-      --ignore-scripts \
-      --no-cache;
-
 # Important: Make sure we're the "node" user before we begin doing things because
 # our tools use "/home/node" as the HOME dir.
 USER node

docker-compose.yml

@@ -17,10 +17,10 @@ services:
       - $HOME/.cache/yarn-offline-mirror:/home/node/.cache/yarn-offline-mirror
       - web-yarn:/home/node/.cache/yarn
       - .:/usr/local/src/reaction-app # link everything from the root folder on the host machine into the container
-      - empty_node_modules:/usr/local/src/reaction-app/node_modules # except do not link the host node_modules in because it will override the container node_modules
-      - node_modules:/usr/local/src/node_modules # persist the node_modules that is used, which is up one folder level in the container
+      - node_modules:/usr/local/src/reaction-app/node_modules # except do not link the host /node_modules in because it will override the container node_modules
+      - package_node_modules:/usr/local/src/reaction-app/package/node_modules # except do not link the host /package/node_modules in because it will override the container node_modules
 
 volumes:
   web-yarn:
-  empty_node_modules:
   node_modules:
+  package_node_modules: