chore: fixes

Author: ovr

packages/cubejs-api-gateway/package.json

@@ -15,7 +15,7 @@
   "typings": "dist/src/index.d.ts",
   "scripts": {
     "test": "npm run unit",
-    "unit": "CUBE_JS_NATIVE_API_GATEWAY_INTERNAL=true jest --coverage dist/test",
+    "unit": "CUBE_JS_NATIVE_API_GATEWAY_INTERNAL=true jest --coverage --forceExit dist/test",
     "build": "rm -rf dist && npm run tsc",
     "tsc": "tsc",
     "watch": "tsc -w",

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

@@ -1,6 +1,5 @@
 import {
   setupLogger,
-  resetLogger,
   registerInterface,
   shutdownInterface,
   execSql,
@@ -15,7 +14,7 @@ import { displayCLIWarning, getEnv } from '@cubejs-backend/shared';
 
 import * as crypto from 'crypto';
 import type { ApiGateway } from './gateway';
-import type { CheckAuthFn, CheckSQLAuthFn, ExtendedRequestContext, CanSwitchSQLUserFn } from './interfaces';
+import type { CheckSQLAuthFn, ExtendedRequestContext, CanSwitchSQLUserFn } from './interfaces';
 
 export type SQLServerOptions = {
   checkSqlAuth?: CheckSQLAuthFn,
@@ -381,9 +380,5 @@ export class SQLServer {
 
   public async shutdown(mode: ShutdownMode): Promise<void> {
     await shutdownInterface(this.sqlInterfaceInstance!, mode);
-
-    resetLogger(
-      process.env.CUBEJS_LOG_LEVEL === 'trace' ? 'trace' : 'warn'
-    );
   }
 }

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

@@ -3,11 +3,11 @@ import express, { Application as ExpressApplication, RequestHandler } from 'expr
 // eslint-disable-next-line import/no-extraneous-dependencies
 import request from 'supertest';
 import jwt from 'jsonwebtoken';
-import { getEnv, pausePromise } from '@cubejs-backend/shared';
+import { pausePromise } from '@cubejs-backend/shared';
+import { resetLogger } from '@cubejs-backend/native';
 
-import { ApiGateway, ApiGatewayOptions, CubejsHandlerError, Request } from '../src';
+import { ApiGateway, ApiGatewayOptions, CubejsHandlerError, Request, RequestContext } from '../src';
 import { AdapterApiMock, DataSourceStorageMock } from './mocks';
-import { RequestContext } from '../src/interfaces';
 import { generateAuthToken } from './utils';
 
 class ApiGatewayOpenAPI extends ApiGateway {
@@ -33,6 +33,12 @@ class ApiGatewayOpenAPI extends ApiGateway {
     } finally {
       this.isRunning = null;
     }
+
+    // SQLServer changes logger for rust side with setupLogger in the constructor, but it leads
+    // to a memory leak, that's why jest doesn't allow to shut down tests
+    resetLogger(
+      process.env.CUBEJS_LOG_LEVEL === 'trace' ? 'trace' : 'warn'
+    );
   }
 }
 
@@ -64,6 +70,7 @@ function createApiGateway(handler: RequestHandler, logger: () => any, options: P
   });
 
   process.env.NODE_ENV = 'unknown';
+
   const app = express();
   apiGateway.initApp(app);
 
@@ -74,27 +81,28 @@ function createApiGateway(handler: RequestHandler, logger: () => any, options: P
 }
 
 describe('test authorization with native gateway', () => {
-  const expectSecurityContext = (securityContext) => {
-    expect(securityContext.uid).toEqual(5);
-    expect(securityContext.iat).toBeDefined();
-    expect(securityContext.exp).toBeDefined();
-  };
-
   let app: ExpressApplication;
   let apiGateway: ApiGatewayOpenAPI;
 
-  const handlerMock = jest.fn((req, res) => {
-    expectSecurityContext(req.context.authInfo);
-    expectSecurityContext(req.context.securityContext);
-
-    res.status(200).end();
+  const handlerMock = jest.fn(() => {
+    // nothing, we are using it to verify that we don't got to express code
   });
   const loggerMock = jest.fn(() => {
     //
   });
+  const checkAuthMock = jest.fn((req, token) => {
+    jwt.verify(token, 'secret');
+
+    return {
+      security_context: {}
+    };
+  });
 
   beforeAll(async () => {
-    const result = createApiGateway(handlerMock, loggerMock, {});
+    const result = createApiGateway(handlerMock, loggerMock, {
+      checkAuth: checkAuthMock,
+      gatewayPort: 8585,
+    });
 
     app = result.app;
     apiGateway = result.apiGateway;
@@ -105,15 +113,11 @@ describe('test authorization with native gateway', () => {
   beforeEach(() => {
     handlerMock.mockClear();
     loggerMock.mockClear();
+    checkAuthMock.mockClear();
   });
 
   afterAll(async () => {
-    try {
-      await apiGateway.shutdownSQLServer();
-    } catch (error) {
-      // TODO: Figure out, why ApiGatewayServer cannot shutdown!?
-      console.log(`Error while shutting down server: ${error}`);
-    }
+    await apiGateway.shutdownSQLServer();
   });
 
   it('default authorization - success', async () => {
@@ -122,43 +126,70 @@ describe('test authorization with native gateway', () => {
     await request(app)
       .get('/cubejs-api/v2/stream')
       .set('Authorization', `${token}`)
+      .send()
       .expect(501);
 
     // No bad logs
     expect(loggerMock.mock.calls.length).toEqual(0);
     // We should not call js handler, request should go into rust code
     expect(handlerMock.mock.calls.length).toEqual(0);
 
-    await apiGateway.shutdownSQLServer();
+    // Verify that we passed token to JS side
+    expect(checkAuthMock.mock.calls.length).toEqual(1);
+    expect(checkAuthMock.mock.calls[0][0].protocol).toEqual('http');
+    expect(checkAuthMock.mock.calls[0][1]).toEqual(token);
+  });
+
+  it('default authorization - success (bearer prefix)', async () => {
+    const token = generateAuthToken({ uid: 5, });
+
+    await request(app)
+      .get('/cubejs-api/v2/stream')
+      .set('Authorization', `Bearer ${token}`)
+      .send()
+      .expect(501);
+
+    // No bad logs
+    expect(loggerMock.mock.calls.length).toEqual(0);
+    // We should not call js handler, request should go into rust code
+    expect(handlerMock.mock.calls.length).toEqual(0);
+
+    // Verify that we passed token to JS side
+    expect(checkAuthMock.mock.calls.length).toEqual(1);
+    expect(checkAuthMock.mock.calls[0][0].protocol).toEqual('http');
+    expect(checkAuthMock.mock.calls[0][1]).toEqual(token);
   });
 
   it('default authorization - wrong secret', async () => {
-    const badToken = generateAuthToken({ uid: 5, }, {}, 'bad');
+    const badToken = 'SUPER_LARGE_BAD_TOKEN_WHICH_IS_NOT_A_TOKEN';
 
     await request(app)
       .get('/cubejs-api/v2/stream')
       .set('Authorization', `${badToken}`)
-      .expect(403);
+      .send()
+      .expect(401);
 
     // No bad logs
     expect(loggerMock.mock.calls.length).toEqual(0);
     // We should not call js handler, request should go into rust code
     expect(handlerMock.mock.calls.length).toEqual(0);
 
-    await apiGateway.shutdownSQLServer();
+    // Verify that we passed token to JS side
+    expect(checkAuthMock.mock.calls.length).toEqual(1);
+    expect(checkAuthMock.mock.calls[0][0].protocol).toEqual('http');
+    expect(checkAuthMock.mock.calls[0][1]).toEqual(badToken);
   });
 
   it('default authorization - missing auth header', async () => {
     await request(app)
       .get('/cubejs-api/v2/stream')
-      .expect(403);
+      .send()
+      .expect(401);
 
     // No bad logs
     expect(loggerMock.mock.calls.length).toEqual(0);
     // We should not call js handler, request should go into rust code
     expect(handlerMock.mock.calls.length).toEqual(0);
-
-    await apiGateway.shutdownSQLServer();
   });
 });