@suffolklitlab/alkiln 5.12.0-delete4 → 5.12.0-delete6

package/.github/workflows/github_server.yml

@@ -75,12 +75,14 @@ jobs:
         shell: bash
 
       #### Developer note: You can probably leave this out
-      - name: "Create a new normal user with an API key env var"
+      - name: "Add a low-level user and their API key (in an env var)"
         env:
           SERVER_URL: "${{ steps.github_server.outputs.SERVER_URL }}"
           KEY: ${{ steps.github_server.outputs.DOCASSEMBLE_DEVELOPER_API_KEY }}
         run: |
           # Create user and their API key
+
+          # Install json processor
           sudo apt-get install jq
 
           # https://docassemble.org/docs/api.html#user_new
@@ -98,7 +100,7 @@ jobs:
           user_id=$(echo "$user_data" | jq '.user_id' -r)
 
           # https://docassemble.org/docs/api.html#api_user_user_id_api_post
-          new_key=$(curl -X POST \
+          new_key_with_quotes=$(curl -X POST \
             ${{ env.SERVER_URL }}/api/user/"$user_id"/api \
             -H 'Content-Type: application/json' \
             -d '{
@@ -106,16 +108,18 @@ jobs:
               "name": "alkiln_key",
               "method": "none"
             }')
-          echo "User new key:"
-          echo "$new_key"
+          echo "new key (watch out, this contains actual quotation marks): $new_key_with_quotes"
+          no_end_quote="${new_key_with_quotes%\"}"
+          unquoted="${no_end_quote#\"}"
+          echo "unquoted: $unquoted"
 
-          echo "USER_NO_PERMISSIONS_API_KEY=$new_key" >> "$GITHUB_ENV"
+          echo "USER_NO_PERMISSIONS_API_KEY=$unquoted" >> "$GITHUB_ENV"
 
-      ### Developer note: You can probably leave this out
-      # Optional debugging to explore things like docker issues
-      - name: Docker debug tmate session
-        #if: ${{ failure() && github.event.inputs.enable_tmate == 'true' }}
-        uses: mxschmitt/action-tmate@v3
+      #### Developer note: You can probably leave this out
+      ## Optional debugging to explore things like docker issues
+      #- name: Docker debug tmate session
+      #  #if: ${{ failure() && github.event.inputs.enable_tmate == 'true' }}
+      #  uses: mxschmitt/action-tmate@v3
 
       #### Developer note: You can probably leave this out
       - name: "Create other env vars for our own tests from server output"

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: "${{ env.ALKILN_TAG_EXPRESSION }}"
+          ALKILN_TAG_EXPRESSION: "@del3"
           #### Developer note: You can probably leave this out
           ALKILN_VERSION: delete

package/CHANGELOG.md

@@ -58,6 +58,7 @@ Format:
 - 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.
 
 ## [5.12.0] - 2024-06-06
 

package/lib/docassemble/docassemble_api_interface.js

@@ -280,11 +280,10 @@ da_i.quietly_try_to_delete_interviews = async function ({ interviews = {}, api_k
       });
       responses.push( sub_responses );
     } else {
-      log.debug({ type: `da api info`, code: `ALK0191`, pre: `There is no interview to delete.` });
+      log.info({ type: `da api info`, code: `ALK0191`, pre: `There is no interview to delete.` });
     }
   }
   return responses;
-
 };  // Ends da_i.quietly_try_to_delete_interviews()
 
 // node -e 'require("./lib/docassemble/docassemble_api_interface.js").quietly_delete_one_interview(...)'
@@ -296,7 +295,7 @@ da_i.quietly_delete_one_interview = async function ( timeout, { interview = {},
   let responses = [];
   for ( let api_key of api_keys ) {
     try {
-      log.debug({ type: `da api info`, code: `ALK0188`,
+      log.info({ type: `da api info`, code: `ALK0188`,
         pre: `Trying to delete the interview with the id ${ interview.uid } and an API key.`
       });
 
@@ -307,13 +306,13 @@ da_i.quietly_delete_one_interview = async function ( timeout, { interview = {},
       });
       responses.push( response );
 
-      log.debug({ type: `da api info`, code: `ALK0189`,
+      log.info({ 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.debug({ type: `da api info`, code: `ALK0190`, pre: msg, data: error });
+      log.info({ type: `da api info`, code: `ALK0190`, pre: msg, data: error });
     }
   }  // ends for api keys
   return responses;
@@ -348,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.debug({ type: `da api info`, code: `ALK0192`, pre: `Trying to get the interview with the id ${ interview.uid } and an API key.` });
+        log.info({ 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, {
@@ -357,22 +356,21 @@ 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.debug({ type: `da api info`, code: `ALK0193`, pre: `Status ${ response.status }. Got ${ response.data.items[0].session }.`});
+          log.info({ type: `da api info`, code: `ALK0193`, pre: `Status ${ response.status }. Got ${ response.data.items[0].session }.`});
           return response.data.items[0];
         } else {
-          log.debug({ type: `da api info`, code: `ALK0194`, pre: `Status ${ response.status }. Cannot find ${ interview.uid }`});
+          log.info({ 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.debug({ type: `da api info`, code: `ALK0195`, pre: msg, data: error });
+        log.info({ type: `da api info`, code: `ALK0195`, pre: msg, data: error });
       }
     }  // ends for api_keys
   } else {
-    log.debug({ type: `da api info`, code: `ALK0196`, pre: `There is no interview to get.` });
+    log.info({ type: `da api info`, code: `ALK0196`, pre: `There is no interview to get.` });
   }
 
   return null;
-
 };  // Ends da_i.get_interview()

package/lib/scope.js

@@ -3327,6 +3327,4 @@ module.exports = {
     return none_included;
   },
 
-  // Test that all interviews have been deleted
-
 };

package/lib/steps.js

@@ -1481,7 +1481,7 @@ After(async function(scenario) {
       // going to the wrong file). If it becomes a problem we can track it down later.
       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`,
+        log.info({ type: `internal warning`, code: `ALK0197`,
           pre: `The API key can see ${ visible_keys.length } interviews that were not deleted: ${ visible_keys.join( ', ' ) }`
         });
       }
@@ -1493,7 +1493,7 @@ After(async function(scenario) {
       // interview. If it becomes a problem we can track it down later.
       // Consider add "internal" to docs: "If you see this, make an
       // issue in ALKiln with your debug/verbose log"
-      log.debug({ type: `internal warning`, code: `ALK0198`, pre: `Error while cleaning up interviews.`, data: error });
+      log.info({ type: `internal warning`, code: `ALK0198`, pre: `Error while cleaning up interviews.`, data: error });
     }
   }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@suffolklitlab/alkiln",
-  "version": "5.12.0-delete4",
+  "version": "5.12.0-delete6",
   "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="./docassemble" --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="ALKilnTests" --exclude-dir="node_modules" --exclude-dir='alkiln-*' --exclude-dir='_alkiln*' 'ALK[[:digit:]][[:digit:]][[:digit:]][[:digit:]]' "$directory")
 sorted=$(echo "$lines" | sort -n)