Daniel dev #47

danielmarv · 2025-11-06T20:03:04Z

Summary of Changes (What does this PR do?)

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Status of maturity (all need to be checked before merging):

I've tested this locally
I consider this code done
This change ready to hit production in its current state
The title of the PR states what changed and the related issues number (used for the release note).
I've included issue number in the "Closes #ISSUE-NUMBER" part of the "What are the relevant tickets?" section to link the issue.
I've updated corresponding documentation for the changes in this PR.
I have written unit and/or e2e tests for my change(s).

How should this be manually tested?

Please include the steps to be done inorder to setup and test this PR.

What are the relevant tickets?

Closes #

Screenshots (optional)

Sync

…into Daniel-Dev

- Created Jest configuration files for `agricasst`, `auth`, `price-monitoring`, and `wcapi` services. - Implemented health check tests for each service: - `agricasst`: Tests for 200 status and 'OK' payload. - `auth`: Tests for 200 status and 'success' status with version. - `price-monitoring`: Tests for 200 status and 'ok' payload with uptime. - `wcapi`: Tests for 200 status and 'OK' payload with uptime.

- Added supertest as a dependency for testing HTTP requests. - Removed unused jest configuration file in auth module. - Updated test scripts in auth module to use experimental VM modules. - Changed dependencies in auth module to use specific versions. - Updated test script in price-monitoring module to use experimental VM modules. - Added jest and supertest as devDependencies in price-monitoring module. - Modified server.js in price-monitoring to connect to the database only outside of test environment. - Updated environment variables in env.js for price-monitoring with default values.

Copilot

Pull Request Overview

This PR refactors the project into a monorepo structure and standardizes environment variable handling, testing infrastructure, and code quality tooling across all microservices.

Introduces centralized environment validation using envalid with a new env module pattern across all services
Consolidates Jest testing configuration with ES modules support and adds health endpoint tests for all services
Establishes monorepo workspace structure with shared linting, formatting, and type-checking configurations

Reviewed Changes

Copilot reviewed 33 out of 35 changed files in this pull request and generated 13 comments.

Show a summary per file

File	Description
tsconfig.base.json	Base TypeScript configuration for JavaScript type-checking across services
package.json	Root package configuration establishing monorepo workspace structure and shared tooling
.prettierrc.json	Centralized code formatting rules
.prettierignore	Exclusion patterns for Prettier formatting
.gitignore	Updated to include additional build artifacts and local files
.github/workflows/ci.yml	CI workflow for automated linting and testing of services
.eslintrc.json	Shared ESLint configuration for code quality enforcement
.editorconfig	Editor configuration for consistent coding style
src/wcapi/tsconfig.json	TypeScript configuration extending base config
src/wcapi/tests/health.test.js	Health endpoint test for wcapi service
src/wcapi/package.json	Updated test command to use monorepo Jest and added typecheck script
src/wcapi/jest.config.cjs	Jest configuration for ES modules support
src/wcapi/config/env.js	Environment variable validation and loading with envalid
src/wcapi/app.js	Migrated to use centralized env module and conditional server startup for tests
src/price-monitoring/tsconfig.json	TypeScript configuration extending base config
src/price-monitoring/tests/health.test.js	Health endpoint test for price-monitoring service
src/price-monitoring/src/config/env.js	Environment variable validation and loading with envalid
src/price-monitoring/server.js	Migrated to use centralized env module and added health endpoint
src/price-monitoring/package.json	Updated dependencies and added test infrastructure
src/price-monitoring/jest.config.cjs	Jest configuration for ES modules support
src/auth/tsconfig.json	TypeScript configuration extending base config
src/auth/tests/health.test.js	Health endpoint test for auth service
src/auth/package.json	Updated test commands and removed setupFilesAfterEnv configuration
src/auth/config/env.js	Environment variable validation and loading with envalid
src/auth/app.js	Migrated to use centralized env module and conditional server startup for tests
src/auth/README.md	Fixed escaped backticks in code blocks
src/auth/.env.example	Updated environment variable examples with duplicates
src/agricasst/tsconfig.json	TypeScript configuration extending base config
src/agricasst/tests/health.test.js	Health endpoint test for agricasst service
src/agricasst/server.js	Migrated to use centralized env module and conditional server startup for tests
src/agricasst/package.json	Updated dependencies and test scripts
src/agricasst/jest.config.cjs	Jest configuration for ES modules support
src/agricasst/config/env.js	Environment variable validation and loading with envalid
src/agricasst/.env.example	Updated environment variable examples with duplicates

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

