Skip to content

Commit 79bbf50

Browse files
committed
renames variable to match their description tense
1 parent 73986a3 commit 79bbf50

File tree

3 files changed

+15
-14
lines changed

3 files changed

+15
-14
lines changed

constants/monitor.js

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
1-
const RESOURCE_CREATED_SUCCEEDED = "Resource created successfully.";
2-
const RESOURCE_UPDATED_SUCCEEDED = "Resource updated successfully.";
3-
const RESOURCE_RETRIEVAL_SUCCEEDED = "Resource retrieved successfully.";
1+
const RESOURCE_CREATED_SUCCESSFULLY = "Resource created successfully.";
2+
const RESOURCE_UPDATED_SUCCESSFULLY = "Resource updated successfully.";
3+
const RESOURCE_RETRIEVED_SUCCESSFULLY = "Resource retrieved successfully.";
44
const RESOURCE_NOT_FOUND = "Resource not found.";
5-
const RESOURCE_ALREADY_EXIST = "Resource is already being tracked.";
5+
const RESOURCE_ALREADY_TRACKED = "Resource is already being tracked.";
66

77
const RESPONSE_MESSAGES = {
8-
RESOURCE_CREATED_SUCCEEDED,
9-
RESOURCE_UPDATED_SUCCEEDED,
10-
RESOURCE_RETRIEVAL_SUCCEEDED,
8+
RESOURCE_CREATED_SUCCESSFULLY,
9+
RESOURCE_UPDATED_SUCCESSFULLY,
10+
RESOURCE_RETRIEVED_SUCCESSFULLY,
1111
RESOURCE_NOT_FOUND,
12-
RESOURCE_ALREADY_EXIST,
12+
RESOURCE_ALREADY_TRACKED,
1313
};
1414

1515
module.exports = { RESPONSE_MESSAGES };

controllers/monitor.js

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@ const {
66
getTrackedProgressDocuments,
77
} = require("../models/monitor");
88
const { RESPONSE_MESSAGES } = require("../constants/monitor");
9-
const { RESOURCE_CREATED_SUCCEEDED, RESOURCE_UPDATED_SUCCEEDED, RESOURCE_RETRIEVAL_SUCCEEDED } = RESPONSE_MESSAGES;
9+
const { RESOURCE_CREATED_SUCCESSFULLY, RESOURCE_UPDATED_SUCCESSFULLY, RESOURCE_RETRIEVED_SUCCESSFULLY } =
10+
RESPONSE_MESSAGES;
1011
/**
1112
* @typedef {Object} TrackedProgressRequestBody
1213
* @property {string} type - The type of tracked progress ("user" or "task").
@@ -46,7 +47,7 @@ const createTrackedProgressController = async (req, res) => {
4647
try {
4748
const data = await createTrackedProgressDocument({ ...req.body });
4849
return res.status(201).json({
49-
message: RESOURCE_CREATED_SUCCEEDED,
50+
message: RESOURCE_CREATED_SUCCESSFULLY,
5051
data,
5152
});
5253
} catch (error) {
@@ -109,7 +110,7 @@ const updateTrackedProgressController = async (req, res) => {
109110
const data = await updateTrackedProgressDocument({ ...req });
110111
return res.status(200).json({
111112
data,
112-
message: RESOURCE_UPDATED_SUCCEEDED,
113+
message: RESOURCE_UPDATED_SUCCESSFULLY,
113114
});
114115
} catch (error) {
115116
if (error instanceof NotFound) {
@@ -161,7 +162,7 @@ const getTrackedProgressController = async (req, res) => {
161162
try {
162163
const data = await getTrackedProgressDocuments({ ...req.query });
163164
return res.status(200).json({
164-
message: RESOURCE_RETRIEVAL_SUCCEEDED,
165+
message: RESOURCE_RETRIEVED_SUCCESSFULLY,
165166
data,
166167
});
167168
} catch (error) {

models/monitor.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ const {
99
buildQueryToFetchTrackedDoc,
1010
} = require("../utils/monitor");
1111
const { RESPONSE_MESSAGES } = require("../constants/monitor");
12-
const { RESOURCE_NOT_FOUND, RESOURCE_ALREADY_EXIST } = RESPONSE_MESSAGES;
12+
const { RESOURCE_NOT_FOUND, RESOURCE_ALREADY_TRACKED } = RESPONSE_MESSAGES;
1313

1414
/**
1515
* Creates a tracked progress document based on the provided data.
@@ -30,7 +30,7 @@ const createTrackedProgressDocument = async (documentData) => {
3030
const query = buildTrackedProgressQueryByType({ userId, taskId });
3131
const existingDocumentSnapshot = await query.get();
3232
if (!existingDocumentSnapshot.empty) {
33-
throw new Conflict(RESOURCE_ALREADY_EXIST);
33+
throw new Conflict(RESOURCE_ALREADY_TRACKED);
3434
}
3535
const timeNow = new Date().toISOString();
3636
// if not passed, the default frequency of 1 will be used as the frequency

0 commit comments

Comments
 (0)