mirror of
https://github.com/Novartis/cellxgene-gateway.git
synced 2026-09-20 11:07:59 +08:00
Compare commits
18 Commits
v0.4.0
...
delay_item
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
d747860118 | ||
|
|
79fef57010 | ||
|
|
cd9c0a3671 | ||
|
|
55b268125f | ||
|
|
4df58f9ceb | ||
|
|
8b4565e745 | ||
|
|
c8056991b0 | ||
|
|
1d1d8b4e59 | ||
|
|
a35c6b9b1e | ||
|
|
f260180a76 | ||
|
|
58ae41fe0c | ||
|
|
0c5adc9fef | ||
|
|
34ac73ba01 | ||
|
|
d16a97906c | ||
|
|
3e5accad65 | ||
|
|
903d25763f | ||
|
|
08c546f40a | ||
|
|
b9f4d35812 |
43
.github/workflows/pr-checks.yaml
vendored
43
.github/workflows/pr-checks.yaml
vendored
@@ -52,16 +52,39 @@ jobs:
|
|||||||
eval "$(conda shell.bash hook)"
|
eval "$(conda shell.bash hook)"
|
||||||
conda activate cellxgene-gateway
|
conda activate cellxgene-gateway
|
||||||
coverage report --fail-under 41
|
coverage report --fail-under 41
|
||||||
|
coverage report > coverage.txt
|
||||||
|
coverage html -i
|
||||||
coverage xml -i
|
coverage xml -i
|
||||||
|
|
||||||
- name: "Upload coverage to Codecov"
|
- name: Upload coverage HTML report
|
||||||
uses: codecov/codecov-action@v1
|
uses: actions/upload-artifact@v4
|
||||||
with:
|
with:
|
||||||
token: ${{ secrets.CODECOV_TOKEN }}
|
name: coverage-html
|
||||||
files: ./coverage.xml
|
path: htmlcov/
|
||||||
flags: unittests
|
retention-days: 30
|
||||||
env_vars: OS,PYTHON
|
|
||||||
name: codecov-umbrella
|
- name: Upload coverage xml
|
||||||
fail_ci_if_error: true
|
uses: actions/upload-artifact@v4
|
||||||
path_to_write_report: ./codecov_report.txt
|
with:
|
||||||
verbose: true
|
name: coverage-xml
|
||||||
|
path: coverage.xml
|
||||||
|
retention-days: 30
|
||||||
|
|
||||||
|
- name: Upload coverage summary
|
||||||
|
uses: actions/upload-artifact@v4
|
||||||
|
with:
|
||||||
|
name: coverage-summary
|
||||||
|
path: coverage.txt
|
||||||
|
retention-days: 30
|
||||||
|
# - name: "Upload coverage to Codecov"
|
||||||
|
# if: ${{ github.event_name == 'push' || (github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == github.repository) }}
|
||||||
|
# uses: codecov/codecov-action@v1
|
||||||
|
# with:
|
||||||
|
# token: ${{ secrets.CODECOV_TOKEN }}
|
||||||
|
# files: ./coverage.xml
|
||||||
|
# flags: unittests
|
||||||
|
# env_vars: OS,PYTHON
|
||||||
|
# name: codecov-umbrella
|
||||||
|
# fail_ci_if_error: true
|
||||||
|
# path_to_write_report: ./codecov_report.txt
|
||||||
|
# verbose: true
|
||||||
|
|||||||
15
README.md
15
README.md
@@ -115,6 +115,21 @@ docker run -it --rm \
|
|||||||
-p 8080:8080 \
|
-p 8080:8080 \
|
||||||
cellxgene-gateway
|
cellxgene-gateway
|
||||||
```
|
```
|
||||||
|
## Running cellxgene gateway with start scripts
|
||||||
|
|
||||||
|
For your convenience, we provide start scripts for flask, gunicorn and uwsgi.
|
||||||
|
|
||||||
|
First, set up a .env
|
||||||
|
```bash
|
||||||
|
cp env_example .env
|
||||||
|
# edit .env
|
||||||
|
open .env
|
||||||
|
```
|
||||||
|
|
||||||
|
Then run the scripts in a subshell
|
||||||
|
```bash
|
||||||
|
( ./start_flask.sh )
|
||||||
|
```
|
||||||
|
|
||||||
# Customization
|
# Customization
|
||||||
|
|
||||||
|
|||||||
@@ -148,7 +148,7 @@ class CacheEntry:
|
|||||||
headers = {}
|
headers = {}
|
||||||
copy_headers = [
|
copy_headers = [
|
||||||
"accept",
|
"accept",
|
||||||
"accept-encoding",
|
# "accept-encoding" - removed: let requests library handle compression/decompression
|
||||||
"accept-language",
|
"accept-language",
|
||||||
"cache-control",
|
"cache-control",
|
||||||
"connection",
|
"connection",
|
||||||
@@ -168,9 +168,8 @@ class CacheEntry:
|
|||||||
headers[h] = request.headers[h]
|
headers[h] = request.headers[h]
|
||||||
|
|
||||||
full_path = self.cellxgene_basepath() + subpath + querystring()
|
full_path = self.cellxgene_basepath() + subpath + querystring()
|
||||||
|
cellxgene_response = None
|
||||||
try:
|
try:
|
||||||
cellxgene_response = None
|
|
||||||
if request.method in ["GET", "HEAD", "OPTIONS"]:
|
if request.method in ["GET", "HEAD", "OPTIONS"]:
|
||||||
cellxgene_response = get(full_path, headers=headers)
|
cellxgene_response = get(full_path, headers=headers)
|
||||||
elif request.method == "PUT":
|
elif request.method == "PUT":
|
||||||
|
|||||||
@@ -40,6 +40,12 @@ app = Flask(__name__)
|
|||||||
item_sources = []
|
item_sources = []
|
||||||
default_item_source = None
|
default_item_source = None
|
||||||
|
|
||||||
|
# Guard for lazy initialization so tests can import this module without
|
||||||
|
# triggering environment-dependent side effects. initialize_data_sources()
|
||||||
|
# will set this to True when it has run.
|
||||||
|
data_sources_initialized = False
|
||||||
|
data_sources_init_lock = Lock()
|
||||||
|
|
||||||
|
|
||||||
def _force_https(app):
|
def _force_https(app):
|
||||||
def wrapper(environ, start_response):
|
def wrapper(environ, start_response):
|
||||||
@@ -75,9 +81,87 @@ if (
|
|||||||
x_prefix=env.proxy_fix_prefix,
|
x_prefix=env.proxy_fix_prefix,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
# WSGI middleware to ensure data sources are initialized before the first
|
||||||
|
# WSGI request is handled. This guarantees initialization works under
|
||||||
|
# Gunicorn/uWSGI (which import the module but don't call main()). The
|
||||||
|
# initialize_data_sources() function is idempotent-protected by
|
||||||
|
# data_sources_initialized and data_sources_init_lock.
|
||||||
|
def _init_on_first_wsgi_request(wsgi_app):
|
||||||
|
def middleware(environ, start_response):
|
||||||
|
global data_sources_initialized
|
||||||
|
if not data_sources_initialized:
|
||||||
|
with data_sources_init_lock:
|
||||||
|
if not app.extensions.get("cellxgene_gateway", {}).get("launchtime"):
|
||||||
|
app.extensions.setdefault("cellxgene_gateway", {})[
|
||||||
|
"launchtime"
|
||||||
|
] = current_time_stamp()
|
||||||
|
|
||||||
|
if not data_sources_initialized:
|
||||||
|
initialize_data_sources()
|
||||||
|
|
||||||
|
env.validate()
|
||||||
|
if not item_sources or not len(item_sources):
|
||||||
|
raise Exception(
|
||||||
|
"No data sources specified for Cellxgene Gateway"
|
||||||
|
)
|
||||||
|
|
||||||
|
global default_item_source
|
||||||
|
if default_item_source is None:
|
||||||
|
default_item_source = item_sources[0]
|
||||||
|
|
||||||
|
data_sources_initialized = True
|
||||||
|
return wsgi_app(environ, start_response)
|
||||||
|
|
||||||
|
return middleware
|
||||||
|
|
||||||
|
|
||||||
|
# Wrap the WSGI app so Gunicorn/uWSGI will trigger initialization when the
|
||||||
|
# first request comes in. Tests that need initialization can call
|
||||||
|
# initialize_data_sources() directly.
|
||||||
|
app.wsgi_app = _init_on_first_wsgi_request(app.wsgi_app)
|
||||||
|
|
||||||
cache = BackendCache()
|
cache = BackendCache()
|
||||||
|
|
||||||
|
|
||||||
|
# Initialize data sources - this is defined later in the file but called here
|
||||||
|
# to ensure initialization happens when WSGI servers (Gunicorn) import the module
|
||||||
|
def initialize_data_sources():
|
||||||
|
"""Initialize data sources from environment variables.
|
||||||
|
Called at module import time for WSGI server compatibility (Gunicorn).
|
||||||
|
Uses a guard flag to prevent double initialization within a process."""
|
||||||
|
global default_item_source
|
||||||
|
|
||||||
|
logging.basicConfig(
|
||||||
|
level=env.log_level,
|
||||||
|
format="%(asctime)s:%(name)s:%(levelname)s:%(message)s",
|
||||||
|
)
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
cellxgene_data = os.environ.get("CELLXGENE_DATA", None)
|
||||||
|
cellxgene_bucket = os.environ.get("CELLXGENE_BUCKET", None)
|
||||||
|
|
||||||
|
if cellxgene_bucket is not None:
|
||||||
|
from cellxgene_gateway.items.s3.s3item_source import S3ItemSource
|
||||||
|
|
||||||
|
s3_source = S3ItemSource(cellxgene_bucket, name="s3")
|
||||||
|
item_sources.append(s3_source)
|
||||||
|
default_item_source = s3_source
|
||||||
|
logger.info("Initialized S3 data source")
|
||||||
|
logger.debug(f"S3 bucket: {cellxgene_bucket}")
|
||||||
|
if cellxgene_data is not None:
|
||||||
|
from cellxgene_gateway.items.file.fileitem_source import FileItemSource
|
||||||
|
|
||||||
|
file_source = FileItemSource(cellxgene_data, name="local")
|
||||||
|
item_sources.append(file_source)
|
||||||
|
default_item_source = file_source
|
||||||
|
logger.info("Initialized local file data source")
|
||||||
|
logger.debug(f"Data directory: {cellxgene_data}")
|
||||||
|
if len(item_sources) == 0:
|
||||||
|
raise Exception("Please specify CELLXGENE_DATA or CELLXGENE_BUCKET")
|
||||||
|
flask_util.include_source_in_url = len(item_sources) > 1
|
||||||
|
|
||||||
|
|
||||||
@app.errorhandler(CellxgeneException)
|
@app.errorhandler(CellxgeneException)
|
||||||
def handle_invalid_usage(error):
|
def handle_invalid_usage(error):
|
||||||
message = f"{error.http_status} Error : {error.message}"
|
message = f"{error.http_status} Error : {error.message}"
|
||||||
@@ -169,7 +253,7 @@ entry_lock = Lock()
|
|||||||
|
|
||||||
|
|
||||||
def matching_source(source_name):
|
def matching_source(source_name):
|
||||||
if source_name is None:
|
if source_name is None and default_item_source is not None:
|
||||||
source_name = default_item_source.name
|
source_name = default_item_source.name
|
||||||
matching = [i for i in item_sources if i.name == source_name]
|
matching = [i for i in item_sources if i.name == source_name]
|
||||||
if len(matching) != 1:
|
if len(matching) != 1:
|
||||||
@@ -216,6 +300,11 @@ def do_view(path, source_name=None):
|
|||||||
raise CellxgeneException("User not authorized to access this data", 403)
|
raise CellxgeneException("User not authorized to access this data", 403)
|
||||||
elif match.status == CacheEntryStatus.error:
|
elif match.status == CacheEntryStatus.error:
|
||||||
raise ProcessException.from_cache_entry(match)
|
raise ProcessException.from_cache_entry(match)
|
||||||
|
else:
|
||||||
|
raise CellxgeneException(
|
||||||
|
f"Unexpected cache entry status {match.status} for key {match.key.descriptor}",
|
||||||
|
500,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
@app.route("/cache_status", methods=["GET"])
|
@app.route("/cache_status", methods=["GET"])
|
||||||
@@ -229,28 +318,40 @@ def do_GET_status():
|
|||||||
|
|
||||||
@app.route("/cache_status.json", methods=["GET"])
|
@app.route("/cache_status.json", methods=["GET"])
|
||||||
def do_GET_status_json():
|
def do_GET_status_json():
|
||||||
|
def map_entry(entry):
|
||||||
|
dataset = entry.key.h5ad_item.descriptor
|
||||||
|
annotation_file = entry.key.annotation_descriptor
|
||||||
|
return {
|
||||||
|
"dataset": dataset,
|
||||||
|
"annotation_file": annotation_file,
|
||||||
|
"launchtime": entry.launchtime,
|
||||||
|
"last_access": entry.timestamp,
|
||||||
|
"status": entry.status.name,
|
||||||
|
}
|
||||||
|
|
||||||
return json.dumps(
|
return json.dumps(
|
||||||
{
|
{
|
||||||
"launchtime": app.launchtime,
|
"launchtime": app.extensions.get("cellxgene_gateway", {}).get("launchtime"),
|
||||||
"entry_list": [
|
"entry_list": [map_entry(entry) for entry in cache.entry_list],
|
||||||
{
|
|
||||||
"dataset": entry.key.dataset,
|
|
||||||
"annotation_file": entry.key.annotation_file,
|
|
||||||
"launchtime": entry.launchtime,
|
|
||||||
"last_access": entry.timestamp,
|
|
||||||
"status": entry.status,
|
|
||||||
}
|
|
||||||
for entry in cache.entry_list
|
|
||||||
],
|
|
||||||
}
|
}
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
@app.route("/relaunch/<path:path>", methods=["GET"])
|
def get_cache_key(path):
|
||||||
def do_relaunch(path):
|
if request.args.get("source_name"):
|
||||||
source_name = request.args.get("source_name") or default_item_source.name
|
source_name = request.args.get("source_name")
|
||||||
|
elif default_item_source:
|
||||||
|
source_name = default_item_source.name
|
||||||
|
else:
|
||||||
|
source_name = None
|
||||||
source = matching_source(source_name)
|
source = matching_source(source_name)
|
||||||
key = CacheKey.for_lookup(source, source.lookup(path))
|
key = CacheKey.for_lookup(source, source.lookup(path))
|
||||||
|
return key
|
||||||
|
|
||||||
|
|
||||||
|
@app.route("/relaunch/<path:path>", methods=["GET"])
|
||||||
|
def do_relaunch(path):
|
||||||
|
key = get_cache_key(path)
|
||||||
match = cache.check_entry(key)
|
match = cache.check_entry(key)
|
||||||
if not match is None:
|
if not match is None:
|
||||||
match.terminate()
|
match.terminate()
|
||||||
@@ -262,9 +363,7 @@ def do_relaunch(path):
|
|||||||
|
|
||||||
@app.route("/terminate/<path:path>", methods=["GET"])
|
@app.route("/terminate/<path:path>", methods=["GET"])
|
||||||
def do_terminate(path):
|
def do_terminate(path):
|
||||||
source_name = request.args.get("source_name") or default_item_source.name
|
key = get_cache_key(path)
|
||||||
source = matching_source(source_name)
|
|
||||||
key = CacheKey.for_lookup(source, source.lookup(path))
|
|
||||||
match = cache.check_entry(key)
|
match = cache.check_entry(key)
|
||||||
if not match is None:
|
if not match is None:
|
||||||
match.terminate()
|
match.terminate()
|
||||||
@@ -277,46 +376,29 @@ def ip_address():
|
|||||||
return set_no_cache(resp)
|
return set_no_cache(resp)
|
||||||
|
|
||||||
|
|
||||||
def launch():
|
def start_pruner_thread():
|
||||||
env.validate()
|
|
||||||
if not item_sources or not len(item_sources):
|
|
||||||
raise Exception("No data sources specified for Cellxgene Gateway")
|
|
||||||
|
|
||||||
global default_item_source
|
|
||||||
if default_item_source is None:
|
|
||||||
default_item_source = item_sources[0]
|
|
||||||
|
|
||||||
pruner = PruneProcessCache(cache)
|
pruner = PruneProcessCache(cache)
|
||||||
|
# Run the pruner as a daemon thread so it won't block interpreter
|
||||||
background_thread = Thread(target=pruner)
|
# shutdown (for example when Ctrl-C is used in the main thread).
|
||||||
|
# This avoids "Exception ignored in: <module 'threading'...>" at exit.
|
||||||
|
background_thread = Thread(target=pruner, daemon=True)
|
||||||
background_thread.start()
|
background_thread.start()
|
||||||
|
|
||||||
app.launchtime = current_time_stamp()
|
|
||||||
|
def launch():
|
||||||
|
start_pruner_thread()
|
||||||
|
|
||||||
|
app.extensions.setdefault("cellxgene_gateway", {})[
|
||||||
|
"launchtime"
|
||||||
|
] = current_time_stamp()
|
||||||
app.run(host="0.0.0.0", port=env.gateway_port, debug=False)
|
app.run(host="0.0.0.0", port=env.gateway_port, debug=False)
|
||||||
|
|
||||||
|
|
||||||
|
app.extensions.setdefault("cellxgene_gateway", {})["launchtime"] = None
|
||||||
|
|
||||||
|
|
||||||
def main():
|
def main():
|
||||||
logging.basicConfig(
|
"""CLI entry point for Flask development server."""
|
||||||
level=env.log_level,
|
|
||||||
format="%(asctime)s:%(name)s:%(levelname)s:%(message)s",
|
|
||||||
)
|
|
||||||
cellxgene_data = os.environ.get("CELLXGENE_DATA", None)
|
|
||||||
cellxgene_bucket = os.environ.get("CELLXGENE_BUCKET", None)
|
|
||||||
|
|
||||||
if cellxgene_bucket is not None:
|
|
||||||
from cellxgene_gateway.items.s3.s3item_source import S3ItemSource
|
|
||||||
|
|
||||||
item_sources.append(S3ItemSource(cellxgene_bucket, name="s3"))
|
|
||||||
default_item_source = "s3"
|
|
||||||
if cellxgene_data is not None:
|
|
||||||
from cellxgene_gateway.items.file.fileitem_source import FileItemSource
|
|
||||||
|
|
||||||
item_sources.append(FileItemSource(cellxgene_data, name="local"))
|
|
||||||
default_item_source = "local"
|
|
||||||
if len(item_sources) == 0:
|
|
||||||
raise Exception("Please specify CELLXGENE_DATA or CELLXGENE_BUCKET")
|
|
||||||
flask_util.include_source_in_url = len(item_sources) > 1
|
|
||||||
|
|
||||||
launch()
|
launch()
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
3
env_example
Normal file
3
env_example
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
export CELLXGENE_LOCATION=$(pwd)/.venv/bin/cellxgene
|
||||||
|
export CELLXGENE_DATA=../cellxgene_data
|
||||||
|
export GATEWAY_IP=127.0.0.1
|
||||||
@@ -1,6 +0,0 @@
|
|||||||
export CELLXGENE_LOCATION=$(pwd)/.cellxgene-gateway/bin/cellxgene
|
|
||||||
export CELLXGENE_DATA=../cellxgene_data
|
|
||||||
export GATEWAY_IP=127.0.0.1
|
|
||||||
|
|
||||||
#Once these are set, you run like a normal Flask app
|
|
||||||
cellxgene-gateway
|
|
||||||
41
start_flask.sh
Executable file
41
start_flask.sh
Executable file
@@ -0,0 +1,41 @@
|
|||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
# start_gunicorn.sh - Start Cellxgene Gateway with Gunicorn
|
||||||
|
#
|
||||||
|
# PREREQUISITES:
|
||||||
|
# - Gunicorn installed (included with cellxgene 1.3.0, or: pip install gunicorn)
|
||||||
|
# - Virtual environment activated
|
||||||
|
# - .env file with CELLXGENE_LOCATION and CELLXGENE_DATA (or CELLXGENE_BUCKET)
|
||||||
|
#
|
||||||
|
# USAGE:
|
||||||
|
# ./start_gunicorn.sh
|
||||||
|
|
||||||
|
# Exit on error
|
||||||
|
set -e
|
||||||
|
|
||||||
|
# Get the directory where this script is located
|
||||||
|
SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
|
||||||
|
|
||||||
|
|
||||||
|
# Source environment variables
|
||||||
|
echo "Loading environment variables..."
|
||||||
|
if [ -f "$SCRIPT_DIR/.env" ]; then
|
||||||
|
source "$SCRIPT_DIR/.env"
|
||||||
|
else
|
||||||
|
echo "Error: .env file not found at $SCRIPT_DIR/.env"
|
||||||
|
echo "Please create it with required environment variables"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Verify required environment variables
|
||||||
|
if [ -z "$CELLXGENE_LOCATION" ]; then
|
||||||
|
echo "Error: CELLXGENE_LOCATION not set"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [ -z "$CELLXGENE_DATA" ] && [ -z "$CELLXGENE_BUCKET" ]; then
|
||||||
|
echo "Error: Either CELLXGENE_DATA or CELLXGENE_BUCKET must be set"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
exec cellxgene-gateway
|
||||||
91
start_gunicorn.sh
Executable file
91
start_gunicorn.sh
Executable file
@@ -0,0 +1,91 @@
|
|||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
# start_gunicorn.sh - Start Cellxgene Gateway with Gunicorn
|
||||||
|
#
|
||||||
|
# PREREQUISITES:
|
||||||
|
# - Gunicorn installed (included with cellxgene 1.3.0, or: pip install gunicorn)
|
||||||
|
# - Virtual environment activated
|
||||||
|
# - .env file with CELLXGENE_LOCATION and CELLXGENE_DATA (or CELLXGENE_BUCKET)
|
||||||
|
#
|
||||||
|
# USAGE:
|
||||||
|
# ./start_gunicorn.sh
|
||||||
|
|
||||||
|
# Exit on error
|
||||||
|
set -e
|
||||||
|
|
||||||
|
# Get the directory where this script is located
|
||||||
|
SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
|
||||||
|
|
||||||
|
# Source environment variables
|
||||||
|
echo "Loading environment variables..."
|
||||||
|
if [ -f "$SCRIPT_DIR/.env" ]; then
|
||||||
|
source "$SCRIPT_DIR/.env"
|
||||||
|
else
|
||||||
|
echo "Error: .env file not found at $SCRIPT_DIR/.env"
|
||||||
|
echo "Please create it with required environment variables"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Verify required environment variables
|
||||||
|
if [ -z "$CELLXGENE_LOCATION" ]; then
|
||||||
|
echo "Error: CELLXGENE_LOCATION not set"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [ -z "$CELLXGENE_DATA" ] && [ -z "$CELLXGENE_BUCKET" ]; then
|
||||||
|
echo "Error: Either CELLXGENE_DATA or CELLXGENE_BUCKET must be set"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Gunicorn configuration
|
||||||
|
# WARNING: Multi-worker mode has cache synchronization issues (see plans/002-shared-cache-implementation.md)
|
||||||
|
# Each worker maintains its own in-memory cache, causing 404s for static assets when different
|
||||||
|
# workers handle requests for the same dataset. Use GUNICORN_WORKERS=1 until shared cache is implemented.
|
||||||
|
WORKERS=${GUNICORN_WORKERS:-1}
|
||||||
|
BIND=${GATEWAY_IP:-0.0.0.0}:${GATEWAY_PORT:-5005}
|
||||||
|
TIMEOUT=${GUNICORN_TIMEOUT:-120}
|
||||||
|
WORKER_CLASS=${GUNICORN_WORKER_CLASS:-sync}
|
||||||
|
KEEPALIVE=${GUNICORN_KEEPALIVE:-5}
|
||||||
|
LOG_LEVEL=${GUNICORN_LOG_LEVEL:-info}
|
||||||
|
|
||||||
|
# Production optimization: enable backed mode to reduce memory usage
|
||||||
|
export GATEWAY_ENABLE_BACKED_MODE=${GATEWAY_ENABLE_BACKED_MODE:-true}
|
||||||
|
|
||||||
|
# Check if gunicorn is installed
|
||||||
|
if ! command -v gunicorn &> /dev/null; then
|
||||||
|
echo "Error: gunicorn not found. Install with: pip install gunicorn"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Display configuration
|
||||||
|
echo "Starting Cellxgene Gateway with Gunicorn..."
|
||||||
|
echo "Configuration:"
|
||||||
|
echo " Data source: ${CELLXGENE_DATA:-$CELLXGENE_BUCKET}"
|
||||||
|
echo " Binding to: $BIND"
|
||||||
|
echo " Workers: $WORKERS"
|
||||||
|
echo " Worker class: $WORKER_CLASS"
|
||||||
|
echo " Timeout: ${TIMEOUT}s"
|
||||||
|
echo " Keepalive: ${KEEPALIVE}s"
|
||||||
|
echo " Log level: $LOG_LEVEL"
|
||||||
|
echo " Backed mode: ${GATEWAY_ENABLE_BACKED_MODE}"
|
||||||
|
echo ""
|
||||||
|
|
||||||
|
cd "$SCRIPT_DIR"
|
||||||
|
|
||||||
|
# Start Gunicorn with optimized settings
|
||||||
|
# Additional options you can add via environment variables:
|
||||||
|
# - GUNICORN_MAX_REQUESTS: Restart worker after N requests (prevents memory leaks)
|
||||||
|
# - GUNICORN_MAX_REQUESTS_JITTER: Add randomness to max-requests
|
||||||
|
exec gunicorn cellxgene_gateway.gateway:app \
|
||||||
|
--workers "$WORKERS" \
|
||||||
|
--worker-class "$WORKER_CLASS" \
|
||||||
|
--bind "$BIND" \
|
||||||
|
--timeout "$TIMEOUT" \
|
||||||
|
--keep-alive "$KEEPALIVE" \
|
||||||
|
--access-logfile - \
|
||||||
|
--error-logfile - \
|
||||||
|
--log-level "$LOG_LEVEL" \
|
||||||
|
--preload \
|
||||||
|
${GUNICORN_MAX_REQUESTS:+--max-requests "$GUNICORN_MAX_REQUESTS"} \
|
||||||
|
${GUNICORN_MAX_REQUESTS_JITTER:+--max-requests-jitter "$GUNICORN_MAX_REQUESTS_JITTER"} \
|
||||||
|
"$@"
|
||||||
89
start_uwsgi.sh
Executable file
89
start_uwsgi.sh
Executable file
@@ -0,0 +1,89 @@
|
|||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
# start_uwsgi.sh - Start Cellxgene Gateway with uWSGI
|
||||||
|
#
|
||||||
|
# PREREQUISITES:
|
||||||
|
# - uWSGI installed (pip install uwsgi)
|
||||||
|
# - Virtual environment activated
|
||||||
|
# - .env file with CELLXGENE_LOCATION and CELLXGENE_DATA (or CELLXGENE_BUCKET)
|
||||||
|
#
|
||||||
|
# USAGE:
|
||||||
|
# ./start_uwsgi.sh
|
||||||
|
|
||||||
|
# Exit on error
|
||||||
|
set -e
|
||||||
|
|
||||||
|
# Get the directory where this script is located
|
||||||
|
SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
|
||||||
|
|
||||||
|
# Source environment variables
|
||||||
|
echo "Loading environment variables..."
|
||||||
|
if [ -f "$SCRIPT_DIR/.env" ]; then
|
||||||
|
source "$SCRIPT_DIR/.env"
|
||||||
|
else
|
||||||
|
echo "Error: .env file not found at $SCRIPT_DIR/.env"
|
||||||
|
echo "Please create it with required environment variables"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Verify required environment variables
|
||||||
|
if [ -z "$CELLXGENE_LOCATION" ]; then
|
||||||
|
echo "Error: CELLXGENE_LOCATION not set"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [ -z "$CELLXGENE_DATA" ] && [ -z "$CELLXGENE_BUCKET" ]; then
|
||||||
|
echo "Error: Either CELLXGENE_DATA or CELLXGENE_BUCKET must be set"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
# uWSGI configuration
|
||||||
|
# WARNING: Multi-worker mode has cache synchronization issues (see plans/002-shared-cache-implementation.md)
|
||||||
|
# Each worker maintains its own in-memory cache, causing 404s for static assets when different
|
||||||
|
# workers handle requests for the same dataset. Use UWSGI_WORKERS=1 until shared cache is implemented.
|
||||||
|
WORKERS=${UWSGI_WORKERS:-1}
|
||||||
|
HOST=${GATEWAY_IP:-0.0.0.0}
|
||||||
|
PORT=${GATEWAY_PORT:-5005}
|
||||||
|
TIMEOUT=${UWSGI_TIMEOUT:-120}
|
||||||
|
THREADS=${UWSGI_THREADS:-1}
|
||||||
|
|
||||||
|
# Production optimization: enable backed mode to reduce memory usage
|
||||||
|
export GATEWAY_ENABLE_BACKED_MODE=${GATEWAY_ENABLE_BACKED_MODE:-true}
|
||||||
|
|
||||||
|
# Check if uwsgi is installed
|
||||||
|
if ! command -v uwsgi &> /dev/null; then
|
||||||
|
echo "Error: uwsgi not found. Install with: pip install uwsgi"
|
||||||
|
exit 1
|
||||||
|
else
|
||||||
|
# Display configuration
|
||||||
|
echo "Starting Cellxgene Gateway with uWSGI..."
|
||||||
|
echo "Configuration:"
|
||||||
|
echo " Data source: ${CELLXGENE_DATA:-$CELLXGENE_BUCKET}"
|
||||||
|
echo " Binding to: $HOST:$PORT"
|
||||||
|
echo " Workers: $WORKERS"
|
||||||
|
echo " Threads: $THREADS"
|
||||||
|
echo " Timeout: ${TIMEOUT}s"
|
||||||
|
echo " Backed mode: ${GATEWAY_ENABLE_BACKED_MODE}"
|
||||||
|
echo ""
|
||||||
|
|
||||||
|
cd "$SCRIPT_DIR"
|
||||||
|
|
||||||
|
# Start uWSGI with optimized settings
|
||||||
|
# Additional options you can add via environment variables:
|
||||||
|
# - UWSGI_MAX_REQUESTS: Restart worker after N requests (prevents memory leaks)
|
||||||
|
exec uwsgi \
|
||||||
|
--http "$HOST:$PORT" \
|
||||||
|
--module cellxgene_gateway.gateway:app \
|
||||||
|
--workers "$WORKERS" \
|
||||||
|
--threads "$THREADS" \
|
||||||
|
--harakiri "$TIMEOUT" \
|
||||||
|
--master \
|
||||||
|
--enable-threads \
|
||||||
|
--single-interpreter \
|
||||||
|
--need-app \
|
||||||
|
--die-on-term \
|
||||||
|
--log-x-forwarded-for \
|
||||||
|
${UWSGI_MAX_REQUESTS:+--max-requests "$UWSGI_MAX_REQUESTS"} \
|
||||||
|
"$@"
|
||||||
|
fi
|
||||||
|
|
||||||
@@ -1,13 +1,24 @@
|
|||||||
import unittest
|
import unittest
|
||||||
|
import os
|
||||||
|
import shutil
|
||||||
|
import tempfile
|
||||||
|
|
||||||
from unittest.mock import MagicMock, Mock, patch
|
from unittest.mock import MagicMock, Mock, patch
|
||||||
|
|
||||||
from cellxgene_gateway.gateway import app
|
|
||||||
from cellxgene_gateway.items.item import ItemType
|
from cellxgene_gateway.items.item import ItemType
|
||||||
from cellxgene_gateway.items.s3.s3item import S3Item
|
from cellxgene_gateway.items.s3.s3item import S3Item
|
||||||
from cellxgene_gateway.items.s3.s3item_source import S3ItemSource
|
from cellxgene_gateway.items.s3.s3item_source import S3ItemSource
|
||||||
|
from cellxgene_gateway.gateway import app
|
||||||
|
|
||||||
|
|
||||||
class TestScanDirectory(unittest.TestCase):
|
class TestScanDirectory(unittest.TestCase):
|
||||||
|
def setUp(self):
|
||||||
|
|
||||||
|
self.app = app
|
||||||
|
|
||||||
|
def tearDown(self):
|
||||||
|
pass
|
||||||
|
|
||||||
@patch("s3fs.S3FileSystem")
|
@patch("s3fs.S3FileSystem")
|
||||||
def test_GIVEN_invalid_bucket_THEN_throws_error(self, s3func):
|
def test_GIVEN_invalid_bucket_THEN_throws_error(self, s3func):
|
||||||
class S3Mock:
|
class S3Mock:
|
||||||
@@ -26,6 +37,7 @@ class TestScanDirectory(unittest.TestCase):
|
|||||||
|
|
||||||
@patch("s3fs.S3FileSystem")
|
@patch("s3fs.S3FileSystem")
|
||||||
def test__GIVEN_multilevel_bucket_THEN_properly_recurses_suburls(self, s3func):
|
def test__GIVEN_multilevel_bucket_THEN_properly_recurses_suburls(self, s3func):
|
||||||
|
|
||||||
class S3Mock:
|
class S3Mock:
|
||||||
def exists(path):
|
def exists(path):
|
||||||
if path in [
|
if path in [
|
||||||
@@ -82,7 +94,7 @@ class TestScanDirectory(unittest.TestCase):
|
|||||||
|
|
||||||
s3func.return_value = S3Mock
|
s3func.return_value = S3Mock
|
||||||
source = S3ItemSource("my-bucket")
|
source = S3ItemSource("my-bucket")
|
||||||
with app.test_request_context(query_string="refresh=true") as test_context:
|
with self.app.test_request_context(query_string="refresh=true") as test_context:
|
||||||
tree = source.scan_directory()
|
tree = source.scan_directory()
|
||||||
|
|
||||||
def s3item_compare(i1, i2, msg=""):
|
def s3item_compare(i1, i2, msg=""):
|
||||||
|
|||||||
@@ -1,14 +1,16 @@
|
|||||||
import unittest
|
import unittest
|
||||||
|
import tempfile
|
||||||
|
import os
|
||||||
|
import shutil
|
||||||
|
|
||||||
from flask import Flask
|
from flask import Flask
|
||||||
|
|
||||||
from cellxgene_gateway import flask_util
|
from cellxgene_gateway import flask_util
|
||||||
from cellxgene_gateway.cache_entry import CacheEntry, CacheEntryStatus
|
from cellxgene_gateway.cache_entry import CacheEntry, CacheEntryStatus
|
||||||
from cellxgene_gateway.cache_key import CacheKey
|
from cellxgene_gateway.cache_key import CacheKey
|
||||||
from cellxgene_gateway.gateway import app
|
from cellxgene_gateway.items.item import ItemType
|
||||||
from cellxgene_gateway.items.file.fileitem import FileItem
|
from cellxgene_gateway.items.file.fileitem import FileItem
|
||||||
from cellxgene_gateway.items.file.fileitem_source import FileItemSource
|
from cellxgene_gateway.items.file.fileitem_source import FileItemSource
|
||||||
from cellxgene_gateway.items.item import ItemType
|
from cellxgene_gateway.gateway import app
|
||||||
|
|
||||||
key = CacheKey(
|
key = CacheKey(
|
||||||
FileItem("/czi/", name="pbmc3k.h5ad", type=ItemType.h5ad),
|
FileItem("/czi/", name="pbmc3k.h5ad", type=ItemType.h5ad),
|
||||||
@@ -23,6 +25,9 @@ class TestRenderEntry(unittest.TestCase):
|
|||||||
self.app_context.push()
|
self.app_context.push()
|
||||||
self.client = self.app.test_client()
|
self.client = self.app.test_client()
|
||||||
|
|
||||||
|
def tearDown(self):
|
||||||
|
self.app_context.pop()
|
||||||
|
|
||||||
def test_GIVEN_key_and_port_THEN_returns_loading_CacheEntry(self):
|
def test_GIVEN_key_and_port_THEN_returns_loading_CacheEntry(self):
|
||||||
entry = CacheEntry.for_key("some-key", 1)
|
entry = CacheEntry.for_key("some-key", 1)
|
||||||
self.assertEqual(entry.status, CacheEntryStatus.loading)
|
self.assertEqual(entry.status, CacheEntryStatus.loading)
|
||||||
|
|||||||
@@ -1,3 +1,6 @@
|
|||||||
|
import os
|
||||||
|
import shutil
|
||||||
|
import tempfile
|
||||||
import unittest
|
import unittest
|
||||||
from collections import defaultdict
|
from collections import defaultdict
|
||||||
from unittest.mock import patch
|
from unittest.mock import patch
|
||||||
@@ -10,6 +13,7 @@ from cellxgene_gateway.filecrawl import (
|
|||||||
from cellxgene_gateway.items.file.fileitem import FileItem
|
from cellxgene_gateway.items.file.fileitem import FileItem
|
||||||
from cellxgene_gateway.items.file.fileitem_source import FileItemSource
|
from cellxgene_gateway.items.file.fileitem_source import FileItemSource
|
||||||
from cellxgene_gateway.items.item import ItemTree, ItemType
|
from cellxgene_gateway.items.item import ItemTree, ItemType
|
||||||
|
from cellxgene_gateway.gateway import app
|
||||||
|
|
||||||
source = FileItemSource("/tmp")
|
source = FileItemSource("/tmp")
|
||||||
|
|
||||||
@@ -25,6 +29,14 @@ def make_entry(subpath="somepath", annotations=None):
|
|||||||
|
|
||||||
|
|
||||||
class TestRenderEntry(unittest.TestCase):
|
class TestRenderEntry(unittest.TestCase):
|
||||||
|
def setUp(self):
|
||||||
|
self.app = app
|
||||||
|
self.app_context = self.app.test_request_context()
|
||||||
|
self.app_context.push()
|
||||||
|
|
||||||
|
def tearDown(self):
|
||||||
|
self.app_context.pop()
|
||||||
|
|
||||||
def test_GIVEN_path_both_slash_THEN_view_has_single_slash(self):
|
def test_GIVEN_path_both_slash_THEN_view_has_single_slash(self):
|
||||||
entry = make_entry(subpath="/somepath/")
|
entry = make_entry(subpath="/somepath/")
|
||||||
rendered = render_item(entry, source)
|
rendered = render_item(entry, source)
|
||||||
@@ -47,6 +59,15 @@ class TestRenderEntry(unittest.TestCase):
|
|||||||
|
|
||||||
|
|
||||||
class TestRenderAnnotation(unittest.TestCase):
|
class TestRenderAnnotation(unittest.TestCase):
|
||||||
|
|
||||||
|
def setUp(self):
|
||||||
|
self.app = app
|
||||||
|
self.app_context = self.app.test_request_context()
|
||||||
|
self.app_context.push()
|
||||||
|
|
||||||
|
def tearDown(self):
|
||||||
|
self.app_context.pop()
|
||||||
|
|
||||||
@patch("cellxgene_gateway.filecrawl.enable_annotations", new=True)
|
@patch("cellxgene_gateway.filecrawl.enable_annotations", new=True)
|
||||||
def test_GIVEN_no_annotation_THEN_new_alone(self):
|
def test_GIVEN_no_annotation_THEN_new_alone(self):
|
||||||
entry = make_entry(annotations=None)
|
entry = make_entry(annotations=None)
|
||||||
@@ -103,12 +124,13 @@ class TestRenderItemSource(unittest.TestCase):
|
|||||||
|
|
||||||
class TestRenderItemTree(unittest.TestCase):
|
class TestRenderItemTree(unittest.TestCase):
|
||||||
def setUp(self):
|
def setUp(self):
|
||||||
from cellxgene_gateway.gateway import app
|
|
||||||
|
|
||||||
self.app = app
|
self.app = app
|
||||||
self.app_context = self.app.test_request_context()
|
self.app_context = self.app.test_request_context()
|
||||||
self.app_context.push()
|
self.app_context.push()
|
||||||
|
|
||||||
|
def tearDown(self):
|
||||||
|
self.app_context.pop()
|
||||||
|
|
||||||
@patch("cellxgene_gateway.items.file.fileitem_source.FileItemSource")
|
@patch("cellxgene_gateway.items.file.fileitem_source.FileItemSource")
|
||||||
def test_GIVEN_deep_nested_dirs_THEN_includes_dirs_in_output(self, item_source):
|
def test_GIVEN_deep_nested_dirs_THEN_includes_dirs_in_output(self, item_source):
|
||||||
item_source.name = "FakeSource"
|
item_source.name = "FakeSource"
|
||||||
|
|||||||
54
tests/test_gateway_status_json.py
Normal file
54
tests/test_gateway_status_json.py
Normal file
@@ -0,0 +1,54 @@
|
|||||||
|
import json
|
||||||
|
import unittest
|
||||||
|
from types import SimpleNamespace
|
||||||
|
|
||||||
|
from cellxgene_gateway.gateway import do_GET_status_json, app, cache
|
||||||
|
from cellxgene_gateway.cache_entry import CacheEntry, CacheEntryStatus
|
||||||
|
|
||||||
|
|
||||||
|
class TestGatewayStatusJson(unittest.TestCase):
|
||||||
|
def test_do_GET_status_json_returns_expected_structure(self):
|
||||||
|
# Create a minimal fake key with required attributes
|
||||||
|
h5ad_item = SimpleNamespace(descriptor="somedir/dataset.h5ad")
|
||||||
|
key = SimpleNamespace(
|
||||||
|
h5ad_item=h5ad_item,
|
||||||
|
annotation_descriptor="somedir/dataset_annotations/foo.csv",
|
||||||
|
)
|
||||||
|
|
||||||
|
# Create a CacheEntry with known launchtime/timestamp/status
|
||||||
|
entry = CacheEntry(
|
||||||
|
None,
|
||||||
|
key,
|
||||||
|
8000,
|
||||||
|
111,
|
||||||
|
222,
|
||||||
|
CacheEntryStatus.loaded,
|
||||||
|
None,
|
||||||
|
None,
|
||||||
|
None,
|
||||||
|
None,
|
||||||
|
)
|
||||||
|
|
||||||
|
# Install into the gateway cache and set app launchtime
|
||||||
|
cache.entry_list = [entry]
|
||||||
|
app.extensions.setdefault("cellxgene_gateway", {})["launchtime"] = "LAUNCH_TIME"
|
||||||
|
|
||||||
|
rv = do_GET_status_json()
|
||||||
|
|
||||||
|
data = json.loads(rv)
|
||||||
|
# top-level launchtime comes from app.extensions
|
||||||
|
self.assertEqual("LAUNCH_TIME", data["launchtime"])
|
||||||
|
|
||||||
|
self.assertIn("entry_list", data)
|
||||||
|
self.assertEqual(1, len(data["entry_list"]))
|
||||||
|
|
||||||
|
e = data["entry_list"][0]
|
||||||
|
self.assertEqual("somedir/dataset.h5ad", e["dataset"])
|
||||||
|
self.assertEqual("somedir/dataset_annotations/foo.csv", e["annotation_file"])
|
||||||
|
self.assertEqual("loaded", e["status"])
|
||||||
|
self.assertEqual(111, e["launchtime"])
|
||||||
|
self.assertEqual(222, e["last_access"])
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
unittest.main()
|
||||||
Reference in New Issue
Block a user