Updated code examples launcher to use examples manifests (#90)

* updated launcher to use examples

* fixes

* fixes

* update manifest urls

* updates to use more manifest text

* fix errors in views

* update error messages

* removing extra text

* fixing template results page

Co-authored-by: Paige Rossi <paige.rossi@docusign.com>

Author: RomanBachaloSigmaSoftware

config/appsettings.example.json

@@ -28,5 +28,10 @@
   "roomsApiUrl": "https://demo.rooms.docusign.com",
   "clickAPIUrl": "https://demo.docusign.net/clickapi",
   "adminAPIUrl": "https://api-d.docusign.net/management",
-  "monitorApiUrl": "https://lens-d.docusign.net"
+  "monitorApiUrl": "https://lens-d.docusign.net",
+  "eSignManifestUrl": "https://raw.githubusercontent.com/docusign/code-examples-csharp/master/manifest/eSignatureManifest.json",
+  "clickManifestUrl": "https://raw.githubusercontent.com/docusign/code-examples-csharp/master/manifest/ClickManifest.json",
+  "roomsManifestUrl": "https://raw.githubusercontent.com/docusign/code-examples-csharp/master/manifest/RoomsManifest.json",
+  "adminManifestUrl": "https://raw.githubusercontent.com/docusign/code-examples-csharp/master/manifest/AdminManifest.json",
+  "monitorManifestUrl": "https://raw.githubusercontent.com/docusign/code-examples-csharp/master/manifest/MonitorManifest.json"
 }

index.js

@@ -19,6 +19,7 @@ const helmet = require('helmet'); // https://expressjs.com/en/advanced/best-prac
 const moment = require('moment');
 const csrf = require('csurf'); // https://www.npmjs.com/package/csurf
 const examplesApi = require('./config/examplesAPI.json');
+const { getManifest } = require('./lib/manifestService')
 
 const eg001 = require('./lib/eSignature/controllers/eg001EmbeddedSigning');
 
@@ -98,6 +99,35 @@ let app = express()
     }
     next()
   })
+  .use(async (req, res, next) => {
+    let manifestUrl;
+
+    switch(true) {
+      case examplesApi.examplesApi.isRoomsApi:
+        manifestUrl = dsConfig.roomsManifestUrl;
+        break;
+
+      case examplesApi.examplesApi.isClickApi:
+        manifestUrl = dsConfig.clickManifestUrl;
+        break;
+
+      case examplesApi.examplesApi.isMonitorApi:
+        manifestUrl = dsConfig.monitorManifestUrl;
+        break;
+
+      case examplesApi.examplesApi.isAdminApi:
+        manifestUrl = dsConfig.adminManifestUrl;
+        break;
+
+      default:
+        manifestUrl = dsConfig.eSignManifestUrl;
+    }
+
+    const manifest = await getManifest(manifestUrl);
+    res.locals.manifest = manifest;
+
+    next();
+  })
   // Routes
   .get('/', commonControllers.indexController)
   .get('/ds/choose_api', commonControllers.chooseApi)

lib/admin/controllers/eg001CreateUser.js

@@ -6,12 +6,14 @@
 
 const path = require('path');
 const { createUser, getPermissionProfilesAndGroups } = require('../examples/createUser');
+const { getExampleByNumber } = require("../../manifestService");
 const dsConfig = require('../../../config/index.js').config;
 const validator = require('validator');
 const { getOrganizationId } = require("../getOrganizationId.js");
 
 const eg001CreateUser = exports;
-const eg = 'eg001' // This example reference.;
+const exampleNumber = 1;
+const eg = `eg00${exampleNumber}`; // This example reference.
 const mustAuthenticate = '/ds/mustAuthenticate';
 const minimumBufferMin = 3;
 
