Merge pull request #318 from daostack/CM-266-common-creation-min-contribution

CM-266 - common creation min contribution

Author: alexander2001i

packages/firebase/__tests__/funtions/__snapshots__/common.test.ts.snap

@@ -5,7 +5,6 @@ Array [
   "You must provide a valid URL",
   "image is a required field",
   "byline is a required field",
-  "fundingGoalDeadline is a required field",
   "contributionAmount is a required field",
 ]
 `;

packages/firebase/__tests__/funtions/common.test.ts

@@ -21,7 +21,7 @@ const validCommonCreationPayload = {
   description: 'hey there, am i descriptive',
   contributionType: 'one-time',
   contributionAmount: 6500,
-  fundingGoalDeadline: new Date().getTime()
+  zeroContribution: true,
 };
 
 describe('Common Related Cloud Functions', () => {

packages/firebase/__tests__/funtions/proposal.test.ts

@@ -38,6 +38,20 @@ const validFundingData = (commonId: string) => ({
   title: 'I need money'
 });
 
+const validJoinDataZeroContribution = (commonId: string) => ({
+  commonId,
+  description: 'I wanna be a part, but without paying',
+  funding: 0,
+  cardId: `test-card-id-for-common-${commonId}`
+});
+
+const invalidJoinDataZeroContribution = (commonId: string) => ({
+  commonId,
+  description: 'I wanna be a part, but pay less that $5',
+  funding: 300,
+  cardId: `test-card-id-for-common-${commonId}`
+});
+
 describe('Proposal Related Cloud Functions', () => {
   afterAll(async () => {
     await test.cleanup();
@@ -168,6 +182,70 @@ describe('Proposal Related Cloud Functions', () => {
       expect(response.body.type).toBe('join');
       expect(response.body.commonId).toBe(common.id);
     });
+
+    it('should make a join request when funding = 0 and 0 contribution is allowed', async () => {
+      // Setup
+      const joinerId = v4();
+      const founderId = v4();
+
+      const authToken = await getTestAuthToken(joinerId);
+      const common = await createTestCommon(founderId);
+
+      const response = await proposalsApp
+        .post(joinEndpoint)
+        .send(validJoinDataZeroContribution(common.id))
+        .set({
+          Authorization: authToken
+        });
+
+      expect(response.body.message).toBe('Join request successfully created!');
+      expect(response.body.proposerId).toBe(joinerId);
+      expect(response.body.type).toBe('join');
+      expect(response.body.commonId).toBe(common.id);
+
+    });
+
+    it('should not make a join request when 0 < funding < 5 and 0 contribution is allowed', async () => {
+      // Setup
+      const joinerId = v4();
+      const founderId = v4();
+
+      const authToken = await getTestAuthToken(joinerId);
+      const common = await createTestCommon(founderId);
+
+      const response = await proposalsApp
+        .post(joinEndpoint)
+        .send(invalidJoinDataZeroContribution(common.id))
+        .set({
+          Authorization: authToken
+        });
+
+      expect(response.body.error.includes(`The funding cannot be less than the minimum required funding`)).toBeTruthy();
+      expect(response.body.errorCode).toBe('GenericError');
+      expect(response.body.errorMessage).toBe('Your join request cannot be created, because the min fee to join is $65.00, but you provided $3.00');
+      expect(response.status).toBe(400);
+    });
+
+    it('should not make a join request when funding = 0 and 0 contribution is not allowed', async () => {
+      // Setup
+      const joinerId = v4();
+      const founderId = v4();
+
+      const authToken = await getTestAuthToken(joinerId);
+      const common = await createTestCommon(founderId, false); //@askAlexI if he's ok with that (having a second argument for zeroContribution) :)
+
+      const response = await proposalsApp
+        .post(joinEndpoint)
+        .send(validJoinDataZeroContribution(common.id))
+        .set({
+          Authorization: authToken
+        });
+
+      expect(response.body.error.includes(`The funding cannot be less than the minimum required funding`)).toBeTruthy();
+      expect(response.body.errorCode).toBe('GenericError');
+      expect(response.body.errorMessage).toBe('Your join request cannot be created, because the min fee to join is $65.00, but you provided $0.00');
+      expect(response.status).toBe(400);
+    });
   });
 
   describe('Funding Proposal Creation', () => {

packages/firebase/__tests__/helpers/createTestCommon.ts

@@ -3,15 +3,15 @@ import { ICommonEntity } from '@common/types';
 import { commonApp } from './supertests';
 import { getTestAuthToken } from './auth';
 
-export const createTestCommon = async (userId = 'test-user'): Promise<ICommonEntity> => {
+export const createTestCommon = async (userId = 'test-user', zeroContribution = true): Promise<ICommonEntity> => {
   const payload = {
     name: 'Common Test',
     image: 'https://llandscapes-10674.kxcdn.com/wp-content/uploads/2019/07/lighting.jpg',
     byline: 'basically this is a test common',
     description: 'hey there, am i descriptive',
     contributionType: 'one-time',
     contributionAmount: 6500,
-    fundingGoalDeadline: new Date().getTime() / 1000
+    zeroContribution,
   };
 
   const authToken = await getTestAuthToken(userId);

packages/firebase/functions/src/common/business/createCommon.ts

@@ -27,8 +27,6 @@ const createCommonDataValidationScheme = yup.object({
 
   description: yup.string().required(),
 
-  fundingGoalDeadline: yup.number().required(),
-
   contributionAmount: yup.number().min(0).required(),
 
   contributionType: yup
@@ -39,7 +37,9 @@ const createCommonDataValidationScheme = yup.object({
 
   rules: yup.array(commonRuleValidationSchema).optional(),
 
-  links: yup.array(linkValidationSchema).optional()
+  links: yup.array(linkValidationSchema).optional(),
+
+  zeroContribution: yup.boolean(),
 });
 
 type CreateCommonPayload = yup.InferType<typeof createCommonDataValidationScheme>;
@@ -73,15 +73,14 @@ export const createCommon = async (
     description,
     contributionType,
     contributionAmount,
-    fundingGoalDeadline
+    zeroContribution,
   } = payload;
 
   // @todo Check if user exists
 
   const common = await commonDb.add({
     name,
     image,
-    fundingGoalDeadline,
 
     rules: (rules as ICommonRule[]) || [],
     links: (links as ICommonLink[]) || [],
@@ -97,7 +96,8 @@ export const createCommon = async (
       contributionType,
 
       founderId: userId,
-      minFeeToJoin: contributionAmount
+      minFeeToJoin: contributionAmount,
+      zeroContribution,
     },
 
     register: 'na'

packages/firebase/functions/src/proposals/business/createJoinRequest.ts

@@ -73,8 +73,8 @@ export const createJoinRequest = async (payload: CreateRequestToJoinPayload): Pr
     );
   }
 
-  // Check if the request is funded with less than required amount
-  if (common.metadata.minFeeToJoin > payload.funding) {
+  if (common.metadata.minFeeToJoin > payload.funding
+    && (!common.metadata.zeroContribution || payload.funding !== 0)) {
     throw new CommonError('The funding cannot be less than the minimum required funding', {
         userMessage: `Your join request cannot be created, because the min fee to join is $${(common.metadata.minFeeToJoin / 100)
           .toFixed(2)}, but you provided $${(payload.funding / 100).toFixed(2)}`,

packages/firebase/functions/src/util/tests/helpers/mockers/commons/getCommon.mocker.ts

@@ -18,13 +18,13 @@ jest.mock('../../../../../common/database/getCommon', () =>
         return {
           links: [],
           image: 'https://firebasestorage.googleapis.com/v0/b/common-staging-50741.appspot.com/o/public_img%2Fimg_1605603725987.jpg?alt=media&token=4fc5ab99-8f38-49f0-8d6e-83a94b30db60',
-          fundingGoalDeadline: 1606206379,
           metadata: {
             minFeeToJoin: 700,
             description: 'testetest',
             founderId: 'Xlun3Ux94Zfc73axkiuVdkktOWf1',
             byline: 'testtestetstetst',
-            contributionType: contributionType
+            contributionType: contributionType,
+            zeroContribution: true,
           },
           raised: 0,
           rules: [

packages/types/src/entities/ICommonEntity.ts

@@ -27,12 +27,6 @@ export interface ICommonEntity extends IBaseEntity {
    */
   raised: number;
 
-  /**
-   *  The timestamp after witch you are able to
-   *  create funding proposals
-   */
-  fundingGoalDeadline: number;
-
   /**
    * List of all users, that are members of this common
    */
@@ -111,6 +105,11 @@ export interface ICommonMetadata {
    * or only when they join
    */
   contributionType: ContributionType;
+
+  /**
+   * Allow users to join common with zero contribution
+   */
+  zeroContribution: boolean;
 }
 
 export interface ICommonUpdate {