merging v1.7.0 ahead of v2 refactor

.circleci/config.yml

@@ -2,7 +2,7 @@ version: 2
 jobs:
   build:
     docker:
-      - image: circleci/node:12.16
+      - image: circleci/node:14
 
         environment:
             DATABASE_URL: postgres://postgres@localhost/osm-teams-test

.env.sample

@@ -1,3 +1,3 @@
 OSM_CONSUMER_KEY=<osm-consumer-key>
 OSM_CONSUMER_SECRET=<osm-consumer-secret>
-DSN=postgres://postgres@host.docker.internal/osm-teams?sslmode=disable
+DSN=postgres://postgres@dev-db/osm-teams?sslmode=disable

.gitignore

@@ -11,4 +11,5 @@ node_modules.nosync
 .idea
 hydra-config/prod/prod.yml
 .nyc_output
-coverage
+coverage
+docker-data/*

.nvmrc

@@ -1 +1 @@
-v12.16
+14

Dockerfile

@@ -1,4 +1,4 @@
-FROM node:lts
+FROM node:14
 
 # Create app directory
 WORKDIR /usr/src/app

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Development Seed
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -16,53 +16,30 @@
 Check the beta 👉 <!-- markdownlint-disable MD034 -->https://mapping.team
 <!-- markdownlint-enable MD034 -->
 
+## Development
 
-## Installation
+Install requirements:
 
-### Requirements
+- [nvm](https://github.com/creationix/nvm)
+- [Docker](https://www.docker.com)
 
-- [PostgreSQL](https://www.postgresql.org). On OS X, the easiest is to install [Postgres.app](https://postgresapp.com/).
-- [Node.js](https://nodejs.org) v12.16+
-- [Docker](https://www.docker.com/) & Docker Compose
+Visit your [OpenStreetMap settings](https://www.openstreetmap.org/account/edit) page and register an OAuth1 Client App:
 
-### Setting up Hydra
+![OSM Client App](oauth1-osm-client-app.png "OAuth1 page at OSM Website")
 
-1. Create the database for tokens
-
-    ```bash
-    createdb osm-teams
-    createdb osm-teams-test
-    ```
-
-    For the rest of this documentation, we will assume that the database location is `postgres://postgres@localhost/osm-teams?sslmode=disable` on your local machine. Inside docker, that location is `postgres://postgres@host.docker.internal/osm-teams?sslmode=disable`
-
-1. Create an `.env` file by copying `.env.sample` and replacing the values as needed. `OSM_CONSUMER_KEY` and `OSM_CONSUMER_SECRET` are values obtained by creating a new OAuth app on openstreetmap.org. The .env file can contain:
+Create an `.env` file by copying `.env.sample` and replacing the values as needed. `OSM_CONSUMER_KEY` and `OSM_CONSUMER_SECRET` are values available at the OAuth app page on openstreetmap.org. The .env file should contain:
 
     ```bash
     OSM_CONSUMER_KEY=<osm-teams-app>
     OSM_CONSUMER_SECRET=<osm-teams-app-secret>
-    DSN=postgres://postgres@host.docker.internal/osm-teams?sslmode=disable
-    ```
-
-1. Build the docker images:
-
-    ```bash
-    docker-compose -f compose.yml build
-    ```
-
-1. Start Hydra and the server
-
-    ```bash
-    docker-compose -f compose.yml -f compose.dev.yml up
+    DSN=postgres://postgres@dev-db/osm-teams?sslmode=disable
     ```
 
-⚠️ In development, `docker-compose -f compose.yml -f compose.dev.yml up` enables hot module reloading while you make modifications to the code. `docker-compose up` should be used for production/staging deployments.
-
-This will start hydra where the token issuer is at `http://localhost:4444` and the admin interface is at `http://localhost:4445`. This also sets up the consent and login interface at `http://localhost:8989` (where we will create a first-party oauth app)
+Start Hydra and PostgreSQL with Docker:
 
-### Setting up the OSM-teams app
+    docker-compose -f compose.dev.yml up --build
 
-Create the [first-party](https://auth0.com/docs/applications/concepts/app-types-first-third-party) "manage" app
+On a separate terminal, create the [first-party](https://auth0.com/docs/applications/concepts/app-types-first-third-party) "manage" app:
 
 ```bash
 docker-compose exec hydra hydra clients create --endpoint http://localhost:4445 \
@@ -74,6 +51,22 @@ docker-compose exec hydra hydra clients create --endpoint http://localhost:4445
   --callbacks http://localhost:8989/login/accept
 ```
 
+Install Node.js the required version (see [.nvmrc](.nvmrc) file):
+
+    nvm i
+
+Install Node.js modules:
+
+    yarn
+
+Migrate `dev-db` database:
+
+    yarn migrate
+
+Start development server:
+
+    yarn dev
+
 <!-- markdownlint-disable MD034 -->
 ✨ You can now login to the app at http://localhost:8989
 <!-- markdownlint-enable MD034 -->

app/db/knexfile.js

@@ -1,16 +1,12 @@
-let DATABASE_URL
+let DATABASE_URL = process.env.DSN || process.env.DATABASE_URL
 
-if (!process.env.NODE_ENV) {
-  process.env.NODE_ENV = 'development'
-}
-
-if (process.env.DSN) {
-  DATABASE_URL = process.env.DSN
-} else {
-  if (process.env.NODE_ENV === 'development') {
-    DATABASE_URL = 'postgres://postgres@localhost/osm-teams?sslmode=disable'
+// Apply defaults if no connection string is passed
+if (!DATABASE_URL) {
+  if (!process.env.NODE_ENV || process.env.NODE_ENV === 'development') {
+    DATABASE_URL =
+      'postgres://postgres:postgres@localhost:5433/osm-teams?sslmode=disable'
   } else if (process.env.NODE_ENV === 'test') {
-    DATABASE_URL = 'postgres://postgres@localhost/osm-teams-test?sslmode=disable'
+    DATABASE_URL = 'postgres://postgres:postgres@localhost:5434/osm-teams-test?sslmode=disable'
   }
 }
 

app/db/migrations/20220125220402_org-privacy-policy.js

@@ -0,0 +1,12 @@
+
+exports.up = async function (knex) {
+  await knex.schema.alterTable('organization', table => {
+    table.json('privacy_policy')
+  })
+}
+
+exports.down = async function (knex) {
+  await knex.schema.alterTable('organization', table => {
+    table.dropColumn('privacy_policy')
+  })
+}

app/db/migrations/20220222155039_add_badges.js

@@ -0,0 +1,16 @@
+exports.up = async function (knex) {
+  await knex.schema.createTable('organization_badge', (table) => {
+    table.increments('id')
+    table
+      .integer('organization_id')
+      .references('id')
+      .inTable('organization')
+      .onDelete('CASCADE')
+    table.string('name').notNullable()
+    table.string('color').notNullable()
+  })
+}
+
+exports.down = async function (knex) {
+  await knex.schema.dropTable('organization_badge')
+}

app/db/migrations/20220302104250_add_user_badges.js

@@ -0,0 +1,17 @@
+exports.up = async function (knex) {
+  await knex.schema.createTable('user_badges', (table) => {
+    table
+      .integer('badge_id')
+      .references('id')
+      .inTable('organization_badge')
+      .onDelete('CASCADE')
+    table.integer('user_id')
+    table.datetime('assigned_at').defaultTo(knex.fn.now())
+    table.datetime('valid_until')
+    table.unique(['badge_id', 'user_id'])
+  })
+}
+
+exports.down = async function (knex) {
+  await knex.schema.dropTable('user_badges')
+}

app/db/migrations/20220302135223_key-types.js

@@ -0,0 +1,11 @@
+exports.up = async (knex) => {
+  return knex.schema.alterTable('profile_keys', table => {
+    table.text('key_type').defaultTo('text')
+  })
+}
+
+exports.down = async (knex) => {
+  return knex.schema.alterTable('profile_keys', table => {
+    table.dropColumn('key_type')
+  })
+}

app/db/migrations/20220415114820_invitations.js

@@ -0,0 +1,13 @@
+
+exports.up = async function (knex) {
+  return knex.schema.createTable('invitations', table => {
+    table.string('id')
+    table.integer('team_id').references('id').inTable('team').onDelete('CASCADE')
+    table.timestamp('created_at').defaultTo(knex.fn.now())
+    table.timestamp('expires_at').nullable()
+  })
+}
+
+exports.down = async function (knex) {
+  return knex.schema.dropTable('invitations')
+}

app/index.js

@@ -1,3 +1,6 @@
+// Set server timezone to UTC to avoid issues with date parsing
+process.env.TZ = 'UTC'
+
 const path = require('path')
 const express = require('express')
 const bodyParser = require('body-parser')
@@ -55,6 +58,9 @@ async function init () {
    * Error handler
    */
   app.use(function (err, req, res, next) {
+    if (err.message === 'Forbidden') {
+      return nextApp.render(req, res, '/uh-oh')
+    }
     res.status(err.status || 500)
     console.error('error', err)
     res.boom.internal('An internal error occurred.')

app/lib/organization.js

@@ -1,6 +1,6 @@
 const db = require('../db')
 const team = require('./team')
-const { map, prop, includes } = require('ramda')
+const { map, prop, includes, has, isNil } = require('ramda')
 const { unpack, PropertyRequiredError } = require('./utils')
 
 // Organization attributes (without profile)
@@ -10,6 +10,7 @@ const orgAttributes = [
   'description',
   'privacy',
   'teams_can_be_public',
+  'privacy_policy',
   'created_at',
   'updated_at'
 ]
@@ -113,9 +114,10 @@ async function destroy (id) {
  * @return {promise}
  */
 async function update (id, data) {
-  if (!data.name) throw new Error('data.name property is required')
-
   const conn = await db()
+  if (has('name', data) && isNil(prop('name', data))) {
+    throw new Error('data.name property is required')
+  }
   return unpack(conn('organization').where('id', id).update(data).returning(orgAttributes))
 }
 
@@ -263,6 +265,20 @@ async function isMemberOrStaff (organizationId, osmId) {
   return result.length > 0
 }
 
+/**
+ * Checks if an osmId is a moderator of any team inside the org
+ * @param {int} organizationId - organization id
+ * @param {int} osmId - id of member we are testing
+ */
+async function isOrgTeamModerator (organizationId, osmId) {
+  if (!organizationId) throw new PropertyRequiredError('organization id')
+  if (!osmId) throw new PropertyRequiredError('osm id')
+  const conn = await db()
+  const subquery = conn('organization_team').select('team_id').where('organization_id', organizationId)
+  const isModeratorOfAny = await conn('moderator').whereIn('team_id', subquery).debug()
+  return isModeratorOfAny.length > 0
+}
+
 /**
  * Checks if the osm user is an owner of a team
  * @param {int} organizationId - organization id
@@ -348,6 +364,7 @@ module.exports = {
   isOwner,
   isManager,
   isMember,
+  isOrgTeamModerator,
   createOrgTeam,
   listMyOrganizations,
   getOrgStaff,

app/lib/osm.js

@@ -4,6 +4,7 @@
  * Route middleware to interact with OSM OAuth
  */
 const passport = require('passport-light')
+const R = require('ramda')
 const hydra = require('./hydra')
 const url = require('url')
 const db = require('../db')
@@ -55,11 +56,12 @@ function openstreetmap (req, res) {
     let conn = await db()
     let [user] = await conn('users').where('id', profile.id)
     if (user) {
+      const newProfile = R.mergeDeepRight(user.profile, profile)
       await conn('users').where('id', profile.id).update(
         {
           'osmToken': token,
           'osmTokenSecret': tokenSecret,
-          'profile': JSON.stringify(profile)
+          'profile': JSON.stringify(newProfile)
         }
       )
     } else {
@@ -83,7 +85,7 @@ function openstreetmap (req, res) {
         hydra.acceptLoginRequest(challenge, {
           subject: user.id,
           remember: true,
-          remember_for: 9999
+          remember_for: 0
         }).then(response => {
           if (response.redirect_to) {
             return res.redirect(response.redirect_to)

app/lib/profile.js

@@ -254,6 +254,25 @@ async function getUserManageToken (id) {
   return unpack(conn('users').select('manageToken').where('id', id).debug())
 }
 
+async function getUserBadges (id) {
+  const conn = await db()
+  return conn('user_badges')
+    .select([
+      'id',
+      'assigned_at',
+      'valid_until',
+      'organization_id',
+      'name',
+      'color'
+    ])
+    .leftJoin(
+      'organization_badge',
+      'user_badges.badge_id',
+      'organization_badge.id'
+    )
+    .where('user_badges.user_id', id)
+}
+
 module.exports = {
   addProfileKeys,
   modifyProfileKey,
@@ -263,5 +282,6 @@ module.exports = {
   setProfile,
   getProfile,
   getTableForProfileType,
-  getUserManageToken
+  getUserManageToken,
+  getUserBadges
 }