@suffolklitlab/alkiln 5.6.0 → 5.7.0-feature-tap1

package/lib/docassemble/docassemble_api_interface.js

@@ -12,7 +12,7 @@ const time = require('../utils/time');
 //    do it before trying to load a page.
 
 // TODO: How can we test busy server stuff properly? Especially down
-// to specific functions, like `.pull()` which run in a very small
+// to specific functions, which can run in a very small
 // window.
 
 /** Notes:
@@ -171,287 +171,10 @@ da_i.get_dev_id = async function ( dev_id_options ) {
   return dev_id;
 };  // Ends da_i.get_dev_id();
 
-
-// node -e 'require("./lib/docassemble/docassemble_api_interface.js").validate_api_key()'
-da_i.validate_api_key = async function ( api_key_options ) {
-  /** Make sure the api key is the right one for this server.
-  *   See https://docassemble.org/docs/api.html#user. */
-
-  log.info({ pre: `Checking the testing account's API key.` });
-
-  // Default timeouts
-  api_key_options = api_key_options ||  { timeout: DEFAULT_MAX_REQUEST_MS };
-
-  try {
-
-    // There's only one possible success result
-    // As long as this succeeds, we're good
-    await _da_REST.get_dev_id( api_key_options.timeout );
-    log.info({ pre: `Your testing account's API key is perfectly valid on this server.` });
-    return true;
-
-  } catch ( error ) {
-    // There's only one possible sever response error
-    if ( error.response && error.response.status === 403 ) {
-      // Throw in here, or at the caller?
-      log.error({
-        pre: `The API key in the GitHub secret DOCASSEMBLE_DEVELOPER_API_KEY `
-        + `failed on this server with "Access Denied". Are you sure your `
-        + `DOCASSEMBLE_DEVELOPER_API_KEY secret is set to the API key for `
-        + `the docassemble account that runs the tests on this server? `
-        + `Are you sure your SERVER_URL GitHub secret is set to the server `
-        + `address on which this testing account exists?`
-        + `To update your GitHub secrets, either set this repository's `
-        + `secrets at ${ session_vars.get_repo_url() }/settings/secrets `
-        + `or ask your GitHub organization admin to set the `
-        + `organization's secrets.`
-      });
-    }  // ends 403 message
-    throw error;
-  }  // ends try to get dev_id
-};  // Ends da_i.validate_api_key()
-
-
-// node -e 'require("./lib/docassemble/docassemble_api_interface.js").loop_to_create_project()'
-da_i.loop_to_create_project = async function( creation_options ) {
-  /** Create a docassemble Project on the docassemble server's account.
-  *    Loop through potential project names until we find one that
-  *    isn't already taken and then use that name to create the Project. */
-
-  // Defaults
-  creation_options = creation_options || {};
-  let timeout = creation_options.timeout || DEFAULT_MAX_REQUEST_MS;
-  let max_tries = creation_options.max_tries || 15;
-  let wait_seconds = creation_options.wait_seconds || 5;
-
-  let project_name = null;
-  // Unlikely, but 2 devs could run locally and create the same Project name
-  let num_tries = 0;
-
-  // Try to create a project. If the project name is already taken, increment and loop again.
-  while ( num_tries <= max_tries ) {
-    num_tries++;
-    try {
-
-      // Try next name that could be unique. Must remove all non-valid characters
-      // TODO: This sanitization is already done in session_vars, so remove it from here
-      project_name = session_vars.get_project_base_name().replace(/[^A-Za-z0-9]/g, '') + `${Date.now()}`;
-      log.info({ pre: `Trying to create a docassemble Project with the name ${ project_name }` });
-      let response = await _da_REST.create_project( project_name, timeout );
-      log.info({ pre: `The docassemble server is ready. Created a Project named ${ project_name }` });
-      // If succeeded in creating project, return the name that worked
-      return project_name;
-
-    } catch ( error ) {
-      // TODO: Make a `normalize_ajax_responses_and_errors()`?
-      let response = error;
-
-      if ( response && response.data ) {
-        if ( response.data.includes( `Invalid project` ) ) {
-          if ( num_tries < max_tries ) {
-            // A non-unique project name. Try the next project name.
-            continue;
-
-          } else {
-            // On the last loop, failed because there were too many project
-            // names already taken
-            log.error({
-              pre: `There were already ${ max_tries } projects with the base `
-              + `name ${ session_vars.get_project_base_name() }. If you need to allow `
-              + `more, file an issue at https://github.com/SuffolkLITLab/ALKiln/issues.`
-            });
-            throw( error );
-          }
-
-        // ends "Invalid project" error
-        } else {
-          // Other response errors should be thrown with link to docs
-          log.error({
-            type: `docassemble ${ response.status } "${ response.data }"`,
-            pre: `See https://docassemble.org/docs/api.html#playground_post_project.`
-          });
-          throw ( error );
-        }
-      } else { // for if error.response
-
-        // If it's a timeout error, server is busy. Try again after waiting.
-        // Why are we using `max_tries` for timeout error as well?
-        if ( is_timeout_error( error ) && num_tries < max_tries ) {
-          log.info({ pre: `The docassemble server was busy when we tried to `
-            + `create the Project. Attempt ${ num_tries } of `
-            + `${ max_tries }. Will try again in ${ wait_seconds } seconds.` });
-          num_tries--;  // Don't count this try
-          await time.waitForTimeout( wait_seconds * 1000 );
-          continue;
-
-        // A non-timeout, non-server error should just be thrown
-        } else {
-          log.error({ pre: `Ran into unexpected error when trying to create the Project.` });
-          throw error;
-
-        }  // ends type of non-response error
-      }  // ends type of response error
-    }  // ends try
-  }  // ends while
-};  // Ends da_i.loop_to_create_project()
-
-
-// node -e 'require("./lib/docassemble/docassemble_api_interface.js").pull()'
-da_i.pull = async function ( pull_options ) {
-  /** Pull github code into an existing Project. */
-
-  log.info({ pre: `Trying to pull code from the "${ session_vars.get_branch_name() }" branch.` });
-
-  // Default timeouts
-  let { timeout } = pull_options ||  { timeout: DEFAULT_MAX_REQUEST_MS };
-
-  try {
-
-    let response = await _da_REST.pull( timeout );
-
-    // If server didn't need to restart
-    if ( response && response.status === 204 ) {
-      log.info({ pre: `Your Docassemble server finished pulling the package's code.` });
-      return null;
-    }
-
-    // If server needed to restart because of the pulled code
-    if ( response && response.status === 200 ) {
-      log.debug({ pre: `Pull task id: ${ response.data.task_id }` });
-      return response.data.task_id;
-    }
-
-  } catch ( error ) {
-    // Pulling should not error
-    log.error({ pre: `Pulling into the docassemble Project ran into an unexpected error.` });
-    log.debug({ pre: `See https://docassemble.org/docs/api.html#playground_pull.` });
-    throw error;
-  }
-};  // Ends da_i.pull()
-
-// node -e 'require("./lib/docassemble/docassemble_api_interface.js").has_task_finished()'
-da_i.has_task_finished = async function ( api_endpoint, task_id, options ) {
-  /** Check task status if it exists. If not, return true as task did
-  *    not require a server restart. See da_i.pull().
-  *    See https://docassemble.org/docs/api.html#restart_status. */
-
-  // Defaults
-  let { timeout } = options ||  { timeout: DEFAULT_MAX_REQUEST_MS };
-
-  try {
-
-    // If server did need to restart, check if it's done.
-    let response = await _da_REST.has_task_finished( api_endpoint, task_id, timeout );
-    log.debug({ pre: `Task status: ${ response.status }. Docassemble status text: ${ response.data.status }. Task id: ${ task_id }` });
-    
-    if ( response.data.status === 'completed' ) {
-      return true;
-    
-    } else if ( response.data.status === 'working' ) {
-      log.info({ pre: `The docassemble server is uploading the package.` });
-      return false;
-
-    } else if ( response.data.status === 'unknown' ) {
-      // Server is working, but status 'unknown'? Bad design, but this
-      // does get returned when install packages, so return true
-      log.info({
-        pre: `\`task_id\` "${ task_id }" has expired. If it's been `
-          + `less than 1 hour since the task started, the task is `
-          + `complete. See https://docassemble.org/docs/api.html#restart_status.`,
-        data: response.data,
-      });
-      return true;
-    }  // ends status type
-
-  } catch ( error ) {
-    // Timeout means the server is busy.
-    if ( is_timeout_error( error ) ) {
-      log.info({ pre: `The docassemble server is still uploading the package.` });
-      return false;
-    }
-
-    log.error({ pre: `Tried to check that the package was uploaded, but ran into an unexpected error.` });
-    throw error;
-  }  // ends try to check for server done restarting
-
-};  // Ends da_i.has_task_finished()
-
-da_i.wait_for_playground_to_restart = async ( task_id, options ) => {
-  return await da_i.wait_for_server_to_restart( "/api/restart_status", task_id, options );
-};
-
-da_i.wait_for_package_to_restart = async ( task_id, options ) => {
-  return await da_i.wait_for_server_to_restart( "/api/package_update_status", task_id, options );
-};
-
-da_i.wait_for_server_to_restart = async ( api_endpoint, task_id, options ) => {
-  /** Wait for the server to finish restarting in case a module needs to load.
-  *     This is a polling function because things may be returned
-  *     that aren't equivalent to the server being done with a task. */
-  log.info({ pre: `Docassemble is pulling this package. The task_id is `
-    + `"${ task_id }". A task_id is usually created for a package `
-    + `with a module. It can take a few minutes to finish uploading.` });
-
-  // Base default
-  options = options || {};
-  // Default timeout
-  let timeout = options.timeout || DEFAULT_MAX_REQUEST_MS;
-  // Other defaults
-  let default_wait_between_loops = 4 * 1000;
-  let default_wait_for_response = 1 * 1000;
-  let default_max_loops = timeout/( default_wait_between_loops + default_wait_for_response );
-  // Actual values
-  let wait_between_loops = options.wait_between_loops || default_wait_between_loops;
-  let wait_for_response = options.wait_for_response || default_wait_for_response;
-  let max_loops = options.max_loops || default_max_loops;
-
-  // Flags for stopping the `while` loop
-  let num_tries = 0;
-  let done_restarting = false;
-
-  // Why loop instead of one long timeout? Because it might not just hang.
-  // We might get a return value that's just `waiting`, meaning the
-  // task is not done.
-  while ( !done_restarting && num_tries <= max_loops ) {
-    num_tries++;
-    // Wait only a short time for the task to finish, not the full default timeout
-    done_restarting = await da_i.has_task_finished( api_endpoint, task_id, { timeout: wait_for_response } );
-    if ( !done_restarting ) {
-      if ( num_tries < max_loops ) {
-        // Show a slightly different message after a number of tries to reassure
-        // users we're still paying attention
-        let msg_start = `Not yet complete`;
-        if ( num_tries > 3 ) { msg_start = `Still not complete`; }
-
-        // When the server is busy, the task timeout causes this loop to actually
-        // take 5 seconds to complete, but this only waits for 4. I'm not sure how
-        // to make that clear
-        log.info({ pre: `${ msg_start }. Check ${ num_tries } of ${ max_loops }. `
-          + `Will check again in ${( wait_between_loops + wait_for_response )/1000 } seconds.`
-        });
-        await time.waitForTimeout( wait_between_loops );
-
-      } else {
-        // This is our last round, let's wrap it up
-        let server_msg = `ALKiln setup: It seems like the docassemble server `
-          + `didn't finish uploading the code after ${ timeout/1000 } `
-          + `seconds. Some things you can try: check your server is up, try `
-          + `re-running the test, and try pulling the package manually `
-          + `into the playground.`;
-          // Add link to docs once the docs are more comprehensive
-        throw( server_msg );
-      }  // ends if ran out of tries
-    }  // ends if done_restarting
-  }  // ends while not done restarting
-
-  log.info({ pre: `The docassemble server has uploaded your package.` });
-};  // Ends da_i.wait_for_server_to_restart()
-
-
-// Delete the Project
 // node -e 'require("./lib/docassemble/docassemble_api_interface.js").delete_project( "create1" )'
 da_i.delete_project = async function ( delete_options ) {
-  /** Delete a project on the user's da server. */
+  /** Delete a project on the user's da server. Do we need to watch
+  *   for a timeout? */
 
   // Defaults
   let { timeout } = delete_options ||  { timeout: DEFAULT_MAX_REQUEST_MS };

package/lib/docassemble/server_install.js

@@ -7,6 +7,7 @@ const fg = require('fast-glob');
 const server_install = async () => {
   session_vars.save_install_method(`server`);
 
+  // Get path to folders inside repo main "docassemble" folder
   let current_dir = process.cwd();
   let path = `${ current_dir }/docassemble/*`;
   let dirs = fg.sync(
@@ -19,6 +20,7 @@ const server_install = async () => {
 
   let folders = dirs.map(function (dir) { return dir.split('/').pop(); })
 
+  // Get names of all folders in repo "docassemble" folder
   let chosen_folder = folders[0];
   if ( folders.length === 0 ) {
     let msg = `There are 0 folders at ${path}. Tests won't run.`;

package/lib/docassemble/setup.js

@@ -1,50 +1,60 @@
 #!/usr/bin/env node
 
-const da_i = require('./docassemble_api_interface');
-const log = require('../utils/log');
-const session_vars = require('../utils/session_vars' );
-const files = require('../utils/files' );
+// TODO: Rename to playground_install?
 
+const child_process = require(`child_process`);
+
+const log = require(`../utils/log`);
+const session_vars = require(`../utils/session_vars` );
 
 const setup = async () => {
-  /* In the docassemble testing account identified by the
+  /** In the docassemble testing account identified by the
   *   DOCASSEMBLE_DEVELOPER_API_KEY secret, create a new Project,
   *   pull code into that project, and, if needed, wait for the
-  *   server to restart. */
-  log.info({ type: `setup`, pre: `Starting to upload this package to `
-    + `a new Project in the server's testing account.` });
-
-  // Check that API key is valid. Will error if it is invalid.
-  // Should the error be thrown here?
-  await da_i.validate_api_key();
-
-  // Create a project on the da server's account with a unique name then
-  // store it locally for later deleting the project. 
-  let project_name = null;
-  // Explicit try-catch prevents "Unhandled promise rejection error"
-  // avoids showing confusing node errors to users that they shouldn't have to fix
-  try {
-    project_name = await da_i.loop_to_create_project();
-    log.info({type: `setup`, pre: `Created a Project named ${ project_name }`});
-  } catch (error) {
-    log.error({type: `setup`, pre: `an unexpected error occurred while trying to create a docassemble project in the user's account`, data: JSON.stringify(error, null, 4)})
-    // we don't re-throw the exception, so make sure to exit with 1 to let Github Actions know the script failed
-    process.exitCode = 1;
-    return;
-  }
-  // Once the name is created, save that name to a local file.
+  *   server to reload.
+  */
+  
+  // Make and save project name
+  let project_name = session_vars.get_project_base_name().replace(/[^A-Za-z0-9]/g, '') + `${Date.now()}`;
   session_vars.save_project_name( project_name );
 
-  // Pull code and wait for server restart to finish if needed
-  let task_id = await da_i.pull();
-  // Task id will be null if server did not need to restart
-  if ( task_id ) {
-    await da_i.wait_for_playground_to_restart( task_id );
+  log.info({ type: `setup`, pre: `Starting to upload this package to `
+    + `a new Project called ${project_name} in the Playground `
+    + `of your server's testing account. It may take a couple of minutes.` });
+
+  // dainstall . --apiurl https://site.org --apikey $API_KEY --playground --project=name
+  // I think this won't run on windows? Why do I think this? Where on the
+  // internet did I find this. Some command here or in dainstall doesn't
+  // work on windows.
+  let result = child_process.spawnSync(
+    `dainstall`,
+    [
+      `.`, `--apiurl`, session_vars.get_da_server_url(),
+      `--apikey`, session_vars.get_dev_api_key(),  // validates api key
+      `--playground`, `--project=${ project_name }`
+    ],
+    // Prints messages from the process to the console while it's running
+    { stdio: 'inherit', }
+  );
+
+  // 403 is invalid API key, but I'm not sure how to output
+  // the response to find out the error code
+
+  if ( result.status !== 0 ) {
+    log.error({
+      type: `setup`,
+      pre: `Status code ${ result.status }. Could not dainstall this package on your server. See above for more details.`
+    });
+    throw(result.stderr);
   }
 
-  // Finish
-  log.info({ type: `setup`, pre: `Success! Test setup has finished successfully.` });
+  log.info({
+    type: `setup`,
+    pre: `Success! ALKiln created a Project in your Playground named "${ project_name }"` 
+  });
 };  // Ends setup();
 
 
+// Before everything, make sure all the required env vars exist
+session_vars.validateEnvironment();
 setup();