Infrastructure/logto
0
Fork 0
mirror of https://github.com/logto-io/logto.git synced 2024-12-16 20:26:19 -05:00
Code Issues Activity

feat(console): support console url with wildcard tenant id (#6780)

Browse source
This commit is contained in:
Charles Zhao 2024-11-11 10:42:41 +08:00 committed by GitHub
parent 48fd33d8ce
commit e1044dbae1
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 23 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
packages/console/src/containers/TenantAccess/index.tsx
View file

@ -1,12 +1,13 @@
import { useLogto } from '@logto/react';
import { useContext, useEffect } from 'react';
import { Outlet } from 'react-router-dom';
import { Outlet, useLocation } from 'react-router-dom';
import { useSWRConfig } from 'swr';
// Used in the docs
// eslint-disable-next-line unused-imports/no-unused-imports
import type ProtectedRoutes from '@/containers/ProtectedRoutes';
import { TenantsContext } from '@/contexts/TenantsProvider';
import { isCloud } from '@/consts/env';
import { reservedTenantIdWildcard, TenantsContext } from '@/contexts/TenantsProvider';
import useUserDefaultTenantId from '@/hooks/use-user-default-tenant-id';
/**
* The container that ensures the user has access to the current tenant. When the user is
@ -43,6 +44,8 @@ export default function TenantAccess() {
const { isAuthenticated } = useLogto();
const { currentTenant, currentTenantId } = useContext(TenantsContext);
const { mutate } = useSWRConfig();
const { pathname } = useLocation();
const { defaultTenantId } = useUserDefaultTenantId();
// Clean the cache when the current tenant ID changes. This is required because the
// SWR cache key is not tenant-aware.
@ -68,13 +71,20 @@ export default function TenantAccess() {
isAuthenticated &&
currentTenantId &&
// The current tenant is unavailable to the user, maybe a deleted tenant or a tenant that
// the user has no access to. Fall back to the home page.
// the user has no access to. Try with prepended default tenant ID, or if it's not available,
// redirect to the home page.
!currentTenant
) {
if (isCloud && defaultTenantId && currentTenantId === reservedTenantIdWildcard) {
// eslint-disable-next-line @silverhand/fp/no-mutation
window.location.href = pathname.replace(reservedTenantIdWildcard, defaultTenantId);
return;
}
// eslint-disable-next-line @silverhand/fp/no-mutation
window.location.href = '/';
}
}, [currentTenant, currentTenantId, isAuthenticated]);
}, [currentTenant, currentTenantId, isAuthenticated, pathname, defaultTenantId]);
return <Outlet />;
}

3
packages/console/src/contexts/SubscriptionDataProvider/index.tsx
View file

@ -7,9 +7,6 @@ import {
defaultSubscriptionQuota,
defaultSubscriptionUsage,
} from '@/consts';
// Used in the docs
// eslint-disable-next-line unused-imports/no-unused-imports
import TenantAccess from '@/containers/TenantAccess';
import { type FullContext } from './types';

7
packages/console/src/contexts/TenantsProvider.tsx
View file

@ -34,6 +34,13 @@ const reservedRoutes: Readonly<string[]> = Object.freeze([
...Object.values(GlobalRoute),
]);
/**
* The reserved tenant ID wildcard for the default tenant. Useful when specifying a console URL in
* the documentation or other places where the tenant ID is not known. Will be replaced with the
* actual default tenant ID in the runtime.
*/
export const reservedTenantIdWildcard = 'default';
/** @see {@link TenantsProvider} for why `useSWR()` is not applicable for this context. */
type Tenants = {
tenants: readonly TenantResponse[];