Datalayer config (#675)

NiloCK · web-flow · commit 7cd1ed4cb552 · 2025-04-18T08:27:08.000-03:00
diff --git a/CLAUDE.md b/CLAUDE.md
@@ -0,0 +1,24 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Commands
+- Build: `yarn build`
+- Dev: `yarn dev` (starts CouchDB, platform-ui, express)
+- Lint: `yarn workspace @vue-skuilder/platform-ui lint` or `yarn workspace @vue-skuilder/express lint:fix`
+- Type check: `yarn workspace @vue-skuilder/express type-check`
+- Unit tests: `yarn workspace @vue-skuilder/platform-ui test:unit`
+- Run single test: `yarn workspace @vue-skuilder/platform-ui test:unit <test-file-path>`
+- E2E tests: `yarn workspace @vue-skuilder/platform-ui test:e2e`
+
+## Style Guidelines
+- Use TypeScript with strict typing
+- Format: singleQuote, 2-space tabs (4 for JSON), 100 char line width (120 for Vue files)
+- Import order: external modules first, then internal modules
+- Vue components use PascalCase
+- CSS uses kebab-case
+- Variables/functions use camelCase
+- Use async/await for promises
+- Error handling: try/catch blocks for async code
+- Use ESLint and Prettier for code formatting
+- Follow Vue 3 Composition API patterns
diff --git a/packages/common-ui/vite.config.js b/packages/common-ui/vite.config.js
@@ -10,6 +10,7 @@ export default defineConfig({
     terserOptions: {
       keep_classnames: true,
     },
+    sourcemap: true,
     lib: {
       entry: resolve(__dirname, 'src/index.ts'),
       name: 'VueSkuilderCommonUI',
@@ -28,6 +29,7 @@ export default defineConfig({
         assetFileNames: (assetInfo) => {
           return `assets/[name][extname]`;
         },
+        sourcemap: true,
       },
     },
     // This is crucial for component libraries - allow CSS to be in chunks
diff --git a/packages/common/src/index.ts b/packages/common/src/index.ts
@@ -1,6 +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';
 export * from './logshim.js';
diff --git a/packages/db/package.json b/packages/db/package.json
@@ -24,6 +24,7 @@
     },
     "scripts": {
         "build": "tsup",
+        "build:debug": "tsup --sourcemap inline",
         "dev": "tsup --watch"
     },
     "dependencies": {
diff --git a/packages/db/src/factory.ts b/packages/db/src/factory.ts
@@ -2,12 +2,24 @@
 
 import { DataLayerProvider } from './core/interfaces';
 
+interface DBEnv {
+  COUCHDB_SERVER_URL: string; // URL of CouchDB server
+  COUCHDB_SERVER_PROTOCOL: string; // Protocol of CouchDB server (http or https)
+}
+
+export const ENV: DBEnv = {
+  COUCHDB_SERVER_PROTOCOL: 'NOT_SET',
+  COUCHDB_SERVER_URL: 'NOT_SET',
+};
+
 // Configuration type for data layer initialization
 export interface DataLayerConfig {
   type: 'pouch' | 'static';
-  options?: {
+  options: {
     staticContentPath?: string; // Path to static content JSON files
     localStoragePrefix?: string; // Prefix for IndexedDB storage names
+    COUCHDB_SERVER_URL?: string;
+    COUCHDB_SERVER_PROTOCOL?: string;
   };
 }
 
@@ -23,8 +35,14 @@ export async function initializeDataLayer(config: DataLayerConfig): Promise<Data
     return dataLayerInstance;
   }
 
-  // Dynamic import to avoid loading both implementations when only one is needed
   if (config.type === 'pouch') {
+    if (!config.options.COUCHDB_SERVER_URL || !config.options.COUCHDB_SERVER_PROTOCOL) {
+      throw new Error('Missing CouchDB server URL or protocol');
+    }
+    ENV.COUCHDB_SERVER_PROTOCOL = config.options.COUCHDB_SERVER_PROTOCOL;
+    ENV.COUCHDB_SERVER_URL = config.options.COUCHDB_SERVER_URL;
+
+    // Dynamic import to avoid loading both implementations when only one is needed
     const { PouchDataLayerProvider } = await import('./impl/pouch/PouchDataLayerProvider');
     dataLayerInstance = new PouchDataLayerProvider();
   } else {
diff --git a/packages/db/src/impl/pouch/adminDB.ts b/packages/db/src/impl/pouch/adminDB.ts
@@ -1,5 +1,5 @@
-import pouch from 'pouchdb';
-import { ENV } from '@vue-skuilder/common';
+import pouch from './pouchdb-setup';
+import { ENV } from '@/factory';
 import {
   pouchDBincludeCredentialsConfig,
   getStartAndEndKeys,
@@ -60,7 +60,7 @@ export class AdminDB implements AdminDBInterface {
   public async getClassrooms() {
     // const joincodes =
     const uuids = (
-      await ClassroomLookupDB.allDocs<{ uuid: string }>({
+      await ClassroomLookupDB().allDocs<{ uuid: string }>({
         include_docs: true,
       })
     ).rows.map((r) => r.doc!.uuid);
diff --git a/packages/db/src/impl/pouch/auth.ts b/packages/db/src/impl/pouch/auth.ts
@@ -1,4 +1,4 @@
-import { ENV } from '@vue-skuilder/common';
+import { ENV } from '@/factory';
 import { GuestUsername } from '../../core/types/types-legacy';
 
 interface SessionResponse {
diff --git a/packages/db/src/impl/pouch/classroomDB.ts b/packages/db/src/impl/pouch/classroomDB.ts
@@ -3,9 +3,10 @@ import {
   StudySessionNewItem,
   StudySessionReviewItem,
 } from '@/core/interfaces/contentSource';
-import { ClassroomConfig, ENV } from '@vue-skuilder/common';
+import { ClassroomConfig } from '@vue-skuilder/common';
+import { ENV } from '@/factory';
 import moment from 'moment';
-import pouch from 'pouchdb';
+import pouch from './pouchdb-setup';
 import {
   getCourseDB,
   getStartAndEndKeys,
@@ -285,12 +286,10 @@ export class TeacherClassroomDB extends ClassroomDBBase implements TeacherClassr
   }
 }
 
-export const ClassroomLookupDB: PouchDB.Database = new pouch(
-  ENV.COUCHDB_SERVER_PROTOCOL + '://' + ENV.COUCHDB_SERVER_URL + classroomLookupDBTitle,
-  {
+export const ClassroomLookupDB: () => PouchDB.Database = () =>
+  new pouch(ENV.COUCHDB_SERVER_PROTOCOL + '://' + ENV.COUCHDB_SERVER_URL + classroomLookupDBTitle, {
     skip_setup: true,
-  }
-);
+  });
 
 export function getClassroomDB(classID: string, version: 'student' | 'teacher'): PouchDB.Database {
   const dbName = `classdb-${version}-${classID}`;
diff --git a/packages/db/src/impl/pouch/courseAPI.ts b/packages/db/src/impl/pouch/courseAPI.ts
@@ -1,6 +1,6 @@
-import pouch from 'pouchdb';
+import pouch from './pouchdb-setup';
 import { pouchDBincludeCredentialsConfig } from '.';
-import { ENV } from '@vue-skuilder/common';
+import { ENV } from '@/factory';
 // import { DataShape } from '../..base-course/Interfaces/DataShape';
 import { NameSpacer, ShapeDescriptor } from '@vue-skuilder/common';
 import { CourseConfig, DataShape } from '@vue-skuilder/common';
diff --git a/packages/db/src/impl/pouch/courseLookupDB.ts b/packages/db/src/impl/pouch/courseLookupDB.ts
@@ -1,5 +1,5 @@
-import pouch from 'pouchdb';
-import { ENV } from '@vue-skuilder/common';
+import pouch from './pouchdb-setup';
+// import { ENV } from '@/factory';
 
 const courseLookupDBTitle = 'coursedb-lookup';
 
@@ -10,6 +10,8 @@ interface CourseLookupDoc {
   disambiguator?: string;
 }
 
+console.log(`COURSELOOKUP FILE RUNNING`);
+
 /**
  * a k-v indexes created courses.
  *
@@ -18,13 +20,16 @@ interface CourseLookupDoc {
  */
 export default class CourseLookup {
   // [ ] this db should be read only for public, admin-write only
-  static _db: PouchDB.Database = new pouch(
-    ENV.COUCHDB_SERVER_PROTOCOL + '://' + ENV.COUCHDB_SERVER_URL + courseLookupDBTitle,
-    {
-      skip_setup: true,
-    }
-  );
+  // static _db: PouchDB.Database = new pouch(
+  //   ENV.COUCHDB_SERVER_PROTOCOL + '://' + ENV.COUCHDB_SERVER_URL + courseLookupDBTitle,
+  //   {
+  //     // skip_setup: true,
+  //   }
+  // );
 
+  static _db: PouchDB.Database = new pouch('http://localhost:5984/' + courseLookupDBTitle, {
+    skip_setup: true,
+  });
   /**
    * Adds a new course to the lookup database, and returns the courseID
    * @param courseName
diff --git a/packages/db/src/impl/pouch/index.ts b/packages/db/src/impl/pouch/index.ts
@@ -1,27 +1,20 @@
-import { DocType, SkuilderCourseData, GuestUsername, log } from '../../core/types/types-legacy';
-import { ENV } from '@vue-skuilder/common';
+import { ENV } from '@/factory';
+import { DocType, GuestUsername, log, SkuilderCourseData } from '../../core/types/types-legacy';
 // import { getCurrentUser } from '../../stores/useAuthStore';
 import moment, { Moment } from 'moment';
-import PouchDBAuth from '@nilock2/pouchdb-authentication';
-import pouch from 'pouchdb';
-import PouchDBFind from 'pouchdb-find';
+
+import pouch from './pouchdb-setup';
+
+import { ScheduledCard } from '@/core/types/user';
 import process from 'process';
 import { getUserDB } from './userDB';
-import { ScheduledCard } from '@/core/types/user';
 
 const isBrowser = typeof window !== 'undefined';
 
 if (isBrowser) {
   (window as any).process = process; // required as a fix for pouchdb - see #18
 }
 
-pouch.plugin(PouchDBAuth);
-pouch.plugin(PouchDBFind);
-
-if (ENV.DEBUG) {
-  // pouch.debug.enable('pouchdb:find');
-}
-
 const expiryDocID: string = 'GuestAccountExpirationDate';
 
 const remoteStr: string = ENV.COUCHDB_SERVER_PROTOCOL + '://' + ENV.COUCHDB_SERVER_URL + 'skuilder';
@@ -234,9 +227,9 @@ export function getStartAndEndKeys(key: string) {
 // Package exports
 //////////////////////
 
-export * from './userDB';
-export * from './courseDB';
-export * from './courseAPI';
-export * from './classroomDB';
 export * from '../../core/interfaces/contentSource';
 export * from './adminDB';
+export * from './classroomDB';
+export * from './courseAPI';
+export * from './courseDB';
+export * from './userDB';
diff --git a/packages/db/src/impl/pouch/userDB.ts b/packages/db/src/impl/pouch/userDB.ts
@@ -1,5 +1,6 @@
 import { getCardHistoryID } from '@/core/util';
-import { CourseElo, ENV, Status } from '@vue-skuilder/common';
+import { CourseElo, Status } from '@vue-skuilder/common';
+import { ENV } from '@/factory';
 import moment, { Moment } from 'moment';
 import { GuestUsername } from '../../core/types/types-legacy';
 import pouch from './pouchdb-setup';
@@ -35,18 +36,22 @@ const log = (s: any) => {
 };
 
 const cardHistoryPrefix = 'cardH-';
-const remoteStr: string = ENV.COUCHDB_SERVER_PROTOCOL + '://' + ENV.COUCHDB_SERVER_URL + 'skuilder';
 
-console.log(`Connecting to remote: ${remoteStr}`);
+// console.log(`Connecting to remote: ${remoteStr}`);
 
-let remoteCouchRootDB: PouchDB.Database;
-try {
-  remoteCouchRootDB = new pouch(remoteStr, {
-    skip_setup: true,
-  });
-} catch (error) {
-  console.error('Failed to initialize remote CouchDB connection:', error);
-  throw new Error(`Failed to initialize CouchDB: ${JSON.stringify(error)}`);
+function getRemoteCouchRootDB(): PouchDB.Database {
+  const remoteStr: string =
+    ENV.COUCHDB_SERVER_PROTOCOL + '://' + ENV.COUCHDB_SERVER_URL + 'skuilder';
+  let remoteCouchRootDB: PouchDB.Database;
+  try {
+    remoteCouchRootDB = new pouch(remoteStr, {
+      skip_setup: true,
+    });
+  } catch (error) {
+    console.error('Failed to initialize remote CouchDB connection:', error);
+    throw new Error(`Failed to initialize CouchDB: ${JSON.stringify(error)}`);
+  }
+  return remoteCouchRootDB;
 }
 
 interface DesignDoc {
@@ -58,17 +63,6 @@ interface DesignDoc {
   };
 }
 
-export async function doesUserExist(name: string) {
-  try {
-    const user = await remoteCouchRootDB.getUser(name);
-    log(`user: ${user._id}`);
-    return true;
-  } catch (err) {
-    log(`User error: ${err}`);
-    return false;
-  }
-}
-
 /**
  * The current logged-in user, with pouch / couch functionality.
  *
@@ -119,13 +113,13 @@ Currently logged-in as ${this._username}.`
       );
     } else {
       try {
-        const signupRequest = await remoteCouchRootDB.signUp(username, password);
+        const signupRequest = await getRemoteCouchRootDB().signUp(username, password);
 
         if (signupRequest.ok) {
           log(`CREATEACCOUNT: logging out of ${this.getUsername()}`);
-          const logoutResult = await remoteCouchRootDB.logOut();
+          const logoutResult = await getRemoteCouchRootDB().logOut();
           log(`CREATEACCOUNT: logged out: ${logoutResult.ok}`);
-          const loginResult = await remoteCouchRootDB.logIn(username, password);
+          const loginResult = await getRemoteCouchRootDB().logIn(username, password);
           log(`CREATEACCOUNT: logged in as new user: ${loginResult.ok}`);
           const newLocal = getLocalUserDB(username);
           const newRemote = getUserDB(username);
@@ -166,7 +160,7 @@ Currently logged-in as ${this._username}.`
       Log out of account ${this.getUsername()} before logging in as ${username}.`);
     }
 
-    const loginResult = await remoteCouchRootDB.logIn(username, password);
+    const loginResult = await getRemoteCouchRootDB().logIn(username, password);
     if (loginResult.ok) {
       log(`Logged in as ${username}`);
       this._username = username;
diff --git a/packages/db/tsconfig.json b/packages/db/tsconfig.json
@@ -14,6 +14,10 @@
     "noUnusedLocals": true,
     "noUnusedParameters": true,
     "noFallthroughCasesInSwitch": true,
+    "sourceMap": true,
+    "inlineSources": true,
+    "declaration": true,
+    "declarationMap": true,
     "paths": {
       "@/*": ["./src/*"]
     }
diff --git a/packages/platform-ui/src/ENVIRONMENT_VARS.ts b/packages/platform-ui/src/ENVIRONMENT_VARS.ts
diff --git a/packages/platform-ui/src/main.ts b/packages/platform-ui/src/main.ts
@@ -1,3 +1,5 @@
+import ENV from './ENVIRONMENT_VARS';
+
 import 'roboto-fontface/css/roboto/roboto-fontface.css';
 import { createApp } from 'vue';
 import App from './App.vue';
@@ -6,21 +8,27 @@ import router from './router';
 import { createPinia } from 'pinia';
 import vuetify from './plugins/vuetify';
 // common-ui imports
-import { piniaPlugin } from '@vue-skuilder/common-ui';
 import '@vue-skuilder/common-ui/style';
-// `courses` imports
-import Courses from '@vue-skuilder/courses';
+// `courses` imports - keep style import for initial page rendering
 import '@vue-skuilder/courses/style';
 // `db` import and initialization
 import { initializeDataLayer } from '@vue-skuilder/db';
 
 (async () => {
   await initializeDataLayer({
     type: 'pouch',
+    options: {
+      COUCHDB_SERVER_PROTOCOL: ENV.COUCHDB_SERVER_PROTOCOL,
+      COUCHDB_SERVER_URL: ENV.COUCHDB_SERVER_URL,
+    },
   });
+
   const pinia = createPinia();
   const app = createApp(App);
 
+  // Dynamically import Courses
+  const { default: Courses } = await import('@vue-skuilder/courses');
+
   // Register all view components globally
   const viewComponents = Courses.allViewsRaw();
   Object.entries(viewComponents).forEach(([name, component]) => {
@@ -30,6 +38,10 @@ import { initializeDataLayer } from '@vue-skuilder/db';
   app.use(router);
   app.use(vuetify);
   app.use(pinia);
+
+  // Dynamically import piniaPlugin
+  const { piniaPlugin } = await import('@vue-skuilder/common-ui');
   app.use(piniaPlugin, { pinia });
+
   app.mount('#app');
 })();
diff --git a/packages/platform-ui/src/router.ts b/packages/platform-ui/src/router.ts
diff --git a/packages/platform-ui/src/server/index.ts b/packages/platform-ui/src/server/index.ts
diff --git a/packages/platform-ui/vite.config.js b/packages/platform-ui/vite.config.js

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { ENV } from '@vue-skuilder/common';`
	`1`	`+import { ENV } from '@/factory';`
`2`	`2`	`import { GuestUsername } from '../../core/types/types-legacy';`
`3`	`3`
`4`	`4`	`interface SessionResponse {`