Db abstraction - add db package (#634)

Toward modular code base.

PR:
- pulls contents of `vue/src/db` into its own `db` package
- removes direct dependency of `pouchdb` from `vue` package 
- lays (rough) foundation for replacing implementations w/ interfaces at package boundaries

Author: NiloCK

.github/workflows/build-vue.yml

@@ -4,6 +4,7 @@ on:
     paths:
       - 'packages/vue/**'
       - 'packages/common/**'
+      - 'packages/db/**'
       - '.github/workflows/build-vue.yml'
 jobs:
   build-vue-spa:
@@ -32,6 +33,10 @@ jobs:
         working-directory: ./packages/common
         run: yarn build
 
+      - name: Build db package
+        working-directory: ./packages/db
+        run: yarn build
+
       - name: Setup Vue environment
         run: printf "${{ secrets.VUE_ENV }}" > ./packages/vue/.env.production
 

.gitignore

@@ -44,3 +44,6 @@ vue/Caddyfile
 
 # TypeScript incremental build info
 *.tsbuildinfo
+
+# specific pattern to place tmp files that should be ignored
+ignore

.prompt

@@ -0,0 +1,29 @@
+This project is a framework for the authoring of interactive tutoring systems, with the eventual goals of
+- a mass-collaborative platform for authoring / sharing etc
+- a toolset for spawning individual specialized tutoring systems whose level of customization is out of scope for a web platform
+
+Think: khan academy + duolingo + anki + wikipedia, with an evolutionary mechanism to filter user generated curricular content based on how that content impacts overall learning outcomes.
+
+
+# History:
+
+developed slowly as an occasional hobby / side project, and used 'in production' for a few years now, but only for household use. Tech stack has recently been modernized:
+- vue 2 class-based-components -> vue 3
+- vuetify 1.x -> vuetify 3 (current)
+- lerna ~3.x hodge podge -> yarn workspaces
+
+Much of the legacy code was written without explicit concerns for performance, security, or scale.
+
+# Current goals:
+
+Seeking to use the project as a vehicle to develop content for commercial, production grade systems. Seeking to iterate quickly to modernize the stack and add key features.
+
+# GENERAL QUALITY CAVEAT
+
+With respect to security, error handling, and performance: _If you see something, say something._
+
+If you parse source code that contains *critical errors*, please prefix your responses with "WARNING: SUBSTANTIVE ERRORS DETECTED" and provide a brief summary of the errors.
+
+Do this at the expense of addressing the specific questions that were posed.
+
+Thanks!

package.json

@@ -1,7 +1,7 @@
 {
     "name": "vue-skuilder",
     "scripts": {
-        "dev": "yarn workspace @vue-skuilder/common build && node scripts/dev-couchdb.js start && concurrently \"yarn dev:vue\" \"yarn dev:express\"",
+        "dev": "yarn workspace @vue-skuilder/common build && yarn workspace @vue-skuilder/db build && node scripts/dev-couchdb.js start && concurrently \"yarn dev:vue\" \"yarn dev:express\"",
         "dev:vue": "yarn workspace @vue-skuilder/vue dev",
         "dev:express": "yarn workspace @vue-skuilder/express dev",
         "dev:couchdb": "node scripts/dev-couchdb.js start",
@@ -13,7 +13,7 @@
         "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/vue build && yarn workspace @vue-skuilder/express build"
+        "build": "yarn workspace @vue-skuilder/common build && yarn workspace @vue-skuilder/db build && yarn workspace @vue-skuilder/vue build && yarn workspace @vue-skuilder/express build"
     },
     "private": true,
     "workspaces": [

packages/vue/src/ENVIRONMENT_VARS.ts renamed to packages/common/src/ENVIRONMENT_VARS.ts

@@ -38,18 +38,38 @@ const ENV: Environment = {
   MOCK: false,
 };
 
-ENV.COUCHDB_SERVER_URL = import.meta.env.VITE_COUCHDB_SERVER!;
-ENV.COUCHDB_SERVER_PROTOCOL = import.meta.env.VITE_COUCHDB_PROTOCOL! as ProtocolString;
+// Try to load from Vite environment if available
+try {
+  // Use typeof check to avoid issues in non-Vite environments
+  if (typeof import.meta !== 'undefined' && 'env' in import.meta) {
+    const env = (import.meta as any).env;
 
-ENV.EXPRESS_SERVER_URL = import.meta.env.VITE_EXPRESS_SERVER!;
-ENV.EXPRESS_SERVER_PROTOCOL = import.meta.env.VITE_EXPRESS_PROTOCOL! as ProtocolString;
+    if (env.VITE_COUCHDB_SERVER) {
+      ENV.COUCHDB_SERVER_URL = env.VITE_COUCHDB_SERVER;
+    }
 
-if (import.meta.env.VITE_DEBUG !== undefined) {
-  ENV.DEBUG = import.meta.env.VITE_DEBUG === 'true';
-}
+    if (env.VITE_COUCHDB_PROTOCOL) {
+      ENV.COUCHDB_SERVER_PROTOCOL = env.VITE_COUCHDB_PROTOCOL as ProtocolString;
+    }
+
+    if (env.VITE_EXPRESS_SERVER) {
+      ENV.EXPRESS_SERVER_URL = env.VITE_EXPRESS_SERVER;
+    }
+
+    if (env.VITE_EXPRESS_PROTOCOL) {
+      ENV.EXPRESS_SERVER_PROTOCOL = env.VITE_EXPRESS_PROTOCOL as ProtocolString;
+    }
+
+    if (env.VITE_DEBUG !== undefined) {
+      ENV.DEBUG = env.VITE_DEBUG === 'true';
+    }
 
-if (import.meta.env.VITE_MOCK !== undefined) {
-  ENV.MOCK = import.meta.env.VITE_MOCK === 'true';
+    if (env.VITE_MOCK !== undefined) {
+      ENV.MOCK = env.VITE_MOCK === 'true';
+    }
+  }
+} catch (e) {
+  console.warn('Unable to load environment variables from Vite:', e);
 }
 
 if (ENV.DEBUG) {

packages/common/src/course-data.ts

@@ -1,27 +1,13 @@
 import { Status } from './wire-format.js';
 import { DisplayableData, DocType } from './db.js';
 import { NameSpacer } from './namespacer.js';
+import { CourseElo } from './elo.js';
 
 export interface DataShape {
   name: DataShapeName;
   fields: FieldDefinition[];
 }
 
-export type CourseElo = {
-  global: EloRank;
-  tags: {
-    [tagID: string]: EloRank;
-  };
-  misc: {
-    [eloID: string]: EloRank;
-  };
-};
-
-type EloRank = {
-  score: number;
-  count: number;
-};
-
 export interface ValidationResult {
   status: Status;
   msg: string;

packages/common/src/db.ts

@@ -1,4 +1,5 @@
-import { Answer, Evaluation, CourseElo } from './course-data.js';
+import { Answer, Evaluation } from './course-data.js';
+import { CourseElo } from './elo.js';
 import { Moment } from 'moment';
 
 export enum DocType {

packages/vue/src/tutor/Elo.ts renamed to packages/common/src/elo.ts

@@ -1,3 +1,5 @@
 export * from './wire-format.js';
-
 export * from './course-data.js';
+export { default as ENV } from './ENVIRONMENT_VARS.js';
+export * from './elo.js';
+export * from './namespacer.js';

packages/common/src/index.ts

@@ -0,0 +1,21 @@
+# @vue-skuilder/db
+
+Database abstraction layer for vue-skuilder.
+
+## Structure
+
+The package is organized into:
+
+- `core/` - Core interfaces and types for database operations
+- `pouch/` - PouchDB implementation of the core interfaces
+
+## Usage
+
+```typescript
+// Import the default implementation
+import { getUserDB } from '@vue-skuilder/db';
+
+// Or import from a specific namespace
+import { DBInterfaces } from '@vue-skuilder/db/core';
+import { PouchImplementation } from '@vue-skuilder/db/pouch';
+```