[🧱 MCP Server Tool] Project Structure Cleanup by bendvc · Pull Request #2699 · SalesforceCommerceCloud/pwa-kit

bendvc · 2025-06-30T22:38:46Z

Description

🧹 This PR gives our mcp server project a little spring cleaning (in June, because who follows rules anymore?). The goal was to make things less "Where the heck is that file?" and more "Ah, there it is."

This PR:

Make the project use commonr patters from other PWA projects.
Add build step so we can use imports without having to be a module type project (this didn't work well with out jest integration)
No need to use .js terminations (this follows the same pattern as the rest of the mono repo). We could change our project to be a esm in the future but that might take more time.

No functionality changes. Just vibes and structure. 🏗️

Types of Changes

Bug fix (non-breaking change that fixes an issue)
New feature (non-breaking change that adds functionality)
Documentation update
Breaking change (could cause existing functionality to not work as expected)
Other changes (non-breaking changes that does not fit any of the above)

Changes

Removed unused or legacy files from packages/pwa, packages/pwa-build, and packages/pwa-dev
Moved packages/pwa/src/cli contents into packages/pwa-dev
Deleted obsolete test fixtures and files that were no longer referenced
Reorganized and renamed some test and utility files for clarity
Updated references/imports to match the new structure

How to Test-Drive This PR

Clone the branch and install dependencies.
Run npm run test from the root — all tests should still pass 🧪.
Manually inspect the new folder structure and smile in appreciation 😄.

Checklists

General

Changes are covered by test cases (no new logic added, existing tests pass)
CHANGELOG.md updated with a short description of changes (optional for structural refactors, but included for visibility)

Accessibility Compliance

There are no changes to UI

Localization

No UI text was updated or added

Let me know if you'd like a pun-filled title suggestion too!

cc-prodsec · 2025-06-30T22:38:53Z

🎉 Snyk checks have passed. No issues have been found so far.

✅ security/snyk check is complete. No issues have been found. (View Details)

✅ license/snyk check is complete. No issues have been found. (View Details)

Revert pty usage so it will be compatible with windows.

bendvc · 2025-07-01T22:03:15Z

jest.config.cjs

I'm not sure why this was added as it wasn't in develop, so I removed it. Things still work without it.

bendvc · 2025-07-01T22:04:04Z

packages/pwa-kit-create-app/scripts/create-mobify-app.js

+const printProgramJsonAndExit = async () => {
+    const output = JSON.stringify(PROGRAM, null, 2)
+    await new Promise((resolve) => {
+        process.stdout.write(output + '\n', () => {
+            resolve()
+        })
+    })


This was a bug that I originally made where the output was being printed and the program exited before the standard out could be flushed. This fixes that problem.

bendvc · 2025-07-01T22:04:21Z

packages/pwa-storefront-mcp/babel.config.js

-    ...parentConfig,
-    sourceType: 'module'
-}
+module.exports = require('internal-lib-build/configs/babel.config')


Module type was no longer required and our project is not an esm project anymore but we still use import syntax. Its a little weird, but that is how we currently do it in the pwa-kit mono repo. We could choose to change this, but we might have to drop pwa-kit-dev as a source of our jest integration.

bendvc · 2025-07-01T22:06:13Z

packages/pwa-storefront-mcp/jest.config.js

 * SPDX-License-Identifier: BSD-3-Clause
 * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
 */
+// eslint-disable-next-line @typescript-eslint/no-var-requires


Fixing some lint errors now that we have linting for all files working.

bendvc · 2025-07-01T22:06:43Z

packages/pwa-storefront-mcp/jest.config.js

-        '!src/**/*.spec.js'
-    ],
+    testMatch: ['**/__tests__/**/*.js', '**/?(*.)+(spec|test).js'],
+    testPathIgnorePatterns: ['bin/*', 'coverage/*', 'dist/*', 'node_modules/*', 'scripts/*'],


Dont test node modules etc.

bendvc · 2025-07-01T22:07:35Z

packages/pwa-storefront-mcp/package.json

+  "main": "dist/server/server.js",
+  "files": [
+    "CHANGELOG.md",
+    "LICENSE",
+    "dist/**/*.{js,d.ts}",
+    "!dist/CHANGELOG.md",
+    "!dist/README.md",
+    "!**/*.test.{ts,js}"
+  ],


Just some clean up on how our package is configured, here we don't want to include test files in our package and some other stuff, we also want to use the built server as our main entry point.

bendvc · 2025-07-01T22:08:03Z

packages/pwa-storefront-mcp/package.json

+    "build": "cross-env NODE_ENV=production internal-lib-build build",
+    "build:watch": "nodemon --watch 'src/**' --ext 'js,ts' --exec  'npm run build'",


New build and build watch commands. If you are developing the server use the build watch so that it's automatically built when you make changes to files.

bendvc · 2025-07-01T22:08:37Z

packages/pwa-storefront-mcp/package.json

+  "engines": {
+    "node": "^16.11.0 || ^18.0.0 || ^20.0.0 || ^22.0.0",
+    "npm": "^8.0.0 || ^9.0.0 || ^10.0.0 || ^11.0.0"
+  },


Add engines so that it's in alignment with the other projects

bendvc · 2025-07-01T22:08:57Z

packages/pwa-storefront-mcp/package.json

+  "publishConfig": {
+    "directory": "dist"


This is required for when we decide to publish our package.

bendvc · 2025-07-01T22:10:02Z

packages/pwa-storefront-mcp/src/server/server.js

+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const productDocument = require('../data/ProductDocument.json')
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const categoryDocument = require('../data/CategoryDocument.json')


here we fall back to using require since it works for json files without special syntax that confuses jest

It seems weird to use require here. Probably we can convert .json to .js file and export it.

bendvc · 2025-07-01T22:12:48Z

packages/pwa-storefront-mcp/src/server/server.test.js

+const BABEL_NODE_PATH = path.resolve(
+    './node_modules/.bin/babel-node' + (process.platform === 'win32' ? '.cmd' : '')
+)


We'll run the server with babel-node for now so it doesn't complain about the import syntax of the source files. but in the future we migrate to ESM, maybe add out own test setup we can revert this.

bendvc · 2025-07-01T22:14:22Z

packages/pwa-storefront-mcp/src/utils/utils.js

- *
- * This is useful for running CLI tools that emit different output
- * when run in a TTY environment (e.g., with color, formatting, or paging).
+ * Runs a shell command and captures its stdout/stderr as a string.


the 3rd party npm package that I was using to communicate with the create-app script was old and didn't support newer versions of node. So I decided to remove it and use vanilla apis. I can do that because I found the root of the problem for truncated output in the create-app script itself.

yhsieh1 · 2025-07-01T22:25:36Z

packages/pwa-storefront-mcp/src/server/server.js

 import {StdioServerTransport} from '@modelcontextprotocol/sdk/server/stdio.js'
+
+// import {McpServer} from '@modelcontextprotocol/sdk/server/mcp'
+// import {StdioServerTransport} from '@modelcontextprotocol/sdk/server/stdio'


Seems these commented out import should be removed.

yhsieh1 · 2025-07-02T13:50:08Z

I checked out the branch and tested. No issue found, all commands in package.json runs correctly.

Initial Commit

aa032c1

bendvc requested a review from a team as a code owner June 30, 2025 22:38

bendvc added 4 commits June 30, 2025 15:39

Remove console log

5de9967

Remove addd jest.config.js, update ignore patterns

6a7096b

Fix for windows

9804f33

Fix create-app script exiting before flushing

09db6aa

Revert pty usage so it will be compatible with windows.

bendvc added the skip changelog Skip the "Changelog Check" GitHub Actions step even if the Changelog.md files are not updated label Jul 1, 2025

Update CHANGELOG.md

76deb5e

bendvc commented Jul 1, 2025

View reviewed changes

jest.config.cjs

Copy link

Contributor Author

bendvc Jul 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure why this was added as it wasn't in develop, so I removed it. Things still work without it.

bendvc commented Jul 1, 2025

View reviewed changes

Remove commented out import

067680c

bendvc commented Jul 1, 2025

View reviewed changes

yhsieh1 reviewed Jul 1, 2025

View reviewed changes

yhsieh1 approved these changes Jul 1, 2025

View reviewed changes

PR feedback

fb01733

bendvc merged commit 91cb2fd into feature/pwa-developer-agent-only Jul 2, 2025
35 checks passed

bendvc deleted the bendvc/clean-up-project-structure branch July 16, 2025 22:21

		"build": "cross-env NODE_ENV=production internal-lib-build build",
		"build:watch": "nodemon --watch 'src/**' --ext 'js,ts' --exec 'npm run build'",

Conversation

bendvc commented Jun 30, 2025

Description

Types of Changes

Changes

How to Test-Drive This PR

Checklists

General

Accessibility Compliance

Localization

Uh oh!

cc-prodsec commented Jun 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🎉 Snyk checks have passed. No issues have been found so far.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bendvc Jul 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

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!

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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

yhsieh1 commented Jul 2, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

cc-prodsec commented Jun 30, 2025 •

edited

Loading

bendvc Jul 1, 2025 •

edited

Loading