add ability for sysadmin to return ES query instead of results

mdunker · mdunker · commit 6aafd1feedef · 2017-12-12T14:37:11.000-08:00
diff --git a/stack/core/src/main/java/org/apache/usergrid/corepersistence/CpRelationManager.java b/stack/core/src/main/java/org/apache/usergrid/corepersistence/CpRelationManager.java
@@ -634,6 +634,7 @@ public Results searchCollection( String collectionName, Query query ) throws Exc
         final Optional<String> queryString = query.isGraphSearch()? Optional.<String>absent(): query.getQl();
         final Id ownerId = headEntity.asId();
         final boolean analyzeOnly = query.getAnalyzeOnly();
+        final boolean returnQuery = query.getReturnQuery();
 
 
         if(query.getLevel() == Level.IDS ){
@@ -648,6 +649,7 @@ protected Observable<ResultsPage<Id>> buildNewResultsPage(
                             queryString, cursor );
 
                     search.setAnalyzeOnly(analyzeOnly);
+                    search.setReturnQuery(returnQuery);
 
                     return collectionService.searchCollectionIds( search );
                 }
@@ -666,6 +668,7 @@ protected Observable<ResultsPage<org.apache.usergrid.persistence.model.entity.En
                         queryString, cursor );
 
                 search.setAnalyzeOnly(analyzeOnly);
+                search.setReturnQuery(returnQuery);
                 IndexConsistency indexConsistency = getIndexConsistencyForType(collectionName);
                 search.setKeepStaleEntries(indexConsistency == IndexConsistency.LATEST);
 
@@ -931,6 +934,7 @@ public Results searchTargetEntities( Query query ) throws Exception {
         headEntity = em.validate( headEntity );
 
         final boolean analyzeOnly = query.getAnalyzeOnly();
+        final boolean returnQuery = query.getReturnQuery();
 
 
         final Query toExecute = adjustQuery( query );
@@ -965,6 +969,7 @@ protected Observable<ResultsPage<ConnectionRef>> buildNewResultsPage( final Opti
                         new ConnectionSearch( applicationScope, sourceId, entityType, connection, toExecute.getLimit(),
                             queryString, cursor, isConnecting );
                     search.setAnalyzeOnly(analyzeOnly);
+                    search.setReturnQuery(returnQuery);
                     return connectionService.searchConnectionAsRefs( search );
                 }
             }.next();
@@ -981,6 +986,7 @@ protected Observable<ResultsPage<org.apache.usergrid.persistence.model.entity.En
                     new ConnectionSearch( applicationScope, sourceId, entityType, connection, toExecute.getLimit(),
                         queryString, cursor, isConnecting );
                 search.setAnalyzeOnly(analyzeOnly);
+                search.setReturnQuery(returnQuery);
                 return connectionService.searchConnection( search );
             }
         }.next();
diff --git a/stack/core/src/main/java/org/apache/usergrid/corepersistence/pipeline/builder/IdBuilder.java b/stack/core/src/main/java/org/apache/usergrid/corepersistence/pipeline/builder/IdBuilder.java
@@ -118,21 +118,23 @@ public IdBuilder traverseConnection( final String connectionName, final Optional
      * @param collectionName  The name of the collection
      * @param ql The user's query to execute
      * @param entityType The type of the entity
-     * @param analyzeOnly
+     * @param analyzeOnly Whether only query analysis should be performed
+     * @param returnQuery Whether query should be returned instead of results
      * @return  Candidate results
      */
-    public CandidateBuilder searchCollection(final String collectionName, final String ql, final String entityType, boolean analyzeOnly) {
+    public CandidateBuilder searchCollection(final String collectionName, final String ql, final String entityType,
+                                             final boolean analyzeOnly, final boolean returnQuery) {
 
         final Pipeline<FilterResult<Candidate>> newFilter = pipeline.withFilter( filterFactory.searchCollectionFilter(
-            ql, collectionName, entityType, analyzeOnly ) );
+            ql, collectionName, entityType, analyzeOnly, returnQuery ) );
 
         return new CandidateBuilder( newFilter, filterFactory , null);
     }
 
     public CandidateBuilder searchCollection(final String collectionName, final String ql, final CollectionSearch search ) {
 
         final Pipeline<FilterResult<Candidate>> newFilter = pipeline.withFilter( filterFactory.searchCollectionFilter(
-            ql, collectionName, search.getEntityType(), search.getAnalyzeOnly() ) );
+            ql, collectionName, search.getEntityType(), search.getAnalyzeOnly(), search.getReturnQuery() ) );
 
         return new CandidateBuilder( newFilter, filterFactory, search );
     }
