paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 37 Packages Projects Releases Wiki Activity

Improve createConfluenceVariables with support for spaces links

Browse Source 
Signed-off-by: Fuglen <fuglenbusiness@gmail.com>
This commit is contained in:
Fuglen
2025-07-02 10:42:02 +02:00
parent ab539cc72b
commit ac81c9813f
1 changed files with 23 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/scaffolder-backend-module-confluence-to-markdown/src/actions/confluence/helpers.ts
+23 -25
View File
@@ -15,7 +15,7 @@
*/
import { Config } from '@backstage/config';
import { ResponseError, ConflictError, InputError } from '@backstage/errors';
import { ResponseError, ConflictError } from '@backstage/errors';
import fs from 'fs-extra';
import { Readable } from 'stream';
@@ -184,30 +184,28 @@ export const getAndWriteAttachments = async (
};
export const createConfluenceVariables = (url: string) => {
let spacekey: string | undefined = undefined;
let title: string | undefined = undefined;
let titleWithSpaces: string | undefined = '';
let spacekey;
let title;
let titleWithSpaces = '';
const params = new URL(url);
if (params.pathname.split('/')[1] === 'display') {
// https://confluence.example.com/display/SPACEKEY/Page+Title
spacekey = params.pathname.split('/')[2];
title = params.pathname.split('/')[3];
titleWithSpaces = title?.replace(/\+/g, ' ');
return { spacekey, title, titleWithSpaces };
} else if (params.pathname.split('/')[2] === 'display') {
// https://confluence.example.com/prefix/display/SPACEKEY/Page+Title
spacekey = params.pathname.split('/')[3];
title = params.pathname.split('/')[4];
titleWithSpaces = title?.replace(/\+/g, ' ');
return { spacekey, title, titleWithSpaces };
} else if (params.pathname.split('/')[2] === 'spaces') {
// https://example.atlassian.net/wiki/spaces/SPACEKEY/pages/1234567/Page+Title
spacekey = params.pathname.split('/')[3];
title = params.pathname.split('/')[6];
titleWithSpaces = title?.replace(/\+/g, ' ');
return { spacekey, title, titleWithSpaces };
const pathParts = params.pathname.split('/').filter(Boolean);
if (pathParts.includes('display')) {
// /display/<SPACEKEY>/<TITLE>
const idx = pathParts.indexOf('display');
spacekey = pathParts[idx + 1];
title = pathParts[idx + 2];
} else if (pathParts.includes('spaces')) {
// /spaces/<SPACEKEY>/pages/<PAGEID>/<TITLE>
const idx = pathParts.indexOf('spaces');
spacekey = pathParts[idx + 1];
title = pathParts[pathParts.length - 1];
} else {
throw new Error(
'The Url format for Confluence is incorrect. Acceptable format is `<CONFLUENCE_BASE_URL>/display/<SPACEKEY>/<PAGE+TITLE>` or `<CONFLUENCE_BASE_URL>/spaces/<SPACEKEY>/pages/<PAGEID>/<PAGE+TITLE>`',
);
}
throw new InputError(
'The Url format for Confluence is incorrect. Acceptable format is `<CONFLUENCE_BASE_URL>/display/<SPACEKEY>/<PAGE+TITLE>` or `<CONFLUENCE_BASE_URL>/spaces/<SPACEKEY>/pages/<PAGEID>/<PAGE+TITLE>` for Confluence cloud',
);
titleWithSpaces = title?.replace(/\+/g, ' ');
return { spacekey, title, titleWithSpaces };
};