feat: Provide status messages for `/cubejs-api/v1/run-scheduled-refresh API

Author: paveltiunov

packages/cubejs-api-gateway/index.js

@@ -325,8 +325,10 @@ class ApiGateway {
     const requestStarted = new Date();
     try {
       const refreshScheduler = this.refreshScheduler();
-      await refreshScheduler.runScheduledRefresh(context, this.parseQueryParam(queryingOptions || {}));
-      res({}); // TODO status
+      res(await refreshScheduler.runScheduledRefresh(context, {
+        ...this.parseQueryParam(queryingOptions || {}),
+        throwErrors: true
+      }));
     } catch (e) {
       this.handleError({
         e, context, res, requestStarted

packages/cubejs-server-core/core/RefreshScheduler.js

@@ -79,6 +79,7 @@ class RefreshScheduler {
 
   async runScheduledRefresh(context, queryingOptions) {
     queryingOptions = { timezone: 'UTC', ...queryingOptions };
+    const { throwErrors, ...restOptions } = queryingOptions;
     context = { requestId: `scheduler-${uuid()}`, ...context };
     this.serverCore.logger('Refresh Scheduler Run', {
       authInfo: context.authInfo,
@@ -87,9 +88,12 @@ class RefreshScheduler {
     try {
       const compilerApi = this.serverCore.getCompilerApi(context);
       await Promise.all([
-        this.refreshCubesRefreshKey(context, compilerApi, queryingOptions),
-        this.refreshPreAggregations(context, compilerApi, queryingOptions)
+        this.refreshCubesRefreshKey(context, compilerApi, restOptions),
+        this.refreshPreAggregations(context, compilerApi, restOptions)
       ]);
+      return {
+        finished: true
+      };
     } catch (e) {
       if (e.error !== 'Continue wait') {
         this.serverCore.logger('Refresh Scheduler Error', {
@@ -98,7 +102,11 @@ class RefreshScheduler {
           requestId: context.requestId
         });
       }
+      if (throwErrors) {
+        throw e;
+      }
     }
+    return { finished: false };
   }
 
   async refreshCubesRefreshKey(context, compilerApi, queryingOptions) {

packages/cubejs-server-core/core/index.js

@@ -462,7 +462,7 @@ class CubejsServerCore {
 
   async runScheduledRefresh(context, queryingOptions) {
     const scheduler = new RefreshScheduler(this);
-    await scheduler.runScheduledRefresh(context, queryingOptions);
+    return scheduler.runScheduledRefresh(context, queryingOptions);
   }
 
   async getDriver() {