@@ -142,14 +144,16 @@ public CandidateBuilder searchCollection(final String collectionName, final Stri
      * @param connectionName The connection name to search
      * @param ql The query to execute
      * @param entityType The optional type of entity.  If this is absent, all entity types in the connection will be searched
-     * @param analyzeOnly
+     * @param analyzeOnly Whether only query analysis should be performed
+     * @param returnQuery Whether index query should be returned instead of results
      * @return  Candidate results
      */
-    public CandidateBuilder searchConnection(final String connectionName, final String ql, final Optional<String> entityType, boolean analyzeOnly) {
+    public CandidateBuilder searchConnection(final String connectionName, final String ql, final Optional<String> entityType,
+                                             final boolean analyzeOnly, final boolean returnQuery) {
 
 
         final Pipeline<FilterResult<Candidate>> newFilter = pipeline.withFilter( filterFactory.searchConnectionFilter(
-            ql, connectionName, entityType,analyzeOnly ) );
+            ql, connectionName, entityType, analyzeOnly, returnQuery ) );
 
         return new CandidateBuilder( newFilter, filterFactory );
     }
diff --git a/stack/core/src/main/java/org/apache/usergrid/corepersistence/pipeline/read/FilterFactory.java b/stack/core/src/main/java/org/apache/usergrid/corepersistence/pipeline/read/FilterFactory.java
@@ -97,7 +97,8 @@ ReadGraphConnectionByTypeFilter readGraphConnectionByTypeFilter(
     SearchCollectionFilter searchCollectionFilter( @Assisted( "query" ) final String query,
                                                    @Assisted( "collectionName" ) final String collectionName,
                                                    @Assisted( "entityType" ) final String entityType,
-                                                   @Assisted( "analyzeOnly") final boolean analyzeOnly);
+                                                   @Assisted( "analyzeOnly") final boolean analyzeOnly,
+                                                   @Assisted( "returnQuery" ) final boolean returnQuery);
 
 
     /**
@@ -110,7 +111,8 @@ SearchCollectionFilter searchCollectionFilter( @Assisted( "query" ) final String
     SearchConnectionFilter searchConnectionFilter( @Assisted( "query" ) final String query,
                                                    @Assisted( "connectionName" ) final String connectionName,
                                                    @Assisted( "connectedEntityType" ) final Optional<String> connectedEntityType,
-                                                   @Assisted( "analyzeOnly") final boolean analyzeOnly);
+                                                   @Assisted( "analyzeOnly") final boolean analyzeOnly,
+                                                   @Assisted( "returnQuery") final boolean returnQuery);
 
 
     /**
diff --git a/stack/core/src/main/java/org/apache/usergrid/corepersistence/pipeline/read/search/AbstractElasticSearchFilter.java b/stack/core/src/main/java/org/apache/usergrid/corepersistence/pipeline/read/search/AbstractElasticSearchFilter.java
@@ -57,6 +57,7 @@ public abstract class AbstractElasticSearchFilter extends AbstractPathFilter<Id,
     private final String query;
     private final Timer searchTimer;
     private final boolean analyzeOnly;
+    private final boolean returnQuery;
 
 
     /**
@@ -65,12 +66,13 @@ public abstract class AbstractElasticSearchFilter extends AbstractPathFilter<Id,
     public AbstractElasticSearchFilter(final EntityIndexFactory entityIndexFactory,
                                        final MetricsFactory metricsFactory,
                                        final IndexLocationStrategyFactory indexLocationStrategyFactory,
-                                       final String query, boolean analyzeOnly) {
+                                       final String query, boolean analyzeOnly, boolean returnQuery) {
         this.entityIndexFactory = entityIndexFactory;
         this.indexLocationStrategyFactory = indexLocationStrategyFactory;
         this.query = query;
         this.searchTimer = metricsFactory.getTimer( AbstractElasticSearchFilter.class, "query.search" );
         this.analyzeOnly = analyzeOnly;
+        this.returnQuery = returnQuery;
     }
 
 
@@ -127,7 +129,8 @@ public Observable<FilterResult<Candidate>> call( final Observable<FilterResult<I
 
                     try {
                         final CandidateResults candidateResults =
-                            applicationEntityIndex.search( searchEdge, searchTypes, query, limit, currentOffSet, propertiesWithType, analyzeOnly );
+                            applicationEntityIndex.search( searchEdge, searchTypes, query, limit, currentOffSet,
+                                propertiesWithType, analyzeOnly, returnQuery);
 
 
                         Collection<SelectFieldMapping> fieldMappingCollection = candidateResults.getGetFieldMappings();
diff --git a/stack/core/src/main/java/org/apache/usergrid/corepersistence/pipeline/read/search/SearchCollectionFilter.java b/stack/core/src/main/java/org/apache/usergrid/corepersistence/pipeline/read/search/SearchCollectionFilter.java
@@ -53,8 +53,9 @@ public SearchCollectionFilter( final EntityIndexFactory entityIndexFactory,
                                    @Assisted( "query" ) final String query,
                                    @Assisted( "collectionName" ) final String collectionName,
                                    @Assisted( "entityType" ) final String entityType,
-                                   @Assisted( "analyzeOnly") final boolean analyzeOnly) {
-        super( entityIndexFactory, metricsFactory, indexLocationStrategyFactory, query, analyzeOnly );
+                                   @Assisted( "analyzeOnly") final boolean analyzeOnly,
+                                   @Assisted( "returnQuery" ) final boolean returnQuery) {
+        super( entityIndexFactory, metricsFactory, indexLocationStrategyFactory, query, analyzeOnly, returnQuery);
         this.collectionName = collectionName;
         this.entityType = entityType;
     }
diff --git a/stack/core/src/main/java/org/apache/usergrid/corepersistence/pipeline/read/search/SearchConnectionFilter.java b/stack/core/src/main/java/org/apache/usergrid/corepersistence/pipeline/read/search/SearchConnectionFilter.java
@@ -51,8 +51,9 @@ public SearchConnectionFilter( final EntityIndexFactory entityIndexFactory,
                                    @Assisted( "query" ) final String query,
                                    @Assisted( "connectionName" ) final String connectionName,
                                    @Assisted( "connectedEntityType" ) final Optional<String> connectedEntityType,
-                                   @Assisted( "analyzeOnly") final boolean analyzeOnly) {
-        super( entityIndexFactory, metricsFactory, indexLocationStrategyFactory, query, analyzeOnly);
+                                   @Assisted( "analyzeOnly") final boolean analyzeOnly,
+                                   @Assisted( "returnQuery" ) final boolean returnQuery) {
+        super( entityIndexFactory, metricsFactory, indexLocationStrategyFactory, query, analyzeOnly, returnQuery);
 
         this.connectionName = connectionName;
         this.connectedEntityType = connectedEntityType;
diff --git a/stack/core/src/main/java/org/apache/usergrid/corepersistence/service/CollectionSearch.java b/stack/core/src/main/java/org/apache/usergrid/corepersistence/service/CollectionSearch.java
@@ -42,6 +42,7 @@ public enum Level {
     private final Optional<String> cursor;
     private Level level = Level.ALL;
     private boolean analyzeOnly;
+    private boolean returnQuery;
     private boolean keepStaleEntries;
 
 
@@ -56,6 +57,7 @@ public CollectionSearch( final ApplicationScope applicationScope, final Id colle
         this.query = query;
         this.cursor = cursor;
         this.analyzeOnly = false;
+        this.returnQuery = false;
     }
 
 
@@ -105,6 +107,14 @@ public void setAnalyzeOnly(final boolean analyzeOnly){
         this.analyzeOnly = analyzeOnly;
     }
 
+    public boolean getReturnQuery() {
+        return returnQuery;
+    }
+
+    public void setReturnQuery(final boolean returnQuery) {
+        this.returnQuery = returnQuery;
+    }
+
     public boolean getKeepStaleEntries() {
         return keepStaleEntries;
     }
diff --git a/stack/core/src/main/java/org/apache/usergrid/corepersistence/service/ConnectionSearch.java b/stack/core/src/main/java/org/apache/usergrid/corepersistence/service/ConnectionSearch.java
@@ -38,6 +38,7 @@ public class ConnectionSearch {
     private final Optional<String> cursor;
     private final boolean isConnecting;
     private boolean analyzeOnly;
+    private boolean returnQuery;
 
 
 
@@ -53,6 +54,7 @@ public ConnectionSearch( final ApplicationScope applicationScope, final Id sourc
         this.cursor = cursor;
         this.isConnecting = isConnecting;
         this.analyzeOnly = false;
+        this.returnQuery = false;
 
     }
 
@@ -102,4 +104,12 @@ public boolean getAnalyzeOnly() {
     public void setAnalyzeOnly(final boolean analyzeOnly){
         this.analyzeOnly = analyzeOnly;
     }
+
+    public boolean getReturnQuery() {
+        return returnQuery;
+    }
+
+    public void setReturnQuery(final boolean returnQuery) {
+        this.returnQuery = returnQuery;
+    }
 }
diff --git a/stack/core/src/main/java/org/apache/usergrid/corepersistence/service/ConnectionServiceImpl.java b/stack/core/src/main/java/org/apache/usergrid/corepersistence/service/ConnectionServiceImpl.java
@@ -106,7 +106,8 @@ public Observable<ResultsPage<Entity>> searchConnection( final ConnectionSearch
         else {
 
             results =
-                pipelineBuilder.searchConnection( search.getConnectionName(), query.get(), search.getEntityType(), search.getAnalyzeOnly() )
+                pipelineBuilder.searchConnection( search.getConnectionName(), query.get(), search.getEntityType(),
+                    search.getAnalyzeOnly(), search.getReturnQuery() )
                                .loadEntities();
         }
 
@@ -135,7 +136,8 @@ public Observable<ResultsPage<ConnectionRef>> searchConnectionAsRefs( final Conn
         }
         else {
             traversedIds =
-                pipelineBuilder.searchConnection( connectionName, query.get(), search.getEntityType(), search.getAnalyzeOnly() ).loadIds();
+                pipelineBuilder.searchConnection( connectionName, query.get(), search.getEntityType(),
+                    search.getAnalyzeOnly(), search.getReturnQuery() ).loadIds();
         }
 
         //create connection refs
diff --git a/stack/core/src/main/java/org/apache/usergrid/persistence/Query.java b/stack/core/src/main/java/org/apache/usergrid/persistence/Query.java
@@ -82,6 +82,7 @@ public enum Level {
     private String ql;
     private Collection<SelectFieldMapping> selectFields;
     private boolean analyzeOnly = false;
+    private boolean returnQuery = false;
 
 
     private static ObjectMapper mapper = new ObjectMapper();
@@ -125,7 +126,7 @@ public Query( Query q ) {
         collection = q.collection;
         level = q.level;
         analyzeOnly = q.analyzeOnly;
-
+        returnQuery = q.returnQuery;
     }
 
 
@@ -506,6 +507,14 @@ public boolean getAnalyzeOnly(){
         return analyzeOnly;
     }
 
+    public void setReturnQuery(final boolean returnQuery) {
+        this.returnQuery = returnQuery;
+    }
+
+    public boolean getReturnQuery() {
+        return returnQuery;
+    }
+
     public boolean isMergeSelectResults() {
         return mergeSelectResults;
     }
diff --git a/stack/corepersistence/queryindex/src/main/java/org/apache/usergrid/persistence/index/EntityIndex.java b/stack/corepersistence/queryindex/src/main/java/org/apache/usergrid/persistence/index/EntityIndex.java
@@ -121,6 +121,25 @@ CandidateResults search(final SearchEdge searchEdge, final SearchTypes searchTyp
                             final int limit, final int offset, final Map<String, Class> fieldsWithType,
                             final boolean analyzeOnly);
 
+    /**
+     * Search on every document in the specified search edge.  Also search by the types if specified
+     *
+     * @param searchEdge        The edge to search on
+     * @param searchTypes       The search types to search
+     * @param query             The query to execute
+     * @param limit             The limit of values to return
+     * @param offset            The offset to query on
+     * @param fieldsWithType    An optional param that allows the caller to provide schema related info which might
+     *                          relate to data in the query, such as sort predicate types
+     * @param analyzeOnly       This optional param will instruct the query processing to only analyze the query and
+     *                          provide info but not actually execute the query.
+     * @param returnQuery       This optional param will cause the index query to be returned instead of run.
+     * @return
+     */
+    CandidateResults search(final SearchEdge searchEdge, final SearchTypes searchTypes, final String query,
+                            final int limit, final int offset, final Map<String, Class> fieldsWithType,
+                            final boolean analyzeOnly, final boolean returnQuery);
+
 
     /**
      * Same as search, just iterates all documents that match the index edge exactly.
diff --git a/stack/corepersistence/queryindex/src/main/java/org/apache/usergrid/persistence/index/exceptions/QueryReturnException.java b/stack/corepersistence/queryindex/src/main/java/org/apache/usergrid/persistence/index/exceptions/QueryReturnException.java
@@ -0,0 +1,47 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ *  contributor license agreements.  The ASF licenses this file to You
+ * under the Apache License, Version 2.0 (the "License"); you may not
+ * use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.  For additional information regarding
+ * copyright in this work, please see the NOTICE file in the top level
+ * directory of this distribution.
+ */
+package org.apache.usergrid.persistence.index.exceptions;
+
+
+import java.util.UUID;
+
+public class QueryReturnException extends RuntimeException {
+
+    private String originalQuery;
+    private String indexQuery;
+    private UUID applicationUUID;
+
+    public QueryReturnException(final String originalQuery, final String indexQuery,
+                                final UUID applicationUUID) {
+        super("Return Query");
+        this.originalQuery = originalQuery;
+        this.indexQuery = indexQuery;
+        this.applicationUUID = applicationUUID;
+    }
+
+    public String getOriginalQuery(){
+        return originalQuery;
+    }
+    public String getIndexQuery(){
+        return indexQuery;
+    }
+
+    public UUID getApplicationUUID(){
+        return applicationUUID;
+    }
+}
diff --git a/stack/corepersistence/queryindex/src/main/java/org/apache/usergrid/persistence/index/impl/EsEntityIndexImpl.java b/stack/corepersistence/queryindex/src/main/java/org/apache/usergrid/persistence/index/impl/EsEntityIndexImpl.java
@@ -39,6 +39,7 @@
 import org.apache.usergrid.persistence.index.exceptions.IndexException;
 import org.apache.usergrid.persistence.index.exceptions.QueryAnalyzerException;
 import org.apache.usergrid.persistence.index.exceptions.QueryAnalyzerEnforcementException;
+import org.apache.usergrid.persistence.index.exceptions.QueryReturnException;
 import org.apache.usergrid.persistence.index.migration.IndexDataVersions;
 import org.apache.usergrid.persistence.index.query.ParsedQuery;
 import org.apache.usergrid.persistence.index.query.ParsedQueryBuilder;
@@ -427,6 +428,12 @@ public CandidateResults search( final SearchEdge searchEdge, final SearchTypes s
     public CandidateResults search( final SearchEdge searchEdge, final SearchTypes searchTypes, final String query,
                                     final int limit, final int offset, final Map<String, Class> fieldsWithType,
                                     final boolean analyzeOnly ) {
+        return search(searchEdge, searchTypes, query, limit, offset, fieldsWithType, analyzeOnly, false);
+    }
+
+    public CandidateResults search( final SearchEdge searchEdge, final SearchTypes searchTypes, final String query,
+                                    final int limit, final int offset, final Map<String, Class> fieldsWithType,
+                                    final boolean analyzeOnly, final boolean returnQuery ) {
 
         IndexValidationUtils.validateSearchEdge(searchEdge);
         Preconditions.checkNotNull(searchTypes, "searchTypes cannot be null");
@@ -449,7 +456,7 @@ public CandidateResults search( final SearchEdge searchEdge, final SearchTypes s
         for (SortPredicate sortPredicate : parsedQuery.getSortPredicates() ){
             hasGeoSortPredicates = visitor.getGeoSorts().contains(sortPredicate.getPropertyName());
         }
-        
+
         final String cacheKey = applicationScope.getApplication().getUuid().toString()+"_"+searchEdge.getEdgeName();
         final Object totalEdgeSizeFromCache = sizeCache.getIfPresent(cacheKey);
         long totalEdgeSizeInBytes;
@@ -490,6 +497,10 @@ public CandidateResults search( final SearchEdge searchEdge, final SearchTypes s
                 searchTypes.getTypeNames( applicationScope ), srb );
         }
 
+        if (returnQuery) {
+            throw new QueryReturnException(parsedQuery.getOriginalQuery(), srb.toString(), applicationScope.getApplication().getUuid());
+        }
+
         //Added For Graphite Metrics
         final Timer.Context timerContext = searchTimer.time();
 
diff --git a/stack/rest/src/main/java/org/apache/usergrid/rest/applications/ServiceResource.java b/stack/rest/src/main/java/org/apache/usergrid/rest/applications/ServiceResource.java
diff --git a/stack/rest/src/main/java/org/apache/usergrid/rest/exceptions/QueryReturnExceptionMapper.java b/stack/rest/src/main/java/org/apache/usergrid/rest/exceptions/QueryReturnExceptionMapper.java
diff --git a/stack/services/src/main/java/org/apache/usergrid/services/AbstractService.java b/stack/services/src/main/java/org/apache/usergrid/services/AbstractService.java
diff --git a/stack/services/src/main/java/org/apache/usergrid/services/ServiceManager.java b/stack/services/src/main/java/org/apache/usergrid/services/ServiceManager.java
diff --git a/stack/services/src/main/java/org/apache/usergrid/services/ServiceRequest.java b/stack/services/src/main/java/org/apache/usergrid/services/ServiceRequest.java

Original file line number	Diff line number	Diff line change
`@@ -106,7 +106,8 @@ public Observable<ResultsPage<Entity>> searchConnection( final ConnectionSearch`
`106`	`106`	`else {`
`107`	`107`
`108`	`108`	`results =`
`109`		`- pipelineBuilder.searchConnection( search.getConnectionName(), query.get(), search.getEntityType(), search.getAnalyzeOnly() )`
	`109`	`+ pipelineBuilder.searchConnection( search.getConnectionName(), query.get(), search.getEntityType(),`
	`110`	`+ search.getAnalyzeOnly(), search.getReturnQuery() )`
`110`	`111`	`.loadEntities();`
`111`	`112`	`}`
`112`	`113`
`@@ -135,7 +136,8 @@ public Observable<ResultsPage<ConnectionRef>> searchConnectionAsRefs( final Conn`
`135`	`136`	`}`
`136`	`137`	`else {`
`137`	`138`	`traversedIds =`
`138`		`- pipelineBuilder.searchConnection( connectionName, query.get(), search.getEntityType(), search.getAnalyzeOnly() ).loadIds();`
	`139`	`+ pipelineBuilder.searchConnection( connectionName, query.get(), search.getEntityType(),`
	`140`	`+ search.getAnalyzeOnly(), search.getReturnQuery() ).loadIds();`
`139`	`141`	`}`
`140`	`142`
`141`	`143`	`//create connection refs`