mirror of
https://github.com/ONLYOFFICE/server.git
synced 2026-02-10 18:05:07 +08:00
[integration tests] baseConnector integration tests
This commit is contained in:
Georgii Petrov
455
tests/integration/baseConnector.tests.js
Normal file
455
tests/integration/baseConnector.tests.js
Normal file
@ -0,0 +1,455 @@
|
||||
const { describe, test, expect, afterAll } = require('@jest/globals');
|
||||
const config = require('../../Common/node_modules/config');
|
||||
|
||||
const baseConnector = require('../../DocService/sources/baseConnector');
|
||||
const operationContext = require('../../Common/sources/operationContext');
|
||||
const taskResult = require("../../DocService/sources/taskresult");
|
||||
const commonDefines = require("../../Common/sources/commondefines");
|
||||
const constants = require("../../Common/sources/constants");
|
||||
const connectorUtilities = require("../../DocService/sources/connectorUtilities");
|
||||
const configSql = config.get('services.CoAuthoring.sql');
|
||||
|
||||
const ctx = new operationContext.Context();
|
||||
const cfgDbType = configSql.get('type');
|
||||
const cfgTableResult = configSql.get('tableResult');
|
||||
const cfgTableChanges = configSql.get('tableChanges');
|
||||
const dbTypes = {
|
||||
oracle: {
|
||||
number: 'NUMBER',
|
||||
string: 'NVARCHAR(50)'
|
||||
},
|
||||
mssql: {
|
||||
number: 'INT',
|
||||
string: 'NVARCHAR(50)'
|
||||
},
|
||||
mysql: {
|
||||
number: 'INT',
|
||||
string: 'VARCHAR(50)'
|
||||
},
|
||||
dameng: {
|
||||
number: 'INT',
|
||||
string: 'VARCHAR(50)'
|
||||
},
|
||||
postgres: {
|
||||
number: 'INT',
|
||||
string: 'VARCHAR(50)'
|
||||
},
|
||||
number: function () {
|
||||
return this[cfgDbType].number;
|
||||
},
|
||||
string: function () {
|
||||
return this[cfgDbType].string;
|
||||
}
|
||||
}
|
||||
|
||||
const insertCases = {
|
||||
5: 'baseConnector-insert()-tester-5-rows',
|
||||
500: 'baseConnector-insert()-tester-500-rows',
|
||||
1000: 'baseConnector-insert()-tester-1000-rows',
|
||||
5000: 'baseConnector-insert()-tester-5000-rows',
|
||||
10000: 'baseConnector-insert()-tester-10000-rows'
|
||||
};
|
||||
const changesCases = {
|
||||
range: 'baseConnector-getChangesPromise()-tester',
|
||||
index: 'baseConnector-getChangesIndexPromise()-tester',
|
||||
delete: 'baseConnector-deleteChangesPromise()-tester'
|
||||
};
|
||||
const emptyCallbacksCase = [
|
||||
'baseConnector-getEmptyCallbacks()-tester-0',
|
||||
'baseConnector-getEmptyCallbacks()-tester-1',
|
||||
'baseConnector-getEmptyCallbacks()-tester-2',
|
||||
'baseConnector-getEmptyCallbacks()-tester-3',
|
||||
'baseConnector-getEmptyCallbacks()-tester-4',
|
||||
];
|
||||
const documentsWithChangesCase = [
|
||||
'baseConnector-getDocumentsWithChanges()-tester-0',
|
||||
'baseConnector-getDocumentsWithChanges()-tester-1'
|
||||
];
|
||||
const getExpiredCase = [
|
||||
'baseConnector-getExpired()-tester-0',
|
||||
'baseConnector-getExpired()-tester-1',
|
||||
'baseConnector-getExpired()-tester-2',
|
||||
];
|
||||
const upsertCases = {
|
||||
insert: 'baseConnector-upsert()-tester-row-inserted',
|
||||
update: 'baseConnector-upsert()-tester-row-updated'
|
||||
};
|
||||
|
||||
function createChanges(changesLength, date) {
|
||||
const objChanges = [
|
||||
{
|
||||
docid: '__ffff_127.0.0.1new.docx41692082262909',
|
||||
change: '"64;AgAAADEA//8BAG+X6xGnEAMAjgAAAAIAAAAEAAAABAAAAAUAAACCAAAAggAAAA4AAAAwAC4AMAAuADAALgAwAA=="',
|
||||
time: date,
|
||||
user: 'uid-18',
|
||||
useridoriginal: 'uid-1'
|
||||
}
|
||||
];
|
||||
|
||||
const length = changesLength - 1;
|
||||
for (let i = 1; i <= length; i++) {
|
||||
objChanges.push(
|
||||
{
|
||||
docid: '__ffff_127.0.0.1new.docx41692082262909',
|
||||
change: '"39;CgAAADcAXwA2ADQAMAACABwAAQAAAAAAAAABAAAALgAAAAAAAAAA"',
|
||||
time: date,
|
||||
user: 'uid-18',
|
||||
useridoriginal: 'uid-1'
|
||||
}
|
||||
);
|
||||
}
|
||||
|
||||
return objChanges;
|
||||
}
|
||||
|
||||
async function getRowsCountById(table, id) {
|
||||
const result = await executeSql(`SELECT COUNT(id) AS count FROM ${table} WHERE id = '${id}';`);
|
||||
return result[0].count;
|
||||
}
|
||||
|
||||
async function nowRowsExistenceCheck(table, id) {
|
||||
const noRows = await getRowsCountById(table, id);
|
||||
expect(noRows).toEqual(0);
|
||||
}
|
||||
|
||||
function getIdsCount(table, ids) {
|
||||
const idsToSearch = ids.map(id => `id = '${id}'`).join(' OR ');
|
||||
return executeSql(`SELECT COUNT(DISTINCT id) AS count FROM ${table} WHERE ${idsToSearch};`);
|
||||
}
|
||||
|
||||
function deleteRowsByIds(table, ids) {
|
||||
const idToDelete = ids.map(id => `id = '${id}'`).join(' OR ');
|
||||
return executeSql(`DELETE FROM ${table} WHERE ${idToDelete};`);
|
||||
}
|
||||
|
||||
function executeSql(sql, values = []) {
|
||||
return new Promise((resolve, reject) => {
|
||||
baseConnector.baseConnector.sqlQuery(ctx, sql, function (error, result) {
|
||||
if (error) {
|
||||
reject(error)
|
||||
} else {
|
||||
resolve(result)
|
||||
}
|
||||
}, false, false, values);
|
||||
});
|
||||
}
|
||||
|
||||
async function insertChangesLocal(objChanges, docId, index, user) {
|
||||
for (let currentIndex = 0; currentIndex < objChanges.length; ++currentIndex, ++index) {
|
||||
const values = [];
|
||||
const placeholder = [
|
||||
baseConnector.baseConnector.addSqlParameter(ctx.tenant, values),
|
||||
baseConnector.baseConnector.addSqlParameter(docId, values),
|
||||
baseConnector.baseConnector.addSqlParameter(index, values),
|
||||
baseConnector.baseConnector.addSqlParameter(user.id, values),
|
||||
baseConnector.baseConnector.addSqlParameter(user.idOriginal, values),
|
||||
baseConnector.baseConnector.addSqlParameter(user.username, values),
|
||||
baseConnector.baseConnector.addSqlParameter(objChanges[currentIndex].change, values),
|
||||
baseConnector.baseConnector.addSqlParameter(objChanges[currentIndex].time, values),
|
||||
];
|
||||
|
||||
const sqlInsert = `INSERT INTO ${cfgTableChanges} VALUES(${placeholder.join(', ')});`;
|
||||
await executeSql(sqlInsert, values);
|
||||
}
|
||||
}
|
||||
|
||||
function createTask(id, callback = '', baseurl = '') {
|
||||
const task = new taskResult.TaskResultData();
|
||||
task.tenant = ctx.tenant;
|
||||
task.key = id;
|
||||
task.status = commonDefines.FileStatus.None;
|
||||
task.statusInfo = constants.NO_ERROR;
|
||||
task.callback = callback;
|
||||
task.baseurl = baseurl;
|
||||
task.completeDefaults();
|
||||
|
||||
return task;
|
||||
}
|
||||
|
||||
function insertResult(dateNow, task) {
|
||||
let cbInsert = task.callback;
|
||||
if (task.callback) {
|
||||
const userCallback = new connectorUtilities.UserCallback();
|
||||
userCallback.fromValues(task.userIndex, task.callback);
|
||||
cbInsert = userCallback.toSQLInsert();
|
||||
}
|
||||
|
||||
const columns = ['tenant', 'id', 'status', 'status_info', 'last_open_date', 'user_index', 'change_id', 'callback', 'baseurl'];
|
||||
const values = [];
|
||||
const placeholder = [
|
||||
baseConnector.baseConnector.addSqlParameter(task.tenant, values),
|
||||
baseConnector.baseConnector.addSqlParameter(task.key, values),
|
||||
baseConnector.baseConnector.addSqlParameter(task.status, values),
|
||||
baseConnector.baseConnector.addSqlParameter(task.statusInfo, values),
|
||||
baseConnector.baseConnector.addSqlParameter(dateNow, values),
|
||||
baseConnector.baseConnector.addSqlParameter(task.userIndex, values),
|
||||
baseConnector.baseConnector.addSqlParameter(task.changeId, values),
|
||||
baseConnector.baseConnector.addSqlParameter(cbInsert, values),
|
||||
baseConnector.baseConnector.addSqlParameter(task.baseurl, values)
|
||||
];
|
||||
|
||||
return executeSql(`INSERT INTO ${cfgTableResult}(${columns.join(', ')}) VALUES(${placeholder.join(', ')});`, values);
|
||||
}
|
||||
|
||||
afterAll(async function () {
|
||||
const insertIds = Object.values(insertCases);
|
||||
const changesIds = Object.values(changesCases);
|
||||
const upsertIds = Object.values(upsertCases);
|
||||
|
||||
const tableChangesIds = [...emptyCallbacksCase, ...documentsWithChangesCase, ...changesIds, ...insertIds];
|
||||
const tableResultIds = [...emptyCallbacksCase, ...documentsWithChangesCase, ...getExpiredCase, ...upsertIds];
|
||||
|
||||
const deletionPool = [
|
||||
deleteRowsByIds(cfgTableChanges, tableChangesIds),
|
||||
deleteRowsByIds(cfgTableResult, tableResultIds)
|
||||
];
|
||||
|
||||
await Promise.allSettled(deletionPool);
|
||||
baseConnector.baseConnector.closePool?.();
|
||||
});
|
||||
|
||||
// Assumed that at least default DB was installed and configured.
|
||||
describe('Base database connector', function () {
|
||||
test('Availability of configured DB', async function () {
|
||||
const result = await baseConnector.healthCheck(ctx);
|
||||
|
||||
expect(result.length).toEqual(1);
|
||||
});
|
||||
|
||||
test('Correct return format of requested rows', async function() {
|
||||
const result = await baseConnector.healthCheck(ctx);
|
||||
|
||||
// The [[constructor]] field is referring to a parent class instance, so for Object-like values it is equal to itself.
|
||||
expect(result.constructor).toEqual(Array);
|
||||
// SQL in healthCheck() request column with value 1, so we expect only one value. The default format, that used here is [{ columnName: columnValue }, { columnName: columnValue }].
|
||||
expect(result.length).toEqual(1);
|
||||
expect(result[0].constructor).toEqual(Object);
|
||||
expect(Object.values(result[0]).length).toEqual(1);
|
||||
// Value itself.
|
||||
expect(Object.values(result[0])[0]).toEqual(1);
|
||||
});
|
||||
|
||||
test('Correct return format of changing in DB', async function () {
|
||||
const createTableSql = `CREATE TABLE test_table(num ${dbTypes.number()});`
|
||||
const alterTableSql = `INSERT INTO test_table VALUES(1);`;
|
||||
// TODO: may not trigger.
|
||||
const deleteTableSql = 'DROP TABLE test_table;';
|
||||
await executeSql(createTableSql);
|
||||
const result = await executeSql(alterTableSql);
|
||||
await executeSql(deleteTableSql);
|
||||
|
||||
expect(result).toEqual({ affectedRows: 1 });
|
||||
});
|
||||
|
||||
describe('DB tables existence', function () {
|
||||
const tables = {
|
||||
[cfgTableResult]: [
|
||||
{ column_name: 'tenant' },
|
||||
{ column_name: 'id' },
|
||||
{ column_name: 'status' },
|
||||
{ column_name: 'status_info' },
|
||||
{ column_name: 'created_at' },
|
||||
{ column_name: 'last_open_date' },
|
||||
{ column_name: 'user_index' },
|
||||
{ column_name: 'change_id' },
|
||||
{ column_name: 'callback' },
|
||||
{ column_name: 'baseurl' },
|
||||
{ column_name: 'password' },
|
||||
{ column_name: 'additional' }
|
||||
],
|
||||
[cfgTableChanges]: [
|
||||
{ column_name: 'tenant' },
|
||||
{ column_name: 'id' },
|
||||
{ column_name: 'change_id' },
|
||||
{ column_name: 'user_id' },
|
||||
{ column_name: 'user_id_original' },
|
||||
{ column_name: 'user_name' },
|
||||
{ column_name: 'change_data' },
|
||||
{ column_name: 'change_date' }
|
||||
]
|
||||
};
|
||||
|
||||
for (const table in tables) {
|
||||
test(`${table} table existence`, async function () {
|
||||
const result = await baseConnector.getTableColumns(ctx, table);
|
||||
expect(result).toEqual(tables[table]);
|
||||
});
|
||||
}
|
||||
});
|
||||
|
||||
describe('Changes manipulations', function () {
|
||||
const date = new Date();
|
||||
const index = 0;
|
||||
const user = {
|
||||
id: 'uid-18',
|
||||
idOriginal: 'uid-1',
|
||||
username: 'John Smith',
|
||||
indexUser: 8,
|
||||
view: false
|
||||
};
|
||||
|
||||
describe('Add changes', function () {
|
||||
for (const testCase in insertCases) {
|
||||
test(`${testCase} rows inserted`, async function () {
|
||||
const docId = insertCases[testCase];
|
||||
const objChanges = createChanges(+testCase, date);
|
||||
|
||||
await nowRowsExistenceCheck(cfgTableChanges, docId);
|
||||
|
||||
await baseConnector.insertChangesPromise(ctx, objChanges, docId, index, user);
|
||||
const result = await getRowsCountById(cfgTableChanges, docId);
|
||||
|
||||
expect(result).toEqual(objChanges.length);
|
||||
});
|
||||
}
|
||||
});
|
||||
|
||||
describe('Get and delete changes', function () {
|
||||
const changesCount = 10;
|
||||
const objChanges = createChanges(changesCount, date);
|
||||
|
||||
test('Get changes in range', async function () {
|
||||
const docId = changesCases.range;
|
||||
|
||||
await nowRowsExistenceCheck(cfgTableChanges, docId);
|
||||
|
||||
await insertChangesLocal(objChanges, docId, index, user);
|
||||
|
||||
const result = await baseConnector.getChangesPromise(ctx, docId, index, changesCount);
|
||||
|
||||
expect(result.length).toEqual(changesCount);
|
||||
});
|
||||
|
||||
test('Get changes index', async function () {
|
||||
const docId = changesCases.index;
|
||||
|
||||
await nowRowsExistenceCheck(cfgTableChanges, docId);
|
||||
|
||||
await insertChangesLocal(objChanges, docId, index, user);
|
||||
|
||||
const result = await baseConnector.getChangesIndexPromise(ctx, docId);
|
||||
|
||||
// We created 10 changes rows, change_id: 0..9, changes index is MAX(change_id).
|
||||
const expected = [{ change_id: 9 }];
|
||||
expect(result).toEqual(expected);
|
||||
});
|
||||
|
||||
test('Delete changes', async function () {
|
||||
const docId = changesCases.delete;
|
||||
|
||||
await insertChangesLocal(objChanges, docId, index, user);
|
||||
|
||||
// Deleting 6 rows.
|
||||
await baseConnector.deleteChangesPromise(ctx, docId, 4);
|
||||
|
||||
const result = await getRowsCountById(cfgTableChanges, docId);
|
||||
|
||||
// Rest rows.
|
||||
expect(result).toEqual(4);
|
||||
});
|
||||
});
|
||||
|
||||
test('Get empty callbacks' , async function () {
|
||||
const idCount = 5;
|
||||
const notNullCallbacks = idCount - 2;
|
||||
|
||||
// Adding non-empty callbacks.
|
||||
for (let i = 0; i < notNullCallbacks; i++) {
|
||||
const task = createTask(emptyCallbacksCase[i], 'some_callback');
|
||||
await insertResult(date, task);
|
||||
}
|
||||
|
||||
// Adding empty callbacks.
|
||||
for (let i = notNullCallbacks; i < idCount; i++) {
|
||||
const task = createTask(emptyCallbacksCase[i], '');
|
||||
await insertResult(date, task);
|
||||
}
|
||||
|
||||
// Adding same amount of changes with same tenant and id.
|
||||
const objChanges = createChanges(1, date);
|
||||
for (let i = 0; i < idCount; i++) {
|
||||
await insertChangesLocal(objChanges, emptyCallbacksCase[i], index, user);
|
||||
}
|
||||
|
||||
const result = await baseConnector.getEmptyCallbacks(ctx);
|
||||
|
||||
// Needs to add ids that already exist at this point. It is cfgTableChanges rest rows of LEFT JOIN result.
|
||||
const restRows = await getIdsCount(cfgTableChanges, [...Object.values(insertCases), ...Object.values(changesCases)]);
|
||||
|
||||
// Rest rows + rows with empty callbacks in right table.
|
||||
expect(result.length).toEqual(restRows[0].count + idCount - notNullCallbacks);
|
||||
});
|
||||
|
||||
test('Get documents with changes', async function () {
|
||||
const objChanges = createChanges(1, date);
|
||||
|
||||
const resultBeforeNewRows = await baseConnector.getDocumentsWithChanges(ctx);
|
||||
|
||||
for (const id of documentsWithChangesCase) {
|
||||
const task = createTask(id);
|
||||
await Promise.all([
|
||||
insertChangesLocal(objChanges, id, index, user),
|
||||
insertResult(date, task)
|
||||
]);
|
||||
}
|
||||
|
||||
const resultAfterNewRows = await baseConnector.getDocumentsWithChanges(ctx);
|
||||
expect(resultAfterNewRows.length).toEqual(resultBeforeNewRows.length + documentsWithChangesCase.length);
|
||||
});
|
||||
|
||||
test('Get expired', async function () {
|
||||
const dayBefore = new Date();
|
||||
dayBefore.setDate(dayBefore.getDate() + 1);
|
||||
|
||||
const resultBeforeNewRows = await baseConnector.getExpired(ctx, 3, 0);
|
||||
|
||||
for (const id of getExpiredCase) {
|
||||
const task = createTask(id);
|
||||
await insertResult(dayBefore, task);
|
||||
}
|
||||
|
||||
const resultAfterNewRows = await baseConnector.getExpired(ctx, 3, 0);
|
||||
console.log('before', resultBeforeNewRows);
|
||||
console.log('after', resultBeforeNewRows);
|
||||
expect(resultAfterNewRows.length).toEqual(resultBeforeNewRows.length + getExpiredCase.length);
|
||||
});
|
||||
});
|
||||
|
||||
describe('upsert() method', function () {
|
||||
test('New row inserted', async function () {
|
||||
const task = createTask(upsertCases.insert);
|
||||
|
||||
await nowRowsExistenceCheck(cfgTableResult, task.key);
|
||||
|
||||
const result = await baseConnector.baseConnector.upsert(ctx, task);
|
||||
|
||||
// affectedRows should be 1 because of insert operation, insertId should be 2 due to it defaults.
|
||||
const expected = { affectedRows: 1, insertId: 1 };
|
||||
expect(result).toEqual(expected);
|
||||
|
||||
const insertedResult = await getRowsCountById(cfgTableResult, task.key);
|
||||
|
||||
expect(insertedResult).toEqual(1);
|
||||
});
|
||||
|
||||
test('Row updated', async function () {
|
||||
const task = createTask(upsertCases.update, '', 'some-url');
|
||||
|
||||
const dateNow = new Date();
|
||||
await insertResult(dateNow, task);
|
||||
|
||||
// Changing baseurl to verify upsert() changing the row.
|
||||
task.baseurl = 'some-updated-url';
|
||||
const result = await baseConnector.baseConnector.upsert(ctx, task);
|
||||
|
||||
// affectedRows should be 2 because of update operation, insertId should be 1 by default.
|
||||
const expected = { affectedRows: 2, insertId: 1 };
|
||||
expect(result).toEqual(expected);
|
||||
|
||||
const updatedRow = await executeSql(`SELECT id, baseurl FROM ${cfgTableResult} WHERE id = '${task.key}';`);
|
||||
|
||||
const expectedUpdate = [{ id: task.key, baseurl: 'some-updated-url' }];
|
||||
expect(updatedRow).toEqual(expectedUpdate);
|
||||
});
|
||||
});
|
||||
});
|
||||
Reference in New Issue
Block a user