Fix/refactor email routes and fix tests#101
Merged
MasumRab merged 3 commits intoscientificfrom Sep 26, 2025
Merged
Conversation
This commit introduces several improvements to the Python testing setup, focusing on the NLP components in `server/python_nlp/`.
Key changes include:
- Resolved all failing unit tests in `server/python_nlp/tests/analysis_components/`:
- Modified `sentiment_model.py` to ensure `TextBlob` is defined even if the optional import fails, allowing tests to patch it correctly.
- Adjusted test input in `test_topic_model.py` to prevent misclassification due to an overly broad keyword ("statement").
- Corrected assertions in `test_urgency_model.py` to align with the defined regex logic for "when you can".
- Added an `npm test` script (via `test:py`) in `package.json` to execute Python tests. This script runs `pytest` and correctly ignores tests in `server/python_backend/tests/` which depend on a missing module (`action_item_extractor.py`) not relevant to the current branch's testing scope.
- Updated `README.md` with a new "Testing" section, detailing how to install Python test dependencies and run the tests.
- TypeScript test setup (Vitest) was explored but ultimately skipped as per current requirements, due to missing dependencies in the `shared` directory and your confirmation that these tests are not needed at this time.
All 25 Python tests in `server/python_nlp/tests/` now pass with the `npm test` command.
Refactor/python nlp testing
This commit addresses significant technical debt by refactoring the email handling logic and fixing the entire test suite. The email routes in the TypeScript server have been updated to proxy requests to the Python server, centralizing the email logic and removing duplication. The test suite has been made robust by: - Mocking the database connection to remove external dependencies. - Using `supertest` for integration-style testing of API routes. - Migrating all tests from `jest` to `vitest` syntax. - Fixing environment variable issues with `dotenv-cli`. All tests are now passing, making the codebase more stable and easier to maintain.
Contributor
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the ✨ Finishing touches🧪 Generate unit tests
Tip 👮 Agentic pre-merge checks are now available in preview!Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.
Please see the documentation for more information. Example: reviews:
pre_merge_checks:
custom_checks:
- name: "Undocumented Breaking Changes"
mode: "warning"
instructions: |
Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).Please share your feedback with us on this Discord post. 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. Comment |
Contributor
Reviewer's GuideThis PR refactors the testing framework from Jest to Vitest with Supertest, overhauls email route implementations to delegate storage operations to the Python NLP bridge, consolidates shared Zod schemas and database configuration, and updates project tooling (Vite, package.json scripts, README) to support the new setup. File-Level Changes
Possibly linked issues
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Hey there - I've reviewed your changes and they look great!
Prompt for AI Agents
Please address the comments from this code review:
## Individual Comments
### Comment 1
<location> `server/python-bridge.ts:42-58` </location>
<code_context>
this.pythonScriptPath = path.join(__dirname, 'python_nlp', 'nlp_engine.py');
}
+ private async request<T>(path: string, options: RequestInit = {}): Promise<T> {
+ const url = `${PYTHON_SERVER_URL}${path}`;
+ const response = await fetch(url, {
+ ...options,
+ headers: {
+ 'Content-Type': 'application/json',
+ ...options.headers,
+ },
+ });
+
+ if (!response.ok) {
+ const errorText = await response.text();
+ throw new Error(`Python server request failed: ${response.status} ${response.statusText} - ${errorText}`);
+ }
+
+ return response.json() as Promise<T>;
+ }
+
</code_context>
<issue_to_address>
**suggestion:** The new request method does not handle network errors or timeouts.
Wrap the fetch call in a try/catch block to handle network errors and timeouts, ensuring that failures are managed and informative errors are returned.
```suggestion
private async request<T>(path: string, options: RequestInit = {}): Promise<T> {
const url = `${PYTHON_SERVER_URL}${path}`;
let response: Response;
try {
response = await fetch(url, {
...options,
headers: {
'Content-Type': 'application/json',
...options.headers,
},
});
} catch (error: any) {
throw new Error(`Network error or timeout when contacting Python server: ${error?.message || error}`);
}
if (!response.ok) {
const errorText = await response.text();
throw new Error(`Python server request failed: ${response.status} ${response.statusText} - ${errorText}`);
}
return response.json() as Promise<T>;
}
```
</issue_to_address>
### Comment 2
<location> `server/python_nlp/analysis_components/sentiment_model.py:12` </location>
<code_context>
# nltk.download('stopwords') # Required for keyword extraction in NLPEngine
HAS_NLTK = True
except ImportError:
+ TextBlob = None # Ensure TextBlob name exists even if import fails
HAS_NLTK = False
</code_context>
<issue_to_address>
**suggestion (bug_risk):** TextBlob is set to None if import fails, which may mask errors.
This approach may lead to unexpected TypeErrors if TextBlob is used without checking HAS_NLTK. Recommend raising an explicit error or consistently guarding usage with HAS_NLTK.
Suggested implementation:
```python
except ImportError:
HAS_NLTK = False
```
You should also:
1. Audit the rest of the file for any usage of `TextBlob`. Wherever `TextBlob` is used, ensure it is only accessed if `HAS_NLTK` is `True`. If not, raise an ImportError with a clear message, e.g.:
```python
if not HAS_NLTK:
raise ImportError("TextBlob is not available. Please install the required dependencies.")
```
2. If there are functions/classes that depend on `TextBlob`, add the above guard at the start of those functions/classes.
</issue_to_address>
### Comment 3
<location> `vite.config.ts:62` </location>
<code_context>
+ },
+});
+
+export default mergeConfig(viteConfig, testConfig);
</code_context>
<issue_to_address>
**issue (complexity):** Consider splitting Vitest configuration into a separate vitest.config.ts file to keep vite.config.ts focused on dev/build setup.
Here’s one way to cut the noise by pulling your Vitest bits into vitest.config.ts and keeping vite.config.ts solely about your dev/build setup. You’ll still get all the same functionality, but each file stays focused and you drop the manual merge/dual-`defineConfig` logic.
---
**1) vite.config.ts**
```ts
import { defineConfig } from "vite";
import react from "@vitejs/plugin-react";
import tsconfigPaths from "vite-tsconfig-paths";
import runtimeErrorOverlay from "@replit/vite-plugin-runtime-error-modal";
import path from "path";
export default defineConfig(async ({ mode }) => ({
plugins: [
tsconfigPaths(), // reads your tsconfig.json aliases
react(),
runtimeErrorOverlay(),
...(mode !== "production" && process.env.REPL_ID
? [
(
await import("@replit/vite-plugin-cartographer")
).cartographer(),
]
: []),
],
resolve: {
// only overrides not in tsconfig.json
alias: {
"@assets": path.resolve(".", "attached_assets"),
},
},
root: path.resolve(".", "client"),
build: {
outDir: path.resolve(".", "dist/public"),
emptyOutDir: true,
},
server: {
fs: { strict: true, deny: ["**/.*"] },
},
}));
```
**2) vitest.config.ts**
```ts
import { defineConfig } from "vitest/config";
import tsconfigPaths from "vite-tsconfig-paths";
export default defineConfig({
test: {
root: ".",
globals: true,
environment: "node",
include: ["server/**/*.test.ts"],
setupFiles: "server/tests/setup.ts", // if you need it
plugins: [tsconfigPaths()], // same alias plugin
coverage: {
provider: "v8",
reporter: ["text", "json", "html"],
},
},
});
```
Benefits:
- No more custom `mergeConfig` dance or dual imports of `defineConfig`.
- Vitest will auto‐pick up vitest.config.ts; your Vite file is only Vite.
- All alias logic lives in your tsconfig.json and is handled by a single plugin.
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Comment on lines
+42
to
+58
| private async request<T>(path: string, options: RequestInit = {}): Promise<T> { | ||
| const url = `${PYTHON_SERVER_URL}${path}`; | ||
| const response = await fetch(url, { | ||
| ...options, | ||
| headers: { | ||
| 'Content-Type': 'application/json', | ||
| ...options.headers, | ||
| }, | ||
| }); | ||
|
|
||
| if (!response.ok) { | ||
| const errorText = await response.text(); | ||
| throw new Error(`Python server request failed: ${response.status} ${response.statusText} - ${errorText}`); | ||
| } | ||
|
|
||
| return response.json() as Promise<T>; | ||
| } |
Contributor
There was a problem hiding this comment.
suggestion: The new request method does not handle network errors or timeouts.
Wrap the fetch call in a try/catch block to handle network errors and timeouts, ensuring that failures are managed and informative errors are returned.
Suggested change
| private async request<T>(path: string, options: RequestInit = {}): Promise<T> { | |
| const url = `${PYTHON_SERVER_URL}${path}`; | |
| const response = await fetch(url, { | |
| ...options, | |
| headers: { | |
| 'Content-Type': 'application/json', | |
| ...options.headers, | |
| }, | |
| }); | |
| if (!response.ok) { | |
| const errorText = await response.text(); | |
| throw new Error(`Python server request failed: ${response.status} ${response.statusText} - ${errorText}`); | |
| } | |
| return response.json() as Promise<T>; | |
| } | |
| private async request<T>(path: string, options: RequestInit = {}): Promise<T> { | |
| const url = `${PYTHON_SERVER_URL}${path}`; | |
| let response: Response; | |
| try { | |
| response = await fetch(url, { | |
| ...options, | |
| headers: { | |
| 'Content-Type': 'application/json', | |
| ...options.headers, | |
| }, | |
| }); | |
| } catch (error: any) { | |
| throw new Error(`Network error or timeout when contacting Python server: ${error?.message || error}`); | |
| } | |
| if (!response.ok) { | |
| const errorText = await response.text(); | |
| throw new Error(`Python server request failed: ${response.status} ${response.statusText} - ${errorText}`); | |
| } | |
| return response.json() as Promise<T>; | |
| } |
| # nltk.download('stopwords') # Required for keyword extraction in NLPEngine | ||
| HAS_NLTK = True | ||
| except ImportError: | ||
| TextBlob = None # Ensure TextBlob name exists even if import fails |
Contributor
There was a problem hiding this comment.
suggestion (bug_risk): TextBlob is set to None if import fails, which may mask errors.
This approach may lead to unexpected TypeErrors if TextBlob is used without checking HAS_NLTK. Recommend raising an explicit error or consistently guarding usage with HAS_NLTK.
Suggested implementation:
except ImportError:
HAS_NLTK = FalseYou should also:
- Audit the rest of the file for any usage of
TextBlob. WhereverTextBlobis used, ensure it is only accessed ifHAS_NLTKisTrue. If not, raise an ImportError with a clear message, e.g.:
if not HAS_NLTK:
raise ImportError("TextBlob is not available. Please install the required dependencies.")- If there are functions/classes that depend on
TextBlob, add the above guard at the start of those functions/classes.
| }, | ||
| }); | ||
|
|
||
| export default mergeConfig(viteConfig, testConfig); |
Contributor
There was a problem hiding this comment.
issue (complexity): Consider splitting Vitest configuration into a separate vitest.config.ts file to keep vite.config.ts focused on dev/build setup.
Here’s one way to cut the noise by pulling your Vitest bits into vitest.config.ts and keeping vite.config.ts solely about your dev/build setup. You’ll still get all the same functionality, but each file stays focused and you drop the manual merge/dual-defineConfig logic.
1) vite.config.ts
import { defineConfig } from "vite";
import react from "@vitejs/plugin-react";
import tsconfigPaths from "vite-tsconfig-paths";
import runtimeErrorOverlay from "@replit/vite-plugin-runtime-error-modal";
import path from "path";
export default defineConfig(async ({ mode }) => ({
plugins: [
tsconfigPaths(), // reads your tsconfig.json aliases
react(),
runtimeErrorOverlay(),
...(mode !== "production" && process.env.REPL_ID
? [
(
await import("@replit/vite-plugin-cartographer")
).cartographer(),
]
: []),
],
resolve: {
// only overrides not in tsconfig.json
alias: {
"@assets": path.resolve(".", "attached_assets"),
},
},
root: path.resolve(".", "client"),
build: {
outDir: path.resolve(".", "dist/public"),
emptyOutDir: true,
},
server: {
fs: { strict: true, deny: ["**/.*"] },
},
}));2) vitest.config.ts
import { defineConfig } from "vitest/config";
import tsconfigPaths from "vite-tsconfig-paths";
export default defineConfig({
test: {
root: ".",
globals: true,
environment: "node",
include: ["server/**/*.test.ts"],
setupFiles: "server/tests/setup.ts", // if you need it
plugins: [tsconfigPaths()], // same alias plugin
coverage: {
provider: "v8",
reporter: ["text", "json", "html"],
},
},
});Benefits:
- No more custom
mergeConfigdance or dual imports ofdefineConfig. - Vitest will auto‐pick up vitest.config.ts; your Vite file is only Vite.
- All alias logic lives in your tsconfig.json and is handled by a single plugin.
MasumRab
added a commit
that referenced
this pull request
Oct 29, 2025
…ix-tests Fix/refactor email routes and fix tests
MasumRab
added a commit
that referenced
this pull request
Nov 6, 2025
…ix-tests Fix/refactor email routes and fix tests
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary by Sourcery
Refactor server routes to use a new pythonNLP HTTP bridge, standardize testing with Vitest and supertest, enhance build and config for testing, and update documentation and shared schemas.
New Features:
Bug Fixes:
Enhancements:
Build:
Documentation:
Tests: