@suffolklitlab/alkiln 5.12.0-delete3 → 5.12.0-delete5

package/.github/workflows/github_server.yml

@@ -43,18 +43,22 @@ jobs:
     #### Developer note: You can probably leave out these specific
     #### environment variables. You may not even need the `env`
     #### keyword or values at all. See
-    #### https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/alkiln/writing#env-vars
+    #### https://assemblyline.suffolklitlab.org/docs/alkiln/writing#env-vars
     env:
       SECRET_VAR1: secret-var1-value
       SECRET_VAR2: secret-var2-value
       SECRET_FOR_MISSING_FIELD: secret for missing field
+      INVALID_API_KEY: invalidAPIkey
+      EMPTY_STRING: ""
+      USER_NO_PERMISSIONS_EMAIL: alkiln@example.com
+      USER_NO_PERMISSIONS_PASSWORD: User123^
       
     steps:
       # Place the root directory in this branch to access
       # relative paths to action files
       - uses: actions/checkout@v4
 
-      - name: ALKiln - Start the isolated temporary docassemble server on GitHub
+      - name: "ALKiln - Start the isolated temporary docassemble server on GitHub"
         id: github_server
         #### Developer note: you'll need to replace `uses: ./action_for_github_server`
         #### with the path to ALKiln’s repository name and branch name. For example,
@@ -71,21 +75,53 @@ jobs:
         shell: bash
 
       #### 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
+      - name: "Create a new normal user with an API key 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
+          sudo apt-get install jq
+
+          # https://docassemble.org/docs/api.html#user_new
+          user_data=$(curl -X POST \
+            ${{ env.SERVER_URL }}/api/user/new \
+            -H 'Content-Type: application/json' \
+            -d '{
+              "key": "${{ env.KEY }}",
+              "username": "${{ env.USER_NO_PERMISSIONS_EMAIL }}",
+              "password": "${{ env.USER_NO_PERMISSIONS_PASSWORD }}"
+            }')
+          echo "User data:"
+          echo "$user_data"
+
+          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 \
+            ${{ env.SERVER_URL }}/api/user/"$user_id"/api \
+            -H 'Content-Type: application/json' \
+            -d '{
+              "key": "${{ env.KEY }}",
+              "name": "alkiln_key",
+              "method": "none"
+            }')
+          echo "User new key:"
+          echo "$new_key"
+
+          echo "USER_NO_PERMISSIONS_API_KEY=$new_key" >> "$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
-      - name: Run ALKiln - Env vars for our own tests from server output
+      - name: "Create other env vars for our own tests from server output"
         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
@@ -111,12 +147,12 @@ jobs:
           ALKILN_TAG_EXPRESSION: "${{ (github.event.inputs.tags && format('{0}', github.event.inputs.tags)) || '(not @error) and (not @temp_error)' }}"
         with:
           #### Developer note: Required inputs. See
-          #### https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/alkiln/writing/#sandbox-inputs
+          #### https://assemblyline.suffolklitlab.org/docs/alkiln/writing/#sandbox-inputs
           SERVER_URL: "${{ steps.github_server.outputs.SERVER_URL }}"
           DOCASSEMBLE_DEVELOPER_API_KEY: "${{ steps.github_server.outputs.DOCASSEMBLE_DEVELOPER_API_KEY }}"
           INSTALL_METHOD: "server"
           #### Developer note: You can probably leave the rest out
-          #### To learn more, see https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/alkiln/writing/#optional-inputs
+          #### To learn more, see https://assemblyline.suffolklitlab.org/docs/alkiln/writing/#optional-inputs
           ALKILN_TAG_EXPRESSION: "${{ env.ALKILN_TAG_EXPRESSION }}"
           ALKILN_VERSION: delete
 

package/.github/workflows/log_code_tests.yml

@@ -24,4 +24,6 @@ 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

@@ -69,10 +69,10 @@ jobs:
           ALKILN_TAG_EXPRESSION: "${{ (github.event.inputs.tags && format('{0}', github.event.inputs.tags)) || '(not @error) and (not @temp_error)' }}"
         with:
           #### Developer note: Required ALKiln inputs. You can read more at
-          #### https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/alkiln/writing/#githubNyou-inputs
+          #### https://assemblyline.suffolklitlab.org/docs/alkiln/writing/#githubNyou-inputs
           SERVER_URL: "${{ env.SERVER_URL }}"
           DOCASSEMBLE_DEVELOPER_API_KEY: "${{ env.DOCASSEMBLE_DEVELOPER_API_KEY }}"
-          #### Developer note: See https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/alkiln/writing/#optional-inputs
+          #### Developer note: See https://assemblyline.suffolklitlab.org/docs/alkiln/writing/#optional-inputs
           #### You can probably leave this out
           # Internal: docassemble changes sometimes break @a11y tests. That is
           # a da problem, not ours. We will trigger these tests manually when we

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.debug({ type: `da api info`, code: `ALK0202`,
+  log.info({ type: `da api info`, code: `ALK0202`,
     pre: `API key authentication info`, data: auth_data });
 
   return auth_data;
@@ -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(...)'
@@ -292,11 +291,11 @@ da_i.quietly_delete_one_interview = async function ( timeout, { interview = {},
   /** Try to delete an interview using all available API keys. Fail silently.
    *    Example failure: the test did not log in any users and the testing
    *    account's role prevents access to other user's interviews. */
-  api_keys = normalize_api_keys( api_keys );
+
   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;
@@ -324,8 +323,6 @@ da_i.get_interviews = async function ({ interviews = {}, api_keys = [], options
   /** Return an object of interviews that exist on the server
    *    that match the given interviews. Keys are the session ids. */
 
-  api_keys = normalize_api_keys( api_keys );
-
   let fetched_interviews = {};
   if ( interviews ) {
     for ( let id in interviews ) {
@@ -346,12 +343,11 @@ da_i.get_interview = async function ({ interview = {}, api_keys = [], options =
 
   // Defaults
   let { timeout } = options || { timeout: DEFAULT_MAX_REQUEST_MS };
-  api_keys = normalize_api_keys( api_keys );
 
   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, {
@@ -360,30 +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()
-
-let normalize_api_keys = function ( api_keys = [] ) {
-  /** Ensure the dev API key is in the api_keys list. */
-  let dev_key = session_vars.get_dev_api_key();
-  if ( !api_keys ) { api_keys = [ dev_key ]; }
-  if ( !api_keys.includes( dev_key ) ) { api_keys.unshift( dev_key ); }
-  return api_keys;
-};

package/lib/scope.js

@@ -2996,17 +2996,17 @@ 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 called "${ api_key_secret_name }" is missing. Check for a typo in your test, workflow file, GitHub secret, or server config.`
+        let api_key_msg = `The API key in the variable "${ 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 }".` });
+            value: `ALKiln found the API key in the variable "${ 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.` });
+            value: `The server rejected the API key in the variable "${ 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.

package/lib/steps.js

@@ -140,7 +140,7 @@ Before(async (scenario) => {
   scope.scenario_id = uuidv4();
   scope.scenarios.set( scope.scenario_id, {} );
   scope.scenarios.get( scope.scenario_id ).interviews = {};
-  scope.scenarios.get( scope.scenario_id ).api_keys = [ session_vars.get_dev_api_key() ];
+  scope.scenarios.get( scope.scenario_id ).api_keys = [];
   scope.expected_status = null;
   scope.expected_in_report = null;
   scope.expected_not_in_report = null;
@@ -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-delete3",
+  "version": "5.12.0-delete5",
   "description": "Integrated automated end-to-end testing with docassemble, puppeteer, and cucumber.",
   "main": "lib/index.js",
   "scripts": {