Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
zulip/zerver/migrations/0206_stream_rendered_descri...

32 lines
1.1 KiB
Python
Raw Normal View History

streams: Render and store the stream description from the backend. This commit does the following three things: 1. Update stream model to accomodate rendered description. 2. Render and save the stream rendered description on update. 3. Render and save stream descriptions on creation. Further, the stream's rendered description is also sent whenever the stream's description is being sent. This is preparatory work for eliminating the use of the non-authoritative marked.js markdown parser for stream descriptions.
2019-01-11 13:48:22 +01:00
from django.db import migrations, models
migrations: Use django.db.backends.postgresql.schema. This replaces django.db.backends.postgresql_psycopg2, which has been an alias to django.db.backends.postgresql since Django 1.9.
2020-04-27 07:19:08 +02:00
from django.db.backends.postgresql.schema import DatabaseSchemaEditor
python: Sort migrations/management command imports with isort. This is a preparatory commit for using isort for sorting all of our imports, merging changes to files where we can easily review the changes as something we're happy with. These are also files with relatively little active development, which means we don't expect much merge conflict risk from these changes.
2020-01-14 21:59:46 +01:00
from django.db.migrations.state import StateApps
streams: Render and store the stream description from the backend. This commit does the following three things: 1. Update stream model to accomodate rendered description. 2. Render and save the stream rendered description on update. 3. Render and save stream descriptions on creation. Further, the stream's rendered description is also sent whenever the stream's description is being sent. This is preparatory work for eliminating the use of the non-authoritative marked.js markdown parser for stream descriptions.
2019-01-11 13:48:22 +01:00
stream-descriptions: Create wrapper for rendering stream descriptions. In commit de65a04 we can see that if the need ever arises to modify how stream descriptions are rendered, we would need to make changes at 5 different call points which can be quite cumbersome. So this functionality has been extracted to a new method called 'render_stream_descriptions'.
2019-03-01 09:10:40 +01:00
from zerver.lib.actions import render_stream_description
streams: Render and store the stream description from the backend. This commit does the following three things: 1. Update stream model to accomodate rendered description. 2. Render and save the stream rendered description on update. 3. Render and save stream descriptions on creation. Further, the stream's rendered description is also sent whenever the stream's description is being sent. This is preparatory work for eliminating the use of the non-authoritative marked.js markdown parser for stream descriptions.
2019-01-11 13:48:22 +01:00
python: Sort migrations/management command imports with isort. This is a preparatory commit for using isort for sorting all of our imports, merging changes to files where we can easily review the changes as something we're happy with. These are also files with relatively little active development, which means we don't expect much merge conflict risk from these changes.
2020-01-14 21:59:46 +01:00
streams: Render and store the stream description from the backend. This commit does the following three things: 1. Update stream model to accomodate rendered description. 2. Render and save the stream rendered description on update. 3. Render and save stream descriptions on creation. Further, the stream's rendered description is also sent whenever the stream's description is being sent. This is preparatory work for eliminating the use of the non-authoritative marked.js markdown parser for stream descriptions.
2019-01-11 13:48:22 +01:00
def render_all_stream_descriptions(apps: StateApps, schema_editor: DatabaseSchemaEditor) -> None:
Stream = apps.get_model('zerver', 'Stream')
all_streams = Stream.objects.exclude(description='')
for stream in all_streams:
stream-descriptions: Create wrapper for rendering stream descriptions. In commit de65a04 we can see that if the need ever arises to modify how stream descriptions are rendered, we would need to make changes at 5 different call points which can be quite cumbersome. So this functionality has been extracted to a new method called 'render_stream_descriptions'.
2019-03-01 09:10:40 +01:00
stream.rendered_description = render_stream_description(stream.description)
streams: Render and store the stream description from the backend. This commit does the following three things: 1. Update stream model to accomodate rendered description. 2. Render and save the stream rendered description on update. 3. Render and save stream descriptions on creation. Further, the stream's rendered description is also sent whenever the stream's description is being sent. This is preparatory work for eliminating the use of the non-authoritative marked.js markdown parser for stream descriptions.
2019-01-11 13:48:22 +01:00
stream.save(update_fields=["rendered_description"])
class Migration(migrations.Migration):
dependencies = [
('zerver', '0205_remove_realmauditlog_requires_billing_update'),
]
operations = [
migrations.AddField(
model_name='stream',
name='rendered_description',
field=models.TextField(default=''),
),
migrations.RunPython(render_all_stream_descriptions,
migrations: Mark RunPython statements elidable. This will make django automatically remove them when we run squashmigrations. There are still some RunSQL statements which we will have to take care of manually.
2020-04-29 08:43:25 +02:00
reverse_code=migrations.RunPython.noop,
elidable=True),
streams: Render and store the stream description from the backend. This commit does the following three things: 1. Update stream model to accomodate rendered description. 2. Render and save the stream rendered description on update. 3. Render and save stream descriptions on creation. Further, the stream's rendered description is also sent whenever the stream's description is being sent. This is preparatory work for eliminating the use of the non-authoritative marked.js markdown parser for stream descriptions.
2019-01-11 13:48:22 +01:00
]