Browse Source

ClaimReportCertificateView

pull/142/head
Matthew Raymer 3 weeks ago
parent
commit
698bee6a27
  1. 157
      docs/migration-testing/CLAIMREPORTCERTIFICATEVIEW_MIGRATION.md
  2. 7
      src/constants/notifications.ts
  3. 106
      src/views/ClaimReportCertificateView.vue

157
docs/migration-testing/CLAIMREPORTCERTIFICATEVIEW_MIGRATION.md

@ -0,0 +1,157 @@
# ClaimReportCertificateView.vue Migration Documentation
**Migration Start**: 2025-07-08 11:25 UTC
**Component**: ClaimReportCertificateView.vue
**Priority**: High (Critical User Journey)
**Location**: `src/views/ClaimReportCertificateView.vue`
## Pre-Migration Analysis
### 🔍 **Current State Assessment**
#### Database Operations
- **Legacy Pattern**: Uses `databaseUtil.retrieveSettingsForActiveAccount()`
- **Raw SQL**: Uses `platformService.dbQuery("SELECT * FROM contacts")`
- **Data Mapping**: Uses `databaseUtil.mapQueryResultToValues()`
- **PlatformServiceFactory**: Direct usage instead of mixin
#### Notification Usage
- **Direct $notify Calls**: 1 instance found
- **Notification Type**: danger (error handling)
- **Message**: Error loading claim
#### Template Complexity
- **Simple Template**: Minimal template with canvas element
- **Canvas Rendering**: Complex canvas drawing logic in component
- **QR Code Generation**: Uses QRCode library for certificate generation
### 📋 **Migration Requirements**
#### 1. Database Migration
- [ ] Replace `databaseUtil.retrieveSettingsForActiveAccount()` with PlatformServiceMixin
- [ ] Replace raw SQL query with service method
- [ ] Replace `databaseUtil.mapQueryResultToValues()` with proper typing
- [ ] Replace PlatformServiceFactory with PlatformServiceMixin
#### 2. SQL Abstraction
- [ ] Replace `platformService.dbQuery("SELECT * FROM contacts")` with `$getAllContacts()`
- [ ] Use proper service methods for all database operations
#### 3. Notification Migration
- [ ] Extract notification message to constants
- [ ] Replace direct `$notify()` call with helper method
#### 4. Template Streamlining
- [ ] Extract canvas drawing logic to computed properties where possible
- [ ] Simplify component methods
## Migration Plan
### 🎯 **Step 1: Database Migration**
Replace legacy database operations with PlatformServiceMixin methods:
```typescript
// Before
const settings = await databaseUtil.retrieveSettingsForActiveAccount();
const platformService = PlatformServiceFactory.getInstance();
const dbAllContacts = await platformService.dbQuery("SELECT * FROM contacts");
const allContacts = databaseUtil.mapQueryResultToValues(dbAllContacts);
// After
const settings = await this.$settings();
this.allContacts = await this.$getAllContacts();
```
### 🎯 **Step 2: Notification Migration**
Extract notification message and use helper method:
```typescript
// Before
this.$notify({
group: "alert",
type: "danger",
title: "Error",
text: "There was a problem loading the claim.",
});
// After
this.notify.error(NOTIFY_ERROR_LOADING_CLAIM.message, TIMEOUTS.LONG);
```
### 🎯 **Step 3: Template Optimization**
Extract canvas constants and simplify methods:
```typescript
// Add computed properties for canvas dimensions
get CANVAS_WIDTH() {
return 1100;
}
get CANVAS_HEIGHT() {
return 850;
}
```
## Migration Progress
### ✅ **Completed Steps**
- [ ] Pre-migration analysis
- [ ] Migration plan created
- [ ] Documentation started
### ✅ **Completed Steps**
- [x] Pre-migration analysis
- [x] Migration plan created
- [x] Documentation started
- [x] Database migration
- [x] Notification migration
- [x] Template streamlining
- [x] Validation testing (linting passed)
### ✅ **Completed**
- [x] All migration requirements met
- [x] Documentation updated
### 📋 **Remaining**
- [ ] Human testing
## Expected Outcomes
### 🎯 **Technical Improvements**
- **Database Security**: Eliminate raw SQL queries
- **Code Quality**: Standardized notification patterns
- **Maintainability**: Simplified database operations
- **Type Safety**: Proper TypeScript typing
### 📊 **Performance Benefits**
- **Database Efficiency**: Optimized contact retrieval
- **Memory Usage**: Reduced template complexity
- **User Experience**: Consistent notification behavior
### 🔒 **Security Enhancements**
- **SQL Injection Prevention**: Parameterized queries
- **Error Handling**: Standardized error messaging
- **Input Validation**: Centralized validation through services
## Testing Requirements
### 🧪 **Functionality Testing**
- [ ] Certificate generation workflow
- [ ] Canvas rendering process
- [ ] QR code generation
- [ ] Error handling scenarios
### 📱 **Platform Testing**
- [ ] Web browser functionality
- [ ] Mobile app compatibility
- [ ] Desktop app performance
### 🔍 **Validation Testing**
- [ ] Migration validation script
- [ ] Linting compliance
- [ ] TypeScript compilation
- [ ] Notification completeness
---
*Migration Status: ✅ COMPLETE*
*Next Update: After human testing*

7
src/constants/notifications.ts

@ -161,6 +161,13 @@ export const NOTIFY_CONFIRMATIONS_ONLY_SUCCESS = {
message: "Your confirmations have been recorded.", message: "Your confirmations have been recorded.",
}; };
// ClaimReportCertificateView.vue specific constants
// Used in: ClaimReportCertificateView.vue (fetchClaim method - error loading claim)
export const NOTIFY_ERROR_LOADING_CLAIM = {
title: "Error",
message: "There was a problem loading the claim.",
};
// ContactsView.vue specific constants // ContactsView.vue specific constants
// Used in: ContactsView.vue (processInviteJwt method - blank invite error) // Used in: ContactsView.vue (processInviteJwt method - blank invite error)
export const NOTIFY_BLANK_INVITE = { export const NOTIFY_BLANK_INVITE = {

106
src/views/ClaimReportCertificateView.vue

@ -12,29 +12,48 @@ import { nextTick } from "vue";
import QRCode from "qrcode"; import QRCode from "qrcode";
import { APP_SERVER, NotificationIface } from "../constants/app"; import { APP_SERVER, NotificationIface } from "../constants/app";
import * as databaseUtil from "../db/databaseUtil";
import * as endorserServer from "../libs/endorserServer"; import * as endorserServer from "../libs/endorserServer";
import { import {
GenericCredWrapper, GenericCredWrapper,
GenericVerifiableCredential, GenericVerifiableCredential,
} from "../interfaces/common"; } from "../interfaces/common";
import { logger } from "../utils/logger"; import { logger } from "../utils/logger";
import { PlatformServiceFactory } from "@/services/PlatformServiceFactory";
import { Contact } from "@/db/tables/contacts"; import { Contact } from "@/db/tables/contacts";
@Component import { PlatformServiceMixin } from "@/utils/PlatformServiceMixin";
import { createNotifyHelpers, TIMEOUTS } from "@/utils/notify";
import { NOTIFY_ERROR_LOADING_CLAIM } from "@/constants/notifications";
@Component({
mixins: [PlatformServiceMixin],
})
export default class ClaimReportCertificateView extends Vue { export default class ClaimReportCertificateView extends Vue {
$notify!: (notification: NotificationIface, timeout?: number) => void; $notify!: (notification: NotificationIface, timeout?: number) => void;
// Notification helper
notify!: ReturnType<typeof createNotifyHelpers>;
activeDid = ""; activeDid = "";
allMyDids: Array<string> = []; allMyDids: Array<string> = [];
apiServer = ""; apiServer = "";
claimId = ""; claimId = "";
claimData = null; claimData = null;
allContacts: Contact[] = [];
endorserServer = endorserServer; endorserServer = endorserServer;
// Computed properties for canvas optimization
get CANVAS_WIDTH() {
return 1100;
}
get CANVAS_HEIGHT() {
return 850;
}
async created() { async created() {
const settings = await databaseUtil.retrieveSettingsForActiveAccount(); // Initialize notification helper
this.notify = createNotifyHelpers(this.$notify);
const settings = await this.$settings();
this.activeDid = settings.activeDid || ""; this.activeDid = settings.activeDid || "";
this.apiServer = settings.apiServer || ""; this.apiServer = settings.apiServer || "";
const pathParams = window.location.pathname.substring( const pathParams = window.location.pathname.substring(
@ -60,12 +79,7 @@ export default class ClaimReportCertificateView extends Vue {
} }
} catch (error) { } catch (error) {
logger.error("Failed to load claim:", error); logger.error("Failed to load claim:", error);
this.$notify({ this.notify.error(NOTIFY_ERROR_LOADING_CLAIM.message, TIMEOUTS.LONG);
group: "alert",
type: "danger",
title: "Error",
text: "There was a problem loading the claim.",
});
} }
} }
@ -74,22 +88,16 @@ export default class ClaimReportCertificateView extends Vue {
return; return;
} }
const platformService = PlatformServiceFactory.getInstance(); // Load contacts if not already loaded
const dbAllContacts = await platformService.dbQuery( if (this.allContacts.length === 0) {
"SELECT * FROM contacts", this.allContacts = await this.$getAllContacts();
); }
const allContacts = databaseUtil.mapQueryResultToValues(
dbAllContacts,
) as unknown as Contact[];
const canvas = this.$refs.claimCanvas as HTMLCanvasElement; const canvas = this.$refs.claimCanvas as HTMLCanvasElement;
if (canvas) { if (canvas) {
const CANVAS_WIDTH = 1100;
const CANVAS_HEIGHT = 850;
// size to approximate portrait of 8.5"x11" // size to approximate portrait of 8.5"x11"
canvas.width = CANVAS_WIDTH; canvas.width = this.CANVAS_WIDTH;
canvas.height = CANVAS_HEIGHT; canvas.height = this.CANVAS_HEIGHT;
const ctx = canvas.getContext("2d"); const ctx = canvas.getContext("2d");
if (ctx) { if (ctx) {
// Load the background image // Load the background image
@ -97,7 +105,13 @@ export default class ClaimReportCertificateView extends Vue {
backgroundImage.src = "/img/background/cert-frame-2.jpg"; backgroundImage.src = "/img/background/cert-frame-2.jpg";
backgroundImage.onload = async () => { backgroundImage.onload = async () => {
// Draw the background image // Draw the background image
ctx.drawImage(backgroundImage, 0, 0, CANVAS_WIDTH, CANVAS_HEIGHT); ctx.drawImage(
backgroundImage,
0,
0,
this.CANVAS_WIDTH,
this.CANVAS_HEIGHT,
);
// Set font and styles // Set font and styles
ctx.fillStyle = "black"; ctx.fillStyle = "black";
@ -111,8 +125,8 @@ export default class ClaimReportCertificateView extends Vue {
const claimTypeWidth = ctx.measureText(claimTypeText).width; const claimTypeWidth = ctx.measureText(claimTypeText).width;
ctx.fillText( ctx.fillText(
claimTypeText, claimTypeText,
(CANVAS_WIDTH - claimTypeWidth) / 2, // Center horizontally (this.CANVAS_WIDTH - claimTypeWidth) / 2, // Center horizontally
CANVAS_HEIGHT * 0.33, this.CANVAS_HEIGHT * 0.33,
); );
if (claimData.claim.agent) { if (claimData.claim.agent) {
@ -121,19 +135,21 @@ export default class ClaimReportCertificateView extends Vue {
const presentedWidth = ctx.measureText(presentedText).width; const presentedWidth = ctx.measureText(presentedText).width;
ctx.fillText( ctx.fillText(
presentedText, presentedText,
(CANVAS_WIDTH - presentedWidth) / 2, // Center horizontally (this.CANVAS_WIDTH - presentedWidth) / 2, // Center horizontally
CANVAS_HEIGHT * 0.37, this.CANVAS_HEIGHT * 0.37,
); );
const agentText = endorserServer.didInfoForCertificate( const agentText = endorserServer.didInfoForCertificate(
claimData.claim.agent, typeof claimData.claim.agent === "string"
allContacts, ? claimData.claim.agent
: claimData.claim.agent?.identifier,
this.allContacts,
); );
ctx.font = "bold 20px Arial"; ctx.font = "bold 20px Arial";
const agentWidth = ctx.measureText(agentText).width; const agentWidth = ctx.measureText(agentText).width;
ctx.fillText( ctx.fillText(
agentText, agentText,
(CANVAS_WIDTH - agentWidth) / 2, // Center horizontally (this.CANVAS_WIDTH - agentWidth) / 2, // Center horizontally
CANVAS_HEIGHT * 0.4, this.CANVAS_HEIGHT * 0.4,
); );
} }
@ -148,8 +164,8 @@ export default class ClaimReportCertificateView extends Vue {
const descriptionWidth = ctx.measureText(descriptionLine).width; const descriptionWidth = ctx.measureText(descriptionLine).width;
ctx.fillText( ctx.fillText(
descriptionLine, descriptionLine,
(CANVAS_WIDTH - descriptionWidth) / 2, (this.CANVAS_WIDTH - descriptionWidth) / 2,
CANVAS_HEIGHT * 0.45, this.CANVAS_HEIGHT * 0.45,
); );
} }
@ -160,18 +176,26 @@ export default class ClaimReportCertificateView extends Vue {
"Issued by " + "Issued by " +
endorserServer.didInfoForCertificate( endorserServer.didInfoForCertificate(
claimData.issuer, claimData.issuer,
allContacts, this.allContacts,
); );
ctx.fillText(issuerText, CANVAS_WIDTH * 0.3, CANVAS_HEIGHT * 0.6); ctx.fillText(
issuerText,
this.CANVAS_WIDTH * 0.3,
this.CANVAS_HEIGHT * 0.6,
);
} }
// Draw claim ID // Draw claim ID
ctx.font = "14px Arial"; ctx.font = "14px Arial";
ctx.fillText(this.claimId, CANVAS_WIDTH * 0.3, CANVAS_HEIGHT * 0.7); ctx.fillText(
this.claimId,
this.CANVAS_WIDTH * 0.3,
this.CANVAS_HEIGHT * 0.7,
);
ctx.fillText( ctx.fillText(
"via EndorserSearch.com", "via EndorserSearch.com",
CANVAS_WIDTH * 0.3, this.CANVAS_WIDTH * 0.3,
CANVAS_HEIGHT * 0.73, this.CANVAS_HEIGHT * 0.73,
); );
// Generate and draw QR code // Generate and draw QR code
@ -184,7 +208,11 @@ export default class ClaimReportCertificateView extends Vue {
color: { light: "#0000" /* Transparent background */ }, color: { light: "#0000" /* Transparent background */ },
}, },
); );
ctx.drawImage(qrCodeCanvas, CANVAS_WIDTH * 0.6, CANVAS_HEIGHT * 0.55); ctx.drawImage(
qrCodeCanvas,
this.CANVAS_WIDTH * 0.6,
this.CANVAS_HEIGHT * 0.55,
);
}; };
} }
} }

Loading…
Cancel
Save