@suffolklitlab/alkiln 4.11.6 → 5.0.0-experimental1

package/lib/utils/session_vars.js

@@ -23,9 +23,27 @@ module.exports = session_vars;
 // These default to null
 // TODO: How to isolate debug elsewhere so this file can use the logger?
 session_vars.get_debug = function () { return process.env.DEBUG || null; };
+session_vars.is_dev_env = function () { return process.env.DEV || null; }
+
 session_vars.get_dev_api_key = function () { return process.env.DOCASSEMBLE_DEVELOPER_API_KEY || null; };
 session_vars.get_repo_url = function () { return process.env.REPO_URL || null; };
-session_vars.is_dev_env = function () { return process.env.DEV || null; }
+
+session_vars.get_origin = function () {
+  /** The location from which the tests are being run. Possible
+  *    valid return values: 'playground', 'github', or 'local'.
+  *    Default is 'local' for ease of our own onboarding process.
+  */
+  return process.env._ORIGIN || 'local';
+};
+session_vars.get_user_project_name = function () { return process.env._PROJECT_NAME || null; };
+session_vars.get_user_id = function () { return process.env._USER_ID || null; };
+session_vars.get_tags = function () {
+  if ( process.env._TAGS ) {
+    return process.env._TAGS.split(` `);
+  } else {
+    return [];
+  }
+};
 
 // More complex logic
 session_vars.get_server_reload_timeout = function () {
@@ -130,7 +148,10 @@ session_vars.save_project_name = function ( project_name ) {
 };  // Ends save_project_name()
 
 session_vars.get_project_name = function () {
-  /* Get the name of the current docassemble Project  */
+  /* Get the name of the current docassemble Project */
+  if ( session_vars.get_origin() === 'playground' ) {
+    return session_vars.get_user_project_name();
+  }
   let json = JSON.parse( fs.readFileSync( runtime_config_path ));
   let project_name = json[ project_name_key ] || null;
   if ( session_vars.get_debug() ) { console.log( `ALKiln debug: Project name from file is "${ project_name }".` ); }
@@ -174,7 +195,7 @@ session_vars.save_artifacts_path_name = function ( path_name ) {
     console.log( `ALKiln debug: Stored name of artifacts directory "${ path_name }" locally.` );
   }
   return file;
-};  // Ends get_project_name()
+};  // Ends save_artifacts_path_name()
 
 session_vars.get_artifacts_path_name = function () {
   /* Get the name of the current artifacts path. */
@@ -187,48 +208,69 @@ session_vars.get_artifacts_path_name = function () {
   } catch ( error ) {
     return null;
   }
-};  // Ends get_project_name()
-
-/**
- * Ensure all required environment variables exist. Add each missing variable
- *    to an error that will be thrown at the end.
- * 
- * @throws ReferenceError with a message for all missing variables. 
- */
- session_vars.validateEnvironment = function() {
-  /** Throw a useful error for the developer if any of the required env vars
-  *    are missing. For most devs, these will be GitHub secrets. */
-
-  // Note: We are checking for BASE_URL, but we are referring it as SERVER_URL as that
-  // is the name used in GitHub secrets, which is what most devs will be using.
+};  // Ends get_artifacts_path_name()
 
