Merge branch 'enext' into cfp-flow-movement-preservation

Author: mariobehling

.dockerignore

@@ -10,3 +10,7 @@ src/dist/
 .venv
 app/.venv
 app/eventyay/static/CACHE
+app/eventyay/static.dist
+*.egg-info
+**/__pycache__
+**/node_modules

.github/workflows/tests.yml

@@ -14,41 +14,34 @@ on:
 
 jobs:
   test:
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     name: Tests
     strategy:
       matrix:
-        python-version: [3.11]
-        database: [sqlite, postgres]
-        exclude:
-          - database: sqlite
-            python-version: 3.11
+        python-version: [3.12]
+        database: [postgres]
     steps:
       - uses: actions/checkout@v4
       - uses: harmon758/postgresql-action@v1
         with:
-          postgresql version: '15'
+          postgresql version: '16'
           postgresql db: 'pretix'
           postgresql user: 'postgres'
           postgresql password: 'postgres'
         if: matrix.database == 'postgres'
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          version: latest
+          enable-cache: true
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: ${{ matrix.python-version }}
-      - uses: actions/cache@v4
-        with:
-          path: ~/.cache/pip
-          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
-          restore-keys: |
-            ${{ runner.os }}-pip-
       - name: Install system dependencies
         run: sudo apt update && sudo apt install gettext
       - name: Install Python dependencies
-        run: |
-          sed -i '/eventyay-stripe/d' pyproject.toml
-          sed -i '/eventyay-paypal/d' pyproject.toml
-          pip3 install --ignore-requires-python -e ".[dev]" psycopg2-binary
+        run: uv sync --all-extras --group test --no-editable
       - name: Run checks
         run: python manage.py check
         working-directory: ./src
@@ -60,10 +53,15 @@ jobs:
         run: make all compress
       - name: Run tests
         working-directory: ./src
-        run: PRETIX_CONFIG_FILE=tests/travis_${{ matrix.database }}.cfg py.test -n 3 -p no:sugar --cov=./ --cov-report=xml --reruns 3 tests --maxfail=100
+        run: pytest -n 3 -p no:sugar --cov=./ --cov-report=xml --reruns 3 tests --maxfail=100
       - name: Upload coverage
         uses: codecov/codecov-action@v1
         with:
           file: src/coverage.xml
           fail_ci_if_error: true
-        if: matrix.database == 'postgres' && matrix.python-version == '3.11' && (github.ref == 'refs/heads/development' || github.ref == 'refs/heads/master')
+        if: matrix.database == 'postgres' && matrix.python-version == '3.12' && (github.ref == 'refs/heads/development' || github.ref == 'refs/heads/master')
+    env:
+      EVY_POSTGRES_HOST: localhost
+      EVY_POSTGRES_PORT: 5432
+      EVY_POSTGRES_USER: postgres
+      EVY_POSTGRES_DB: pretix

.gitignore

@@ -60,6 +60,10 @@ deployment/.env.dev
 deployment/.env.prod
 deployment/.env
 deployment/data
+*.local.cfg
+*.local.toml
+.secrets
+app/.env
 
 # Emails which are not sent out to Internet are saved here.
 dev-sent-emails

README.rst

@@ -1,8 +1,8 @@
 eventyay-tickets (ENext)
 ========================
 
-.. image:: https://codecov.io/gh/fossasia/eventyay/branch/enext/graph/badge.svg
-   :target: https://codecov.io/gh/pretix/pretix
+.. image:: https://codecov.io/gh/fossasia/eventyay-tickets/branch/enext/graph/badge.svg
+  :target: https://codecov.io/gh/pretix/pretix
 
 Project status & release cycle
 ------------------------------
@@ -12,7 +12,7 @@ Welcome to the **Eventyay** project! The ticketing component of the system provi
 ENext is the new and updated version of Eventyay with a unified codebase for the Tickets, Talk, and Videos components.
 
 External Dependencies
----------------------
+----------------------
 
 The *deb-packages.txt* file lists Debian packages we need to install.
 If you are using Debian / Ubuntu, you can install them quickly with this command:
@@ -21,13 +21,13 @@ For traditional shell:
 
 .. code-block:: bash
 
-   $ xargs -a deb-packages.txt sudo apt install
+  $ xargs -a deb-packages.txt sudo apt install
 
 For Nushell:
 
 .. code-block:: nu
 
-   > open deb-packages.txt | lines | sudo apt install ...$in
+  > open deb-packages.txt | lines | sudo apt install ...$in
 
 
 If you are using other Linux distros, please guess the corresponding package names for that list.
@@ -39,31 +39,31 @@ Getting Started
 
 1. **Clone the repository**:
 
-   .. code-block:: bash
+.. code-block:: bash
 
-      git clone https://github.com/fossasia/eventyay.git
+  git clone https://github.com/fossasia/eventyay.git
 
 2. **Enter the project directory and app directory**:
 
-   .. code-block:: bash
+.. code-block:: bash
 
-      cd eventyay/app
+  cd eventyay/app
 
 3. **Switch to the `enext` branch**:
 
-   .. code-block:: bash
+.. code-block:: bash
 
-      git switch enext
+  git switch enext
 
 
 4. **Install Python packages**
 
 Use ``uv`` to create virtual environment and install Python packages at the same time.
 **Make sure you are in app directory**
 
-  .. code-block:: sh
+.. code-block:: sh
 
-    uv sync --all-extras --all-groups
+  uv sync --all-extras --all-groups
 
 
 5. **Create a PostgreSQL database**
@@ -75,69 +75,58 @@ Create a Postgres user with the same name as your Linux user:
 
 .. code-block:: sh
 
-   sudo -u postgres createuser -s $USER
+  sudo -u postgres createuser -s $USER
 
 (``-s`` means *superuser*)
 
 Then just create a database owned by your user:
 
 .. code-block:: sh
 
-   createdb eventyay-db
+  createdb eventyay-db
 
 From now on, you can do everything with the database without specifying password, host and port.
 
 .. code-block:: sh
 
-   psql eventyay-db
-
-In case you cannot take advantage of PostgreSQL *peer* mode, you need to create a *.env* file with these values:
-
-.. code-block:: sh
-
-   POSTGRES_USER=
-   POSTGRES_PASSWORD=
-   POSTGRES_HOST=
-   POSTGRES_PORT=
-
-6. **Activate virtual environment**
+  psql eventyay-db
 
-After running ``uv sync```, activate a virtual environment
-
-  .. code-block:: sh
-
-    . .venv/bin/activate
+In case you cannot take advantage of PostgreSQL *peer* mode, you need to create a *eventyay.local.toml* file with these values:
 
+.. code-block:: toml
 
-7. **Initialize the database**:
+  postgres_user = 'your_db_user'
+  postgres_password = 'your_db_password'
+  postgres_host = 'localhost'
+  postgres_port = 5432
 
-   .. code-block:: bash
+6. **Install and run Redis**
 
-      python manage.py migrate
+7. **Activate virtual environment**
 
-   If you see any Redis issues, Install Redis and start it:
+After running ``uv sync```, activate a virtual environment
 
-   **Update configuration**
+.. code-block:: sh
 
+  . .venv/bin/activate
 
-   Edit ``app/eventyay.cfg`` and change Redis URLs from
-   ``redis://eventyay-next-redis`` **to**
-   ``redis://localhost:6379/``
+8. **Initialize the database**:
 
+.. code-block:: bash
 
-   Do **not** edit the database numbers (0, 1, etc.).
+  python manage.py migrate
 
-8. **Create a admin user account** (for accessing the admin panel):
+9. **Create a admin user account** (for accessing the admin panel):
 
-   .. code-block:: bash
+.. code-block:: bash
 
-      python manage.py create_admin_user
+  python manage.py create_admin_user
 
-9. **Run the development server**:
+10. **Run the development server**:
 
-    .. code-block:: bash
+.. code-block:: bash
 
-       python manage.py runserver
+  python manage.py runserver
 
 
 Notes: If you get permission errors for eventyay/static/CACHE, make sure that the directory and
@@ -166,7 +155,7 @@ We assume your current working directory is the checkout of this repo.
 
    .. code-block:: bash
 
-      docker volume rm eventyay_postgres_data_dev eventyay_static_volume
+  docker volume rm eventyay_postgres_data_dev eventyay_static_volume
 
 4. **Build and run the images**
 
@@ -180,31 +169,84 @@ We assume your current working directory is the checkout of this repo.
    as docker volume. If you see strange behaviour, see the point 3.
    on how to reset.
 
-   .. code-block:: bash
+  .. code-block:: bash
 
-      docker exec -ti eventyay-next-web python manage.py createsuperuser
+  docker exec -ti eventyay-next-web python manage.py createsuperuser
 
 6. **Visit the site**
 
-   Open `http://localhost:8000` in a browser.
+  Open `http://localhost:8000` in a browser.
 
 7. **Checking the logs**
 
-   .. code-block:: bash
+  .. code-block:: bash
 
