fix: show proper error if server down in self-hosting

Author: prafull-opensignlabs

apps/OpenSign/public/locales/en/translation.json

@@ -668,6 +668,8 @@
   "download-files":"Download files",
   "download-pdf":"Download Pdf",
   "pdf-certificate":"Download Pdf + Certificate",
-  "document-logs":"Document logs"
+  "document-logs":"Document logs",
+  "server-down": "Unable to connect to the OpenSign server. If you are self-hosting OpenSign, please ensure that all the steps in the documentation have been followed correctly. If you're running OpenSign locally, you might be accessing it through an incorrect port number.",
+  "admin-exists": "Admin already exists. Please login to the application using admin credentials in order to manage users."
 
 }

apps/OpenSign/public/locales/fr/translation.json

@@ -667,6 +667,9 @@
    "download-files" :"Télécharger des fichiers",
    "download-pdf" :"Télécharger le PDF",
   "pdf-certificate"  :"Télécharger Pdf + Certificat",
-  "document-logs":"Journaux de documents"
+  "document-logs":"Journaux de documents",
+  "server-down": "Impossible de se connecter au serveur OpenSign. Si vous hébergez vous-même OpenSign, veuillez vous assurer que toutes les étapes de la documentation ont été correctement suivies. Si vous exécutez OpenSign localement, vous y accédez peut-être via un numéro de port incorrect.",
+  "admin-exists": "L'administrateur existe déjà. Veuillez vous connecter à l'application en utilisant les informations d'identification de l'administrateur afin de gérer les utilisateurs."
+
 
 }

apps/OpenSign/public/version.txt

@@ -1926,7 +1926,11 @@ export const getAppLogo = async () => {
       }
     } catch (err) {
       console.log("err in getlogo ", err);
-      return { logo: appInfo.applogo, user: "exist" };
+      if (err?.includes("is not valid JSON")) {
+        return { logo: appInfo.applogo, user: "exist", error: "invalid_json" };
+      } else {
+        return { logo: appInfo.applogo, user: "exist" };
+      }
     }
   }
 };

apps/OpenSign/src/constant/Utils.js

