@suffolklitlab/alkiln 5.12.0-delete2 → 5.12.0-delete3

package/.github/workflows/github_server.yml

@@ -81,6 +81,11 @@ jobs:
         run: |
           echo "USER1_EMAIL=${{ steps.github_server.outputs.DA_ADMIN_EMAIL }}" >> $GITHUB_ENV
           echo "USER1_PASSWORD=${{ steps.github_server.outputs.DA_ADMIN_PASSWORD }}" >> $GITHUB_ENV
+          echo "USER_NO_PERMISSIONS_EMAIL=${{ steps.github_server.outputs.DA_ADMIN_EMAIL }}" >> $GITHUB_ENV
+          echo "USER_NO_PERMISSIONS_PASSWORD=${{ steps.github_server.outputs.DA_ADMIN_PASSWORD }}" >> $GITHUB_ENV
+          echo "USER_NO_PERMISSIONS_API_KEY=${{ steps.github_server.outputs.DOCASSEMBLE_DEVELOPER_API_KEY }}" >> $GITHUB_ENV
+          echo "INVALID_API_KEY=invalidAPIkey" >> $GITHUB_ENV
+          echo "EMPTY_STRING=''" >> $GITHUB_ENV
 
       #### Developer note:
       #### Example of working with the docker container after it's been

package/.github/workflows/playground.yml

@@ -43,6 +43,11 @@ jobs:
       PLAYGROUND_ID: ${{ secrets.PLAYGROUND_ID }}
       USER1_EMAIL: ${{ secrets.USER1_EMAIL }}
       USER1_PASSWORD: ${{ secrets.USER1_PASSWORD }}
+      USER_NO_PERMISSIONS_EMAIL: ${{ secrets.USER_NO_PERMISSIONS_EMAIL }}
+      USER_NO_PERMISSIONS_PASSWORD: ${{ secrets.USER_NO_PERMISSIONS_PASSWORD }}
+      USER_NO_PERMISSIONS_API_KEY: ${{ secrets.USER_NO_PERMISSIONS_API_KEY }}
+      INVALID_API_KEY: invalidAPIkey
+      EMPTY_STRING: ""
       SECRET_VAR1: secret-var1-value
       SECRET_VAR2: secret-var2-value
       SECRET_FOR_MISSING_FIELD: secret for missing field

package/CHANGELOG.md

@@ -51,11 +51,12 @@ Format:
 
 ### Fixed
 
