openttd / bananas-frontend-web

Front-end to the BaNaNaS API

BaNaNaS web front-end

This is a front-end for browsing and upload content to OpenTTD's content service, called BaNaNaS. It works together with bananas-api, which serves the HTTP API.

See introduction.md for more documentation about the different BaNaNaS components and how they work together.

Development

This front-end is written in Python 3.7 with Flask.

Usage

To start it, you are advised to first create a virtualenv:

npm install
python3 -m venv .env
.env/bin/pip install -r requirements.txt

After this, you can run the flask application by running:

make run

Running via docker

docker build -t openttd/bananas-frontend-web:local .
docker run --rm -p 127.0.0.1:5000:80 openttd/bananas-frontend-web:local

bananas-frontend-web's Issues

Map enums from API to nice looking user-readable values.

The frontend displays enums from the API as it.

Add mappings between api-enum and user-enums:

• Content type: "ai-library" -- "AI Library"
• Availability: "new-games" -- "New games"
• Compatibilty branches: "master" -- "Official branch"

Licenses are probably good enough. "Creative Commons" would be too long in tables.

Handle multiple requests in parallel

Currently the frontend can only handle one request at a time, while waiting for the API.

Two solutions:

• Make the front-end really state-less, so multiple instances can run in parallel. That is, store all session information in cookies. However, don't use Flask's default sessions. While they sign the data to prevent modification, they still expose somewhat-secrets like the API tokens. Encrypt the data instead.
• Reimplement the frontend with aiohttp.

No link to upload new package from the package overview

If you are at for example
http:///manager/base-graphics/4f474658

There is no longer to "upload update".

You have to go back to Manager to find that link. Possibly it might be good to add it in the package overview too.

Instrument edit/upload forms with labels

Andy says:

1) form inputs require labels
2) in most cases, it's difficult to justify marking up forms as tables, we'll want to rework this

Bananas re-starting file-upload when uploading an update

Currently BaNaNas loops file uploads when trying to update existing .grf's in the database.

After ticking the Terms of Service box and uploading the file, the upload starts. Once the upload hits 100%, it takes a short break and re-starts from 0%.

The issue occurs with latest Firefox and Edge browsers. The .grf has been compiled twice and uploaded. Also occurs when the .grf is packed into a zip-file before.

UndefinedError: 'dict object' has no attribute 'description'

Sentry Issue: BANANAS-FRONTEND-WEB-1

UndefinedError: 'dict object' has no attribute 'description'
(13 additional frame(s) were not displayed)
...
  File "jinja2/_compat.py", line 28, in reraise
    raise value.with_traceback(tb)
  File "/code/webclient/templates/manager_package_info.html", line 1, in top-level template code
    {% extends 'base.html' %}
  File "/code/webclient/templates/base.html", line 37, in top-level template code
    {% block content %}{% endblock %}
  File "/code/webclient/templates/manager_package_info.html", line 35, in block "content"
    {% for l in package["description"].splitlines() %}
  File "jinja2/environment.py", line 471, in getattr
    return getattr(obj, attribute)

Exception on /manager/base-graphics/4f474658 [GET]

During editing, wrong dependencies don't result in an error

Edit an existing version
Add some nonsense in the dependency field
Hit save

It saves fine, no errors, and your change is (of course) not processed.

RuntimeError: dictionary changed size during iteration

Sentry Issue: BANANAS-FRONTEND-WEB-2

RuntimeError: dictionary changed size during iteration
(4 additional frame(s) were not displayed)
...
  File "flask/app.py", line 1950, in full_dispatch_request
    rv = self.dispatch_request()
  File "flask/app.py", line 1936, in dispatch_request
    return self.view_functions[rule.endpoint](**req.view_args)
  File "webclient/pages/login.py", line 22, in login
    session = start_session()
  File "webclient/session.py", line 101, in start_session
    cleanup_sessions()
  File "webclient/session.py", line 95, in cleanup_sessions
    for sid, session in _sessions.items():

Exception on /login [GET]

Can't download any packages using the website; therefore, there is misleading info on the front page.

bananas-frontend-web/webclient/templates/main.html

Line 13 in bc57d9f

<li> For downloading content, prefer using OpenTTD's build-in content downloader. But packages are also available for download on this page. </li>

Expected result

The above line should instead read as follows: For downloading content, please use OpenTTD's built-in content downloader.

Actual result

The front page includes a line saying that packages are available for download on the website. However, no packages are available for direct download when using the website, whether the content is for new-games or savegames-only.

Prettify errors returning on edit

Currently the JSON blob is just returned; this could use a bit more userfriendlyness.

"manager" URLs not blocked for content that doesn't belong to you

If after login I for example visit:

https://bananas.staging.openttd.org/manager/newgrf/66724456

It acts like I can edit this package, while I really cannot. When I press save, the API will block the request and not processed it, but it does look weird from a user perspective.

Guess we should check for permissions when visiting those pages, and show an error instead of an edit page.

Wrong "upload update" link in manager package info

In manager package info there is <a href="/manager/new-package">Upload update</a>
But in manager package list it is <a href="/manager/new-package?unique-id={{ package["unique-id"] }}">Upload update</a> (and there's also <a href="/manager/new-package">Upload new content</a>)