Better way to add a new field

Author: stsewd

readthedocs/projects/models.py

@@ -1245,7 +1245,7 @@ def get_processed_json(self):
             for fjson_path in fjson_paths:
                 file_path = os.path.join(full_json_path, fjson_path)
                 if os.path.exists(file_path):
-                    return process_file(file_path, self.path)
+                    return process_file(file_path)
         except Exception:
             log.warning(
                 'Unhandled exception during search processing file: %s',
@@ -1255,7 +1255,6 @@ def get_processed_json(self):
             'headers': [],
             'content': '',
             'path': file_path,
-            'full_path': self.path,
             'title': '',
             'sections': [],
         }

readthedocs/search/documents.py

@@ -116,7 +116,7 @@ class PageDocument(RTDDocTypeMixin, DocType):
     project = fields.KeywordField(attr='project.slug')
     version = fields.KeywordField(attr='version.slug')
     path = fields.KeywordField(attr='processed_json.path')
-    full_path = fields.KeywordField(attr='processed_json.full_path')
+    full_path = fields.KeywordField(attr='path')
 
     # Searchable content
     title = fields.TextField(attr='processed_json.title')

readthedocs/search/parse_json.py

@@ -59,7 +59,7 @@ def generate_sections_from_pyquery(body):
         }
 
 
-def process_file(fjson_filename, filename):
+def process_file(fjson_filename):
     """Read the fjson file from disk and parse it into a structured dict."""
     try:
         with codecs.open(fjson_filename, encoding='utf-8', mode='r') as f:
@@ -76,7 +76,7 @@ def process_file(fjson_filename, filename):
     if 'current_page_name' in data:
         path = data['current_page_name']
     else:
-        log.info('Unable to index file due to no name %s', filename)
+        log.info('Unable to index file due to no name %s', fjson_filename)
 
     if data.get('body'):
         body = PyQuery(data['body'])
@@ -96,7 +96,6 @@ def process_file(fjson_filename, filename):
         'headers': process_headers(data, fjson_filename),
         'content': body_content,
         'path': path,
-        'full_path': filename,
         'title': title,
         'sections': sections,
     }

readthedocs/search/tests/data/docs/story.json

@@ -27,6 +27,5 @@
       "title": "Rationale"
     }
   ],
-  "path": "open-source-philosophy",
-  "full_path": "open-source-philosophy.html"
+  "path": "open-source-philosophy"
 }

readthedocs/search/tests/data/docs/wiping.json

@@ -11,6 +11,5 @@
       "title": "Wiping a Build Environment"
     }
   ],
-  "path": "guides/wipe-environment",
-  "full_path": "guides/wipe-environment.html"
+  "path": "guides/wipe-environment"
 }

readthedocs/search/tests/data/kuma/docker.json

@@ -21,6 +21,5 @@
       "title": "Docker Images"
     }
   ],
-  "path": "docker",
-  "full_path": "docker.html"
+  "path": "docker"
 }

readthedocs/search/tests/data/kuma/documentation.json

@@ -17,6 +17,5 @@
       "title": "Generating documentation"
     }
   ],
-  "path": "documentation",
-  "full_path": "documentation.html"
+  "path": "documentation"
 }

readthedocs/search/tests/data/pipeline/installation.json

@@ -29,6 +29,5 @@
       "title": "Recommendations"
     }
   ],
-  "path": "installation",
-  "full_path": "installation.html"
+  "path": "installation"
 }

readthedocs/search/tests/data/pipeline/signals.json

@@ -23,6 +23,5 @@
       "title": "js_compressed"
     }
   ],
-  "path": "signals",
-  "full_path": "signals.html"
+  "path": "signals"
 }