-      docker compose logs -f
+  docker compose logs -f
 
 
 8. **Shut down**
 
    To shut down the development docker deployment, run
 
-   .. code-block:: bash
+  .. code-block:: bash
 
-      docker compose down
+  docker compose down
 
 The directory `app/eventyay` is mounted into the docker, thus live editing is supported.
 
+Configuration
+-------------
+
+Our configuration are based on TOML files. First of all, check the ``BaseSettings`` class in *app/eventyay/config/next_settings.py* for possible keys and original values.
+Other than that, the configuration is divided to three running environments:
+
+* ``development``: With default values in *eventyay.development.toml*.
+* ``production``: With default values in *eventyay.production.toml*.
+* ``testing``: With default values in *eventyay.testing.toml*.
+
+The values in these files will override ones in ``BaseSettings``.
+
+Running environment is selected via the ``EVY_RUNNING_ENVIRONMENT`` environment variable. It is pre-set in *manage.py*, *wsgi.py* and *asgi.py*.
+For example, if you want to run a command in production environment, you can do:
+
+.. code-block:: bash
+
+  EVY_RUNNING_ENVIRONMENT=production ./manage.py command
+
+How to override the configuration values
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+- Create a file named *eventyay.local.toml* in the same folder as *manage.py* file.
+- Add only the values you want to override in this file. For example, to override the ``debug`` value in production environment, you only need to add one line:
+
+  .. code-block:: toml
+
+    debug = true
+
+- You can also override values via environment variables. The environment variable names are the upper case versions of the setting keys, prefixed by ``EVY_``.
+  For example, to override the ``debug`` value in production environment, you can set the environment variable ``EVY_DEBUG`` to ``true``.
+
+  .. code-block:: bash
+
+    export EVY_DEBUG=true
+
+- Dotenv (*.env*) file is also supported, but please be aware that the values from *.env* file will be overriden by environment variables.
+
+- Sensitive data like passwords, API keys should be provided via files in *.secrets* directory, each file for a key.
+  The file name follows the pattern of environment variable names above (with prefix), the file content is the value.
+  For example, to provide a value for the ``secret_key`` setting, you should create a file named ``EVY_SECRET_KEY`` and put the value inside.
+
+- If you deployed the app via Docker containers, you can provide the secret data via `Docker secrets`_.
+
+Why TOML?
+~~~~~~~~~
+
+TOML has rich data types. In comparison with *ini* format that this project used before, *ini* doesn't have "list" type, we had to define a convention to encode lists in strings.
+This method is not portable, not understood by other tools and libraries, and error-prone.
+TOML has dedicated syntax for lists, making it easier to read and write such configurations, and developers can use different tools and libraries without worrying about incompatibility.
+
+Due to this reason, overriding configuration via environment variables are not encouraged. The environment variables only have one data type: string!
+
 
 Deployment
 ----------
@@ -247,5 +289,4 @@ This project is maintained by **FOSSASIA**. See the AUTHORS file for a list of a
 .. _installation guide: https://docs.eventyay.com/en/latest/admin/installation/index.html
 .. _eventyay.com: https://eventyay.com
 .. _blog: https://blog.eventyay.com
-
-
+.. _Docker secrets: https://docs.docker.com/engine/swarm/secrets/

app/Dockerfile

@@ -10,15 +10,17 @@ ENV PYTHONDONTWRITEBYTECODE=1
 ENV PYTHONUNBUFFERED=1
 
 # install system dependencies
-RUN apt-get update && apt-get install --no-install-recommends -y netcat-traditional git build-essential gettext make npm
+RUN apt-get update && apt-get install -y wget gnupg
+# Repo for newer NodeJS
+RUN wget -qO- https://deb.nodesource.com/gpgkey/nodesource-repo.gpg.key | gpg --dearmor -o /etc/apt/keyrings/nodesource.gpg && \
+    echo "deb [signed-by=/etc/apt/keyrings/nodesource.gpg] https://deb.nodesource.com/node_22.x nodistro main" > /etc/apt/sources.list.d/nodesource.list
+RUN apt-get update && apt-get install --no-install-recommends -y netcat-traditional git build-essential gettext make nodejs
 
 # copy project files
 COPY . .
 
 # install dependencies
 RUN --mount=type=cache,target=/root/.cache/uv \
-    --mount=type=bind,source=uv.lock,target=uv.lock \
-    --mount=type=bind,source=pyproject.toml,target=pyproject.toml \
     uv sync --all-extras --all-groups
 
 # copy entrypoint.sh