testing api-unit job

.babelrc

@@ -9,4 +9,4 @@
       }
     ]
   ]
-}
+}

.eslintrc.js

@@ -1,20 +1,6 @@
-/* eslint-disable import/no-commonjs */
 module.exports = {
   root: true,
   extends: [
-    'habitrpg/lib/node',
+    'habitrpg/lib/node'
   ],
-  rules: {
-    'prefer-regex-literals': 'warn',
-    'import/no-extraneous-dependencies': 'off',
-    'require-await': 'error',
-  },
-  overrides: [
-    {
-      files: ['migrations/**', 'gulp/**'], // Or *.test.js
-      rules: {
-        'require-await': 'off',
-      },
-    },
-  ],
-};
+}

.github/actions/shared-job-steps/action.yml

@@ -0,0 +1,61 @@
+name: job setup
+description: 'Sets the shared steps for each job'
+
+inputs:
+  node-version:
+    description: 'The Node version to be setup'
+    required: true
+  node-env:
+    description: 'Node-Env for CI'
+    required: true
+  package-install-cmd:
+    description: 'CI or install or custom to skip post install and unneeded builds'
+    required: false
+    default: 'ci'
+  install-website-package:
+    description: 'if package-install-cmd skipped post install, you can trigger an installation of website'
+    required: false
+    default: 'false'
+
+  website-package-install-cmd:
+    description: 'CI or install or custom to skip post install and unneeded builds'
+    required: false
+    default: 'ci'
+
+runs:
+  using: composite
+  steps:
+    - name: Use Node.js ${{ inputs.node-version }}
+      uses: actions/setup-node@v3
+      with:
+        node-version: ${{ inputs.node-version }}
+    - name: Cache multiple paths
+      id: cache-package
+      uses: actions/cache@v2
+      with:
+        path: |
+          **/node_modules
+        key: ${{ runner.os }}-${{ inputs.node-version }}-${{ inputs.node-env }}-${{ inputs.install-website-package }}-${{ hashFiles('**/package.json') }}
+
+    - name: Create dummy config.json
+      shell: bash
+      run: cp config.json.example config.json
+
+    - name: npm install
+      if: steps.cache-package.outputs.cache-hit != 'true'
+      shell: bash
+      run: |
+        npm ${{ inputs.package-install-cmd }}
+      env:
+        CI: true
+        NODE_ENV: ${{ inputs.node-env }}
+
+    - name: npm install website
+      if: ${{ steps.cache-package.outputs.cache-hit != 'true' && inputs.install-website-package != 'false' }}
+      shell: bash
+      working-directory: ./website/client
+      run: |
+        npm ${{ inputs.website-package-install-cmd }}
+      env:
+        CI: true
+        NODE_ENV: ${{ inputs.node-env }}

.github/dependabot.yml

@@ -0,0 +1,186 @@
+version: 2
+updates:
+- package-ecosystem: npm
+  directory: "/"
+  schedule:
+    interval: weekly
+    time: "06:00"
+    timezone: Europe/Rome
+  open-pull-requests-limit: 99
+  ignore:
+  - dependency-name: express-validator
+    versions:
+    - 6.10.0
+    - 6.10.1
+    - 6.9.2
+  - dependency-name: "@babel/core"
+    versions:
+    - 7.12.13
+    - 7.12.16
+    - 7.12.17
+    - 7.13.1
+    - 7.13.10
+    - 7.13.13
+    - 7.13.14
+    - 7.13.15
+    - 7.13.8
+  - dependency-name: redis
+    versions:
+    - 3.1.0
+  - dependency-name: stripe
+    versions:
+    - 8.134.0
+    - 8.135.0
+    - 8.137.0
+    - 8.138.0
+    - 8.140.0
+    - 8.142.0
+  - dependency-name: "@babel/register"
+    versions:
+    - 7.12.13
+    - 7.13.14
+    - 7.13.8
+  - dependency-name: mongoose
+    versions:
+    - 5.11.14
+    - 5.11.15
+    - 5.11.16
+    - 5.11.17
+    - 5.11.18
+    - 5.11.19
+    - 5.12.0
+    - 5.12.1
+    - 5.12.2
+    - 5.12.3
+  - dependency-name: jwks-rsa
+    versions:
+    - 1.12.3
+    - 2.0.1
+    - 2.0.2
+  - dependency-name: "@babel/preset-env"
+    versions:
+    - 7.12.13
+    - 7.12.16
+    - 7.12.17
+    - 7.13.10
+    - 7.13.12
+    - 7.13.8
+    - 7.13.9
+  - dependency-name: image-size
+    versions:
+    - 0.9.4
+    - 0.9.5
+    - 0.9.7
+  - dependency-name: winston-loggly-bulk
+    versions:
+    - 3.2.0
+  - dependency-name: chai
+    versions:
+    - 4.3.0
+    - 4.3.3
+  - dependency-name: mocha
+    versions:
+    - 8.2.1
+    - 8.3.0
+    - 8.3.1
+  - dependency-name: "@google-cloud/trace-agent"
+    versions:
+    - 5.1.2
+  - dependency-name: monk
+    versions:
+    - 7.3.3
+- package-ecosystem: npm
+  directory: "/website/client"
+  schedule:
+    interval: weekly
+    time: "06:00"
+    timezone: Europe/Rome
+  open-pull-requests-limit: 99
+  ignore:
+  - dependency-name: eslint-plugin-vue
+    versions:
+    - 7.5.0
+    - 7.6.0
+    - 7.7.0
+    - 7.8.0
+    - 7.9.0
+  - dependency-name: "@storybook/addon-knobs"
+    versions:
+    - 6.1.17
+    - 6.1.18
+    - 6.1.20
+    - 6.1.21
+    - 6.2.2
+    - 6.2.3
+    - 6.2.7
+  - dependency-name: "@storybook/addon-links"
+    versions:
+    - 6.1.17
+    - 6.1.18
+    - 6.1.20
+    - 6.1.21
+    - 6.2.2
+    - 6.2.3
+    - 6.2.7
+  - dependency-name: "@storybook/vue"
+    versions:
+    - 6.1.17
+    - 6.1.18
+    - 6.1.20
+    - 6.1.21
+    - 6.2.2
+    - 6.2.3
+    - 6.2.7
+  - dependency-name: "@storybook/addon-actions"
+    versions:
+    - 6.1.17
+    - 6.1.18
+    - 6.1.20
+    - 6.1.21
+    - 6.2.2
+    - 6.2.3
+    - 6.2.7
+  - dependency-name: core-js
+    versions:
+    - 3.10.0
+    - 3.10.1
+    - 3.9.0
+    - 3.9.1
+  - dependency-name: bootstrap
+    versions:
+    - 4.6.0
+  - dependency-name: y18n
+    versions:
+    - 4.0.1
+  - dependency-name: hellojs
+    versions:
+    - 1.18.8
+    - 1.19.2
+  - dependency-name: chai
+    versions:
+    - 4.3.0
+    - 4.3.3
+  - dependency-name: amplitude-js
+    versions:
+    - 7.4.2
+    - 7.4.3
+    - 7.4.4
+  - dependency-name: pug
+    versions:
+    - 3.0.2
+  - dependency-name: sass
+    versions:
+    - 1.32.6
+    - 1.32.7
+    - 1.32.8
+  - dependency-name: "@vue/test-utils"
+    versions:
+    - 1.1.2
+    - 1.1.3
+  - dependency-name: intro.js
+    versions:
+    - 3.2.1
+    - 3.3.1
+  - dependency-name: sass-loader
+    versions:
+    - 10.1.1

.github/workflows/test.yml

@@ -1,13 +1,13 @@
 name: Test
 
 on:
-  push:
-    branches-ignore:
-    - 'phillip/**'
-    - 'sabrecat/**'
-    - 'kalista/**'
-    - 'natalie/**'
   pull_request:
+    branches:
+      - '**'
+  push:
+    branches:
+      - 'develop'
+      - 'release'
 
 permissions:
   contents: read
@@ -17,147 +17,120 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [21.x]
+        node-version: [14.x]
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v1
       with:
         fetch-depth: 1
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v4
+
+    - name: Setup Shared Job Steps
+      uses: './.github/actions/shared-job-steps'
       with:
         node-version: ${{ matrix.node-version }}
-    - run: sudo apt update
-    - run: sudo apt -y install libkrb5-dev
-    - run: cp config.json.example config.json
-    - name: npm install
-      run: |
-        npm i
-      env:
-        CI: true
-        NODE_ENV: test
+        node-env: 'test'
+        package-install-cmd: 'ci --ignore-scripts'
+        install-website-package: 'true'
+        website-package-install-cmd: 'ci --ignore-scripts'
+
     - run: npm run lint-no-fix
   apidoc:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [21.x]
+        node-version: [14.x]
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v1
       with:
         fetch-depth: 1
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v4
+
+    - name: Setup Shared Job Steps
+      uses: './.github/actions/shared-job-steps'
       with:
         node-version: ${{ matrix.node-version }}
-    - run: sudo apt update
-    - run: sudo apt -y install libkrb5-dev
-    - run: cp config.json.example config.json
-    - name: npm install
-      run: |
-        npm i
-      env:
-        CI: true
-        NODE_ENV: test
+        node-env: 'test'
+        package-install-cmd: 'ci --ignore-scripts'
+
     - run: npm run apidoc
   sanity:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [21.x]
+        node-version: [14.x]
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v1
       with:
         fetch-depth: 1
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v4
+
+    - name: Setup Shared Job Steps
+      uses: './.github/actions/shared-job-steps'
       with:
         node-version: ${{ matrix.node-version }}
-    - run: sudo apt update
-    - run: sudo apt -y install libkrb5-dev
-    - run: cp config.json.example config.json
-    - name: npm install
-      run: |
-        npm i
-      env:
-        CI: true
-        NODE_ENV: test
+        node-env: 'test'
+        package-install-cmd: 'ci --ignore-scripts'
+
     - run: npm run test:sanity
-  
+
   common:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [21.x]
+        node-version: [14.x]
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v1
       with:
         fetch-depth: 1
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v4
+
+    - name: Setup Shared Job Steps
+      uses: './.github/actions/shared-job-steps'
       with:
         node-version: ${{ matrix.node-version }}
-    - run: sudo apt update
-    - run: sudo apt -y install libkrb5-dev
-    - run: cp config.json.example config.json
-    - name: npm install
-      run: |
-        npm i
-      env:
-        CI: true
-        NODE_ENV: test
+        node-env: 'test'
+        package-install-cmd: 'ci --ignore-scripts'
+
     - run: npm run test:common
   content:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [21.x]
+        node-version: [14.x]
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v1
       with:
         fetch-depth: 1
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v4
+
+    - name: Setup Shared Job Steps
+      uses: './.github/actions/shared-job-steps'
       with:
         node-version: ${{ matrix.node-version }}
-    - run: sudo apt update
-    - run: sudo apt -y install libkrb5-dev
-    - run: cp config.json.example config.json
-    - name: npm install
-      run: |
-        npm i
-      env:
-        CI: true
-        NODE_ENV: test
+        node-env: 'test'
+        package-install-cmd: 'ci --ignore-scripts'
+
     - run: npm run test:content
-  
+
   api-unit:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [21.x]
+        node-version: [14.x]
         mongodb-version: [4.2]
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v1
       with:
         fetch-depth: 1
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v4
+
+    - name: Setup Shared Job Steps
+      uses: './.github/actions/shared-job-steps'
       with:
         node-version: ${{ matrix.node-version }}
+        node-env: 'test'
+        package-install-cmd: 'ci'
+
     - name: Start MongoDB ${{ matrix.mongodb-version }} Replica Set
       uses: supercharge/mongodb-github-action@1.3.0
       with:
         mongodb-version: ${{ matrix.mongodb-version }}
         mongodb-replica-set: rs
-    - run: sudo apt update
-    - run: sudo apt -y install libkrb5-dev
-    - run: cp config.json.example config.json
-    - name: npm install
-      run: |
-        npm i
-      env:
-        CI: true
-        NODE_ENV: test
+
     - run: npm run test:api:unit
       env:
         REQUIRES_SERVER=true: true
@@ -165,30 +138,26 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [21.x]
+        node-version: [14.x]
         mongodb-version: [4.2]
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v1
       with:
         fetch-depth: 1
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v4
+
+    - name: Setup Shared Job Steps
+      uses: './.github/actions/shared-job-steps'
       with:
         node-version: ${{ matrix.node-version }}
+        node-env: 'test'
+        package-install-cmd: 'ci --ignore-scripts'
+
     - name: Start MongoDB ${{ matrix.mongodb-version }} Replica Set
       uses: supercharge/mongodb-github-action@1.3.0
       with:
         mongodb-version: ${{ matrix.mongodb-version }}
         mongodb-replica-set: rs
-    - run: sudo apt update
-    - run: sudo apt -y install libkrb5-dev
-    - run: cp config.json.example config.json
-    - name: npm install
-      run: |
-        npm i
-      env:
-        CI: true
-        NODE_ENV: test
+
     - run: npm run test:api-v3:integration
       env:
         REQUIRES_SERVER=true: true
@@ -196,30 +165,26 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [21.x]
+        node-version: [14.x]
         mongodb-version: [4.2]
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v1
       with:
         fetch-depth: 1
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v4
+
+    - name: Setup Shared Job Steps
+      uses: './.github/actions/shared-job-steps'
       with:
         node-version: ${{ matrix.node-version }}
+        node-env: 'test'
+        package-install-cmd: 'ci --ignore-scripts'
+
     - name: Start MongoDB ${{ matrix.mongodb-version }} Replica Set
       uses: supercharge/mongodb-github-action@1.3.0
       with:
         mongodb-version: ${{ matrix.mongodb-version }}
         mongodb-replica-set: rs
-    - run: sudo apt update
-    - run: sudo apt -y install libkrb5-dev
-    - run: cp config.json.example config.json
-    - name: npm install
-      run: |
-        npm i
-      env:
-        CI: true
-        NODE_ENV: test
+
     - run: npm run test:api-v4:integration
       env:
         REQUIRES_SERVER=true: true
@@ -228,24 +193,21 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [21.x]
+        node-version: [14.x]
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v1
       with:
         fetch-depth: 1
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v4
+
+    - name: Setup Shared Job Steps
+      uses: './.github/actions/shared-job-steps'
       with:
         node-version: ${{ matrix.node-version }}
-    - run: sudo apt update
-    - run: sudo apt -y install libkrb5-dev
-    - run: cp config.json.example config.json
-    - name: npm install
-      run: |
-        npm i
-      env:
-        CI: true
-        NODE_ENV: test
+        node-env: 'test'
+        package-install-cmd: 'ci --ignore-scripts'
+        install-website-package: 'true'
+        website-package-install-cmd: 'ci --ignore-scripts'
+
     - run: npm run test:unit
       working-directory: ./website/client
 
@@ -253,21 +215,14 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [21.x]
+        node-version: [14.x]
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v1
       with:
         fetch-depth: 1
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v4
+
+    - name: Setup Shared Job Steps
+      uses: './.github/actions/shared-job-steps'
       with:
         node-version: ${{ matrix.node-version }}
-    - run: sudo apt update
-    - run: sudo apt -y install libkrb5-dev
-    - run: cp config.json.example config.json
-    - name: npm install
-      run: |
-        npm install
-      env:
-        CI: true
-        NODE_ENV: production
+        node-env: 'production'

.gitignore

@@ -8,7 +8,7 @@ i18n_cache
 apidoc/html
 *.swp
 .idea*
-config*.json
+config.json
 npm-debug.log*
 lib
 newrelic_agent.log
@@ -40,12 +40,10 @@ yarn.lock
 !.elasticbeanstalk/*.global.yml
 
 /.vscode
-habitica.code-workspace
 
 # webstorm fake webpack for path intellisense
 webpack.webstorm.config
 
 # mongodb replica set for local dev
 mongodb-*.tgz
-/mongodb-data*
-/.nyc_output
+/mongodb-data

.heroku/report_deploy.sh

@@ -1,25 +0,0 @@
-#!/bin/bash
-
-DEVELOPER="someone"
-if git rev-parse --git-dir > /dev/null 2>&1; then
-    DEVELOPERS=$(git log -5 --pretty=format:'%an')
-    IFS=$'\n'
-    DEVELOPER=""
-    for dev in $DEVELOPERS
-    do
-        if [ "$DEVELOPER" == "someone" ]; then
-            if [[ ${dev} != *"[bot]"* ]]; then
-                DEVELOPER=$dev
-                continue
-            fi
-            continue
-        fi
-    done
-fi
-
-PARTS=$(cut -d"." -f1 <<< $BASE_URL)
-SERVER_NAME=$(cut -d"/" -f3 <<< ${PARTS[0]})
-
-SERVER_NAME=":$SERVER_EMOJI: $SERVER_NAME"
-
-wget $SLACK_DEPLOY_URL --post-data="{\"server_name\": \"$SERVER_NAME\", \"developer\": \"$DEVELOPER\", \"base_url\": \"$BASE_URL\"}" -O /dev/null

.nvmrc

@@ -1 +1 @@
-20
+14

Dockerfile

@@ -0,0 +1,30 @@
+FROM node:14
+
+ENV ADMIN_EMAIL admin@habitica.com
+ENV EMAILS_COMMUNITY_MANAGER_EMAIL admin@habitica.com
+ENV AMAZON_PAYMENTS_CLIENT_ID amzn1.application-oa2-client.68ed9e6904ef438fbc1bf86bf494056e
+ENV AMAZON_PAYMENTS_SELLER_ID AMQ3SB4SG5E91
+ENV AMPLITUDE_KEY e8d4c24b3d6ef3ee73eeba715023dd43
+ENV BASE_URL https://habitica.com
+ENV FACEBOOK_KEY 128307497299777
+ENV GA_ID UA-33510635-1
+ENV GOOGLE_CLIENT_ID 1035232791481-32vtplgnjnd1aufv3mcu1lthf31795fq.apps.googleusercontent.com
+ENV LOGGLY_CLIENT_TOKEN ab5663bf-241f-4d14-8783-7d80db77089a
+ENV NODE_ENV production
+ENV STRIPE_PUB_KEY pk_85fQ0yMECHNfHTSsZoxZXlPSwSNfA
+ENV APPLE_AUTH_CLIENT_ID 9Q9SMRMCNN.com.habitrpg.ios.Habitica
+
+# Install global packages
+RUN npm install -g gulp-cli mocha
+
+# Clone Habitica repo and install dependencies
+RUN mkdir -p /usr/src/habitrpg
+WORKDIR /usr/src/habitrpg
+RUN git clone --branch release --depth 1 https://github.com/HabitRPG/habitica.git /usr/src/habitrpg
+RUN git config --global url."https://".insteadOf git://
+RUN npm set unsafe-perm true
+RUN npm install
+
+# Start Habitica
+EXPOSE 80 8080 36612
+CMD ["node", "./website/transpiled-babel/index.js"]

Dockerfile-Dev

@@ -1,15 +1,14 @@
-FROM node:20
+FROM node:14
 
 # Install global packages
 RUN npm install -g gulp-cli mocha
 
-# Copy package.json and package-lock.json into image
+# Copy package.json and package-lock.json into image, then install
+# dependencies.
 WORKDIR /usr/src/habitica
 COPY ["package.json", "package-lock.json", "./"]
+RUN npm install
+
 # Copy the remaining source files in.
 COPY . /usr/src/habitica
-# Install dependencies
-RUN npm install
 RUN npm run postinstall
-RUN npm run client:build
-RUN gulp build:prod

README.md

@@ -1,20 +1,14 @@
-Habitica ![Build Status](https://github.com/HabitRPG/habitica/workflows/Test/badge.svg)
+Habitica ![Build Status](https://github.com/HabitRPG/habitica/workflows/Test/badge.svg) [![Code Climate](https://codeclimate.com/github/HabitRPG/habitrpg.svg)](https://codeclimate.com/github/HabitRPG/habitrpg) [![Bountysource](https://api.bountysource.com/badge/tracker?tracker_id=68393)](https://www.bountysource.com/trackers/68393-habitrpg?utm_source=68393&utm_medium=shield&utm_campaign=TRACKER_BADGE)
 ===============
 
-[Habitica](https://habitica.com) is an open-source habit-building program that treats your life like a role-playing game. Level up as you succeed, lose HP as you fail, and earn Gold to buy weapons and armor!
+[Habitica](https://habitica.com) is an open source habit building program which treats your life like a Role Playing Game. Level up as you succeed, lose HP as you fail, earn money to buy weapons and armor.
 
-**Want to contribute code to Habitica?** We're always looking for assistance on any issues in our repo with the "Help Wanted" label. The wiki pages below and the additional linked pages will tell you how to start contributing code and where you can seek further help or ask questions:
+**We need more programmers!** Your assistance will be greatly appreciated. The wiki pages below and the additional pages they link to will tell you how to get started on contributing code and where you can go to seek further help or ask questions:
 * [Guidance for Blacksmiths](https://habitica.fandom.com/wiki/Guidance_for_Blacksmiths) - an introduction to the technologies used and how the software is organized.
-* [Setting up Habitica Locally](https://github.com/HabitRPG/habitica/wiki/Setting-Up-Habitica-for-Local-Development) - how to set up a local install of Habitica for development and testing.
-
-**Interested in contributing to Habitica’s mobile apps?** Visit the links below for our mobile repositories.
-* **Android:** https://github.com/HabitRPG/habitica-android
-* **iOS:** https://github.com/HabitRPG/habitica-ios
+* [Setting up Habitica Locally](https://habitica.fandom.com/wiki/Setting_up_Habitica_Locally) - how to set up a local install of Habitica for development and testing on various platforms.
 
 Habitica's code is licensed as described at https://github.com/HabitRPG/habitica/blob/develop/LICENSE
 
-**Found a bug?** Please report it to [admin email](mailto:admin@habitica.com) rather than create an issue (an admin will advise you if a new issue is necessary; usually it is not).
+**Found a bug?** Please report it to [admin email](mailto:admin@habitica.com) rather than creating an issue (an admin will advise you if a new issue is necessary; usually it is not).
 
-**Creating a third-party tool?** Please review our [API Usage Guidelines](https://github.com/HabitRPG/habitica/wiki/API-Usage-Guidelines) to ensure that your tool is compliant and maintains the best experience for Habitica players.
-
-**Have any questions about Habitica or contributing?** See the links in the [Habitica](https://habitica.com) website's Help menu. There’s FAQ’s, guides, and the option to reach out to us with any further questions!
+**Have any questions about Habitica or its community?** See the links in the [habitica.com](https://habitica.com) website's Help menu or drop in to [Guilds > Tavern Chat](https://habitica.com/groups/tavern) to ask questions or chat socially!

apidoc/header.md

@@ -2,4 +2,4 @@
 
 This webpage includes the documentation for version 3 of the [Habitica](https://habitica.com) API.
 
-If you're developing a 3rd party tool that uses the Habitica API, read the [API Usage Guidelines](https://github.com/HabitRPG/habitica/wiki/API-Usage-Guidelines), which describe how to be a responsible user of our server resources!
+If you're developing a 3rd party tool that uses the Habitica API you should read the [Guidance for Comrades](https://habitica.fandom.com/wiki/Guidance_for_Comrades) and in particular the section called [Rules for Third-Party Tools](https://habitica.fandom.com/wiki/Guidance_for_Comrades#Rules_for_Third-Party_Tools) which includes suggestions on how to best use the API and the rules to follow when interacting with it.

config.json.example

@@ -32,12 +32,10 @@
   "LOGGLY_CLIENT_TOKEN": "token",
   "LOGGLY_SUBDOMAIN": "example-subdomain",
   "LOGGLY_TOKEN": "example-token",
-  "LOG_REQUESTS_EXCESSIVE_MODE": "false",
   "MAINTENANCE_MODE": "false",
   "NODE_DB_URI": "mongodb://localhost:27017/habitica-dev?replicaSet=rs",
   "TEST_DB_URI": "mongodb://localhost:27017/habitica-test?replicaSet=rs",
   "MONGODB_POOL_SIZE": "10",
-  "MONGODB_SOCKET_TIMEOUT": "20000",
   "NODE_ENV": "development",
   "PATH": "bin:node_modules/.bin:/usr/local/bin:/usr/bin:/bin",
   "PAYPAL_BILLING_PLANS_basic_12mo": "basic_12mo",
@@ -86,13 +84,8 @@
   "BLOCKED_IPS": "",
   "LOG_AMPLITUDE_EVENTS": "false",
   "RATE_LIMITER_ENABLED": "false",
-  "LIVELINESS_PROBE_KEY": "",
   "REDIS_HOST": "aaabbbcccdddeeefff",
   "REDIS_PORT": "1234",
   "REDIS_PASSWORD": "12345678",
-  "TRUSTED_DOMAINS": "localhost,https://habitica.com",
-  "TIME_TRAVEL_ENABLED": "false",
-  "DEBUG_ENABLED": "false",
-  "CONTENT_SWITCHOVER_TIME_OFFSET": 8,
-  "SLOW_REQUEST_THRESHOLD": 1000
+  "TRUSTED_DOMAINS": "https://localhost,https://habitica.com"
 }

docker-compose.dev.yml

@@ -22,8 +22,7 @@ services:
       dockerfile: ./Dockerfile-Dev
     command: ["npm", "start"]
     depends_on:
-      mongo:
-        condition: service_healthy
+      - mongo
     environment:
       - NODE_DB_URI=mongodb://mongo/habitrpg
     networks:
@@ -34,16 +33,7 @@ services:
       - .:/usr/src/habitica
       - /usr/src/habitica/node_modules
   mongo:
-    image: mongo:5.0.23
-    restart: unless-stopped
-    command: ["--replSet", "rs", "--bind_ip_all", "--port", "27017"]
-    healthcheck:
-      test: echo "try { rs.status() } catch (err) { rs.initiate() }" | mongosh --port 27017 --quiet
-      interval: 10s
-      timeout: 30s
-      start_period: 0s
-      start_interval: 1s
-      retries: 30
+    image: mongo:3.6
     networks:
       - habitica
     ports:

gulp/gulp-build.js

@@ -51,7 +51,7 @@ gulp.task('build:prepare-mongo', async () => {
   console.log('MongoDB data folder is missing, setting up.'); // eslint-disable-line no-console
 
   // use run-rs without --keep, kill it as soon as the replica set starts
-  const runRsProcess = spawn('run-rs', ['-v', '4.1.1', '-l', 'ubuntu1804', '--dbpath', 'mongodb-data', '--number', '1', '--quiet']);
+  const runRsProcess = spawn('run-rs', ['-v', '4.2.8', '-l', 'ubuntu1804', '--dbpath', 'mongodb-data', '--number', '1', '--quiet']);
 
   for await (const chunk of runRsProcess.stdout) {
     const stringChunk = chunk.toString();

gulp/gulp-console.js

@@ -2,6 +2,7 @@ import mongoose from 'mongoose';
 import nconf from 'nconf';
 import repl from 'repl';
 import gulp from 'gulp';
+import logger from '../website/server/libs/logger';
 import {
   getDevelopmentConnectionUrl,
   getDefaultConnectionOptions,
@@ -38,6 +39,10 @@ const improveRepl = context => {
   mongoose.connect(
     connectionUrl,
     mongooseOptions,
+    err => {
+      if (err) throw err;
+      logger.info('Connected with Mongoose');
+    },
   );
 };
 

gulp/gulp-sprites.js

@@ -42,50 +42,10 @@ function cssVarMap (sprite) {
   }
 }
 
-function filterFile (file) {
-  if (file.relative.indexOf('Mount_Icon_') !== -1) {
-    return false;
-  }
-  if (file.path.indexOf('shop/') !== -1) {
-    return false;
-  }
-  if (file.path.indexOf('stable/eggs') !== -1) {
-    return false;
-  }
-  if (file.path.indexOf('stable/food') !== -1) {
-    return false;
-  }
-  if (file.path.indexOf('stable/potions') !== -1) {
-    return false;
-  }
-  if (file.relative.indexOf('shop_') === 0) {
-    return false;
-  }
-  if (file.relative.indexOf('icon_background') === 0) {
-    return false;
-  }
-  if (file.relative.indexOf('notif_') === 0) {
-    return false;
-  }
-  if (file.relative.indexOf('quest_') === 0) {
-    return false;
-  }
-  if (file.relative.indexOf('inventory_quest_') === 0) {
-    return false;
-  }
-  return true;
-}
-
-async function createSpritesStream (name, src) {
+function createSpritesStream (name, src) {
   const stream = mergeStream();
-  // need to import this way bc of weird dependency things
-  // eslint-disable-next-line global-require
-  const filter = require('gulp-filter');
-
-  const f = filter(filterFile);
 
   const spriteData = gulp.src(src)
-    .pipe(f)
     .pipe(spritesmith({
       imgName: `spritesmith-${name}.png`,
       cssName: `spritesmith-${name}.css`,
@@ -103,7 +63,7 @@ async function createSpritesStream (name, src) {
   return stream;
 }
 
-gulp.task('sprites:main', async () => {
+gulp.task('sprites:main', () => {
   const mainSrc = sync('habitica-images/**/*.png');
   return createSpritesStream('main', mainSrc);
 });

gulp/gulp-start.js

@@ -0,0 +1,11 @@
+import gulp from 'gulp';
+import nodemon from 'gulp-nodemon';
+
+import pkg from '../package.json';
+
+gulp.task('nodemon', done => {
+  nodemon({
+    script: pkg.main,
+  });
+  done();
+});

