Hathim NSLookup tool updated using the baseline checklist

[hathimsh]

During the latest code review, some significant modifications were implemented to improve the clarity and ensure the resilience of the code. The handleProcessData and handleProcessTermination functions were enhanced with comprehensive docstrings and inline comments, providing a thorough explanation of their purpose and internal mechanisms. This facilitates enhanced comprehension and upkeep of the code. In addition, the state variables and form management logic were thoroughly examined to verify their accuracy, assuring appropriate initialisation and updates. The examination also included an assessment of error handling to ensure the smooth and effective management of any issues. In addition, the tutorial component was included with a blank string to offer explicit guidance on utilising the NSLookup utility. The objective of these enhancements is to enhance the readability, maintainability, and reliability of the NSLookup component during execution.

[hathimsh]

Hi Micheal

I just saw the mail I don’t know what happened as all mails were in the spam folder i guess this one is old pull request i have made a pull request saying including the tutorial which has empty tutorial string and it has some more changes. Can you please check and i will also compare the suggestions that is given by you with that code. So can i make this as sprint 2 of the project?

On Fri, 16 Aug 2024 at 5:41 PM, michaeljpigott @.***> wrote:

@.**** requested changes on this pull request.

Hi @hathimsh https://github.com/hathimsh

This is a good first effort, but there is still a fair bit of work to do before this tool is baselined.

Please implement my recommended changes and push them back into your branch. The pull request will automatically update.

In src/components/NSLookupTool/NSLookupTool.tsx https://github.com/Hardhat-Enterprises/Deakin-Detonator-Toolkit/pull/740#discussion_r1719465862 :

@@ -7,50 +7,54 @@ import { UserGuide } from "../UserGuide/UserGuide"; import { SaveOutputToTextFile_v2 } from "../SaveOutputToFile/SaveOutputToTextFile"; import { LoadingOverlayAndCancelButton } from "../OverlayAndCancelButton/OverlayAndCancelButton";

You do not need to import UserGuide because it is deprecated. You need to import checkAllCommandsAvailability, InstallationModal and RenderComponent. ⬇️ Suggested change

- +import { checkAllCommandsAvailability } from "../../utils/CommandAvailability"; +import InstallationModal from "../InstallationModal/InstallationModal"; +import { RenderComponent } from "../UserGuide/UserGuide";

---

In src/components/NSLookupTool/NSLookupTool.tsx https://github.com/Hardhat-Enterprises/Deakin-Detonator-Toolkit/pull/740#discussion_r1719466454 :

@@ -7,50 +7,54 @@ import { UserGuide } from "../UserGuide/UserGuide"; import { SaveOutputToTextFile_v2 } from "../SaveOutputToFile/SaveOutputToTextFile"; import { LoadingOverlayAndCancelButton } from "../OverlayAndCancelButton/OverlayAndCancelButton";

-const title = "NsLookup"; -const description_userguide =

• "The nslookup command is a tool used to query Domain Name System (DNS) servers and retrieve information about a specific domain or IP address." + +/**
• • Title and Description of the tool

These constants need to be moved to within the function.

In src/components/NSLookupTool/NSLookupTool.tsx https://github.com/Hardhat-Enterprises/Deakin-Detonator-Toolkit/pull/740#discussion_r1719467150 :

@@ -7,50 +7,54 @@ import { UserGuide } from "../UserGuide/UserGuide"; import { SaveOutputToTextFile_v2 } from "../SaveOutputToFile/SaveOutputToTextFile"; import { LoadingOverlayAndCancelButton } from "../OverlayAndCancelButton/OverlayAndCancelButton";

-const title = "NsLookup"; -const description_userguide =

• "The nslookup command is a tool used to query Domain Name System (DNS) servers and retrieve information about a specific domain or IP address." + +/**
• • Title and Description of the tool
• */ +const title = "NSLookup"; +const description_Userguide =

Change this constant title to description. ⬇️ Suggested change

-const description_Userguide = +const description =

---

In src/components/NSLookupTool/NSLookupTool.tsx https://github.com/Hardhat-Enterprises/Deakin-Detonator-Toolkit/pull/740#discussion_r1719467739 :

@@ -7,50 +7,54 @@ import { UserGuide } from "../UserGuide/UserGuide"; import { SaveOutputToTextFile_v2 } from "../SaveOutputToFile/SaveOutputToTextFile"; import { LoadingOverlayAndCancelButton } from "../OverlayAndCancelButton/OverlayAndCancelButton";

-const title = "NsLookup"; -const description_userguide =

• "The nslookup command is a tool used to query Domain Name System (DNS) servers and retrieve information about a specific domain or IP address." + +/**
• • Title and Description of the tool
• */ +const title = "NSLookup"; +const description_Userguide =
• "The NSLookup command is a tool used to query Domain Name System (DNS) servers and retrieve information about a specific domain or IP address." + "This command is an essential tool for network administrators and system engineers as it can be used to troubleshoot DNS issues and gather information about DNS configurations." + "How to use NSLookUp.\n\n" + "Step 1: Enter an IP or Web URL.\n" +

