From 7dba3f54ee158fc55d63047e71148ce174323ea0 Mon Sep 17 00:00:00 2001 From: Craig Rueda Date: Fri, 6 Dec 2019 13:15:12 -0800 Subject: [PATCH] Adding updates to CONTRIBUTING and UPDATING for app factory changes (#8782) * Adding updates to CONTRIBUTING and UPDATING for app factory changes * Fixing celery_app:app --- CONTRIBUTING.md | 11 +++++++++-- UPDATING.md | 4 ++++ 2 files changed, 13 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c3bdaa86c..4972ca1be 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -370,6 +370,9 @@ superset load_examples FLASK_ENV=development superset run -p 8088 --with-threads --reload --debugger ``` +**Note: the FLASK_APP env var should not need to be set, as it's currently controlled +via `.flaskenv`, however if needed, it should be set to `superset.app:create_app()`** + If you have made changes to the FAB-managed templates, which are not built the same way as the newer, React-powered front-end assets, you need to start the app without the `--with-threads` argument like so: `FLASK_ENV=development superset run -p 8088 --reload --debugger` @@ -387,7 +390,7 @@ def FLASK_APP_MUTATOR(app): Then make sure you run your WSGI server using the right worker type: ```bash -FLASK_ENV=development gunicorn superset:app -k "geventwebsocket.gunicorn.workers.GeventWebSocketWorker" -b 127.0.0.1:8088 --reload +FLASK_ENV=development gunicorn "superset.app:create_app()" -k "geventwebsocket.gunicorn.workers.GeventWebSocketWorker" -b 127.0.0.1:8088 --reload ``` You can log anything to the browser console, including objects: @@ -456,7 +459,7 @@ If you run this service from somewhere other than your local machine, you may ne npm install --global webpack webpack-cli webpack-dev-server ``` -#### Docker +#### Docker (docker-compose) See docs [here](docker/README.md) @@ -835,6 +838,10 @@ To do this, you'll need to: from werkzeug.contrib.cache import FileSystemCache RESULTS_BACKEND = FileSystemCache('/tmp/sqllab') ``` +* Start up a celery worker + ```shell script + celery worker --app=superset.tasks.celery_app:app -Ofair + ``` Note that: * for changes that affect the worker logic, you'll have to diff --git a/UPDATING.md b/UPDATING.md index ca04fe305..aebe63a3e 100644 --- a/UPDATING.md +++ b/UPDATING.md @@ -38,6 +38,10 @@ defaults to False. To enable Druid-API-based functionality, override the * [8450](https://github.com/apache/incubator-superset/pull/8450): The time range picker now uses UTC for the tooltips and default placeholder timestamps (sans timezone). +* [8418](https://github.com/apache/incubator-superset/pull/8418): FLASK_APP / Worker App +have changed. FLASK_APP should be updated to `superset.app:create_app()` and Celery Workers +should be started with `--app=superset.tasks.celery_app:app` + ## 0.35.0 * [8370](https://github.com/apache/incubator-superset/pull/8370): Deprecates