feat(entities-plugins): support upstream-oauth (#1543)

* feat(entities-plugins): support upstream-oauth * fix(entities-plugins): edit number array fields
Kong · Aug 8, 2024 · 3aec318 · 3aec318
1 parent ab848a2
commit 3aec318
Show file tree

Hide file tree

Showing 10 changed files with 54 additions and 16 deletions.
diff --git a/packages/core/forms/src/components/fields/FieldArray.vue b/packages/core/forms/src/components/fields/FieldArray.vue
@@ -60,11 +60,12 @@
         />
 
         <KInput
-          v-else-if="!schema.inputAttributes || !schema.inputAttributes.type || schema.inputAttributes.type === 'text'"
-          v-model="value[index]"
+          v-else-if="!schema.inputAttributes || !schema.inputAttributes.type || schema.inputAttributes.type === 'text' || schema.inputAttributes.type === 'number'"
           :aria-labelledby="getLabelId(schema)"
           v-bind="schema.inputAttributes"
+          :model-value="value[index]"
           :type="schema.inputAttributes && schema.inputAttributes.type || 'text'"
+          @input="(val) => { handleInput(val, index) }"
         />
 
         <input
@@ -211,6 +212,9 @@ export default {
       return 'field-' + fieldSchema.type
     },
     modelUpdated() {},
+    handleInput(val, index) {
+      this.value = this.value.map((item, i) => i === index ? val : item)
+    },
   },
 }
 </script>

diff --git a/packages/entities/entities-plugins/src/components/PluginEntityForm.vue b/packages/entities/entities-plugins/src/components/PluginEntityForm.vue
@@ -407,6 +407,8 @@ const getModel = (): Record<string, any> => {
       } else if (fieldSchemaValueType === 'array') {
         if ((!fieldValue || !fieldValue.length)) {
           fieldValue = fieldSchema.submitWhenNull ? null : []
+        } else if (fieldSchema.inputAttributes?.type === 'number') {
+          fieldValue = fieldValue.map((value: string) => Number(value))
         }
       }
 

diff --git a/packages/entities/entities-plugins/src/components/PluginForm.vue b/packages/entities/entities-plugins/src/components/PluginForm.vue
@@ -147,7 +147,7 @@ import { computed, onBeforeMount, reactive, ref, watch, type PropType } from 'vu
 import { useRouter } from 'vue-router'
 import composables from '../composables'
 import { CREDENTIAL_METADATA, CREDENTIAL_SCHEMAS, PLUGIN_METADATA } from '../definitions/metadata'
