Feature/add tests by Samuel3 · Pull Request #5 · Samuel3/LetterCreator

Samuel3 · 2026-02-28T19:49:50Z

Added tests, updated Electron and fixed bugs

Copilot

Pull request overview

This PR introduces a new Mocha-based test suite (unit + Spectron E2E) and updates the project’s test scripts and runtime setup to support running those tests in CI.

Changes:

Added multiple new unit test files for Store, Letter, i18n, and LetterStructure plus a test README.
Updated E2E test bootstrapping (test/spec.js) and npm scripts to run unit vs E2E tests.
Updated Electron/Electron Builder versions and adjusted BrowserWindow webPreferences and Store/i18n initialization behavior.

Reviewed changes

Copilot reviewed 17 out of 19 changed files in this pull request and generated 15 comments.

Show a summary per file

File	Description
`.github/workflows/build.yml`	Expands workflow triggers; currently contains a YAML indentation bug that will break the workflow.
`package.json`	Adds mocha test scripts and bumps Electron/Electron Builder versions (version/tooling compatibility concerns).
`app/package.json`	Bumps Electron version inside `app/`, creating a multi-Electron-version setup risk.
`app/package-lock.json`	Large lockfile rewrite and lockfileVersion downgrade (CI/install reliability risk).
`app/main.js`	Sets insecure `webPreferences` and adds guard for `window-all-closed` send.
`app/js/MenuTemplate.js`	Sets insecure `webPreferences` on Settings/About windows.
`app/js/i18n.js`	Wraps `electron-store` usage in try/catch; introduces a possible `locale` undefined crash path.
`app/js/Store.js`	Fixes callback `this` binding; adds sync callback path that can introduce timing bugs.
`app/js/Letter.js`	Exports `Letter` for unit tests.
`app/js/About.js`	Makes copyright year dynamic (still uses “Github” in UI text).
`app/i18n/en.json`	Updates intro/help strings.
`LICENSE`	Updates copyright year.
`test/spec.js`	Improves Electron path detection and adds skips/logging for E2E stability.
`test/store.test.js`	Adds Store unit tests, but `storeHistory` tests currently don’t exercise `storeHistory()`.
`test/letter.test.js`	Adds basic Letter constructor/toWord tests.
`test/letterStructure.test.js`	Adds tests, but they validate mock implementations rather than production code.
`test/i18n.test.js`	Adds language file consistency checks; includes a brittle “80% must differ” rule.
`test/README.md`	Documents test structure and commands.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-02-28T19:54:43Z

