feat: 使用 mockm #4011
feat: 使用 mockm #4011
Conversation
|
WalkthroughThe recent changes reflect a substantial reorganization of the codebase, particularly in the mock service architecture. Transitioning from "Nitro" to "Mockm" enhances clarity and aligns with the new project direction. Key updates include the addition of new API modules for authentication, user information, and menu handling, alongside improved documentation and dependency management. This restructuring aims to streamline development workflows and better integrate mock services into the development environment. Changes
Sequence Diagram(s)sequenceDiagram
participant Client
participant MockServer
participant API
Client->>API: Request authentication data
API->>MockServer: Check credentials
MockServer-->>API: Return token
API-->>Client: Provide authentication success
sequenceDiagram
participant Client
participant MockServer
participant API
Client->>API: Request user info
API->>MockServer: Validate token
MockServer-->>API: Return user details
API-->>Client: Provide user info
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
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 as PR comments)
Additionally, you can add CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 5
Outside diff range, codebase verification and nitpick comments (1)
apps/backend-mock/mm.config.cjs (1)
1-5: Missing implementation ofuseResponseErrorfunctionThe function
useResponseErrorimported inapps/backend-mock/mm.config.cjsis not implemented in the codebase. This could lead to runtime errors. Please ensure that theuseResponseErrorfunction is correctly implemented.
apps/backend-mock/util.cjs: Implement theuseResponseErrorfunction.Analysis chain
Ensure utility functions are correctly implemented.
The configuration imports utility functions from
./util.cjs. Verify that these functions are correctly implemented and tested.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the implementation and testing of utility functions imported from `./util.cjs`. # Test: Search for the implementation of utility functions in `./util.cjs`. rg --type js -A 5 $'wrapApiData' rg --type js -A 5 $'useResponseSuccess' rg --type js -A 5 $'useResponseError'Length of output: 107
Script:
#!/bin/bash # Description: Verify the implementation of utility functions imported from `./util.cjs`. # Test: Search for the implementation of utility functions in `./util.cjs` using ast-grep. ast-grep --lang javascript --pattern 'function wrapApiData($_) { $$$ }' ast-grep --lang javascript --pattern 'function useResponseSuccess($_) { $$$ }' ast-grep --lang javascript --pattern 'function useResponseError($_) { $$$ }'Length of output: 983
Script:
#!/bin/bash # Description: Verify the presence of the `useResponseError` function in the entire codebase. # Test: Search for the implementation of `useResponseError` in the entire codebase. rg --type js -A 5 'function useResponseError'Length of output: 47
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files ignored due to path filters (1)
pnpm-lock.yamlis excluded by!**/pnpm-lock.yaml
Files selected for processing (37)
- .prettierignore (1 hunks)
- apps/backend-mock/.eslintignore (1 hunks)
- apps/backend-mock/README.md (1 hunks)
- apps/backend-mock/api/auth.cjs (1 hunks)
- apps/backend-mock/api/menu.cjs (1 hunks)
- apps/backend-mock/api/user.cjs (1 hunks)
- apps/backend-mock/apiWeb.json (1 hunks)
- apps/backend-mock/httpData/.gitignore (1 hunks)
- apps/backend-mock/httpData/apiWeb.json (1 hunks)
- apps/backend-mock/mm.config.cjs (1 hunks)
- apps/backend-mock/package.json (1 hunks)
- apps/backend-mock/util.cjs (5 hunks)
- apps/web-antd/.env.development (1 hunks)
- apps/web-antd/vite.config.mts (1 hunks)
- apps/web-ele/.env.development (1 hunks)
- apps/web-ele/vite.config.mts (1 hunks)
- apps/web-naive/.env.development (1 hunks)
- apps/web-naive/vite.config.mts (1 hunks)
- docs/src/en/index.md (1 hunks)
- docs/src/guide/essentials/package.json (1 hunks)
- docs/src/guide/essentials/server.md (4 hunks)
- docs/src/guide/essentials/settings.md (1 hunks)
- docs/src/guide/introduction/vben.md (1 hunks)
- docs/src/index.md (1 hunks)
- internal/lint-configs/eslint-config/src/configs/ignores.ts (1 hunks)
- internal/lint-configs/eslint-config/src/custom-config.ts (1 hunks)
- internal/vite-config/index.ts (1 hunks)
- internal/vite-config/package.json (1 hunks)
- internal/vite-config/src/config/application.ts (1 hunks)
- internal/vite-config/src/plugins/index.ts (3 hunks)
- internal/vite-config/src/plugins/mockm-mock.ts (1 hunks)
- internal/vite-config/src/typing.ts (3 hunks)
- internal/vite-config/src/utils/env.ts (2 hunks)
- internal/vite-config/typing.ts (1 hunks)
- package.json (1 hunks)
- scripts/vsh/src/check-dep/index.ts (1 hunks)
- turbo.json (1 hunks)
Files skipped from review due to trivial changes (16)
- .prettierignore
- apps/backend-mock/.eslintignore
- apps/backend-mock/httpData/.gitignore
- apps/backend-mock/httpData/apiWeb.json
- apps/web-antd/.env.development
- apps/web-antd/vite.config.mts
- apps/web-ele/.env.development
- apps/web-ele/vite.config.mts
- apps/web-naive/.env.development
- apps/web-naive/vite.config.mts
- docs/src/en/index.md
- docs/src/guide/essentials/settings.md
- docs/src/index.md
- internal/lint-configs/eslint-config/src/custom-config.ts
- internal/vite-config/src/config/application.ts
- package.json
Additional context used
Markdownlint
apps/backend-mock/README.md
21-21: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
22-22: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
9-9: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
Additional comments not posted (50)
apps/backend-mock/apiWeb.json (1)
1-4: LGTM!The JSON structure is simple and appears to be correctly formatted.
apps/backend-mock/package.json (3)
8-8: Specify the module system.The addition of the
"type": "commonjs"field specifies the module system used in the project, aligning it with Node.js conventions.
10-10: Add a new script for mockm.The new
"mm": "npx mockm"script indicates a shift in the development workflow, potentially replacing previous build and start processes with a new mock server setup.
12-13: Add mockm as a development dependency.The addition of
"mockm": "1.1.27-alpha.2"to thedevDependenciessection signifies thatmockmis now considered a development-only dependency.apps/backend-mock/README.md (3)
5-5: Clarify the description.The updated description clarifies that the service does not require database installation and uses JSON-based storage, enhancing the deployment process.
7-15: Add file structure section.The new file structure section provides an overview of the project layout, enhancing clarity for developers.
Tools
Markdownlint
9-9: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
27-29: Add references for mockm and mockjs.The new references provide useful links to the mockm and mockjs documentation, enhancing usability for developers.
apps/backend-mock/api/menu.cjs (1)
1-10: LGTM! Import and export statements are appropriate.The import statements bring in necessary utilities and mock data, and the export statement defines the configuration for the
mockmlibrary.apps/backend-mock/api/user.cjs (1)
1-8: LGTM! Import and export statements are appropriate.The import statements bring in necessary utilities and mock data, and the export statement defines the configuration for the
mockmlibrary.turbo.json (1)
Line range hint
1-28:
LGTM! Simplified build configuration.The removal of the dependency configuration for
@vben/backend-mock#buildsimplifies the build process. Ensure that the build process is still functioning correctly without this dependency.Verify the impact on the build process.
Ensure that the build process is still functioning correctly without the dependency on
@vben/backend-mock#build.internal/lint-configs/eslint-config/src/configs/ignores.ts (1)
Line range hint
1-37:
Verify the implications of removing the '/.nitro' pattern.**The removal of the '**/.nitro' pattern means that files or directories matching this pattern will now be included in linting checks. Ensure that this change does not introduce any unintended linting errors or issues.
Verification successful
No immediate issues found with the removal of the '/.nitro' pattern.**
The search did not find any
.nitrodirectories or files in the current codebase. While this suggests that removing the '**/.nitro' pattern from the linting ignores is unlikely to have a significant impact, it is advisable to monitor future additions to the codebase for any.nitrodirectories or files that would then be subject to linting.
- No
.nitrodirectories or files found in the current codebase.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the implications of removing the '**/.nitro' pattern from the linting ignores. # Test: Search for files or directories matching the '.nitro' pattern to ensure they are lint-free. rg --type python -A 5 $'.nitro'Length of output: 61
Script:
#!/bin/bash # Description: Verify the implications of removing the '**/.nitro' pattern from the linting ignores. # Test: Search for files or directories matching the '.nitro' pattern across the entire codebase. rg '.nitro'Length of output: 307
apps/backend-mock/mm.config.cjs (2)
12-37: LGTM! Ensure the configuration is correctly integrated.The configuration for mockm looks good. Ensure that it is correctly integrated into the project and that all API routes, proxy settings, and response handlers are functioning as expected.
7-11: Ensure documentation is up-to-date.The configuration references documentation for mockm. Ensure that the documentation is up-to-date and accurately reflects the current configuration.
Verification successful
Documentation is up-to-date.
The configuration references documentation for mockm, and the provided URL leads to a comprehensive and current page detailing the configuration options.
Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the documentation for mockm configuration. # Test: Check the documentation URL to ensure it is up-to-date. curl -s https://hongqiye.com/doc/mockm/config/option.html | grep -i 'mockm configuration options'Length of output: 99
Script:
#!/bin/bash # Description: Fetch the content of the mockm configuration documentation page for manual inspection. # Fetch and display the content of the documentation page. curl -s https://hongqiye.com/doc/mockm/config/option.htmlLength of output: 95869
internal/vite-config/package.json (1)
Line range hint
1-45:
Verify the implications of removing the "nitropack" dependency.The removal of the "nitropack" dependency suggests a shift away from using the Nitropack library. Ensure that this change does not introduce any issues or break existing functionality.
apps/backend-mock/api/auth.cjs (1)
1-10: LGTM!The import statements and module exports are correctly defined.
Also applies to: 12-17
docs/src/guide/essentials/package.json (3)
1-16: LGTM!The package metadata and scripts are correctly defined.
17-28: LGTM!The package files, main/module/types, and exports are correctly defined.
29-54: LGTM!The package dependencies and devDependencies are correctly defined.
scripts/vsh/src/check-dep/index.ts (1)
13-14: LGTM!The modification correctly integrates
@vben/backend-mockinto the dependency check process.internal/vite-config/src/utils/env.ts (2)
72-72: Ensure the new environment variableVITE_MOCKM_MOCKis correctly set.Verify that
VITE_MOCKM_MOCKis correctly defined and used in the environment configuration.Verification successful
The new environment variable
VITE_MOCKM_MOCKis correctly set and used.The variable
VITE_MOCKM_MOCKis defined and utilized in the codebase, as well as documented appropriately.
internal/vite-config/src/utils/env.ts: Definition and usage.docs/src/guide/essentials/settings.md: Documentation reference.docs/src/guide/essentials/server.md: Documentation reference.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the correct usage of the new environment variable `VITE_MOCKM_MOCK`. # Test: Search for the definition and usage of `VITE_MOCKM_MOCK`. Expect: Correct definition and usage. rg --type env -A 5 $'VITE_MOCKM_MOCK'Length of output: 64
Script:
#!/bin/bash # Description: Verify the correct usage of the new environment variable `VITE_MOCKM_MOCK`. # Test: Search for the definition and usage of `VITE_MOCKM_MOCK`. Expect: Correct definition and usage. rg 'VITE_MOCKM_MOCK'Length of output: 419
89-89: Ensure the new variablemockmMockis correctly used in the codebase.Verify that all instances of
mockmMockare correctly used and integrated.Verification successful
The new variable
mockmMockis correctly used and integrated in the codebase.The variable
mockmMockis consistently used across multiple files, including configuration and plugin setup, with proper type definitions.
internal/vite-config/index.tsinternal/vite-config/src/typing.tsinternal/vite-config/typing.tsinternal/vite-config/src/utils/env.tsinternal/vite-config/src/plugins/index.tsScripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the correct usage of the new variable `mockmMock`. # Test: Search for the usage of `mockmMock`. Expect: Correct usage and integration. rg --type python -A 5 $'mockmMock'Length of output: 64
Script:
#!/bin/bash # Description: Verify the correct usage of the new variable `mockmMock`. # Test: Search for the usage of `mockmMock` in TypeScript files. Expect: Correct usage and integration. rg --type ts -A 5 $'mockmMock'Length of output: 3202
docs/src/guide/introduction/vben.md (1)
21-21: Ensure the new mock data solution "Mockm" is correctly documented.Verify that "Mockm" is correctly documented and integrated into the guide.
Verification successful
The new mock data solution "Mockm" is correctly documented and integrated.
The term "Mockm" is consistently used and well-documented across various sections of the guide, ensuring clarity and correctness.
docs/src/guide/introduction/vben.mddocs/src/index.mddocs/src/guide/essentials/settings.mddocs/src/guide/essentials/server.mddocs/src/en/index.mdScripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the correct documentation of the new mock data solution "Mockm". # Test: Search for the term "Mockm" in the documentation. Expect: Correct documentation and integration. rg --type md -A 5 $'Mockm'Length of output: 2848
internal/vite-config/src/plugins/mockm-mock.ts (8)
44-51: Ensure the command-line arguments are correctly constructed.Verify that the command-line arguments are correctly constructed and used.
Verification successful
The command-line arguments are correctly constructed and used.
The
cliArgarray is correctly formed using thelinearray, which includes the necessary key-value pairs for the command-line arguments. These arguments are then passed to theProcessManagerobject as expected.
internal/vite-config/src/plugins/mockm-mock.ts: Lines 44-51Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the correct construction and usage of the command-line arguments. # Test: Search for the usage of the command-line arguments. Expect: Correct construction and handling of the arguments. rg --type typescript -A 5 $'cliArg'Length of output: 69
Script:
#!/bin/bash # Description: Verify the correct construction and usage of the command-line arguments. # Test: Search for the usage of the command-line arguments. Expect: Correct construction and handling of the arguments. rg -t ts -A 5 'cliArg'Length of output: 924
26-30: Ensure the package is correctly retrieved.Verify that the package specified by
mockServerPackageis correctly retrieved.Verification successful
Package retrieval is correctly handled.
The package specified by
mockServerPackageis correctly retrieved using thegetPackagefunction. If the package is not found, an error is logged and the function returns early.
internal/vite-config/src/plugins/mockm-mock.ts(lines 26-30)Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the correct retrieval of the package specified by `mockServerPackage`. # Test: Search for the usage of the `getPackage` function. Expect: Correct retrieval and handling of the package. rg --type typescript -A 5 $'getPackage'Length of output: 73
Script:
#!/bin/bash # Description: Verify the correct retrieval of the package specified by `mockServerPackage`. # Test: Search for the usage of the `getPackage` function. Expect: Correct retrieval and handling of the package. rg --type ts -A 5 $'getPackage'Length of output: 8721
10-14: Ensure the default plugin options are correctly set.Verify that the default plugin options (
mockServerPackage,port,verbose) are correctly set and used.Verification successful
Ensure the default plugin options are correctly set.
The default plugin options (
mockServerPackage,port,verbose) are correctly set in theviteMockmPluginfunction.
mockServerPackageis set to@vben/backend-mock.portis set to5320.verboseis set totrue.These options are used within the function to configure the mock server package, port, and verbosity.
Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the correct usage of the default plugin options. # Test: Search for the usage of the default plugin options. Expect: Correct usage and integration. rg --type typescript -A 5 $'mockServerPackage|port|verbose'Length of output: 95
Script:
#!/bin/bash # Description: Verify the correct usage of the default plugin options. # Test: Search for the usage of the default plugin options. Expect: Correct usage and integration. rg --type ts -A 5 'mockServerPackage|port|verbose'Length of output: 364471
78-86: Ensure thehandleSpacefunction is correctly implemented.Verify that the
handleSpacefunction is correctly implemented and used.Verification successful
The
handleSpacefunction is correctly implemented and used.The function is used to handle paths that may contain spaces, wrapping them in double quotes if the operating system is Windows. This is consistent with the intended behavior described in the comments.
internal/vite-config/src/plugins/mockm-mock.ts:
- Line 78:
--config': handleSpace(${pkg.dir}/mm.config.cjs`),- Line 86:
handleSpace(${pkg.dir}/node_modules/mockm/run.js`),Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the correct implementation and usage of the `handleSpace` function. # Test: Search for the usage of the `handleSpace` function. Expect: Correct implementation and handling of the function. rg --type typescript -A 5 $'handleSpace'Length of output: 74
Script:
#!/bin/bash # Find all TypeScript files and search for the usage of the `handleSpace` function within those files. fd -e ts -e tsx | xargs rg 'handleSpace'Length of output: 336
35-39: Ensure the ports are correctly retrieved.Verify that the ports (
availablePort,testPort,replayPort) are correctly retrieved and used.Verification successful
Ports are correctly retrieved and used.
The ports (
availablePort,testPort,replayPort) are correctly retrieved usingPromise.alland thegetPortfunction. They are subsequently used in the code to check port availability and form command-line arguments.
internal/vite-config/src/plugins/mockm-mock.ts: Lines 35-39, 41-45, 47-52Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the correct retrieval and usage of the ports. # Test: Search for the usage of the ports. Expect: Correct retrieval and handling of the ports. rg --type typescript -A 5 $'availablePort|testPort|replayPort'Length of output: 98
Script:
#!/bin/bash # Description: Verify the correct retrieval and usage of the ports. # Test: Search for the usage of the ports. Expect: Correct retrieval and handling of the ports. rg -t ts -A 5 'availablePort|testPort|replayPort'Length of output: 1358
16-23: Ensure theTransformstream is correctly implemented.Verify that the
Transformstream is correctly implemented and used for logging.Verification successful
The
Transformstream is correctly implemented and integrated.
- The
verboseflag is properly defined and used to conditionally log data.- The
transformStreamis correctly integrated as thestdoutstream for theProcessManagerinstance.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the correct implementation of the `Transform` stream. # Test: Search for the usage of the `Transform` stream. Expect: Correct implementation and integration. rg --type typescript -A 5 $'Transform'Length of output: 72
Script:
#!/bin/bash # Description: Verify the correct implementation of the `Transform` stream. # Test: Search for the usage of the `Transform` stream in TypeScript files. Expect: Correct implementation and integration. rg 'Transform' --glob '*.ts' -A 5Length of output: 1898
Script:
#!/bin/bash # Description: Verify the definition of `verbose` and the integration of `transformStream`. # Test: Search for the definition of `verbose` in the relevant TypeScript file. rg 'verbose' internal/vite-config/src/plugins/mockm-mock.ts -A 5 -B 5 # Test: Search for the usage of `transformStream` in the relevant TypeScript file. rg 'transformStream' internal/vite-config/src/plugins/mockm-mock.ts -A 5 -B 5Length of output: 1755
33-33: Ensure theProcessManageris correctly imported.Verify that the
ProcessManageris correctly imported and used.Verification successful
The
ProcessManageris correctly imported and used.
- The
ProcessManageris dynamically imported usingawait import('@wll8/process-manager').- It is used within the same file
internal/vite-config/src/plugins/mockm-mock.ts.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the correct import and usage of the `ProcessManager`. # Test: Search for the usage of the `ProcessManager`. Expect: Correct import and integration. rg --type typescript -A 5 $'ProcessManager'Length of output: 77
Script:
#!/bin/bash # Description: Verify the correct import of the `ProcessManager`. # Test: Search for the import statement of `ProcessManager`. Expect: Correct import statement. rg "import.*ProcessManager" -t tsLength of output: 35
Script:
#!/bin/bash # Description: Verify the usage of the `ProcessManager`. # Test: Search for the usage of `ProcessManager`. Expect: Correct usage in the codebase. rg "ProcessManager" -t tsLength of output: 229
57-61: Ensure theProcessManageris correctly instantiated.Verify that the
ProcessManageris correctly instantiated and used.internal/vite-config/src/typing.ts (3)
Line range hint
19-33: RenamedNitroMockPluginOptionstoMockmMockPluginOptions.The renaming is consistent and the properties within the interface are clear and well-documented.
98-100: UpdatedApplicationPluginOptionsto usemockmMockandmockmMockOptions.The renaming is consistent with the new
MockmMockPluginOptionsinterface. Ensure that all references tonitroMockandnitroMockOptionsin the codebase are updated accordingly.
145-145: Updated export statement to useMockmMockPluginOptions.The export statement is updated correctly to reflect the new interface name. This ensures that any consumers of this module will use the updated interface.
internal/vite-config/typing.ts (1)
1-147: New file with interface declarations and type exports.The new file introduces interface declarations for various plugin options and exports them. The structure and documentation are clear and consistent with the existing codebase. Ensure that this file is correctly integrated and referenced where needed.
apps/backend-mock/util.cjs (7)
1-14: New functionwrapApiData.The function encapsulates API response wrapping, improving code modularity and reusability. The logic for determining success or error responses is clear and well-documented.
16-23: New functionuseResponseSuccess.The function standardizes the structure of successful API responses. The structure is clear and consistent with common API response formats.
25-32: New functionuseResponseError.The function standardizes the structure of error API responses. The structure is clear and consistent with common API response formats.
34-34: UpdatedMOCK_USERSto a local constant.The change to a local constant is consistent with the new export structure. Ensure that
MOCK_USERSis correctly referenced where needed.
58-58: UpdatedMOCK_CODESto a local constant.The change to a local constant is consistent with the new export structure. Ensure that
MOCK_CODESis correctly referenced where needed.
108-108: UpdatedMOCK_MENUSto a local constant.The change to a local constant is consistent with the new export structure. Ensure that
MOCK_MENUSis correctly referenced where needed.
213-220: Updated export structure to usemodule.exports.The new export structure is clear and consistent, improving the module's usability. Ensure that all exported entities are correctly referenced where needed.
internal/vite-config/src/plugins/index.ts (3)
26-26: Import statement forviteMockmPluginlooks good.The import statement correctly imports the
viteMockmPluginfrom themockm-mockmodule.
104-105: Function signature change forloadApplicationPluginslooks good.The function signature correctly replaces
nitroMockandnitroMockOptionswithmockmMockandmockmMockOptions.
136-138: Conditional plugin loading forviteMockmPluginlooks good.The conditional logic correctly checks for
mockmMockand loads theviteMockmPluginwithmockmMockOptions.docs/src/guide/essentials/server.md (3)
7-7: Introduction update to referenceMockmlooks good.The introduction correctly references
Mockmand provides a link to its documentation.
49-49: Proxy target URL update looks good.The update to use
127.0.0.1instead oflocalhostcan help avoid potential DNS resolution issues.
257-271: Mockm usage and configuration update looks good.The documentation correctly describes how to use and configure
Mockmand provides relevant links to its documentation.internal/vite-config/index.ts (3)
1-27: Import statements look good.The import statements correctly import the necessary Vite plugins, including the new
viteMockmPlugin.
29-42: FunctionloadConditionPluginslooks good.The function is well-structured and correctly loads the plugins based on the provided conditions.
87-200: FunctionloadApplicationPluginslooks good.The function is well-structured and correctly loads the application-specific plugins based on the provided conditions, including the new
viteMockmPlugin.
apps/backend-mock/api/menu.cjs
Outdated
| /** @type {import('mockm/@types/config').Config} */ | ||
| module.exports = util => { | ||
| const { | ||
| libObj: { mockjs }, | ||
| } = util | ||
| return { | ||
| api: { | ||
| '/api/menu/all'(req, res){ | ||
| const token = req.get(`Authorization`) | ||
| if (!token) { | ||
| return res.status(401).json(useResponseError('UnauthorizedException', 'Unauthorized Exception')) | ||
| } | ||
| const username = Buffer.from(token, 'base64').toString('utf8'); | ||
|
|
||
| const menus = MOCK_MENUS.find((item) => item.username === username)?.menus ?? []; | ||
| res.json(useResponseSuccess(menus)) | ||
|
|
||
| }, | ||
| }, | ||
| } |
There was a problem hiding this comment.
LGTM! Well-structured function definition.
The function defines the configuration for the mockm library, including an API endpoint for retrieving all menu items. It properly handles authorization and returns appropriate responses.
Reminder: Add tests for the new API endpoint.
The new API endpoint should have corresponding tests to ensure its functionality.
Do you want me to generate the unit testing code or open a GitHub issue to track this task?
apps/backend-mock/api/user.cjs
Outdated
| /** @type {import('mockm/@types/config').Config} */ | ||
| module.exports = util => { | ||
| const { | ||
| libObj: { mockjs }, | ||
| } = util | ||
| return { | ||
| api: { | ||
| '/api/user/info'(req, res) { | ||
| const token = req.get(`Authorization`) | ||
| if (!token) { | ||
| return res.status(401).json(useResponseError('UnauthorizedException', 'Unauthorized Exception')) | ||
| } | ||
| const username = Buffer.from(token, 'base64').toString('utf8'); | ||
|
|
||
| const user = MOCK_USERS.find((item) => item.username === username); | ||
|
|
||
| const { password: _pwd, ...userInfo } = user; | ||
| res.json(useResponseSuccess(user)) | ||
| }, | ||
| }, | ||
| } | ||
| } |
There was a problem hiding this comment.
LGTM! Well-structured function definition.
The function defines the configuration for the mockm library, including an API endpoint for retrieving user information. It properly handles authorization and returns appropriate responses.
Reminder: Add tests for the new API endpoint.
The new API endpoint should have corresponding tests to ensure its functionality.
Do you want me to generate the unit testing code or open a GitHub issue to track this task?
| 'post /api/auth/login'(req, res) { | ||
| const { password, username } = req.body; | ||
|
|
||
| const findUser = MOCK_USERS.find( | ||
| (item) => item.username === username && item.password === password, | ||
| ); | ||
|
|
||
| if (!findUser) { | ||
| return res.status(403).json(useResponseError('UnauthorizedException', '用户名或密码错误')) | ||
| } | ||
|
|
||
| const accessToken = Buffer.from(username).toString('base64'); | ||
| res.json(useResponseSuccess({ | ||
| accessToken, | ||
| // TODO: refresh token | ||
| refreshToken: accessToken, | ||
| })); |
There was a problem hiding this comment.
Reminder: Generate refresh token.
There is a TODO comment for generating a refresh token.
Do you want me to generate the code for generating a refresh token or open a GitHub issue to track this task?
apps/backend-mock/README.md
Outdated
| $ pnpm i mockm | ||
| $ npx mm |
There was a problem hiding this comment.
Fix Markdownlint issues by removing dollar signs.
The dollar signs before the commands should be removed to comply with Markdownlint rules.
- $ pnpm i mockm
- $ npx mm
+ pnpm i mockm
+ npx mmCommittable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| $ pnpm i mockm | |
| $ npx mm | |
| pnpm i mockm | |
| npx mm |
Tools
Markdownlint
21-21: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
22-22: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
apps/backend-mock/api/auth.cjs
Outdated
| '/api/auth/codes'(req, res) { | ||
| const token = req.get(`Authorization`) | ||
| if (!token) { | ||
| return res.status(401).json(useResponseError('UnauthorizedException', 'Unauthorized Exception')) | ||
| } | ||
| const username = Buffer.from(token, 'base64').toString('utf8'); | ||
|
|
||
| const codes = MOCK_CODES.find((item) => item.username === username)?.codes ?? []; | ||
| res.json(useResponseSuccess(codes)) | ||
| }, |
There was a problem hiding this comment.
Improve token validation and error handling.
The function should validate the token format and improve error handling for potential issues during token decoding.
+ if (!token || !Buffer.from(token, 'base64').toString('utf8')) {
+ return res.status(400).json(useResponseError('InvalidTokenException', 'Invalid token format'))
+ }Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| '/api/auth/codes'(req, res) { | |
| const token = req.get(`Authorization`) | |
| if (!token) { | |
| return res.status(401).json(useResponseError('UnauthorizedException', 'Unauthorized Exception')) | |
| } | |
| const username = Buffer.from(token, 'base64').toString('utf8'); | |
| const codes = MOCK_CODES.find((item) => item.username === username)?.codes ?? []; | |
| res.json(useResponseSuccess(codes)) | |
| }, | |
| '/api/auth/codes'(req, res) { | |
| const token = req.get(`Authorization`) | |
| if (!token) { | |
| return res.status(401).json(useResponseError('UnauthorizedException', 'Unauthorized Exception')) | |
| } | |
| if (!token || !Buffer.from(token, 'base64').toString('utf8')) { | |
| return res.status(400).json(useResponseError('InvalidTokenException', 'Invalid token format')) | |
| } | |
| const username = Buffer.from(token, 'base64').toString('utf8'); | |
| const codes = MOCK_CODES.find((item) => item.username === username)?.codes ?? []; | |
| res.json(useResponseSuccess(codes)) | |
| }, |
There was a problem hiding this comment.
Actionable comments posted: 2
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files ignored due to path filters (1)
pnpm-lock.yamlis excluded by!**/pnpm-lock.yaml
Files selected for processing (5)
- apps/backend-mock/api/auth.cjs (1 hunks)
- apps/backend-mock/api/menu.cjs (1 hunks)
- apps/backend-mock/api/user.cjs (1 hunks)
- apps/backend-mock/get-user.cjs (1 hunks)
- apps/backend-mock/mm.config.cjs (1 hunks)
Files skipped from review as they are similar to previous changes (3)
- apps/backend-mock/api/auth.cjs
- apps/backend-mock/api/menu.cjs
- apps/backend-mock/api/user.cjs
Additional comments not posted (3)
apps/backend-mock/mm.config.cjs (3)
16-16: LGTM!The inclusion of the
getUserplugin is appropriate.
17-19: LGTM!The proxy configuration appears correct.
58-60: LGTM!The response handlers are well-defined and follow best practices.
apps/backend-mock/get-user.cjs
Outdated
| try { | ||
| const token = req.get(`Authorization`); | ||
| const username = Buffer.from(token, 'base64').toString('utf8'); | ||
| req.username = username; | ||
| } catch { | ||
| // ... | ||
| } |
There was a problem hiding this comment.
Add logging for errors and improve error handling.
The current error handling is minimal and lacks logging. This can make debugging difficult.
- } catch {
- // ...
+ } catch (error) {
+ console.error('Error decoding Authorization header:', error);
+ res.status(400).send('Invalid Authorization header');Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| try { | |
| const token = req.get(`Authorization`); | |
| const username = Buffer.from(token, 'base64').toString('utf8'); | |
| req.username = username; | |
| } catch { | |
| // ... | |
| } | |
| try { | |
| const token = req.get(`Authorization`); | |
| const username = Buffer.from(token, 'base64').toString('utf8'); | |
| req.username = username; | |
| } catch (error) { | |
| console.error('Error decoding Authorization header:', error); | |
| res.status(400).send('Invalid Authorization header'); |
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- internal/vite-config/src/config/application.ts (1 hunks)
Files skipped from review as they are similar to previous changes (1)
- internal/vite-config/src/config/application.ts
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- apps/backend-mock/README.md (1 hunks)
- apps/backend-mock/mm.config.cjs (1 hunks)
Files skipped from review as they are similar to previous changes (1)
- apps/backend-mock/mm.config.cjs
Additional context used
Markdownlint
apps/backend-mock/README.md
9-9: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
Additional comments not posted (4)
apps/backend-mock/README.md (4)
5-6: Description Update Approved.The updated description accurately reflects the use of
mockmand JSON-based storage, providing clear information about the new approach and its benefits.
7-16: File Structure Section Approved.The new section detailing the project file structure is clear and provides useful information about the organization of directories and files.
Tools
Markdownlint
9-9: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
21-22: Running Instructions Update Approved.The updated instructions for running the application with
mockmare clear and provide necessary information.
25-29: Reference Section Update Approved.The new references to
mockmdocumentation and code repository are useful and provide additional information for users.
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files ignored due to path filters (1)
pnpm-lock.yamlis excluded by!**/pnpm-lock.yaml
Files selected for processing (5)
- docs/src/index.md (1 hunks)
- internal/lint-configs/eslint-config/src/configs/ignores.ts (1 hunks)
- internal/vite-config/src/config/application.ts (1 hunks)
- package.json (1 hunks)
- turbo.json (1 hunks)
Files skipped from review due to trivial changes (1)
- package.json
Files skipped from review as they are similar to previous changes (4)
- docs/src/index.md
- internal/lint-configs/eslint-config/src/configs/ignores.ts
- internal/vite-config/src/config/application.ts
- turbo.json
Description
使用 mockm, 因为:
Type of change
Please delete options that are not relevant.
pnpm-lock.yamlunless you introduce a new test example.Checklist
pnpm run docs:devcommand.pnpm test.feat:,fix:,perf:,docs:, orchore:.Summary by CodeRabbit
New Features
/api/auth/codesand/api/auth/loginendpoints./api/menu/all./api/user/info.Documentation
Bug Fixes
Chores
.gitignoreand.eslintignoreconfigurations to streamline development.VITE_NITRO_MOCKtoVITE_MOCKM_MOCKacross configurations.