dceky 1.0.20 → 1.0.22

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dceky",
-  "version": "1.0.20",
+  "version": "1.0.22",
   "description": "Cypress toolkit for Harvard DCE",
   "main": "./lib/src/index.js",
   "types": "./lib/src/index.d.ts",

package/src/commands/handleHarvardKey.ts

@@ -8,7 +8,7 @@ declare global {
   namespace Cypress {
     interface Chainable {
       /**
-       * Handle a HarvardKey login page for a user
+       * Handle a HarvardKey login page for a user via UI (form filling with cy.origin(), not API calls)
        * @author Yuen Ler Chow
        * @param name the name of the user environment variable
        * @return Cypress chainable (void) - performs authentication flow, no return value
@@ -30,16 +30,15 @@ const handleHarvardKey = () => {
     (
       name: string,
     ) => {
-      cy.log('🔓 Handling HarvardKey authentication');
+      cy.log('🔓 Handling HarvardKey authentication via UI');
 
       const userInfo = Cypress.env(name);
       if (!userInfo) {
         throw new Error(`Could not find ${name} in environment variables`);
       }
 
-      // Destructure the user info object to get the username and password
-      const { username } = userInfo;
-      const { password } = userInfo;
+      // Destructure the user info object
+      const { username, password } = userInfo;
 
       // Get the Harvard login URL using originWithKaixa with auto-initialized functions
       cy.origin('https://apps.cirrusidentity.com', () => {

package/src/commands/index.ts

@@ -18,13 +18,14 @@ import handleHarvardKey from './handleHarvardKey';
 import launchAs from './launchAs';
 import listSelectLabels from './listSelectLabels';
 import listSelectValues from './listSelectValues';
+import logIntoPorta from './logIntoPorta';
 import navigateToHref from './navigateToHref';
 import padWithZeros from './padWithZeros';
 import runScript from './runScript';
-import typeInto from './typeInto';
-import uniquify from './uniquify';
 import tap from './tap';
 import tapInIFrame from './tapInIFrame';
+import typeInto from './typeInto';
+import uniquify from './uniquify';
 import visitCanvasEndpoint from './visitCanvasEndpoint';
 import waitForAtLeastOneElementPresent from './waitForAtLeastOneElementPresent';
 import waitForElementVisible from './waitForElementVisible';
@@ -54,13 +55,14 @@ const commands = () => {
   launchAs();
   listSelectLabels();
   listSelectValues();
+  logIntoPorta();
   navigateToHref();
   padWithZeros();
   runScript();
-  typeInto();
-  uniquify();
   tap();
   tapInIFrame();
+  typeInto();
+  uniquify();
   visitCanvasEndpoint();
   waitForAtLeastOneElementPresent();
   waitForElementVisible();

package/src/commands/logIntoPorta.ts

@@ -0,0 +1,166 @@
+/// <reference types="cypress" />
+
+/*----------------------------------------*/
+/* ---------------- Type ---------------- */
+/*----------------------------------------*/
+
+declare global {
+  namespace Cypress {
+    interface Chainable {
+      /**
+       * Log into Porta via HarvardKey authentication using API requests (no UI interaction).
+       *
+       * Flow:
+       * 1. GET Cirrus Identity discovery page → extract HarvardKey IdP button href
+       * 2. GET IdP login page → extract form action and hidden fields
+       * 3. POST credentials to the login form
+       * 4. POST SAML form to ACS
+       *
+       * @author Yuen Ler Chow
+       * @param name the name of the user environment variable
+       * @return Cypress chainable (void) - performs authentication flow, no return value
+       */
+      loginToPorta(
+        name: string,
+      ): Chainable<void>;
+    }
+  }
+}
+
+/*----------------------------------------*/
+/* ---------------- Constants ----------------- */
+/*----------------------------------------*/
+
+// Cirrus Identity discovery page (Request 1)
+const LOGIN_PAGE = 'https://harvard.proxy.cirrusidentity.com/cas/login?service=https%3A%2F%2Fporta-auto.dcex.harvard.edu%2Fcas%2Flogin%2F';
+// Base URL for HarvardKey IdP (Request 2)
+const IDP_BASE_URL = 'https://apps.cirrusidentity.com';
+// HarvardKey IdP button ID on Cirrus discovery page
+const HARVARDKEY_IDP_BUTTON_ID = 'idp_1001962798_button';
+
+/*----------------------------------------*/
+/* -------------- Helpers --------------- */
+/*----------------------------------------*/
+
+/**
+ * Parse HTML and extract form action URL and hidden input fields.
+ * @author Yuen Ler Chow
+ * @param html - Raw HTML string to parse
+ * @param formSelector - CSS selector for the form (default: 'form')
+ * @returns Object with action URL and record of hidden field name/value pairs
+ */
+const getFormData = (html: string, formSelector = 'form') => {
+  const doc = new DOMParser().parseFromString(html, 'text/html');
+  const form = doc.querySelector(formSelector);
+  const action = form?.getAttribute('action') ?? '';
+  const fields: { [key: string]: string } = {};
+  form?.querySelectorAll('input[type=hidden]').forEach((input) => {
+    const name = input.getAttribute('name');
+    if (name) fields[name] = input.getAttribute('value') ?? '';
+  });
+  return { action, fields };
+};
+
+/*----------------------------------------*/
+/* --------------- Command -------------- */
+/*----------------------------------------*/
+
+const loginToPorta = () => {
+  Cypress.Commands.add(
+    'loginToPorta',
+    (
+      name: string,
+    ) => {
+      cy.log('🔓 Handling HarvardKey authentication via API');
+
+      const userInfo = Cypress.env(name);
+      if (!userInfo) {
+        throw new Error(`Could not find ${name} in environment variables`);
+      }
+      const { username, password } = userInfo;
+
+      // Check if username and password are set
+      if (!username || !password) {
+        throw new Error(`Credential "${name}" is missing username and/or password`);
+      }
+
+      const htmlHeaders = { accept: 'text/html' };
+
+      // Request 1: GET Cirrus Identity discovery page
+      cy.request({
+        url: LOGIN_PAGE,
+        followRedirect: true,
+        failOnStatusCode: false,
+        headers: htmlHeaders,
+      }).then((discoveryRes) => {
+        // Parse discovery page for HarvardKey IdP button href
+        const btnMatch = discoveryRes.body.match(
+          new RegExp(`href=["']([^"']+)["'][^>]*id=["']${HARVARDKEY_IDP_BUTTON_ID}["']`),
+        );
+        if (!btnMatch) {
+          throw new Error('Could not find HarvardKey IdP button link on discovery page');
+        }
+
+        const idpUrl = `${IDP_BASE_URL}${btnMatch[1]}`;
+
+        // Request 2: GET HarvardKey IdP login page
+        cy.request({
+          url: idpUrl,
+          followRedirect: true,
+          failOnStatusCode: false,
+          headers: htmlHeaders,
+        }).then((loginPageRes) => {
+          // Parse login form action and hidden fields
+          const {
+            action: loginFormUrl,
+            fields: loginHiddenFields,
+          } = getFormData(loginPageRes.body);
+          if (!loginFormUrl) {
+            throw new Error('Could not find login form action on HarvardKey page');
+          }
+
+          // Request 3: POST credentials to HarvardKey login form
+          cy.request({
+            method: 'POST',
+            url: loginFormUrl,
+            form: true,
+            followRedirect: true,
+            failOnStatusCode: false,
+            headers: htmlHeaders,
+            body: {
+              ...loginHiddenFields,
+              username,
+              password,
+            },
+          }).then((authRes) => {
+            // Parse SAML form from login response
+            const {
+              action: samlFormUrl,
+              fields: samlHiddenFields,
+            } = getFormData(authRes.body, 'form[action*="saml2-acs"]');
+            if (!samlFormUrl) {
+              throw new Error('Could not find SAML form in login response');
+            }
+
+            // Request 4: POST SAML assertion to ACS
+            return cy.request({
+              method: 'POST',
+              url: samlFormUrl,
+              form: true,
+              followRedirect: true,
+              failOnStatusCode: false,
+              headers: htmlHeaders,
+              body: samlHiddenFields,
+            });
+          });
+        });
+      });
+    },
+  );
+};
+
+/*----------------------------------------*/
+/* --------------- Export --------------- */
+/*----------------------------------------*/
+
+export default loginToPorta;