Merge pull request #251 from map-of-pi/feature-toggle-impl

Approved (1).

Author: swoocn

src/config/docs/TogglesSchema.yml

@@ -0,0 +1,102 @@
+components:
+  schemas:
+    AddToggleRq:
+      type: object
+      properties:
+        name:
+          type: string
+          example: testToggle
+        enabled:
+          type: boolean
+          example: false
+        description:
+          type: string
+          example: This is a toggle description.
+      required:
+      - name
+      - enabled
+      - description
+
+    UpdateToggleRq:
+      type: object
+      properties:
+        name:
+          type: string
+          example: testToggle
+        enabled:
+          type: boolean
+          example: false
+        description:
+          type: string
+          example: This is a toggle description.
+
+    GetAllTogglesRs:
+      type: array
+      items:
+        type: object
+        properties:
+          name:
+            type: string
+            example: testToggle
+          enabled:
+            type: boolean
+            example: false
+          description:
+            type: string
+            example: This is a toggle description.
+
+    GetSingleToggleRs:
+      type: object
+      properties:
+        name:
+          type: string
+          example: testToggle
+        enabled:
+          type: boolean
+          example: false
+        description:
+          type: string
+          example: This is a toggle description.
+
+    AddToggleRs:
+      type: object
+      properties:
+        addedToggle:
+          name:
+            type: string
+            example: testToggle
+          enabled:
+            type: boolean
+            example: false
+          description:
+            type: string
+            example: This is a toggle description.
+
+    UpdateToggleRs:
+      type: object
+      properties:
+        updatedToggle:
+          name:
+            type: string
+            example: testToggle
+          enabled:
+            type: boolean
+            example: false
+          description:
+            type: string
+            example: This is a toggle description.
+
+    DeleteToggleRs:
+      type: object
+      properties:
+        deletedToggle:
+          name:
+            type: string
+            example: testToggle
+          enabled:
+            type: boolean
+            example: false
+          description:
+            type: string
+            example: This is a toggle description.
+ 

src/controllers/admin/toggleController.ts

@@ -0,0 +1,72 @@
+import { Request, Response } from "express";
+import * as toggleService from "../../services/admin/toggle.service";
+import { IToggle } from "../../types";
+
+import logger from "../../config/loggingConfig";
+
+export const getToggles = async (req: Request, res: Response) => {
+  try {
+    const existingToggles = await toggleService.getToggles();
+    logger.info(`Successfully fetched ${ existingToggles.length } toggles`);
+    return res.status(200).json(existingToggles);
+  } catch (error) {
+    logger.error('Failed to get toggles', error);
+    return res.status(500).json({ message: 'An error occurred while fetching toggles; please try again later' });
+  }
+};
+
+export const getToggle = async (req: Request, res: Response) => {
+  const { toggle_name } = req.params;
+  try {
+    const currentToggle = await toggleService.getToggleByName(toggle_name);
+    if (!currentToggle) {
+      logger.warn(`Toggle with identifier ${toggle_name} not found.`);
+      return res.status(404).json({ message: "Toggle not found" });
+    }
+    logger.info(`Fetched toggle with identifier ${toggle_name}`);
+    return res.status(200).json(currentToggle);
+  } catch (error) {
+    logger.error(`Failed to get toggle for identifier ${ toggle_name }:`, error);
+    return res.status(500).json({ message: 'An error occurred while fetching toggle; please try again later' });
+  }
+};
+
+export const addToggle = async (req: Request, res: Response) => {
+  const { name, enabled, description } = req.body;
+  try {
+    const newToggle = await toggleService.addToggle({ name, enabled, description } as IToggle);
+    logger.info(`Successfully added toggle with identifier ${name}`);
+    return res.status(201).json({ message: "Toggle successfully added", newToggle });
+  } catch (error) {
+    logger.error(`Failed to add toggle for identifier ${ name }:`, error);
+    return res.status(500).json({ message: 'An error occurred while adding toggle; please try again later' });
+  }
+};
+
+export const updateToggle = async (req: Request, res: Response) => {
+  const { name, enabled, description } = req.body;
+  try {
+    const updatedToggle = await toggleService.updateToggle(name, enabled, description);
+    logger.info(`Successfully updated toggle with identifier ${name}`);
+    return res.status(200).json({ message: "Toggle successfully updated", updatedToggle });
+  } catch (error) {
+    logger.error(`Failed to update toggle for identifier ${ name }:`, error);
+    return res.status(500).json({ message: 'An error occurred while updating toggle; please try again later' });
+  }
+};
+
+export const deleteToggle = async (req: Request, res: Response) => {
+  const { toggle_name } = req.params;
+  try {
+    const deletedToggle = await toggleService.deleteToggleByName(toggle_name);
+    if (!deletedToggle) {
+      logger.warn(`Toggle with identifier ${toggle_name} not found.`);
+      return res.status(404).json({ message: "Toggle not found" });
+    }
+    logger.info(`Successfully deleted toggle with identifier ${toggle_name}`);
+    return res.status(200).json({ message: "Toggle successfully deleted", deletedToggle });
+  } catch (error) {
+    logger.error(`Failed to delete toggle for identifier ${ toggle_name }:`, error);
+    return res.status(500).json({ message: 'An error occurred while deleting toggle; please try again later' });
+  }
+};

src/models/misc/Toggle.ts

@@ -0,0 +1,36 @@
+import mongoose, { Schema } from "mongoose";
+
+import { IToggle } from "../../types";
+
+const toggleSchema = new Schema<IToggle>(
+  {
+    name: {
+      type: String,
+      required: true,
+      unique: true,
+    },
+    enabled: {
+      type: Boolean,
+      required: true,
+      default: false,
+    },
+    description: {
+      type: String,
+      required: false,
+    },
+  },
+  {
+    timestamps: true, // Automatically creates createdAt and updatedAt
+    toJSON: {
+      transform: function (doc, ret) {
+        delete ret._id;
+        delete ret.__v;
+        return ret;
+      }
+    }
+  }
+);
+
+const Toggle = mongoose.model<IToggle>("Toggle", toggleSchema);
+
+export default Toggle;

src/routes/toggle.routes.ts

@@ -0,0 +1,184 @@
+import { Router } from "express";
+
+import * as toggleController from "../controllers/admin/toggleController";
+import { verifyAdminToken } from "../middlewares/verifyToken";
+
+/**
+ * @swagger
+ * components:
+ *   schemas:
+ *     ToggleSchema:
+ *       type: object
+ *       properties:
+ *         name:
+ *           type: string
+ *           description: Name of the toggle
+ *         enabled:
+ *           type: boolean
+ *           description: State of the toggle
+ *         description:
+ *           type: string
+ *           description: Description of the toggle
+ */
+const toggleRoutes = Router();
+
+/**
+ * @swagger
+ * /api/v1/toggles:
+ *   get:
+ *     tags:
+ *       - Toggle
+ *     summary: Get all existing toggles
+ *     responses:
+ *       200:
+ *         description: Successful response
+ *         content:
+ *           application/json:
+ *             schema:
+ *               type: array
+ *               items:
+ *                 $ref: '/api/docs/TogglesSchema.yml#/components/schemas/GetAllTogglesRs'
+ *       500:
+ *         description: Internal server error
+ */
+toggleRoutes.get("/", toggleController.getToggles);
+
+/**
+ * @swagger
+ * /api/v1/toggles/{toggle_name}:
+ *   get:
+ *     tags:
+ *       - Toggle
+ *     summary: Get the corresponding toggle by toggle name
+ *     parameters:
+ *       - name: toggle_name
+ *         in: path
+ *         required: true
+ *         schema:
+ *           type: string
+ *         description: The name of the toggle to retrieve
+ *     responses:
+ *       200:
+ *         description: Successful response
+ *         content:
+ *           application/json:
+ *             schema:
+ *               type: array
+ *               items:
+ *                 $ref: '/api/docs/TogglesSchema.yml#/components/schemas/GetSingleToggleRs'
+ *       404:
+ *         description: Toggle not found
+ *       500:
+ *         description: Internal server error
+ */
+toggleRoutes.get("/:toggle_name", toggleController.getToggle);
+
+/**
+ * @swagger
+ * /api/v1/toggles/add:
+ *   post:
+ *     tags:
+ *       - Toggle
+ *     summary: Add a new toggle *
+ *     security:
+ *       - AdminPasswordAuth: []
+ *     requestBody:
+ *       required: true
+ *       content:
+ *         application/json:
+ *           schema:
+ *             $ref: '/api/docs/TogglesSchema.yml#/components/schemas/AddToggleRq'
+ *     responses:
+ *       201:
+ *         description: Successful response
+ *         content:
+ *           application/json:
+ *             schema:
+ *               type: object
+ *               properties:
+ *                 message:
+ *                   type: string
+ *                   example: "Toggle successfully added"
+ *                 addedToggle:
+ *                   $ref: '/api/docs/TogglesSchema.yml#/components/schemas/AddToggleRs'
+ *       401:
+ *         description: Unauthorized
+ *       500:
+ *         description: Internal server error
+ */
+toggleRoutes.post("/add", verifyAdminToken, toggleController.addToggle);
+
+/**
+ * @swagger
+ * /api/v1/toggles/update:
+ *   put:
+ *     tags:
+ *       - Toggle
+ *     summary: Update an existing toggle *
+ *     security:
+ *       - AdminPasswordAuth: []
+ *     requestBody:
+ *       required: true
+ *       content:
+ *         application/json:
+ *           schema:
+ *             $ref: '/api/docs/TogglesSchema.yml#/components/schemas/UpdateToggleRq'
+ *     responses:
+ *       200:
+ *         description: Successful response
+ *         content:
+ *           application/json:
+ *             schema:
+ *               type: object
+ *               properties:
+ *                 message:
+ *                   type: string
+ *                   example: "Toggle successfully updated"
+ *                 updatedToggle:
+ *                   $ref: '/api/docs/TogglesSchema.yml#/components/schemas/UpdateToggleRs'
+ *       401:
+ *         description: Unauthorized
+ *       500:
+ *         description: Internal server error
+ */
+toggleRoutes.put("/update", verifyAdminToken, toggleController.updateToggle);
+
+/**
+ * @swagger
+ * /api/v1/toggles/delete/{toggle_name}:
+ *   delete:
+ *     tags:
+ *       - Toggle
+ *     summary: Delete the corresponding toggle by toggle name *
+ *     security:
+ *       - AdminPasswordAuth: []
+ *     parameters:
+ *       - name: toggle_name
+ *         in: path
+ *         required: true
+ *         schema:
+ *           type: string
+ *         description: The name of the toggle to delete
+ *     responses:
+ *       200:
+ *         description: Successful response
+ *         content:
+ *           application/json:
+ *             schema:
+ *               type: object
+ *               properties:
+ *                 message:
+ *                   type: string
+ *                   example: "Toggle successfully deleted"
+ *                 deletedToggle:
+ *                   $ref: '/api/docs/TogglesSchema.yml#/components/schemas/DeleteToggleRs'
+ *       404:
+ *         description: Toggle not found
+ *       401:
+ *         description: Unauthorized
+ *       500:
+ *         description: Internal server error
+ */
+toggleRoutes.delete("/delete/:toggle_name", verifyAdminToken, toggleController.deleteToggle);
+
+export default toggleRoutes;