mirrors/mostlymatter
1
0
Форкнуть 0
Код Задачи Запросы на слияние Действия Пакеты Проекты Релизы Вики Активность

Adds support for public routes on shared boards (#22710)

Просмотр исходного кода 
* Adds support for public routes on shared boards

* Fix linter

* Address review comments

* Update playbooks registerProduct call

* Use boards product config for setting

* update additional product locations for parameter changes

* fixes for read-only when logged in

* turn off global header and don't initialize plugin if shared board

* fix unit tests

* revert package-lock.json

* more fixes

* Remove FF check for system console setting for boards

* update tests, Product boards is displayed in system console

* only check products section of config

* update test for config change

---------

Co-authored-by: Scott Bishel <scott.bishel@mattermost.com>
Co-authored-by: Mattermost Build <build@mattermost.com>
Этот коммит содержится в:
Miguel de la Cruz
2023-04-06 20:24:32 +02:00
коммит произвёл GitHub
родитель 71923fe311
Коммит 4cc2fed079
27 изменённых файлов: 552 добавлений и 49 удалений
Скачать Patch файл Скачать Diff файл Показать все файлы Свернуть все файлы

9
server/boards/integrationtests/boardsapp_test.go
Просмотреть файл

@@ -77,10 +77,13 @@ func TestSetConfiguration(t *testing.T) {
})
t.Run("test enable shared boards", func(t *testing.T) {
baseProductSettings := &model.ProductSettings{
EnablePublicSharedBoards: &falseRef,
}
mmConfig := baseConfig
mmConfig.PluginSettings.Plugins = make(map[string]map[string]interface{})
mmConfig.PluginSettings.Plugins[server.PluginName] = make(map[string]interface{})
mmConfig.PluginSettings.Plugins[server.PluginName][server.SharedBoardsName] = true
mmConfig.ProductSettings = *baseProductSettings
mmConfig.ProductSettings.EnablePublicSharedBoards = &boolTrue
config := server.CreateBoardsConfig(*mmConfig, "", "")
assert.Equal(t, true, config.EnablePublicSharedBoards)
})

4
server/boards/server/boards_service_util.go
Просмотреть файл

@@ -59,8 +59,8 @@ func CreateBoardsConfig(mmconfig mm_model.Config, baseURL string, serverID strin
}
enablePublicSharedBoards := false
if mmconfig.PluginSettings.Plugins[PluginName][SharedBoardsName] == true {
enablePublicSharedBoards = true
if mmconfig.ProductSettings.EnablePublicSharedBoards != nil {
enablePublicSharedBoards = *mmconfig.ProductSettings.EnablePublicSharedBoards
}
enableBoardsDeletion := false

8
webapp/boards/src/components/__snapshots__/workspace.test.tsx.snap
Просмотреть файл

@@ -873,7 +873,7 @@ exports[`src/components/workspace return workspace readonly and showcard 1`] = `
>
<div
class="octo-board-header-cell KanbanColumnHeader"
draggable="true"
draggable="false"
style="opacity: 1;"
>
<span
@@ -901,7 +901,7 @@ exports[`src/components/workspace return workspace readonly and showcard 1`] = `
</div>
<div
class="octo-board-header-cell KanbanColumnHeader"
draggable="true"
draggable="false"
style="opacity: 1;"
>
<span
@@ -1927,7 +1927,7 @@ exports[`src/components/workspace should match snapshot with readonly 1`] = `
>
<div
class="octo-board-header-cell KanbanColumnHeader"
draggable="true"
draggable="false"
style="opacity: 1;"
>
<span
@@ -1955,7 +1955,7 @@ exports[`src/components/workspace should match snapshot with readonly 1`] = `
</div>
<div
class="octo-board-header-cell KanbanColumnHeader"
draggable="true"
draggable="false"
style="opacity: 1;"
>
<span

9
webapp/boards/src/components/centerPanel.test.tsx
Просмотреть файл

@@ -29,7 +29,14 @@ jest.mock('react-router-dom', () => {
return {
...originalModule,
useRouteMatch: jest.fn(() => {
return {url: '/board/view'}
return {
params: {
teamId: 'team1',
boardId: 'boardId1',
viewId: 'viewId1',
cardId: 'cardId1',
},
}
}),
}
})

2
webapp/boards/src/components/kanban/__snapshots__/kanbanColumnHeader.test.tsx.snap
Просмотреть файл

@@ -469,7 +469,7 @@ exports[`src/components/kanban/kanbanColumnHeader should match snapshot readonly
<div>
<div
class="octo-board-header-cell KanbanColumnHeader"
draggable="true"
draggable="false"
style="opacity: 1;"
>
<span

14
webapp/boards/src/components/kanban/kanbanColumnHeader.tsx
Просмотреть файл

@@ -52,8 +52,12 @@ const defaultProperty: IPropertyTemplate = {
export default function KanbanColumnHeader(props: Props): JSX.Element {
const intl = useIntl()
const {board, activeView, group, groupByProperty} = props
let readonly = props.readonly
if(!readonly){
readonly = !useHasCurrentBoardPermissions([Permission.ManageBoardProperties])
}
const [groupTitle, setGroupTitle] = useState(group.option.value)
const canEditBoardProperties = useHasCurrentBoardPermissions([Permission.ManageBoardProperties])
const canEditOption = groupByProperty?.type !== 'person' && group.option.id
const headerRef = useRef<HTMLDivElement>(null)
@@ -79,7 +83,7 @@ export default function KanbanColumnHeader(props: Props): JSX.Element {
setGroupTitle(group.option.value)
}, [group.option.value])
if (canEditBoardProperties) {
if (!readonly) {
drop(drag(headerRef))
}
@@ -97,7 +101,7 @@ export default function KanbanColumnHeader(props: Props): JSX.Element {
ref={headerRef}
style={{opacity: isDragging ? 0.5 : 1}}
className={className}
draggable={!props.readonly && canEditBoardProperties}
draggable={!readonly}
>
{!group.option.id &&
<Label
@@ -133,7 +137,7 @@ export default function KanbanColumnHeader(props: Props): JSX.Element {
onCancel={() => {
setGroupTitle(group.option.value)
}}
readonly={props.readonly || !canEditBoardProperties}
readonly={readonly}
spellCheck={true}
/>
</Label>}
@@ -145,7 +149,7 @@ export default function KanbanColumnHeader(props: Props): JSX.Element {
onMenuClose={props.onCalculationMenuClose}
onMenuOpen={props.onCalculationMenuOpen}
cardProperties={board.cardProperties}
readonly={props.readonly || !canEditBoardProperties}
readonly={readonly}
onChange={(data: {calculation: string, propertyId: string}) => {
if (data.calculation === calculationValue && data.propertyId === calculationProperty.id) {
return

12
webapp/boards/src/components/shareBoard/__snapshots__/shareBoard.test.tsx.snap
Просмотреть файл

@@ -983,11 +983,11 @@ exports[`src/components/shareBoard/shareBoard return shareBoard and click Regene
>
<a
class="shareUrl"
href="http://localhost:8065/team/team-id/shared/1/1?r=anotherToken"
href="http://localhost:8065/boards/public/team/team-id/shared/1/1?r=anotherToken"
rel="noreferrer"
target="_blank"
>
http://localhost:8065/team/team-id/shared/1/1?r=anotherToken
http://localhost:8065/boards/public/team/team-id/shared/1/1?r=anotherToken
</a>
<div
class="octo-tooltip tooltip-top"
@@ -3188,11 +3188,11 @@ exports[`src/components/shareBoard/shareBoard return shareBoard, and click switc
>
<a
class="shareUrl"
href="http://localhost:8065/team/team-id/shared/1/1?r=oneToken"
href="http://localhost:8065/boards/public/team/team-id/shared/1/1?r=oneToken"
rel="noreferrer"
target="_blank"
>
http://localhost:8065/team/team-id/shared/1/1?r=oneToken
http://localhost:8065/boards/public/team/team-id/shared/1/1?r=oneToken
</a>
<div
class="octo-tooltip tooltip-top"
@@ -3461,11 +3461,11 @@ exports[`src/components/shareBoard/shareBoard return shareBoardComponent and cli
>
<a
class="shareUrl"
href="http://localhost:8065/team/team-id/shared/1/1?r=aToken"
href="http://localhost:8065/boards/public/team/team-id/shared/1/1?r=aToken"
rel="noreferrer"
target="_blank"
>
http://localhost:8065/team/team-id/shared/1/1?r=aToken
http://localhost:8065/boards/public/team/team-id/shared/1/1?r=aToken
</a>
<div
class="octo-tooltip tooltip-top"

2
webapp/boards/src/components/shareBoard/shareBoard.tsx
Просмотреть файл

@@ -259,7 +259,7 @@ export default function ShareBoardDialog(props: Props): JSX.Element {
viewId: match.params.viewId,
teamId: match.params.teamId,
})
shareUrl.pathname = newPath
shareUrl.pathname = `/boards/public${newPath}`
const boardPath = generatePath('/team/:teamId/:boardId/:viewId', {
boardId: match.params.boardId,

10
webapp/boards/src/components/shareBoard/shareBoardLoginButton.test.tsx
Просмотреть файл

@@ -21,10 +21,12 @@ jest.mock('react-router-dom', () => {
...originalModule,
useRouteMatch: jest.fn(() => {
return {
teamId: 'team1',
boardId: 'boardId1',
viewId: 'viewId1',
cardId: 'cardId1',
params: {
teamId: 'team1',
boardId: 'boardId1',
viewId: 'viewId1',
cardId: 'cardId1',
},
}
}),
}

13
webapp/boards/src/components/shareBoard/shareBoardLoginButton.tsx
Просмотреть файл

@@ -3,7 +3,7 @@
import React, {useCallback} from 'react'
import {FormattedMessage} from 'react-intl'
import {generatePath, useRouteMatch, useHistory} from 'react-router-dom'
import {generatePath, useRouteMatch} from 'react-router-dom'
import Button from 'src/widgets/buttons/button'
import TelemetryClient, {TelemetryActions, TelemetryCategory} from 'src/telemetry/telemetryClient'
@@ -12,14 +12,17 @@ import './shareBoardLoginButton.scss'
const ShareBoardLoginButton = () => {
const match = useRouteMatch<{teamId: string, boardId: string, viewId?: string, cardId?: string}>()
const history = useHistory()
const redirectQueryParam = 'r=' + encodeURIComponent(generatePath('/:boardId?/:viewId?/:cardId?', match.params))
const loginPath = '/login?' + redirectQueryParam
// Mattermost login doesn't respect the redirect query parameter
// if the user is already logged in, so we send the user to the
// board and if they are not logged in, the webapp will take care
// of the redirection
const baseURL = window.location.href.split('/boards/public')[0]
const loginPath = `${baseURL}/${generatePath('/boards/team/:teamId/:boardId?/:viewId?/:cardId?', match.params)}`
const onLoginClick = useCallback(() => {
TelemetryClient.trackEvent(TelemetryCategory, TelemetryActions.ShareBoardLogin)
history.push(loginPath)
location.assign(loginPath)
}, [])
return (

11
webapp/boards/src/components/viewHeader/viewHeader.tsx
Просмотреть файл

@@ -59,9 +59,12 @@ const ViewHeader = (props: Props) => {
const [showFilter, setShowFilter] = useState(false)
const [lockFilterOnClose, setLockFilterOnClose] = useState(false)
const intl = useIntl()
const canEditBoardProperties = useHasCurrentBoardPermissions([Permission.ManageBoardProperties])
const {board, activeView, views, groupByProperty, cards, dateDisplayProperty} = props
let readonly = props.readonly
if(!readonly){
readonly = !useHasCurrentBoardPermissions([Permission.ManageBoardProperties])
}
const withGroupBy = activeView.fields.viewType === 'board' || activeView.fields.viewType === 'table'
const withDisplayBy = activeView.fields.viewType === 'calendar'
@@ -137,7 +140,7 @@ const ViewHeader = (props: Props) => {
}}
onChange={setViewTitle}
saveOnEsc={true}
readonly={props.readonly || !canEditBoardProperties}
readonly={readonly}
spellCheck={true}
autoExpand={false}
/>
@@ -148,7 +151,7 @@ const ViewHeader = (props: Props) => {
board={board}
activeView={activeView}
views={views}
readonly={props.readonly || !canEditBoardProperties}
readonly={readonly}
allowCreateView={allowCreateView}
/>
</MenuWrapper>
@@ -159,7 +162,7 @@ const ViewHeader = (props: Props) => {
<div className='octo-spacer'/>
{!props.readonly && canEditBoardProperties &&
{!readonly &&
<>
{/* Card properties */}

6
webapp/boards/src/components/viewTitle.tsx
Просмотреть файл

@@ -34,9 +34,11 @@ const ViewTitle = (props: Props) => {
}, [board.id, board.icon])
const onShowDescription = useCallback(() => mutator.showBoardDescription(board.id, Boolean(board.showDescription), true), [board.id, board.showDescription])
const onHideDescription = useCallback(() => mutator.showBoardDescription(board.id, Boolean(board.showDescription), false), [board.id, board.showDescription])
const canEditBoardProperties = useHasCurrentBoardPermissions([Permission.ManageBoardProperties])
const readonly = props.readonly || !canEditBoardProperties
let readonly = props.readonly
if(!readonly){
readonly = !useHasCurrentBoardPermissions([Permission.ManageBoardProperties])
}
const intl = useIntl()

1
webapp/boards/src/components/workspace.test.tsx
Просмотреть файл

@@ -114,6 +114,7 @@ jest.mock('react-router-dom', () => {
useRouteMatch: jest.fn(() => {
return {
params: {
teamId: board.teamId,
boardId: board.id,
viewId: activeView.id,
},

3
webapp/boards/src/hooks/permissions.tsx
Просмотреть файл

@@ -12,13 +12,12 @@ export const useHasPermissions = (teamId: string, boardId: string, permissions:
return false
}
const member = useAppSelector(getMyBoardMembership(boardId))
const board = useAppSelector(getBoard(boardId))
if (!board) {
return false
}
const member = useAppSelector(getMyBoardMembership(boardId))
if (!member) {
return false
}

46
webapp/boards/src/index.tsx
Просмотреть файл

@@ -28,6 +28,7 @@ windowAny.baseURL = '/plugins/boards'
windowAny.frontendBaseURL = '/boards'
import App from 'src/app'
import PublicApp, {publicBaseURL} from 'src/public/app'
import store from 'src/store'
import WithWebSockets from 'src/components/withWebSockets'
@@ -175,10 +176,44 @@ const MainApp = (props: Props) => {
)
}
const PublicMainApp = () => {
useEffect(() => {
document.body.classList.add('focalboard-body')
const root = document.getElementById('root')
if (root) {
while (root.firstElementChild) {
if( root.firstElementChild.id === 'focalboard-app'){
break
}
root.removeChild(root.firstElementChild)
}
root.classList.add('focalboard-plugin-root')
}
return () => {
document.body.classList.remove('focalboard-body')
if (root) {
root.classList.remove('focalboard-plugin-root')
}
}
}, [])
return (
<ErrorBoundary>
<ReduxProvider store={store}>
<div id='focalboard-app'>
<PublicApp />
</div>
<div id='focalboard-root-portal' />
</ReduxProvider>
</ErrorBoundary>
)
}
const HeaderComponent = () => {
return (
<ErrorBoundary>
<GlobalHeader history={browserHistory}/>
<GlobalHeader history={browserHistory} />
</ErrorBoundary>
)
}
@@ -243,8 +278,6 @@ export default class Plugin {
}
})
const initCurrentChannelId = mmStore.getState().entities.channels.currentChannelId
const initCurrentChannel = mmStore.getState().entities.channels.channels[initCurrentChannelId]
let lastViewedChannelId = initCurrentChannelId
@@ -274,7 +307,9 @@ export default class Plugin {
prevTeamId = currentTeamId
store.dispatch(setTeam(currentTeamId))
octoClient.teamId = currentTeamId
store.dispatch(initialLoad())
if(!window.location.pathname.includes(publicBaseURL())){
store.dispatch(initialLoad())
}
}
if (currentTeamId && currentTeamId !== prevTeamId) {
@@ -336,6 +371,9 @@ export default class Plugin {
HeaderComponent,
() => null,
true,
true,
true,
PublicMainApp,
)
const goToFocalboardTemplate = () => {

61
webapp/boards/src/public/app.tsx Обычный файл
Просмотреть файл

@@ -0,0 +1,61 @@
// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
// See LICENSE.txt for license information.
import React from 'react'
import {Router, Switch} from 'react-router-dom'
import {IntlProvider} from 'react-intl'
import {DndProvider} from 'react-dnd'
import {HTML5Backend} from 'react-dnd-html5-backend'
import {TouchBackend} from 'react-dnd-touch-backend'
import {createBrowserHistory} from 'history'
import BoardPage from 'src/pages/boardPage/boardPage'
import FBRoute from 'src/route'
import {getMessages} from 'src/i18n'
import FlashMessages from 'src/components/flashMessages'
import NewVersionBanner from 'src/components/newVersionBanner'
import {Utils} from 'src/utils'
import {getLanguage} from 'src/store/language'
import {useAppSelector} from 'src/store/hooks'
export const publicBaseURL = () => {
return Utils.getFrontendBaseURL() + '/public'
}
const PublicRouter = () => {
const history = createBrowserHistory({basename: publicBaseURL()})
return (
<Router history={history}>
<Switch>
<FBRoute path={['/team/:teamId/shared/:boardId?/:viewId?/:cardId?', '/shared/:boardId?/:viewId?/:cardId?']}>
<BoardPage readonly={true}/>
</FBRoute>
</Switch>
</Router>
)
}
const PublicApp = (): JSX.Element => {
const language = useAppSelector<string>(getLanguage)
return (
<IntlProvider
locale={language.split(/[_]/)[0]}
messages={getMessages(language)}
>
<DndProvider backend={Utils.isMobile() ? TouchBackend : HTML5Backend}>
<FlashMessages milliseconds={2000}/>
<div id='frame'>
<div id='main'>
<NewVersionBanner/>
<PublicRouter/>
</div>
</div>
</DndProvider>
</IntlProvider>
)
}
export default React.memo(PublicApp)

4
webapp/boards/src/types/mattermost-webapp/index.d.ts поставляемый
Просмотреть файл

@@ -14,7 +14,9 @@ export interface PluginRegistry {
registerCustomRoute(route: string, component: ReactResolvable): any
registerProductRoute(route: string, component: ReactResolvable): any
unregisterComponent(componentId: string): any
registerProduct(baseURL: string, switcherIcon: string, switcherText: string, switcherLinkURL: string, mainComponent: ReactResolvable, headerCentreComponent: ReactResolvable, headerRightComponent: ReactResolvable, showTeamSidebar: boolean): any
registerProduct(baseURL: string, switcherIcon: string, switcherText: string, switcherLinkURL: string,
mainComponent: ReactResolvable, headerCentreComponent: ReactResolvable, headerRightComponent: ReactResolvable,
showTeamSidebar: boolean, showAppBar: boolean, wrapped: boolean, publicComponent: ReactResolvable | null): any
registerPostWillRenderEmbedComponent(match: (embed: {type: string, data: any}) => void, component: any, toggleable: boolean): any
registerWebSocketEventHandler(event: string, handler: (e: any) => void): any
unregisterWebSocketEventHandler(event: string): any

1
webapp/channels/src/components/admin_console/admin_definition.jsx
Просмотреть файл

@@ -5746,7 +5746,6 @@ const AdminDefinition = {
sectionTitle: t('admin.sidebar.products'),
sectionTitleDefault: 'Products',
isHidden: it.any(
it.configIsFalse('FeatureFlags', 'BoardsProduct'),
it.not(it.userHasReadPermissionOnSomeResources(RESOURCE_KEYS.PRODUCTS)),
),
boards: {

186
webapp/channels/src/components/admin_console/admin_sidebar/__snapshots__/admin_sidebar.test.tsx.snap
Просмотреть файл

@@ -1072,6 +1072,37 @@ exports[`components/AdminSidebar should match snapshot 1`] = `
title="Plugin 0"
/>
</AdminSidebarCategory>
<AdminSidebarCategory
definitionKey="products"
icon={
<ProductsIcon
className="category-icon fa"
color="currentColor"
size={16}
/>
}
key="products"
parentLink="/admin_console"
sectionClass=""
title={
<Memo(MemoizedFormattedMessage)
defaultMessage="Products"
id="admin.sidebar.products"
/>
}
>
<AdminSidebarSection
definitionKey="products.boards"
key="products.boards"
name="products/boards"
title={
<Memo(MemoizedFormattedMessage)
defaultMessage="Boards"
id="admin.sidebar.boards"
/>
}
/>
</AdminSidebarCategory>
<AdminSidebarCategory
definitionKey="integrations"
icon={
@@ -1775,6 +1806,37 @@ exports[`components/AdminSidebar should match snapshot with workspace optimizati
title="Plugin 0"
/>
</AdminSidebarCategory>
<AdminSidebarCategory
definitionKey="products"
icon={
<ProductsIcon
className="category-icon fa"
color="currentColor"
size={16}
/>
}
key="products"
parentLink="/admin_console"
sectionClass=""
title={
<Memo(MemoizedFormattedMessage)
defaultMessage="Products"
id="admin.sidebar.products"
/>
}
>
<AdminSidebarSection
definitionKey="products.boards"
key="products.boards"
name="products/boards"
title={
<Memo(MemoizedFormattedMessage)
defaultMessage="Boards"
id="admin.sidebar.boards"
/>
}
/>
</AdminSidebarCategory>
<AdminSidebarCategory
definitionKey="integrations"
icon={
@@ -2533,6 +2595,37 @@ exports[`components/AdminSidebar should match snapshot, not prevent the console
title="Plugin 0"
/>
</AdminSidebarCategory>
<AdminSidebarCategory
definitionKey="products"
icon={
<ProductsIcon
className="category-icon fa"
color="currentColor"
size={16}
/>
}
key="products"
parentLink="/admin_console"
sectionClass=""
title={
<Memo(MemoizedFormattedMessage)
defaultMessage="Products"
id="admin.sidebar.products"
/>
}
>
<AdminSidebarSection
definitionKey="products.boards"
key="products.boards"
name="products/boards"
title={
<Memo(MemoizedFormattedMessage)
defaultMessage="Boards"
id="admin.sidebar.boards"
/>
}
/>
</AdminSidebarCategory>
<AdminSidebarCategory
definitionKey="integrations"
icon={
@@ -3236,6 +3329,37 @@ exports[`components/AdminSidebar should match snapshot, render plugins without a
title="Plugin 0"
/>
</AdminSidebarCategory>
<AdminSidebarCategory
definitionKey="products"
icon={
<ProductsIcon
className="category-icon fa"
color="currentColor"
size={16}
/>
}
key="products"
parentLink="/admin_console"
sectionClass=""
title={
<Memo(MemoizedFormattedMessage)
defaultMessage="Products"
id="admin.sidebar.products"
/>
}
>
<AdminSidebarSection
definitionKey="products.boards"
key="products.boards"
name="products/boards"
title={
<Memo(MemoizedFormattedMessage)
defaultMessage="Boards"
id="admin.sidebar.boards"
/>
}
/>
</AdminSidebarCategory>
<AdminSidebarCategory
definitionKey="integrations"
icon={
@@ -4038,6 +4162,37 @@ exports[`components/AdminSidebar should match snapshot, with license (with all f
title="Plugin 0"
/>
</AdminSidebarCategory>
<AdminSidebarCategory
definitionKey="products"
icon={
<ProductsIcon
className="category-icon fa"
color="currentColor"
size={16}
/>
}
key="products"
parentLink="/admin_console"
sectionClass=""
title={
<Memo(MemoizedFormattedMessage)
defaultMessage="Products"
id="admin.sidebar.products"
/>
}
>
<AdminSidebarSection
definitionKey="products.boards"
key="products.boards"
name="products/boards"
title={
<Memo(MemoizedFormattedMessage)
defaultMessage="Boards"
id="admin.sidebar.boards"
/>
}
/>
</AdminSidebarCategory>
<AdminSidebarCategory
definitionKey="integrations"
icon={
@@ -4973,6 +5128,37 @@ exports[`components/AdminSidebar should match snapshot, with license (without an
title="Plugin 0"
/>
</AdminSidebarCategory>
<AdminSidebarCategory
definitionKey="products"
icon={
<ProductsIcon
className="category-icon fa"
color="currentColor"
size={16}
/>
}
key="products"
parentLink="/admin_console"
sectionClass=""
title={
<Memo(MemoizedFormattedMessage)
defaultMessage="Products"
id="admin.sidebar.products"
/>
}
>
<AdminSidebarSection
definitionKey="products.boards"
key="products.boards"
name="products/boards"
title={
<Memo(MemoizedFormattedMessage)
defaultMessage="Boards"
id="admin.sidebar.boards"
/>
}
/>
</AdminSidebarCategory>
<AdminSidebarCategory
definitionKey="integrations"
icon={

136
webapp/channels/src/components/root/__snapshots__/root.test.tsx.snap Обычный файл
Просмотреть файл

@@ -0,0 +1,136 @@
// Jest Snapshot v1, https://goo.gl/fbAQLP
exports[`components/Root Routes Should mount public product routes 1`] = `
<RootProvider>
<Switch>
<Route
component={[Function]}
path="/error"
/>
<HFRoute
component={[Function]}
path="/login"
/>
<HFRoute
component={[Function]}
path="/access_problem"
/>
<HFTRoute
component={[Function]}
path="/reset_password"
/>
<HFTRoute
component={[Function]}
path="/reset_password_complete"
/>
<HFRoute
component={[Function]}
path="/signup_user_complete"
/>
<HFRoute
component={[Function]}
path="/should_verify_email"
/>
<HFRoute
component={[Function]}
path="/do_verify_email"
/>
<HFTRoute
component={[Function]}
path="/claim"
/>
<HFTRoute
component={[Function]}
path="/help"
/>
<LoggedInRoute
component={[Function]}
path="/terms_of_service"
/>
<Route
component={[Function]}
path="/landing"
/>
<Route
path="/admin_console"
>
<Switch>
<LoggedInRoute
component={[Function]}
path="/admin_console"
theme={Object {}}
/>
<Connect(RootRedirect) />
</Switch>
</Route>
<LoggedInHFTRoute
component={[Function]}
path="/select_team"
/>
<LoggedInHFTRoute
component={[Function]}
path="/oauth/authorize"
/>
<LoggedInHFTRoute
component={[Function]}
path="/create_team"
/>
<LoggedInRoute
component={[Function]}
path="/mfa"
/>
<LoggedInRoute
component={[Function]}
path="/preparing-workspace"
/>
<Redirect
from="/_redirect/integrations/:subpath*"
to="/myTeam/integrations/:subpath*"
/>
<Redirect
from="/_redirect/pl/:postid"
to="/myTeam/pl/:postid"
/>
<CompassThemeProvider
theme={Object {}}
>
<Connect(ModalController) />
<Connect(_class) />
<Connect(SystemNotice) />
<GlobalHeader />
<CloudEffectsWrapper />
<withRouter(Connect(TeamSidebar)) />
<DelinquencyModalController />
<Switch>
<Route
key="productwithpublic-public"
path="/productwithpublic/public"
render={[Function]}
/>
<Route
key="productwithpublic"
path="/productwithpublic"
render={[Function]}
/>
<Route
key="productwithoutpublic"
path="/productwithoutpublic"
render={[Function]}
/>
<LoggedInRoute
component={[Function]}
path="/:team"
theme={Object {}}
/>
<Connect(RootRedirect) />
</Switch>
<Connect(Pluggable)
pluggableName="Global"
/>
<withRouter(Connect(Component)) />
<AppBar />
<Connect(SidebarRightMenu) />
</CompassThemeProvider>
</Switch>
</RootProvider>
`;

32
webapp/channels/src/components/root/root.test.tsx
Просмотреть файл

@@ -15,6 +15,7 @@ import Root from 'components/root/root';
import * as GlobalActions from 'actions/global_actions';
import Constants, {StoragePrefixes, WindowSizes} from 'utils/constants';
import matchMedia from 'tests/helpers/match_media.mock';
import {ProductComponent} from 'types/store/plugins';
jest.mock('rudder-sdk-js', () => ({
identify: jest.fn(),
@@ -64,7 +65,7 @@ describe('components/Root', () => {
registerCustomPostRenderer: jest.fn(),
initializeProducts: jest.fn(),
},
permalinkRedirectTeamName: '',
permalinkRedirectTeamName: 'myTeam',
showLaunchingWorkspace: false,
plugins: [],
products: [],
@@ -325,4 +326,33 @@ describe('components/Root', () => {
wrapper.unmount();
});
});
describe('Routes', () => {
test('Should mount public product routes', () => {
const mainComponent = () => (<p>{'TestMainComponent'}</p>);
const publicComponent = () => (<p>{'TestPublicProduct'}</p>);
const props = {
...baseProps,
products: [{
id: 'productwithpublic',
baseURL: '/productwithpublic',
mainComponent,
publicComponent,
} as unknown as ProductComponent,
{
id: 'productwithoutpublic',
baseURL: '/productwithoutpublic',
mainComponent,
publicComponent: null,
} as unknown as ProductComponent],
};
const wrapper = shallow(<Root {...props}/>);
(wrapper.instance() as any).setState({configLoaded: true});
expect(wrapper).toMatchSnapshot();
wrapper.unmount();
});
});
});

17
webapp/channels/src/components/root/root.tsx
Просмотреть файл

@@ -650,6 +650,23 @@ export default class Root extends React.PureComponent<Props, State> {
<TeamSidebar/>
<DelinquencyModalController/>
<Switch>
{this.props.products?.filter((product) => Boolean(product.publicComponent)).map((product) => (
<Route
key={`${product.id}-public`}
path={`${product.baseURL}/public`}
render={(props) => {
return (
<Pluggable
pluggableName={'Product'}
subComponentName={'publicComponent'}
pluggableId={product.id}
css={{gridArea: 'center'}}
{...props}
/>
);
}}
/>
))}
{this.props.products?.map((product) => (
<Route
key={product.id}

2
webapp/channels/src/plugins/pluggable/pluggable.tsx
Просмотреть файл

@@ -41,7 +41,7 @@ type Props = {
*
* Only supported when pluggableName is "Product".
*/
subComponentName?: 'mainComponent' | 'headerCentreComponent' | 'headerRightComponent';
subComponentName?: 'mainComponent' | 'publicComponent' | 'headerCentreComponent' | 'headerRightComponent';
/*
* Accept any other prop to pass onto the plugin component

3
webapp/channels/src/plugins/registry.ts
Просмотреть файл

@@ -986,6 +986,7 @@ export default class PluginRegistry {
'showTeamSidebar',
'showAppBar',
'wrapped',
'publicComponent',
], ({
baseURL,
switcherIcon,
@@ -997,6 +998,7 @@ export default class PluginRegistry {
showTeamSidebar = false,
showAppBar = false,
wrapped = true,
publicComponent,
}: Omit<ProductComponent, 'id' | 'pluginId'>) => {
const id = generateId();
@@ -1016,6 +1018,7 @@ export default class PluginRegistry {
showTeamSidebar,
showAppBar,
wrapped,
publicComponent,
},
});

5
webapp/channels/src/types/store/plugins.ts
Просмотреть файл

@@ -187,6 +187,11 @@ export type ProductComponent = {
*/
mainComponent: React.ComponentType;
/**
* The public component to be displayed when a public route is active.
*/
publicComponent: React.ComponentType | null;
/**
* A component to fill the generic area in the center of
* the global header when your route is active.

1
webapp/channels/src/utils/test_helper.ts
Просмотреть файл

@@ -371,6 +371,7 @@ export class TestHelper {
showTeamSidebar: false,
showAppBar: false,
wrapped: true,
publicComponent: null,
};
}

3
webapp/playbooks/src/index.tsx
Просмотреть файл

@@ -180,7 +180,8 @@ export default class Plugin {
BackstageWrapped,
GlobalHeaderCenter,
GlobalHeaderRight,
enableTeamSidebar
enableTeamSidebar,
null
);
// RHS Registration