Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CB-349: Gulp to webpack #253

Merged
merged 18 commits into from
Aug 3, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion .babelrc
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
{
"presets": ["es2015", "stage-2"],
"presets": [
"@babel/preset-env"
]
}
5 changes: 2 additions & 3 deletions Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ RUN apt-get update \
ENV PGPASSWORD "critiquebrainz"

# Node
RUN curl -sL https://deb.nodesource.com/setup_6.x | bash -
RUN curl -sL https://deb.nodesource.com/setup_10.x | bash -
RUN apt-get install -y nodejs

RUN pip install uWSGI==2.0.13.1
Expand All @@ -41,13 +41,12 @@ RUN pip install -r requirements.txt

# Node dependencies
COPY ./package.json /code/
COPY ./npm-shrinkwrap.json /code/
RUN npm install

COPY . /code/

# Build static files
RUN ./node_modules/.bin/gulp
RUN npm run build

# Compile translations
RUN pybabel compile -d critiquebrainz/frontend/translations
Expand Down
8 changes: 8 additions & 0 deletions Dockerfile.webpack
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
FROM node:10.15-alpine
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does the builder have to be a separate docker image? Typically we try to share our images as much as possible. The Dockerfile for CB also performs npm install, so as far as I can tell we should be able to build the static files using a container based on that image

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@alastair Well, I just tried to take inspiration from the new setup in LB. 😅 @paramsingh @MonkeyDo what do you guys think about this?

Copy link
Member

@MonkeyDo MonkeyDo Apr 25, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

alastair is absolutely right! If the CB docker image can run npm commands, then there's no need to use another image.

For LB, there was previously nothing using node so the image did not contain node.


RUN mkdir /code
WORKDIR /code

COPY package.json package-lock.json webpack.config.js /code/
RUN npm install

4 changes: 0 additions & 4 deletions admin/compile_resources.sh

This file was deleted.

121 changes: 0 additions & 121 deletions critiquebrainz/frontend/static/gulpfile.js

This file was deleted.

3 changes: 2 additions & 1 deletion critiquebrainz/frontend/static/scripts/leaflet.js
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
import '../styles/leaflet.less';
var L = require('leaflet');
L.Icon.Default.imagePath = '/static/images';
L.Icon.Default.imagePath = '/static/images/';
1 change: 1 addition & 0 deletions critiquebrainz/frontend/static/scripts/main.js
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
import '../styles/main.less';
3 changes: 2 additions & 1 deletion critiquebrainz/frontend/static_manager.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import os.path
import json

MANIFEST_PATH = os.path.join(os.path.dirname(__file__), "static", "build", "rev-manifest.json")
MANIFEST_PATH = os.path.join(os.path.dirname(__file__), "static", "build", "manifest.json")

manifest_content = {}

Expand All @@ -14,6 +14,7 @@ def read_manifest():


def get_static_path(resource_name):

if resource_name not in manifest_content:
return "/static/%s" % resource_name
return "/static/build/%s" % manifest_content[resource_name]
9 changes: 9 additions & 0 deletions docker/docker-compose.dev.yml
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ services:
- db_test
- critiquebrainz_redis
- musicbrainz_db
- static_builder

critiquebrainz_redis:
image: redis:4.0-alpine
Expand All @@ -50,3 +51,11 @@ services:
MB_IMPORT_DUMPS: "true"
ports:
- "5430:5432"

static_builder:
build:
context: ..
dockerfile: Dockerfile.webpack
command: npm run dev
volumes:
- ..:/code:z
20 changes: 4 additions & 16 deletions docs/intro.rst
Original file line number Diff line number Diff line change
Expand Up @@ -123,26 +123,14 @@ Initialization of CritiqueBrainz database is also required::
$ docker-compose -f docker/docker-compose.dev.yml run critiquebrainz python3 \
manage.py init_db --skip-create-db

Then you can start all the services::

$ docker-compose -f docker/docker-compose.dev.yml up -d

Building static files
'''''''''''''''''''''

Current Docker setup for development has one caveat: installation of Node.js dependencies
and static file builds need to be done manually. This is caused by the volume setup.
You will also need to run a command to build the static assets (javascript and css files) for the first run::

After you started development versions of containers with Compose, connect to the main
container::
$ docker-compose -f docker/docker-compose.dev.yml run --rm static_builder npm run pre-dev

$ docker-compose -f docker/docker-compose.dev.yml run critiquebrainz /bin/bash

then install dependencies (it's enough to do this once, unless you modify ``package.json``)
and build static files (needs to be done after any changes to JS or Less)::
Then you can start all the services::

root@<container_id>:/code# npm install
root@<container_id>:/code# ./node_modules/.bin/gulp
$ docker-compose -f docker/docker-compose.dev.yml up -d

Importing data dump
'''''''''''''''''''
Expand Down
2 changes: 0 additions & 2 deletions gulpfile.js

This file was deleted.

2 changes: 1 addition & 1 deletion manage.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
# Files listed here will be monitored for changes in debug mode and will
# force a reload when modified.
OBSERVE_FILES = [
"critiquebrainz/frontend/static/build/rev-manifest.json",
"critiquebrainz/frontend/static/build/manifest.json",
]


Expand Down
Loading