-
## Benefits
- For _engineering managers_, it allows you to maintain standards and best
diff --git a/docs/permissions/custom-rules.md b/docs/permissions/custom-rules.md
index 7bfcd1220a..d90f36e59d 100644
--- a/docs/permissions/custom-rules.md
+++ b/docs/permissions/custom-rules.md
@@ -159,7 +159,7 @@ To install custom rules in a plugin, we need to use the [`PermissionsRegistrySer
```typescript title="packages/backend/src/modules/catalogPermissionRules.ts"
import { createBackendModule } from '@backstage/backend-plugin-api';
import { catalogPermissionExtensionPoint } from '@backstage/plugin-catalog-node/alpha';
- import { isInSystemRule } from './permissionPolicyExtension';
+ import { isInSystemRule } from './permissionsPolicyExtension';
export default createBackendModule({
pluginId: 'catalog',
diff --git a/docs/plugins/structure-of-a-plugin.md b/docs/plugins/structure-of-a-plugin.md
index 0d18942320..8412ead179 100644
--- a/docs/plugins/structure-of-a-plugin.md
+++ b/docs/plugins/structure-of-a-plugin.md
@@ -81,7 +81,7 @@ export const ExamplePage = examplePlugin.provide(
```
This is where the plugin is created and where it creates and exports extensions
-that can be imported and used the app. See reference docs for
+that can be imported and used in the app. See reference docs for
[`createPlugin`](../reference/core-plugin-api.createplugin.md) or introduction to
the new [Composability System](./composability.md).
diff --git a/docs/releases/v1.46.0-next.1-changelog.md b/docs/releases/v1.46.0-next.1-changelog.md
new file mode 100644
index 0000000000..42a188ec7f
--- /dev/null
+++ b/docs/releases/v1.46.0-next.1-changelog.md
@@ -0,0 +1,392 @@
+# Release v1.46.0-next.1
+
+Upgrade Helper: [https://backstage.github.io/upgrade-helper/?to=1.46.0-next.1](https://backstage.github.io/upgrade-helper/?to=1.46.0-next.1)
+
+## @backstage/plugin-techdocs-addons-test-utils@2.0.0-next.1
+
+### Major Changes
+
+- 8d6709e: **BREAKING**: `TechDocsAddonTester.renderWithEffects()` no longer returns a screen; this means that you can no longer grab assertions such as `getByText` from its return value.
+
+ Newer versions of `@testing-library` recommends using the `screen` export for assertions - and removing this from the addon tester contract allows us to more freely iterate on which underlying version of the testing library is being used.
+
+ One notable effect of this, however, is that the `@testing-library` `screen` does NOT support assertions on the shadow DOM, which techdocs relies on. You will therefore want to add a dependency on [the `shadow-dom-testing-library` package](https://github.com/konnorrogers/shadow-dom-testing-library/) in your tests, and using its `screen` and its dedicated `*Shadow*` methods. As an example, if you keep doing `getByText` you will not get matches inside the shadow DOM - switch to `getByShadowText` instead.
+
+ ```ts
+ import { screen } from 'shadow-dom-testing-library';
+
+ // ... render the addon ...
+ await TechDocsAddonTester.buildAddonsInTechDocs([` block with `white-space: pre-wrap` or `white-space: pre`
+ *
+ * @remarks
+ *
+ * Default: false (`white-space: pre`)
+ */
+ wrapLongLines?: boolean;
/**
* Custom styles applied to code
*
@@ -79,6 +87,7 @@ export function CodeSnippet(props: CodeSnippetProps) {
language,
showLineNumbers = false,
highlightedNumbers,
+ wrapLongLines,
customStyle,
showCopyCodeButton = false,
} = props;
@@ -94,6 +103,7 @@ export function CodeSnippet(props: CodeSnippetProps) {
style={mode}
showLineNumbers={showLineNumbers}
wrapLines
+ wrapLongLines={wrapLongLines}
lineNumberStyle={{ color: theme.palette.textVerySubtle }}
lineProps={(lineNumber: number) =>
highlightedNumbers?.includes(lineNumber)
diff --git a/packages/core-components/src/components/LogViewer/RealLogViewer.tsx b/packages/core-components/src/components/LogViewer/RealLogViewer.tsx
index e384a8e882..1936061b1c 100644
--- a/packages/core-components/src/components/LogViewer/RealLogViewer.tsx
+++ b/packages/core-components/src/components/LogViewer/RealLogViewer.tsx
@@ -21,7 +21,7 @@ import classnames from 'classnames';
import { useEffect, useMemo, useRef, useState } from 'react';
import { useLocation } from 'react-router-dom';
import AutoSizer from 'react-virtualized-auto-sizer';
-import { VariableSizeList, FixedSizeList } from 'react-window';
+import { FixedSizeList, VariableSizeList } from 'react-window';
import { AnsiLine, AnsiProcessor } from './AnsiProcessor';
import { LogLine } from './LogLine';
@@ -29,6 +29,7 @@ import { LogViewerControls } from './LogViewerControls';
import { HEADER_SIZE, useStyles } from './styles';
import { useLogViewerSearch } from './useLogViewerSearch';
import { useLogViewerSelection } from './useLogViewerSelection';
+import Snackbar from '@material-ui/core/Snackbar';
export interface RealLogViewerProps {
text: string;
@@ -47,6 +48,7 @@ export function RealLogViewer(props: RealLogViewerProps) {
// The processor keeps state that optimizes appending to the text
const processor = useMemo(() => new AnsiProcessor(), []);
const lines = processor.process(props.text);
+ const [showCopyInfo, setShowCopyInfo] = useState(false);
const search = useLogViewerSearch(lines);
const selection = useLogViewerSelection(lines);
@@ -69,19 +71,39 @@ export function RealLogViewer(props: RealLogViewerProps) {
}
}, [listInstance, search.resultLine, lines]);
+ useEffect(() => {
+ const hash = selection.getHash();
+ if (hash.length > 0) {
+ history.replaceState(null, '', hash);
+ }
+ }, [selection]);
+
useEffect(() => {
if (location.hash) {
- // #line-6 -> 6
- const line = parseInt(location.hash.replace(/\D/g, ''), 10);
- selection.setSelection(line, false);
+ selection.selectAll(location.hash);
}
}, []); // eslint-disable-line react-hooks/exhaustive-deps
const handleSelectLine = (
line: number,
- event: { shiftKey: boolean; preventDefault: () => void },
+ event: {
+ shiftKey: boolean;
+ metaKey: boolean;
+ ctrlKey: boolean;
+ preventDefault: () => void;
+ },
) => {
- selection.setSelection(line, event.shiftKey);
+ event.preventDefault();
+ selection.setSelection(
+ line,
+ event.shiftKey,
+ event.metaKey || event.ctrlKey,
+ );
+ };
+
+ const handleCopySelection = (line: number) => {
+ selection.copySelection(line);
+ setShowCopyInfo(true);
};
function setRowHeight(index: number, size: number) {
@@ -97,90 +119,99 @@ export function RealLogViewer(props: RealLogViewerProps) {
}
return (
-
- {({ height, width }: { height?: number; width?: number }) => {
- const commonProps = {
- ref: setListInstance,
- className: classes.log,
- height: (height || 480) - HEADER_SIZE,
- width: width || 640,
- itemData: search.lines,
- itemCount: search.lines.length,
- };
+ <>
+
+ {({ height, width }: { height?: number; width?: number }) => {
+ const commonProps = {
+ ref: setListInstance,
+ className: classes.log,
+ height: (height || 480) - HEADER_SIZE,
+ width: width || 640,
+ itemData: search.lines,
+ itemCount: search.lines.length,
+ };
- const renderItem = ({
- index,
- style,
- data,
- }: {
- index: number;
- style: React.CSSProperties;
- data: AnsiLine[];
- }) => {
- const line = data[index];
- const { lineNumber } = line;
- return (
-
- {selection.shouldShowButton(lineNumber) && (
- selection.copySelection()}
- >
-
- )}
- handleSelectLine(lineNumber, event)}
- onKeyPress={event => handleSelectLine(lineNumber, event)}
+ const renderItem = ({
+ index,
+ style,
+ data,
+ }: {
+ index: number;
+ style: React.CSSProperties;
+ data: AnsiLine[];
+ }) => {
+ const line = data[index];
+ const { lineNumber } = line;
+ return (
+
- {lineNumber}
-
- handleCopySelection(lineNumber)}
+ >
+
+ )}
+ handleSelectLine(lineNumber, event)}
+ onKeyPress={event => handleSelectLine(lineNumber, event)}
+ >
+ {lineNumber}
+
+
+ );
+ };
+
+ return (
+
+
+
+ {shouldTextWrap ? (
+
+ {...commonProps}
+ itemSize={getRowHeight}
+ >
+ {renderItem}
+
+ ) : (
+ {...commonProps} itemSize={20}>
+ {renderItem}
+
+ )}
);
- };
-
- return (
-
-
-
- {shouldTextWrap ? (
-
- {...commonProps}
- itemSize={getRowHeight}
- >
- {renderItem}
-
- ) : (
- {...commonProps} itemSize={20}>
- {renderItem}
-
- )}
-
- );
- }}
-
+ }}
+
+ setShowCopyInfo(false)}
+ message="Lines copied to clipboard"
+ anchorOrigin={{ vertical: 'bottom', horizontal: 'center' }}
+ />
+
);
}
diff --git a/packages/core-components/src/components/LogViewer/styles.ts b/packages/core-components/src/components/LogViewer/styles.ts
index 238361f9a9..83fb3a84ad 100644
--- a/packages/core-components/src/components/LogViewer/styles.ts
+++ b/packages/core-components/src/components/LogViewer/styles.ts
@@ -89,15 +89,20 @@ export const useStyles = makeStyles(
position: 'absolute',
paddingTop: 0,
paddingBottom: 0,
+ '&:hover': {
+ color: theme.palette.linkHover,
+ },
},
lineNumber: {
display: 'inline-block',
textAlign: 'end',
width: 60,
+ paddingRight: theme.spacing(1),
marginRight: theme.spacing(1),
cursor: 'pointer',
flexShrink: 0,
- userSelect: 'none',
+ color: colors.blue[300],
+ borderRight: `1px solid ${colors.blue[700]}`,
},
textHighlight: {
background: alpha(theme.palette.info.main, 0.15),
diff --git a/packages/core-components/src/components/LogViewer/useLogViewerSelection.test.tsx b/packages/core-components/src/components/LogViewer/useLogViewerSelection.test.tsx
index 5314f4e7f6..13280d38a4 100644
--- a/packages/core-components/src/components/LogViewer/useLogViewerSelection.test.tsx
+++ b/packages/core-components/src/components/LogViewer/useLogViewerSelection.test.tsx
@@ -16,7 +16,7 @@
import { PropsWithChildren } from 'react';
import { act, renderHook } from '@testing-library/react';
-import { TestApiProvider, MockErrorApi } from '@backstage/test-utils';
+import { MockErrorApi, TestApiProvider } from '@backstage/test-utils';
import { errorApiRef } from '@backstage/core-plugin-api';
import { AnsiLine } from './AnsiProcessor';
import { useLogViewerSelection } from './useLogViewerSelection';
@@ -35,10 +35,26 @@ const lines = [
new AnsiLine(3, [{ text: '3', modifiers: {} }]),
new AnsiLine(4, [{ text: '4', modifiers: {} }]),
new AnsiLine(5, [{ text: '5', modifiers: {} }]),
+ new AnsiLine(6, [{ text: '6', modifiers: {} }]),
+ new AnsiLine(7, [{ text: '7', modifiers: {} }]),
];
+const expectSelectedLines = (rendered: any, selectedLines: number[]) => {
+ expect(rendered.result.current.isSelected(1)).toBe(selectedLines.includes(1));
+ expect(rendered.result.current.isSelected(2)).toBe(selectedLines.includes(2));
+ expect(rendered.result.current.isSelected(3)).toBe(selectedLines.includes(3));
+ expect(rendered.result.current.isSelected(4)).toBe(selectedLines.includes(4));
+ expect(rendered.result.current.isSelected(5)).toBe(selectedLines.includes(5));
+ expect(rendered.result.current.isSelected(6)).toBe(selectedLines.includes(6));
+ expect(rendered.result.current.isSelected(7)).toBe(selectedLines.includes(7));
+};
+
describe('useLogViewerSelection', () => {
- it('should manage a selection', () => {
+ beforeEach(() => {
+ (copyToClipboard as jest.Mock).mockClear();
+ });
+
+ it('should select a new line when clicked', () => {
const rendered = renderHook(() => useLogViewerSelection(lines), {
wrapper: ({ children }: PropsWithChildren<{}>) => (
@@ -47,77 +63,290 @@ describe('useLogViewerSelection', () => {
),
});
- expect(rendered.result.current.isSelected(1)).toBe(false);
- expect(rendered.result.current.isSelected(2)).toBe(false);
- expect(rendered.result.current.isSelected(3)).toBe(false);
+ expectSelectedLines(rendered, []);
+ act(() => rendered.result.current.setSelection(2, false, false));
+ expectSelectedLines(rendered, [2]);
+ act(() => rendered.result.current.setSelection(5, false, false));
+ expectSelectedLines(rendered, [5]);
+ act(() => rendered.result.current.setSelection(2, false, false));
+ expectSelectedLines(rendered, [2]);
+ });
- expect(rendered.result.current.shouldShowButton(1)).toBe(false);
- expect(rendered.result.current.shouldShowButton(2)).toBe(false);
- expect(rendered.result.current.shouldShowButton(3)).toBe(false);
+ it('should deselect a selected line when clicked', () => {
+ const rendered = renderHook(() => useLogViewerSelection(lines), {
+ wrapper: ({ children }: PropsWithChildren<{}>) => (
+
+ {children}
+
+ ),
+ });
- act(() => rendered.result.current.setSelection(2, false));
+ expectSelectedLines(rendered, []);
+ act(() => rendered.result.current.setSelection(2, false, false));
+ expectSelectedLines(rendered, [2]);
+ act(() => rendered.result.current.setSelection(2, false, false));
+ expectSelectedLines(rendered, []);
+ });
- expect(rendered.result.current.isSelected(1)).toBe(false);
- expect(rendered.result.current.isSelected(2)).toBe(true);
- expect(rendered.result.current.isSelected(3)).toBe(false);
+ it('should select a new line on shift+click if nothing is selected', () => {
+ const rendered = renderHook(() => useLogViewerSelection(lines), {
+ wrapper: ({ children }: PropsWithChildren<{}>) => (
+
+ {children}
+
+ ),
+ });
- expect(rendered.result.current.shouldShowButton(1)).toBe(false);
- expect(rendered.result.current.shouldShowButton(2)).toBe(true);
- expect(rendered.result.current.shouldShowButton(3)).toBe(false);
+ expectSelectedLines(rendered, []);
+ act(() => rendered.result.current.setSelection(2, true, false));
+ expectSelectedLines(rendered, [2]);
+ });
- act(() => rendered.result.current.setSelection(3, false));
+ it('should deselect a single line on shift+click', () => {
+ const rendered = renderHook(() => useLogViewerSelection(lines), {
+ wrapper: ({ children }: PropsWithChildren<{}>) => (
+
+ {children}
+
+ ),
+ });
- expect(rendered.result.current.isSelected(1)).toBe(false);
- expect(rendered.result.current.isSelected(2)).toBe(false);
- expect(rendered.result.current.isSelected(3)).toBe(true);
- expect(rendered.result.current.isSelected(4)).toBe(false);
+ expectSelectedLines(rendered, []);
+ act(() => rendered.result.current.setSelection(2, true, false));
+ expectSelectedLines(rendered, [2]);
+ act(() => rendered.result.current.setSelection(2, true, false));
+ expectSelectedLines(rendered, []);
+ });
- expect(rendered.result.current.shouldShowButton(1)).toBe(false);
- expect(rendered.result.current.shouldShowButton(2)).toBe(false);
- expect(rendered.result.current.shouldShowButton(3)).toBe(true);
- expect(rendered.result.current.shouldShowButton(4)).toBe(false);
+ it('should select a range below on shift+click', () => {
+ const rendered = renderHook(() => useLogViewerSelection(lines), {
+ wrapper: ({ children }: PropsWithChildren<{}>) => (
+
+ {children}
+
+ ),
+ });
- act(() => rendered.result.current.setSelection(1, true));
+ expectSelectedLines(rendered, []);
+ act(() => rendered.result.current.setSelection(2, true, false));
+ expectSelectedLines(rendered, [2]);
+ act(() => rendered.result.current.setSelection(5, true, false));
+ expectSelectedLines(rendered, [2, 3, 4, 5]);
+ });
- expect(rendered.result.current.isSelected(1)).toBe(true);
- expect(rendered.result.current.isSelected(2)).toBe(true);
- expect(rendered.result.current.isSelected(3)).toBe(true);
- expect(rendered.result.current.isSelected(4)).toBe(false);
+ it('should select a range above on shift+click', () => {
+ const rendered = renderHook(() => useLogViewerSelection(lines), {
+ wrapper: ({ children }: PropsWithChildren<{}>) => (
+
+ {children}
+
+ ),
+ });
- expect(rendered.result.current.shouldShowButton(1)).toBe(true);
- expect(rendered.result.current.shouldShowButton(2)).toBe(false);
- expect(rendered.result.current.shouldShowButton(3)).toBe(true);
- expect(rendered.result.current.shouldShowButton(4)).toBe(false);
+ expectSelectedLines(rendered, []);
+ act(() => rendered.result.current.setSelection(5, true, false));
+ expectSelectedLines(rendered, [5]);
+ act(() => rendered.result.current.setSelection(2, true, false));
+ expectSelectedLines(rendered, [2, 3, 4, 5]);
+ });
- act(() => rendered.result.current.setSelection(4, true));
+ it('should reduce a selection on shift+click', () => {
+ const rendered = renderHook(() => useLogViewerSelection(lines), {
+ wrapper: ({ children }: PropsWithChildren<{}>) => (
+
+ {children}
+
+ ),
+ });
- expect(rendered.result.current.isSelected(1)).toBe(false);
- expect(rendered.result.current.isSelected(2)).toBe(false);
- expect(rendered.result.current.isSelected(3)).toBe(true);
- expect(rendered.result.current.isSelected(4)).toBe(true);
- expect(rendered.result.current.isSelected(5)).toBe(false);
+ expectSelectedLines(rendered, []);
+ act(() => rendered.result.current.setSelection(2, true, false));
+ expectSelectedLines(rendered, [2]);
+ act(() => rendered.result.current.setSelection(7, true, false));
+ expectSelectedLines(rendered, [2, 3, 4, 5, 6, 7]);
+ act(() => rendered.result.current.setSelection(4, true, false));
+ expectSelectedLines(rendered, [2, 3, 4]);
+ act(() => rendered.result.current.setSelection(2, true, false));
+ expectSelectedLines(rendered, [2]);
+ });
- expect(rendered.result.current.shouldShowButton(1)).toBe(false);
- expect(rendered.result.current.shouldShowButton(2)).toBe(false);
- expect(rendered.result.current.shouldShowButton(3)).toBe(true);
- expect(rendered.result.current.shouldShowButton(4)).toBe(true);
- expect(rendered.result.current.shouldShowButton(5)).toBe(false);
+ it('should add a new selection on cmd/ctrl+click', () => {
+ const rendered = renderHook(() => useLogViewerSelection(lines), {
+ wrapper: ({ children }: PropsWithChildren<{}>) => (
+
+ {children}
+
+ ),
+ });
+
+ expectSelectedLines(rendered, []);
+ act(() => rendered.result.current.setSelection(2, false, true));
+ expectSelectedLines(rendered, [2]);
+ act(() => rendered.result.current.setSelection(5, false, true));
+ expectSelectedLines(rendered, [2, 5]);
+ });
+
+ it('should merge selections on cmd/ctrl+click', () => {
+ const rendered = renderHook(() => useLogViewerSelection(lines), {
+ wrapper: ({ children }: PropsWithChildren<{}>) => (
+
+ {children}
+
+ ),
+ });
+
+ expectSelectedLines(rendered, []);
+ act(() => rendered.result.current.setSelection(1, false, true));
+ expectSelectedLines(rendered, [1]);
+ act(() => rendered.result.current.setSelection(3, true, false));
+ expectSelectedLines(rendered, [1, 2, 3]);
+ act(() => rendered.result.current.setSelection(5, false, true));
+ expectSelectedLines(rendered, [1, 2, 3, 5]);
+ act(() => rendered.result.current.setSelection(7, true, false));
+ expectSelectedLines(rendered, [1, 2, 3, 5, 6, 7]);
+ act(() => rendered.result.current.setSelection(4, false, true));
+ expectSelectedLines(rendered, [1, 2, 3, 4, 5, 6, 7]);
+ });
+
+ it('should split a selection on cmd/ctrl+click', () => {
+ const rendered = renderHook(() => useLogViewerSelection(lines), {
+ wrapper: ({ children }: PropsWithChildren<{}>) => (
+
+ {children}
+
+ ),
+ });
+
+ expectSelectedLines(rendered, []);
+ act(() => rendered.result.current.setSelection(1, false, true));
+ expectSelectedLines(rendered, [1]);
+ act(() => rendered.result.current.setSelection(5, true, false));
+ expectSelectedLines(rendered, [1, 2, 3, 4, 5]);
+ act(() => rendered.result.current.setSelection(3, false, true));
+ expectSelectedLines(rendered, [1, 2, 4, 5]);
+ });
+
+ it('should copy a selected line', () => {
+ const rendered = renderHook(() => useLogViewerSelection(lines), {
+ wrapper: ({ children }: PropsWithChildren<{}>) => (
+
+ {children}
+
+ ),
+ });
+
+ expectSelectedLines(rendered, []);
+ act(() => rendered.result.current.setSelection(2, false, false));
+ expectSelectedLines(rendered, [2]);
expect(copyToClipboard).not.toHaveBeenCalled();
- act(() => rendered.result.current.copySelection());
- expect(copyToClipboard).toHaveBeenLastCalledWith('3\n4');
+ act(() => rendered.result.current.copySelection(2));
+ expect(copyToClipboard).toHaveBeenLastCalledWith('2');
+ });
- act(() => rendered.result.current.setSelection(2, true));
- act(() => rendered.result.current.setSelection(4, true));
+ it('should copy a selected range', () => {
+ const rendered = renderHook(() => useLogViewerSelection(lines), {
+ wrapper: ({ children }: PropsWithChildren<{}>) => (
+
+ {children}
+
+ ),
+ });
+ rendered.rerender();
- act(() => rendered.result.current.copySelection());
- expect(copyToClipboard).toHaveBeenCalledWith('2\n3\n4');
+ expectSelectedLines(rendered, []);
+ act(() => rendered.result.current.setSelection(2, false, false));
+ expectSelectedLines(rendered, [2]);
+ act(() => rendered.result.current.setSelection(5, true, false));
+ expectSelectedLines(rendered, [2, 3, 4, 5]);
- act(() => rendered.result.current.setSelection(2, false));
- act(() => rendered.result.current.setSelection(4, false));
- act(() => rendered.result.current.setSelection(4, false));
- act(() => rendered.result.current.setSelection(5, true));
- act(() => rendered.result.current.copySelection());
- expect(copyToClipboard).toHaveBeenCalledWith('5');
+ expect(copyToClipboard).not.toHaveBeenCalled();
+ act(() => rendered.result.current.copySelection(2));
+ expect(copyToClipboard).toHaveBeenCalledWith('2\n3\n4\n5');
+ });
+
+ it('should copy the correct selection', () => {
+ const rendered = renderHook(() => useLogViewerSelection(lines), {
+ wrapper: ({ children }: PropsWithChildren<{}>) => (
+
+ {children}
+
+ ),
+ });
+ rendered.rerender();
+
+ expectSelectedLines(rendered, []);
+ act(() => rendered.result.current.setSelection(2, false, false));
+ expectSelectedLines(rendered, [2]);
+ act(() => rendered.result.current.setSelection(5, true, false));
+ expectSelectedLines(rendered, [2, 3, 4, 5]);
+
+ act(() => rendered.result.current.setSelection(7, false, true));
+ expectSelectedLines(rendered, [2, 3, 4, 5, 7]);
+
+ expect(copyToClipboard).not.toHaveBeenCalled();
+ act(() => rendered.result.current.copySelection(2));
+ expect(copyToClipboard).toHaveBeenCalledWith('2\n3\n4\n5');
+ act(() => rendered.result.current.copySelection(7));
+ expect(copyToClipboard).toHaveBeenCalledWith('7');
+ });
+
+ it('should add a single line selection to the hash', () => {
+ const rendered = renderHook(() => useLogViewerSelection(lines), {
+ wrapper: ({ children }: PropsWithChildren<{}>) => (
+
+ {children}
+
+ ),
+ });
+ rendered.rerender();
+
+ expectSelectedLines(rendered, []);
+ act(() => rendered.result.current.setSelection(2, false, false));
+ expectSelectedLines(rendered, [2]);
+
+ expect(rendered.result.current.getHash()).toBe('#lines-2');
+ });
+
+ it('should add a range selection to the hash', () => {
+ const rendered = renderHook(() => useLogViewerSelection(lines), {
+ wrapper: ({ children }: PropsWithChildren<{}>) => (
+
+ {children}
+
+ ),
+ });
+ rendered.rerender();
+
+ expectSelectedLines(rendered, []);
+ act(() => rendered.result.current.setSelection(2, false, false));
+ expectSelectedLines(rendered, [2]);
+ act(() => rendered.result.current.setSelection(5, true, false));
+ expectSelectedLines(rendered, [2, 3, 4, 5]);
+
+ expect(rendered.result.current.getHash()).toBe('#lines-2-5');
+ });
+
+ it('should add multiple selections to the hash', () => {
+ const rendered = renderHook(() => useLogViewerSelection(lines), {
+ wrapper: ({ children }: PropsWithChildren<{}>) => (
+
+ {children}
+
+ ),
+ });
+ rendered.rerender();
+
+ expectSelectedLines(rendered, []);
+ act(() => rendered.result.current.setSelection(3, false, false));
+ expectSelectedLines(rendered, [3]);
+ act(() => rendered.result.current.setSelection(5, true, false));
+ expectSelectedLines(rendered, [3, 4, 5]);
+ act(() => rendered.result.current.setSelection(1, false, true));
+ expectSelectedLines(rendered, [1, 3, 4, 5]);
+ act(() => rendered.result.current.setSelection(7, false, true));
+ expectSelectedLines(rendered, [1, 3, 4, 5, 7]);
+
+ expect(rendered.result.current.getHash()).toBe('#lines-3-5,1,7');
});
});
diff --git a/packages/core-components/src/components/LogViewer/useLogViewerSelection.tsx b/packages/core-components/src/components/LogViewer/useLogViewerSelection.tsx
index 97fee53c8a..d59a552777 100644
--- a/packages/core-components/src/components/LogViewer/useLogViewerSelection.tsx
+++ b/packages/core-components/src/components/LogViewer/useLogViewerSelection.tsx
@@ -19,11 +19,14 @@ import { useEffect, useState } from 'react';
import useCopyToClipboard from 'react-use/esm/useCopyToClipboard';
import { AnsiLine } from './AnsiProcessor';
+type Selection = {
+ start: number;
+ end: number;
+};
+
export function useLogViewerSelection(lines: AnsiLine[]) {
const errorApi = useApi(errorApiRef);
- const [sel, setSelection] = useState<{ start: number; end: number }>();
- const start = sel ? Math.min(sel.start, sel.end) : undefined;
- const end = sel ? Math.max(sel.start, sel.end) : undefined;
+ const [selections, setSelections] = useState([]);
const [{ error }, copyToClipboard] = useCopyToClipboard();
@@ -33,38 +36,202 @@ export function useLogViewerSelection(lines: AnsiLine[]) {
}
}, [error, errorApi]);
+ const findClosestSelection = (
+ allSelections: Selection[],
+ line: number,
+ ): Selection | undefined => {
+ if (selections.length === 0) {
+ return undefined;
+ }
+ let minDistance = Number.MAX_SAFE_INTEGER;
+ let closestSelection: Selection | undefined = undefined;
+
+ allSelections.forEach(s => {
+ const distance = Math.min(
+ Math.abs(s.start - line),
+ Math.abs(s.end - line),
+ );
+ if (distance < minDistance) {
+ minDistance = distance;
+ closestSelection = s;
+ }
+ });
+
+ return closestSelection;
+ };
+
+ const mergeNeighbouringSelections = (
+ allSelections: Selection[],
+ line: number,
+ ): Selection[] => {
+ // Merge selections if they're next to each other
+ const neighboringSelections = allSelections.filter(
+ s => s.start - 1 === line || s.end + 1 === line,
+ );
+ if (neighboringSelections.length === 0) {
+ return allSelections;
+ }
+ const newSelection = {
+ start: Math.min(line, ...neighboringSelections.map(s => s.start)),
+ end: Math.max(line, ...neighboringSelections.map(s => s.end)),
+ };
+
+ return [
+ ...allSelections.filter(
+ s =>
+ !neighboringSelections.includes(s) &&
+ !(s.start === line && s.end === line),
+ ),
+ newSelection,
+ ];
+ };
+
return {
- shouldShowButton(line: number) {
- return start === line || end === line;
+ shouldShowCopyButton(line: number) {
+ // show copy button at the beginning of each selection
+ return selections.some(s => s.start === line);
},
isSelected(line: number) {
- if (!sel) {
+ if (!selections) {
return false;
}
- return start! <= line && line <= end!;
+ // check if line is in any selection range
+ return selections.some(
+ s => s.start <= line && (s.end ?? s.start) >= line,
+ );
},
- setSelection(line: number, add: boolean) {
- if (add) {
- setSelection(s =>
- s ? { start: s.start, end: line } : { start: line, end: line },
+ setSelection(line: number, addRange: boolean, addNewSelection: boolean) {
+ setSelections(currentSelections => {
+ const clickedSelection = currentSelections.find(
+ s => s.start <= line && s.end >= line,
);
- } else {
- setSelection(s =>
- s?.start === line && s?.end === line
- ? undefined
- : { start: line, end: line },
+ const otherSelections = currentSelections.filter(
+ s => s !== clickedSelection,
);
- }
+
+ if (!addRange && !addNewSelection) {
+ // Normal click -> select only this line if nothing or multiple lines are selected
+ if (
+ !clickedSelection ||
+ clickedSelection.start !== clickedSelection.end
+ ) {
+ return [{ start: line, end: line }];
+ }
+ // Clear selection if single line is selected
+ return [];
+ }
+
+ if (addRange) {
+ // Shift+click -> extend/reduce selection
+ if (currentSelections.length === 0) {
+ // No existing selection -> create new selection
+ return [{ start: line, end: line }];
+ }
+
+ if (clickedSelection) {
+ // Clicked inside an existing selection -> reduce selection
+ if (clickedSelection.start === clickedSelection.end) {
+ // Single line selection -> remove it
+ return otherSelections;
+ }
+ // Reduce selection
+ return [
+ ...otherSelections,
+ { start: clickedSelection.start, end: line },
+ ];
+ }
+
+ // Extend the closest selection to the new line
+ const closestSelection = findClosestSelection(
+ currentSelections,
+ line,
+ );
+ if (!closestSelection) {
+ // Can't actually happen
+ return currentSelections;
+ }
+ if (closestSelection.start < line) {
+ // Add lines before the selection
+ return mergeNeighbouringSelections(
+ [
+ ...otherSelections.filter(s => s !== closestSelection),
+ { start: closestSelection.start, end: line },
+ ],
+ line,
+ );
+ }
+ // Add lines after the selection
+ return mergeNeighbouringSelections(
+ [
+ ...otherSelections.filter(s => s !== closestSelection),
+ { start: line, end: closestSelection!.end },
+ ],
+ line,
+ );
+ }
+
+ if (addNewSelection) {
+ // Ctrl/Cmd+click -> add new selection
+ if (!clickedSelection) {
+ // Just add new selection
+ return mergeNeighbouringSelections(
+ [...currentSelections, { start: line, end: line }],
+ line,
+ );
+ }
+ if (clickedSelection.start === clickedSelection.end) {
+ // Single line selection -> remove it
+ return otherSelections;
+ }
+ // Multi line selection -> split it
+ return [
+ ...otherSelections,
+ ...(clickedSelection.start < line
+ ? [{ start: clickedSelection.start, end: line - 1 }]
+ : []),
+ ...(clickedSelection.end > line
+ ? [{ start: line + 1, end: clickedSelection.end }]
+ : []),
+ ];
+ }
+
+ return [];
+ });
},
- copySelection() {
- if (sel) {
- const copyText = lines
- .slice(Math.min(sel.start, sel.end) - 1, Math.max(sel.start, sel.end))
- .map(l => l.chunks.map(c => c.text).join(''))
- .join('\n');
- copyToClipboard(copyText);
- setSelection(undefined);
+ copySelection(line: number) {
+ const selection = selections.find(s => s.start === line);
+ if (!selection) {
+ return;
}
+ const copyText = lines
+ .slice(selection.start - 1, selection.end)
+ .map(l => l.chunks.map(c => c.text).join(''))
+ .join('\n');
+ copyToClipboard(copyText);
+ },
+ getHash() {
+ if (selections.length === 0) {
+ return '';
+ }
+ const parts = selections.map(s => {
+ if (s.start === s.end) {
+ return `${s.start}`;
+ }
+ return `${s.start}-${s.end}`;
+ });
+ return `#lines-${parts.join(',')}`;
+ },
+ selectAll(hash: string) {
+ const match = hash.match(/#lines-([\d,-]+)/);
+ const s: Selection[] = [];
+ if (match) {
+ const ranges = match[1].split(',');
+ ranges.forEach(r => {
+ const [start, end] = r.split('-').map(Number);
+ s.push({ start, end: end ?? start });
+ });
+ }
+ setSelections(s);
},
};
}
diff --git a/packages/core-components/src/components/OverflowTooltip/OverflowTooltip.tsx b/packages/core-components/src/components/OverflowTooltip/OverflowTooltip.tsx
index 68499e2dc1..7fc45d767d 100644
--- a/packages/core-components/src/components/OverflowTooltip/OverflowTooltip.tsx
+++ b/packages/core-components/src/components/OverflowTooltip/OverflowTooltip.tsx
@@ -23,6 +23,7 @@ type Props = {
title?: TooltipProps['title'];
line?: number | undefined;
placement?: TooltipProps['placement'];
+ tooltipClasses?: TooltipProps['classes'];
};
export type OverflowTooltipClassKey = 'container';
@@ -51,6 +52,7 @@ export function OverflowTooltip(props: Props) {
{props.text}
diff --git a/packages/core-components/src/components/WarningPanel/WarningPanel.tsx b/packages/core-components/src/components/WarningPanel/WarningPanel.tsx
index 7d9c4d472d..2e05784fd6 100644
--- a/packages/core-components/src/components/WarningPanel/WarningPanel.tsx
+++ b/packages/core-components/src/components/WarningPanel/WarningPanel.tsx
@@ -96,6 +96,7 @@ const useStyles = makeStyles(
fontWeight: theme.typography.fontWeightBold,
},
markdownContent: {
+ wordBreak: 'break-word',
'& p': {
display: 'inline',
},
diff --git a/packages/create-app/CHANGELOG.md b/packages/create-app/CHANGELOG.md
index c921e2ad9b..e26b1347a3 100644
--- a/packages/create-app/CHANGELOG.md
+++ b/packages/create-app/CHANGELOG.md
@@ -1,5 +1,22 @@
# @backstage/create-app
+## 0.7.7-next.2
+
+### Patch Changes
+
+- 2bae83a: Updated engines to support Node 22 or 24
+- 2bae83a: Bumped dev dependencies `@types/node`
+- Updated dependencies
+ - @backstage/cli-common@0.1.16-next.2
+
+## 0.7.7-next.1
+
+### Patch Changes
+
+- Bumped create-app version.
+- Updated dependencies
+ - @backstage/cli-common@0.1.16-next.1
+
## 0.7.7-next.0
### Patch Changes
diff --git a/packages/create-app/package.json b/packages/create-app/package.json
index 2132f57b1d..029cec855a 100644
--- a/packages/create-app/package.json
+++ b/packages/create-app/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/create-app",
- "version": "0.7.7-next.0",
+ "version": "0.7.7-next.2",
"description": "A CLI that helps you create your own Backstage app",
"backstage": {
"role": "cli"
@@ -58,7 +58,7 @@
"@types/command-exists": "^1.2.0",
"@types/fs-extra": "^11.0.0",
"@types/inquirer": "^8.1.3",
- "@types/node": "^20.16.0",
+ "@types/node": "^22.13.14",
"@types/recursive-readdir": "^2.2.0",
"msw": "^2.0.0",
"nodemon": "^3.0.1"
diff --git a/packages/create-app/templates/default-app/package.json.hbs b/packages/create-app/templates/default-app/package.json.hbs
index 8399c6505a..d0a088a7d1 100644
--- a/packages/create-app/templates/default-app/package.json.hbs
+++ b/packages/create-app/templates/default-app/package.json.hbs
@@ -3,7 +3,7 @@
"version": "1.0.0",
"private": true,
"engines": {
- "node": "20 || 22"
+ "node": "22 || 24"
},
"scripts": {
"start": "backstage-cli repo start",
diff --git a/packages/create-app/templates/next-app/package.json.hbs b/packages/create-app/templates/next-app/package.json.hbs
index 33e76aba3b..55a591067b 100644
--- a/packages/create-app/templates/next-app/package.json.hbs
+++ b/packages/create-app/templates/next-app/package.json.hbs
@@ -3,7 +3,7 @@
"version": "1.0.0",
"private": true,
"engines": {
- "node": "20 || 22"
+ "node": "22 || 24"
},
"scripts": {
"start": "backstage-cli repo start",
diff --git a/packages/dev-utils/CHANGELOG.md b/packages/dev-utils/CHANGELOG.md
index 90b69eb678..1b26653336 100644
--- a/packages/dev-utils/CHANGELOG.md
+++ b/packages/dev-utils/CHANGELOG.md
@@ -1,5 +1,14 @@
# @backstage/dev-utils
+## 1.1.18-next.1
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/ui@0.10.0-next.1
+ - @backstage/core-components@0.18.4-next.1
+ - @backstage/plugin-catalog-react@1.21.4-next.1
+
## 1.1.18-next.0
### Patch Changes
diff --git a/packages/dev-utils/package.json b/packages/dev-utils/package.json
index 85361d46a0..5b0c9bbee7 100644
--- a/packages/dev-utils/package.json
+++ b/packages/dev-utils/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/dev-utils",
- "version": "1.1.18-next.0",
+ "version": "1.1.18-next.1",
"description": "Utilities for developing Backstage plugins.",
"backstage": {
"role": "web-library"
diff --git a/packages/e2e-test/package.json b/packages/e2e-test/package.json
index 65fe932620..e70f2f8105 100644
--- a/packages/e2e-test/package.json
+++ b/packages/e2e-test/package.json
@@ -47,7 +47,7 @@
"devDependencies": {
"@backstage/cli": "workspace:^",
"@types/fs-extra": "^11.0.0",
- "@types/node": "^20.16.0",
+ "@types/node": "^22.13.14",
"nodemon": "^3.0.1"
}
}
diff --git a/packages/e2e-test/src/commands/index.ts b/packages/e2e-test/src/commands/index.ts
index fd0ba59c30..cbcb9f3907 100644
--- a/packages/e2e-test/src/commands/index.ts
+++ b/packages/e2e-test/src/commands/index.ts
@@ -15,12 +15,12 @@
*/
import { Command } from 'commander';
-import { run } from './run';
+import { runCommand } from './runCommand';
export function registerCommands(program: Command) {
program
.command('run')
.option('--keep', 'Do not remove the temporary dir after tests complete')
.description('Run e2e tests')
- .action(run);
+ .action(runCommand);
}
diff --git a/packages/e2e-test/src/commands/run.ts b/packages/e2e-test/src/commands/runCommand.ts
similarity index 94%
rename from packages/e2e-test/src/commands/run.ts
rename to packages/e2e-test/src/commands/runCommand.ts
index 6df58349df..112937dbe7 100644
--- a/packages/e2e-test/src/commands/run.ts
+++ b/packages/e2e-test/src/commands/runCommand.ts
@@ -22,18 +22,12 @@ import killTree from 'tree-kill';
import { resolve as resolvePath, join as joinPath } from 'path';
import path from 'path';
-import {
- spawnPiped,
- runPlain,
- waitFor,
- waitForExit,
- print,
-} from '../lib/helpers';
+import { waitFor, print } from '../lib/helpers';
import mysql from 'mysql2/promise';
import pgtools from 'pgtools';
-import { findPaths } from '@backstage/cli-common';
+import { findPaths, runOutput, run } from '@backstage/cli-common';
import { OptionValues } from 'commander';
// eslint-disable-next-line no-restricted-syntax
@@ -46,7 +40,7 @@ const templatePackagePaths = [
'packages/create-app/templates/default-app/packages/backend/package.json.hbs',
];
-export async function run(opts: OptionValues) {
+export async function runCommand(opts: OptionValues) {
const rootDir = await fs.mkdtemp(resolvePath(os.tmpdir(), 'backstage-e2e-'));
print(`CLI E2E test root: ${rootDir}\n`);
@@ -67,7 +61,7 @@ export async function run(opts: OptionValues) {
await createPlugin({ appDir, pluginId, select: 'backend-plugin' });
print(`Running 'yarn test:e2e' in newly created app with new plugin`);
- await runPlain(['yarn', 'test:e2e'], {
+ await runOutput(['yarn', 'test:e2e'], {
cwd: appDir,
env: { ...process.env, CI: undefined },
});
@@ -75,13 +69,13 @@ export async function run(opts: OptionValues) {
await switchToReact17(appDir);
print(`Running 'yarn install' to install React 17`);
- await runPlain(['yarn', 'install'], { cwd: appDir });
+ await runOutput(['yarn', 'install'], { cwd: appDir });
print(`Running 'yarn tsc' with React 17`);
- await runPlain(['yarn', 'tsc'], { cwd: appDir });
+ await runOutput(['yarn', 'tsc'], { cwd: appDir });
print(`Running 'yarn test:e2e' with React 17`);
- await runPlain(['yarn', 'test:e2e'], {
+ await runOutput(['yarn', 'test:e2e'], {
cwd: appDir,
env: { ...process.env, CI: undefined },
});
@@ -190,7 +184,7 @@ async function buildDistWorkspace(workspaceName: string, rootDir: string) {
appendDeps(require('@backstage/create-app/package.json'));
print(`Preparing workspace`);
- await runPlain([
+ await runOutput([
'yarn',
'backstage-cli',
'build-workspace',
@@ -209,7 +203,7 @@ async function buildDistWorkspace(workspaceName: string, rootDir: string) {
}
print('Installing workspace dependencies');
- await runPlain(['yarn', 'workspaces', 'focus', '--all', '--production'], {
+ await runOutput(['yarn', 'workspaces', 'focus', '--all', '--production'], {
cwd: workspaceDir,
});
@@ -257,7 +251,7 @@ async function createApp(
workspaceDir: string,
rootDir: string,
) {
- const child = spawnPiped(
+ const child = run(
[
'node',
resolvePath(workspaceDir, 'packages/create-app/bin/backstage-create-app'),
@@ -265,6 +259,7 @@ async function createApp(
],
{
cwd: rootDir,
+ stdio: ['pipe', 'pipe', 'pipe'],
},
);
@@ -278,7 +273,7 @@ async function createApp(
child.stdin?.write(`${appName}\n`);
print('Waiting for app create script to be done');
- await waitForExit(child);
+ await child.waitForExit();
const appDir = resolvePath(rootDir, appName);
@@ -318,7 +313,7 @@ async function createApp(
'test:all',
]) {
print(`Running 'yarn ${cmd}' in newly created app`);
- await runPlain(['yarn', cmd], { cwd: appDir });
+ await runOutput(['yarn', cmd], { cwd: appDir });
}
return appDir;
@@ -378,10 +373,11 @@ async function createPlugin(options: {
select: string;
}) {
const { appDir, pluginId, select } = options;
- const child = spawnPiped(
+ const child = run(
['yarn', 'new', '--select', select, '--option', `pluginId=${pluginId}`],
{
cwd: appDir,
+ stdio: ['pipe', 'pipe', 'pipe'],
},
);
@@ -392,7 +388,7 @@ async function createPlugin(options: {
});
print('Waiting for plugin create script to be done');
- await waitForExit(child);
+ await child.waitForExit();
const pluginDir = resolvePath(
appDir,
@@ -401,11 +397,11 @@ async function createPlugin(options: {
);
print(`Running 'yarn tsc' in root for newly created plugin`);
- await runPlain(['yarn', 'tsc'], { cwd: appDir });
+ await runOutput(['yarn', 'tsc'], { cwd: appDir });
for (const cmd of [['lint'], ['test', '--no-watch']]) {
print(`Running 'yarn ${cmd.join(' ')}' in newly created plugin`);
- await runPlain(['yarn', ...cmd], { cwd: pluginDir });
+ await runOutput(['yarn', ...cmd], { cwd: pluginDir });
}
} finally {
child.kill();
@@ -494,7 +490,7 @@ async function dropClientDatabases(client: string) {
* Start serving the newly created backend and make sure that all db migrations works correctly
*/
async function testBackendStart(appDir: string, ...args: string[]) {
- const child = spawnPiped(['yarn', 'workspace', 'backend', 'start', ...args], {
+ const child = run(['yarn', 'workspace', 'backend', 'start', ...args], {
cwd: appDir,
// Windows does not like piping stdin here, the child process will hang when requiring the 'process' module
stdio: ['ignore', 'pipe', 'pipe'],
@@ -586,7 +582,7 @@ async function testBackendStart(appDir: string, ...args: string[]) {
}
try {
- await waitForExit(child);
+ await child.waitForExit();
} catch (error) {
if (!successful) {
throw new Error(`Backend failed to startup: ${stderr}`);
diff --git a/packages/e2e-test/src/index.ts b/packages/e2e-test/src/index.ts
index f3c63ae175..df299628b2 100644
--- a/packages/e2e-test/src/index.ts
+++ b/packages/e2e-test/src/index.ts
@@ -18,7 +18,6 @@ import { program } from 'commander';
import chalk from 'chalk';
import { registerCommands } from './commands';
import { version } from '../package.json';
-import { exitWithError } from './lib/helpers';
async function main(argv: string[]) {
program.name('e2e-test').version(version);
@@ -36,4 +35,12 @@ async function main(argv: string[]) {
program.parse(argv);
}
-main(process.argv).catch(exitWithError);
+main(process.argv).catch(err => {
+ process.stdout.write(`${err.name}: ${err.stack || err.message}\n`);
+
+ if (typeof err.code === 'number') {
+ process.exit(err.code);
+ } else {
+ process.exit(1);
+ }
+});
diff --git a/packages/e2e-test/src/lib/helpers.ts b/packages/e2e-test/src/lib/helpers.ts
index fc5aefcff9..d310812794 100644
--- a/packages/e2e-test/src/lib/helpers.ts
+++ b/packages/e2e-test/src/lib/helpers.ts
@@ -14,77 +14,6 @@
* limitations under the License.
*/
-import { assertError } from '@backstage/errors';
-import {
- spawn,
- execFile as execFileCb,
- SpawnOptions,
- ChildProcess,
-} from 'child_process';
-import { promisify } from 'util';
-
-const execFile = promisify(execFileCb);
-
-export function spawnPiped(cmd: string[], options?: SpawnOptions) {
- function pipeWithPrefix(stream: NodeJS.WriteStream, prefix = '') {
- return (data: Buffer) => {
- const prefixedMsg = data
- .toString('utf8')
- .trimEnd()
- .replace(/^/gm, prefix);
- stream.write(`${prefixedMsg}\n`, 'utf8');
- };
- }
-
- const child = spawn(cmd[0], cmd.slice(1), {
- stdio: 'pipe',
- shell: true,
- ...options,
- });
- child.on('error', exitWithError);
-
- const logPrefix = cmd.map(s => s.replace(/.+\//, '')).join(' ');
- child.stdout?.on(
- 'data',
- pipeWithPrefix(process.stdout, `[${logPrefix}].out: `),
- );
- child.stderr?.on(
- 'data',
- pipeWithPrefix(process.stderr, `[${logPrefix}].err: `),
- );
-
- return child;
-}
-
-export async function runPlain(cmd: string[], options?: SpawnOptions) {
- try {
- const { stdout } = await execFile(cmd[0], cmd.slice(1), {
- ...options,
- shell: true,
- });
- return stdout.trim();
- } catch (error) {
- assertError(error);
- if (error.stdout) {
- process.stdout.write(error.stdout as Buffer);
- }
- if (error.stderr) {
- process.stderr.write(error.stderr as Buffer);
- }
- throw error;
- }
-}
-
-export function exitWithError(err: Error & { code?: unknown }) {
- process.stdout.write(`${err.name}: ${err.stack || err.message}\n`);
-
- if (typeof err.code === 'number') {
- process.exit(err.code);
- } else {
- process.exit(1);
- }
-}
-
/**
* Waits for fn() to be true
* Checks every 100ms
@@ -108,22 +37,6 @@ export function waitFor(fn: () => boolean, maxSeconds: number = 120) {
});
}
-export async function waitForExit(child: ChildProcess) {
- if (child.exitCode !== null) {
- throw new Error(`Child already exited with code ${child.exitCode}`);
- }
- await new Promise((resolve, reject) =>
- child.once('exit', code => {
- if (code) {
- reject(new Error(`Child exited with code ${code}`));
- } else {
- print('Child finished');
- resolve();
- }
- }),
- );
-}
-
export function print(msg: string) {
return process.stdout.write(`${msg}\n`);
}
diff --git a/packages/frontend-internal/package.json b/packages/frontend-internal/package.json
index 4ac3285d9f..f2268f38f4 100644
--- a/packages/frontend-internal/package.json
+++ b/packages/frontend-internal/package.json
@@ -25,8 +25,7 @@
"dependencies": {
"@backstage/frontend-plugin-api": "workspace:^",
"@backstage/types": "workspace:^",
- "@backstage/version-bridge": "workspace:^",
- "zod": "^3.22.4"
+ "@backstage/version-bridge": "workspace:^"
},
"devDependencies": {
"@backstage/cli": "workspace:^",
diff --git a/packages/frontend-plugin-api/CHANGELOG.md b/packages/frontend-plugin-api/CHANGELOG.md
index c0c6b6ec0e..6c5ede72df 100644
--- a/packages/frontend-plugin-api/CHANGELOG.md
+++ b/packages/frontend-plugin-api/CHANGELOG.md
@@ -1,5 +1,21 @@
# @backstage/frontend-plugin-api
+## 0.13.2-next.1
+
+### Patch Changes
+
+- 75683ed: Added a new `errorPresentation` prop to `ExtensionBoundary` to control how errors are presented to the user. The default is `'error-display'`, which is the current behavior of showing the error in the `ErrorDisplay` component. The new option is `'error-api'`, posts errors to the `ErrorApi` and does not allow retries.
+
+ The `AppRootElementBlueprint` now wraps its element in an `ErrorBoundary` using the new `'error-api'` presentation mode.
+
+- f3f84f1: Made the return type of `.withOverrides` to be simplified.
+- Updated dependencies
+ - @backstage/core-components@0.18.4-next.2
+ - @backstage/config@1.3.6
+ - @backstage/errors@1.2.7
+ - @backstage/types@1.2.2
+ - @backstage/version-bridge@1.0.11
+
## 0.13.2-next.0
### Patch Changes
diff --git a/packages/frontend-plugin-api/package.json b/packages/frontend-plugin-api/package.json
index 25c40b2e0a..af3359ff22 100644
--- a/packages/frontend-plugin-api/package.json
+++ b/packages/frontend-plugin-api/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/frontend-plugin-api",
- "version": "0.13.2-next.0",
+ "version": "0.13.2-next.1",
"backstage": {
"role": "web-library"
},
@@ -40,18 +40,15 @@
"test": "backstage-cli package test"
},
"dependencies": {
- "@backstage/config": "workspace:^",
- "@backstage/core-components": "workspace:^",
"@backstage/errors": "workspace:^",
"@backstage/types": "workspace:^",
"@backstage/version-bridge": "workspace:^",
- "@material-ui/core": "^4.12.4",
- "lodash": "^4.17.21",
"zod": "^3.22.4",
"zod-to-json-schema": "^3.21.4"
},
"devDependencies": {
"@backstage/cli": "workspace:^",
+ "@backstage/config": "workspace:^",
"@backstage/frontend-app-api": "workspace:^",
"@backstage/frontend-test-utils": "workspace:^",
"@backstage/test-utils": "workspace:^",
diff --git a/packages/frontend-plugin-api/report.api.md b/packages/frontend-plugin-api/report.api.md
index d95634988c..fbe7110d80 100644
--- a/packages/frontend-plugin-api/report.api.md
+++ b/packages/frontend-plugin-api/report.api.md
@@ -4,12 +4,14 @@
```ts
import { AnyRouteRefParams as AnyRouteRefParams_2 } from '@backstage/frontend-plugin-api';
+import { ApiRef as ApiRef_2 } from '@backstage/frontend-plugin-api';
import { ComponentType } from 'react';
-import { Config } from '@backstage/config';
+import type { Config } from '@backstage/config';
import { ConfigurableExtensionDataRef as ConfigurableExtensionDataRef_2 } from '@backstage/frontend-plugin-api';
import { Expand } from '@backstage/types';
import { ExpandRecursive } from '@backstage/types';
import { ExtensionBlueprint as ExtensionBlueprint_2 } from '@backstage/frontend-plugin-api';
+import { ExtensionBlueprintParams as ExtensionBlueprintParams_2 } from '@backstage/frontend-plugin-api';
import { ExtensionDataRef as ExtensionDataRef_2 } from '@backstage/frontend-plugin-api';
import { IconComponent as IconComponent_2 } from '@backstage/frontend-plugin-api';
import { JsonObject } from '@backstage/types';
@@ -20,7 +22,8 @@ import { Observable } from '@backstage/types';
import { PropsWithChildren } from 'react';
import { ReactNode } from 'react';
import { RouteRef as RouteRef_2 } from '@backstage/frontend-plugin-api';
-import { z } from 'zod';
+import { SwappableComponentRef as SwappableComponentRef_2 } from '@backstage/frontend-plugin-api';
+import type { z } from 'zod';
// @public
export type AlertApi = {
@@ -80,12 +83,12 @@ export type AnalyticsImplementation = {
};
// @public
-export const AnalyticsImplementationBlueprint: ExtensionBlueprint<{
+export const AnalyticsImplementationBlueprint: ExtensionBlueprint_2<{
kind: 'analytics';
params: (
params: AnalyticsImplementationFactory,
- ) => ExtensionBlueprintParams>;
- output: ExtensionDataRef<
+ ) => ExtensionBlueprintParams_2>;
+ output: ExtensionDataRef_2<
AnalyticsImplementationFactory<{}>,
'core.analytics.factory',
{}
@@ -94,7 +97,7 @@ export const AnalyticsImplementationBlueprint: ExtensionBlueprint<{
config: {};
configInput: {};
dataRefs: {
- factory: ConfigurableExtensionDataRef<
+ factory: ConfigurableExtensionDataRef_2<
AnalyticsImplementationFactory<{}>,
'core.analytics.factory',
{}
@@ -147,7 +150,7 @@ export type AnyRouteRefParams =
| undefined;
// @public
-export const ApiBlueprint: ExtensionBlueprint<{
+export const ApiBlueprint: ExtensionBlueprint_2<{
kind: 'api';
params: <
TApi,
@@ -155,13 +158,13 @@ export const ApiBlueprint: ExtensionBlueprint<{
TDeps extends { [name in string]: unknown },
>(
params: ApiFactory,
- ) => ExtensionBlueprintParams;
- output: ExtensionDataRef;
+ ) => ExtensionBlueprintParams_2;
+ output: ExtensionDataRef_2;
inputs: {};
config: {};
configInput: {};
dataRefs: {
- factory: ConfigurableExtensionDataRef<
+ factory: ConfigurableExtensionDataRef_2<
AnyApiFactory,
'core.api.factory',
{}
@@ -256,12 +259,12 @@ export interface AppNodeSpec {
}
// @public
-export const AppRootElementBlueprint: ExtensionBlueprint<{
+export const AppRootElementBlueprint: ExtensionBlueprint_2<{
kind: 'app-root-element';
params: {
element: JSX.Element;
};
- output: ExtensionDataRef;
+ output: ExtensionDataRef_2;
inputs: {};
config: {};
configInput: {};
@@ -269,13 +272,13 @@ export const AppRootElementBlueprint: ExtensionBlueprint<{
}>;
// @public
-export const AppRootWrapperBlueprint: ExtensionBlueprint<{
+export const AppRootWrapperBlueprint: ExtensionBlueprint_2<{
kind: 'app-root-wrapper';
params: {
Component?: [error: 'Use the `component` parameter instead'];
component: (props: { children: ReactNode }) => JSX.Element | null;
};
- output: ExtensionDataRef<
+ output: ExtensionDataRef_2<
(props: { children: ReactNode }) => JSX.Element | null,
'app.root.wrapper',
{}
@@ -284,7 +287,7 @@ export const AppRootWrapperBlueprint: ExtensionBlueprint<{
config: {};
configInput: {};
dataRefs: {
- component: ConfigurableExtensionDataRef<
+ component: ConfigurableExtensionDataRef_2<
(props: { children: ReactNode }) => JSX.Element | null,
'app.root.wrapper',
{}
@@ -330,7 +333,7 @@ export interface AppTreeApi {
}
// @public
-export const appTreeApiRef: ApiRef;
+export const appTreeApiRef: ApiRef_2;
// @public
export const atlassianAuthApiRef: ApiRef<
@@ -410,14 +413,14 @@ export interface ConfigurableExtensionDataRef<
// @public (undocumented)
export const coreExtensionData: {
- title: ConfigurableExtensionDataRef;
- reactElement: ConfigurableExtensionDataRef<
+ title: ConfigurableExtensionDataRef_2;
+ reactElement: ConfigurableExtensionDataRef_2<
JSX_3.Element,
'core.reactElement',
{}
>;
- routePath: ConfigurableExtensionDataRef;
- routeRef: ConfigurableExtensionDataRef<
+ routePath: ConfigurableExtensionDataRef_2;
+ routeRef: ConfigurableExtensionDataRef_2<
RouteRef,
'core.routing.ref',
{}
@@ -891,7 +894,7 @@ export interface DialogApiDialog {
}
// @public
-export const dialogApiRef: ApiRef;
+export const dialogApiRef: ApiRef_2;
// @public
export type DiscoveryApi = {
@@ -928,7 +931,7 @@ export const errorApiRef: ApiRef;
// @public (undocumented)
export const ErrorDisplay: {
(props: ErrorDisplayProps): JSX.Element | null;
- ref: SwappableComponentRef;
+ ref: SwappableComponentRef_2;
};
// @public (undocumented)
@@ -975,7 +978,7 @@ export interface ExtensionBlueprint<
// (undocumented)
make<
TName extends string | undefined,
- TParamsInput extends AnyParamsInput>,
+ TParamsInput extends AnyParamsInput_2>,
UParentInputs extends ExtensionDataRef,
>(args: {
name?: TName;
@@ -1003,10 +1006,10 @@ export interface ExtensionBlueprint<
},
UFactoryOutput extends ExtensionDataValue,
UNewOutput extends ExtensionDataRef,
+ UParentInputs extends ExtensionDataRef,
TExtraInputs extends {
[inputName in string]: ExtensionInput;
- },
- UParentInputs extends ExtensionDataRef,
+ } = {},
>(args: {
name?: TName;
attachTo?: ExtensionDefinitionAttachTo &
@@ -1030,7 +1033,7 @@ export interface ExtensionBlueprint<
};
factory(
originalFactory: <
- TParamsInput extends AnyParamsInput>,
+ TParamsInput extends AnyParamsInput_2>,
>(
params: TParamsInput extends ExtensionBlueprintDefineParams
? TParamsInput
@@ -1060,26 +1063,30 @@ export interface ExtensionBlueprint<
UFactoryOutput
>;
}): OverridableExtensionDefinition<{
- config: (string extends keyof TExtensionConfigSchema
- ? {}
- : {
- [key in keyof TExtensionConfigSchema]: z.infer<
- ReturnType
- >;
- }) &
- T['config'];
- configInput: (string extends keyof TExtensionConfigSchema
- ? {}
- : z.input<
- z.ZodObject<{
- [key in keyof TExtensionConfigSchema]: ReturnType<
- TExtensionConfigSchema[key]
+ config: Expand<
+ (string extends keyof TExtensionConfigSchema
+ ? {}
+ : {
+ [key in keyof TExtensionConfigSchema]: z.infer<
+ ReturnType
>;
- }>
- >) &
- T['configInput'];
+ }) &
+ T['config']
+ >;
+ configInput: Expand<
+ (string extends keyof TExtensionConfigSchema
+ ? {}
+ : z.input<
+ z.ZodObject<{
+ [key in keyof TExtensionConfigSchema]: ReturnType<
+ TExtensionConfigSchema[key]
+ >;
+ }>
+ >) &
+ T['configInput']
+ >;
output: ExtensionDataRef extends UNewOutput ? T['output'] : UNewOutput;
- inputs: T['inputs'] & TExtraInputs;
+ inputs: Expand;
kind: T['kind'];
name: string | undefined extends TName ? undefined : TName;
params: T['params'];
@@ -1139,6 +1146,8 @@ export interface ExtensionBoundaryProps {
// (undocumented)
children: ReactNode;
// (undocumented)
+ errorPresentation?: 'error-api' | 'error-display';
+ // (undocumented)
node: AppNode;
}
@@ -1449,12 +1458,12 @@ export const googleAuthApiRef: ApiRef<
>;
// @public (undocumented)
-export const IconBundleBlueprint: ExtensionBlueprint<{
+export const IconBundleBlueprint: ExtensionBlueprint_2<{
kind: 'icon-bundle';
params: {
icons: { [key in string]: IconComponent };
};
- output: ExtensionDataRef<
+ output: ExtensionDataRef_2<
{
[x: string]: IconComponent;
},
@@ -1465,7 +1474,7 @@ export const IconBundleBlueprint: ExtensionBlueprint<{
config: {};
configInput: {};
dataRefs: {
- icons: ConfigurableExtensionDataRef<
+ icons: ConfigurableExtensionDataRef_2<
{
[x: string]: IconComponent;
},
@@ -1489,7 +1498,7 @@ export interface IconsApi {
}
// @public
-export const iconsApiRef: ApiRef;
+export const iconsApiRef: ApiRef_2;
// @public
export type IdentityApi = {
@@ -1553,14 +1562,14 @@ export interface NavContentComponentProps {
}
// @public
-export const NavItemBlueprint: ExtensionBlueprint<{
+export const NavItemBlueprint: ExtensionBlueprint_2<{
kind: 'nav-item';
params: {
title: string;
icon: IconComponent;
routeRef: RouteRef;
};
- output: ExtensionDataRef<
+ output: ExtensionDataRef_2<
{
title: string;
icon: IconComponent;
@@ -1573,7 +1582,7 @@ export const NavItemBlueprint: ExtensionBlueprint<{
config: {};
configInput: {};
dataRefs: {
- target: ConfigurableExtensionDataRef<
+ target: ConfigurableExtensionDataRef_2<
{
title: string;
icon: IconComponent;
@@ -1588,7 +1597,7 @@ export const NavItemBlueprint: ExtensionBlueprint<{
// @public (undocumented)
export const NotFoundErrorPage: {
(props: NotFoundErrorPageProps): JSX.Element | null;
- ref: SwappableComponentRef;
+ ref: SwappableComponentRef_2;
};
// @public (undocumented)
@@ -1676,7 +1685,7 @@ export interface OverridableExtensionDefinition<
TExtraInputs extends {
[inputName in string]: ExtensionInput;
},
- TParamsInput extends AnyParamsInput_2>,
+ TParamsInput extends AnyParamsInput>,
UParentInputs extends ExtensionDataRef,
>(
args: Expand<
@@ -1702,7 +1711,7 @@ export interface OverridableExtensionDefinition<
};
factory?(
originalFactory: <
- TFactoryParamsReturn extends AnyParamsInput_2<
+ TFactoryParamsReturn extends AnyParamsInput<
NonNullable
>,
>(
@@ -1799,7 +1808,7 @@ export interface OverridableFrontendPlugin<
}
// @public
-export const PageBlueprint: ExtensionBlueprint<{
+export const PageBlueprint: ExtensionBlueprint_2<{
kind: 'page';
params: {
defaultPath?: [Error: `Use the 'path' param instead`];
@@ -1808,10 +1817,10 @@ export const PageBlueprint: ExtensionBlueprint<{
routeRef?: RouteRef;
};
output:
- | ExtensionDataRef
- | ExtensionDataRef
- | ExtensionDataRef<
- RouteRef,
+ | ExtensionDataRef_2
+ | ExtensionDataRef_2
+ | ExtensionDataRef_2<
+ RouteRef,
'core.routing.ref',
{
optional: true;
@@ -1880,7 +1889,7 @@ export type ProfileInfoApi = {
// @public (undocumented)
export const Progress: {
(props: ProgressProps): JSX.Element | null;
- ref: SwappableComponentRef;
+ ref: SwappableComponentRef_2;
};
// @public (undocumented)
@@ -1915,13 +1924,13 @@ export type RouteFunc = (
) => string;
// @public (undocumented)
-export const RouterBlueprint: ExtensionBlueprint<{
+export const RouterBlueprint: ExtensionBlueprint_2<{
kind: 'app-router-component';
params: {
Component?: [error: 'Use the `component` parameter instead'];
component: (props: { children: ReactNode }) => JSX.Element | null;
};
- output: ExtensionDataRef<
+ output: ExtensionDataRef_2<
(props: { children: ReactNode }) => JSX.Element | null,
'app.router.wrapper',
{}
@@ -1930,7 +1939,7 @@ export const RouterBlueprint: ExtensionBlueprint<{
config: {};
configInput: {};
dataRefs: {
- component: ConfigurableExtensionDataRef<
+ component: ConfigurableExtensionDataRef_2<
(props: { children: ReactNode }) => JSX.Element | null,
'app.router.wrapper',
{}
@@ -1963,7 +1972,7 @@ export interface RouteResolutionApi {
}
// @public
-export const routeResolutionApiRef: ApiRef;
+export const routeResolutionApiRef: ApiRef_2;
// @public
export type SessionApi = {
@@ -1990,12 +1999,12 @@ export namespace SessionState {
}
// @public
-export const SignInPageBlueprint: ExtensionBlueprint<{
+export const SignInPageBlueprint: ExtensionBlueprint_2<{
kind: 'sign-in-page';
params: {
loader: () => Promise>;
};
- output: ExtensionDataRef<
+ output: ExtensionDataRef_2<
ComponentType,
'core.sign-in-page.component',
{}
@@ -2004,7 +2013,7 @@ export const SignInPageBlueprint: ExtensionBlueprint<{
config: {};
configInput: {};
dataRefs: {
- component: ConfigurableExtensionDataRef<
+ component: ConfigurableExtensionDataRef_2<
ComponentType,
'core.sign-in-page.component',
{}
@@ -2058,7 +2067,7 @@ export interface SubRouteRef<
}
// @public
-export const SwappableComponentBlueprint: ExtensionBlueprint<{
+export const SwappableComponentBlueprint: ExtensionBlueprint_2<{
kind: 'component';
params: >(params: {
component: Ref extends SwappableComponentRef<
@@ -2074,7 +2083,7 @@ export const SwappableComponentBlueprint: ExtensionBlueprint<{
| (() => (props: IInnerComponentProps) => JSX.Element | null)
| (() => Promise<(props: IInnerComponentProps) => JSX.Element | null>)
: never;
- }) => ExtensionBlueprintParams<{
+ }) => ExtensionBlueprintParams_2<{
component: Ref extends SwappableComponentRef<
any,
infer IExternalComponentProps
@@ -2089,7 +2098,7 @@ export const SwappableComponentBlueprint: ExtensionBlueprint<{
| (() => Promise<(props: IInnerComponentProps) => JSX.Element | null>)
: never;
}>;
- output: ExtensionDataRef<
+ output: ExtensionDataRef_2<
{
ref: SwappableComponentRef;
loader:
@@ -2103,7 +2112,7 @@ export const SwappableComponentBlueprint: ExtensionBlueprint<{
config: {};
configInput: {};
dataRefs: {
- component: ConfigurableExtensionDataRef<
+ component: ConfigurableExtensionDataRef_2<
{
ref: SwappableComponentRef;
loader:
@@ -2139,20 +2148,20 @@ export interface SwappableComponentsApi {
}
// @public
-export const swappableComponentsApiRef: ApiRef;
+export const swappableComponentsApiRef: ApiRef_2;
// @public
-export const ThemeBlueprint: ExtensionBlueprint<{
+export const ThemeBlueprint: ExtensionBlueprint_2<{
kind: 'theme';
params: {
theme: AppTheme;
};
- output: ExtensionDataRef;
+ output: ExtensionDataRef_2;
inputs: {};
config: {};
configInput: {};
dataRefs: {
- theme: ConfigurableExtensionDataRef;
+ theme: ConfigurableExtensionDataRef_2;
};
}>;
@@ -2178,12 +2187,12 @@ export type TranslationApi = {
export const translationApiRef: ApiRef;
// @public
-export const TranslationBlueprint: ExtensionBlueprint<{
+export const TranslationBlueprint: ExtensionBlueprint_2<{
kind: 'translation';
params: {
resource: TranslationResource | TranslationMessages;
};
- output: ExtensionDataRef<
+ output: ExtensionDataRef_2<
| TranslationResource
| TranslationMessages<
string,
@@ -2199,7 +2208,7 @@ export const TranslationBlueprint: ExtensionBlueprint<{
config: {};
configInput: {};
dataRefs: {
- translation: ConfigurableExtensionDataRef<
+ translation: ConfigurableExtensionDataRef_2<
| TranslationResource
| TranslationMessages<
string,
diff --git a/packages/frontend-plugin-api/src/apis/definitions/ConfigApi.ts b/packages/frontend-plugin-api/src/apis/definitions/ConfigApi.ts
index d3bada9e46..f935dfa3af 100644
--- a/packages/frontend-plugin-api/src/apis/definitions/ConfigApi.ts
+++ b/packages/frontend-plugin-api/src/apis/definitions/ConfigApi.ts
@@ -14,7 +14,7 @@
* limitations under the License.
*/
import { ApiRef, createApiRef } from '../system';
-import { Config } from '@backstage/config';
+import type { Config } from '@backstage/config';
/**
* The Config API is used to provide a mechanism to access the
diff --git a/packages/frontend-plugin-api/src/blueprints/AppRootElementBlueprint.test.tsx b/packages/frontend-plugin-api/src/blueprints/AppRootElementBlueprint.test.tsx
index 39f03cfad4..31d7323aec 100644
--- a/packages/frontend-plugin-api/src/blueprints/AppRootElementBlueprint.test.tsx
+++ b/packages/frontend-plugin-api/src/blueprints/AppRootElementBlueprint.test.tsx
@@ -14,7 +14,19 @@
* limitations under the License.
*/
+import { screen, waitFor } from '@testing-library/react';
+import {
+ MockErrorApi,
+ TestApiProvider,
+ withLogCollector,
+} from '@backstage/test-utils';
+import { errorApiRef } from '../apis';
+import {
+ createExtensionTester,
+ renderInTestApp,
+} from '@backstage/frontend-test-utils';
import { AppRootElementBlueprint } from './AppRootElementBlueprint';
+import { ForwardedError } from '@backstage/errors';
describe('AppRootElementBlueprint', () => {
it('should create an extension with sensible defaults', () => {
@@ -46,4 +58,57 @@ describe('AppRootElementBlueprint', () => {
}
`);
});
+
+ it('should post error to errorApi and not render children when error occurs', async () => {
+ const errorApi = new MockErrorApi({ collect: true });
+ const errorMessage = 'Test error message';
+ const ErrorComponent = () => {
+ throw new Error(errorMessage);
+ };
+
+ await withLogCollector(['error'], async () => {
+ const extension = AppRootElementBlueprint.make({
+ params: {
+ element:
+ {tester.reactElement()}
+ ,
+ );
+
+ await waitFor(() => {
+ const errors = errorApi.getErrors();
+ expect(errors.length).toBeGreaterThan(0);
+ const postedError = errors[0].error;
+ expect(postedError).toBeInstanceOf(ForwardedError);
+ expect(postedError.message).toBe(
+ "Error in extension 'app-root-element:test'; caused by Error: Test error message",
+ );
+ });
+
+ expect(screen.queryByText(errorMessage)).not.toBeInTheDocument();
+ });
+ });
+
+ it('should render children when there is no error', async () => {
+ const successMessage = 'Success!';
+ const SuccessComponent = () => {successMessage};
+
+ const extension = AppRootElementBlueprint.make({
+ params: {
+ element:
+ {params.element}
+ ,
+ );
},
});
diff --git a/packages/frontend-plugin-api/src/components/ErrorApiBoundary.tsx b/packages/frontend-plugin-api/src/components/ErrorApiBoundary.tsx
new file mode 100644
index 0000000000..e195da5d0f
--- /dev/null
+++ b/packages/frontend-plugin-api/src/components/ErrorApiBoundary.tsx
@@ -0,0 +1,50 @@
+/*
+ * Copyright 2023 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { Component, ErrorInfo, ReactNode } from 'react';
+import { AppNode, ErrorApi } from '../apis';
+import { ForwardedError } from '@backstage/errors';
+
+/** @internal */
+export class ErrorApiBoundary extends Component<
+ {
+ children: ReactNode;
+ node: AppNode;
+ errorApi?: ErrorApi;
+ },
+ { error?: Error }
+> {
+ static getDerivedStateFromError(error: Error) {
+ return { error };
+ }
+
+ state = { error: undefined };
+
+ componentDidCatch(error: Error, _errorInfo: ErrorInfo) {
+ const { node, errorApi } = this.props;
+ errorApi?.post(
+ new ForwardedError(`Error in extension '${node.spec.id}'`, error),
+ );
+ }
+
+ render() {
+ if (this.state.error) {
+ return null;
+ }
+
+ return this.props.children;
+ }
+}
diff --git a/packages/frontend-plugin-api/src/components/ErrorBoundary.tsx b/packages/frontend-plugin-api/src/components/ErrorDisplayBoundary.tsx
similarity index 80%
rename from packages/frontend-plugin-api/src/components/ErrorBoundary.tsx
rename to packages/frontend-plugin-api/src/components/ErrorDisplayBoundary.tsx
index 4cde84ee93..1584f18514 100644
--- a/packages/frontend-plugin-api/src/components/ErrorBoundary.tsx
+++ b/packages/frontend-plugin-api/src/components/ErrorDisplayBoundary.tsx
@@ -14,25 +14,23 @@
* limitations under the License.
*/
-import { Component, PropsWithChildren } from 'react';
+import { Component, ReactNode } from 'react';
import { FrontendPlugin } from '../wiring';
import { ErrorDisplay } from './DefaultSwappableComponents';
-type ErrorBoundaryProps = PropsWithChildren<{
- plugin?: FrontendPlugin;
-}>;
-type ErrorBoundaryState = { error?: Error };
-
/** @internal */
-export class ErrorBoundary extends Component<
- ErrorBoundaryProps,
- ErrorBoundaryState
+export class ErrorDisplayBoundary extends Component<
+ {
+ children: ReactNode;
+ plugin: FrontendPlugin;
+ },
+ { error?: Error }
> {
static getDerivedStateFromError(error: Error) {
return { error };
}
- state: ErrorBoundaryState = { error: undefined };
+ state = { error: undefined };
handleErrorReset = () => {
this.setState({ error: undefined });
diff --git a/packages/frontend-plugin-api/src/components/ExtensionBoundary.tsx b/packages/frontend-plugin-api/src/components/ExtensionBoundary.tsx
index 421f41be56..6e4487ed9b 100644
--- a/packages/frontend-plugin-api/src/components/ExtensionBoundary.tsx
+++ b/packages/frontend-plugin-api/src/components/ExtensionBoundary.tsx
@@ -22,14 +22,23 @@ import {
lazy as reactLazy,
} from 'react';
import { AnalyticsContext, useAnalytics } from '../analytics';
-import { ErrorBoundary } from './ErrorBoundary';
+import { ErrorDisplayBoundary } from './ErrorDisplayBoundary';
+import { ErrorApiBoundary } from './ErrorApiBoundary';
// eslint-disable-next-line @backstage/no-relative-monorepo-imports
import { routableExtensionRenderedEvent } from '../../../core-plugin-api/src/analytics/Tracker';
-import { AppNode } from '../apis';
+import { AppNode, ErrorApi, errorApiRef, useApi } from '../apis';
import { coreExtensionData } from '../wiring';
import { AppNodeProvider } from './AppNodeProvider';
import { Progress } from './DefaultSwappableComponents';
+function useOptionalErrorApi(): ErrorApi | undefined {
+ try {
+ return useApi(errorApiRef);
+ } catch {
+ return undefined;
+ }
+}
+
type RouteTrackerProps = PropsWithChildren<{
enabled?: boolean;
}>;
@@ -53,6 +62,7 @@ const RouteTracker = (props: RouteTrackerProps) => {
/** @public */
export interface ExtensionBoundaryProps {
+ errorPresentation?: 'error-api' | 'error-display';
node: AppNode;
children: ReactNode;
}
@@ -61,6 +71,8 @@ export interface ExtensionBoundaryProps {
export function ExtensionBoundary(props: ExtensionBoundaryProps) {
const { node, children } = props;
+ const errorApi = useOptionalErrorApi();
+
const hasRoutePathOutput = Boolean(
node.instance?.getData(coreExtensionData.routePath),
);
@@ -70,18 +82,30 @@ export function ExtensionBoundary(props: ExtensionBoundaryProps) {
// Skipping "routeRef" attribute in the new system, the extension "id" should provide more insight
const attributes = {
extensionId: node.spec.id,
- pluginId: node.spec.plugin?.id ?? 'app',
+ pluginId: plugin.id ?? 'app',
};
+ let content = (
+
+ {children}
+
+ );
+
+ if (props.errorPresentation === 'error-api') {
+ content = (
+
+ {content}
+
+ );
+ } else {
+ content = (
+ {content}
+ );
+ }
+
return (
-
-
- {children}
-
-
-
+
);
}
diff --git a/packages/frontend-plugin-api/src/schema/createSchemaFromZod.ts b/packages/frontend-plugin-api/src/schema/createSchemaFromZod.ts
index 85f9d5c44a..b15ff980ec 100644
--- a/packages/frontend-plugin-api/src/schema/createSchemaFromZod.ts
+++ b/packages/frontend-plugin-api/src/schema/createSchemaFromZod.ts
@@ -15,7 +15,7 @@
*/
import { JsonObject } from '@backstage/types';
-import { z, ZodSchema, ZodTypeDef } from 'zod';
+import { z, type ZodSchema, type ZodTypeDef } from 'zod';
import zodToJsonSchema from 'zod-to-json-schema';
import { PortableSchema } from './types';
diff --git a/packages/frontend-plugin-api/src/wiring/createExtension.ts b/packages/frontend-plugin-api/src/wiring/createExtension.ts
index 9b55505056..6e4aba2910 100644
--- a/packages/frontend-plugin-api/src/wiring/createExtension.ts
+++ b/packages/frontend-plugin-api/src/wiring/createExtension.ts
@@ -26,7 +26,7 @@ import {
} from '@internal/frontend';
import { ExtensionDataRef, ExtensionDataValue } from './createExtensionDataRef';
import { ExtensionInput } from './createExtensionInput';
-import { z } from 'zod';
+import type { z } from 'zod';
import { createSchemaFromZod } from '../schema/createSchemaFromZod';
import { OpaqueExtensionDefinition } from '@internal/frontend';
import { ExtensionDataContainer } from './types';
diff --git a/packages/frontend-plugin-api/src/wiring/createExtensionBlueprint.ts b/packages/frontend-plugin-api/src/wiring/createExtensionBlueprint.ts
index 70b6209ae3..a7537d27e9 100644
--- a/packages/frontend-plugin-api/src/wiring/createExtensionBlueprint.ts
+++ b/packages/frontend-plugin-api/src/wiring/createExtensionBlueprint.ts
@@ -26,7 +26,7 @@ import {
ctxParamsSymbol,
VerifyExtensionAttachTo,
} from './createExtension';
-import { z } from 'zod';
+import type { z } from 'zod';
import { ExtensionInput } from './createExtensionInput';
import { ExtensionDataRef, ExtensionDataValue } from './createExtensionDataRef';
import { createExtensionDataContainer } from '@internal/frontend';
@@ -249,8 +249,8 @@ export interface ExtensionBlueprint<
},
UFactoryOutput extends ExtensionDataValue,
UNewOutput extends ExtensionDataRef,
- TExtraInputs extends { [inputName in string]: ExtensionInput },
UParentInputs extends ExtensionDataRef,
+ TExtraInputs extends { [inputName in string]: ExtensionInput } = {},
>(args: {
name?: TName;
attachTo?: ExtensionDefinitionAttachTo &
@@ -304,26 +304,30 @@ export interface ExtensionBlueprint<
UFactoryOutput
>;
}): OverridableExtensionDefinition<{
- config: (string extends keyof TExtensionConfigSchema
- ? {}
- : {
- [key in keyof TExtensionConfigSchema]: z.infer<
- ReturnType
- >;
- }) &
- T['config'];
- configInput: (string extends keyof TExtensionConfigSchema
- ? {}
- : z.input<
- z.ZodObject<{
- [key in keyof TExtensionConfigSchema]: ReturnType<
- TExtensionConfigSchema[key]
+ config: Expand<
+ (string extends keyof TExtensionConfigSchema
+ ? {}
+ : {
+ [key in keyof TExtensionConfigSchema]: z.infer<
+ ReturnType
>;
- }>
- >) &
- T['configInput'];
+ }) &
+ T['config']
+ >;
+ configInput: Expand<
+ (string extends keyof TExtensionConfigSchema
+ ? {}
+ : z.input<
+ z.ZodObject<{
+ [key in keyof TExtensionConfigSchema]: ReturnType<
+ TExtensionConfigSchema[key]
+ >;
+ }>
+ >) &
+ T['configInput']
+ >;
output: ExtensionDataRef extends UNewOutput ? T['output'] : UNewOutput;
- inputs: T['inputs'] & TExtraInputs;
+ inputs: Expand;
kind: T['kind'];
name: string | undefined extends TName ? undefined : TName;
params: T['params'];
diff --git a/packages/integration-react/report.api.md b/packages/integration-react/report.api.md
index 78da2eb5fa..0974c4821a 100644
--- a/packages/integration-react/report.api.md
+++ b/packages/integration-react/report.api.md
@@ -3,17 +3,17 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
-import { ApiFactory } from '@backstage/core-plugin-api';
+import { ApiFactory } from '@backstage/frontend-plugin-api';
import { ApiRef } from '@backstage/core-plugin-api';
import { AuthRequestOptions } from '@backstage/core-plugin-api';
-import { BackstageIdentityApi } from '@backstage/core-plugin-api';
+import { BackstageIdentityApi } from '@backstage/frontend-plugin-api';
import { Config } from '@backstage/config';
import { JSX as JSX_2 } from 'react/jsx-runtime';
import { OAuthApi } from '@backstage/core-plugin-api';
-import { OpenIdConnectApi } from '@backstage/core-plugin-api';
-import { ProfileInfoApi } from '@backstage/core-plugin-api';
+import { OpenIdConnectApi } from '@backstage/frontend-plugin-api';
+import { ProfileInfoApi } from '@backstage/frontend-plugin-api';
import { ScmIntegrationRegistry } from '@backstage/integration';
-import { SessionApi } from '@backstage/core-plugin-api';
+import { SessionApi } from '@backstage/frontend-plugin-api';
// @public
export class ScmAuth implements ScmAuthApi {
diff --git a/packages/integration/CHANGELOG.md b/packages/integration/CHANGELOG.md
index a45b3d9770..3e412d5d88 100644
--- a/packages/integration/CHANGELOG.md
+++ b/packages/integration/CHANGELOG.md
@@ -1,5 +1,14 @@
# @backstage/integration
+## 1.18.3-next.1
+
+### Patch Changes
+
+- fb029b6: Updated luxon types
+- Updated dependencies
+ - @backstage/config@1.3.6
+ - @backstage/errors@1.2.7
+
## 1.18.3-next.0
### Patch Changes
diff --git a/packages/integration/config.d.ts b/packages/integration/config.d.ts
index a601d63472..a49c4cc0d6 100644
--- a/packages/integration/config.d.ts
+++ b/packages/integration/config.d.ts
@@ -330,6 +330,10 @@ export interface Config {
* https://docs.github.com/en/rest/reference/apps#list-installations-for-the-authenticated-app--code-samples
*/
allowedInstallationOwners?: string[];
+ /**
+ * If true, then an installation token will be issued for access when no other token is available.
+ */
+ publicAccess?: boolean;
}>;
}>;
diff --git a/packages/integration/package.json b/packages/integration/package.json
index 3294a70dc5..f984c2b249 100644
--- a/packages/integration/package.json
+++ b/packages/integration/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/integration",
- "version": "1.18.3-next.0",
+ "version": "1.18.3-next.1",
"description": "Helpers for managing integrations towards external systems",
"backstage": {
"role": "common-library"
@@ -51,7 +51,6 @@
"devDependencies": {
"@backstage/cli": "workspace:^",
"@backstage/config-loader": "workspace:^",
- "@types/luxon": "^3.0.0",
"msw": "^1.0.0"
},
"configSchema": "config.d.ts"
diff --git a/packages/integration/report.api.md b/packages/integration/report.api.md
index f642058ccd..d065f441f0 100644
--- a/packages/integration/report.api.md
+++ b/packages/integration/report.api.md
@@ -665,6 +665,7 @@ export type GithubAppConfig = {
clientId: string;
clientSecret: string;
allowedInstallationOwners?: string[];
+ publicAccess?: boolean;
};
// @public
diff --git a/packages/integration/src/github/SingleInstanceGithubCredentialsProvider.test.ts b/packages/integration/src/github/SingleInstanceGithubCredentialsProvider.test.ts
index 0468e96e14..fefccf22f6 100644
--- a/packages/integration/src/github/SingleInstanceGithubCredentialsProvider.test.ts
+++ b/packages/integration/src/github/SingleInstanceGithubCredentialsProvider.test.ts
@@ -563,4 +563,330 @@ describe('SingleInstanceGithubCredentialsProvider tests', () => {
2,
);
});
+
+ describe('public access', () => {
+ it('should use an installation token when public access is enabled and owner is not in allowed list', async () => {
+ const githubProvider = SingleInstanceGithubCredentialsProvider.create({
+ host: 'github.com',
+ apps: [
+ {
+ appId: 1,
+ privateKey: 'privateKey',
+ webhookSecret: '123',
+ clientId: 'CLIENT_ID',
+ clientSecret: 'CLIENT_SECRET',
+ allowedInstallationOwners: ['other-org'],
+ publicAccess: true,
+ },
+ ],
+ });
+
+ octokit.apps.listInstallations.mockResolvedValue({
+ headers: {
+ etag: '123',
+ },
+ data: [
+ {
+ id: 1,
+ repository_selection: 'all',
+ account: {
+ login: 'other-org',
+ },
+ },
+ ],
+ } as RestEndpointMethodTypes['apps']['listInstallations']['response']);
+
+ octokit.apps.createInstallationAccessToken.mockResolvedValueOnce({
+ data: {
+ expires_at: DateTime.local().plus({ hours: 1 }).toString(),
+ token: 'public_access_token',
+ },
+ } as RestEndpointMethodTypes['apps']['createInstallationAccessToken']['response']);
+
+ const { token, headers, type } = await githubProvider.getCredentials({
+ url: 'https://github.com/some-public-org/some-repo',
+ });
+
+ expect(type).toEqual('app');
+ expect(token).toEqual('public_access_token');
+ expect(headers).toEqual({ Authorization: 'Bearer public_access_token' });
+ });
+
+ it('should use an installation token when public access is enabled and no installation exists for owner', async () => {
+ const githubProvider = SingleInstanceGithubCredentialsProvider.create({
+ host: 'github.com',
+ apps: [
+ {
+ appId: 1,
+ privateKey: 'privateKey',
+ webhookSecret: '123',
+ clientId: 'CLIENT_ID',
+ clientSecret: 'CLIENT_SECRET',
+ publicAccess: true,
+ },
+ ],
+ });
+
+ octokit.apps.listInstallations.mockResolvedValue({
+ headers: {
+ etag: '123',
+ },
+ data: [
+ {
+ id: 42,
+ repository_selection: 'all',
+ account: {
+ login: 'installed-org',
+ },
+ },
+ ],
+ } as RestEndpointMethodTypes['apps']['listInstallations']['response']);
+
+ octokit.apps.createInstallationAccessToken.mockResolvedValueOnce({
+ data: {
+ expires_at: DateTime.local().plus({ hours: 1 }).toString(),
+ token: 'public_installation_token',
+ },
+ } as RestEndpointMethodTypes['apps']['createInstallationAccessToken']['response']);
+
+ const { token, headers, type } = await githubProvider.getCredentials({
+ url: 'https://github.com/non-installed-org/some-repo',
+ });
+
+ expect(type).toEqual('app');
+ expect(token).toEqual('public_installation_token');
+ expect(headers).toEqual({
+ Authorization: 'Bearer public_installation_token',
+ });
+ });
+
+ it('should not use public access when normal installation credentials are available', async () => {
+ const githubProvider = SingleInstanceGithubCredentialsProvider.create({
+ host: 'github.com',
+ apps: [
+ {
+ appId: 1,
+ privateKey: 'privateKey',
+ webhookSecret: '123',
+ clientId: 'CLIENT_ID',
+ clientSecret: 'CLIENT_SECRET',
+ publicAccess: true,
+ },
+ ],
+ });
+
+ octokit.apps.listInstallations.mockResolvedValue({
+ headers: {
+ etag: '123',
+ },
+ data: [
+ {
+ id: 1,
+ repository_selection: 'all',
+ account: {
+ login: 'backstage',
+ },
+ },
+ ],
+ } as RestEndpointMethodTypes['apps']['listInstallations']['response']);
+
+ octokit.apps.createInstallationAccessToken.mockResolvedValueOnce({
+ data: {
+ expires_at: DateTime.local().plus({ hours: 1 }).toString(),
+ token: 'normal_token',
+ },
+ } as RestEndpointMethodTypes['apps']['createInstallationAccessToken']['response']);
+
+ const { token, type } = await githubProvider.getCredentials({
+ url: 'https://github.com/backstage/repo',
+ });
+
+ expect(type).toEqual('app');
+ expect(token).toEqual('normal_token');
+ // createInstallationAccessToken should only be called once for the normal flow
+ expect(octokit.apps.createInstallationAccessToken).toHaveBeenCalledTimes(
+ 1,
+ );
+ });
+
+ it('should fall back to configured token when public access fails', async () => {
+ const githubProvider = SingleInstanceGithubCredentialsProvider.create({
+ host: 'github.com',
+ apps: [
+ {
+ appId: 1,
+ privateKey: 'privateKey',
+ webhookSecret: '123',
+ clientId: 'CLIENT_ID',
+ clientSecret: 'CLIENT_SECRET',
+ allowedInstallationOwners: ['other-org'],
+ publicAccess: true,
+ },
+ ],
+ token: 'fallback_token',
+ });
+
+ octokit.apps.listInstallations.mockResolvedValue({
+ headers: {
+ etag: '123',
+ },
+ data: [],
+ } as unknown as RestEndpointMethodTypes['apps']['listInstallations']['response']);
+
+ const { token, type } = await githubProvider.getCredentials({
+ url: 'https://github.com/some-org/repo',
+ });
+
+ expect(type).toEqual('token');
+ expect(token).toEqual('fallback_token');
+ });
+
+ it('should return undefined when public access is disabled and no installation exists', async () => {
+ const githubProvider = SingleInstanceGithubCredentialsProvider.create({
+ host: 'github.com',
+ apps: [
+ {
+ appId: 1,
+ privateKey: 'privateKey',
+ webhookSecret: '123',
+ clientId: 'CLIENT_ID',
+ clientSecret: 'CLIENT_SECRET',
+ allowedInstallationOwners: ['other-org'],
+ // publicAccess is not set (defaults to false)
+ },
+ ],
+ });
+
+ octokit.apps.listInstallations.mockResolvedValue({
+ headers: {
+ etag: '123',
+ },
+ data: [
+ {
+ id: 1,
+ repository_selection: 'all',
+ account: {
+ login: 'other-org',
+ },
+ },
+ ],
+ } as RestEndpointMethodTypes['apps']['listInstallations']['response']);
+
+ const { token, headers } = await githubProvider.getCredentials({
+ url: 'https://github.com/some-org/repo',
+ });
+
+ expect(token).toBeUndefined();
+ expect(headers).toBeUndefined();
+ });
+
+ it('should cache public access tokens separately from regular tokens', async () => {
+ const githubProvider = SingleInstanceGithubCredentialsProvider.create({
+ host: 'github.com',
+ apps: [
+ {
+ appId: 1,
+ privateKey: 'privateKey',
+ webhookSecret: '123',
+ clientId: 'CLIENT_ID',
+ clientSecret: 'CLIENT_SECRET',
+ allowedInstallationOwners: ['installed-org'],
+ publicAccess: true,
+ },
+ ],
+ });
+
+ octokit.apps.listInstallations.mockResolvedValue({
+ headers: {
+ etag: '123',
+ },
+ data: [
+ {
+ id: 1,
+ repository_selection: 'all',
+ account: {
+ login: 'installed-org',
+ },
+ },
+ ],
+ } as RestEndpointMethodTypes['apps']['listInstallations']['response']);
+
+ octokit.apps.createInstallationAccessToken.mockResolvedValue({
+ data: {
+ expires_at: DateTime.local().plus({ hours: 1 }).toString(),
+ token: 'public_token',
+ },
+ } as RestEndpointMethodTypes['apps']['createInstallationAccessToken']['response']);
+
+ // First call for a public org
+ await githubProvider.getCredentials({
+ url: 'https://github.com/public-org/repo',
+ });
+
+ // Second call for the same public org should use cached token
+ await githubProvider.getCredentials({
+ url: 'https://github.com/public-org/repo',
+ });
+
+ // createInstallationAccessToken should only be called once due to caching
+ expect(octokit.apps.createInstallationAccessToken).toHaveBeenCalledTimes(
+ 1,
+ );
+ });
+
+ it('should use public access with multiple apps when only one has publicAccess enabled', async () => {
+ const githubProvider = SingleInstanceGithubCredentialsProvider.create({
+ host: 'github.com',
+ apps: [
+ {
+ appId: 1,
+ privateKey: 'privateKey',
+ webhookSecret: '123',
+ clientId: 'CLIENT_ID',
+ clientSecret: 'CLIENT_SECRET',
+ allowedInstallationOwners: ['org-1'],
+ // publicAccess not set, defaults to false
+ },
+ {
+ appId: 2,
+ privateKey: 'privateKey2',
+ webhookSecret: '456',
+ clientId: 'CLIENT_ID_2',
+ clientSecret: 'CLIENT_SECRET_2',
+ allowedInstallationOwners: ['org-2'],
+ publicAccess: true,
+ },
+ ],
+ });
+
+ octokit.apps.listInstallations.mockResolvedValue({
+ headers: {
+ etag: '123',
+ },
+ data: [
+ {
+ id: 1,
+ repository_selection: 'all',
+ account: {
+ login: 'org-2',
+ },
+ },
+ ],
+ } as RestEndpointMethodTypes['apps']['listInstallations']['response']);
+
+ octokit.apps.createInstallationAccessToken.mockResolvedValueOnce({
+ data: {
+ expires_at: DateTime.local().plus({ hours: 1 }).toString(),
+ token: 'public_access_from_app_2',
+ },
+ } as RestEndpointMethodTypes['apps']['createInstallationAccessToken']['response']);
+
+ const { token, type } = await githubProvider.getCredentials({
+ url: 'https://github.com/unknown-org/repo',
+ });
+
+ expect(type).toEqual('app');
+ expect(token).toEqual('public_access_from_app_2');
+ });
+ });
});
diff --git a/packages/integration/src/github/SingleInstanceGithubCredentialsProvider.ts b/packages/integration/src/github/SingleInstanceGithubCredentialsProvider.ts
index d2c1e37a65..40d166b223 100644
--- a/packages/integration/src/github/SingleInstanceGithubCredentialsProvider.ts
+++ b/packages/integration/src/github/SingleInstanceGithubCredentialsProvider.ts
@@ -100,6 +100,7 @@ class GithubAppManager {
private readonly baseAuthConfig: { appId: number; privateKey: string };
private readonly cache = new Cache();
private readonly allowedInstallationOwners: string[] | undefined; // undefined allows all installations
+ public readonly publicAccess: boolean;
constructor(config: GithubAppConfig, baseUrl?: string) {
this.allowedInstallationOwners = config.allowedInstallationOwners?.map(
@@ -116,6 +117,7 @@ class GithubAppManager {
authStrategy: createAppAuth,
auth: this.baseAuthConfig,
});
+ this.publicAccess = config.publicAccess ?? false;
}
async getInstallationCredentials(
@@ -170,6 +172,30 @@ class GithubAppManager {
});
}
+ async getPublicInstallationToken(): Promise<{ accessToken: string }> {
+ const [installation] = await this.getInstallations();
+
+ if (!installation) {
+ throw new Error(`No installation found for public app`);
+ }
+
+ return this.cache.getOrCreateToken(
+ `public:${installation.id}`,
+ undefined,
+ async () => {
+ const result = await this.appClient.apps.createInstallationAccessToken({
+ installation_id: installation.id,
+ headers: HEADERS,
+ });
+
+ return {
+ token: result.data.token,
+ expiresAt: DateTime.fromISO(result.data.expires_at),
+ };
+ },
+ );
+ }
+
getInstallations(): Promise<
RestEndpointMethodTypes['apps']['listInstallations']['response']['data']
> {
@@ -185,12 +211,14 @@ class GithubAppManager {
inst.account.login?.toLocaleLowerCase('en-US') ===
owner.toLocaleLowerCase('en-US'),
);
+
if (installation) {
return {
installationId: installation.id,
suspended: Boolean(installation.suspended_by),
};
}
+
const notFoundError = new Error(
`No app installation found for ${owner} in ${this.baseAuthConfig.appId}`,
);
@@ -245,10 +273,26 @@ export class GithubAppCredentialsMux {
const result = results.find(
resultItem => resultItem.credentials?.accessToken,
);
+
if (result) {
return result.credentials!.accessToken;
}
+ // If there was no token returned, then let's find a public access app and use an installation to get a token.
+ const publicAccessApp = this.apps.find(app => app.publicAccess);
+ if (publicAccessApp) {
+ const publicResult = await publicAccessApp
+ .getPublicInstallationToken()
+ .then(
+ credentials => ({ credentials, error: undefined }),
+ error => ({ credentials: undefined, error }),
+ );
+
+ if (publicResult.credentials?.accessToken) {
+ return publicResult.credentials.accessToken;
+ }
+ }
+
const errors = results.map(r => r.error);
const notNotFoundError = errors.find(err => err?.name !== 'NotFoundError');
if (notNotFoundError) {
diff --git a/packages/integration/src/github/config.ts b/packages/integration/src/github/config.ts
index 74a0267d62..f755b84c2a 100644
--- a/packages/integration/src/github/config.ts
+++ b/packages/integration/src/github/config.ts
@@ -109,6 +109,10 @@ export type GithubAppConfig = {
* https://docs.github.com/en/rest/reference/apps#list-installations-for-the-authenticated-app--code-samples
*/
allowedInstallationOwners?: string[];
+ /**
+ * If true, then an installation token will be issued for access when no other token is available.
+ */
+ publicAccess?: boolean;
};
/**
@@ -133,6 +137,7 @@ export function readGithubIntegrationConfig(
allowedInstallationOwners: c.getOptionalStringArray(
'allowedInstallationOwners',
),
+ publicAccess: c.getOptionalBoolean('publicAccess'),
}));
if (!isValidHost(host)) {
diff --git a/packages/repo-tools/CHANGELOG.md b/packages/repo-tools/CHANGELOG.md
index db451fee15..d9fe8257fe 100644
--- a/packages/repo-tools/CHANGELOG.md
+++ b/packages/repo-tools/CHANGELOG.md
@@ -1,5 +1,29 @@
# @backstage/repo-tools
+## 0.16.1-next.2
+
+### Patch Changes
+
+- 2bae83a: Bump `@microsoft/api-documenter` and `@microsoft/api-extractor` to latest versions.
+- 2bae83a: Bumped dev dependencies `@types/node`
+- Updated dependencies
+ - @backstage/backend-plugin-api@1.6.0-next.1
+ - @backstage/config-loader@1.10.7-next.1
+ - @backstage/cli-common@0.1.16-next.2
+ - @backstage/catalog-model@1.7.6
+ - @backstage/cli-node@0.2.16-next.1
+ - @backstage/errors@1.2.7
+
+## 0.16.1-next.1
+
+### Patch Changes
+
+- 688f070: Updated to use new utilities from `@backstage/cli-common`.
+- d1e38a7: Properly create workspace in OS temporary directory for `generate-patch` command
+- Updated dependencies
+ - @backstage/cli-node@0.2.16-next.1
+ - @backstage/cli-common@0.1.16-next.1
+
## 0.16.1-next.0
### Patch Changes
diff --git a/packages/repo-tools/package.json b/packages/repo-tools/package.json
index 4de9c4459d..95e29cb3f6 100644
--- a/packages/repo-tools/package.json
+++ b/packages/repo-tools/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/repo-tools",
- "version": "0.16.1-next.0",
+ "version": "0.16.1-next.2",
"description": "CLI for Backstage repo tooling ",
"backstage": {
"role": "cli"
@@ -51,8 +51,8 @@
"@backstage/errors": "workspace:^",
"@electric-sql/pglite": "^0.3.0",
"@manypkg/get-packages": "^1.1.3",
- "@microsoft/api-documenter": "^7.25.7",
- "@microsoft/api-extractor": "^7.47.2",
+ "@microsoft/api-documenter": "^7.28.1",
+ "@microsoft/api-extractor": "^7.55.1",
"@openapitools/openapi-generator-cli": "^2.7.0",
"@stoplight/spectral-core": "^1.18.0",
"@stoplight/spectral-formatters": "^1.1.0",
@@ -90,7 +90,7 @@
"@backstage/cli": "workspace:^",
"@backstage/types": "workspace:^",
"@types/is-glob": "^4.0.2",
- "@types/node": "^20.16.0",
+ "@types/node": "^22.13.14",
"@types/prettier": "^2.0.0",
"typedoc": "^0.28.0"
},
diff --git a/packages/repo-tools/src/commands/api-reports/api-reports/generateTypeDeclarations.ts b/packages/repo-tools/src/commands/api-reports/api-reports/generateTypeDeclarations.ts
index d7304553c0..a51c9ed17b 100644
--- a/packages/repo-tools/src/commands/api-reports/api-reports/generateTypeDeclarations.ts
+++ b/packages/repo-tools/src/commands/api-reports/api-reports/generateTypeDeclarations.ts
@@ -15,7 +15,7 @@
*/
import fs from 'fs-extra';
-import { spawnSync } from 'child_process';
+import { run, ExitCodeError } from '@backstage/cli-common';
import { paths as cliPaths } from '../../../lib/paths';
/**
@@ -30,21 +30,26 @@ import { paths as cliPaths } from '../../../lib/paths';
*/
export async function generateTypeDeclarations(tsconfigFilePath: string) {
await fs.remove(cliPaths.resolveTargetRoot('dist-types'));
- const { status } = spawnSync(
- 'yarn',
- [
- 'tsc',
- ['--project', tsconfigFilePath],
- ['--skipLibCheck', 'false'],
- ['--incremental', 'false'],
- ].flat(),
- {
- stdio: 'inherit',
- shell: true,
- cwd: cliPaths.targetRoot,
- },
- );
- if (status !== 0) {
- process.exit(status || undefined);
+ try {
+ await run(
+ [
+ 'yarn',
+ 'tsc',
+ '--project',
+ tsconfigFilePath,
+ '--skipLibCheck',
+ 'false',
+ '--incremental',
+ 'false',
+ ],
+ {
+ cwd: cliPaths.targetRoot,
+ },
+ ).waitForExit();
+ } catch (error) {
+ if (error instanceof ExitCodeError) {
+ process.exit(error.code);
+ }
+ throw error;
}
}
diff --git a/packages/repo-tools/src/commands/generate-patch/generate-patch.ts b/packages/repo-tools/src/commands/generate-patch/generate-patch.ts
index 10b31e0584..90cbe7f322 100644
--- a/packages/repo-tools/src/commands/generate-patch/generate-patch.ts
+++ b/packages/repo-tools/src/commands/generate-patch/generate-patch.ts
@@ -98,7 +98,9 @@ export default async (
throw new Error(`Could not find package ${packageArg} in source repo`);
}
- const tmpDir = await fs.mkdtemp(os.tmpdir());
+ const tmpDir = await fs.mkdtemp(
+ joinPath(os.tmpdir(), 'backstage-repo-tools-generate-patch-'),
+ );
const ctx: PatchContext = {
sourceRepo,
targetRepo,
diff --git a/packages/techdocs-cli-embedded-app/CHANGELOG.md b/packages/techdocs-cli-embedded-app/CHANGELOG.md
index eb81d1d132..63fe804a80 100644
--- a/packages/techdocs-cli-embedded-app/CHANGELOG.md
+++ b/packages/techdocs-cli-embedded-app/CHANGELOG.md
@@ -1,5 +1,35 @@
# techdocs-cli-embedded-app
+## 0.2.115-next.2
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/core-app-api@1.19.3-next.1
+ - @backstage/cli@0.35.0-next.2
+ - @backstage/plugin-techdocs@1.16.1-next.2
+ - @backstage/plugin-catalog@1.32.1-next.1
+ - @backstage/core-components@0.18.4-next.2
+ - @backstage/app-defaults@1.7.3-next.0
+ - @backstage/catalog-model@1.7.6
+ - @backstage/config@1.3.6
+ - @backstage/core-plugin-api@1.12.1-next.0
+ - @backstage/integration-react@1.2.13-next.0
+ - @backstage/test-utils@1.7.14-next.0
+ - @backstage/theme@0.7.1-next.0
+ - @backstage/ui@0.10.0-next.1
+ - @backstage/plugin-techdocs-react@1.3.6-next.0
+
+## 0.2.115-next.1
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/ui@0.10.0-next.1
+ - @backstage/core-components@0.18.4-next.1
+ - @backstage/cli@0.34.6-next.1
+ - @backstage/plugin-techdocs@1.16.1-next.1
+
## 0.2.115-next.0
### Patch Changes
diff --git a/packages/techdocs-cli-embedded-app/package.json b/packages/techdocs-cli-embedded-app/package.json
index deec921041..b0018e634f 100644
--- a/packages/techdocs-cli-embedded-app/package.json
+++ b/packages/techdocs-cli-embedded-app/package.json
@@ -1,6 +1,6 @@
{
"name": "techdocs-cli-embedded-app",
- "version": "0.2.115-next.0",
+ "version": "0.2.115-next.2",
"backstage": {
"role": "frontend"
},
diff --git a/packages/techdocs-cli/CHANGELOG.md b/packages/techdocs-cli/CHANGELOG.md
index e8d5065f9a..32d6ad189e 100644
--- a/packages/techdocs-cli/CHANGELOG.md
+++ b/packages/techdocs-cli/CHANGELOG.md
@@ -1,5 +1,25 @@
# @techdocs/cli
+## 1.10.3-next.2
+
+### Patch Changes
+
+- 2bae83a: Bumped dev dependencies `@types/node`
+- Updated dependencies
+ - @backstage/backend-defaults@0.14.0-next.1
+ - @backstage/plugin-techdocs-node@1.13.10-next.1
+ - @backstage/cli-common@0.1.16-next.2
+ - @backstage/catalog-model@1.7.6
+ - @backstage/config@1.3.6
+
+## 1.10.3-next.1
+
+### Patch Changes
+
+- 43629b1: Updated to use new utilities from `@backstage/cli-common`.
+- Updated dependencies
+ - @backstage/cli-common@0.1.16-next.1
+
## 1.10.3-next.0
### Patch Changes
diff --git a/packages/techdocs-cli/package.json b/packages/techdocs-cli/package.json
index 774969edb3..fae5187156 100644
--- a/packages/techdocs-cli/package.json
+++ b/packages/techdocs-cli/package.json
@@ -1,6 +1,6 @@
{
"name": "@techdocs/cli",
- "version": "1.10.3-next.0",
+ "version": "1.10.3-next.2",
"description": "Utility CLI for managing TechDocs sites in Backstage.",
"backstage": {
"role": "cli"
@@ -62,7 +62,7 @@
"@types/commander": "^2.12.2",
"@types/fs-extra": "^11.0.0",
"@types/http-proxy": "^1.17.4",
- "@types/node": "^20.16.0",
+ "@types/node": "^22.13.14",
"@types/serve-handler": "^6.1.0",
"@types/webpack-env": "^1.15.3",
"find-process": "^1.4.5",
diff --git a/packages/techdocs-cli/src/commands/serve/mkdocs.ts b/packages/techdocs-cli/src/commands/serve/mkdocs.ts
index 00c5e5f0ed..cd1072a88f 100644
--- a/packages/techdocs-cli/src/commands/serve/mkdocs.ts
+++ b/packages/techdocs-cli/src/commands/serve/mkdocs.ts
@@ -18,7 +18,7 @@ import { OptionValues } from 'commander';
import openBrowser from 'react-dev-utils/openBrowser';
import { createLogger } from '../../lib/utility';
import { runMkdocsServer } from '../../lib/mkdocsServer';
-import { LogFunc, waitForSignal } from '../../lib/run';
+import { RunOnOutput } from '@backstage/cli-common';
import { getMkdocsYml } from '@backstage/plugin-techdocs-node';
import fs from 'fs-extra';
import { checkIfDockerIsOperational } from './utils';
@@ -45,7 +45,7 @@ export default async function serveMkdocs(opts: OptionValues) {
// We want to open browser only once based on a log.
let boolOpenBrowserTriggered = false;
- const logFunc: LogFunc = data => {
+ const logFunc: RunOnOutput = data => {
// Sometimes the lines contain an unnecessary extra new line in between
const logLines = data.toString().split('\n');
const logPrefix = opts.docker ? '[docker/mkdocs]' : '[mkdocs]';
@@ -74,18 +74,18 @@ export default async function serveMkdocs(opts: OptionValues) {
// Had me questioning this whole implementation for half an hour.
// Commander stores --no-docker in cmd.docker variable
- const childProcess = await runMkdocsServer({
+ const childProcess = runMkdocsServer({
port: opts.port,
dockerImage: opts.dockerImage,
dockerEntrypoint: opts.dockerEntrypoint,
dockerOptions: opts.dockerOption,
useDocker: opts.docker,
- stdoutLogFunc: logFunc,
- stderrLogFunc: logFunc,
+ onStdout: logFunc,
+ onStderr: logFunc,
});
// Keep waiting for user to cancel the process
- await waitForSignal([childProcess]);
+ await childProcess.waitForExit();
if (configIsTemporary) {
process.on('exit', async () => {
diff --git a/packages/techdocs-cli/src/commands/serve/serve.ts b/packages/techdocs-cli/src/commands/serve/serve.ts
index 27f432c22d..a0d0030c6b 100644
--- a/packages/techdocs-cli/src/commands/serve/serve.ts
+++ b/packages/techdocs-cli/src/commands/serve/serve.ts
@@ -17,10 +17,9 @@
import { OptionValues } from 'commander';
import path from 'path';
import openBrowser from 'react-dev-utils/openBrowser';
-import { findPaths } from '@backstage/cli-common';
+import { findPaths, RunOnOutput } from '@backstage/cli-common';
import HTTPServer from '../../lib/httpServer';
import { runMkdocsServer } from '../../lib/mkdocsServer';
-import { LogFunc, waitForSignal } from '../../lib/run';
import { createLogger } from '../../lib/utility';
import { getMkdocsYml } from '@backstage/plugin-techdocs-node';
import fs from 'fs-extra';
@@ -83,7 +82,7 @@ export default async function serve(opts: OptionValues) {
}
let mkdocsServerHasStarted = false;
- const mkdocsLogFunc: LogFunc = data => {
+ const mkdocsLogFunc: RunOnOutput = data => {
// Sometimes the lines contain an unnecessary extra new line
const logLines = data.toString().split('\n');
const logPrefix = opts.docker ? '[docker/mkdocs]' : '[mkdocs]';
@@ -107,14 +106,14 @@ export default async function serve(opts: OptionValues) {
// https://github.com/mkdocs/mkdocs/issues/879#issuecomment-203536006
// Had me questioning this whole implementation for half an hour.
logger.info('Starting mkdocs server.');
- const mkdocsChildProcess = await runMkdocsServer({
+ const mkdocsChildProcess = runMkdocsServer({
port: opts.mkdocsPort,
dockerImage: opts.dockerImage,
dockerEntrypoint: opts.dockerEntrypoint,
dockerOptions: opts.dockerOption,
useDocker: opts.docker,
- stdoutLogFunc: mkdocsLogFunc,
- stderrLogFunc: mkdocsLogFunc,
+ onStdout: mkdocsLogFunc,
+ onStderr: mkdocsLogFunc,
mkdocsConfigFileName: mkdocsYmlPath,
mkdocsParameterClean: opts.mkdocsParameterClean,
mkdocsParameterDirtyReload: opts.mkdocsParameterDirtyreload,
@@ -161,7 +160,7 @@ export default async function serve(opts: OptionValues) {
);
});
- await waitForSignal([mkdocsChildProcess]);
+ await mkdocsChildProcess.waitForExit();
if (configIsTemporary) {
process.on('exit', async () => {
diff --git a/packages/techdocs-cli/src/commands/serve/utils.ts b/packages/techdocs-cli/src/commands/serve/utils.ts
index 2b19b0fbc0..9ecb8bc29b 100644
--- a/packages/techdocs-cli/src/commands/serve/utils.ts
+++ b/packages/techdocs-cli/src/commands/serve/utils.ts
@@ -14,25 +14,22 @@
* limitations under the License.
*/
-import { promisify } from 'util';
import * as winston from 'winston';
-import { execFile } from 'child_process';
+import { runCheck } from '@backstage/cli-common';
export async function checkIfDockerIsOperational(
logger: winston.Logger,
): Promise {
logger.info('Checking Docker status...');
- try {
- const runCheck = promisify(execFile);
- await runCheck('docker', ['info'], { shell: true });
+ const isOperational = await runCheck(['docker', 'info']);
+ if (isOperational) {
logger.info(
'Docker is up and running. Proceed to starting up mkdocs server',
);
return true;
- } catch {
- logger.error(
- 'Docker is not running. Exiting. Please check status of Docker daemon with `docker info` before re-running',
- );
- return false;
}
+ logger.error(
+ 'Docker is not running. Exiting. Please check status of Docker daemon with `docker info` before re-running',
+ );
+ return false;
}
diff --git a/packages/techdocs-cli/src/lib/mkdocsServer.test.ts b/packages/techdocs-cli/src/lib/mkdocsServer.test.ts
index 83f9c9f382..5acd1784a3 100644
--- a/packages/techdocs-cli/src/lib/mkdocsServer.test.ts
+++ b/packages/techdocs-cli/src/lib/mkdocsServer.test.ts
@@ -15,9 +15,9 @@
*/
import { runMkdocsServer } from './mkdocsServer';
-import { run } from './run';
+import { run } from '@backstage/cli-common';
-jest.mock('./run', () => {
+jest.mock('@backstage/cli-common', () => {
return {
run: jest.fn(),
};
@@ -29,12 +29,12 @@ describe('runMkdocsServer', () => {
});
describe('docker', () => {
- it('should run docker directly by default', async () => {
- await runMkdocsServer({});
+ it('should run docker directly by default', () => {
+ runMkdocsServer({});
expect(run).toHaveBeenCalledWith(
- 'docker',
expect.arrayContaining([
+ 'docker',
'run',
`${process.cwd()}:/content`,
'8000:8000',
@@ -47,26 +47,24 @@ describe('runMkdocsServer', () => {
);
});
- it('should accept port option', async () => {
- await runMkdocsServer({ port: '5678' });
+ it('should accept port option', () => {
+ runMkdocsServer({ port: '5678' });
expect(run).toHaveBeenCalledWith(
- 'docker',
- expect.arrayContaining(['5678:5678', '0.0.0.0:5678']),
+ expect.arrayContaining(['docker', '5678:5678', '0.0.0.0:5678']),
expect.objectContaining({}),
);
});
- it('should accept custom docker image', async () => {
- await runMkdocsServer({ dockerImage: 'my-org/techdocs' });
+ it('should accept custom docker image', () => {
+ runMkdocsServer({ dockerImage: 'my-org/techdocs' });
expect(run).toHaveBeenCalledWith(
- 'docker',
- expect.arrayContaining(['my-org/techdocs']),
+ expect.arrayContaining(['docker', 'my-org/techdocs']),
expect.objectContaining({}),
);
});
- it('should accept custom docker options', async () => {
- await runMkdocsServer({
+ it('should accept custom docker options', () => {
+ runMkdocsServer({
dockerOptions: [
'--add-host=internal.host:192.168.11.12',
'--name',
@@ -75,8 +73,8 @@ describe('runMkdocsServer', () => {
});
expect(run).toHaveBeenCalledWith(
- 'docker',
expect.arrayContaining([
+ 'docker',
'run',
'--rm',
'-w',
@@ -98,14 +96,14 @@ describe('runMkdocsServer', () => {
);
});
- it('should accept additinoal mkdocs CLI parameters', async () => {
- await runMkdocsServer({
+ it('should accept additinoal mkdocs CLI parameters', () => {
+ runMkdocsServer({
mkdocsParameterClean: true,
mkdocsParameterStrict: true,
});
expect(run).toHaveBeenCalledWith(
- 'docker',
expect.arrayContaining([
+ 'docker',
'serve',
'--dev-addr',
'0.0.0.0:8000',
@@ -118,21 +116,24 @@ describe('runMkdocsServer', () => {
});
describe('mkdocs', () => {
- it('should run mkdocs if specified', async () => {
- await runMkdocsServer({ useDocker: false });
+ it('should run mkdocs if specified', () => {
+ runMkdocsServer({ useDocker: false });
expect(run).toHaveBeenCalledWith(
- 'mkdocs',
- expect.arrayContaining(['serve', '--dev-addr', '127.0.0.1:8000']),
+ expect.arrayContaining([
+ 'mkdocs',
+ 'serve',
+ '--dev-addr',
+ '127.0.0.1:8000',
+ ]),
expect.objectContaining({}),
);
});
- it('should accept port option', async () => {
- await runMkdocsServer({ useDocker: false, port: '5678' });
+ it('should accept port option', () => {
+ runMkdocsServer({ useDocker: false, port: '5678' });
expect(run).toHaveBeenCalledWith(
- 'mkdocs',
- expect.arrayContaining(['127.0.0.1:5678']),
+ expect.arrayContaining(['mkdocs', '127.0.0.1:5678']),
expect.objectContaining({}),
);
});
diff --git a/packages/techdocs-cli/src/lib/mkdocsServer.ts b/packages/techdocs-cli/src/lib/mkdocsServer.ts
index a793643367..c557015256 100644
--- a/packages/techdocs-cli/src/lib/mkdocsServer.ts
+++ b/packages/techdocs-cli/src/lib/mkdocsServer.ts
@@ -14,30 +14,29 @@
* limitations under the License.
*/
-import { ChildProcess } from 'child_process';
-import { run, LogFunc } from './run';
+import { run, RunChildProcess, RunOnOutput } from '@backstage/cli-common';
-export const runMkdocsServer = async (options: {
+export const runMkdocsServer = (options: {
port?: string;
useDocker?: boolean;
dockerImage?: string;
dockerEntrypoint?: string;
dockerOptions?: string[];
- stdoutLogFunc?: LogFunc;
- stderrLogFunc?: LogFunc;
+ onStdout?: RunOnOutput;
+ onStderr?: RunOnOutput;
mkdocsConfigFileName?: string;
mkdocsParameterClean?: boolean;
mkdocsParameterDirtyReload?: boolean;
mkdocsParameterStrict?: boolean;
-}): Promise => {
+}): RunChildProcess => {
const port = options.port ?? '8000';
const useDocker = options.useDocker ?? true;
const dockerImage = options.dockerImage ?? 'spotify/techdocs';
if (useDocker) {
- return await run(
- 'docker',
+ return run(
[
+ 'docker',
'run',
'--rm',
'-w',
@@ -63,15 +62,15 @@ export const runMkdocsServer = async (options: {
...(options.mkdocsParameterStrict ? ['--strict'] : []),
],
{
- stdoutLogFunc: options.stdoutLogFunc,
- stderrLogFunc: options.stderrLogFunc,
+ onStdout: options.onStdout,
+ onStderr: options.onStderr,
},
);
}
- return await run(
- 'mkdocs',
+ return run(
[
+ 'mkdocs',
'serve',
'--dev-addr',
`127.0.0.1:${port}`,
@@ -83,8 +82,8 @@ export const runMkdocsServer = async (options: {
...(options.mkdocsParameterStrict ? ['--strict'] : []),
],
{
- stdoutLogFunc: options.stdoutLogFunc,
- stderrLogFunc: options.stderrLogFunc,
+ onStdout: options.onStdout,
+ onStderr: options.onStderr,
},
);
};
diff --git a/packages/techdocs-cli/src/lib/run.ts b/packages/techdocs-cli/src/lib/run.ts
deleted file mode 100644
index 13ac7d9d4c..0000000000
--- a/packages/techdocs-cli/src/lib/run.ts
+++ /dev/null
@@ -1,99 +0,0 @@
-/*
- * Copyright 2020 The Backstage Authors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-import { spawn, SpawnOptions, ChildProcess } from 'child_process';
-
-export type LogFunc = (data: Buffer | string) => void;
-type SpawnOptionsPartialEnv = Omit & {
- env?: Partial;
- // Pipe stdout to this log function
- stdoutLogFunc?: LogFunc;
- // Pipe stderr to this log function
- stderrLogFunc?: LogFunc;
-};
-
-// TODO: Accept log functions to pipe logs with.
-// Runs a child command, returning the child process instance.
-// Use it along with waitForSignal to run a long running process e.g. mkdocs serve
-export const run = async (
- name: string,
- args: string[] = [],
- options: SpawnOptionsPartialEnv = {},
-): Promise => {
- const { stdoutLogFunc, stderrLogFunc } = options;
-
- const env: NodeJS.ProcessEnv = {
- ...process.env,
- FORCE_COLOR: 'true',
- ...(options.env ?? {}),
- };
-
- // Refer: https://nodejs.org/api/child_process.html#child_process_subprocess_stdio
- const stdio = [
- 'inherit',
- stdoutLogFunc ? 'pipe' : 'inherit',
- stderrLogFunc ? 'pipe' : 'inherit',
- ] as ('inherit' | 'pipe')[];
-
- const childProcess = spawn(name, args, {
- stdio: stdio,
- ...options,
- env,
- });
-
- if (stdoutLogFunc && childProcess.stdout) {
- childProcess.stdout.on('data', stdoutLogFunc);
- }
- if (stderrLogFunc && childProcess.stderr) {
- childProcess.stderr.on('data', stderrLogFunc);
- }
-
- return childProcess;
-};
-
-// Block indefinitely and wait for a signal to stop the child process(es)
-// Throw error if any child process errors
-// Resolves only when all processes exit with status code 0
-export async function waitForSignal(
- childProcesses: Array,
-): Promise {
- const promises: Array> = [];
-
- for (const signal of ['SIGINT', 'SIGTERM'] as const) {
- process.on(signal, () => {
- childProcesses.forEach(childProcess => {
- childProcess.kill();
- });
- });
- }
-
- childProcesses.forEach(childProcess => {
- if (typeof childProcess.exitCode === 'number') {
- if (childProcess.exitCode) {
- throw new Error(`Non zero exit code from child process`);
- }
- return;
- }
-
- promises.push(
- new Promise((resolve, reject) => {
- childProcess.once('error', reject);
- childProcess.once('exit', resolve);
- }),
- );
- });
-
- await Promise.all(promises);
-}
diff --git a/packages/ui/CHANGELOG.md b/packages/ui/CHANGELOG.md
index d4a1de4688..9f867ba2ed 100644
--- a/packages/ui/CHANGELOG.md
+++ b/packages/ui/CHANGELOG.md
@@ -1,5 +1,57 @@
# @backstage/ui
+## 0.10.0-next.1
+
+### Minor Changes
+
+- 16543fa: **Breaking change** The `Cell` component has been refactored to be a generic wrapper component that accepts `children` for custom cell content. The text-specific functionality (previously part of `Cell`) has been moved to a new `CellText` component.
+
+ ### Migration Guide
+
+ If you were using `Cell` with text-specific props (`title`, `description`, `leadingIcon`, `href`), you need to update your code to use `CellText` instead:
+
+ **Before:**
+
+ ```tsx
+ | }
+ href="/path"
+ />
+ ```
+
+ **After:**
+
+ ```tsx
+ {/* Your custom content */} |
+ ```
+
+### Patch Changes
+
+- 50b7927: Fixed Checkbox indicator showing checkmark color when unchecked.
+
+ Affected components: Checkbox
+
+- 5bacf55: Fixed `ButtonIcon` incorrectly applying `className` to inner elements instead of only the root element.
+
+ Affected components: ButtonIcon
+
+- a20d317: Added row selection support with visual state styling for hover, selected, and pressed states. Fixed checkbox rendering to only show for multi-select toggle mode.
+
+ Affected components: Table, TableHeader, Row, Column
+
## 0.9.1-next.0
### Patch Changes
diff --git a/packages/ui/package.json b/packages/ui/package.json
index 1d5d6f945c..3ac6e991c8 100644
--- a/packages/ui/package.json
+++ b/packages/ui/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/ui",
- "version": "0.9.1-next.0",
+ "version": "0.10.0-next.1",
"backstage": {
"role": "web-library"
},
diff --git a/packages/ui/report.api.md b/packages/ui/report.api.md
index 30910724eb..0a7e289d0a 100644
--- a/packages/ui/report.api.md
+++ b/packages/ui/report.api.md
@@ -406,7 +406,16 @@ export interface CellProfileProps extends CellProps_2 {
}
// @public (undocumented)
-export interface CellProps extends CellProps_2 {
+export interface CellProps extends CellProps_2 {}
+
+// @public (undocumented)
+export const CellText: {
+ (props: CellTextProps): JSX_2.Element;
+ displayName: string;
+};
+
+// @public (undocumented)
+export interface CellTextProps extends CellProps_2 {
// (undocumented)
color?: TextColors;
// (undocumented)
@@ -863,12 +872,16 @@ export const LinkDefinition: {
// @public (undocumented)
export interface LinkProps extends LinkProps_2 {
+ // (undocumented)
+ children?: ReactNode;
// (undocumented)
color?:
| TextColors
| TextColorStatus
| Partial>;
// (undocumented)
+ title?: string;
+ // (undocumented)
truncate?: boolean;
// (undocumented)
variant?: TextVariants | Partial>;
@@ -1265,6 +1278,8 @@ export const TableDefinition: {
readonly cellProfileAvatarFallback: 'bui-TableCellProfileAvatarFallback';
readonly cellProfileName: 'bui-TableCellProfileName';
readonly cellProfileLink: 'bui-TableCellProfileLink';
+ readonly headSelection: 'bui-TableHeadSelection';
+ readonly cellSelection: 'bui-TableCellSelection';
};
};
diff --git a/packages/ui/src/components/ButtonIcon/ButtonIcon.tsx b/packages/ui/src/components/ButtonIcon/ButtonIcon.tsx
index d3596da799..9bbeca9d5b 100644
--- a/packages/ui/src/components/ButtonIcon/ButtonIcon.tsx
+++ b/packages/ui/src/components/ButtonIcon/ButtonIcon.tsx
@@ -64,7 +64,6 @@ export const ButtonIcon = forwardRef(
classNamesButtonIcon.content,
stylesButton[classNames.content],
stylesButtonIcon[classNamesButtonIcon.content],
- className,
)}
>
{icon}
@@ -79,7 +78,6 @@ export const ButtonIcon = forwardRef(
classNamesButtonIcon.spinner,
stylesButton[classNames.spinner],
stylesButtonIcon[classNamesButtonIcon.spinner],
- className,
)}
>
diff --git a/packages/ui/src/components/Checkbox/Checkbox.module.css b/packages/ui/src/components/Checkbox/Checkbox.module.css
index bc4f700bce..23a88d2b80 100644
--- a/packages/ui/src/components/Checkbox/Checkbox.module.css
+++ b/packages/ui/src/components/Checkbox/Checkbox.module.css
@@ -48,7 +48,23 @@
background-color: var(--bui-bg-surface-1);
padding: 0;
flex-shrink: 0;
- color: var(--bui-fg-solid);
+ color: transparent;
+
+ .bui-Checkbox[data-focus-visible] & {
+ transition: none;
+ outline: 2px solid var(--bui-ring);
+ outline-offset: 2px;
+ }
+
+ .bui-Checkbox[data-selected] & {
+ background-color: var(--bui-bg-solid);
+ box-shadow: none;
+ color: var(--bui-fg-solid);
+ }
+
+ .bui-Checkbox[data-hovered]:not([data-selected]) & {
+ box-shadow: inset 0 0 0 1px var(--bui-border-hover);
+ }
@media (prefers-reduced-motion: reduce) {
& {
@@ -56,19 +72,4 @@
}
}
}
-
- .bui-Checkbox[data-focus-visible] .bui-CheckboxIndicator {
- transition: none;
- outline: 2px solid var(--bui-ring);
- outline-offset: 2px;
- }
-
- .bui-Checkbox[data-selected] .bui-CheckboxIndicator {
- background-color: var(--bui-bg-solid);
- box-shadow: none;
- }
-
- .bui-Checkbox[data-hovered]:not([data-selected]) .bui-CheckboxIndicator {
- box-shadow: inset 0 0 0 1px var(--bui-border-hover);
- }
}
diff --git a/packages/ui/src/components/Link/Link.tsx b/packages/ui/src/components/Link/Link.tsx
index 56b0cae5bb..351fc15279 100644
--- a/packages/ui/src/components/Link/Link.tsx
+++ b/packages/ui/src/components/Link/Link.tsx
@@ -14,8 +14,9 @@
* limitations under the License.
*/
-import { forwardRef } from 'react';
-import { Link as AriaLink, RouterProvider } from 'react-aria-components';
+import { forwardRef, useRef } from 'react';
+import { useLink } from 'react-aria';
+import { RouterProvider } from 'react-aria-components';
import clsx from 'clsx';
import { useStyles } from '../../hooks/useStyles';
import { LinkDefinition } from './definition';
@@ -37,29 +38,57 @@ export const Link = forwardRef((props, ref) => {
},
);
- const { className, href, ...restProps } = cleanedProps;
+ const {
+ className,
+ href,
+ title,
+ children,
+ onPress,
+ variant,
+ weight,
+ color,
+ truncate,
+ slot,
+ ...restProps
+ } = cleanedProps;
const isExternal = isExternalLink(href);
+ const internalRef = useRef(null);
+ const linkRef = (ref || internalRef) as React.RefObject;
- const component = (
-
- {component}
+ {anchorElement}
);
});
diff --git a/packages/ui/src/components/Link/types.ts b/packages/ui/src/components/Link/types.ts
index 33c33b26c0..796676e593 100644
--- a/packages/ui/src/components/Link/types.ts
+++ b/packages/ui/src/components/Link/types.ts
@@ -22,6 +22,7 @@ import type {
TextWeights,
} from '../../types';
import type { LinkProps as AriaLinkProps } from 'react-aria-components';
+import type { ReactNode } from 'react';
/** @public */
export interface LinkProps extends AriaLinkProps {
@@ -32,4 +33,10 @@ export interface LinkProps extends AriaLinkProps {
| TextColorStatus
| Partial>;
truncate?: boolean;
+
+ // This is used to set the title attribute on the link
+ title?: string;
+
+ // This is used to set the children of the link
+ children?: ReactNode;
}
diff --git a/packages/ui/src/components/Table/Table.module.css b/packages/ui/src/components/Table/Table.module.css
index 3dd407f0e8..001d5b21d1 100644
--- a/packages/ui/src/components/Table/Table.module.css
+++ b/packages/ui/src/components/Table/Table.module.css
@@ -21,6 +21,7 @@
width: 100%;
caption-side: bottom;
border-collapse: collapse;
+ table-layout: fixed;
}
.bui-TableHeader {
@@ -41,6 +42,10 @@
}
}
+ .bui-TableHeadSelection {
+ width: 40px;
+ }
+
.bui-TableHeadContent {
display: flex;
flex-direction: row;
@@ -81,30 +86,48 @@
border-bottom: 1px solid var(--bui-border);
transition: color 0.2s ease-in-out;
+ &:hover {
+ background-color: var(--bui-bg-tint-hover);
+ }
+
+ &[data-selected] {
+ background-color: var(--bui-bg-tint-pressed);
+ }
+
+ &[data-pressed] {
+ background-color: var(--bui-bg-tint-pressed);
+ }
+
+ &[data-disabled] {
+ background-color: var(--bui-bg-tint-disabled);
+ }
+
&[data-react-aria-pressable='true'] {
cursor: pointer;
}
}
- .bui-TableBody .bui-TableRow:hover {
- background-color: var(--bui-gray-2);
- }
-
.bui-TableCell {
padding: var(--bui-space-3);
font-size: var(--bui-font-size-3);
+ font-family: var(--bui-font-regular);
+ font-weight: var(--bui-font-weight-regular);
+ min-width: 0;
+ overflow: hidden;
}
- .bui-TableCell {
- padding: var(--bui-space-3);
- font-size: var(--bui-font-size-3);
+ .bui-TableCellSelection {
+ width: 40px;
}
.bui-TableCellContentWrapper {
- display: inline-flex;
+ display: flex;
flex-direction: row;
align-items: center;
gap: var(--bui-space-2);
+ min-width: 0;
+ width: 100%;
+ max-width: 100%;
}
.bui-TableCellIcon,
@@ -118,6 +141,15 @@
display: flex;
flex-direction: column;
gap: var(--bui-space-0_5);
+ min-width: 0;
+ flex: 1;
+ overflow: hidden;
+ max-width: 100%;
+ }
+
+ .bui-TableCellContent > * {
+ min-width: 0;
+ max-width: 100%;
}
.bui-TableCellProfile {
diff --git a/packages/ui/src/components/Table/Table.stories.tsx b/packages/ui/src/components/Table/Table.stories.tsx
index cee7169b62..37790c5055 100644
--- a/packages/ui/src/components/Table/Table.stories.tsx
+++ b/packages/ui/src/components/Table/Table.stories.tsx
@@ -16,6 +16,7 @@
import { useState } from 'react';
import type { Meta, StoryFn, StoryObj } from '@storybook/react-vite';
+import { type Selection } from 'react-aria-components';
import {
Table,
TableHeader,
@@ -23,9 +24,12 @@ import {
TableBody,
Row,
Cell,
- CellProfile as CellProfileBUI,
+ CellText,
+ CellProfile,
useTable,
} from '.';
+import { RadioGroup, Radio } from '../RadioGroup';
+import { Flex } from '../Flex';
import { MemoryRouter } from 'react-router-dom';
import { data as data1Raw } from './mocked-data1';
import { data as data2 } from './mocked-data2';
@@ -33,6 +37,7 @@ import { data as data3 } from './mocked-data3';
import { data as data4 } from './mocked-data4';
import { RiCactusLine } from '@remixicon/react';
import { TablePagination } from '../TablePagination';
+import { Text } from '../Text';
const meta = {
title: 'Backstage UI/Table',
@@ -65,18 +70,18 @@ export const TableOnly: Story = {
{data1.map(item => (
- | }
description={item.description}
/>
- |
- |
+
))}
@@ -101,14 +106,14 @@ export const WithPaginationUncontrolled: Story = {
{data?.map(item => (
- | }
description={item.description}
/>
- |
- |
- |
+
))}
@@ -148,14 +153,14 @@ export const WithPaginationControlled: Story = {
{data?.map(item => (
- |
- |
- |
+
))}
@@ -184,18 +189,18 @@ export const Sorting: Story = {
{data1.map(item => (
- | }
description={item.description}
/>
- |
- |
+
))}
@@ -225,14 +230,14 @@ export const TableRockBand: Story = {
{data?.map(item => (
- |
- |
- |
+
))}
@@ -264,14 +269,14 @@ export const RowClick: Story = {
{data?.map(item => (
alert('Row clicked')}>
- |
- |
- |
+
))}
@@ -303,14 +308,14 @@ export const RowLink: Story = {
{data?.map(item => (
- |
- |
- |
+
))}
@@ -321,7 +326,38 @@ export const RowLink: Story = {
},
};
-export const CellText: Story = {
+export const CellComponent: Story = {
+ name: 'Cell',
+ render: () => {
+ return (
+
+
+ Name
+
+
+
+ | Hello world |
+
+
+ |
+ This is a very long text that demonstrates how the Cell component
+ handles lengthy content. It should wrap appropriately and maintain
+ proper styling even when the text extends beyond the normal cell
+ width. This helps ensure that the table remains readable and
+ visually consistent regardless of the content length.
+ |
+
+
+ | Hello world |
+
+
+
+ );
+ },
+};
+
+export const CellTextComponent: Story = {
+ name: 'CellText',
render: () => {
return (
@@ -331,10 +367,11 @@ export const CellText: Story = {
{data2.map(item => (
- |
))}
@@ -344,7 +381,8 @@ export const CellText: Story = {
},
};
-export const CellProfile: Story = {
+export const CellProfileComponent: Story = {
+ name: 'CellProfile',
render: () => {
return (
@@ -354,7 +392,7 @@ export const CellProfile: Story = {
{data3.map(item => (
- {
+ const [selectedKeys, setSelectedKeys] = useState(new Set([]));
+
+ return (
+
+
+ Name
+ Owner
+ Type
+
+
+
+
+
+
+
+
+
+
+ );
+ },
+};
+
+export const SelectionMultiToggle: Story = {
+ render: () => {
+ const [selectedKeys, setSelectedKeys] = useState(new Set([]));
+
+ return (
+
+
+ Name
+ Owner
+ Type
+
+
+
+
+
+
+
+
+
+
+ );
+ },
+};
+
+export const SelectionSingleReplace: Story = {
+ render: () => {
+ const [selectedKeys, setSelectedKeys] = useState(new Set([]));
+
+ return (
+
+
+ Name
+ Owner
+ Type
+
+
+
+
+
+
+
+
+
+
+ );
+ },
+};
+
+export const SelectionMultiReplace: Story = {
+ render: () => {
+ const [selectedKeys, setSelectedKeys] = useState(new Set([]));
+
+ return (
+
+
+ Name
+ Owner
+ Type
+
+
+
+
+
+
+
+
+
+
+ );
+ },
+};
+
+export const SelectionToggleWithActions: Story = {
+ render: () => {
+ const [selectedKeys, setSelectedKeys] = useState(new Set([]));
+
+ return (
+ alert(`Opening ${key}`)}
+ >
+
+ Name
+ Owner
+ Type
+
+
+
+
+
+
+
+
+
+
+ );
+ },
+};
+
+export const SelectionReplaceWithActions: Story = {
+ render: () => {
+ const [selectedKeys, setSelectedKeys] = useState(new Set([]));
+
+ return (
+ alert(`Opening ${key}`)}
+ >
+
+ Name
+ Owner
+ Type
+
+
+
+
+
+
+
+
+
+
+ );
+ },
+};
+
+export const SelectionToggleWithLinks: Story = {
+ render: () => {
+ const [selectedKeys, setSelectedKeys] = useState(new Set([]));
+
+ return (
+
+
+ Name
+ Owner
+ Type
+
+
+
+
+
+
+
+
+
+
+ );
+ },
+};
+
+export const SelectionReplaceWithLinks: Story = {
+ render: () => {
+ const [selectedKeys, setSelectedKeys] = useState(new Set([]));
+
+ return (
+
+
+ Name
+ Owner
+ Type
+
+
+
+
+
+
+
+
+
+
+ );
+ },
+};
+
+export const SelectionWithDisabledRows: Story = {
+ render: () => {
+ const [selectedKeys, setSelectedKeys] = useState(new Set([]));
+
+ return (
+
+
+ Name
+ Owner
+ Type
+
+
+
+
+
+
+
+
+
+
+ );
+ },
+};
+
+export const SelectionWithPagination: Story = {
+ render: () => {
+ const [selectedKeys, setSelectedKeys] = useState(new Set([]));
+
+ const { data, paginationProps } = useTable({
+ data: data1,
+ pagination: {
+ defaultPageSize: 5,
+ },
+ });
+
+ return (
+ <>
+
+
+ Name
+ Owner
+ Type
+
+
+ {data?.map(item => (
+
+
+ ))}
+
+
+ (new Set([]));
+
+ return (
+
+
+
+ Name
+ Owner
+ Type
+
+
+
+
+
+
+
+
+
+
+
+
+ Selection mode:
+
+ {
+ setSelectionMode(value as 'single' | 'multiple');
+ setSelectedKeys(new Set([]));
+ }}
+ >
+ single
+ multiple
+
+
+
+ );
+ },
+};
+
+export const SelectionBehaviorPlayground: Story = {
+ render: () => {
+ const [selectionBehavior, setSelectionBehavior] = useState<
+ 'toggle' | 'replace'
+ >('toggle');
+ const [selectedKeys, setSelectedKeys] = useState(new Set([]));
+
+ return (
+
+
+
+ Name
+ Owner
+ Type
+
+
+
+
+
+
+
+
+
+
+
+
+ Selection behavior:
+
+ {
+ setSelectionBehavior(value as 'toggle' | 'replace');
+ setSelectedKeys(new Set([]));
+ }}
+ >
+ toggle
+ replace
+
+
+
+ );
+ },
+};
diff --git a/packages/ui/src/components/Table/components/Cell.tsx b/packages/ui/src/components/Table/components/Cell.tsx
index 65be8482a7..809b224a07 100644
--- a/packages/ui/src/components/Table/components/Cell.tsx
+++ b/packages/ui/src/components/Table/components/Cell.tsx
@@ -15,8 +15,6 @@
*/
import clsx from 'clsx';
-import { Text } from '../../Text';
-import { Link } from '../../Link';
import { Cell as ReactAriaCell } from 'react-aria-components';
import type { CellProps } from '../types';
import { useStyles } from '../../../hooks/useStyles';
@@ -29,49 +27,14 @@ const Cell = (props: CellProps) => {
color: 'primary' as const,
...props,
});
- const { className, title, description, color, leadingIcon, href, ...rest } =
- cleanedProps;
+ const { className, children, ...rest } = cleanedProps;
return (
-
- {leadingIcon && (
-
- {leadingIcon}
-
- )}
-
- {href ? (
-
- {title}
-
- ) : (
-
- {title}
-
- )}
- {description && (
-
- {description}
-
- )}
-
-
+ {children}
);
};
diff --git a/packages/ui/src/components/Table/components/CellText.tsx b/packages/ui/src/components/Table/components/CellText.tsx
new file mode 100644
index 0000000000..8855c92e80
--- /dev/null
+++ b/packages/ui/src/components/Table/components/CellText.tsx
@@ -0,0 +1,98 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import clsx from 'clsx';
+import { Text } from '../../Text';
+import { Link } from '../../Link';
+import { Cell as ReactAriaCell } from 'react-aria-components';
+import type { CellTextProps } from '../types';
+import { useStyles } from '../../../hooks/useStyles';
+import { TableDefinition } from '../definition';
+import styles from '../Table.module.css';
+
+/** @public */
+const CellText = (props: CellTextProps) => {
+ const { classNames, cleanedProps } = useStyles(TableDefinition, {
+ color: 'primary' as const,
+ ...props,
+ });
+ const { className, title, description, color, leadingIcon, href, ...rest } =
+ cleanedProps;
+
+ return (
+
+
+ {leadingIcon && (
+
+ {leadingIcon}
+
+ )}
+
+ {href ? (
+
+ {title}
+
+ ) : (
+
+ {title}
+
+ )}
+ {description && (
+
+ {description}
+
+ )}
+
+
+
+ );
+};
+
+CellText.displayName = 'CellText';
+
+export { CellText };
diff --git a/packages/ui/src/components/Table/components/Column.tsx b/packages/ui/src/components/Table/components/Column.tsx
index 78c45f6a3c..9076ec8557 100644
--- a/packages/ui/src/components/Table/components/Column.tsx
+++ b/packages/ui/src/components/Table/components/Column.tsx
@@ -25,11 +25,11 @@ import { RiArrowUpLine, RiArrowDownLine } from '@remixicon/react';
/** @public */
export const Column = (props: ColumnProps) => {
const { classNames, cleanedProps } = useStyles(TableDefinition, props);
- const { children, ...rest } = cleanedProps;
+ const { className, children, ...rest } = cleanedProps;
return (
{({ allowsSorting, sortDirection }) => (
diff --git a/packages/ui/src/components/Table/components/Row.tsx b/packages/ui/src/components/Table/components/Row.tsx
index 0b09c157ab..e08649c63b 100644
--- a/packages/ui/src/components/Table/components/Row.tsx
+++ b/packages/ui/src/components/Table/components/Row.tsx
@@ -18,11 +18,11 @@ import {
Row as ReactAriaRow,
RowProps,
useTableOptions,
- Cell,
+ Cell as ReactAriaCell,
Collection,
- Checkbox,
RouterProvider,
} from 'react-aria-components';
+import { Checkbox } from '../../Checkbox';
import { useStyles } from '../../../hooks/useStyles';
import { TableDefinition } from '../definition';
import { useNavigate } from 'react-router-dom';
@@ -30,6 +30,7 @@ import { useHref } from 'react-router-dom';
import { isExternalLink } from '../../../utils/isExternalLink';
import styles from '../Table.module.css';
import clsx from 'clsx';
+import { Flex } from '../../Flex';
/** @public */
export function Row(props: RowProps) {
@@ -38,14 +39,23 @@ export function Row(props: RowProps) {
const navigate = useNavigate();
const isExternal = isExternalLink(href);
- let { selectionBehavior } = useTableOptions();
+ let { selectionBehavior, selectionMode } = useTableOptions();
const content = (
<>
- {selectionBehavior === 'toggle' && (
-
- |
+ {selectionBehavior === 'toggle' && selectionMode === 'multiple' && (
+
+
+
+ <>
+
+
+
)}
{children}
diff --git a/packages/ui/src/components/Table/components/TableHeader.tsx b/packages/ui/src/components/Table/components/TableHeader.tsx
index d8eea45271..28146b098a 100644
--- a/packages/ui/src/components/Table/components/TableHeader.tsx
+++ b/packages/ui/src/components/Table/components/TableHeader.tsx
@@ -17,18 +17,20 @@
import {
TableHeader as ReactAriaTableHeader,
type TableHeaderProps,
- Checkbox,
+ Collection,
+ useTableOptions,
} from 'react-aria-components';
-import { Collection, useTableOptions } from 'react-aria-components';
+import { Checkbox } from '../../Checkbox';
import { Column } from './Column';
import { useStyles } from '../../../hooks/useStyles';
import { TableDefinition } from '../definition';
import styles from '../Table.module.css';
import clsx from 'clsx';
+import { Flex } from '../../Flex';
/** @public */
export const TableHeader = (props: TableHeaderProps) => {
- let { selectionBehavior, selectionMode, allowsDragging } = useTableOptions();
+ let { selectionBehavior, selectionMode } = useTableOptions();
const { classNames, cleanedProps } = useStyles(TableDefinition, props);
const { columns, children, ...rest } = cleanedProps;
@@ -38,11 +40,21 @@ export const TableHeader = (props: TableHeaderProps) => {
className={clsx(classNames.header, styles[classNames.header])}
{...rest}
>
- {/* Add extra columns for drag and drop and selection. */}
- {allowsDragging &&
- {selectionMode === 'multiple' &&
+
+
+ <>
+
+
)}
{children}
diff --git a/packages/ui/src/components/Table/definition.ts b/packages/ui/src/components/Table/definition.ts
index 8ec9dfb1f0..313604902c 100644
--- a/packages/ui/src/components/Table/definition.ts
+++ b/packages/ui/src/components/Table/definition.ts
@@ -39,5 +39,7 @@ export const TableDefinition = {
cellProfileAvatarFallback: 'bui-TableCellProfileAvatarFallback',
cellProfileName: 'bui-TableCellProfileName',
cellProfileLink: 'bui-TableCellProfileLink',
+ headSelection: 'bui-TableHeadSelection',
+ cellSelection: 'bui-TableCellSelection',
},
} as const satisfies ComponentDefinition;
diff --git a/packages/ui/src/components/Table/index.ts b/packages/ui/src/components/Table/index.ts
index 8d6603ee00..42ba6ff9c9 100644
--- a/packages/ui/src/components/Table/index.ts
+++ b/packages/ui/src/components/Table/index.ts
@@ -20,10 +20,16 @@ export { TableBody } from './components/TableBody';
export { Column } from './components/Column';
export { Row } from './components/Row';
export { Cell } from './components/Cell';
+export { CellText } from './components/CellText';
export { CellProfile } from './components/CellProfile';
export { useTable } from './hooks/useTable';
-export type { CellProps, CellProfileProps, ColumnProps } from './types';
+export type {
+ CellProps,
+ CellTextProps,
+ CellProfileProps,
+ ColumnProps,
+} from './types';
export type {
UseTableConfig,
UseTableResult,
diff --git a/packages/ui/src/components/Table/mocked-data2.ts b/packages/ui/src/components/Table/mocked-data2.ts
index 30ca36a689..0aff7bcd98 100644
--- a/packages/ui/src/components/Table/mocked-data2.ts
+++ b/packages/ui/src/components/Table/mocked-data2.ts
@@ -21,6 +21,7 @@ export interface DataProps {
name: string;
description?: string;
icon?: React.ReactNode;
+ href?: string;
}
export const data: DataProps[] = [
@@ -43,4 +44,44 @@ export const data: DataProps[] = [
'A comprehensive service handling user authentication and role-based access control across all applications.',
icon: createElement(RiCactusLine),
},
+ {
+ icon: createElement(RiCactusLine),
+ name: 'Cell with extremely long title that demonstrates text wrapping behavior and how the component handles content that extends well beyond typical cell widths in table layouts',
+ description:
+ 'This is a comprehensive and detailed description that contains a substantial amount of text to demonstrate how the CellText component handles lengthy content. It includes multiple sentences and covers various aspects of the service or component being described. The text should wrap appropriately within the cell boundaries while maintaining readability and proper spacing. This example helps ensure that the table remains visually consistent and user-friendly even when dealing with extensive content that might otherwise break the layout or cause accessibility issues. The component should gracefully handle such scenarios by providing appropriate text wrapping, maintaining proper line heights, and ensuring that all content remains accessible and readable regardless of its length.',
+ },
+ {
+ name: 'Cell with title and URL',
+ href: '/catalog/default/service/auth-service',
+ },
+ {
+ name: 'Cell with title, description and URL',
+ description:
+ 'A comprehensive service handling user authentication and role-based access control across all applications.',
+ href: '/catalog/default/service/auth-service',
+ },
+ {
+ name: 'Cell with title, icon and URL',
+ icon: createElement(RiCactusLine),
+ href: '/catalog/default/service/auth-service',
+ },
+ {
+ name: 'Cell with title, description, icon and URL',
+ description:
+ 'A comprehensive service handling user authentication and role-based access control across all applications.',
+ icon: createElement(RiCactusLine),
+ href: '/catalog/default/service/auth-service',
+ },
+ {
+ icon: createElement(RiCactusLine),
+ name: 'Cell with extremely long title that demonstrates text wrapping behavior and how the component handles content that extends well beyond typical cell widths in table layouts',
+ description:
+ 'This is a comprehensive and detailed description that contains a substantial amount of text to demonstrate how the CellText component handles lengthy content. It includes multiple sentences and covers various aspects of the service or component being described. The text should wrap appropriately within the cell boundaries while maintaining readability and proper spacing. This example helps ensure that the table remains visually consistent and user-friendly even when dealing with extensive content that might otherwise break the layout or cause accessibility issues. The component should gracefully handle such scenarios by providing appropriate text wrapping, maintaining proper line heights, and ensuring that all content remains accessible and readable regardless of its length.',
+ href: '/catalog/default/service/auth-service',
+ },
+ {
+ name: 'External link example',
+ description: 'This is an external link that opens in a new tab',
+ href: 'https://backstage.io',
+ },
];
diff --git a/packages/ui/src/components/Table/types.ts b/packages/ui/src/components/Table/types.ts
index be9e860a0c..1ac477e3ff 100644
--- a/packages/ui/src/components/Table/types.ts
+++ b/packages/ui/src/components/Table/types.ts
@@ -21,7 +21,10 @@ import {
import type { TextColors } from '../../types';
/** @public */
-export interface CellProps extends ReactAriaCellProps {
+export interface CellProps extends ReactAriaCellProps {}
+
+/** @public */
+export interface CellTextProps extends ReactAriaCellProps {
title: string;
description?: string;
color?: TextColors;
diff --git a/plugins/api-docs/CHANGELOG.md b/plugins/api-docs/CHANGELOG.md
index 7db04d494c..a5b01fb068 100644
--- a/plugins/api-docs/CHANGELOG.md
+++ b/plugins/api-docs/CHANGELOG.md
@@ -1,5 +1,20 @@
# @backstage/plugin-api-docs
+## 0.13.2-next.1
+
+### Patch Changes
+
+- f3f84f1: Minor extension type updates after frontend API bump
+- Updated dependencies
+ - @backstage/plugin-catalog@1.32.1-next.1
+ - @backstage/frontend-plugin-api@0.13.2-next.1
+ - @backstage/plugin-catalog-react@1.21.4-next.2
+ - @backstage/core-components@0.18.4-next.2
+ - @backstage/catalog-model@1.7.6
+ - @backstage/core-plugin-api@1.12.1-next.0
+ - @backstage/plugin-catalog-common@1.1.7
+ - @backstage/plugin-permission-react@0.4.39-next.0
+
## 0.13.2-next.0
### Patch Changes
diff --git a/plugins/api-docs/package.json b/plugins/api-docs/package.json
index e8f7392e87..225e329d36 100644
--- a/plugins/api-docs/package.json
+++ b/plugins/api-docs/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-api-docs",
- "version": "0.13.2-next.0",
+ "version": "0.13.2-next.1",
"description": "A Backstage plugin that helps represent API entities in the frontend",
"backstage": {
"role": "frontend-plugin",
diff --git a/plugins/api-docs/report-alpha.api.md b/plugins/api-docs/report-alpha.api.md
index 3e8b0153d8..1a035bc706 100644
--- a/plugins/api-docs/report-alpha.api.md
+++ b/plugins/api-docs/report-alpha.api.md
@@ -12,7 +12,6 @@ import { EntityCardType } from '@backstage/plugin-catalog-react/alpha';
import { EntityPredicate } from '@backstage/plugin-catalog-react/alpha';
import { ExtensionBlueprintParams } from '@backstage/frontend-plugin-api';
import { ExtensionDataRef } from '@backstage/frontend-plugin-api';
-import { ExtensionInput } from '@backstage/frontend-plugin-api';
import { ExternalRouteRef } from '@backstage/core-plugin-api';
import { IconComponent } from '@backstage/frontend-plugin-api';
import { JSX as JSX_2 } from 'react';
@@ -472,12 +471,10 @@ const _default: OverridableFrontendPlugin<
'page:api-docs': OverridableExtensionDefinition<{
config: {
initiallySelectedFilter: 'all' | 'owned' | 'starred' | undefined;
- } & {
path: string | undefined;
};
configInput: {
initiallySelectedFilter?: 'all' | 'owned' | 'starred' | undefined;
- } & {
path?: string | undefined;
};
output:
@@ -490,15 +487,7 @@ const _default: OverridableFrontendPlugin<
optional: true;
}
>;
- inputs: {
- [x: string]: ExtensionInput<
- ExtensionDataRef,
- {
- singleton: boolean;
- optional: boolean;
- }
- >;
- };
+ inputs: {};
kind: 'page';
name: undefined;
params: {
diff --git a/plugins/api-docs/report.api.md b/plugins/api-docs/report.api.md
index fb37b2b33b..5c84544319 100644
--- a/plugins/api-docs/report.api.md
+++ b/plugins/api-docs/report.api.md
@@ -4,7 +4,7 @@
```ts
import { ApiEntity } from '@backstage/catalog-model';
-import { ApiRef } from '@backstage/core-plugin-api';
+import { ApiRef } from '@backstage/frontend-plugin-api';
import { BackstagePlugin } from '@backstage/core-plugin-api';
import { CatalogTableRow } from '@backstage/plugin-catalog';
import { ComponentEntity } from '@backstage/catalog-model';
diff --git a/plugins/app-backend/CHANGELOG.md b/plugins/app-backend/CHANGELOG.md
index c28c59c78c..f4df39b170 100644
--- a/plugins/app-backend/CHANGELOG.md
+++ b/plugins/app-backend/CHANGELOG.md
@@ -1,5 +1,19 @@
# @backstage/plugin-app-backend
+## 0.5.9-next.1
+
+### Patch Changes
+
+- de96a60: chore(deps): bump `express` from 4.21.2 to 4.22.0
+- Updated dependencies
+ - @backstage/plugin-app-node@0.1.40-next.1
+ - @backstage/plugin-auth-node@0.6.10-next.1
+ - @backstage/backend-plugin-api@1.6.0-next.1
+ - @backstage/config-loader@1.10.7-next.1
+ - @backstage/config@1.3.6
+ - @backstage/errors@1.2.7
+ - @backstage/types@1.2.2
+
## 0.5.9-next.0
### Patch Changes
diff --git a/plugins/app-backend/package.json b/plugins/app-backend/package.json
index d15f004c81..d30770d3c3 100644
--- a/plugins/app-backend/package.json
+++ b/plugins/app-backend/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-app-backend",
- "version": "0.5.9-next.0",
+ "version": "0.5.9-next.1",
"description": "A Backstage backend plugin that serves the Backstage frontend app",
"backstage": {
"role": "backend-plugin",
@@ -60,7 +60,7 @@
"@backstage/plugin-app-node": "workspace:^",
"@backstage/plugin-auth-node": "workspace:^",
"@backstage/types": "workspace:^",
- "express": "^4.17.1",
+ "express": "^4.22.0",
"express-promise-router": "^4.1.0",
"fs-extra": "^11.2.0",
"globby": "^11.0.0",
diff --git a/plugins/app-node/CHANGELOG.md b/plugins/app-node/CHANGELOG.md
index 1f1f124d16..3971b0ed54 100644
--- a/plugins/app-node/CHANGELOG.md
+++ b/plugins/app-node/CHANGELOG.md
@@ -1,5 +1,14 @@
# @backstage/plugin-app-node
+## 0.1.40-next.1
+
+### Patch Changes
+
+- de96a60: chore(deps): bump `express` from 4.21.2 to 4.22.0
+- Updated dependencies
+ - @backstage/backend-plugin-api@1.6.0-next.1
+ - @backstage/config-loader@1.10.7-next.1
+
## 0.1.40-next.0
### Patch Changes
diff --git a/plugins/app-node/package.json b/plugins/app-node/package.json
index 87b8e2b5d5..1583d90e57 100644
--- a/plugins/app-node/package.json
+++ b/plugins/app-node/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-app-node",
- "version": "0.1.40-next.0",
+ "version": "0.1.40-next.1",
"description": "Node.js library for the app plugin",
"backstage": {
"role": "node-library",
@@ -39,7 +39,7 @@
"@backstage/backend-plugin-api": "workspace:^",
"@backstage/config-loader": "workspace:^",
"@types/express": "^4.17.6",
- "express": "^4.17.1",
+ "express": "^4.22.0",
"fs-extra": "^11.2.0"
},
"devDependencies": {
diff --git a/plugins/app-visualizer/CHANGELOG.md b/plugins/app-visualizer/CHANGELOG.md
index bba37c8351..d04d2461ba 100644
--- a/plugins/app-visualizer/CHANGELOG.md
+++ b/plugins/app-visualizer/CHANGELOG.md
@@ -1,5 +1,13 @@
# @backstage/plugin-app-visualizer
+## 0.1.26-next.1
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/ui@0.10.0-next.1
+ - @backstage/core-components@0.18.4-next.1
+
## 0.1.26-next.0
### Patch Changes
diff --git a/plugins/app-visualizer/package.json b/plugins/app-visualizer/package.json
index dcc38047bb..8b580ea17b 100644
--- a/plugins/app-visualizer/package.json
+++ b/plugins/app-visualizer/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-app-visualizer",
- "version": "0.1.26-next.0",
+ "version": "0.1.26-next.1",
"description": "Visualizes the Backstage app structure",
"backstage": {
"role": "frontend-plugin",
diff --git a/plugins/app/CHANGELOG.md b/plugins/app/CHANGELOG.md
index 0e84389ecd..351479a54f 100644
--- a/plugins/app/CHANGELOG.md
+++ b/plugins/app/CHANGELOG.md
@@ -1,5 +1,21 @@
# @backstage/plugin-app
+## 0.3.3-next.1
+
+### Patch Changes
+
+- f3f84f1: Minor extension type updates after frontend API bump
+- f7bc228: Support to set `defaultLanguage` and `availableLanguages` for the app language API in the new frontend system
+- Updated dependencies
+ - @backstage/frontend-plugin-api@0.13.2-next.1
+ - @backstage/core-components@0.18.4-next.2
+ - @backstage/core-plugin-api@1.12.1-next.0
+ - @backstage/integration-react@1.2.13-next.0
+ - @backstage/theme@0.7.1-next.0
+ - @backstage/types@1.2.2
+ - @backstage/version-bridge@1.0.11
+ - @backstage/plugin-permission-react@0.4.39-next.0
+
## 0.3.3-next.0
### Patch Changes
diff --git a/plugins/app/package.json b/plugins/app/package.json
index 8a87cae63e..a531c5b450 100644
--- a/plugins/app/package.json
+++ b/plugins/app/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-app",
- "version": "0.3.3-next.0",
+ "version": "0.3.3-next.1",
"backstage": {
"role": "frontend-plugin",
"pluginId": "app",
diff --git a/plugins/app/report.api.md b/plugins/app/report.api.md
index 313d09cfee..ea34a1731f 100644
--- a/plugins/app/report.api.md
+++ b/plugins/app/report.api.md
@@ -232,12 +232,18 @@ const appPlugin: OverridableFrontendPlugin<
) => ExtensionBlueprintParams;
}>;
'api:app/app-language': OverridableExtensionDefinition<{
- kind: 'api';
- name: 'app-language';
- config: {};
- configInput: {};
+ config: {
+ defaultLanguage: string | undefined;
+ availableLanguages: string[] | undefined;
+ };
+ configInput: {
+ defaultLanguage?: string | undefined;
+ availableLanguages?: string[] | undefined;
+ };
output: ExtensionDataRef;
inputs: {};
+ kind: 'api';
+ name: 'app-language';
params: <
TApi,
TImpl extends TApi,
@@ -712,15 +718,7 @@ const appPlugin: OverridableFrontendPlugin<
transientTimeoutMs?: number | undefined;
};
output: ExtensionDataRef;
- inputs: {
- [x: string]: ExtensionInput<
- ExtensionDataRef,
- {
- singleton: boolean;
- optional: boolean;
- }
- >;
- };
+ inputs: {};
kind: 'app-root-element';
name: 'alert-display';
params: {
@@ -731,15 +729,7 @@ const appPlugin: OverridableFrontendPlugin<
config: {};
configInput: {};
output: ExtensionDataRef;
- inputs: {
- [x: string]: ExtensionInput<
- ExtensionDataRef,
- {
- singleton: boolean;
- optional: boolean;
- }
- >;
- };
+ inputs: {};
kind: 'app-root-element';
name: 'dialog-display';
params: {
diff --git a/plugins/app/src/extensions/AppLanguageApi.ts b/plugins/app/src/extensions/AppLanguageApi.ts
index 325dffa2fd..4f605aa30f 100644
--- a/plugins/app/src/extensions/AppLanguageApi.ts
+++ b/plugins/app/src/extensions/AppLanguageApi.ts
@@ -19,12 +19,25 @@ import { AppLanguageSelector } from '../../../../packages/core-app-api/src/apis/
import { appLanguageApiRef } from '@backstage/core-plugin-api/alpha';
import { ApiBlueprint } from '@backstage/frontend-plugin-api';
-export const AppLanguageApi = ApiBlueprint.make({
+export const AppLanguageApi = ApiBlueprint.makeWithOverrides({
name: 'app-language',
- params: defineParams =>
- defineParams({
- api: appLanguageApiRef,
- deps: {},
- factory: () => AppLanguageSelector.createWithStorage(),
- }),
+ config: {
+ schema: {
+ defaultLanguage: z => z.string().optional(),
+ availableLanguages: z => z.array(z.string()).optional(),
+ },
+ },
+ factory(originalFactory, { config }) {
+ return originalFactory(defineParams =>
+ defineParams({
+ api: appLanguageApiRef,
+ deps: {},
+ factory: () =>
+ AppLanguageSelector.createWithStorage({
+ defaultLanguage: config.defaultLanguage,
+ availableLanguages: config.availableLanguages,
+ }),
+ }),
+ );
+ },
});
diff --git a/plugins/auth-backend-module-atlassian-provider/CHANGELOG.md b/plugins/auth-backend-module-atlassian-provider/CHANGELOG.md
index 29cb492841..ec89692a85 100644
--- a/plugins/auth-backend-module-atlassian-provider/CHANGELOG.md
+++ b/plugins/auth-backend-module-atlassian-provider/CHANGELOG.md
@@ -1,5 +1,14 @@
# @backstage/plugin-auth-backend-module-atlassian-provider
+## 0.4.10-next.1
+
+### Patch Changes
+
+- de96a60: chore(deps): bump `express` from 4.21.2 to 4.22.0
+- Updated dependencies
+ - @backstage/plugin-auth-node@0.6.10-next.1
+ - @backstage/backend-plugin-api@1.6.0-next.1
+
## 0.4.10-next.0
### Patch Changes
diff --git a/plugins/auth-backend-module-atlassian-provider/package.json b/plugins/auth-backend-module-atlassian-provider/package.json
index d1355886bd..d22ebf0b1a 100644
--- a/plugins/auth-backend-module-atlassian-provider/package.json
+++ b/plugins/auth-backend-module-atlassian-provider/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-auth-backend-module-atlassian-provider",
- "version": "0.4.10-next.0",
+ "version": "0.4.10-next.1",
"description": "The atlassian-provider backend module for the auth plugin.",
"backstage": {
"role": "backend-plugin-module",
@@ -36,7 +36,7 @@
"dependencies": {
"@backstage/backend-plugin-api": "workspace:^",
"@backstage/plugin-auth-node": "workspace:^",
- "express": "^4.18.2",
+ "express": "^4.22.0",
"passport": "^0.7.0",
"passport-atlassian-oauth2": "^2.1.0",
"zod": "^3.22.4"
diff --git a/plugins/auth-backend-module-auth0-provider/CHANGELOG.md b/plugins/auth-backend-module-auth0-provider/CHANGELOG.md
index 9e73851696..7e3db38938 100644
--- a/plugins/auth-backend-module-auth0-provider/CHANGELOG.md
+++ b/plugins/auth-backend-module-auth0-provider/CHANGELOG.md
@@ -1,5 +1,14 @@
# @backstage/plugin-auth-backend-module-auth0-provider
+## 0.2.10-next.1
+
+### Patch Changes
+
+- de96a60: chore(deps): bump `express` from 4.21.2 to 4.22.0
+- Updated dependencies
+ - @backstage/plugin-auth-node@0.6.10-next.1
+ - @backstage/backend-plugin-api@1.6.0-next.1
+
## 0.2.10-next.0
### Patch Changes
diff --git a/plugins/auth-backend-module-auth0-provider/package.json b/plugins/auth-backend-module-auth0-provider/package.json
index 0e65d6b255..6e9293d944 100644
--- a/plugins/auth-backend-module-auth0-provider/package.json
+++ b/plugins/auth-backend-module-auth0-provider/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-auth-backend-module-auth0-provider",
- "version": "0.2.10-next.0",
+ "version": "0.2.10-next.1",
"description": "The auth0-provider backend module for the auth plugin.",
"backstage": {
"role": "backend-plugin-module",
@@ -36,7 +36,7 @@
"dependencies": {
"@backstage/backend-plugin-api": "workspace:^",
"@backstage/plugin-auth-node": "workspace:^",
- "express": "^4.17.1",
+ "express": "^4.22.0",
"passport-auth0": "^1.4.3",
"passport-oauth2": "^1.6.1"
},
diff --git a/plugins/auth-backend-module-aws-alb-provider/CHANGELOG.md b/plugins/auth-backend-module-aws-alb-provider/CHANGELOG.md
index afea70a08b..6207a3cfbf 100644
--- a/plugins/auth-backend-module-aws-alb-provider/CHANGELOG.md
+++ b/plugins/auth-backend-module-aws-alb-provider/CHANGELOG.md
@@ -1,5 +1,16 @@
# @backstage/plugin-auth-backend-module-aws-alb-provider
+## 0.4.10-next.1
+
+### Patch Changes
+
+- de96a60: chore(deps): bump `express` from 4.21.2 to 4.22.0
+- Updated dependencies
+ - @backstage/plugin-auth-backend@0.25.7-next.1
+ - @backstage/plugin-auth-node@0.6.10-next.1
+ - @backstage/backend-plugin-api@1.6.0-next.1
+ - @backstage/errors@1.2.7
+
## 0.4.10-next.0
### Patch Changes
diff --git a/plugins/auth-backend-module-aws-alb-provider/package.json b/plugins/auth-backend-module-aws-alb-provider/package.json
index 25e308ec4a..48dee6b124 100644
--- a/plugins/auth-backend-module-aws-alb-provider/package.json
+++ b/plugins/auth-backend-module-aws-alb-provider/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-auth-backend-module-aws-alb-provider",
- "version": "0.4.10-next.0",
+ "version": "0.4.10-next.1",
"description": "The aws-alb provider module for the Backstage auth backend.",
"backstage": {
"role": "backend-plugin-module",
@@ -50,7 +50,7 @@
"@backstage/cli": "workspace:^",
"@backstage/config": "workspace:^",
"@backstage/types": "workspace:^",
- "express": "^4.18.2",
+ "express": "^4.22.0",
"msw": "^2.0.8"
}
}
diff --git a/plugins/auth-backend-module-azure-easyauth-provider/CHANGELOG.md b/plugins/auth-backend-module-azure-easyauth-provider/CHANGELOG.md
index 9464f4ce1d..3d139b57cd 100644
--- a/plugins/auth-backend-module-azure-easyauth-provider/CHANGELOG.md
+++ b/plugins/auth-backend-module-azure-easyauth-provider/CHANGELOG.md
@@ -1,5 +1,16 @@
# @backstage/plugin-auth-backend-module-azure-easyauth-provider
+## 0.2.15-next.1
+
+### Patch Changes
+
+- de96a60: chore(deps): bump `express` from 4.21.2 to 4.22.0
+- Updated dependencies
+ - @backstage/plugin-auth-node@0.6.10-next.1
+ - @backstage/backend-plugin-api@1.6.0-next.1
+ - @backstage/catalog-model@1.7.6
+ - @backstage/errors@1.2.7
+
## 0.2.15-next.0
### Patch Changes
diff --git a/plugins/auth-backend-module-azure-easyauth-provider/package.json b/plugins/auth-backend-module-azure-easyauth-provider/package.json
index 57a6482e2b..66f7094031 100644
--- a/plugins/auth-backend-module-azure-easyauth-provider/package.json
+++ b/plugins/auth-backend-module-azure-easyauth-provider/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-auth-backend-module-azure-easyauth-provider",
- "version": "0.2.15-next.0",
+ "version": "0.2.15-next.1",
"description": "The azure-easyauth-provider backend module for the auth plugin.",
"backstage": {
"role": "backend-plugin-module",
@@ -38,7 +38,7 @@
"@backstage/errors": "workspace:^",
"@backstage/plugin-auth-node": "workspace:^",
"@types/passport": "^1.0.16",
- "express": "^4.19.2",
+ "express": "^4.22.0",
"jose": "^5.0.0",
"passport": "^0.7.0",
"zod": "^3.22.4"
diff --git a/plugins/auth-backend-module-bitbucket-provider/CHANGELOG.md b/plugins/auth-backend-module-bitbucket-provider/CHANGELOG.md
index f4cb03f95e..12bd0a13dc 100644
--- a/plugins/auth-backend-module-bitbucket-provider/CHANGELOG.md
+++ b/plugins/auth-backend-module-bitbucket-provider/CHANGELOG.md
@@ -1,5 +1,14 @@
# @backstage/plugin-auth-backend-module-bitbucket-provider
+## 0.3.10-next.1
+
+### Patch Changes
+
+- de96a60: chore(deps): bump `express` from 4.21.2 to 4.22.0
+- Updated dependencies
+ - @backstage/plugin-auth-node@0.6.10-next.1
+ - @backstage/backend-plugin-api@1.6.0-next.1
+
## 0.3.10-next.0
### Patch Changes
diff --git a/plugins/auth-backend-module-bitbucket-provider/package.json b/plugins/auth-backend-module-bitbucket-provider/package.json
index 6e8861871b..7f43a93502 100644
--- a/plugins/auth-backend-module-bitbucket-provider/package.json
+++ b/plugins/auth-backend-module-bitbucket-provider/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-auth-backend-module-bitbucket-provider",
- "version": "0.3.10-next.0",
+ "version": "0.3.10-next.1",
"description": "The bitbucket-provider backend module for the auth plugin.",
"backstage": {
"role": "backend-plugin-module",
@@ -36,7 +36,7 @@
"dependencies": {
"@backstage/backend-plugin-api": "workspace:^",
"@backstage/plugin-auth-node": "workspace:^",
- "express": "^4.18.2",
+ "express": "^4.22.0",
"passport": "^0.7.0",
"passport-bitbucket-oauth2": "^0.1.2",
"zod": "^3.22.4"
diff --git a/plugins/auth-backend-module-bitbucket-server-provider/CHANGELOG.md b/plugins/auth-backend-module-bitbucket-server-provider/CHANGELOG.md
index c29d1ef826..8c0df56cb1 100644
--- a/plugins/auth-backend-module-bitbucket-server-provider/CHANGELOG.md
+++ b/plugins/auth-backend-module-bitbucket-server-provider/CHANGELOG.md
@@ -1,5 +1,13 @@
# @backstage/plugin-auth-backend-module-bitbucket-server-provider
+## 0.2.10-next.1
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-auth-node@0.6.10-next.1
+ - @backstage/backend-plugin-api@1.6.0-next.1
+
## 0.2.10-next.0
### Patch Changes
diff --git a/plugins/auth-backend-module-bitbucket-server-provider/package.json b/plugins/auth-backend-module-bitbucket-server-provider/package.json
index 9d410e8da0..576ca6f925 100644
--- a/plugins/auth-backend-module-bitbucket-server-provider/package.json
+++ b/plugins/auth-backend-module-bitbucket-server-provider/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-auth-backend-module-bitbucket-server-provider",
- "version": "0.2.10-next.0",
+ "version": "0.2.10-next.1",
"description": "The bitbucket-server-provider backend module for the auth plugin.",
"backstage": {
"role": "backend-plugin-module",
diff --git a/plugins/auth-backend-module-cloudflare-access-provider/CHANGELOG.md b/plugins/auth-backend-module-cloudflare-access-provider/CHANGELOG.md
index b7928bd822..7de1d06be6 100644
--- a/plugins/auth-backend-module-cloudflare-access-provider/CHANGELOG.md
+++ b/plugins/auth-backend-module-cloudflare-access-provider/CHANGELOG.md
@@ -1,5 +1,16 @@
# @backstage/plugin-auth-backend-module-cloudflare-access-provider
+## 0.4.10-next.1
+
+### Patch Changes
+
+- de96a60: chore(deps): bump `express` from 4.21.2 to 4.22.0
+- Updated dependencies
+ - @backstage/plugin-auth-node@0.6.10-next.1
+ - @backstage/backend-plugin-api@1.6.0-next.1
+ - @backstage/config@1.3.6
+ - @backstage/errors@1.2.7
+
## 0.4.10-next.0
### Patch Changes
diff --git a/plugins/auth-backend-module-cloudflare-access-provider/package.json b/plugins/auth-backend-module-cloudflare-access-provider/package.json
index e666208ac4..2d524f8741 100644
--- a/plugins/auth-backend-module-cloudflare-access-provider/package.json
+++ b/plugins/auth-backend-module-cloudflare-access-provider/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-auth-backend-module-cloudflare-access-provider",
- "version": "0.4.10-next.0",
+ "version": "0.4.10-next.1",
"description": "The cloudflare-access-provider backend module for the auth plugin.",
"backstage": {
"role": "backend-plugin-module",
@@ -38,7 +38,7 @@
"@backstage/config": "workspace:^",
"@backstage/errors": "workspace:^",
"@backstage/plugin-auth-node": "workspace:^",
- "express": "^4.18.2",
+ "express": "^4.22.0",
"jose": "^5.0.0",
"zod": "^3.22.4"
},
diff --git a/plugins/auth-backend-module-gcp-iap-provider/CHANGELOG.md b/plugins/auth-backend-module-gcp-iap-provider/CHANGELOG.md
index 7fc1271072..155c616491 100644
--- a/plugins/auth-backend-module-gcp-iap-provider/CHANGELOG.md
+++ b/plugins/auth-backend-module-gcp-iap-provider/CHANGELOG.md
@@ -1,5 +1,16 @@
# @backstage/plugin-auth-backend-module-gcp-iap-provider
+## 0.4.10-next.1
+
+### Patch Changes
+
+- de96a60: chore(deps): bump `express` from 4.21.2 to 4.22.0
+- Updated dependencies
+ - @backstage/plugin-auth-node@0.6.10-next.1
+ - @backstage/backend-plugin-api@1.6.0-next.1
+ - @backstage/errors@1.2.7
+ - @backstage/types@1.2.2
+
## 0.4.10-next.0
### Patch Changes
diff --git a/plugins/auth-backend-module-gcp-iap-provider/package.json b/plugins/auth-backend-module-gcp-iap-provider/package.json
index f93d35e684..69b224a9c6 100644
--- a/plugins/auth-backend-module-gcp-iap-provider/package.json
+++ b/plugins/auth-backend-module-gcp-iap-provider/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-auth-backend-module-gcp-iap-provider",
- "version": "0.4.10-next.0",
+ "version": "0.4.10-next.1",
"description": "A GCP IAP auth provider module for the Backstage auth backend",
"backstage": {
"role": "backend-plugin-module",
@@ -48,7 +48,7 @@
"devDependencies": {
"@backstage/backend-test-utils": "workspace:^",
"@backstage/cli": "workspace:^",
- "express": "^4.18.2"
+ "express": "^4.22.0"
},
"configSchema": "config.d.ts"
}
diff --git a/plugins/auth-backend-module-github-provider/CHANGELOG.md b/plugins/auth-backend-module-github-provider/CHANGELOG.md
index 23bb42eac1..d81802fd50 100644
--- a/plugins/auth-backend-module-github-provider/CHANGELOG.md
+++ b/plugins/auth-backend-module-github-provider/CHANGELOG.md
@@ -1,5 +1,13 @@
# @backstage/plugin-auth-backend-module-github-provider
+## 0.3.10-next.1
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-auth-node@0.6.10-next.1
+ - @backstage/backend-plugin-api@1.6.0-next.1
+
## 0.3.10-next.0
### Patch Changes
diff --git a/plugins/auth-backend-module-github-provider/package.json b/plugins/auth-backend-module-github-provider/package.json
index 28a9404ef3..1cdc217126 100644
--- a/plugins/auth-backend-module-github-provider/package.json
+++ b/plugins/auth-backend-module-github-provider/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-auth-backend-module-github-provider",
- "version": "0.3.10-next.0",
+ "version": "0.3.10-next.1",
"description": "The github-provider backend module for the auth plugin.",
"backstage": {
"role": "backend-plugin-module",
diff --git a/plugins/auth-backend-module-gitlab-provider/CHANGELOG.md b/plugins/auth-backend-module-gitlab-provider/CHANGELOG.md
index 0cf1db7128..9c3e318c71 100644
--- a/plugins/auth-backend-module-gitlab-provider/CHANGELOG.md
+++ b/plugins/auth-backend-module-gitlab-provider/CHANGELOG.md
@@ -1,5 +1,14 @@
# @backstage/plugin-auth-backend-module-gitlab-provider
+## 0.3.10-next.1
+
+### Patch Changes
+
+- de96a60: chore(deps): bump `express` from 4.21.2 to 4.22.0
+- Updated dependencies
+ - @backstage/plugin-auth-node@0.6.10-next.1
+ - @backstage/backend-plugin-api@1.6.0-next.1
+
## 0.3.10-next.0
### Patch Changes
diff --git a/plugins/auth-backend-module-gitlab-provider/package.json b/plugins/auth-backend-module-gitlab-provider/package.json
index 3463abe4e4..5ea1d2ccf6 100644
--- a/plugins/auth-backend-module-gitlab-provider/package.json
+++ b/plugins/auth-backend-module-gitlab-provider/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-auth-backend-module-gitlab-provider",
- "version": "0.3.10-next.0",
+ "version": "0.3.10-next.1",
"description": "The gitlab-provider backend module for the auth plugin.",
"backstage": {
"role": "backend-plugin-module",
@@ -36,7 +36,7 @@
"dependencies": {
"@backstage/backend-plugin-api": "workspace:^",
"@backstage/plugin-auth-node": "workspace:^",
- "express": "^4.18.2",
+ "express": "^4.22.0",
"passport": "^0.7.0",
"passport-gitlab2": "^5.0.0",
"zod": "^3.22.4"
diff --git a/plugins/auth-backend-module-google-provider/CHANGELOG.md b/plugins/auth-backend-module-google-provider/CHANGELOG.md
index 6c21b76fef..77976afe3f 100644
--- a/plugins/auth-backend-module-google-provider/CHANGELOG.md
+++ b/plugins/auth-backend-module-google-provider/CHANGELOG.md
@@ -1,5 +1,13 @@
# @backstage/plugin-auth-backend-module-google-provider
+## 0.3.10-next.1
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-auth-node@0.6.10-next.1
+ - @backstage/backend-plugin-api@1.6.0-next.1
+
## 0.3.10-next.0
### Patch Changes
diff --git a/plugins/auth-backend-module-google-provider/package.json b/plugins/auth-backend-module-google-provider/package.json
index c0d04e491c..ce142af63f 100644
--- a/plugins/auth-backend-module-google-provider/package.json
+++ b/plugins/auth-backend-module-google-provider/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-auth-backend-module-google-provider",
- "version": "0.3.10-next.0",
+ "version": "0.3.10-next.1",
"description": "A Google auth provider module for the Backstage auth backend",
"backstage": {
"role": "backend-plugin-module",
diff --git a/plugins/auth-backend-module-guest-provider/CHANGELOG.md b/plugins/auth-backend-module-guest-provider/CHANGELOG.md
index 629e851ce9..ecf498d085 100644
--- a/plugins/auth-backend-module-guest-provider/CHANGELOG.md
+++ b/plugins/auth-backend-module-guest-provider/CHANGELOG.md
@@ -1,5 +1,16 @@
# @backstage/plugin-auth-backend-module-guest-provider
+## 0.2.15-next.1
+
+### Patch Changes
+
+- de96a60: chore(deps): bump `express` from 4.21.2 to 4.22.0
+- Updated dependencies
+ - @backstage/plugin-auth-node@0.6.10-next.1
+ - @backstage/backend-plugin-api@1.6.0-next.1
+ - @backstage/catalog-model@1.7.6
+ - @backstage/errors@1.2.7
+
## 0.2.15-next.0
### Patch Changes
diff --git a/plugins/auth-backend-module-guest-provider/package.json b/plugins/auth-backend-module-guest-provider/package.json
index 34565928e1..03bd08d7e7 100644
--- a/plugins/auth-backend-module-guest-provider/package.json
+++ b/plugins/auth-backend-module-guest-provider/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-auth-backend-module-guest-provider",
- "version": "0.2.15-next.0",
+ "version": "0.2.15-next.1",
"description": "The guest-provider backend module for the auth plugin.",
"backstage": {
"role": "backend-plugin-module",
@@ -44,7 +44,7 @@
"@backstage/backend-test-utils": "workspace:^",
"@backstage/cli": "workspace:^",
"@backstage/config": "workspace:^",
- "express": "^4.18.2"
+ "express": "^4.22.0"
},
"configSchema": "config.d.ts"
}
diff --git a/plugins/auth-backend-module-microsoft-provider/CHANGELOG.md b/plugins/auth-backend-module-microsoft-provider/CHANGELOG.md
index 4353509f9c..b8d865d182 100644
--- a/plugins/auth-backend-module-microsoft-provider/CHANGELOG.md
+++ b/plugins/auth-backend-module-microsoft-provider/CHANGELOG.md
@@ -1,5 +1,14 @@
# @backstage/plugin-auth-backend-module-microsoft-provider
+## 0.3.10-next.1
+
+### Patch Changes
+
+- de96a60: chore(deps): bump `express` from 4.21.2 to 4.22.0
+- Updated dependencies
+ - @backstage/plugin-auth-node@0.6.10-next.1
+ - @backstage/backend-plugin-api@1.6.0-next.1
+
## 0.3.10-next.0
### Patch Changes
diff --git a/plugins/auth-backend-module-microsoft-provider/package.json b/plugins/auth-backend-module-microsoft-provider/package.json
index e759aaa752..c0b0ebc89d 100644
--- a/plugins/auth-backend-module-microsoft-provider/package.json
+++ b/plugins/auth-backend-module-microsoft-provider/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-auth-backend-module-microsoft-provider",
- "version": "0.3.10-next.0",
+ "version": "0.3.10-next.1",
"description": "The microsoft-provider backend module for the auth plugin.",
"backstage": {
"role": "backend-plugin-module",
@@ -36,7 +36,7 @@
"dependencies": {
"@backstage/backend-plugin-api": "workspace:^",
"@backstage/plugin-auth-node": "workspace:^",
- "express": "^4.18.2",
+ "express": "^4.22.0",
"jose": "^5.0.0",
"passport-microsoft": "^1.0.0",
"zod": "^3.22.4"
diff --git a/plugins/auth-backend-module-oauth2-provider/CHANGELOG.md b/plugins/auth-backend-module-oauth2-provider/CHANGELOG.md
index dc10e9a4f8..5804fe281b 100644
--- a/plugins/auth-backend-module-oauth2-provider/CHANGELOG.md
+++ b/plugins/auth-backend-module-oauth2-provider/CHANGELOG.md
@@ -1,5 +1,13 @@
# @backstage/plugin-auth-backend-module-oauth2-provider
+## 0.4.10-next.1
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-auth-node@0.6.10-next.1
+ - @backstage/backend-plugin-api@1.6.0-next.1
+
## 0.4.10-next.0
### Patch Changes
diff --git a/plugins/auth-backend-module-oauth2-provider/package.json b/plugins/auth-backend-module-oauth2-provider/package.json
index d7c1c62aea..2b09f84a3e 100644
--- a/plugins/auth-backend-module-oauth2-provider/package.json
+++ b/plugins/auth-backend-module-oauth2-provider/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-auth-backend-module-oauth2-provider",
- "version": "0.4.10-next.0",
+ "version": "0.4.10-next.1",
"description": "The oauth2-provider backend module for the auth plugin.",
"backstage": {
"role": "backend-plugin-module",
diff --git a/plugins/auth-backend-module-oauth2-proxy-provider/CHANGELOG.md b/plugins/auth-backend-module-oauth2-proxy-provider/CHANGELOG.md
index c791003a0f..f0b86176d3 100644
--- a/plugins/auth-backend-module-oauth2-proxy-provider/CHANGELOG.md
+++ b/plugins/auth-backend-module-oauth2-proxy-provider/CHANGELOG.md
@@ -1,5 +1,14 @@
# @backstage/plugin-auth-backend-module-oauth2-proxy-provider
+## 0.2.15-next.1
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-auth-node@0.6.10-next.1
+ - @backstage/backend-plugin-api@1.6.0-next.1
+ - @backstage/errors@1.2.7
+
## 0.2.15-next.0
### Patch Changes
diff --git a/plugins/auth-backend-module-oauth2-proxy-provider/package.json b/plugins/auth-backend-module-oauth2-proxy-provider/package.json
index c6d4fbe77d..9df99d1a01 100644
--- a/plugins/auth-backend-module-oauth2-proxy-provider/package.json
+++ b/plugins/auth-backend-module-oauth2-proxy-provider/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-auth-backend-module-oauth2-proxy-provider",
- "version": "0.2.15-next.0",
+ "version": "0.2.15-next.1",
"description": "The oauth2-proxy-provider backend module for the auth plugin.",
"backstage": {
"role": "backend-plugin-module",
diff --git a/plugins/auth-backend-module-oidc-provider/CHANGELOG.md b/plugins/auth-backend-module-oidc-provider/CHANGELOG.md
index 50c0e98d58..bea755da76 100644
--- a/plugins/auth-backend-module-oidc-provider/CHANGELOG.md
+++ b/plugins/auth-backend-module-oidc-provider/CHANGELOG.md
@@ -1,5 +1,17 @@
# @backstage/plugin-auth-backend-module-oidc-provider
+## 0.4.10-next.1
+
+### Patch Changes
+
+- de96a60: chore(deps): bump `express` from 4.21.2 to 4.22.0
+- Updated dependencies
+ - @backstage/plugin-auth-backend@0.25.7-next.1
+ - @backstage/plugin-auth-node@0.6.10-next.1
+ - @backstage/backend-plugin-api@1.6.0-next.1
+ - @backstage/config@1.3.6
+ - @backstage/types@1.2.2
+
## 0.4.10-next.0
### Patch Changes
diff --git a/plugins/auth-backend-module-oidc-provider/package.json b/plugins/auth-backend-module-oidc-provider/package.json
index 4845cfffe9..288e43ed90 100644
--- a/plugins/auth-backend-module-oidc-provider/package.json
+++ b/plugins/auth-backend-module-oidc-provider/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-auth-backend-module-oidc-provider",
- "version": "0.4.10-next.0",
+ "version": "0.4.10-next.1",
"description": "The oidc-provider backend module for the auth plugin.",
"backstage": {
"role": "backend-plugin-module",
@@ -39,7 +39,7 @@
"@backstage/plugin-auth-backend": "workspace:^",
"@backstage/plugin-auth-node": "workspace:^",
"@backstage/types": "workspace:^",
- "express": "^4.18.2",
+ "express": "^4.22.0",
"openid-client": "^5.5.0",
"passport": "^0.7.0",
"zod": "^3.22.4"
diff --git a/plugins/auth-backend-module-okta-provider/CHANGELOG.md b/plugins/auth-backend-module-okta-provider/CHANGELOG.md
index afeb13cdff..9035d60a6b 100644
--- a/plugins/auth-backend-module-okta-provider/CHANGELOG.md
+++ b/plugins/auth-backend-module-okta-provider/CHANGELOG.md
@@ -1,5 +1,14 @@
# @backstage/plugin-auth-backend-module-okta-provider
+## 0.2.10-next.1
+
+### Patch Changes
+
+- de96a60: chore(deps): bump `express` from 4.21.2 to 4.22.0
+- Updated dependencies
+ - @backstage/plugin-auth-node@0.6.10-next.1
+ - @backstage/backend-plugin-api@1.6.0-next.1
+
## 0.2.10-next.0
### Patch Changes
diff --git a/plugins/auth-backend-module-okta-provider/package.json b/plugins/auth-backend-module-okta-provider/package.json
index 0b62a7678e..d6320355ee 100644
--- a/plugins/auth-backend-module-okta-provider/package.json
+++ b/plugins/auth-backend-module-okta-provider/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-auth-backend-module-okta-provider",
- "version": "0.2.10-next.0",
+ "version": "0.2.10-next.1",
"description": "The okta-provider backend module for the auth plugin.",
"backstage": {
"role": "backend-plugin-module",
@@ -37,7 +37,7 @@
"@backstage/backend-plugin-api": "workspace:^",
"@backstage/plugin-auth-node": "workspace:^",
"@davidzemon/passport-okta-oauth": "^0.0.7",
- "express": "^4.18.2",
+ "express": "^4.22.0",
"passport": "^0.7.0",
"zod": "^3.22.4"
},
diff --git a/plugins/auth-backend-module-onelogin-provider/CHANGELOG.md b/plugins/auth-backend-module-onelogin-provider/CHANGELOG.md
index 2a201b6a23..8a8c58b644 100644
--- a/plugins/auth-backend-module-onelogin-provider/CHANGELOG.md
+++ b/plugins/auth-backend-module-onelogin-provider/CHANGELOG.md
@@ -1,5 +1,14 @@
# @backstage/plugin-auth-backend-module-onelogin-provider
+## 0.3.10-next.1
+
+### Patch Changes
+
+- de96a60: chore(deps): bump `express` from 4.21.2 to 4.22.0
+- Updated dependencies
+ - @backstage/plugin-auth-node@0.6.10-next.1
+ - @backstage/backend-plugin-api@1.6.0-next.1
+
## 0.3.10-next.0
### Patch Changes
diff --git a/plugins/auth-backend-module-onelogin-provider/package.json b/plugins/auth-backend-module-onelogin-provider/package.json
index 1b7a878b21..f2056e8062 100644
--- a/plugins/auth-backend-module-onelogin-provider/package.json
+++ b/plugins/auth-backend-module-onelogin-provider/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-auth-backend-module-onelogin-provider",
- "version": "0.3.10-next.0",
+ "version": "0.3.10-next.1",
"description": "The onelogin-provider backend module for the auth plugin.",
"backstage": {
"role": "backend-plugin-module",
@@ -36,7 +36,7 @@
"dependencies": {
"@backstage/backend-plugin-api": "workspace:^",
"@backstage/plugin-auth-node": "workspace:^",
- "express": "^4.18.2",
+ "express": "^4.22.0",
"passport": "^0.7.0",
"passport-onelogin-oauth": "^0.0.1",
"zod": "^3.22.4"
diff --git a/plugins/auth-backend-module-openshift-provider/CHANGELOG.md b/plugins/auth-backend-module-openshift-provider/CHANGELOG.md
index 88fd02d73e..85212d8896 100644
--- a/plugins/auth-backend-module-openshift-provider/CHANGELOG.md
+++ b/plugins/auth-backend-module-openshift-provider/CHANGELOG.md
@@ -1,5 +1,16 @@
# @backstage/plugin-auth-backend-module-openshift-provider
+## 0.1.3-next.1
+
+### Patch Changes
+
+- de96a60: chore(deps): bump `express` from 4.21.2 to 4.22.0
+- Updated dependencies
+ - @backstage/plugin-auth-node@0.6.10-next.1
+ - @backstage/backend-plugin-api@1.6.0-next.1
+ - @backstage/catalog-model@1.7.6
+ - @backstage/types@1.2.2
+
## 0.1.3-next.0
### Patch Changes
diff --git a/plugins/auth-backend-module-openshift-provider/package.json b/plugins/auth-backend-module-openshift-provider/package.json
index ed86940699..e60b0cf0cd 100644
--- a/plugins/auth-backend-module-openshift-provider/package.json
+++ b/plugins/auth-backend-module-openshift-provider/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-auth-backend-module-openshift-provider",
- "version": "0.1.3-next.0",
+ "version": "0.1.3-next.1",
"description": "The OpenShift backend module for the auth plugin.",
"backstage": {
"role": "backend-plugin-module",
@@ -47,7 +47,7 @@
"@backstage/cli": "workspace:^",
"@backstage/config": "workspace:^",
"@backstage/plugin-auth-backend": "workspace:^",
- "express": "^4.18.2",
+ "express": "^4.22.0",
"msw": "^2.7.3",
"supertest": "^7.1.0"
},
diff --git a/plugins/auth-backend-module-pinniped-provider/CHANGELOG.md b/plugins/auth-backend-module-pinniped-provider/CHANGELOG.md
index 86429f1b56..7dc93b5450 100644
--- a/plugins/auth-backend-module-pinniped-provider/CHANGELOG.md
+++ b/plugins/auth-backend-module-pinniped-provider/CHANGELOG.md
@@ -1,5 +1,16 @@
# @backstage/plugin-auth-backend-module-pinniped-provider
+## 0.3.10-next.1
+
+### Patch Changes
+
+- de96a60: chore(deps): bump `express` from 4.21.2 to 4.22.0
+- Updated dependencies
+ - @backstage/plugin-auth-node@0.6.10-next.1
+ - @backstage/backend-plugin-api@1.6.0-next.1
+ - @backstage/config@1.3.6
+ - @backstage/types@1.2.2
+
## 0.3.10-next.0
### Patch Changes
diff --git a/plugins/auth-backend-module-pinniped-provider/package.json b/plugins/auth-backend-module-pinniped-provider/package.json
index 769cdf4bce..4b4473fadd 100644
--- a/plugins/auth-backend-module-pinniped-provider/package.json
+++ b/plugins/auth-backend-module-pinniped-provider/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-auth-backend-module-pinniped-provider",
- "version": "0.3.10-next.0",
+ "version": "0.3.10-next.1",
"description": "The pinniped-provider backend module for the auth plugin.",
"backstage": {
"role": "backend-plugin-module",
@@ -46,7 +46,7 @@
"@backstage/cli": "workspace:^",
"@backstage/plugin-auth-backend": "workspace:^",
"cookie-parser": "^1.4.6",
- "express": "^4.18.2",
+ "express": "^4.22.0",
"express-session": "^1.17.3",
"jose": "^5.0.0",
"msw": "^1.3.0",
diff --git a/plugins/auth-backend-module-vmware-cloud-provider/CHANGELOG.md b/plugins/auth-backend-module-vmware-cloud-provider/CHANGELOG.md
index 2535bd1e87..fc915370ad 100644
--- a/plugins/auth-backend-module-vmware-cloud-provider/CHANGELOG.md
+++ b/plugins/auth-backend-module-vmware-cloud-provider/CHANGELOG.md
@@ -1,5 +1,14 @@
# @backstage/plugin-auth-backend-module-vmware-cloud-provider
+## 0.5.10-next.1
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-auth-node@0.6.10-next.1
+ - @backstage/backend-plugin-api@1.6.0-next.1
+ - @backstage/catalog-model@1.7.6
+
## 0.5.10-next.0
### Patch Changes
diff --git a/plugins/auth-backend-module-vmware-cloud-provider/package.json b/plugins/auth-backend-module-vmware-cloud-provider/package.json
index 36dc189e5a..93e953897f 100644
--- a/plugins/auth-backend-module-vmware-cloud-provider/package.json
+++ b/plugins/auth-backend-module-vmware-cloud-provider/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-auth-backend-module-vmware-cloud-provider",
- "version": "0.5.10-next.0",
+ "version": "0.5.10-next.1",
"description": "The vmware-cloud-provider backend module for the auth plugin.",
"backstage": {
"role": "backend-plugin-module",
diff --git a/plugins/auth-backend/CHANGELOG.md b/plugins/auth-backend/CHANGELOG.md
index 04752f4432..96f12f68d3 100644
--- a/plugins/auth-backend/CHANGELOG.md
+++ b/plugins/auth-backend/CHANGELOG.md
@@ -1,5 +1,19 @@
# @backstage/plugin-auth-backend
+## 0.25.7-next.1
+
+### Patch Changes
+
+- de96a60: chore(deps): bump `express` from 4.21.2 to 4.22.0
+- Updated dependencies
+ - @backstage/plugin-auth-node@0.6.10-next.1
+ - @backstage/backend-plugin-api@1.6.0-next.1
+ - @backstage/catalog-model@1.7.6
+ - @backstage/config@1.3.6
+ - @backstage/errors@1.2.7
+ - @backstage/types@1.2.2
+ - @backstage/plugin-catalog-node@1.20.1-next.1
+
## 0.25.7-next.0
### Patch Changes
diff --git a/plugins/auth-backend/package.json b/plugins/auth-backend/package.json
index 38dc903811..3f2a86a654 100644
--- a/plugins/auth-backend/package.json
+++ b/plugins/auth-backend/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-auth-backend",
- "version": "0.25.7-next.0",
+ "version": "0.25.7-next.1",
"description": "A Backstage backend plugin that handles authentication",
"backstage": {
"role": "backend-plugin",
@@ -54,7 +54,7 @@
"@google-cloud/firestore": "^7.0.0",
"connect-session-knex": "^4.0.0",
"cookie-parser": "^1.4.5",
- "express": "^4.17.1",
+ "express": "^4.22.0",
"express-promise-router": "^4.1.0",
"express-session": "^1.17.1",
"jose": "^5.0.0",
diff --git a/plugins/auth-node/CHANGELOG.md b/plugins/auth-node/CHANGELOG.md
index 7cf9a43e21..4168ce3284 100644
--- a/plugins/auth-node/CHANGELOG.md
+++ b/plugins/auth-node/CHANGELOG.md
@@ -1,5 +1,19 @@
# @backstage/plugin-auth-node
+## 0.6.10-next.1
+
+### Patch Changes
+
+- de96a60: chore(deps): bump `express` from 4.21.2 to 4.22.0
+- e9dd634: fix flawed cookie removal logic with chunked tokens
+- Updated dependencies
+ - @backstage/backend-plugin-api@1.6.0-next.1
+ - @backstage/catalog-client@1.12.1
+ - @backstage/catalog-model@1.7.6
+ - @backstage/config@1.3.6
+ - @backstage/errors@1.2.7
+ - @backstage/types@1.2.2
+
## 0.6.10-next.0
### Patch Changes
diff --git a/plugins/auth-node/package.json b/plugins/auth-node/package.json
index 1bd4f1212e..d74c83e426 100644
--- a/plugins/auth-node/package.json
+++ b/plugins/auth-node/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-auth-node",
- "version": "0.6.10-next.0",
+ "version": "0.6.10-next.1",
"backstage": {
"role": "node-library",
"pluginId": "auth",
@@ -46,7 +46,7 @@
"@backstage/types": "workspace:^",
"@types/express": "^4.17.6",
"@types/passport": "^1.0.3",
- "express": "^4.17.1",
+ "express": "^4.22.0",
"jose": "^5.0.0",
"lodash": "^4.17.21",
"passport": "^0.7.0",
diff --git a/plugins/auth-node/src/oauth/OAuthCookieManager.ts b/plugins/auth-node/src/oauth/OAuthCookieManager.ts
index 49cb188880..afbedd4dba 100644
--- a/plugins/auth-node/src/oauth/OAuthCookieManager.ts
+++ b/plugins/auth-node/src/oauth/OAuthCookieManager.ts
@@ -152,6 +152,36 @@ export class OAuthCookieManager {
};
const req = res.req;
let output = res;
+
+ const chunkedFormatExists = OAuthCookieManager.chunkedCookieExists(
+ req,
+ name,
+ );
+
+ // If using the default cookieConfigurer, delete old cookie with domain
+ // explicitly set to the callbackUrl's domain (legacy behavior)
+ if (this.cookieConfigurer === defaultCookieConfigurer) {
+ const { hostname: domain } = new URL(this.options.callbackUrl);
+ output = output.cookie(name, '', {
+ ...this.getRemoveCookieOptions(),
+ domain: domain,
+ });
+
+ if (chunkedFormatExists) {
+ for (let chunkNumber = 0; ; chunkNumber++) {
+ const key = OAuthCookieManager.getCookieChunkName(name, chunkNumber);
+ const exists = !!req.cookies[key];
+ if (!exists) {
+ break;
+ }
+ output = output.cookie(key, '', {
+ ...this.getRemoveCookieOptions(),
+ domain: domain,
+ });
+ }
+ }
+ }
+
if (val.length > MAX_COOKIE_SIZE_CHARACTERS) {
const nonChunkedFormatExists = !!req.cookies[name];
if (nonChunkedFormatExists) {
@@ -169,10 +199,6 @@ export class OAuthCookieManager {
return output;
}
- const chunkedFormatExists = OAuthCookieManager.chunkedCookieExists(
- req,
- name,
- );
if (chunkedFormatExists) {
for (let chunkNumber = 0; ; chunkNumber++) {
const key = OAuthCookieManager.getCookieChunkName(name, chunkNumber);
@@ -184,15 +210,6 @@ export class OAuthCookieManager {
}
}
- // If using the default cookieConfigurer, delete old cookie with domain set to the callbackUrl's domain (legacy behavior)
- if (this.cookieConfigurer === defaultCookieConfigurer) {
- const { hostname: domain } = new URL(this.options.callbackUrl);
- output = output.cookie(name, '', {
- ...this.getRemoveCookieOptions(),
- domain: domain,
- });
- }
-
return output.cookie(name, val, options);
}
diff --git a/plugins/auth-node/src/oauth/createOAuthRouteHandlers.test.ts b/plugins/auth-node/src/oauth/createOAuthRouteHandlers.test.ts
index a943717553..df012bcff1 100644
--- a/plugins/auth-node/src/oauth/createOAuthRouteHandlers.test.ts
+++ b/plugins/auth-node/src/oauth/createOAuthRouteHandlers.test.ts
@@ -337,6 +337,178 @@ describe('createOAuthRouteHandlers', () => {
expect(getGrantedScopesCookie(agent)).toBeUndefined();
});
+ it('should clean up old cookies (non-chunked) with domain attribute during migration', async () => {
+ const agent = request.agent(
+ wrapInApp(createOAuthRouteHandlers(baseConfig)),
+ );
+
+ agent.jar.setCookie(
+ 'my-provider-nonce=123',
+ '127.0.0.1',
+ '/my-provider/handler',
+ );
+
+ agent.jar.setCookie(
+ 'my-provider-refresh-token=old-refresh-token; Domain=127.0.0.1',
+ '127.0.0.1',
+ '/my-provider',
+ );
+
+ mockAuthenticator.authenticate.mockResolvedValue({
+ fullProfile: { id: 'id' } as PassportProfile,
+ session: mockSession,
+ });
+
+ const res = await agent.get('/my-provider/handler/frame').query({
+ state: encodeOAuthState({
+ env: 'development',
+ nonce: '123',
+ } as OAuthState),
+ });
+
+ expect(res.status).toBe(200);
+
+ const setCookieHeaders = [res.get('Set-Cookie') ?? []].flat();
+ const hasDeleteWithDomain = setCookieHeaders.some(
+ cookie =>
+ cookie.includes('my-provider-refresh-token=;') &&
+ cookie.includes('Max-Age=0') &&
+ cookie.includes('Domain=127.0.0.1'),
+ );
+ expect(hasDeleteWithDomain).toBe(true);
+
+ expect(getRefreshTokenCookie(agent).value).toBe('refresh-token');
+ });
+
+ it('should clean up old chunked cookies with domain attribute during migration', async () => {
+ const agent = request.agent(
+ wrapInApp(createOAuthRouteHandlers(baseConfig)),
+ );
+
+ agent.jar.setCookie(
+ 'my-provider-nonce=123',
+ '127.0.0.1',
+ '/my-provider/handler',
+ );
+
+ // Simulate old chunked cookies with domain attribute (legacy format)
+ agent.jar.setCookie(
+ `my-provider-refresh-token-0=${fiveKilobyteRefreshToken.slice(
+ 0,
+ 4000,
+ )}; Domain=127.0.0.1`,
+ '/my-provider',
+ );
+ agent.jar.setCookie(
+ `my-provider-refresh-token-1=${fiveKilobyteRefreshToken.slice(
+ 4000,
+ )}; Domain=127.0.0.1`,
+ '/my-provider',
+ );
+
+ mockAuthenticator.authenticate.mockResolvedValue({
+ fullProfile: { id: 'id' } as PassportProfile,
+ session: {
+ ...mockSession,
+ refreshToken: fiveKilobyteRefreshToken,
+ },
+ });
+
+ const res = await agent.get('/my-provider/handler/frame').query({
+ state: encodeOAuthState({
+ env: 'development',
+ nonce: '123',
+ } as OAuthState),
+ });
+
+ expect(res.status).toBe(200);
+
+ const setCookieHeaders = [res.get('Set-Cookie') ?? []].flat();
+ const hasChunk0DeleteWithDomain = setCookieHeaders.some(
+ cookie =>
+ cookie.includes('my-provider-refresh-token-0=') &&
+ cookie.includes('Max-Age=0') &&
+ cookie.includes('Domain=127.0.0.1'),
+ );
+ const hasChunk1DeleteWithDomain = setCookieHeaders.some(
+ cookie =>
+ cookie.includes('my-provider-refresh-token-1=') &&
+ cookie.includes('Max-Age=0') &&
+ cookie.includes('Domain=127.0.0.1'),
+ );
+
+ expect(hasChunk0DeleteWithDomain).toBe(true);
+ expect(hasChunk1DeleteWithDomain).toBe(true);
+
+ expect(getRefreshTokenCookie(agent, 0).value).toBe(
+ fiveKilobyteRefreshToken.slice(0, 4000),
+ );
+ expect(getRefreshTokenCookie(agent, 1).value).toBe(
+ fiveKilobyteRefreshToken.slice(4000),
+ );
+ });
+
+ it('should clean up old chunked cookies with domain when migrating to non-chunked', async () => {
+ const agent = request.agent(
+ wrapInApp(createOAuthRouteHandlers(baseConfig)),
+ );
+
+ agent.jar.setCookie(
+ 'my-provider-nonce=123',
+ '127.0.0.1',
+ '/my-provider/handler',
+ );
+
+ agent.jar.setCookie(
+ `my-provider-refresh-token-0=${fiveKilobyteRefreshToken.slice(
+ 0,
+ 4000,
+ )}; Domain=127.0.0.1`,
+ '/my-provider',
+ );
+ agent.jar.setCookie(
+ `my-provider-refresh-token-1=${fiveKilobyteRefreshToken.slice(
+ 4000,
+ )}; Domain=127.0.0.1`,
+ '/my-provider',
+ );
+
+ mockAuthenticator.authenticate.mockResolvedValue({
+ fullProfile: { id: 'id' } as PassportProfile,
+ session: mockSession,
+ });
+
+ const res = await agent.get('/my-provider/handler/frame').query({
+ state: encodeOAuthState({
+ env: 'development',
+ nonce: '123',
+ } as OAuthState),
+ });
+
+ expect(res.status).toBe(200);
+
+ const setCookieHeaders = [res.get('Set-Cookie') ?? []].flat();
+ const hasChunk0DeleteWithDomain = setCookieHeaders.some(
+ cookie =>
+ cookie.includes('my-provider-refresh-token-0=;') &&
+ cookie.includes('Max-Age=0') &&
+ cookie.includes('Domain=127.0.0.1'),
+ );
+ const hasChunk1DeleteWithDomain = setCookieHeaders.some(
+ cookie =>
+ cookie.includes('my-provider-refresh-token-1=;') &&
+ cookie.includes('Max-Age=0') &&
+ cookie.includes('Domain=127.0.0.1'),
+ );
+
+ expect(hasChunk0DeleteWithDomain).toBe(true);
+ expect(hasChunk1DeleteWithDomain).toBe(true);
+
+ expect(getRefreshTokenCookie(agent).value).toBe('refresh-token');
+ expect(getRefreshTokenCookie(agent, 0)).toBeUndefined();
+ expect(getRefreshTokenCookie(agent, 1)).toBeUndefined();
+ });
+
it('should authenticate with sign-in, profile transform, and persisted scopes', async () => {
const agent = request.agent(
wrapInApp(
@@ -877,10 +1049,10 @@ describe('createOAuthRouteHandlers', () => {
const expectedExpirationDate = Date.now() + 1000 * 24 * 60 * 60 * 1000;
const cookie = getRefreshTokenCookie(agent);
expect(cookie.expiration_date).toBeGreaterThanOrEqual(
- expectedExpirationDate - 1000,
+ expectedExpirationDate - 5000,
);
expect(cookie.expiration_date).toBeLessThanOrEqual(
- expectedExpirationDate + 1000,
+ expectedExpirationDate + 5000,
);
});
});
diff --git a/plugins/catalog-backend-module-aws/CHANGELOG.md b/plugins/catalog-backend-module-aws/CHANGELOG.md
index ee9bc35e33..d42c4e06b6 100644
--- a/plugins/catalog-backend-module-aws/CHANGELOG.md
+++ b/plugins/catalog-backend-module-aws/CHANGELOG.md
@@ -1,5 +1,28 @@
# @backstage/plugin-catalog-backend-module-aws
+## 0.4.18-next.2
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-defaults@0.14.0-next.1
+ - @backstage/integration@1.18.3-next.1
+ - @backstage/backend-plugin-api@1.6.0-next.1
+ - @backstage/catalog-model@1.7.6
+ - @backstage/config@1.3.6
+ - @backstage/errors@1.2.7
+ - @backstage/integration-aws-node@0.1.19
+ - @backstage/plugin-catalog-common@1.1.7
+ - @backstage/plugin-catalog-node@1.20.1-next.1
+ - @backstage/plugin-kubernetes-common@0.9.9-next.0
+
+## 0.4.18-next.1
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-kubernetes-common@0.9.9-next.0
+
## 0.4.18-next.0
### Patch Changes
diff --git a/plugins/catalog-backend-module-aws/package.json b/plugins/catalog-backend-module-aws/package.json
index 17a5abd057..c73960b473 100644
--- a/plugins/catalog-backend-module-aws/package.json
+++ b/plugins/catalog-backend-module-aws/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-catalog-backend-module-aws",
- "version": "0.4.18-next.0",
+ "version": "0.4.18-next.2",
"description": "A Backstage catalog backend module that helps integrate towards AWS",
"backstage": {
"role": "backend-plugin-module",
diff --git a/plugins/catalog-backend-module-azure/CHANGELOG.md b/plugins/catalog-backend-module-azure/CHANGELOG.md
index 88e6e91ca1..c5956021fe 100644
--- a/plugins/catalog-backend-module-azure/CHANGELOG.md
+++ b/plugins/catalog-backend-module-azure/CHANGELOG.md
@@ -1,5 +1,16 @@
# @backstage/plugin-catalog-backend-module-azure
+## 0.3.12-next.1
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/integration@1.18.3-next.1
+ - @backstage/backend-plugin-api@1.6.0-next.1
+ - @backstage/config@1.3.6
+ - @backstage/plugin-catalog-common@1.1.7
+ - @backstage/plugin-catalog-node@1.20.1-next.1
+
## 0.3.12-next.0
### Patch Changes
diff --git a/plugins/catalog-backend-module-azure/package.json b/plugins/catalog-backend-module-azure/package.json
index bea8d358d7..23ad359d21 100644
--- a/plugins/catalog-backend-module-azure/package.json
+++ b/plugins/catalog-backend-module-azure/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-catalog-backend-module-azure",
- "version": "0.3.12-next.0",
+ "version": "0.3.12-next.1",
"description": "A Backstage catalog backend module that helps integrate towards Azure",
"backstage": {
"role": "backend-plugin-module",
diff --git a/plugins/catalog-backend-module-backstage-openapi/CHANGELOG.md b/plugins/catalog-backend-module-backstage-openapi/CHANGELOG.md
index 001bb8c816..3bf19b22da 100644
--- a/plugins/catalog-backend-module-backstage-openapi/CHANGELOG.md
+++ b/plugins/catalog-backend-module-backstage-openapi/CHANGELOG.md
@@ -1,5 +1,17 @@
# @backstage/plugin-catalog-backend-module-backstage-openapi
+## 0.5.9-next.1
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-openapi-utils@0.6.4-next.1
+ - @backstage/backend-plugin-api@1.6.0-next.1
+ - @backstage/catalog-model@1.7.6
+ - @backstage/config@1.3.6
+ - @backstage/errors@1.2.7
+ - @backstage/plugin-catalog-node@1.20.1-next.1
+
## 0.5.9-next.0
### Patch Changes
diff --git a/plugins/catalog-backend-module-backstage-openapi/package.json b/plugins/catalog-backend-module-backstage-openapi/package.json
index 5045026df4..3dfa270e86 100644
--- a/plugins/catalog-backend-module-backstage-openapi/package.json
+++ b/plugins/catalog-backend-module-backstage-openapi/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-catalog-backend-module-backstage-openapi",
- "version": "0.5.9-next.0",
+ "version": "0.5.9-next.1",
"backstage": {
"role": "backend-plugin-module",
"pluginId": "catalog",
diff --git a/plugins/catalog-backend-module-bitbucket-cloud/CHANGELOG.md b/plugins/catalog-backend-module-bitbucket-cloud/CHANGELOG.md
index e34fb75316..951cd48ace 100644
--- a/plugins/catalog-backend-module-bitbucket-cloud/CHANGELOG.md
+++ b/plugins/catalog-backend-module-bitbucket-cloud/CHANGELOG.md
@@ -1,5 +1,19 @@
# @backstage/plugin-catalog-backend-module-bitbucket-cloud
+## 0.5.6-next.1
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-events-node@0.4.18-next.1
+ - @backstage/integration@1.18.3-next.1
+ - @backstage/backend-plugin-api@1.6.0-next.1
+ - @backstage/catalog-model@1.7.6
+ - @backstage/config@1.3.6
+ - @backstage/plugin-bitbucket-cloud-common@0.3.5-next.0
+ - @backstage/plugin-catalog-common@1.1.7
+ - @backstage/plugin-catalog-node@1.20.1-next.1
+
## 0.5.6-next.0
### Patch Changes
diff --git a/plugins/catalog-backend-module-bitbucket-cloud/package.json b/plugins/catalog-backend-module-bitbucket-cloud/package.json
index 02b677cffb..d91f41cb8f 100644
--- a/plugins/catalog-backend-module-bitbucket-cloud/package.json
+++ b/plugins/catalog-backend-module-bitbucket-cloud/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-catalog-backend-module-bitbucket-cloud",
- "version": "0.5.6-next.0",
+ "version": "0.5.6-next.1",
"description": "A Backstage catalog backend module that helps integrate towards Bitbucket Cloud",
"backstage": {
"role": "backend-plugin-module",
diff --git a/plugins/catalog-backend-module-bitbucket-server/CHANGELOG.md b/plugins/catalog-backend-module-bitbucket-server/CHANGELOG.md
index 96c75fb09d..7aba4e8a30 100644
--- a/plugins/catalog-backend-module-bitbucket-server/CHANGELOG.md
+++ b/plugins/catalog-backend-module-bitbucket-server/CHANGELOG.md
@@ -1,5 +1,19 @@
# @backstage/plugin-catalog-backend-module-bitbucket-server
+## 0.5.6-next.1
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-events-node@0.4.18-next.1
+ - @backstage/integration@1.18.3-next.1
+ - @backstage/backend-plugin-api@1.6.0-next.1
+ - @backstage/catalog-model@1.7.6
+ - @backstage/config@1.3.6
+ - @backstage/errors@1.2.7
+ - @backstage/plugin-catalog-common@1.1.7
+ - @backstage/plugin-catalog-node@1.20.1-next.1
+
## 0.5.6-next.0
### Patch Changes
diff --git a/plugins/catalog-backend-module-bitbucket-server/package.json b/plugins/catalog-backend-module-bitbucket-server/package.json
index c026aaa869..f94d7c87d7 100644
--- a/plugins/catalog-backend-module-bitbucket-server/package.json
+++ b/plugins/catalog-backend-module-bitbucket-server/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-catalog-backend-module-bitbucket-server",
- "version": "0.5.6-next.0",
+ "version": "0.5.6-next.1",
"backstage": {
"role": "backend-plugin-module",
"pluginId": "catalog",
diff --git a/plugins/catalog-backend-module-gcp/CHANGELOG.md b/plugins/catalog-backend-module-gcp/CHANGELOG.md
index 75a49d4748..f5b00f9d06 100644
--- a/plugins/catalog-backend-module-gcp/CHANGELOG.md
+++ b/plugins/catalog-backend-module-gcp/CHANGELOG.md
@@ -1,5 +1,23 @@
# @backstage/plugin-catalog-backend-module-gcp
+## 0.3.15-next.2
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-plugin-api@1.6.0-next.1
+ - @backstage/catalog-model@1.7.6
+ - @backstage/config@1.3.6
+ - @backstage/plugin-catalog-node@1.20.1-next.1
+ - @backstage/plugin-kubernetes-common@0.9.9-next.0
+
+## 0.3.15-next.1
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-kubernetes-common@0.9.9-next.0
+
## 0.3.15-next.0
### Patch Changes
diff --git a/plugins/catalog-backend-module-gcp/package.json b/plugins/catalog-backend-module-gcp/package.json
index 6e0e1fb57d..bb7c0a200e 100644
--- a/plugins/catalog-backend-module-gcp/package.json
+++ b/plugins/catalog-backend-module-gcp/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-catalog-backend-module-gcp",
- "version": "0.3.15-next.0",
+ "version": "0.3.15-next.2",
"description": "A Backstage catalog backend module that helps integrate towards GCP",
"backstage": {
"role": "backend-plugin-module",
diff --git a/plugins/catalog-backend-module-gerrit/CHANGELOG.md b/plugins/catalog-backend-module-gerrit/CHANGELOG.md
index d1493a5d34..dc2c9d7a4d 100644
--- a/plugins/catalog-backend-module-gerrit/CHANGELOG.md
+++ b/plugins/catalog-backend-module-gerrit/CHANGELOG.md
@@ -1,5 +1,17 @@
# @backstage/plugin-catalog-backend-module-gerrit
+## 0.3.9-next.1
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/integration@1.18.3-next.1
+ - @backstage/backend-plugin-api@1.6.0-next.1
+ - @backstage/config@1.3.6
+ - @backstage/errors@1.2.7
+ - @backstage/plugin-catalog-common@1.1.7
+ - @backstage/plugin-catalog-node@1.20.1-next.1
+
## 0.3.9-next.0
### Patch Changes
diff --git a/plugins/catalog-backend-module-gerrit/package.json b/plugins/catalog-backend-module-gerrit/package.json
index dbf1929bc8..6a49d35277 100644
--- a/plugins/catalog-backend-module-gerrit/package.json
+++ b/plugins/catalog-backend-module-gerrit/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-catalog-backend-module-gerrit",
- "version": "0.3.9-next.0",
+ "version": "0.3.9-next.1",
"backstage": {
"role": "backend-plugin-module",
"pluginId": "catalog",
diff --git a/plugins/catalog-backend-module-gitea/CHANGELOG.md b/plugins/catalog-backend-module-gitea/CHANGELOG.md
index 0e3ec28314..11f4ff7cc3 100644
--- a/plugins/catalog-backend-module-gitea/CHANGELOG.md
+++ b/plugins/catalog-backend-module-gitea/CHANGELOG.md
@@ -1,5 +1,17 @@
# @backstage/plugin-catalog-backend-module-gitea
+## 0.1.7-next.1
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/integration@1.18.3-next.1
+ - @backstage/backend-plugin-api@1.6.0-next.1
+ - @backstage/config@1.3.6
+ - @backstage/errors@1.2.7
+ - @backstage/plugin-catalog-common@1.1.7
+ - @backstage/plugin-catalog-node@1.20.1-next.1
+
## 0.1.7-next.0
### Patch Changes
diff --git a/plugins/catalog-backend-module-gitea/package.json b/plugins/catalog-backend-module-gitea/package.json
index f4dacc1e06..d80ddb806f 100644
--- a/plugins/catalog-backend-module-gitea/package.json
+++ b/plugins/catalog-backend-module-gitea/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-catalog-backend-module-gitea",
- "version": "0.1.7-next.0",
+ "version": "0.1.7-next.1",
"license": "Apache-2.0",
"description": "The gitea backend module for the catalog plugin.",
"main": "src/index.ts",
diff --git a/plugins/catalog-backend-module-github-org/CHANGELOG.md b/plugins/catalog-backend-module-github-org/CHANGELOG.md
index b3f624781d..2c7acb8b3e 100644
--- a/plugins/catalog-backend-module-github-org/CHANGELOG.md
+++ b/plugins/catalog-backend-module-github-org/CHANGELOG.md
@@ -1,5 +1,28 @@
# @backstage/plugin-catalog-backend-module-github-org
+## 0.3.17-next.2
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-events-node@0.4.18-next.1
+ - @backstage/backend-plugin-api@1.6.0-next.1
+ - @backstage/config@1.3.6
+ - @backstage/plugin-catalog-backend-module-github@0.11.3-next.2
+ - @backstage/plugin-catalog-node@1.20.1-next.1
+
+## 0.3.17-next.1
+
+### Patch Changes
+
+- ed5a7a3: Introduce new configuration option to exclude suspended users from GitHub Enterprise instances.
+
+ When it’s set to true, suspended users won’t be returned when querying the organization users for GitHub Enterprise instances.
+ Note that this option should be used only against GitHub Enterprise instances, the property does not exist in the github.com GraphQL schema, setting it will cause a schema validation error and the syncing of users will fail.
+
+- Updated dependencies
+ - @backstage/plugin-catalog-backend-module-github@0.11.3-next.1
+
## 0.3.17-next.0
### Patch Changes
diff --git a/plugins/catalog-backend-module-github-org/package.json b/plugins/catalog-backend-module-github-org/package.json
index dcdfb2a578..0d871749ea 100644
--- a/plugins/catalog-backend-module-github-org/package.json
+++ b/plugins/catalog-backend-module-github-org/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-catalog-backend-module-github-org",
- "version": "0.3.17-next.0",
+ "version": "0.3.17-next.2",
"description": "The github-org backend module for the catalog plugin.",
"backstage": {
"role": "backend-plugin-module",
diff --git a/plugins/catalog-backend-module-github-org/src/module.ts b/plugins/catalog-backend-module-github-org/src/module.ts
index 2d349cb873..26abede133 100644
--- a/plugins/catalog-backend-module-github-org/src/module.ts
+++ b/plugins/catalog-backend-module-github-org/src/module.ts
@@ -121,6 +121,7 @@ export const catalogModuleGithubOrgEntityProvider = createBackendModule({
alwaysUseDefaultNamespace:
definitions.length === 1 && definition.orgs?.length === 1,
pageSizes: definition.pageSizes,
+ excludeSuspendedUsers: definition.excludeSuspendedUsers,
}),
);
}
@@ -139,6 +140,7 @@ function readDefinitionsFromConfig(rootConfig: Config): Array<{
teamMembers?: number;
organizationMembers?: number;
};
+ excludeSuspendedUsers?: boolean;
}> {
const baseKey = 'catalog.providers.githubOrg';
const baseConfig = rootConfig.getOptional(baseKey);
@@ -166,5 +168,7 @@ function readDefinitionsFromConfig(rootConfig: Config): Array<{
),
}
: undefined,
+ excludeSuspendedUsers:
+ c.getOptionalBoolean('excludeSuspendedUsers') ?? false,
}));
}
diff --git a/plugins/catalog-backend-module-github/CHANGELOG.md b/plugins/catalog-backend-module-github/CHANGELOG.md
index ae4052af1e..2247087317 100644
--- a/plugins/catalog-backend-module-github/CHANGELOG.md
+++ b/plugins/catalog-backend-module-github/CHANGELOG.md
@@ -1,5 +1,27 @@
# @backstage/plugin-catalog-backend-module-github
+## 0.11.3-next.2
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-events-node@0.4.18-next.1
+ - @backstage/integration@1.18.3-next.1
+ - @backstage/backend-plugin-api@1.6.0-next.1
+ - @backstage/catalog-model@1.7.6
+ - @backstage/config@1.3.6
+ - @backstage/plugin-catalog-common@1.1.7
+ - @backstage/plugin-catalog-node@1.20.1-next.1
+
+## 0.11.3-next.1
+
+### Patch Changes
+
+- ed5a7a3: Introduce new configuration option to exclude suspended users from GitHub Enterprise instances.
+
+ When it’s set to true, suspended users won’t be returned when querying the organization users for GitHub Enterprise instances.
+ Note that this option should be used only against GitHub Enterprise instances, the property does not exist in the github.com GraphQL schema, setting it will cause a schema validation error and the syncing of users will fail.
+
## 0.11.3-next.0
### Patch Changes
diff --git a/plugins/catalog-backend-module-github/config.d.ts b/plugins/catalog-backend-module-github/config.d.ts
index f3cbb15e06..5425cae9d0 100644
--- a/plugins/catalog-backend-module-github/config.d.ts
+++ b/plugins/catalog-backend-module-github/config.d.ts
@@ -264,6 +264,12 @@ export interface Config {
*/
orgs?: string[];
+ /**
+ * (Optional) Only for GitHub Enterprise. Whether to exclude suspended users when querying organization users.
+ * Default: `false`.
+ */
+ excludeSuspendedUsers?: boolean;
+
/**
* The refresh schedule to use.
*/
@@ -315,6 +321,12 @@ export interface Config {
*/
orgs?: string[];
+ /**
+ * (Optional) Only for GitHub Enterprise. Whether to exclude suspended users when querying organization users.
+ * Default: `false`.
+ */
+ excludeSuspendedUsers?: boolean;
+
/**
* The refresh schedule to use.
*/
diff --git a/plugins/catalog-backend-module-github/package.json b/plugins/catalog-backend-module-github/package.json
index fb58848838..cbd57f1568 100644
--- a/plugins/catalog-backend-module-github/package.json
+++ b/plugins/catalog-backend-module-github/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-catalog-backend-module-github",
- "version": "0.11.3-next.0",
+ "version": "0.11.3-next.2",
"description": "A Backstage catalog backend module that helps integrate towards GitHub",
"backstage": {
"role": "backend-plugin-module",
diff --git a/plugins/catalog-backend-module-github/report.api.md b/plugins/catalog-backend-module-github/report.api.md
index 016bb6da65..aa275cfc9e 100644
--- a/plugins/catalog-backend-module-github/report.api.md
+++ b/plugins/catalog-backend-module-github/report.api.md
@@ -151,6 +151,7 @@ export class GithubMultiOrgEntityProvider implements EntityProvider {
teamTransformer?: TeamTransformer;
alwaysUseDefaultNamespace?: boolean;
pageSizes?: Partial;
+ excludeSuspendedUsers?: boolean;
});
connect(connection: EntityProviderConnection): Promise;
// (undocumented)
@@ -166,6 +167,7 @@ export class GithubMultiOrgEntityProvider implements EntityProvider {
export interface GithubMultiOrgEntityProviderOptions {
alwaysUseDefaultNamespace?: boolean;
events?: EventsService;
+ excludeSuspendedUsers?: boolean;
githubCredentialsProvider?: GithubCredentialsProvider;
githubUrl: string;
id: string;
@@ -227,6 +229,8 @@ export class GithubOrgEntityProvider implements EntityProvider {
githubCredentialsProvider?: GithubCredentialsProvider;
userTransformer?: UserTransformer;
teamTransformer?: TeamTransformer;
+ pageSizes?: Partial;
+ excludeSuspendedUsers?: boolean;
});
connect(connection: EntityProviderConnection): Promise;
// (undocumented)
@@ -244,10 +248,12 @@ export type GitHubOrgEntityProviderOptions = GithubOrgEntityProviderOptions;
// @public
export interface GithubOrgEntityProviderOptions {
events?: EventsService;
+ excludeSuspendedUsers?: boolean;
githubCredentialsProvider?: GithubCredentialsProvider;
id: string;
logger: LoggerService;
orgUrl: string;
+ pageSizes?: Partial;
schedule?: 'manual' | SchedulerServiceTaskRunner;
teamTransformer?: TeamTransformer;
userTransformer?: UserTransformer;
@@ -306,6 +312,7 @@ export type GithubUser = {
email?: string;
name?: string;
organizationVerifiedDomainEmails?: string[];
+ suspendedAt?: string;
};
// @public
diff --git a/plugins/catalog-backend-module-github/src/lib/github.test.ts b/plugins/catalog-backend-module-github/src/lib/github.test.ts
index ca9b3eb692..6933c9a245 100644
--- a/plugins/catalog-backend-module-github/src/lib/github.test.ts
+++ b/plugins/catalog-backend-module-github/src/lib/github.test.ts
@@ -166,6 +166,54 @@ describe('github', () => {
getOrganizationUsers(graphql, 'a', 'token'),
).resolves.toEqual(output);
});
+
+ it('reads members excluding suspended users', async () => {
+ const input: QueryResponse = {
+ organization: {
+ membersWithRole: {
+ pageInfo: { hasNextPage: false },
+ nodes: [
+ {
+ login: 'a',
+ name: 'b',
+ bio: 'c',
+ email: 'd',
+ avatarUrl: 'e',
+ suspendedAt: '2025-01-01',
+ },
+ {
+ login: 'a',
+ name: 'b',
+ bio: 'c',
+ email: 'd',
+ avatarUrl: 'e',
+ suspendedAt: undefined,
+ },
+ ],
+ },
+ },
+ };
+
+ const output = {
+ users: [
+ expect.objectContaining({
+ metadata: expect.objectContaining({ name: 'a', description: 'c' }),
+ spec: {
+ profile: { displayName: 'b', email: 'd', picture: 'e' },
+ memberOf: [],
+ },
+ }),
+ ],
+ };
+
+ server.use(
+ graphqlMsw.query('users', () => HttpResponse.json({ data: input })),
+ );
+
+ await expect(
+ getOrganizationUsers(graphql, 'a', 'token', undefined, undefined, true),
+ ).resolves.toEqual(output);
+ });
});
describe('getOrganizationUsers using custom UserTransformer', () => {
@@ -279,6 +327,63 @@ describe('github', () => {
expect(users.users).toHaveLength(1);
expect(users).toEqual(output);
});
+
+ it('reads members including suspended users', async () => {
+ const input: QueryResponse = {
+ organization: {
+ membersWithRole: {
+ pageInfo: { hasNextPage: false },
+ nodes: [
+ {
+ login: 'a',
+ name: 'b',
+ bio: 'c',
+ email: 'd',
+ avatarUrl: 'e',
+ },
+ {
+ login: 'ab',
+ name: 'bb',
+ bio: 'cc',
+ email: 'dd',
+ avatarUrl: 'ee',
+ suspendedAt: '2025-01-01',
+ },
+ ],
+ },
+ },
+ };
+
+ const output = {
+ users: [
+ expect.objectContaining({
+ metadata: expect.objectContaining({
+ name: 'a-custom',
+ }),
+ }),
+ expect.objectContaining({
+ metadata: expect.objectContaining({
+ name: 'ab-custom',
+ }),
+ }),
+ ],
+ };
+
+ server.use(
+ graphqlMsw.query('users', () => HttpResponse.json({ data: input })),
+ );
+
+ await expect(
+ getOrganizationUsers(
+ graphql,
+ 'a',
+ 'token',
+ customUserTransformer,
+ undefined,
+ false,
+ ),
+ ).resolves.toEqual(output);
+ });
});
describe('getOrganizationTeams using default TeamTransformer', () => {
diff --git a/plugins/catalog-backend-module-github/src/lib/github.ts b/plugins/catalog-backend-module-github/src/lib/github.ts
index 625fb57bba..bd77df4da7 100644
--- a/plugins/catalog-backend-module-github/src/lib/github.ts
+++ b/plugins/catalog-backend-module-github/src/lib/github.ts
@@ -117,6 +117,7 @@ export type GithubUser = {
email?: string;
name?: string;
organizationVerifiedDomainEmails?: string[];
+ suspendedAt?: string;
};
/**
@@ -181,6 +182,7 @@ export type Connection = {
* @param tokenType - The type of GitHub credential
* @param userTransformer - Optional transformer for user entities
* @param pageSizes - Optional page sizes configuration
+ * @param excludeSuspendedUsers - Optional flag to exclude suspended users (only for GitHub Enterprise instances)
*/
export async function getOrganizationUsers(
client: typeof graphql,
@@ -188,7 +190,9 @@ export async function getOrganizationUsers(
tokenType: GithubCredentialType,
userTransformer: UserTransformer = defaultUserTransformer,
pageSizes: GithubPageSizes = DEFAULT_PAGE_SIZES,
+ excludeSuspendedUsers: boolean = false,
): Promise<{ users: Entity[] }> {
+ const suspendedAtField = excludeSuspendedUsers ? 'suspendedAt,' : '';
const query = `
query users($org: String!, $email: Boolean!, $cursor: String, $organizationMembersPageSize: Int!) {
organization(login: $org) {
@@ -200,6 +204,7 @@ export async function getOrganizationUsers(
email @include(if: $email),
login,
name,
+ ${suspendedAtField}
organizationVerifiedDomainEmails(login: $org)
}
}
@@ -209,18 +214,19 @@ export async function getOrganizationUsers(
// There is no user -> teams edge, so we leave the memberships empty for
// now and let the team iteration handle it instead
- const users = await queryWithPaging(
+ const users = await queryWithPaging({
client,
query,
org,
- r => r.organization?.membersWithRole,
- userTransformer,
- {
+ connection: r => r.organization?.membersWithRole,
+ transformer: userTransformer,
+ variables: {
org,
email: tokenType === 'token',
organizationMembersPageSize: pageSizes.organizationMembers,
},
- );
+ filter: u => (excludeSuspendedUsers ? !u.suspendedAt : true),
+ });
return { users };
}
@@ -305,18 +311,18 @@ export async function getOrganizationTeams(
return await teamTransformer(team, ctx);
};
- const teams = await queryWithPaging(
+ const teams = await queryWithPaging({
client,
query,
org,
- r => r.organization?.teams,
- materialisedTeams,
- {
+ connection: r => r.organization?.teams,
+ transformer: materialisedTeams,
+ variables: {
org,
teamsPageSize: pageSizes.teams,
membersPageSize: pageSizes.teamMembers,
},
- );
+ });
return { teams };
}
@@ -399,19 +405,19 @@ export async function getOrganizationTeamsFromUsers(
return await teamTransformer(team, ctx);
};
- const teams = await queryWithPaging(
+ const teams = await queryWithPaging({
client,
query,
org,
- r => r.organization?.teams,
- materialisedTeams,
- {
+ connection: r => r.organization?.teams,
+ transformer: materialisedTeams,
+ variables: {
org,
userLogins,
teamsPageSize: pageSizes.teams,
membersPageSize: pageSizes.teamMembers,
},
- );
+ });
return { teams };
}
@@ -458,14 +464,14 @@ export async function getOrganizationTeamsForUser(
return await teamTransformer(team, ctx);
};
- const teams = await queryWithPaging(
+ const teams = await queryWithPaging({
client,
query,
org,
- r => r.organization?.teams,
- materialisedTeams,
- { org, userLogins: [userLogin], teamsPageSize: pageSizes.teams },
- );
+ connection: r => r.organization?.teams,
+ transformer: materialisedTeams,
+ variables: { org, userLogins: [userLogin], teamsPageSize: pageSizes.teams },
+ });
return { teams };
}
@@ -486,14 +492,14 @@ export async function getOrganizationsFromUser(
}
}`;
- const orgs = await queryWithPaging(
+ const orgs = await queryWithPaging({
client,
query,
- '',
- r => r.user?.organizations,
- async o => o.login,
- { user },
- );
+ org: '',
+ connection: r => r.user?.organizations,
+ transformer: async o => o.login,
+ variables: { user },
+ });
return { orgs };
}
@@ -632,14 +638,18 @@ export async function getOrganizationRepositories(
}
}`;
- const repositories = await queryWithPaging(
+ const repositories = await queryWithPaging({
client,
query,
org,
- r => r.repositoryOwner?.repositories,
- async x => x,
- { org, catalogPathRef, repositoriesPageSize: pageSizes.repositories },
- );
+ connection: r => r.repositoryOwner?.repositories,
+ transformer: async x => x,
+ variables: {
+ org,
+ catalogPathRef,
+ repositoriesPageSize: pageSizes.repositories,
+ },
+ });
return { repositories };
}
@@ -727,14 +737,14 @@ export async function getTeamMembers(
}
}`;
- const members = await queryWithPaging(
+ const members = await queryWithPaging({
client,
query,
org,
- r => r.organization?.team?.members,
- async user => user,
- { org, teamSlug, membersPageSize: pageSizes.teamMembers },
- );
+ connection: r => r.organization?.team?.members,
+ transformer: async user => user,
+ variables: { org, teamSlug, membersPageSize: pageSizes.teamMembers },
+ });
return { members };
}
@@ -748,31 +758,36 @@ export async function getTeamMembers(
*
* Requires that the query accepts a $cursor variable.
*
- * @param client - The octokit client
- * @param query - The query to execute
- * @param org - The slug of the org to read
- * @param connection - A function that, given the response, picks out the actual
+ * @param params - Object containing all parameters
+ * @param params.client - The octokit client
+ * @param params.query - The query to execute
+ * @param params.org - The slug of the org to read
+ * @param params.connection - A function that, given the response, picks out the actual
* Connection object that's being iterated
- * @param transformer - A function that, given one of the nodes in the Connection,
+ * @param params.transformer - A function that, given one of the nodes in the Connection,
* returns the model mapped form of it
- * @param variables - The variable values that the query needs, minus the cursor
+ * @param params.variables - The variable values that the query needs, minus the cursor
+ * @param params.filter - An optional filter function to filter the nodes before transforming them
*/
export async function queryWithPaging<
GraphqlType,
OutputType,
Variables extends {},
Response = QueryResponse,
->(
- client: typeof graphql,
- query: string,
- org: string,
- connection: (response: Response) => Connection | undefined,
+>(params: {
+ client: typeof graphql;
+ query: string;
+ org: string;
+ connection: (response: Response) => Connection | undefined;
transformer: (
item: GraphqlType,
ctx: TransformerContext,
- ) => Promise,
- variables: Variables,
-): Promise {
+ ) => Promise;
+ variables: Variables;
+ filter?: (item: GraphqlType) => boolean;
+}): Promise {
+ const { client, query, org, connection, transformer, variables, filter } =
+ params;
const result: OutputType[] = [];
const sleep = (ms: number) => new Promise(r => setTimeout(r, ms));
@@ -789,6 +804,9 @@ export async function queryWithPaging<
}
for (const node of conn.nodes) {
+ if (filter && !filter(node)) {
+ continue;
+ }
const transformedNode = await transformer(node, {
client,
query,
diff --git a/plugins/catalog-backend-module-github/src/providers/GithubMultiOrgEntityProvider.ts b/plugins/catalog-backend-module-github/src/providers/GithubMultiOrgEntityProvider.ts
index 839ca66e40..173da84f58 100644
--- a/plugins/catalog-backend-module-github/src/providers/GithubMultiOrgEntityProvider.ts
+++ b/plugins/catalog-backend-module-github/src/providers/GithubMultiOrgEntityProvider.ts
@@ -174,6 +174,14 @@ export interface GithubMultiOrgEntityProviderOptions {
* Reduce these values if hitting RESOURCE_LIMITS_EXCEEDED errors.
*/
pageSizes?: Partial;
+
+ /**
+ * Optionally exclude suspended users when querying organization users.
+ * @defaultValue false
+ * @remarks
+ * Only for GitHub Enterprise instances. Will error if used against GitHub.com API.
+ */
+ excludeSuspendedUsers?: boolean;
}
type CreateDeltaOperation = (entities: Entity[]) => {
@@ -221,6 +229,7 @@ export class GithubMultiOrgEntityProvider implements EntityProvider {
events: options.events,
alwaysUseDefaultNamespace: options.alwaysUseDefaultNamespace,
pageSizes: options.pageSizes,
+ excludeSuspendedUsers: options.excludeSuspendedUsers,
});
provider.schedule(options.schedule);
@@ -241,6 +250,7 @@ export class GithubMultiOrgEntityProvider implements EntityProvider {
teamTransformer?: TeamTransformer;
alwaysUseDefaultNamespace?: boolean;
pageSizes?: Partial;
+ excludeSuspendedUsers?: boolean;
},
) {}
@@ -306,6 +316,7 @@ export class GithubMultiOrgEntityProvider implements EntityProvider {
tokenType,
this.options.userTransformer,
pageSizes,
+ this.options.excludeSuspendedUsers,
);
const { teams } = await getOrganizationTeams(
@@ -458,6 +469,7 @@ export class GithubMultiOrgEntityProvider implements EntityProvider {
tokenType,
this.options.userTransformer,
pageSizes,
+ this.options.excludeSuspendedUsers,
);
const { teams } = await getOrganizationTeams(
@@ -692,6 +704,7 @@ export class GithubMultiOrgEntityProvider implements EntityProvider {
tokenType,
this.options.userTransformer,
pageSizes,
+ this.options.excludeSuspendedUsers,
);
const usersFromChangedGroup = isGroupEntity(team)
diff --git a/plugins/catalog-backend-module-github/src/providers/GithubOrgEntityProvider.ts b/plugins/catalog-backend-module-github/src/providers/GithubOrgEntityProvider.ts
index 6dfa8a07f8..35ec849e12 100644
--- a/plugins/catalog-backend-module-github/src/providers/GithubOrgEntityProvider.ts
+++ b/plugins/catalog-backend-module-github/src/providers/GithubOrgEntityProvider.ts
@@ -53,11 +53,13 @@ import {
createGraphqlClient,
createRemoveEntitiesOperation,
createReplaceEntitiesOperation,
+ DEFAULT_PAGE_SIZES,
DeferredEntitiesBuilder,
getOrganizationTeam,
getOrganizationTeams,
getOrganizationTeamsFromUsers,
getOrganizationUsers,
+ GithubPageSizes,
GithubTeam,
} from '../lib/github';
import { areGroupEntities, areUserEntities } from '../lib/guards';
@@ -130,6 +132,20 @@ export interface GithubOrgEntityProviderOptions {
* Optionally include a team transformer for transforming from GitHub teams to Group Entities
*/
teamTransformer?: TeamTransformer;
+
+ /**
+ * Optionally configure page sizes for GitHub GraphQL API queries.
+ * Reduce these values if hitting RESOURCE_LIMITS_EXCEEDED errors.
+ */
+ pageSizes?: Partial;
+
+ /**
+ * Optionally exclude suspended users when querying organization users.
+ * @defaultValue false
+ * @remarks
+ * Only for GitHub Enterprise instances. Will error if used against GitHub.com API.
+ */
+ excludeSuspendedUsers?: boolean;
}
/**
@@ -167,6 +183,8 @@ export class GithubOrgEntityProvider implements EntityProvider {
userTransformer: options.userTransformer,
teamTransformer: options.teamTransformer,
events: options.events,
+ pageSizes: options.pageSizes,
+ excludeSuspendedUsers: options.excludeSuspendedUsers,
});
provider.schedule(options.schedule);
@@ -184,6 +202,8 @@ export class GithubOrgEntityProvider implements EntityProvider {
githubCredentialsProvider?: GithubCredentialsProvider;
userTransformer?: UserTransformer;
teamTransformer?: TeamTransformer;
+ pageSizes?: Partial;
+ excludeSuspendedUsers?: boolean;
},
) {
this.credentialsProvider =
@@ -196,6 +216,13 @@ export class GithubOrgEntityProvider implements EntityProvider {
return `GithubOrgEntityProvider:${this.options.id}`;
}
+ private getPageSizes(): GithubPageSizes {
+ return {
+ ...DEFAULT_PAGE_SIZES,
+ ...this.options.pageSizes,
+ };
+ }
+
/** {@inheritdoc @backstage/plugin-catalog-node#EntityProvider.connect} */
async connect(connection: EntityProviderConnection) {
this.connection = connection;
@@ -231,16 +258,20 @@ export class GithubOrgEntityProvider implements EntityProvider {
});
const { org } = parseGithubOrgUrl(this.options.orgUrl);
+ const pageSizes = this.getPageSizes();
const { users } = await getOrganizationUsers(
client,
org,
tokenType,
this.options.userTransformer,
+ pageSizes,
+ this.options.excludeSuspendedUsers,
);
const { teams } = await getOrganizationTeams(
client,
org,
this.options.teamTransformer,
+ pageSizes,
);
if (areGroupEntities(teams)) {
@@ -352,6 +383,7 @@ export class GithubOrgEntityProvider implements EntityProvider {
});
const { org } = parseGithubOrgUrl(this.options.orgUrl);
+ const pageSizes = this.getPageSizes();
const { team } = await getOrganizationTeam(
client,
org,
@@ -364,6 +396,8 @@ export class GithubOrgEntityProvider implements EntityProvider {
org,
tokenType,
this.options.userTransformer,
+ pageSizes,
+ this.options.excludeSuspendedUsers,
);
if (!isGroupEntity(team)) {
@@ -380,6 +414,7 @@ export class GithubOrgEntityProvider implements EntityProvider {
org,
usersToRebuild.map(u => u.metadata.name),
this.options.teamTransformer,
+ pageSizes,
);
if (areGroupEntities(teams)) {
@@ -443,6 +478,7 @@ export class GithubOrgEntityProvider implements EntityProvider {
});
const { org } = parseGithubOrgUrl(this.options.orgUrl);
+ const pageSizes = this.getPageSizes();
const { team } = await getOrganizationTeam(
client,
org,
@@ -455,6 +491,8 @@ export class GithubOrgEntityProvider implements EntityProvider {
org,
tokenType,
this.options.userTransformer,
+ pageSizes,
+ this.options.excludeSuspendedUsers,
);
const usersToRebuild = users.filter(u => u.metadata.name === userLogin);
@@ -464,6 +502,7 @@ export class GithubOrgEntityProvider implements EntityProvider {
org,
[userLogin],
this.options.teamTransformer,
+ pageSizes,
);
// we include group because the removed event need to update the old group too
diff --git a/plugins/catalog-backend-module-gitlab-org/CHANGELOG.md b/plugins/catalog-backend-module-gitlab-org/CHANGELOG.md
index c7cb44a75f..1f9bc5035d 100644
--- a/plugins/catalog-backend-module-gitlab-org/CHANGELOG.md
+++ b/plugins/catalog-backend-module-gitlab-org/CHANGELOG.md
@@ -1,5 +1,15 @@
# @backstage/plugin-catalog-backend-module-gitlab-org
+## 0.2.16-next.1
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-events-node@0.4.18-next.1
+ - @backstage/backend-plugin-api@1.6.0-next.1
+ - @backstage/plugin-catalog-backend-module-gitlab@0.7.6-next.1
+ - @backstage/plugin-catalog-node@1.20.1-next.1
+
## 0.2.16-next.0
### Patch Changes
diff --git a/plugins/catalog-backend-module-gitlab-org/package.json b/plugins/catalog-backend-module-gitlab-org/package.json
index 1ecdd6b91d..12d6b52425 100644
--- a/plugins/catalog-backend-module-gitlab-org/package.json
+++ b/plugins/catalog-backend-module-gitlab-org/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-catalog-backend-module-gitlab-org",
- "version": "0.2.16-next.0",
+ "version": "0.2.16-next.1",
"description": "The gitlab-org backend module for the catalog plugin.",
"backstage": {
"role": "backend-plugin-module",
diff --git a/plugins/catalog-backend-module-gitlab/CHANGELOG.md b/plugins/catalog-backend-module-gitlab/CHANGELOG.md
index e4a8799928..9736abe90b 100644
--- a/plugins/catalog-backend-module-gitlab/CHANGELOG.md
+++ b/plugins/catalog-backend-module-gitlab/CHANGELOG.md
@@ -1,5 +1,19 @@
# @backstage/plugin-catalog-backend-module-gitlab
+## 0.7.6-next.1
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-defaults@0.14.0-next.1
+ - @backstage/plugin-events-node@0.4.18-next.1
+ - @backstage/integration@1.18.3-next.1
+ - @backstage/backend-plugin-api@1.6.0-next.1
+ - @backstage/catalog-model@1.7.6
+ - @backstage/config@1.3.6
+ - @backstage/plugin-catalog-common@1.1.7
+ - @backstage/plugin-catalog-node@1.20.1-next.1
+
## 0.7.6-next.0
### Patch Changes
diff --git a/plugins/catalog-backend-module-gitlab/package.json b/plugins/catalog-backend-module-gitlab/package.json
index 28838904cd..37edb7bb1a 100644
--- a/plugins/catalog-backend-module-gitlab/package.json
+++ b/plugins/catalog-backend-module-gitlab/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-catalog-backend-module-gitlab",
- "version": "0.7.6-next.0",
+ "version": "0.7.6-next.1",
"description": "A Backstage catalog backend module that helps integrate towards GitLab",
"backstage": {
"role": "backend-plugin-module",
diff --git a/plugins/catalog-backend-module-incremental-ingestion/CHANGELOG.md b/plugins/catalog-backend-module-incremental-ingestion/CHANGELOG.md
index 3d29535081..d2cd96a4b1 100644
--- a/plugins/catalog-backend-module-incremental-ingestion/CHANGELOG.md
+++ b/plugins/catalog-backend-module-incremental-ingestion/CHANGELOG.md
@@ -1,5 +1,23 @@
# @backstage/plugin-catalog-backend-module-incremental-ingestion
+## 0.7.7-next.1
+
+### Patch Changes
+
+- de96a60: chore(deps): bump `express` from 4.21.2 to 4.22.0
+- fb029b6: Updated luxon types
+- Updated dependencies
+ - @backstage/backend-defaults@0.14.0-next.1
+ - @backstage/plugin-catalog-backend@3.2.1-next.1
+ - @backstage/plugin-events-node@0.4.18-next.1
+ - @backstage/backend-plugin-api@1.6.0-next.1
+ - @backstage/catalog-model@1.7.6
+ - @backstage/config@1.3.6
+ - @backstage/errors@1.2.7
+ - @backstage/types@1.2.2
+ - @backstage/plugin-catalog-node@1.20.1-next.1
+ - @backstage/plugin-permission-common@0.9.3
+
## 0.7.7-next.0
### Patch Changes
diff --git a/plugins/catalog-backend-module-incremental-ingestion/package.json b/plugins/catalog-backend-module-incremental-ingestion/package.json
index 963ff2f0ee..875d3c3d9e 100644
--- a/plugins/catalog-backend-module-incremental-ingestion/package.json
+++ b/plugins/catalog-backend-module-incremental-ingestion/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-catalog-backend-module-incremental-ingestion",
- "version": "0.7.7-next.0",
+ "version": "0.7.7-next.1",
"description": "An entity provider for streaming large asset sources into the catalog",
"backstage": {
"role": "backend-plugin-module",
@@ -58,7 +58,7 @@
"@backstage/plugin-permission-common": "workspace:^",
"@backstage/types": "workspace:^",
"@opentelemetry/api": "^1.9.0",
- "express": "^4.17.1",
+ "express": "^4.22.0",
"express-promise-router": "^4.1.0",
"knex": "^3.0.0",
"luxon": "^3.0.0",
@@ -67,7 +67,6 @@
"devDependencies": {
"@backstage/backend-test-utils": "workspace:^",
"@backstage/cli": "workspace:^",
- "@types/express": "^4.17.6",
- "@types/luxon": "^3.0.0"
+ "@types/express": "^4.17.6"
}
}
diff --git a/plugins/catalog-backend-module-ldap/CHANGELOG.md b/plugins/catalog-backend-module-ldap/CHANGELOG.md
index 2dbc7cdfa1..9e4cca6cc4 100644
--- a/plugins/catalog-backend-module-ldap/CHANGELOG.md
+++ b/plugins/catalog-backend-module-ldap/CHANGELOG.md
@@ -1,5 +1,18 @@
# @backstage/plugin-catalog-backend-module-ldap
+## 0.12.1-next.1
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-plugin-api@1.6.0-next.1
+ - @backstage/catalog-model@1.7.6
+ - @backstage/config@1.3.6
+ - @backstage/errors@1.2.7
+ - @backstage/types@1.2.2
+ - @backstage/plugin-catalog-common@1.1.7
+ - @backstage/plugin-catalog-node@1.20.1-next.1
+
## 0.12.1-next.0
### Patch Changes
diff --git a/plugins/catalog-backend-module-ldap/package.json b/plugins/catalog-backend-module-ldap/package.json
index 4ed1c23ed5..abf0717679 100644
--- a/plugins/catalog-backend-module-ldap/package.json
+++ b/plugins/catalog-backend-module-ldap/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-catalog-backend-module-ldap",
- "version": "0.12.1-next.0",
+ "version": "0.12.1-next.1",
"description": "A Backstage catalog backend module that helps integrate towards LDAP",
"backstage": {
"role": "backend-plugin-module",
diff --git a/plugins/catalog-backend-module-logs/CHANGELOG.md b/plugins/catalog-backend-module-logs/CHANGELOG.md
index 213138f4de..ffcf0a98ba 100644
--- a/plugins/catalog-backend-module-logs/CHANGELOG.md
+++ b/plugins/catalog-backend-module-logs/CHANGELOG.md
@@ -1,5 +1,14 @@
# @backstage/plugin-catalog-backend-module-logs
+## 0.1.17-next.1
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-catalog-backend@3.2.1-next.1
+ - @backstage/plugin-events-node@0.4.18-next.1
+ - @backstage/backend-plugin-api@1.6.0-next.1
+
## 0.1.17-next.0
### Patch Changes
diff --git a/plugins/catalog-backend-module-logs/package.json b/plugins/catalog-backend-module-logs/package.json
index 581467311a..2b4fd92c73 100644
--- a/plugins/catalog-backend-module-logs/package.json
+++ b/plugins/catalog-backend-module-logs/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-catalog-backend-module-logs",
- "version": "0.1.17-next.0",
+ "version": "0.1.17-next.1",
"description": "A module that subscribes to catalog related events and logs them.",
"backstage": {
"role": "backend-plugin-module",
diff --git a/plugins/catalog-backend-module-msgraph/CHANGELOG.md b/plugins/catalog-backend-module-msgraph/CHANGELOG.md
index 51433c91c1..7354d45c76 100644
--- a/plugins/catalog-backend-module-msgraph/CHANGELOG.md
+++ b/plugins/catalog-backend-module-msgraph/CHANGELOG.md
@@ -1,5 +1,16 @@
# @backstage/plugin-catalog-backend-module-msgraph
+## 0.8.3-next.1
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-plugin-api@1.6.0-next.1
+ - @backstage/catalog-model@1.7.6
+ - @backstage/config@1.3.6
+ - @backstage/plugin-catalog-common@1.1.7
+ - @backstage/plugin-catalog-node@1.20.1-next.1
+
## 0.8.3-next.0
### Patch Changes
diff --git a/plugins/catalog-backend-module-msgraph/package.json b/plugins/catalog-backend-module-msgraph/package.json
index 5a4161ae1f..9b87318300 100644
--- a/plugins/catalog-backend-module-msgraph/package.json
+++ b/plugins/catalog-backend-module-msgraph/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-catalog-backend-module-msgraph",
- "version": "0.8.3-next.0",
+ "version": "0.8.3-next.1",
"description": "A Backstage catalog backend module that helps integrate towards Microsoft Graph",
"backstage": {
"role": "backend-plugin-module",
diff --git a/plugins/catalog-backend-module-openapi/CHANGELOG.md b/plugins/catalog-backend-module-openapi/CHANGELOG.md
index 3fd5040a18..af02b2a7dc 100644
--- a/plugins/catalog-backend-module-openapi/CHANGELOG.md
+++ b/plugins/catalog-backend-module-openapi/CHANGELOG.md
@@ -1,5 +1,17 @@
# @backstage/plugin-catalog-backend-module-openapi
+## 0.2.17-next.1
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/integration@1.18.3-next.1
+ - @backstage/backend-plugin-api@1.6.0-next.1
+ - @backstage/catalog-model@1.7.6
+ - @backstage/types@1.2.2
+ - @backstage/plugin-catalog-common@1.1.7
+ - @backstage/plugin-catalog-node@1.20.1-next.1
+
## 0.2.17-next.0
### Patch Changes
diff --git a/plugins/catalog-backend-module-openapi/package.json b/plugins/catalog-backend-module-openapi/package.json
index a32778dfe4..47ea21295f 100644
--- a/plugins/catalog-backend-module-openapi/package.json
+++ b/plugins/catalog-backend-module-openapi/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-catalog-backend-module-openapi",
- "version": "0.2.17-next.0",
+ "version": "0.2.17-next.1",
"description": "A Backstage catalog backend module that helps with OpenAPI specifications",
"backstage": {
"role": "backend-plugin-module",
diff --git a/plugins/catalog-backend-module-puppetdb/CHANGELOG.md b/plugins/catalog-backend-module-puppetdb/CHANGELOG.md
index ef31a1fa75..01df77b6e7 100644
--- a/plugins/catalog-backend-module-puppetdb/CHANGELOG.md
+++ b/plugins/catalog-backend-module-puppetdb/CHANGELOG.md
@@ -1,5 +1,17 @@
# @backstage/plugin-catalog-backend-module-puppetdb
+## 0.2.17-next.1
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-plugin-api@1.6.0-next.1
+ - @backstage/catalog-model@1.7.6
+ - @backstage/config@1.3.6
+ - @backstage/errors@1.2.7
+ - @backstage/types@1.2.2
+ - @backstage/plugin-catalog-node@1.20.1-next.1
+
## 0.2.17-next.0
### Patch Changes
diff --git a/plugins/catalog-backend-module-puppetdb/package.json b/plugins/catalog-backend-module-puppetdb/package.json
index 218d037800..baaa9b1adb 100644
--- a/plugins/catalog-backend-module-puppetdb/package.json
+++ b/plugins/catalog-backend-module-puppetdb/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-catalog-backend-module-puppetdb",
- "version": "0.2.17-next.0",
+ "version": "0.2.17-next.1",
"description": "A Backstage catalog backend module that helps integrate towards PuppetDB",
"backstage": {
"role": "backend-plugin-module",
diff --git a/plugins/catalog-backend-module-scaffolder-entity-model/CHANGELOG.md b/plugins/catalog-backend-module-scaffolder-entity-model/CHANGELOG.md
index fd98e743c2..490700d5f4 100644
--- a/plugins/catalog-backend-module-scaffolder-entity-model/CHANGELOG.md
+++ b/plugins/catalog-backend-module-scaffolder-entity-model/CHANGELOG.md
@@ -1,5 +1,16 @@
# @backstage/plugin-catalog-backend-module-scaffolder-entity-model
+## 0.2.15-next.1
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-plugin-api@1.6.0-next.1
+ - @backstage/catalog-model@1.7.6
+ - @backstage/plugin-catalog-common@1.1.7
+ - @backstage/plugin-catalog-node@1.20.1-next.1
+ - @backstage/plugin-scaffolder-common@1.7.4-next.0
+
## 0.2.15-next.0
### Patch Changes
diff --git a/plugins/catalog-backend-module-scaffolder-entity-model/package.json b/plugins/catalog-backend-module-scaffolder-entity-model/package.json
index bec61b7a20..c01c22cad6 100644
--- a/plugins/catalog-backend-module-scaffolder-entity-model/package.json
+++ b/plugins/catalog-backend-module-scaffolder-entity-model/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-catalog-backend-module-scaffolder-entity-model",
- "version": "0.2.15-next.0",
+ "version": "0.2.15-next.1",
"description": "Adds support for the scaffolder specific entity model (e.g. the Template kind) to the catalog backend plugin.",
"backstage": {
"role": "backend-plugin-module",
diff --git a/plugins/catalog-backend-module-unprocessed/CHANGELOG.md b/plugins/catalog-backend-module-unprocessed/CHANGELOG.md
index 49394075cf..fb3d3f57a4 100644
--- a/plugins/catalog-backend-module-unprocessed/CHANGELOG.md
+++ b/plugins/catalog-backend-module-unprocessed/CHANGELOG.md
@@ -1,5 +1,25 @@
# @backstage/plugin-catalog-backend-module-unprocessed
+## 0.6.7-next.2
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-auth-node@0.6.10-next.1
+ - @backstage/backend-plugin-api@1.6.0-next.1
+ - @backstage/catalog-model@1.7.6
+ - @backstage/errors@1.2.7
+ - @backstage/plugin-catalog-node@1.20.1-next.1
+ - @backstage/plugin-catalog-unprocessed-entities-common@0.0.12-next.0
+ - @backstage/plugin-permission-common@0.9.3
+
+## 0.6.7-next.1
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-catalog-unprocessed-entities-common@0.0.12-next.0
+
## 0.6.7-next.0
### Patch Changes
diff --git a/plugins/catalog-backend-module-unprocessed/package.json b/plugins/catalog-backend-module-unprocessed/package.json
index 50fd70e31a..d0185c8a6d 100644
--- a/plugins/catalog-backend-module-unprocessed/package.json
+++ b/plugins/catalog-backend-module-unprocessed/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-catalog-backend-module-unprocessed",
- "version": "0.6.7-next.0",
+ "version": "0.6.7-next.2",
"description": "Backstage Catalog module to view unprocessed entities",
"backstage": {
"role": "backend-plugin-module",
diff --git a/plugins/catalog-backend/CHANGELOG.md b/plugins/catalog-backend/CHANGELOG.md
index 2ab123b03f..fee155e596 100644
--- a/plugins/catalog-backend/CHANGELOG.md
+++ b/plugins/catalog-backend/CHANGELOG.md
@@ -1,5 +1,25 @@
# @backstage/plugin-catalog-backend
+## 3.2.1-next.1
+
+### Patch Changes
+
+- de96a60: chore(deps): bump `express` from 4.21.2 to 4.22.0
+- Updated dependencies
+ - @backstage/backend-openapi-utils@0.6.4-next.1
+ - @backstage/plugin-events-node@0.4.18-next.1
+ - @backstage/plugin-permission-node@0.10.7-next.1
+ - @backstage/integration@1.18.3-next.1
+ - @backstage/backend-plugin-api@1.6.0-next.1
+ - @backstage/catalog-client@1.12.1
+ - @backstage/catalog-model@1.7.6
+ - @backstage/config@1.3.6
+ - @backstage/errors@1.2.7
+ - @backstage/types@1.2.2
+ - @backstage/plugin-catalog-common@1.1.7
+ - @backstage/plugin-catalog-node@1.20.1-next.1
+ - @backstage/plugin-permission-common@0.9.3
+
## 3.2.1-next.0
### Patch Changes
diff --git a/plugins/catalog-backend/package.json b/plugins/catalog-backend/package.json
index 3be629a239..04676121a8 100644
--- a/plugins/catalog-backend/package.json
+++ b/plugins/catalog-backend/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-catalog-backend",
- "version": "3.2.1-next.0",
+ "version": "3.2.1-next.1",
"description": "The Backstage backend plugin that provides the Backstage catalog",
"backstage": {
"role": "backend-plugin",
@@ -77,7 +77,7 @@
"@opentelemetry/api": "^1.9.0",
"codeowners-utils": "^1.0.2",
"core-js": "^3.6.5",
- "express": "^4.17.1",
+ "express": "^4.22.0",
"fast-json-stable-stringify": "^2.1.0",
"fs-extra": "^11.2.0",
"git-url-parse": "^15.0.0",
diff --git a/plugins/catalog-graph/CHANGELOG.md b/plugins/catalog-graph/CHANGELOG.md
index 759f4fbb7c..7cb4eb28b4 100644
--- a/plugins/catalog-graph/CHANGELOG.md
+++ b/plugins/catalog-graph/CHANGELOG.md
@@ -1,5 +1,19 @@
# @backstage/plugin-catalog-graph
+## 0.5.4-next.1
+
+### Patch Changes
+
+- f3f84f1: Minor extension type updates after frontend API bump
+- Updated dependencies
+ - @backstage/frontend-plugin-api@0.13.2-next.1
+ - @backstage/plugin-catalog-react@1.21.4-next.2
+ - @backstage/core-components@0.18.4-next.2
+ - @backstage/catalog-client@1.12.1
+ - @backstage/catalog-model@1.7.6
+ - @backstage/core-plugin-api@1.12.1-next.0
+ - @backstage/types@1.2.2
+
## 0.5.4-next.0
### Patch Changes
diff --git a/plugins/catalog-graph/package.json b/plugins/catalog-graph/package.json
index fb28ba1a27..ff97c60d76 100644
--- a/plugins/catalog-graph/package.json
+++ b/plugins/catalog-graph/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-catalog-graph",
- "version": "0.5.4-next.0",
+ "version": "0.5.4-next.1",
"backstage": {
"role": "frontend-plugin",
"pluginId": "catalog-graph",
diff --git a/plugins/catalog-graph/report-alpha.api.md b/plugins/catalog-graph/report-alpha.api.md
index bf2087e9ec..2ce85431e8 100644
--- a/plugins/catalog-graph/report-alpha.api.md
+++ b/plugins/catalog-graph/report-alpha.api.md
@@ -11,7 +11,6 @@ import { EntityCardType } from '@backstage/plugin-catalog-react/alpha';
import { EntityPredicate } from '@backstage/plugin-catalog-react/alpha';
import { ExtensionBlueprintParams } from '@backstage/frontend-plugin-api';
import { ExtensionDataRef } from '@backstage/frontend-plugin-api';
-import { ExtensionInput } from '@backstage/frontend-plugin-api';
import { ExternalRouteRef } from '@backstage/core-plugin-api';
import { JSX as JSX_2 } from 'react';
import { OverridableExtensionDefinition } from '@backstage/frontend-plugin-api';
@@ -92,7 +91,6 @@ const _default: OverridableFrontendPlugin<
curve: 'curveStepBefore' | 'curveMonotoneX' | undefined;
title: string | undefined;
height: number | undefined;
- } & {
filter: EntityPredicate | undefined;
type: 'content' | 'summary' | 'info' | undefined;
};
@@ -108,7 +106,6 @@ const _default: OverridableFrontendPlugin<
mergeRelations?: boolean | undefined;
relationPairs?: [string, string][] | undefined;
unidirectional?: boolean | undefined;
- } & {
filter?: EntityPredicate | undefined;
type?: 'content' | 'summary' | 'info' | undefined;
};
@@ -135,15 +132,7 @@ const _default: OverridableFrontendPlugin<
optional: true;
}
>;
- inputs: {
- [x: string]: ExtensionInput<
- ExtensionDataRef,
- {
- singleton: boolean;
- optional: boolean;
- }
- >;
- };
+ inputs: {};
kind: 'entity-card';
name: 'relations';
params: {
@@ -167,7 +156,6 @@ const _default: OverridableFrontendPlugin<
relations: string[] | undefined;
relationPairs: [string, string][] | undefined;
zoom: 'disabled' | 'enabled' | 'enable-on-click' | undefined;
- } & {
path: string | undefined;
};
configInput: {
@@ -184,7 +172,6 @@ const _default: OverridableFrontendPlugin<
selectedRelations?: string[] | undefined;
selectedKinds?: string[] | undefined;
showFilters?: boolean | undefined;
- } & {
path?: string | undefined;
};
output:
@@ -197,15 +184,7 @@ const _default: OverridableFrontendPlugin<
optional: true;
}
>;
- inputs: {
- [x: string]: ExtensionInput<
- ExtensionDataRef,
- {
- singleton: boolean;
- optional: boolean;
- }
- >;
- };
+ inputs: {};
kind: 'page';
name: undefined;
params: {
diff --git a/plugins/catalog-graph/report.api.md b/plugins/catalog-graph/report.api.md
index d9342dbf36..8d3b8f2cc8 100644
--- a/plugins/catalog-graph/report.api.md
+++ b/plugins/catalog-graph/report.api.md
@@ -3,7 +3,7 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
-import { ApiRef } from '@backstage/core-plugin-api';
+import { ApiRef } from '@backstage/frontend-plugin-api';
import { BackstagePlugin } from '@backstage/core-plugin-api';
import { CompoundEntityRef } from '@backstage/catalog-model';
import { DependencyGraphTypes } from '@backstage/core-components';
diff --git a/plugins/catalog-import/report-alpha.api.md b/plugins/catalog-import/report-alpha.api.md
index a718145b24..935c3711ab 100644
--- a/plugins/catalog-import/report-alpha.api.md
+++ b/plugins/catalog-import/report-alpha.api.md
@@ -3,9 +3,9 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
-import { AnyApiFactory } from '@backstage/core-plugin-api';
+import { AnyApiFactory } from '@backstage/frontend-plugin-api';
import { AnyRouteRefParams } from '@backstage/frontend-plugin-api';
-import { ApiFactory } from '@backstage/core-plugin-api';
+import { ApiFactory } from '@backstage/frontend-plugin-api';
import { ExtensionBlueprintParams } from '@backstage/frontend-plugin-api';
import { ExtensionDataRef } from '@backstage/frontend-plugin-api';
import { JSX as JSX_2 } from 'react';
@@ -13,7 +13,7 @@ import { OverridableExtensionDefinition } from '@backstage/frontend-plugin-api';
import { OverridableFrontendPlugin } from '@backstage/frontend-plugin-api';
import { RouteRef } from '@backstage/core-plugin-api';
import { RouteRef as RouteRef_2 } from '@backstage/frontend-plugin-api';
-import { TranslationRef } from '@backstage/core-plugin-api/alpha';
+import { TranslationRef } from '@backstage/frontend-plugin-api';
// @alpha (undocumented)
export const catalogImportTranslationRef: TranslationRef<
diff --git a/plugins/catalog-import/report.api.md b/plugins/catalog-import/report.api.md
index ed7d2f3347..238231e498 100644
--- a/plugins/catalog-import/report.api.md
+++ b/plugins/catalog-import/report.api.md
@@ -3,7 +3,7 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
-import { ApiRef } from '@backstage/core-plugin-api';
+import { ApiRef } from '@backstage/frontend-plugin-api';
import { BackstagePlugin } from '@backstage/core-plugin-api';
import { CatalogApi } from '@backstage/catalog-client';
import { catalogImportTranslationRef } from '@backstage/plugin-catalog-import/alpha';
diff --git a/plugins/catalog-node/CHANGELOG.md b/plugins/catalog-node/CHANGELOG.md
index 018df720cd..018b9e4cee 100644
--- a/plugins/catalog-node/CHANGELOG.md
+++ b/plugins/catalog-node/CHANGELOG.md
@@ -1,5 +1,19 @@
# @backstage/plugin-catalog-node
+## 1.20.1-next.1
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-permission-node@0.10.7-next.1
+ - @backstage/backend-plugin-api@1.6.0-next.1
+ - @backstage/catalog-client@1.12.1
+ - @backstage/catalog-model@1.7.6
+ - @backstage/errors@1.2.7
+ - @backstage/types@1.2.2
+ - @backstage/plugin-catalog-common@1.1.7
+ - @backstage/plugin-permission-common@0.9.3
+
## 1.20.1-next.0
### Patch Changes
diff --git a/plugins/catalog-node/package.json b/plugins/catalog-node/package.json
index d083c08d34..28ee49c7a0 100644
--- a/plugins/catalog-node/package.json
+++ b/plugins/catalog-node/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-catalog-node",
- "version": "1.20.1-next.0",
+ "version": "1.20.1-next.1",
"description": "The plugin-catalog-node module for @backstage/plugin-catalog-backend",
"backstage": {
"role": "node-library",
diff --git a/plugins/catalog-react/CHANGELOG.md b/plugins/catalog-react/CHANGELOG.md
index 0133b16336..6a033f0865 100644
--- a/plugins/catalog-react/CHANGELOG.md
+++ b/plugins/catalog-react/CHANGELOG.md
@@ -1,5 +1,34 @@
# @backstage/plugin-catalog-react
+## 1.21.4-next.2
+
+### Patch Changes
+
+- b3c0594: Use a versioned context for `useEntityList`, to better work with mixed `@backstage/plugin-catalog-react` versions.
+- Updated dependencies
+ - @backstage/frontend-plugin-api@0.13.2-next.1
+ - @backstage/core-components@0.18.4-next.2
+ - @backstage/catalog-client@1.12.1
+ - @backstage/catalog-model@1.7.6
+ - @backstage/core-compat-api@0.5.5-next.0
+ - @backstage/core-plugin-api@1.12.1-next.0
+ - @backstage/errors@1.2.7
+ - @backstage/frontend-test-utils@0.4.2-next.0
+ - @backstage/integration-react@1.2.13-next.0
+ - @backstage/types@1.2.2
+ - @backstage/version-bridge@1.0.11
+ - @backstage/plugin-catalog-common@1.1.7
+ - @backstage/plugin-permission-common@0.9.3
+ - @backstage/plugin-permission-react@0.4.39-next.0
+
+## 1.21.4-next.1
+
+### Patch Changes
+
+- 6d39141: Fixed an issue where `EntityOwnerPicker` failed to filter options when the input text contained uppercase characters.
+- Updated dependencies
+ - @backstage/core-components@0.18.4-next.1
+
## 1.21.4-next.0
### Patch Changes
diff --git a/plugins/catalog-react/package.json b/plugins/catalog-react/package.json
index 3e5cc73d28..ee8e8757f6 100644
--- a/plugins/catalog-react/package.json
+++ b/plugins/catalog-react/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-catalog-react",
- "version": "1.21.4-next.0",
+ "version": "1.21.4-next.2",
"description": "A frontend library that helps other Backstage plugins interact with the catalog",
"backstage": {
"role": "web-library",
diff --git a/plugins/catalog-react/report-alpha.api.md b/plugins/catalog-react/report-alpha.api.md
index 166aa7aaaa..3f2ed575b4 100644
--- a/plugins/catalog-react/report-alpha.api.md
+++ b/plugins/catalog-react/report-alpha.api.md
@@ -16,7 +16,7 @@ import { JSX as JSX_2 } from 'react';
import { ReactNode } from 'react';
import { ResourcePermission } from '@backstage/plugin-permission-common';
import { RouteRef } from '@backstage/frontend-plugin-api';
-import { TranslationRef } from '@backstage/core-plugin-api/alpha';
+import { TranslationRef } from '@backstage/frontend-plugin-api';
// @alpha
export const CatalogFilterBlueprint: ExtensionBlueprint<{
diff --git a/plugins/catalog-react/report.api.md b/plugins/catalog-react/report.api.md
index d013199a00..14c832d545 100644
--- a/plugins/catalog-react/report.api.md
+++ b/plugins/catalog-react/report.api.md
@@ -3,7 +3,8 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
-import { ApiRef } from '@backstage/core-plugin-api';
+import { ApiRef } from '@backstage/frontend-plugin-api';
+import { ApiRef as ApiRef_2 } from '@backstage/core-plugin-api';
import { AutocompleteProps } from '@material-ui/lab/Autocomplete';
import { CATALOG_FILTER_EXISTS } from '@backstage/catalog-client';
import { CatalogApi } from '@backstage/catalog-client';
@@ -321,7 +322,7 @@ export const EntityLifecyclePicker: (props: {
initialFilter?: string[];
}) => JSX_2.Element;
-// @public
+// @public @deprecated
export const EntityListContext: Context<
EntityListContextProps | undefined
>;
@@ -475,7 +476,7 @@ export interface EntityPresentationApi {
}
// @public
-export const entityPresentationApiRef: ApiRef;
+export const entityPresentationApiRef: ApiRef_2;
// @public (undocumented)
export const EntityProcessingStatusPicker: () => JSX_2.Element;
@@ -774,7 +775,7 @@ export interface StarredEntitiesApi {
}
// @public
-export const starredEntitiesApiRef: ApiRef;
+export const starredEntitiesApiRef: ApiRef_2;
// @public (undocumented)
export const UnregisterEntityDialog: (
diff --git a/plugins/catalog-react/src/components/EntityOwnerPicker/EntityOwnerPicker.test.tsx b/plugins/catalog-react/src/components/EntityOwnerPicker/EntityOwnerPicker.test.tsx
index b8c8e58d32..87c5c9a002 100644
--- a/plugins/catalog-react/src/components/EntityOwnerPicker/EntityOwnerPicker.test.tsx
+++ b/plugins/catalog-react/src/components/EntityOwnerPicker/EntityOwnerPicker.test.tsx
@@ -362,6 +362,76 @@ describe('
+
+
+ ,
+ );
+
+ expect(mockCatalogApi.getEntitiesByRefs).not.toHaveBeenCalled();
+ expect(updateFilters).toHaveBeenLastCalledWith({
+ owners: undefined,
+ });
+
+ const input = screen.getByRole('textbox');
+ fireEvent.change(input, { target: { value: 'Some-Owner' } });
+
+ await waitFor(() =>
+ expect(screen.getByText('some-owner')).toBeInTheDocument(),
+ );
+ expect(mockCatalogApi.queryEntities).toHaveBeenLastCalledWith(
+ expect.objectContaining({
+ fullTextFilter: expect.objectContaining({
+ term: 'some-owner',
+ }),
+ }),
+ );
+
+ fireEvent.click(screen.getByText('some-owner'));
+ expect(updateFilters).toHaveBeenLastCalledWith({
+ owners: new EntityOwnerFilter(['group:default/some-owner']),
+ });
+ });
});
describe('
+
{children}
-
+
);
}
+
+/**
+ * Creates new context for entity listing and filtering.
+ *
+ * @public
+ * @deprecated Please use `EntityListProvider` and `EntityListProvider` instead.
+ */
+export const EntityListContext = OldEntityListContext;
diff --git a/plugins/catalog-react/src/hooks/index.ts b/plugins/catalog-react/src/hooks/index.ts
index befcce520d..2bce5a4673 100644
--- a/plugins/catalog-react/src/hooks/index.ts
+++ b/plugins/catalog-react/src/hooks/index.ts
@@ -24,11 +24,7 @@ export type {
EntityProviderProps,
AsyncEntityProviderProps,
} from './useEntity';
-export {
- EntityListContext,
- EntityListProvider,
- useEntityList,
-} from './useEntityListProvider';
+export { EntityListProvider, useEntityList } from './useEntityListProvider';
export type {
DefaultEntityFilters,
EntityListContextProps,
diff --git a/plugins/catalog-react/src/hooks/useEntityListProvider.test.tsx b/plugins/catalog-react/src/hooks/useEntityListProvider.test.tsx
index f7090f330b..7b9d17d82e 100644
--- a/plugins/catalog-react/src/hooks/useEntityListProvider.test.tsx
+++ b/plugins/catalog-react/src/hooks/useEntityListProvider.test.tsx
@@ -42,7 +42,13 @@ import {
} from '../filters';
import { createDeferred } from '@backstage/types';
import { EntityListPagination } from '../types';
-import { EntityListProvider, useEntityList } from './useEntityListProvider';
+import {
+ EntityListContextProps,
+ EntityListProvider,
+ NewEntityListContext,
+ useEntityList,
+} from './useEntityListProvider';
+import { createVersionedValueMap } from '@backstage/version-bridge';
const entities: Entity[] = [
{
@@ -1048,3 +1054,59 @@ describe(` = {
+ filters: {},
+ entities: [],
+ backendEntities: [],
+ updateFilters: jest.fn(),
+ queryParameters: {},
+ loading: true,
+ limit: 277,
+ setLimit: jest.fn(),
+ setOffset: jest.fn(),
+ paginationMode: 'none',
+ };
+
+ const { result } = renderHook(() => useEntityList(), {
+ wrapper: ({ children }) => {
+ const InitialFiltersWrapper = (f: PropsWithChildren<{}>) => {
+ const { updateFilters } = useEntityList();
+ useMountEffect(() => {
+ updateFilters({
+ kind: new EntityKindFilter('component', 'Component'),
+ });
+ });
+ return <>{f.children};
+ };
+
+ return (
+
+
+
+ {children}
+
+
+
+ );
+ },
+ });
+
+ expect(result.current.limit).toBe(277);
+ });
+});
diff --git a/plugins/catalog-react/src/hooks/useEntityListProvider.tsx b/plugins/catalog-react/src/hooks/useEntityListProvider.tsx
index 8c4927ad0a..a2ab4ea377 100644
--- a/plugins/catalog-react/src/hooks/useEntityListProvider.tsx
+++ b/plugins/catalog-react/src/hooks/useEntityListProvider.tsx
@@ -17,6 +17,11 @@
import { QueryEntitiesResponse } from '@backstage/catalog-client';
import { Entity } from '@backstage/catalog-model';
import { useApi } from '@backstage/core-plugin-api';
+import {
+ createVersionedContext,
+ createVersionedValueMap,
+ useVersionedContext,
+} from '@backstage/version-bridge';
import { compact, isEqual } from 'lodash';
import qs from 'qs';
import {
@@ -122,11 +127,17 @@ export type EntityListContextProps<
paginationMode: PaginationMode;
};
+// This context has support for multiple concurrent versions of this package.
+// It is currently used in parallel with the old context in order to provide
+// a smooth transition, but will eventually be the only context we use.
+export const NewEntityListContext = createVersionedContext<{
+ 1: EntityListContextProps;
+}>('entity-list-context');
+
/**
* Creates new context for entity listing and filtering.
- * @public
*/
-export const EntityListContext = createContext<
+export const OldEntityListContext = createContext<
EntityListContextProps | undefined
>(undefined);
@@ -487,9 +498,13 @@ export const EntityListProvider = (
);
return (
-
- {props.children}
-
+
+
+ {props.children}
+
+
);
};
@@ -500,8 +515,22 @@ export const EntityListProvider = (
export function useEntityList<
EntityFilters extends DefaultEntityFilters = DefaultEntityFilters,
>(): EntityListContextProps {
- const context = useContext(EntityListContext);
- if (!context)
- throw new Error('useEntityList must be used within EntityListProvider');
- return context;
+ const versionedHolder = useVersionedContext<{
+ 1: EntityListContextProps;
+ }>('entity-list-context');
+ const oldContext = useContext(OldEntityListContext);
+
+ if (versionedHolder) {
+ const value = versionedHolder.atVersion(1);
+ if (!value) {
+ throw new Error('EntityListContext v1 not available');
+ }
+ return value;
+ }
+
+ if (oldContext) {
+ return oldContext;
+ }
+
+ throw new Error('useEntityList must be used within EntityListProvider');
}
diff --git a/plugins/catalog-react/src/testUtils/MockEntityListContextProvider.tsx b/plugins/catalog-react/src/testUtils/MockEntityListContextProvider.tsx
index 0dcbbed8e8..e75e7e20e3 100644
--- a/plugins/catalog-react/src/testUtils/MockEntityListContextProvider.tsx
+++ b/plugins/catalog-react/src/testUtils/MockEntityListContextProvider.tsx
@@ -17,9 +17,10 @@
import { PropsWithChildren, useCallback, useMemo, useState } from 'react';
import {
DefaultEntityFilters,
- EntityListContext,
EntityListContextProps,
} from '@backstage/plugin-catalog-react';
+import { createVersionedValueMap } from '@backstage/version-bridge';
+import { NewEntityListContext } from '../hooks/useEntityListProvider';
/**
* Simplifies testing of code that uses the entity list hooks.
@@ -82,8 +83,10 @@ export function MockEntityListContextProvider<
);
return (
-
+
{children}
-
+
);
}
diff --git a/plugins/catalog-unprocessed-entities-common/CHANGELOG.md b/plugins/catalog-unprocessed-entities-common/CHANGELOG.md
index 962c3dff33..67dfa74dae 100644
--- a/plugins/catalog-unprocessed-entities-common/CHANGELOG.md
+++ b/plugins/catalog-unprocessed-entities-common/CHANGELOG.md
@@ -1,5 +1,20 @@
# @backstage/plugin-catalog-unprocessed-entities-common
+## 0.0.12-next.0
+
+### Patch Changes
+
+- df4d646: Moved types, API and client to the common package, allowing both frontend and
+ backend plugins to use the `CatalogUnprocessedEntitiesClient`.
+
+ The following types, clients and interfaces have been deprecated and should be
+ imported from the `@backstage/plugin-catalog-unprocessed-entities-common` instead:
+ `CatalogUnprocessedEntitiesApi`, `CatalogUnprocessedEntitiesApiResponse`, `UnprocessedEntity`,
+ `UnprocessedEntityCache`, `UnprocessedEntityError`, `CatalogUnprocessedEntitiesClient`.
+
+ All those types, clients and interfaces are re-exported temporarily in the
+ `@backstage/plugin-catalog-unprocessed-entities` package until cleaned up.
+
## 0.0.11
### Patch Changes
diff --git a/plugins/catalog-unprocessed-entities-common/package.json b/plugins/catalog-unprocessed-entities-common/package.json
index 49ead8da1b..c20e1c142a 100644
--- a/plugins/catalog-unprocessed-entities-common/package.json
+++ b/plugins/catalog-unprocessed-entities-common/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-catalog-unprocessed-entities-common",
- "version": "0.0.11",
+ "version": "0.0.12-next.0",
"description": "Common functionalities for the catalog-unprocessed-entities plugin",
"backstage": {
"role": "common-library",
@@ -37,6 +37,8 @@
"test": "backstage-cli package test"
},
"dependencies": {
+ "@backstage/catalog-model": "workspace:^",
+ "@backstage/errors": "workspace:^",
"@backstage/plugin-permission-common": "workspace:^"
},
"devDependencies": {
diff --git a/plugins/catalog-unprocessed-entities-common/report.api.md b/plugins/catalog-unprocessed-entities-common/report.api.md
index 03b316eebb..e373a3f45b 100644
--- a/plugins/catalog-unprocessed-entities-common/report.api.md
+++ b/plugins/catalog-unprocessed-entities-common/report.api.md
@@ -4,6 +4,53 @@
```ts
import { BasicPermission } from '@backstage/plugin-permission-common';
+import { Entity } from '@backstage/catalog-model';
+
+// @public
+export interface CatalogUnprocessedEntitiesApi {
+ delete(
+ entityId: string,
+ options?: UnprocessedEntitiesRequestOptions,
+ ): Promise;
+ failed(
+ options?: UnprocessedEntitiesRequestOptions,
+ ): Promise;
+ pending(
+ options?: UnprocessedEntitiesRequestOptions,
+ ): Promise;
+}
+
+// @public
+export type CatalogUnprocessedEntitiesApiResponse = {
+ entities: UnprocessedEntity[];
+};
+
+// @public
+export class CatalogUnprocessedEntitiesClient
+ implements CatalogUnprocessedEntitiesApi
+{
+ constructor(
+ discovery: {
+ getBaseUrl(pluginId: string): Promise;
+ },
+ fetchApi?: {
+ fetch: typeof fetch;
+ },
+ );
+ // (undocumented)
+ delete(
+ entityId: string,
+ options?: UnprocessedEntitiesRequestOptions,
+ ): Promise;
+ // (undocumented)
+ failed(
+ options?: UnprocessedEntitiesRequestOptions,
+ ): Promise;
+ // (undocumented)
+ pending(
+ options?: UnprocessedEntitiesRequestOptions,
+ ): Promise;
+}
// @public
export const unprocessedEntitiesDeletePermission: BasicPermission;
@@ -12,4 +59,42 @@ export const unprocessedEntitiesDeletePermission: BasicPermission;
export const unprocessedEntitiesPermissions: {
unprocessedEntitiesDeletePermission: BasicPermission;
};
+
+// @public
+export interface UnprocessedEntitiesRequestOptions {
+ // (undocumented)
+ token?: string;
+}
+
+// @public
+export type UnprocessedEntity = {
+ entity_id: string;
+ entity_ref: string;
+ unprocessed_entity: Entity;
+ unprocessed_hash?: string;
+ processed_entity?: Entity;
+ result_hash?: string;
+ cache?: UnprocessedEntityCache;
+ next_update_at: string | Date;
+ last_discovery_at: string | Date;
+ errors?: UnprocessedEntityError[];
+ location_key?: string;
+};
+
+// @public
+export type UnprocessedEntityCache = {
+ ttl: number;
+ cache: object;
+};
+
+// @public
+export type UnprocessedEntityError = {
+ name: string;
+ message: string;
+ cause: {
+ name: string;
+ message: string;
+ stack: string;
+ };
+};
```
diff --git a/plugins/catalog-unprocessed-entities-common/src/api/api.ts b/plugins/catalog-unprocessed-entities-common/src/api/api.ts
new file mode 100644
index 0000000000..02b230aaec
--- /dev/null
+++ b/plugins/catalog-unprocessed-entities-common/src/api/api.ts
@@ -0,0 +1,124 @@
+/*
+ * Copyright 2023 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { CatalogUnprocessedEntitiesApiResponse } from '../types';
+import { ResponseError } from '@backstage/errors';
+
+/**
+ * Options you can pass into a catalog request for additional information.
+ *
+ * @public
+ */
+export interface UnprocessedEntitiesRequestOptions {
+ token?: string;
+}
+
+/**
+ * Interface for the CatalogUnprocessedEntitiesApi.
+ *
+ * @public
+ */
+export interface CatalogUnprocessedEntitiesApi {
+ /**
+ * Returns a list of entities with state 'pending'
+ *
+ * @param options - Additional options
+ */
+ pending(
+ options?: UnprocessedEntitiesRequestOptions,
+ ): Promise;
+ /**
+ * Returns a list of entities with state 'failed'
+ *
+ * @param options - Additional options
+ */
+ failed(
+ options?: UnprocessedEntitiesRequestOptions,
+ ): Promise;
+ /**
+ * Deletes an entity from the refresh_state table
+ *
+ * @param entityId - The ID of the entity to delete
+ * @param options - Additional options
+ */
+ delete(
+ entityId: string,
+ options?: UnprocessedEntitiesRequestOptions,
+ ): Promise;
+}
+
+/**
+ * Default API implementation for the Catalog Unprocessed Entities plugin
+ *
+ * @public
+ */
+export class CatalogUnprocessedEntitiesClient
+ implements CatalogUnprocessedEntitiesApi
+{
+ private readonly discovery: { getBaseUrl(pluginId: string): Promise };
+ private readonly fetchApi: { fetch: typeof fetch };
+
+ constructor(
+ discovery: { getBaseUrl(pluginId: string): Promise },
+ fetchApi?: { fetch: typeof fetch },
+ ) {
+ this.discovery = discovery;
+ this.fetchApi = fetchApi ?? { fetch };
+ }
+
+ private async fetch(
+ method: string,
+ path: string,
+ options?: UnprocessedEntitiesRequestOptions,
+ ): Promise {
+ const url = await this.discovery.getBaseUrl('catalog');
+ const resp = await this.fetchApi.fetch(`${url}/${path}`, {
+ method,
+ headers: {
+ ...(options?.token ? { Authorization: `Bearer ${options.token}` } : {}),
+ },
+ });
+
+ if (!resp.ok) {
+ throw await ResponseError.fromResponse(resp);
+ }
+
+ return resp.status === 204 ? (resp as T) : await resp.json();
+ }
+
+ async pending(
+ options?: UnprocessedEntitiesRequestOptions,
+ ): Promise {
+ return await this.fetch('GET', 'entities/unprocessed/pending', options);
+ }
+
+ async failed(
+ options?: UnprocessedEntitiesRequestOptions,
+ ): Promise {
+ return await this.fetch('GET', 'entities/unprocessed/failed', options);
+ }
+
+ async delete(
+ entityId: string,
+ options?: UnprocessedEntitiesRequestOptions,
+ ): Promise {
+ await this.fetch(
+ 'DELETE',
+ `entities/unprocessed/delete/${entityId}`,
+ options,
+ );
+ }
+}
diff --git a/plugins/catalog-unprocessed-entities-common/src/api/index.ts b/plugins/catalog-unprocessed-entities-common/src/api/index.ts
new file mode 100644
index 0000000000..5b8bf17e1d
--- /dev/null
+++ b/plugins/catalog-unprocessed-entities-common/src/api/index.ts
@@ -0,0 +1,16 @@
+/*
+ * Copyright 2025 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export * from './api';
diff --git a/plugins/catalog-unprocessed-entities-common/src/index.ts b/plugins/catalog-unprocessed-entities-common/src/index.ts
index cd5a39c731..d11cb4fdb5 100644
--- a/plugins/catalog-unprocessed-entities-common/src/index.ts
+++ b/plugins/catalog-unprocessed-entities-common/src/index.ts
@@ -20,4 +20,6 @@
* @packageDocumentation
*/
+export * from './api';
export * from './permissions';
+export * from './types';
diff --git a/plugins/catalog-unprocessed-entities-common/src/types.ts b/plugins/catalog-unprocessed-entities-common/src/types.ts
new file mode 100644
index 0000000000..d7af485e83
--- /dev/null
+++ b/plugins/catalog-unprocessed-entities-common/src/types.ts
@@ -0,0 +1,66 @@
+/*
+ * Copyright 2023 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { Entity } from '@backstage/catalog-model';
+
+/**
+ * Unprocessed entity data stored in the database.
+ * @public
+ */
+export type UnprocessedEntity = {
+ entity_id: string;
+ entity_ref: string;
+ unprocessed_entity: Entity;
+ unprocessed_hash?: string;
+ processed_entity?: Entity;
+ result_hash?: string;
+ cache?: UnprocessedEntityCache;
+ next_update_at: string | Date;
+ last_discovery_at: string | Date; // remove?
+ errors?: UnprocessedEntityError[];
+ location_key?: string;
+};
+
+/**
+ * Unprocessed entity cache stored in the database.
+ * @public
+ */
+export type UnprocessedEntityCache = {
+ ttl: number;
+ cache: object;
+};
+
+/**
+ * Unprocessed entity error information stored in the database.
+ * @public
+ */
+export type UnprocessedEntityError = {
+ name: string;
+ message: string;
+ cause: {
+ name: string;
+ message: string;
+ stack: string;
+ };
+};
+
+/**
+ * Response expected by the {@link CatalogUnprocessedEntitiesApi}
+ *
+ * @public
+ */
+export type CatalogUnprocessedEntitiesApiResponse = {
+ entities: UnprocessedEntity[];
+};
diff --git a/plugins/catalog-unprocessed-entities/CHANGELOG.md b/plugins/catalog-unprocessed-entities/CHANGELOG.md
index c47881b3b9..b48f12b4dd 100644
--- a/plugins/catalog-unprocessed-entities/CHANGELOG.md
+++ b/plugins/catalog-unprocessed-entities/CHANGELOG.md
@@ -1,5 +1,24 @@
# @backstage/plugin-catalog-unprocessed-entities
+## 0.2.24-next.1
+
+### Patch Changes
+
+- df4d646: Moved types, API and client to the common package, allowing both frontend and
+ backend plugins to use the `CatalogUnprocessedEntitiesClient`.
+
+ The following types, clients and interfaces have been deprecated and should be
+ imported from the `@backstage/plugin-catalog-unprocessed-entities-common` instead:
+ `CatalogUnprocessedEntitiesApi`, `CatalogUnprocessedEntitiesApiResponse`, `UnprocessedEntity`,
+ `UnprocessedEntityCache`, `UnprocessedEntityError`, `CatalogUnprocessedEntitiesClient`.
+
+ All those types, clients and interfaces are re-exported temporarily in the
+ `@backstage/plugin-catalog-unprocessed-entities` package until cleaned up.
+
+- Updated dependencies
+ - @backstage/core-components@0.18.4-next.1
+ - @backstage/plugin-catalog-unprocessed-entities-common@0.0.12-next.0
+
## 0.2.24-next.0
### Patch Changes
diff --git a/plugins/catalog-unprocessed-entities/package.json b/plugins/catalog-unprocessed-entities/package.json
index d5111ab591..2b6d876226 100644
--- a/plugins/catalog-unprocessed-entities/package.json
+++ b/plugins/catalog-unprocessed-entities/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-catalog-unprocessed-entities",
- "version": "0.2.24-next.0",
+ "version": "0.2.24-next.1",
"backstage": {
"role": "frontend-plugin",
"pluginId": "catalog-unprocessed-entities",
@@ -50,11 +50,11 @@
"test": "backstage-cli package test"
},
"dependencies": {
- "@backstage/catalog-model": "workspace:^",
"@backstage/core-components": "workspace:^",
"@backstage/core-plugin-api": "workspace:^",
"@backstage/errors": "workspace:^",
"@backstage/frontend-plugin-api": "workspace:^",
+ "@backstage/plugin-catalog-unprocessed-entities-common": "workspace:^",
"@material-ui/core": "^4.9.13",
"@material-ui/icons": "^4.9.1",
"@material-ui/lab": "^4.0.0-alpha.60",
diff --git a/plugins/catalog-unprocessed-entities/report.api.md b/plugins/catalog-unprocessed-entities/report.api.md
index adaf7af643..deeafb8a7c 100644
--- a/plugins/catalog-unprocessed-entities/report.api.md
+++ b/plugins/catalog-unprocessed-entities/report.api.md
@@ -3,26 +3,26 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
-import { ApiRef } from '@backstage/core-plugin-api';
+import { ApiRef } from '@backstage/frontend-plugin-api';
import { BackstagePlugin } from '@backstage/core-plugin-api';
-import { Entity } from '@backstage/catalog-model';
+import { CatalogUnprocessedEntitiesApi as CatalogUnprocessedEntitiesApi_2 } from '@backstage/plugin-catalog-unprocessed-entities-common';
+import { CatalogUnprocessedEntitiesApiResponse as CatalogUnprocessedEntitiesApiResponse_2 } from '@backstage/plugin-catalog-unprocessed-entities-common';
import { JSX as JSX_2 } from 'react/jsx-runtime';
import { RouteRef } from '@backstage/core-plugin-api';
+import type { UnprocessedEntity as UnprocessedEntity_2 } from '@backstage/plugin-catalog-unprocessed-entities-common';
+import type { UnprocessedEntityCache as UnprocessedEntityCache_2 } from '@backstage/plugin-catalog-unprocessed-entities-common';
+import type { UnprocessedEntityError as UnprocessedEntityError_2 } from '@backstage/plugin-catalog-unprocessed-entities-common';
-// @public
-export interface CatalogUnprocessedEntitiesApi {
- delete(entityId: string): Promise;
- failed(): Promise;
- pending(): Promise;
-}
+// @public @deprecated
+export interface CatalogUnprocessedEntitiesApi
+ extends CatalogUnprocessedEntitiesApi_2 {}
// @public
export const catalogUnprocessedEntitiesApiRef: ApiRef;
-// @public
-export type CatalogUnprocessedEntitiesApiResponse = {
- entities: UnprocessedEntity[];
-};
+// @public @deprecated
+export type CatalogUnprocessedEntitiesApiResponse =
+ CatalogUnprocessedEntitiesApiResponse_2;
// @public
export const CatalogUnprocessedEntitiesPage: () => JSX_2.Element;
@@ -38,37 +38,14 @@ export const catalogUnprocessedEntitiesPlugin: BackstagePlugin<
// @public (undocumented)
export const UnprocessedEntitiesContent: () => JSX_2.Element;
-// @public
-export type UnprocessedEntity = {
- entity_id: string;
- entity_ref: string;
- unprocessed_entity: Entity;
- unprocessed_hash?: string;
- processed_entity?: Entity;
- result_hash?: string;
- cache?: UnprocessedEntityCache;
- next_update_at: string | Date;
- last_discovery_at: string | Date;
- errors?: UnprocessedEntityError[];
- location_key?: string;
-};
+// @public @deprecated
+export type UnprocessedEntity = UnprocessedEntity_2;
-// @public
-export type UnprocessedEntityCache = {
- ttl: number;
- cache: object;
-};
+// @public @deprecated
+export type UnprocessedEntityCache = UnprocessedEntityCache_2;
-// @public
-export type UnprocessedEntityError = {
- name: string;
- message: string;
- cause: {
- name: string;
- message: string;
- stack: string;
- };
-};
+// @public @deprecated
+export type UnprocessedEntityError = UnprocessedEntityError_2;
// (No @packageDocumentation comment for this package)
```
diff --git a/plugins/catalog-unprocessed-entities/src/api/index.ts b/plugins/catalog-unprocessed-entities/src/api/index.ts
index 67daa81319..cec9bd29bd 100644
--- a/plugins/catalog-unprocessed-entities/src/api/index.ts
+++ b/plugins/catalog-unprocessed-entities/src/api/index.ts
@@ -13,13 +13,12 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
+import { createApiRef } from '@backstage/core-plugin-api';
import {
- DiscoveryApi,
- createApiRef,
- FetchApi,
-} from '@backstage/core-plugin-api';
-import { ResponseError } from '@backstage/errors';
-import { UnprocessedEntity } from '../types';
+ CatalogUnprocessedEntitiesApiResponse as CommonCatalogUnprocessedEntitiesApiResponse,
+ CatalogUnprocessedEntitiesApi as CommonCatalogUnprocessedEntitiesApi,
+ CatalogUnprocessedEntitiesClient as CommonCatalogUnprocessedEntitiesClient,
+} from '@backstage/plugin-catalog-unprocessed-entities-common';
/**
* {@link @backstage/core-plugin-api#ApiRef} for the {@link CatalogUnprocessedEntitiesApi}
@@ -35,69 +34,24 @@ export const catalogUnprocessedEntitiesApiRef =
* Response expected by the {@link CatalogUnprocessedEntitiesApi}
*
* @public
+ * @deprecated Use the type imported from `@backstage/plugin-catalog-unprocessed-entities-common` instead.
*/
-export type CatalogUnprocessedEntitiesApiResponse = {
- entities: UnprocessedEntity[];
-};
+export type CatalogUnprocessedEntitiesApiResponse =
+ CommonCatalogUnprocessedEntitiesApiResponse;
/**
* Interface for the CatalogUnprocessedEntitiesApi.
*
* @public
+ * @deprecated Use the type imported from `@backstage/plugin-catalog-unprocessed-entities-common` instead.
*/
-export interface CatalogUnprocessedEntitiesApi {
- /**
- * Returns a list of entities with state 'pending'
- */
- pending(): Promise;
- /**
- * Returns a list of entities with state 'failed'
- */
- failed(): Promise;
- /**
- * Deletes an entity from the refresh_state table
- */
- delete(entityId: string): Promise;
-}
+export interface CatalogUnprocessedEntitiesApi
+ extends CommonCatalogUnprocessedEntitiesApi {}
/**
* Default API implementation for the Catalog Unprocessed Entities plugin
*
* @public
+ * @deprecated Use the client imported from `@backstage/plugin-catalog-unprocessed-entities-common` instead.
*/
-export class CatalogUnprocessedEntitiesClient
- implements CatalogUnprocessedEntitiesApi
-{
- public discovery: DiscoveryApi;
- public fetchApi: FetchApi;
-
- constructor(discovery: DiscoveryApi, fetchApi: FetchApi) {
- this.discovery = discovery;
- this.fetchApi = fetchApi;
- }
-
- private async fetch(path: string, init?: RequestInit): Promise {
- const url = await this.discovery.getBaseUrl('catalog');
- const resp = await this.fetchApi.fetch(`${url}/${path}`, init);
-
- if (!resp.ok) {
- throw await ResponseError.fromResponse(resp);
- }
-
- return resp.status === 204 ? (resp as T) : await resp.json();
- }
-
- async pending(): Promise {
- return await this.fetch('entities/unprocessed/pending');
- }
-
- async failed(): Promise {
- return await this.fetch('entities/unprocessed/failed');
- }
-
- async delete(entityId: string): Promise {
- await this.fetch(`entities/unprocessed/delete/${entityId}`, {
- method: 'DELETE',
- });
- }
-}
+export class CatalogUnprocessedEntitiesClient extends CommonCatalogUnprocessedEntitiesClient {}
diff --git a/plugins/catalog-unprocessed-entities/src/types.ts b/plugins/catalog-unprocessed-entities/src/types.ts
index 65f21970f5..38b4b9dad7 100644
--- a/plugins/catalog-unprocessed-entities/src/types.ts
+++ b/plugins/catalog-unprocessed-entities/src/types.ts
@@ -13,45 +13,29 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-import { Entity } from '@backstage/catalog-model';
+import type {
+ UnprocessedEntity as CommonUnprocessedEntity,
+ UnprocessedEntityCache as CommonUnprocessedEntityCache,
+ UnprocessedEntityError as CommonUnprocessedEntityError,
+} from '@backstage/plugin-catalog-unprocessed-entities-common';
/**
* Unprocessed entity data stored in the database.
* @public
+ * @deprecated Use the type imported from `@backstage/plugin-catalog-unprocessed-entities-common` instead.
*/
-export type UnprocessedEntity = {
- entity_id: string;
- entity_ref: string;
- unprocessed_entity: Entity;
- unprocessed_hash?: string;
- processed_entity?: Entity;
- result_hash?: string;
- cache?: UnprocessedEntityCache;
- next_update_at: string | Date;
- last_discovery_at: string | Date; // remove?
- errors?: UnprocessedEntityError[];
- location_key?: string;
-};
+export type UnprocessedEntity = CommonUnprocessedEntity;
/**
* Unprocessed entity cache stored in the database.
* @public
+ * @deprecated Use the type imported from `@backstage/plugin-catalog-unprocessed-entities-common` instead.
*/
-export type UnprocessedEntityCache = {
- ttl: number;
- cache: object;
-};
+export type UnprocessedEntityCache = CommonUnprocessedEntityCache;
/**
* Unprocessed entity error information stored in the database.
* @public
+ * @deprecated Use the type imported from `@backstage/plugin-catalog-unprocessed-entities-common` instead.
*/
-export type UnprocessedEntityError = {
- name: string;
- message: string;
- cause: {
- name: string;
- message: string;
- stack: string;
- };
-};
+export type UnprocessedEntityError = CommonUnprocessedEntityError;
diff --git a/plugins/catalog/CHANGELOG.md b/plugins/catalog/CHANGELOG.md
index 32dd520819..9215ba537c 100644
--- a/plugins/catalog/CHANGELOG.md
+++ b/plugins/catalog/CHANGELOG.md
@@ -1,5 +1,31 @@
# @backstage/plugin-catalog
+## 1.32.1-next.1
+
+### Patch Changes
+
+- f3f84f1: Minor extension type updates after frontend API bump
+- 91f5ed8: Fixed `catalogAboutEntityCard` to filter icon links before calling useProps(), preventing side effects from hooks in filtered-out links
+- Updated dependencies
+ - @backstage/frontend-plugin-api@0.13.2-next.1
+ - @backstage/plugin-catalog-react@1.21.4-next.2
+ - @backstage/core-components@0.18.4-next.2
+ - @backstage/catalog-client@1.12.1
+ - @backstage/catalog-model@1.7.6
+ - @backstage/core-compat-api@0.5.5-next.0
+ - @backstage/core-plugin-api@1.12.1-next.0
+ - @backstage/errors@1.2.7
+ - @backstage/integration-react@1.2.13-next.0
+ - @backstage/types@1.2.2
+ - @backstage/version-bridge@1.0.11
+ - @backstage/plugin-catalog-common@1.1.7
+ - @backstage/plugin-permission-react@0.4.39-next.0
+ - @backstage/plugin-scaffolder-common@1.7.4-next.0
+ - @backstage/plugin-search-common@1.2.21
+ - @backstage/plugin-search-react@1.10.1-next.0
+ - @backstage/plugin-techdocs-common@0.1.1
+ - @backstage/plugin-techdocs-react@1.3.6-next.0
+
## 1.32.1-next.0
### Patch Changes
diff --git a/plugins/catalog/package.json b/plugins/catalog/package.json
index 3901b11b29..c0c851469a 100644
--- a/plugins/catalog/package.json
+++ b/plugins/catalog/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-catalog",
- "version": "1.32.1-next.0",
+ "version": "1.32.1-next.1",
"description": "The Backstage plugin for browsing the Backstage catalog",
"backstage": {
"role": "frontend-plugin",
diff --git a/plugins/catalog/report-alpha.api.md b/plugins/catalog/report-alpha.api.md
index e40444bd07..f70572e371 100644
--- a/plugins/catalog/report-alpha.api.md
+++ b/plugins/catalog/report-alpha.api.md
@@ -27,7 +27,7 @@ import { RouteRef as RouteRef_2 } from '@backstage/frontend-plugin-api';
import { SearchResultItemExtensionComponent } from '@backstage/plugin-search-react/alpha';
import { SearchResultItemExtensionPredicate } from '@backstage/plugin-search-react/alpha';
import { SearchResultListItemBlueprintParams } from '@backstage/plugin-search-react/alpha';
-import { TranslationRef } from '@backstage/core-plugin-api/alpha';
+import { TranslationRef } from '@backstage/frontend-plugin-api';
// @alpha (undocumented)
export const catalogTranslationRef: TranslationRef<
@@ -197,15 +197,7 @@ const _default: OverridableFrontendPlugin<
initialFilter?: string | undefined;
};
output: ExtensionDataRef;
- inputs: {
- [x: string]: ExtensionInput<
- ExtensionDataRef,
- {
- singleton: boolean;
- optional: boolean;
- }
- >;
- };
+ inputs: {};
kind: 'catalog-filter';
name: 'kind';
params: {
@@ -231,15 +223,7 @@ const _default: OverridableFrontendPlugin<
initialFilter?: 'all' | 'owned' | 'starred' | undefined;
};
output: ExtensionDataRef;
- inputs: {
- [x: string]: ExtensionInput<
- ExtensionDataRef,
- {
- singleton: boolean;
- optional: boolean;
- }
- >;
- };
+ inputs: {};
kind: 'catalog-filter';
name: 'list';
params: {
@@ -254,15 +238,7 @@ const _default: OverridableFrontendPlugin<
mode?: 'all' | 'owners-only' | undefined;
};
output: ExtensionDataRef;
- inputs: {
- [x: string]: ExtensionInput<
- ExtensionDataRef,
- {
- singleton: boolean;
- optional: boolean;
- }
- >;
- };
+ inputs: {};
kind: 'catalog-filter';
name: 'mode';
params: {
@@ -995,7 +971,6 @@ const _default: OverridableFrontendPlugin<
offset?: number | undefined;
limit?: number | undefined;
};
- } & {
path: string | undefined;
};
configInput: {
@@ -1007,7 +982,6 @@ const _default: OverridableFrontendPlugin<
limit?: number | undefined;
}
| undefined;
- } & {
path?: string | undefined;
};
output:
@@ -1048,7 +1022,6 @@ const _default: OverridableFrontendPlugin<
}
>[]
| undefined;
- } & {
path: string | undefined;
};
configInput: {
@@ -1060,7 +1033,6 @@ const _default: OverridableFrontendPlugin<
}
>[]
| undefined;
- } & {
path?: string | undefined;
};
output:
diff --git a/plugins/catalog/src/alpha/entityCards.tsx b/plugins/catalog/src/alpha/entityCards.tsx
index 6df50a5123..556a130dff 100644
--- a/plugins/catalog/src/alpha/entityCards.tsx
+++ b/plugins/catalog/src/alpha/entityCards.tsx
@@ -41,12 +41,14 @@ export const catalogAboutEntityCard = EntityCardBlueprint.makeWithOverrides({
// The "useProps" functions may be calling other hooks, so we need to
// call them in a component function to avoid breaking the rules of hooks.
const links = inputs.iconLinks.reduce((rest, iconLink) => {
- const props = iconLink.get(EntityIconLinkBlueprint.dataRefs.useProps)();
const filter = buildFilterFn(
iconLink.get(EntityIconLinkBlueprint.dataRefs.filterFunction),
iconLink.get(EntityIconLinkBlueprint.dataRefs.filterExpression),
);
if (filter(entity)) {
+ const props = iconLink.get(
+ EntityIconLinkBlueprint.dataRefs.useProps,
+ )();
return [...rest, props];
}
return rest;
diff --git a/plugins/config-schema/report.api.md b/plugins/config-schema/report.api.md
index c78e56aa0e..66c856f4d8 100644
--- a/plugins/config-schema/report.api.md
+++ b/plugins/config-schema/report.api.md
@@ -3,7 +3,7 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
-import { ApiRef } from '@backstage/core-plugin-api';
+import { ApiRef } from '@backstage/frontend-plugin-api';
import { BackstagePlugin } from '@backstage/core-plugin-api';
import { JSX as JSX_2 } from 'react/jsx-runtime';
import { Observable } from '@backstage/types';
diff --git a/plugins/devtools-backend/CHANGELOG.md b/plugins/devtools-backend/CHANGELOG.md
index d1ae56ddac..8c3d629ba4 100644
--- a/plugins/devtools-backend/CHANGELOG.md
+++ b/plugins/devtools-backend/CHANGELOG.md
@@ -1,5 +1,22 @@
# @backstage/plugin-devtools-backend
+## 0.5.12-next.1
+
+### Patch Changes
+
+- de96a60: chore(deps): bump `express` from 4.21.2 to 4.22.0
+- Updated dependencies
+ - @backstage/backend-defaults@0.14.0-next.1
+ - @backstage/plugin-permission-node@0.10.7-next.1
+ - @backstage/backend-plugin-api@1.6.0-next.1
+ - @backstage/config-loader@1.10.7-next.1
+ - @backstage/cli-common@0.1.16-next.2
+ - @backstage/config@1.3.6
+ - @backstage/errors@1.2.7
+ - @backstage/types@1.2.2
+ - @backstage/plugin-devtools-common@0.1.19
+ - @backstage/plugin-permission-common@0.9.3
+
## 0.5.12-next.0
### Patch Changes
diff --git a/plugins/devtools-backend/package.json b/plugins/devtools-backend/package.json
index 5b729a06a8..0102e18257 100644
--- a/plugins/devtools-backend/package.json
+++ b/plugins/devtools-backend/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-devtools-backend",
- "version": "0.5.12-next.0",
+ "version": "0.5.12-next.1",
"backstage": {
"role": "backend-plugin",
"pluginId": "devtools",
@@ -51,7 +51,7 @@
"@manypkg/get-packages": "^1.1.3",
"@yarnpkg/lockfile": "^1.1.0",
"@yarnpkg/parsers": "^3.0.0",
- "express": "^4.18.1",
+ "express": "^4.22.0",
"express-promise-router": "^4.1.0",
"fs-extra": "^11.0.0",
"lodash": "^4.17.21",
diff --git a/plugins/devtools-backend/src/plugin.ts b/plugins/devtools-backend/src/plugin.ts
index d3fefda343..d7ac3ff6d9 100644
--- a/plugins/devtools-backend/src/plugin.ts
+++ b/plugins/devtools-backend/src/plugin.ts
@@ -20,6 +20,10 @@ import {
} from '@backstage/backend-plugin-api';
import { createRouter } from './service/router';
import { devToolsPermissions } from '@backstage/plugin-devtools-common';
+import {
+ devToolsTaskSchedulerReadPermission,
+ devToolsTaskSchedulerCreatePermission,
+} from '@backstage/plugin-devtools-common/alpha';
/**
* DevTools backend plugin
@@ -61,7 +65,11 @@ export const devtoolsPlugin = createBackendPlugin({
path: '/health',
allow: 'unauthenticated',
});
- permissionsRegistry.addPermissions(devToolsPermissions);
+ permissionsRegistry.addPermissions([
+ ...devToolsPermissions,
+ devToolsTaskSchedulerReadPermission,
+ devToolsTaskSchedulerCreatePermission,
+ ]);
},
});
},
diff --git a/plugins/devtools-common/package.json b/plugins/devtools-common/package.json
index c442185e14..cc03b91103 100644
--- a/plugins/devtools-common/package.json
+++ b/plugins/devtools-common/package.json
@@ -12,10 +12,7 @@
]
},
"publishConfig": {
- "access": "public",
- "main": "dist/index.cjs.js",
- "module": "dist/index.esm.js",
- "types": "dist/index.d.ts"
+ "access": "public"
},
"homepage": "https://backstage.io",
"repository": {
@@ -25,8 +22,23 @@
},
"license": "Apache-2.0",
"sideEffects": false,
+ "exports": {
+ ".": "./src/index.ts",
+ "./alpha": "./src/alpha.ts",
+ "./package.json": "./package.json"
+ },
"main": "src/index.ts",
"types": "src/index.ts",
+ "typesVersions": {
+ "*": {
+ "alpha": [
+ "src/alpha.ts"
+ ],
+ "package.json": [
+ "package.json"
+ ]
+ }
+ },
"files": [
"dist"
],
diff --git a/plugins/devtools-common/report-alpha.api.md b/plugins/devtools-common/report-alpha.api.md
new file mode 100644
index 0000000000..3c3b7ff89e
--- /dev/null
+++ b/plugins/devtools-common/report-alpha.api.md
@@ -0,0 +1,69 @@
+## API Report File for "@backstage/plugin-devtools-common"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+import { BasicPermission } from '@backstage/plugin-permission-common';
+import { JsonObject } from '@backstage/types';
+
+// @alpha (undocumented)
+export const devToolsTaskSchedulerCreatePermission: BasicPermission;
+
+// @alpha (undocumented)
+export const devToolsTaskSchedulerReadPermission: BasicPermission;
+
+// @alpha (undocumented)
+export type ScheduledTasks = {
+ scheduledTasks?: TaskApiTasksResponse[];
+ error?: string;
+};
+
+// @alpha
+export interface TaskApiTasksResponse {
+ // (undocumented)
+ pluginId: string;
+ // (undocumented)
+ scope: 'global' | 'local';
+ // (undocumented)
+ settings: {
+ version: number;
+ } & JsonObject;
+ // (undocumented)
+ taskId: string;
+ // (undocumented)
+ taskState:
+ | {
+ status: 'running';
+ startedAt: string;
+ timesOutAt?: string;
+ lastRunError?: string;
+ lastRunEndedAt?: string;
+ }
+ | {
+ status: 'idle';
+ startsAt?: string;
+ lastRunError?: string;
+ lastRunEndedAt?: string;
+ }
+ | null;
+ // (undocumented)
+ workerState:
+ | {
+ status: 'initial-wait';
+ }
+ | {
+ status: 'idle';
+ }
+ | {
+ status: 'running';
+ }
+ | null;
+}
+
+// @alpha (undocumented)
+export type TriggerScheduledTask = {
+ error?: string;
+};
+
+// (No @packageDocumentation comment for this package)
+```
diff --git a/plugins/devtools-common/src/alpha.ts b/plugins/devtools-common/src/alpha.ts
new file mode 100644
index 0000000000..984967c4f3
--- /dev/null
+++ b/plugins/devtools-common/src/alpha.ts
@@ -0,0 +1,24 @@
+/*
+ * Copyright 2025 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export {
+ devToolsTaskSchedulerReadPermission,
+ devToolsTaskSchedulerCreatePermission,
+} from './permissions';
+export type {
+ ScheduledTasks,
+ TaskApiTasksResponse,
+ TriggerScheduledTask,
+} from './types';
diff --git a/plugins/devtools-common/src/index.ts b/plugins/devtools-common/src/index.ts
index be7426394b..88bc0d545f 100644
--- a/plugins/devtools-common/src/index.ts
+++ b/plugins/devtools-common/src/index.ts
@@ -20,5 +20,19 @@
* @packageDocumentation
*/
-export * from './types';
-export * from './permissions';
+export type {
+ ConfigError,
+ ConfigInfo,
+ DevToolsInfo,
+ Endpoint,
+ ExternalDependency,
+ PackageDependency,
+} from './types';
+export { ExternalDependencyStatus } from './types';
+export {
+ devToolsAdministerPermission,
+ devToolsConfigReadPermission,
+ devToolsExternalDependenciesReadPermission,
+ devToolsInfoReadPermission,
+ devToolsPermissions,
+} from './permissions';
diff --git a/plugins/devtools-common/src/permissions.ts b/plugins/devtools-common/src/permissions.ts
index ba464f7d80..42a7efe777 100644
--- a/plugins/devtools-common/src/permissions.ts
+++ b/plugins/devtools-common/src/permissions.ts
@@ -48,6 +48,22 @@ export const devToolsExternalDependenciesReadPermission = createPermission({
attributes: { action: 'read' },
});
+/**
+ * @alpha
+ */
+export const devToolsTaskSchedulerReadPermission = createPermission({
+ name: 'devtools.scheduler.read',
+ attributes: { action: 'read' },
+});
+
+/**
+ * @alpha
+ */
+export const devToolsTaskSchedulerCreatePermission = createPermission({
+ name: 'devtools.scheduler.trigger',
+ attributes: { action: 'update' },
+});
+
/**
* List of all Devtools permissions
*
diff --git a/plugins/devtools-common/src/types.ts b/plugins/devtools-common/src/types.ts
index f1e60d9c2d..dc35188fde 100644
--- a/plugins/devtools-common/src/types.ts
+++ b/plugins/devtools-common/src/types.ts
@@ -16,7 +16,7 @@
/* We want to maintain the same information as an enum, so we disable the redeclaration warning */
/* eslint-disable @typescript-eslint/no-redeclare */
-import { JsonValue } from '@backstage/types';
+import { JsonObject, JsonValue } from '@backstage/types';
/** @public */
export type Endpoint = {
@@ -82,3 +82,54 @@ export type ConfigError = {
messages?: string[];
stack?: string;
};
+
+/**
+ * The shape of a task definition as returned by the service's REST API.
+ * This is a duplication of the below:
+ * @see https://github.com/backstage/backstage/blob/master/packages/backend-defaults/src/entrypoints/scheduler/lib/types.ts
+ *
+ * @alpha
+ */
+export interface TaskApiTasksResponse {
+ taskId: string;
+ pluginId: string;
+ scope: 'global' | 'local';
+ settings: { version: number } & JsonObject;
+ taskState:
+ | {
+ status: 'running';
+ startedAt: string;
+ timesOutAt?: string;
+ lastRunError?: string;
+ lastRunEndedAt?: string;
+ }
+ | {
+ status: 'idle';
+ startsAt?: string;
+ lastRunError?: string;
+ lastRunEndedAt?: string;
+ }
+ | null;
+ workerState:
+ | {
+ status: 'initial-wait';
+ }
+ | {
+ status: 'idle';
+ }
+ | {
+ status: 'running';
+ }
+ | null;
+}
+
+/** @alpha */
+export type ScheduledTasks = {
+ scheduledTasks?: TaskApiTasksResponse[];
+ error?: string;
+};
+
+/** @alpha */
+export type TriggerScheduledTask = {
+ error?: string;
+};
diff --git a/plugins/devtools/README.md b/plugins/devtools/README.md
index 3d82190c2f..07374db5da 100644
--- a/plugins/devtools/README.md
+++ b/plugins/devtools/README.md
@@ -34,6 +34,12 @@ Lists the configuration being used by your current running Backstage instance.
+### Scheduled Tasks
+
+Scheduled tasks can be viewed and triggered under the `Scheduled Tasks` tab. [See below to configure](#scheduled-tasks-configuration).
+
+
+
## Optional Features
The DevTools plugin can be setup with other tabs with additional helpful features.
@@ -456,3 +462,14 @@ RUN --mount=type=cache,target=/var/cache/apt,sharing=locked \
apt-get update && \
apt-get install -y ... iputils-ping
```
+
+### Scheduled Tasks Configuration
+
+Scheduled tasks can be viewed and triggered under the `Scheduled Tasks` tab. You first must add the list of plugins for scheduled tasks to your config:
+
+```yaml
+devTools:
+ scheduledTasks:
+ plugins:
+ - catalog
+```
diff --git a/plugins/devtools/config.d.ts b/plugins/devtools/config.d.ts
new file mode 100644
index 0000000000..841bb0b042
--- /dev/null
+++ b/plugins/devtools/config.d.ts
@@ -0,0 +1,30 @@
+/*
+ * Copyright 2025 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export interface Config {
+ devTools?: {
+ /**
+ * Scheduled tasks configuration
+ * @visibility frontend
+ */
+ scheduledTasks?: {
+ /**
+ * A list of plugin IDs to select from, e.g. ['catalog', 'scaffolder']
+ * @visibility frontend
+ */
+ plugins: string[];
+ };
+ };
+}
diff --git a/plugins/devtools/docs/devtools-scheduled-tasks-tab.png b/plugins/devtools/docs/devtools-scheduled-tasks-tab.png
new file mode 100644
index 0000000000..90e5e57d83
Binary files /dev/null and b/plugins/devtools/docs/devtools-scheduled-tasks-tab.png differ
diff --git a/plugins/devtools/package.json b/plugins/devtools/package.json
index 235c639602..d79a4a4bff 100644
--- a/plugins/devtools/package.json
+++ b/plugins/devtools/package.json
@@ -39,7 +39,8 @@
}
},
"files": [
- "dist"
+ "dist",
+ "config.d.ts"
],
"scripts": {
"build": "backstage-cli package build",
@@ -51,6 +52,7 @@
"test": "backstage-cli package test"
},
"dependencies": {
+ "@backstage/core-compat-api": "workspace:^",
"@backstage/core-components": "workspace:^",
"@backstage/core-plugin-api": "workspace:^",
"@backstage/errors": "workspace:^",
@@ -60,6 +62,7 @@
"@material-ui/core": "^4.9.13",
"@material-ui/icons": "^4.9.1",
"@material-ui/lab": "^4.0.0-alpha.57",
+ "lodash": "^4.17.21",
"react-json-view": "^1.21.3",
"react-use": "^17.2.4"
},
@@ -67,6 +70,7 @@
"@backstage/cli": "workspace:^",
"@backstage/dev-utils": "workspace:^",
"@testing-library/jest-dom": "^6.0.0",
+ "@types/lodash": "^4.14.151",
"@types/react": "^18.0.0",
"react": "^18.0.2",
"react-dom": "^18.0.2",
@@ -82,5 +86,6 @@
"@types/react": {
"optional": true
}
- }
+ },
+ "configSchema": "config.d.ts"
}
diff --git a/plugins/devtools/report.api.md b/plugins/devtools/report.api.md
index e7a42f4377..80297f299b 100644
--- a/plugins/devtools/report.api.md
+++ b/plugins/devtools/report.api.md
@@ -9,6 +9,7 @@ import { JSX as JSX_2 } from 'react/jsx-runtime';
import { ReactNode } from 'react';
import { RouteRef } from '@backstage/core-plugin-api';
import { TabProps } from '@material-ui/core/Tab';
+import { TaskApiTasksResponse } from '@backstage/plugin-devtools-common/alpha';
// @public (undocumented)
export const ConfigContent: () => JSX_2.Element;
@@ -43,6 +44,16 @@ export const ExternalDependenciesContent: () => JSX_2.Element;
// @public (undocumented)
export const InfoContent: () => JSX_2.Element;
+// @public (undocumented)
+export const ScheduledTaskDetailPanel: ({
+ rowData,
+}: {
+ rowData: TaskApiTasksResponse;
+}) => JSX_2.Element;
+
+// @public (undocumented)
+export const ScheduledTasksContent: () => JSX_2.Element;
+
// @public (undocumented)
export type SubRoute = {
path: string;
diff --git a/plugins/devtools/src/api/DevToolsApi.ts b/plugins/devtools/src/api/DevToolsApi.ts
index ff58a4ea16..4fc579ee06 100644
--- a/plugins/devtools/src/api/DevToolsApi.ts
+++ b/plugins/devtools/src/api/DevToolsApi.ts
@@ -20,6 +20,10 @@ import {
DevToolsInfo,
ExternalDependency,
} from '@backstage/plugin-devtools-common';
+import {
+ ScheduledTasks,
+ TriggerScheduledTask,
+} from '@backstage/plugin-devtools-common/alpha';
export const devToolsApiRef = createApiRef({
id: 'plugin.devtools.service',
@@ -29,4 +33,9 @@ export interface DevToolsApi {
getConfig(): Promise;
getExternalDependencies(): Promise;
getInfo(): Promise;
+ getScheduledTasksByPlugin(plugin: string): Promise;
+ triggerScheduledTask(
+ plugin: string,
+ taskId: string,
+ ): Promise;
}
diff --git a/plugins/devtools/src/api/DevToolsClient.ts b/plugins/devtools/src/api/DevToolsClient.ts
index e0b387a6ca..cd4f53fa81 100644
--- a/plugins/devtools/src/api/DevToolsClient.ts
+++ b/plugins/devtools/src/api/DevToolsClient.ts
@@ -20,6 +20,10 @@ import {
DevToolsInfo,
ExternalDependency,
} from '@backstage/plugin-devtools-common';
+import {
+ ScheduledTasks,
+ TriggerScheduledTask,
+} from '@backstage/plugin-devtools-common/alpha';
import { ResponseError } from '@backstage/errors';
import { DevToolsApi } from './DevToolsApi';
@@ -42,6 +46,45 @@ export class DevToolsClient implements DevToolsApi {
return configInfo;
}
+ public async getScheduledTasksByPlugin(
+ plugin: string,
+ ): Promise {
+ const baseUrl = `${await this.discoveryApi.getBaseUrl(plugin)}/`;
+ const url = new URL('.backstage/scheduler/v1/tasks', baseUrl);
+
+ const response = await this.fetchApi.fetch(url.toString());
+
+ if (!response.ok) {
+ throw await ResponseError.fromResponse(response);
+ }
+
+ const scheduledTasks = await response.json();
+ return {
+ scheduledTasks: scheduledTasks.tasks,
+ };
+ }
+
+ public async triggerScheduledTask(
+ plugin: string,
+ taskId: string,
+ ): Promise