fix(api): use a more reliable approach to find project root

Author: azzamsa

.gitignore

@@ -13,4 +13,4 @@ config.yml
 compose.yml
 .env
 
-.dockerignore
+cdata

api/pyproject.toml

@@ -31,6 +31,7 @@ managed = true
 dev-dependencies = [
     "pytest>=8.3.2",
     "pytest-mock>=3.14.0",
+    "ipdb>=0.13.13",
 ]
 
 [tool.hatch.metadata]

api/requirements-dev.lock

@@ -12,6 +12,8 @@
 -e file:.
 aniso8601==9.0.1
     # via flask-restful
+asttokens==2.4.1
+    # via stack-data
 certifi==2024.7.4
     # via requests
 charset-normalizer==3.3.2
@@ -20,8 +22,13 @@ click==8.1.7
     # via flask
 confluent-kafka==2.0.2
     # via rkapi
+decorator==5.1.1
+    # via ipdb
+    # via ipython
 environs==9.5.0
     # via rkapi
+executing==2.0.1
+    # via stack-data
 flask==2.2.3
     # via flask-cors
     # via flask-restful
@@ -36,8 +43,13 @@ idna==3.7
     # via requests
 iniconfig==2.0.0
     # via pytest
+ipdb==0.13.13
+ipython==8.26.0
+    # via ipdb
 itsdangerous==2.2.0
     # via flask
+jedi==0.19.1
+    # via ipython
 jinja2==3.1.4
     # via flask
 libknot==3.2.5
@@ -47,13 +59,27 @@ markupsafe==2.1.5
     # via werkzeug
 marshmallow==3.21.3
     # via environs
+matplotlib-inline==0.1.7
+    # via ipython
 packaging==24.1
     # via marshmallow
     # via pytest
+parso==0.8.4
+    # via jedi
+pexpect==4.9.0
+    # via ipython
 pluggy==1.5.0
     # via pytest
+prompt-toolkit==3.0.47
+    # via ipython
 psycopg2==2.9.5
     # via rkapi
+ptyprocess==0.7.0
+    # via pexpect
+pure-eval==0.2.3
+    # via stack-data
+pygments==2.18.0
+    # via ipython
 pytest==8.3.2
     # via pytest-mock
 pytest-mock==3.14.0
@@ -69,10 +95,20 @@ requests==2.28.2
 setuptools==72.1.0
     # via gunicorn
 six==1.16.0
+    # via asttokens
     # via flask-cors
     # via flask-restful
+stack-data==0.6.3
+    # via ipython
+traitlets==5.14.3
+    # via ipython
+    # via matplotlib-inline
+typing-extensions==4.12.2
+    # via ipython
 urllib3==1.26.19
     # via requests
+wcwidth==0.2.13
+    # via prompt-toolkit
 werkzeug==2.2.2
     # via flask
     # via rkapi

api/src/rkapi/app/controllers/api/meta.py

@@ -7,7 +7,7 @@
 
 class MetaVersion(Resource):
     def get(self):
-        build = helpers.read_version("pyproject.toml", "version")
+        build = helpers.read_version()
 
         data = {"build": build}
         return response(200, data=data, message="OK")

api/src/rkapi/app/helpers/helpers.py

@@ -2,6 +2,7 @@
 import os
 import pathlib
 from functools import wraps
+from flask import current_app
 
 import yaml
 
@@ -78,21 +79,25 @@ def decorated_function(*args, **kwargs):
     return decorated_function
 
 
-def read_file(other_file_name, filename):
-    root_dir = pathlib.Path(other_file_name).resolve().parent
-    path = root_dir.joinpath(filename)
+def root_path() -> pathlib.Path:
+    """Get root path of the app"""
+    return pathlib.Path(os.path.dirname(current_app.instance_path))
 
+
+def read_file(path) -> str | None:
+    path = pathlib.Path(path)
     if path.is_file():
         with open(path, "rb") as f:
             content = f.read().decode("utf-8")
             return content
 
 
-def read_version(other_file_name, filename):
+def read_version() -> str:
     """Read the the current version or build of the app"""
     version = ""
 
-    version = read_file(other_file_name, filename)
+    path = root_path().joinpath("version")
+    version = read_file(path)
     if version:
         version = version.rstrip()
 
@@ -102,21 +107,20 @@ def read_version(other_file_name, filename):
     return version
 
 
-def config_file():
+def config_file() -> pathlib.Path:
     """Return config file path."""
-    path = os.environ.get("RESTKNOT_CONFIG_FILE")
+    path = os.environ.get("RESTKNOT_CONFIG_FILE")  # custom path
     if not path:
-        current_path = pathlib.Path(__file__)
-        path = current_path.parents[2].joinpath("config.yml")
+        path = root_path().joinpath("config.yml")
 
-    is_exists = os.path.exists(path)
-    if is_exists:
+    path = pathlib.Path(path)
+    if path.exists():
         return path
     else:
         raise ValueError(f"Config File Not Found: {path}")
 
 
-def get_config():
+def get_config() -> str:
     """Return config file content."""
     file_ = config_file()
     config = yaml.safe_load(open(file_))