kie-issues#2466: Serverless Logic Web Tools: Runtime Tools settings doesn't validate the data index url. #2608

kumaradityaraj · 2024-09-20T12:08:44Z

Closes apache/incubator/kie-issues#2466

Description:
The data index url is now validated and if its invalid an alert is shown.

How to test:

Navigate to serverless-logic-web-tools package
Execute the command pnpm start
Click on this link to set your data index url and validate it Runtime tools settings page

Preview:

Screen.Recording.2024-09-20.at.4.21.45.PM.mov

kumaradityaraj · 2024-09-20T12:09:37Z

@fantonangeli Please review this PR. Thank you.

fantonangeli

Thank you @kumaradityaraj for your prompt PR.

fantonangeli · 2024-09-20T15:53:04Z

packages/serverless-logic-web-tools/src/settings/runtimeTools/RuntimeToolsSettings.tsx

  const settings = useSettings();
  const settingsDispatch = useSettingsDispatch();
  const [config, setConfig] = useState(settings.runtimeTools.config);
  const [isModalOpen, setIsModalOpen] = useState(false);
+  const [isDataIndexUrlValidated, setDataIndexUrlValidated] = useState(DataIndexValidation.INVALID);


Suggested change

const [isDataIndexUrlValidated, setDataIndexUrlValidated] = useState(DataIndexValidation.INVALID);

const [isDataIndexUrlValidated, setDataIndexUrlValidated] = useState(DataIndexValidation.INITIAL);

fantonangeli · 2024-09-20T16:02:00Z

packages/serverless-logic-web-tools/src/settings/runtimeTools/RuntimeToolsSettings.tsx


 const PAGE_TITLE = "Runtime Tools";

+enum DataIndexValidation {


XXS suggestion. On some pages we call this FormValiationOptions, we can make this name consistent with those pages:
packages/serverless-logic-web-tools/src/settings/openshift/OpenShiftSettingsSimpleConfig.tsx
packages/online-editor/src/accounts/kubernetes/ConnectToKubernetesSimple.tsx
packages/online-editor/src/accounts/openshift/ConnecToOpenShiftSimple.tsx

Suggested change

enum DataIndexValidation {

enum FormValiationOptions {

fantonangeli · 2024-09-20T16:06:15Z

packages/serverless-logic-web-tools/src/i18n/AppI18n.ts

@@ -71,6 +71,7 @@ interface AppDictionary extends ReferenceDictionary {
      validationError: string;
      connectionError: string;
      configExpiredWarning: string;
+      validDataIndexURLError: string;


Thank you for taking care of the translations.
This section is related to the OpenShift settings page.
I suggest creating a section for RuntimeToolsSettings page to store this property.
ie: RuntimeToolsSettings.configModal.validDataIndexURLError

fantonangeli · 2024-09-20T16:32:40Z

packages/serverless-logic-web-tools/tests/url/dataIndexValidUrl.test.ts

+    ["http://example.com/", true],
+    ["https://example.com/", true],


Let's ensure we accept only http/https protocol.

Suggested change

["http://example.com/", true],

["https://example.com/", true],

["http://example.com", true],

["http://example.com/", true],

["https://example.com/", true],

["ftps://example.com/", false],

fantonangeli · 2024-09-20T16:45:34Z

packages/serverless-logic-web-tools/src/url/index.ts

+    new URL(url);
+    return true;


I found a bug here, we are accepting every protocol in this function.

@tiagobento it's out of scope, but do you think we should also reproduce this suggestion here?
https://github.com/kumaradityaraj/kie-tools/blob/fc27f22fa01303a39132ae27494b43a41bc7101f/packages/kubernetes-bridge/src/service/KubernetesConnection.ts#L51

Suggested change

new URL(url);

return true;

const parsedUrl = new URL(url);

return parsedUrl.protocol === "http:" || parsedUrl.protocol === "https:";

fantonangeli · 2024-09-20T16:47:41Z

packages/serverless-logic-web-tools/tests/url/dataIndexValidUrl.test.ts

+    ["https://example.com/", true],
+    ["loremIpsum", false],
+    ["google.com", false],
+  ])("should validate the data index URL", (inputUrl, isValidUrl) => {


Let's improve the log messages.

Suggested change

])("should validate the data index URL", (inputUrl, isValidUrl) => {

])("the data index URL %s validation should be %s", (inputUrl, isValidUrl) => {

fantonangeli · 2024-09-20T16:51:50Z

packages/serverless-logic-web-tools/src/url/index.ts

@@ -26,3 +26,12 @@
 export function removeTrailingSlashFromUrl(url: string): string {
  return url.replace(/\/$/, "");
 }
+
+export function validDataIndexUrl(url: string): boolean {


We can make this name consistent with the other kie-tools validation functions.

Suggested change

export function validDataIndexUrl(url: string): boolean {

export function isDataIndexUrlValid(url: string): boolean {

fantonangeli · 2024-09-20T16:53:02Z

packages/serverless-logic-web-tools/tests/url/dataIndexValidUrl.test.ts

+
+import { validDataIndexUrl } from "../../src/url";
+
+describe("removeTrailingSlash", () => {


fantonangeli · 2024-09-20T17:19:17Z

packages/serverless-logic-web-tools/src/settings/runtimeTools/RuntimeToolsSettings.tsx

+      setDataIndexUrlValidated(DataIndexValidation.INVALID);
+      return;
+    }
+


After checking if it's valid it would be great to really test the url answers to a simple query.
You can use:

incubator-kie-tools/packages/sonataflow-deployment-webapp/src/data/index.ts

Line 33 in fc27f22

export async function verifyDataIndex(dataIndexUrl?: string): Promise<boolean> {

Maybe we can move verifyDataIndex() inside the package runtime-tools-swf-gateway-api to avoid code duplication.

Added validation for data index url and its tests

fc27f22

kumaradityaraj requested a review from tiagobento as a code owner September 20, 2024 12:08

fantonangeli self-requested a review September 20, 2024 12:11

fantonangeli added the area:sonataflow label Sep 20, 2024

fantonangeli requested changes Sep 20, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

kie-issues#2466: Serverless Logic Web Tools: Runtime Tools settings doesn't validate the data index url. #2608

kie-issues#2466: Serverless Logic Web Tools: Runtime Tools settings doesn't validate the data index url. #2608

kumaradityaraj commented Sep 20, 2024

kumaradityaraj commented Sep 20, 2024

fantonangeli left a comment

fantonangeli Sep 20, 2024

fantonangeli Sep 20, 2024

fantonangeli Sep 20, 2024

fantonangeli Sep 20, 2024

fantonangeli Sep 20, 2024

fantonangeli Sep 20, 2024

fantonangeli Sep 20, 2024

fantonangeli Sep 20, 2024

fantonangeli Sep 20, 2024

	const [isDataIndexUrlValidated, setDataIndexUrlValidated] = useState(DataIndexValidation.INVALID);
	const [isDataIndexUrlValidated, setDataIndexUrlValidated] = useState(DataIndexValidation.INITIAL);


		const PAGE_TITLE = "Runtime Tools";

		enum DataIndexValidation {

		["http://example.com/", true],
		["https://example.com/", true],

	])("should validate the data index URL", (inputUrl, isValidUrl) => {
	])("the data index URL %s validation should be %s", (inputUrl, isValidUrl) => {

	export function validDataIndexUrl(url: string): boolean {
	export function isDataIndexUrlValid(url: string): boolean {


		import { validDataIndexUrl } from "../../src/url";

		describe("removeTrailingSlash", () => {

kie-issues#2466: Serverless Logic Web Tools: Runtime Tools settings doesn't validate the data index url. #2608

Are you sure you want to change the base?

kie-issues#2466: Serverless Logic Web Tools: Runtime Tools settings doesn't validate the data index url. #2608

Conversation

kumaradityaraj commented Sep 20, 2024

kumaradityaraj commented Sep 20, 2024

fantonangeli left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment