Skip to content

Commit

Permalink
Improved code clarity with more/better comments and improved function…
Browse files Browse the repository at this point in the history 
… names
  • Loading branch information
@jjoderis
jjoderis committed Oct 19, 2023
1 parent c81d1b3 commit d7d7741
Show file tree
Hide file tree
Showing 2 changed files with 64 additions and 33 deletions.
57 changes: 33 additions & 24 deletions src/management-system-v2/lib/process-export/export-preparation.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,10 @@ type ExportMap = {
};
};

function getVersionName(version?: string | number) {
return version ? `${version}` : 'latest';
}

/**
* Will fetch information for a process (version) from the backend if it is not present in the exportData yet
*
Expand Down Expand Up @@ -180,7 +184,7 @@ async function ensureProcessInfo(
}

// prevent (unlikely) situations where a version might be referenced once by number and once by string
const versionName = processVersion ? `${processVersion}` : 'latest';
const versionName = getVersionName(processVersion);

if (!exportData[definitionId].versions[versionName]) {
const versionBpmn = await getVersionBpmn(definitionId, processVersion);
Expand Down Expand Up @@ -213,38 +217,41 @@ export async function prepareExport(

const exportData: ExportMap = {};

let processesToAdd = processes.map((info) => ({ ...info, isImport: false }));
let processVersionsToAdd = processes.map((info) => ({ ...info, isImport: false }));

// keep resolving process (version) information until no new information is required by imports
while (processesToAdd.length) {
let newProcessesToAdd: typeof processesToAdd = [];
while (processVersionsToAdd.length) {
let newProcessVersionsToAdd: typeof processVersionsToAdd = [];
// get the bpmn for all processes and their versions to export
for (const { definitionId, processVersion, isImport } of processesToAdd) {
for (const { definitionId, processVersion, isImport } of processVersionsToAdd) {
await ensureProcessInfo(exportData, { definitionId, processVersion }, isImport);

// if the option to export referenced processes is selected make sure to fetch their information as well
if (options.imports) {
for (const { bpmn, imports } of Object.values(exportData[definitionId].versions)) {
const importInfo = await getDefinitionsAndProcessIdForEveryCallActivity(bpmn, true);

for (const { definitionId: importDefinitionId, version: importVersion } of Object.values(
importInfo,
)) {
// add the import information to the respective version
imports.push({ definitionId: importDefinitionId, processVersion: `${importVersion}` });
const importVersionName = importVersion ? `${importVersion}` : 'latest';
// if the information for this import needs to be fetched as well
if (!exportData[importDefinitionId]?.versions[importVersionName]) {
newProcessesToAdd.push({
definitionId: importDefinitionId,
processVersion: importVersion,
isImport: true,
});
}
const versionName = getVersionName(processVersion);
const { bpmn, imports } = exportData[definitionId].versions[versionName];

// check the bpmn for referenced processes
const importInfo = await getDefinitionsAndProcessIdForEveryCallActivity(bpmn, true);

for (const { definitionId: importDefinitionId, version: importVersion } of Object.values(
importInfo,
)) {
// add the import information to the respective version
imports.push({ definitionId: importDefinitionId, processVersion: `${importVersion}` });
const importVersionName = getVersionName(importVersion);
// mark the process (version) as to be added if there is no information for it
if (!exportData[importDefinitionId]?.versions[importVersionName]) {
newProcessVersionsToAdd.push({
definitionId: importDefinitionId,
processVersion: importVersion,
isImport: true,
});
}
}
}
}
processesToAdd = newProcessesToAdd;
processVersionsToAdd = newProcessVersionsToAdd;
}

// get additional process information
Expand All @@ -254,7 +261,9 @@ export async function prepareExport(
for (const [version, { bpmn }] of Object.entries(exportData[definitionId].versions)) {
exportData[definitionId].versions[version].subprocesses = (
await getCollapsedSubprocessInfos(bpmn)
).reverse();
)
// the subprocess info is returned in the reversed order from what we want (we want from the outmost subprocess to the most nested)
.reverse();
}
}

Expand Down
40 changes: 31 additions & 9 deletions src/management-system-v2/lib/process-export/index.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -136,15 +136,15 @@ async function addPDFPage(
}

/**
* Allows to recursively add versions of the process and its imports to the pdf
* Allows to recursively add versions of a process and its imports to the pdf
*
* @param processesData the data of all processes
* @param processData the data of the complete process
* @param version the specific version to handle
* @param pdf the pdf to add a page to
* @param isImport if the version is of an import
*/
async function handleProcessPdfExportData(
async function handleProcessVersionPdfExport(
processesData: ProcessesExportData,
processData: ProcessExportData,
version: string,
Expand All @@ -164,11 +164,18 @@ async function handleProcessPdfExportData(
for (const { definitionId, processVersion } of versionData.imports) {
const importData = processesData.find((el) => el.definitionId === definitionId);
if (importData) {
await handleProcessPdfExportData(processesData, importData, processVersion, pdf, true);
await handleProcessVersionPdfExport(processesData, importData, processVersion, pdf, true);
}
}
}

/**
* Creates a pdf and adds all the requested information of a specific process (including other processes if there are imports to add)
*
* @param processesData the data of all processes
* @param processData the data of the complete process to export
* @param zip a zip archive this pdf should be added to in case multiple processes should be exported
*/
async function pdfExport(
processesData: ProcessesExportData,
processData: ProcessExportData,
Expand All @@ -182,13 +189,13 @@ async function pdfExport(
});
pdf.deletePage(1);

// only export the versions that were explicitly selected for export inside the pdf file for the given process
// only export the versions that were explicitly selected for the given process
const nonImportVersions = Object.entries(processData.versions)
.filter(([_, { isImport }]) => !isImport)
.map(([version]) => version);

for (const version of nonImportVersions) {
await handleProcessPdfExportData(processesData, processData, version, pdf);
await handleProcessVersionPdfExport(processesData, processData, version, pdf);
}

if (zip) {
Expand Down Expand Up @@ -258,7 +265,7 @@ async function addSVGFile(
* @param isImport if the version is of an import
* @param zipFolder the folder to add the svg to (optional since we can export a single file directly as an svg which is decided before this function is called)
*/
async function handleProcessSVGExportData(
async function handleProcessVersionSVGExport(
processesData: ProcessesExportData,
processData: ProcessExportData,
version: string,
Expand All @@ -278,11 +285,26 @@ async function handleProcessSVGExportData(
for (const { definitionId, processVersion } of versionData.imports) {
const importData = processesData.find((el) => el.definitionId === definitionId);
if (importData) {
await handleProcessSVGExportData(processesData, importData, processVersion, true, zipFolder);
await handleProcessVersionSVGExport(
processesData,
importData,
processVersion,
true,
zipFolder,
);
}
}
}

/**
* Exports a process as a svg either as a single file or into a folder of a zip archive if multiple files should be exported
*
* Might export multiple files if imports or collapsed subprocesses should be exported as well
*
* @param processesData the data of all processes
* @param processData the data of the complete process
* @param zipFolder a zip folder the exported files should be added to in case of multi file export
*/
async function svgExport(
processesData: ProcessesExportData,
processData: ProcessExportData,
Expand All @@ -294,13 +316,13 @@ async function svgExport(
.map(([version]) => version);

for (const version of nonImportVersions) {
await handleProcessSVGExportData(processesData, processData, version, false, zipFolder);
await handleProcessVersionSVGExport(processesData, processData, version, false, zipFolder);
}
}

async function bpmnExport(processData: ProcessExportData, zipFolder?: jsZip | null) {
for (let [versionName, versionData] of Object.entries(processData.versions)) {
// if the version data contains an explicit name use that instead of the the current versionName which is just the version id or "latest"
// if the version data contains an explicit name use that instead of the the current versionName which is just the version id
if (versionData.name) {
versionName = versionData.name;
}
Expand Down

0 comments on commit d7d7741

Please sign in to comment.