Skip to content

🐛 Fix wrong go-style UUID regexp - made portal links fail #6268

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 29, 2024
Merged

🐛 Fix wrong go-style UUID regexp - made portal links fail #6268

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c67b83e
Fix wrong go UUID regexp - made portal links fail
mrnicegyu11 Aug 29, 2024
4a0de8b
Fix wrong go UUID regexp - made portal links fail - 2
mrnicegyu11 Aug 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions services/docker-compose.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -527,7 +527,7 @@ services:
- traefik.http.routers.${SWARM_STACK_NAME}_legacy_services_catchall.service=${SWARM_STACK_NAME}_legacy_services_catchall
- traefik.http.routers.${SWARM_STACK_NAME}_legacy_services_catchall.priority=1
- traefik.http.routers.${SWARM_STACK_NAME}_legacy_services_catchall.entrypoints=http
- traefik.http.routers.${SWARM_STACK_NAME}_legacy_services_catchall.rule=(Path(`/x/{node_uuid:\b[0-9a-f]{8}\b-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-\b[0-9a-f]{12}\b}`) || PathPrefix(`/x/{node_uuid:\b[0-9a-f]{8}\b-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-\b[0-9a-f]{12}\b}/`))
- traefik.http.routers.${SWARM_STACK_NAME}_legacy_services_catchall.rule=PathRegexp(`\/x\/(?i)[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}`)
Copy link
Member

@pcrespov pcrespov Aug 29, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mrnicegyu11 I propose to create a test in tests/environment-setup/test_traefik_setup.py that checks the regex against some known entrypoints

This is an idea of it ...

import pytest
import re
import yaml

# Function to load the docker-compose file and extract the regex
def extract_regex_from_docker_compose(file_path):
    with open(file_path, 'r') as file:
        compose_data = yaml.safe_load(file)
        labels = compose_data['services']['traefik']['labels']
        for label in labels:
            if 'traefik.http.routers' in label and 'PathRegexp' in label:
                # Extract the regex from the label
                regex = re.search(r'PathRegexp\(`(.*)`\)', label).group(1)
                return regex
    return None

# Test cases with parametrized paths
@pytest.mark.parametrize("path,expected", [
    ("/x/12345678-1234-1234-1234-123456789abc", True),  # Valid UUID
    ("/x/abcdef12-3456-7890-abcd-ef1234567890", True),  # Valid UUID
    ("/x/invalid-uuid-1234-1234-1234-123456789abc", False),  # Invalid UUID
    ("/y/12345678-1234-1234-1234-123456789abc", False),  # Valid UUID but wrong path
    ("/x/1234-5678-1234-1234-123456789abc", False),  # Invalid UUID format
])
def test_traefik_path_regex_matching(path: str, expected: bool):
    # Load the regex from the docker-compose file
    regex = extract_regex_from_docker_compose('docker-compose.yml')
    
    # Compile the regex with the appropriate flags (case insensitive)
    compiled_regex = re.compile(regex, re.IGNORECASE)
    
    # Test if the path matches the regex
    match = compiled_regex.match(path)
    assert (match is not None) == expected

# this tricks traefik into a 502 (bad gateway) since the service does not exist on this port
- traefik.http.services.${SWARM_STACK_NAME}_legacy_services_catchall.loadbalancer.server.port=0
# this tricks traefik into returning a 503 (service unavailable) since the healthcheck will always return false
Expand Down Expand Up @@ -748,7 +748,7 @@ services:
- traefik.http.services.${SWARM_STACK_NAME}_webserver.loadbalancer.sticky.cookie.secure=true
- traefik.http.middlewares.${SWARM_STACK_NAME}_webserver_retry.retry.attempts=2
- traefik.http.routers.${SWARM_STACK_NAME}_webserver.service=${SWARM_STACK_NAME}_webserver
- traefik.http.routers.${SWARM_STACK_NAME}_webserver.rule=(Path(`/`) || Path(`/v0`) || Path(`/socket.io/`) || Path(`/static-frontend-data.json`) || Path(`/study/{study_uuid:\b[0-9a-f]{8}\b-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-\b[0-9a-f]{12}\b}`) || Path(`/view`) || Path(`/#/view`) || Path(`/#/error`) || PathPrefix(`/v0/`))
- traefik.http.routers.${SWARM_STACK_NAME}_webserver.rule=(Path(`/`) || Path(`/v0`) || Path(`/socket.io/`) || Path(`/static-frontend-data.json`) || PathRegexp(`\/study\/(?i)[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}`) || Path(`/view`) || Path(`/#/view`) || Path(`/#/error`) || PathPrefix(`/v0/`))
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same story here. We need a way to reliably enforce certain conditions and avoid errors

- traefik.http.routers.${SWARM_STACK_NAME}_webserver.entrypoints=http
- traefik.http.routers.${SWARM_STACK_NAME}_webserver.priority=2
- traefik.http.routers.${SWARM_STACK_NAME}_webserver.middlewares=${SWARM_STACK_NAME}_gzip@swarm, ${SWARM_STACK_NAME_NO_HYPHEN}_sslheader@swarm, ${SWARM_STACK_NAME}_webserver_retry
Expand Down
Loading