SNO2-68-search-config-default-group (#1271)

Author: keenangraham

setup.cfg

@@ -52,7 +52,7 @@ install_requires =
     xlrd==1.2.0
     zope.interface==5.3.0
     zope.sqlalchemy==1.2
-    snovault@git+https://github.com/IGVF-DACC/snovault.git@add-memory-queue
+    snovault@git+https://github.com/IGVF-DACC/snovault.git@v16.0.0
 
 [options.extras_require]
 test =

src/igvfd/report.py

@@ -107,8 +107,8 @@ def report_download(context, request):
     request.GET['limit'] = 'all'
     type_str = types[0]
     schema = request.registry[TYPES][type_str].schema
-    search_config = request.registry[SEARCH_CONFIG].as_dict()[type_str]
-    columns = list_visible_columns_for_schemas(request, schema, search_config)
+    search_configs = request.registry['SEARCH_CONFIG_REPORT_CLIENT'].get(type_str)
+    columns = list_visible_columns_for_schemas(request, schema, search_configs)
     snake_type = _convert_camel_to_snake(type_str).replace("'", '')
     results = search_generator(request)
 
@@ -143,13 +143,17 @@ def generate_rows():
     return request.response
 
 
-def list_visible_columns_for_schemas(request, schema, search_config):
+def list_visible_columns_for_schemas(request, schema, search_configs):
     """
     Returns mapping of default columns for a set of schemas.
     """
     columns = OrderedDict({'@id': {'title': 'ID'}})
-    if 'columns' in search_config:
-        columns.update(search_config['columns'])
+    collected_columns = OrderedDict()
+    for config in search_configs:
+        if 'columns' in config:
+            collected_columns.update(config['columns'])
+    if collected_columns:
+        columns.update(collected_columns)
     else:
         # default columns if not explicitly specified
         columns.update(OrderedDict(
@@ -265,10 +269,13 @@ def get_result_columns(request, facets, report_response_columns):
     else:
         for type_str in types_in_search_result:
             schema = request.registry[TYPES][type_str].schema
-            search_config = request.registry[SEARCH_CONFIG].as_dict()[type_str]
-
-            if 'columns' in search_config:
-                columns.update(search_config['columns'])
+            search_configs = request.registry['SEARCH_CONFIG_REPORT_CLIENT'].get(type_str)
+            collected_columns = OrderedDict()
+            for config in search_configs:
+                if 'columns' in config:
+                    collected_columns.update(config['columns'])
+            if collected_columns:
+                columns.update(collected_columns)
             else:
                 # default columns if not explicitly specified
                 columns.update(OrderedDict(

src/igvfd/search_views.py

@@ -115,6 +115,7 @@ def report(context, request):
             BasicReportWithFacetsResponseField(
                 default_item_types=DEFAULT_ITEM_TYPES,
                 reserved_keys=RESERVED_KEYS,
+                search_config_registry_client=request.registry['SEARCH_CONFIG_REPORT_CLIENT'],
             ),
             AllResponseField(),
             FacetGroupsResponseField(),
@@ -148,6 +149,7 @@ def multireport(context, request):
             MultipleTypesReportWithFacetsResponseField(
                 default_item_types=DEFAULT_ITEM_TYPES,
                 reserved_keys=RESERVED_KEYS,
+                search_config_registry_client=request.registry['SEARCH_CONFIG_REPORT_CLIENT'],
             ),
             AllResponseField(),
             FacetGroupsResponseField(),
@@ -286,7 +288,11 @@ def top_hits(context, request):
 @view_config(route_name='search-config-registry', request_method='GET', permission='search')
 def search_config_registry(context, request):
     registry = request.registry[SEARCH_CONFIG]
-    return dict(sorted(registry.as_dict().items()))
+    return {
+        'configs': dict(sorted(registry.as_dict().items())),
+        'defaults': registry.defaults_to_json(),
+        'aliases': registry.aliases_to_json(),
+    }
 
 
 @view_config(route_name='search-quick', request_method='GET', permission='search')

src/igvfd/searches/configs/__init__.py

@@ -6,6 +6,11 @@
 
 from snosearch.interfaces import COLUMNS
 
+from snosearch.configs import SearchConfigRegistryClient
+from snosearch.configs import SearchConfigRegistryClientProps
+
+from .defaults import REPORT_VIEW_DEFAULTS
+
 
 def register_subtype_columns_in_abstract_search_configs(config):
     item_registry = config.registry[TYPES]
@@ -34,3 +39,18 @@ def includeme(config):
         args=(config,),
         order=PHASE3_CONFIG,
     )
+    config.registry['SEARCH_CONFIG_DEFAULT_CLIENT'] = SearchConfigRegistryClient(
+        props=SearchConfigRegistryClientProps(
+            registry=config.registry[SEARCH_CONFIG]
+        )
+    )
+    config.registry['SEARCH_CONFIG_REPORT_CLIENT'] = SearchConfigRegistryClient(
+        props=SearchConfigRegistryClientProps(
+            registry=config.registry[SEARCH_CONFIG],
+            group='report',
+        )
+    )
+    config.registry[SEARCH_CONFIG].add_defaults(
+        REPORT_VIEW_DEFAULTS,
+        group='report',
+    )

src/igvfd/searches/configs/defaults.py

@@ -0,0 +1,3 @@
+REPORT_VIEW_DEFAULTS = {
+    #    'MeasurementSet': ['MeasurementSetReportView'],
+}

src/igvfd/searches/configs/measurement_set.py

@@ -208,3 +208,21 @@ def measurement_set():
             }
         }
     }
+
+
+@search_config(
+    name='MeasurementSetReportView'
+)
+def measurement_set_report_view():
+    # Copy normal measurement_set config.
+    config = measurement_set()
+    # Override columns.
+    config['columns'] = {
+        'accession': {
+            'title': 'Accession'
+        },
+        'summary': {
+            'title': 'Summary'
+        },
+    }
+    return config

src/igvfd/tests/indexing/test_search_views.py

@@ -361,11 +361,15 @@ def test_search_views_search_config_registry(workbook, testapp):
     r = testapp.get(
         '/search-config-registry/'
     )
-    assert len(r.json) > 40
-    assert 'User' in r.json
-    assert 'Award' in r.json
-    assert 'facets' in r.json['Award']
-    assert 'columns' in r.json['Award']
+    assert 'configs' in r.json
+    assert 'defaults' in r.json
+    assert 'aliases' in r.json
+    configs = r.json['configs']
+    assert len(configs) > 40
+    assert 'User' in configs
+    assert 'Award' in configs
+    assert 'facets' in configs['Award']
+    assert 'columns' in configs['Award']
 
 
 def test_search_views_multireport_view_values(workbook, testapp):