Shared: Added typescript for times helper

.dockerignore

@@ -1,6 +1,13 @@
-.git
-.github
+# from .gitignore
 .env
+lerna-debug.json
+yarn-error.log
+node_modules
+build
+
+# extra ignores to help docker caching
 monitoring
+.git
+.github
 docker-compose.yml
-README.md
+*.md

.gitignore

@@ -5,7 +5,10 @@
 
 # Logs
 lerna-debug.json
+yarn-error.log
 
 # Dependencies
 node_modules
-package-lock.json
+
+# builds
+build

Dockerfile

@@ -1,33 +1,21 @@
-FROM node:12.14.0-alpine
+FROM node:12.19.0-alpine
 RUN apk add --no-cache git
 
 WORKDIR /app
 
-# copy root package and lerna json files
-COPY ./package.json /app/package.json
-COPY ./lerna.json /app/lerna.json
-
-# copy app package json
-RUN mkdir -p /packages/app
-COPY ./packages/app/package.json /app/packages/app/package.json
-
-# copy server package json
-RUN mkdir -p /packages/server
-COPY ./packages/server/package.json /app/packages/server/package.json
-
-# copy services package json
-RUN mkdir -p /packages/services
-COPY ./packages/services/package.json /app/packages/services/package.json
-
-# copy shared package json
-RUN mkdir -p /packages/shared
-COPY ./packages/shared/package.json /app/packages/shared/package.json
+# copy all package json files
+COPY ./package.json                       /app/package.json
+COPY ./packages/app/package.json          /app/packages/app/package.json
+COPY ./packages/server/package.json       /app/packages/server/package.json
+COPY ./packages/services/package.json     /app/packages/services/package.json
+COPY ./packages/shared/package.json       /app/packages/shared/package.json
 
 # install dependencies
-COPY ./yarn.lock /app/yarn.lock
-RUN yarn install
-RUN yarn lerna link
+COPY ./yarn.lock                          /app/yarn.lock
+RUN yarn install --frozen-lockfile
 
+# try building the app
 COPY . .
+RUN yarn build
 
 CMD echo specify one of the package.json scripts in command line

package.json

