kallithea Files · docs/dev/dbmigrations.rst

Files @ b293ec74ef98

Branch filter:

Location: kallithea/docs/dev/dbmigrations.rst

b293ec74ef98 2.9 KiB text/prs.fallenstein.rst Show Annotation Show as Raw Download as Raw

Thomas De Schampheleire

files: restore 'Show Authors' functionality

Commit d66201a7ce6e ("files: change "callbacks" function to the more
descriptive name "post_load_state" and let it take an actual state data
object") broke the 'Show Authors' button when visiting a file
in the files browser. The button normally shows a count of authors and their
avatars, but after the aforementioned commit it did nothing.

Following patch would have fixed the problems in commit d66201a7ce6e:

diff --git a/kallithea/templates/files/files_source.html b/kallithea/templates/files/files_source.html
--- a/kallithea/templates/files/files_source.html
+++ b/kallithea/templates/files/files_source.html
@@ -81,11 +81,13 @@
<script>
$(document).ready(function(){
var state = {
+ data: {
node_list_url: node_list_url.replace('__REV__',${h.js(c.changeset.raw_id)}).replace('__FPATH__', ${h.js(h.safe_unicode(c.file.path))}),
url_base: url_base.replace('__REV__',${h.js(c.changeset.raw_id)}),
rev: ${h.js(c.changeset.raw_id)},
f_path: ${h.js(h.safe_unicode(c.file.path))}
+ }
}
- post_load_state(State.data); // defined in files.html
+ post_load_state(state.data); // defined in files.html
});
</script>

But, later the code got refactored more, and commit 006d68c4d7b9 ("files:
use the web browsers built-in js history instead of native.history.js")
broke the feature further: the click handler for the button no longer got
installed on the 'document-ready' event, but only when a new 'state' is
loaded. And it seems there is never a situation where a new state preserves
the button, so it makes no sense installing the click handler at that
moment.

Instead, move the click handler back to the 'document-ready' event.

=======================
Database schema changes
=======================

Kallithea uses Alembic for :ref:`database migrations <upgrade_db>`
(upgrades and downgrades).

If you are developing a Kallithea feature that requires database schema
changes, you should make a matching Alembic database migration script:

1. :ref:`Create a Kallithea configuration and database <setup>` for testing
   the migration script, or use existing ``development.ini`` setup.

   Ensure that this database is up to date with the latest database
   schema *before* the changes you're currently developing. (Do not
   create the database while your new schema changes are applied.)

2. Create a separate throwaway configuration for iterating on the actual
   database changes::

    kallithea-cli config-create temp.ini

   Edit the file to change database settings. SQLite is typically fine,
   but make sure to change the path to e.g. ``temp.db``, to avoid
   clobbering any existing database file.

3. Make your code changes (including database schema changes in ``db.py``).

4. After every database schema change, recreate the throwaway database
   to test the changes::

    rm temp.db
    kallithea-cli db-create -c temp.ini --repos=/var/repos --user=doe --email doe@example.com --password=123456 --no-public-access --force-yes
    kallithea-cli repo-scan -c temp.ini

5. Once satisfied with the schema changes, auto-generate a draft Alembic
   script using the development database that has *not* been upgraded.
   (The generated script will upgrade the database to match the code.)

   ::

    alembic -c development.ini revision -m "area: add cool feature" --autogenerate

6. Edit the script to clean it up and fix any problems.

   Note that for changes that simply add columns, it may be appropriate
   to not remove them in the downgrade script (and instead do nothing),
   to avoid the loss of data. Unknown columns will simply be ignored by
   Kallithea versions predating your changes.

7. Run ``alembic -c development.ini upgrade head`` to apply changes to
   the (non-throwaway) database, and test the upgrade script. Also test
   downgrades.

   The included ``development.ini`` has full SQL logging enabled. If
   you're using another configuration file, you may want to enable it
   by setting ``level = DEBUG`` in section ``[handler_console_sql]``.

The Alembic migration script should be committed in the same revision as
the database schema (``db.py``) changes.

See the `Alembic documentation`__ for more information, in particular
the tutorial and the section about auto-generating migration scripts.

.. __: http://alembic.zzzcomputing.com/en/latest/


Troubleshooting
---------------

* If ``alembic --autogenerate`` responds "Target database is not up to
  date", you need to either first use Alembic to upgrade the database
  to the most recent version (before your changes), or recreate the
  database from scratch (without your schema changes applied).