Skip to content

Show operation default setting values and host settings in the designer#9253

Open
JoaquimMalcampo wants to merge 5 commits into
mainfrom
jmalcampo/nodeSettingDetailsEnhancements
Open

Show operation default setting values and host settings in the designer#9253
JoaquimMalcampo wants to merge 5 commits into
mainfrom
jmalcampo/nodeSettingDetailsEnhancements

Conversation

@JoaquimMalcampo
Copy link
Copy Markdown
Contributor

@JoaquimMalcampo JoaquimMalcampo commented Jun 5, 2026

Commit Type

  • feature - New functionality
  • fix - Bug fix
  • refactor - Code restructuring without behavior change
  • perf - Performance improvement
  • docs - Documentation update
  • test - Test-related changes
  • chore - Maintenance/tooling

Risk Level

  • Low - Minor changes, limited scope
  • Medium - Moderate changes, some user impact
  • High - Major changes, significant user/system impact

What & Why

Adds UI visibility for operation setting defaults returned by the settingDefaults API. Previously, settings like retry policy showed "Default" with no detail fields when no explicit value was set in the workflow definition. Now the designer fetches defaults from the host and displays actual values (e.g., "Exponential interval", count, intervals) while preserving the existing serialization behavior — no changes are written to the workflow JSON.

Additionally, unknown host-level settings returned by the API (e.g., maxMessageBatchSize) are now surfaced in a new read-only "Host settings" section in the settings panel.

Changes

  • settingDefaults.ts - React Query cached fetch for the settingDefaults API endpoint. Applies merge logic for returned setting values and routes additional settings as hostSettings.
  • added defaultHint to SettingData and hostSettings map to Settings interface
  • serializer.ts - if defaultHint is present, does not serialize on retry
  • hostsettings.tsx - dynamic read only section that renders host settings as text fields and is included with the rest of the settings sections in index.tsx
  • operationmanifest.ts (standard/consumption/base) - add getSettingDefaults to operation manifest service interface and implementations.

Impact of Change

  • Users:
    Settings panel now shows actual default values for retry policy and other settings instead of an opaque "Default" label. Host-level read-only settings (e.g., maxMessageBatchSize) are visible in a new collapsible section. No changes to saved workflow definitions.
  • Developers:
    New defaultHint field on SettingData — indicates the value came from API defaults and should not be serialized. hostSettings on Settings is a dynamic Record<string, SettingData> for arbitrary host-returned keys. KNOWN_SETTING_KEYS set in settingDefaults.ts controls which API keys are treated as known vs host-level.
  • System:
    One additional HTTP call per operation during deserialization (cached by React Query). No changes to workflow JSON serialization output.

Test Plan

  • Unit tests added/updated
  • E2E tests added/updated
  • Manual testing completed
  • Tested in: VS Code Extension Development Host with Standard Logic App (Service Bus completeQueueMessageV2 operation)

Contributors

Screenshots/Videos

setting_enhancements_part2

Copilot AI review requested due to automatic review settings June 5, 2026 17:09
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jun 5, 2026

🤖 AI PR Validation Report

PR Review Results

Thank you for your submission! Here's detailed feedback on your PR title and body compliance:

PR Title

  • Current: Show operation default setting values and host settings in the designer
  • Issue: No blocking issue — the title is clear and specific.
  • Recommendation: None required.

Commit Type

  • Properly selected (feature).
  • Only one commit type is selected, which is correct.

⚠️ Risk Level

  • The selected risk level is Medium, which is reasonable, but the code change introduces a new backend call during operation initialization and changes serialization behavior for retry policy defaults. That makes the impact a bit more than a routine medium change.
  • Recommendation: Consider updating the PR risk label/body to High if this behavior affects many operation paths or could influence persisted workflow behavior in edge cases.

What & Why

  • Current: Clear and sufficiently detailed.
  • Issue: None blocking.
  • Recommendation: Optional: trim a bit of implementation detail and keep this section focused on the user-facing purpose and rationale.

⚠️ Impact of Change

  • The section is mostly complete and the impact is described well.
  • Recommendation:
    • Users: Good as written; you may want to explicitly mention that host settings are read-only.
    • Developers: Good as written; note the new getSettingDefaults service contract if you want to make the API impact clearer.
    • System: Good as written; you may want to mention the new per-operation query is cached but still introduces extra initialization work.

Test Plan

  • Manual testing is checked and the PR includes a clear environment/example (VS Code Extension Development Host with Standard Logic App ...).
  • This is acceptable because the change is feature/UI-oriented and includes a manual validation path.
  • No blocking test-plan issue found.

⚠️ Contributors

  • Blank section, which is allowed.
  • Recommendation: If others contributed design/implementation feedback, please add them here for credit.

Screenshots/Videos

  • Included and appropriate for the UI change.

Summary Table

