feat(entities-plugins): add free form support and request callout #2016

Justineo · 2025-03-12T07:49:51Z

Summary

KM-963
KM-1043
KM-1044

This PR introduces a new free-form alternative for implementing plugin forms that:

Allows complete flexibility in form construction, accommodating any custom rendering needs.
Manages plugin configurations without requiring flatten/unflatten logic.
Supports future migration to a dual-schema approach (data + UI).

Implemented Features

Ability to register a free-form configuration for specific plugins.
Enhanced field components (object, array, key-value, string, number, boolean, enum) for a better user experience.
Improvements to the plugin form playground, including autosave to local storage.

Still Missing

Validation support.
Entity checks.

New directory structure

└ entities-plugins
  └ src
    └ components
      └ free-form        # all free form implementation
        ├ RequestCallout # plugin specific directory
        ├ ...
        └ shared         # shared components like `StringField`, `ObjectField`, etc.

jw-foss

@Justineo I left a few comments, PTAL 🙇

packages/entities/entities-plugins/src/components/PluginEntityForm.vue

packages/entities/entities-plugins/sandbox/pages/PluginFormPlayground.vue

...ges/entities/entities-plugins/src/components/free-form/RequestCallout/CalloutRequestForm.vue

packages/entities/entities-plugins/src/components/free-form/RequestCallout/RedisForm.vue

jw-foss

LGTM @Justineo

Leopoldthecoder · 2025-03-13T09:39:12Z

Should we pull the changes into kong-admin and konnect-ui-apps and run all the e2e tests before merging this?

Justineo · 2025-03-13T15:47:31Z

Should we pull the changes into kong-admin and konnect-ui-apps and run all the e2e tests before merging this?

Yes. And I’ll record a video to showcase this to the PMs first. There’s no rush to merge.

…lementation

…ents

…rapper

… reference

jw-foss

@Justineo I left a few comments for your consideration PTAL 👍

packages/entities/entities-plugins/src/components/PluginForm.vue

...ges/entities/entities-plugins/src/components/free-form/RequestCallout/CalloutRequestForm.vue

...ges/entities/entities-plugins/src/components/free-form/RequestCallout/RequestCalloutForm.vue

packages/entities/entities-plugins/src/components/free-form/RequestCallout/UpstreamForm.vue

…kv fields

…order redis fields

Justineo · 2025-03-27T05:12:19Z

packages/entities/entities-plugins/src/components/PluginEntityForm.vue

