Referral code refactor/fixes (#4277)

* display message when there is no active campaign

* prettier

* bug fix

* disable the autopass

* translate the conrtents

* re-set the autopass

* handle when there is no active growth campaign

* improve link

* correct the attestation account id

* separate growth referral code creation logic into a separate package

* fix referral creation on notifications side

* prettify

* fix lint problem

* prettify

* prettify

* undo mistake

* fix typo

* undoing change

* move utils functionality to growth-shared

* remove desktop invite code length restriction

* minor fixes

Co-authored-by: Shahul Hameed <[email protected]>

Author: sparrowDom

.circleci/config.yml

@@ -133,7 +133,7 @@ jobs:
           at: .
       - run: cd packages/auth-utils && yarn migrate
       - run: cd infra/identity && yarn migrate
-      - run: cd infra/growth-event && yarn migrate
+      - run: cd infra/growth-shared && yarn migrate
       - run:
           name: Run Bridge Tests
           command: cd infra/bridge && yarn migrate && yarn test
@@ -164,7 +164,7 @@ jobs:
       - run: cd infra/bridge && yarn migrate
       - run: cd infra/discovery && yarn migrate
       - run: cd infra/growth && yarn migrate
-      - run: cd infra/growth-event && yarn migrate
+      - run: cd infra/growth-shared && yarn migrate
       - run: cd infra/identity && yarn migrate
       - run:
           name: Run Discovery Tests
@@ -176,7 +176,7 @@ jobs:
       - attach_workspace:
           at: .
       - run: cd infra/growth && yarn migrate
-      - run: cd infra/growth-event && yarn migrate
+      - run: cd infra/growth-shared && yarn migrate
       - run: cd infra/identity && yarn migrate
       - run: cd infra/discovery && yarn migrate
       - run:
@@ -189,7 +189,7 @@ jobs:
       - attach_workspace:
           at: .
       - run: cd infra/growth && yarn migrate
-      - run: cd infra/growth-event && yarn migrate
+      - run: cd infra/growth-shared && yarn migrate
       - run: cd infra/identity && yarn migrate
       - run: cd packages/auth-utils && yarn migrate
       - run:

Dockerfile

@@ -30,7 +30,7 @@ COPY ./infra/notifications/package.json ./infra/notifications/
 COPY ./infra/growth/package.json ./infra/growth/
 COPY ./infra/identity/package.json ./infra/identity/
 COPY ./infra/bridge/package.json ./infra/bridge/
-COPY ./infra/growth-event/package.json ./infra/growth-event/
+COPY ./infra/growth-shared/package.json ./infra/growth-shared/
 COPY ./infra/auth-server/package.json ./infra/auth-server/
 COPY ./packages/auth-utils/package.json ./packages/auth-utils/
 

dapps/marketplace/src/pages/growth/Welcome.js

@@ -36,13 +36,6 @@ class GrowthWelcome extends Component {
     // code so ignore it.
     inviteCode = inviteCode !== 'onboard' ? inviteCode : undefined
 
-    if (inviteCode && inviteCode.length !== 11) {
-      console.warn(
-        `Unexpected invite code ${inviteCode}. Invite code should be 11 characters long.`
-      )
-      inviteCode = undefined
-    }
-
     const localStorageKey = 'growth_invite_code'
 
     const storedInviteCode = localStorage.getItem(localStorageKey)

devops/dockerfiles/event-listener

@@ -28,7 +28,7 @@ COPY ./packages/services ./packages/services
 COPY ./packages/validator ./packages/validator
 COPY ./packages/token ./packages/token
 COPY ./infra/discovery ./infra/discovery
-COPY ./infra/growth-event ./infra/growth-event
+COPY ./infra/growth-shared ./infra/growth-shared
 COPY ./infra/identity ./infra/identity
 COPY ./packages/auth-utils ./packages/auth-utils
 COPY ./packages/auth-client ./packages/auth-client

devops/dockerfiles/origin-bridge

@@ -19,7 +19,7 @@ COPY ./packages/ip2geo ./packages/ip2geo
 COPY ./packages/validator ./packages/validator
 COPY ./infra/bridge ./infra/bridge
 COPY ./infra/identity ./infra/identity
-COPY ./infra/growth-event ./infra/growth-event
+COPY ./infra/growth-shared ./infra/growth-shared
 COPY ./packages/auth-utils ./packages/auth-utils
 
 RUN yarn install

devops/dockerfiles/origin-cron

@@ -28,7 +28,7 @@ COPY ./packages/validator ./packages/validator
 COPY ./packages/contracts ./packages/contracts
 COPY ./packages/token ./packages/token
 COPY ./infra/consistency ./infra/consistency
-COPY ./infra/growth-event ./infra/growth-event
+COPY ./infra/growth-shared ./infra/growth-shared
 COPY ./infra/cron ./infra/cron
 COPY ./infra/discovery ./infra/discovery
 COPY ./infra/growth ./infra/growth

devops/dockerfiles/origin-discovery

@@ -22,7 +22,7 @@ COPY ./packages/services ./packages/services
 COPY ./packages/validator ./packages/validator
 COPY ./packages/token ./packages/token
 COPY ./infra/discovery ./infra/discovery
-COPY ./infra/growth-event ./infra/growth-event
+COPY ./infra/growth-shared ./infra/growth-shared
 COPY ./infra/identity ./infra/identity
 
 RUN yarn install

devops/dockerfiles/origin-faucet

@@ -17,7 +17,7 @@ COPY ./packages/contracts ./packages/contracts
 COPY ./packages/token ./packages/token
 COPY ./packages/ipfs ./packages/ipfs
 COPY ./infra/identity ./infra/identity
-COPY ./infra/growth-event ./infra/growth-event
+COPY ./infra/growth-shared ./infra/growth-shared
 COPY ./infra/faucet ./infra/faucet
 
 RUN yarn install

devops/dockerfiles/origin-notifications

@@ -27,7 +27,7 @@ COPY ./packages/validator ./packages/validator
 COPY ./packages/contracts ./packages/contracts
 COPY ./packages/token ./packages/token
 COPY ./infra/discovery ./infra/discovery
-COPY ./infra/growth-event ./infra/growth-event
+COPY ./infra/growth-shared ./infra/growth-shared
 # @origin/identity required for the db model
 COPY ./infra/identity ./infra/identity
 COPY ./packages/auth-utils ./packages/auth-utils

devops/dockerfiles/origin-growth renamed to devops/dockerfiles/origin-shared

@@ -29,13 +29,13 @@ COPY ./packages/contracts ./packages/contracts
 COPY ./packages/token ./packages/token
 COPY ./infra/discovery ./infra/discovery
 COPY ./infra/growth ./infra/growth
-COPY ./infra/growth-event ./infra/growth-event
+COPY ./infra/growth-shared ./infra/growth-shared
 COPY ./infra/identity ./infra/identity
 
 RUN yarn install
 
 # Run migrations then start the growth server.
 CMD eval "$(envkey-source)" && \
 	npm run migrate --prefix infra/growth && \
-	npm run migrate --prefix infra/growth-event && \
+	npm run migrate --prefix infra/growth-shared && \
 	npm run start --prefix infra/growth

docker-compose.yml

@@ -59,14 +59,15 @@ services:
       - ./packages/validator:/app/packages/validator/
       - ./packages/token/:/app/packages/token/
       - ./packages/auth-client/:/app/packages/auth-client/
+      - ./packages/utils/:/app/packages/utils/
       # Infrastructure packages
       - ./infra/bridge/:/app/infra/bridge/
       - ./infra/discovery/:/app/infra/discovery/
       - ./infra/ipfs-proxy/:/app/infra/ipfs-proxy/
       - ./infra/messaging/:/app/infra/messaging/
       - ./infra/notifications/:/app/infra/notifications/
       - ./infra/growth/:/app/infra/growth/
-      - ./infra/growth-event/:/app/infra/growth-event/
+      - ./infra/growth-shared/:/app/infra/growth-shared/
       - ./infra/identity/:/app/infra/identity/
       - ./infra/auth-server/:/app/infra/auth-server/
       - ./packages/auth-utils/:/app/packages/auth-utils/
@@ -90,7 +91,7 @@ services:
       - /app/infra/messaging/node_modules/
       - /app/infra/notifications/node_modules/
       - /app/infra/growth/node_modules/
-      - /app/infra/growth-event/node_modules/
+      - /app/infra/growth-shared/node_modules/
       - /app/infra/identity/node_modules/
       - /app/infra/auth-server/node_modules/
       - /app/packages/auth-utils/node_modules/
@@ -110,7 +111,7 @@ services:
       >
       /bin/bash -c "npm run migrate --prefix infra/discovery &&
       npm run migrate --prefix infra/growth &&
-      npm run migrate --prefix infra/growth-event &&
+      npm run migrate --prefix infra/growth-shared &&
       npm run migrate --prefix infra/identity &&
       npm run migrate --prefix infra/notifications &&
       npm run migrate --prefix infra/bridge &&

infra/bridge/package.json

@@ -31,7 +31,7 @@
   "dependencies": {
     "@google-cloud/pubsub": "1.3.0",
     "@origin/auth-utils": "^0.1.0",
-    "@origin/growth-event": "^0.1.0",
+    "@origin/growth-shared": "^0.1.0",
     "@origin/identity": "^0.1.0",
     "@origin/ip2geo": "^0.1.0",
     "@sendgrid/mail": "^6.4.0",

infra/bridge/src/controllers/identity.js

@@ -6,7 +6,7 @@ const get = require('lodash/get')
 const router = express.Router()
 
 const authMiddleware = require('@origin/auth-utils/src/middleware/auth')
-const { GrowthEvent } = require('@origin/growth-event/src/resources/event')
+const { GrowthEvent } = require('@origin/growth-shared/src/resources/event')
 const {
   loadAttestationMetadata,
   loadIdentityAddresses,

infra/bridge/src/controllers/promotions.js

@@ -3,11 +3,11 @@
 const express = require('express')
 const router = express.Router()
 
-const { GrowthEvent } = require('@origin/growth-event/src/resources/event')
+const { GrowthEvent } = require('@origin/growth-shared/src/resources/event')
 const {
   GrowthEventTypes,
   GrowthEventStatuses
-} = require('@origin/growth-event/src/enums')
+} = require('@origin/growth-shared/src/enums')
 
 const {
   hashContent,

infra/bridge/src/utils/growth-event-helpers.js

@@ -2,8 +2,8 @@
 
 const logger = require('../logger')
 
-const { GrowthEvent } = require('@origin/growth-event/src/resources/event')
-const { GrowthEventTypes } = require('@origin/growth-event/src/enums')
+const { GrowthEvent } = require('@origin/growth-shared/src/resources/event')
+const { GrowthEventTypes } = require('@origin/growth-shared/src/enums')
 
 const db = require('@origin/identity/src/models')
 

infra/discovery/package.json

@@ -17,7 +17,7 @@
   "dependencies": {
     "@google-cloud/pubsub": "1.3.0",
     "@origin/graphql": "^0.1.1",
-    "@origin/growth-event": "^0.1.0",
+    "@origin/growth-shared": "^0.1.0",
     "@origin/identity": "^0.1.0",
     "@origin/ipfs": "^0.1.0",
     "@origin/ip2geo": "^0.1.0",

infra/discovery/src/listener/handler_identity.js

@@ -2,7 +2,7 @@ const get = require('lodash/get')
 const Web3 = require('web3')
 
 const originIpfs = require('@origin/ipfs')
-const { GrowthEvent } = require('@origin/growth-event/src/resources/event')
+const { GrowthEvent } = require('@origin/growth-shared/src/resources/event')
 const {
   convertLegacyAvatar,
   loadAttestationMetadata,

infra/discovery/src/listener/handler_marketplace.js

@@ -2,8 +2,8 @@ const esmImport = require('esm')(module)
 const logger = require('./logger')
 const search = require('../lib/search')
 const db = require('../models')
-const { GrowthEvent } = require('@origin/growth-event/src/resources/event')
-const { GrowthEventTypes } = require('@origin/growth-event/src/enums')
+const { GrowthEvent } = require('@origin/growth-shared/src/resources/event')
+const { GrowthEventTypes } = require('@origin/growth-shared/src/enums')
 const listingQuery = require('./queries/Listing')
 const offerQuery = require('./queries/Offer')
 const { getOriginListingId, getOriginOfferId } = esmImport(

infra/discovery/test/listener-handler.test.js

@@ -3,8 +3,8 @@ const sinon = require('sinon')
 const expect = chai.expect
 const esmImport = require('esm')(module)
 
-const { GrowthEvent } = require('@origin/growth-event/src/resources/event')
-const { GrowthEventTypes } = require('@origin/growth-event/src/enums')
+const { GrowthEvent } = require('@origin/growth-shared/src/resources/event')
+const { GrowthEventTypes } = require('@origin/growth-shared/src/enums')
 
 const graphqlClient = esmImport('@origin/graphql').default
 

infra/growth-event/README.md

@@ -1,6 +1,6 @@
 {
-  "name": "@origin/growth-event",
-  "description": "Growth event migration files, models and resources",
+  "name": "@origin/growth-shared",
+  "description": "Shared growth functionality: growth event migration files, models and resources",
   "version": "0.1.0",
   "engines": {
     "node": "10.x"

infra/growth-event/.eslintrc.js renamed to infra/growth-shared/.eslintrc.js

@@ -0,0 +1,64 @@
+const {
+  GrowthReferral,
+  GrowthInviteCode
+} = require('@origin/growth-shared/src/models')
+
+async function _getReferrer(code) {
+  // Lookup the code.
+  const inviteCode = await GrowthInviteCode.findOne({ where: { code } })
+  if (!inviteCode) {
+    throw new Error(`Invalid invite code ${code}`)
+  }
+  return inviteCode.ethAddress
+}
+
+async function makeReferralConnection(code, walletAddress) {
+  walletAddress = walletAddress.toLowerCase()
+  const referralLink = await GrowthReferral.findOne({
+    where: {
+      refereeEthAddress: walletAddress
+    }
+  })
+  const referrer = await _getReferrer(code)
+
+  if (referrer === walletAddress) {
+    throw new Error(`Referrer ${referrer} can't use own referral code`)
+  }
+
+  const returnObj = {
+    referrer
+  }
+
+  if (referralLink) {
+    if (referralLink.referrerEthAddress !== referrer) {
+      /* The referrer associated with the invite code does not match previously stored referrer.
+       * A corner case scenario this might happen is as follow:
+       *  - referee receives multiple invites.
+       *  - referee clicks on an invite and enrolls into growth campaing
+       *  - referee clicks on another invite link and enrolls again into
+       *  growth campaign.
+       *
+       * When this happens we ignore the subsequent invites and attribute all
+       * referees actions to the initial referrer.
+       *
+       */
+      throw new Error(
+        `Referee ${walletAddress} already referred by ${referralLink.referrerEthAddress}`
+      )
+    } else {
+      // the referrer -> referee link already created
+      return returnObj
+    }
+  }
+
+  await GrowthReferral.create({
+    referrerEthAddress: referrer,
+    refereeEthAddress: walletAddress
+  })
+
+  return returnObj
+}
+
+module.exports = {
+  makeReferralConnection
+}

infra/growth-event/.sequelizerc renamed to infra/growth-shared/.sequelizerc

@@ -14,7 +14,7 @@
     "@origin/auth-utils": "^0.1.0",
     "@origin/discovery": "^0.1.0",
     "@origin/graphql": "^0.1.1",
-    "@origin/growth-event": "^0.1.0",
+    "@origin/growth-shared": "^0.1.0",
     "@origin/identity": "^0.1.0",
     "@origin/ip2geo": "^0.1.0",
     "@origin/token": "^0.1.0",

infra/growth-shared/README.md

@@ -20,7 +20,7 @@ const { sendInvites, sendInviteReminder } = require('../resources/email')
 const enums = require('../enums')
 const logger = require('../logger')
 const { BannedUserError } = require('../util/bannedUserError')
-const { GrowthEvent } = require('@origin/growth-event/src/resources/event')
+const { GrowthEvent } = require('@origin/growth-shared/src/resources/event')
 
 const requireEnrolledUser = context => {
   if (
@@ -205,7 +205,7 @@ const resolvers = {
         if (args.inviteCode) {
           await GrowthInvite.makeReferralConnection(
             args.inviteCode,
-            args.accountId
+            context.walletAddress
           )
         }
 

infra/growth-event/dev.env renamed to infra/growth-shared/dev.env

@@ -7,7 +7,7 @@ const {
   Enum,
   GrowthEventStatuses,
   GrowthEventTypes
-} = require('@origin/growth-event/src/enums')
+} = require('@origin/growth-shared/src/enums')
 
 const GrowthCampaignRewardStatuses = new Enum(
   'NotReady',

infra/growth-event/migrations/20190124003426-create-growth-event.js renamed to infra/growth-shared/migrations/20190124003426-create-growth-event.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const _growthEventModels = require('@origin/growth-event/src/models')
+const _growthEventModels = require('@origin/growth-shared/src/models')
 
 const fs = require('fs')
 const path = require('path')