Simulated Testing Database For Talawa Admin (PalisadoesFoundation#1369)

* Fixed Merge Conflicts

* Removed Unnecessary Test Assertions

* Increased Test Coverage

* fixed package.json conflict

* removed extra whitespace

* updated package.json

* added package.json

* re-aded faker-js/faker package

* removed unnecessary code

Author: JamarTG

locales/en.json

@@ -12,6 +12,7 @@
   "organization.profileImage.notFound": "Organization profile image not found",
   "organization.member.notFound": "Organization's user is not a member",
   "organization.notAuthorized": "Organization is not authorized",
+  "sampleOrganization.duplicate": "Sample Organization already generated",
   "membershipRequest.notFound": "Membership Request not found",
   "membershipRequest.alreadyExists": "Membership Request already exists",
   "chat.notFound": "Chat not found",

locales/fr.json

@@ -11,6 +11,7 @@
   "organization.profileImage.notFound": "Image du profil de l'organisation introuvable",
   "organization.member.notFound": "L'utilisateur de l'organisation n'est pas membre",
   "organization.notAuthorized": "L'organisation n'est pas autorisée",
+  "sampleOrganization.duplicate": "Exemple d'organisation déjà généré",
   "membershipRequest.notFound": "Demande d'adhésion introuvable",
   "membershipRequest.alreadyExists": "La demande d'adhésion existe déjà",
   "chat.notFound": "Chat non trouvé",

locales/hi.json

@@ -12,6 +12,7 @@
   "organization.profileImage.notFound": "संगठन की प्रोफ़ाइल छवि नहीं मिली",
   "organization.member.notFound": "संगठन का उपयोगकर्ता सदस्य नहीं है",
   "organization.notAuthorized": "संगठन अधिकृत नहीं है",
+  "sampleOrganization.dulicate": "नमूना संगठन पहले ही तैयार हो चुका है",
   "membershipRequest.notFound": "सदस्यता अनुरोध नहीं मिला",
   "membershipRequest.alreadyExists": "सदस्यता अनुरोध पहले से मौजूद है",
   "chat.notFound": "चैट नहीं मिली",

locales/sp.json

@@ -11,6 +11,7 @@
   "organization.profileImage.notFound": "No se encontró la imagen del perfil de la organización",
   "organization.member.notFound": "El usuario de la organización no es miembro",
   "organization.notAuthorized": "La organización no está autorizada",
+  "sampleOrganization.duplicate": "Organización de muestra ya generada",
   "membershipRequest.notFound": "Solicitud de membresía no encontrada",
   "membershipRequest.alreadyExists": "La solicitud de membresía ya existe",
   "chat.notFound": "Chat no encontrado",

locales/zh.json

@@ -11,6 +11,7 @@
   "organization.profileImage.notFound": "未找到組織檔案圖像",
   "organization.member.notFound": "組織的用戶不是成員",
   "organization.notAuthorized": "組織未授權",
+  "sampleOrganization.duplicate": "已生成样本组织",
   "membershipRequest.notFound": "未找到會員請求",
   "membershipRequest.alreadyExists": "成員資格請求已存在",
   "chat.notFound": "未找到聊天",

package-lock.json

@@ -42,6 +42,7 @@
   "homepage": "https://github.com/PalisadoesFoundation/talawa-api#readme",
   "dependencies": {
     "@apollo/server": "^4.9.3",
+    "@faker-js/faker": "^8.2.0",
     "@graphql-inspector/cli": "^3.4.19",
     "@graphql-tools/resolvers-composition": "^7.0.0",
     "@graphql-tools/schema": "^10.0.0",

package.json

@@ -444,6 +444,7 @@ type Mutation {
   createOrganization(data: OrganizationInput, file: String): Organization!
   createPlugin(pluginCreatedBy: String!, pluginDesc: String!, pluginName: String!, uninstalledOrgs: [ID!]): Plugin!
   createPost(data: PostInput!, file: String): Post
+  createSampleOrganization: Boolean!
   createTask(data: TaskInput!, eventProjectId: ID!): Task!
   createUserTag(input: CreateUserTagInput!): UserTag
   deleteAdvertisementById(id: ID!): DeletePayload!
@@ -473,6 +474,7 @@ type Mutation {
   removeOrganization(id: ID!): User!
   removeOrganizationImage(organizationId: String!): Organization!
   removePost(id: ID!): Post
+  removeSampleOrganization: Boolean!
   removeTask(id: ID!): Task
   removeUserFromGroupChat(chatId: ID!, userId: ID!): GroupChat!
   removeUserImage: User!
@@ -743,6 +745,7 @@ type Query {
   getPlugins: [Plugin]
   getlanguage(lang_code: String!): [Translation]
   hasSubmittedFeedback(eventId: ID!, userId: ID!): Boolean
+  isSampleOrganization(id: ID!): Boolean!
   joinedOrganizations(id: ID): [Organization]
   me: User!
   myLanguage: String

schema.graphql

@@ -393,6 +393,13 @@ export const USER_ALREADY_CHECKED_IN = {
   PARAM: "user.alreadyCheckedIn",
 };
 
+export const SAMPLE_ORGANIZATION_ALREADY_EXISTS = {
+  DESC: "Sample Organization was already generated",
+  CODE: "sampleOrganization.duplicate",
+  MESSAGE: "sampleOrganization.duplicate",
+  PARAM: "sampleOrganization",
+};
+
 export const MAXIMUM_FETCH_LIMIT = 100;
 
 export const BASE_URL = `http://localhost:${process.env.port || 4000}/`;

src/constants.ts

@@ -0,0 +1,25 @@
+import type { Model } from "mongoose";
+import { Schema, model, models } from "mongoose";
+
+export interface InterfaceSampleData {
+  documentId: string;
+  collectionName: "Organization" | "Post" | "Event" | "User" | "Plugin";
+}
+
+const sampleDataSchema = new Schema<InterfaceSampleData>({
+  documentId: {
+    type: String,
+    required: true,
+  },
+  collectionName: {
+    type: String,
+    required: true,
+    enum: ["Organization", "Post", "Event", "User", "Plugin"],
+  },
+});
+
+const sampleDataModel = (): Model<InterfaceSampleData> =>
+  model<InterfaceSampleData>("SampleData", sampleDataSchema);
+
+export const SampleData = (models.SampleData ||
+  sampleDataModel()) as ReturnType<typeof sampleDataModel>;

src/models/SampleData.ts

@@ -22,6 +22,7 @@ export * from "./OrganizationTagUser";
 export * from "./Plugin";
 export * from "./PluginField";
 export * from "./Post";
+export * from "./SampleData";
 export * from "./Task";
 export * from "./TaskVolunteer";
 export * from "./User";

src/models/index.ts

@@ -0,0 +1,56 @@
+import {
+  USER_NOT_AUTHORIZED_ERROR,
+  USER_NOT_FOUND_ERROR,
+  SAMPLE_ORGANIZATION_ALREADY_EXISTS,
+} from "../../constants";
+import { errors, requestContext } from "../../libraries";
+import type { MutationResolvers } from "../../types/generatedGraphQLTypes";
+import { createSampleOrganization as createSampleOrgUtil } from "../../utilities/createSampleOrganizationUtil";
+import { SampleData, User } from "../../models";
+
+/**
+ * Generates sample data for testing or development purposes.
+ * @returns True if the sample data generation is successful, false otherwise.
+ */
+export const createSampleOrganization: MutationResolvers["createSampleOrganization"] =
+  async (_parent, _args, _context) => {
+    const currentUser = await User.findOne({
+      _id: _context.userId,
+    }).lean();
+
+    if (!currentUser) {
+      throw new errors.NotFoundError(
+        requestContext.translate(USER_NOT_FOUND_ERROR.MESSAGE),
+        USER_NOT_FOUND_ERROR.CODE,
+        USER_NOT_FOUND_ERROR.PARAM
+      );
+    }
+
+    if (
+      !(
+        currentUser.userType === "SUPERADMIN" ||
+        currentUser.userType === "ADMIN"
+      )
+    ) {
+      throw new errors.UnauthorizedError(
+        requestContext.translate(USER_NOT_AUTHORIZED_ERROR.MESSAGE),
+        USER_NOT_AUTHORIZED_ERROR.CODE,
+        USER_NOT_AUTHORIZED_ERROR.PARAM
+      );
+    }
+
+    const existingOrganization = await SampleData.findOne({
+      collectionName: "Organization",
+    });
+
+    if (existingOrganization) {
+      throw new errors.UnauthorizedError(
+        requestContext.translate(SAMPLE_ORGANIZATION_ALREADY_EXISTS.MESSAGE),
+        SAMPLE_ORGANIZATION_ALREADY_EXISTS.CODE,
+        SAMPLE_ORGANIZATION_ALREADY_EXISTS.PARAM
+      );
+    }
+
+    await createSampleOrgUtil();
+    return true;
+  };

src/resolvers/Mutation/createSampleOrganization.ts

@@ -28,6 +28,7 @@ import { createOrganization } from "./createOrganization";
 import { createPlugin } from "./createPlugin";
 import { createAdvertisement } from "./createAdvertisement";
 import { createPost } from "./createPost";
+import { createSampleOrganization } from "./createSampleOrganization";
 import { createTask } from "./createTask";
 import { createUserTag } from "./createUserTag";
 import { deleteDonationById } from "./deleteDonationById";
@@ -56,6 +57,7 @@ import { removeMember } from "./removeMember";
 import { removeOrganization } from "./removeOrganization";
 import { removeOrganizationImage } from "./removeOrganizationImage";
 import { removePost } from "./removePost";
+import { removeSampleOrganization } from "./removeSampleOrganization";
 import { removeTask } from "./removeTask";
 import { removeUserFromGroupChat } from "./removeUserFromGroupChat";
 import { removeUserImage } from "./removeUserImage";
@@ -116,6 +118,7 @@ export const Mutation: MutationResolvers = {
   createOrganization,
   createPlugin,
   createPost,
+  createSampleOrganization,
   createTask,
   createUserTag,
   deleteDonationById,
@@ -144,6 +147,7 @@ export const Mutation: MutationResolvers = {
   removeMember,
   removeOrganization,
   removeOrganizationImage,
+  removeSampleOrganization,
   removePost,
   removeTask,
   removeUserFromGroupChat,

src/resolvers/Mutation/index.ts

@@ -0,0 +1,52 @@
+import type { MutationResolvers } from "../../types/generatedGraphQLTypes";
+import { removeSampleOrganization as removeSampleOrgUtil } from "../../utilities/removeSampleOrganizationUtil";
+import { SampleData, User } from "../../models";
+import { errors, requestContext } from "../../libraries";
+import {
+  ORGANIZATION_NOT_FOUND_ERROR,
+  USER_NOT_AUTHORIZED_ERROR,
+  USER_NOT_FOUND_ERROR,
+} from "../../constants";
+
+export const removeSampleOrganization: MutationResolvers["removeSampleOrganization"] =
+  async (_parent, _args, _context) => {
+    const currentUser = await User.findOne({
+      _id: _context.userId,
+    }).lean();
+
+    if (!currentUser) {
+      throw new errors.NotFoundError(
+        requestContext.translate(USER_NOT_FOUND_ERROR.MESSAGE),
+        USER_NOT_FOUND_ERROR.CODE,
+        USER_NOT_FOUND_ERROR.PARAM
+      );
+    }
+
+    if (
+      !(
+        currentUser.userType === "SUPERADMIN" ||
+        currentUser.userType === "ADMIN"
+      )
+    ) {
+      throw new errors.UnauthorizedError(
+        requestContext.translate(USER_NOT_AUTHORIZED_ERROR.MESSAGE),
+        USER_NOT_AUTHORIZED_ERROR.CODE,
+        USER_NOT_AUTHORIZED_ERROR.PARAM
+      );
+    }
+
+    const existingOrganization = await SampleData.findOne({
+      collectionName: "Organization",
+    });
+
+    if (!existingOrganization) {
+      throw new errors.NotFoundError(
+        requestContext.translate(ORGANIZATION_NOT_FOUND_ERROR.MESSAGE),
+        ORGANIZATION_NOT_FOUND_ERROR.CODE,
+        ORGANIZATION_NOT_FOUND_ERROR.PARAM
+      );
+    }
+
+    await removeSampleOrgUtil();
+    return true;
+  };

src/resolvers/Mutation/removeSampleOrganization.ts

@@ -15,6 +15,7 @@ import { myLanguage } from "./myLanguage";
 import { organizations } from "./organizations";
 import { organizationsConnection } from "./organizationsConnection";
 import { organizationsMemberConnection } from "./organizationsMemberConnection";
+import { isSampleOrganization } from "../Query/organizationIsSample";
 import { post } from "./post";
 import { postsByOrganization } from "./postsByOrganization";
 import { postsByOrganizationConnection } from "./postsByOrganizationConnection";
@@ -38,6 +39,7 @@ export const Query: QueryResolvers = {
   getDonationByOrgIdConnection,
   getlanguage,
   getPlugins,
+  isSampleOrganization,
   me,
   myLanguage,
   organizations,

src/resolvers/Query/index.ts

@@ -0,0 +1,25 @@
+import type { QueryResolvers } from "../../types/generatedGraphQLTypes";
+import { Organization, SampleData } from "../../models";
+import { errors, requestContext } from "../../libraries";
+import { ORGANIZATION_NOT_FOUND_ERROR } from "../../constants";
+
+export const isSampleOrganization: QueryResolvers["isSampleOrganization"] =
+  async (_parent, args) => {
+    const organizationId = args.id;
+
+    const organization = await Organization.findById(args.id);
+
+    if (!organization) {
+      throw new errors.UnauthorizedError(
+        requestContext.translate(ORGANIZATION_NOT_FOUND_ERROR.MESSAGE),
+        ORGANIZATION_NOT_FOUND_ERROR.CODE,
+        ORGANIZATION_NOT_FOUND_ERROR.PARAM
+      );
+    }
+
+    const sampleOrganization = await SampleData.findOne({
+      documentId: organizationId,
+    });
+
+    return !!sampleOrganization;
+  };

src/resolvers/Query/organizationIsSample.ts

@@ -1,6 +1,8 @@
 import { withFilter } from "graphql-subscriptions";
 import type { SubscriptionResolvers } from "../../types/generatedGraphQLTypes";
 
+// import { GroupChat } from "../GroupChat";
+
 const TALAWA_PLUGIN_UPDATED = "TALAWA_PLUGIN_UPDATED";
 /**
  * This property included a `subscribe` method, which is used to

src/resolvers/Subscription/onPluginUpdate.ts

@@ -89,6 +89,8 @@ export const mutations = gql`
 
     createUserTag(input: CreateUserTagInput!): UserTag @auth
 
+    createSampleOrganization: Boolean! @auth
+
     createTask(data: TaskInput!, eventProjectId: ID!): Task! @auth
 
     deleteAdvertisementById(id: ID!): DeletePayload!
@@ -149,6 +151,8 @@ export const mutations = gql`
 
     removeUserTag(id: ID!): UserTag @auth
 
+    removeSampleOrganization: Boolean! @auth
+
     removeTask(id: ID!): Task @auth
 
     removeUserFromGroupChat(userId: ID!, chatId: ID!): GroupChat! @auth

src/typeDefs/mutations.ts

@@ -40,6 +40,7 @@ export const queries = gql`
     getPlugins: [Plugin]
     getAdvertisements: [Advertisement]
 
+    isSampleOrganization(id: ID!): Boolean!
     hasSubmittedFeedback(userId: ID!, eventId: ID!): Boolean
 
     joinedOrganizations(id: ID): [Organization]