Refactor Errors for DataHub Validation

gradle/libs.versions.toml

@@ -13,6 +13,7 @@ digitalpetri-modbus-tcp = "2.1.3"
 dropwizard-metrics = "4.2.37"
 equalsverifier = "3.17.5"
 errorprone = "2.38.0"
+freemarker = "2.3.34"
 future-converter = "1.2.0"
 guava = "33.4.8-jre"
 hikari = "6.2.1"
@@ -94,6 +95,7 @@ dropwizard-metrics-jvm = { module = "io.dropwizard.metrics:metrics-jvm", version
 dropwizard-metrics-logback = { module = "io.dropwizard.metrics:metrics-logback", version.ref = "dropwizard-metrics" }
 equalsverifier = { module = "nl.jqno.equalsverifier:equalsverifier", version.ref = "equalsverifier" }
 errorprone = { module = "com.google.errorprone:error_prone_core", version.ref = "errorprone" }
+freemarker = { module = "org.freemarker:freemarker", version.ref = "freemarker" }
 guava = { module = "com.google.guava:guava", version.ref = "guava" }
 hikari = { module = "com.zaxxer:HikariCP", version.ref = "hikari" }
 hivemq-edge-adaptersdk = { module = "com.hivemq:hivemq-edge-adapter-sdk", version.ref = "hivemq-edge-adaptersdk" }

hivemq-edge-frontend/src/api/hooks/useHttpClient/useHttpClient.ts

@@ -63,6 +63,9 @@ export const useHttpClient = () => {
       {
         BASE: config.apiBaseUrl,
         TOKEN: credentials?.token,
+        HEADERS: {
+          Accept: 'application/json, application/problem+json',
+        },
       },
       AxiosHttpRequestWithInterceptors
     )

hivemq-edge-frontend/src/extensions/datahub/hooks/useGetFilteredFunctions.tsx

@@ -0,0 +1,66 @@
+import { useMemo } from 'react'
+
+import { BehaviorPolicyTransitionEvent, type FunctionSpecs } from '@/api/__generated__'
+import { DataHubNodeType } from '@datahub/types.ts'
+import { useGetAllFunctionSpecs } from '@datahub/api/hooks/DataHubFunctionsService/useGetAllFunctionSpecs.ts'
+
+export const MqttTransformFunction: FunctionSpecs = {
+  functionId: 'DataHub.transform',
+  metadata: {
+    inLicenseAllowed: true,
+    isTerminal: false,
+    isDataOnly: false,
+    hasArguments: true,
+    supportedEvents: [
+      BehaviorPolicyTransitionEvent.EVENT_ON_ANY,
+      BehaviorPolicyTransitionEvent.MQTT_ON_INBOUND_CONNECT,
+      BehaviorPolicyTransitionEvent.MQTT_ON_INBOUND_PUBLISH,
+      BehaviorPolicyTransitionEvent.MQTT_ON_INBOUND_SUBSCRIBE,
+      BehaviorPolicyTransitionEvent.MQTT_ON_INBOUND_DISCONNECT,
+      BehaviorPolicyTransitionEvent.CONNECTION_ON_DISCONNECT,
+    ],
+  },
+  schema: {
+    title: 'Transformation',
+    description:
+      'The list of Javascript functions used in this transformation operation. Add them directly on the graph',
+    properties: {
+      transform: {
+        type: 'array',
+        title: 'Execution order',
+        description: 'Change the order in which the transform functions will be executed',
+        items: {
+          type: 'string',
+          title: 'Function name',
+        },
+      },
+    },
+  },
+}
+
+export const useGetFilteredFunction = (
+  type: DataHubNodeType = DataHubNodeType.DATA_POLICY,
+  transition?: BehaviorPolicyTransitionEvent
+) => {
+  const { isError, error, isLoading, isSuccess, data } = useGetAllFunctionSpecs()
+
+  const filteredFunctions = useMemo(() => {
+    if (!data || !data.items?.length) return []
+
+    return data.items.filter((functionSpec) => {
+      if (!functionSpec.metadata.inLicenseAllowed) return false
+      if (
+        functionSpec.metadata.supportedEvents?.length &&
+        transition &&
+        !functionSpec.metadata.supportedEvents.includes(transition)
+      )
+        return false
+      if (functionSpec.metadata.isDataOnly && type !== DataHubNodeType.DATA_POLICY) return false
+
+      // In all other cases, the function is valid
+      return true
+    })
+  }, [data, transition, type])
+
+  return { data: [...filteredFunctions, MqttTransformFunction], isError, error, isLoading, isSuccess }
+}

hivemq-edge-openapi/openapi/components/schemas/ProblemDetails.yaml

@@ -6,6 +6,7 @@ properties:
   detail:
     type: string
   errors:
+    deprecated: true
     type: array
     items:
       $ref: ./Error.yaml

hivemq-edge-openapi/openapi/components/schemas/errors/ApiProblemDetails.yaml

@@ -0,0 +1,54 @@
+allOf:
+  - $ref: "../ProblemDetails.yaml"
+  - type: object
+    required:
+      - detail
+      - status
+      - type
+discriminator:
+  propertyName: type
+  mapping:
+    # DataHub
+    https://hivemq.com/edge/api/model/BehaviorPolicyAlreadyPresentError: "./datahub/BehaviorPolicyAlreadyPresentError.yaml"
+    https://hivemq.com/edge/api/model/BehaviorPolicyCreationFailureError: "./datahub/BehaviorPolicyCreationFailureError.yaml"
+    https://hivemq.com/edge/api/model/BehaviorPolicyInvalidErrors: "./datahub/BehaviorPolicyInvalidErrors.yaml"
+    https://hivemq.com/edge/api/model/BehaviorPolicyNotFoundError: "./datahub/BehaviorPolicyNotFoundError.yaml"
+    https://hivemq.com/edge/api/model/BehaviorPolicyRejectedError: "./datahub/BehaviorPolicyRejectedError.yaml"
+    https://hivemq.com/edge/api/model/BehaviorPolicyUpdateFailureError: "./datahub/BehaviorPolicyUpdateFailureError.yaml"
+    https://hivemq.com/edge/api/model/ClientDisconnectedError: "./datahub/ClientDisconnectedError.yaml"
+    https://hivemq.com/edge/api/model/ClientNotFoundError: "./datahub/ClientNotFoundError.yaml"
+    https://hivemq.com/edge/api/model/DataPolicyAlreadyPresentError: "./datahub/DataPolicyAlreadyPresentError.yaml"
+    https://hivemq.com/edge/api/model/DataPolicyCreationFailureError: "./datahub/DataPolicyCreationFailureError.yaml"
+    https://hivemq.com/edge/api/model/DataPolicyInvalidErrors: "./datahub/DataPolicyInvalidErrors.yaml"
+    https://hivemq.com/edge/api/model/DataPolicyNotFoundError: "./datahub/DataPolicyNotFoundError.yaml"
+    https://hivemq.com/edge/api/model/DataPolicyRejectedError: "./datahub/DataPolicyRejectedError.yaml"
+    https://hivemq.com/edge/api/model/DataPolicyUpdateFailureError: "./datahub/DataPolicyUpdateFailureError.yaml"
+    https://hivemq.com/edge/api/model/PolicyIdMismatchError: "./datahub/PolicyIdMismatchError.yaml"
+    https://hivemq.com/edge/api/model/PolicyInsufficientStorageError: "./datahub/PolicyInsufficientStorageError.yaml"
+    https://hivemq.com/edge/api/model/PolicyNotFoundError: "./datahub/PolicyNotFoundError.yaml"
+    https://hivemq.com/edge/api/model/SchemaAlreadyPresentError: "./datahub/SchemaAlreadyPresentError.yaml"
+    https://hivemq.com/edge/api/model/SchemaEtagMismatchError: "./datahub/SchemaEtagMismatchError.yaml"
+    https://hivemq.com/edge/api/model/SchemaInsufficientStorageError: "./datahub/SchemaInsufficientStorageError.yaml"
+    https://hivemq.com/edge/api/model/SchemaInvalidErrors: "./datahub/SchemaInvalidErrors.yaml"
+    https://hivemq.com/edge/api/model/SchemaNotFoundError: "./datahub/SchemaNotFoundError.yaml"
+    https://hivemq.com/edge/api/model/SchemaParsingFailureError: "./datahub/SchemaParsingFailureError.yaml"
+    https://hivemq.com/edge/api/model/SchemaReferencedError: "./datahub/SchemaReferencedError.yaml"
+    https://hivemq.com/edge/api/model/ScriptAlreadyPresentError: "./datahub/ScriptAlreadyPresentError.yaml"
+    https://hivemq.com/edge/api/model/ScriptCreationFailureError: "./datahub/ScriptCreationFailureError.yaml"
+    https://hivemq.com/edge/api/model/ScriptEtagMismatchError: "./datahub/ScriptEtagMismatchError.yaml"
+    https://hivemq.com/edge/api/model/ScriptInsufficientStorageError: "./datahub/ScriptInsufficientStorageError.yaml"
+    https://hivemq.com/edge/api/model/ScriptInvalidErrors: "./datahub/ScriptInvalidErrors.yaml"
+    https://hivemq.com/edge/api/model/ScriptNotFoundError: "./datahub/ScriptNotFoundError.yaml"
+    https://hivemq.com/edge/api/model/ScriptParsingFailureError: "./datahub/ScriptParsingFailureError.yaml"
+    https://hivemq.com/edge/api/model/ScriptReferencedError: "./datahub/ScriptReferencedError.yaml"
+    https://hivemq.com/edge/api/model/ScriptSanitationFailureError: "./datahub/ScriptSanitationFailureError.yaml"
+    https://hivemq.com/edge/api/model/TopicFilterMismatchError: "./datahub/TopicFilterMismatchError.yaml"
+    # HTTP
+    https://hivemq.com/edge/api/model/InsufficientStorageError: "./http/InsufficientStorageError.yaml"
+    https://hivemq.com/edge/api/model/InternalServerError: "./http/InternalServerError.yaml"
+    https://hivemq.com/edge/api/model/InvalidQueryParameterError: "./http/InvalidQueryParameterError.yaml"
+    https://hivemq.com/edge/api/model/PreconditionFailedError: "./http/PreconditionFailedError.yaml"
+    https://hivemq.com/edge/api/model/RequestBodyMissingError: "./http/RequestBodyMissingError.yaml"
+    https://hivemq.com/edge/api/model/RequestBodyParameterMissingError: "./http/RequestBodyParameterMissingError.yaml"
+    https://hivemq.com/edge/api/model/TemporaryNotAvailableError: "./http/TemporaryNotAvailableError.yaml"
+    https://hivemq.com/edge/api/model/UrlParameterMissingError: "./http/UrlParameterMissingError.yaml"

hivemq-edge-openapi/openapi/components/schemas/errors/datahub/AtMostOneFunctionValidationError.yaml

@@ -0,0 +1,38 @@
+allOf:
+  - $ref: "../validation/ValidationError.yaml"
+  - type: object
+    properties:
+      function:
+        type: string
+        description: The function.
+        example: "function1"
+      occurrences:
+        type: integer
+        format: int32
+        description: The occurrences of the function.
+        minimum: 0
+        example: 3
+      paths:
+        type: array
+        items:
+          type: string
+          format: json-path
+        description: The json paths where the function occurs.
+        example:
+          - "$.path1"
+          - "$.path2"
+          - "$.path3"
+    required:
+      - function
+      - occurrences
+      - paths
+example:
+  general:
+    detail: "The pipeline must contain at most one 'function1' function, but 3 were found at ['$.path1', '$.path2', '$.path3']."
+    function: "function1"
+    occurrences: 3
+    paths:
+      - "$.path1"
+      - "$.path2"
+      - "$.path3"
+    type: "https://hivemq.com/edge/api/model/AtMostOneFunctionValidationError"

hivemq-edge-openapi/openapi/components/schemas/errors/datahub/BehaviorPolicyAlreadyPresentError.yaml

@@ -0,0 +1,17 @@
+allOf:
+  - $ref: "../ApiProblemDetails.yaml"
+  - type: object
+    properties:
+      id:
+        type: string
+        description: The behavior policy id.
+        example: "abc"
+    required:
+      - id
+example:
+  general:
+    status: 409
+    title: "Behavior Policy Already Present"
+    detail: "The given behavior policy 'abc' is already present."
+    id: "abc"
+    type: "https://hivemq.com/edge/api/model/BehaviorPolicyAlreadyPresentError"

hivemq-edge-openapi/openapi/components/schemas/errors/datahub/BehaviorPolicyCreationFailureError.yaml

@@ -0,0 +1,8 @@
+allOf:
+  - $ref: "../ApiProblemDetails.yaml"
+example:
+  general:
+    status: 400
+    title: "Behavior Policy Creation Failed"
+    detail: "Behavior policy creation failed: The policy was rejected."
+    type: "https://hivemq.com/edge/api/model/BehaviorPolicyCreationFailureError"

hivemq-edge-openapi/openapi/components/schemas/errors/datahub/BehaviorPolicyInvalidErrors.yaml

@@ -0,0 +1,24 @@
+allOf:
+  - $ref: "../ApiProblemDetails.yaml"
+  - type: object
+    properties:
+      childErrors:
+        type: array
+        description: List of child validation errors.
+        items:
+          $ref: "./BehaviorPolicyValidationError.yaml"
+    required:
+      - childErrors
+example:
+  general:
+    status: 400
+    title: "Behavior Policy Invalid"
+    detail: "Behavior policy is invalid due to validation errors."
+    type: "https://hivemq.com/edge/api/model/BehaviorPolicyInvalidErrors"
+    childErrors:
+      - detail: "The transition from state 'state1' to state 'state2' on event 'event1' in '$.path' is not defined for behavior 'id1'."
+        fromState: "state1"
+        toState: "state2"
+        path: "$.path"
+        id: "id1"
+        type: "https://hivemq.com/edge/api/model/IllegalEventTransitionValidationError"

hivemq-edge-openapi/openapi/components/schemas/errors/datahub/BehaviorPolicyNotFoundError.yaml

@@ -0,0 +1,17 @@
+allOf:
+  - $ref: "../ApiProblemDetails.yaml"
+  - type: object
+    properties:
+      id:
+        type: string
+        description: The data policy id.
+        example: "abc"
+    required:
+      - id
+example:
+  general:
+    status: 404
+    title: "Behavior Policy Not Found"
+    detail: "Behavior policy with ID 'abc' is not found."
+    id: "abc"
+    type: "https://hivemq.com/edge/api/model/BehaviorPolicyNotFoundError"

hivemq-edge-openapi/openapi/components/schemas/errors/datahub/BehaviorPolicyRejectedError.yaml

@@ -0,0 +1,8 @@
+allOf:
+  - $ref: "../ApiProblemDetails.yaml"
+example:
+  general:
+    status: 400
+    title: "Behavior Policy Rejected"
+    detail: "Behavior policy is rejected."
+    type: "https://hivemq.com/edge/api/model/BehaviorPolicyRejectedError"

hivemq-edge-openapi/openapi/components/schemas/errors/datahub/BehaviorPolicyUpdateFailureError.yaml

@@ -0,0 +1,17 @@
+allOf:
+  - $ref: "../ApiProblemDetails.yaml"
+  - type: object
+    properties:
+      id:
+        type: string
+        description: The ID of the policy that failed to update.
+        example: "abc"
+    required:
+      - id
+example:
+  general:
+    status: 400
+    title: "Behavior Policy Update Failed"
+    detail: "Behavior policy with ID 'abc' update failed."
+    id: "abc"
+    type: "https://hivemq.com/edge/api/model/BehaviorPolicyUpdateFailureError"

hivemq-edge-openapi/openapi/components/schemas/errors/datahub/BehaviorPolicyValidationError.yaml

@@ -0,0 +1,26 @@
+allOf:
+  - $ref: "../validation/ValidationError.yaml"
+  - oneOf:
+    - $ref: "./IllegalEventTransitionValidationError.yaml"
+    - $ref: "./IllegalFunctionValidationError.yaml"
+    - $ref: "./InvalidSchemaVersionValidationError.yaml"
+    - $ref: "../validation/AtLeastOneFieldMissingValidationError.yaml"
+    - $ref: "../validation/EmptyFieldValidationError.yaml"
+    - $ref: "../validation/InvalidFieldLengthValidationError.yaml"
+    - $ref: "../validation/InvalidFieldValueValidationError.yaml"
+    - $ref: "../validation/InvalidIdentifierValidationError.yaml"
+    - $ref: "../validation/MissingFieldValidationError.yaml"
+    - $ref: "../validation/UnsupportedFieldValidationError.yaml"
+discriminator:
+  propertyName: type
+  mapping:
+    https://hivemq.com/edge/api/model/AtLeastOneFieldMissingValidationError: "../validation/AtLeastOneFieldMissingValidationError.yaml"
+    https://hivemq.com/edge/api/model/EmptyFieldValidationError: "../validation/EmptyFieldValidationError.yaml"
+    https://hivemq.com/edge/api/model/IllegalEventTransitionValidationError: "./IllegalEventTransitionValidationError.yaml"
+    https://hivemq.com/edge/api/model/IllegalFunctionValidationError: "./IllegalFunctionValidationError.yaml"
+    https://hivemq.com/edge/api/model/InvalidFieldLengthValidationError: "../validation/InvalidFieldLengthValidationError.yaml"
+    https://hivemq.com/edge/api/model/InvalidFieldValueValidationError: "../validation/InvalidFieldValueValidationError.yaml"
+    https://hivemq.com/edge/api/model/InvalidIdentifierValidationError: "../validation/InvalidIdentifierValidationError.yaml"
+    https://hivemq.com/edge/api/model/InvalidSchemaVersionValidationError: "./InvalidSchemaVersionValidationError.yaml"
+    https://hivemq.com/edge/api/model/MissingFieldValidationError: "../validation/MissingFieldValidationError.yaml"
+    https://hivemq.com/edge/api/model/UnsupportedFieldValidationError: "../validation/UnsupportedFieldValidationError.yaml"

hivemq-edge-openapi/openapi/components/schemas/errors/datahub/ClientDisconnectedError.yaml

@@ -0,0 +1,17 @@
+allOf:
+  - $ref: "../ApiProblemDetails.yaml"
+  - type: object
+    properties:
+      id:
+        type: string
+        description: The client id.
+        example: "abc"
+    required:
+      - id
+example:
+  general:
+    status: 404
+    title: "Client Disconnected"
+    detail: "Client with ID 'abc' is disconnected."
+    id: "abc"
+    type: "https://hivemq.com/edge/api/model/ClientDisconnectedError"

hivemq-edge-openapi/openapi/components/schemas/errors/datahub/ClientNotFoundError.yaml

@@ -0,0 +1,17 @@
+allOf:
+  - $ref: "../ApiProblemDetails.yaml"
+  - type: object
+    properties:
+      id:
+        type: string
+        description: The client id.
+        example: "abc"
+    required:
+      - id
+example:
+  general:
+    status: 404
+    title: "Client Not Found"
+    detail: "Client with ID 'abc' is not found."
+    id: "abc"
+    type: "https://hivemq.com/edge/api/model/ClientNotFoundError"

hivemq-edge-openapi/openapi/components/schemas/errors/datahub/DataPolicyAlreadyPresentError.yaml

@@ -0,0 +1,17 @@
+allOf:
+  - $ref: "../ApiProblemDetails.yaml"
+  - type: object
+    properties:
+      id:
+        type: string
+        description: The data policy id.
+        example: "abc"
+    required:
+      - id
+example:
+  general:
+    status: 409
+    title: "Data Policy Already Present"
+    detail: "The given data policy 'abc' is already present."
+    id: "abc"
+    type: "https://hivemq.com/edge/api/model/DataPolicyAlreadyPresentError"

hivemq-edge-openapi/openapi/components/schemas/errors/datahub/DataPolicyCreationFailureError.yaml

@@ -0,0 +1,8 @@
+allOf:
+  - $ref: "../ApiProblemDetails.yaml"
+example:
+  general:
+    status: 400
+    title: "Data Policy Creation Failed"
+    detail: "Data policy creation failed: The policy was rejected."
+    type: "https://hivemq.com/edge/api/model/DataPolicyCreationFailureError"