+session_vars.validateEnvironment = function() {
+  /** Throw a useful error for the developer if any of the env vars
+  *    required by absolutely all tests are missing. Gather all
+  *    missing var names into one message to ease dev process.
+  * 
+  * Rational for doing it all in here:
+  * 1. Easier to test
+  * 2. Will avoid piecemeal errors in separate locations
+  * 
+  * TODO: Also validate format of variables?
+  * 
+  * @throws ReferenceError with a message for all missing variables. 
+  */
   let errorMessage = '';
 
-  // Since this code will most often be run in GitHub, I'm going to build a single error message that outlines all missing variables.  Otherwise, a developer
-  // will have to run their pipeline an incredible number of times to discover all the missing variables.
-  if ( !session_vars.get_dev_api_key() )
-  {
-    errorMessage += `\nThe DOCASSEMBLE_DEVELOPER_API_KEY GitHub secret must be defined. The DOCASSEMBLE_DEVELOPER_API_KEY is a docassemble API key you created for your server's testing account. It should have developer permissions.`
-  }
-  if ( !session_vars.get_da_server_url() )
-  {
+  // Env vars required for any tests
+  if ( !session_vars.get_da_server_url() ) {
     errorMessage += `\nThe SERVER_URL GitHub secret must be defined. The SERVER_URL is the URL of the Docassemble Server where the tests should be run.`;
   }
-  if ( !session_vars.get_repo_url() )
-  {
-    errorMessage += `\nThe REPO_URL GitHub secret must be defined. The REPO_URL is the URL to the Git repo whose Actions are being run.`;
-  }
-  // The branch name is always automatically defined in Github, it'll be missing only if you're running locally and missing an env var.
-  if ( !session_vars.get_branch_name() )
-  {
-    errorMessage += `\nThe BRANCH_NAME environment variable must be defined. The BRANCH_NAME is the name of the repository branch that should be pulled into the docassemble project.`;
-  }
+
+  let origin = session_vars.get_origin();
+  if ( origin !== 'github' && origin !== 'local' && origin !== 'playground' ) {
+    errorMessage += `\nThe _ORIGIN environment variable should be set to a valid value automatically. If you see this error, file an issue at https://github.com/suffolkLITLab/docassemble-ALKilnInThePlayground. It must be defined as either 'playground', 'github', or 'local', but its value was ${origin}`;
+
+  // If origin has one of the allowed values, we can do the rest of the validations
+  } else {
+
+    // Env vars required for github or local runs, as both create Projects
+    // in the Playground and pull the repo from GitHub
+    if ( origin === 'github' || origin === 'local' ) {
+      if ( !session_vars.get_dev_api_key() ) {
+        errorMessage += `\nThe DOCASSEMBLE_DEVELOPER_API_KEY GitHub secret must be defined. The DOCASSEMBLE_DEVELOPER_API_KEY is a docassemble API key you created for your server's testing account. It should have developer permissions.`
+      }
+      // Github automatically gives this, but may be missing locally.
+      if ( !session_vars.get_repo_url() ) {
+        errorMessage += `\nThe REPO_URL environment variable must be defined. The REPO_URL is the URL to the GitHub repo whose Actions are being run.`;
+      }
+      // Github automatically gives this, but may be missing locally.
+      if ( !session_vars.get_branch_name() ) {
+        errorMessage += `\nThe BRANCH_NAME environment variable must be defined. The BRANCH_NAME is the name of the repository branch that should be pulled into the docassemble project.`;
+      }
+    }  // ends github and local env vars
+
+    // We're the ones ensuring these exist for Playground runs
+    if ( origin === 'playground' ) {
+      if ( !session_vars.get_user_project_name() ) {
+        errorMessage += `\nThe _PROJECT_NAME environment variable should automatically exist. If you see this error, file an issue at https://github.com/suffolkLITLab/docassemble-ALKilnInThePlayground. It is the name of the Project the developer chose to test.`
+      }
+      if ( !session_vars.get_user_id() ) {
+        errorMessage += `\nThe _USER_ID environment variable should automatically exist. If you see this error, file an issue at https://github.com/suffolkLITLab/docassemble-ALKilnInThePlayground. It is the user ID of the developer on the server.`
+      }
+      // Tags are optional
+    }  // ends Playground env vars
+
+  }  // ends validation based on origin
 
   errorMessage = errorMessage.trim();
 
   if (errorMessage !== '') {
-    throw new ReferenceError(errorMessage);
+    throw new ReferenceError(`ALKiln error: ${errorMessage}`);
   }
 };
-  
+
 session_vars.validateEnvironment();