add tests for api-gw preagg jobs endpoint

Author: KSDaemon

packages/cubejs-api-gateway/src/gateway.ts

@@ -856,7 +856,7 @@ class ApiGateway {
     try {
       await this.assertApiScope('jobs', req?.context?.securityContext);
 
-      if (!query) {
+      if (!query || Object.keys(query).length === 0) {
         throw new UserError('No job description provided');
       }
 
@@ -906,11 +906,6 @@ class ApiGateway {
   ): Promise<string[]> {
     let jobs: string[] = [];
 
-    // For the sake of type check, as contexts are checked in preAggregationsJobs()
-    if (!selector.contexts) {
-      return jobs;
-    }
-
     // There might be a few contexts but dateRange if present is still the same
     // so let's normalize it only once.
     // It's expected that selector.dateRange is provided in local time (without timezone)
@@ -919,7 +914,7 @@ class ApiGateway {
       const start = parseLocalDate([{ val: selector.dateRange[0] }], 'UTC');
       const end = parseLocalDate([{ val: selector.dateRange[1] }], 'UTC');
       if (!start || !end) {
-        throw new Error(`Cannot parse selector date range ${selector.dateRange}`);
+        throw new UserError(`Cannot parse selector date range ${selector.dateRange}`);
       }
       selector.dateRange = [start, end];
     }

packages/cubejs-api-gateway/test/index.test.ts

@@ -17,6 +17,7 @@ import {
   DataSourceStorageMock,
   AdapterApiMock
 } from './mocks';
+import { ApiScopesTuple } from '../src/types/auth';
 
 const logger = (type, message) => console.log({ type, ...message });
 
@@ -61,6 +62,7 @@ async function createApiGateway(
 
   process.env.NODE_ENV = 'unknown';
   const app = express();
+  app.use(express.json());
   apiGateway.initApp(app);
 
   return {
@@ -982,6 +984,96 @@ describe('API Gateway', () => {
     });
   });
 
+  describe('/v1/pre-aggregations/jobs', () => {
+    const scheduledRefreshContextsFactory = () => ([
+      { securityContext: { foo: 'bar' } },
+      { securityContext: { bar: 'foo' } }
+    ]);
+
+    const scheduledRefreshTimeZonesFactory = () => (['UTC', 'America/Los_Angeles']);
+
+    const appPrepareFactory = async (scope: string[]) => {
+      const playgroundAuthSecret = 'test12345';
+      const { app } = await createApiGateway(
+        new AdapterApiMock(),
+        new DataSourceStorageMock(),
+        {
+          basePath: '/test',
+          playgroundAuthSecret,
+          refreshScheduler: () => new RefreshSchedulerMock(),
+          scheduledRefreshContexts: () => Promise.resolve(scheduledRefreshContextsFactory()),
+          scheduledRefreshTimeZones: scheduledRefreshTimeZonesFactory,
+          contextToApiScopes: () => Promise.resolve(<ApiScopesTuple>scope)
+        }
+      );
+      const token = generateAuthToken({ uid: 5, scope }, {}, playgroundAuthSecret);
+      const tokenUser = generateAuthToken({ uid: 5, scope }, {}, API_SECRET);
+
+      return { app, token, tokenUser };
+    };
+
+    test('no input', async () => {
+      const { app, tokenUser } = await appPrepareFactory(['graphql', 'data', 'meta', 'jobs']);
+
+      const req = request(app).post('/test/v1/pre-aggregations/jobs')
+        .set('Content-type', 'application/json')
+        .set('Authorization', `Bearer ${tokenUser}`);
+
+      const res = await req;
+      expect(res.status).toEqual(400);
+      expect(res.body.error).toEqual('No job description provided');
+    });
+
+    test('invalid input action', async () => {
+      const { app, tokenUser } = await appPrepareFactory(['graphql', 'data', 'meta', 'jobs']);
+
+      const req = request(app).post('/test/v1/pre-aggregations/jobs')
+        .set('Content-type', 'application/json')
+        .set('Authorization', `Bearer ${tokenUser}`)
+        .send({ action: 'patch' });
+
+      const res = await req;
+      expect(res.status).toEqual(400);
+      expect(res.body.error.includes('Invalid Job query format')).toBeTruthy();
+    });
+
+    test('invalid input date range', async () => {
+      const { app, tokenUser } = await appPrepareFactory(['graphql', 'data', 'meta', 'jobs']);
+
+      let req = request(app).post('/test/v1/pre-aggregations/jobs')
+        .set('Content-type', 'application/json')
+        .set('Authorization', `Bearer ${tokenUser}`)
+        .send({
+          action: 'post',
+          selector: {
+            contexts: [{ securityContext: {} }],
+            timezones: ['UTC', 'America/Los_Angeles'],
+            dateRange: ['invalid string', '2020-02-20']
+          }
+        });
+
+      let res = await req;
+      expect(res.status).toEqual(400);
+      expect(res.body.error.includes('Cannot parse selector date range')).toBeTruthy();
+
+      req = request(app).post('/test/v1/pre-aggregations/jobs')
+        .set('Content-type', 'application/json')
+        .set('Authorization', `Bearer ${tokenUser}`)
+        .send({
+          action: 'post',
+          selector: {
+            contexts: [{ securityContext: {} }],
+            timezones: ['UTC', 'America/Los_Angeles'],
+            dateRange: ['2020-02-20', 'invalid string']
+          }
+        });
+
+      res = await req;
+      expect(res.status).toEqual(400);
+      expect(res.body.error.includes('Cannot parse selector date range')).toBeTruthy();
+    });
+  });
+
   describe('healtchecks', () => {
     test('readyz (standalone)', async () => {
       const { app, adapterApi } = await createApiGateway();