Copilot · 2025-11-06T20:10:45Z

src/auth/.env.example

+NODE_ENV=development
+PORT=5000
+MONGODB_URI=mongodb://localhost:27017/clycites-auth
+JWT_SECRET=replace_me
+JWT_REFRESH_SECRET=replace_me
+OPENAI_API_KEY=replace_me
+SESSION_SECRET=replace_me
+CLIENT_URL=http://localhost:3000
+EMAIL_SERVICE=
 # Environment
 NODE_ENV=development
 PORT=5000


Duplicate entries detected in the .env.example file. Lines 1-18 contain environment variable definitions that are repeated again starting at line 19. This duplication should be removed to avoid confusion.

Suggested change

NODE_ENV=development

PORT=5000

MONGODB_URI=mongodb://localhost:27017/clycites-auth

JWT_SECRET=replace_me

JWT_REFRESH_SECRET=replace_me

OPENAI_API_KEY=replace_me

SESSION_SECRET=replace_me

CLIENT_URL=http://localhost:3000

EMAIL_SERVICE=

# Environment

NODE_ENV=development

PORT=5000

Copilot · 2025-11-06T20:10:45Z

src/price-monitoring/server.js

-connectDB();
+// Connect to DB only outside test
+if (env.NODE_ENV !== 'test') {
+	connectDB();


Tab character used for indentation instead of spaces. This is inconsistent with the project's .editorconfig which specifies indent_style = space with indent_size = 2.

Suggested change

connectDB();

connectDB();

Copilot · 2025-11-06T20:10:46Z

src/price-monitoring/package.json

  "dependencies": {
    "axios": "^1.8.4",
-    "bcryptjs": "^3.0.2",
+    "bcryptjs": "^2.4.3",


Version mismatch: The package.json specifies bcryptjs@^2.4.3, but the package-lock.json shows version 3.0.2 is installed. This inconsistency can lead to unexpected behavior. Either update package.json to match the lock file or regenerate the lock file to match package.json.

Suggested change

"bcryptjs": "^2.4.3",

"bcryptjs": "^3.0.2",

Copilot · 2025-11-06T20:10:46Z

src/price-monitoring/server.js


+// Health check endpoint
+app.get('/health', (req, res) => {
+	res.json({ status: 'ok', uptime: process.uptime() });


Tab character used for indentation instead of spaces. This is inconsistent with the project's .editorconfig which specifies indent_style = space with indent_size = 2.

Suggested change

res.json({ status: 'ok', uptime: process.uptime() });

res.json({ status: 'ok', uptime: process.uptime() });

Copilot · 2025-11-06T20:10:47Z

src/auth/package.json

@@ -79,9 +81,6 @@
  },
  "jest": {
    "testEnvironment": "node",


The setupFilesAfterEnv configuration was removed, but the tests/setup.js file still exists and provides important test setup including MongoDB memory server initialization, cleanup, and environment mocking. Without this configuration, the setup file won't be executed and tests may fail or not run in the proper test environment.

Suggested change

"testEnvironment": "node",

"testEnvironment": "node",

"setupFilesAfterEnv": [

"<rootDir>/tests/setup.js"

],

Copilot · 2025-11-06T20:10:48Z

.github/workflows/ci.yml

+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+  service: [wcapi, agricasst, price-monitoring]


Incorrect indentation for matrix configuration. The service: key should be indented with 8 spaces (or 4 additional spaces from matrix:), not 2. This will cause the GitHub Actions workflow to fail with a syntax error.

Suggested change

service: [wcapi, agricasst, price-monitoring]

service: [wcapi, agricasst, price-monitoring]

Copilot · 2025-11-06T20:10:49Z

src/price-monitoring/src/config/env.js

+  PORT: port({ default: 5000 }),
+  MONGO_URI: str({ default: 'mongodb://localhost:27017/price-monitoring' }),
+  JWT_SECRET: str({ default: 'test-secret' }),
+  EMAIL_USER: email({ default: '' }),


The email() validator from envalid requires a valid email format, but the default is an empty string ''. Empty strings do not pass email validation. Either use str() validator instead, provide a valid default email, or make the field optional by using { default: undefined } with proper handling.

Suggested change

EMAIL_USER: email({ default: '' }),

EMAIL_USER: email({ default: undefined }),

Copilot · 2025-11-06T20:10:49Z

src/auth/app.js

@@ -609,29 +596,31 @@ app.use(errorHandler)

 const PORT = process.env.PORT || 5000


The PORT is still using process.env.PORT instead of env.PORT from the imported env module. This is inconsistent with the rest of the file where environment variables have been migrated to use the env module.

Suggested change

const PORT = process.env.PORT || 5000

const PORT = env.PORT || 5000

Copilot · 2025-11-06T20:10:50Z

src/agricasst/.env.example

+NODE_ENV=development
+PORT=3001
+MONGODB_URI=mongodb://localhost:27017/agric-assistant


Duplicate entries detected. Lines 1-7 are repeated starting at line 5. This duplication creates confusion and should be removed.

Suggested change

NODE_ENV=development

PORT=3001

MONGODB_URI=mongodb://localhost:27017/agric-assistant

Copilot · 2025-11-06T20:10:50Z

src/price-monitoring/server.js

-app.listen(PORT, () => console.log(`Server running on port ${PORT}`));
+const PORT = env.PORT;
+if (env.NODE_ENV !== 'test') {
+	app.listen(PORT, () => console.log(`Server running on port ${PORT}`));


Tab character used for indentation instead of spaces. This is inconsistent with the project's .editorconfig which specifies indent_style = space with indent_size = 2.

Suggested change

app.listen(PORT, () => console.log(`Server running on port ${PORT}`));

app.listen(PORT, () => console.log(`Server running on port ${PORT}`));

danielmarv added 11 commits July 14, 2025 12:59

Merge pull request #42 from ClyCites/staging

6651149

Sync

commit

f1ddd61

Merge branch 'Daniel-Dev' of https://github.com/ClyCites/ClyCites-api …

60e6687

…into Daniel-Dev

Merge remote-tracking branch 'origin/staging' into Daniel-Dev

7443b9e

chore: update project configuration and add health check endpoint

3bd341c

backup before fixing refs

d8b6319

refactor: replace dotenv with custom env configuration and add env.js

d25c036

commit

adc9830

fix: correct code block formatting in README.md

8af0c23

Copilot AI review requested due to automatic review settings November 6, 2025 20:03

danielmarv merged commit 4a36cf9 into staging Nov 6, 2025
4 checks passed

Copilot AI reviewed Nov 6, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Daniel dev #47

Daniel dev #47

Uh oh!

danielmarv commented Nov 6, 2025

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Nov 6, 2025

Uh oh!

Copilot AI Nov 6, 2025

Uh oh!

Copilot AI Nov 6, 2025

Uh oh!

Copilot AI Nov 6, 2025

Uh oh!

Copilot AI Nov 6, 2025

Uh oh!

Copilot AI Nov 6, 2025

Uh oh!

Copilot AI Nov 6, 2025

Uh oh!

Copilot AI Nov 6, 2025

Uh oh!

Copilot AI Nov 6, 2025

Uh oh!

Copilot AI Nov 6, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	res.json({ status: 'ok', uptime: process.uptime() });
	res.json({ status: 'ok', uptime: process.uptime() });

	service: [wcapi, agricasst, price-monitoring]
	service: [wcapi, agricasst, price-monitoring]

	EMAIL_USER: email({ default: '' }),
	EMAIL_USER: email({ default: undefined }),

		@@ -609,29 +596,31 @@ app.use(errorHandler)

		const PORT = process.env.PORT \|\| 5000

	const PORT = process.env.PORT \|\| 5000
	const PORT = env.PORT \|\| 5000

	NODE_ENV=development
	PORT=3001
	MONGODB_URI=mongodb://localhost:27017/agric-assistant

	app.listen(PORT, () => console.log(`Server running on port ${PORT}`));
	app.listen(PORT, () => console.log(`Server running on port ${PORT}`));

Uh oh!

Daniel dev #47

Daniel dev #47

Uh oh!

Conversation

danielmarv commented Nov 6, 2025

Summary of Changes (What does this PR do?)

Status of maturity (all need to be checked before merging):

How should this be manually tested?

What are the relevant tickets?

Screenshots (optional)

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Nov 6, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 6, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 6, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 6, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 6, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 6, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 6, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 6, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 6, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 6, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants