Skip to content
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.

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

Upgrade Elasticsearch to version 6.x #4211

Merged
merged 16 commits into from
Jun 19, 2018
2 changes: 2 additions & 0 deletions readthedocs/projects/apps.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,7 @@ class ProjectsConfig(AppConfig):
def ready(self):
from readthedocs.projects import tasks
from readthedocs.worker import app
from .signals import pre_save_html_file #noqa

app.tasks.register(tasks.SyncRepositoryTask)
app.tasks.register(tasks.UpdateDocsTask)
7 changes: 7 additions & 0 deletions readthedocs/projects/managers.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
from django.db import models


class HTMLFileManager(models.Manager):

def get_queryset(self):
return super(HTMLFileManager, self).get_queryset().filter(is_html=True)
Copy link
Member

Choose a reason for hiding this comment

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

Can't this just do filter(filename__endswith='html') instead of adding additional state to the model?

Copy link
Member Author

Choose a reason for hiding this comment

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

Yeah. It can be done. I thought it would be slower, so I added another state.
But I think performance is not a issue here. So I am good to filter by name.

18 changes: 17 additions & 1 deletion readthedocs/projects/models.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@
import fnmatch
import logging
import os
from builtins import object # pylint: disable=redefined-builtin

from builtins import object # pylint: disable=redefined-builtin
from django.conf import settings
from django.contrib.auth.models import User
from django.core.urlresolvers import NoReverseMatch, reverse
Expand All @@ -24,6 +24,7 @@
from readthedocs.core.utils import broadcast, slugify
from readthedocs.projects import constants
from readthedocs.projects.exceptions import ProjectConfigurationError
from readthedocs.projects.managers import HTMLFileManager
from readthedocs.projects.querysets import (
ChildRelatedProjectQuerySet, FeatureQuerySet, ProjectQuerySet,
RelatedProjectQuerySet)
Expand Down Expand Up @@ -902,6 +903,7 @@ class ImportedFile(models.Model):
path = models.CharField(_('Path'), max_length=255)
md5 = models.CharField(_('MD5 checksum'), max_length=255)
commit = models.CharField(_('Commit'), max_length=255)
is_html = models.BooleanField(default=False)
Copy link
Member

Choose a reason for hiding this comment

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

I don't think we need this on the model, the queryset manager can just do the filter, no?

Copy link
Member Author

Choose a reason for hiding this comment

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

Yeah. it can do the filtering. but I thought it would be much slow to filter in the queryset manager. I am ok to remove it.


def get_absolute_url(self):
return resolve(project=self.project, version_slug=self.version.slug, filename=self.path)
Expand All @@ -910,6 +912,20 @@ def __str__(self):
return '%s: %s' % (self.name, self.project)


class HTMLFile(ImportedFile):

"""
Imported HTML file Proxy model.

This tracks only the HTML files for indexing to search.
"""

class Meta(object):
proxy = True

objects = HTMLFileManager()


class Notification(models.Model):
project = models.ForeignKey(Project,
related_name='%(class)s_notifications')
Expand Down
8 changes: 7 additions & 1 deletion readthedocs/projects/signals.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,11 @@

from __future__ import absolute_import
import django.dispatch
from django.db.models.signals import pre_save
from django.dispatch import receiver

from readthedocs.oauth.utils import attach_webhook

from .models import HTMLFile

before_vcs = django.dispatch.Signal(providing_args=["version"])
after_vcs = django.dispatch.Signal(providing_args=["version"])
Expand All @@ -25,3 +26,8 @@ def handle_project_import(sender, **kwargs):
request = kwargs.get('request')

attach_webhook(project=project, request=request)


@receiver(pre_save, sender=HTMLFile)
def pre_save_html_file(sender, instance, *args, **kwargs):
instance.is_html = True
20 changes: 16 additions & 4 deletions readthedocs/projects/tasks.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
from __future__ import absolute_import

import datetime
import fnmatch
import hashlib
import json
import logging
Expand All @@ -29,7 +30,7 @@

from .constants import LOG_TEMPLATE
from .exceptions import RepositoryError
from .models import ImportedFile, Project, Domain
from .models import ImportedFile, Project, Domain, HTMLFile
from .signals import before_vcs, after_vcs, before_build, after_build, files_changed
from readthedocs.builds.constants import (LATEST,
BUILD_STATE_CLONING,
Expand Down Expand Up @@ -943,18 +944,23 @@ def _manage_imported_files(version, path, commit):
changed_files = set()
for root, __, filenames in os.walk(path):
for filename in filenames:
if fnmatch.fnmatch(filename, '*.html'):
model_class = HTMLFile
else:
model_class = ImportedFile
Copy link
Member

Choose a reason for hiding this comment

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

I don't believe this is needed, since it's all the same model in the database.

Copy link
Member Author

Choose a reason for hiding this comment

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

The problem is with actually signal manager. I have opened django-es/django-elasticsearch-dsl#111 about this.

Untill it has been fixed, we need to have a proxy model for the purpose, I believe.


dirpath = os.path.join(root.replace(path, '').lstrip('/'),
filename.lstrip('/'))
full_path = os.path.join(root, filename)
md5 = hashlib.md5(open(full_path, 'rb').read()).hexdigest()
try:
obj, __ = ImportedFile.objects.get_or_create(
obj, __ = model_class.objects.get_or_create(
project=version.project,
version=version,
path=dirpath,
name=filename,
)
except ImportedFile.MultipleObjectsReturned:
except model_class.MultipleObjectsReturned:
log.warning('Error creating ImportedFile')
continue
if obj.md5 != md5:
Expand All @@ -963,6 +969,12 @@ def _manage_imported_files(version, path, commit):
if obj.commit != commit:
obj.commit = commit
obj.save()

# Delete the HTMLFile first
HTMLFile.objects.filter(project=version.project,
version=version
).exclude(commit=commit).delete()

# Delete ImportedFiles from previous versions
ImportedFile.objects.filter(project=version.project,
version=version
Expand Down Expand Up @@ -1173,7 +1185,7 @@ def sync_callback(_, version_pk, commit, *args, **kwargs):
The first argument is the result from previous tasks, which we discard.
"""
fileify(version_pk, commit=commit)
update_search(version_pk, commit=commit)
# update_search(version_pk, commit=commit)


@app.task()
Expand Down
17 changes: 16 additions & 1 deletion readthedocs/search/documents.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
from django_elasticsearch_dsl import DocType, Index, fields

from readthedocs.projects.models import Project
from readthedocs.projects.models import Project, HTMLFile

from readthedocs.search.faceted_search import ProjectSearch

Expand Down Expand Up @@ -43,3 +43,18 @@ def faceted_search(cls, query, language=None, using=None, index=None):
kwargs['filters'] = {'language': language}

return ProjectSearch(**kwargs)


page_index = Index('page')

page_index.settings(
number_of_shards=1,
number_of_replicas=0
)


@page_index.doc_type
class PageDocument(DocType):

class Meta(object):
model = HTMLFile