Merge pull request #4285 from freqtrade/ui_deploy

Deploy FreqUI into webserver

freqtrade/commands/__init__.py

@@ -10,8 +10,8 @@ from freqtrade.commands.arguments import Arguments
 from freqtrade.commands.build_config_commands import start_new_config
 from freqtrade.commands.data_commands import (start_convert_data, start_download_data,
                                               start_list_data)
-from freqtrade.commands.deploy_commands import (start_create_userdir, start_new_hyperopt,
-                                                start_new_strategy)
+from freqtrade.commands.deploy_commands import (start_create_userdir, start_install_ui,
+                                                start_new_hyperopt, start_new_strategy)
 from freqtrade.commands.hyperopt_commands import start_hyperopt_list, start_hyperopt_show
 from freqtrade.commands.list_commands import (start_list_exchanges, start_list_hyperopts,
                                               start_list_markets, start_list_strategies,

freqtrade/commands/arguments.py

@@ -70,6 +70,8 @@ ARGS_PLOT_DATAFRAME = ["pairs", "indicators1", "indicators2", "plot_limit",
 ARGS_PLOT_PROFIT = ["pairs", "timerange", "export", "exportfilename", "db_url",
                     "trade_source", "timeframe"]
 
+ARGS_INSTALL_UI = ["erase_ui_only"]
+
 ARGS_SHOW_TRADES = ["db_url", "trade_ids", "print_json"]
 
 ARGS_HYPEROPT_LIST = ["hyperopt_list_best", "hyperopt_list_profitable",
@@ -167,8 +169,8 @@ class Arguments:
 
         from freqtrade.commands import (start_backtesting, start_convert_data, start_create_userdir,
                                         start_download_data, start_edge, start_hyperopt,
-                                        start_hyperopt_list, start_hyperopt_show, start_list_data,
-                                        start_list_exchanges, start_list_hyperopts,
+                                        start_hyperopt_list, start_hyperopt_show, start_install_ui,
+                                        start_list_data, start_list_exchanges, start_list_hyperopts,
                                         start_list_markets, start_list_strategies,
                                         start_list_timeframes, start_new_config, start_new_hyperopt,
                                         start_new_strategy, start_plot_dataframe, start_plot_profit,
@@ -355,6 +357,14 @@ class Arguments:
         test_pairlist_cmd.set_defaults(func=start_test_pairlist)
         self._build_args(optionlist=ARGS_TEST_PAIRLIST, parser=test_pairlist_cmd)
 
+        # Add install-ui subcommand
+        install_ui_cmd = subparsers.add_parser(
+            'install-ui',
+            help='Install FreqUI',
+        )
+        install_ui_cmd.set_defaults(func=start_install_ui)
+        self._build_args(optionlist=ARGS_INSTALL_UI, parser=install_ui_cmd)
+
         # Add Plotting subcommand
         plot_dataframe_cmd = subparsers.add_parser(
             'plot-dataframe',

freqtrade/commands/cli_options.py

@@ -387,6 +387,12 @@ AVAILABLE_CLI_OPTIONS = {
         help='Clean all existing data for the selected exchange/pairs/timeframes.',
         action='store_true',
     ),
+    "erase_ui_only": Arg(
+        '--erase',
+        help="Clean UI folder, don't download new version.",
+        action='store_true',
+        default=False,
+    ),
     # Templating options
     "template": Arg(
         '--template',

freqtrade/commands/deploy_commands.py

@@ -1,7 +1,9 @@
 import logging
 import sys
 from pathlib import Path
-from typing import Any, Dict
+from typing import Any, Dict, Optional, Tuple
+
+import requests
 
 from freqtrade.configuration import setup_utils_configuration
 from freqtrade.configuration.directory_operations import copy_sample_files, create_userdata_dir
@@ -137,3 +139,87 @@ def start_new_hyperopt(args: Dict[str, Any]) -> None:
         deploy_new_hyperopt(args['hyperopt'], new_path, args['template'])
     else:
         raise OperationalException("`new-hyperopt` requires --hyperopt to be set.")
+
+
+def clean_ui_subdir(directory: Path):
+    if directory.is_dir():
+        logger.info("Removing UI directory content.")
+
+        for p in reversed(list(directory.glob('**/*'))):  # iterate contents from leaves to root
+            if p.name in ('.gitkeep', 'fallback_file.html'):
+                continue
+            if p.is_file():
+                p.unlink()
+            elif p.is_dir():
+                p.rmdir()
+
+
+def read_ui_version(dest_folder: Path) -> Optional[str]:
+    file = dest_folder / '.uiversion'
+    if not file.is_file():
+        return None
+
+    with file.open('r') as f:
+        return f.read()
+
+
+def download_and_install_ui(dest_folder: Path, dl_url: str, version: str):
+    from io import BytesIO
+    from zipfile import ZipFile
+
+    logger.info(f"Downloading {dl_url}")
+    resp = requests.get(dl_url).content
+    dest_folder.mkdir(parents=True, exist_ok=True)
+    with ZipFile(BytesIO(resp)) as zf:
+        for fn in zf.filelist:
+            with zf.open(fn) as x:
+                destfile = dest_folder / fn.filename
+                if fn.is_dir():
+                    destfile.mkdir(exist_ok=True)
+                else:
+                    destfile.write_bytes(x.read())
+    with (dest_folder / '.uiversion').open('w') as f:
+        f.write(version)
+
+
+def get_ui_download_url() -> Tuple[str, str]:
+    base_url = 'https://api.github.com/repos/freqtrade/frequi/'
+    # Get base UI Repo path
+
+    resp = requests.get(f"{base_url}releases")
+    resp.raise_for_status()
+    r = resp.json()
+
+    latest_version = r[0]['name']
+    assets = r[0].get('assets', [])
+    dl_url = ''
+    if assets and len(assets) > 0:
+        dl_url = assets[0]['browser_download_url']
+
+    # URL not found - try assets url
+    if not dl_url:
+        assets = r[0]['assets_url']
+        resp = requests.get(assets)
+        r = resp.json()
+        dl_url = r[0]['browser_download_url']
+
+    return dl_url, latest_version
+
+
+def start_install_ui(args: Dict[str, Any]) -> None:
+
+    dest_folder = Path(__file__).parents[1] / 'rpc/api_server/ui/installed/'
+    # First make sure the assets are removed.
+    dl_url, latest_version = get_ui_download_url()
+
+    curr_version = read_ui_version(dest_folder)
+    if curr_version == latest_version and not args.get('erase_ui_only'):
+        logger.info(f"UI already up-to-date, FreqUI Version {curr_version}.")
+        return
+
+    clean_ui_subdir(dest_folder)
+    if args.get('erase_ui_only'):
+        logger.info("Erased UI directory content. Not downloading new version.")
+    else:
+        # Download a new version
+        download_and_install_ui(dest_folder, dl_url, latest_version)

freqtrade/rpc/api_server/ui/fallback_file.html

@@ -0,0 +1,31 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <title>Freqtrade UI</title>
+  <style>
+    body {
+      background-color: #3c3c3c;
+      color: #dedede;
+      text-align: center;
+    }
+    .main-container {
+      display: flex;
+      align-items: center;
+      justify-content: center;
+      flex-direction: column;
+    }
+    h1 {
+      margin-top: 10rem;
+    }
+  </style>
+</head>
+<body>
+  <div class="main-container">
+    <h1>Freqtrade UI not installed.</h1>
+    <p>Please run `freqtrade install-ui` in your terminal to install the UI files and restart your bot.</p>
+    <p>You can then refresh this page and you should see the UI.</p>
+  </div>
+</body>
+</html>

freqtrade/rpc/api_server/web_ui.py

@@ -0,0 +1,31 @@
+from pathlib import Path
+
+from fastapi import APIRouter
+from fastapi.exceptions import HTTPException
+from starlette.responses import FileResponse
+
+
+router_ui = APIRouter()
+
+
+@router_ui.get('/favicon.ico', include_in_schema=False)
+async def favicon():
+    return FileResponse(Path(__file__).parent / 'ui/favicon.ico')
+
+
+@router_ui.get('/{rest_of_path:path}', include_in_schema=False)
+async def index_html(rest_of_path: str):
+    """
+    Emulate path fallback to index.html.
+    """
+    if rest_of_path.startswith('api') or rest_of_path.startswith('.'):
+        raise HTTPException(status_code=404, detail="Not Found")
+    uibase = Path(__file__).parent / 'ui/installed/'
+    if (uibase / rest_of_path).is_file():
+        return FileResponse(str(uibase / rest_of_path))
+
+    index_file = uibase / 'index.html'
+    if not index_file.is_file():
+        return FileResponse(str(uibase.parent / 'fallback_file.html'))
+    # Fall back to index.html, as indicated by vue router docs
+    return FileResponse(str(index_file))

freqtrade/rpc/api_server/webserver.py

@@ -57,12 +57,16 @@ class ApiServer(RPCHandler):
         from freqtrade.rpc.api_server.api_auth import http_basic_or_jwt_token, router_login
         from freqtrade.rpc.api_server.api_v1 import router as api_v1
         from freqtrade.rpc.api_server.api_v1 import router_public as api_v1_public
+        from freqtrade.rpc.api_server.web_ui import router_ui
+
         app.include_router(api_v1_public, prefix="/api/v1")
 
         app.include_router(api_v1, prefix="/api/v1",
                            dependencies=[Depends(http_basic_or_jwt_token)],
                            )
         app.include_router(router_login, prefix="/api/v1", tags=["auth"])
+        # UI Router MUST be last!
+        app.include_router(router_ui, prefix='')
 
         app.add_middleware(
             CORSMiddleware,