Merge pull request #235 from privacy-scaling-explorations/staging

.eslintrc.json

@@ -19,7 +19,12 @@
         "no-bitwise": "off",
         "no-await-in-loop": "off",
         "no-restricted-syntax": "off",
-        "no-console": ["warn", { "allow": ["info", "warn", "error", "log"] }],
+        "no-console": [
+            "warn",
+            {
+                "allow": ["info", "warn", "error", "log"]
+            }
+        ],
         "@typescript-eslint/lines-between-class-members": "off",
         "no-plusplus": "off",
         "@typescript-eslint/no-unused-expressions": "warn",
@@ -28,5 +33,19 @@
         "no-promise-executor-return": "warn",
         "prefer-promise-reject-errors": "warn",
         "@typescript-eslint/no-shadow": "warn"
-    }
+    },
+    "overrides": [
+        {
+            "files": ["packages/actions/src/helpers/utils.ts"],
+            "rules": {
+                "no-useless-escape": "off"
+            }
+        },
+        {
+            "files": ["packages/**/*.test.ts"],
+            "rules": {
+                "@typescript-eslint/no-unused-expressions": "off"
+            }
+        }
+    ]
 }

.github/workflows/publish-dev-packages.yaml

@@ -20,6 +20,14 @@ jobs:
           registry-url: "https://registry.npmjs.org"
           cache: yarn
 
+      - name: Initialize Project
+        run: |
+          yarn install
+          yarn build
+        env:
+          NODE_OPTIONS: "--max_old_space_size=4096"
+          YARN_ENABLE_IMMUTABLE_INSTALLS: "false"
+
       - name: Update package.json dependencies and names
         run: |
           # Enable recursive globbing
@@ -34,16 +42,9 @@ jobs:
           sed -i -e 's/"name": "@p0tion\/backend"/"name": "@devtion\/backend"/g' ./packages/backend/package.json
           sed -i -e 's/"name": "@p0tion\/actions"/"name": "@devtion\/actions"/g' ./packages/actions/package.json
 
-          # Update string literals in TypeScript files
+          # Update string literals in TypeScript and JS files
           sed -i 's|p0tion/actions|devtion/actions|g' packages/**/*.ts
-
-      - name: Initialize Project
-        run: |
-          yarn install
-          yarn build
-        env:
-          NODE_OPTIONS: "--max_old_space_size=4096"
-          YARN_ENABLE_IMMUTABLE_INSTALLS: "false"
+          sed -i 's|p0tion/actions|devtion/actions|g' packages/**/*.js
 
       - name: Install lerna
         run: |

.github/workflows/publish-staging-packages.yaml

@@ -20,6 +20,14 @@ jobs:
           registry-url: "https://registry.npmjs.org"
           cache: yarn
 
+      - name: Initialize Project
+        run: |
+          yarn install
+          yarn build
+        env:
+          NODE_OPTIONS: "--max_old_space_size=4096"
+          YARN_ENABLE_IMMUTABLE_INSTALLS: "false"
+
       - name: Update package.json dependencies and names
         run: |
           # Enable recursive globbing
@@ -34,16 +42,9 @@ jobs:
           sed -i -e 's/"name": "@p0tion\/backend"/"name": "@stagtion\/backend"/g' ./packages/backend/package.json
           sed -i -e 's/"name": "@p0tion\/actions"/"name": "@stagtion\/actions"/g' ./packages/actions/package.json
 
-          # Update string literals in TypeScript files
+          # Update string literals in TypeScript and JS files
           sed -i 's|p0tion/actions|stagtion/actions|g' packages/**/*.ts
-
-      - name: Initialize Project
-        run: |
-          yarn install
-          yarn build
-        env:
-          NODE_OPTIONS: "--max_old_space_size=4096"
-          YARN_ENABLE_IMMUTABLE_INSTALLS: "false"
+          sed -i 's|p0tion/actions|stagtion/actions|g' packages/**/*.js
 
       - name: Install lerna
         run: |

.gitignore

@@ -8,6 +8,7 @@ lerna-debug.log
 coverage/
 
 .DS_Store
+.idea
 
 .gcloudignore
 

README.md

@@ -187,7 +187,7 @@ For test execution (e2e/unit) we leverage [Jest](https://jestjs.io/).
 
 #### Local Environment
 
-**Prerequisities**
+**Prerequisites**
 
 -   Node.js version 16.0 or higher.
 -   Java JDK version 11 or higher.
@@ -202,7 +202,7 @@ yarn test
 
 #### Production Environment
 
-**Prerequisities**
+**Prerequisites**
 
 -   A Firebase Application w/ active billing (Blaze Plan) in order to support Cloud Functions deployment.
 -   Copy the `packages/actions/.env.default` file as `.env` `cp .env.default .env` and add your environment variables.

lerna.json

@@ -3,7 +3,7 @@
     "packages/*"
   ],
   "npmClient": "yarn",
-  "version": "1.0.9",
+  "version": "1.1.0",
   "changelogPreset": {
     "name": "conventionalcommits",
     "issuePrefixes": [

package.json

@@ -20,6 +20,7 @@
     "scripts": {
         "build": "yarn workspaces foreach -t run build",
         "test": "yarn test:dev",
+        "test:dev": "NODE_ENV=dev yarn workspace @p0tion/backend emulator:exec-test",
         "test:firebase-emulator": "NODE_ENV=dev yarn workspace @p0tion/backend emulator:exec-test",
         "test:prod": "yarn workspace @p0tion/actions test:contracts && GOOGLE_APPLICATION_CREDENTIALS=\"./packages/backend/serviceAccountKey.json\" && NODE_ENV=prod jest --config=jest.json --detectOpenHandles --forceExit --runInBand",
         "test:ci-prod": "NODE_ENV=prod jest --config=jest.json --detectOpenHandles --forceExit --runInBand",

packages/actions/.env.default

@@ -46,8 +46,8 @@ AWS_SECRET_ACCESS_KEY="YOUR-AWS-SECRET-ACCESS-KEY"
 AWS_REGION="YOUR-AWS-REGION"
 # The AWS AMI ID (default to Amazon Linux 2).
 AWS_AMI_ID="ami-022e1a32d3f742bd8"
-# The EC2 instance role to access S3
-AWS_ROLE_ARN="YOUR-AWS-ROLE-ARN"
+# The IAM instance profile for the EC2 instance to assume
+AWS_INSTANCE_PROFILE_ARN="YOUR-AWS-INSTANCE-PROFILE-ARN"
 
 ### AUTHENTICATION ###
 ### These configs are related to the authentication of users.

packages/actions/README.md

@@ -67,7 +67,7 @@ yarn add @p0tion/actions
 
 ### Local Development
 
-**Prerequisities**
+**Prerequisites**
 
 -   Node.js version 16.0 or higher.
 -   Yarn version 3.5.0 or higher.

packages/actions/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@p0tion/actions",
-    "version": "1.0.9",
+    "version": "1.1.0",
     "description": "A set of actions and helpers for CLI commands",
     "repository": "[email protected]:privacy-scaling-explorations/p0tion.git",
     "homepage": "https://github.com/privacy-scaling-explorations/p0tion",

packages/actions/src/helpers/security.ts

@@ -20,7 +20,8 @@ const getGitHubStats = async (user: string): Promise<any> => {
         following: jsonData.following,
         followers: jsonData.followers,
         publicRepos: jsonData.public_repos,
-        avatarUrl: jsonData.avatar_url
+        avatarUrl: jsonData.avatar_url,
+        age: jsonData.created_at
     }
 
     return data
@@ -38,19 +39,21 @@ export const githubReputation = async (
     userLogin: string,
     minimumAmountOfFollowing: number,
     minimumAmountOfFollowers: number,
-    minimumAmountOfPublicRepos: number
+    minimumAmountOfPublicRepos: number,
+    minimumAge: number
 ): Promise<any> => {
     if (!process.env.GITHUB_ACCESS_TOKEN)
         throw new Error(
             "The GitHub access token is missing. Please insert a valid token to be used for anti-sybil checks on user registation, and then try again."
         )
 
-    const { following, followers, publicRepos, avatarUrl } = await getGitHubStats(userLogin)
+    const { following, followers, publicRepos, avatarUrl, age } = await getGitHubStats(userLogin)
 
     if (
         following < minimumAmountOfFollowing ||
         publicRepos < minimumAmountOfPublicRepos ||
-        followers < minimumAmountOfFollowers
+        followers < minimumAmountOfFollowers ||
+        new Date(age) > new Date(Date.now() - minimumAge)
     )
         return {
             reputable: false,
@@ -59,6 +62,6 @@ export const githubReputation = async (
 
     return {
         reputable: true,
-        avatarUrl: avatarUrl
+        avatarUrl
     }
 }

packages/actions/src/helpers/services.ts

@@ -33,7 +33,7 @@ export const getAWSVariables = (): AWSVariables => {
         !process.env.AWS_ACCESS_KEY_ID ||
         !process.env.AWS_SECRET_ACCESS_KEY ||
         !process.env.AWS_REGION ||
-        !process.env.AWS_ROLE_ARN ||
+        !process.env.AWS_INSTANCE_PROFILE_ARN ||
         !process.env.AWS_AMI_ID
     )
         throw new Error(
@@ -44,7 +44,7 @@ export const getAWSVariables = (): AWSVariables => {
         accessKeyId: process.env.AWS_ACCESS_KEY_ID!,
         secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY!,
         region: process.env.AWS_REGION || "us-east-1",
-        roleArn: process.env.AWS_ROLE_ARN!,
+        instanceProfileArn: process.env.AWS_INSTANCE_PROFILE_ARN!,
         amiId: process.env.AWS_AMI_ID!
     }
 }

packages/actions/src/helpers/storage.ts

@@ -3,6 +3,7 @@ import mime from "mime-types"
 import fs, { createWriteStream } from "fs"
 import fetch from "@adobe/node-fetch-retry"
 import https from "https"
+import { GenericBar } from "cli-progress"
 import { ETagWithPartNumber, ChunkWithUrl, TemporaryParticipantContributionData } from "../types/index"
 import { commonTerms } from "./constants"
 import {
@@ -80,18 +81,23 @@ export const getChunksAndPreSignedUrls = async (
  * @param cloudFunctions <Functions> - the Firebase Cloud Functions service instance.
  * @param ceremonyId <string> - the unique identifier of the ceremony.
  * @param alreadyUploadedChunks Array<ETagWithPartNumber> - the temporary information about the already uploaded chunks.
+ * @param logger <GenericBar> - an optional logger to show progress.
  * @returns <Promise<Array<ETagWithPartNumber>>> - the completed (uploaded) chunks information.
  */
 export const uploadParts = async (
     chunksWithUrls: Array<ChunkWithUrl>,
     contentType: string | false,
     cloudFunctions?: Functions,
     ceremonyId?: string,
-    alreadyUploadedChunks?: Array<ETagWithPartNumber>
+    alreadyUploadedChunks?: Array<ETagWithPartNumber>,
+    logger?: GenericBar
 ): Promise<Array<ETagWithPartNumber>> => {
     // Keep track of uploaded chunks.
     const uploadedChunks: Array<ETagWithPartNumber> = alreadyUploadedChunks || []
 
+    // if we were passed a logger, start it
+    if (logger) logger.start(chunksWithUrls.length, 0)
+
     // Loop through remaining chunks.
     for (let i = alreadyUploadedChunks ? alreadyUploadedChunks.length : 0; i < chunksWithUrls.length; i += 1) {
         // Consume the pre-signed url to upload the chunk.
@@ -128,6 +134,9 @@ export const uploadParts = async (
         // nb. this must be done only when contributing (not finalizing).
         if (!!ceremonyId && !!cloudFunctions)
             await temporaryStoreCurrentContributionUploadedChunkData(cloudFunctions, ceremonyId, chunk)
+
+        // increment the count on the logger
+        if (logger) logger.increment()
     }
 
     return uploadedChunks
@@ -150,6 +159,7 @@ export const uploadParts = async (
  * @param configStreamChunkSize <number> - size of each chunk into which the artifact is going to be splitted (nb. will be converted in MB).
  * @param [ceremonyId] <string> - the unique identifier of the ceremony (used as a double-edge sword - as identifier and as a check if current contributor is the coordinator finalizing the ceremony).
  * @param [temporaryDataToResumeMultiPartUpload] <TemporaryParticipantContributionData> - the temporary information necessary to resume an already started multi-part upload.
+ * @param logger <GenericBar> - an optional logger to show progress.
  */
 export const multiPartUpload = async (
     cloudFunctions: Functions,
@@ -158,7 +168,8 @@ export const multiPartUpload = async (
     localFilePath: string,
     configStreamChunkSize: number,
     ceremonyId?: string,
-    temporaryDataToResumeMultiPartUpload?: TemporaryParticipantContributionData
+    temporaryDataToResumeMultiPartUpload?: TemporaryParticipantContributionData,
+    logger?: GenericBar
 ) => {
     // The unique identifier of the multi-part upload.
     let multiPartUploadId: string = ""
@@ -198,7 +209,8 @@ export const multiPartUpload = async (
         mime.lookup(localFilePath), // content-type.
         cloudFunctions,
         ceremonyId,
-        alreadyUploadedChunks
+        alreadyUploadedChunks,
+        logger
     )
 
     // Step (3).