Merge pull request #670 from cube-js/react-query-skip

feat(cubejs-client-react)!: ability to skip the query for the useCubeQuery hook

Author: vasilev-alex

packages/cubejs-client-react/src/useCubeQuery.js

@@ -1,25 +1,26 @@
 import {
-  useContext, useEffect, useState
+  useContext, useEffect, useState, useRef
 } from 'react';
 import { equals } from 'ramda';
 import CubeContext from './CubeContext';
 import isQueryPresent from './isQueryPresent';
 import useDeepCompareMemoize from './useDeepCompareMemoize';
 
 export default (query, options = {}) => {
-  const [mutexObj] = useState({});
+  const mutexRef = useRef({});
   const [currentQuery, setCurrentQuery] = useState(null);
   const [isLoading, setLoading] = useState(false);
   const [resultSet, setResultSet] = useState(null);
   const [error, setError] = useState(null);
   const context = useContext(CubeContext);
-  const { resetResultSetOnChange } = options;
 
   let subscribeRequest = null;
 
   useEffect(() => {
+    const { skip = false, resetResultSetOnChange } = options;
+
     async function loadQuery() {
-      if (query && isQueryPresent(query)) {
+      if (!skip && query && isQueryPresent(query)) {
         if (!equals(currentQuery, query)) {
           if (resetResultSetOnChange == null || resetResultSetOnChange) {
             setResultSet(null);
@@ -36,19 +37,19 @@ export default (query, options = {}) => {
           const cubejsApi = options.cubejsApi || context && context.cubejsApi;
           if (options.subscribe) {
             subscribeRequest = cubejsApi.subscribe(query, {
-              mutexObj,
+              mutexObj: mutexRef.current,
               mutexKey: 'query'
             }, (e, result) => {
-              setLoading(false);
               if (e) {
                 setError(e);
               } else {
                 setResultSet(result);
               }
+              setLoading(false);
             });
           } else {
             setResultSet(await cubejsApi.load(query, {
-              mutexObj,
+              mutexObj: mutexRef.current,
               mutexKey: 'query'
             }));
             setLoading(false);
@@ -59,6 +60,7 @@ export default (query, options = {}) => {
         }
       }
     }
+
     loadQuery();
     return () => {
       if (subscribeRequest) {