-import { ArrayStringFieldSchema } from '../definitions/schemas/ArrayStringFieldSchema'
+import { ArrayInputFieldSchema } from '../definitions/schemas/ArrayInputFieldSchema'
 import endpoints from '../plugins-endpoints'
 import {
   EntityTypeIdField,
@@ -623,11 +623,11 @@ const buildFormSchema = (parentKey: string, response: Record<string, any>, initi
           fields: [{
             schema: {
               fields: [{
-                ...ArrayStringFieldSchema,
+                ...ArrayInputFieldSchema,
                 model: field,
                 valueArrayType: elementsType === 'integer' ? 'number' : elementsType || 'string',
                 inputAttributes: {
-                  ...ArrayStringFieldSchema.inputAttributes,
+                  ...ArrayInputFieldSchema.inputAttributes,
                   type: elementsType === 'integer' ? 'number' : 'text',
                   inputMode: elementsType === 'integer' ? 'numeric' : 'text',
                 },
@@ -685,14 +685,11 @@ const buildFormSchema = (parentKey: string, response: Record<string, any>, initi
       // pass the referenceable flag from elements to the parent
       initialFormSchema[field].referenceable = elements.referenceable
 
-      if (elements.type === 'string' && !elements.one_of) {
+      if ((elements.type === 'string' || elements.type === 'integer') && !elements.one_of) {
         const { id, help, label, hint, values, referenceable } = initialFormSchema[field]
-        const { help: helpOverride, ...overrides } = JSON.parse(JSON.stringify(ArrayStringFieldSchema))
-        initialFormSchema[field] = { id, help, label, hint, values, referenceable, ...overrides }
-        // Only replace the help text when it is not defined because ArrayStringFieldSchema is more generic
-        if (initialFormSchema[field].help === undefined && typeof helpOverride === 'string') {
-          initialFormSchema[field].help = marked.parse(helpOverride, { mangle: false, headerIds: false } as MarkedOptions)
-        }
+        const { inputAttributes, ...overrides } = JSON.parse(JSON.stringify(ArrayInputFieldSchema))
+        inputAttributes.type = elements.type === 'integer' ? 'number' : 'text'
+        initialFormSchema[field] = { id, help, label, hint, values, referenceable, inputAttributes, ...overrides }
       }
     }
 

diff --git a/packages/entities/entities-plugins/src/composables/useSchemas.ts b/packages/entities/entities-plugins/src/composables/useSchemas.ts
@@ -6,7 +6,7 @@ import { aiPromptDecoratorSchema } from '../definitions/schemas/AIPromptDecorato
 import { aiPromptTemplateSchema } from '../definitions/schemas/AIPromptTemplate'
 import { aiRateLimitingAdvancedSchema } from '../definitions/schemas/AIRateLimitingAdvanced'
 import { applicationRegistrationSchema } from '../definitions/schemas/ApplicationRegistration'
-import { ArrayStringFieldSchema } from '../definitions/schemas/ArrayStringFieldSchema'
+import { ArrayInputFieldSchema } from '../definitions/schemas/ArrayInputFieldSchema'
 import { dataDogSchema } from '../definitions/schemas/Datadog'
 import { graphqlRateLimitingAdvancedSchema } from '../definitions/schemas/GraphQLRateLimitingAdvanced'
 import { jwtSchema } from '../definitions/schemas/JWT'
@@ -22,6 +22,7 @@ import { statsDSchema } from '../definitions/schemas/StatsD'
 import { statsDAdvancedSchema } from '../definitions/schemas/StatsDAdvanced'
 import { vaultAuthSchema } from '../definitions/schemas/VaultAuth'
 import ZipkinSchema from '../definitions/schemas/Zipkin'
+import { upstreamOauthSchema } from '../definitions/schemas/UpstreamOauth'
 import typedefs from '../definitions/schemas/typedefs'
 import { type CustomSchemas } from '../types'
 import useI18n from './useI18n'
@@ -200,6 +201,10 @@ export const useSchemas = (options?: UseSchemasOptions) => {
       ...ZipkinSchema,
     },
 
+    'upstream-oauth': {
+      ...upstreamOauthSchema,
+    },
+
     saml: {
       ...samlSchema,
     },
@@ -499,11 +504,11 @@ export const useSchemas = (options?: UseSchemasOptions) => {
         fields: [{
           schema: {
             fields: [{
-              ...ArrayStringFieldSchema,
+              ...ArrayInputFieldSchema,
               model: schema.model,
               valueArrayType: elementsType === 'integer' ? 'number' : elementsType || 'string',
               inputAttributes: {
-                ...ArrayStringFieldSchema.inputAttributes,
+                ...ArrayInputFieldSchema.inputAttributes,
                 type: elementsType === 'integer' ? 'number' : 'text',
                 inputMode: elementsType === 'integer' ? 'numeric' : 'text',
               },

diff --git a/packages/entities/entities-plugins/src/definitions/metadata.ts b/packages/entities/entities-plugins/src/definitions/metadata.ts
@@ -740,6 +740,14 @@ export const PLUGIN_METADATA: Record<string, Omit<PluginMetaData<I18nMessageSour
       ],
     },
   },
+  'upstream-oauth': {
+    descriptionKey: 'plugins.meta.upstream-oauth.description',
+    group: PluginGroup.AUTHENTICATION,
+    isEnterprise: true,
+    nameKey: 'plugins.meta.upstream-oauth.name',
+    scope: [PluginScope.GLOBAL, PluginScope.SERVICE, PluginScope.ROUTE, PluginScope.CONSUMER, PluginScope.CONSUMER_GROUP],
+    imageName: 'oauth2',
+  },
 }
 
 /**

diff --git a/...nitions/schemas/ArrayStringFieldSchema.ts → ...initions/schemas/ArrayInputFieldSchema.ts b/...nitions/schemas/ArrayStringFieldSchema.ts → ...initions/schemas/ArrayInputFieldSchema.ts
@@ -1,4 +1,4 @@
-export const ArrayStringFieldSchema = {
+export const ArrayInputFieldSchema = {
   type: 'array',
   valueType: 'string',
   valueArrayType: 'array',

diff --git a/packages/entities/entities-plugins/src/definitions/schemas/UpstreamOauth.ts b/packages/entities/entities-plugins/src/definitions/schemas/UpstreamOauth.ts
@@ -0,0 +1,8 @@
+import type { UpstreamOauthSchema } from '../../types/plugins/upstream-oauth'
+
+export const upstreamOauthSchema: UpstreamOauthSchema = {
+  'config-behavior-idp_error_response_body_template': {
+    type: 'textArea',
+    rows: 4,
+  },
+}
diff --git a/packages/entities/entities-plugins/src/locales/en.json b/packages/entities/entities-plugins/src/locales/en.json
@@ -472,6 +472,10 @@
       "header-cert-auth": {
         "name": "Header Certificate Authentication",
         "description": "Authenticate clients with MTLS certificate passed in header by a WAF or load balancer"
+      },
+      "upstream-oauth": {
+        "name": "Upstream OAuth",
+        "description": "Configure Kong to obtain a OAuth2 token to consume an upstream API"
       }
     },
     "fields": {

diff --git a/packages/entities/entities-plugins/src/types/plugin-form.ts b/packages/entities/entities-plugins/src/types/plugin-form.ts
@@ -19,6 +19,7 @@ import type { VaultAuthSchema } from './plugins/vault-auth'
 import type { GraphQLRateLimitingAdvancedSchema } from './plugins/graphql-rate-limiting-advanced'
 import type { SAMLSchema } from './plugins/saml'
 import type { OasValidationSchema } from './plugins/oas-validation'
+import type { UpstreamOauthSchema } from './plugins/upstream-oauth'
 
 export interface BasePluginSelectConfig {
   /** A function that returns the route for creating a plugin */
@@ -215,4 +216,5 @@ export interface CustomSchemas {
   zipkin: CommonSchemaFields & Record<string, any>
   saml: SAMLSchema
   'oas-validation': OasValidationSchema
+  'upstream-oauth': UpstreamOauthSchema
 }
diff --git a/packages/entities/entities-plugins/src/types/plugins/upstream-oauth.d.ts b/packages/entities/entities-plugins/src/types/plugins/upstream-oauth.d.ts
@@ -0,0 +1,8 @@
+import type { CommonSchemaFields } from './shared'
+
+export interface UpstreamOauthSchema extends CommonSchemaFields {
+  'config-behavior-idp_error_response_body_template': {
+    type: string,
+    rows: number
+  }
+}