+  // Handle the special case of the freeform plugin
+  if (freeformName.value) {
+    const configSchema = props.rawSchema?.fields?.find((field: any) => 'config' in field)?.config
+    model.config = pruneRecord(freeformConfig.value, configSchema)


As we are not building the model from the flattened schema, we'll need to prune out undefined fields in the raw schema instead.

packages/entities/entities-plugins/src/components/PluginEntityForm.vue

packages/entities/entities-plugins/src/components/free-form/RequestCallout/CalloutForm.vue

Leopoldthecoder

LGTM

sumimakito

Code LGTM

jw-foss

LGTM! Thank you! 👍

Justineo requested review from a team as code owners March 12, 2025 07:49

github-actions bot assigned Justineo Mar 12, 2025

jw-foss reviewed Mar 12, 2025

View reviewed changes

jw-foss reviewed Mar 13, 2025

View reviewed changes

packages/entities/entities-plugins/src/components/free-form/RequestCallout/RedisForm.vue Outdated Show resolved Hide resolved

jw-foss previously approved these changes Mar 13, 2025

View reviewed changes

Justineo dismissed jw-foss’s stale review via 16e6708 March 13, 2025 16:21

Justineo marked this pull request as draft March 14, 2025 07:03

Justineo added 12 commits March 18, 2025 11:02

feat(entities-plugins): add free form support and request callout imp…

e952982

…lementation

chore(entities-plugins): revert stylistic changes

01ddb4a

chore(entities-plugins): revert stylistic changes

2b370fd

chore(entities-plugins): remove is-wizard-step

b1a2b3b

chore(entities-plugins): fix km plugin playground

6371224

fix(entities-plugins): refactor code, update schema

6cc4d59

fix(entities-plugins): get default value from schema, fix review comm…

a99e76e

…ents

fix(entities-plugins): remove debugger, remove unnecessary function w…

a55897a

…rapper

fix(entities-plugins): improve playground, adjust objectfield style

820ca03

fix(entities-vaults): revert vault change

1ae5b93

fix(entities-plugins): fix default value creation

04926fe

feat(entities-plugins): add default value placeholder, fix depends_on…

efdc57c

… reference

Justineo force-pushed the feat/request-callout branch from f4f1a98 to efdc57c Compare March 18, 2025 03:04

fix(entities-plugins): fix label margin and tooltip slot

a171244

jw-foss reviewed Mar 18, 2025

View reviewed changes

chore(entities-plugins): fix review comments

1cc3993

Justineo marked this pull request as ready for review March 19, 2025 03:21

Justineo and others added 3 commits March 19, 2025 12:29

chore(entities-plugins): fix review comments

b37f960

fix(entities-plugins): fix label margin and support referenceable in …

6f1c44c

…kv fields

Merge branch 'main' into feat/request-callout

ce2b5db

ValeryG and others added 9 commits March 20, 2025 10:49

Merge branch 'main' into feat/request-callout

482de41

fix(entities-plugins): fix freeform init form

668b84b

fix(entities-plugins): add missing decode field

2644d33

fix(entities-plugins): update config for freeform onModelUpdate

7e6a77f

fix(entities-plugins): update formModel to enable submit button

7af71d0

fix(entities-plugins): use index as key for null values in arrayfield

bbd0bd2

fix(entities-plugins): handle encrypted fields

1715c95

fix(entities-plugins): fix optional record initialization

169c56e

fix(entities-plugins): prune config according to raw schema first, re…

0c7d2c5

…order redis fields

Justineo commented Mar 27, 2025

View reviewed changes

fix(entities-plugins): temporary workaround for KAG-6676

a60e7dc

2eha0 reviewed Mar 27, 2025

View reviewed changes

packages/entities/entities-plugins/src/components/PluginEntityForm.vue Outdated Show resolved Hide resolved

packages/entities/entities-plugins/src/components/free-form/RequestCallout/CalloutForm.vue Outdated Show resolved Hide resolved

fix(entities-plugins): trim string fields

b389539

Leopoldthecoder approved these changes Mar 28, 2025

View reviewed changes

sumimakito approved these changes Mar 28, 2025

View reviewed changes

jw-foss approved these changes Mar 28, 2025

View reviewed changes

Justineo merged commit 37417a8 into main Mar 28, 2025
9 checks passed

Justineo deleted the feat/request-callout branch March 28, 2025 04:57

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(entities-plugins): add free form support and request callout #2016

feat(entities-plugins): add free form support and request callout #2016

Justineo commented Mar 12, 2025 •

edited

Loading

jw-foss left a comment

jw-foss left a comment

Leopoldthecoder commented Mar 13, 2025

Justineo commented Mar 13, 2025

jw-foss left a comment

Justineo Mar 27, 2025

Leopoldthecoder left a comment

sumimakito left a comment

jw-foss left a comment

feat(entities-plugins): add free form support and request callout #2016

feat(entities-plugins): add free form support and request callout #2016

Conversation

Justineo commented Mar 12, 2025 • edited Loading

Summary

Implemented Features

Still Missing

New directory structure

jw-foss left a comment

Choose a reason for hiding this comment

jw-foss left a comment

Choose a reason for hiding this comment

Leopoldthecoder commented Mar 13, 2025

Justineo commented Mar 13, 2025

jw-foss left a comment

Choose a reason for hiding this comment

Justineo Mar 27, 2025

Choose a reason for hiding this comment

Leopoldthecoder left a comment

Choose a reason for hiding this comment

sumimakito left a comment

Choose a reason for hiding this comment

jw-foss left a comment

Choose a reason for hiding this comment

Justineo commented Mar 12, 2025 •

edited

Loading