@@ -46,7 +46,7 @@ const AddAdmin = () => {
     try {
       const app = await getAppLogo();
       if (app?.user === "exist") {
-        setErrMsg(t("admin-already-exist"));
+        setErrMsg(t("admin-exists"));
       }
     } catch (err) {
       setErrMsg(t("something-went-wrong-mssg"));

apps/OpenSign/src/pages/AddAdmin.js

@@ -51,6 +51,7 @@ function Login() {
   const [isModal, setIsModal] = useState(false);
   const [image, setImage] = useState();
   const [isLoginSSO, setIsLoginSSO] = useState(false);
+  const [errMsg, setErrMsg] = useState();
 
   useEffect(() => {
     checkUserExt();
@@ -59,7 +60,9 @@ function Login() {
 
   const checkUserExt = async () => {
     const app = await getAppLogo();
-    if (!isEnableSubscription && app?.user === "not_exist") {
+    if (app?.error === "invalid_json") {
+      setErrMsg(t("server-down"));
+    } else if (!isEnableSubscription && app?.user === "not_exist") {
       navigate("/addadmin");
     }
     if (app?.logo) {
@@ -620,7 +623,11 @@ function Login() {
     }
   };
 
-  return (
+  return errMsg ? (
+    <div className="h-screen flex justify-center text-center items-center p-4 text-gray-500 text-base">
+      {errMsg}
+    </div>
+  ) : (
     <div>
       <Title title={"Login Page"} />
       {state.loading && (

apps/OpenSign/src/pages/Login.js

@@ -52,7 +52,7 @@ const UpdateExistUserAdmin = () => {
       } else if (err.code === 101) {
         setIsAlert((prev) => ({ ...prev, msg: t("user-not-found") }));
       } else if (err.code === 137) {
-        setIsAlert((prev) => ({ ...prev, msg: t("admin-already-exist") }));
+        setIsAlert((prev) => ({ ...prev, msg: t("admin-exists") }));
       } else {
         setErrMsg(t("something-went-wrong-mssg"));
       }

apps/OpenSign/src/pages/UpdateExistUserAdmin.js

@@ -41,7 +41,7 @@
   "upgrade-now": "Upgrade now",
   "upgrade-to": "Upgrade to",
   "plan": "Plan",
-  "subscribe-card-teamplan":"Unlock the full power of collaboration! Create unlimited organizations, teams, and hierarchies. Share templates seamlessly across teams and assign custom user roles. Elevate your workflow today!",
+  "subscribe-card-teamplan": "Unlock the full power of collaboration! Create unlimited organizations, teams, and hierarchies. Share templates seamlessly across teams and assign custom user roles. Elevate your workflow today!",
   "subscribe-card-plan": "Unlock premium features starting at just {{premiumPrice}}/month. Enjoy enhanced performance and only {{addonPrice}} per additional credit after your included premium credits.",
   "user-name-limit-char": "To have a username less than 8 character please subscribe",
   "tour-content": "Don't show this again",
@@ -132,7 +132,7 @@
     "View": "View",
     "option": "Option",
     "Embed": "Embed",
-    "Copy TemplateId":"Copy TemplateId"
+    "Copy TemplateId": "Copy TemplateId"
   },
   "report-heading": {
     "Sr.No": "Sr.No",
@@ -266,7 +266,7 @@
   "public-role": "Public role",
   "public-url": "Public URL",
   "public-url-copy": "Here’s your public URL: ",
-  "public-url-copy-mssg":"Copy it or share it with the signer, and you will be able to see all your publicly set templates.",
+  "public-url-copy-mssg": "Copy it or share it with the signer, and you will be able to see all your publicly set templates.",
   "add-public-url-alert": "Please add your public URL, and you will be able to make a public template.",
   "share-with-alert": "You cannot share a template if any roles already have contacts assigned. Please remove all contact assignments from the roles before sharing the template.",
   "share-with": "Share with",
@@ -597,7 +597,7 @@
     "Recently sent for signatures": "This is a list of documents you've sent to other parties for signature.",
     "Drafts": "This are documents you have started but have not finalized for sending.",
     "public-template": "This video demonstrates how to set up your personalized public profile, such as ‘https://opensign.me/your-username’. You’ll also learn how to customize your tagline and make your templates available for public signing."
-   },
+  },
   "enter-email-plaholder": "Add an email address and hit enter",
   "success-email-alert": "Email sent successfully!",
   "expired-doc-title": "Expired Document",
@@ -618,55 +618,58 @@
   "select-date-format": "Select a date format",
   "quantity-of-credits": "Quantity of premium credits",
   "remaining-credits": "Premium credits available:",
-  "remaining-credits-help":"Use premium credits for API document signing, bulk sending, or embedding OpenSign integration on your website. You have {{allowedcredits}} included credits and {{addoncredits}} additional purchased credits remaining.",
+  "remaining-credits-help": "Use premium credits for API document signing, bulk sending, or embedding OpenSign integration on your website. You have {{allowedcredits}} included credits and {{addoncredits}} additional purchased credits remaining.",
   "additional-credits": "Please purchase premium credits",
   "quota-err-quicksend": "Quota Reached, You don't have enough credits.",
   "buy-credits": "Buy Premium Credits",
-  "rotate-right":"Rotate right",
-  "rotate-left":"Rotate left",
-  "rotate-alert-mssg":"All widgets on this page will be lost. Are you sure you want to proceed?",
-  "templateid":"Template-Id",
-  "bulk-send-subcription-alert":"Please upgrade to Professional or Team plan to use bulk send.",
-  "generate-test-token":"Generate Test Token",
-  "regenerate-test-token":"Regenerate Test Token",
-  "help-test-token":"This token can be used to test the APIs at the https://sandbox.opensignlabs.com/api/v1 endpoint, allowing you to conduct unlimited document signatures. Please note that the sandbox API will sign your documents with self-signed certificates, which may not be recognized as valid by Adobe. Once you’ve completed your testing, you can upgrade to one of our paid plans to generate a production token.",
-  "help-api-token":"This token can be used to access the production APIs at the {{origin}}/api/v1 endpoint. It can only be generated on one of our paid plans.",
-  "reason":"Reason",
-  "decline-by":"Declined/revoked by",
+  "rotate-right": "Rotate right",
+  "rotate-left": "Rotate left",
+  "rotate-alert-mssg": "All widgets on this page will be lost. Are you sure you want to proceed?",
+  "templateid": "Template-Id",
+  "bulk-send-subcription-alert": "Please upgrade to Professional or Team plan to use bulk send.",
+  "generate-test-token": "Generate Test Token",
+  "regenerate-test-token": "Regenerate Test Token",
+  "help-test-token": "This token can be used to test the APIs at the https://sandbox.opensignlabs.com/api/v1 endpoint, allowing you to conduct unlimited document signatures. Please note that the sandbox API will sign your documents with self-signed certificates, which may not be recognized as valid by Adobe. Once you’ve completed your testing, you can upgrade to one of our paid plans to generate a production token.",
+  "help-api-token": "This token can be used to access the production APIs at the {{origin}}/api/v1 endpoint. It can only be generated on one of our paid plans.",
+  "reason": "Reason",
+  "decline-by": "Declined/revoked by",
   "document-declined": "Document declined",
-  "public-template-mssg-1":"To integrate OpenSign into your React or Next.js project, simply run the following command:",
-  "public-template-mssg-2" :"Ensure you have npm or yarn set up in your project. If you’re using Yarn, you can replace npm install with yarn add @opensign/react.",
-  "public-template-mssg-3"  :"Need more details or examples?",
+  "public-template-mssg-1": "To integrate OpenSign into your React or Next.js project, simply run the following command:",
+  "public-template-mssg-2": "Ensure you have npm or yarn set up in your project. If you’re using Yarn, you can replace npm install with yarn add @opensign/react.",
+  "public-template-mssg-3": "Need more details or examples?",
   "public-template-mssg-4": "Visit the",
   "public-template-mssg-5": " npm for the latest updates, detailed documentation, and version history.",
-  "public-template-mssg-6" :"You need to set this template as public before you can utilize this code snippet.",
-  "copy-code":"COPY",
-  "copied-code":"COPIED",
-  "Installation":"Installation",
-  "Usage" :"Usage",
-  "insufficient-credits":"Insufficient Signing Credits",
-  "insufficient-credits-mssg":"The owner of this document currently lacks the necessary OpenSign credits for you to sign. Please reach out to the owner if you require further details.",
+  "public-template-mssg-6": "You need to set this template as public before you can utilize this code snippet.",
+  "copy-code": "COPY",
+  "copied-code": "COPIED",
+  "Installation": "Installation",
+  "Usage": "Usage",
+  "insufficient-credits": "Insufficient Signing Credits",
+  "insufficient-credits-mssg": "The owner of this document currently lacks the necessary OpenSign credits for you to sign. Please reach out to the owner if you require further details.",
   "angular-npm-mssg-1": "To integrate OpenSign into your Angular project, simply run the following command:",
-  "quota-mail-info-head":"Monthly request signatures email limit",
+  "quota-mail-info-head": "Monthly request signatures email limit",
   "quota-mail-info": "You can send upto 15 signature request emails every month. Upgrade now to send unlimited signing requests directly.",
   "quota-mail": "You've reached your limit of 15 signature request emails for this month. Upgrade now to continue sending emails directly.",
-  "quota-mail-tip":"Tip: You can still sign <1>unlimited documents</1> by manually sharing the signing request links.",
-  "quota-mail-head":"Quota Reached",
-  "unauthorized-modal":"You don't have permission to perform this action, please contact {{adminEmail}}.",
-  "sent-this-month":"Sent this month",
-  "available-seats":"Available seats",
-  "buy-users":"Buy more users",
+  "quota-mail-tip": "Tip: You can still sign <1>unlimited documents</1> by manually sharing the signing request links.",
+  "quota-mail-head": "Quota Reached",
+  "unauthorized-modal": "You don't have permission to perform this action, please contact {{adminEmail}}.",
+  "sent-this-month": "Sent this month",
+  "available-seats": "Available seats",
+  "buy-users": "Buy more users",
   "isenable-otp": "Enable OTP verification",
   "isenable-otp-help": {
     "p1": "Would you like to enable the verification process using a one-time password (OTP)?",
     "p2": "Selecting this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document.",
     "p3": "Selecting this option will disable OTP verification, allowing users to sign the document directly without additional steps.",
     "p4": "Please choose the option that best suits your document signing requirements."
   },
-  "advanced-options":"Advanced options",
-  "hide-advanced-options":"Hide Advanced options",
-  "download-files":"Download files",
-  "download-pdf":"Download Pdf",
-  "pdf-certificate":"Download Pdf + Certificate",
-  "document-logs":"Document logs"
+  "advanced-options": "Advanced options",
+  "hide-advanced-options": "Hide Advanced options",
+  "download-files": "Download files",
+  "download-pdf": "Download Pdf",
+  "pdf-certificate": "Download Pdf + Certificate",
+  "document-logs": "Document logs",
+  "server-down": "Unable to connect to the OpenSign server. If you are self-hosting OpenSign, please ensure that all the steps in the documentation have been followed correctly. If you're running OpenSign locally, you might be accessing it through an incorrect port number.",
+  "admin-exists": "Admin already exists. Please login to the application using admin credentials in order to manage users."
+
 }