mirror of
https://github.com/qlik-oss/nebula.js.git
synced 2025-12-19 17:58:43 -05:00
e29328cae3
* fix: make sure checking stepCycle func exist before calling * fix: make sure stepCycle func exist before calling * fix: also check if app exist * fix: add return * fix: make sure checking stepCycle func exist before calling * fix: make sure stepCycle func exist before calling * fix: also check if app exist * fix: add return * chore: update engima and schema version * test: unit test * fix: remove engine version --------- Co-authored-by: caele <tsm@qlik.com>
536 lines
18 KiB
JavaScript
536 lines
18 KiB
JavaScript
import * as SDK from '@qlik/sdk';
|
|
import * as ENIGMA from 'enigma.js';
|
|
import qixSchema from 'enigma.js/schemas/12.2015.0.json';
|
|
import * as SenseUtilities from 'enigma.js/sense-utilities';
|
|
import { connect, openApp, getConnectionInfo, getParams, parseEngineURL } from '../connect';
|
|
|
|
jest.mock('@qlik/sdk');
|
|
jest.mock('enigma.js');
|
|
jest.mock('enigma.js/sense-utilities');
|
|
|
|
describe('connect.js', () => {
|
|
let appId;
|
|
let authConfig = {};
|
|
let isAuthenticatedMock;
|
|
let authenticateMock;
|
|
let restCallMock;
|
|
let jsonResponseMock;
|
|
let generateWebsocketUrlMock;
|
|
let windowFetchSpy;
|
|
|
|
beforeEach(() => {
|
|
appId = 'someAppId';
|
|
authConfig = {
|
|
authType: 'WebIntegration',
|
|
autoRedirect: 'true',
|
|
host: 'some.eu.tenant.pte.qlikdev.com',
|
|
webIntegrationId: 'someIntegrationId',
|
|
};
|
|
isAuthenticatedMock = jest.fn();
|
|
authenticateMock = jest.fn();
|
|
restCallMock = jest.fn();
|
|
jsonResponseMock = jest.fn();
|
|
generateWebsocketUrlMock = jest.fn();
|
|
jest.spyOn(global, 'fetch').mockImplementationOnce(() =>
|
|
Promise.resolve({
|
|
ok: true,
|
|
json: jsonResponseMock,
|
|
})
|
|
);
|
|
SDK.Auth.mockImplementation(() => ({
|
|
config: authConfig,
|
|
isAuthenticated: isAuthenticatedMock,
|
|
authenticate: authenticateMock,
|
|
rest: restCallMock,
|
|
generateWebsocketUrl: generateWebsocketUrlMock,
|
|
}));
|
|
windowFetchSpy = jest.spyOn(window, 'fetch');
|
|
});
|
|
|
|
afterEach(() => {
|
|
jest.resetAllMocks();
|
|
jest.restoreAllMocks();
|
|
});
|
|
|
|
describe('connect()', () => {
|
|
beforeEach(() => {
|
|
windowFetchSpy.mockResolvedValue({
|
|
ok: true,
|
|
json: async () => ({ isAuthorized: false }),
|
|
});
|
|
});
|
|
|
|
test('should throw error if fails to get enigma instance', async () => {
|
|
jsonResponseMock.mockImplementation(() => Promise.reject(new Error('failed')));
|
|
try {
|
|
await connect();
|
|
} catch (err) {
|
|
expect(err.message).toBe('Failed to return enigma instance');
|
|
}
|
|
});
|
|
|
|
describe('connectiong with `webIntegrationId` flow', () => {
|
|
beforeEach(() => {
|
|
jsonResponseMock.mockImplementation(() =>
|
|
Promise.resolve({
|
|
webIntegrationId: 'someIntegrationId',
|
|
enigma: {
|
|
secure: false,
|
|
host: 'some.eu.tenant.pte.qlikdev.com',
|
|
},
|
|
})
|
|
);
|
|
});
|
|
|
|
test('should not call `Auth.authenticate()` if user is already logged in', async () => {
|
|
isAuthenticatedMock.mockImplementationOnce(() => true);
|
|
await connect();
|
|
expect(SDK.Auth).toHaveBeenCalledTimes(1);
|
|
expect(isAuthenticatedMock).toHaveBeenCalledTimes(1);
|
|
expect(authenticateMock).toHaveBeenCalledTimes(0);
|
|
});
|
|
|
|
test('should call `Auth.authenticate()` if user is not logged in', async () => {
|
|
isAuthenticatedMock.mockImplementationOnce(() => false);
|
|
await connect();
|
|
expect(SDK.Auth).toHaveBeenCalledTimes(1);
|
|
expect(isAuthenticatedMock).toHaveBeenCalledTimes(1);
|
|
expect(authenticateMock).toHaveBeenCalledTimes(1);
|
|
});
|
|
|
|
test('should return `getDocList()` and `getConfiguration()`', async () => {
|
|
const result = await connect();
|
|
expect(result).toMatchObject({
|
|
getDocList: expect.any(Function),
|
|
getConfiguration: expect.any(Function),
|
|
});
|
|
});
|
|
});
|
|
|
|
describe('connectiong with Local Engine flow', () => {
|
|
let connectionResponse = {};
|
|
let buildUrlMock;
|
|
let enigmaOpenMock;
|
|
let enigmaCreateMock;
|
|
|
|
beforeEach(() => {
|
|
connectionResponse = {
|
|
webIntegrationId: undefined,
|
|
enigma: {
|
|
secure: false,
|
|
host: 'localhost:1234/app/engineData',
|
|
},
|
|
};
|
|
jsonResponseMock.mockImplementation(() => Promise.resolve(connectionResponse));
|
|
|
|
buildUrlMock = jest.fn().mockReturnValue(`ws://${connectionResponse.enigma.host}`);
|
|
jest.spyOn(SenseUtilities, 'buildUrl').mockImplementation(buildUrlMock);
|
|
|
|
enigmaOpenMock = jest.fn();
|
|
enigmaCreateMock = jest.fn().mockReturnValue({
|
|
open: enigmaOpenMock,
|
|
});
|
|
ENIGMA.create.mockImplementation(enigmaCreateMock);
|
|
});
|
|
|
|
afterEach(() => {
|
|
jest.resetAllMocks();
|
|
jest.restoreAllMocks();
|
|
});
|
|
|
|
test('should call buildUrl with proper arguments', async () => {
|
|
await connect();
|
|
expect(buildUrlMock).toHaveBeenCalledTimes(1);
|
|
expect(buildUrlMock).toHaveBeenCalledWith(connectionResponse.enigma);
|
|
});
|
|
|
|
test('should call `enigma.create` with proper arguments', async () => {
|
|
await connect();
|
|
expect(enigmaCreateMock).toHaveBeenCalledTimes(1);
|
|
expect(enigmaCreateMock).toHaveBeenCalledWith({
|
|
schema: qixSchema,
|
|
url: `ws://${connectionResponse.enigma.host}`,
|
|
});
|
|
});
|
|
|
|
test('should call `enigma.create().open()` one time', async () => {
|
|
await connect();
|
|
expect(enigmaOpenMock).toHaveBeenCalledTimes(1);
|
|
});
|
|
});
|
|
});
|
|
|
|
describe('openApp()', () => {
|
|
test('should throw error if fails to open app', async () => {
|
|
jsonResponseMock.mockImplementation(() => Promise.reject(new Error('failed')));
|
|
try {
|
|
await openApp();
|
|
} catch (err) {
|
|
expect(err.message).toBe('Failed to open app!');
|
|
}
|
|
});
|
|
|
|
describe('Open app flows', () => {
|
|
let connectionResponse = {};
|
|
let buildUrlMock;
|
|
let enigmaOpenDocMock;
|
|
let enigmaOpenMock;
|
|
let enigmaCreateMock;
|
|
|
|
beforeEach(() => {
|
|
enigmaOpenDocMock = jest.fn();
|
|
enigmaOpenMock = jest.fn().mockReturnValue({
|
|
openDoc: enigmaOpenDocMock,
|
|
});
|
|
enigmaCreateMock = jest.fn().mockReturnValue({
|
|
open: enigmaOpenMock,
|
|
});
|
|
ENIGMA.create.mockImplementation(enigmaCreateMock);
|
|
});
|
|
|
|
describe('open app with `webIntegrationId` flow', () => {
|
|
let webSocketURL;
|
|
|
|
beforeEach(() => {
|
|
jsonResponseMock.mockImplementation(() =>
|
|
Promise.resolve({
|
|
webIntegrationId: 'someIntegrationId',
|
|
enigma: {
|
|
secure: false,
|
|
host: 'some.eu.tenant.pte.qlikdev.com',
|
|
},
|
|
})
|
|
);
|
|
webSocketURL = `wss://${authConfig.host}/apps/${appId}?qlik-csrf-token=SOME_CSRF_TOKEN&qlik-web-integration-id=${authConfig.webIntegrationId}`;
|
|
generateWebsocketUrlMock.mockReturnValue(webSocketURL);
|
|
});
|
|
|
|
test('should not call `Auth.authenticate()` if user is already logged in', async () => {
|
|
isAuthenticatedMock.mockImplementationOnce(() => true);
|
|
await openApp(appId);
|
|
expect(SDK.Auth).toHaveBeenCalledTimes(1);
|
|
expect(isAuthenticatedMock).toHaveBeenCalledTimes(1);
|
|
expect(authenticateMock).toHaveBeenCalledTimes(0);
|
|
});
|
|
|
|
test('should call `Auth.authenticate()` if user is not logged in', async () => {
|
|
isAuthenticatedMock.mockImplementationOnce(() => false);
|
|
await openApp(appId);
|
|
expect(SDK.Auth).toHaveBeenCalledTimes(1);
|
|
expect(isAuthenticatedMock).toHaveBeenCalledTimes(1);
|
|
expect(authenticateMock).toHaveBeenCalledTimes(1);
|
|
});
|
|
|
|
test('should call `enigma.create` with proper arguments', async () => {
|
|
await openApp(appId);
|
|
expect(enigmaCreateMock).toHaveBeenCalledTimes(1);
|
|
expect(enigmaCreateMock).toHaveBeenCalledWith({
|
|
schema: qixSchema,
|
|
url: webSocketURL,
|
|
});
|
|
});
|
|
|
|
test('should call `enigma.create().open()` one time', async () => {
|
|
await openApp(appId);
|
|
expect(enigmaOpenMock).toHaveBeenCalledTimes(1);
|
|
});
|
|
|
|
test('should call `enigma.create().open().openDoc()` one time with proper app id', async () => {
|
|
await openApp(appId);
|
|
expect(enigmaOpenDocMock).toHaveBeenCalledTimes(1);
|
|
expect(enigmaOpenDocMock).toHaveBeenCalledWith(appId);
|
|
});
|
|
});
|
|
|
|
describe('with Local engine flow', () => {
|
|
beforeEach(() => {
|
|
connectionResponse = {
|
|
webIntegrationId: undefined,
|
|
enigma: {
|
|
secure: false,
|
|
host: 'localhost:1234/app/engineData',
|
|
},
|
|
};
|
|
jsonResponseMock.mockImplementation(() => Promise.resolve(connectionResponse));
|
|
buildUrlMock = jest.fn().mockReturnValue(`ws://${connectionResponse.enigma.host}`);
|
|
jest.spyOn(SenseUtilities, 'buildUrl').mockImplementation(buildUrlMock);
|
|
});
|
|
|
|
test('should call buildUrl with proper arguments', async () => {
|
|
await openApp(appId);
|
|
expect(buildUrlMock).toHaveBeenCalledTimes(1);
|
|
expect(buildUrlMock).toHaveBeenCalledWith(connectionResponse.enigma);
|
|
});
|
|
|
|
test('should call `enigma.create` with proper arguments', async () => {
|
|
await openApp(appId);
|
|
expect(enigmaCreateMock).toHaveBeenCalledTimes(1);
|
|
expect(enigmaCreateMock).toHaveBeenCalledWith({
|
|
schema: qixSchema,
|
|
url: `ws://${connectionResponse.enigma.host}`,
|
|
});
|
|
});
|
|
|
|
test('should call `enigma.create().open()` one time', async () => {
|
|
await openApp(appId);
|
|
expect(enigmaOpenMock).toHaveBeenCalledTimes(1);
|
|
});
|
|
|
|
test('should call `enigma.create().open().openDoc()` one time with proper app id', async () => {
|
|
await openApp(appId);
|
|
expect(enigmaOpenDocMock).toHaveBeenCalledTimes(1);
|
|
expect(enigmaOpenDocMock).toHaveBeenCalledWith(appId);
|
|
});
|
|
});
|
|
});
|
|
});
|
|
|
|
describe('getConnectionInfo()', () => {
|
|
beforeEach(() => {
|
|
jsonResponseMock.mockImplementation(() =>
|
|
Promise.resolve({
|
|
webIntegrationId: 'someIntegrationId',
|
|
enigma: {
|
|
secure: false,
|
|
host: 'some.eu.tenant.pte.qlikdev.com',
|
|
},
|
|
})
|
|
);
|
|
});
|
|
|
|
test('should parse engine url while connecting into SDE', async () => {
|
|
window.location.assign(
|
|
`/some-url?engine_url=wss://${authConfig.host}&qlik-web-integration-id=${authConfig.webIntegrationId}`
|
|
);
|
|
const result = await getConnectionInfo();
|
|
expect(result).toEqual(
|
|
expect.objectContaining({
|
|
appUrl: undefined,
|
|
enigma: expect.objectContaining({
|
|
secure: true, // since it is "wss"
|
|
host: authConfig.host,
|
|
port: undefined, // since we are providing link
|
|
appId: undefined, // since we are providing link
|
|
}),
|
|
engineUrl: `wss://${authConfig.host}`,
|
|
rootPath: `https://${authConfig.host}`,
|
|
})
|
|
);
|
|
});
|
|
|
|
test('should pass `qlik-web-integration-id` if it is provided in url', async () => {
|
|
window.location.assign(
|
|
`/some-url?engine_url=wss://${authConfig.host}&qlik-web-integration-id=${authConfig.webIntegrationId}`
|
|
);
|
|
const result = await getConnectionInfo();
|
|
expect(result).toEqual(
|
|
expect.objectContaining({
|
|
appUrl: undefined,
|
|
webIntegrationId: authConfig.webIntegrationId,
|
|
engineUrl: `wss://${authConfig.host}`,
|
|
rootPath: `https://${authConfig.host}`,
|
|
})
|
|
);
|
|
});
|
|
|
|
test('should parse engine url while connecting to local docker engine', async () => {
|
|
window.location.assign('/?engine_url=ws://localhost:1234');
|
|
const result = await getConnectionInfo();
|
|
expect(result).toEqual(
|
|
expect.objectContaining({
|
|
enigma: expect.objectContaining({
|
|
secure: false, // since it is "ws"
|
|
host: 'localhost',
|
|
port: '1234',
|
|
appId: undefined, // there is no appId
|
|
}),
|
|
engineUrl: 'ws://localhost:1234',
|
|
appUrl: undefined,
|
|
})
|
|
);
|
|
});
|
|
|
|
test('should pass appId if it is provided in url', async () => {
|
|
window.location.assign('/?app=SOME_APP_ID');
|
|
const result = await getConnectionInfo();
|
|
expect(result).toEqual(
|
|
expect.objectContaining({
|
|
enigma: expect.objectContaining({
|
|
secure: false, // since it is "ws"
|
|
host: authConfig.host,
|
|
appId: 'SOME_APP_ID',
|
|
}),
|
|
webIntegrationId: authConfig.webIntegrationId,
|
|
})
|
|
);
|
|
});
|
|
|
|
test('should return invalid if url was not matching anything', async () => {
|
|
jsonResponseMock.mockImplementation(() =>
|
|
Promise.resolve({
|
|
invalid: true,
|
|
})
|
|
);
|
|
const result = await getConnectionInfo();
|
|
expect(result).toEqual({
|
|
invalid: true,
|
|
});
|
|
});
|
|
});
|
|
|
|
describe('getParams()', () => {
|
|
beforeEach(() => {
|
|
jsonResponseMock.mockImplementation(() =>
|
|
Promise.resolve({
|
|
webIntegrationId: 'someIntegrationId',
|
|
enigma: {
|
|
secure: false,
|
|
host: 'some.eu.tenant.pte.qlikdev.com',
|
|
},
|
|
})
|
|
);
|
|
});
|
|
|
|
test('should detect engine url and integration id from provided link', () => {
|
|
window.location.assign(
|
|
`/some-url?engine_url=wss://${authConfig.host}&qlik-web-integration-id=${authConfig.webIntegrationId}`
|
|
);
|
|
expect(getParams()).toEqual({
|
|
engine_url: `wss://${authConfig.host}`,
|
|
'qlik-web-integration-id': authConfig.webIntegrationId,
|
|
});
|
|
});
|
|
|
|
test('should separate columns in to an array in case of any `cols` params in link', () => {
|
|
window.location.assign('/?engine_url=ws://localhost:1234&cols=col_01,col_02,col_03');
|
|
expect(getParams()).toEqual({
|
|
engine_url: 'ws://localhost:1234',
|
|
cols: ['col_01', 'col_02', 'col_03'],
|
|
});
|
|
});
|
|
});
|
|
|
|
describe('parseEngineURL()', () => {
|
|
let url;
|
|
|
|
test('should return invalid object if there was no match', () => {
|
|
url = '/?someParam=https://localhost:1234';
|
|
const result = parseEngineURL(url);
|
|
expect(result).toEqual({
|
|
engineUrl: url,
|
|
invalid: true,
|
|
});
|
|
});
|
|
|
|
test('should return expected info from SDE url', () => {
|
|
url = `/some-url?engine_url=wss://${authConfig.host}&qlik-web-integration-id=${authConfig.webIntegrationId}`;
|
|
const result = parseEngineURL(url);
|
|
expect(result).toMatchObject({
|
|
enigma: expect.objectContaining({
|
|
secure: expect.any(Boolean),
|
|
host: expect.any(String),
|
|
port: undefined, // because of providing a link
|
|
appId: undefined, // since there is not appid in link
|
|
prefix: undefined,
|
|
}),
|
|
engineUrl: expect.any(String),
|
|
appUrl: undefined, // because no app has been provided
|
|
});
|
|
});
|
|
|
|
test('should return expected info from Local Docker url', () => {
|
|
url = '/?engine_url=ws://localhost:1234';
|
|
const result = parseEngineURL(url);
|
|
expect(result).toMatchObject({
|
|
enigma: expect.objectContaining({
|
|
secure: expect.any(Boolean),
|
|
host: expect.any(String),
|
|
port: expect.any(String),
|
|
appId: undefined, // since there is not appid in link
|
|
prefix: undefined,
|
|
}),
|
|
engineUrl: expect.any(String),
|
|
appUrl: undefined, // because no app has been provided
|
|
});
|
|
});
|
|
|
|
test('should find app url param from provided link', () => {
|
|
url = `engine_url=wss://${authConfig.host}/app/SOME_APP_ID/`;
|
|
const result = parseEngineURL(url);
|
|
expect(result).toMatchObject({
|
|
enigma: expect.objectContaining({
|
|
secure: expect.any(Boolean),
|
|
host: expect.any(String),
|
|
port: undefined, // because of providing a link
|
|
appId: 'SOME_APP_ID/', // since there is an appid in link
|
|
prefix: undefined,
|
|
}),
|
|
engineUrl: expect.any(String),
|
|
appUrl: url,
|
|
});
|
|
});
|
|
|
|
test('should match prefix correctly', () => {
|
|
url = `engine_url=wss://${authConfig.host}/prefix`;
|
|
const result = parseEngineURL(url);
|
|
expect(result).toMatchObject({
|
|
enigma: expect.objectContaining({
|
|
secure: expect.any(Boolean),
|
|
host: expect.any(String),
|
|
port: undefined,
|
|
appId: undefined,
|
|
prefix: 'prefix',
|
|
}),
|
|
engineUrl: expect.any(String),
|
|
appUrl: undefined,
|
|
});
|
|
});
|
|
test('should match prefix correctly with app', () => {
|
|
url = `wss://${authConfig.host}/prefix/app/SOME_APP_ID/`;
|
|
const result2 = parseEngineURL(url);
|
|
expect(result2).toMatchObject({
|
|
enigma: expect.objectContaining({
|
|
secure: expect.any(Boolean),
|
|
host: expect.any(String),
|
|
port: undefined, // because of providing a link
|
|
appId: 'SOME_APP_ID/', // since there is an appid in link
|
|
prefix: 'prefix',
|
|
}),
|
|
engineUrl: expect.any(String),
|
|
appUrl: url,
|
|
});
|
|
});
|
|
test('should match app correctly without prefix', () => {
|
|
url = `wss://${authConfig.host}/app/SOME_APP_ID/`;
|
|
const result2 = parseEngineURL(url);
|
|
expect(result2).toMatchObject({
|
|
enigma: expect.objectContaining({
|
|
secure: expect.any(Boolean),
|
|
host: expect.any(String),
|
|
port: undefined, // because of providing a link
|
|
appId: 'SOME_APP_ID/', // since there is an appid in link
|
|
prefix: undefined,
|
|
}),
|
|
engineUrl: expect.any(String),
|
|
appUrl: url,
|
|
});
|
|
});
|
|
|
|
test('should match app and prefix with all allowed characters', () => {
|
|
url = `wss://${authConfig.host}/prefix123456789-._~/app/SOME_APP_ID/`;
|
|
const result2 = parseEngineURL(url);
|
|
expect(result2).toMatchObject({
|
|
enigma: expect.objectContaining({
|
|
secure: expect.any(Boolean),
|
|
host: expect.any(String),
|
|
port: undefined, // because of providing a link
|
|
appId: 'SOME_APP_ID/', // since there is an appid in link
|
|
prefix: 'prefix123456789-._~',
|
|
}),
|
|
engineUrl: expect.any(String),
|
|
appUrl: url,
|
|
});
|
|
});
|
|
});
|
|
});
|