+    describe('getAddress logic', function() {
+        // Mock implementation based on the actual logic
+        function getAddress(tableRow) {
+            const fullAddress = [];
+            const attributes = tableRow.children || [];
+
+            function isCellEmpty(cell) {
+                return typeof getValueOfTableCell(cell) === "undefined" || 
+                       getValueOfTableCell(cell) === "";
+            }
+
+            function getValueOfTableCell(cell) {
+                return cell && cell.value ? cell.value : (cell && cell.text ? cell.text : "");
+            }
+
+            if (!isCellEmpty(attributes[0]) || !isCellEmpty(attributes[1]) || 
+                !isCellEmpty(attributes[2]) || !isCellEmpty(attributes[3])) {
+                let _name = getValueOfTableCell(attributes[0]) + " " + 
+                           getValueOfTableCell(attributes[1]) + " " + 
+                           getValueOfTableCell(attributes[2]) + " " + 
+                           getValueOfTableCell(attributes[3]);
+                _name = _name.replace(/  /g, " ").trim();
+                if (_name) fullAddress.push(_name);
+            }
+            if (!isCellEmpty(attributes[4])) {
+                fullAddress.push(getValueOfTableCell(attributes[4]));
+            }
+            if (!isCellEmpty(attributes[5])) {
+                fullAddress.push(getValueOfTableCell(attributes[5]));
+            }
+            if (!isCellEmpty(attributes[6])) {
+                fullAddress.push(getValueOfTableCell(attributes[6]));
+            }
+            if (!isCellEmpty(attributes[7]) || !isCellEmpty(attributes[8])) {
+                let _city = getValueOfTableCell(attributes[7]) + " " + 
+                           getValueOfTableCell(attributes[8]);
+                _city = _city.trim();
+                if (_city) fullAddress.push(_city);
+            }
+            if (!isCellEmpty(attributes[9])) {
+                fullAddress.push(getValueOfTableCell(attributes[9]));
+            }
+            if (fullAddress.length === 0) {
+                return ["Doppelklicken um Empfänger hinzuzufügen", "", "", ""];
+            }
+            return fullAddress;
+        }


These tests define mock implementations of getAddress/getCurrentContent/colorize inside the test file rather than importing and exercising the production code. As written, they can pass even if LetterStructure.js breaks. Consider exporting the pure helpers from LetterStructure.js (or moving them to a separate module) and testing those exports instead of duplicating the logic here.

@copilot open a new pull request to apply changes based on this feedback

Copilot · 2026-02-28T19:54:45Z

 function createWindow () {
    autoUpdater.checkForUpdates();
-    mainWindow = new BrowserWindow({width: 640, height: 480, backgroundColor: "#04C800"});
+    mainWindow = new BrowserWindow({width: 640, height: 480, backgroundColor: "#04C800", webPreferences: {nodeIntegration: true, contextIsolation: false}});


Enabling webPreferences: { nodeIntegration: true, contextIsolation: false } disables key Electron security protections and allows any renderer XSS to escalate to full Node.js/RCE. Prefer nodeIntegration: false, contextIsolation: true, and expose only the required APIs via a preload script + contextBridge.

Suggested change

mainWindow = new BrowserWindow({width: 640, height: 480, backgroundColor: "#04C800", webPreferences: {nodeIntegration: true, contextIsolation: false}});

mainWindow = new BrowserWindow({

width: 640,

height: 480,

backgroundColor: "#04C800",

webPreferences: {

nodeIntegration: false,

contextIsolation: true,

preload: path.join(__dirname, 'preload.js')

}

});

@copilot please fix

Copilot · 2026-02-28T19:54:45Z

                    label: i18n("menu.edit.settings"),
                    click: function () {
-                    settingsWindow = new BrowserWindow({width: 800, height: 600, title: "Settings"});
+                    settingsWindow = new BrowserWindow({width: 800, height: 600, title: "Settings", webPreferences: {nodeIntegration: true, contextIsolation: false}});


Same concern here: setting nodeIntegration: true and contextIsolation: false for these auxiliary windows weakens renderer isolation and increases the impact of any injected/remote content. Use a secure preload bridge (or keep Node disabled) instead of enabling Node integration in the window.

Suggested change

settingsWindow = new BrowserWindow({width: 800, height: 600, title: "Settings", webPreferences: {nodeIntegration: true, contextIsolation: false}});

settingsWindow = new BrowserWindow({width: 800, height: 600, title: "Settings", webPreferences: {nodeIntegration: false, contextIsolation: true}});

@copilot please fix

Copilot · 2026-02-28T19:54:45Z

+    describe('Store.storeHistory', function() {
+        beforeEach(function(done) {
+            store = new Store(function() {
+                // Clear history before each test
+                store.set('history', []);
+                done();
+            });
+        });
+
+        it('should add new entry to history when history exists', function() {
+            // Initialize history first
+            store.set('history', []);
+
+            const content1 = {
+                sender: 'John Doe',
+                receiver: 'Jane Smith',
+                subject: 'Test 1',
+                content: 'Content 1'
+            };
+            const content2 = {
+                sender: 'Jane Doe',
+                receiver: 'John Smith',
+                subject: 'Test 2',
+                content: 'Content 2'
+            };
+
+            // Manually add to history since storeHistory requires getCurrentContent
+            let history = store.get('history') || [];
+            if (!store.compareTwoHistories(content1, history[0] || {})) {
+                history.unshift(content1);
+                store.set('history', history);
+            }
+
+            history = store.get('history');
+            if (!store.compareTwoHistories(content2, history[0] || {})) {
+                history.unshift(content2);
+                store.set('history', history);
+            }


The newly added tests in this section don’t actually call store.storeHistory(...); they manually reimplement the logic using compareTwoHistories and direct set/get. This won’t catch regressions in storeHistory itself (e.g., its getCurrentContent() call, cloud sync side-effects, etc.). Refactor the test to stub getCurrentContent (or pass explicit currentContent) and exercise store.storeHistory directly.

@copilot open a new pull request to apply changes based on this feedback

Copilot · 2026-02-28T19:54:45Z

@@ -30,6 +31,8 @@ var Store = function (callback) {
                ipcRenderer.send('message', i18n("message.dropboxfailed"));
            }
        })
+    } else if (callback) {
+        callback.call(this);


callback is only invoked after a successful Dropbox download/parse. If filesDownload fails (network/auth/etc.), the callback is never called and callers can hang waiting for initialization. Consider invoking the callback on the error path as well (possibly after showing the failure message), or centralize callback completion so it's guaranteed exactly once.

@copilot open a new pull request to apply changes based on this feedback

Copilot · 2026-02-28T20:11:16Z

@Samuel3 I've opened a new pull request, #6, to work on those changes. Once the pull request is ready, I'll request review from you.

Copilot · 2026-02-28T20:11:44Z

@Samuel3 I've opened a new pull request, #7, to work on those changes. Once the pull request is ready, I'll request review from you.

Copilot · 2026-02-28T20:14:10Z

@Samuel3 I've opened a new pull request, #8, to work on those changes. Once the pull request is ready, I'll request review from you.

Copilot · 2026-02-28T20:15:06Z

@Samuel3 I've opened a new pull request, #9, to work on those changes. Once the pull request is ready, I'll request review from you.

Co-authored-by: Samuel3 <15921086+Samuel3@users.noreply.github.com>

…on code Co-authored-by: Samuel3 <15921086+Samuel3@users.noreply.github.com>

…es window Co-authored-by: Samuel3 <15921086+Samuel3@users.noreply.github.com>

Co-authored-by: Samuel3 <15921086+Samuel3@users.noreply.github.com>

Copilot · 2026-03-02T19:23:58Z

@Samuel3 I've opened a new pull request, #12, to work on those changes. Once the pull request is ready, I'll request review from you.

…y windows Co-authored-by: Samuel3 <15921086+Samuel3@users.noreply.github.com>

Copilot · 2026-03-02T19:24:10Z

@Samuel3 I've opened a new pull request, #13, to work on those changes. Once the pull request is ready, I'll request review from you.

Copilot · 2026-03-02T19:24:50Z

@Samuel3 I've opened a new pull request, #14, to work on those changes. Once the pull request is ready, I'll request review from you.

Co-authored-by: Samuel3 <15921086+Samuel3@users.noreply.github.com>

…ined branch test Co-authored-by: Samuel3 <15921086+Samuel3@users.noreply.github.com>

…ndow Co-authored-by: Samuel3 <15921086+Samuel3@users.noreply.github.com>

Co-authored-by: Samuel3 <15921086+Samuel3@users.noreply.github.com>

Extract pure helpers from LetterStructure.js and test actual production code

Co-authored-by: Samuel3 <15921086+Samuel3@users.noreply.github.com>

…Bridge APIs Co-authored-by: Samuel3 <15921086+Samuel3@users.noreply.github.com>

Refactor Store.storeHistory tests to exercise the method directly

Align Electron devDependency version in app/package.json and app/package-lock.json with root

Disable nodeIntegration and enable contextIsolation for auxiliary windows with preload bridges

… in test Co-authored-by: Samuel3 <15921086+Samuel3@users.noreply.github.com>

…stener cleanup Agent-Logs-Url: https://github.com/Samuel3/LetterCreator/sessions/8d47fbaa-3b3d-465a-b84b-ac1ba49449c7 Co-authored-by: Samuel3 <15921086+Samuel3@users.noreply.github.com>

Agent-Logs-Url: https://github.com/Samuel3/LetterCreator/sessions/8d47fbaa-3b3d-465a-b84b-ac1ba49449c7 Co-authored-by: Samuel3 <15921086+Samuel3@users.noreply.github.com>

Fix: callback not invoked on Dropbox filesDownload error in Store.js

…kage-lock.json conflicts Agent-Logs-Url: https://github.com/Samuel3/LetterCreator/sessions/e4012f10-97cd-47f1-aef5-c14bf1fc407f Co-authored-by: Samuel3 <15921086+Samuel3@users.noreply.github.com>

Co-authored-by: Samuel3 <15921086+Samuel3@users.noreply.github.com>

Samuel3 added 6 commits February 13, 2026 21:15

Added tests

a79ac01

Fixed tests

6a5741e

Updated node version

f979b99

Fixed error

9a11a63

Updated about page

1210c8f

Changed build to build for all branches

cd87573

Samuel3 requested a review from Copilot February 28, 2026 19:49

Copilot started reviewing on behalf of Samuel3 February 28, 2026 19:50 View session

Copilot AI reviewed Feb 28, 2026

View reviewed changes

Initial plan

9400369

Copilot AI mentioned this pull request Feb 28, 2026

Extract pure helpers from LetterStructure.js and test actual production code #6

Merged

5 tasks

Initial plan

ff1adb6

Copilot AI mentioned this pull request Feb 28, 2026

Refactor Store.storeHistory tests to exercise the method directly #7

Merged

Initial plan

efeca7d

Copilot AI mentioned this pull request Feb 28, 2026

Fix: callback not invoked on Dropbox filesDownload error in Store.js #8

Merged

8 tasks

Samuel3 and others added 2 commits February 28, 2026 21:14

Fixed review findings

7c8df1b

Initial plan

00fade6

Copilot AI mentioned this pull request Feb 28, 2026

Security: Harden release notes window with contextIsolation and preload bridge #9

Merged

7 tasks

Copilot AI and others added 8 commits February 28, 2026 20:15

Initial plan: extract pure helpers from LetterStructure.js

6200d73

Co-authored-by: Samuel3 <15921086+Samuel3@users.noreply.github.com>

Fixed review findings

aec8a2d

Refactor Store.storeHistory tests to call the method directly

3f615b2

Co-authored-by: Samuel3 <15921086+Samuel3@users.noreply.github.com>

Fix: invoke callback on filesDownload error path in Store.js

e29b72c

Co-authored-by: Samuel3 <15921086+Samuel3@users.noreply.github.com>

Extract pure helpers from LetterStructure.js and test actual producti…

32584bf

…on code Co-authored-by: Samuel3 <15921086+Samuel3@users.noreply.github.com>

Security fix: use contextIsolation and preload bridge for release not…

b959cc4

…es window Co-authored-by: Samuel3 <15921086+Samuel3@users.noreply.github.com>

Restore package-lock.json files to fix CI npm ci failure

7727f99

Co-authored-by: Samuel3 <15921086+Samuel3@users.noreply.github.com>

Restore package-lock.json to original lockfileVersion 1 to fix CI

d544b68

Co-authored-by: Samuel3 <15921086+Samuel3@users.noreply.github.com>

Copilot AI mentioned this pull request Mar 2, 2026

Electron security: disable nodeIntegration, enable contextIsolation with contextBridge preloads #11

Closed

Initial plan

e1aa938

Copilot AI mentioned this pull request Mar 2, 2026

Align Electron devDependency version in app/package.json and app/package-lock.json with root #12

Merged

fix: disable nodeIntegration and enable contextIsolation for auxiliar…

ba549d6

…y windows Co-authored-by: Samuel3 <15921086+Samuel3@users.noreply.github.com>

Copilot AI mentioned this pull request Mar 2, 2026

Make non-Dropbox Store callback consistently async #13

Draft

Initial plan

b04cfcf

Copilot AI mentioned this pull request Mar 2, 2026

Secure About window with contextBridge preload instead of nodeIntegration #14

Merged

Copilot AI and others added 18 commits March 2, 2026 19:25

Remove duplicate electron devDependency from app/package.json

6eb94eb

Co-authored-by: Samuel3 <15921086+Samuel3@users.noreply.github.com>

Restore app/package-lock.json to v1 format and add storeHistory undef…

7cdf042

…ined branch test Co-authored-by: Samuel3 <15921086+Samuel3@users.noreply.github.com>

fix: disable nodeIntegration and enable contextIsolation for about wi…

48be829

…ndow Co-authored-by: Samuel3 <15921086+Samuel3@users.noreply.github.com>

fix: add secure preload bridge for About window with contextBridge

5968370

Co-authored-by: Samuel3 <15921086+Samuel3@users.noreply.github.com>

Merge pull request #6 from Samuel3/copilot/sub-pr-5

a893263

Extract pure helpers from LetterStructure.js and test actual production code

Sync app/package-lock.json to exactly match feature/add-tests branch

b786b7d

Co-authored-by: Samuel3 <15921086+Samuel3@users.noreply.github.com>

Align electron version in app/package.json with root (^40.6.1)

4b34ce5

Co-authored-by: Samuel3 <15921086+Samuel3@users.noreply.github.com>

Regenerate app/package-lock.json to reflect electron ^40.6.1

3e1955a

Co-authored-by: Samuel3 <15921086+Samuel3@users.noreply.github.com>

feat: add preload scripts for About and Settings windows with context…

9514628

…Bridge APIs Co-authored-by: Samuel3 <15921086+Samuel3@users.noreply.github.com>

Merge pull request #7 from Samuel3/copilot/sub-pr-5-again

7c7080c

Refactor Store.storeHistory tests to exercise the method directly

Merge pull request #12 from Samuel3/copilot/sub-pr-5-please-work

f4a4059

Align Electron devDependency version in app/package.json and app/package-lock.json with root

Merge pull request #10 from Samuel3/copilot/sub-pr-5-yet-again

aa20be0

Disable nodeIntegration and enable contextIsolation for auxiliary windows with preload bridges

Fix: guard callback with typeof check; replace Blob with plain object…

e713b5d

… in test Co-authored-by: Samuel3 <15921086+Samuel3@users.noreply.github.com>

fix: merge feature/add-tests, fix locale validation and onProgress li…

acc1b3f

…stener cleanup Agent-Logs-Url: https://github.com/Samuel3/LetterCreator/sessions/8d47fbaa-3b3d-465a-b84b-ac1ba49449c7 Co-authored-by: Samuel3 <15921086+Samuel3@users.noreply.github.com>

fix: correct package.json path in about-preload.js to use app version

4579117

Agent-Logs-Url: https://github.com/Samuel3/LetterCreator/sessions/8d47fbaa-3b3d-465a-b84b-ac1ba49449c7 Co-authored-by: Samuel3 <15921086+Samuel3@users.noreply.github.com>

Merge pull request #8 from Samuel3/copilot/sub-pr-5-another-one

e90b060

Fix: callback not invoked on Dropbox filesDownload error in Store.js

fix: merge latest feature/add-tests, resolve about-preload.js and pac…

042c4ee

…kage-lock.json conflicts Agent-Logs-Url: https://github.com/Samuel3/LetterCreator/sessions/e4012f10-97cd-47f1-aef5-c14bf1fc407f Co-authored-by: Samuel3 <15921086+Samuel3@users.noreply.github.com>

fix: merge feature/add-tests, resolve about-preload.js conflict

87e18d7

Co-authored-by: Samuel3 <15921086+Samuel3@users.noreply.github.com>

Samuel3 merged commit 5855aa9 into master Jun 1, 2026
4 checks passed

Samuel3 deleted the feature/add-tests branch June 1, 2026 10:14

	settingsWindow = new BrowserWindow({width: 800, height: 600, title: "Settings", webPreferences: {nodeIntegration: true, contextIsolation: false}});
	settingsWindow = new BrowserWindow({width: 800, height: 600, title: "Settings", webPreferences: {nodeIntegration: false, contextIsolation: true}});

Conversation

Samuel3 commented Feb 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Copilot AI Feb 28, 2026

Choose a reason for hiding this comment

Uh oh!

Samuel3 Feb 28, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Copilot AI Feb 28, 2026

Choose a reason for hiding this comment

Uh oh!

Samuel3 Mar 2, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 28, 2026

Choose a reason for hiding this comment

Uh oh!

Samuel3 Mar 2, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 28, 2026

Choose a reason for hiding this comment

Uh oh!

Samuel3 Feb 28, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI Feb 28, 2026

Choose a reason for hiding this comment

Uh oh!

Samuel3 Feb 28, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI commented Feb 28, 2026

Uh oh!

Copilot AI commented Feb 28, 2026

Uh oh!

Copilot AI commented Feb 28, 2026

Uh oh!

Copilot AI commented Feb 28, 2026

Uh oh!

Copilot AI commented Mar 2, 2026

Uh oh!

Copilot AI commented Mar 2, 2026

Uh oh!

Copilot AI commented Mar 2, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Samuel3 commented Feb 28, 2026 •

edited

Loading