Railtie yarn check --integrity fails running in development under docker #1568

sauy7 · 2018-06-12T21:13:27Z

Software versions:

Docker for Mac: 18.03.1-ce-mac65 (24312)
ruby: 2.5.1
rails: 5.2.0
webpacker: 3.5.3

Expected behaviour:

I would expect a new containerised Rails 5.2 application to pass the yarn integrity check when starting the application.

Note: Running puma -C config/puma.rb natively on the host Mac OS X does not trigger this issue.

Actual behaviour:

Same error as reported in #1374. When running the rails development server:

========================================
  Your Yarn packages are out of date!
  Please run `yarn install` to update.
========================================

Steps to reproduce:

Create a new Rails 5.2 application, specifying --webpack (other options used in example to reduce the number of moving parts)

$ rails new webpacker-example --webpack --skip-active-record --skip-action-mailer --skip-active-storage --skip-action-cable --skip-turbolinks --skip-test --skip-system-test --no-rc
$ cd webpacker-example
$ yarn install

Add .dockerignore, Dockerfile, .env.docker and docker-compose.yml files as per this gist:
https://gist.github.com/sauy7/d5c732faad876fde8b2d16672b29a992
Run:

docker-compose up --build

Note in the output that:

RUN yarn check --integrity

shows:

yarn check v1.7.0
success Folder in sync.
Done in 0.XXs.

Wait for Rails to try to fully start up.
Observe in server output:

========================================
  Your Yarn packages are out of date!
  Please run `yarn install` to update.
========================================

Note in config/environments/development.rb:

config.webpacker.check_yarn_integrity = true
Edit to:

config.webpacker.check_yarn_integrity = false
Re-run:

docker-compose up --build
Browse to http://localhost:3000 to see the default Rails home page.

The text was updated successfully, but these errors were encountered:

mhbsti · 2018-06-19T17:21:39Z

Hi. I have the same problem.

@sauy7 , got any solutions?

Thanks.

sauy7 · 2018-06-19T17:24:22Z

@mhbsti None, other than running with config.webpacker.check_yarn_integrity = false in development.rb as a workaround.

mhbsti · 2018-06-19T17:27:51Z

Thank you @sauy7 . If my find any public solution here.

andreynering · 2018-07-04T17:15:24Z

Same problem here, but outside Docker

jemminger · 2018-09-07T20:28:53Z

Same problem, deploying to Heroku

dylangrafmyre · 2018-10-11T02:04:16Z

Same problem with running rails in my docker local development.

amiuhle · 2018-11-14T10:42:48Z

Seems like the problem are different bindings for node-sass (and possibly other packages that depend on native libs).

docker exec container yarn check --integrity fails for me with the message "warning Integrity check: Linked modules don't match".

ls node_modules/node-sass/vendor
linux-x64-67

docker exec container ls node_modules/node-sass/vendor/
linux-x64-64
linux-x64-67

Edit: Possible workarounds:

Delete node_modules before building (also delete relevant volumes, eg docker-compose down && docker volume prune)
~~If already on linux-x64, use matching node versions~~

lucasdeassis · 2018-12-13T15:35:10Z

same problem outside docker

IlkhamGaysin · 2018-12-24T17:57:07Z

👍 same on dev without docker

kulte · 2019-01-25T00:28:24Z

What have people done to solve this. It literally just showed up today and I have no idea what I should do!

schodevio · 2019-02-01T22:13:44Z

Try: docker-compose run <service_name_here> yarn

connorshea · 2019-02-02T20:08:47Z

I had this problem but config.webpacker.check_yarn_integrity = false didn't seem to fix it. For anyone else that's an idiot like me, the check_yarn_integrity config needs to be changed in config/environments/development.rb, not config/webpacker.yml. 🤦‍♂️

zhengpd · 2019-08-03T16:19:50Z

~~I put /node_modules into .dockerignore file and the problem is gone. Not sure if this is a general solution.~~

Edited: not a solution since docker compose ignores .dockerignore for volume mount. The problem gone by coincidence at that time.

thephw · 2019-08-15T16:49:36Z

The command it runs if you want to shell into the running container is yarn check --integrity && yarn check --verify-tree. I removed RUN ./bin/webpack from my Dockerfile and this error went away, but I'm confused as to why that would happen.

zhengpd · 2019-08-15T18:18:52Z

The integrity failure comes because docker compose ignores .dockerignore for volume mount, which includes node_modules.

When creating a new Rails application and run yarn install, a node_modules folder is created according to the host environment.
And for the first time to run docker-compose up --build, the node_modules folder inside docker container would be overlaid by the one from host machine, because of the volume mount:

volumes:
  - '.:/usr/src/app'

Error occurs this time since the node modules are not for container environment.

After you run docker-compose run <service_name_here> yarn, the node_modules on host machine would be updated according to the container environment since yarn is run inside container. The error would be gone when trying docker-compose up --build again.

A solution could be to avoid node_modules overlay by using anonymous volume:

volumes:
  - '.:/usr/src/app'
  - '/usr/src/app/node_modules'

thephw · 2019-08-16T00:09:27Z

It still occurs with volume overlays is the baffling part. Our workflow also doesn't involve a local node install so there isn't a local ./app/node_modules folder anyways. Ended up disabling it because the later deployed version is installed with yarn install --frozen-lock and doesn't have any issues 🤷‍♂

volumes:
      - ./app:/app:cached
      - /app/node_modules

omarsotillo · 2019-08-23T13:53:48Z

It still happens 😢

As @connorshea suggested removing the check_yarn_integrity in development fixed, but I don't think is the best way to go.

dmolesUC · 2019-09-17T18:48:59Z

What are the down sides of setting config.webpacker.check_yarn_integrity = false in development? Assuming @zpdsky's explanation is correct, is this likely to lead to a situation where yarn on the host OS (e.g. macOS) installs JS modules that won't behave properly on the container OS, or vice versa?

omarsotillo · 2019-09-30T13:52:28Z

@dmolesUC It often saved me already when running bin/webpacker or rails server with outdated dependencies, so in general it makes sense to have it enabled on development.

etiennevvv · 2020-01-21T21:07:16Z

Any solutions???

jmadkins · 2020-03-27T04:35:59Z

Thanks @zhengpd! Your suggestion worked with rails 5.2.4.1, docker 19.03.8, and yarn 1.17.3.

rafaeljcadena · 2020-03-27T15:56:03Z

What worked for me is not to COPY the yarn.lock to the image by Dockerfile.

yarn.lock must be generate after Dockerfile execute "RUN yarn install". Try remove yarn.lock from your project too and run the "docker-compose up --build" again.

jmadkins · 2020-03-27T20:33:52Z

@rafaeljcadena That seemed to do the trick!

viktorianer · 2020-03-28T12:44:29Z

What worked for me is not to COPY the yarn.lock to the image by Dockerfile.

yarn.lock must be generate after Dockerfile execute "RUN yarn install". Try remove yarn.lock from your project too and run the "docker-compose up --build" again.

But, then you install not the same Versions. Which may not be what you want.

rafaeljcadena · 2020-03-31T21:26:11Z

What worked for me is not to COPY the yarn.lock to the image by Dockerfile.
yarn.lock must be generate after Dockerfile execute "RUN yarn install". Try remove yarn.lock from your project too and run the "docker-compose up --build" again.

But, then you install not the same Versions. Which may not be what you want.

Yes, you can't guarantee the exactly version as in yarn.lock, but in package.json you have the lib versions with safe range.

Uin-Lee · 2020-05-12T23:27:39Z

thanks. i love you

nachoal · 2020-05-30T04:48:48Z

Trying @rafaelfranca suggestion did the trick, here's the end result for my Dockerfile

FROM ruby:2.6

LABEL maintainer="i@codia.co"

# YARN repository
RUN curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | apt-key add -
RUN echo "deb https://dl.yarnpkg.com/debian/ stable main" | tee /etc/apt/sources.list.d/yarn.list

# Convention to use update and install on same line to actually install new packages
# We also use the line separation to make this easier to change
RUN apt-get update -yqq && apt-get install -yqq --no-install-recommends \
nodejs \
yarn

COPY Gemfile* /usr/src/app/
COPY package.json /usr/src/app/

WORKDIR /usr/src/app
RUN bundle install
RUN yarn install
COPY yarn.lock /usr/src/app/
COPY . /usr/src/app/

CMD ["bin/rails", "s", "-b", "0.0.0.0"]

And the docker-compose:

version: '3'

services:
  web:
    build: .
    ports:
    - "3000:3000"

nachoal · 2020-05-31T21:23:33Z

This also fails when deploying to production ended up modifying the image like this:

FROM ruby:2.6

LABEL maintainer="ignacio@codia.co"

# Allow apt to work with https-based sources
RUN apt-get update -yqq && apt-get install -yqq --no-install-recommends \
  apt-transport-https


# Ensure we install an up-to-date version of Node
# see https://github.com/yarnpkg/yarn/issues/2888
RUN curl -sL https://deb.nodesource.com/setup_12.x | bash -

# Ensure latest packages for Yarn
RUN curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | apt-key add -
RUN echo "deb https://dl.yarnpkg.com/debian/ stable main" | \
  tee /etc/apt/sources.list.d/yarn.list

# Convention to use update and install on same line to actually install new packages
# We also use the line separation to make this easier to change
RUN apt-get update -yqq && apt-get install -yqq --no-install-recommends \
  nodejs \
  yarn

COPY Gemfile* /usr/src/app/
COPY package.json /usr/src/app/

WORKDIR /usr/src/app

ENV BUNDLE_PATH /gems

RUN bundle install

COPY package.json yarn.lock ./
RUN yarn install --check-files

COPY . /usr/src/app/



CMD ["bin/rails", "s", "-b", "0.0.0.0"]

the workaround is the COPY package.json yarn.lock ./
and RUN yarn install --check-files

rossta · 2020-08-28T12:23:08Z

@sauy7 Can this issue be closed? The integrity check was removed in #2518

sauy7 · 2020-08-28T12:23:48Z

go for it

stevecondylios · 2021-04-25T17:38:39Z

What does the yarn integrity check do? Are there consequences/risks for disabling it?

iMerica mentioned this issue Aug 16, 2018

Adds optional support for Docker/Compose forem/forem#296

Merged

2 tasks

jakeNiemiec added the docker/VM label Aug 15, 2019

rhymes mentioned this issue Jan 30, 2020

Update yarn.lock forem/forem#5811

Merged

5 tasks

rossta mentioned this issue Apr 1, 2020

Remove yarn integrity check #2518

Merged

inoda mentioned this issue Aug 9, 2020

Docker container definition inoda/ontrack#20

Closed

gauravtiwari closed this as completed Aug 28, 2020

WorkSutton mentioned this issue Jan 7, 2021

Update to webpacker 5.n wearefuturegov/camden-style-guide#9

Open

timirwin mentioned this issue Jan 11, 2021

Update example6 app to Ruby 3.0 and Rails 6.1 RoleModel/rolemodel_rails#40

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Railtie yarn check --integrity fails running in development under docker #1568

Railtie yarn check --integrity fails running in development under docker #1568

sauy7 commented Jun 12, 2018 •

edited

mhbsti commented Jun 19, 2018

sauy7 commented Jun 19, 2018

mhbsti commented Jun 19, 2018

andreynering commented Jul 4, 2018

jemminger commented Sep 7, 2018

dylangrafmyre commented Oct 11, 2018

amiuhle commented Nov 14, 2018 •

edited

lucasdeassis commented Dec 13, 2018

IlkhamGaysin commented Dec 24, 2018

kulte commented Jan 25, 2019

schodevio commented Feb 1, 2019 •

edited

connorshea commented Feb 2, 2019

zhengpd commented Aug 3, 2019 •

edited

thephw commented Aug 15, 2019

zhengpd commented Aug 15, 2019

thephw commented Aug 16, 2019

omarsotillo commented Aug 23, 2019

dmolesUC commented Sep 17, 2019

omarsotillo commented Sep 30, 2019

etiennevvv commented Jan 21, 2020

jmadkins commented Mar 27, 2020

rafaeljcadena commented Mar 27, 2020

jmadkins commented Mar 27, 2020

viktorianer commented Mar 28, 2020

rafaeljcadena commented Mar 31, 2020

Uin-Lee commented May 12, 2020

nachoal commented May 30, 2020

nachoal commented May 31, 2020

rossta commented Aug 28, 2020

sauy7 commented Aug 28, 2020

stevecondylios commented Apr 25, 2021

Railtie yarn check --integrity fails running in development under docker #1568

Railtie yarn check --integrity fails running in development under docker #1568

Comments

sauy7 commented Jun 12, 2018 • edited

mhbsti commented Jun 19, 2018

sauy7 commented Jun 19, 2018

mhbsti commented Jun 19, 2018

andreynering commented Jul 4, 2018

jemminger commented Sep 7, 2018

dylangrafmyre commented Oct 11, 2018

amiuhle commented Nov 14, 2018 • edited

lucasdeassis commented Dec 13, 2018

IlkhamGaysin commented Dec 24, 2018

kulte commented Jan 25, 2019

schodevio commented Feb 1, 2019 • edited

connorshea commented Feb 2, 2019

zhengpd commented Aug 3, 2019 • edited

thephw commented Aug 15, 2019

zhengpd commented Aug 15, 2019

thephw commented Aug 16, 2019

omarsotillo commented Aug 23, 2019

dmolesUC commented Sep 17, 2019

omarsotillo commented Sep 30, 2019

etiennevvv commented Jan 21, 2020

jmadkins commented Mar 27, 2020

rafaeljcadena commented Mar 27, 2020

jmadkins commented Mar 27, 2020

viktorianer commented Mar 28, 2020

rafaeljcadena commented Mar 31, 2020

Uin-Lee commented May 12, 2020

nachoal commented May 30, 2020

nachoal commented May 31, 2020

rossta commented Aug 28, 2020

sauy7 commented Aug 28, 2020

stevecondylios commented Apr 25, 2021

sauy7 commented Jun 12, 2018 •

edited

amiuhle commented Nov 14, 2018 •

edited

schodevio commented Feb 1, 2019 •

edited

zhengpd commented Aug 3, 2019 •

edited