mirror of
https://github.com/overleaf/overleaf.git
synced 2024-10-31 21:21:03 -04:00
662122bb1c
The need for this became very noticeable due to the slowness of filesystem access in docker-in-mac, with a full compile taking over a minute for me in docker. Using make to introduce incremental compile makes this near instantaneous outside of docker (if only a few files have changed), and quick enough inside docker. With incremental compile via make, it compiles quickly enough that re-compiling and restarting the web service automatically when backend files change is quick enough now. This is how the service is run via docker-compose in https://github.com/sharelatex/sharelatex-dev-environment, so it shouldn't be necessary to manually restart the container each time a coffee file changes. At the moment Jenkins pull web modules in via the GitSCM plugin, but I believe this is creating a dependency in Jenkins, where any commits to any of the modules causes all of the web branches to rebuild. By doing it via our own scripts we can hopefully avoid this. It also creates a build process which is reproducible locally. **Note that at the moment in this PR all modules pull from `ja-dockerize-dev` branches, but these should be merged first, and this PR updated to point to the master branches before merging**. This is necessary for other changes to build process/docker-compose workflow. As well as a Makefile for web, there is now a `Makefile.module`. This is copied into each module directory by the top-level Makefile, and is written in a way to be flexible and support unit tests, acceptance tests, front-end js for the ide and main, and the modules `app/coffee` directory, while allowing modules to have some of these missing (not all modules have e.g. acceptance tests, or front-end JS). This will allows us to refine the build process in future, without needing to update the Makefile in each module repo separately (I found this to be a painful part of this development). This makes web compatible with the docker-compose workflow at https://github.com/sharelatex/sharelatex-dev-environment, where each service is running in its own docker container, with networking managed by docker. Previously the Makefile was set up to run unit tests in docker with `make unit_tests`. This now just runs them natively. In the CI, they are run in docker anyway (all steps in Jenkins are), and locally, they run fine natively with `npm run test:unit`, or can be run in docker via https://github.com/sharelatex/sharelatex-dev-environment with `bin/run web_sl npm run test:unit`. Previously we did a lot of juggling with only mounting source files (coffee, less, etc) into the docker container for acceptance tests. This was to avoid creating root owned files if the whole directory was mounted. Now instead the whole web directory is mounted read-only, with the compilation step done outside of the container before running the tests. This allows the host and container to share the `node_modules` folder as well, which avoids needing to `npm install` twice on the CI box, and should speed up the build by a few minutes. On macOS, this would cause a problem with compiled modules if you tried to use the same `node_modules` to run the app natively. However, if running via docker-compose in https://github.com/sharelatex/sharelatex-dev-environment, this is no longer a problem.
222 lines
6.7 KiB
Makefile
222 lines
6.7 KiB
Makefile
DOCKER_COMPOSE_FLAGS ?= -f docker-compose.yml
|
|
BUILD_NUMBER ?= local
|
|
BRANCH_NAME ?= $(shell git rev-parse --abbrev-ref HEAD)
|
|
PROJECT_NAME = web
|
|
|
|
MODULE_DIRS := $(shell find modules -mindepth 1 -maxdepth 1 -type d -not -name '.git' )
|
|
MODULE_MAKEFILES := $(MODULE_DIRS:=/Makefile)
|
|
COFFEE := node_modules/.bin/coffee
|
|
GRUNT := node_modules/.bin/grunt
|
|
APP_COFFEE_FILES := $(shell find app/coffee -name '*.coffee')
|
|
FRONT_END_COFFEE_FILES := $(shell find public/coffee -name '*.coffee')
|
|
TEST_COFFEE_FILES := $(shell find test -name '*.coffee')
|
|
MODULE_MAIN_COFFEE_FILES := $(shell find modules -type f -wholename '*main/index.coffee')
|
|
MODULE_IDE_COFFEE_FILES := $(shell find modules -type f -wholename '*ide/index.coffee')
|
|
COFFEE_FILES := app.coffee $(APP_COFFEE_FILES) $(FRONT_END_COFFEE_FILES) $(TEST_COFFEE_FILES)
|
|
JS_FILES := $(subst coffee,js,$(COFFEE_FILES))
|
|
SHAREJS_COFFEE_FILES := \
|
|
public/coffee/ide/editor/sharejs/header.coffee \
|
|
public/coffee/ide/editor/sharejs/vendor/types/helpers.coffee \
|
|
public/coffee/ide/editor/sharejs/vendor/types/text.coffee \
|
|
public/coffee/ide/editor/sharejs/vendor/types/text-api.coffee \
|
|
public/coffee/ide/editor/sharejs/vendor/client/microevent.coffee \
|
|
public/coffee/ide/editor/sharejs/vendor/client/doc.coffee \
|
|
public/coffee/ide/editor/sharejs/vendor/client/ace.coffee
|
|
LESS_FILES := $(shell find public/stylesheets -name '*.less')
|
|
CSS_FILES := public/stylesheets/style.css public/stylesheets/ol-style.css
|
|
|
|
app.js: app.coffee
|
|
$(COFFEE) --compile --print $< > $@
|
|
|
|
app/js/%.js: app/coffee/%.coffee
|
|
@mkdir -p $(dir $@)
|
|
$(COFFEE) --compile --print $< > $@
|
|
|
|
public/js/%.js: public/coffee/%.coffee
|
|
@mkdir -p $(dir $@)
|
|
$(COFFEE) --output $(dir $@) --map --compile $<
|
|
|
|
test/unit/js/%.js: test/unit/coffee/%.coffee
|
|
@mkdir -p $(dir $@)
|
|
$(COFFEE) --compile --print $< > $@
|
|
|
|
test/acceptance/js/%.js: test/acceptance/coffee/%.coffee
|
|
@mkdir -p $(dir $@)
|
|
$(COFFEE) --compile --print $< > $@
|
|
|
|
test/unit_frontend/js/%.js: test/unit_frontend/coffee/%.coffee
|
|
@mkdir -p $(dir $@)
|
|
$(COFFEE) --compile --print $< > $@
|
|
|
|
test/smoke/js/%.js: test/smoke/coffee/%.coffee
|
|
@mkdir -p $(dir $@)
|
|
$(COFFEE) --compile --print $< > $@
|
|
|
|
public/js/libs/sharejs.js: $(SHAREJS_COFFEE_FILES)
|
|
@echo "Compiling public/js/libs/sharejs.js"
|
|
@echo 'define(["ace/ace"], function() {' > public/js/libs/sharejs.js
|
|
@cat $(SHAREJS_COFFEE_FILES) | $(COFFEE) --stdio --print >> public/js/libs/sharejs.js
|
|
@echo "" >> public/js/libs/sharejs.js
|
|
@echo "return window.sharejs; });" >> public/js/libs/sharejs.js
|
|
|
|
public/js/ide.js: public/coffee/ide.coffee $(MODULE_IDE_COFFEE_FILES)
|
|
@echo Compiling and injecting module includes into public/js/ide.js
|
|
@INCLUDES=""; \
|
|
for dir in modules/*; \
|
|
do \
|
|
MODULE=`echo $$dir | cut -d/ -f2`; \
|
|
if [ -e $$dir/public/coffee/ide/index.coffee ]; then \
|
|
INCLUDES="\"ide/$$MODULE/index\",$$INCLUDES"; \
|
|
fi \
|
|
done; \
|
|
INCLUDES=$${INCLUDES%?}; \
|
|
$(COFFEE) --compile --print $< | \
|
|
sed -e s=\"__IDE_CLIENTSIDE_INCLUDES__\"=$$INCLUDES= \
|
|
> $@
|
|
|
|
public/js/main.js: public/coffee/main.coffee $(MODULE_MAIN_COFFEE_FILES)
|
|
@echo Compiling and injecting module includes into public/js/main.js
|
|
@INCLUDES=""; \
|
|
for dir in modules/*; \
|
|
do \
|
|
MODULE=`echo $$dir | cut -d/ -f2`; \
|
|
if [ -e $$dir/public/coffee/main/index.coffee ]; then \
|
|
INCLUDES="\"main/$$MODULE/index\",$$INCLUDES"; \
|
|
fi \
|
|
done; \
|
|
INCLUDES=$${INCLUDES%?}; \
|
|
$(COFFEE) --compile --print $< | \
|
|
sed -e s=\"__MAIN_CLIENTSIDE_INCLUDES__\"=$$INCLUDES= \
|
|
> $@
|
|
|
|
$(CSS_FILES): $(LESS_FILES)
|
|
$(GRUNT) compile:css
|
|
|
|
minify: $(CSS_FILES) $(JS_FILES)
|
|
$(GRUNT) compile:minify
|
|
|
|
css: $(CSS_FILES)
|
|
|
|
compile: $(JS_FILES) css public/js/libs/sharejs.js public/js/main.js public/js/ide.js
|
|
@$(MAKE) compile_modules
|
|
|
|
compile_full:
|
|
$(COFFEE) -c -p app.coffee > app.js
|
|
$(COFFEE) -o app/js -c app/coffee
|
|
$(COFFEE) -o public/js -c public/coffee
|
|
$(COFFEE) -o test/acceptance/js -c test/acceptance/coffee
|
|
$(COFFEE) -o test/smoke/js -c test/smoke/coffee
|
|
$(COFFEE) -o test/unit/js -c test/unit/coffee
|
|
$(COFFEE) -o test/unit_frontend/js -c test/unit_frontend/coffee
|
|
rm -f public/js/ide.js public/js/main.js # We need to generate ide.js, main.js manually later
|
|
$(MAKE) $(CSS_FILES)
|
|
$(MAKE) compile_modules_full
|
|
$(MAKE) compile # ide.js, main.js, share.js, and anything missed
|
|
|
|
compile_modules: $(MODULE_MAKEFILES)
|
|
@set -e; \
|
|
for dir in $(MODULE_DIRS); \
|
|
do \
|
|
if [ -e $$dir/Makefile ]; then \
|
|
(cd $$dir && $(MAKE) compile); \
|
|
fi; \
|
|
if [ ! -e $$dir/Makefile ]; then \
|
|
echo "No makefile found in $$dir"; \
|
|
fi; \
|
|
done
|
|
|
|
compile_modules_full: $(MODULE_MAKEFILES)
|
|
@set -e; \
|
|
for dir in $(MODULE_DIRS); \
|
|
do \
|
|
if [ -e $$dir/Makefile ]; then \
|
|
echo "Compiling $$dir in full"; \
|
|
(cd $$dir && $(MAKE) compile_full); \
|
|
fi; \
|
|
if [ ! -e $$dir/Makefile ]; then \
|
|
echo "No makefile found in $$dir"; \
|
|
fi; \
|
|
done
|
|
|
|
$(MODULE_MAKEFILES): Makefile.module
|
|
@set -e; \
|
|
for makefile in $(MODULE_MAKEFILES); \
|
|
do \
|
|
cp Makefile.module $$makefile; \
|
|
done
|
|
|
|
clean: clean_app clean_frontend clean_css clean_tests clean_modules
|
|
|
|
clean_app:
|
|
rm -f app.js
|
|
rm -rf app/js
|
|
|
|
clean_frontend:
|
|
rm -rf public/js/{analytics,directives,filters,ide,main,modules,services,utils}
|
|
rm -f public/js/*.js
|
|
rm -f public/js/libs/sharejs.js
|
|
|
|
clean_tests:
|
|
rm -rf test/unit/js
|
|
rm -rf test/acceptance/js
|
|
|
|
clean_modules:
|
|
for dir in modules/*; \
|
|
do \
|
|
rm -f $$dir/index.js; \
|
|
rm -rf $$dir/app/js; \
|
|
rm -rf $$dir/test/unit/js; \
|
|
rm -rf $$dir/test/acceptance/js; \
|
|
done
|
|
|
|
clean_css:
|
|
rm -f public/stylesheets/*.css*
|
|
|
|
clean_ci:
|
|
docker-compose down
|
|
|
|
test: test_unit test_frontend test_acceptance
|
|
|
|
test_unit:
|
|
npm -q run test:unit -- ${MOCHA_ARGS}
|
|
|
|
test_frontend:
|
|
npm -q run test:frontend -- ${MOCHA_ARGS}
|
|
|
|
test_acceptance: test_acceptance_app test_acceptance_modules
|
|
|
|
test_acceptance_app: test_acceptance_app_start_service test_acceptance_app_run
|
|
$(MAKE) test_acceptance_app_stop_service
|
|
|
|
test_acceptance_app_start_service: test_acceptance_app_stop_service
|
|
$(MAKE) compile
|
|
docker-compose ${DOCKER_COMPOSE_FLAGS} up -d test_acceptance
|
|
|
|
test_acceptance_app_stop_service:
|
|
docker-compose ${DOCKER_COMPOSE_FLAGS} stop test_acceptance redis mongo
|
|
|
|
test_acceptance_app_run:
|
|
docker-compose ${DOCKER_COMPOSE_FLAGS} exec -T test_acceptance npm -q run test:acceptance -- ${MOCHA_ARGS}
|
|
|
|
test_acceptance_modules:
|
|
@set -e; \
|
|
for dir in $(MODULE_DIRS); \
|
|
do \
|
|
if [ -e $$dir/test/acceptance ]; then \
|
|
$(MAKE) test_acceptance_module MODULE=$$dir; \
|
|
fi; \
|
|
done
|
|
|
|
test_acceptance_module: $(MODULE_MAKEFILES)
|
|
@if [ -e $(MODULE)/test/acceptance ]; then \
|
|
cd $(MODULE) && $(MAKE) test_acceptance; \
|
|
fi
|
|
|
|
ci:
|
|
MOCHA_ARGS="--reporter tap" \
|
|
$(MAKE) test
|
|
|
|
.PHONY:
|
|
all add install update test test_unit test_frontend test_acceptance \
|
|
test_acceptance_start_service test_acceptance_stop_service \
|
|
test_acceptance_run ci ci_clean compile clean css
|