migrate e2e (#664)

- **rename vue->platform-ui**
- **git mv platform-ui e2e tests to platform-ui**
- **move testing scripts for platform-ui e2e**

Author: NiloCK

.github/workflows/e2e-tests.yml

@@ -1,4 +1,4 @@
-name: E2E Tests
+name: Platform E2E Tests
 
 on:
   schedule:
@@ -37,7 +37,7 @@ jobs:
         run: yarn install
 
       - name: Install Cypress
-        run: yarn cypress install
+        run: yarn workspace @vue-skuilder/platform-ui cypress install
 
       - name: Setup and wait for services
         run: |
@@ -53,7 +53,7 @@ jobs:
       - name: Run E2E tests
         run: |
           # Run Cypress tests
-          yarn cypress run
+          yarn workspace @vue-skuilder/platform-ui cypress run
 
       - name: Cleanup services
         if: always()
@@ -68,13 +68,13 @@ jobs:
         if: failure()
         with:
           name: cypress-screenshots
-          path: cypress/screenshots
+          path: packages/platform-ui/cypress/screenshots
           retention-days: 7 # Optional: set retention period
 
       - name: Upload videos
         uses: actions/upload-artifact@v4
         if: always()
         with:
           name: cypress-videos
-          path: cypress/videos
+          path: packages/platform-ui/cypress/videos
           retention-days: 7 # Optional: set retention period

.gitignore

@@ -31,9 +31,6 @@ yarn-error.log*
 # The caddy (web server) config file
 vue/Caddyfile
 
-# Cyrpress build artifacts
-/packages/platform-ui/cypress
-
 # yarn 2+ files
 .yarn/*
 !.yarn/patches

package.json

@@ -10,9 +10,6 @@
         "couchdb:status": "node scripts/dev-couchdb.js status",
         "couchdb:remove": "node scripts/dev-couchdb.js remove",
         "postdev": "node scripts/dev-couchdb.js stop",
-        "test:e2e": "cypress open",
-        "test:e2e:headless": "cypress run",
-        "ci:e2e": "yarn dev & wait-on http://localhost:5173 && cypress run; kill $(lsof -t -i:8080); yarn couchdb:stop",
         "build": "yarn workspace @vue-skuilder/common build && yarn workspace @vue-skuilder/db build && yarn workspace @vue-skuilder/common-ui build && yarn workspace @vue-skuilder/courses build && yarn workspace @vue-skuilder/platform-ui build && yarn workspace @vue-skuilder/express build",
         "clean": "yarn clean:dist && yarn clean:node_modules",
         "clean:dist": "find packages -name 'dist' -type d -exec rm -rf {} +",
@@ -25,9 +22,6 @@
     ],
     "packageManager": "yarn@4.6.0",
     "devDependencies": {
-        "@types/cypress": "^1.1.6",
-        "concurrently": "^9.1.2",
-        "cypress": "^14.1.0",
-        "wait-on": "^8.0.2"
+        "concurrently": "^9.1.2"
     }
 }

packages/db/src/core/interfaces/courseDB.ts

@@ -2,6 +2,7 @@ import { CourseConfig, CourseElo, DataShape } from '@vue-skuilder/common';
 import { StudySessionNewItem, StudySessionItem } from './contentSource';
 import { TagStub, Tag } from '../types/types-legacy';
 import { SkuilderCourseData } from '@vue-skuilder/common/dist/db';
+import { DataLayerResult } from '../types/db';
 
 /**
  * Course content and management
@@ -121,7 +122,7 @@ export interface CourseDBInterface {
     tags: string[],
     uploads?: { [key: string]: PouchDB.Core.FullAttachment },
     elo?: CourseElo
-  ): Promise<PouchDB.Core.Response>;
+  ): Promise<DataLayerResult>;
 
   removeCard(cardId: string): Promise<PouchDB.Core.Response>;
 

packages/db/src/core/types/db.ts

@@ -0,0 +1,6 @@
+import { Status } from '@vue-skuilder/common';
+
+export interface DataLayerResult {
+  status: Status;
+  message: string;
+}

packages/db/src/impl/pouch/courseAPI.ts

@@ -11,7 +11,6 @@ import { prepareNote55 } from '@vue-skuilder/common';
 import { User } from './userDB';
 
 /**
- * @deprecated Use similar functionality from the dataLayerProvider
  *
  * @param courseID id of the course (quilt) being added to
  * @param codeCourse
@@ -43,14 +42,13 @@ export async function addNote55(
   if (result.ok) {
     // create cards
     await createCards(courseID, dataShapeId, result.id, tags, elo);
+  } else {
+    console.log(`Error adding note: ${result}`);
   }
 
   return result;
 }
 
-/**
- * @deprecated Use similar functionality from the dataLayerProvider
- */
 export async function createCards(
   courseID: string,
   datashapeID: PouchDB.Core.DocumentId,
@@ -73,9 +71,6 @@ export async function createCards(
   }
 }
 
-/**
- * @deprecated Use similar functionality from the dataLayerProvider
- */
 async function createCard(
   questionViewName: string,
   courseID: string,
@@ -109,14 +104,15 @@ async function createCard(
 }
 
 /**
- * @deprecated Use similar functionality from the dataLayerProvider
  *
  * Adds a card to the DB. This function is called
  * as a side effect of adding either a View or
  * DisplayableData item.
  * @param course The name of the course that the card belongs to
  * @param id_displayable_data C/PouchDB ID of the data used to hydrate the view
  * @param id_view C/PouchDB ID of the view used to display the card
+ *
+ * @package
  */
 async function addCard(
   courseID: string,
@@ -153,8 +149,6 @@ export async function getCredentialledCourseConfig(courseID: string) {
 }
 
 /**
- @deprecated Use similar functionality from the dataLayerProvider
-
  Assciates a tag with a card.
 
  NB: DB stores tags as separate documents, with a list of card IDs.
@@ -163,6 +157,7 @@ export async function getCredentialledCourseConfig(courseID: string) {
  NB: tags are created if they don't already exist
 
  @param updateELO whether to update the ELO of the card with the new tag. Default true.
+ @package
 */
 export async function addTagToCard(
   courseID: string,
@@ -213,12 +208,6 @@ class AlreadyTaggedErr extends Error {
   }
 }
 
-/**
- * @deprecated Use similar functionality from the dataLayerProvider
- *
- * @param tagName
- * @returns
- */
 export function getTagID(tagName: string): string {
   const tagPrefix = DocType.TAG.valueOf() + '-';
   if (tagName.indexOf(tagPrefix) === 0) {
@@ -227,9 +216,7 @@ export function getTagID(tagName: string): string {
     return tagPrefix + tagName;
   }
 }
-/**
- * @deprecated Use similar functionality from the dataLayerProvider
- */
+
 export function getCourseDB(courseID: string): PouchDB.Database {
   const dbName = `coursedb-${courseID}`;
   return new pouch(

packages/db/src/impl/pouch/courseDB.ts

@@ -6,6 +6,7 @@ import {
   DataShape,
   ENV,
   EloToNumber,
+  Status,
   blankCourseElo,
   toCourseElo,
 } from '@vue-skuilder/common';
@@ -21,6 +22,8 @@ import {
 import { CardData, DocType, SkuilderCourseData, Tag, TagStub } from '../../core/types/types-legacy';
 import { GET_CACHED } from './clientCache';
 import { addNote55, addTagToCard, getCredentialledCourseConfig, getTagID } from './courseAPI';
+import { DataLayerResult } from '@/core/types/db';
+import { PouchError } from './types';
 
 const courseLookupDBTitle = 'coursedb-lookup';
 
@@ -495,8 +498,30 @@ above:\n${above.rows.map((r) => `\t${r.id}-${r.key}\n`)}`;
     tags: string[],
     uploads?: { [key: string]: PouchDB.Core.FullAttachment },
     elo: CourseElo = blankCourseElo()
-  ): Promise<PouchDB.Core.Response> {
-    return await addNote55(this.id, codeCourse, shape, data, author, tags, uploads, elo);
+  ): Promise<DataLayerResult> {
+    try {
+      const resp = await addNote55(this.id, codeCourse, shape, data, author, tags, uploads, elo);
+      if (resp.ok) {
+        return {
+          status: Status.ok,
+          message: '',
+        };
+      } else {
+        return {
+          status: Status.error,
+          message: 'Unexpected ',
+        };
+      }
+    } catch (e) {
+      const err = e as PouchDB.Core.Error;
+      console.error(
+        `[addNote] error ${err.name}\n\treason: ${err.reason}\n\tmessage: ${err.message}`
+      );
+      return {
+        status: Status.error,
+        message: `Error adding note to course. ${(e as PouchError).reason}`,
+      };
+    }
   }
 
   async getCourseDoc<T extends SkuilderCourseData>(

packages/express/src/client-requests/course-requests.ts

@@ -6,6 +6,7 @@ import { postProcessCourse } from '../attachment-preprocessing/index.js';
 import AsyncProcessQueue from '../utils/processQueue.js';
 import nano from 'nano';
 import { Status } from '@vue-skuilder/common';
+import logger from '@/logger.js';
 
 /**
  * Fake fcn to allow usage in couchdb map fcns which, after passing
@@ -190,22 +191,34 @@ async function createCourse(cfg: CourseConfig): Promise<any> {
   }
 
   const courseID = lookupInsert.id;
+
   cfg.courseID = courseID;
+  await lookup.insert({
+    ...cfg,
+    _id: lookupInsert.id,
+    _rev: lookupInsert.rev,
+  } as nano.MaybeDocument);
 
   const courseDBName: string = getCourseDBName(courseID);
   const dbCreation = await CouchDB.db.create(courseDBName);
 
   if (dbCreation.ok) {
     const courseDB = CouchDB.use(courseDBName);
 
-    courseDB.insert({
-      _id: 'CourseConfig',
-      ...cfg,
-    });
+    courseDB
+      .insert({
+        _id: 'CourseConfig',
+        ...cfg,
+      })
+      .catch((e) => {
+        logger.error(`Error inserting CourseConfig for course ${courseID}:`, e);
+      });
 
     // insert the tags, elo, etc view docs
     courseDBDesignDocs.forEach((doc) => {
-      courseDB.insert(doc);
+      courseDB.insert(doc).catch((e) => {
+        logger.error(`Error inserting design doc for course ${courseID}:`, e);
+      });
     });
 
     if (!cfg.public) {
@@ -220,7 +233,12 @@ async function createCourse(cfg: CourseConfig): Promise<any> {
         },
       };
 
-      courseDB.insert(secObj as nano.MaybeDocument, '_security');
+      courseDB.insert(secObj as nano.MaybeDocument, '_security').catch((e) => {
+        logger.error(
+          `Error inserting security object for course ${courseID}:`,
+          e
+        );
+      });
     }
   }
 
@@ -238,7 +256,7 @@ async function createCourse(cfg: CourseConfig): Promise<any> {
 export type CreateCourseResp = CreateCourse['response'];
 
 export const CourseCreationQueue = new AsyncProcessQueue<
-  // @ts-ignore
+  // @ts-expect-error [I do not know why this thinks is is broken or why it works.]
   CreateCourse['data'],
   CreateCourse['response']
 >(createCourse);

cypress.config.js renamed to packages/platform-ui/cypress.config.js

@@ -2,7 +2,7 @@ const { defineConfig } = require('cypress');
 
 module.exports = defineConfig({
   e2e: {
-    baseUrl: 'http://localhost:5173', // package/vue vite dev server port
+    baseUrl: 'http://localhost:5173', // package/platform-ui vite dev server port
     supportFile: 'cypress/support/e2e.js',
     specPattern: 'cypress/e2e/**/*.cy.{js,jsx,ts,tsx}',
     setupNodeEvents(on, config) {