{pr_title} #57

loganbek · 2025-04-03T19:24:55Z

{pr_body}

…handling and support for BML operations in admin tools

…tions

…ling

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

…debugging, and remove deprecated files

…into manis

…, and ensure graceful handling of missing DOM elements

…cripts

…streamline message sending

…ton event handler setup

Bumps [tar-fs](https://github.com/mafintosh/tar-fs) to 3.0.8 and updates ancestor dependency [puppeteer](https://github.com/puppeteer/puppeteer). These dependencies need to be updated together. Updates `tar-fs` from 3.0.5 to 3.0.8 - [Commits](mafintosh/tar-fs@v3.0.5...v3.0.8) Updates `puppeteer` from 22.11.2 to 22.15.0 - [Release notes](https://github.com/puppeteer/puppeteer/releases) - [Changelog](https://github.com/puppeteer/puppeteer/blob/main/CHANGELOG.md) - [Commits](puppeteer/puppeteer@puppeteer-v22.11.2...puppeteer-v22.15.0) --- updated-dependencies: - dependency-name: tar-fs dependency-type: indirect - dependency-name: puppeteer dependency-type: direct:production ... Signed-off-by: dependabot[bot] <support@github.com>

…f3b7f925 Bump tar-fs and puppeteer

…njected module and update import path in tests

coderabbitai · 2025-04-03T19:25:03Z

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

🗂️ Base branches to auto review (2)

master
coverage

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai plan to trigger planning for file edits and PR creation.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

…eScript and adjust wallaby version

…loading and unloading JSON/XML

… scripts

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

…nteractions

…into typescript

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

Introduces descriptive titles for various popup HTML files to improve document clarity and accessibility. Corrects a typo in the script reference for the SOAP popup interface. Enhances unit test environment setup with the addition of the Jest DOM environment.

…iles

Copilot

Pull Request Overview

This PR adds Wallaby.js support, extends Jest-based unit tests (including popup and admin scripts), refactors the main popup script for improved modularity and debug logging, reorganizes several popup HTML templates (renaming files and updating background references), and updates dependencies and configuration files.

Configure Wallaby.js for Chrome extension tests
Expand and deduplicate Jest tests for popup functionality and admin injections
Refactor src/popup/popup.js (URL analysis, event listener wiring, saveText, sanitizeFilename)
Rename popup HTML templates and update background.js to point to new files

Reviewed Changes

Copilot reviewed 30 out of 40 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
tests/wallaby.js	Add Wallaby.js configuration with bootstrap/teardown for Puppeteer
tests/unit/popup/popup2.test.js	Add new suite of unit tests for popup V2
tests/unit/popup/popup.test.js	Extend existing popup tests, mock handlers, simulate clicks
src/popup/popup.js	Major refactor: extract URL analysis, modularize handlers, replace onclicks with addEventListener
src/popup/*.html	Rename and update multiple popup HTML templates with aria-labels and new file names
src/background/background.js	Update popup file paths to `.html` variants with `HTML` suffix
package.json	Update devDependencies, bump Jest, add Wallaby and Babel

Files not reviewed (1)

.cpqdevkit/libs/package-lock.json: Language not supported

Comments suppressed due to low confidence (1)

tests/unit/popup/popup.test.js:13

The tests use element IDs like loadTestButton and unloadButton, but the actual popup HTML defines IDs loadTest, unload, etc. Update the test IDs to match the real markup.

  let mockSendMessage, mockExecuteScript, mockQuery;

Copilot · 2025-07-03T20:00:32Z

tests/wallaby.js

+    testFramework: 'jest',
+
+    setup: function(wallaby) {
+      const jestConfig = require('./package.json').jest;


The require path points to tests/package.json which likely doesn't exist. Update to require('../package.json').jest so it correctly loads the project’s Jest configuration.

Suggested change

const jestConfig = require('./package.json').jest;

const jestConfig = require('../package.json').jest;

Copilot · 2025-07-03T20:00:33Z

src/popup/popup.js

-    logDebug("Options button clicked, redirecting to options page.");
-    window.location = '/options.html';
-}
+logDebug("Extension initialized.");


Event listeners for the ‘options’ and ‘logs’ buttons were removed during refactoring. Reintroduce handlers (e.g. document.getElementById('options').addEventListener('click', …)) to restore navigation and logging functionality.

Copilot · 2025-07-03T20:00:33Z

tests/unit/popup/popup2.test.js

+/**
+ * Unit tests for popup.js
+ */
+
+describe('Popup v2 Script', () => {
+  let mockSendMessage, mockExecuteScript, mockQuery;
+
+  beforeEach(() => {
+    // Mock Chrome APIs
+    global.chrome = {
+      tabs: {
+        query: jest.fn(),
+        sendMessage: jest.fn(),
+      },
+      scripting: {
+        executeScript: jest.fn(),
+      },
+      runtime: {
+        getManifest: jest.fn(() => ({
+          name: 'Streamline Tools',
+          version: '1.0.0',
+        })),
+      },
+      downloads: {
+        setShelfEnabled: jest.fn(),
+        onDeterminingFilename: {
+          addListener: jest.fn(),
+        },
+      },
+    };
+
+    mockSendMessage = chrome.tabs.sendMessage;
+    mockExecuteScript = chrome.scripting.executeScript;
+    mockQuery = chrome.tabs.query;
+
+    // Mock DOM elements
+    document.getElementById = jest.fn().mockImplementation(id => {
+      return {
+        addEventListener: jest.fn(),
+        onclick: jest.fn(),
+        disabled: false,
+      };
+    });
+
+    jest.clearAllMocks();
+  });
+
+  test('should initialize extension and log debug messages', () => {
+    const logSpy = jest.spyOn(console, 'log').mockImplementation(() => {});
+    require('../../../src/popup/popup');
+    expect(logSpy).toHaveBeenCalledWith('[POPUP_DEBUG]', 'Initializing extension...');
+    logSpy.mockRestore();
+  });
+
+  test('should query active tab and log URL', () => {
+    mockQuery.mockImplementation((queryInfo, callback) => {
+      callback([{ url: 'https://devmcnichols.bigmachines.com/admin/configuration/rules' }]);
+    });
+
+    require('../../../src/popup/popup');
+    expect(mockQuery).toHaveBeenCalledWith({ active: true, currentWindow: true }, expect.any(Function));
+  });
+
+  test('should handle unload button click', () => {
+    const unloadButton = document.getElementById('unload');
+    unloadButton.onclick();
+
+    expect(mockSendMessage).toHaveBeenCalledWith(
+      expect.any(Number),
+      { greeting: 'unload' },
+      expect.any(Function)
+    );
+  });
+
+  test('should handle load button click', async () => {
+    const loadButton = document.getElementById('load');
+    const fileHandle = {
+      getFile: jest.fn().mockResolvedValue({
+        text: jest.fn().mockResolvedValue('file contents'),
+      }),
+    };
+
+    window.showOpenFilePicker = jest.fn().mockResolvedValue([fileHandle]);
+
+    await loadButton.addEventListener.mock.calls[0][1]();
+    expect(mockSendMessage).toHaveBeenCalledWith(
+      expect.any(Number),
+      { greeting: 'load', code: 'file contents' },
+      expect.any(Function)
+    );
+  });
+
+  test('should set footer information on DOMContentLoaded', () => {
+    const footer = { innerHTML: '' };
+    document.getElementById = jest.fn().mockImplementation(id => (id === 'footer' ? footer : {}));
+
+    document.dispatchEvent(new Event('DOMContentLoaded'));
+    expect(footer.innerHTML).toContain('Streamline Tools v1.0.0');
+  });
+});


[nitpick] There’s significant overlap between popup.test.js and popup2.test.js. Consider consolidating these into a single test suite to reduce duplication and improve maintainability.

Suggested change

/**

* Unit tests for popup.js

*/

describe('Popup v2 Script', () => {

let mockSendMessage, mockExecuteScript, mockQuery;

beforeEach(() => {

// Mock Chrome APIs

global.chrome = {

tabs: {

query: jest.fn(),

sendMessage: jest.fn(),

},

scripting: {

executeScript: jest.fn(),

},

runtime: {

getManifest: jest.fn(() => ({

name: 'Streamline Tools',

version: '1.0.0',

})),

},

downloads: {

setShelfEnabled: jest.fn(),

onDeterminingFilename: {

addListener: jest.fn(),

},

},

};

mockSendMessage = chrome.tabs.sendMessage;

mockExecuteScript = chrome.scripting.executeScript;

mockQuery = chrome.tabs.query;

// Mock DOM elements

document.getElementById = jest.fn().mockImplementation(id => {

return {

addEventListener: jest.fn(),

onclick: jest.fn(),

disabled: false,

};

});

jest.clearAllMocks();

});

test('should initialize extension and log debug messages', () => {

const logSpy = jest.spyOn(console, 'log').mockImplementation(() => {});

require('../../../src/popup/popup');

expect(logSpy).toHaveBeenCalledWith('[POPUP_DEBUG]', 'Initializing extension...');

logSpy.mockRestore();

});

test('should query active tab and log URL', () => {

mockQuery.mockImplementation((queryInfo, callback) => {

callback([{ url: 'https://devmcnichols.bigmachines.com/admin/configuration/rules' }]);

});

require('../../../src/popup/popup');

expect(mockQuery).toHaveBeenCalledWith({ active: true, currentWindow: true }, expect.any(Function));

});

test('should handle unload button click', () => {

const unloadButton = document.getElementById('unload');

unloadButton.onclick();

expect(mockSendMessage).toHaveBeenCalledWith(

expect.any(Number),

{ greeting: 'unload' },

expect.any(Function)

);

});

test('should handle load button click', async () => {

const loadButton = document.getElementById('load');

const fileHandle = {

getFile: jest.fn().mockResolvedValue({

text: jest.fn().mockResolvedValue('file contents'),

}),

};

window.showOpenFilePicker = jest.fn().mockResolvedValue([fileHandle]);

await loadButton.addEventListener.mock.calls[0][1]();

expect(mockSendMessage).toHaveBeenCalledWith(

expect.any(Number),

{ greeting: 'load', code: 'file contents' },

expect.any(Function)

);

});

test('should set footer information on DOMContentLoaded', () => {

const footer = { innerHTML: '' };

document.getElementById = jest.fn().mockImplementation(id => (id === 'footer' ? footer : {}));

document.dispatchEvent(new Event('DOMContentLoaded'));

expect(footer.innerHTML).toContain('Streamline Tools v1.0.0');

});

});

// This file has been removed after consolidating its tests into popup.test.js.

loganbek and others added 25 commits March 17, 2025 17:51

Enhance documentation and comments across scripts; improve file type …

531b6f1

…handling and support for BML operations in admin tools

Remove unused adminDocumentsContent.js file and associated debug func…

fa69f22

…tions

Enable early access feature in coderabbit configuration

c0cd7b2

Add adminStylesheetsContent.js with debug logging and stylesheet hand…

84b8068

…ling

Update src/background/background.js

3fe0b74

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

Update src/background/background.js

d4c7ed1

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

Merge branch 'master' into manis

b4c52a3

Refactor admin commerce scripts: consolidate injected logic, enhance …

48fea09

…debugging, and remove deprecated files

Merge branch 'manis' of https://github.com/loganbek/streamline-tools …

658c6dd

…into manis

Update message keys in background.js for clarity

afcfec3

Enhance popup tests: add event handler checks, improve error handling…

6a23ad8

…, and ensure graceful handling of missing DOM elements

Fix script paths in popup.js to include 'admin/' prefix for content s…

60fedf7

…cripts

Refactor BML loading and unloading logic: improve error handling and …

a6bead4

…streamline message sending

Remove .gitignore file from popup directory

05afaad

Add admin pages to review configuration in .coderabbit.yaml

b89ad7f

Refactor popup tests: streamline mock implementations and enhance but…

871a4b8

…ton event handler setup

Merge branch 'master' into manis

03decc1

Merge pull request #55 from loganbek/dependabot/npm_and_yarn/multi-f4…

9ddb4f1

…f3b7f925 Bump tar-fs and puppeteer

Merge branch 'master' into manis

149ade4

Stop tracking .cpqdevkit folder

4d94912

Update .gitignore to stop tracking the .cpqdevkit directory

1e2b262

Add Wallaby configuration and update .gitignore for new files

10c62b6

Export ADMIN_COMMERCE_ACTIONS_INJECT_DEBUG from adminCommerceActionsI…

1d7b711

…njected module and update import path in tests

wallaby js config

a108ea8

loganbek added 4 commits April 3, 2025 12:35

Refactor URL_MATCHERS to use const and update package.json to add Typ…

3afcc57

…eScript and adjust wallaby version

Add HTML files for popup interfaces (REST and SOAP) with buttons for …

223d499

…loading and unloading JSON/XML

Add unit tests for popup.js functionality and mock Chrome APIs

ad9b9da

Add new popup HTML files and update popup.js to reference new content…

6b7bb43

… scripts

loganbek and others added 9 commits April 3, 2025 13:59

Update src/popup/popupStyleSheetsCSS.html

8c21e41

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

Update popup.js to improve functionality and enhance user interface i…

08d75ad

…nteractions

Merge branch 'manis' of https://github.com/loganbek/streamline-tools …

35de06a

…into typescript

Add optimal command hotkeys and customization instructions to README

7aaf39f

Update src/popup/popup.js

410bf3f

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

Update src/popup/popupInterfacesREST.html

8614ea8

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

Add aria-labels to buttons for improved accessibility in popup HTML f…

16cc8c1

…iles

Fix popup HTML file reference in background script

2a9ba52

loganbek requested a review from Copilot July 3, 2025 19:59

Copilot AI reviewed Jul 3, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

{pr_title} #57

{pr_title} #57

Uh oh!

loganbek commented Apr 3, 2025

Uh oh!

coderabbitai bot commented Apr 3, 2025

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Jul 3, 2025

Uh oh!

Copilot AI Jul 3, 2025

Uh oh!

Copilot AI Jul 3, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	const jestConfig = require('./package.json').jest;
	const jestConfig = require('../package.json').jest;

{pr_title} #57

Are you sure you want to change the base?

{pr_title} #57

Uh oh!

Conversation

loganbek commented Apr 3, 2025

Uh oh!

coderabbitai bot commented Apr 3, 2025

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Jul 3, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 3, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 3, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants