Feature/3 elastic search setup (#15)

* Fix/10 static prefix (#11)
* config static_url correctly for both  local & AWS
* changelog
* fix bumpversion cfg
* Bump version: 0.1.1 → 0.1.2
* Feature/9 about resolver (#12)
* upgrade pip version (as per dependabot advisory)
* add new resolvers + tests
* changelog
* Bump version: 0.1.2 → 0.1.3
* basic working with django-elasticsearch-dsl
* working a little better now - with local docker ES v6.8.0
* WIP - where we hit the wall
* remove monkeypatch nshm/management
* this is now running in --stage DEV and in use by weka-apigw
* better search indexing;

Author: chrisbc

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.1.1
+current_version = 0.1.3
 commit = True
 tag = False
 
@@ -9,8 +9,8 @@ replace = version = "{new_version}"
 
 [bumpversion:file:package.json]
 search = "version": "{current_version}",
-replace = "version": "{new_version}"
+replace = "version": "{new_version}",
 
 [bumpversion:file:nzshm_model_graphql_api/__init__.py]
-search = __version__ = '{current_version}'
-replace = __version__ = '{new_version}'
+search = __version__ = "{current_version}"
+replace = __version__ = "{new_version}"

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## [0.1.3] - 2023-09-04
+## Added
+ - new about and version resolvers
+
+## [0.1.2] - 2023-09-04
+## Changed
+ - configure static_url correctly for both local & AWS
+
 ## [0.1.1] - 2023-09-01
 ### Added
  - pytest, tox, etc

README.md

@@ -1,5 +1,5 @@
 ref: https://docs.graphene-python.org/projects/django/en/latest/tutorial-relay/
-
+1
 
 ## the Sqlite3 on lambda issue
 
@@ -50,4 +50,19 @@ poetry run python manage.py runserver_plus
 ```
 poetry shell
 npx sls wsgi serve
-```
+```
+
+### AWS OpenSearch integration
+
+Alert we use [email protected]:daily-science/django-elasticsearch-dsl.git fork for now. This should be PR'd onto the main project.
+
+This project now has ES settings and uses the above to maintain indexes as the django SQL db is maintained. 
+
+You can also maintain the indexes via new manage.py commaneds e.g:
+
+```
+DEBUG=1 poetry run python manage.py search_index --create
+DEBUG=1 poetry run python manage.py search_index --populate
+DEBUG=1 poetry run python manage.py search_index --rebuild
+DEBug=1 poetry run python manage.py search_index --help
+```

db.sqlite3

@@ -0,0 +1,130 @@
+# documents.py
+
+from django_elasticsearch_dsl import Document, Index, fields
+from django_elasticsearch_dsl.registries import registry
+
+from nshm import models
+
+COMMON_INDEX = 'toshi_nshm_models_index'
+models_index = Index(COMMON_INDEX)
+models_index.settings(
+    number_of_shards=1,
+    number_of_replicas=0
+)
+
+class DocumentWithNodeId(Document):
+    """
+    Override the object ID used in the search engine to be similar to that use in Toshi_ID
+    """
+    @classmethod
+    def generate_id(cls, object_instance):
+        """
+        The default behavior is to use the Django object's pk (id) as the
+        elasticseach index id (_id). If needed, this method can be overloaded
+        to change this default behavior.
+        """
+        #return object_instance.pk
+        return f"{cls.Django.model.__name__}_{object_instance.pk}"
+
+@registry.register_document
+class SeismicHazardModelDocument(DocumentWithNodeId):
+
+    class Index:
+        name = COMMON_INDEX
+            
+    class Django:
+        model = models.SeismicHazardModel # The model associated with this Document
+        fields = [
+            "id",
+            "version",
+            "notes",
+        ]
+
+    source_logic_tree = fields.ObjectField(properties={
+        'version': fields.TextField(),
+    })
+    gmcm_logic_tree = fields.ObjectField(properties={
+        'version': fields.TextField(),
+    })
+
+@registry.register_document
+class SourceLogicTreeDocument(DocumentWithNodeId):
+    class Index:
+        name = COMMON_INDEX
+
+    class Django:
+        model = models.SourceLogicTree
+        fields = [
+            'version',
+            'notes'
+        ]
+
+    seismic_hazard_models = fields.NestedField(properties={
+        'version': fields.TextField(),
+        'id': fields.TextField()        
+    })
+    
+    slt_weighted_components = fields.NestedField(properties={
+        'weight': fields.TextField(),
+        'id': fields.TextField()
+    })    
+
+@registry.register_document
+class SourceLogicTreeComponentDocument(DocumentWithNodeId):
+    class Index:
+        name = COMMON_INDEX
+
+    class Django:
+        model = models.SourceLogicTreeComponent
+        fields = [
+            'tag', 
+            'notes',
+            'inversion_toshi_id',
+            'background_toshi_id',
+            'tectonic_region',
+            'group'
+        ]
+
+    slt_weighted_components = fields.NestedField(properties={
+        'weight': fields.TextField(),
+        'id': fields.TextField()        
+    })
+
+
+@registry.register_document
+class SourceLogicTreeWeightedComponentDocument(DocumentWithNodeId):
+    
+    class Index:
+        name = COMMON_INDEX
+    
+    class Django:
+        model = models.SourceLogicTreeWeightedComponent
+        fields = [
+            'weight',
+        ]
+
+    source_logic_tree = fields.ObjectField(properties={
+        'version': fields.TextField(),
+        'id': fields.TextField()        
+    })
+
+    source_logic_tree_component = fields.ObjectField(properties={
+        'tag': fields.TextField(),
+        'id': fields.TextField()        
+    })
+
+
+@registry.register_document
+class HazardSolutionDocument(DocumentWithNodeId):
+    class Index:
+        name = COMMON_INDEX
+
+    class Django:
+        model = models.HazardSolution # The model associated with this Document
+        fields = [
+            "id",
+            "solution_id",
+            "created",
+            "vs30",
+            "notes",
+        ]

nshm/documents.py

@@ -0,0 +1,18 @@
+# Generated by Django 4.2.4 on 2023-09-04 04:54
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("nshm", "0013_delete_openquakehazardtask"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="hazardsolution",
+            name="typename",
+            field=models.CharField(default="HazardSolution", max_length=50),
+        ),
+    ]

nshm/migrations/0014_hazardsolution_typename.py

@@ -0,0 +1,18 @@
+# Generated by Django 4.2.4 on 2023-09-04 04:59
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("nshm", "0014_hazardsolution_typename"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="seismichazardmodel",
+            name="typename",
+            field=models.CharField(default="SeismicHazardModel", max_length=50),
+        ),
+    ]

nshm/migrations/0015_seismichazardmodel_typename.py

@@ -0,0 +1,17 @@
+# Generated by Django 4.2.4 on 2023-09-04 06:11
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("nshm", "0015_seismichazardmodel_typename"),
+    ]
+
+    operations = [
+        migrations.RemoveField(
+            model_name="seismichazardmodel",
+            name="typename",
+        ),
+    ]

nshm/migrations/0016_remove_seismichazardmodel_typename.py

@@ -83,7 +83,6 @@ class SeismicHazardModel(models.Model):
     def __str__(self):
         return self.version
 
-
 class LocationList(models.Model):
     list_id = models.CharField(max_length=10)
     notes = models.TextField(null=True, blank=True)
@@ -94,6 +93,7 @@ def __str__(self):
 
 
 class HazardSolution(models.Model):
+    typename = models.CharField(max_length=50, null=False, default="HazardSolution")
     solution_id = models.CharField(max_length=50, null=False)
     created = models.DateTimeField(auto_now=False, auto_now_add=False)
     vs30 = models.SmallIntegerField()
@@ -105,14 +105,3 @@ class HazardSolution(models.Model):
         SourceLogicTreeWeightedComponent, related_name="hazard_solutions"
     )
 
-
-# class OpenquakeHazardTask(models.Model):
-#     general_task_id = models.CharField(max_length=50, null=False)
-#     date = models.DateField(auto_now=False, auto_now_add=False)
-#     config_info = models.TextField(null=True, blank=True)
-#     notes = models.TextField(null=True, blank=True)
-#     part_of = models.ForeignKey(
-#         SeismicHazardModel, related_name='hazard_tasks',null=True, blank=True, on_delete=models.SET_NULL)
-
-#     def __str__(self):
-#         return self.general_task_id

nshm/models.py

@@ -1,5 +1,5 @@
 """Top-level package for kororaa-graphql-api."""
 
 __author__ = """GNS Science New Zealand"""
-__email__ = '[email protected]'
-__version__ = '0.1.1'
+__email__ = "[email protected]"
+__version__ = "0.1.3"