feat(#161): refactor string literals to typed enums #216

naaa760 · 2025-06-14T17:05:22Z

#161

Purpose of the PR*

Refactor hardcoded string literals into typed enums to improve type safety and maintainability across the extension.

Priority*

High: This PR needs to be merged first, before other tasks.
Medium: This PR should be merged quickly to prevent conflicts due to common changes. (default)
Low: This PR does not affect other tasks, so it can be merged later.

Changes*

Added new enums in packages/shared/lib/constants/enums/:
- MessageType, MessageAction
- CaptureState, CaptureType
- RecordType, RecordSource, LogMethod
- Chrome-specific enums
Updated files to use new enums:
- Background script
- Interceptors (network, console, storage)
- Event listeners
- Screen capture functionality

How to check the feature

Run pnpm run:chrome:local
Test core features: screenshots, console logging, network requests
Verify no TypeScript errors: pnpm type-check

Reference

Improves code quality by replacing string literals with type-safe enums

develop to main

github-actions · 2025-06-14T17:05:31Z

Hey @naaa760,
Thanks for another PR! 🚀

ionleu

Good job, @naaa760 !

I have just a few questions, but overall looks great! 🔥

ionleu · 2025-06-14T17:47:46Z

packages/i18n/lib/index.ts

@@ -1,4 +1,4 @@
 import type { t as t_dev } from './i18n-dev.js';
-import { t as t_dev_or_prod } from './i18n.js';
+import { t as t_dev_or_prod } from './i18n-dev.js';


Hmm 🤔
Do we need this change?

packages/shared/README.md

packages/shared/lib/constants/enums/chrome-extension.enum.ts

naaa760 · 2025-06-14T19:27:50Z

Good job, @naaa760 !

I have just a few questions, but overall looks great! 🔥

Thank you! @ionleu for your appreciation!

ionleu · 2025-06-15T16:46:41Z

pages/content/src/interceptors/network/xhr.interceptor.ts

  ): void {
    this._requestDetails = {
      method,
      url: url.toString(),
      requestStart: new Date().toISOString(),
      requestBody: null,
    };
-    originalOpen.apply(this, [method, url, ...rest]);


@naaa760, can you please elaborate a bit on this change?

This change refactors the XHR interceptor to use the new enums (RecordType, RecordSource, LogMethod) instead of hardcoded strings like 'network', 'client', and 'error' for better type safety.

But I see the username, password has been added, why?

cc @naaa760

CODE_OF_CONDUCT.md

ionleu · 2025-06-15T16:53:35Z

chrome-extension/src/utils/manage-records.util.ts

@@ -1,14 +1,12 @@
 import { v4 as uuidv4 } from 'uuid';

-import { deepRedactSensitiveInfo } from '@extension/shared';
+import { deepRedactSensitiveInfo, RecordType } from '@extension/shared';

 const restricted = ['https://api.briehq.com']; // 'extend.iife',  'kbmbnelnoppneadncmmkfikbcgmilbao'  Note: it blocks the logs


I see some differences between current changes in develop branch.
Can you pull the latests changes from develop branch?

@naaa760,
I still see the issue with missing changes that are not matching the develop branch.

@naaa760,
can you please pull the latest changes from upstream develop branch?

package-lock.json

ionleu · 2025-06-15T17:00:02Z

package.json

@@ -52,18 +52,19 @@
  },
  "dependencies": {
    "html2canvas": "^1.4.1",
+    "i18n": "^0.15.1",


Remove this.

Also,
it seems that you used to create your branch from main branch.
Please rebase it to match develop branch, since this is our development branch.

@naaa760,
what was the reason to add i18n package?

We have our own custom i18n package, see: packages/i18n

@naaa760,
we don't need i18n as of now.

.github/workflows/lint.yml

ionleu · 2025-06-16T16:33:07Z

@naaa760,
let me know when you got a minute to resolve the suggestions and the rebase issue (we'll need the develop branch changes).

naaa760 · 2025-06-16T17:19:30Z

@naaa760, let me know when you got a minute to resolve the suggestions and the rebase issue (we'll need the develop branch changes).

please check once again, I have updated it!

ionleu · 2025-06-16T18:27:51Z

.github/workflows/prettier.yml

@@ -33,3 +35,6 @@ jobs:
          --ignore-path ./.prettierignore \
          --no-error-on-unmatched-pattern \
          '**/*.{js,jsx,ts,tsx,json}'
+
+      - name: Fix formatting issues


@naaa760,
please remove this step changes: Fix formatting issues, since we'll want the workflow to be read only.

Also,
.turbo and manifest are added into the .gitignore

ionleu · 2025-06-16T18:29:26Z

chrome-extension/src/utils/manage-records.util.ts

@@ -1,14 +1,12 @@
 import { v4 as uuidv4 } from 'uuid';

-import { deepRedactSensitiveInfo } from '@extension/shared';
+import { deepRedactSensitiveInfo, RecordType } from '@extension/shared';

 const restricted = ['https://api.briehq.com']; // 'extend.iife',  'kbmbnelnoppneadncmmkfikbcgmilbao'  Note: it blocks the logs


@naaa760,
I still see the issue with missing changes that are not matching the develop branch.

ionleu · 2025-06-16T19:37:52Z

package.json

@@ -52,18 +52,19 @@
  },
  "dependencies": {
    "html2canvas": "^1.4.1",
+    "i18n": "^0.15.1",


@naaa760,
what was the reason to add i18n package?

We have our own custom i18n package, see: packages/i18n

packages/shared/README.md

ionleu · 2025-06-16T19:44:07Z

pages/content/src/interceptors/network/xhr.interceptor.ts

  ): void {
    this._requestDetails = {
      method,
      url: url.toString(),
      requestStart: new Date().toISOString(),
      requestBody: null,
    };
-    originalOpen.apply(this, [method, url, ...rest]);


But I see the username, password has been added, why?

ionleu · 2025-06-17T17:33:46Z

pages/content/src/interceptors/network/xhr.interceptor.ts

  ): void {
    this._requestDetails = {
      method,
      url: url.toString(),
      requestStart: new Date().toISOString(),
      requestBody: null,
    };
-    originalOpen.apply(this, [method, url, ...rest]);


cc @naaa760

ionleu · 2025-06-17T17:34:47Z

pages/content/src/interceptors/console/console.interceptor.ts

-    };
-  });
+  // Override each console method individually to avoid type issues
+  console.log = (...args: any[]) => {


The comment says that this was implemented due to avoid type issues.

Do we still need then to use any[]?

Changed from any[] to unknown[] for better type safety

packages/shared/README.md

ionleu · 2025-06-17T17:37:44Z

package.json

@@ -52,18 +52,19 @@
  },
  "dependencies": {
    "html2canvas": "^1.4.1",
+    "i18n": "^0.15.1",


@naaa760,
we don't need i18n as of now.

ionleu · 2025-06-17T17:40:25Z

chrome-extension/src/utils/manage-records.util.ts

@@ -1,14 +1,12 @@
 import { v4 as uuidv4 } from 'uuid';

-import { deepRedactSensitiveInfo } from '@extension/shared';
+import { deepRedactSensitiveInfo, RecordType } from '@extension/shared';

 const restricted = ['https://api.briehq.com']; // 'extend.iife',  'kbmbnelnoppneadncmmkfikbcgmilbao'  Note: it blocks the logs


@naaa760,
can you please pull the latest changes from upstream develop branch?

ionleu · 2025-06-19T15:15:28Z

.gitignore

@@ -8,7 +8,7 @@
 **/dist
 **/build
 **/dist-zip
-chrome-extension/manifest.js
+chrome-extension


@naaa760,
can we please revert these changes back?

ionleu · 2025-06-19T15:19:13Z

.turbo/preferences/tui.json

@@ -0,0 +1,4 @@
+{


@naaa760,
this file will be regenerated at each startup.
So no need to modify it.

sorry for that.

but i have not modify the .turbo folder at all.

ionleu · 2025-06-19T15:23:18Z

packages/i18n/.gitignore

@naaa760,
no need to remove our custom i18n packages.

I asked to remove only the i18n that you added in the package.json as a independent package.

This is the external package that you need to remove

But I already checked in package.json, the i18n is not there.

Seems that was removed when you did the rebase. So that's fine.

Remains to revert back our custom i18n package.

again i will update it

naaa760 · 2025-06-20T06:13:28Z

Hello, @ionleu
Let me know if there are any issues regarding this.

ionleu · 2025-06-20T15:28:59Z

Let me know if there are any issues regarding this.

@naaa760,
there are a few pending changes and also conflicts that we'll be great to fix.

ionleu · 2025-06-23T17:31:28Z

@naaa760,
Could you please look into the remaining comments and change requested. Once done we can merge it.

Thank you

ionleu and others added 2 commits June 9, 2025 11:08

chore: briehq#204 from develop

60114ba

develop to main

feat: refactor string literals into typed enums

3d6fef1

naaa760 requested a review from ionleu as a code owner June 14, 2025 17:05

github-actions bot requested a review from LuminitaL June 14, 2025 17:05

github-actions bot assigned naaa760 Jun 14, 2025

ionleu requested changes Jun 14, 2025

View reviewed changes

ionleu linked an issue Jun 14, 2025 that may be closed by this pull request

Implement ENUMs for uniq actions or/and types #161

Open

feat: refactor string literals into typed enums

2234bcf

ionleu reviewed Jun 15, 2025

View reviewed changes

CODE_OF_CONDUCT.md Outdated Show resolved Hide resolved

ionleu reviewed Jun 15, 2025

View reviewed changes

package-lock.json Outdated Show resolved Hide resolved

ionleu reviewed Jun 15, 2025

View reviewed changes

nehhhhha6 added 3 commits June 16, 2025 02:05

feat: refactor string literals into typed enums

d46f0af

update

8a5e8fc

update

4dd6a8b

ionleu reviewed Jun 16, 2025

View reviewed changes

.github/workflows/lint.yml Outdated Show resolved Hide resolved

ionleu changed the title ~~feat: Refactor string literals to typed enums~~ feat(#161): refactor string literals to typed enums Jun 16, 2025

fix: address formatting and workflow issues for CI/CD

686d425

ionleu requested changes Jun 16, 2025

View reviewed changes

nehhhhha6 added 2 commits June 17, 2025 20:13

update

42149d8

update

6a5af94

ionleu requested changes Jun 17, 2025

View reviewed changes

nehhhhha6 added 2 commits June 19, 2025 20:42

update

59caa47

update

a7e15e6

ionleu requested changes Jun 19, 2025

View reviewed changes

update

c46874f

naaa760 force-pushed the develop branch from 2373219 to c46874f Compare June 19, 2025 16:03

Merge branch 'develop' into develop

17c871a

Uh oh!

feat(#161): refactor string literals to typed enums #216

Are you sure you want to change the base?

feat(#161): refactor string literals to typed enums #216

Uh oh!

Conversation

naaa760 commented Jun 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Purpose of the PR*

Priority*

Changes*

How to check the feature

Reference

Uh oh!

github-actions bot commented Jun 14, 2025

Uh oh!

ionleu left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

naaa760 commented Jun 14, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ionleu commented Jun 16, 2025

Uh oh!

naaa760 commented Jun 16, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

naaa760 Jun 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

naaa760 commented Jun 14, 2025 •

edited

Loading

naaa760 Jun 19, 2025 •

edited

Loading