-- Now delete interviews upon interview completion for signed in users
+- Now ALKiln deletes interviews upon interview completion for [signed in users](https://assemblyline.suffolklitlab.org/docs/alkiln/writing/#sign-in) as long as the user has an API key. Also, the author must have used the ["start interview" Step](https://assemblyline.suffolklitlab.org/docs/alkiln/writing/#start-interview) to get to the interview. Admins can give a regular user an API key with https://docassemble.org/docs/api.html#api_user_user_id_api_post. See [#831](https://github.com/SuffolkLITLab/ALKiln/issues/831).
 
 ### Internal
 
-- Test deleting interviews upon interview completion for signed in users
+- Test deleting interviews upon interview completion for signed in users.
+- Switch to mostly using a lowest-access-level user account for actually running interviews.
 - Added @temp_error to neutralize tests that are getting undesired errors right now, but which we anticipate being fixed soon. We want to ignore them for a short while. For example, an upstream change temporarily breaking some tests.
 
 ## [5.12.0] - 2024-06-06

package/lib/docassemble/docassemble_api_REST.js

@@ -31,6 +31,27 @@ da.get_dev_id = async function ( timeout ) {
 };  // Ends da.get_dev_id()
 
 
+da.get_api_key_info = async function ( timeout, { api_key = null, server_url = null }) {
+  /** Get information about an API key owned by the user of the given API key. */
+  let options = {
+    method: 'GET',
+    headers: {'X-API-Key': api_key},
+    url: `${ server_url }/api/user/api`,
+    params: {
+      api_key: api_key,
+    },
+    timeout: timeout,
+  };
+
+  try {
+    return await axios.request( options );
+  } catch (error) {
+    let response = error.response || { data: null }
+    throw {...error.toJSON(), data: response.data};
+  }
+};  // Ends da.get_api_key_info()
+
+
 // node -e 'require("./lib/docassemble/docassemble_api_REST.js").delete_project()'
 da.delete_project = async function ( timeout ) {
   /* Delete a project on the user's da server. */

package/lib/docassemble/docassemble_api_interface.js

@@ -177,6 +177,67 @@ da_i.get_dev_id = async function ( dev_id_options ) {
   return dev_id;
 };  // Ends da_i.get_dev_id();
 
+da_i.get_api_key_access_status = async function ({ timeout = null, api_key = null }) {
+  /** Check if the API key has minimal authorization on the server.
+  *    See https://docassemble.org/docs/api.html#api_user_api_get.
+  *
+  * @param options {obj} Options for getting authorization of the API key
+  * @param options.api_key {str | null} Required. The API key to test.
+  * @param options.timeout {int | null} Optional. Max MS
+  *    to allow for server request.
+  */
+
+  let auth_data = {
+    codes: [ 1 ],
+    has_auth: null,
+    messages: [`API key authorization is not yet determined.`],
+    error: null
+  }
+
+  // Skip this for tests run from ALKilnInThePlayground
+  if ( session_vars.get_origin() === 'playground' ) {
+    auth_data.codes.push( 2 );
+    auth_data.messages.push( `API keys are unnecessary for tests run in the Playground.` );
+  }
+
+  if ( typeof api_key !== `string` ) {
+    auth_data.codes.push( 3 );
+    auth_data.messages.push( `The given API key is not a string. Type: ${ typeof api_key }`);
+  }
+
+  if ( auth_data.codes.length === 1 ) {
+    // Default timeouts
+    timeout = timeout || DEFAULT_MAX_REQUEST_MS;
+    try {
+      let response = await _da_REST.get_api_key_info( timeout, {
+        api_key,
+        server_url: session_vars.get_da_server_url(),
+      });
+      auth_data.has_auth = true;
+      auth_data.codes = [ 6 ];
+      auth_data.messages = [ `This API key has at least basic authorization on this server.` ];
+
+    } catch ( error ) {
+      auth_data.error = error;
+      if ( error.status === 403 ) {
+        auth_data.has_auth = false;
+        auth_data.codes = [ 4 ];
+        auth_data.messages = [ `This API is unverified on this server. It is probably missing or has been deleted.` ];
+      } else {
+        // Note on 404, non-existent key: 404 == 403 - Since we're using the
+        // key itself to get its own info, if it doesn't exist, we'll get 403
+        auth_data.codes = [ 5 ];
+        auth_data.messages = [ `This API key threw a non-403 error.` ];
+      }  // ends error status
+    }  // ends try
+  }  // ends auth_data.codes only has the first code
+
+  log.debug({ type: `da api info`, code: `ALK0202`,
+    pre: `API key authentication info`, data: auth_data });
+
+  return auth_data;
+};  // Ends da_i.get_api_key_access_status()
+
 // 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. Do we need to watch
@@ -304,6 +365,7 @@ da_i.get_interview = async function ({ interview = {}, api_keys = [], options =
         } else {
           log.debug({ type: `da api info`, code: `ALK0194`, pre: `Status ${ response.status }. Cannot find ${ interview.uid }`});
         }
+
       } catch ( error ) {
         error.interview = interview;
         let msg = `${ error.status || `No error.status.` } ${ error.statusText || error.data || `No error.statusText.` } Ran into an error when getting the interview ${ interview.uid }. See https://docassemble.org/docs/api.html#interviews.`

package/lib/scope.js

@@ -16,7 +16,7 @@ const time = require('./utils/time');
 const log = require('./utils/log');
 const { waitForTimeout } = require('./utils/time');
 const files = require('./utils/files' );
-const server = require('./docassemble/docassemble_api_interface');
+const da_api = require('./docassemble/docassemble_api_interface');
 const wrapPromiseWithTimeout = require('./cucumber_8_shim');
 const reports = require(`./utils/reports`);
 
@@ -339,7 +339,7 @@ module.exports = {
       // This code assumes a reasonable response time would be n seconds if the
       // server is up and that a server reload/restart won't take less than n seconds.
       // Also, it's non-blocking, so it doesn't slow down tests
-      let is_up = await server.is_server_responding({ timeout: scope.server_check_interval_ms });
+      let is_up = await da_api.is_server_responding({ timeout: scope.server_check_interval_ms });
       // Add status to the beginning of the list to make truncating easier
       scope.server_statuses.unshift( is_up );
 
@@ -2996,10 +2996,20 @@ module.exports = {
       // Save API key to clean up interviews later. Nice to have, not critical
       if ( api_key_secret_name ) {
         let api_key = process.env[ api_key_secret_name ];
-        let api_key_msg = `The api_key GitHub SECRET "${ api_key_secret_name }" doesn't exist. Check for a typo and check your workflow file.`
+        let api_key_msg = `The API key called "${ api_key_secret_name }" is missing. Check for a typo in your test, workflow file, GitHub secret, or server config.`
         if ( api_key === undefined ) {
           reports.addToReport( scope, { type: `warning`, code: `ALK0199`, value: api_key_msg });
+        } else if ( api_key === `` ) {
+          reports.addToReport( scope, { type: `warning`, code: `ALK0200`,
+            value: `ALKiln found the API key called "${ api_key_secret_name }", but it was empty. It had no text in it. Edit the value of the GitHub secret or server config variable called "${ api_key_secret_name }".` });
         } else {
+          let access_info = await da_api.get_api_key_access_status({ api_key });
+          if ( !access_info.has_auth ) {
+          reports.addToReport( scope, { type: `warning`, code: `ALK0201`,
+            value: `The server rejected the API key called "${ api_key_secret_name }". Does it exist on this server? Was it deleted somehow? You can always make a new one.` });
+          }
+          // Even if it doesn't have access, give it a shot anyway.
+          // Maybe we got something wrong.
           scope.scenarios.get( scope.scenario_id ).api_keys.push( api_key );
         }
       }

package/lib/steps.js

@@ -286,14 +286,14 @@ Given(
   { timeout: -1 },
   async ( email, password, api_key ) => {
   /** Uses the names of environment variables (most often GitHub SECRETs) to
-  *     log into an account on the user's server. Must be SECRETs to stay secure.
+  *     log into an account on the user's server. Must be secure.
   * 
   * Variations:
-  * I sign into the server with the email "USER1_EMAIL" and the password "USER1_PASSWORD" SECRETs
-  * I sign on with the email "USER1_EMAIL" and the password "USER1_PASSWORD" SECRETs
-  * I log in with "USER1_EMAIL" and "USER1_PASSWORD"
-  * I sign in with the email "USER1_EMAIL", the password "USER1_PASSWORD", and the API key "USER1_API_KEY"
-  * I sign in with "USER1_EMAIL", "USER1_PASSWORD", "USER1_API_KEY"
+  * I sign into the server with the email "USER2_EMAIL" and the password "USER2_PASSWORD"
+  * I sign on with the email "USER2_EMAIL" and the password "USER2_PASSWORD"
+  * I log in with "USER2_EMAIL" and "USER2_PASSWORD"
+  * I sign in with the email "USER2_EMAIL", the password "USER2_PASSWORD", and the API key "USER2_API_KEY"
+  * I sign in with "USER2_EMAIL", "USER2_PASSWORD", "USER2_API_KEY"
   */
   // `page` timeout will deal with custom timeout
   // Couldn't test the timeout for tapping the button because there's not
@@ -1205,11 +1205,11 @@ Then(/of two interviews, I delete one __internal__/i, async () => {
 
   // Check that both interviews exist on the server. 1 √ 2 √
   let api_keys = scope.scenarios.get( scope.scenario_id ).api_keys;
-  let existing_interviews = await da_api.get_interviews({ interviews, api_keys });
-  let existing_keys = Object.keys( existing_interviews );
+  let visible_interviews = await da_api.get_interviews({ interviews, api_keys });
+  let visible_keys = Object.keys( visible_interviews );
   expect(
-    existing_keys.length,
-    `2 interviews should be on the server. Instead: "${ existing_keys.join(', ') }"`
+    visible_keys.length,
+    `2 interviews should be on the server. Instead: "${ visible_keys.join(', ') }"`
   ).to.equal( 2 );
 
   // Delete one. 1 x 2 √
@@ -1233,24 +1233,23 @@ Then(/of two interviews, I delete one __internal__/i, async () => {
   // In After(), the other session should get deleted
 });
 
-Then(/as an anonymous user, I fail to delete an interview and get no error __internal__/i, async () => {
-  /** Test that an interview passes even when unable to delete an interview.
-   *    An API test
-   */
+Then(/I fail to delete (\d) detected interview(?:s)? and get no error __internal__/i, async ( num ) => {
+  /** Test that there is no error when ALKiln is unable to delete an interview. */
+  num = parseInt( num );
   // Make sure we started an interview
   let interviews = scope.scenarios.get( scope.scenario_id ).interviews;
   expect(
     Object.keys( interviews ).length,
-    `The test should have saved one interview session`
-  ).to.equal( 1 );
+    `The test should have saved ${ num } interview session(s)`
+  ).to.equal( num );
 
   // There should be no error about an unauthorized user
   let api_keys = scope.scenarios.get( scope.scenario_id ).api_keys;
-  let existing_interviews = await da_api.get_interviews({ interviews, api_keys });
-  let existing_keys = Object.keys( existing_interviews );
+  let visible_interviews = await da_api.get_interviews({ interviews, api_keys });
+  let visible_keys = Object.keys( visible_interviews );
   expect(
-    existing_keys.length,
-    `Anonymous user should detect 0 interviews on the server. Instead: "${ existing_keys.join(', ') }"`
+    visible_keys.length,
+    `User should detect 0 interviews on the server. Instead: "${ visible_keys.join(', ') }"`
   ).to.equal( 0 );
 
   // Deleting with an anonymous user should fail silently
@@ -1475,14 +1474,15 @@ After(async function(scenario) {
       let interviews = scope.scenarios.get( scope.scenario_id ).interviews;
       let api_keys = scope.scenarios.get( scope.scenario_id ).api_keys;
       await da_api.quietly_try_to_delete_interviews({ interviews, api_keys });
-      let existing_interviews = await da_api.get_interviews({ interviews, api_keys });
-      let existing_keys = Object.keys( existing_interviews );
+      let visible_interviews = await da_api.get_interviews({ interviews, api_keys });
+      let visible_keys = Object.keys( visible_interviews );
       // Deleting interviews is nice, but not non-critical. Don't bother the
       // user with it. Don't want to cover up a more meaningful failure (like
       // going to the wrong file). If it becomes a problem we can track it down later.
-      if ( existing_keys.length > 0 ) {
+      if ( visible_keys.length > 0 ) {
+        // Can an API key ever see an interview that it can't delete?
         log.debug({ type: `internal warning`, code: `ALK0197`,
-          pre: `${ existing_keys.length } interviews were not deleted: ${ existing_keys.join( ', ' ) }`
+          pre: `The API key can see ${ visible_keys.length } interviews that were not deleted: ${ visible_keys.join( ', ' ) }`
         });
       }
     } catch ( error ) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@suffolklitlab/alkiln",
-  "version": "5.12.0-delete2",
+  "version": "5.12.0-delete3",
   "description": "Integrated automated end-to-end testing with docassemble, puppeteer, and cucumber.",
   "main": "lib/index.js",
   "scripts": {

package/tests/log_codes/check_codes.sh

@@ -16,7 +16,7 @@ fi
 # The grepped files will include the list of all the codes that have been
 # removed and are no longer used. Syntax used works with GitHub cli ([[:digit:]])
 # https://stackoverflow.com/a/6901221
-lines=$(grep -roh --exclude="tests/log_codes/check_codes.sh" --exclude="debug_log.txt" --exclude="cucumber-report.txt" --exclude-dir="node_modules" --exclude-dir='alkiln-*' --exclude-dir='_alkiln*' 'ALK[[:digit:]][[:digit:]][[:digit:]][[:digit:]]' "$directory")
+lines=$(grep -roh --exclude="tests/log_codes/check_codes.sh" --exclude="debug_log.txt" --exclude="cucumber-report.txt" --exclude-dir="./docassemble" --exclude-dir="node_modules" --exclude-dir='alkiln-*' --exclude-dir='_alkiln*' 'ALK[[:digit:]][[:digit:]][[:digit:]][[:digit:]]' "$directory")
 sorted=$(echo "$lines" | sort -n)