@@ -24,12 +26,12 @@ eg001CreateUser.createController = async(req, res) => {
   // Step 1. Check the token
   // At this point we should have a good token. But we
   // double-check here to enable a better UX to the user.
-  const tokenOK = req.dsAuth.checkToken(minimumBufferMin);
-  if (!tokenOK) {
+  const isTokenOK = req.dsAuth.checkToken(minimumBufferMin);
+  if (!isTokenOK) {
     req.flash('info', 'Sorry, you need to re-authenticate.');
     // Save the current operation so it will be resumed after authentication
     req.dsAuth.setEg(req, eg);
-    res.redirect(mustAuthenticate);
+    return res.redirect(mustAuthenticate);
   }
 
   const { body } = req;
@@ -61,10 +63,10 @@ eg001CreateUser.createController = async(req, res) => {
     res.render('pages/error', { err: error, errorCode, errorMessage });
   }
   if (results) {
+    const example = getExampleByNumber(res.locals.manifest, exampleNumber);
     res.render('pages/example_done', {
-      title: "Create a new active eSignature user",
-      h1: "Create a new active eSignature user",
-      message: "Results from eSignUserManagement:createUser method:",
+      title: example.ExampleName,
+      message: example.ResultsPageText,
       json: JSON.stringify(results)
     });
   }
@@ -78,46 +80,45 @@ eg001CreateUser.getController = async (req, res) => {
   // If needed, now is the best time to ask the user to authenticate
   // since they have not yet entered any information into the form.
 
-  let tokenOK = req.dsAuth.checkToken();
-  if (tokenOK) {
-    try {
-      await getOrganizationId(req);
+  let isTokenOK = req.dsAuth.checkToken();
+  if (!isTokenOK) {
+    // Save the current operation so it will be resumed after authentication
+    req.dsAuth.setEg(req, eg);
+    return res.redirect(mustAuthenticate);
+  }
 
-      const args = {
-        accessToken: req.user.accessToken,
-        accountId: req.session.accountId,
-        basePath: req.session.basePath,
-        organizationId: req.session.organizationId
-      };
+  try {
+    await getOrganizationId(req);
 
-      const { profiles, groups } = await getPermissionProfilesAndGroups(args);
+    const args = {
+      accessToken: req.user.accessToken,
+      accountId: req.session.accountId,
+      basePath: req.session.basePath,
+      organizationId: req.session.organizationId
+    };
 
-      sourceFile = (path.basename(__filename))[5].toLowerCase() + (path.basename(__filename)).substr(6);
-      res.render('pages/admin-examples/eg001CreateUser', {
-        eg: eg,
-        csrfToken: req.csrfToken(),
-        title: "Creating a new user",
-        permissionProfiles: profiles.permissionProfiles,
-        groups: groups.groups,
-        sourceFile: sourceFile,
-        sourceUrl: dsConfig.githubExampleUrl + "admin/examples/" + sourceFile,
-        documentation: dsConfig.documentation + eg,
-        showDoc: dsConfig.documentation
-      });
-    }
-    catch (error) {
-      const errorBody = error && error.response && error.response.body;
-      const errorCode = errorBody && errorBody.errorCode;
-      const errorMessage = errorBody && errorBody.message;
+    const { profiles, groups } = await getPermissionProfilesAndGroups(args);
 
-      // In production, may want to provide customized error messages and
-      // remediation advice to the user.
-      res.render('pages/error', { err: error, errorCode, errorMessage });
-    }
+    const example = getExampleByNumber(res.locals.manifest, exampleNumber);
+    const sourceFile = (path.basename(__filename))[5].toLowerCase() + (path.basename(__filename)).substr(6);
+    res.render('pages/admin-examples/eg001CreateUser', {
+      eg: eg,
+      csrfToken: req.csrfToken(),
+      example: example,
+      permissionProfiles: profiles.permissionProfiles,
+      groups: groups.groups,
+      sourceFile: sourceFile,
+      sourceUrl: dsConfig.githubExampleUrl + "admin/examples/" + sourceFile,
+      documentation: dsConfig.documentation + eg,
+      showDoc: dsConfig.documentation
+    });
+  } catch (error) {
+    const errorBody = error && error.response && error.response.body;
+    const errorCode = errorBody && errorBody.errorCode;
+    const errorMessage = errorBody && errorBody.message;
 
-  } else {
-    // Save the current operation so it will be resumed after authentication
-    req.dsAuth.setEg(req, eg);
-    res.redirect(mustAuthenticate);
+    // In production, may want to provide customized error messages and
+    // remediation advice to the user.
+    res.render('pages/error', { err: error, errorCode, errorMessage });
   }
 }

lib/admin/controllers/eg002CreateCLMESignUser.js

@@ -6,12 +6,14 @@
 
 const path = require('path')
 const { createCLMESignUser, getProductPermissionProfiles, getDSAdminGroups } = require('../examples/createCLMESignUser');
+const { getExampleByNumber } = require("../../manifestService");
 const dsConfig = require('../../../config/index.js').config;
 const validator = require('validator');
 const { getOrganizationId } = require("../getOrganizationId.js");
 
 const eg002CreateCLMESignUser = exports;
-const eg = 'eg002' // This example reference.;
+const exampleNumber = 2;
+const eg = `eg00${exampleNumber}`; // This example reference.
 const mustAuthenticate = '/ds/mustAuthenticate';
 const minimumBufferMin = 3;
 
@@ -23,12 +25,12 @@ const minimumBufferMin = 3;
 eg002CreateCLMESignUser.createController = async (req, res) => {
   // At this point we should have a good token. But we
   // double-check here to enable a better UX to the user.
-  let tokenOK = req.dsAuth.checkToken(minimumBufferMin);
-  if (!tokenOK) {
+  let isTokenOK = req.dsAuth.checkToken(minimumBufferMin);
+  if (!isTokenOK) {
     req.flash("info", "Sorry, you need to re-authenticate.");
     // Save the current operation so it will be resumed after authentication
     req.dsAuth.setEg(req, eg);
-    res.redirect(mustAuthenticate);
+    return res.redirect(mustAuthenticate);
   }
 
   let results = null;
@@ -51,8 +53,7 @@ eg002CreateCLMESignUser.createController = async (req, res) => {
 
   try {
     results = await createCLMESignUser(args)
-  }
-  catch (error) {
+  } catch (error) {
     let errorBody = error && error.response && error.response.body
       // we can pull the DocuSign error code and message from the response body
       , errorCode = errorBody && errorBody.errorCode
@@ -65,10 +66,10 @@ eg002CreateCLMESignUser.createController = async (req, res) => {
   if (results) {
     req.session.clmEmail = validator.escape(body.email);
 
+    const example = getExampleByNumber(res.locals.manifest, exampleNumber);
     res.render("pages/example_done", {
-      title: "Create active user for CLM and eSignature",
-      h1: "Create active user for CLM and eSignature",
-      message: "Results from MultiProductUserManagement:addOrUpdateUser method:",
+      title: example.ExampleName,
+      message: example.ResultsPageText,
       json: JSON.stringify(results).replace(/'/g, '')
     });
   }
@@ -81,47 +82,47 @@ eg002CreateCLMESignUser.getController = async (req, res) => {
   // Check that the authentication token is ok with a long buffer time.
   // If needed, now is the best time to ask the user to authenticate
   // since they have not yet entered any information into the form.
-  let tokenOK = req.dsAuth.checkToken();
-  if (tokenOK) {
-    try {
-      await getOrganizationId(req)
-      const args = {
-        accessToken: req.user.accessToken,
-        accountId: req.session.accountId,
-        organizationId: req.session.organizationId
-      };
-
-      let productPermissionProfiles = await getProductPermissionProfiles(args);
-      let dsGroups = await getDSAdminGroups(args);
-
-      sourceFile = (path.basename(__filename))[5].toLowerCase() + (path.basename(__filename)).substr(6);
-      res.render("pages/admin-examples/eg002CreateCLMESignUser", {
-        eg: eg, csrfToken: req.csrfToken(),
-        title: "Create active user for CLM and eSignature",
-        clmPermissionProfiles: productPermissionProfiles.clmPermissionProfiles,
-        eSignPermissionProfiles: productPermissionProfiles.eSignPermissionProfiles,
-        dsGroups,
-        clmProductId: productPermissionProfiles.clmProductId,
-        eSignProductId: productPermissionProfiles.eSignProductId,
-        sourceFile: sourceFile,
-        sourceUrl: dsConfig.githubExampleUrl + 'admin/examples/' + sourceFile,
-        documentation: dsConfig.documentation + eg,
-        showDoc: dsConfig.documentation
-      });
-    }
-    catch (error) {
-      let errorBody = error && error.response && error.response.body
-        // we can pull the DocuSign error code and message from the response body
-        , errorCode = errorBody && errorBody.errorCode
-        , errorMessage = errorBody && errorBody.message
-        ;
-      // In production, may want to provide customized error messages and
-      // remediation advice to the user.
-      res.render("pages/error", { err: error, errorCode: errorCode, errorMessage: errorMessage });
-    }
-  } else {
+  let isTokenOK = req.dsAuth.checkToken();
+  if (!isTokenOK) {
     // Save the current operation so it will be resumed after authentication
     req.dsAuth.setEg(req, eg);
-    res.redirect(mustAuthenticate);
+    return res.redirect(mustAuthenticate);
+  }
+
+  try {
+    await getOrganizationId(req)
+    const args = {
+      accessToken: req.user.accessToken,
+      accountId: req.session.accountId,
+      organizationId: req.session.organizationId
+    };
+
+    let productPermissionProfiles = await getProductPermissionProfiles(args);
+    let dsGroups = await getDSAdminGroups(args);
+
+    const example = getExampleByNumber(res.locals.manifest, exampleNumber);
+    const sourceFile = (path.basename(__filename))[5].toLowerCase() + (path.basename(__filename)).substr(6);
+    res.render("pages/admin-examples/eg002CreateCLMESignUser", {
+      eg: eg, csrfToken: req.csrfToken(),
+      example: example,
+      clmPermissionProfiles: productPermissionProfiles.clmPermissionProfiles,
+      eSignPermissionProfiles: productPermissionProfiles.eSignPermissionProfiles,
+      dsGroups,
+      clmProductId: productPermissionProfiles.clmProductId,
+      eSignProductId: productPermissionProfiles.eSignProductId,
+      sourceFile: sourceFile,
+      sourceUrl: dsConfig.githubExampleUrl + 'admin/examples/' + sourceFile,
+      documentation: dsConfig.documentation + eg,
+      showDoc: dsConfig.documentation
+    });
+  } catch (error) {
+    let errorBody = error && error.response && error.response.body
+      // we can pull the DocuSign error code and message from the response body
+      , errorCode = errorBody && errorBody.errorCode
+      , errorMessage = errorBody && errorBody.message
+      ;
+    // In production, may want to provide customized error messages and
+    // remediation advice to the user.
+    res.render("pages/error", { err: error, errorCode: errorCode, errorMessage: errorMessage });
   }
 }