docs: Added content in Readme and deploymentguide for SFI issue#914
docs: Added content in Readme and deploymentguide for SFI issue#914Roopan-Microsoft merged 2 commits intodev-v4from
Conversation
Added notes about tenant security restrictions and Azure OpenAI quota availability.
Added note about security restrictions and WAF-supported version deployment.
There was a problem hiding this comment.
Pull request overview
This PR adds deployment documentation notes related to tenant security restrictions, but also introduces a large set of functional and infrastructure changes including a frontend migration/refactor, dependency upgrades, and CI/CD adjustments.
Changes:
- Added SFI/security-restriction guidance to README and DeploymentGuide.
- Migrated/refactored the frontend into
src/App(Vite + Redux Toolkit + restructured API/store/hooks/components) and updated build/deploy pipelines accordingly. - Updated infra templates and introduced new CI workflows (e.g., bicep parameter validation), plus dependency bumps across Python components.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| src/tests/backend/v4/orchestration/helper/test_plan_to_mplan_converter.py | Removes unused model imports in tests. |
| src/tests/backend/v4/config/test_settings.py | Refactors unittest imports and strengthens cancellation assertions. |
| src/tests/backend/common/database/test_database_base.py | Tightens exception assertion with match=. |
| src/mcp_server/pyproject.toml | Bumps MCP server runtime dependencies (incl. fastmcp). |
| src/frontend/src/services/index.tsx | Removes old frontend service barrel exports. |
| src/frontend/src/hooks/index.tsx | Removes old frontend hook barrel exports. |
| src/frontend/src/api/index.tsx | Removes old frontend API barrel exports. |
| src/frontend/src/api/apiClient.tsx | Removes legacy API client implementation. |
| src/backend/requirements.txt | Bumps backend Python dependencies (security/patch updates). |
| src/backend/pyproject.toml | Mirrors backend dependency bumps in pyproject. |
| src/App/vitest.config.ts | Adds Vitest configuration for the new frontend app. |
| src/App/vite.config.ts | Adjusts Vite build config/optimizeDeps. |
| src/App/tsconfig.node.json | Adds node tsconfig for tooling/build config typing. |
| src/App/tsconfig.json | Adds Vite-oriented TS config (bundler resolution, strict, paths). |
| src/App/src/vite-env.d.ts | Adds Vite env typing declarations. |
| src/App/src/utils/utils.tsx | Adds date formatting utility. |
| src/App/src/utils/messageUtils.ts | Adds message formatting/extraction helpers. |
| src/App/src/utils/index.ts | Adds utils barrel export. |
| src/App/src/utils/errorUtils.tsx | Adds user-friendly error mapping utilities. |
| src/App/src/utils/agentIconUtils.tsx | Updates service import paths for agent icon logic. |
| src/App/src/styles/TaskList.css | Adds TaskList styles (including skeleton/accordion styling). |
| src/App/src/styles/TaskDetails.css | Adds TaskDetails component styling. |
| src/App/src/styles/prism-material-oceanic.css | Adds Prism theme CSS for syntax highlighting. |
| src/App/src/styles/PlanPanelLeft.css | Adds left panel styling for plan/task navigation. |
| src/App/src/styles/PlanPage.css | Adds layout and responsive styles for PlanPage. |
| src/App/src/styles/PlanCreatePage.css | Adds placeholder styles for plan creation page. |
| src/App/src/styles/Panel.css | Adds shared panel toolbar/dialog/button focus styles. |
| src/App/src/styles/HomeInput.css | Adds HomeInput layout and responsive styles. |
| src/App/src/store/TeamService.tsx | Cleans up logging and narrows catch blocks in team service. |
| src/App/src/store/store.ts | Introduces Redux store configuration with serializableCheck ignores. |
| src/App/src/store/slices/teamSlice.ts | Adds Redux slice/selectors for team state. |
| src/App/src/store/slices/streamingSlice.ts | Adds Redux slice/selectors for streaming state. |
| src/App/src/store/slices/chatSlice.ts | Adds Redux slice/selectors for chat state. |
| src/App/src/store/slices/appSlice.ts | Adds Redux slice/selectors for global app state. |
| src/App/src/store/PlanDataService.tsx | Adjusts log levels for plan data operations. |
| src/App/src/store/NewTaskService.tsx | Adds cross-page “new task” event helper service. |
| src/App/src/store/index.ts | Adds store barrel export for slices/hooks/services. |
| src/App/src/store/hooks.ts | Adds typed Redux hooks. |
| src/App/src/setupTests.tsx | Adds Testing Library DOM matchers setup for Vitest. |
| src/App/src/reportWebVitals.tsx | Adds web-vitals helper (duplicate of .ts version). |
| src/App/src/reportWebVitals.ts | Adds web-vitals helper (duplicate of .tsx version). |
| src/App/src/react-app-env.d.ts | Adds CRA type reference file (potentially legacy). |
| src/App/src/pages/index.tsx | Adds pages barrel export. |
| src/App/src/models/Team.tsx | Adds Team/Agent/TeamConfig model types. |
| src/App/src/models/taskList.tsx | Adds TaskList model/props types. |
| src/App/src/models/taskDetails.tsx | Adjusts PlanDetailsProps to allow planData nullable. |
| src/App/src/models/planPanelLeft.tsx | Adds PlanPanelLeft props interface. |
| src/App/src/models/messages.tsx | Adds websocket/message model types. |
| src/App/src/models/inputTask.tsx | Adds input task request/response model types. |
| src/App/src/models/index.tsx | Adds models barrel export with conflict-avoidance types. |
| src/App/src/models/homeInput.tsx | Adds HomeInput models and icon mapping. |
| src/App/src/models/auth.tsx | Adds auth/user info model types. |
| src/App/src/models/agentMessage.tsx | Adds agent message model types. |
| src/App/src/index.tsx | Wraps app with Redux Provider; keeps config/theme init. |
| src/App/src/index.css | Adds global CSS, scrollbar styles, and error-hiding rules. |
| src/App/src/hooks/useWebSocket.tsx | Updates websocket service import and error handling. |
| src/App/src/hooks/useTeamSelection.tsx | Updates TeamService import and removes console logging. |
| src/App/src/hooks/useRAIErrorHandling.tsx | Adds hook to parse/hold RAI validation errors. |
| src/App/src/hooks/usePlanCancellationAlert.tsx | Simplifies error handling on cancellation flow. |
| src/App/src/hooks/usePlanActions.tsx | Adds thunk-based plan loader/reset logic with abort support. |
| src/App/src/hooks/useAutoScroll.tsx | Extracts auto-scroll behavior into reusable hook. |
| src/App/src/hooks/index.tsx | Adds hooks barrel export. |
| src/App/src/components/NotFound/ContentNotFound.tsx | Adds generic “content not found” component. |
| src/App/src/components/errors/RAIErrorCard.tsx | Adds UI card for RAI validation errors. |
| src/App/src/components/errors/index.tsx | Adds errors barrel export. |
| src/App/src/components/content/TaskList.tsx | Memoizes TaskList export. |
| src/App/src/components/content/streaming/StreamingUserPlanMessage.tsx | Adds user message rendering for streaming UI. |
| src/App/src/components/content/streaming/StreamingUserPlan.tsx | Adds helper to derive user task text from plan sources. |
| src/App/src/components/content/streaming/StreamingPlanState.tsx | Adds thinking/execution status render helpers. |
| src/App/src/components/content/streaming/StreamingBufferMessage.tsx | Memoizes StreamingBufferMessage export. |
| src/App/src/components/content/streaming/StreamingAgentMessage.tsx | Updates TaskService import path for streaming agent messages. |
| src/App/src/components/content/PlanPanelRight.tsx | Memoizes PlanPanelRight export. |
| src/App/src/components/content/PlanPanelLeft.tsx | Switches to commonComponents panels, updates imports, memoizes export. |
| src/App/src/components/content/PlanChatBody.tsx | Switches ChatInput/icon imports to commonComponents; memoizes export. |
| src/App/src/components/content/PlanChat.tsx | Memoizes PlanChat export. |
| src/App/src/components/content/HomeInput.tsx | Updates service imports to store, commonComponents ChatInput/PromptCard; memoizes export. |
| src/App/src/components/content/contoso.tsx | Adds inline Contoso SVG component. |
| src/App/src/components/common/TeamSelector.tsx | Updates TeamService import and removes debug logging. |
| src/App/src/components/common/TeamSelected.tsx | Adds component to display currently selected team. |
| src/App/src/components/common/PlanCancellationDialog.tsx | Adds reusable cancellation confirmation dialog. |
| src/App/src/commonComponents/SYSTEM_OVERVIEW.md | Adds architecture overview/documentation for common components layer. |
| src/App/src/commonComponents/modules/prism-material-oceanic.css | Adds duplicate Prism theme CSS under commonComponents. |
| src/App/src/commonComponents/modules/ChatExample.tsx | Adds example chat mock UI module. |
| src/App/src/commonComponents/modules/Chat.tsx | Tweaks error handling and removes noisy logs in module chat. |
| src/App/src/commonComponents/imports/MsftColor.tsx | Adds Microsoft logo SVG component. |
| src/App/src/commonComponents/imports/ContosoLogo.tsx | Adds Contoso logo SVG component. |
| src/App/src/commonComponents/imports/bundleicons.tsx | Adds Fluent bundleIcon exports for common icon usage. |
| src/App/src/commonComponents/components/PromptCard.tsx | Adds reusable PromptCard component. |
| src/App/src/commonComponents/components/Progress/ProgressCircle.tsx | Adds progress ring UI component. |
| src/App/src/commonComponents/components/Panels/UserCard.tsx | Adds user avatar/name card for panels. |
| src/App/src/commonComponents/components/Panels/PanelRightToolbar.tsx | Adds right panel toolbar with dismiss behavior. |
| src/App/src/commonComponents/components/Panels/PanelRight.tsx | Adds resizable right panel implementation. |
| src/App/src/commonComponents/components/Panels/PanelLeftToolbar.tsx | Adds left panel toolbar with link/click behaviors. |
| src/App/src/commonComponents/components/Panels/PanelLeft.tsx | Adds resizable left panel implementation with footer support. |
| src/App/src/commonComponents/components/Panels/PanelFooter.tsx | Adds panel footer wrapper. |
| src/App/src/commonComponents/components/LoadingMessage.tsx | Adds reusable loading message component/messages list. |
| src/App/src/commonComponents/components/Layout/README.md | Adds layout documentation for shell row/column. |
| src/App/src/commonComponents/components/Layout/CoralShellRow.tsx | Adds horizontal layout shell component. |
| src/App/src/commonComponents/components/Layout/CoralShellColumn.tsx | Adds vertical layout shell component. |
| src/App/src/commonComponents/components/Header/PanelRightToggles.tsx | Updates icon imports to commonComponents bundleicons. |
| src/App/src/commonComponents/components/Header/HeaderTools.tsx | Adds header toolbar wrapper. |
| src/App/src/commonComponents/components/Header/Header.tsx | Adds header with logo/title/subtitle and slots. |
| src/App/src/commonComponents/components/eventbus.tsx | Adds lightweight event bus used by panel components. |
| src/App/src/commonComponents/components/CoralAccordion/CoralAccordionPanel.tsx | Adds accordion panel component. |
| src/App/src/commonComponents/components/CoralAccordion/CoralAccordionItem.tsx | Adds accordion item with open/close logic. |
| src/App/src/commonComponents/components/CoralAccordion/CoralAccordionHeader.tsx | Adds accordion header with chevron and toggle. |
| src/App/src/commonComponents/components/CoralAccordion/CoralAccordionContext.tsx | Adds accordion context and hook. |
| src/App/src/commonComponents/components/CoralAccordion/CoralAccordion.tsx | Adds accordion wrapper component. |
| src/App/src/commonComponents/components/Content/ContentToolbar.tsx | Adds content toolbar component. |
| src/App/src/commonComponents/components/Content/Content.tsx | Adds content container that extracts a toolbar child. |
| src/App/src/App.tsx | Adds router wiring for Home/Plan pages and initializes websocket hook. |
| src/App/src/App.css | Adds app-wide styles (tabs/task list). |
| src/App/src/api/index.tsx | Reintroduces API barrel with new httpClient/apiUtils exports. |
| src/App/src/api/config.tsx | Removes headerBuilder and trims logging in config helpers. |
| src/App/src/api/apiUtils.ts | Adds request cache, retry, and helper utilities. |
| src/App/src/api/apiService.tsx | Removes verbose logs and preserves cache invalidation logic. |
| src/App/src/api/apiClient.tsx | Replaces legacy apiClient with httpClient-based adapter. |
| src/App/requirements.txt | Adds Python requirements for the frontend server container. |
| src/App/README.md | Adds CRA template README (may be stale given Vite migration). |
| src/App/pyproject.toml | Adds Python project definition for frontend server dependencies. |
| src/App/public/robots.txt | Adds robots.txt. |
| src/App/public/manifest.json | Adds PWA manifest. |
| src/App/public/index.html | Adds public index.html (static template). |
| src/App/public/contosoLogo.svg | Adds contoso logo asset. |
| src/App/package.json | Adds Redux deps, removes axios, pins Vite, and adjusts overrides/scripts. |
| src/App/migration-commands.txt | Adds local migration command notes (CRA → Vite). |
| src/App/index.html | Adds Vite root index.html. |
| src/App/frontend_server.py | Adds FastAPI server to serve built frontend + /config endpoint. |
| src/App/Dockerfile | Adds multi-stage build for frontend + python server runtime. |
| src/App/.python-version | Pins Python version for the frontend server. |
| src/App/.gitignore | Adds frontend-specific ignore patterns. |
| src/App/.eslintrc.js | Adds ESLint config file for the new app. |
| src/App/.env.sample | Adds sample env vars for frontend server/config. |
| src/App/.dockerignore | Adds dockerignore for frontend build context. |
| README.md | Adds tenant-security/WAF deployment note. |
| Multi-Agent-Custom-Automation-Engine-Solution-Accelerator.code-workspace | Updates commented workspace path from frontend → App. |
| infra/old/08-2025/modules/role.bicep | Removes obsolete infra module. |
| infra/old/08-2025/modules/fetch-container-image.bicep | Removes obsolete infra module. |
| infra/old/08-2025/modules/container-app-environment.bicep | Removes obsolete infra module. |
| infra/old/08-2025/modules/ai-hub.bicep | Removes obsolete infra module. |
| infra/old/08-2025/modules/account/modules/project.bicep | Removes obsolete infra module. |
| infra/old/08-2025/modules/account/modules/keyVaultExport.bicep | Removes obsolete infra module. |
| infra/old/08-2025/main.parameters.json | Removes obsolete infra parameters file. |
| infra/old/08-2025/bicepconfig.json | Removes obsolete bicep config. |
| infra/old/00-older/main2.bicep | Removes legacy infra template. |
| infra/old/00-older/macae-mini.bicepparam | Removes legacy infra param file. |
| infra/old/00-older/macae-large.bicepparam | Removes legacy infra param file. |
| infra/old/00-older/macae-dev.bicep | Removes legacy dev infra template. |
| infra/old/00-older/deploy_managed_identity.bicep | Removes legacy infra template. |
| infra/old/00-older/deploy_keyvault.bicep | Removes legacy infra template. |
| infra/main.waf.parameters.json | Removes/adjusts WAF parameter list content. |
| infra/main.json | Updates compiled ARM template (hash + outputs/identity/location changes). |
| infra/main.bicep | Enables system-assigned identity for web site; adds location to search module update. |
| infra/main_custom.bicep | Enables system-assigned identity for custom web site deployment. |
| docs/ManualAzureDeployment.md | Updates manual deployment doc path from frontend → App. |
| docs/LocalDevelopmentSetup.md | Updates local setup doc paths and instructions for new frontend directory. |
| docs/DeploymentGuide.md | Adds tenant restriction/WAF guidance note. |
| azure.yaml | Adds required bicep version constraint. |
| azure_custom.yaml | Updates frontend project path to ./src/App. |
| .github/workflows/validate-bicep-params.yml | Adds scheduled/PR bicep parameter validation workflow. |
| .github/workflows/job-docker-build.yml | Updates docker build context/path to src/App. |
| .github/workflows/docker-build-and-push.yml | Updates docker build context/path filters to src/App. |
| .github/workflows/deploy-waf.yml | Adds path filters for deploy-waf workflow trigger. |
| .github/workflows/azure-dev.yml | Replaces template validation workflow with azd-based deploy job. |
| .github/workflows/azd-template-validation.yml | Adds scheduled azd template validation workflow. |
| .github/dependabot.yml | Updates pip ecosystem directory from /src/frontend → /src/App. |
| .azdo/pipelines/azure-dev.yml | Adds path filters and excludes docs/markdown from triggers. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| > **Note**: Some tenants may have additional security restrictions that run periodically and could impact the application (e.g., blocking public network access). If you experience issues or the application stops working, check if these restrictions are the cause. In such cases, consider deploying the WAF-supported version to ensure compliance. To configure, [Click here](./docs/DeploymentGuide.md#31-choose-deployment-type-optional). | ||
|
|
There was a problem hiding this comment.
The PR title/description says this is a docs-only change for an SFI note, but the diff includes a large frontend refactor/migration (new src/App app, Redux store, API client rewrite, Dockerfile/workflow changes, infra changes, dependency upgrades). Please update the PR description/title to reflect the actual scope so reviewers can assess risk appropriately (or split into separate PRs).
Purpose
Does this introduce a breaking change?
Other Information
Added content in Readme for SFI issue