frontend-defaults: add back deprecated createPublicSignInApp

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2025-08-01 10:18:16 +02:00
parent e8828e82b2
commit 3ee992dcb9
4 changed files with 156 additions and 0 deletions
@@ -41,6 +41,11 @@ export interface CreateAppOptions {
  pluginInfoResolver?: FrontendPluginInfoResolver;
 }

+// @public @deprecated (undocumented)
+export function createPublicSignInApp(options?: CreateAppOptions): {
+  createRoot(): JSX_2;
+};
+
 // @public (undocumented)
 export function discoverAvailableFeatures(config: Config): {
  features: (FrontendFeature | FrontendFeatureLoader)[];
@@ -0,0 +1,121 @@
+/*
+ * 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 {
+  SignInPageBlueprint,
+  createFrontendModule,
+} from '@backstage/frontend-plugin-api';
+import { render, screen, waitFor } from '@testing-library/react';
+import { useEffect } from 'react';
+import { createPublicSignInApp } from './createPublicSignInApp';
+import { mockApis } from '@backstage/test-utils';
+
+describe('createPublicSignInApp', () => {
+  beforeEach(() => {
+    jest.resetAllMocks();
+  });
+
+  it('should render a sign-in page', async () => {
+    const app = createPublicSignInApp({
+      configLoader: async () => ({ config: mockApis.config() }),
+      features: [
+        createFrontendModule({
+          pluginId: 'app',
+          extensions: [
+            SignInPageBlueprint.make({
+              params: {
+                loader: async () => () => <div>Sign in page</div>,
+              },
+            }),
+          ],
+        }),
+      ],
+    });
+
+    render(app.createRoot());
+
+    await expect(
+      screen.findByText('Sign in page'),
+    ).resolves.toBeInTheDocument();
+  });
+
+  it('should render the form redirect on sign-in', async () => {
+    const submitSpy = jest
+      .spyOn(HTMLFormElement.prototype, 'submit')
+      .mockReturnValue();
+
+    const app = createPublicSignInApp({
+      configLoader: async () => ({ config: mockApis.config() }),
+      features: [
+        createFrontendModule({
+          pluginId: 'app',
+          extensions: [
+            SignInPageBlueprint.make({
+              params: {
+                loader:
+                  async () =>
+                  ({ onSignInSuccess }) => {
+                    useEffect(() => {
+                      onSignInSuccess(
+                        mockApis.identity({ token: 'mock-token' }),
+                      );
+                    }, [onSignInSuccess]);
+                    return <div />;
+                  },
+              },
+            }),
+          ],
+        }),
+      ],
+    });
+
+    const { baseElement } = render(app.createRoot());
+
+    await waitFor(() => {
+      expect(submitSpy).toHaveBeenCalled();
+    });
+
+    expect(baseElement).toMatchInlineSnapshot(`
+      <body
+        data-theme-mode="light"
+        data-theme-name="backstage"
+      >
+        <div>
+          <form
+            action="http://localhost/"
+            method="POST"
+            style="visibility: hidden;"
+          >
+            <input
+              name="type"
+              type="hidden"
+              value="sign-in"
+            />
+            <input
+              name="token"
+              type="hidden"
+              value="mock-token"
+            />
+            <input
+              type="submit"
+              value="Continue"
+            />
+          </form>
+        </div>
+      </body>
+    `);
+  });
+});
@@ -0,0 +1,29 @@
+/*
+ * 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.
+ */
+
+import { appModulePublicSignIn } from '@backstage/plugin-app/alpha';
+import { CreateAppOptions, createApp } from './createApp';
+
+/**
+ * @public
+ * @deprecated Use {@link @backstage/plugin-app/alpha#appModulePublicSignIn} instead.
+ */
+export function createPublicSignInApp(options?: CreateAppOptions) {
+  return createApp({
+    ...options,
+    features: [...(options?.features ?? []), appModulePublicSignIn],
+  });
+}
@@ -21,5 +21,6 @@
 */

 export { createApp, type CreateAppOptions } from './createApp';
+export { createPublicSignInApp } from './createPublicSignInApp';
 export { discoverAvailableFeatures } from './discovery';
 export { resolveAsyncFeatures } from './resolution';