Section Status Recommendation
Title
Commit Type
Risk Level ⚠️ Consider high if you want the label/body to reflect the new serialization and fetch behavior more conservatively.
What & Why
Impact of Change ⚠️ Add explicit note that host settings are read-only and that initialization now makes an extra cached backend call.
Test Plan
Contributors ⚠️ Add names if anyone else contributed.
Screenshots/Videos

Overall: the PR body passes, but I recommend revisiting the risk label/body to ensure it matches the scope of the change.


Last updated: Fri, 05 Jun 2026 17:46:38 GMT

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR enhances the Designer settings panel to display concrete default operation setting values returned by the backend settingDefaults API (instead of an opaque “Default”), and surfaces unknown host-level settings in a new read-only “Host settings” section—while keeping workflow JSON serialization behavior unchanged.

Changes:

  • Add a React Query–cached settingDefaults fetch + merge path during operation initialization/deserialization.
  • Extend settings types (SettingData, Settings, SettingSectionName) to support read-only/default-hint semantics and host-level settings display.
  • Add a new Settings panel section to render host-level settings as read-only text fields.

Reviewed changes

Copilot reviewed 13 out of 13 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
Localize/lang/strings.json Adds localization entry for the new “Host settings” section title.
libs/logic-apps-shared/src/designer-client-services/lib/operationmanifest.ts Extends the operation manifest service interface with optional getSettingDefaults.
libs/logic-apps-shared/src/designer-client-services/lib/standard/operationmanifest.ts Implements getSettingDefaults for Standard (including hybrid proxy path).
libs/logic-apps-shared/src/designer-client-services/lib/consumption/operationmanifest.ts Implements getSettingDefaults for Consumption using the existing baseUrl/connectorId URL pattern.
libs/designer/src/lib/ui/settings/sections/hostsettings.tsx New UI section that renders host-level settings as read-only fields.
libs/designer/src/lib/ui/settings/index.tsx Wires the new Host Settings section into the Settings panel and centralizes SettingSectionName.
libs/designer/src/lib/core/state/setting/settingInterface.ts Adds HOSTSETTINGS to the settings section name map.
libs/designer/src/lib/core/queries/settingDefaults.ts Adds supported-settings key extraction, React Query fetch, and merge logic (including hostSettings routing).
libs/designer/src/lib/core/actions/bjsworkflow/settings.ts Extends settings types to support readOnly, defaultHint, and hostSettings.
libs/designer/src/lib/core/actions/bjsworkflow/serializer.ts Avoids serializing retry policy when it was populated from API defaults (via defaultHint).
libs/designer/src/lib/core/actions/bjsworkflow/operationdeserializer.ts Fetches and merges setting defaults during manifest-based operation initialization.
libs/designer/src/lib/core/actions/bjsworkflow/add.ts Fetches and merges setting defaults during operation creation/initialization flows.
libs/designer-v2/src/lib/core/actions/bjsworkflow/settings.ts Adds readOnly to v2 SettingData to keep parity for read-only settings support.


const title = intl.formatMessage({
defaultMessage: 'Host settings',
id: 'xhrvz3',
Comment on lines +63 to +67
try {
return await getReactQueryClient().fetchQuery(
['settingDefaults', connectorId.toLowerCase(), operationId.toLowerCase(), workflowKind ?? ''],
() => service.getSettingDefaults!(connectorId, operationId, supportedSettings, workflowKind)
);
Comment on lines +1 to +2
import type { HeaderClickHandler } from '..';
import { SettingSectionName } from '..';
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jun 5, 2026

📊 Coverage Check

The following changed files need attention:

⚠️ libs/designer/src/lib/core/queries/settingDefaults.ts - 13% covered (needs improvement)
⚠️ libs/designer/src/lib/ui/settings/sections/hostsettings.tsx - 17% covered (needs improvement)
⚠️ libs/designer-v2/src/lib/core/actions/bjsworkflow/settings.ts - 17% covered (needs improvement)
⚠️ libs/designer/src/lib/core/actions/bjsworkflow/add.ts - 5% covered (needs improvement)
⚠️ libs/designer/src/lib/core/actions/bjsworkflow/operationdeserializer.ts - 4% covered (needs improvement)
⚠️ libs/designer/src/lib/core/actions/bjsworkflow/serializer.ts - 16% covered (needs improvement)
⚠️ libs/designer/src/lib/core/actions/bjsworkflow/settings.ts - 17% covered (needs improvement)
⚠️ libs/logic-apps-shared/src/designer-client-services/lib/consumption/operationmanifest.ts - 75% covered (needs improvement)
⚠️ libs/logic-apps-shared/src/designer-client-services/lib/standard/operationmanifest.ts - 14% covered (needs improvement)

Please add tests for the uncovered files before merging.

@JoaquimMalcampo JoaquimMalcampo changed the title Jmalcampo/node setting details enhancements Show operation default setting values and host settings in the designer Jun 5, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants