forked from trent_larson/crowd-funder-for-time-pwa
Fix migration dates, add multi-platform testing infrastructure, and organize docs
Migration Date Corrections: - Update all migration TODO comments to use correct date: 2025-07-06 - Add proper TypeScript type declarations for $route and $router in DeepLinkErrorView - Fix template property references to use $route instead of route Multi-Platform Testing Infrastructure: - Add comprehensive multi-platform testing requirements for migrations - Update component migration template with platform testing requirements - Establish sign-off requirements for web, desktop, and mobile platforms - Document expected outcomes and validation procedures Migration Testing Organization: - Create docs/migration-testing/ folder for testing documentation - Move TESTING_CONTACTIMPORT.md from project root to migration-testing/ - Relocate all migration-checklist-*.md files to migration-testing/ - Add comprehensive README.md with organization guidelines - Update file references in components and TODOs - Establish naming conventions and quality standards Files added: - docs/migration-testing/README.md - docs/migration-testing/TESTING_CONTACTIMPORT.md - docs/migration-testing/migration-checklist-ContactImportView.md - docs/migration-testing/migration-checklist-MembersList.md Files modified: - src/views/ContactImportView.vue (date correction) - src/components/MembersList.vue (date correction, reference path update) - src/views/DeepLinkErrorView.vue (date correction, Vue router types) - docs/migration-templates/component-migration.md (multi-platform requirements) Files moved: - TESTING_CONTACTIMPORT.md → docs/migration-testing/ - docs/migration-checklist-*.md → docs/migration-testing/ This establishes comprehensive testing infrastructure for all future migrations with proper organization and multi-platform validation requirements.
This commit is contained in:
@@ -160,11 +160,11 @@
|
||||
|
||||
<script lang="ts">
|
||||
/* TODO: Human Testing Required - PlatformServiceMixin Migration */
|
||||
// Priority: High | Migrated: 2025-01-06 | Author: Matthew Raymer
|
||||
//
|
||||
// TESTING NEEDED: Component migrated from legacy logConsoleAndDb to PlatformServiceMixin
|
||||
// Priority: High | Migrated: 2025-07-06 | Author: Matthew Raymer
|
||||
//
|
||||
// TESTING NEEDED: Component migrated from legacy logConsoleAndDb to PlatformServiceMixin
|
||||
// but requires human validation due to meeting component accessibility limitations.
|
||||
//
|
||||
//
|
||||
// Test Scenarios Required:
|
||||
// 1. Load members list with valid meeting password
|
||||
// 2. Test member admission toggle (organizer role)
|
||||
@@ -172,13 +172,12 @@
|
||||
// 4. Test error scenarios: network failure, invalid password, server errors
|
||||
// 5. Verify error logging appears in console and database
|
||||
// 6. Cross-platform testing: web, mobile, desktop
|
||||
//
|
||||
// Reference: docs/migration-checklist-MembersList.md
|
||||
//
|
||||
// Reference: docs/migration-testing/migration-checklist-MembersList.md
|
||||
// Migration Details: Replaced 3 logConsoleAndDb() calls with this.$logAndConsole()
|
||||
// Validation: Passes lint checks and TypeScript compilation
|
||||
// Navigation: Contacts → Chair Icon → Start/Join Meeting → Members List
|
||||
|
||||
|
||||
import { Component, Vue, Prop } from "vue-facing-decorator";
|
||||
|
||||
import {
|
||||
|
||||
@@ -201,9 +201,7 @@ import QuickNav from "../components/QuickNav.vue";
|
||||
import EntityIcon from "../components/EntityIcon.vue";
|
||||
import OfferDialog from "../components/OfferDialog.vue";
|
||||
import { APP_SERVER, AppString, NotificationIface } from "../constants/app";
|
||||
import { logConsoleAndDb } from "../db/index";
|
||||
import { Contact, ContactMethod } from "../db/tables/contacts";
|
||||
import * as databaseUtil from "../db/databaseUtil";
|
||||
import * as libsUtil from "../libs/util";
|
||||
import {
|
||||
capitalizeAndInsertSpacesBeforeCaps,
|
||||
@@ -212,60 +210,7 @@ import {
|
||||
} from "../libs/endorserServer";
|
||||
import { getContactJwtFromJwtUrl } from "../libs/crypto";
|
||||
import { decodeEndorserJwt } from "../libs/crypto/vc";
|
||||
import { PlatformServiceFactory } from "@/services/PlatformServiceFactory";
|
||||
|
||||
/**
|
||||
* Interface for contact data as stored in the database
|
||||
* Differs from Contact interface in that contactMethods is stored as a JSON string
|
||||
*/
|
||||
interface ContactDbRecord {
|
||||
did: string;
|
||||
contactMethods: string;
|
||||
name: string;
|
||||
notes: string;
|
||||
profileImageUrl: string;
|
||||
publicKeyBase64: string;
|
||||
nextPubKeyHashB64: string;
|
||||
seesMe: boolean;
|
||||
registered: boolean;
|
||||
}
|
||||
|
||||
/**
|
||||
* Ensures a value is a string, never null or undefined
|
||||
*/
|
||||
function safeString(val: unknown): string {
|
||||
return typeof val === "string" ? val : val == null ? "" : String(val);
|
||||
}
|
||||
|
||||
/**
|
||||
* Converts a Contact object to a ContactDbRecord for database storage
|
||||
* @param contact The contact object to convert
|
||||
* @returns A ContactDbRecord with contactMethods as a JSON string
|
||||
* @throws Error if contact.did is missing or invalid
|
||||
*/
|
||||
function contactToDbRecord(contact: Contact): ContactDbRecord {
|
||||
if (!contact.did) {
|
||||
throw new Error("Contact must have a DID");
|
||||
}
|
||||
|
||||
// Convert contactMethods array to JSON string, defaulting to empty array
|
||||
const contactMethodsStr =
|
||||
contact.contactMethods != null
|
||||
? JSON.stringify(contact.contactMethods)
|
||||
: "[]";
|
||||
|
||||
return {
|
||||
did: safeString(contact.did), // Required field, must be present
|
||||
contactMethods: contactMethodsStr,
|
||||
name: safeString(contact.name),
|
||||
notes: safeString(contact.notes),
|
||||
profileImageUrl: safeString(contact.profileImageUrl),
|
||||
publicKeyBase64: safeString(contact.publicKeyBase64),
|
||||
nextPubKeyHashB64: safeString(contact.nextPubKeyHashB64),
|
||||
seesMe: contact.seesMe ?? false,
|
||||
registered: contact.registered ?? false,
|
||||
};
|
||||
}
|
||||
import { PlatformServiceMixin } from "@/utils/PlatformServiceMixin";
|
||||
|
||||
/**
|
||||
* Contact Import View Component
|
||||
@@ -307,8 +252,29 @@ function contactToDbRecord(contact: Contact): ContactDbRecord {
|
||||
*
|
||||
* @component
|
||||
*/
|
||||
// TODO: Testing Required - Database Operations + Logging Migration to PlatformServiceMixin
|
||||
// Priority: Medium | Migrated: 2025-07-06 | Author: Matthew Raymer
|
||||
//
|
||||
// MIGRATION DETAILS: Migrated from legacy databaseUtil + logConsoleAndDb to PlatformServiceMixin
|
||||
// - Replaced logConsoleAndDb() with this.$logAndConsole()
|
||||
// - Replaced databaseUtil.* calls with mixin methods
|
||||
// - Removed PlatformServiceFactory direct usage in favor of mixin
|
||||
//
|
||||
// TESTING NEEDED: Contact import functionality
|
||||
// 1. Test contact import via URL: /contact-import?contacts=[{"did":"did:example:123","name":"Alice"}]
|
||||
// 2. Test JWT import via URL path: /contact-import/[JWT_TOKEN]
|
||||
// 3. Test manual JWT input via textarea
|
||||
// 4. Test duplicate contact detection and field comparison
|
||||
// 5. Test error scenarios: invalid JWT, malformed data, network issues
|
||||
// 6. Verify error logging appears correctly
|
||||
//
|
||||
// Test URLs:
|
||||
// /contact-import (manual input)
|
||||
// /contact-import?contacts=[{"did":"did:test:123","name":"Test User"}]
|
||||
|
||||
@Component({
|
||||
components: { EntityIcon, OfferDialog, QuickNav },
|
||||
mixins: [PlatformServiceMixin],
|
||||
})
|
||||
export default class ContactImportView extends Vue {
|
||||
/** Notification function injected by Vue */
|
||||
@@ -388,7 +354,7 @@ export default class ContactImportView extends Vue {
|
||||
* Initializes component settings from active account
|
||||
*/
|
||||
private async initializeSettings() {
|
||||
const settings = await databaseUtil.retrieveSettingsForActiveAccount();
|
||||
const settings = await this.$accountSettings();
|
||||
this.activeDid = settings.activeDid || "";
|
||||
this.apiServer = settings.apiServer || "";
|
||||
}
|
||||
@@ -452,13 +418,8 @@ export default class ContactImportView extends Vue {
|
||||
this.contactsImporting = contacts;
|
||||
this.contactsSelected = new Array(this.contactsImporting.length).fill(true);
|
||||
|
||||
const platformService = PlatformServiceFactory.getInstance();
|
||||
const dbAllContacts = await platformService.dbQuery(
|
||||
"SELECT * FROM contacts",
|
||||
);
|
||||
const baseContacts = databaseUtil.mapQueryResultToValues(
|
||||
dbAllContacts,
|
||||
) as unknown as Contact[];
|
||||
// Get all existing contacts for comparison
|
||||
const baseContacts = await this.$getAllContacts();
|
||||
|
||||
// Check for existing contacts and differences
|
||||
for (let i = 0; i < this.contactsImporting.length; i++) {
|
||||
@@ -542,7 +503,7 @@ export default class ContactImportView extends Vue {
|
||||
}
|
||||
} catch (error) {
|
||||
const fullError = "Error importing contacts: " + errorStringForLog(error);
|
||||
logConsoleAndDb(fullError, true);
|
||||
this.$logAndConsole(fullError, true);
|
||||
this.$notify(
|
||||
{
|
||||
group: "alert",
|
||||
@@ -570,30 +531,14 @@ export default class ContactImportView extends Vue {
|
||||
if (this.contactsSelected[i]) {
|
||||
const contact = this.contactsImporting[i];
|
||||
const existingContact = this.contactsExisting[contact.did];
|
||||
const platformService = PlatformServiceFactory.getInstance();
|
||||
|
||||
// Convert contact to database record format
|
||||
const contactToStore = contactToDbRecord(contact);
|
||||
|
||||
if (existingContact) {
|
||||
// Update existing contact
|
||||
const { sql, params } = databaseUtil.generateUpdateStatement(
|
||||
contactToStore as unknown as Record<string, unknown>,
|
||||
"contacts",
|
||||
"did = ?",
|
||||
[contact.did],
|
||||
);
|
||||
await platformService.dbExec(sql, params);
|
||||
|
||||
await this.$updateContact(contact.did, contact);
|
||||
updatedCount++;
|
||||
} else {
|
||||
// Add new contact
|
||||
const { sql, params } = databaseUtil.generateInsertStatement(
|
||||
contactToStore as unknown as Record<string, unknown>,
|
||||
"contacts",
|
||||
);
|
||||
await platformService.dbExec(sql, params);
|
||||
|
||||
await this.$insertContact(contact);
|
||||
importedCount++;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -15,9 +15,9 @@
|
||||
<code>timesafari://{{ formattedPath }}</code>
|
||||
<div class="debug-info">
|
||||
<h4>Parameters:</h4>
|
||||
<pre>{{ JSON.stringify(route.params, null, 2) }}</pre>
|
||||
<pre>{{ JSON.stringify($route.params, null, 2) }}</pre>
|
||||
<h4>Query:</h4>
|
||||
<pre>{{ JSON.stringify(route.query, null, 2) }}</pre>
|
||||
<pre>{{ JSON.stringify($route.query, null, 2) }}</pre>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
@@ -40,7 +40,7 @@
|
||||
|
||||
<script lang="ts">
|
||||
// TODO: Testing Required - Vue 3 to Options API + PlatformServiceMixin Migration
|
||||
// Priority: Medium | Migrated: 2025-01-06 | Author: Matthew Raymer
|
||||
// Priority: Medium | Migrated: 2025-07-06 | Author: Matthew Raymer
|
||||
//
|
||||
// MIGRATION DETAILS: Converted from Vue 3 Composition API to Options API for PlatformServiceMixin
|
||||
// - Replaced logConsoleAndDb() with this.$logAndConsole()
|
||||
@@ -56,6 +56,7 @@
|
||||
// Test URL: timesafari://invalid/path?param=test
|
||||
|
||||
import { Component, Vue } from "vue-facing-decorator";
|
||||
import { RouteLocationNormalizedLoaded, Router } from "vue-router";
|
||||
import { VALID_DEEP_LINK_ROUTES } from "../interfaces/deepLinks";
|
||||
import { logger } from "../utils/logger";
|
||||
import { PlatformServiceMixin } from "@/utils/PlatformServiceMixin";
|
||||
@@ -64,6 +65,11 @@ import { PlatformServiceMixin } from "@/utils/PlatformServiceMixin";
|
||||
mixins: [PlatformServiceMixin],
|
||||
})
|
||||
export default class DeepLinkErrorView extends Vue {
|
||||
/** Current route instance */
|
||||
$route!: RouteLocationNormalizedLoaded;
|
||||
/** Router instance for navigation */
|
||||
$router!: Router;
|
||||
|
||||
validRoutes = VALID_DEEP_LINK_ROUTES;
|
||||
|
||||
// Extract error information from query params
|
||||
|
||||
Reference in New Issue
Block a user