Merge pull request #544 from devtron-labs/fix/app-details-manifest

feat: add support for json schema 07 validation

Author: Elessar1802

package-lock.json

@@ -1,6 +1,6 @@
 {
     "name": "@devtron-labs/devtron-fe-common-lib",
-    "version": "1.6.4",
+    "version": "1.6.5",
     "description": "Supporting common component library",
     "type": "module",
     "main": "dist/index.js",

package.json

@@ -16,17 +16,17 @@
 
 import { forwardRef } from 'react'
 import RJSF from '@rjsf/core'
-import RJSFValidator from '@rjsf/validator-ajv8'
 
 import { templates, widgets } from './config'
 import { FormProps } from './types'
 import { translateString } from './utils'
+import { SCHEMA_07_VALIDATOR_STRICT } from '@Shared/validations'
 import './rjsfForm.scss'
 
 // Need to use this way because the default import was not working as expected
 // The default import resolves to an object intead of a function
 const Form = RJSF
-const validator = RJSFValidator
+const validator = SCHEMA_07_VALIDATOR_STRICT
 
 export const RJSFForm = forwardRef((props: FormProps, ref: FormProps['ref']) => (
     <Form

src/Common/RJSF/Form.tsx

@@ -15,6 +15,7 @@
  */
 
 import { getSanitizedIframe } from '@Common/Helper'
+import { customizeValidator } from '@rjsf/validator-ajv8'
 import { PATTERNS } from '@Common/Constants'
 import { URLProtocolType } from './types'
 import { SKIP_LABEL_KEY_VALIDATION_PREFIX } from './constants'
@@ -378,10 +379,26 @@ export const validateSemanticVersioning = (version: string): ValidationResponseT
 export const validateDisplayName = (name: string): ValidationResponseType =>
     validateStringLength(name, DISPLAY_NAME_CONSTRAINTS.MAX_LIMIT, DISPLAY_NAME_CONSTRAINTS.MIN_LIMIT)
 
-export const validateJSON = (json: string): ValidationResponseType => {
+export const SCHEMA_07_VALIDATOR_STRICT = customizeValidator({
+    ajvOptionsOverrides: {
+        strict: true,
+        allowUnionTypes: true,
+    },
+})
+SCHEMA_07_VALIDATOR_STRICT.ajv.addKeyword('hidden')
+SCHEMA_07_VALIDATOR_STRICT.ajv.addFormat('memory', /^\d+(\.\d+)?(Ki|Mi|Gi|Ti|Pi|Ei|KiB|MiB|GiB|TiB|PiB|EiB)?$/)
+SCHEMA_07_VALIDATOR_STRICT.ajv.addFormat('cpu', /^(?:\d+(\.\d+)?|(\d+)(m))$/)
+
+const SCHEMA_07_VALIDATOR = customizeValidator({ ajvOptionsOverrides: { strict: false } })
+SCHEMA_07_VALIDATOR.ajv.addKeyword('hidden')
+
+export const doesJSONConformToSchema07 = (json: string, strict = false): ValidationResponseType => {
     try {
         if (json) {
-            JSON.parse(json)
+            // NOTE: if json is not parsable JSON.parse will through error
+            // if validators can't be compiled from the parsed json schema then
+            // provided json schema does not conform to json schema draft 07; again can throw error
+            ;(strict ? SCHEMA_07_VALIDATOR_STRICT : SCHEMA_07_VALIDATOR).ajv.compile(JSON.parse(json))
         }
         return {
             isValid: true,