docs: update backend logging documentation and rename to LFX Projects (#32)

asithade · web-flow · commit e955522863b6 · 2025-08-08T15:55:58.000-07:00
* docs: update backend logging documentation and rename to LFX Projects - Document dual logger architecture (serverLogger + httpLogger) - Add LOG_LEVEL environment variable configuration - Update security redaction paths for both loggers - Add comprehensive error handling integration examples - Document server startup logging with environment details - Add logger export and reusability patterns - Update production considerations with conditional stack traces - Enhance formatting configuration documentation - Add clear guidance on when to use each logger type - Rename application from "LFX Projects Self-Service" to "LFX Projects" - Update all references and branding to reflect new name - Update authentication documentation with new application name Generated with [Claude Code](https://claude.ai/code) Signed-off-by: Asitha de Silva <asithade@gmail.com> * fix: address pr comments and fix lfx v2 service url Signed-off-by: Asitha de Silva <asithade@gmail.com> --------- Signed-off-by: Asitha de Silva <asithade@gmail.com>
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -1,6 +1,7 @@
 {
   "cSpell.words": [
     "animateonscroll",
+    "AUTHELIA",
     "autorestart",
     "cloudops",
     "confirmdialog",
diff --git a/apps/lfx-pcc/.env.example b/apps/lfx-pcc/.env.example
@@ -1,6 +1,7 @@
 # Environment Configuration
 ENV=development
 PCC_BASE_URL=http://localhost:4200
+LOG_LEVEL=info
 
 # Auth0 Authentication Configuration
 # Get these values from your Auth0 dashboard
@@ -25,4 +26,5 @@ SUPABASE_STORAGE_BUCKET=your-supabase-bucket-name
 TEST_USERNAME=your-test-username
 TEST_PASSWORD=your-test-password
 
+# LOCAL ONLY FOR AUTHELIA
 NODE_TLS_REJECT_UNAUTHORIZED=0
diff --git a/apps/lfx-pcc/e2e/homepage-robust.spec.ts b/apps/lfx-pcc/e2e/homepage-robust.spec.ts
@@ -1,7 +1,7 @@
 // Copyright The Linux Foundation and each contributor to LFX.
 // SPDX-License-Identifier: MIT
 
-import { test, expect } from '@playwright/test';
+import { expect, test } from '@playwright/test';
 
 test.describe('Homepage - Robust Tests', () => {
   test.beforeEach(async ({ page }) => {
@@ -13,7 +13,7 @@ test.describe('Homepage - Robust Tests', () => {
 
   test.describe('Page Structure and Components', () => {
     test('should have correct page structure with main sections', async ({ page }) => {
-      await expect(page).toHaveTitle('LFX Projects Self-Service');
+      await expect(page).toHaveTitle('LFX Projects');
       await expect(page).toHaveURL('/');
 
       // Check main homepage component is present
@@ -320,7 +320,7 @@ test.describe('Homepage - Robust Tests', () => {
       if (isMobile) {
         // Search in header should be hidden on mobile
         await expect(page.getByPlaceholder('Search projects...')).toBeHidden();
-        await expect(page.getByText('Projects Self-Service')).toBeHidden();
+        await expect(page.getByText('Projects', { exact: true })).toBeHidden();
       }
 
       // Logo should still be visible
@@ -336,7 +336,7 @@ test.describe('Homepage - Robust Tests', () => {
 
       // Header elements should be visible on tablet (medium and up)
       await expect(page.getByPlaceholder('Search projects...')).toBeVisible();
-      await expect(page.getByText('Projects Self-Service')).toBeVisible();
+      await expect(page.getByText('Projects', { exact: true })).toBeVisible();
       await expect(page.getByAltText('LFX Logo')).toBeVisible();
     });
 
@@ -349,7 +349,7 @@ test.describe('Homepage - Robust Tests', () => {
 
       // Header elements should be visible on desktop
       await expect(page.getByPlaceholder('Search projects...')).toBeVisible();
-      await expect(page.getByText('Projects Self-Service')).toBeVisible();
+      await expect(page.getByText('Projects', { exact: true })).toBeVisible();
       await expect(page.getByAltText('LFX Logo')).toBeVisible();
     });
   });
diff --git a/apps/lfx-pcc/e2e/homepage.spec.ts b/apps/lfx-pcc/e2e/homepage.spec.ts
@@ -28,7 +28,7 @@ test.describe('Homepage', () => {
     // Check for logo and brand
     await expect(page.getByRole('button', { name: 'Go to home page' })).toBeVisible();
     await expect(page.getByAltText('LFX Logo')).toBeVisible();
-    await expect(page.getByText('Projects Self-Service')).toBeVisible();
+    await expect(page.getByText('Projects', { exact: true })).toBeVisible();
 
     // Header search should be visible on desktop (md and larger)
     await expect(page.getByPlaceholder('Search projects...')).toBeVisible();
@@ -47,7 +47,7 @@ test.describe('Homepage', () => {
 
     // Header search and brand text should be hidden on mobile
     await expect(page.getByPlaceholder('Search projects...')).toBeHidden();
-    await expect(page.getByText('Projects Self-Service')).toBeHidden();
+    await expect(page.getByText('Projects', { exact: true })).toBeHidden();
 
     // Mobile search toggle button should be visible
     await expect(page.getByTestId('mobile-search-toggle')).toBeVisible();
@@ -205,7 +205,7 @@ test.describe('Homepage', () => {
 
     // On mobile, header search and brand text should be hidden
     await expect(page.getByPlaceholder('Search projects...')).toBeHidden();
-    await expect(page.getByText('Projects Self-Service')).toBeHidden();
+    await expect(page.getByText('Projects', { exact: true })).toBeHidden();
 
     // Logo should still be visible
     await expect(page.getByAltText('LFX Logo')).toBeVisible();
diff --git a/apps/lfx-pcc/e2e/project-dashboard-robust.spec.ts b/apps/lfx-pcc/e2e/project-dashboard-robust.spec.ts
@@ -1,7 +1,7 @@
 // Copyright The Linux Foundation and each contributor to LFX.
 // SPDX-License-Identifier: MIT
 
-import { test, expect } from '@playwright/test';
+import { expect, test } from '@playwright/test';
 
 test.describe('Project Dashboard - Robust Tests', () => {
   test.beforeEach(async ({ page }) => {
@@ -19,7 +19,7 @@ test.describe('Project Dashboard - Robust Tests', () => {
 
   test.describe('Page Structure and Components', () => {
     test('should have correct page structure with main content', async ({ page }) => {
-      await expect(page).toHaveTitle('LFX Projects Self-Service');
+      await expect(page).toHaveTitle('LFX Projects');
       await expect(page).toHaveURL(/\/project\/\w+$/);
 
       // Check main project component is present
@@ -249,8 +249,8 @@ test.describe('Project Dashboard - Robust Tests', () => {
       // Search bar should be hidden on mobile (responsive design)
       await expect(page.getByPlaceholder('Search projects...')).toBeHidden();
 
-      // Projects Self-Service text should be hidden on mobile
-      await expect(page.getByText('Projects Self-Service')).toBeHidden();
+      // Projects text should be hidden on mobile
+      await expect(page.getByText('Projects', { exact: true })).toBeHidden();
 
       // Logo should still be visible
       await expect(page.getByAltText('LFX Logo')).toBeVisible();
@@ -267,7 +267,7 @@ test.describe('Project Dashboard - Robust Tests', () => {
 
       // Header elements should be visible on tablet (medium and up)
       await expect(page.getByPlaceholder('Search projects...')).toBeVisible();
-      await expect(page.getByText('Projects Self-Service')).toBeVisible();
+      await expect(page.getByText('Projects', { exact: true })).toBeVisible();
       await expect(page.getByAltText('LFX Logo')).toBeVisible();
     });
   });
diff --git a/apps/lfx-pcc/e2e/project-dashboard.spec.ts b/apps/lfx-pcc/e2e/project-dashboard.spec.ts
@@ -1,7 +1,7 @@
 // Copyright The Linux Foundation and each contributor to LFX.
 // SPDX-License-Identifier: MIT
 
-import { test, expect } from '@playwright/test';
+import { expect, test } from '@playwright/test';
 
 test.describe('Project Dashboard', () => {
   test.beforeEach(async ({ page }) => {
@@ -19,7 +19,7 @@ test.describe('Project Dashboard', () => {
 
   test.describe('Navigation and Layout', () => {
     test('should display correct page title and URL', async ({ page }) => {
-      await expect(page).toHaveTitle('LFX Projects Self-Service');
+      await expect(page).toHaveTitle('LFX Projects');
       await expect(page).toHaveURL(/\/project\/\w+$/);
     });
 
@@ -34,13 +34,13 @@ test.describe('Project Dashboard', () => {
       if (isMobile) {
         // On mobile: search and brand text should be hidden
         await expect(page.getByPlaceholder('Search projects...')).toBeHidden();
-        await expect(page.getByText('Projects Self-Service')).toBeHidden();
+        await expect(page.getByText('Projects', { exact: true })).toBeHidden();
         // Mobile search toggle should be visible
         await expect(page.getByTestId('mobile-search-toggle')).toBeVisible();
       } else {
         // On desktop: search and brand text should be visible
         await expect(page.getByPlaceholder('Search projects...')).toBeVisible();
-        await expect(page.getByText('Projects Self-Service')).toBeVisible();
+        await expect(page.getByText('Projects', { exact: true })).toBeVisible();
         // Mobile search toggle should be hidden
         await expect(page.getByTestId('mobile-search-toggle')).toBeHidden();
       }
@@ -278,8 +278,8 @@ test.describe('Project Dashboard', () => {
       // Search bar should be hidden on mobile (responsive design)
       await expect(page.getByPlaceholder('Search projects...')).toBeHidden();
 
-      // Projects Self-Service text should also be hidden on mobile
-      await expect(page.getByText('Projects Self-Service')).toBeHidden();
+      // Projects text should also be hidden on mobile
+      await expect(page.getByText('Projects', { exact: true })).toBeHidden();
 
       // Mobile search toggle should be visible
       await expect(page.getByTestId('mobile-search-toggle')).toBeVisible();
diff --git a/apps/lfx-pcc/src/app/shared/components/header/header.component.html b/apps/lfx-pcc/src/app/shared/components/header/header.component.html
@@ -9,13 +9,13 @@
           <div class="border-r border-solid border-gray-200 pr-2">
             <img src="/images/lfx-logo.svg" alt="LFX Logo" class="w-auto h-5" />
           </div>
-          <span class="text-xl font-display text-gray-900 hidden md:block">Projects Self-Service</span>
+          <span class="text-xl font-display text-gray-900 hidden md:block">Projects</span>
         </button>
       </ng-template>
 
       <ng-template #end>
         <div class="flex items-center gap-4">
-          <lfx-tools kit="736c27f195" product="projects-self-service"></lfx-tools>
+          <lfx-tools kit="736c27f195" product="projects"></lfx-tools>
           <div class="flex items-center gap-6">
             <!-- Mobile Search Toggle -->
             <button
diff --git a/apps/lfx-pcc/src/app/shared/components/header/header.component.ts b/apps/lfx-pcc/src/app/shared/components/header/header.component.ts
@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: MIT
 
 import { CommonModule } from '@angular/common';
-import { Component, CUSTOM_ELEMENTS_SCHEMA, inject, signal, WritableSignal, viewChild, ElementRef } from '@angular/core';
+import { Component, CUSTOM_ELEMENTS_SCHEMA, ElementRef, inject, signal, viewChild, WritableSignal } from '@angular/core';
 import { FormControl, ReactiveFormsModule } from '@angular/forms';
 import { Router, RouterModule } from '@angular/router';
 import { AvatarComponent } from '@components/avatar/avatar.component';
@@ -42,7 +42,7 @@ export class HeaderComponent {
     {
       label: 'Developer Settings',
       icon: 'fa-light fa-cog',
-      url: environment.urls.profile + '/developer-settings',
+      url: environment.urls.profile + 'developer-settings',
       target: '_blank',
     },
     {
diff --git a/apps/lfx-pcc/src/index.html b/apps/lfx-pcc/src/index.html
@@ -5,7 +5,7 @@
 <html lang="en">
   <head>
     <meta charset="utf-8" />
-    <title>LFX Projects Self-Service</title>
+    <title>LFX Projects</title>
     <base href="/" />
     <meta name="viewport" content="width=device-width, initial-scale=1" />
     <link rel="icon" type="image/x-icon" href="favicon.ico" />
diff --git a/apps/lfx-pcc/src/server/server.ts b/apps/lfx-pcc/src/server/server.ts
@@ -43,7 +43,7 @@ const app = express();
 const serverLogger = pino({
   level: process.env['LOG_LEVEL'] || 'info',
   redact: {
-    paths: ['access_token', 'refresh_token', 'authorization', 'cookie'],
+    paths: ['access_token', 'refresh_token', 'authorization', 'cookie', 'req.headers.authorization', 'req.headers.cookie', 'res.headers["set-cookie"]'],
     remove: true,
   },
   formatters: {
@@ -92,10 +92,10 @@ const httpLogger = pinoHttp({
     },
   },
   redact: {
-    paths: ['req.headers.authorization', 'req.headers.cookie', 'res.headers["set-cookie"]'],
+    paths: ['access_token', 'refresh_token', 'authorization', 'cookie', 'req.headers.authorization', 'req.headers.cookie', 'res.headers["set-cookie"]'],
     remove: true,
   },
-  level: 'info',
+  level: process.env['LOG_LEVEL'] || 'info',
   formatters: {
     level: (label) => {
       return { level: label.toUpperCase() };
diff --git a/apps/lfx-pcc/src/server/services/microservice-proxy.service.ts b/apps/lfx-pcc/src/server/services/microservice-proxy.service.ts
@@ -29,7 +29,7 @@ export class MicroserviceProxyService {
       }
 
       const MICROSERVICE_URLS: MicroserviceUrls = {
-        LFX_V2_SERVICE: process.env['LFX_V2_SERVICE_URL'] || 'http://lfx-api.k8s.orb.local',
+        LFX_V2_SERVICE: process.env['LFX_V2_SERVICE'] || 'http://lfx-api.k8s.orb.local',
       };
 
       const baseUrl = MICROSERVICE_URLS[service];
diff --git a/docs/architecture/backend/authentication.md b/docs/architecture/backend/authentication.md
@@ -31,7 +31,6 @@ const authConfig: ConfigParams = {
   clientID: process.env['PCC_AUTH0_CLIENT_ID'] || '1234',
   issuerBaseURL: process.env['PCC_AUTH0_ISSUER_BASE_URL'] || 'https://example.com',
   secret: process.env['PCC_AUTH0_SECRET'] || 'sufficiently-long-string',
-  idTokenSigningAlg: 'HS256',
   authorizationParams: {
     response_type: 'code',
     audience: process.env['PCC_AUTH0_AUDIENCE'] || 'https://example.com',
diff --git a/docs/architecture/backend/logging-monitoring.md b/docs/architecture/backend/logging-monitoring.md

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"cSpell.words": [`
`3`	`3`	`"animateonscroll",`
	`4`	`+ "AUTHELIA",`
`4`	`5`	`"autorestart",`
`5`	`6`	`"cloudops",`
`6`	`7`	`"confirmdialog",`