gulp/gulp-tests.js

@@ -44,24 +44,28 @@ function runInChildProcess (command, options = {}, envVariables = '') {
   return done => pipe(exec(testBin(command, envVariables), options, done));
 }
 
-function integrationTestCommand (testDir) {
-  return `nyc --silent --no-clean mocha ${testDir} --recursive --require ./test/helpers/start-server`;
+function integrationTestCommand (testDir, coverageDir) {
+  return `istanbul cover --dir coverage/${coverageDir} --report lcovonly node_modules/mocha/bin/_mocha -- ${testDir} --recursive --require ./test/helpers/start-server`;
 }
 
 /* Test task definitions */
+gulp.task('test:nodemon', gulp.series(done => {
+  process.env.PORT = TEST_SERVER_PORT; // eslint-disable-line no-process-env
+  process.env.NODE_DB_URI = TEST_DB_URI; // eslint-disable-line no-process-env
+  done();
+}, 'nodemon'));
+
 gulp.task('test:prepare:mongo', cb => {
   const mongooseOptions = getDefaultConnectionOptions();
   const connectionUrl = getDevelopmentConnectionUrl(TEST_DB_URI);
 
-  mongoose.connect(connectionUrl, mongooseOptions)
-    .then(() => mongoose.connection.dropDatabase())
-    .then(() => mongoose.connection.close()).then(() => {
-      cb();
-    })
-    .catch(err => {
-      if (err) return cb(`Unable to connect to mongo database. Are you sure it's running? \n\n${err}`);
-      throw err;
+  mongoose.connect(connectionUrl, mongooseOptions, err => {
+    if (err) return cb(`Unable to connect to mongo database. Are you sure it's running? \n\n${err}`);
+    return mongoose.connection.dropDatabase(err2 => {
+      if (err2) return cb(err2);
+      return mongoose.connection.close(cb);
     });
+  });
 });
 
 gulp.task('test:prepare:server', gulp.series('test:prepare:mongo', done => {
@@ -112,10 +116,8 @@ gulp.task('test:common:safe', gulp.series('test:prepare:build', cb => {
   pipe(runner);
 }));
 
-gulp.task('test:content', gulp.series(
-  'test:prepare:build',
-  runInChildProcess(CONTENT_TEST_COMMAND, LIMIT_MAX_BUFFER_OPTIONS),
-));
+gulp.task('test:content', gulp.series('test:prepare:build',
+  runInChildProcess(CONTENT_TEST_COMMAND, LIMIT_MAX_BUFFER_OPTIONS)));
 
 gulp.task('test:content:clean', cb => {
   pipe(exec(testBin(CONTENT_TEST_COMMAND), LIMIT_MAX_BUFFER_OPTIONS, () => cb()));
@@ -140,20 +142,16 @@ gulp.task('test:content:safe', gulp.series('test:prepare:build', cb => {
   pipe(runner);
 }));
 
-gulp.task(
-  'test:api:unit:run',
-  runInChildProcess(integrationTestCommand('test/api/unit')),
-);
+gulp.task('test:api:unit:run',
+  runInChildProcess(integrationTestCommand('test/api/unit', 'coverage/api-unit')));
 
 gulp.task('test:api:unit:watch', () => gulp.watch(['website/server/libs/*', 'test/api/unit/**/*', 'website/server/controllers/**/*'], gulp.series('test:api:unit:run', done => done())));
 
-gulp.task('test:api-v3:integration', gulp.series(
-  'test:prepare:mongo',
+gulp.task('test:api-v3:integration', gulp.series('test:prepare:mongo',
   runInChildProcess(
-    integrationTestCommand('test/api/v3/integration'),
+    integrationTestCommand('test/api/v3/integration', 'coverage/api-v3-integration'),
     LIMIT_MAX_BUFFER_OPTIONS,
-  ),
-));
+  )));
 
 gulp.task('test:api-v3:integration:watch', () => gulp.watch([
   'website/server/controllers/api-v3/**/*', 'common/script/ops/*', 'website/server/libs/*.js',
@@ -166,13 +164,11 @@ gulp.task('test:api-v3:integration:separate-server', runInChildProcess(
   'LOAD_SERVER=0',
 ));
 
-gulp.task('test:api-v4:integration', gulp.series(
-  'test:prepare:mongo',
+gulp.task('test:api-v4:integration', gulp.series('test:prepare:mongo',
   runInChildProcess(
-    integrationTestCommand('test/api/v4'),
+    integrationTestCommand('test/api/v4', 'api-v4-integration'),
     LIMIT_MAX_BUFFER_OPTIONS,
-  ),
-));
+  )));
 
 gulp.task('test:api-v4:integration:separate-server', runInChildProcess(
   'mocha test/api/v4 --recursive --require ./test/helpers/start-server',

gulpfile.js

@@ -21,6 +21,7 @@ if (process.env.NODE_ENV === 'production') { // eslint-disable-line no-process-e
   require('./gulp/gulp-build'); // eslint-disable-line global-require
   require('./gulp/gulp-console'); // eslint-disable-line global-require
   require('./gulp/gulp-sprites'); // eslint-disable-line global-require
+  require('./gulp/gulp-start'); // eslint-disable-line global-require
   require('./gulp/gulp-tests'); // eslint-disable-line global-require
   require('./gulp/gulp-transifex-test'); // eslint-disable-line global-require
   require('gulp').task('default', gulp.series('test')); // eslint-disable-line global-require

migrations/.eslintrc.js

@@ -3,6 +3,6 @@ module.exports = {
   root: false,
   rules: {
     'no-console': 0,
-    'no-use-before-define': ['error', { functions: false }],
-  },
-};
+    'no-use-before-define': ['error', { functions: false }]
+  }
+}

migrations/archive/2021/20210129_habit_birthday.js

@@ -61,7 +61,7 @@ async function updateUser (user) {
 
 export default async function processUsers () {
   let query = {
-    migration: {$ne: MIGRATION_NAME},
+    // migration: {$ne: MIGRATION_NAME},
     'auth.timestamps.loggedin': {$gt: new Date('2021-01-01')},
   };
 

migrations/archive/2021/20210824_pet_group_achievements.js

@@ -105,7 +105,7 @@ async function updateUser (user) {
 
 export default async function processUsers () {
   let query = {
-    migration: { $ne: MIGRATION_NAME },
+    // migration: { $ne: MIGRATION_NAME },
     'auth.timestamps.loggedin': { $gt: new Date('2021-08-01') },
   };
 

migrations/archive/2022/20220201_pet_group_achievements.js

@@ -145,7 +145,7 @@ async function updateUser (user) {
 
 export default async function processUsers () {
   let query = {
-    migration: { $ne: MIGRATION_NAME },
+    // migration: { $ne: MIGRATION_NAME },
     'auth.timestamps.loggedin': { $gt: new Date('2021-08-01') },
   };
 

migrations/archive/2022/20220309_pet_group_achievements.js

@@ -105,7 +105,7 @@ async function updateUser (user) {
 
 export default async function processUsers () {
   let query = {
-    migration: { $ne: MIGRATION_NAME },
+    // migration: { $ne: MIGRATION_NAME },
     'auth.timestamps.loggedin': { $gt: new Date('2021-08-01') },
   };
 

migrations/archive/2022/20220524_pet_group_achievements.js

@@ -95,7 +95,7 @@ async function updateUser (user) {
 
 export default async function processUsers () {
   let query = {
-    migration: { $ne: MIGRATION_NAME },
+    // migration: { $ne: MIGRATION_NAME },
     'auth.timestamps.loggedin': { $gt: new Date('2022-01-01') },
   };
 

migrations/archive/2022/20221031_pet_set_group_achievements.js

@@ -86,7 +86,7 @@ async function updateUser (user) {
 
 export default async function processUsers () {
   let query = {
-    migration: { $ne: MIGRATION_NAME },
+    // migration: { $ne: MIGRATION_NAME },
     'auth.timestamps.loggedin': { $gt: new Date('2022-01-01') },
   };
 

migrations/archive/2022/20221213_pet_group_achievements.js

@@ -63,7 +63,7 @@ async function updateUser (user) {
       && pets['Wolf-Shade']
       && pets['Wolf-Skeleton']
       && pets['Wolf-White']
-      && pets['Wolf-Zombie']) {
+      && pets['Wolf-Zombie'] {
         set['achievements.polarPro'] = true;
       }
   }
@@ -75,7 +75,7 @@ async function updateUser (user) {
 
 export default async function processUsers () {
   let query = {
-    migration: { $ne: MIGRATION_NAME },
+    // migration: { $ne: MIGRATION_NAME },
     'auth.timestamps.loggedin': { $gt: new Date('2022-11-01') },
   };
 

migrations/archive/2023/20230522_pet_group_achievements.js

@@ -125,7 +125,7 @@ async function updateUser (user) {
 
 export default async function processUsers () {
   let query = {
-    migration: { $ne: MIGRATION_NAME },
+    // migration: { $ne: MIGRATION_NAME },
     'auth.timestamps.loggedin': { $gt: new Date('2023-04-15') },
   };
 

migrations/archive/2023/20230718_summer_splash_orcas.js

@@ -1,79 +0,0 @@
-/* eslint-disable no-console */
-const MIGRATION_NAME = '20230718_summer_splash_orcas';
-
-import { model as User } from '../../../website/server/models/user';
-
-const progressCount = 1000;
-let count = 0;
-
-async function updateUser (user) {
-  count++;
-
-  const set = { migration: MIGRATION_NAME };
-  const push = {};
-
-  if (user && user.items && user.items.pets && typeof user.items.pets['Orca-Base'] !== 'undefined') {
-    return;
-  } else if (user && user.items && user.items.mounts && typeof user.items.mounts['Orca-Base'] !== 'undefined') {
-    set['items.pets.Orca-Base'] = 5;
-    push.notifications = {
-      type: 'ITEM_RECEIVED',
-      data: {
-        icon: 'notif_orca_pet',
-        title: 'Orcas for Summer Splash!',
-        text: 'To celebrate Summer Splash, we\'ve given you an Orca Pet!',
-        destination: 'stable',
-      },
-      seen: false,
-    };
-  } else {
-    set['items.mounts.Orca-Base'] = true;
-    push.notifications = {
-      type: 'ITEM_RECEIVED',
-      data: {
-        icon: 'notif_orca_mount',
-        title: 'Orcas for Summer Splash!',
-        text: 'To celebrate Summer Splash, we\'ve given you an Orca Mount!',
-        destination: 'stable',
-      },
-      seen: false,
-    };
-  }
-
-  if (count % progressCount === 0) console.warn(`${count} ${user._id}`);
-
-  return await user.updateOne({ $set: set, $push: push }).exec();
-}
-
-export default async function processUsers () {
-  let query = {
-    migration: {$ne: MIGRATION_NAME},
-    'auth.timestamps.loggedin': {$gt: new Date('2023-06-18')},
-  };
-
-  const fields = {
-    _id: 1,
-    items: 1,
-  };
-
-  while (true) { // eslint-disable-line no-constant-condition
-    const users = await User // eslint-disable-line no-await-in-loop
-      .find(query)
-      .limit(250)
-      .sort({_id: 1})
-      .select(fields)
-      .exec();
-
-    if (users.length === 0) {
-      console.warn('All appropriate users found and modified.');
-      console.warn(`\n${count} users processed\n`);
-      break;
-    } else {
-      query._id = {
-        $gt: users[users.length - 1],
-      };
-    }
-
-    await Promise.all(users.map(updateUser)); // eslint-disable-line no-await-in-loop
-  }
-};

migrations/archive/2023/20230808_guild_gems.js

@@ -1,72 +0,0 @@
-/* eslint-disable no-console */
-import { model as User } from '../../../website/server/models/user';
-import { model as Group } from '../../../website/server/models/group';
-
-const guildsPerRun = 500;
-const progressCount = 1000;
-const guildsQuery = {
-  type: 'guild',
-};
-
-let count = 0;
-async function updateGroup (guild) {
-  count++;
-  if (count % progressCount === 0) {
-    console.warn(`${count} ${guild._id}`);
-  }
-
-  if (guild.hasActiveGroupPlan()) {
-    return console.warn(`Guild ${guild._id} is active Group Plan`);
-  }
-
-  const leader = await User
-    .findOne({ _id: guild.leader })
-    .select({ _id: true })
-    .exec();
-
-  if (!leader) {
-    return console.warn(`Leader not found for Guild ${guild._id}`);
-  }
-
-  if (guild.balance > 0) {
-    await leader.updateBalance(
-      guild.balance,
-      'create_guild',
-      '',
-      `Guild Bank refund for ${guild.name} (${guild._id})`,
-    );
-  }
-
-  return guild.updateOne({ $set: { balance: 0 } }).exec();
-}
-
-export default async function processGroups () {
-  const guildFields = {
-    _id: 1,
-    balance: 1,
-    leader: 1,
-    name: 1,
-    purchased: 1,
-  };
-
-  while (true) { // eslint-disable-line no-constant-condition
-    const foundGroups = await Group // eslint-disable-line no-await-in-loop
-      .find(guildsQuery)
-      .limit(guildsPerRun)
-      .sort({ _id: 1 })
-      .select(guildFields)
-      .exec();
-
-    if (foundGroups.length === 0) {
-      console.warn('All appropriate Guilds found and modified.');
-      console.warn(`\n${count} Guilds processed\n`);
-      break;
-    } else {
-      guildsQuery._id = {
-        $gt: foundGroups[foundGroups.length - 1],
-      };
-    }
-
-    await Promise.all(foundGroups.map(guild => updateGroup(guild))); // eslint-disable-line no-await-in-loop
-  }
-};

migrations/archive/2023/20230808_guild_gems_fix.js

@@ -1,62 +0,0 @@
-/* eslint-disable no-console */
-import { model as User } from '../../../website/server/models/user';
-import { TransactionModel as Transaction } from '../../../website/server/models/transaction';
-
-const transactionsPerRun = 500;
-const progressCount = 1000;
-const transactionsQuery = {
-  transactionType: 'create_guild',
-  amount: { $gt: 0 },
-};
-
-let count = 0;
-async function updateTransaction (transaction) {
-  count++;
-  if (count % progressCount === 0) {
-    console.warn(`${count} ${transaction._id}`);
-  }
-
-  const leader = await User
-    .findOne({ _id: transaction.userId })
-    .select({ _id: true })
-    .exec();
-
-  if (!leader) {
-    return console.warn(`User not found for transaction ${transaction._id}`);
-  }
-
-  return leader.updateOne(
-    { $inc: { balance: transaction.amount }},
-  ).exec();
-}
-
-export default async function processTransactions () {
-  const transactionFields = {
-    _id: 1,
-    userId: 1,
-    currency: 1,
-    amount: 1,
-  };
-
-  while (true) { // eslint-disable-line no-constant-condition
-    const foundTransactions = await Transaction // eslint-disable-line no-await-in-loop
-      .find(transactionsQuery)
-      .limit(transactionsPerRun)
-      .sort({ _id: 1 })
-      .select(transactionFields)
-      .lean()
-      .exec();
-
-    if (foundTransactions.length === 0) {
-      console.warn('All appropriate transactions found and modified.');
-      console.warn(`\n${count} transactions processed\n`);
-      break;
-    } else {
-      transactionsQuery._id = {
-        $gt: foundTransactions[foundTransactions.length - 1],
-      };
-    }
-
-    await Promise.all(foundTransactions.map(txn => updateTransaction(txn))); // eslint-disable-line no-await-in-loop
-  }
-};

migrations/archive/2023/20230808_veteran_pet_ladder.js

@@ -1,144 +0,0 @@
-/* eslint-disable no-console */
-const MIGRATION_NAME = '20230808_veteran_pet_ladder';
-import { model as User } from '../../../website/server/models/user';
-
-const progressCount = 1000;
-let count = 0;
-
-async function updateUser (user) {
-  count++;
-
-  const set = {};
-  let push = { notifications: { $each: [] }};
-
-  set.migration = MIGRATION_NAME;
-  if (user.items.pets['Fox-Veteran']) {
-    set['items.pets.Dragon-Veteran'] = 5;
-    push.notifications.$each.push({
-      type: 'ITEM_RECEIVED',
-      data: {
-        icon: 'icon_pet_veteran_dragon',
-        title: 'You’ve received a Veteran Pet!',
-        text: 'To commemorate being here for a new era of Habitica, we’ve awarded you a Veteran Dragon.',
-        destination: '/inventory/stable',
-      },
-      seen: false,
-    });
-  } else if (user.items.pets['Bear-Veteran']) {
-    set['items.pets.Fox-Veteran'] = 5;
-    push.notifications.$each.push({
-      type: 'ITEM_RECEIVED',
-      data: {
-        icon: 'icon_pet_veteran_fox',
-        title: 'You’ve received a Veteran Pet!',
-        text: 'To commemorate being here for a new era of Habitica, we’ve awarded you a Veteran Fox.',
-        destination: '/inventory/stable',
-      },
-      seen: false,
-    });
-  } else if (user.items.pets['Lion-Veteran']) {
-    set['items.pets.Bear-Veteran'] = 5;
-    push.notifications.$each.push({
-      type: 'ITEM_RECEIVED',
-      data: {
-        icon: 'icon_pet_veteran_bear',
-        title: 'You’ve received a Veteran Pet!',
-        text: 'To commemorate being here for a new era of Habitica, we’ve awarded you a Veteran Bear.',
-        destination: '/inventory/stable',
-      },
-      seen: false,
-    });
-  } else if (user.items.pets['Tiger-Veteran']) {
-    set['items.pets.Lion-Veteran'] = 5;
-    push.notifications.$each.push({
-      type: 'ITEM_RECEIVED',
-      data: {
-        icon: 'icon_pet_veteran_lion',
-        title: 'You’ve received a Veteran Pet!',
-        text: 'To commemorate being here for a new era of Habitica, we’ve awarded you a Veteran Lion.',
-        destination: '/inventory/stable',
-      },
-      seen: false,
-    });
-  } else if (user.items.pets['Wolf-Veteran']) {
-    set['items.pets.Tiger-Veteran'] = 5;
-    push.notifications.$each.push({
-      type: 'ITEM_RECEIVED',
-      data: {
-        icon: 'icon_pet_veteran_tiger',
-        title: 'You’ve received a Veteran Pet!',
-        text: 'To commemorate being here for a new era of Habitica, we’ve awarded you a Veteran Tiger.',
-        destination: '/inventory/stable',
-      },
-      seen: false,
-    });
-  } else {
-    set['items.pets.Wolf-Veteran'] = 5;
-    push.notifications.$each.push({
-      type: 'ITEM_RECEIVED',
-      data: {
-        icon: 'icon_pet_veteran_wolf',
-        title: 'You’ve received a Veteran Pet!',
-        text: 'To commemorate being here for a new era of Habitica, we’ve awarded you a Veteran Wolf.',
-        destination: '/inventory/stable',
-      },
-      seen: false,
-    });
-  }
-
-  if (user.contributor.level > 0) {
-    set['items.gear.owned.armor_special_heroicTunic'] = true;
-    set['items.gear.owned.back_special_heroicAureole'] = true;
-    set['items.gear.owned.headAccessory_special_heroicCirclet'] = true;
-    push.notifications.$each.push({
-      type: 'ITEM_RECEIVED',
-      data: {
-        icon: 'heroic_set_icon',
-        title: 'You’ve received the Heroic Set!',
-        text: 'To commemorate your hard work as a contributor, we’ve awarded you the Heroic Circlet, Heroic Aureole, and Heroic Tunic.',
-        destination: '/inventory/equipment',
-      },
-      seen: false,
-    });
-  }
-
-  if (count % progressCount === 0) console.warn(`${count} ${user._id}`);
-
-  return await User.update({_id: user._id}, {$set: set, $push: push}).exec();
-}
-
-export default async function processUsers () {
-  let query = {
-    migration: {$ne: MIGRATION_NAME},
-    'auth.timestamps.loggedin': { $gt: new Date('2023-07-08') },
-  };
-
-  const fields = {
-    _id: 1,
-    items: 1,
-    migration: 1,
-    contributor: 1,
-  };
-
-  while (true) { // eslint-disable-line no-constant-condition
-    const users = await User // eslint-disable-line no-await-in-loop
-      .find(query)
-      .limit(250)
-      .sort({_id: 1})
-      .select(fields)
-      .lean()
-      .exec();
-
-    if (users.length === 0) {
-      console.warn('All appropriate users found and modified.');
-      console.warn(`\n${count} users processed\n`);
-      break;
-    } else {
-      query._id = {
-        $gt: users[users.length - 1],
-      };
-    }
-
-    await Promise.all(users.map(updateUser)); // eslint-disable-line no-await-in-loop
-  }
-};

migrations/archive/2023/20231017_pet_group_achievements.js

@@ -1,118 +0,0 @@
-/* eslint-disable no-console */
-const MIGRATION_NAME = '20231017_pet_group_achievements';
-import { model as User } from '../../../website/server/models/user';
-
-const progressCount = 1000;
-let count = 0;
-
-async function updateUser (user) {
-  count++;
-
-  const set = {
-    migration: MIGRATION_NAME,
-  };
-
-  if (user && user.items && user.items.pets) {
-    const pets = user.items.pets;
-    if (pets['Armadillo-Base']
-      && pets['Armadillo-CottonCandyBlue']
-      && pets['Armadillo-CottonCandyPink']
-      && pets['Armadillo-Desert']
-      && pets['Armadillo-Golden']
-      && pets['Armadillo-Red']
-      && pets['Armadillo-Shade']
-      && pets['Armadillo-Skeleton']
-      && pets['Armadillo-White']
-      && pets['Armadillo-Zombie']
-      && pets['Cactus-Base']
-      && pets['Cactus-CottonCandyBlue']
-      && pets['Cactus-CottonCandyPink']
-      && pets['Cactus-Desert']
-      && pets['Cactus-Golden']
-      && pets['Cactus-Red']
-      && pets['Cactus-Shade']
-      && pets['Cactus-Skeleton']
-      && pets['Cactus-White']
-      && pets['Cactus-Zombie']
-      && pets['Fox-Base']
-      && pets['Fox-CottonCandyBlue']
-      && pets['Fox-CottonCandyPink']
-      && pets['Fox-Desert']
-      && pets['Fox-Golden']
-      && pets['Fox-Red']
-      && pets['Fox-Shade']
-      && pets['Fox-Skeleton']
-      && pets['Fox-White']
-      && pets['Fox-Zombie']
-      && pets['Frog-Base']
-      && pets['Frog-CottonCandyBlue']
-      && pets['Frog-CottonCandyPink']
-      && pets['Frog-Desert']
-      && pets['Frog-Golden']
-      && pets['Frog-Red']
-      && pets['Frog-Shade']
-      && pets['Frog-Skeleton']
-      && pets['Frog-White']
-      && pets['Frog-Zombie']
-      && pets['Snake-Base']
-      && pets['Snake-CottonCandyBlue']
-      && pets['Snake-CottonCandyPink']
-      && pets['Snake-Desert']
-      && pets['Snake-Golden']
-      && pets['Snake-Red']
-      && pets['Snake-Shade']
-      && pets['Snake-Skeleton']
-      && pets['Snake-White']
-      && pets['Snake-Zombie']
-      && pets['Spider-Base']
-      && pets['Spider-CottonCandyBlue']
-      && pets['Spider-CottonCandyPink']
-      && pets['Spider-Desert']
-      && pets['Spider-Golden']
-      && pets['Spider-Red']
-      && pets['Spider-Shade']
-      && pets['Spider-Skeleton']
-      && pets['Spider-White']
-      && pets['Spider-Zombie']) {
-        set['achievements.duneBuddy'] = true;
-      }
-  }
-
-  if (count % progressCount === 0) console.warn(`${count} ${user._id}`);
-
-  return await User.updateOne({ _id: user._id }, { $set: set }).exec();
-}
-
-export default async function processUsers () {
-  let query = {
-    migration: { $ne: MIGRATION_NAME },
-    'auth.timestamps.loggedin': { $gt: new Date('2023-09-16') },
-  };
-
-  const fields = {
-    _id: 1,
-    items: 1,
-  };
-
-  while (true) { // eslint-disable-line no-constant-condition
-    const users = await User // eslint-disable-line no-await-in-loop
-      .find(query)
-      .limit(250)
-      .sort({_id: 1})
-      .select(fields)
-      .lean()
-      .exec();
-
-    if (users.length === 0) {
-      console.warn('All appropriate users found and modified.');
-      console.warn(`\n${count} users processed\n`);
-      break;
-    } else {
-      query._id = {
-        $gt: users[users.length - 1]._id,
-      };
-    }
-
-    await Promise.all(users.map(updateUser)); // eslint-disable-line no-await-in-loop
-  }
-};

migrations/archive/2023/20231114_pet_group_achievements.js

@@ -1,124 +0,0 @@
-/* eslint-disable no-console */
-const MIGRATION_NAME = '20231114_pet_group_achievements';
-import { model as User } from '../../../website/server/models/user';
-
-const progressCount = 1000;
-let count = 0;
-
-async function updateUser (user) {
-  count++;
-
-  let set = {
-    migration: MIGRATION_NAME,
-  };
-
-  if (user && user.items && user.items.pets) {
-    const pets = user.items.pets;
-    if (pets['Cactus-Zombie'] > 0
-      && pets['Cactus-Skeleton'] > 0
-      && pets['Cactus-Base'] > 0
-      && pets['Cactus-Desert'] > 0
-      && pets['Cactus-Red'] > 0
-      && pets['Cactus-Shade'] > 0
-      && pets['Cactus-White']> 0
-      && pets['Cactus-Golden'] > 0
-      && pets['Cactus-CottonCandyBlue'] > 0
-      && pets['Cactus-CottonCandyPink'] > 0
-      && pets['Hedgehog-Zombie'] > 0
-      && pets['Hedgehog-Skeleton'] > 0
-      && pets['Hedgehog-Base'] > 0
-      && pets['Hedgehog-Desert'] > 0
-      && pets['Hedgehog-Red'] > 0
-      && pets['Hedgehog-Shade'] > 0
-      && pets['Hedgehog-White'] > 0
-      && pets['Hedgehog-Golder'] > 0
-      && pets['Hedgehog-CottonCandyBlue'] > 0
-      && pets['Hedgehog-CottonCandyPink'] > 0
-      && pets['Rock-Zombie'] > 0
-      && pets['Rock-Skeleton'] > 0
-      && pets['Rock-Base'] > 0
-      && pets['Rock-Desert'] > 0
-      && pets['Rock-Red'] > 0
-      && pets['Rock-Shade'] > 0
-      && pets['Rock-White'] > 0
-      && pets['Rock-Golden'] > 0
-      && pets['Rock-CottonCandyBlue'] > 0
-      && pets['Rock-CottonCandyPink'] > 0 ) {
-        set['achievements.roughRider'] = true;
-      }
-  }
-
-  if (user && user.items && user.items.mounts) {
-    const mounts = user.items.mounts;
-    if (mounts['Cactus-Zombie']
-      && mounts['Cactus-Skeleton']
-      && mounts['Cactus-Base']
-      && mounts['Cactus-Desert']
-      && mounts['Cactus-Red']
-      && mounts['Cactus-Shade']
-      && mounts['Cactus-White']
-      && mounts['Cactus-Golden']
-      && mounts['Cactus-CottonCandyPink']
-      && mounts['Cactus-CottonCandyBlue']
-      && mounts['Hedgehog-Zombie']
-      && mounts['Hedgehog-Skeleton']
-      && mounts['Hedgehog-Base']
-      && mounts['Hedgehog-Desert']
-      && mounts['Hedgehog-Red']
-      && mounts['Hedgehog-Shade']
-      && mounts['Hedgehog-White']
-      && mounts['Hedgehog-Golden']
-      && mounts['Hedgehog-CottonCandyPink']
-      && mounts['Hedgehog-CottonCandyBlue']
-      && mounts['Rock-Zombie']
-      && mounts['Rock-Skeleton']
-      && mounts['Rock-Base']
-      && mounts['Rock-Desert']
-      && mounts['Rock-Red']
-      && mounts['Rock-Shade']
-      && mounts['Rock-White']
-      && mounts['Rock-Golden']
-      && mounts['Rock-CottonCandyPink']
-      && mounts['Rock-CottonCandyBlue'] ) {
-        set['achievements.roughRider'] = true;
-      }
-  }
-
-  if (count % progressCount === 0) console.warn(`${count} ${user._id}`);
-
-  return await User.update({ _id: user._id }, { $set: set }).exec();
-}
-
-module.exports = async function processUsers () {
-  let query = {
-    migration: { $ne: MIGRATION_NAME },
-    'auth.timestamps.loggedin': { $gt: new Date('2023-02-01') },
-  };
-
-  const fields = {
-    _id: 1,
-    items: 1,
-  };
-
-  while (true) { // eslint-disable-line no-constant-condition
-    const users = await User // eslint-disable-line no-await-in-loop
-      .find(query)
-      .limit(250)
-      .sort({_id: 1})
-      .select(fields)
-      .lean()
-      .exec();
-
-    if (users.length === 0) {
-      console.warn('All appropriate users found and modified.');
-      console.warn(`\n${count} users processed\n`);
-      break;
-    } else {
-      query._id = {
-        $gt: users[users.length - 1]._id,
-      };
-    }
-
-    await Promise.all(users.map(updateUser)); // eslint-disable-line no-await-in-loop
-  }
-};

migrations/archive/2023/20231228_nye.js

@@ -1,87 +0,0 @@
-/* eslint-disable no-console */
-const MIGRATION_NAME = '20231228_nye';
-import { model as User } from '../../../website/server/models/user';
-import { v4 as uuid } from 'uuid';
-
-const progressCount = 1000;
-let count = 0;
-
-async function updateUser (user) {
-  count++;
-
-  const set = { migration: MIGRATION_NAME };
-  let push = {};
-
-  if (typeof user.items.gear.owned.head_special_nye2022 !== 'undefined') {
-    set['items.gear.owned.head_special_nye2023'] = true;
-  } else if (typeof user.items.gear.owned.head_special_nye2021 !== 'undefined') {
-    set['items.gear.owned.head_special_nye2022'] = true;
-  } else if (typeof user.items.gear.owned.head_special_nye2020 !== 'undefined') {
-    set['items.gear.owned.head_special_nye2021'] = true;
-  } else if (typeof user.items.gear.owned.head_special_nye2019 !== 'undefined') {
-    set['items.gear.owned.head_special_nye2020'] = true;
-  } else if (typeof user.items.gear.owned.head_special_nye2018 !== 'undefined') {
-    set['items.gear.owned.head_special_nye2019'] = true;
-  } else if (typeof user.items.gear.owned.head_special_nye2017 !== 'undefined') {
-    set['items.gear.owned.head_special_nye2018'] = true;
-  } else if (typeof user.items.gear.owned.head_special_nye2016 !== 'undefined') {
-    set['items.gear.owned.head_special_nye2017'] = true;
-  } else if (typeof user.items.gear.owned.head_special_nye2015 !== 'undefined') {
-    set['items.gear.owned.head_special_nye2016'] = true;
-  } else if (typeof user.items.gear.owned.head_special_nye2014 !== 'undefined') {
-    set['items.gear.owned.head_special_nye2015'] = true;
-  } else if (typeof user.items.gear.owned.head_special_nye !== 'undefined') {
-    set['items.gear.owned.head_special_nye2014'] = true;
-  } else {
-    set['items.gear.owned.head_special_nye'] = true;
-  }
-
-  push.notifications = {
-    type: 'ITEM_RECEIVED',
-    data: {
-      icon: 'notif_head_special_nye',
-      title: 'Happy New Year!',
-      text: 'Check your Equipment for this year\'s party hat!',
-      destination: 'inventory/equipment',
-    },
-    seen: false,
-  };
-
-  if (count % progressCount === 0) console.warn(`${count} ${user._id}`);
-
-  return await User.updateOne({_id: user._id}, {$set: set, $push: push}).exec();
-}
-
-export default async function processUsers () {
-  let query = {
-    'auth.timestamps.loggedin': { $gt: new Date('2023-12-01') },
-    migration: { $ne: MIGRATION_NAME },
-  };
-
-  const fields = {
-    _id: 1,
-    items: 1,
-  };
-
-  while (true) { // eslint-disable-line no-constant-condition
-    const users = await User // eslint-disable-line no-await-in-loop
-      .find(query)
-      .limit(250)
-      .sort({_id: 1})
-      .select(fields)
-      .lean()
-      .exec();
-
-    if (users.length === 0) {
-      console.warn('All appropriate users found and modified.');
-      console.warn(`\n${count} users processed\n`);
-      break;
-    } else {
-      query._id = {
-        $gt: users[users.length - 1],
-      };
-    }
-
-    await Promise.all(users.map(updateUser)); // eslint-disable-line no-await-in-loop
-  }
-};

migrations/archive/2024/20240131_habit_birthday.js

@@ -1,102 +0,0 @@
-/* eslint-disable no-console */
-import { v4 as uuid } from 'uuid';
-import { model as User } from '../../../website/server/models/user';
-
-const MIGRATION_NAME = '20240131_habit_birthday';
-const progressCount = 1000;
-let count = 0;
-
-async function updateUser (user) {
-  count += 1;
-
-   const inc = {
-    'items.food.Cake_Skeleton': 1,
-    'items.food.Cake_Base': 1,
-    'items.food.Cake_CottonCandyBlue': 1,
-    'items.food.Cake_CottonCandyPink': 1,
-    'items.food.Cake_Shade': 1,
-    'items.food.Cake_White': 1,
-    'items.food.Cake_Golden': 1,
-    'items.food.Cake_Zombie': 1,
-    'items.food.Cake_Desert': 1,
-    'items.food.Cake_Red': 1,
-    'achievements.habitBirthdays': 1,
-  };
-  const set = {};
-  const push = {
-    notifications: {
-      type: 'ITEM_RECEIVED',
-      data: {
-        icon: 'notif_namingDay_cake',
-        title: 'Happy Habit Birthday!',
-        text: 'Habitica turns 11 today! Enjoy free party robes and cake!',
-        destination: 'inventory/equipment',
-      },
-      seen: false,
-    },
-  };
-
-  set.migration = MIGRATION_NAME;
-
-  if (typeof user.items.gear.owned.armor_special_birthday2023 !== 'undefined') {
-    set['items.gear.owned.armor_special_birthday2024'] = true;
-  } else if (typeof user.items.gear.owned.armor_special_birthday2022 !== 'undefined') {
-    set['items.gear.owned.armor_special_birthday2023'] = true;
-  } else if (typeof user.items.gear.owned.armor_special_birthday2021 !== 'undefined') {
-    set['items.gear.owned.armor_special_birthday2022'] = true;
-  } else if (typeof user.items.gear.owned.armor_special_birthday2020 !== 'undefined') {
-    set['items.gear.owned.armor_special_birthday2021'] = true;
-  } else if (typeof user.items.gear.owned.armor_special_birthday2019 !== 'undefined') {
-    set['items.gear.owned.armor_special_birthday2020'] = true;
-  } else if (typeof user.items.gear.owned.armor_special_birthday2018 !== 'undefined') {
-    set['items.gear.owned.armor_special_birthday2019'] = true;
-  } else if (typeof user.items.gear.owned.armor_special_birthday2017 !== 'undefined') {
-    set['items.gear.owned.armor_special_birthday2018'] = true;
-  } else if (typeof user.items.gear.owned.armor_special_birthday2016 !== 'undefined') {
-    set['items.gear.owned.armor_special_birthday2017'] = true;
-  } else if (typeof user.items.gear.owned.armor_special_birthday2015 !== 'undefined') {
-    set['items.gear.owned.armor_special_birthday2016'] = true;
-  } else if (typeof user.items.gear.owned.armor_special_birthday !== 'undefined') {
-    set['items.gear.owned.armor_special_birthday2015'] = true;
-  } else {
-    set['items.gear.owned.armor_special_birthday'] = true;
-  }
-
-  if (count % progressCount === 0) console.warn(`${count} ${user._id}`);
-
-  return await User.updateOne({_id: user._id}, {$inc: inc, $set: set, $push: push}).exec();
-}
-
-export default async function processUsers () {
-  let query = {
-    migration: {$ne: MIGRATION_NAME},
-    'auth.timestamps.loggedin': {$gt: new Date('2023-12-23')},
-  };
-
-  const fields = {
-    _id: 1,
-    items: 1,
-  };
-
-  while (true) { // eslint-disable-line no-constant-condition
-    const users = await User // eslint-disable-line no-await-in-loop
-      .find(query)
-      .limit(250)
-      .sort({_id: 1})
-      .select(fields)
-      .lean()
-      .exec();
-
-    if (users.length === 0) {
-      console.warn('All appropriate users found and modified.');
-      console.warn(`\n${count} users processed\n`);
-      break;
-    } else {
-      query._id = {
-        $gt: users[users.length - 1],
-      };
-    }
-
-    await Promise.all(users.map(updateUser)); // eslint-disable-line no-await-in-loop
-  }
-};

migrations/archive/2024/20240318_pet_group_achievements.js

@@ -1,89 +0,0 @@
-/* eslint-disable no-console */
-const MIGRATION_NAME = '202403_pet_group_achievements';
-import { model as User } from '../../../website/server/models/user';
-
-const progressCount = 1000;
-let count = 0;
-
-async function updateUser (user) {
-  count++;
-
-  let set = {
-    migration: MIGRATION_NAME,
-  };
-
-  if (user && user.items && user.items.pets) {
-    const pets = user.items.pets;
-    if (pets['GuineaPig-Zombie'] > 0
-      && pets['GuineaPig-Skeleton'] > 0
-      && pets['GuineaPig-Base'] > 0
-      && pets['GuineaPig-Desert'] > 0
-      && pets['GuineaPig-Red'] > 0
-      && pets['GuineaPig-Shade'] > 0
-      && pets['GuineaPig-White']> 0
-      && pets['GuineaPig-Golden'] > 0
-      && pets['GuineaPig-CottonCandyBlue'] > 0
-      && pets['GuineaPig-CottonCandyPink'] > 0
-      && pets['Squirrel-Zombie'] > 0
-      && pets['Squirrel-Skeleton'] > 0
-      && pets['Squirrel-Base'] > 0
-      && pets['Squirrel-Desert'] > 0
-      && pets['Squirrel-Red'] > 0
-      && pets['Squirrel-Shade'] > 0
-      && pets['Squirrel-White'] > 0
-      && pets['Squirrel-Golden'] > 0
-      && pets['Squirrel-CottonCandyBlue'] > 0
-      && pets['Squirrel-CottonCandyPink'] > 0
-      && pets['Rat-Zombie'] > 0
-      && pets['Rat-Skeleton'] > 0
-      && pets['Rat-Base'] > 0
-      && pets['Rat-Desert'] > 0
-      && pets['Rat-Red'] > 0
-      && pets['Rat-Shade'] > 0
-      && pets['Rat-White'] > 0
-      && pets['Rat-Golden'] > 0
-      && pets['Rat-CottonCandyBlue'] > 0
-      && pets['Rat-CottonCandyPink'] > 0 ) {
-        set['achievements.rodentRuler'] = true;
-      
-    }
-  }
-
-  if (count % progressCount === 0) console.warn(`${count} ${user._id}`);
-
-  return await User.updateOne({ _id: user._id }, { $set: set }).exec();
-}
-
-export default async function processUsers () {
-  let query = {
-    migration: { $ne: MIGRATION_NAME },
-    'auth.timestamps.loggedin': { $gt: new Date('2024-02-01') },
-  };
-
-  const fields = {
-    _id: 1,
-    items: 1,
-  };
-
-  while (true) { // eslint-disable-line no-constant-condition
-    const users = await User // eslint-disable-line no-await-in-loop
-      .find(query)
-      .limit(250)
-      .sort({_id: 1})
-      .select(fields)
-      .lean()
-      .exec();
-
-    if (users.length === 0) {
-      console.warn('All appropriate users found and modified.');
-      console.warn(`\n${count} users processed\n`);
-      break;
-    } else {
-      query._id = {
-        $gt: users[users.length - 1]._id,
-      };
-    }
-
-    await Promise.all(users.map(updateUser)); // eslint-disable-line no-await-in-loop
-  }
-};

migrations/archive/2024/20240516_pet_group_achievements.js

@@ -1,99 +0,0 @@
-/* eslint-disable no-console */
-const MIGRATION_NAME = '202405_pet_group_achievements';
-import { model as User } from '../../../website/server/models/user';
-
-const progressCount = 1000;
-let count = 0;
-
-async function updateUser (user) {
-  count++;
-
-  let set = {
-    migration: MIGRATION_NAME,
-  };
-
-  if (user && user.items && user.items.pets) {
-    const pets = user.items.pets;
-    if (pets['LionCub-Zombie'] > 0
-      && pets['LionCub-Skeleton'] > 0
-      && pets['LionCub-Base'] > 0
-      && pets['LionCub-Desert'] > 0
-      && pets['LionCub-Red'] > 0
-      && pets['LionCub-Shade'] > 0
-      && pets['LionCub-White']> 0
-      && pets['LionCub-Golden'] > 0
-      && pets['LionCub-CottonCandyBlue'] > 0
-      && pets['LionCub-CottonCandyPink'] > 0
-      && pets['TigerCub-Zombie'] > 0
-      && pets['TigerCub-Skeleton'] > 0
-      && pets['TigerCub-Base'] > 0
-      && pets['TigerCub-Desert'] > 0
-      && pets['TigerCub-Red'] > 0
-      && pets['TigerCub-Shade'] > 0
-      && pets['TigerCub-White'] > 0
-      && pets['TigerCub-Golden'] > 0
-      && pets['TigerCub-CottonCandyBlue'] > 0
-      && pets['TigerCub-CottonCandyPink'] > 0
-      && pets['Sabretooth-Zombie'] > 0
-      && pets['Sabretooth-Skeleton'] > 0
-      && pets['Sabretooth-Base'] > 0
-      && pets['Sabretooth-Desert'] > 0
-      && pets['Sabretooth-Red'] > 0
-      && pets['Sabretooth-Shade'] > 0
-      && pets['Sabretooth-White'] > 0
-      && pets['Sabretooth-Golden'] > 0
-      && pets['Sabretooth-CottonCandyBlue'] > 0
-      && pets['Sabretooth-CottonCandyPink'] > 0 
-      && pets['Cheetah-Zombie'] > 0
-      && pets['Cheetah-Skeleton'] > 0
-      && pets['Cheetah-Base'] > 0
-      && pets['Cheetah-Desert'] > 0
-      && pets['Cheetah-Red'] > 0
-      && pets['Cheetah-Shade'] > 0
-      && pets['Cheetah-White'] > 0
-      && pets['Cheetah-Golden'] > 0
-      && pets['Cheetah-CottonCandyBlue'] > 0
-      && pets['Cheetah-CottonCandyPink'] > 0 ) {
-        set['achievements.cats'] = true;
-      
-    }
-  }
-
-  if (count % progressCount === 0) console.warn(`${count} ${user._id}`);
-
-  return await User.updateOne({ _id: user._id }, { $set: set }).exec();
-}
-
-export default async function processUsers () {
-  let query = {
-    migration: { $ne: MIGRATION_NAME },
-    'auth.timestamps.loggedin': { $gt: new Date('2024-03-01') },
-  };
-
-  const fields = {
-    _id: 1,
-    items: 1,
-  };
-
-  while (true) { // eslint-disable-line no-constant-condition
-    const users = await User // eslint-disable-line no-await-in-loop
-      .find(query)
-      .limit(250)
-      .sort({_id: 1})
-      .select(fields)
-      .lean()
-      .exec();
-
-    if (users.length === 0) {
-      console.warn('All appropriate users found and modified.');
-      console.warn(`\n${count} users processed\n`);
-      break;
-    } else {
-      query._id = {
-        $gt: users[users.length - 1]._id,
-      };
-    }
-
-    await Promise.all(users.map(updateUser)); // eslint-disable-line no-await-in-loop
-  }
-};

migrations/archive/2024/20240621_veteran_pets.js

@@ -1,149 +0,0 @@
-/* eslint-disable no-console */
-const MIGRATION_NAME = '20240621_veteran_pet_ladder';
-import { model as User } from '../../../website/server/models/user';
-
-const progressCount = 1000;
-let count = 0;
-
-async function updateUser (user) {
-  count++;
-
-  const set = {};
-  let push = { notifications: { $each: [] }};
-
-  set.migration = MIGRATION_NAME;
-  if (user.items.pets['Dragon-Veteran']) {
-    set['items.pets.Cactus-Veteran'] = 5;
-    push.notifications.$each.push({
-      type: 'ITEM_RECEIVED',
-      data: {
-        icon: 'icon_pet_veteran_cactus',
-        title: 'You’ve received a Veteran Pet!',
-        text: 'To commemorate being here for a new era of Habitica, we’ve awarded you a Veteran Cactus and 24 Gems!',
-        destination: '/inventory/stable',
-      },
-      seen: false,
-    });
-  } else if (user.items.pets['Fox-Veteran']) {
-    set['items.pets.Dragon-Veteran'] = 5;
-    push.notifications.$each.push({
-      type: 'ITEM_RECEIVED',
-      data: {
-        icon: 'icon_pet_veteran_dragon',
-        title: 'You’ve received a Veteran Pet!',
-        text: 'To commemorate being here for a new era of Habitica, we’ve awarded you a Veteran Dragon and 24 Gems!',
-        destination: '/inventory/stable',
-      },
-      seen: false,
-    });
-  } else if (user.items.pets['Bear-Veteran']) {
-    set['items.pets.Fox-Veteran'] = 5;
-    push.notifications.$each.push({
-      type: 'ITEM_RECEIVED',
-      data: {
-        icon: 'icon_pet_veteran_fox',
-        title: 'You’ve received a Veteran Pet!',
-        text: 'To commemorate being here for a new era of Habitica, we’ve awarded you a Veteran Fox and 24 Gems!',
-        destination: '/inventory/stable',
-      },
-      seen: false,
-    });
-  } else if (user.items.pets['Lion-Veteran']) {
-    set['items.pets.Bear-Veteran'] = 5;
-    push.notifications.$each.push({
-      type: 'ITEM_RECEIVED',
-      data: {
-        icon: 'icon_pet_veteran_bear',
-        title: 'You’ve received a Veteran Pet!',
-        text: 'To commemorate being here for a new era of Habitica, we’ve awarded you a Veteran Bear and 24 Gems!',
-        destination: '/inventory/stable',
-      },
-      seen: false,
-    });
-  } else if (user.items.pets['Tiger-Veteran']) {
-    set['items.pets.Lion-Veteran'] = 5;
-    push.notifications.$each.push({
-      type: 'ITEM_RECEIVED',
-      data: {
-        icon: 'icon_pet_veteran_lion',
-        title: 'You’ve received a Veteran Pet!',
-        text: 'To commemorate being here for a new era of Habitica, we’ve awarded you a Veteran Lion and 24 Gems!',
-        destination: '/inventory/stable',
-      },
-      seen: false,
-    });
-  } else if (user.items.pets['Wolf-Veteran']) {
-    set['items.pets.Tiger-Veteran'] = 5;
-    push.notifications.$each.push({
-      type: 'ITEM_RECEIVED',
-      data: {
-        icon: 'icon_pet_veteran_tiger',
-        title: 'You’ve received a Veteran Pet!',
-        text: 'To commemorate being here for a new era of Habitica, we’ve awarded you a Veteran Tiger and 24 Gems!',
-        destination: '/inventory/stable',
-      },
-      seen: false,
-    });
-  } else {
-    set['items.pets.Wolf-Veteran'] = 5;
-    push.notifications.$each.push({
-      type: 'ITEM_RECEIVED',
-      data: {
-        icon: 'icon_pet_veteran_wolf',
-        title: 'You’ve received a Veteran Pet!',
-        text: 'To commemorate being here for a new era of Habitica, we’ve awarded you a Veteran Wolf and 24 Gems!',
-        destination: '/inventory/stable',
-      },
-      seen: false,
-    });
-  }
-
-  if (count % progressCount === 0) console.warn(`${count} ${user._id}`);
-
-  await user.updateBalance(
-    6,
-    'admin_update_balance',
-    '',
-    'Veteran Ladder award',
-  );
-
-  return await User.updateOne(
-    { _id: user._id },
-    { $set: set, $push: push, $inc: { balance: 6 } },
-  ).exec();
-}
-
-export default async function processUsers () {
-  let query = {
-    migration: {$ne: MIGRATION_NAME},
-    'auth.timestamps.loggedin': { $gt: new Date('2024-05-21') },
-  };
-
-  const fields = {
-    _id: 1,
-    items: 1,
-    migration: 1,
-    contributor: 1,
-  };
-
-  while (true) { // eslint-disable-line no-constant-condition
-    const users = await User // eslint-disable-line no-await-in-loop
-      .find(query)
-      .limit(250)
-      .sort({_id: 1})
-      .select(fields)
-      .exec();
-
-    if (users.length === 0) {
-      console.warn('All appropriate users found and modified.');
-      console.warn(`\n${count} users processed\n`);
-      break;
-    } else {
-      query._id = {
-        $gt: users[users.length - 1],
-      };
-    }
-
-    await Promise.all(users.map(updateUser)); // eslint-disable-line no-await-in-loop
-  }
-};

migrations/archive/2024/20240806_purge_invite_accepted.js

@@ -1,47 +0,0 @@
-/* eslint-disable no-console */
-import { model as User } from '../../../website/server/models/user';
-
-const MIGRATION_NAME = '2024_purge_invite_accepted';
-const progressCount = 1000;
-let count = 0;
-
-async function updateUsers (userIds) {
-  count += userIds.length;
-  if (count % progressCount === 0) console.warn(`${count} ${userIds[0]}`);
-
-  return await User.updateMany(
-    { _id: { $in: userIds } },
-    { $pull: { notifications: { type: 'GROUP_INVITE_ACCEPTED' } } },
-  ).exec();
-}
-
-export default async function processUsers () {
-  let query = {
-    migration: { $ne: MIGRATION_NAME },
-    'notifications.type': 'GROUP_INVITE_ACCEPTED',
-    'auth.timestamps.loggedin': { $gt: new Date('2024-06-25') },
-  };
-
-  while (true) { // eslint-disable-line no-constant-condition
-    const users = await User // eslint-disable-line no-await-in-loop
-      .find(query)
-      .limit(250)
-      .sort({ _id: 1 })
-      .select({ _id: 1 })
-      .exec();
-
-    if (users.length === 0) {
-      console.warn('All appropriate users found and modified.');
-      console.warn(`\n${count} users processed\n`);
-      break;
-    } else {
-      query._id = {
-        $gt: users[users.length - 1],
-      };
-    }
-
-    const userIds = users.map(user => user._id);
-
-    await updateUsers(userIds); // eslint-disable-line no-await-in-loop
-  }
-};

migrations/archive/2024/20241119_gem_caps_hourglasses.js

@@ -1,115 +0,0 @@
-/* eslint-disable no-console */
-const MIGRATION_NAME = '20241119_gem_caps_hourglasses';
-import { model as User } from '../../../website/server/models/user';
-
-const progressCount = 1000;
-let count = 0;
-
-async function updateUser (user) {
-  count += 1;
-  if (count % progressCount === 0) console.warn(`${count} ${user._id}`);
-
-  const { consecutive, customerId, dateTerminated, planId } = user.purchased.plan;
-  const isRecurring = customerId !== 'Gift' && !dateTerminated;
-  const updateOp = {
-    $set: {
-      migration: MIGRATION_NAME,
-      'purchased.plan.consecutive.gemCapExtra': Math.max(2 * Math.ceil((consecutive.gemCapExtra + 1) / 2, 26)),
-    },
-    $inc: {},
-  };
-
-  let hourglassBonus = 0;
-
-  if (isRecurring) {
-    await user.updateBalance(
-      5,
-      'admin_update_balance',
-      '',
-      'Subscription Reward Migration',
-    );
-    updateOp.$inc.balance = 5;
-    switch (planId) {
-      case 'basic':
-      case 'basic_earned':
-      case 'group_plan_auto':
-        hourglassBonus = 2;
-        break;
-      case 'basic_3mo':
-      case 'basic_6mo':
-      case 'google_6mo':
-        hourglassBonus = 4;
-        break;
-      case 'basic_12mo':
-        hourglassBonus = 12;
-        updateOp.$set['purchased.plan.hourglassPromoReceived'] = new Date();
-        break;
-      default:
-        hourglassBonus = 0;
-    }
-
-    if (hourglassBonus) {
-      updateOp.$inc['purchased.plan.consecutive.trinkets'] = hourglassBonus;
-      await user.updateHourglasses(
-        hourglassBonus,
-        'admin_update_balance',
-        '',
-        'Subscription Reward Migration',
-      );
-    }
-    updateOp.$push = {
-      notifications: {
-        type: 'ITEM_RECEIVED',
-        data: {
-          icon: 'notif_subscriber_reward',
-          title: 'Thanks for being a subscriber!',
-          text: 'Enjoy these extra Mystic Hourglasses and Gems to celebrate our new benefits.',
-        },
-        seen: false,
-      },
-    };
-  }
-
-  return await User.updateOne(
-    { _id: user._id },
-    updateOp,
-  ).exec();
-}
-
-export default async function processUsers () {
-  let query = {
-    migration: { $ne: MIGRATION_NAME },
-    'purchased.plan.customerId': { $exists: true },
-    $or: [
-      { 'purchased.plan.dateTerminated': { $exists: false } },
-      { 'purchased.plan.dateTerminated': null },
-      { 'purchased.plan.dateTerminated': { $gt: new Date() } },
-    ],
-  };
-
-  const fields = {
-    _id: 1,
-    purchased: 1,
-  };
-
-  while (true) { // eslint-disable-line no-constant-condition
-    const users = await User // eslint-disable-line no-await-in-loop
-      .find(query)
-      .limit(250)
-      .sort({_id: 1})
-      .select(fields)
-      .exec();
-
-    if (users.length === 0) {
-      console.warn('All appropriate users found and modified.');
-      console.warn(`\n${count} users processed\n`);
-      break;
-    } else {
-      query._id = {
-        $gt: users[users.length - 1],
-      };
-    }
-
-    await Promise.all(users.map(updateUser)); // eslint-disable-line no-await-in-loop
-  }
-};

migrations/archive/api_v3/groups.js

@@ -37,7 +37,7 @@ let consoleStamp = require('console-stamp');
 consoleStamp(console);
 
 // Initialize configuration
-require('../../website/server/libs/api-v3/setupNconf').default();
+require('../../website/server/libs/api-v3/setupNconf')();
 
 let MONGODB_OLD = nconf.get('MONGODB_OLD');
 let MONGODB_NEW = nconf.get('MONGODB_NEW');

migrations/archive/api_v3/users.js

@@ -32,7 +32,7 @@ let moment = require('moment');
 consoleStamp(console);
 
 // Initialize configuration
-require('../../website/server/libs/api-v3/setupNconf').default();
+require('../../website/server/libs/api-v3/setupNconf')();
 
 let MONGODB_OLD = nconf.get('MONGODB_OLD');
 let MONGODB_NEW = nconf.get('MONGODB_NEW');

migrations/archive/takeThis.js

@@ -0,0 +1,118 @@
+let migrationName = '20180904_takeThis.js'; // Update per month
+let authorName = 'Sabe'; // in case script author needs to know when their ...
+let authorUuid = '7f14ed62-5408-4e1b-be83-ada62d504931'; // ... own data is done
+
+/*
+ * Award Take This ladder items to participants in this month's challenge
+ */
+
+import monk from 'monk';
+import nconf from 'nconf';
+const CONNECTION_STRING = nconf.get('MIGRATION_CONNECT_STRING'); // FOR TEST DATABASE
+let dbUsers = monk(CONNECTION_STRING).get('users', { castIds: false });
+
+function processUsers (lastId) {
+  // specify a query to limit the affected users (empty for all users):
+  let query = {
+    migration: {$ne: migrationName},
+    challenges: {$in: ['1044ec0c-4a85-48c5-9f36-d51c0c62c7d3']}, // Update per month
+  };
+
+  if (lastId) {
+    query._id = {
+      $gt: lastId,
+    };
+  }
+
+  dbUsers.find(query, {
+    sort: {_id: 1},
+    limit: 250,
+    fields: [
+      'items.gear.owned',
+    ], // specify fields we are interested in to limit retrieved data (empty if we're not reading data):
+  })
+    .then(updateUsers)
+    .catch((err) => {
+      console.log(err);
+      return exiting(1, `ERROR! ${  err}`);
+    });
+}
+
+let progressCount = 1000;
+let count = 0;
+
+function updateUsers (users) {
+  if (!users || users.length === 0) {
+    console.warn('All appropriate users found and modified.');
+    displayData();
+    return;
+  }
+
+  let userPromises = users.map(updateUser);
+  let lastUser = users[users.length - 1];
+
+  return Promise.all(userPromises)
+    .then(() => {
+      processUsers(lastUser._id);
+    });
+}
+
+function updateUser (user) {
+  count++;
+
+  let set = {};
+  let push;
+
+  if (typeof user.items.gear.owned.back_special_takeThis !== 'undefined') {
+    set = {migration: migrationName};
+  } else if (typeof user.items.gear.owned.body_special_takeThis !== 'undefined') {
+    set = {migration: migrationName, 'items.gear.owned.back_special_takeThis': false};
+    push = {pinnedItems: {type: 'marketGear', path: 'gear.flat.back_special_takeThis', _id: monk.id()}};
+  } else if (typeof user.items.gear.owned.head_special_takeThis !== 'undefined') {
+    set = {migration: migrationName, 'items.gear.owned.body_special_takeThis': false};
+    push = {pinnedItems: {type: 'marketGear', path: 'gear.flat.body_special_takeThis', _id: monk.id()}};
+  } else if (typeof user.items.gear.owned.armor_special_takeThis !== 'undefined') {
+    set = {migration: migrationName, 'items.gear.owned.head_special_takeThis': false};
+    push = {pinnedItems: {type: 'marketGear', path: 'gear.flat.head_special_takeThis', _id: monk.id()}};
+  } else if (typeof user.items.gear.owned.weapon_special_takeThis !== 'undefined') {
+    set = {migration: migrationName, 'items.gear.owned.armor_special_takeThis': false};
+    push = {pinnedItems: {type: 'marketGear', path: 'gear.flat.armor_special_takeThis', _id: monk.id()}};
+  } else if (typeof user.items.gear.owned.shield_special_takeThis !== 'undefined') {
+    set = {migration: migrationName, 'items.gear.owned.weapon_special_takeThis': false};
+    push = {pinnedItems: {type: 'marketGear', path: 'gear.flat.weapon_special_takeThis', _id: monk.id()}};
+  } else {
+    set = {migration: migrationName, 'items.gear.owned.shield_special_takeThis': false};
+    push = {pinnedItems: {type: 'marketGear', path: 'gear.flat.shield_special_takeThis', _id: monk.id()}};
+  }
+
+  if (push) {
+    dbUsers.update({_id: user._id}, {$set: set, $push: push});
+  } else {
+    dbUsers.update({_id: user._id}, {$set: set});
+  }
+
+  if (count % progressCount === 0) console.warn(`${count  } ${  user._id}`);
+  if (user._id === authorUuid) console.warn(`${authorName  } processed`);
+}
+
+function displayData () {
+  console.warn(`\n${  count  } users processed\n`);
+  return exiting(0);
+}
+
+function exiting (code, msg) {
+  code = code || 0; // 0 = success
+  if (code && !msg) {
+    msg = 'ERROR!';
+  }
+  if (msg) {
+    if (code) {
+      console.error(msg);
+    } else      {
+      console.log(msg);
+    }
+  }
+  process.exit(code);
+}
+
+module.exports = processUsers;

migrations/csvexport.py

@@ -0,0 +1,10 @@
+import csv
+
+with open(r"/home/slappybag/Documents/SurveyScrape.csv") as f:
+     reader = csv.reader(f, delimiter=',', quotechar='"')
+     column = []
+     for row in reader:
+        if row:
+            column.append(row[4])
+
+print column

migrations/groups/habitrpg-jackalopes.js

@@ -21,14 +21,12 @@ async function handOutJackalopes () {
     if (user.party._id) groupList.push(user.party._id);
     groupList = groupList.concat(user.guilds);
 
-    const subscribedGroup = await Group.findOne(
-      {
-        _id: { $in: groupList },
-        'purchased.plan.planId': 'group_monthly',
-        'purchased.plan.dateTerminated': null,
-      },
-      { _id: 1 },
-    );
+    const subscribedGroup = await Group.findOne({
+      _id: { $in: groupList },
+      'purchased.plan.planId': 'group_monthly',
+      'purchased.plan.dateTerminated': null,
+    },
+    { _id: 1 });
 
     if (subscribedGroup) {
       User.update({ _id: user._id }, { $set: { 'items.mounts.Jackalope-RoyalPurple': true } }).exec();

migrations/migration-runner.js

@@ -6,11 +6,11 @@ require('@babel/register'); // eslint-disable-line import/no-extraneous-dependen
 function setUpServer () {
   const nconf = require('nconf'); // eslint-disable-line global-require, no-unused-vars
   const mongoose = require('mongoose'); // eslint-disable-line global-require, no-unused-vars
-  const setupNconf = require('../website/server/libs/setupNconf').default; // eslint-disable-line global-require
+  const setupNconf = require('../website/server/libs/setupNconf'); // eslint-disable-line global-require
 
   setupNconf();
 
-  // We require src/server and not src/index because
+  // We require src/server and npt src/index because
   // 1. nconf is already setup
   // 2. we don't need clustering
   require('../website/server/server'); // eslint-disable-line global-require

migrations/users/achievement-restore.js

@@ -51,8 +51,7 @@ function getAchievementUpdate (newUser, oldUser) {
   // Rebirth level
   if (achievementsUpdate.rebirthLevel) {
     achievementsUpdate.rebirthLevel = Math.max(
-      achievementsUpdate.rebirthLevel,
-      oldAchievements.rebirthLevel,
+      achievementsUpdate.rebirthLevel, oldAchievements.rebirthLevel,
     );
   } else if (oldAchievements.rebirthLevel) {
     achievementsUpdate.rebirthLevel = oldAchievements.rebirthLevel;

migrations/users/bulk-email.js

@@ -16,7 +16,6 @@ async function updateUser (user) {
 
   if (count % progressCount === 0) {
     console.warn(`${count} ${user._id}`);
-    // eslint-disable-next-line no-promise-executor-return
     await new Promise(resolve => setTimeout(resolve, 5000));
   }
 
@@ -26,7 +25,7 @@ async function updateUser (user) {
     [{ name: 'BASE_URL', content: BASE_URL }], // Add variables from template
   );
 
-  return User.updateOne({ _id: user._id }, { $set: { migration: MIGRATION_NAME } }).exec();
+  return User.update({ _id: user._id }, { $set: { migration: MIGRATION_NAME } }).exec();
 }
 
 export default async function processUsers () {

migrations/users/full-gear.js

@@ -11,7 +11,7 @@ const progressCount = 1000;
 let count = 0;
 
 /*
- * Award every extant piece of equippable gear
+ * Award users every extant pet and mount
  */
 
 async function updateUser (user) {
@@ -27,13 +27,13 @@ async function updateUser (user) {
 
   if (count % progressCount === 0) console.warn(`${count} ${user._id}`);
 
-  return User.updateOne({ _id: user._id }, { $set: set }).exec();
+  return User.update({ _id: user._id }, { $set: set }).exec();
 }
 
 export default async function processUsers () {
   const query = {
     migration: { $ne: MIGRATION_NAME },
-    'auth.local.username': 'ExampleHabitican',
+    'auth.local.lowerCaseUsername': 'olson1',
   };
 
   const fields = {

migrations/users/full-stable.js

@@ -51,13 +51,13 @@ async function updateUser (user) {
 
   if (count % progressCount === 0) console.warn(`${count} ${user._id}`);
 
-  return User.updateOne({ _id: user._id }, { $set: set }).exec();
+  return User.update({ _id: user._id }, { $set: set }).exec();
 }
 
 export default async function processUsers () {
   const query = {
     migration: { $ne: MIGRATION_NAME },
-    'auth.local.username': 'ExampleHabitican',
+    'auth.local.username': 'SabreTest',
   };
 
   const fields = {

migrations/users/habitoween.js

@@ -1,175 +0,0 @@
-/*
- * Award Habitoween ladder items to participants in this month's Habitoween festivities
- */
-/* eslint-disable no-console */
-import { model as User } from '../../website/server/models/user';
-
-const MIGRATION_NAME = '20241030_habitoween_ladder'; // Update when running in future years
-
-const progressCount = 1000;
-let count = 0;
-
-async function updateUser (user) {
-  count += 1;
-
-  const set = { migration: MIGRATION_NAME };
-  const inc = {
-    'items.food.Candy_Skeleton': 1,
-    'items.food.Candy_Base': 1,
-    'items.food.Candy_CottonCandyBlue': 1,
-    'items.food.Candy_CottonCandyPink': 1,
-    'items.food.Candy_Shade': 1,
-    'items.food.Candy_White': 1,
-    'items.food.Candy_Golden': 1,
-    'items.food.Candy_Zombie': 1,
-    'items.food.Candy_Desert': 1,
-    'items.food.Candy_Red': 1,
-  };
-  const push = { notifications: { $each: [] } };
-
-  if (user && user.items && user.items.mounts && user.items.mounts['JackOLantern-RoyalPurple']) {
-    push.notifications.$each.push({
-      type: 'ITEM_RECEIVED',
-      data: {
-        icon: 'notif_habitoween_candy',
-        title: 'Happy Habitoween!',
-        text: 'For this spooky celebration, you\'ve received an assortment of candy for your Pets!',
-        destination: '/inventory/stable',
-      },
-      seen: false,
-    });
-  } else if (user && user.items && user.items.pets && user.items.pets['JackOLantern-RoyalPurple']) {
-    set['items.mounts.JackOLantern-RoyalPurple'] = true;
-    push.notifications.$each.push({
-      type: 'ITEM_RECEIVED',
-      data: {
-        icon: 'notif_habitoween_purple_mount',
-        title: 'Happy Habitoween!',
-        text: 'For this spooky celebration, you\'ve received a Royal Purple Jack-O-Lantern Mount and an assortment of candy for your Pets!',
-        destination: '/inventory/stable',
-      },
-      seen: false,
-    });
-  } else if (user && user.items && user.items.mounts && user.items.mounts['JackOLantern-Glow']) {
-    set['items.pets.JackOLantern-RoyalPurple'] = 5;
-    push.notifications.$each.push({
-      type: 'ITEM_RECEIVED',
-      data: {
-        icon: 'notif_habitoween_purple_pet',
-        title: 'Happy Habitoween!',
-        text: 'For this spooky celebration, you\'ve received a Royal Purple Jack-O-Lantern Pet and an assortment of candy for your Pets!',
-        destination: '/inventory/stable',
-      },
-      seen: false,
-    });
-  } else if (user && user.items && user.items.pets && user.items.pets['JackOLantern-Glow']) {
-    set['items.mounts.JackOLantern-Glow'] = true;
-    push.notifications.$each.push({
-      type: 'ITEM_RECEIVED',
-      data: {
-        icon: 'notif_habitoween_glow_mount',
-        title: 'Happy Habitoween!',
-        text: 'For this spooky celebration, you\'ve received a Glow-in-the-Dark Jack-O-Lantern Mount and an assortment of candy for your Pets!',
-        destination: '/inventory/stable',
-      },
-      seen: false,
-    });
-  } else if (user && user.items && user.items.mounts && user.items.mounts['JackOLantern-Ghost']) {
-    set['items.pets.JackOLantern-Glow'] = 5;
-    push.notifications.$each.push({
-      type: 'ITEM_RECEIVED',
-      data: {
-        icon: 'notif_habitoween_glow_pet',
-        title: 'Happy Habitoween!',
-        text: 'For this spooky celebration, you\'ve received a Glow-in-the-Dark Jack-O-Lantern Pet and an assortment of candy for your Pets!',
-        destination: '/inventory/stable',
-      },
-      seen: false,
-    });
-  } else if (user && user.items && user.items.pets && user.items.pets['JackOLantern-Ghost']) {
-    set['items.mounts.JackOLantern-Ghost'] = true;
-    push.notifications.$each.push({
-      type: 'ITEM_RECEIVED',
-      data: {
-        icon: 'notif_habitoween_ghost_mount',
-        title: 'Happy Habitoween!',
-        text: 'For this spooky celebration, you\'ve received a Ghost Jack-O-Lantern Mount and an assortment of candy for your Pets!',
-        destination: '/inventory/stable',
-      },
-      seen: false,
-    });
-  } else if (user && user.items && user.items.mounts && user.items.mounts['JackOLantern-Base']) {
-    set['items.pets.JackOLantern-Ghost'] = 5;
-    push.notifications.$each.push({
-      type: 'ITEM_RECEIVED',
-      data: {
-        icon: 'notif_habitoween_ghost_pet',
-        title: 'Happy Habitoween!',
-        text: 'For this spooky celebration, you\'ve received a Ghost Jack-O-Lantern Pet and an assortment of candy for your Pets!',
-        destination: '/inventory/stable',
-      },
-      seen: false,
-    });
-  } else if (user && user.items && user.items.pets && user.items.pets['JackOLantern-Base']) {
-    set['items.mounts.JackOLantern-Base'] = true;
-    push.notifications.$each.push({
-      type: 'ITEM_RECEIVED',
-      data: {
-        icon: 'notif_habitoween_base_mount',
-        title: 'Happy Habitoween!',
-        text: 'For this spooky celebration, you\'ve received a Jack-O-Lantern Mount and an assortment of candy for your Pets!',
-        destination: '/inventory/stable',
-      },
-      seen: false,
-    });
-  } else {
-    set['items.pets.JackOLantern-Base'] = 5;
-    push.notifications.$each.push({
-      type: 'ITEM_RECEIVED',
-      data: {
-        icon: 'notif_habitoween_base_pet',
-        title: 'Happy Habitoween!',
-        text: 'For this spooky celebration, you\'ve received a Jack-O-Lantern Pet and an assortment of candy for your Pets!',
-        destination: '/inventory/stable',
-      },
-      seen: false,
-    });
-  }
-
-  if (count % progressCount === 0) console.warn(`${count} ${user._id}`);
-  return User.updateOne({ _id: user._id }, { $inc: inc, $push: push, $set: set }).exec();
-}
-
-export default async function processUsers () {
-  const query = {
-    migration: { $ne: MIGRATION_NAME },
-    'auth.timestamps.loggedin': { $gt: new Date('2024-10-01') },
-  };
-
-  const fields = {
-    _id: 1,
-    items: 1,
-  };
-
-  while (true) { // eslint-disable-line no-constant-condition
-    const users = await User // eslint-disable-line no-await-in-loop
-      .find(query)
-      .limit(250)
-      .sort({ _id: 1 })
-      .select(fields)
-      .lean()
-      .exec();
-
-    if (users.length === 0) {
-      console.warn('All appropriate users found and modified.');
-      console.warn(`\n${count} users processed\n`);
-      break;
-    } else {
-      query._id = {
-        $gt: users[users.length - 1],
-      };
-    }
-
-    await Promise.all(users.map(updateUser)); // eslint-disable-line no-await-in-loop
-  }
-}

migrations/users/harvest_feast.js

@@ -1,167 +0,0 @@
-/* eslint-disable no-console */
-import { model as User } from '../../website/server/models/user';
-
-const MIGRATION_NAME = '20241120_harvest_feast';
-const progressCount = 1000;
-let count = 0;
-
-async function updateUser (user) {
-  count += 1;
-
-  const updateOp = {
-    $set: { migration: MIGRATION_NAME },
-  };
-
-  if (typeof user.items.gear.owned.head_special_turkeyHelmGilded !== 'undefined') {
-    updateOp.$inc = {
-      'items.food.Pie_Base': 1,
-      'items.food.Pie_CottonCandyBlue': 1,
-      'items.food.Pie_CottonCandyPink': 1,
-      'items.food.Pie_Desert': 1,
-      'items.food.Pie_Golden': 1,
-      'items.food.Pie_Red': 1,
-      'items.food.Pie_Shade': 1,
-      'items.food.Pie_Skeleton': 1,
-      'items.food.Pie_Zombie': 1,
-      'items.food.Pie_White': 1,
-    };
-    updateOp.$push = {
-      notifications: {
-        type: 'ITEM_RECEIVED',
-        data: {
-          icon: 'notif_harvestfeast_pie',
-          title: 'Happy Harvest Feast!',
-          text: 'Gobble gobble, you\'ve received an assortment of pie for your Pets!',
-          destination: '/inventory/stable',
-        },
-        seen: false,
-      },
-    };
-  } else if (typeof user.items.gear.owned.armor_special_turkeyArmorBase !== 'undefined') {
-    updateOp.$set['items.gear.owned.head_special_turkeyHelmGilded'] = true;
-    updateOp.$set['items.gear.owned.armor_special_turkeyArmorGilded'] = true;
-    updateOp.$set['items.gear.owned.back_special_turkeyTailGilded'] = true;
-    updateOp.$push = {
-      notifications: {
-        type: 'ITEM_RECEIVED',
-        data: {
-          icon: 'notif_harvestfeast_gilded_set',
-          title: 'Happy Harvest Feast!',
-          text: 'Gobble gobble, you\'ve received the Gilded Turkey Armor, Helm, and Tail!',
-          destination: '/inventory/equipment',
-        },
-        seen: false,
-      },
-    };
-  } else if (user.items && user.items.mounts && user.items.mounts['Turkey-Gilded']) {
-    updateOp.$set['items.gear.owned.head_special_turkeyHelmBase'] = true;
-    updateOp.$set['items.gear.owned.armor_special_turkeyArmorBase'] = true;
-    updateOp.$set['items.gear.owned.back_special_turkeyTailBase'] = true;
-    updateOp.$push = {
-      notifications: {
-        type: 'ITEM_RECEIVED',
-        data: {
-          icon: 'notif_harvestfeast_base_set',
-          title: 'Happy Harvest Feast!',
-          text: 'Gobble gobble, you\'ve received the Turkey Armor, Helm, and Tail!',
-          destination: '/inventory/equipment',
-        },
-        seen: false,
-      },
-    };
-  } else if (user.items && user.items.pets && user.items.pets['Turkey-Gilded']) {
-    updateOp.$set['items.mounts.Turkey-Gilded'] = true;
-    updateOp.$push = {
-      notifications: {
-        type: 'ITEM_RECEIVED',
-        data: {
-          icon: 'notif_harvestfeast_gilded_mount',
-          title: 'Happy Harvest Feast!',
-          text: 'Gobble gobble, you\'ve received the Gilded Turkey Mount!',
-          destination: '/inventory/stable',
-        },
-        seen: false,
-      },
-    };
-  } else if (user.items && user.items.mounts && user.items.mounts['Turkey-Base']) {
-    updateOp.$set['items.pets.Turkey-Gilded'] = 5;
-    updateOp.$push = {
-      notifications: {
-        type: 'ITEM_RECEIVED',
-        data: {
-          icon: 'notif_harvestfeast_gilded_pet',
-          title: 'Happy Harvest Feast!',
-          text: 'Gobble gobble, you\'ve received the Gilded Turkey Pet!',
-          destination: '/inventory/stable',
-        },
-        seen: false,
-      },
-    };
-  } else if (user.items && user.items.pets && user.items.pets['Turkey-Base']) {
-    updateOp.$set['items.mounts.Turkey-Base'] = true;
-    updateOp.$push = {
-      notifications: {
-        type: 'ITEM_RECEIVED',
-        data: {
-          icon: 'notif_harvestfeast_base_mount',
-          title: 'Happy Harvest Feast!',
-          text: 'Gobble gobble, you\'ve received the Turkey Mount!',
-          destination: '/inventory/stable',
-        },
-        seen: false,
-      },
-    };
-  } else {
-    updateOp.$set['items.pets.Turkey-Base'] = 5;
-    updateOp.$push = {
-      notifications: {
-        type: 'ITEM_RECEIVED',
-        data: {
-          icon: 'notif_harvestfeast_base_pet',
-          title: 'Happy Harvest Feast!',
-          text: 'Gobble gobble, you\'ve received the Turkey Pet!',
-          destination: '/inventory/stable',
-        },
-        seen: false,
-      },
-    };
-  }
-
-  if (count % progressCount === 0) console.warn(`${count} ${user._id}`);
-
-  return User.updateOne({ _id: user._id }, updateOp).exec();
-}
-
-export default async function processUsers () {
-  const query = {
-    migration: { $ne: MIGRATION_NAME },
-    'auth.timestamps.loggedin': { $gt: new Date('2024-10-20') },
-  };
-
-  const fields = {
-    _id: 1,
-    items: 1,
-  };
-
-  while (true) { // eslint-disable-line no-constant-condition
-    const users = await User // eslint-disable-line no-await-in-loop
-      .find(query)
-      .limit(250)
-      .sort({ _id: 1 })
-      .select(fields)
-      .lean()
-      .exec();
-
-    if (users.length === 0) {
-      console.warn('All appropriate users found and modified.');
-      console.warn(`\n${count} users processed\n`);
-      break;
-    } else {
-      query._id = {
-        $gt: users[users.length - 1],
-      };
-    }
-
-    await Promise.all(users.map(updateUser)); // eslint-disable-line no-await-in-loop
-  }
-}

migrations/users/naming-day.js

@@ -1,153 +0,0 @@
-/* eslint-disable no-console */
-import { model as User } from '../../website/server/models/user';
-
-const MIGRATION_NAME = '20240731_naming_day';
-const progressCount = 1000;
-let count = 0;
-
-async function updateUser (user) {
-  count += 1;
-
-  let set;
-  let push;
-  const inc = {
-    'items.food.Cake_Base': 1,
-    'items.food.Cake_CottonCandyBlue': 1,
-    'items.food.Cake_CottonCandyPink': 1,
-    'items.food.Cake_Desert': 1,
-    'items.food.Cake_Golden': 1,
-    'items.food.Cake_Red': 1,
-    'items.food.Cake_Shade': 1,
-    'items.food.Cake_Skeleton': 1,
-    'items.food.Cake_White': 1,
-    'items.food.Cake_Zombie': 1,
-    'achievements.habiticaDays': 1,
-  };
-
-  if (user && user.items && user.items.gear && user.items.gear.owned && typeof user.items.gear.owned.back_special_namingDay2020 !== 'undefined') {
-    set = { migration: MIGRATION_NAME };
-    push = {
-      notifications: {
-        type: 'ITEM_RECEIVED',
-        data: {
-          icon: 'notif_namingDay_cake',
-          title: 'Happy Naming Day!',
-          text: 'To celebrate the day we became Habitica, we’ve awarded you some cake!',
-          destination: '/inventory/items',
-        },
-        seen: false,
-      },
-    };
-  } else if (user && user.items && user.items.gear && user.items.gear.owned && typeof user.items.gear.owned.body_special_namingDay2018 !== 'undefined') {
-    set = { migration: MIGRATION_NAME, 'items.gear.owned.back_special_namingDay2020': true };
-    push = {
-      notifications: {
-        type: 'ITEM_RECEIVED',
-        data: {
-          icon: 'notif_namingDay_back',
-          title: 'Happy Naming Day!',
-          text: 'To celebrate the day we became Habitica, we’ve awarded you a Royal Purple Gryphon Tail and cake!',
-          destination: '/inventory/equipment',
-        },
-        seen: false,
-      },
-    };
-  } else if (user && user.items && user.items.gear && user.items.gear.owned && typeof user.items.gear.owned.head_special_namingDay2017 !== 'undefined') {
-    set = { migration: MIGRATION_NAME, 'items.gear.owned.body_special_namingDay2018': true };
-    push = {
-      notifications: {
-        type: 'ITEM_RECEIVED',
-        data: {
-          icon: 'notif_namingDay_body',
-          title: 'Happy Naming Day!',
-          text: 'To celebrate the day we became Habitica, we’ve awarded you a Royal Purple Gryphon Cloak and cake!',
-          destination: '/inventory/equipment',
-        },
-        seen: false,
-      },
-    };
-  } else if (user && user.items && user.items.pets && typeof user.items.pets['Gryphon-RoyalPurple'] !== 'undefined') {
-    set = { migration: MIGRATION_NAME, 'items.gear.owned.head_special_namingDay2017': true };
-    push = {
-      notifications: {
-        type: 'ITEM_RECEIVED',
-        data: {
-          icon: 'notif_namingDay_head',
-          title: 'Happy Naming Day!',
-          text: 'To celebrate the day we became Habitica, we’ve awarded you a Royal Purple Gryphon Helm and cake!',
-          destination: '/inventory/equipment',
-        },
-        seen: false,
-      },
-    };
-  } else if (user && user.items && user.items.mounts && typeof user.items.mounts['Gryphon-RoyalPurple'] !== 'undefined') {
-    set = { migration: MIGRATION_NAME, 'items.pets.Gryphon-RoyalPurple': 5 };
-    push = {
-      notifications: {
-        type: 'ITEM_RECEIVED',
-        data: {
-          icon: 'notif_namingDay_pet',
-          title: 'Happy Naming Day!',
-          text: 'To celebrate the day we became Habitica, we’ve awarded you a Royal Purple Gryphon Pet and cake!',
-          destination: '/inventory/stable',
-        },
-        seen: false,
-      },
-    };
-  } else {
-    set = { migration: MIGRATION_NAME, 'items.mounts.Gryphon-RoyalPurple': true };
-    push = {
-      notifications: {
-        type: 'ITEM_RECEIVED',
-        data: {
-          icon: 'notif_namingDay_mount',
-          title: 'Happy Naming Day!',
-          text: 'To celebrate the day we became Habitica, we’ve awarded you a Royal Purple Gryphon Mount and cake!',
-          destination: '/inventory/stable',
-        },
-        seen: false,
-      },
-    };
-  }
-
-  if (count % progressCount === 0) console.warn(`${count} ${user._id}`);
-
-  if (push) {
-    return user.updateOne({ $set: set, $inc: inc, $push: push }).exec();
-  }
-
-  return user.updateOne({ $set: set, $inc: inc }).exec();
-}
-
-export default async function processUsers () {
-  const query = {
-    migration: { $ne: MIGRATION_NAME },
-    'auth.timestamps.loggedin': { $gt: new Date('2024-07-01') },
-  };
-
-  const fields = {
-    _id: 1,
-    items: 1,
-  };
-
-  while (true) { // eslint-disable-line no-constant-condition
-    const users = await User // eslint-disable-line no-await-in-loop
-      .find(query)
-      .limit(250)
-      .sort({ _id: 1 })
-      .select(fields)
-      .exec();
-
-    if (users.length === 0) {
-      console.warn('All appropriate users found and modified.');
-      console.warn(`\n${count} users processed\n`);
-      break;
-    } else {
-      query._id = {
-        $gt: users[users.length - 1]._id,
-      };
-    }
-
-    await Promise.all(users.map(updateUser)); // eslint-disable-line no-await-in-loop
-  }
-}

migrations/users/nye.js

@@ -1,125 +0,0 @@
-/* eslint-disable no-console */
-import { model as User } from '../../website/server/models/user';
-
-const MIGRATION_NAME = '20231228_nye';
-const progressCount = 1000;
-let count = 0;
-
-async function updateUser (user) {
-  count += 1;
-
-  const updateOp = {
-    $set: { migration: MIGRATION_NAME },
-    $push: { },
-  };
-  const data = {
-    title: 'Happy New Year!',
-    destination: '/inventory/equipment',
-  };
-
-  if (typeof user.items.gear.owned.head_special_nye2023 !== 'undefined') {
-    updateOp.$inc = {
-      'items.food.Candy_Skeleton': 1,
-      'items.food.Candy_Base': 1,
-      'items.food.Candy_CottonCandyBlue': 1,
-      'items.food.Candy_CottonCandyPink': 1,
-      'items.food.Candy_Shade': 1,
-      'items.food.Candy_White': 1,
-      'items.food.Candy_Golden': 1,
-      'items.food.Candy_Zombie': 1,
-      'items.food.Candy_Desert': 1,
-      'items.food.Candy_Red': 1,
-    };
-    data.icon = 'notif_candy_nye';
-    data.text = 'You’ve received an assortment of candy to celebrate with your Pets!';
-    data.destination = '/inventory/stable';
-  } else if (typeof user.items.gear.owned.head_special_nye2022 !== 'undefined') {
-    updateOp.$set['items.gear.owned.head_special_nye2023'] = true;
-    data.icon = 'notif_2023hat_nye';
-    data.text = 'Take on your resolutions with style in this Ludicrous Party Hat!';
-  } else if (typeof user.items.gear.owned.head_special_nye2021 !== 'undefined') {
-    updateOp.$set['items.gear.owned.head_special_nye2022'] = true;
-    data.icon = 'notif_2022hat_nye';
-    data.text = 'Take on your resolutions with style in this Fabulous Party Hat!';
-  } else if (typeof user.items.gear.owned.head_special_nye2020 !== 'undefined') {
-    updateOp.$set['items.gear.owned.head_special_nye2021'] = true;
-    data.icon = 'notif_2021hat_nye';
-    data.text = 'Take on your resolutions with style in this Preposterous Party Hat!';
-  } else if (typeof user.items.gear.owned.head_special_nye2019 !== 'undefined') {
-    updateOp.$set['items.gear.owned.head_special_nye2020'] = true;
-    data.icon = 'notif_2020hat_nye';
-    data.text = 'Take on your resolutions with style in this Extravagant Party Hat!';
-  } else if (typeof user.items.gear.owned.head_special_nye2018 !== 'undefined') {
-    updateOp.$set['items.gear.owned.head_special_nye2019'] = true;
-    data.icon = 'notif_2019hat_nye';
-    data.text = 'Take on your resolutions with style in this Outrageous Party Hat!';
-  } else if (typeof user.items.gear.owned.head_special_nye2017 !== 'undefined') {
-    updateOp.$set['items.gear.owned.head_special_nye2018'] = true;
-    data.icon = 'notif_2018hat_nye';
-    data.text = 'Take on your resolutions with style in this Outlandish Party Hat!';
-  } else if (typeof user.items.gear.owned.head_special_nye2016 !== 'undefined') {
-    updateOp.$set['items.gear.owned.head_special_nye2017'] = true;
-    data.icon = 'notif_2017hat_nye';
-    data.text = 'Take on your resolutions with style in this Fanciful Party Hat!';
-  } else if (typeof user.items.gear.owned.head_special_nye2015 !== 'undefined') {
-    updateOp.$set['items.gear.owned.head_special_nye2016'] = true;
-    data.icon = 'notif_2016hat_nye';
-    data.text = 'Take on your resolutions with style in this Whimsical Party Hat!';
-  } else if (typeof user.items.gear.owned.head_special_nye2014 !== 'undefined') {
-    updateOp.$set['items.gear.owned.head_special_nye2015'] = true;
-    data.icon = 'notif_2015hat_nye';
-    data.text = 'Take on your resolutions with style in this Ridiculous Party Hat!';
-  } else if (typeof user.items.gear.owned.head_special_nye !== 'undefined') {
-    updateOp.$set['items.gear.owned.head_special_nye2014'] = true;
-    data.icon = 'notif_2014hat_nye';
-    data.text = 'Take on your resolutions with style in this Silly Party Hat!';
-  } else {
-    updateOp.$set['items.gear.owned.head_special_nye'] = true;
-    data.icon = 'notif_2013hat_nye';
-    data.text = 'Take on your resolutions with style in this Absurd Party Hat!';
-  }
-
-  updateOp.$push.notifications = {
-    type: 'ITEM_RECEIVED',
-    data,
-    seen: false,
-  };
-
-  if (count % progressCount === 0) console.warn(`${count} ${user._id}`);
-
-  return User.updateOne({ _id: user._id }, updateOp).exec();
-}
-
-export default async function processUsers () {
-  const query = {
-    'auth.timestamps.loggedin': { $gt: new Date('2023-12-01') },
-    migration: { $ne: MIGRATION_NAME },
-  };
-
-  const fields = {
-    _id: 1,
-    items: 1,
-  };
-
-  while (true) { // eslint-disable-line no-constant-condition
-    const users = await User // eslint-disable-line no-await-in-loop
-      .find(query)
-      .limit(250)
-      .sort({ _id: 1 })
-      .select(fields)
-      .lean()
-      .exec();
-
-    if (users.length === 0) {
-      console.warn('All appropriate users found and modified.');
-      console.warn(`\n${count} users processed\n`);
-      break;
-    } else {
-      query._id = {
-        $gt: users[users.length - 1],
-      };
-    }
-
-    await Promise.all(users.map(updateUser)); // eslint-disable-line no-await-in-loop
-  }
-}

migrations/users/pi-day.js

@@ -3,7 +3,7 @@ import { v4 as uuid } from 'uuid';
 
 import { model as User } from '../../website/server/models/user';
 
-const MIGRATION_NAME = '20240314_pi_day';
+const MIGRATION_NAME = '20230314_pi_day';
 
 const progressCount = 1000;
 let count = 0;

package.json

@@ -1,88 +1,87 @@
 {
   "name": "habitica",
   "description": "A habit tracker app which treats your goals like a Role Playing Game.",
-  "version": "5.39.1",
+  "version": "4.274.0",
   "main": "./website/server/index.js",
   "dependencies": {
-    "@babel/core": "^7.22.10",
-    "@babel/preset-env": "^7.22.10",
-    "@babel/register": "^7.22.15",
+    "@babel/core": "^7.22.5",
+    "@babel/preset-env": "^7.22.5",
+    "@babel/register": "^7.22.5",
     "@google-cloud/trace-agent": "^7.1.2",
-    "@parse/node-apn": "^5.2.3",
+    "@parse/node-apn": "^5.1.3",
     "@slack/webhook": "^6.1.0",
     "accepts": "^1.3.8",
     "amazon-payments": "^0.2.9",
     "amplitude": "^6.0.0",
     "apidoc": "^0.54.0",
     "apple-auth": "^1.0.9",
-    "babel-preset-env": "^1.7.0",
-    "bcrypt": "^5.1.1",
-    "body-parser": "^1.20.3",
-    "bootstrap": "^4.6.2",
+    "bcrypt": "^5.1.0",
+    "body-parser": "^1.20.2",
+    "bootstrap": "^4.6.0",
     "compression": "^1.7.4",
     "cookie-session": "^2.0.0",
     "coupon-code": "^0.4.5",
     "csv-stringify": "^5.6.5",
     "cwait": "^1.1.1",
     "domain-middleware": "~0.1.0",
-    "eslint": "^8.55.0",
-    "eslint-config-habitrpg": "^6.2.3",
+    "eslint": "^6.8.0",
+    "eslint-config-habitrpg": "^6.2.0",
     "eslint-plugin-mocha": "^5.0.0",
-    "express": "^4.21.1",
+    "express": "^4.18.2",
     "express-basic-auth": "^1.2.1",
     "express-validator": "^5.2.0",
-    "firebase-admin": "^12.1.1",
     "glob": "^8.1.0",
-    "got": "^11.8.6",
+    "got": "^11.8.3",
     "gulp": "^4.0.0",
     "gulp-babel": "^8.0.0",
-    "gulp-filter": "^7.0.0",
     "gulp-imagemin": "^7.1.0",
+    "gulp-nodemon": "^2.5.0",
     "gulp.spritesmith": "^6.13.0",
     "habitica-markdown": "^3.0.0",
     "helmet": "^4.6.0",
+    "image-size": "^1.0.2",
     "in-app-purchase": "^1.11.3",
     "js2xmlparser": "^5.0.0",
-    "jsonwebtoken": "^9.0.2",
+    "jsonwebtoken": "^9.0.0",
     "jwks-rsa": "^2.1.5",
     "lodash": "^4.17.21",
     "merge-stream": "^2.0.0",
     "method-override": "^3.0.0",
     "moment": "^2.29.4",
-    "moment-recur": "git://github.com/HabitRPG/moment-recur.git#d3e8e6da0806f13b74dd2e4d7d9053e6a63db119",
-    "mongoose": "^8.9.5",
+    "moment-recur": "^1.0.7",
+    "mongoose": "^5.13.7",
     "morgan": "^1.10.0",
-    "nconf": "^0.12.1",
+    "nconf": "^0.12.0",
     "node-gcm": "^1.0.5",
     "on-headers": "^1.0.2",
-    "passport": "^0.5.3",
+    "passport": "^0.5.0",
     "passport-facebook": "^3.0.0",
     "passport-google-oauth2": "^0.2.0",
     "passport-google-oauth20": "2.0.0",
     "paypal-rest-sdk": "^1.8.1",
     "pp-ipn": "^1.1.0",
     "ps-tree": "^1.0.0",
-    "rate-limiter-flexible": "^2.4.2",
+    "rate-limiter-flexible": "^2.4.0",
     "redis": "^3.1.2",
+    "regenerator-runtime": "^0.13.11",
     "remove-markdown": "^0.5.0",
     "rimraf": "^3.0.2",
     "short-uuid": "^4.2.2",
-    "sinon": "^15.2.0",
-    "stripe": "^12.18.0",
-    "superagent": "^8.1.2",
+    "stripe": "^12.9.0",
+    "superagent": "^8.0.9",
     "universal-analytics": "^0.5.3",
     "useragent": "^2.1.9",
     "uuid": "^9.0.0",
-    "validator": "^13.11.0",
-    "webpack-bundle-analyzer": "^4.10.2",
-    "winston": "^3.10.0",
-    "winston-loggly-bulk": "^3.3.0",
-    "xml2js": "^0.6.2"
+    "validator": "^13.9.0",
+    "vinyl-buffer": "^1.0.1",
+    "winston": "^3.9.0",
+    "winston-loggly-bulk": "^3.2.1",
+    "xml2js": "^0.6.0"
   },
   "private": true,
   "engines": {
-    "node": "20",
-    "npm": "^10"
+    "node": "^14",
+    "npm": "^6"
   },
   "scripts": {
     "lint": "eslint --ext .js --fix . && cd website/client && npm run lint",
@@ -95,36 +94,37 @@
     "test:api-v3:integration:separate-server": "NODE_ENV=test gulp test:api-v3:integration:separate-server",
     "test:api-v4:integration": "gulp test:api-v4:integration",
     "test:api-v4:integration:separate-server": "NODE_ENV=test gulp test:api-v4:integration:separate-server",
-    "test:sanity": "nyc --silent --no-clean mocha test/sanity --recursive",
-    "test:common": "nyc --silent --no-clean mocha test/common --recursive",
-    "test:content": "nyc --silent --no-clean mocha test/content --recursive",
-    "coverage": "nyc report --reporter=html --report-dir coverage/results; open coverage/results/index.html",
+    "test:sanity": "istanbul cover --dir coverage/sanity --report lcovonly node_modules/mocha/bin/_mocha -- test/sanity --recursive",
+    "test:common": "istanbul cover --dir coverage/common --report lcovonly node_modules/mocha/bin/_mocha -- test/common --recursive",
+    "test:content": "istanbul cover --dir coverage/content --report lcovonly node_modules/mocha/bin/_mocha -- test/content --recursive",
+    "test:nodemon": "gulp test:nodemon",
+    "coverage": "COVERAGE=true mocha --require register-handlers.js --reporter html-cov > coverage.html; open coverage.html",
     "sprites": "gulp sprites:compile",
     "client:dev": "cd website/client && npm run serve",
     "client:build": "cd website/client && npm run build",
     "client:unit": "cd website/client && npm run test:unit",
-    "start": "node --watch ./website/server/index.js",
-    "start:simple": "node ./website/server/index.js",
-    "debug": "node --watch --inspect ./website/server/index.js",
-    "mongo:dev": "run-rs -v 7.0.23 -l ubuntu2404 --keep --dbpath mongodb-data --number 1 --quiet",
-    "mongo:test": "run-rs -v 7.0.23 -l ubuntu2404 --keep --dbpath mongodb-data-testing --number 1 --quiet",
+    "start": "gulp nodemon",
+    "debug": "gulp nodemon --inspect",
+    "mongo:dev": "run-rs -v 4.2.8 -l ubuntu1804 --keep --dbpath mongodb-data --number 1 --quiet",
     "postinstall": "git config --global url.\"https://\".insteadOf git:// && gulp build && cd website/client && npm install",
-    "apidoc": "gulp apidoc",
-    "heroku-postbuild": ".heroku/report_deploy.sh"
+    "apidoc": "gulp apidoc"
   },
   "devDependencies": {
-    "axios": "^1.8.2",
+    "axios": "^1.3.6",
     "chai": "^4.3.7",
     "chai-as-promised": "^7.1.1",
     "chai-moment": "^0.1.0",
-    "chalk": "^5.3.0",
-    "cross-spawn": "^7.0.5",
+    "chalk": "^5.2.0",
+    "cross-spawn": "^7.0.3",
+    "expect.js": "^0.3.1",
+    "istanbul": "^1.1.0-alpha.1",
     "mocha": "^5.1.1",
     "monk": "^7.3.4",
-    "nyc": "^15.1.0",
     "require-again": "^2.0.0",
     "run-rs": "^0.7.7",
+    "sinon": "^15.1.2",
     "sinon-chai": "^3.7.0",
     "sinon-stub-promise": "^4.0.0"
-  }
+  },
+  "optionalDependencies": {}
 }

scripts/gdpr-delete-users.js

@@ -44,7 +44,6 @@ async function deleteHabiticaData (user, email) {
     { _id: user._id },
     { $set: set },
   );
-  // eslint-disable-next-line no-promise-executor-return
   await new Promise(resolve => setTimeout(resolve, 1000));
   const response = await axios.delete(
     `${BASE_URL}/api/v3/user`,
@@ -71,14 +70,15 @@ async function deleteHabiticaData (user, email) {
 }
 
 async function processEmailAddress (email) {
+  const emailRegex = new RegExp(`^${email}$`, 'i');
   const localUsers = await User.find(
-    { 'auth.local.email': email },
+    { 'auth.local.email': emailRegex },
     { _id: 1, apiToken: 1, auth: 1 },
   ).exec();
 
   const socialUsers = await User.find(
     {
-      'auth.local.email': { $ne: email },
+      'auth.local.email': { $not: emailRegex },
       $or: [
         { 'auth.facebook.emails.value': email },
         { 'auth.google.emails.value': email },
@@ -96,7 +96,6 @@ async function processEmailAddress (email) {
     return console.log(`No users found with email address ${email}`);
   }
 
-  // eslint-disable-next-line no-promise-executor-return
   await new Promise(resolve => setTimeout(resolve, 1000));
   return Promise.all(users.map(user => (async () => {
     await deleteAmplitudeData(user._id, email); // eslint-disable-line no-await-in-loop

scripts/team-cron.js

@@ -8,17 +8,7 @@ const TASK_VALUE_CHANGE_FACTOR = 0.9747;
 const MIN_TASK_VALUE = -47.27;
 
 async function updateTeamTasks (team) {
-  if (team.purchased.plan.dateTerminated) {
-    const dateTerminated = new Date(team.purchased.plan.dateTerminated);
-    if (dateTerminated < new Date()) {
-      team.purchased.plan.customerId = undefined;
-      team.markModified('purchased.plan');
-      return team.save();
-    }
-  }
-
   const toSave = [];
-
   let teamLeader = await User.findOne({ _id: team.leader }, 'preferences').exec();
 
   if (!teamLeader) { // why would this happen?
@@ -103,7 +93,12 @@ async function updateTeamTasks (team) {
 export default async function processTeamsCron () {
   const activeTeams = await Group.find({
     'purchased.plan.customerId': { $exists: true },
-  }, { cron: 1, leader: 1, purchased: 1 }).exec();
+    $or: [
+      { 'purchased.plan.dateTerminated': { $exists: false } },
+      { 'purchased.plan.dateTerminated': null },
+      { 'purchased.plan.dateTerminated': { $gt: new Date() } },
+    ],
+  }).exec();
 
   const cronPromises = activeTeams.map(updateTeamTasks);
   return Promise.all(cronPromises);

test/.eslintrc.js

@@ -1,5 +1,3 @@
-/* eslint-disable import/no-commonjs */
-
 module.exports = {
   extends: [
     'habitrpg/lib/mocha',
@@ -9,9 +7,6 @@ module.exports = {
     chai: true,
     expect: true,
     sinon: true,
-    sandbox: true,
+    sandbox: true
   },
-  rules: {
-    'import/no-extraneous-dependencies': 'off',
-  },
-};
+}

test/api/unit/libs/apiError.js

@@ -1,4 +1,4 @@
-import { apiError } from '../../../../website/server/libs/apiError';
+import apiError from '../../../../website/server/libs/apiError';
 
 describe('API Messages', () => {
   const message = 'Only public guilds support pagination.';

test/api/unit/libs/bug-report.test.js

@@ -26,7 +26,9 @@ describe('bug-report', () => {
       _id: userId,
     });
 
-    const result = await bugReportLogic(user, userMail, userMessage, userAgent);
+    const result = await bugReportLogic(
+      user, userMail, userMessage, userAgent,
+    );
 
     expect(emailLib.sendTxn).to.be.called;
     expect(result).to.deep.equal({
@@ -44,6 +46,7 @@ describe('bug-report', () => {
         USER_HOURGLASSES: 0,
         USER_ID: userId,
         USER_LEVEL: 1,
+        USER_OFFSET_MONTHS: 0,
         USER_PAYMENT_PLATFORM: undefined,
         USER_SUBSCRIPTION: undefined,
         USER_TIMEZONE_OFFSET: 0,

test/api/unit/libs/content.test.js

@@ -1,9 +1,5 @@
-import fs from 'fs';
 import * as contentLib from '../../../../website/server/libs/content';
 import content from '../../../../website/common/script/content';
-import {
-  generateRes,
-} from '../../../helpers/api-unit.helper';
 
 describe('contentLib', () => {
   describe('CONTENT_CACHE_PATH', () => {
@@ -17,90 +13,5 @@ describe('contentLib', () => {
       contentLib.getLocalizedContentResponse();
       expect(typeof content.backgrounds.backgrounds062014.beach.text).to.equal('function');
     });
-
-    it('removes keys from the content data', () => {
-      const response = contentLib.localizeContentData(content, 'en', { backgroundsFlat: true, dropHatchingPotions: true });
-      expect(response.backgroundsFlat).to.not.exist;
-      expect(response.backgrounds).to.exist;
-      expect(response.dropHatchingPotions).to.not.exist;
-      expect(response.hatchingPotions).to.exist;
-    });
-
-    it('removes nested keys from the content data', () => {
-      const response = contentLib.localizeContentData(content, 'en', { gear: { tree: true } });
-      expect(response.gear.tree).to.not.exist;
-      expect(response.gear.flat).to.exist;
-    });
-  });
-
-  it('generates a hash for a filter', () => {
-    const hash = contentLib.hashForFilter('backgroundsFlat,gear.flat');
-    expect(hash).to.equal('-1791877526');
-  });
-
-  it('serves content', () => {
-    const resSpy = generateRes();
-    contentLib.serveContent(resSpy, 'en', '', false);
-    expect(resSpy.send).to.have.been.calledOnce;
-  });
-
-  it('serves filtered content', () => {
-    const resSpy = generateRes();
-    contentLib.serveContent(resSpy, 'en', 'backgroundsFlat,gear.flat', false);
-    expect(resSpy.send).to.have.been.calledOnce;
-  });
-
-  describe('caches content', async () => {
-    let resSpy;
-    beforeEach(() => {
-      resSpy = generateRes();
-      if (fs.existsSync(contentLib.CONTENT_CACHE_PATH)) {
-        fs.rmSync(contentLib.CONTENT_CACHE_PATH, { recursive: true });
-      }
-      fs.mkdirSync(contentLib.CONTENT_CACHE_PATH);
-    });
-
-    it('does not cache requests in development mode', async () => {
-      contentLib.serveContent(resSpy, 'en', '', false);
-      expect(fs.existsSync(`${contentLib.CONTENT_CACHE_PATH}en.json`)).to.be.false;
-    });
-
-    it('caches unfiltered requests', async () => {
-      expect(fs.existsSync(`${contentLib.CONTENT_CACHE_PATH}en.json`)).to.be.false;
-      contentLib.serveContent(resSpy, 'en', '', true);
-      expect(fs.existsSync(`${contentLib.CONTENT_CACHE_PATH}en.json`)).to.be.true;
-    });
-
-    it('serves cached requests', async () => {
-      fs.writeFileSync(
-        `${contentLib.CONTENT_CACHE_PATH}en.json`,
-        '{"success": true, "data": {"all": {}}}',
-        'utf8',
-      );
-      contentLib.serveContent(resSpy, 'en', '', true);
-      expect(resSpy.sendFile).to.have.been.calledOnce;
-      expect(resSpy.sendFile).to.have.been.calledWith(`${contentLib.CONTENT_CACHE_PATH}en.json`);
-    });
-
-    it('caches filtered requests', async () => {
-      const filter = 'backgroundsFlat,gear.flat';
-      const hash = contentLib.hashForFilter(filter);
-      expect(fs.existsSync(`${contentLib.CONTENT_CACHE_PATH}en${hash}.json`)).to.be.false;
-      contentLib.serveContent(resSpy, 'en', filter, true);
-      expect(fs.existsSync(`${contentLib.CONTENT_CACHE_PATH}en${hash}.json`)).to.be.true;
-    });
-
-    it('serves filtered cached requests', async () => {
-      const filter = 'backgroundsFlat,gear.flat';
-      const hash = contentLib.hashForFilter(filter);
-      fs.writeFileSync(
-        `${contentLib.CONTENT_CACHE_PATH}en${hash}.json`,
-        '{"success": true, "data": {}}',
-        'utf8',
-      );
-      contentLib.serveContent(resSpy, 'en', filter, true);
-      expect(resSpy.sendFile).to.have.been.calledOnce;
-      expect(resSpy.sendFile).to.have.been.calledWith(`${contentLib.CONTENT_CACHE_PATH}en${hash}.json`);
-    });
   });
 });

test/api/unit/libs/email.test.js

@@ -171,23 +171,23 @@ describe('emails', () => {
       expect(got.post).not.to.be.called;
     });
 
-    it('throws error when mail target is only a string', async () => {
+    it('throws error when mail target is only a string', () => {
       const emailType = 'an email type';
       const mailingInfo = 'my email';
 
-      await expect(sendTxn(mailingInfo, emailType)).to.be.rejectedWith('Argument Error mailingInfoArray: does not contain email or _id');
+      expect(sendTxn(mailingInfo, emailType)).to.throw;
     });
 
-    it('throws error when mail target has no _id or email', async () => {
+    it('throws error when mail target has no _id or email', () => {
       const emailType = 'an email type';
       const mailingInfo = {
 
       };
 
-      await expect(sendTxn(mailingInfo, emailType)).to.be.rejectedWith('Argument Error mailingInfoArray: does not contain email or _id');
+      expect(sendTxn(mailingInfo, emailType)).to.throw;
     });
 
-    it('throws error when variables not an array', async () => {
+    it('throws error when variables not an array', () => {
       const emailType = 'an email type';
       const mailingInfo = {
         name: 'my name',
@@ -195,10 +195,9 @@ describe('emails', () => {
       };
       const variables = {};
 
-      await expect(sendTxn(mailingInfo, emailType, variables)).to.be.rejectedWith('Argument Error variables: is not an array');
+      expect(sendTxn(mailingInfo, emailType, variables)).to.throw;
     });
-
-    it('throws error when variables array not contain name/content', async () => {
+    it('throws error when variables array not contain name/content', () => {
       const emailType = 'an email type';
       const mailingInfo = {
         name: 'my name',
@@ -210,9 +209,8 @@ describe('emails', () => {
         },
       ];
 
-      await expect(sendTxn(mailingInfo, emailType, variables)).to.be.rejectedWith('Argument Error variables: does not contain name or content');
+      expect(sendTxn(mailingInfo, emailType, variables)).to.throw;
     });
-
     it('throws no error when variables array contain name but no content', () => {
       const emailType = 'an email type';
       const mailingInfo = {

test/api/unit/libs/items/utils.test.js

@@ -117,7 +117,7 @@ describe('Items Utils', () => {
     it('converts values for owned gear to true/false', () => {
       expect(castItemVal('items.gear.owned.shield_warrior_0', 'true')).to.equal(true);
       expect(castItemVal('items.gear.owned.invalid', 'false')).to.equal(false);
-      expect(castItemVal('items.gear.owned.invalid', 'null')).to.equal(undefined);
+      expect(castItemVal('items.gear.owned.invalid', 'null')).to.equal(false);
       expect(castItemVal('items.gear.owned.invalid', 'truthy')).to.equal(true);
       expect(castItemVal('items.gear.owned.invalid', 0)).to.equal(false);
     });

test/api/unit/libs/mongodb.js

@@ -1,4 +1,5 @@
 import os from 'os';
+import nconf from 'nconf';
 import requireAgain from 'require-again';
 
 const pathToMongoLib = '../../../../website/server/libs/mongodb';
@@ -28,4 +29,22 @@ describe('mongodb', () => {
       expect(string).to.equal('mongodb://hostname:3030');
     });
   });
+
+  describe('getDefaultConnectionOptions', () => {
+    it('returns development config when IS_PROD is false', () => {
+      sandbox.stub(nconf, 'get').withArgs('IS_PROD').returns(false);
+      const mongoLibOverride = requireAgain(pathToMongoLib);
+
+      const options = mongoLibOverride.getDefaultConnectionOptions();
+      expect(options).to.have.all.keys(['useNewUrlParser', 'useUnifiedTopology']);
+    });
+
+    it('returns production config when IS_PROD is true', () => {
+      sandbox.stub(nconf, 'get').withArgs('IS_PROD').returns(true);
+      const mongoLibOverride = requireAgain(pathToMongoLib);
+
+      const options = mongoLibOverride.getDefaultConnectionOptions();
+      expect(options).to.have.all.keys(['useNewUrlParser', 'useUnifiedTopology', 'keepAlive', 'keepAliveInitialDelay']);
+    });
+  });
 });

test/api/unit/libs/password.test.js

@@ -227,7 +227,7 @@ describe('Password Utilities', () => {
         expiresAt: moment().subtract({ minutes: 1 }),
       }));
 
-      await user.updateOne({
+      await user.update({
         'auth.local.passwordResetCode': code,
       });
 
@@ -264,7 +264,7 @@ describe('Password Utilities', () => {
         expiresAt: moment().add({ days: 1 }),
       }));
 
-      await user.updateOne({
+      await user.update({
         'auth.local.passwordResetCode': 'invalid',
       });
 
@@ -280,7 +280,7 @@ describe('Password Utilities', () => {
         expiresAt: moment().add({ days: 1 }),
       }));
 
-      await user.updateOne({
+      await user.update({
         'auth.local.passwordResetCode': code,
       });
 

test/api/unit/libs/payments/amazon/checkout.test.js

@@ -2,7 +2,7 @@ import { model as User } from '../../../../../../website/server/models/user';
 import amzLib from '../../../../../../website/server/libs/payments/amazon';
 import payments from '../../../../../../website/server/libs/payments/payments';
 import common from '../../../../../../website/common';
-import { apiError } from '../../../../../../website/server/libs/apiError';
+import apiError from '../../../../../../website/server/libs/apiError';
 import * as gems from '../../../../../../website/server/libs/payments/gems';
 
 const { i18n } = common;

test/api/unit/libs/payments/apple.test.js

@@ -342,12 +342,10 @@ describe('Apple Payments', () => {
             }]);
           sub = common.content.subscriptionBlocks[newOption.subKey];
 
-          await applePayments.subscribe(
-            user,
+          await applePayments.subscribe(user,
             receipt,
             headers,
-            nextPaymentProcessing,
-          );
+            nextPaymentProcessing);
 
           expect(iapSetupStub).to.be.calledOnce;
           expect(iapValidateStub).to.be.calledOnce;
@@ -389,12 +387,10 @@ describe('Apple Payments', () => {
             }]);
           sub = common.content.subscriptionBlocks[newOption.subKey];
 
-          await applePayments.subscribe(
-            user,
+          await applePayments.subscribe(user,
             receipt,
             headers,
-            nextPaymentProcessing,
-          );
+            nextPaymentProcessing);
 
           expect(iapSetupStub).to.be.calledOnce;
           expect(iapValidateStub).to.be.calledOnce;
@@ -521,7 +517,9 @@ describe('Apple Payments', () => {
 
         const secondUser = new User();
         await secondUser.save();
-        await expect(applePayments.subscribe(secondUser, receipt, headers, nextPaymentProcessing))
+        await expect(applePayments.subscribe(
+          secondUser, receipt, headers, nextPaymentProcessing,
+        ))
           .to.eventually.be.rejected.and.to.eql({
             httpCode: 401,
             name: 'NotAuthorized',
@@ -561,7 +559,9 @@ describe('Apple Payments', () => {
 
         const thirdUser = new User();
         await thirdUser.save();
-        await expect(applePayments.subscribe(thirdUser, receipt, headers, nextPaymentProcessing))
+        await expect(applePayments.subscribe(
+          thirdUser, receipt, headers, nextPaymentProcessing,
+        ))
           .to.eventually.be.rejected.and.to.eql({
             httpCode: 401,
             name: 'NotAuthorized',

test/api/unit/libs/payments/group-plans/group-payments-create.test.js

@@ -715,7 +715,7 @@ describe('Purchasing a group plan for group', () => {
     const mysteryItem = { title: 'item' };
     const mysteryItems = [mysteryItem];
     const consecutive = {
-      trinkets: 4,
+      trinkets: 3,
       gemCapExtra: 20,
       offset: 1,
       count: 13,

test/api/unit/libs/payments/payments.test.js

@@ -12,7 +12,6 @@ import {
 } from '../../../../helpers/api-unit.helper';
 import * as worldState from '../../../../../website/server/libs/worldState';
 import { TransactionModel } from '../../../../../website/server/models/transaction';
-import { REPEATING_EVENTS } from '../../../../../website/common/script/content/constants/events';
 
 describe('payments/index', () => {
   let user;
@@ -66,6 +65,7 @@ describe('payments/index', () => {
       mysteryItems: [],
       consecutive: {
         trinkets: 0,
+        offset: 0,
         gemCapExtra: 0,
       },
     };
@@ -108,8 +108,14 @@ describe('payments/index', () => {
       });
 
       it('add a transaction entry to the recipient', async () => {
+        recipient.purchased.plan = plan;
+
+        expect(recipient.purchased.plan.extraMonths).to.eql(0);
+
         await api.createSubscription(data);
 
+        expect(recipient.purchased.plan.extraMonths).to.eql(3);
+
         const transactions = await TransactionModel
           .find({ userId: recipient._id })
           .sort({ createdAt: -1 })
@@ -171,45 +177,6 @@ describe('payments/index', () => {
         expect(recipient.purchased.plan.dateUpdated).to.exist;
       });
 
-      it('does not reset gemCapExtra if they already had one', async () => {
-        recipient.purchased.plan.consecutive.gemCapExtra = 10;
-
-        await api.createSubscription(data);
-
-        expect(recipient.purchased.plan.consecutive.gemCapExtra).to.eql(10);
-      });
-
-      it('sets gemCapExtra to 0 if they receive a 3 month sub', async () => {
-        data.gift.subscription.key = 'basic_3mo';
-        data.gift.subscription.months = 3;
-
-        await api.createSubscription(data);
-
-        expect(recipient.purchased.plan.consecutive.gemCapExtra).to.eql(0);
-      });
-
-      it('sets gemCapExtra to max if they receive a 12 month sub', async () => {
-        recipient.purchased.plan.consecutive.gemCapExtra = 10;
-
-        data.gift.subscription.key = 'basic_12mo';
-        data.gift.subscription.months = 12;
-
-        await api.createSubscription(data);
-
-        expect(recipient.purchased.plan.consecutive.gemCapExtra).to.eql(26);
-      });
-
-      it('gives user 1 hourglass if they have no active subscription', async () => {
-        await api.createSubscription(data);
-        expect(recipient.purchased.plan.consecutive.trinkets).to.eql(1);
-      });
-
-      it('does not give any hourglasses if they have an active subscription', async () => {
-        recipient.purchased.plan = plan;
-        await api.createSubscription(data);
-        expect(recipient.purchased.plan.consecutive.trinkets).to.eql(plan.consecutive.trinkets);
-      });
-
       it('sets plan.dateUpdated if it did exist but the user has cancelled', async () => {
         recipient.purchased.plan.dateUpdated = moment().subtract(1, 'days').toDate();
         recipient.purchased.plan.dateTerminated = moment().subtract(1, 'days').toDate();
@@ -268,6 +235,116 @@ describe('payments/index', () => {
         expect(recipient.purchased.plan.customerId).to.eql('customer-id');
       });
 
+      it('sets plan.perkMonthCount to 1 if user is not subscribed', async () => {
+        recipient.purchased.plan = plan;
+        recipient.purchased.plan.perkMonthCount = 1;
+        recipient.purchased.plan.customerId = undefined;
+        data.sub.key = 'basic_earned';
+        data.gift.subscription.key = 'basic_earned';
+        data.gift.subscription.months = 1;
+
+        expect(recipient.purchased.plan.perkMonthCount).to.eql(1);
+        await api.createSubscription(data);
+
+        expect(recipient.purchased.plan.perkMonthCount).to.eql(1);
+      });
+
+      it('sets plan.perkMonthCount to 1 if field is not initialized', async () => {
+        recipient.purchased.plan = plan;
+        recipient.purchased.plan.perkMonthCount = -1;
+        recipient.purchased.plan.customerId = undefined;
+        data.sub.key = 'basic_earned';
+        data.gift.subscription.key = 'basic_earned';
+        data.gift.subscription.months = 1;
+
+        expect(recipient.purchased.plan.perkMonthCount).to.eql(-1);
+        await api.createSubscription(data);
+
+        expect(recipient.purchased.plan.perkMonthCount).to.eql(1);
+      });
+
+      it('sets plan.perkMonthCount to 1 if user had previous count but lapsed subscription', async () => {
+        recipient.purchased.plan = plan;
+        recipient.purchased.plan.perkMonthCount = 2;
+        recipient.purchased.plan.customerId = undefined;
+        data.sub.key = 'basic_earned';
+        data.gift.subscription.key = 'basic_earned';
+        data.gift.subscription.months = 1;
+
+        expect(recipient.purchased.plan.perkMonthCount).to.eql(2);
+        await api.createSubscription(data);
+
+        expect(recipient.purchased.plan.perkMonthCount).to.eql(1);
+      });
+
+      it('adds to plan.perkMonthCount if user is already subscribed', async () => {
+        recipient.purchased.plan = plan;
+        recipient.purchased.plan.perkMonthCount = 1;
+        data.sub.key = 'basic_earned';
+        data.gift.subscription.key = 'basic_earned';
+        data.gift.subscription.months = 1;
+
+        expect(recipient.purchased.plan.perkMonthCount).to.eql(1);
+        await api.createSubscription(data);
+
+        expect(recipient.purchased.plan.perkMonthCount).to.eql(2);
+      });
+
+      it('awards perks if plan.perkMonthCount reaches 3 with existing subscription', async () => {
+        recipient.purchased.plan = plan;
+        recipient.purchased.plan.perkMonthCount = 2;
+        data.sub.key = 'basic_earned';
+        data.gift.subscription.key = 'basic_earned';
+        data.gift.subscription.months = 1;
+
+        expect(recipient.purchased.plan.perkMonthCount).to.eql(2);
+        expect(recipient.purchased.plan.consecutive.trinkets).to.eql(0);
+        expect(recipient.purchased.plan.consecutive.gemCapExtra).to.eql(0);
+        await api.createSubscription(data);
+
+        expect(recipient.purchased.plan.perkMonthCount).to.eql(0);
+        expect(recipient.purchased.plan.consecutive.trinkets).to.eql(1);
+        expect(recipient.purchased.plan.consecutive.gemCapExtra).to.eql(5);
+      });
+
+      it('awards perks if plan.perkMonthCount reaches 3 without existing subscription', async () => {
+        recipient.purchased.plan.perkMonthCount = 0;
+        expect(recipient.purchased.plan.perkMonthCount).to.eql(0);
+        expect(recipient.purchased.plan.consecutive.trinkets).to.eql(0);
+        expect(recipient.purchased.plan.consecutive.gemCapExtra).to.eql(0);
+        await api.createSubscription(data);
+
+        expect(recipient.purchased.plan.perkMonthCount).to.eql(0);
+        expect(recipient.purchased.plan.consecutive.trinkets).to.eql(1);
+        expect(recipient.purchased.plan.consecutive.gemCapExtra).to.eql(5);
+      });
+
+      it('awards perks if plan.perkMonthCount reaches 3 without initialized field', async () => {
+        expect(recipient.purchased.plan.perkMonthCount).to.eql(-1);
+        expect(recipient.purchased.plan.consecutive.trinkets).to.eql(0);
+        expect(recipient.purchased.plan.consecutive.gemCapExtra).to.eql(0);
+        await api.createSubscription(data);
+
+        expect(recipient.purchased.plan.perkMonthCount).to.eql(0);
+        expect(recipient.purchased.plan.consecutive.trinkets).to.eql(1);
+        expect(recipient.purchased.plan.consecutive.gemCapExtra).to.eql(5);
+      });
+
+      it('awards perks if plan.perkMonthCount goes over 3', async () => {
+        recipient.purchased.plan = plan;
+        recipient.purchased.plan.perkMonthCount = 2;
+        data.sub.key = 'basic_earned';
+
+        expect(recipient.purchased.plan.perkMonthCount).to.eql(2);
+        expect(recipient.purchased.plan.consecutive.trinkets).to.eql(0);
+        expect(recipient.purchased.plan.consecutive.gemCapExtra).to.eql(0);
+        await api.createSubscription(data);
+
+        expect(recipient.purchased.plan.perkMonthCount).to.eql(2);
+        expect(recipient.purchased.plan.consecutive.trinkets).to.eql(1);
+        expect(recipient.purchased.plan.consecutive.gemCapExtra).to.eql(5);
+      });
+
       it('sets plan.customerId to "Gift" if it does not already exist', async () => {
         expect(recipient.purchased.plan.customerId).to.not.exist;
 
@@ -344,8 +421,8 @@ describe('payments/index', () => {
       context('Active Promotion', () => {
         beforeEach(() => {
           sinon.stub(worldState, 'getCurrentEventList').returns([{
-            ...REPEATING_EVENTS.giftOneGetOne,
-            event: 'g1g1',
+            ...common.content.events.winter2021Promo,
+            event: 'winter2021',
           }]);
         });
 
@@ -361,30 +438,22 @@ describe('payments/index', () => {
           expect(user.purchased.plan.dateTerminated).to.exist;
           expect(user.purchased.plan.dateUpdated).to.exist;
           expect(user.purchased.plan.dateCreated).to.exist;
-          expect(user.purchased.plan.consecutive.trinkets).to.eql(1);
-          expect(user.purchased.plan.consecutive.gemCapExtra).to.eql(0);
 
           expect(recipient.items.pets['Jackalope-RoyalPurple']).to.eql(5);
           expect(recipient.purchased.plan.customerId).to.eql('Gift');
           expect(recipient.purchased.plan.dateTerminated).to.exist;
           expect(recipient.purchased.plan.dateUpdated).to.exist;
           expect(recipient.purchased.plan.dateCreated).to.exist;
-          expect(recipient.purchased.plan.consecutive.trinkets).to.eql(1);
-          expect(recipient.purchased.plan.consecutive.gemCapExtra).to.eql(0);
         });
 
         it('adds extraMonths to existing subscription for purchaser and creates a gift subscription for recipient without sub', async () => {
           user.purchased.plan = plan;
 
           expect(user.purchased.plan.extraMonths).to.eql(0);
-          expect(user.purchased.plan.consecutive.trinkets).to.eql(0);
-          expect(user.purchased.plan.consecutive.gemCapExtra).to.eql(0);
 
           await api.createSubscription(data);
 
           expect(user.purchased.plan.extraMonths).to.eql(3);
-          expect(user.purchased.plan.consecutive.trinkets).to.eql(0);
-          expect(user.purchased.plan.consecutive.gemCapExtra).to.eql(0);
 
           expect(recipient.items.pets['Jackalope-RoyalPurple']).to.eql(5);
           expect(recipient.purchased.plan.customerId).to.eql('Gift');
@@ -397,12 +466,10 @@ describe('payments/index', () => {
           recipient.purchased.plan = plan;
 
           expect(recipient.purchased.plan.extraMonths).to.eql(0);
-          expect(recipient.purchased.plan.consecutive.trinkets).to.eql(0);
 
           await api.createSubscription(data);
 
           expect(recipient.purchased.plan.extraMonths).to.eql(3);
-          expect(recipient.purchased.plan.consecutive.trinkets).to.eql(0);
 
           expect(user.items.pets['Jackalope-RoyalPurple']).to.eql(5);
           expect(user.purchased.plan.customerId).to.eql('Gift');
@@ -417,15 +484,11 @@ describe('payments/index', () => {
 
           expect(user.purchased.plan.extraMonths).to.eql(0);
           expect(recipient.purchased.plan.extraMonths).to.eql(0);
-          expect(user.purchased.plan.consecutive.trinkets).to.eql(0);
-          expect(recipient.purchased.plan.consecutive.trinkets).to.eql(0);
 
           await api.createSubscription(data);
 
           expect(user.purchased.plan.extraMonths).to.eql(3);
           expect(recipient.purchased.plan.extraMonths).to.eql(3);
-          expect(user.purchased.plan.consecutive.trinkets).to.eql(0);
-          expect(recipient.purchased.plan.consecutive.trinkets).to.eql(0);
         });
 
         it('sends a private message about the promotion', async () => {
@@ -448,6 +511,7 @@ describe('payments/index', () => {
         expect(user.purchased.plan.customerId).to.eql('customer-id');
         expect(user.purchased.plan.dateUpdated).to.exist;
         expect(user.purchased.plan.gemsBought).to.eql(0);
+        expect(user.purchased.plan.perkMonthCount).to.eql(0);
         expect(user.purchased.plan.paymentMethod).to.eql('Payment Method');
         expect(user.purchased.plan.extraMonths).to.eql(0);
         expect(user.purchased.plan.dateTerminated).to.eql(null);
@@ -485,6 +549,33 @@ describe('payments/index', () => {
         expect(user.purchased.plan.dateCurrentTypeCreated).to.not.eql(initialDate);
       });
 
+      it('keeps plan.perkMonthCount when changing subscription type', async () => {
+        await api.createSubscription(data);
+        user.purchased.plan.perkMonthCount = 2;
+        await api.createSubscription(data);
+        expect(user.purchased.plan.perkMonthCount).to.eql(2);
+      });
+
+      it('sets plan.perkMonthCount to zero when creating new monthly subscription', async () => {
+        user.purchased.plan.perkMonthCount = 2;
+        await api.createSubscription(data);
+        expect(user.purchased.plan.perkMonthCount).to.eql(0);
+      });
+
+      it('sets plan.perkMonthCount to zero when creating new 3 month subscription', async () => {
+        user.purchased.plan.perkMonthCount = 2;
+        await api.createSubscription(data);
+        expect(user.purchased.plan.perkMonthCount).to.eql(0);
+      });
+
+      it('updates plan.consecutive.offset when changing subscription type', async () => {
+        await api.createSubscription(data);
+        expect(user.purchased.plan.consecutive.offset).to.eql(3);
+        data.sub.key = 'basic_6mo';
+        await api.createSubscription(data);
+        expect(user.purchased.plan.consecutive.offset).to.eql(6);
+      });
+
       it('awards the Royal Purple Jackalope pet', async () => {
         await api.createSubscription(data);
 
@@ -603,7 +694,6 @@ describe('payments/index', () => {
           expect(user.purchased.plan.dateCreated).to.eql(created);
           expect(user.purchased.plan.dateUpdated).to.not.eql(updated);
           expect(user.purchased.plan.customerId).to.eql('customer-id');
-          expect(user.purchased.plan.consecutive.gemCapExtra).to.eql(26);
         });
       });
 
@@ -651,20 +741,55 @@ describe('payments/index', () => {
     });
 
     context('Block subscription perks', () => {
-      it('adds 26 to plan.consecutive.gemCapExtra for 12 month block', async () => {
-        data.sub.key = 'basic_12mo';
+      it('adds block months to plan.consecutive.offset', async () => {
         await api.createSubscription(data);
 
-        expect(user.purchased.plan.consecutive.gemCapExtra).to.eql(26);
+        expect(user.purchased.plan.consecutive.offset).to.eql(3);
       });
 
-      it('does not raise plan.consecutive.gemCapExtra higher than 26', async () => {
+      it('does not add to plans.consecutive.offset if 1 month subscription', async () => {
+        data.sub.key = 'basic_earned';
+        await api.createSubscription(data);
+
+        expect(user.purchased.plan.consecutive.offset).to.eql(0);
+      });
+
+      it('resets plans.consecutive.offset if 1 month subscription', async () => {
+        user.purchased.plan.consecutive.offset = 1;
+        await user.save();
+        data.sub.key = 'basic_earned';
+        await api.createSubscription(data);
+
+        expect(user.purchased.plan.consecutive.offset).to.eql(0);
+      });
+
+      it('adds 5 to plan.consecutive.gemCapExtra for 3 month block', async () => {
+        await api.createSubscription(data);
+
+        expect(user.purchased.plan.consecutive.gemCapExtra).to.eql(5);
+      });
+
+      it('adds 10 to plan.consecutive.gemCapExtra for 6 month block', async () => {
+        data.sub.key = 'basic_6mo';
+        await api.createSubscription(data);
+
+        expect(user.purchased.plan.consecutive.gemCapExtra).to.eql(10);
+      });
+
+      it('adds 20 to plan.consecutive.gemCapExtra for 12 month block', async () => {
+        data.sub.key = 'basic_12mo';
+        await api.createSubscription(data);
+
+        expect(user.purchased.plan.consecutive.gemCapExtra).to.eql(20);
+      });
+
+      it('does not raise plan.consecutive.gemCapExtra higher than 25', async () => {
         data.sub.key = 'basic_12mo';
 
         await api.createSubscription(data);
         await api.createSubscription(data);
 
-        expect(user.purchased.plan.consecutive.gemCapExtra).to.eql(26);
+        expect(user.purchased.plan.consecutive.gemCapExtra).to.eql(25);
       });
 
       it('adds a plan.consecutive.trinkets for 3 month block', async () => {
@@ -673,29 +798,20 @@ describe('payments/index', () => {
         expect(user.purchased.plan.consecutive.trinkets).to.eql(1);
       });
 
-      it('adds 1 plan.consecutive.trinkets for 6 month block', async () => {
+      it('adds 2 plan.consecutive.trinkets for 6 month block', async () => {
         data.sub.key = 'basic_6mo';
 
         await api.createSubscription(data);
 
-        expect(user.purchased.plan.consecutive.trinkets).to.eql(1);
+        expect(user.purchased.plan.consecutive.trinkets).to.eql(2);
       });
 
-      it('adds 1 plan.consecutive.trinkets for 12 month block if they had promo', async () => {
-        user.purchased.plan.hourglassPromoReceived = new Date();
+      it('adds 4 plan.consecutive.trinkets for 12 month block', async () => {
         data.sub.key = 'basic_12mo';
 
         await api.createSubscription(data);
 
-        expect(user.purchased.plan.consecutive.trinkets).to.eql(1);
-      });
-
-      it('adds 12 plan.consecutive.trinkets for 12 month block', async () => {
-        data.sub.key = 'basic_12mo';
-
-        await api.createSubscription(data);
-
-        expect(user.purchased.plan.consecutive.trinkets).to.eql(13);
+        expect(user.purchased.plan.consecutive.trinkets).to.eql(4);
       });
 
       context('Upgrades subscription', () => {
@@ -703,38 +819,70 @@ describe('payments/index', () => {
           beforeEach(async () => {
             data.updatedFrom = { logic: 'payDifference' };
           });
-          it('Adds 26 to plan.consecutive.gemCapExtra when upgrading from basic_3mo to basic_12mo', async () => {
+          it('Adds 10 to plan.consecutive.gemCapExtra from basic_earned to basic_6mo', async () => {
+            data.sub.key = 'basic_earned';
+            expect(user.purchased.plan.planId).to.not.exist;
+
+            await api.createSubscription(data);
+
+            expect(user.purchased.plan.planId).to.eql('basic_earned');
+            expect(user.purchased.plan.consecutive.gemCapExtra).to.eql(0);
+
+            data.sub.key = 'basic_6mo';
+            data.updatedFrom.key = 'basic_earned';
+            await api.createSubscription(data);
+            expect(user.purchased.plan.planId).to.eql('basic_6mo');
+            expect(user.purchased.plan.consecutive.gemCapExtra).to.eql(10);
+          });
+
+          it('Adds 15 to plan.consecutive.gemCapExtra when upgrading from basic_3mo to basic_12mo', async () => {
             expect(user.purchased.plan.planId).to.not.exist;
 
             await api.createSubscription(data);
 
             expect(user.purchased.plan.planId).to.eql('basic_3mo');
-            expect(user.purchased.plan.consecutive.gemCapExtra).to.eql(0);
+            expect(user.purchased.plan.consecutive.gemCapExtra).to.eql(5);
 
             data.sub.key = 'basic_12mo';
             data.updatedFrom.key = 'basic_3mo';
             await api.createSubscription(data);
             expect(user.purchased.plan.planId).to.eql('basic_12mo');
-            expect(user.purchased.plan.consecutive.gemCapExtra).to.eql(26);
+            expect(user.purchased.plan.consecutive.gemCapExtra).to.eql(20);
           });
 
-          it('Adds 12 to plan.consecutive.trinkets when upgrading from basic_6mo to basic_12mo', async () => {
+          it('Adds 2 to plan.consecutive.trinkets from basic_earned to basic_6mo', async () => {
+            data.sub.key = 'basic_earned';
+            expect(user.purchased.plan.planId).to.not.exist;
+
+            await api.createSubscription(data);
+
+            expect(user.purchased.plan.planId).to.eql('basic_earned');
+            expect(user.purchased.plan.consecutive.trinkets).to.eql(0);
+
+            data.sub.key = 'basic_6mo';
+            data.updatedFrom.key = 'basic_earned';
+            await api.createSubscription(data);
+            expect(user.purchased.plan.planId).to.eql('basic_6mo');
+            expect(user.purchased.plan.consecutive.trinkets).to.eql(2);
+          });
+
+          it('Adds 2 to plan.consecutive.trinkets when upgrading from basic_6mo to basic_12mo', async () => {
             data.sub.key = 'basic_6mo';
             expect(user.purchased.plan.planId).to.not.exist;
 
             await api.createSubscription(data);
 
             expect(user.purchased.plan.planId).to.eql('basic_6mo');
-            expect(user.purchased.plan.consecutive.trinkets).to.eql(1);
+            expect(user.purchased.plan.consecutive.trinkets).to.eql(2);
 
             data.sub.key = 'basic_12mo';
             data.updatedFrom.key = 'basic_6mo';
             await api.createSubscription(data);
             expect(user.purchased.plan.planId).to.eql('basic_12mo');
-            expect(user.purchased.plan.consecutive.trinkets).to.eql(13);
+            expect(user.purchased.plan.consecutive.trinkets).to.eql(4);
           });
 
-          it('Adds 12 to plan.consecutive.trinkets when upgrading from basic_3mo to basic_12mo', async () => {
+          it('Adds 3 to plan.consecutive.trinkets when upgrading from basic_3mo to basic_12mo', async () => {
             expect(user.purchased.plan.planId).to.not.exist;
 
             await api.createSubscription(data);
@@ -746,7 +894,7 @@ describe('payments/index', () => {
             data.updatedFrom.key = 'basic_3mo';
             await api.createSubscription(data);
             expect(user.purchased.plan.planId).to.eql('basic_12mo');
-            expect(user.purchased.plan.consecutive.trinkets).to.eql(13);
+            expect(user.purchased.plan.consecutive.trinkets).to.eql(4);
           });
         });
 
@@ -754,39 +902,70 @@ describe('payments/index', () => {
           beforeEach(async () => {
             data.updatedFrom = { logic: 'payFull' };
           });
+          it('Adds 10 to plan.consecutive.gemCapExtra from basic_earned to basic_6mo', async () => {
+            data.sub.key = 'basic_earned';
+            expect(user.purchased.plan.planId).to.not.exist;
 
-          it('Adds 26 to plan.consecutive.gemCapExtra when upgrading from basic_3mo to basic_12mo', async () => {
+            await api.createSubscription(data);
+
+            expect(user.purchased.plan.planId).to.eql('basic_earned');
+            expect(user.purchased.plan.consecutive.gemCapExtra).to.eql(0);
+
+            data.sub.key = 'basic_6mo';
+            data.updatedFrom.key = 'basic_earned';
+            await api.createSubscription(data);
+            expect(user.purchased.plan.planId).to.eql('basic_6mo');
+            expect(user.purchased.plan.consecutive.gemCapExtra).to.eql(10);
+          });
+
+          it('Adds 20 to plan.consecutive.gemCapExtra when upgrading from basic_3mo to basic_12mo', async () => {
             expect(user.purchased.plan.planId).to.not.exist;
 
             await api.createSubscription(data);
 
             expect(user.purchased.plan.planId).to.eql('basic_3mo');
-            expect(user.purchased.plan.consecutive.gemCapExtra).to.eql(0);
+            expect(user.purchased.plan.consecutive.gemCapExtra).to.eql(5);
 
             data.sub.key = 'basic_12mo';
             data.updatedFrom.key = 'basic_3mo';
             await api.createSubscription(data);
             expect(user.purchased.plan.planId).to.eql('basic_12mo');
-            expect(user.purchased.plan.consecutive.gemCapExtra).to.eql(26);
+            expect(user.purchased.plan.consecutive.gemCapExtra).to.eql(25);
           });
 
-          it('Adds 12 to plan.consecutive.trinkets when upgrading from basic_6mo to basic_12mo', async () => {
+          it('Adds 2 to plan.consecutive.trinkets from basic_earned to basic_6mo', async () => {
+            data.sub.key = 'basic_earned';
+            expect(user.purchased.plan.planId).to.not.exist;
+
+            await api.createSubscription(data);
+
+            expect(user.purchased.plan.planId).to.eql('basic_earned');
+            expect(user.purchased.plan.consecutive.trinkets).to.eql(0);
+
+            data.sub.key = 'basic_6mo';
+            data.updatedFrom.key = 'basic_earned';
+            await api.createSubscription(data);
+            expect(user.purchased.plan.planId).to.eql('basic_6mo');
+            expect(user.purchased.plan.consecutive.trinkets).to.eql(2);
+          });
+
+          it('Adds 4 to plan.consecutive.trinkets when upgrading from basic_6mo to basic_12mo', async () => {
             data.sub.key = 'basic_6mo';
             expect(user.purchased.plan.planId).to.not.exist;
 
             await api.createSubscription(data);
 
             expect(user.purchased.plan.planId).to.eql('basic_6mo');
-            expect(user.purchased.plan.consecutive.trinkets).to.eql(1);
+            expect(user.purchased.plan.consecutive.trinkets).to.eql(2);
 
             data.sub.key = 'basic_12mo';
             data.updatedFrom.key = 'basic_6mo';
             await api.createSubscription(data);
             expect(user.purchased.plan.planId).to.eql('basic_12mo');
-            expect(user.purchased.plan.consecutive.trinkets).to.eql(13);
+            expect(user.purchased.plan.consecutive.trinkets).to.eql(6);
           });
 
-          it('Adds 12 to plan.consecutive.trinkets when upgrading from basic_3mo to basic_12mo', async () => {
+          it('Adds 4 to plan.consecutive.trinkets when upgrading from basic_3mo to basic_12mo', async () => {
             expect(user.purchased.plan.planId).to.not.exist;
 
             await api.createSubscription(data);
@@ -798,7 +977,7 @@ describe('payments/index', () => {
             data.updatedFrom.key = 'basic_3mo';
             await api.createSubscription(data);
             expect(user.purchased.plan.planId).to.eql('basic_12mo');
-            expect(user.purchased.plan.consecutive.trinkets).to.eql(13);
+            expect(user.purchased.plan.consecutive.trinkets).to.eql(5);
           });
         });
 
@@ -809,13 +988,30 @@ describe('payments/index', () => {
             data.updatedFrom = { logic: 'refundAndRepay' };
           });
           context('Upgrades within first half of subscription', () => {
-            it('Adds 26 to plan.consecutive.gemCapExtra when upgrading from basic_3mo to basic_12mo', async () => {
+            it('Adds 10 to plan.consecutive.gemCapExtra from basic_earned to basic_6mo', async () => {
+              data.sub.key = 'basic_earned';
+              expect(user.purchased.plan.planId).to.not.exist;
+              await api.createSubscription(data);
+
+              expect(user.purchased.plan.planId).to.eql('basic_earned');
+              expect(user.purchased.plan.consecutive.gemCapExtra).to.eql(0);
+
+              data.sub.key = 'basic_6mo';
+              data.updatedFrom.key = 'basic_earned';
+              clock.restore();
+              clock = sinon.useFakeTimers(new Date('2022-01-10'));
+              await api.createSubscription(data);
+              expect(user.purchased.plan.planId).to.eql('basic_6mo');
+              expect(user.purchased.plan.consecutive.gemCapExtra).to.eql(10);
+            });
+
+            it('Adds 15 to plan.consecutive.gemCapExtra when upgrading from basic_3mo to basic_12mo', async () => {
               expect(user.purchased.plan.planId).to.not.exist;
 
               await api.createSubscription(data);
 
               expect(user.purchased.plan.planId).to.eql('basic_3mo');
-              expect(user.purchased.plan.consecutive.gemCapExtra).to.eql(0);
+              expect(user.purchased.plan.consecutive.gemCapExtra).to.eql(5);
 
               data.sub.key = 'basic_12mo';
               data.updatedFrom.key = 'basic_3mo';
@@ -823,10 +1019,28 @@ describe('payments/index', () => {
               clock = sinon.useFakeTimers(new Date('2022-02-05'));
               await api.createSubscription(data);
               expect(user.purchased.plan.planId).to.eql('basic_12mo');
-              expect(user.purchased.plan.consecutive.gemCapExtra).to.eql(26);
+              expect(user.purchased.plan.consecutive.gemCapExtra).to.eql(20);
             });
 
-            it('Adds 12 to plan.consecutive.trinkets when upgrading from basic_3mo to basic_12mo', async () => {
+            it('Adds 2 to plan.consecutive.trinkets from basic_earned to basic_6mo', async () => {
+              data.sub.key = 'basic_earned';
+              expect(user.purchased.plan.planId).to.not.exist;
+
+              await api.createSubscription(data);
+
+              expect(user.purchased.plan.planId).to.eql('basic_earned');
+              expect(user.purchased.plan.consecutive.trinkets).to.eql(0);
+
+              data.sub.key = 'basic_6mo';
+              data.updatedFrom.key = 'basic_earned';
+              clock.restore();
+              clock = sinon.useFakeTimers(new Date('2022-01-08'));
+              await api.createSubscription(data);
+              expect(user.purchased.plan.planId).to.eql('basic_6mo');
+              expect(user.purchased.plan.consecutive.trinkets).to.eql(2);
+            });
+
+            it('Adds 3 to plan.consecutive.trinkets when upgrading from basic_3mo to basic_12mo', async () => {
               expect(user.purchased.plan.planId).to.not.exist;
 
               await api.createSubscription(data);
@@ -840,17 +1054,17 @@ describe('payments/index', () => {
               clock = sinon.useFakeTimers(new Date('2022-01-31'));
               await api.createSubscription(data);
               expect(user.purchased.plan.planId).to.eql('basic_12mo');
-              expect(user.purchased.plan.consecutive.trinkets).to.eql(13);
+              expect(user.purchased.plan.consecutive.trinkets).to.eql(4);
             });
 
-            it('Adds 12 to plan.consecutive.trinkets when upgrading from basic_6mo to basic_12mo', async () => {
+            it('Adds 2 to plan.consecutive.trinkets when upgrading from basic_6mo to basic_12mo', async () => {
               data.sub.key = 'basic_6mo';
               expect(user.purchased.plan.planId).to.not.exist;
 
               await api.createSubscription(data);
 
               expect(user.purchased.plan.planId).to.eql('basic_6mo');
-              expect(user.purchased.plan.consecutive.trinkets).to.eql(1);
+              expect(user.purchased.plan.consecutive.trinkets).to.eql(2);
 
               data.sub.key = 'basic_12mo';
               data.updatedFrom.key = 'basic_6mo';
@@ -858,17 +1072,35 @@ describe('payments/index', () => {
               clock = sinon.useFakeTimers(new Date('2022-01-28'));
               await api.createSubscription(data);
               expect(user.purchased.plan.planId).to.eql('basic_12mo');
-              expect(user.purchased.plan.consecutive.trinkets).to.eql(13);
+              expect(user.purchased.plan.consecutive.trinkets).to.eql(4);
             });
 
-            it('2 plan.consecutive.trinkets when upgrading from basic_6mo to basic_12mo after initial cycle', async () => {
+            it('Adds 2 to plan.consecutive.trinkets from basic_earned to basic_6mo after initial cycle', async () => {
+              data.sub.key = 'basic_earned';
+              expect(user.purchased.plan.planId).to.not.exist;
+
+              await api.createSubscription(data);
+
+              expect(user.purchased.plan.planId).to.eql('basic_earned');
+              expect(user.purchased.plan.consecutive.trinkets).to.eql(0);
+
+              data.sub.key = 'basic_6mo';
+              data.updatedFrom.key = 'basic_earned';
+              clock.restore();
+              clock = sinon.useFakeTimers(new Date('2024-01-08'));
+              await api.createSubscription(data);
+              expect(user.purchased.plan.planId).to.eql('basic_6mo');
+              expect(user.purchased.plan.consecutive.trinkets).to.eql(2);
+            });
+
+            it('Adds 2 to plan.consecutive.trinkets when upgrading from basic_6mo to basic_12mo after initial cycle', async () => {
               data.sub.key = 'basic_6mo';
               expect(user.purchased.plan.planId).to.not.exist;
 
               await api.createSubscription(data);
 
               expect(user.purchased.plan.planId).to.eql('basic_6mo');
-              expect(user.purchased.plan.consecutive.trinkets).to.eql(1);
+              expect(user.purchased.plan.consecutive.trinkets).to.eql(2);
 
               data.sub.key = 'basic_12mo';
               data.updatedFrom.key = 'basic_6mo';
@@ -876,10 +1108,10 @@ describe('payments/index', () => {
               clock = sinon.useFakeTimers(new Date('2022-08-28'));
               await api.createSubscription(data);
               expect(user.purchased.plan.planId).to.eql('basic_12mo');
-              expect(user.purchased.plan.consecutive.trinkets).to.eql(13);
+              expect(user.purchased.plan.consecutive.trinkets).to.eql(4);
             });
 
-            it('Adds 12 to plan.consecutive.trinkets when upgrading from basic_3mo to basic_12mo after initial cycle', async () => {
+            it('Adds 3 to plan.consecutive.trinkets when upgrading from basic_3mo to basic_12mo after initial cycle', async () => {
               expect(user.purchased.plan.planId).to.not.exist;
 
               await api.createSubscription(data);
@@ -893,11 +1125,11 @@ describe('payments/index', () => {
               clock = sinon.useFakeTimers(new Date('2022-07-31'));
               await api.createSubscription(data);
               expect(user.purchased.plan.planId).to.eql('basic_12mo');
-              expect(user.purchased.plan.consecutive.trinkets).to.eql(13);
+              expect(user.purchased.plan.consecutive.trinkets).to.eql(4);
             });
           });
           context('Upgrades within second half of subscription', () => {
-            it('Adds 0 to plan.consecutive.gemCapExtra from basic_earned to basic_6mo', async () => {
+            it('Adds 10 to plan.consecutive.gemCapExtra from basic_earned to basic_6mo', async () => {
               data.sub.key = 'basic_earned';
               expect(user.purchased.plan.planId).to.not.exist;
 
@@ -912,16 +1144,16 @@ describe('payments/index', () => {
               clock = sinon.useFakeTimers(new Date('2022-01-20'));
               await api.createSubscription(data);
               expect(user.purchased.plan.planId).to.eql('basic_6mo');
-              expect(user.purchased.plan.consecutive.gemCapExtra).to.eql(0);
+              expect(user.purchased.plan.consecutive.gemCapExtra).to.eql(10);
             });
 
-            it('Adds 26 to plan.consecutive.gemCapExtra when upgrading from basic_3mo to basic_12mo', async () => {
+            it('Adds 20 to plan.consecutive.gemCapExtra when upgrading from basic_3mo to basic_12mo', async () => {
               expect(user.purchased.plan.planId).to.not.exist;
 
               await api.createSubscription(data);
 
               expect(user.purchased.plan.planId).to.eql('basic_3mo');
-              expect(user.purchased.plan.consecutive.gemCapExtra).to.eql(0);
+              expect(user.purchased.plan.consecutive.gemCapExtra).to.eql(5);
 
               data.sub.key = 'basic_12mo';
               data.updatedFrom.key = 'basic_3mo';
@@ -929,17 +1161,17 @@ describe('payments/index', () => {
               clock = sinon.useFakeTimers(new Date('2022-02-24'));
               await api.createSubscription(data);
               expect(user.purchased.plan.planId).to.eql('basic_12mo');
-              expect(user.purchased.plan.consecutive.gemCapExtra).to.eql(26);
+              expect(user.purchased.plan.consecutive.gemCapExtra).to.eql(25);
             });
 
-            it('Adds 0 to plan.consecutive.trinkets from basic_earned to basic_6mo', async () => {
+            it('Adds 2 to plan.consecutive.trinkets from basic_earned to basic_6mo', async () => {
               data.sub.key = 'basic_earned';
               expect(user.purchased.plan.planId).to.not.exist;
 
               await api.createSubscription(data);
 
               expect(user.purchased.plan.planId).to.eql('basic_earned');
-              expect(user.purchased.plan.consecutive.trinkets).to.eql(1);
+              expect(user.purchased.plan.consecutive.trinkets).to.eql(0);
 
               data.sub.key = 'basic_6mo';
               data.updatedFrom.key = 'basic_earned';
@@ -947,17 +1179,17 @@ describe('payments/index', () => {
               clock = sinon.useFakeTimers(new Date('2022-01-28'));
               await api.createSubscription(data);
               expect(user.purchased.plan.planId).to.eql('basic_6mo');
-              expect(user.purchased.plan.consecutive.trinkets).to.eql(1);
+              expect(user.purchased.plan.consecutive.trinkets).to.eql(2);
             });
 
-            it('Adds 12 to plan.consecutive.trinkets when upgrading from basic_6mo to basic_12mo', async () => {
+            it('Adds 4 to plan.consecutive.trinkets when upgrading from basic_6mo to basic_12mo', async () => {
               data.sub.key = 'basic_6mo';
               expect(user.purchased.plan.planId).to.not.exist;
 
               await api.createSubscription(data);
 
               expect(user.purchased.plan.planId).to.eql('basic_6mo');
-              expect(user.purchased.plan.consecutive.trinkets).to.eql(1);
+              expect(user.purchased.plan.consecutive.trinkets).to.eql(2);
 
               data.sub.key = 'basic_12mo';
               data.updatedFrom.key = 'basic_6mo';
@@ -965,10 +1197,10 @@ describe('payments/index', () => {
               clock = sinon.useFakeTimers(new Date('2022-05-28'));
               await api.createSubscription(data);
               expect(user.purchased.plan.planId).to.eql('basic_12mo');
-              expect(user.purchased.plan.consecutive.trinkets).to.eql(13);
+              expect(user.purchased.plan.consecutive.trinkets).to.eql(6);
             });
 
-            it('Adds 12 to plan.consecutive.trinkets when upgrading from basic_3mo to basic_12mo', async () => {
+            it('Adds 4 to plan.consecutive.trinkets when upgrading from basic_3mo to basic_12mo', async () => {
               expect(user.purchased.plan.planId).to.not.exist;
 
               await api.createSubscription(data);
@@ -982,17 +1214,17 @@ describe('payments/index', () => {
               clock = sinon.useFakeTimers(new Date('2022-03-03'));
               await api.createSubscription(data);
               expect(user.purchased.plan.planId).to.eql('basic_12mo');
-              expect(user.purchased.plan.consecutive.trinkets).to.eql(13);
+              expect(user.purchased.plan.consecutive.trinkets).to.eql(5);
             });
 
-            it('Adds 0 to plan.consecutive.trinkets from basic_earned to basic_6mo after initial cycle', async () => {
+            it('Adds 2 to plan.consecutive.trinkets from basic_earned to basic_6mo after initial cycle', async () => {
               data.sub.key = 'basic_earned';
               expect(user.purchased.plan.planId).to.not.exist;
 
               await api.createSubscription(data);
 
               expect(user.purchased.plan.planId).to.eql('basic_earned');
-              expect(user.purchased.plan.consecutive.trinkets).to.eql(1);
+              expect(user.purchased.plan.consecutive.trinkets).to.eql(0);
 
               data.sub.key = 'basic_6mo';
               data.updatedFrom.key = 'basic_earned';
@@ -1000,17 +1232,17 @@ describe('payments/index', () => {
               clock = sinon.useFakeTimers(new Date('2022-05-28'));
               await api.createSubscription(data);
               expect(user.purchased.plan.planId).to.eql('basic_6mo');
-              expect(user.purchased.plan.consecutive.trinkets).to.eql(1);
+              expect(user.purchased.plan.consecutive.trinkets).to.eql(2);
             });
 
-            it('Adds 12 to plan.consecutive.trinkets when upgrading from basic_6mo to basic_12mo after initial cycle', async () => {
+            it('Adds 4 to plan.consecutive.trinkets when upgrading from basic_6mo to basic_12mo after initial cycle', async () => {
               data.sub.key = 'basic_6mo';
               expect(user.purchased.plan.planId).to.not.exist;
 
               await api.createSubscription(data);
 
               expect(user.purchased.plan.planId).to.eql('basic_6mo');
-              expect(user.purchased.plan.consecutive.trinkets).to.eql(1);
+              expect(user.purchased.plan.consecutive.trinkets).to.eql(2);
 
               data.sub.key = 'basic_12mo';
               data.updatedFrom.key = 'basic_6mo';
@@ -1018,10 +1250,10 @@ describe('payments/index', () => {
               clock = sinon.useFakeTimers(new Date('2023-05-28'));
               await api.createSubscription(data);
               expect(user.purchased.plan.planId).to.eql('basic_12mo');
-              expect(user.purchased.plan.consecutive.trinkets).to.eql(13);
+              expect(user.purchased.plan.consecutive.trinkets).to.eql(6);
             });
 
-            it('Adds 12 to plan.consecutive.trinkets when upgrading from basic_3mo to basic_12mo after initial cycle', async () => {
+            it('Adds 4 to plan.consecutive.trinkets when upgrading from basic_3mo to basic_12mo after initial cycle', async () => {
               expect(user.purchased.plan.planId).to.not.exist;
 
               await api.createSubscription(data);
@@ -1035,7 +1267,7 @@ describe('payments/index', () => {
               clock = sinon.useFakeTimers(new Date('2023-09-03'));
               await api.createSubscription(data);
               expect(user.purchased.plan.planId).to.eql('basic_12mo');
-              expect(user.purchased.plan.consecutive.trinkets).to.eql(13);
+              expect(user.purchased.plan.consecutive.trinkets).to.eql(5);
             });
           });
           afterEach(async () => {
@@ -1045,6 +1277,22 @@ describe('payments/index', () => {
       });
 
       context('Downgrades subscription', () => {
+        it('does not remove from plan.consecutive.gemCapExtra from basic_6mo to basic_earned', async () => {
+          data.sub.key = 'basic_6mo';
+          expect(user.purchased.plan.planId).to.not.exist;
+
+          await api.createSubscription(data);
+
+          expect(user.purchased.plan.planId).to.eql('basic_6mo');
+          expect(user.purchased.plan.consecutive.gemCapExtra).to.eql(10);
+
+          data.sub.key = 'basic_earned';
+          data.updatedFrom = { key: 'basic_6mo' };
+          await api.createSubscription(data);
+          expect(user.purchased.plan.planId).to.eql('basic_earned');
+          expect(user.purchased.plan.consecutive.gemCapExtra).to.eql(10);
+        });
+
         it('does not remove from plan.consecutive.gemCapExtra from basic_12mo to basic_3mo', async () => {
           expect(user.purchased.plan.planId).to.not.exist;
 
@@ -1052,12 +1300,28 @@ describe('payments/index', () => {
           await api.createSubscription(data);
 
           expect(user.purchased.plan.planId).to.eql('basic_12mo');
-          expect(user.purchased.plan.consecutive.gemCapExtra).to.eql(26);
+          expect(user.purchased.plan.consecutive.gemCapExtra).to.eql(20);
 
           data.sub.key = 'basic_3mo';
           data.updatedFrom = { key: 'basic_12mo' };
           await api.createSubscription(data);
-          expect(user.purchased.plan.consecutive.gemCapExtra).to.eql(26);
+          expect(user.purchased.plan.consecutive.gemCapExtra).to.eql(20);
+        });
+
+        it('does not remove from plan.consecutive.trinkets from basic_6mo to basic_earned', async () => {
+          data.sub.key = 'basic_6mo';
+          expect(user.purchased.plan.planId).to.not.exist;
+
+          await api.createSubscription(data);
+
+          expect(user.purchased.plan.planId).to.eql('basic_6mo');
+          expect(user.purchased.plan.consecutive.trinkets).to.eql(2);
+
+          data.sub.key = 'basic_earned';
+          data.updatedFrom = { key: 'basic_6mo' };
+          await api.createSubscription(data);
+          expect(user.purchased.plan.planId).to.eql('basic_earned');
+          expect(user.purchased.plan.consecutive.trinkets).to.eql(2);
         });
 
         it('does not remove from plan.consecutive.trinkets from basic_12mo to basic_3mo', async () => {
@@ -1067,12 +1331,12 @@ describe('payments/index', () => {
           await api.createSubscription(data);
 
           expect(user.purchased.plan.planId).to.eql('basic_12mo');
-          expect(user.purchased.plan.consecutive.trinkets).to.eql(13);
+          expect(user.purchased.plan.consecutive.trinkets).to.eql(4);
 
           data.sub.key = 'basic_3mo';
           data.updatedFrom = { key: 'basic_12mo' };
           await api.createSubscription(data);
-          expect(user.purchased.plan.consecutive.trinkets).to.eql(13);
+          expect(user.purchased.plan.consecutive.trinkets).to.eql(4);
         });
       });
     });
@@ -1118,6 +1382,18 @@ describe('payments/index', () => {
         expect(user.purchased.plan.mysteryItems).to.have.a.lengthOf(1);
         expect(user.purchased.plan.mysteryItems).to.include('head_mystery_201605');
       });
+
+      it('does not award mystery item when user already has the item in the mystery box', async () => {
+        user.purchased.plan.mysteryItems = [mayMysteryItem];
+
+        sandbox.spy(user.purchased.plan.mysteryItems, 'push');
+
+        data = { paymentMethod: 'PaymentMethod', user, sub: { key: 'basic_3mo' } };
+        await api.createSubscription(data);
+
+        expect(user.purchased.plan.mysteryItems.push).to.be.calledOnce;
+        expect(user.purchased.plan.mysteryItems.push).to.be.calledWith('head_mystery_201605');
+      });
     });
   });
 
@@ -1189,32 +1465,6 @@ describe('payments/index', () => {
         expect(user.purchased.plan.extraMonths).to.eql(0);
       });
 
-      it('does not reset gemCapExtra', async () => {
-        user.purchased.plan.consecutive.gemCapExtra = 12;
-
-        await api.cancelSubscription(data);
-
-        expect(user.purchased.plan.consecutive.gemCapExtra).to.eql(12);
-      });
-
-      it('initializes gemCapExtra', async () => {
-        await api.cancelSubscription(data);
-        expect(user.purchased.plan.consecutive.gemCapExtra).to.eql(0);
-      });
-
-      it('initializes hourglasses', async () => {
-        await api.cancelSubscription(data);
-        expect(user.purchased.plan.consecutive.trinkets).to.eql(0);
-      });
-
-      it('does not reset owned hourglasses', async () => {
-        user.purchased.plan.consecutive.trinkets = 12;
-
-        await api.cancelSubscription(data);
-
-        expect(user.purchased.plan.consecutive.trinkets).to.eql(12);
-      });
-
       it('sends an email', async () => {
         await api.cancelSubscription(data);
 
@@ -1349,10 +1599,10 @@ describe('payments/index', () => {
       it('sends gem donation message in each participant\'s language', async () => {
         // TODO using english for both users because other languages are not loaded
         // for api.buyGems
-        await recipient.updateOne({
+        await recipient.update({
           'preferences.language': 'en',
         });
-        await user.updateOne({
+        await user.update({
           'preferences.language': 'en',
         });
         await api.buyGems(data);

test/api/unit/libs/payments/paypal/checkout.test.js

@@ -4,7 +4,7 @@ import nconf from 'nconf';
 import paypalPayments from '../../../../../../website/server/libs/payments/paypal';
 import { model as User } from '../../../../../../website/server/models/user';
 import common from '../../../../../../website/common';
-import { apiError } from '../../../../../../website/server/libs/apiError';
+import apiError from '../../../../../../website/server/libs/apiError';
 import * as gems from '../../../../../../website/server/libs/payments/gems';
 
 const BASE_URL = nconf.get('BASE_URL');

test/api/unit/libs/payments/stripe/checkout.test.js

@@ -51,7 +51,6 @@ describe('Stripe - Checkout', () => {
         gift: undefined,
         sub: undefined,
         gemsBlock: gemsBlockKey,
-        server_url: BASE_URL,
       };
 
       expect(gems.validateGiftMessage).to.not.be.called;
@@ -102,7 +101,6 @@ describe('Stripe - Checkout', () => {
         gift: JSON.stringify(gift),
         sub: undefined,
         gemsBlock: undefined,
-        server_url: BASE_URL,
       };
 
       expect(gems.validateGiftMessage).to.be.calledOnce;
@@ -157,7 +155,6 @@ describe('Stripe - Checkout', () => {
         gift: JSON.stringify(gift),
         sub: undefined,
         gemsBlock: undefined,
-        server_url: BASE_URL,
       };
 
       expect(oneTimePayments.getOneTimePaymentInfo).to.be.calledOnce;
@@ -195,7 +192,6 @@ describe('Stripe - Checkout', () => {
         userId: user._id,
         gift: undefined,
         sub: JSON.stringify(sub),
-        server_url: BASE_URL,
       };
 
       expect(subscriptions.checkSubData).to.be.calledOnce;
@@ -262,7 +258,6 @@ describe('Stripe - Checkout', () => {
         userId: user._id,
         gift: undefined,
         sub: JSON.stringify(sub),
-        server_url: BASE_URL,
         groupId,
       };
 
@@ -333,9 +328,8 @@ describe('Stripe - Checkout', () => {
       user.purchased.plan.customerId = customerId;
 
       const metadata = {
-        type: 'edit-card-user',
         userId: user._id,
-        server_url: BASE_URL,
+        type: 'edit-card-user',
       };
 
       const res = await createEditCardCheckoutSession({ user }, stripe);
@@ -424,7 +418,6 @@ describe('Stripe - Checkout', () => {
         const metadata = {
           userId: user._id,
           type: 'edit-card-group',
-          server_url: BASE_URL,
           groupId,
         };
 
@@ -462,7 +455,6 @@ describe('Stripe - Checkout', () => {
           userId: anotherUser._id,
           type: 'edit-card-group',
           groupId,
-          server_url: BASE_URL,
         };
 
         const res = await createEditCardCheckoutSession({ user: anotherUser, groupId }, stripe);

test/api/unit/libs/payments/stripe/oneTimePayments.test.js

@@ -1,4 +1,4 @@
-import { apiError } from '../../../../../../website/server/libs/apiError';
+import apiError from '../../../../../../website/server/libs/apiError';
 import common from '../../../../../../website/common';
 import {
   getOneTimePaymentInfo,
@@ -308,7 +308,6 @@ describe('Stripe - One Time Payments', () => {
           customerId,
           paymentMethod: 'Gift',
           gift,
-          autoRenews: false,
           gemsBlock: undefined,
         });
       });

test/api/unit/libs/payments/stripe/subscriptions.test.js

@@ -173,7 +173,6 @@ describe('Stripe - Subscriptions', () => {
         paymentMethod: 'Stripe',
         sub: sinon.match({ ...sub }),
         groupId: null,
-        autoRenews: true,
       });
     });
 
@@ -198,7 +197,6 @@ describe('Stripe - Subscriptions', () => {
         paymentMethod: 'Stripe',
         sub: sinon.match({ ...sub }),
         groupId,
-        autoRenews: true,
       });
     });
 
@@ -233,7 +231,6 @@ describe('Stripe - Subscriptions', () => {
         paymentMethod: 'Stripe',
         sub: sinon.match({ ...sub }),
         groupId,
-        autoRenews: true,
       });
     });
   });

test/api/unit/libs/payments/stripe/webhooks.test.js

@@ -16,7 +16,6 @@ import * as subscriptions from '../../../../../../website/server/libs/payments/s
 const { i18n } = common;
 
 describe('Stripe - Webhooks', () => {
-  const BASE_URL = nconf.get('BASE_URL');
   const stripe = stripeModule('test');
   const endpointSecret = nconf.get('STRIPE_WEBHOOKS_ENDPOINT_SECRET');
   const headers = {};
@@ -285,9 +284,7 @@ describe('Stripe - Webhooks', () => {
     const session = {};
 
     beforeEach(() => {
-      session.metadata = {
-        server_url: BASE_URL,
-      };
+      session.metadata = {};
       event = { type: eventType, data: { object: session } };
       constructEventStub = sandbox.stub(stripe.webhooks, 'constructEvent');
       constructEventStub.returns(event);

test/api/unit/libs/pushNotifications.js

@@ -0,0 +1,184 @@
+import apn from '@parse/node-apn/mock';
+import _ from 'lodash';
+import nconf from 'nconf';
+import gcmLib from 'node-gcm'; // works with FCM notifications too
+import { model as User } from '../../../../website/server/models/user';
+import {
+  sendNotification as sendPushNotification,
+  MAX_MESSAGE_LENGTH,
+} from '../../../../website/server/libs/pushNotifications';
+
+describe('pushNotifications', () => {
+  let user;
+  let fcmSendSpy;
+  let apnSendSpy;
+
+  const identifier = 'identifier';
+  const title = 'title';
+  const message = 'message';
+
+  beforeEach(() => {
+    user = new User();
+    fcmSendSpy = sinon.spy();
+    apnSendSpy = sinon.spy();
+
+    sandbox.stub(nconf, 'get').returns('true-key');
+
+    sandbox.stub(gcmLib.Sender.prototype, 'send').callsFake(fcmSendSpy);
+
+    sandbox.stub(apn.Provider.prototype, 'send').returns({
+      on: () => null,
+      send: apnSendSpy,
+    });
+  });
+
+  afterEach(() => {
+    sandbox.restore();
+  });
+
+  it('throws if user is not supplied', () => {
+    expect(sendPushNotification).to.throw;
+    expect(fcmSendSpy).to.not.have.been.called;
+    expect(apnSendSpy).to.not.have.been.called;
+  });
+
+  it('throws if user.preferences.pushNotifications.unsubscribeFromAll is true', () => {
+    user.preferences.pushNotifications.unsubscribeFromAll = true;
+    expect(() => sendPushNotification(user)).to.throw;
+    expect(fcmSendSpy).to.not.have.been.called;
+    expect(apnSendSpy).to.not.have.been.called;
+  });
+
+  it('throws if details.identifier is not supplied', () => {
+    expect(() => sendPushNotification(user, {
+      title,
+      message,
+    })).to.throw;
+    expect(fcmSendSpy).to.not.have.been.called;
+    expect(apnSendSpy).to.not.have.been.called;
+  });
+
+  it('throws if details.title is not supplied', () => {
+    expect(() => sendPushNotification(user, {
+      identifier,
+      message,
+    })).to.throw;
+    expect(fcmSendSpy).to.not.have.been.called;
+    expect(apnSendSpy).to.not.have.been.called;
+  });
+
+  it('throws if details.message is not supplied', () => {
+    expect(() => sendPushNotification(user, {
+      identifier,
+      title,
+    })).to.throw;
+    expect(fcmSendSpy).to.not.have.been.called;
+    expect(apnSendSpy).to.not.have.been.called;
+  });
+
+  it('returns if no device is registered', () => {
+    sendPushNotification(user, {
+      identifier,
+      title,
+      message,
+    });
+    expect(fcmSendSpy).to.not.have.been.called;
+    expect(apnSendSpy).to.not.have.been.called;
+  });
+
+  it('cuts the message to 300 chars', () => {
+    const longMessage = `12345 12345 12345 12345 12345 12345 12345
+      12345 12345 12345 12345 12345 12345 12345 12345 12345 12345
+      12345 12345 12345 12345 12345 12345 12345 12345 12345 12345
+      12345 12345 12345 12345 12345 12345 12345 12345 12345 12345
+      12345 12345 12345 12345 12345 12345 12345 12345 12345 12345
+      12345 12345 12345 12345 12345 12345 12345 12345 12345 12345
+      12345 12345 12345 12345 12345 12345 12345 12345 12345 12345
+      12345 12345 12345 12345 12345 12345 12345 12345 12345 12345
+      12345 12345 12345 12345 12345 12345 12345 12345 12345 12345
+      12345 12345 12345 12345 12345 12345 12345 12345 12345 12345
+      12345 12345 12345 12345 12345 12345 12345 12345 12345 12345`;
+
+    expect(longMessage.length > MAX_MESSAGE_LENGTH).to.equal(true);
+
+    const details = {
+      identifier,
+      title,
+      message: longMessage,
+      payload: {
+        message: longMessage,
+      },
+    };
+
+    sendPushNotification(user, details);
+
+    expect(details.message).to.equal(_.truncate(longMessage, { length: MAX_MESSAGE_LENGTH }));
+    expect(details.payload.message)
+      .to.equal(_.truncate(longMessage, { length: MAX_MESSAGE_LENGTH }));
+
+    expect(details.message.length).to.equal(MAX_MESSAGE_LENGTH);
+    expect(details.payload.message.length).to.equal(MAX_MESSAGE_LENGTH);
+  });
+
+  it('cuts the message to 300 chars (no payload)', () => {
+    const longMessage = `12345 12345 12345 12345 12345 12345 12345
+      12345 12345 12345 12345 12345 12345 12345 12345 12345 12345
+      12345 12345 12345 12345 12345 12345 12345 12345 12345 12345
+      12345 12345 12345 12345 12345 12345 12345 12345 12345 12345
+      12345 12345 12345 12345 12345 12345 12345 12345 12345 12345
+      12345 12345 12345 12345 12345 12345 12345 12345 12345 12345
+      12345 12345 12345 12345 12345 12345 12345 12345 12345 12345
+      12345 12345 12345 12345 12345 12345 12345 12345 12345 12345
+      12345 12345 12345 12345 12345 12345 12345 12345 12345 12345
+      12345 12345 12345 12345 12345 12345 12345 12345 12345 12345
+      12345 12345 12345 12345 12345 12345 12345 12345 12345 12345`;
+
+    expect(longMessage.length > MAX_MESSAGE_LENGTH).to.equal(true);
+
+    const details = {
+      identifier,
+      title,
+      message: longMessage,
+    };
+
+    sendPushNotification(user, details);
+
+    expect(details.message).to.equal(_.truncate(longMessage, { length: MAX_MESSAGE_LENGTH }));
+    expect(details.message.length).to.equal(MAX_MESSAGE_LENGTH);
+  });
+
+  // TODO disabled because APN relies on a Promise
+  xit('uses APN for iOS devices', () => {
+    user.pushDevices.push({
+      type: 'ios',
+      regId: '123',
+    });
+
+    const details = {
+      identifier,
+      title,
+      message,
+      category: 'fun',
+      payload: {
+        a: true,
+        b: true,
+      },
+    };
+
+    const expectedNotification = new apn.Notification({
+      alert: message,
+      sound: 'default',
+      category: 'fun',
+      payload: {
+        identifier,
+        a: true,
+        b: true,
+      },
+    });
+
+    sendPushNotification(user, details);
+    expect(apnSendSpy).to.have.been.calledOnce;
+    expect(apnSendSpy).to.have.been.calledWithMatch(expectedNotification, '123');
+    expect(fcmSendSpy).to.not.have.been.called;
+  });
+});

test/api/unit/libs/pushNotifications.test.js

@@ -1,354 +0,0 @@
-import apn from '@parse/node-apn';
-import _ from 'lodash';
-import nconf from 'nconf';
-import admin from 'firebase-admin';
-import { model as User } from '../../../../website/server/models/user';
-import {
-  MAX_MESSAGE_LENGTH,
-} from '../../../../website/server/libs/pushNotifications';
-
-let sendPushNotification;
-
-describe('pushNotifications', () => {
-  let user;
-  let fcmSendSpy;
-  let apnSendSpy;
-  let updateStub;
-  let classStubbedInstance;
-
-  const identifier = 'identifier';
-  const title = 'title';
-  const message = 'message';
-
-  beforeEach(() => {
-    user = new User();
-    fcmSendSpy = sinon.stub().returns(Promise.resolve('success'));
-    apnSendSpy = sinon.stub().returns(Promise.resolve());
-
-    nconf.set('PUSH_CONFIGS_APN_ENABLED', 'true');
-
-    classStubbedInstance = sandbox.createStubInstance(apn.Provider, {
-      send: apnSendSpy,
-    });
-    sandbox.stub(apn, 'Provider').returns(classStubbedInstance);
-
-    delete require.cache[require.resolve('../../../../website/server/libs/pushNotifications')];
-    // eslint-disable-next-line global-require
-    sendPushNotification = require('../../../../website/server/libs/pushNotifications').sendNotification;
-
-    updateStub = sandbox.stub(User, 'updateOne').resolves();
-    sandbox.stub(admin, 'messaging').get(() => () => ({ send: fcmSendSpy }));
-  });
-
-  afterEach(() => {
-    sandbox.restore();
-  });
-
-  describe('validates supplied data', () => {
-    it('throws if user is not supplied', () => {
-      expect(sendPushNotification).to.throw;
-      expect(fcmSendSpy).to.not.have.been.called;
-      expect(apnSendSpy).to.not.have.been.called;
-    });
-
-    it('throws if user.preferences.pushNotifications.unsubscribeFromAll is true', () => {
-      user.preferences.pushNotifications.unsubscribeFromAll = true;
-      expect(() => sendPushNotification(user)).to.throw;
-      expect(fcmSendSpy).to.not.have.been.called;
-      expect(apnSendSpy).to.not.have.been.called;
-    });
-
-    it('throws if details.identifier is not supplied', () => {
-      expect(() => sendPushNotification(user, {
-        title,
-        message,
-      })).to.throw;
-      expect(fcmSendSpy).to.not.have.been.called;
-      expect(apnSendSpy).to.not.have.been.called;
-    });
-
-    it('throws if details.title is not supplied', () => {
-      expect(() => sendPushNotification(user, {
-        identifier,
-        message,
-      })).to.throw;
-      expect(fcmSendSpy).to.not.have.been.called;
-      expect(apnSendSpy).to.not.have.been.called;
-    });
-
-    it('throws if details.message is not supplied', () => {
-      expect(() => sendPushNotification(user, {
-        identifier,
-        title,
-      })).to.throw;
-      expect(fcmSendSpy).to.not.have.been.called;
-      expect(apnSendSpy).to.not.have.been.called;
-    });
-
-    it('returns if no device is registered', () => {
-      sendPushNotification(user, {
-        identifier,
-        title,
-        message,
-      });
-      expect(fcmSendSpy).to.not.have.been.called;
-      expect(apnSendSpy).to.not.have.been.called;
-    });
-  });
-
-  it('cuts the message to 300 chars', () => {
-    const longMessage = `12345 12345 12345 12345 12345 12345 12345
-      12345 12345 12345 12345 12345 12345 12345 12345 12345 12345
-      12345 12345 12345 12345 12345 12345 12345 12345 12345 12345
-      12345 12345 12345 12345 12345 12345 12345 12345 12345 12345
-      12345 12345 12345 12345 12345 12345 12345 12345 12345 12345
-      12345 12345 12345 12345 12345 12345 12345 12345 12345 12345
-      12345 12345 12345 12345 12345 12345 12345 12345 12345 12345
-      12345 12345 12345 12345 12345 12345 12345 12345 12345 12345
-      12345 12345 12345 12345 12345 12345 12345 12345 12345 12345
-      12345 12345 12345 12345 12345 12345 12345 12345 12345 12345
-      12345 12345 12345 12345 12345 12345 12345 12345 12345 12345`;
-
-    expect(longMessage.length > MAX_MESSAGE_LENGTH).to.equal(true);
-
-    const details = {
-      identifier,
-      title,
-      message: longMessage,
-      payload: {
-        message: longMessage,
-      },
-    };
-
-    sendPushNotification(user, details);
-
-    expect(details.message).to.equal(_.truncate(longMessage, { length: MAX_MESSAGE_LENGTH }));
-    expect(details.payload.message)
-      .to.equal(_.truncate(longMessage, { length: MAX_MESSAGE_LENGTH }));
-
-    expect(details.message.length).to.equal(MAX_MESSAGE_LENGTH);
-    expect(details.payload.message.length).to.equal(MAX_MESSAGE_LENGTH);
-  });
-
-  it('cuts the message to 300 chars (no payload)', () => {
-    const longMessage = `12345 12345 12345 12345 12345 12345 12345
-      12345 12345 12345 12345 12345 12345 12345 12345 12345 12345
-      12345 12345 12345 12345 12345 12345 12345 12345 12345 12345
-      12345 12345 12345 12345 12345 12345 12345 12345 12345 12345
-      12345 12345 12345 12345 12345 12345 12345 12345 12345 12345
-      12345 12345 12345 12345 12345 12345 12345 12345 12345 12345
-      12345 12345 12345 12345 12345 12345 12345 12345 12345 12345
-      12345 12345 12345 12345 12345 12345 12345 12345 12345 12345
-      12345 12345 12345 12345 12345 12345 12345 12345 12345 12345
-      12345 12345 12345 12345 12345 12345 12345 12345 12345 12345
-      12345 12345 12345 12345 12345 12345 12345 12345 12345 12345`;
-
-    expect(longMessage.length > MAX_MESSAGE_LENGTH).to.equal(true);
-
-    const details = {
-      identifier,
-      title,
-      message: longMessage,
-    };
-
-    sendPushNotification(user, details);
-
-    expect(details.message).to.equal(_.truncate(longMessage, { length: MAX_MESSAGE_LENGTH }));
-    expect(details.message.length).to.equal(MAX_MESSAGE_LENGTH);
-  });
-
-  describe('sends notifications', () => {
-    let details;
-
-    beforeEach(() => {
-      details = {
-        identifier,
-        title,
-        message,
-        category: 'fun',
-        payload: {
-          a: true,
-          b: true,
-        },
-      };
-    });
-
-    it('uses APN for iOS devices', async () => {
-      user.pushDevices.push({
-        type: 'ios',
-        regId: '123',
-      });
-
-      const expectedNotification = new apn.Notification({
-        alert: {
-          title,
-          body: message,
-        },
-        sound: 'default',
-        category: 'fun',
-        payload: {
-          identifier,
-          a: true,
-          b: true,
-        },
-      });
-
-      await sendPushNotification(user, details);
-      expect(apnSendSpy).to.have.been.calledOnce;
-      expect(apnSendSpy).to.have.been.calledWithMatch(expectedNotification, '123');
-      expect(fcmSendSpy).to.not.have.been.called;
-    });
-
-    it('uses FCM for Android devices', async () => {
-      user.pushDevices.push({
-        type: 'android',
-        regId: '123',
-      });
-
-      const expectedMessage = {
-        notification: {
-          title,
-          body: message,
-        },
-        data: {
-          identifier,
-          notificationIdentifier: identifier,
-        },
-        token: '123',
-      };
-
-      await sendPushNotification(user, details);
-      expect(fcmSendSpy).to.have.been.calledOnce;
-      expect(fcmSendSpy).to.have.been.calledWithMatch(expectedMessage);
-      expect(apnSendSpy).to.not.have.been.called;
-    });
-
-    it('handles multiple devices', async () => {
-      user.pushDevices.push({
-        type: 'android',
-        regId: '123',
-      });
-      user.pushDevices.push({
-        type: 'ios',
-        regId: '456',
-      });
-      user.pushDevices.push({
-        type: 'android',
-        regId: '789',
-      });
-
-      await sendPushNotification(user, details);
-      expect(fcmSendSpy).to.have.been.calledTwice;
-      expect(apnSendSpy).to.have.been.calledOnce;
-    });
-  });
-
-  describe('handles sending errors', () => {
-    let clock;
-
-    beforeEach(() => {
-      clock = sinon.useFakeTimers();
-    });
-
-    afterEach(() => {
-      clock.restore();
-    });
-
-    it('removes unregistered fcm devices', async () => {
-      user.pushDevices.push({
-        type: 'android',
-        regId: '123',
-      });
-
-      const error = new Error();
-      error.code = 'messaging/registration-token-not-registered';
-      fcmSendSpy.rejects(error);
-
-      await sendPushNotification(user, {
-        identifier,
-        title,
-        message,
-      });
-
-      expect(fcmSendSpy).to.have.been.calledOnce;
-      expect(apnSendSpy).to.not.have.been.called;
-      await clock.tick(10);
-      expect(updateStub).to.have.been.calledOnce;
-    });
-
-    it('removes invalid fcm devices', async () => {
-      user.pushDevices.push({
-        type: 'android',
-        regId: '123',
-      });
-
-      const error = new Error();
-      error.code = 'messaging/registration-token-not-registered';
-      fcmSendSpy.rejects(error);
-
-      await sendPushNotification(user, {
-        identifier,
-        title,
-        message,
-      });
-
-      expect(fcmSendSpy).to.have.been.calledOnce;
-      expect(apnSendSpy).to.not.have.been.called;
-      expect(updateStub).to.have.been.calledOnce;
-    });
-
-    it('removes unregistered apn devices', async () => {
-      user.pushDevices.push({
-        type: 'ios',
-        regId: '123',
-      });
-
-      const error = {
-        failed: [
-          {
-            device: '123',
-            response: { reason: 'Unregistered' },
-          },
-        ],
-      };
-      apnSendSpy.resolves(error);
-
-      await sendPushNotification(user, {
-        identifier,
-        title,
-        message,
-      });
-
-      expect(fcmSendSpy).to.not.have.been.called;
-      expect(apnSendSpy).to.have.been.calledOnce;
-      expect(updateStub).to.have.been.calledOnce;
-    });
-
-    it('removes invalid apn devices', async () => {
-      user.pushDevices.push({
-        type: 'ios',
-        regId: '123',
-      });
-
-      const error = {
-        failed: [
-          {
-            device: '123',
-            response: { reason: 'BadDeviceToken' },
-          },
-        ],
-      };
-      apnSendSpy.resolves(error);
-
-      await sendPushNotification(user, {
-        identifier,
-        title,
-        message,
-      });
-
-      expect(fcmSendSpy).to.not.have.been.called;
-      expect(apnSendSpy).to.have.been.calledOnce;
-      expect(updateStub).to.have.been.calledOnce;
-    });
-  });
-});

test/api/unit/middlewares/auth.test.js

@@ -1,11 +1,8 @@
-import nconf from 'nconf';
-import requireAgain from 'require-again';
 import {
   generateRes,
   generateReq,
 } from '../../../helpers/api-unit.helper';
-
-const authPath = '../../../../website/server/middlewares/auth';
+import { authWithHeaders as authWithHeadersFactory } from '../../../../website/server/middlewares/auth';
 
 describe('auth middleware', () => {
   let res; let req; let
@@ -19,7 +16,6 @@ describe('auth middleware', () => {
 
   describe('auth with headers', () => {
     it('allows to specify a list of user field that we do not want to load', done => {
-      const authWithHeadersFactory = requireAgain(authPath).authWithHeaders;
       const authWithHeaders = authWithHeadersFactory({
         userFieldsToExclude: ['items'],
       });
@@ -39,7 +35,6 @@ describe('auth middleware', () => {
     });
 
     it('makes sure some fields are always included', done => {
-      const authWithHeadersFactory = requireAgain(authPath).authWithHeaders;
       const authWithHeaders = authWithHeadersFactory({
         userFieldsToExclude: [
           'items', 'auth.timestamps',
@@ -65,57 +60,5 @@ describe('auth middleware', () => {
         return done();
       });
     });
-
-    it('errors with InvalidCredentialsError and code when token is wrong', done => {
-      const authWithHeadersFactory = requireAgain(authPath).authWithHeaders;
-      const authWithHeaders = authWithHeadersFactory({ userFieldsToExclude: [] });
-
-      req.headers['x-api-user'] = user._id;
-      req.headers['x-api-key'] = 'totally-wrong-token';
-
-      authWithHeaders(req, res, err => {
-        expect(err).to.exist;
-        expect(err.name).to.equal('InvalidCredentialsError');
-        expect(err.code).to.equal('invalid_credentials');
-        expect(err.message).to.equal(res.t('invalidCredentials'));
-        return done();
-      });
-    });
-
-    describe('when ENFORCE_CLIENT_HEADER is true', () => {
-      let authFactory;
-
-      beforeEach(() => {
-        sandbox.stub(nconf, 'get').withArgs('ENFORCE_CLIENT_HEADER').returns('true');
-        authFactory = requireAgain(authPath).authWithHeaders;
-      });
-
-      it('errors with missingClientHeader when x-client header is not present', done => {
-        const authWithHeaders = authFactory({ userFieldsToExclude: [] });
-
-        req.headers['x-api-user'] = user._id;
-        req.headers['x-api-key'] = user;
-        authWithHeaders(req, res, err => {
-          expect(err).to.exist;
-          expect(err.name).to.equal('BadRequest');
-          expect(err.message).to.equal(res.t('missingClientHeader'));
-          return done();
-        });
-      });
-
-      it('allows request to pass when x-client header is present', done => {
-        const authWithHeaders = authFactory({ userFieldsToExclude: [] });
-
-        req.headers['x-api-user'] = user._id;
-        req.headers['x-api-key'] = user.apiToken;
-        req.headers['x-client'] = 'habitica-web';
-
-        authWithHeaders(req, res, err => {
-          if (err) return done(err);
-          expect(res.locals.user).to.exist;
-          return done();
-        });
-      });
-    });
   });
 });

test/api/unit/middlewares/blocker.test.js

@@ -1,197 +0,0 @@
-import nconf from 'nconf';
-import requireAgain from 'require-again';
-import {
-  generateRes,
-  generateReq,
-  generateNext,
-} from '../../../helpers/api-unit.helper';
-import { Forbidden } from '../../../../website/server/libs/errors';
-import { apiError } from '../../../../website/server/libs/apiError';
-import { model as Blocker } from '../../../../website/server/models/blocker';
-
-function checkIPBlockedErrorThrown (next) {
-  expect(next).to.have.been.calledOnce;
-  const calledWith = next.getCall(0).args;
-  expect(calledWith[0].message).to.equal(apiError('ipAddressBlocked'));
-  expect(calledWith[0] instanceof Forbidden).to.equal(true);
-}
-
-function checkClientBlockedErrorThrown (next) {
-  expect(next).to.have.been.calledOnce;
-  const calledWith = next.getCall(0).args;
-  expect(calledWith[0].message).to.equal(apiError('clientBlocked'));
-  expect(calledWith[0] instanceof Forbidden).to.equal(true);
-}
-
-function checkErrorNotThrown (next) {
-  expect(next).to.have.been.calledOnce;
-  const calledWith = next.getCall(0).args;
-  expect(typeof calledWith[0] === 'undefined').to.equal(true);
-}
-
-describe('Blocker middleware', () => {
-  const pathToBlocker = '../../../../website/server/middlewares/blocker';
-
-  let res; let req; let next;
-
-  beforeEach(() => {
-    res = generateRes();
-    req = generateReq();
-    next = generateNext();
-  });
-
-  describe('Blocking IPs', () => {
-    it('is disabled when the env var is not defined', () => {
-      sandbox.stub(nconf, 'get').withArgs('BLOCKED_IPS').returns(undefined);
-      const attachBlocker = requireAgain(pathToBlocker).default;
-      attachBlocker(req, res, next);
-
-      checkErrorNotThrown(next);
-    });
-
-    it('is disabled when the env var is an empty string', () => {
-      sandbox.stub(nconf, 'get').withArgs('BLOCKED_IPS').returns('');
-      const attachBlocker = requireAgain(pathToBlocker).default;
-      attachBlocker(req, res, next);
-
-      checkErrorNotThrown(next);
-    });
-
-    it('is disabled when the env var contains comma separated empty strings', () => {
-      sandbox.stub(nconf, 'get').withArgs('BLOCKED_IPS').returns(' , , ');
-      const attachBlocker = requireAgain(pathToBlocker).default;
-      attachBlocker(req, res, next);
-
-      checkErrorNotThrown(next);
-    });
-
-    it('does not throw when the ip does not match', () => {
-      req.ip = '192.168.1.1';
-      sandbox.stub(nconf, 'get').withArgs('BLOCKED_IPS').returns('192.168.1.2');
-      const attachBlocker = requireAgain(pathToBlocker).default;
-      attachBlocker(req, res, next);
-
-      checkErrorNotThrown(next);
-    });
-
-    it('does not throw when the blocker IP does not match', async () => {
-      req.ip = '192.168.1.1';
-      sandbox.stub(Blocker, 'watchBlockers').returns({
-        on: (event, callback) => {
-          if (event === 'change') {
-            callback({ operation: 'add', blocker: { type: 'ipaddress', area: 'full', value: '192.168.1.2' } });
-          }
-        },
-      });
-      const attachBlocker = requireAgain(pathToBlocker).default;
-      attachBlocker(req, res, next);
-
-      checkErrorNotThrown(next);
-    });
-
-    it('does not throw when a client is blocked', async () => {
-      sandbox.stub(Blocker, 'watchBlockers').returns({
-        on: (event, callback) => {
-          if (event === 'change') {
-            callback({ operation: 'add', blocker: { type: 'client', area: 'full', value: '192.168.1.1' } });
-          }
-        },
-      });
-      const attachBlocker = requireAgain(pathToBlocker).default;
-      attachBlocker(req, res, next);
-
-      checkErrorNotThrown(next);
-    });
-
-    it('throws when the blocker IP is blocked', async () => {
-      req.ip = '192.168.1.1';
-      sandbox.stub(Blocker, 'watchBlockers').returns({
-        on: (event, callback) => {
-          if (event === 'change') {
-            callback({ operation: 'add', blocker: { type: 'ipaddress', area: 'full', value: '192.168.1.1' } });
-          }
-        },
-      });
-      const attachBlocker = requireAgain(pathToBlocker).default;
-      attachBlocker(req, res, next);
-
-      checkIPBlockedErrorThrown(next);
-    });
-  });
-
-  describe('Blocking clients', () => {
-    beforeEach(() => {
-      sandbox.stub(nconf, 'get').withArgs('BLOCKED_IPS').returns('');
-      req.headers['x-client'] = 'test-client';
-    });
-    it('is disabled when no clients are blocked', () => {
-      const attachBlocker = requireAgain(pathToBlocker).default;
-      attachBlocker(req, res, next);
-
-      checkErrorNotThrown(next);
-    });
-
-    it('does not throw when the client does not match', async () => {
-      sandbox.stub(Blocker, 'watchBlockers').returns({
-        on: (event, callback) => {
-          if (event === 'change') {
-            callback({ operation: 'add', blocker: { type: 'client', area: 'full', value: 'another-client' } });
-          }
-        },
-      });
-      const attachBlocker = requireAgain(pathToBlocker).default;
-      attachBlocker(req, res, next);
-
-      checkErrorNotThrown(next);
-    });
-
-    it('throws when the client is blocked', async () => {
-      sandbox.stub(Blocker, 'watchBlockers').returns({
-        on: (event, callback) => {
-          if (event === 'change') {
-            callback({ operation: 'add', blocker: { type: 'client', area: 'full', value: 'test-client' } });
-          }
-        },
-      });
-      const attachBlocker = requireAgain(pathToBlocker).default;
-      attachBlocker(req, res, next);
-
-      checkClientBlockedErrorThrown(next);
-    });
-
-    it('does not throw when an ip is blocked', async () => {
-      sandbox.stub(Blocker, 'watchBlockers').returns({
-        on: (event, callback) => {
-          if (event === 'change') {
-            callback({ operation: 'add', blocker: { type: 'ipaddress', area: 'full', value: 'test-client' } });
-          }
-        },
-      });
-      const attachBlocker = requireAgain(pathToBlocker).default;
-      attachBlocker(req, res, next);
-
-      checkErrorNotThrown(next);
-    });
-
-    it('updates the list when data changes', async () => {
-      let blockCallback;
-      sandbox.stub(Blocker, 'watchBlockers').returns({
-        on: (event, callback) => {
-          blockCallback = callback;
-          if (event === 'change') {
-            callback({ operation: 'add', blocker: { type: 'client', area: 'full', value: 'another-client' } });
-          }
-        },
-      });
-      const attachBlocker = requireAgain(pathToBlocker).default;
-      attachBlocker(req, res, next);
-      checkErrorNotThrown(next);
-      blockCallback({ operation: 'add', blocker: { type: 'client', area: 'full', value: 'test-client' } });
-      attachBlocker(req, res, next);
-      expect(next).to.have.been.calledTwice;
-      const calledWith = next.getCall(1).args;
-      expect(calledWith[0].message).to.equal(apiError('clientBlocked'));
-      expect(calledWith[0] instanceof Forbidden).to.equal(true);
-    });
-  });
-});

test/api/unit/middlewares/cronMiddleware.js

@@ -0,0 +1,341 @@
+import moment from 'moment';
+import { v4 as generateUUID } from 'uuid';
+import {
+  generateRes,
+  generateReq,
+  generateTodo,
+  generateDaily,
+} from '../../../helpers/api-unit.helper';
+import cronMiddleware from '../../../../website/server/middlewares/cron';
+import { model as User } from '../../../../website/server/models/user';
+import { model as Group } from '../../../../website/server/models/group';
+import * as Tasks from '../../../../website/server/models/task';
+import * as analyticsService from '../../../../website/server/libs/analyticsService';
+import * as cronLib from '../../../../website/server/libs/cron';
+
+const CRON_TIMEOUT_WAIT = new Date(60 * 60 * 1000).getTime();
+const CRON_TIMEOUT_UNIT = new Date(60 * 1000).getTime();
+
+describe('cron middleware', () => {
+  let res; let
+    req;
+  let user;
+
+  beforeEach(async () => {
+    res = generateRes();
+    req = generateReq();
+    user = await res.locals.user.save();
+    res.analytics = analyticsService;
+  });
+
+  afterEach(() => {
+    sandbox.restore();
+  });
+
+  it('calls next when user is not attached', done => {
+    res.locals.user = null;
+    cronMiddleware(req, res, done);
+  });
+
+  it('calls next when days have not been missed', done => {
+    cronMiddleware(req, res, done);
+  });
+
+  it('should clear todos older than 30 days for free users', async () => {
+    user.lastCron = moment(new Date()).subtract({ days: 2 });
+    const task = generateTodo(user);
+    task.dateCompleted = moment(new Date()).subtract({ days: 31 });
+    task.completed = true;
+    await task.save();
+    await user.save();
+
+    await new Promise((resolve, reject) => {
+      cronMiddleware(req, res, err => {
+        if (err) return reject(err);
+
+        Tasks.Task.findOne({ _id: task }, (secondErr, taskFound) => {
+          if (secondErr) return reject(err);
+          expect(secondErr).to.not.exist;
+          expect(taskFound).to.not.exist;
+          return resolve();
+        });
+
+        return null;
+      });
+    });
+  });
+
+  it('should not clear todos older than 30 days for subscribed users', async () => {
+    user.purchased.plan.customerId = 'subscribedId';
+    user.purchased.plan.dateUpdated = moment('012013', 'MMYYYY');
+    user.lastCron = moment(new Date()).subtract({ days: 2 });
+    const task = generateTodo(user);
+    task.dateCompleted = moment(new Date()).subtract({ days: 31 });
+    task.completed = true;
+    await task.save();
+    await user.save();
+
+    await new Promise((resolve, reject) => {
+      cronMiddleware(req, res, err => {
+        if (err) return reject(err);
+        Tasks.Task.findOne({ _id: task }, (secondErr, taskFound) => {
+          if (secondErr) return reject(secondErr);
+          expect(secondErr).to.not.exist;
+          expect(taskFound).to.exist;
+          return resolve();
+        });
+        return null;
+      });
+    });
+  });
+
+  it('should clear todos older than 90 days for subscribed users', async () => {
+    user.purchased.plan.customerId = 'subscribedId';
+    user.purchased.plan.dateUpdated = moment('012013', 'MMYYYY');
+    user.lastCron = moment(new Date()).subtract({ days: 2 });
+
+    const task = generateTodo(user);
+    task.dateCompleted = moment(new Date()).subtract({ days: 91 });
+    task.completed = true;
+    await task.save();
+    await user.save();
+
+    await new Promise((resolve, reject) => {
+      cronMiddleware(req, res, err => {
+        if (err) return reject(err);
+        Tasks.Task.findOne({ _id: task }, (secondErr, taskFound) => {
+          if (secondErr) return reject(secondErr);
+          expect(secondErr).to.not.exist;
+          expect(taskFound).to.not.exist;
+          return resolve();
+        });
+        return null;
+      });
+    });
+  });
+
+  it('should call next if user was not modified after cron', async () => {
+    const hpBefore = user.stats.hp;
+    user.lastCron = moment(new Date()).subtract({ days: 2 });
+    await user.save();
+
+    await new Promise((resolve, reject) => {
+      cronMiddleware(req, res, err => {
+        if (err) return reject(err);
+        expect(hpBefore).to.equal(user.stats.hp);
+        return resolve();
+      });
+    });
+  });
+
+  it('runs cron if previous cron was incomplete', async () => {
+    user.lastCron = moment(new Date()).subtract({ days: 1 });
+    user.auth.timestamps.loggedin = moment(new Date()).subtract({ days: 4 });
+    const now = new Date();
+    await user.save();
+
+    await new Promise((resolve, reject) => {
+      cronMiddleware(req, res, err => {
+        if (err) return reject(err);
+        expect(moment(now).isSame(user.lastCron, 'day'));
+        expect(moment(now).isSame(user.auth.timestamps.loggedin, 'day'));
+        return resolve();
+      });
+    });
+  });
+
+  it('updates user.auth.timestamps.loggedin and lastCron', async () => {
+    user.lastCron = moment(new Date()).subtract({ days: 2 });
+    const now = new Date();
+    await user.save();
+
+    await new Promise((resolve, reject) => {
+      cronMiddleware(req, res, err => {
+        if (err) return reject(err);
+        expect(moment(now).isSame(user.lastCron, 'day'));
+        expect(moment(now).isSame(user.auth.timestamps.loggedin, 'day'));
+        return resolve();
+      });
+    });
+  });
+
+  it('does damage for missing dailies', async () => {
+    const hpBefore = user.stats.hp;
+    user.lastCron = moment(new Date()).subtract({ days: 2 });
+    const daily = generateDaily(user);
+    daily.startDate = moment(new Date()).subtract({ days: 2 });
+    await daily.save();
+    await user.save();
+
+    await new Promise((resolve, reject) => {
+      cronMiddleware(req, res, err => {
+        if (err) return reject(err);
+        return User.findOne({ _id: user._id }, (secondErr, updatedUser) => {
+          if (secondErr) return reject(secondErr);
+          expect(updatedUser.stats.hp).to.be.lessThan(hpBefore);
+          return resolve();
+        });
+      });
+    });
+  });
+
+  it('updates tasks', async () => {
+    user.lastCron = moment(new Date()).subtract({ days: 2 });
+    const todo = generateTodo(user);
+    const todoValueBefore = todo.value;
+    await Promise.all([todo.save(), user.save()]);
+
+    await new Promise((resolve, reject) => {
+      cronMiddleware(req, res, err => {
+        if (err) return reject(err);
+        return Tasks.Task.findOne({ _id: todo._id }, (secondErr, todoFound) => {
+          if (secondErr) return reject(secondErr);
+          expect(todoFound.value).to.be.lessThan(todoValueBefore);
+          return resolve();
+        });
+      });
+    });
+  });
+
+  it('applies quest progress', async () => {
+    const hpBefore = user.stats.hp;
+    user.lastCron = moment(new Date()).subtract({ days: 2 });
+    const daily = generateDaily(user);
+    daily.startDate = moment(new Date()).subtract({ days: 2 });
+    await daily.save();
+
+    const questKey = 'dilatory';
+    user.party.quest.key = questKey;
+
+    const party = new Group({
+      type: 'party',
+      name: generateUUID(),
+      leader: user._id,
+    });
+    party.quest.members[user._id] = true;
+    party.quest.key = questKey;
+    await party.save();
+
+    user.party._id = party._id;
+    await user.save();
+
+    party.startQuest(user);
+
+    await new Promise((resolve, reject) => {
+      cronMiddleware(req, res, err => {
+        if (err) return reject(err);
+        return User.findOne({ _id: user._id }, (secondErr, updatedUser) => {
+          if (secondErr) return reject(secondErr);
+          expect(updatedUser.stats.hp).to.be.lessThan(hpBefore);
+          return resolve();
+        });
+      });
+    });
+  });
+
+  it('recovers from failed cron and does not error when user is already cronning', async () => {
+    user.lastCron = moment(new Date()).subtract({ days: 2 });
+    await user.save();
+
+    const updatedUser = user.toObject();
+    updatedUser.nMatched = 0;
+
+    sandbox.spy(cronLib, 'recoverCron');
+
+    sandbox.stub(User, 'updateOne')
+      .withArgs({
+        _id: user._id,
+        $or: [
+          { _cronSignature: 'NOT_RUNNING' },
+          { _cronSignature: { $lt: sinon.match.number } },
+        ],
+      })
+      .returns({
+        exec () {
+          return Promise.resolve(updatedUser);
+        },
+      });
+
+    await new Promise((resolve, reject) => {
+      cronMiddleware(req, res, err => {
+        if (err) return reject(err);
+        expect(cronLib.recoverCron).to.be.calledOnce;
+
+        return resolve();
+      });
+    });
+  });
+
+  it('cronSignature less than an hour ago should error', async () => {
+    user.lastCron = moment(new Date()).subtract({ days: 2 });
+    const now = new Date();
+    await User.update({
+      _id: user._id,
+    }, {
+      $set: {
+        _cronSignature: now.getTime() - CRON_TIMEOUT_WAIT + CRON_TIMEOUT_UNIT,
+      },
+    }).exec();
+    await user.save();
+    const expectedErrMessage = `Impossible to recover from cron for user ${user._id}.`;
+
+    await new Promise((resolve, reject) => {
+      cronMiddleware(req, res, err => {
+        if (!err) return reject(new Error('Cron should have failed.'));
+        expect(err.message).to.be.equal(expectedErrMessage);
+        return resolve();
+      });
+    });
+  });
+
+  it('cronSignature longer than an hour ago should allow cron', async () => {
+    user.lastCron = moment(new Date()).subtract({ days: 2 });
+    const now = new Date();
+    await User.update({
+      _id: user._id,
+    }, {
+      $set: {
+        _cronSignature: now.getTime() - CRON_TIMEOUT_WAIT - CRON_TIMEOUT_UNIT,
+      },
+    }).exec();
+    await user.save();
+
+    await new Promise((resolve, reject) => {
+      cronMiddleware(req, res, err => {
+        if (err) return reject(err);
+        expect(moment(now).isSame(user.auth.timestamps.loggedin, 'day'));
+        expect(user._cronSignature).to.be.equal('NOT_RUNNING');
+        return resolve();
+      });
+    });
+  });
+
+  it('cron should not run more than once', async () => {
+    user.lastCron = moment(new Date()).subtract({ days: 2 });
+    await user.save();
+
+    sandbox.spy(cronLib, 'cron');
+
+    await Promise.all([new Promise((resolve, reject) => {
+      cronMiddleware(req, res, err => {
+        if (err) return reject(err);
+        return resolve();
+      });
+    }), new Promise((resolve, reject) => {
+      cronMiddleware(req, res, err => {
+        if (err) return reject(err);
+        return resolve();
+      });
+    }), new Promise((resolve, reject) => {
+      setTimeout(() => {
+        cronMiddleware(req, res, err => {
+          if (err) return reject(err);
+          return resolve();
+        });
+      }, 400);
+    }),
+    ]);
+
+    expect(cronLib.cron).to.be.calledOnce;
+  });
+});