Steps should be saved in their own variable const steps.

In src/components/NSLookupTool/NSLookupTool.tsx https://github.com/Hardhat-Enterprises/Deakin-Detonator-Toolkit/pull/740#discussion_r1719470207 :

• let form = useForm({
• const [loading, setLoading] = useState(false); // Indication of running the process
• const [pid, setPid] = useState(""); // Process ID
• const [output, setOutput] = useState(""); // Output
• const [allowSave, setAllowSave] = useState(false); // Looking whether the process can be saved
• const [hasSaved, setHasSaved] = useState(false); // Indication of saved process

the useEffect function can go here. ⬇️ Suggested change

- +// Check if the command is available and set the state variables accordingly.

• useEffect(() => {
• // Check if the command is available and set the state variables accordingly.
• checkAllCommandsAvailability(dependencies)
• .then((isAvailable) => {
• setIsCommandAvailable(isAvailable); // Set the command availability state
• setOpened(!isAvailable); // Set the modal state to opened if the command is not available
• setLoadingModal(false); // Set loading to false after the check is done
• })
• .catch((error) => {
• console.error("An error occurred:", error);
• setLoadingModal(false); // Also set loading to false in case of error
• });
• }, []);

---

In src/components/NSLookupTool/NSLookupTool.tsx https://github.com/Hardhat-Enterprises/Deakin-Detonator-Toolkit/pull/740#discussion_r1719471432 :

• let form = useForm({
• const [loading, setLoading] = useState(false); // Indication of running the process
• const [pid, setPid] = useState(""); // Process ID
• const [output, setOutput] = useState(""); // Output
• const [allowSave, setAllowSave] = useState(false); // Looking whether the process can be saved
• const [hasSaved, setHasSaved] = useState(false); // Indication of saved process
• // Form management by using Mantine

This is probably a more descriptive comment for this particular piece of code. ⬇️ Suggested change

• // Form management by using Mantine
• // Form Hook to handle form input.

---

In src/components/NSLookupTool/NSLookupTool.tsx https://github.com/Hardhat-Enterprises/Deakin-Detonator-Toolkit/pull/740#discussion_r1719474027 :

 const clearOutput = useCallback(() => {

• setOutput("");
• setHasSaved(false);
• setAllowSave(false);
• }, [setOutput]); // Dependency on the setOutput function.
• setOutput(""); // Clears output
• setHasSaved(false); // Reset save status
• setAllowSave(false); // Disable saving
• }, [setOutput]);

 return (
     <form onSubmit={form.onSubmit((values) => onSubmit(values))}>

Can add RenderComponent and loadingModal here. ⬇️ Suggested change

• <form onSubmit={form.onSubmit((values) => onSubmit(values))}>
• <>
• <RenderComponent
• title={title}
• description={description}
• steps={steps}
• tutorial={tutorial}
• sourceLink={sourceLink}
• {!loadingModal && (
• <InstallationModal
• isOpen={opened}
• setOpened={setOpened}
• feature_description={description}
• dependencies={dependencies}
• )}
• <form onSubmit={form.onSubmit((values) => onSubmit(values))}>

---

In src/components/NSLookupTool/NSLookupTool.tsx https://github.com/Hardhat-Enterprises/Deakin-Detonator-Toolkit/pull/740#discussion_r1719475163 :

 "This command is an essential tool for network administrators and system engineers as it can be used to troubleshoot DNS issues and gather information about DNS configurations." +

"How to use NSLookUp.\n\n" + "Step 1: Enter an IP or Web URL.\n" +

• " E.g. 127.0.0.1\n\n" +
• " E.g. 127.0.0.1\n\n" + "Step 2: View the Output block below to view the results of the Scan.";

You also need to add the tutorial and sourceLink variables.

In src/components/NSLookupTool/NSLookupTool.tsx https://github.com/Hardhat-Enterprises/Deakin-Detonator-Toolkit/pull/740#discussion_r1719476892 :

return ( <form onSubmit={form.onSubmit((values) => onSubmit(values))}> {LoadingOverlayAndCancelButton(loading, pid)}

- {UserGuide(title, description_userguide)} + {UserGuide(title, description_Userguide)}

Can delete userguide. It is not required as part of baselining. ⬇️ Suggested change

• {UserGuide(title, description_Userguide)}

---

In src/components/NSLookupTool/NSLookupTool.tsx https://github.com/Hardhat-Enterprises/Deakin-Detonator-Toolkit/pull/740#discussion_r1719477820 :

             />

+

• <TextInput label={"Tutorial"} {...form.getInputProps("tutorial")} />

• {SaveOutputToTextFile_v2(output, allowSave, hasSaved, handleSaveComplete)} <Button type={"submit"}>Scan

Convention is "Start