@@ -8,13 +8,15 @@
   },
   "scripts": {
     "db:setup": "lerna run db:setup --scope '*/*-server' --stream",
-    "start:app": "lerna run --scope=@aragon/protocol-backend-app --concurrency=1 --stream start",
-    "start:server": "lerna run --scope=@aragon/protocol-backend-server --concurrency=1 --stream start",
-    "start:server:dev": "lerna run --scope=@aragon/protocol-backend-server --concurrency=1 --stream start:dev",
-    "start:services": "lerna run --scope=@aragon/protocol-backend-services --concurrency=1 --stream start",
-    "start:services:dev": "lerna run --scope=@aragon/protocol-backend-services --concurrency=1 --stream start:dev",
-    "test:server": "lerna run --scope=@aragon/protocol-backend-server --concurrency=1 --stream test",
-    "test:services": "lerna run --scope=@aragon/protocol-backend-services --concurrency=1 --stream test"
+    "build": "lerna run --stream build",
+    "build:shared": "yarn run --scope '*/*-shared' build",
+    "start:app": "lerna run --scope '*/*-app' --stream start",
+    "start:server": "lerna run --scope '*/*-server' --stream start",
+    "start:server:dev": "lerna run --scope '*/*-server' --stream start:dev",
+    "start:services": "lerna run --scope '*/*-services' --stream start",
+    "start:services:dev": "lerna run --scope '*/*-services' --stream start:dev",
+    "test:server": "lerna run --scope '*/*-server' --stream test",
+    "test:services": "lerna run --scope '*/*-services' --stream test"
   },
   "workspaces": {
     "packages": [

packages/app/package.json

@@ -24,8 +24,8 @@
     "web3-utils": "^1.2.4"
   },
   "scripts": {
+    "build:shared": "yarn workspace @aragon/protocol-backend-shared build",
     "start": "react-scripts start",
-    "build": "react-scripts build",
     "test": "react-scripts test",
     "eject": "react-scripts eject"
   },

packages/cli/package.json

@@ -5,6 +5,7 @@
   "author": "Aragon One",
   "license": "(GPL-3.0-or-later OR AGPL-3.0-or-later)",
   "scripts": {
+    "build:shared": "yarn workspace @aragon/protocol-backend-shared build",
     "mint": "node ./bin/index.js mint --verbose",
     "stake": "node ./bin/index.js stake --verbose",
     "unstake": "node ./bin/index.js unstake --verbose",

packages/server/package.json

@@ -9,6 +9,7 @@
   },
   "scripts": {
     "build": "babel ./src --out-dir ./build --source-maps --copy-files",
+    "build:shared": "yarn workspace @aragon/protocol-backend-shared build",
     "start": "yarn build && yarn db:setup && node ./build",
     "start:dev": "yarn db:setup && nodemon --ignore ./build --exec babel-node ./src/index.js",
     "knex": "npx babel-node ./node_modules/.bin/knex",

packages/server/src/helpers/session-middleware.js

@@ -1,7 +1,7 @@
 import expressSession from 'express-session'
 import { Session } from '../models/objection'
 
-import { HOURS, DAYS } from '@aragon/protocol-backend-shared/helpers/times'
+import { HOURS, DAYS } from '@aragon/protocol-backend-shared/build/helpers/times'
 const SESSION_MAXAGE = 30 * DAYS
 const SESSION_EXPIRE_INTERVAL = HOURS
 const { SESSION_SECURE } = process.env

packages/server/src/models/objection/User.js

@@ -3,7 +3,7 @@ import UserEmail from './UserEmail'
 import emailClient from '@aragon/protocol-backend-shared/helpers/email-client'
 import { generateToken } from '../../helpers/token-manager'
 
-import { DAYS } from '@aragon/protocol-backend-shared/helpers/times'
+import { DAYS } from '@aragon/protocol-backend-shared/build/helpers/times'
 const EMAIL_TOKEN_EXPIRES = DAYS
 const EMAIL_TOKEN_OLD = DAYS
 

packages/server/src/models/objection/UserNotification.js

@@ -1,5 +1,5 @@
 import BaseModel from './BaseModel'
-import { HOURS } from '@aragon/protocol-backend-shared/helpers/times'
+import { HOURS } from '@aragon/protocol-backend-shared/build/helpers/times'
 
 export default class UserNotification extends BaseModel {
   static get tableName() {

packages/server/src/validators/UserSessionsValidator.js

@@ -1,7 +1,7 @@
 import { utils } from 'ethers'
 import BaseValidator from './BaseValidator'
 
-import { MINUTES } from '@aragon/protocol-backend-shared/helpers/times'
+import { MINUTES } from '@aragon/protocol-backend-shared/build/helpers/times'
 const SESSION_SIGNATURE_EXPIRES = MINUTES * 10
 
 class UserSessionsValidator  extends BaseValidator {

packages/services/package.json

@@ -6,7 +6,8 @@
   "license": "(GPL-3.0-or-later OR AGPL-3.0-or-later)",
   "main": "index.js",
   "scripts": {
-    "build:server": "cd node_modules/@aragon/protocol-backend-server && npm run build",
+    "build:shared": "yarn workspace @aragon/protocol-backend-shared build",
+    "build:server": "yarn workspace @aragon/protocol-backend-server build",
     "start": "npm run build:server && babel-node ./bin/main.js",
     "start:dev": "npm run build:server && nodemon --ignore ./build --exec babel-node ./bin/main.js",
     "test": "npx mocha test --recursive --exit --require @babel/register"

packages/services/src/models/notification-scanners/NotificationScannerBaseModel.js

@@ -1,5 +1,5 @@
 const { env: { CLIENT_URL } } = process
-import { MINUTES, HOURS, DAYS } from '@aragon/protocol-backend-shared/helpers/times'
+import { MINUTES, HOURS, DAYS } from '@aragon/protocol-backend-shared/build/helpers/times'
 
 export default class NotificationScannerBaseModel {
   async shouldNotifyUser(user) {

packages/services/src/workers/contract-monitor.js

@@ -1,5 +1,5 @@
 import Etherscan from '../models/Etherscan'
-import { DAYS } from '@aragon/protocol-backend-shared/helpers/times'
+import { DAYS } from '@aragon/protocol-backend-shared/build/helpers/times'
 import getWalletFromPk from '@aragon/protocol-backend-shared/helpers/get-wallet-from-pk'
 import abi from 'web3-eth-abi'
 

packages/services/test/integration/notification-scanners/SubscriptionReminder.js

@@ -14,7 +14,7 @@ const { env: { CLIENT_URL } } = process
 const notificationTypeModel = 'SubscriptionReminder'
 const TEST_ADDR = '0xfc3771B19123F1f0237C737e92645BA6d628e2cB'
 const TEST_EMAIL = 'subscription@reminder.test'
-import { DAYS } from '@aragon/protocol-backend-shared/helpers/times'
+import { DAYS } from '@aragon/protocol-backend-shared/build/helpers/times'
 
 
 describe('SubscriptionReminder notifications', () => {

packages/shared/.eslintrc.json

@@ -0,0 +1,15 @@
+{
+  "root": true,
+  "plugins": ["@typescript-eslint"],
+  "parser": "@typescript-eslint/parser",
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended"
+  ],
+  "rules": {
+    // allow using any and non null assertion for Objection models
+    "@typescript-eslint/explicit-module-boundary-types": "off",
+    "@typescript-eslint/no-explicit-any": "off",
+    "@typescript-eslint/no-non-null-assertion": "off"
+  }
+}

packages/shared/README.md

@@ -32,5 +32,16 @@ It provides the following helper functions:
 - [`logger`](./helpers/logger.js): Logger object that provides a friendly interface for fancy logging 
 - [`numbers`](./helpers/numbers.js): BigNumber-related helper functions
 - [`sleep`](./helpers/sleep.js): Sleep function to wait a number of seconds 
-- [`times`](./helpers/times.js): Time constants for using with `Date()`
+- [`times`](./helpers/times.ts): Time constants for using with `Date()`
 - [`voting`](./helpers/voting.js): Utils related to the CR Voting module of Aragon Protocol
+
+
+## TypeScript compilation
+
+Shared modules need to be compiled first before importing in other packages:
+```
+yarn build
+
+# from another package:
+yarn build:shared
+```

packages/shared/babel.config.json

@@ -0,0 +1,18 @@
+{
+  "presets": [
+    "@babel/preset-typescript",
+    [
+      "@babel/preset-env",
+      {
+        "targets": {
+          "node": "current"
+        },
+        "useBuiltIns": "usage",
+        "corejs": 3
+      }
+    ]  
+  ],
+  "plugins": [
+    "@babel/plugin-proposal-export-namespace-from"
+  ]
+}

packages/shared/package.json

@@ -4,9 +4,17 @@
   "private": true,
   "author": "Aragon One",
   "license": "(GPL-3.0-or-later OR AGPL-3.0-or-later)",
+  "scripts": {
+    "lint": "eslint src/** --ext .ts",
+    "build": "yarn lint && yarn build:types && yarn build:js",
+    "build:types": "tsc",
+    "build:js": "babel ./src --out-dir ./build --extensions .ts",
+    "build:clean": "yarn clean && yarn build",
+    "clean": "rm -rf ./build"
+  },
   "dependencies": {
-    "@aragon/protocol-evm": "1.0.0-beta.2",
     "@aragon/contract-helpers-test": "^0.1.0",
+    "@aragon/protocol-evm": "1.0.0-beta.2",
     "@aragon/truffle-config-v5": "^1.0.1",
     "@aragonone/erc20-faucet": "^1.0.0",
     "@truffle/config": "1.2.7",
@@ -17,5 +25,15 @@
     "graphql-request": "^1.8.2",
     "postmark": "^2.5.3",
     "web3-utils": "^1.2.4"
+  },
+  "devDependencies": {
+    "@babel/cli": "^7.12.1",
+    "@babel/core": "^7.12.3",
+    "@babel/preset-env": "^7.12.1",
+    "@babel/preset-typescript": "^7.12.1",
+    "@typescript-eslint/eslint-plugin": "^4.6.1",
+    "@typescript-eslint/parser": "^4.6.1",
+    "eslint": "^7.12.1",
+    "typescript": "^4.0.5"
   }
 }

packages/shared/src/helpers/times.ts

@@ -0,0 +1,6 @@
+const SECONDS = 1000
+const MINUTES = 60 * SECONDS
+const HOURS = 60 * MINUTES
+const DAYS = 24 * HOURS
+
+export { SECONDS, MINUTES, HOURS, DAYS }

packages/shared/tsconfig.json

@@ -0,0 +1,18 @@
+{
+  "include": [
+    "src/**/*"
+  ],
+  "compilerOptions": {
+    "strict": true,
+    "outDir": "./build",
+    "declaration": true,
+    "emitDeclarationOnly": true,
+    "moduleResolution": "Node",
+    // allow advanced js features, proper targeting is done using Babel
+    "target": "ESNext",
+    // allow non-ES modules with 'export =' syntax as default imports
+    "esModuleInterop": true,
+    // allow json import
+    "resolveJsonModule": true
+  }
+}