mirror of
https://github.com/ONLYOFFICE/server.git
synced 2026-04-07 14:04:35 +08:00
Forgotten files commands (#415)
* [ds] Add forgotten files comands * Feature fixes 1 * Feature fixes 2 * [feature] Refactor validateCommand and deleteForgotten * Feature fixes 3 * Feature fixes 4 * [test] Move jest module * Feature fixes 5 * [test] Move jest.config.js --------- Co-authored-by: Sergey Konovalov <Sergey.Konovalov@onlyoffice.com>
This commit is contained in:
Georgii Petrov
246
tests/integration/forgottenFilesCommnads.tests.js
Normal file
246
tests/integration/forgottenFilesCommnads.tests.js
Normal file
@ -0,0 +1,246 @@
|
||||
const { describe, test, expect, afterAll, beforeAll } = require('@jest/globals');
|
||||
const http = require('http');
|
||||
|
||||
const { signToken } = require('../../DocService/sources/DocsCoServer');
|
||||
const storage = require('../../Common/sources/storage-base');
|
||||
const constants = require('../../Common/sources/commondefines');
|
||||
const operationContext = require('../../Common/sources/operationContext');
|
||||
const utils = require("../../Common/sources/utils");
|
||||
const config = require('../../Common/node_modules/config');
|
||||
|
||||
const cfgForgottenFiles = config.get('services.CoAuthoring.server.forgottenfiles');
|
||||
const cfgForgottenFilesName = config.get('services.CoAuthoring.server.forgottenfilesname');
|
||||
const cfgTokenAlgorithm = config.get('services.CoAuthoring.token.session.algorithm');
|
||||
const cfgSecretOutbox = config.get('services.CoAuthoring.secret.outbox');
|
||||
const cfgTokenOutboxExpires = config.get('services.CoAuthoring.token.outbox.expires');
|
||||
const cfgTokenEnableRequestOutbox = config.get('services.CoAuthoring.token.enable.request.outbox');
|
||||
const ctx = new operationContext.Context();
|
||||
const testFilesNames = {
|
||||
get: 'DocService-DocsCoServer-forgottenFilesCommands-getForgotten-integration-test',
|
||||
delete1: 'DocService-DocsCoServer-forgottenFilesCommands-deleteForgotten-integration-test',
|
||||
// delete2: 'DocService-DocsCoServer-forgottenFilesCommands-deleteForgotten-2-integration-test',
|
||||
// delete3: 'DocService-DocsCoServer-forgottenFilesCommands-deleteForgotten-3-integration-test',
|
||||
getList: 'DocService-DocsCoServer-forgottenFilesCommands-getForgottenList-integration-test'
|
||||
};
|
||||
|
||||
function makeRequest(requestBody, timeout = 5000) {
|
||||
return new Promise(async (resolve, reject) => {
|
||||
const timer = setTimeout(() => reject('Request timeout'), timeout);
|
||||
|
||||
let body = '';
|
||||
if (cfgTokenEnableRequestOutbox) {
|
||||
const secret = utils.getSecretByElem(cfgSecretOutbox);
|
||||
const token = await signToken(ctx, requestBody, cfgTokenAlgorithm, cfgTokenOutboxExpires, constants.c_oAscSecretType.Inbox, secret);
|
||||
body = JSON.stringify({ token });
|
||||
} else {
|
||||
body = JSON.stringify(requestBody);
|
||||
}
|
||||
|
||||
const options = {
|
||||
port: '8000',
|
||||
path: '/coauthoring/CommandService.ashx',
|
||||
method: 'POST',
|
||||
headers: {
|
||||
'Content-Type': 'application/json',
|
||||
'Content-Length': Buffer.byteLength(body)
|
||||
}
|
||||
};
|
||||
const request = http.request(options, (response) => {
|
||||
response.setEncoding('utf8');
|
||||
|
||||
let data = '';
|
||||
response.on('data', (chunk) => {
|
||||
data += chunk
|
||||
});
|
||||
response.on('end', () => {
|
||||
resolve(data);
|
||||
clearTimeout(timer);
|
||||
});
|
||||
});
|
||||
|
||||
request.on('error', (error) => {
|
||||
reject(error);
|
||||
clearTimeout(timer);
|
||||
});
|
||||
|
||||
request.write(body);
|
||||
request.end();
|
||||
});
|
||||
}
|
||||
|
||||
function getKeysDirectories(keys) {
|
||||
return keys.map(value => value.split('/')[0]);
|
||||
}
|
||||
|
||||
beforeAll(async function () {
|
||||
const buffer = Buffer.from('Forgotten commands test file');
|
||||
for (const index in testFilesNames) {
|
||||
await storage.putObject(ctx, `${testFilesNames[index]}/${cfgForgottenFilesName}.docx`, buffer, buffer.length, cfgForgottenFiles);
|
||||
}
|
||||
});
|
||||
|
||||
afterAll(async function () {
|
||||
const keys = await storage.listObjects(ctx, '', cfgForgottenFiles);
|
||||
const deletePromises = keys.filter(key => key.includes('DocService-DocsCoServer-forgottenFilesCommands'))
|
||||
.map(filteredKey => storage.deleteObject(ctx, filteredKey, cfgForgottenFiles));
|
||||
|
||||
return Promise.allSettled(deletePromises);
|
||||
});
|
||||
|
||||
// Assumed, that server is already up.
|
||||
describe('Command service', function () {
|
||||
describe('Forgotten files commands parameters validation', function () {
|
||||
describe('Invalid key format', function () {
|
||||
const tests = ['getForgotten', 'deleteForgotten'];
|
||||
const addSpecialCases = (invalidRequests, expected, testSubject) => {
|
||||
invalidRequests.push({
|
||||
c: testSubject
|
||||
});
|
||||
expected.push({ error: 1});
|
||||
|
||||
invalidRequests.push({
|
||||
c: testSubject,
|
||||
key: null
|
||||
});
|
||||
expected.push({
|
||||
key: null,
|
||||
error: 1
|
||||
});
|
||||
};
|
||||
|
||||
for (const testSubject of tests) {
|
||||
test(testSubject, async function () {
|
||||
const invalidKeys = [true, [], {}, 1, 1.1];
|
||||
const invalidRequests = invalidKeys.map(key => {
|
||||
return {
|
||||
c: testSubject,
|
||||
key
|
||||
}
|
||||
});
|
||||
|
||||
const expected = invalidKeys.map(key => {
|
||||
return {
|
||||
key,
|
||||
error: 1,
|
||||
};
|
||||
});
|
||||
|
||||
addSpecialCases(invalidRequests, expected, testSubject);
|
||||
|
||||
for (const index in invalidRequests) {
|
||||
const actualResponse = await makeRequest(invalidRequests[index]);
|
||||
const actual = JSON.parse(actualResponse);
|
||||
|
||||
expect(actual).toEqual(expected[index]);
|
||||
}
|
||||
});
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
describe('Forgotten files commands verification', function () {
|
||||
describe('getForgotten', function () {
|
||||
const createExpected = ({ key, error }) => {
|
||||
const validKey = typeof key === 'string' && error === 0
|
||||
const urlPattern = 'http://localhost:8000/cache/files/forgotten/--key--/output.docx/output.docx';
|
||||
|
||||
const expected = { key, error };
|
||||
|
||||
if (validKey) {
|
||||
expected.url = urlPattern.replace('--key--', key);
|
||||
}
|
||||
|
||||
return expected;
|
||||
};
|
||||
|
||||
const testCases = {
|
||||
'Single key': { key: testFilesNames.get, error: 0 },
|
||||
'Not existed key': { key: '--not-existed--', error: 1 },
|
||||
};
|
||||
|
||||
for (const testCase in testCases) {
|
||||
test(testCase, async () => {
|
||||
const requestBody = {
|
||||
c: 'getForgotten',
|
||||
key: testCases[testCase].key
|
||||
};
|
||||
|
||||
const actualResponse = await makeRequest(requestBody);
|
||||
|
||||
const expected = createExpected(testCases[testCase]);
|
||||
const actual = JSON.parse(actualResponse);
|
||||
|
||||
if (actual.url) {
|
||||
actual.url = actual.url.split('?')[0];
|
||||
}
|
||||
|
||||
expect(actual).toEqual(expected);
|
||||
});
|
||||
}
|
||||
});
|
||||
|
||||
describe('deleteForgotten', function () {
|
||||
const createExpected = ({ key, error }) => {
|
||||
return {
|
||||
key,
|
||||
error
|
||||
};
|
||||
};
|
||||
|
||||
const testCases = {
|
||||
'Single key': { key: testFilesNames.delete1, error: 0 },
|
||||
'Not existed key': { key: '--not-existed--', error: 1 },
|
||||
};
|
||||
|
||||
for (const testCase in testCases) {
|
||||
test(testCase, async () => {
|
||||
const requestBody = {
|
||||
c: 'deleteForgotten',
|
||||
key: testCases[testCase].key
|
||||
};
|
||||
|
||||
const alreadyExistedDirectories = getKeysDirectories(await storage.listObjects(ctx, '', cfgForgottenFiles));
|
||||
const directoryToBeDeleted = testCases[testCase].error !== 0 ? '--not-existed--' : testCases[testCase].key;
|
||||
const shouldExist = alreadyExistedDirectories.filter(directory => directoryToBeDeleted !== directory);
|
||||
|
||||
const actualResponse = await makeRequest(requestBody);
|
||||
|
||||
const expected = createExpected(testCases[testCase]);
|
||||
const actual = JSON.parse(actualResponse);
|
||||
|
||||
const directoriesExistedAfterDeletion = getKeysDirectories(await storage.listObjects(ctx, '', cfgForgottenFiles));
|
||||
expect(actual).toEqual(expected);
|
||||
// Checking that files not existing on disk/cloud.
|
||||
expect(shouldExist).toEqual(directoriesExistedAfterDeletion);
|
||||
});
|
||||
}
|
||||
});
|
||||
|
||||
describe('getForgottenList', function () {
|
||||
test('Main case', async () => {
|
||||
const requestBody = {
|
||||
c: 'getForgottenList'
|
||||
};
|
||||
|
||||
const stateBeforeChanging = await makeRequest(requestBody);
|
||||
const alreadyExistedDirectories = JSON.parse(stateBeforeChanging);
|
||||
|
||||
const docId = 'DocService-DocsCoServer-forgottenFilesCommands-getForgottenList-2-integration-test';
|
||||
const buffer = Buffer.from('getForgottenList test file');
|
||||
await storage.putObject(ctx, `${docId}/${cfgForgottenFilesName}.docx`, buffer, buffer.length, cfgForgottenFiles);
|
||||
alreadyExistedDirectories.keys.push(docId);
|
||||
|
||||
const actualResponse = await makeRequest(requestBody);
|
||||
const actual = JSON.parse(actualResponse);
|
||||
const expected = {
|
||||
error: 0,
|
||||
keys: alreadyExistedDirectories.keys
|
||||
}
|
||||
|
||||
actual.keys?.sort();
|
||||
expected.keys.sort();
|
||||
expect(actual).toEqual(expected);
|
||||
});
|
||||
});
|
||||
});
|
||||
});
|
||||
Reference in New Issue
Block a user