@suffolklitlab/alkiln 5.12.0-delete6 → 5.13.0

package/.github/workflows/log_code_tests.yml

@@ -24,6 +24,4 @@ jobs:
         with:
           node-version: ${{ matrix.node-version }}
       - run: npm install
-      - name: Docker debug tmate session
-        uses: mxschmitt/action-tmate@v3
       - run: npm run codes

package/.github/workflows/playground.yml

@@ -77,6 +77,6 @@ jobs:
           # Internal: docassemble changes sometimes break @a11y tests. That is
           # a da problem, not ours. We will trigger these tests manually when we
           # want to check up on this.
-          ALKILN_TAG_EXPRESSION: "@del3"
+          ALKILN_TAG_EXPRESSION: "${{ env.ALKILN_TAG_EXPRESSION }}"
           #### Developer note: You can probably leave this out
           ALKILN_VERSION: delete

package/CHANGELOG.md

@@ -43,7 +43,13 @@ Format:
 - 
 -->
 
-## [Unreleased]
+<!-- ## [Unreleased] -->
+
+## [5.13.0] - 2024-07-11
+
+## Added
+
+- Authors can now make sure that ALKiln deletes the interviews it creates for an ALKiln testing account. They can add a new (optional) value, an API key, to [the "sign in" Step](https://assemblyline.suffolklitlab.org/docs/alkiln/writing/#sign-in) and use the ["start interview" Step](https://assemblyline.suffolklitlab.org/docs/alkiln/writing/#start-interview) to go to the interview. The API key must belong to the user who signs in. Example: `Given I sign in with the email "<username env var>", the password "<password env var>", and the API key "<user API key>`. Admins can create an API key for a regular user with https://docassemble.org/docs/api.html#api_user_user_id_api_post. We will add this to the documentation for the "sign in" Step.
 
 ### Changed
 
@@ -51,14 +57,15 @@ Format:
 
 ### Fixed
 
-- 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).
+- 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 an API key to a regular user 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.
-- 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.
-- Excluded docassemble/ALKiln files from log code checks.
+- Tests deleting interviews upon interview completion for signed in users.
+- Switches to mostly using a lowest-access-level user account for actually running interviews.
+- Switches to adding our own `users[0]` question because of changes in Assembly Line.
+- Adds @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.
+- Excludes docassemble/ALKiln files from log code checks.
 
 ## [5.12.0] - 2024-06-06
 

package/lib/docassemble/docassemble_api_interface.js

@@ -232,7 +232,7 @@ da_i.get_api_key_access_status = async function ({ timeout = null, api_key = nul
     }  // ends try
   }  // ends auth_data.codes only has the first code
 
-  log.info({ type: `da api info`, code: `ALK0202`,
+  log.debug({ type: `da api info`, code: `ALK0202`,
     pre: `API key authentication info`, data: auth_data });
 
   return auth_data;
@@ -280,7 +280,7 @@ da_i.quietly_try_to_delete_interviews = async function ({ interviews = {}, api_k
       });
       responses.push( sub_responses );
     } else {
-      log.info({ type: `da api info`, code: `ALK0191`, pre: `There is no interview to delete.` });
+      log.debug({ type: `da api info`, code: `ALK0191`, pre: `There is no interview to delete.` });
     }
   }
   return responses;
@@ -295,7 +295,7 @@ da_i.quietly_delete_one_interview = async function ( timeout, { interview = {},
   let responses = [];
   for ( let api_key of api_keys ) {
     try {
-      log.info({ type: `da api info`, code: `ALK0188`,
+      log.debug({ type: `da api info`, code: `ALK0188`,
         pre: `Trying to delete the interview with the id ${ interview.uid } and an API key.`
       });
 
@@ -306,13 +306,13 @@ da_i.quietly_delete_one_interview = async function ( timeout, { interview = {},
       });
       responses.push( response );
 
-      log.info({ type: `da api info`, code: `ALK0189`,
+      log.debug({ type: `da api info`, code: `ALK0189`,
         pre: `No error when trying to delete interview ${ interview.uid } at ${ interview.i }.`
       });
     } catch ( error ) {
       error.interview = interview;
       let msg = `Error when deleting the interview. See https://docassemble.org/docs/api.html#session_delete.`
-      log.info({ type: `da api info`, code: `ALK0190`, pre: msg, data: error });
+      log.debug({ type: `da api info`, code: `ALK0190`, pre: msg, data: error });
     }
   }  // ends for api keys
   return responses;
@@ -347,7 +347,7 @@ da_i.get_interview = async function ({ interview = {}, api_keys = [], options =
   if ( interview && interview.uid ) {
     for ( let api_key of api_keys ) {
       try {
-        log.info({ type: `da api info`, code: `ALK0192`, pre: `Trying to get the interview with the id ${ interview.uid } and an API key.` });
+        log.debug({ type: `da api info`, code: `ALK0192`, pre: `Trying to get the interview with the id ${ interview.uid } and an API key.` });
 
         // Actual work:
         let response = await _da_REST.get_interview( timeout, {
@@ -356,20 +356,20 @@ da_i.get_interview = async function ({ interview = {}, api_keys = [], options =
         });
 
         if ( response && response.data && response.data.items && response.data.items[0] && response.data.items[0].session ) {
-          log.info({ type: `da api info`, code: `ALK0193`, pre: `Status ${ response.status }. Got ${ response.data.items[0].session }.`});
+          log.debug({ type: `da api info`, code: `ALK0193`, pre: `Status ${ response.status }. Got ${ response.data.items[0].session }.`});
           return response.data.items[0];
         } else {
-          log.info({ type: `da api info`, code: `ALK0194`, pre: `Status ${ response.status }. Cannot find ${ interview.uid }`});
+          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.`
-        log.info({ type: `da api info`, code: `ALK0195`, pre: msg, data: error });
+        log.debug({ type: `da api info`, code: `ALK0195`, pre: msg, data: error });
       }
     }  // ends for api_keys
   } else {
-    log.info({ type: `da api info`, code: `ALK0196`, pre: `There is no interview to get.` });
+    log.debug({ type: `da api info`, code: `ALK0196`, pre: `There is no interview to get.` });
   }
 
   return null;

package/package.json

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