Merge pull request #111 from sahil143/deprecate-workpsace

chore: mark workspace hooks and utils deprecated

config/jest.setup.js

@@ -24,9 +24,9 @@ jest.mock('../src/components/Workspace/useWorkspaceInfo', () => ({
   ...jest.requireActual('../src/components/Workspace/useWorkspaceInfo'),
 }));
 
-jest.mock('../src/components/Namespace/useNamespaceInfo', () => ({
+jest.mock('../src/shared/providers/Namespace/useNamespaceInfo', () => ({
   __esModule: true,
-  ...jest.requireActual('../src/components/Namespace/useNamespaceInfo'),
+  ...jest.requireActual('../src/shared/providers/Namespace/useNamespaceInfo'),
 }));
 
 jest.mock('../src/utils/rbac', () => ({

src/components/Applications/ApplicationListView.tsx

@@ -20,11 +20,11 @@ import { IMPORT_PATH } from '../../routes/paths';
 import { Table } from '../../shared';
 import AppEmptyState from '../../shared/components/empty-state/AppEmptyState';
 import FilteredEmptyState from '../../shared/components/empty-state/FilteredEmptyState';
+import { useNamespace } from '../../shared/providers/Namespace';
 import { ApplicationKind } from '../../types';
 import { useApplicationBreadcrumbs } from '../../utils/breadcrumb-utils';
 import { useAccessReviewForModel } from '../../utils/rbac';
 import { ButtonWithAccessTooltip } from '../ButtonWithAccessTooltip';
-import { useNamespace } from '../Namespace/useNamespaceInfo';
 import PageLayout from '../PageLayout/PageLayout';
 import { ApplicationListHeader } from './ApplicationListHeader';
 import ApplicationListRow from './ApplicationListRow';

src/components/Applications/switcher/ApplicationSwitcher.tsx

@@ -8,10 +8,10 @@ import {
   APPLICATION_LIST_PATH,
   IMPORT_PATH,
 } from '../../../routes/paths';
+import { ContextMenuItem, ContextSwitcher } from '../../../shared/components';
+import { useNamespace } from '../../../shared/providers/Namespace';
 import { useAccessReviewForModel } from '../../../utils/rbac';
 import { ButtonWithAccessTooltip } from '../../ButtonWithAccessTooltip';
-import { ContextMenuItem, ContextSwitcher } from '../../ContextSwitcher';
-import { useNamespace } from '../../Namespace/useNamespaceInfo';
 
 export const ApplicationSwitcher: React.FC<
   React.PropsWithChildren<{ selectedApplication?: string }>

src/components/ImportForm/GitImportForm.tsx

@@ -4,8 +4,8 @@ import { Form, PageSection } from '@patternfly/react-core';
 import { Formik, FormikHelpers } from 'formik';
 import { useBombinoUrl } from '../../hooks/useUIInstance';
 import { APPLICATION_DETAILS_PATH } from '../../routes/paths';
+import { useNamespace } from '../../shared/providers/Namespace';
 import { AnalyticsProperties, TrackEvents, useTrackEvent } from '../../utils/analytics';
-import { useNamespace } from '../Namespace/useNamespaceInfo';
 import ApplicationSection from './ApplicationSection/ApplicationSection';
 import { ComponentSection } from './ComponentSection/ComponentSection';
 import GitImportActions from './GitImportActions';

src/components/ImportForm/SecretSection/SecretSection.tsx

@@ -7,12 +7,12 @@ import { Base64 } from 'js-base64';
 import { useSecrets } from '../../../hooks/useSecrets';
 import { SecretModel } from '../../../models';
 import TextColumnField from '../../../shared/components/formik-fields/text-column-field/TextColumnField';
+import { useNamespace } from '../../../shared/providers/Namespace';
 import { BuildTimeSecret, SecretType } from '../../../types';
 import { AccessReviewResources } from '../../../types/rbac';
 import { useAccessReviewForModels } from '../../../utils/rbac';
 import { ButtonWithAccessTooltip } from '../../ButtonWithAccessTooltip';
 import { useModalLauncher } from '../../modal/ModalProvider';
-import { useNamespace } from '../../Namespace/useNamespaceInfo';
 import { SecretModalLauncher } from '../../Secrets/SecretModalLauncher';
 import { ImportFormValues } from '../type';
 

src/components/Overview/IntroBanner.tsx

@@ -15,10 +15,10 @@ import { useApplications } from '../../hooks/useApplications';
 import { ApplicationModel, ComponentModel } from '../../models';
 import { APPLICATION_LIST_PATH, IMPORT_PATH } from '../../routes/paths';
 import ExternalLink from '../../shared/components/links/ExternalLink';
+import { useNamespace } from '../../shared/providers/Namespace';
 import { AccessReviewResources } from '../../types';
 import { useAccessReviewForModels } from '../../utils/rbac';
 import { ButtonWithAccessTooltip } from '../ButtonWithAccessTooltip';
-import { useNamespace } from '../Namespace/useNamespaceInfo';
 import { SignupStatus } from '../SignUp/signup-utils';
 import SignupButton from '../SignUp/SignupButton';
 import { useSignupStatus } from '../SignUp/useSignupStatus';

src/components/Secrets/SecretsForm/ApplicationDropdown.tsx

@@ -2,7 +2,7 @@ import React from 'react';
 import { useField } from 'formik';
 import { useApplications } from '../../../hooks/useApplications';
 import DropdownField from '../../../shared/components/formik-fields/DropdownField';
-import { useNamespace } from '../../Namespace/useNamespaceInfo';
+import { useNamespace } from '../../../shared/providers/Namespace';
 
 type ApplicationDropdownProps = Omit<
   React.ComponentProps<typeof DropdownField>,

src/components/Secrets/SecretsListView/SecretsListView.tsx

@@ -15,9 +15,9 @@ import { useSecrets } from '../../../hooks/useSecrets';
 import { SecretModel } from '../../../models';
 import AppEmptyState from '../../../shared/components/empty-state/AppEmptyState';
 import FilteredEmptyState from '../../../shared/components/empty-state/FilteredEmptyState';
+import { useNamespace } from '../../../shared/providers/Namespace';
 import { useAccessReviewForModel } from '../../../utils/rbac';
 import { ButtonWithAccessTooltip } from '../../ButtonWithAccessTooltip';
-import { useNamespace } from '../../Namespace/useNamespaceInfo';
 import SecretsList from './SecretsList';
 
 const SecretsListView: React.FC = () => {

src/components/Workspace/WorkspaceSwitcher.tsx

@@ -1,10 +1,14 @@
 import React from 'react';
 import { useLocation, useNavigate } from 'react-router-dom';
 import { useQuery } from '@tanstack/react-query';
-import { ContextMenuItem, ContextSwitcher } from '../ContextSwitcher';
+import { ContextMenuItem, ContextSwitcher } from '../../shared/components';
 import { useWorkspaceInfo } from './useWorkspaceInfo';
 import { createWorkspaceQueryOptions } from './utils';
 
+/**
+ *
+ * @deprecated
+ */
 export const WorkspaceSwitcher: React.FC<
   React.PropsWithChildren<{ selectedWorkspace?: string }>
 > = () => {

src/components/Workspace/index.ts

@@ -1,9 +1,15 @@
 import { LoaderFunction } from 'react-router-dom';
 import { queryWorkspaces } from './utils';
 
+/**
+ * @deprecated in favor of Namespaces
+ */
 export const workspaceLoader: LoaderFunction = async () => {
   const workspaces = await queryWorkspaces();
   return { data: workspaces };
 };
 
+/**
+ * @deprecated in favor of Namespaces
+ */
 export { WorkspaceProvider } from './workspace-context';

src/components/Workspace/useWorkspaceInfo.ts

@@ -1,4 +1,12 @@
 import { useContext } from 'react';
+// remove eslint disable once migration to namespace is done
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+import type { useNamespace } from '../../shared/providers/Namespace';
 import { WorkspaceContext } from './workspace-context';
 
+/**
+ * @deprecated Migrate to Namespaces
+ * use {@link useNamespace}
+ *
+ */
 export const useWorkspaceInfo = () => useContext(WorkspaceContext);

src/components/Workspace/utils.ts

@@ -4,33 +4,60 @@ import { queryClient } from '../../k8s/query/core';
 import { WorkspaceModel } from '../../models';
 import { Workspace } from '../../types';
 
+/**
+ * @deprecated in favor of [Namespace](../../shared/providers/Namespace/utils.ts)
+ */
 const LOCAL_STORAGE_WORKSPACE_KEY = 'lastUsedWorkspace';
 
+/**
+ * @deprecated in favor of [Namespace](../../shared/providers/Namespace/utils.ts)
+ */
 export const WORKSPACE_QUERY_KEY = 'workspaces';
 
+/**
+ * @deprecated in favor of [Namespace](../../shared/providers/Namespace/utils.ts)
+ */
 export const getLastUsedWorkspace = (): string => {
   return localStorage.getItem(LOCAL_STORAGE_WORKSPACE_KEY);
 };
 
+/**
+ * @deprecated in favor of [Namespace](../../shared/providers/Namespace/utils.ts)
+ */
 export const setLastUsedWorkspace = (workspace: string) => {
   localStorage.setItem(LOCAL_STORAGE_WORKSPACE_KEY, workspace);
 };
 
+/**
+ * @deprecated in favor of [Namespace](../../shared/providers/Namespace/utils.ts)
+ */
 const createWorkspaceQueryKey = (name?: string) => {
   return [WORKSPACE_QUERY_KEY, ...(name ? [name] : [])];
 };
 
+/**
+ * @deprecated in favor of [Namespace](../../shared/providers/Namespace/utils.ts)
+ */
 export const getHomeWorkspace = (workspaces: Workspace[]) =>
   workspaces?.find((w) => w?.status?.type === 'home');
 
+/**
+ * @deprecated in favor of [Namespace](../../shared/providers/Namespace/utils.ts)
+ */
 export const getDefaultNsForWorkspace = (obj: Workspace) => {
   return obj?.status?.namespaces.find((n) => n.type === 'default');
 };
 
+/**
+ * @deprecated in favor of [Namespace](../../shared/providers/Namespace/utils.ts)
+ */
 export const getWorkspaceForNamespace = (workspaces: Workspace[], namespace) => {
   return workspaces?.find((w) => w.status?.namespaces?.some((ns) => ns.name === namespace));
 };
 
+/**
+ * @deprecated in favor of [Namespace](../../shared/providers/Namespace/utils.ts)
+ */
 function fetchWorkspaces(): Promise<Workspace[]>;
 function fetchWorkspaces(name: string): Promise<Workspace>;
 function fetchWorkspaces(name?: string): Promise<Workspace | Workspace[]> {
@@ -39,6 +66,9 @@ function fetchWorkspaces(name?: string): Promise<Workspace | Workspace[]> {
     : K8sGetResource<Workspace>({ model: WorkspaceModel, queryOptions: { name } });
 }
 
+/**
+ * @deprecated in favor of [Namespace](../../shared/providers/Namespace/utils.ts)
+ */
 export function createWorkspaceQueryOptions(): UseQueryOptions<Workspace[]>;
 export function createWorkspaceQueryOptions(name: string): UseQueryOptions<Workspace>;
 export function createWorkspaceQueryOptions(
@@ -58,12 +88,18 @@ export function createWorkspaceQueryOptions(
   });
 }
 
+/**
+ * @deprecated in favor of [Namespace](../../shared/providers/Namespace/utils.ts)
+ */
 export function invalidateWorkspaceQuery(): Promise<void>;
 export function invalidateWorkspaceQuery(name: string): Promise<void>;
 export async function invalidateWorkspaceQuery(name?: string): Promise<void> {
   return await queryClient.invalidateQueries({ queryKey: createWorkspaceQueryKey(name) });
 }
 
+/**
+ * @deprecated in favor of [Namespace](../../shared/providers/Namespace/utils.ts)
+ */
 export const getNamespaceUsingWorspaceFromQueryCache = async (
   workspace: string,
 ): Promise<string | undefined> => {
@@ -74,6 +110,10 @@ export const getNamespaceUsingWorspaceFromQueryCache = async (
     }),
   )?.name;
 };
+
+/**
+ * @deprecated in favor of [Namespace](../../shared/providers/Namespace/utils.ts)
+ */
 export const getWorkspaceUsingNamespaceFromQueryCache = async (
   namespace: string,
 ): Promise<string | undefined> => {
@@ -86,6 +126,9 @@ export const getWorkspaceUsingNamespaceFromQueryCache = async (
   )?.metadata?.name;
 };
 
+/**
+ * @deprecated in favor of [Namespace](../../shared/providers/Namespace/utils.ts)
+ */
 export const queryWorkspaces = () => {
   return queryClient.ensureQueryData(createWorkspaceQueryOptions());
 };

src/components/Workspace/workspace-context.tsx

@@ -13,6 +13,9 @@ import {
   setLastUsedWorkspace,
 } from './utils';
 
+/**
+ * @deprecated in favor of [Namespace](../../shared/providers/Namespace/namespace-context.ts)
+ */
 export type WorkspaceContextData = {
   namespace: string;
   workspace: string;
@@ -22,6 +25,9 @@ export type WorkspaceContextData = {
   workspaces: Workspace[];
 };
 
+/**
+ * @deprecated in favor of [Namespace](../../shared/providers/Namespace/namespace-context.ts)
+ */
 export const WorkspaceContext = React.createContext<WorkspaceContextData>({
   namespace: '',
   workspace: '',
@@ -31,6 +37,9 @@ export const WorkspaceContext = React.createContext<WorkspaceContextData>({
   lastUsedWorkspace: getLastUsedWorkspace(),
 });
 
+/**
+ * @deprecated in favor of [Namespace](../../shared/providers/Namespace/namespace-context.ts)
+ */
 export const WorkspaceProvider: React.FC<React.PropsWithChildren> = ({ children }) => {
   const { data: workspaces, isLoading: workspaceLoading } = useQuery(createWorkspaceQueryOptions());
   const params = useParams<RouterParams>();

src/k8s/index.ts

@@ -1,5 +1,6 @@
 export * from './hooks';
 export * from './query';
+export * from './query/core';
 export * from './fetch';
 export * from './k8s-fetch';
 export * from './k8s-utils';

src/routes/index.tsx

@@ -32,7 +32,6 @@ import {
   IntegrationTestsListView,
 } from '../components/IntegrationTests/IntegrationTestsListView';
 import { ModalProvider } from '../components/modal/ModalProvider';
-import { namespaceLoader, NamespaceProvider } from '../components/Namespace';
 import { Overview } from '../components/Overview/Overview';
 import {
   PipelineRunDetailsLayout,
@@ -85,6 +84,7 @@ import {
 import { workspaceLoader, WorkspaceProvider } from '../components/Workspace';
 import { HttpError } from '../k8s/error';
 import ErrorEmptyState from '../shared/components/empty-state/ErrorEmptyState';
+import { namespaceLoader, NamespaceProvider } from '../shared/providers/Namespace';
 import applicationRoutes from './page-routes/application';
 import workspaceRoutes from './page-routes/workspace';
 import { RouteErrorBoundry } from './RouteErrorBoundary';

src/routes/utils.ts

@@ -1,4 +1,11 @@
 export const RouterParams = {
+  /**
+   * @deprecated
+   * Existing usages are permitted for backward compatibility;
+   * however, please avoid adding new references
+   *
+   * use [useNamespace](../shared/providers/Namespace)
+   */
   workspaceName: 'workspaceName',
   applicationName: 'applicationName',
   integrationTestName: 'integrationTestName',

src/components/ContextSwitcher/ContextSwitcher.spec.tsx → src/shared/components/ContextSwitcher/ContextSwitcher.spec.tsx

@@ -1,9 +1,9 @@
 import { act, fireEvent, render, screen } from '@testing-library/react';
 import '@testing-library/jest-dom';
-import { useLocalStorage } from '../../hooks/useLocalStorage';
+import { useLocalStorage } from '../../../hooks/useLocalStorage';
 import { ContextSwitcher } from './ContextSwitcher';
 
-jest.mock('../../hooks/useLocalStorage', () => ({
+jest.mock('../../../hooks/useLocalStorage', () => ({
   useLocalStorage: jest.fn(() => [{}, jest.fn()]),
 }));
 

src/components/ContextSwitcher/ContextSwitcher.tsx → src/shared/components/ContextSwitcher/ContextSwitcher.tsx

@@ -14,7 +14,7 @@ import {
 import { Dropdown, DropdownToggle } from '@patternfly/react-core/deprecated';
 import { EllipsisHIcon } from '@patternfly/react-icons/dist/esm/icons/ellipsis-h-icon';
 import '././ContextSwitcher.scss';
-import { useLocalStorage } from '../../hooks/useLocalStorage';
+import { useLocalStorage } from '../../../hooks/useLocalStorage';
 import { ContextMenuListItem, filteredItems, findItemByKey } from './context-switcher-utils';
 
 const LOCAL_STORAGE_KEY = 'context-switcher';

src/shared/components/index.ts

@@ -7,3 +7,4 @@ export * from './timestamp';
 export * from './markdown-view';
 export * from './help-tooltip';
 export * from './pipeline-run-logs';
+export * from './ContextSwitcher';

src/components/Namespace/__tests__/namespace-context.spec.tsx → src/shared/providers/Namespace/__tests__/namespace-context.spec.tsx

@@ -1,7 +1,7 @@
 import * as React from 'react';
 import { useQuery } from '@tanstack/react-query';
 import { screen, waitFor, render } from '@testing-library/react';
-import { createReactRouterMock, createUseWorkspaceInfoMock } from '../../../utils/test-utils';
+import { createReactRouterMock, createUseWorkspaceInfoMock } from '../../../../utils/test-utils';
 import { NamespaceProvider, NamespaceContext } from '../namespace-context';
 
 jest.mock('react-router-dom', () => ({

src/components/Namespace/index.ts → src/shared/providers/Namespace/index.ts

@@ -7,3 +7,4 @@ export const namespaceLoader: LoaderFunction = async () => {
 };
 
 export { NamespaceProvider } from './namespace-context';
+export * from './useNamespaceInfo';

src/components/Namespace/namespace-context.tsx → src/shared/providers/Namespace/namespace-context.tsx

@@ -2,11 +2,11 @@ import * as React from 'react';
 import { useNavigate, useParams } from 'react-router-dom';
 import { Bullseye, Button, Spinner } from '@patternfly/react-core';
 import { useQuery } from '@tanstack/react-query';
-import { APPLICATION_LIST_PATH } from '../../routes/paths';
-import { RouterParams } from '../../routes/utils';
-import ErrorEmptyState from '../../shared/components/empty-state/ErrorEmptyState';
-import { NamespaceKind } from '../../types';
-import { useWorkspaceInfo } from '../Workspace/useWorkspaceInfo';
+import { useWorkspaceInfo } from '../../../components/Workspace/useWorkspaceInfo';
+import { APPLICATION_LIST_PATH } from '../../../routes/paths';
+import { RouterParams } from '../../../routes/utils';
+import { NamespaceKind } from '../../../types';
+import ErrorEmptyState from '../../components/empty-state/ErrorEmptyState';
 import { createNamespaceQueryOptions, getLastUsedNamespace, setLastUsedNamespace } from './utils';
 
 export type NamespaceContextData = {

src/components/Namespace/useNamespaceInfo.ts → src/shared/providers/Namespace/useNamespaceInfo.ts

@@ -1,6 +1,10 @@
 import { useContext } from 'react';
+import { useQuery } from '@tanstack/react-query';
 import { NamespaceContext } from './namespace-context';
+import { createNamespaceQueryOptions } from './utils';
 
 export const useNamespaceInfo = () => useContext(NamespaceContext);
 
 export const useNamespace = () => useNamespaceInfo().namespace;
+
+export const useNamespacesQuery = () => useQuery(createNamespaceQueryOptions());

src/components/Namespace/utils.ts → src/shared/providers/Namespace/utils.ts

@@ -1,8 +1,7 @@
 import { queryOptions as _createQueryOptions, UseQueryOptions } from '@tanstack/react-query';
-import { K8sGetResource, K8sListResourceItems } from '../../k8s/k8s-fetch';
-import { queryClient } from '../../k8s/query/core';
-import { NamespaceModel } from '../../models';
-import { NamespaceKind } from '../../types';
+import { K8sGetResource, K8sListResourceItems, queryClient } from '../../../k8s';
+import { NamespaceModel } from '../../../models';
+import { NamespaceKind } from '../../../types';
 
 const LOCAL_STORAGE_NAMESPACE_KEY = 'lastUsedNamespace';