Compare commits
47 Commits
release/20
...
feat/coll-
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
fa8c7a9f35 | ||
|
|
56f427740d | ||
|
|
e4eaa2cec9 | ||
|
|
8bb628354e | ||
|
|
b3bef85b87 | ||
|
|
80d54565eb | ||
|
|
9e7f1b58b9 | ||
|
|
b07d0c69cc | ||
|
|
00ff318194 | ||
|
|
b5c1fe4619 | ||
|
|
8e72ab44a6 | ||
|
|
987d1a74d1 | ||
|
|
d5d4e51848 | ||
|
|
509775878a | ||
|
|
95953557de | ||
|
|
9d2b7cc03f | ||
|
|
276d48e3f8 | ||
|
|
6526247869 | ||
|
|
08b6e0b747 | ||
|
|
79a8bc669e | ||
|
|
b6f3b24b9e | ||
|
|
16bbfec736 | ||
|
|
ebe680c596 | ||
|
|
f79ab298da | ||
|
|
83019733e3 | ||
|
|
c18e801420 | ||
|
|
bb8c77fa7a | ||
|
|
951cff9f30 | ||
|
|
574d800a12 | ||
|
|
ed825cf648 | ||
|
|
569c170fec | ||
|
|
056a8a8719 | ||
|
|
9bfe195253 | ||
|
|
fce68de282 | ||
|
|
ad7b3f05b1 | ||
|
|
ea8de655d7 | ||
|
|
369d01a399 | ||
|
|
0a54455fe7 | ||
|
|
b893607ad1 | ||
|
|
7c3a84246d | ||
|
|
2687592a56 | ||
|
|
a48d7e879f | ||
|
|
d326063659 | ||
|
|
59735c15e4 | ||
|
|
ae531f5882 | ||
|
|
f8aeb42da5 | ||
|
|
1896e5afe1 |
15
.github/workflows/tests.yml
vendored
15
.github/workflows/tests.yml
vendored
@@ -17,21 +17,22 @@ jobs:
|
|||||||
|
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout
|
- name: Checkout
|
||||||
uses: actions/checkout@v4
|
uses: actions/checkout@v3
|
||||||
|
|
||||||
- name: Setup environment
|
- name: Setup environment
|
||||||
run: mv .env.example .env
|
run: mv .env.example .env
|
||||||
|
|
||||||
- name: Setup node
|
|
||||||
uses: actions/setup-node@v4
|
|
||||||
with:
|
|
||||||
node-version: ${{ matrix.node-version }}
|
|
||||||
|
|
||||||
- name: Setup pnpm
|
- name: Setup pnpm
|
||||||
uses: pnpm/action-setup@v3
|
uses: pnpm/action-setup@v2.2.4
|
||||||
with:
|
with:
|
||||||
version: 8
|
version: 8
|
||||||
run_install: true
|
run_install: true
|
||||||
|
|
||||||
|
- name: Setup node
|
||||||
|
uses: actions/setup-node@v3
|
||||||
|
with:
|
||||||
|
node-version: ${{ matrix.node }}
|
||||||
|
cache: pnpm
|
||||||
|
|
||||||
- name: Run tests
|
- name: Run tests
|
||||||
run: pnpm test
|
run: pnpm test
|
||||||
|
|||||||
5
.gitignore
vendored
5
.gitignore
vendored
@@ -81,7 +81,10 @@ web_modules/
|
|||||||
|
|
||||||
# dotenv environment variable files
|
# dotenv environment variable files
|
||||||
.env
|
.env
|
||||||
.env.*
|
.env.development.local
|
||||||
|
.env.test.local
|
||||||
|
.env.production.local
|
||||||
|
.env.local
|
||||||
|
|
||||||
# parcel-bundler cache (https://parceljs.org/)
|
# parcel-bundler cache (https://parceljs.org/)
|
||||||
.cache
|
.cache
|
||||||
|
|||||||
@@ -239,7 +239,7 @@ Help us to translate Hoppscotch. Please read [`TRANSLATIONS`](TRANSLATIONS.md) f
|
|||||||
|
|
||||||
📦 **Add-ons:** Official add-ons for hoppscotch.
|
📦 **Add-ons:** Official add-ons for hoppscotch.
|
||||||
|
|
||||||
- **[Hoppscotch CLI](https://github.com/hoppscotch/hoppscotch/tree/main/packages/hoppscotch-cli)** - Command-line interface for Hoppscotch.
|
- **[Hoppscotch CLI](https://github.com/hoppscotch/hopp-cli)** - Command-line interface for Hoppscotch.
|
||||||
- **[Proxy](https://github.com/hoppscotch/proxyscotch)** - A simple proxy server created for Hoppscotch.
|
- **[Proxy](https://github.com/hoppscotch/proxyscotch)** - A simple proxy server created for Hoppscotch.
|
||||||
- **[Browser Extensions](https://github.com/hoppscotch/hoppscotch-extension)** - Browser extensions that enhance your Hoppscotch experience.
|
- **[Browser Extensions](https://github.com/hoppscotch/hoppscotch-extension)** - Browser extensions that enhance your Hoppscotch experience.
|
||||||
|
|
||||||
|
|||||||
@@ -1,48 +0,0 @@
|
|||||||
# THIS IS NOT TO BE USED FOR PERSONAL DEPLOYMENTS!
|
|
||||||
# Internal Docker Compose Image used for internal testing deployments
|
|
||||||
|
|
||||||
version: "3.7"
|
|
||||||
|
|
||||||
services:
|
|
||||||
hoppscotch-db:
|
|
||||||
image: postgres:15
|
|
||||||
user: postgres
|
|
||||||
environment:
|
|
||||||
POSTGRES_USER: postgres
|
|
||||||
POSTGRES_PASSWORD: testpass
|
|
||||||
POSTGRES_DB: hoppscotch
|
|
||||||
healthcheck:
|
|
||||||
test:
|
|
||||||
[
|
|
||||||
"CMD-SHELL",
|
|
||||||
"sh -c 'pg_isready -U $${POSTGRES_USER} -d $${POSTGRES_DB}'"
|
|
||||||
]
|
|
||||||
interval: 5s
|
|
||||||
timeout: 5s
|
|
||||||
retries: 10
|
|
||||||
|
|
||||||
hoppscotch-aio:
|
|
||||||
container_name: hoppscotch-aio
|
|
||||||
build:
|
|
||||||
dockerfile: prod.Dockerfile
|
|
||||||
context: .
|
|
||||||
target: aio
|
|
||||||
environment:
|
|
||||||
- DATABASE_URL=postgresql://postgres:testpass@hoppscotch-db:5432/hoppscotch
|
|
||||||
- ENABLE_SUBPATH_BASED_ACCESS=true
|
|
||||||
env_file:
|
|
||||||
- ./.env
|
|
||||||
depends_on:
|
|
||||||
hoppscotch-db:
|
|
||||||
condition: service_healthy
|
|
||||||
command: ["sh", "-c", "pnpm exec prisma migrate deploy && node /usr/src/app/aio_run.mjs"]
|
|
||||||
healthcheck:
|
|
||||||
test:
|
|
||||||
- CMD
|
|
||||||
- curl
|
|
||||||
- '-f'
|
|
||||||
- 'http://localhost:80'
|
|
||||||
interval: 2s
|
|
||||||
timeout: 10s
|
|
||||||
retries: 30
|
|
||||||
|
|
||||||
@@ -9,10 +9,6 @@ curlCheck() {
|
|||||||
fi
|
fi
|
||||||
}
|
}
|
||||||
|
|
||||||
if [ "$ENABLE_SUBPATH_BASED_ACCESS" = "true" ]; then
|
curlCheck "http://localhost:3000"
|
||||||
curlCheck "http://localhost:80/backend/ping"
|
curlCheck "http://localhost:3100"
|
||||||
else
|
curlCheck "http://localhost:3170/ping"
|
||||||
curlCheck "http://localhost:3000"
|
|
||||||
curlCheck "http://localhost:3100"
|
|
||||||
curlCheck "http://localhost:3170/ping"
|
|
||||||
fi
|
|
||||||
|
|||||||
13
package.json
13
package.json
@@ -23,13 +23,12 @@
|
|||||||
"./packages/*"
|
"./packages/*"
|
||||||
],
|
],
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@commitlint/cli": "16.3.0",
|
"@commitlint/cli": "^16.2.3",
|
||||||
"@commitlint/config-conventional": "16.2.4",
|
"@commitlint/config-conventional": "^16.2.1",
|
||||||
"@hoppscotch/ui": "0.1.0",
|
|
||||||
"@types/node": "17.0.27",
|
"@types/node": "17.0.27",
|
||||||
"cross-env": "7.0.3",
|
"cross-env": "^7.0.3",
|
||||||
"http-server": "14.1.1",
|
"http-server": "^14.1.1",
|
||||||
"husky": "7.0.4",
|
"husky": "^7.0.4",
|
||||||
"lint-staged": "12.4.0"
|
"lint-staged": "12.4.0"
|
||||||
},
|
},
|
||||||
"pnpm": {
|
"pnpm": {
|
||||||
@@ -37,7 +36,7 @@
|
|||||||
"vue": "3.3.9"
|
"vue": "3.3.9"
|
||||||
},
|
},
|
||||||
"packageExtensions": {
|
"packageExtensions": {
|
||||||
"httpsnippet@3.0.1": {
|
"httpsnippet@^3.0.1": {
|
||||||
"peerDependencies": {
|
"peerDependencies": {
|
||||||
"ajv": "6.12.3"
|
"ajv": "6.12.3"
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -17,16 +17,16 @@
|
|||||||
"types": "dist/index.d.ts",
|
"types": "dist/index.d.ts",
|
||||||
"sideEffects": false,
|
"sideEffects": false,
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@codemirror/language": "6.10.1",
|
"@codemirror/language": "6.9.0",
|
||||||
"@lezer/highlight": "1.2.0",
|
"@lezer/highlight": "1.1.4",
|
||||||
"@lezer/lr": "1.3.14"
|
"@lezer/lr": "^1.3.13"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@lezer/generator": "1.5.1",
|
"@lezer/generator": "^1.5.1",
|
||||||
"mocha": "9.2.2",
|
"mocha": "^9.2.2",
|
||||||
"rollup": "3.29.4",
|
"rollup": "^3.29.3",
|
||||||
"rollup-plugin-dts": "6.0.2",
|
"rollup-plugin-dts": "^6.0.2",
|
||||||
"rollup-plugin-ts": "3.4.5",
|
"rollup-plugin-ts": "^3.4.5",
|
||||||
"typescript": "5.2.2"
|
"typescript": "^5.2.2"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "hoppscotch-backend",
|
"name": "hoppscotch-backend",
|
||||||
"version": "2024.3.1",
|
"version": "2023.8.4-1",
|
||||||
"description": "",
|
"description": "",
|
||||||
"author": "",
|
"author": "",
|
||||||
"private": true,
|
"private": true,
|
||||||
@@ -24,83 +24,80 @@
|
|||||||
"do-test": "pnpm run test"
|
"do-test": "pnpm run test"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@apollo/server": "4.9.5",
|
"@apollo/server": "^4.9.4",
|
||||||
"@nestjs-modules/mailer": "1.9.1",
|
"@nestjs-modules/mailer": "^1.9.1",
|
||||||
"@nestjs/apollo": "12.0.9",
|
"@nestjs/apollo": "^12.0.9",
|
||||||
"@nestjs/common": "10.2.7",
|
"@nestjs/common": "^10.2.6",
|
||||||
"@nestjs/config": "3.1.1",
|
"@nestjs/config": "^3.1.1",
|
||||||
"@nestjs/core": "10.2.7",
|
"@nestjs/core": "^10.2.6",
|
||||||
"@nestjs/graphql": "12.0.9",
|
"@nestjs/graphql": "^12.0.9",
|
||||||
"@nestjs/jwt": "10.1.1",
|
"@nestjs/jwt": "^10.1.1",
|
||||||
"@nestjs/passport": "10.0.2",
|
"@nestjs/passport": "^10.0.2",
|
||||||
"@nestjs/platform-express": "10.2.7",
|
"@nestjs/platform-express": "^10.2.6",
|
||||||
"@nestjs/schedule": "4.0.1",
|
"@nestjs/throttler": "^5.0.0",
|
||||||
"@nestjs/throttler": "5.0.1",
|
"@prisma/client": "^4.16.2",
|
||||||
"@prisma/client": "5.8.1",
|
"argon2": "^0.30.3",
|
||||||
"argon2": "0.30.3",
|
"bcrypt": "^5.1.0",
|
||||||
"bcrypt": "5.1.0",
|
"cookie": "^0.5.0",
|
||||||
"cookie": "0.5.0",
|
"cookie-parser": "^1.4.6",
|
||||||
"cookie-parser": "1.4.6",
|
"express": "^4.17.1",
|
||||||
"cron": "3.1.6",
|
"express-session": "^1.17.3",
|
||||||
"express": "4.18.2",
|
"fp-ts": "^2.13.1",
|
||||||
"express-session": "1.17.3",
|
"graphql": "^16.8.1",
|
||||||
"fp-ts": "2.13.1",
|
"graphql-query-complexity": "^0.12.0",
|
||||||
"graphql": "16.8.1",
|
"graphql-redis-subscriptions": "^2.6.0",
|
||||||
"graphql-query-complexity": "0.12.0",
|
"graphql-subscriptions": "^2.0.0",
|
||||||
"graphql-redis-subscriptions": "2.6.0",
|
"handlebars": "^4.7.7",
|
||||||
"graphql-subscriptions": "2.0.0",
|
"io-ts": "^2.2.16",
|
||||||
"handlebars": "4.7.7",
|
"luxon": "^3.2.1",
|
||||||
"io-ts": "2.2.16",
|
"nodemailer": "^6.9.1",
|
||||||
"luxon": "3.2.1",
|
"passport": "^0.6.0",
|
||||||
"nodemailer": "6.9.1",
|
"passport-github2": "^0.1.12",
|
||||||
"passport": "0.6.0",
|
"passport-google-oauth20": "^2.0.0",
|
||||||
"passport-github2": "0.1.12",
|
"passport-jwt": "^4.0.1",
|
||||||
"passport-google-oauth20": "2.0.0",
|
"passport-local": "^1.0.0",
|
||||||
"passport-jwt": "4.0.1",
|
"passport-microsoft": "^1.0.0",
|
||||||
"passport-local": "1.0.0",
|
"prisma": "^4.16.2",
|
||||||
"passport-microsoft": "1.0.0",
|
"reflect-metadata": "^0.1.13",
|
||||||
"posthog-node": "3.6.3",
|
"rimraf": "^3.0.2",
|
||||||
"prisma": "5.8.1",
|
"rxjs": "^7.6.0"
|
||||||
"reflect-metadata": "0.1.13",
|
|
||||||
"rimraf": "3.0.2",
|
|
||||||
"rxjs": "7.6.0"
|
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@nestjs/cli": "10.2.1",
|
"@nestjs/cli": "^10.1.18",
|
||||||
"@nestjs/schematics": "10.0.3",
|
"@nestjs/schematics": "^10.0.2",
|
||||||
"@nestjs/testing": "10.2.7",
|
"@nestjs/testing": "^10.2.6",
|
||||||
"@relmify/jest-fp-ts": "2.0.2",
|
"@relmify/jest-fp-ts": "^2.0.2",
|
||||||
"@types/argon2": "0.15.0",
|
"@types/argon2": "^0.15.0",
|
||||||
"@types/bcrypt": "5.0.0",
|
"@types/bcrypt": "^5.0.0",
|
||||||
"@types/cookie": "0.5.1",
|
"@types/cookie": "^0.5.1",
|
||||||
"@types/cookie-parser": "1.4.3",
|
"@types/cookie-parser": "^1.4.3",
|
||||||
"@types/express": "4.17.14",
|
"@types/express": "^4.17.14",
|
||||||
"@types/jest": "29.4.0",
|
"@types/jest": "^29.4.0",
|
||||||
"@types/luxon": "3.2.0",
|
"@types/luxon": "^3.2.0",
|
||||||
"@types/node": "18.11.10",
|
"@types/node": "^18.11.10",
|
||||||
"@types/nodemailer": "6.4.7",
|
"@types/nodemailer": "^6.4.7",
|
||||||
"@types/passport-github2": "1.2.5",
|
"@types/passport-github2": "^1.2.5",
|
||||||
"@types/passport-google-oauth20": "2.0.11",
|
"@types/passport-google-oauth20": "^2.0.11",
|
||||||
"@types/passport-jwt": "3.0.8",
|
"@types/passport-jwt": "^3.0.8",
|
||||||
"@types/passport-microsoft": "0.0.0",
|
"@types/passport-microsoft": "^0.0.0",
|
||||||
"@types/supertest": "2.0.12",
|
"@types/supertest": "^2.0.12",
|
||||||
"@typescript-eslint/eslint-plugin": "5.45.0",
|
"@typescript-eslint/eslint-plugin": "^5.45.0",
|
||||||
"@typescript-eslint/parser": "5.45.0",
|
"@typescript-eslint/parser": "^5.45.0",
|
||||||
"cross-env": "7.0.3",
|
"cross-env": "^7.0.3",
|
||||||
"eslint": "8.29.0",
|
"eslint": "^8.29.0",
|
||||||
"eslint-config-prettier": "8.5.0",
|
"eslint-config-prettier": "^8.5.0",
|
||||||
"eslint-plugin-prettier": "4.2.1",
|
"eslint-plugin-prettier": "^4.2.1",
|
||||||
"jest": "29.4.1",
|
"jest": "^29.4.1",
|
||||||
"jest-mock-extended": "3.0.1",
|
"jest-mock-extended": "^3.0.1",
|
||||||
"jwt": "link:@types/nestjs/jwt",
|
"jwt": "link:@types/nestjs/jwt",
|
||||||
"prettier": "2.8.4",
|
"prettier": "^2.8.4",
|
||||||
"source-map-support": "0.5.21",
|
"source-map-support": "^0.5.21",
|
||||||
"supertest": "6.3.2",
|
"supertest": "^6.3.2",
|
||||||
"ts-jest": "29.0.5",
|
"ts-jest": "29.0.5",
|
||||||
"ts-loader": "9.4.2",
|
"ts-loader": "^9.4.2",
|
||||||
"ts-node": "10.9.1",
|
"ts-node": "^10.9.1",
|
||||||
"tsconfig-paths": "4.1.1",
|
"tsconfig-paths": "4.1.1",
|
||||||
"typescript": "4.9.3"
|
"typescript": "^4.9.3"
|
||||||
},
|
},
|
||||||
"jest": {
|
"jest": {
|
||||||
"moduleFileExtensions": [
|
"moduleFileExtensions": [
|
||||||
|
|||||||
@@ -1,22 +0,0 @@
|
|||||||
-- This is a custom migration file which is not generated by Prisma.
|
|
||||||
-- The aim of this migration is to add text search indices to the TeamCollection and TeamRequest tables.
|
|
||||||
|
|
||||||
-- Create Extension
|
|
||||||
CREATE EXTENSION IF NOT EXISTS pg_trgm;
|
|
||||||
|
|
||||||
-- Create GIN Trigram Index for Team Collection title
|
|
||||||
CREATE INDEX
|
|
||||||
"TeamCollection_title_trgm_idx"
|
|
||||||
ON
|
|
||||||
"TeamCollection"
|
|
||||||
USING
|
|
||||||
GIN (title gin_trgm_ops);
|
|
||||||
|
|
||||||
-- Create GIN Trigram Index for Team Collection title
|
|
||||||
CREATE INDEX
|
|
||||||
"TeamRequest_title_trgm_idx"
|
|
||||||
ON
|
|
||||||
"TeamRequest"
|
|
||||||
USING
|
|
||||||
GIN (title gin_trgm_ops);
|
|
||||||
|
|
||||||
@@ -41,31 +41,31 @@ model TeamInvitation {
|
|||||||
}
|
}
|
||||||
|
|
||||||
model TeamCollection {
|
model TeamCollection {
|
||||||
id String @id @default(cuid())
|
id String @id @default(cuid())
|
||||||
parentID String?
|
parentID String?
|
||||||
data Json?
|
data Json?
|
||||||
parent TeamCollection? @relation("TeamCollectionChildParent", fields: [parentID], references: [id])
|
parent TeamCollection? @relation("TeamCollectionChildParent", fields: [parentID], references: [id])
|
||||||
children TeamCollection[] @relation("TeamCollectionChildParent")
|
children TeamCollection[] @relation("TeamCollectionChildParent")
|
||||||
requests TeamRequest[]
|
requests TeamRequest[]
|
||||||
teamID String
|
teamID String
|
||||||
team Team @relation(fields: [teamID], references: [id], onDelete: Cascade)
|
team Team @relation(fields: [teamID], references: [id], onDelete: Cascade)
|
||||||
title String
|
title String
|
||||||
orderIndex Int
|
orderIndex Int
|
||||||
createdOn DateTime @default(now()) @db.Timestamp(3)
|
createdOn DateTime @default(now()) @db.Timestamp(3)
|
||||||
updatedOn DateTime @updatedAt @db.Timestamp(3)
|
updatedOn DateTime @updatedAt @db.Timestamp(3)
|
||||||
}
|
}
|
||||||
|
|
||||||
model TeamRequest {
|
model TeamRequest {
|
||||||
id String @id @default(cuid())
|
id String @id @default(cuid())
|
||||||
collectionID String
|
collectionID String
|
||||||
collection TeamCollection @relation(fields: [collectionID], references: [id], onDelete: Cascade)
|
collection TeamCollection @relation(fields: [collectionID], references: [id], onDelete: Cascade)
|
||||||
teamID String
|
teamID String
|
||||||
team Team @relation(fields: [teamID], references: [id], onDelete: Cascade)
|
team Team @relation(fields: [teamID], references: [id], onDelete: Cascade)
|
||||||
title String
|
title String
|
||||||
request Json
|
request Json
|
||||||
orderIndex Int
|
orderIndex Int
|
||||||
createdOn DateTime @default(now()) @db.Timestamp(3)
|
createdOn DateTime @default(now()) @db.Timestamp(3)
|
||||||
updatedOn DateTime @updatedAt @db.Timestamp(3)
|
updatedOn DateTime @updatedAt @db.Timestamp(3)
|
||||||
}
|
}
|
||||||
|
|
||||||
model Shortcode {
|
model Shortcode {
|
||||||
|
|||||||
@@ -27,7 +27,9 @@ import {
|
|||||||
} from './input-types.args';
|
} from './input-types.args';
|
||||||
import { GqlThrottlerGuard } from 'src/guards/gql-throttler.guard';
|
import { GqlThrottlerGuard } from 'src/guards/gql-throttler.guard';
|
||||||
import { SkipThrottle } from '@nestjs/throttler';
|
import { SkipThrottle } from '@nestjs/throttler';
|
||||||
import { UserDeletionResult } from 'src/user/user.model';
|
import { User } from 'src/user/user.model';
|
||||||
|
import { PaginationArgs } from 'src/types/input-types.args';
|
||||||
|
import { TeamInvitation } from 'src/team-invitation/team-invitation.model';
|
||||||
|
|
||||||
@UseGuards(GqlThrottlerGuard)
|
@UseGuards(GqlThrottlerGuard)
|
||||||
@Resolver(() => Admin)
|
@Resolver(() => Admin)
|
||||||
@@ -47,6 +49,203 @@ export class AdminResolver {
|
|||||||
return admin;
|
return admin;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ResolveField(() => [User], {
|
||||||
|
description: 'Returns a list of all admin users in infra',
|
||||||
|
deprecationReason: 'Use `infra` query instead',
|
||||||
|
})
|
||||||
|
@UseGuards(GqlAuthGuard, GqlAdminGuard)
|
||||||
|
async admins() {
|
||||||
|
const admins = await this.adminService.fetchAdmins();
|
||||||
|
return admins;
|
||||||
|
}
|
||||||
|
@ResolveField(() => User, {
|
||||||
|
description: 'Returns a user info by UID',
|
||||||
|
deprecationReason: 'Use `infra` query instead',
|
||||||
|
})
|
||||||
|
@UseGuards(GqlAuthGuard, GqlAdminGuard)
|
||||||
|
async userInfo(
|
||||||
|
@Args({
|
||||||
|
name: 'userUid',
|
||||||
|
type: () => ID,
|
||||||
|
description: 'The user UID',
|
||||||
|
})
|
||||||
|
userUid: string,
|
||||||
|
): Promise<AuthUser> {
|
||||||
|
const user = await this.adminService.fetchUserInfo(userUid);
|
||||||
|
if (E.isLeft(user)) throwErr(user.left);
|
||||||
|
return user.right;
|
||||||
|
}
|
||||||
|
|
||||||
|
@ResolveField(() => [User], {
|
||||||
|
description: 'Returns a list of all the users in infra',
|
||||||
|
deprecationReason: 'Use `infra` query instead',
|
||||||
|
})
|
||||||
|
@UseGuards(GqlAuthGuard, GqlAdminGuard)
|
||||||
|
async allUsers(
|
||||||
|
@Parent() admin: Admin,
|
||||||
|
@Args() args: PaginationArgs,
|
||||||
|
): Promise<AuthUser[]> {
|
||||||
|
const users = await this.adminService.fetchUsers(args.cursor, args.take);
|
||||||
|
return users;
|
||||||
|
}
|
||||||
|
|
||||||
|
@ResolveField(() => [InvitedUser], {
|
||||||
|
description: 'Returns a list of all the invited users',
|
||||||
|
deprecationReason: 'Use `infra` query instead',
|
||||||
|
})
|
||||||
|
async invitedUsers(@Parent() admin: Admin): Promise<InvitedUser[]> {
|
||||||
|
const users = await this.adminService.fetchInvitedUsers();
|
||||||
|
return users;
|
||||||
|
}
|
||||||
|
|
||||||
|
@ResolveField(() => [Team], {
|
||||||
|
description: 'Returns a list of all the teams in the infra',
|
||||||
|
deprecationReason: 'Use `infra` query instead',
|
||||||
|
})
|
||||||
|
async allTeams(
|
||||||
|
@Parent() admin: Admin,
|
||||||
|
@Args() args: PaginationArgs,
|
||||||
|
): Promise<Team[]> {
|
||||||
|
const teams = await this.adminService.fetchAllTeams(args.cursor, args.take);
|
||||||
|
return teams;
|
||||||
|
}
|
||||||
|
@ResolveField(() => Team, {
|
||||||
|
description: 'Returns a team info by ID when requested by Admin',
|
||||||
|
deprecationReason: 'Use `infra` query instead',
|
||||||
|
})
|
||||||
|
async teamInfo(
|
||||||
|
@Parent() admin: Admin,
|
||||||
|
@Args({
|
||||||
|
name: 'teamID',
|
||||||
|
type: () => ID,
|
||||||
|
description: 'Team ID for which info to fetch',
|
||||||
|
})
|
||||||
|
teamID: string,
|
||||||
|
): Promise<Team> {
|
||||||
|
const team = await this.adminService.getTeamInfo(teamID);
|
||||||
|
if (E.isLeft(team)) throwErr(team.left);
|
||||||
|
return team.right;
|
||||||
|
}
|
||||||
|
|
||||||
|
@ResolveField(() => Number, {
|
||||||
|
description: 'Return count of all the members in a team',
|
||||||
|
deprecationReason: 'Use `infra` query instead',
|
||||||
|
})
|
||||||
|
async membersCountInTeam(
|
||||||
|
@Parent() admin: Admin,
|
||||||
|
@Args({
|
||||||
|
name: 'teamID',
|
||||||
|
type: () => ID,
|
||||||
|
description: 'Team ID for which team members to fetch',
|
||||||
|
nullable: false,
|
||||||
|
})
|
||||||
|
teamID: string,
|
||||||
|
): Promise<number> {
|
||||||
|
const teamMembersCount = await this.adminService.membersCountInTeam(teamID);
|
||||||
|
return teamMembersCount;
|
||||||
|
}
|
||||||
|
|
||||||
|
@ResolveField(() => Number, {
|
||||||
|
description: 'Return count of all the stored collections in a team',
|
||||||
|
deprecationReason: 'Use `infra` query instead',
|
||||||
|
})
|
||||||
|
async collectionCountInTeam(
|
||||||
|
@Parent() admin: Admin,
|
||||||
|
@Args({
|
||||||
|
name: 'teamID',
|
||||||
|
type: () => ID,
|
||||||
|
description: 'Team ID for which team members to fetch',
|
||||||
|
})
|
||||||
|
teamID: string,
|
||||||
|
): Promise<number> {
|
||||||
|
const teamCollCount = await this.adminService.collectionCountInTeam(teamID);
|
||||||
|
return teamCollCount;
|
||||||
|
}
|
||||||
|
@ResolveField(() => Number, {
|
||||||
|
description: 'Return count of all the stored requests in a team',
|
||||||
|
deprecationReason: 'Use `infra` query instead',
|
||||||
|
})
|
||||||
|
async requestCountInTeam(
|
||||||
|
@Parent() admin: Admin,
|
||||||
|
@Args({
|
||||||
|
name: 'teamID',
|
||||||
|
type: () => ID,
|
||||||
|
description: 'Team ID for which team members to fetch',
|
||||||
|
})
|
||||||
|
teamID: string,
|
||||||
|
): Promise<number> {
|
||||||
|
const teamReqCount = await this.adminService.requestCountInTeam(teamID);
|
||||||
|
return teamReqCount;
|
||||||
|
}
|
||||||
|
|
||||||
|
@ResolveField(() => Number, {
|
||||||
|
description: 'Return count of all the stored environments in a team',
|
||||||
|
deprecationReason: 'Use `infra` query instead',
|
||||||
|
})
|
||||||
|
async environmentCountInTeam(
|
||||||
|
@Parent() admin: Admin,
|
||||||
|
@Args({
|
||||||
|
name: 'teamID',
|
||||||
|
type: () => ID,
|
||||||
|
description: 'Team ID for which team members to fetch',
|
||||||
|
})
|
||||||
|
teamID: string,
|
||||||
|
): Promise<number> {
|
||||||
|
const envsCount = await this.adminService.environmentCountInTeam(teamID);
|
||||||
|
return envsCount;
|
||||||
|
}
|
||||||
|
|
||||||
|
@ResolveField(() => [TeamInvitation], {
|
||||||
|
description: 'Return all the pending invitations in a team',
|
||||||
|
deprecationReason: 'Use `infra` query instead',
|
||||||
|
})
|
||||||
|
async pendingInvitationCountInTeam(
|
||||||
|
@Parent() admin: Admin,
|
||||||
|
@Args({
|
||||||
|
name: 'teamID',
|
||||||
|
type: () => ID,
|
||||||
|
description: 'Team ID for which team members to fetch',
|
||||||
|
})
|
||||||
|
teamID: string,
|
||||||
|
) {
|
||||||
|
const invitations = await this.adminService.pendingInvitationCountInTeam(
|
||||||
|
teamID,
|
||||||
|
);
|
||||||
|
return invitations;
|
||||||
|
}
|
||||||
|
|
||||||
|
@ResolveField(() => Number, {
|
||||||
|
description: 'Return total number of Users in organization',
|
||||||
|
deprecationReason: 'Use `infra` query instead',
|
||||||
|
})
|
||||||
|
async usersCount() {
|
||||||
|
return this.adminService.getUsersCount();
|
||||||
|
}
|
||||||
|
|
||||||
|
@ResolveField(() => Number, {
|
||||||
|
description: 'Return total number of Teams in organization',
|
||||||
|
deprecationReason: 'Use `infra` query instead',
|
||||||
|
})
|
||||||
|
async teamsCount() {
|
||||||
|
return this.adminService.getTeamsCount();
|
||||||
|
}
|
||||||
|
|
||||||
|
@ResolveField(() => Number, {
|
||||||
|
description: 'Return total number of Team Collections in organization',
|
||||||
|
deprecationReason: 'Use `infra` query instead',
|
||||||
|
})
|
||||||
|
async teamCollectionsCount() {
|
||||||
|
return this.adminService.getTeamCollectionsCount();
|
||||||
|
}
|
||||||
|
|
||||||
|
@ResolveField(() => Number, {
|
||||||
|
description: 'Return total number of Team Requests in organization',
|
||||||
|
deprecationReason: 'Use `infra` query instead',
|
||||||
|
})
|
||||||
|
async teamRequestsCount() {
|
||||||
|
return this.adminService.getTeamRequestsCount();
|
||||||
|
}
|
||||||
|
|
||||||
/* Mutations */
|
/* Mutations */
|
||||||
|
|
||||||
@Mutation(() => InvitedUser, {
|
@Mutation(() => InvitedUser, {
|
||||||
@@ -70,26 +269,8 @@ export class AdminResolver {
|
|||||||
return invitedUser.right;
|
return invitedUser.right;
|
||||||
}
|
}
|
||||||
|
|
||||||
@Mutation(() => Boolean, {
|
|
||||||
description: 'Revoke a user invites by invitee emails',
|
|
||||||
})
|
|
||||||
@UseGuards(GqlAuthGuard, GqlAdminGuard)
|
|
||||||
async revokeUserInvitationsByAdmin(
|
|
||||||
@Args({
|
|
||||||
name: 'inviteeEmails',
|
|
||||||
description: 'Invitee Emails',
|
|
||||||
type: () => [String],
|
|
||||||
})
|
|
||||||
inviteeEmails: string[],
|
|
||||||
): Promise<boolean> {
|
|
||||||
const invite = await this.adminService.revokeUserInvitations(inviteeEmails);
|
|
||||||
if (E.isLeft(invite)) throwErr(invite.left);
|
|
||||||
return invite.right;
|
|
||||||
}
|
|
||||||
|
|
||||||
@Mutation(() => Boolean, {
|
@Mutation(() => Boolean, {
|
||||||
description: 'Delete an user account from infra',
|
description: 'Delete an user account from infra',
|
||||||
deprecationReason: 'Use removeUsersByAdmin instead',
|
|
||||||
})
|
})
|
||||||
@UseGuards(GqlAuthGuard, GqlAdminGuard)
|
@UseGuards(GqlAuthGuard, GqlAdminGuard)
|
||||||
async removeUserByAdmin(
|
async removeUserByAdmin(
|
||||||
@@ -100,33 +281,12 @@ export class AdminResolver {
|
|||||||
})
|
})
|
||||||
userUID: string,
|
userUID: string,
|
||||||
): Promise<boolean> {
|
): Promise<boolean> {
|
||||||
const removedUser = await this.adminService.removeUserAccount(userUID);
|
const invitedUser = await this.adminService.removeUserAccount(userUID);
|
||||||
if (E.isLeft(removedUser)) throwErr(removedUser.left);
|
if (E.isLeft(invitedUser)) throwErr(invitedUser.left);
|
||||||
return removedUser.right;
|
return invitedUser.right;
|
||||||
}
|
}
|
||||||
|
|
||||||
@Mutation(() => [UserDeletionResult], {
|
|
||||||
description: 'Delete user accounts from infra',
|
|
||||||
})
|
|
||||||
@UseGuards(GqlAuthGuard, GqlAdminGuard)
|
|
||||||
async removeUsersByAdmin(
|
|
||||||
@Args({
|
|
||||||
name: 'userUIDs',
|
|
||||||
description: 'users UID',
|
|
||||||
type: () => [ID],
|
|
||||||
})
|
|
||||||
userUIDs: string[],
|
|
||||||
): Promise<UserDeletionResult[]> {
|
|
||||||
const deletionResults = await this.adminService.removeUserAccounts(
|
|
||||||
userUIDs,
|
|
||||||
);
|
|
||||||
if (E.isLeft(deletionResults)) throwErr(deletionResults.left);
|
|
||||||
return deletionResults.right;
|
|
||||||
}
|
|
||||||
|
|
||||||
@Mutation(() => Boolean, {
|
@Mutation(() => Boolean, {
|
||||||
description: 'Make user an admin',
|
description: 'Make user an admin',
|
||||||
deprecationReason: 'Use makeUsersAdmin instead',
|
|
||||||
})
|
})
|
||||||
@UseGuards(GqlAuthGuard, GqlAdminGuard)
|
@UseGuards(GqlAuthGuard, GqlAdminGuard)
|
||||||
async makeUserAdmin(
|
async makeUserAdmin(
|
||||||
@@ -142,51 +302,8 @@ export class AdminResolver {
|
|||||||
return admin.right;
|
return admin.right;
|
||||||
}
|
}
|
||||||
|
|
||||||
@Mutation(() => Boolean, {
|
|
||||||
description: 'Make users an admin',
|
|
||||||
})
|
|
||||||
@UseGuards(GqlAuthGuard, GqlAdminGuard)
|
|
||||||
async makeUsersAdmin(
|
|
||||||
@Args({
|
|
||||||
name: 'userUIDs',
|
|
||||||
description: 'users UID',
|
|
||||||
type: () => [ID],
|
|
||||||
})
|
|
||||||
userUIDs: string[],
|
|
||||||
): Promise<boolean> {
|
|
||||||
const isUpdated = await this.adminService.makeUsersAdmin(userUIDs);
|
|
||||||
if (E.isLeft(isUpdated)) throwErr(isUpdated.left);
|
|
||||||
return isUpdated.right;
|
|
||||||
}
|
|
||||||
|
|
||||||
@Mutation(() => Boolean, {
|
|
||||||
description: 'Update user display name',
|
|
||||||
})
|
|
||||||
@UseGuards(GqlAuthGuard, GqlAdminGuard)
|
|
||||||
async updateUserDisplayNameByAdmin(
|
|
||||||
@Args({
|
|
||||||
name: 'userUID',
|
|
||||||
description: 'users UID',
|
|
||||||
type: () => ID,
|
|
||||||
})
|
|
||||||
userUID: string,
|
|
||||||
@Args({
|
|
||||||
name: 'displayName',
|
|
||||||
description: 'users display name',
|
|
||||||
})
|
|
||||||
displayName: string,
|
|
||||||
): Promise<boolean> {
|
|
||||||
const isUpdated = await this.adminService.updateUserDisplayName(
|
|
||||||
userUID,
|
|
||||||
displayName,
|
|
||||||
);
|
|
||||||
if (E.isLeft(isUpdated)) throwErr(isUpdated.left);
|
|
||||||
return isUpdated.right;
|
|
||||||
}
|
|
||||||
|
|
||||||
@Mutation(() => Boolean, {
|
@Mutation(() => Boolean, {
|
||||||
description: 'Remove user as admin',
|
description: 'Remove user as admin',
|
||||||
deprecationReason: 'Use demoteUsersByAdmin instead',
|
|
||||||
})
|
})
|
||||||
@UseGuards(GqlAuthGuard, GqlAdminGuard)
|
@UseGuards(GqlAuthGuard, GqlAdminGuard)
|
||||||
async removeUserAsAdmin(
|
async removeUserAsAdmin(
|
||||||
@@ -202,23 +319,6 @@ export class AdminResolver {
|
|||||||
return admin.right;
|
return admin.right;
|
||||||
}
|
}
|
||||||
|
|
||||||
@Mutation(() => Boolean, {
|
|
||||||
description: 'Remove users as admin',
|
|
||||||
})
|
|
||||||
@UseGuards(GqlAuthGuard, GqlAdminGuard)
|
|
||||||
async demoteUsersByAdmin(
|
|
||||||
@Args({
|
|
||||||
name: 'userUIDs',
|
|
||||||
description: 'users UID',
|
|
||||||
type: () => [ID],
|
|
||||||
})
|
|
||||||
userUIDs: string[],
|
|
||||||
): Promise<boolean> {
|
|
||||||
const isUpdated = await this.adminService.demoteUsersByAdmin(userUIDs);
|
|
||||||
if (E.isLeft(isUpdated)) throwErr(isUpdated.left);
|
|
||||||
return isUpdated.right;
|
|
||||||
}
|
|
||||||
|
|
||||||
@Mutation(() => Team, {
|
@Mutation(() => Team, {
|
||||||
description:
|
description:
|
||||||
'Create a new team by providing the user uid to nominate as Team owner',
|
'Create a new team by providing the user uid to nominate as Team owner',
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
import { AdminService } from './admin.service';
|
import { AdminService } from './admin.service';
|
||||||
import { PubSubService } from '../pubsub/pubsub.service';
|
import { PubSubService } from '../pubsub/pubsub.service';
|
||||||
import { mockDeep } from 'jest-mock-extended';
|
import { mockDeep } from 'jest-mock-extended';
|
||||||
import { InvitedUsers, User as DbUser } from '@prisma/client';
|
import { InvitedUsers } from '@prisma/client';
|
||||||
import { UserService } from '../user/user.service';
|
import { UserService } from '../user/user.service';
|
||||||
import { TeamService } from '../team/team.service';
|
import { TeamService } from '../team/team.service';
|
||||||
import { TeamEnvironmentsService } from '../team-environments/team-environments.service';
|
import { TeamEnvironmentsService } from '../team-environments/team-environments.service';
|
||||||
@@ -13,15 +13,10 @@ import { PrismaService } from 'src/prisma/prisma.service';
|
|||||||
import {
|
import {
|
||||||
DUPLICATE_EMAIL,
|
DUPLICATE_EMAIL,
|
||||||
INVALID_EMAIL,
|
INVALID_EMAIL,
|
||||||
ONLY_ONE_ADMIN_ACCOUNT,
|
|
||||||
USER_ALREADY_INVITED,
|
USER_ALREADY_INVITED,
|
||||||
USER_INVITATION_DELETION_FAILED,
|
|
||||||
USER_NOT_FOUND,
|
|
||||||
} from '../errors';
|
} from '../errors';
|
||||||
import { ShortcodeService } from 'src/shortcode/shortcode.service';
|
import { ShortcodeService } from 'src/shortcode/shortcode.service';
|
||||||
import { ConfigService } from '@nestjs/config';
|
import { ConfigService } from '@nestjs/config';
|
||||||
import { OffsetPaginationArgs } from 'src/types/input-types.args';
|
|
||||||
import * as E from 'fp-ts/Either';
|
|
||||||
|
|
||||||
const mockPrisma = mockDeep<PrismaService>();
|
const mockPrisma = mockDeep<PrismaService>();
|
||||||
const mockPubSub = mockDeep<PubSubService>();
|
const mockPubSub = mockDeep<PubSubService>();
|
||||||
@@ -63,87 +58,20 @@ const invitedUsers: InvitedUsers[] = [
|
|||||||
invitedOn: new Date(),
|
invitedOn: new Date(),
|
||||||
},
|
},
|
||||||
];
|
];
|
||||||
|
|
||||||
const dbAdminUsers: DbUser[] = [
|
|
||||||
{
|
|
||||||
uid: 'uid 1',
|
|
||||||
displayName: 'displayName',
|
|
||||||
email: 'email@email.com',
|
|
||||||
photoURL: 'photoURL',
|
|
||||||
isAdmin: true,
|
|
||||||
refreshToken: 'refreshToken',
|
|
||||||
currentRESTSession: '',
|
|
||||||
currentGQLSession: '',
|
|
||||||
createdOn: new Date(),
|
|
||||||
},
|
|
||||||
{
|
|
||||||
uid: 'uid 2',
|
|
||||||
displayName: 'displayName',
|
|
||||||
email: 'email@email.com',
|
|
||||||
photoURL: 'photoURL',
|
|
||||||
isAdmin: true,
|
|
||||||
refreshToken: 'refreshToken',
|
|
||||||
currentRESTSession: '',
|
|
||||||
currentGQLSession: '',
|
|
||||||
createdOn: new Date(),
|
|
||||||
},
|
|
||||||
];
|
|
||||||
const dbNonAminUser: DbUser = {
|
|
||||||
uid: 'uid 3',
|
|
||||||
displayName: 'displayName',
|
|
||||||
email: 'email@email.com',
|
|
||||||
photoURL: 'photoURL',
|
|
||||||
isAdmin: false,
|
|
||||||
refreshToken: 'refreshToken',
|
|
||||||
currentRESTSession: '',
|
|
||||||
currentGQLSession: '',
|
|
||||||
createdOn: new Date(),
|
|
||||||
};
|
|
||||||
|
|
||||||
describe('AdminService', () => {
|
describe('AdminService', () => {
|
||||||
describe('fetchInvitedUsers', () => {
|
describe('fetchInvitedUsers', () => {
|
||||||
test('should resolve right and apply pagination correctly', async () => {
|
|
||||||
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
|
|
||||||
// @ts-ignore
|
|
||||||
mockPrisma.user.findMany.mockResolvedValue([dbAdminUsers[0]]);
|
|
||||||
// @ts-ignore
|
|
||||||
mockPrisma.invitedUsers.findMany.mockResolvedValue(invitedUsers);
|
|
||||||
|
|
||||||
const paginationArgs: OffsetPaginationArgs = { take: 5, skip: 2 };
|
|
||||||
const results = await adminService.fetchInvitedUsers(paginationArgs);
|
|
||||||
|
|
||||||
expect(mockPrisma.invitedUsers.findMany).toHaveBeenCalledWith({
|
|
||||||
...paginationArgs,
|
|
||||||
orderBy: {
|
|
||||||
invitedOn: 'desc',
|
|
||||||
},
|
|
||||||
where: {
|
|
||||||
NOT: {
|
|
||||||
inviteeEmail: {
|
|
||||||
in: [dbAdminUsers[0].email],
|
|
||||||
},
|
|
||||||
},
|
|
||||||
},
|
|
||||||
});
|
|
||||||
});
|
|
||||||
test('should resolve right and return an array of invited users', async () => {
|
test('should resolve right and return an array of invited users', async () => {
|
||||||
const paginationArgs: OffsetPaginationArgs = { take: 10, skip: 0 };
|
|
||||||
|
|
||||||
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
|
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
|
||||||
// @ts-ignore
|
// @ts-ignore
|
||||||
mockPrisma.user.findMany.mockResolvedValue([dbAdminUsers[0]]);
|
|
||||||
// @ts-ignore
|
|
||||||
mockPrisma.invitedUsers.findMany.mockResolvedValue(invitedUsers);
|
mockPrisma.invitedUsers.findMany.mockResolvedValue(invitedUsers);
|
||||||
|
|
||||||
const results = await adminService.fetchInvitedUsers(paginationArgs);
|
const results = await adminService.fetchInvitedUsers();
|
||||||
expect(results).toEqual(invitedUsers);
|
expect(results).toEqual(invitedUsers);
|
||||||
});
|
});
|
||||||
test('should resolve left and return an empty array if invited users not found', async () => {
|
test('should resolve left and return an empty array if invited users not found', async () => {
|
||||||
const paginationArgs: OffsetPaginationArgs = { take: 10, skip: 0 };
|
|
||||||
|
|
||||||
mockPrisma.invitedUsers.findMany.mockResolvedValue([]);
|
mockPrisma.invitedUsers.findMany.mockResolvedValue([]);
|
||||||
|
|
||||||
const results = await adminService.fetchInvitedUsers(paginationArgs);
|
const results = await adminService.fetchInvitedUsers();
|
||||||
expect(results).toEqual([]);
|
expect(results).toEqual([]);
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
@@ -206,58 +134,6 @@ describe('AdminService', () => {
|
|||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
describe('revokeUserInvitations', () => {
|
|
||||||
test('should resolve left and return error if email not invited', async () => {
|
|
||||||
mockPrisma.invitedUsers.deleteMany.mockRejectedValueOnce(
|
|
||||||
'RecordNotFound',
|
|
||||||
);
|
|
||||||
|
|
||||||
const result = await adminService.revokeUserInvitations([
|
|
||||||
'test@gmail.com',
|
|
||||||
]);
|
|
||||||
|
|
||||||
expect(result).toEqualLeft(USER_INVITATION_DELETION_FAILED);
|
|
||||||
});
|
|
||||||
|
|
||||||
test('should resolve right and return deleted invitee email', async () => {
|
|
||||||
const adminUid = 'adminUid';
|
|
||||||
mockPrisma.invitedUsers.deleteMany.mockResolvedValueOnce({ count: 1 });
|
|
||||||
|
|
||||||
const result = await adminService.revokeUserInvitations([
|
|
||||||
invitedUsers[0].inviteeEmail,
|
|
||||||
]);
|
|
||||||
|
|
||||||
expect(mockPrisma.invitedUsers.deleteMany).toHaveBeenCalledWith({
|
|
||||||
where: {
|
|
||||||
inviteeEmail: { in: [invitedUsers[0].inviteeEmail] },
|
|
||||||
},
|
|
||||||
});
|
|
||||||
expect(result).toEqualRight(true);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('removeUsersAsAdmin', () => {
|
|
||||||
test('should resolve right and make admins to users', async () => {
|
|
||||||
mockUserService.fetchAdminUsers.mockResolvedValueOnce(dbAdminUsers);
|
|
||||||
mockUserService.removeUsersAsAdmin.mockResolvedValueOnce(E.right(true));
|
|
||||||
|
|
||||||
return expect(
|
|
||||||
await adminService.demoteUsersByAdmin([dbAdminUsers[0].uid]),
|
|
||||||
).toEqualRight(true);
|
|
||||||
});
|
|
||||||
|
|
||||||
test('should resolve left and return error if only one admin in the infra', async () => {
|
|
||||||
mockUserService.fetchAdminUsers.mockResolvedValueOnce(dbAdminUsers);
|
|
||||||
mockUserService.removeUsersAsAdmin.mockResolvedValueOnce(E.right(true));
|
|
||||||
|
|
||||||
return expect(
|
|
||||||
await adminService.demoteUsersByAdmin(
|
|
||||||
dbAdminUsers.map((user) => user.uid),
|
|
||||||
),
|
|
||||||
).toEqualLeft(ONLY_ONE_ADMIN_ACCOUNT);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('getUsersCount', () => {
|
describe('getUsersCount', () => {
|
||||||
test('should return count of all users in the organization', async () => {
|
test('should return count of all users in the organization', async () => {
|
||||||
mockUserService.getUsersCount.mockResolvedValueOnce(10);
|
mockUserService.getUsersCount.mockResolvedValueOnce(10);
|
||||||
|
|||||||
@@ -6,16 +6,13 @@ import * as E from 'fp-ts/Either';
|
|||||||
import * as O from 'fp-ts/Option';
|
import * as O from 'fp-ts/Option';
|
||||||
import { validateEmail } from '../utils';
|
import { validateEmail } from '../utils';
|
||||||
import {
|
import {
|
||||||
ADMIN_CAN_NOT_BE_DELETED,
|
|
||||||
DUPLICATE_EMAIL,
|
DUPLICATE_EMAIL,
|
||||||
EMAIL_FAILED,
|
EMAIL_FAILED,
|
||||||
INVALID_EMAIL,
|
INVALID_EMAIL,
|
||||||
ONLY_ONE_ADMIN_ACCOUNT,
|
ONLY_ONE_ADMIN_ACCOUNT,
|
||||||
TEAM_INVITE_ALREADY_MEMBER,
|
TEAM_INVITE_ALREADY_MEMBER,
|
||||||
TEAM_INVITE_NO_INVITE_FOUND,
|
TEAM_INVITE_NO_INVITE_FOUND,
|
||||||
USERS_NOT_FOUND,
|
|
||||||
USER_ALREADY_INVITED,
|
USER_ALREADY_INVITED,
|
||||||
USER_INVITATION_DELETION_FAILED,
|
|
||||||
USER_IS_ADMIN,
|
USER_IS_ADMIN,
|
||||||
USER_NOT_FOUND,
|
USER_NOT_FOUND,
|
||||||
} from '../errors';
|
} from '../errors';
|
||||||
@@ -29,8 +26,6 @@ import { TeamInvitationService } from '../team-invitation/team-invitation.servic
|
|||||||
import { TeamMemberRole } from '../team/team.model';
|
import { TeamMemberRole } from '../team/team.model';
|
||||||
import { ShortcodeService } from 'src/shortcode/shortcode.service';
|
import { ShortcodeService } from 'src/shortcode/shortcode.service';
|
||||||
import { ConfigService } from '@nestjs/config';
|
import { ConfigService } from '@nestjs/config';
|
||||||
import { OffsetPaginationArgs } from 'src/types/input-types.args';
|
|
||||||
import { UserDeletionResult } from 'src/user/user.model';
|
|
||||||
|
|
||||||
@Injectable()
|
@Injectable()
|
||||||
export class AdminService {
|
export class AdminService {
|
||||||
@@ -53,30 +48,12 @@ export class AdminService {
|
|||||||
* @param cursorID Users uid
|
* @param cursorID Users uid
|
||||||
* @param take number of users to fetch
|
* @param take number of users to fetch
|
||||||
* @returns an Either of array of user or error
|
* @returns an Either of array of user or error
|
||||||
* @deprecated use fetchUsersV2 instead
|
|
||||||
*/
|
*/
|
||||||
async fetchUsers(cursorID: string, take: number) {
|
async fetchUsers(cursorID: string, take: number) {
|
||||||
const allUsers = await this.userService.fetchAllUsers(cursorID, take);
|
const allUsers = await this.userService.fetchAllUsers(cursorID, take);
|
||||||
return allUsers;
|
return allUsers;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Fetch all the users in the infra.
|
|
||||||
* @param searchString search on users displayName or email
|
|
||||||
* @param paginationOption pagination options
|
|
||||||
* @returns an Either of array of user or error
|
|
||||||
*/
|
|
||||||
async fetchUsersV2(
|
|
||||||
searchString: string,
|
|
||||||
paginationOption: OffsetPaginationArgs,
|
|
||||||
) {
|
|
||||||
const allUsers = await this.userService.fetchAllUsersV2(
|
|
||||||
searchString,
|
|
||||||
paginationOption,
|
|
||||||
);
|
|
||||||
return allUsers;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Invite a user to join the infra.
|
* Invite a user to join the infra.
|
||||||
* @param adminUID Admin's UID
|
* @param adminUID Admin's UID
|
||||||
@@ -133,68 +110,14 @@ export class AdminService {
|
|||||||
return E.right(invitedUser);
|
return E.right(invitedUser);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Update the display name of a user
|
|
||||||
* @param userUid Who's display name is being updated
|
|
||||||
* @param displayName New display name of the user
|
|
||||||
* @returns an Either of boolean or error
|
|
||||||
*/
|
|
||||||
async updateUserDisplayName(userUid: string, displayName: string) {
|
|
||||||
const updatedUser = await this.userService.updateUserDisplayName(
|
|
||||||
userUid,
|
|
||||||
displayName,
|
|
||||||
);
|
|
||||||
if (E.isLeft(updatedUser)) return E.left(updatedUser.left);
|
|
||||||
|
|
||||||
return E.right(true);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Revoke infra level user invitations
|
|
||||||
* @param inviteeEmails Invitee's emails
|
|
||||||
* @param adminUid Admin Uid
|
|
||||||
* @returns an Either of boolean or error string
|
|
||||||
*/
|
|
||||||
async revokeUserInvitations(inviteeEmails: string[]) {
|
|
||||||
try {
|
|
||||||
await this.prisma.invitedUsers.deleteMany({
|
|
||||||
where: {
|
|
||||||
inviteeEmail: { in: inviteeEmails },
|
|
||||||
},
|
|
||||||
});
|
|
||||||
return E.right(true);
|
|
||||||
} catch (error) {
|
|
||||||
return E.left(USER_INVITATION_DELETION_FAILED);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Fetch the list of invited users by the admin.
|
* Fetch the list of invited users by the admin.
|
||||||
* @returns an Either of array of `InvitedUser` object or error
|
* @returns an Either of array of `InvitedUser` object or error
|
||||||
*/
|
*/
|
||||||
async fetchInvitedUsers(paginationOption: OffsetPaginationArgs) {
|
async fetchInvitedUsers() {
|
||||||
const userEmailObjs = await this.prisma.user.findMany({
|
const invitedUsers = await this.prisma.invitedUsers.findMany();
|
||||||
select: {
|
|
||||||
email: true,
|
|
||||||
},
|
|
||||||
});
|
|
||||||
|
|
||||||
const pendingInvitedUsers = await this.prisma.invitedUsers.findMany({
|
const users: InvitedUser[] = invitedUsers.map(
|
||||||
take: paginationOption.take,
|
|
||||||
skip: paginationOption.skip,
|
|
||||||
orderBy: {
|
|
||||||
invitedOn: 'desc',
|
|
||||||
},
|
|
||||||
where: {
|
|
||||||
NOT: {
|
|
||||||
inviteeEmail: {
|
|
||||||
in: userEmailObjs.map((user) => user.email),
|
|
||||||
},
|
|
||||||
},
|
|
||||||
},
|
|
||||||
});
|
|
||||||
|
|
||||||
const users: InvitedUser[] = pendingInvitedUsers.map(
|
|
||||||
(user) => <InvitedUser>{ ...user },
|
(user) => <InvitedUser>{ ...user },
|
||||||
);
|
);
|
||||||
|
|
||||||
@@ -414,7 +337,6 @@ export class AdminService {
|
|||||||
* Remove a user account by UID
|
* Remove a user account by UID
|
||||||
* @param userUid User UID
|
* @param userUid User UID
|
||||||
* @returns an Either of boolean or error
|
* @returns an Either of boolean or error
|
||||||
* @deprecated use removeUserAccounts instead
|
|
||||||
*/
|
*/
|
||||||
async removeUserAccount(userUid: string) {
|
async removeUserAccount(userUid: string) {
|
||||||
const user = await this.userService.findUserById(userUid);
|
const user = await this.userService.findUserById(userUid);
|
||||||
@@ -427,73 +349,10 @@ export class AdminService {
|
|||||||
return E.right(delUser.right);
|
return E.right(delUser.right);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Remove user (not Admin) accounts by UIDs
|
|
||||||
* @param userUIDs User UIDs
|
|
||||||
* @returns an Either of boolean or error
|
|
||||||
*/
|
|
||||||
async removeUserAccounts(userUIDs: string[]) {
|
|
||||||
const userDeleteResult: UserDeletionResult[] = [];
|
|
||||||
|
|
||||||
// step 1: fetch all users
|
|
||||||
const allUsersList = await this.userService.findUsersByIds(userUIDs);
|
|
||||||
if (allUsersList.length === 0) return E.left(USERS_NOT_FOUND);
|
|
||||||
|
|
||||||
// step 2: admin user can not be deleted without removing admin status/role
|
|
||||||
allUsersList.forEach((user) => {
|
|
||||||
if (user.isAdmin) {
|
|
||||||
userDeleteResult.push({
|
|
||||||
userUID: user.uid,
|
|
||||||
isDeleted: false,
|
|
||||||
errorMessage: ADMIN_CAN_NOT_BE_DELETED,
|
|
||||||
});
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
const nonAdminUsers = allUsersList.filter((user) => !user.isAdmin);
|
|
||||||
let deletedUserEmails: string[] = [];
|
|
||||||
|
|
||||||
// step 3: delete non-admin users
|
|
||||||
const deletionPromises = nonAdminUsers.map((user) => {
|
|
||||||
return this.userService
|
|
||||||
.deleteUserByUID(user)()
|
|
||||||
.then((res) => {
|
|
||||||
if (E.isLeft(res)) {
|
|
||||||
return {
|
|
||||||
userUID: user.uid,
|
|
||||||
isDeleted: false,
|
|
||||||
errorMessage: res.left,
|
|
||||||
} as UserDeletionResult;
|
|
||||||
}
|
|
||||||
|
|
||||||
deletedUserEmails.push(user.email);
|
|
||||||
return {
|
|
||||||
userUID: user.uid,
|
|
||||||
isDeleted: true,
|
|
||||||
errorMessage: null,
|
|
||||||
} as UserDeletionResult;
|
|
||||||
});
|
|
||||||
});
|
|
||||||
const promiseResult = await Promise.allSettled(deletionPromises);
|
|
||||||
|
|
||||||
// step 4: revoke all the invites sent to the deleted users
|
|
||||||
await this.revokeUserInvitations(deletedUserEmails);
|
|
||||||
|
|
||||||
// step 5: return the result
|
|
||||||
promiseResult.forEach((result) => {
|
|
||||||
if (result.status === 'fulfilled') {
|
|
||||||
userDeleteResult.push(result.value);
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
return E.right(userDeleteResult);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Make a user an admin
|
* Make a user an admin
|
||||||
* @param userUid User UID
|
* @param userUid User UID
|
||||||
* @returns an Either of boolean or error
|
* @returns an Either of boolean or error
|
||||||
* @deprecated use makeUsersAdmin instead
|
|
||||||
*/
|
*/
|
||||||
async makeUserAdmin(userUID: string) {
|
async makeUserAdmin(userUID: string) {
|
||||||
const admin = await this.userService.makeAdmin(userUID);
|
const admin = await this.userService.makeAdmin(userUID);
|
||||||
@@ -501,22 +360,10 @@ export class AdminService {
|
|||||||
return E.right(true);
|
return E.right(true);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Make users to admin
|
|
||||||
* @param userUid User UIDs
|
|
||||||
* @returns an Either of boolean or error
|
|
||||||
*/
|
|
||||||
async makeUsersAdmin(userUIDs: string[]) {
|
|
||||||
const isUpdated = await this.userService.makeAdmins(userUIDs);
|
|
||||||
if (E.isLeft(isUpdated)) return E.left(isUpdated.left);
|
|
||||||
return E.right(true);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Remove user as admin
|
* Remove user as admin
|
||||||
* @param userUid User UID
|
* @param userUid User UID
|
||||||
* @returns an Either of boolean or error
|
* @returns an Either of boolean or error
|
||||||
* @deprecated use demoteUsersByAdmin instead
|
|
||||||
*/
|
*/
|
||||||
async removeUserAsAdmin(userUID: string) {
|
async removeUserAsAdmin(userUID: string) {
|
||||||
const adminUsers = await this.userService.fetchAdminUsers();
|
const adminUsers = await this.userService.fetchAdminUsers();
|
||||||
@@ -527,26 +374,6 @@ export class AdminService {
|
|||||||
return E.right(true);
|
return E.right(true);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Remove users as admin
|
|
||||||
* @param userUIDs User UIDs
|
|
||||||
* @returns an Either of boolean or error
|
|
||||||
*/
|
|
||||||
async demoteUsersByAdmin(userUIDs: string[]) {
|
|
||||||
const adminUsers = await this.userService.fetchAdminUsers();
|
|
||||||
|
|
||||||
const remainingAdmins = adminUsers.filter(
|
|
||||||
(adminUser) => !userUIDs.includes(adminUser.uid),
|
|
||||||
);
|
|
||||||
if (remainingAdmins.length < 1) {
|
|
||||||
return E.left(ONLY_ONE_ADMIN_ACCOUNT);
|
|
||||||
}
|
|
||||||
|
|
||||||
const isUpdated = await this.userService.removeUsersAsAdmin(userUIDs);
|
|
||||||
if (E.isLeft(isUpdated)) return E.left(isUpdated.left);
|
|
||||||
return E.right(isUpdated.right);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Fetch list of all the Users in org
|
* Fetch list of all the Users in org
|
||||||
* @returns number of users in the org
|
* @returns number of users in the org
|
||||||
|
|||||||
@@ -1,11 +0,0 @@
|
|||||||
import { Injectable, ExecutionContext, CanActivate } from '@nestjs/common';
|
|
||||||
|
|
||||||
@Injectable()
|
|
||||||
export class RESTAdminGuard implements CanActivate {
|
|
||||||
canActivate(context: ExecutionContext): boolean {
|
|
||||||
const request = context.switchToHttp().getRequest();
|
|
||||||
const user = request.user;
|
|
||||||
|
|
||||||
return user.isAdmin;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -17,10 +17,7 @@ import { AuthUser } from 'src/types/AuthUser';
|
|||||||
import { throwErr } from 'src/utils';
|
import { throwErr } from 'src/utils';
|
||||||
import * as E from 'fp-ts/Either';
|
import * as E from 'fp-ts/Either';
|
||||||
import { Admin } from './admin.model';
|
import { Admin } from './admin.model';
|
||||||
import {
|
import { PaginationArgs } from 'src/types/input-types.args';
|
||||||
OffsetPaginationArgs,
|
|
||||||
PaginationArgs,
|
|
||||||
} from 'src/types/input-types.args';
|
|
||||||
import { InvitedUser } from './invited-user.model';
|
import { InvitedUser } from './invited-user.model';
|
||||||
import { Team } from 'src/team/team.model';
|
import { Team } from 'src/team/team.model';
|
||||||
import { TeamInvitation } from 'src/team-invitation/team-invitation.model';
|
import { TeamInvitation } from 'src/team-invitation/team-invitation.model';
|
||||||
@@ -32,8 +29,7 @@ import {
|
|||||||
EnableAndDisableSSOArgs,
|
EnableAndDisableSSOArgs,
|
||||||
InfraConfigArgs,
|
InfraConfigArgs,
|
||||||
} from 'src/infra-config/input-args';
|
} from 'src/infra-config/input-args';
|
||||||
import { InfraConfigEnum } from 'src/types/InfraConfig';
|
import { InfraConfigEnumForClient } from 'src/types/InfraConfig';
|
||||||
import { ServiceStatus } from 'src/infra-config/helper';
|
|
||||||
|
|
||||||
@UseGuards(GqlThrottlerGuard)
|
@UseGuards(GqlThrottlerGuard)
|
||||||
@Resolver(() => Infra)
|
@Resolver(() => Infra)
|
||||||
@@ -80,7 +76,6 @@ export class InfraResolver {
|
|||||||
|
|
||||||
@ResolveField(() => [User], {
|
@ResolveField(() => [User], {
|
||||||
description: 'Returns a list of all the users in infra',
|
description: 'Returns a list of all the users in infra',
|
||||||
deprecationReason: 'Use allUsersV2 instead',
|
|
||||||
})
|
})
|
||||||
@UseGuards(GqlAuthGuard, GqlAdminGuard)
|
@UseGuards(GqlAuthGuard, GqlAdminGuard)
|
||||||
async allUsers(@Args() args: PaginationArgs): Promise<AuthUser[]> {
|
async allUsers(@Args() args: PaginationArgs): Promise<AuthUser[]> {
|
||||||
@@ -88,33 +83,11 @@ export class InfraResolver {
|
|||||||
return users;
|
return users;
|
||||||
}
|
}
|
||||||
|
|
||||||
@ResolveField(() => [User], {
|
|
||||||
description: 'Returns a list of all the users in infra',
|
|
||||||
})
|
|
||||||
@UseGuards(GqlAuthGuard, GqlAdminGuard)
|
|
||||||
async allUsersV2(
|
|
||||||
@Args({
|
|
||||||
name: 'searchString',
|
|
||||||
nullable: true,
|
|
||||||
description: 'Search on users displayName or email',
|
|
||||||
})
|
|
||||||
searchString: string,
|
|
||||||
@Args() paginationOption: OffsetPaginationArgs,
|
|
||||||
): Promise<AuthUser[]> {
|
|
||||||
const users = await this.adminService.fetchUsersV2(
|
|
||||||
searchString,
|
|
||||||
paginationOption,
|
|
||||||
);
|
|
||||||
return users;
|
|
||||||
}
|
|
||||||
|
|
||||||
@ResolveField(() => [InvitedUser], {
|
@ResolveField(() => [InvitedUser], {
|
||||||
description: 'Returns a list of all the invited users',
|
description: 'Returns a list of all the invited users',
|
||||||
})
|
})
|
||||||
async invitedUsers(
|
async invitedUsers(): Promise<InvitedUser[]> {
|
||||||
@Args() args: OffsetPaginationArgs,
|
const users = await this.adminService.fetchInvitedUsers();
|
||||||
): Promise<InvitedUser[]> {
|
|
||||||
const users = await this.adminService.fetchInvitedUsers(args);
|
|
||||||
return users;
|
return users;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -274,10 +247,10 @@ export class InfraResolver {
|
|||||||
async infraConfigs(
|
async infraConfigs(
|
||||||
@Args({
|
@Args({
|
||||||
name: 'configNames',
|
name: 'configNames',
|
||||||
type: () => [InfraConfigEnum],
|
type: () => [InfraConfigEnumForClient],
|
||||||
description: 'Configs to fetch',
|
description: 'Configs to fetch',
|
||||||
})
|
})
|
||||||
names: InfraConfigEnum[],
|
names: InfraConfigEnumForClient[],
|
||||||
) {
|
) {
|
||||||
const infraConfigs = await this.infraConfigService.getMany(names);
|
const infraConfigs = await this.infraConfigService.getMany(names);
|
||||||
if (E.isLeft(infraConfigs)) throwErr(infraConfigs.left);
|
if (E.isLeft(infraConfigs)) throwErr(infraConfigs.left);
|
||||||
@@ -311,25 +284,6 @@ export class InfraResolver {
|
|||||||
return updatedRes.right;
|
return updatedRes.right;
|
||||||
}
|
}
|
||||||
|
|
||||||
@Mutation(() => Boolean, {
|
|
||||||
description: 'Enable or disable analytics collection',
|
|
||||||
})
|
|
||||||
@UseGuards(GqlAuthGuard, GqlAdminGuard)
|
|
||||||
async toggleAnalyticsCollection(
|
|
||||||
@Args({
|
|
||||||
name: 'status',
|
|
||||||
type: () => ServiceStatus,
|
|
||||||
description: 'Toggle analytics collection',
|
|
||||||
})
|
|
||||||
analyticsCollectionStatus: ServiceStatus,
|
|
||||||
) {
|
|
||||||
const res = await this.infraConfigService.toggleAnalyticsCollection(
|
|
||||||
analyticsCollectionStatus,
|
|
||||||
);
|
|
||||||
if (E.isLeft(res)) throwErr(res.left);
|
|
||||||
return res.right;
|
|
||||||
}
|
|
||||||
|
|
||||||
@Mutation(() => Boolean, {
|
@Mutation(() => Boolean, {
|
||||||
description: 'Reset Infra Configs with default values (.env)',
|
description: 'Reset Infra Configs with default values (.env)',
|
||||||
})
|
})
|
||||||
@@ -352,9 +306,7 @@ export class InfraResolver {
|
|||||||
})
|
})
|
||||||
providerInfo: EnableAndDisableSSOArgs[],
|
providerInfo: EnableAndDisableSSOArgs[],
|
||||||
) {
|
) {
|
||||||
const isUpdated = await this.infraConfigService.enableAndDisableSSO(
|
const isUpdated = await this.infraConfigService.enableAndDisableSSO(providerInfo);
|
||||||
providerInfo,
|
|
||||||
);
|
|
||||||
if (E.isLeft(isUpdated)) throwErr(isUpdated.left);
|
if (E.isLeft(isUpdated)) throwErr(isUpdated.left);
|
||||||
|
|
||||||
return true;
|
return true;
|
||||||
|
|||||||
@@ -24,8 +24,6 @@ import { ConfigModule, ConfigService } from '@nestjs/config';
|
|||||||
import { InfraConfigModule } from './infra-config/infra-config.module';
|
import { InfraConfigModule } from './infra-config/infra-config.module';
|
||||||
import { loadInfraConfiguration } from './infra-config/helper';
|
import { loadInfraConfiguration } from './infra-config/helper';
|
||||||
import { MailerModule } from './mailer/mailer.module';
|
import { MailerModule } from './mailer/mailer.module';
|
||||||
import { PosthogModule } from './posthog/posthog.module';
|
|
||||||
import { ScheduleModule } from '@nestjs/schedule';
|
|
||||||
|
|
||||||
@Module({
|
@Module({
|
||||||
imports: [
|
imports: [
|
||||||
@@ -98,8 +96,6 @@ import { ScheduleModule } from '@nestjs/schedule';
|
|||||||
UserCollectionModule,
|
UserCollectionModule,
|
||||||
ShortcodeModule,
|
ShortcodeModule,
|
||||||
InfraConfigModule,
|
InfraConfigModule,
|
||||||
PosthogModule,
|
|
||||||
ScheduleModule.forRoot(),
|
|
||||||
],
|
],
|
||||||
providers: [GQLComplexityPlugin],
|
providers: [GQLComplexityPlugin],
|
||||||
controllers: [AppController],
|
controllers: [AppController],
|
||||||
|
|||||||
@@ -18,7 +18,12 @@ import { JwtAuthGuard } from './guards/jwt-auth.guard';
|
|||||||
import { GqlUser } from 'src/decorators/gql-user.decorator';
|
import { GqlUser } from 'src/decorators/gql-user.decorator';
|
||||||
import { AuthUser } from 'src/types/AuthUser';
|
import { AuthUser } from 'src/types/AuthUser';
|
||||||
import { RTCookie } from 'src/decorators/rt-cookie.decorator';
|
import { RTCookie } from 'src/decorators/rt-cookie.decorator';
|
||||||
import { AuthProvider, authCookieHandler, authProviderCheck } from './helper';
|
import {
|
||||||
|
AuthProvider,
|
||||||
|
authCookieHandler,
|
||||||
|
authProviderCheck,
|
||||||
|
throwHTTPErr,
|
||||||
|
} from './helper';
|
||||||
import { GoogleSSOGuard } from './guards/google-sso.guard';
|
import { GoogleSSOGuard } from './guards/google-sso.guard';
|
||||||
import { GithubSSOGuard } from './guards/github-sso.guard';
|
import { GithubSSOGuard } from './guards/github-sso.guard';
|
||||||
import { MicrosoftSSOGuard } from './guards/microsoft-sso-.guard';
|
import { MicrosoftSSOGuard } from './guards/microsoft-sso-.guard';
|
||||||
@@ -26,7 +31,6 @@ import { ThrottlerBehindProxyGuard } from 'src/guards/throttler-behind-proxy.gua
|
|||||||
import { SkipThrottle } from '@nestjs/throttler';
|
import { SkipThrottle } from '@nestjs/throttler';
|
||||||
import { AUTH_PROVIDER_NOT_SPECIFIED } from 'src/errors';
|
import { AUTH_PROVIDER_NOT_SPECIFIED } from 'src/errors';
|
||||||
import { ConfigService } from '@nestjs/config';
|
import { ConfigService } from '@nestjs/config';
|
||||||
import { throwHTTPErr } from 'src/utils';
|
|
||||||
|
|
||||||
@UseGuards(ThrottlerBehindProxyGuard)
|
@UseGuards(ThrottlerBehindProxyGuard)
|
||||||
@Controller({ path: 'auth', version: '1' })
|
@Controller({ path: 'auth', version: '1' })
|
||||||
|
|||||||
@@ -12,10 +12,7 @@ import { GithubStrategy } from './strategies/github.strategy';
|
|||||||
import { MicrosoftStrategy } from './strategies/microsoft.strategy';
|
import { MicrosoftStrategy } from './strategies/microsoft.strategy';
|
||||||
import { AuthProvider, authProviderCheck } from './helper';
|
import { AuthProvider, authProviderCheck } from './helper';
|
||||||
import { ConfigModule, ConfigService } from '@nestjs/config';
|
import { ConfigModule, ConfigService } from '@nestjs/config';
|
||||||
import {
|
import { loadInfraConfiguration } from 'src/infra-config/helper';
|
||||||
isInfraConfigTablePopulated,
|
|
||||||
loadInfraConfiguration,
|
|
||||||
} from 'src/infra-config/helper';
|
|
||||||
import { InfraConfigModule } from 'src/infra-config/infra-config.module';
|
import { InfraConfigModule } from 'src/infra-config/infra-config.module';
|
||||||
|
|
||||||
@Module({
|
@Module({
|
||||||
@@ -37,11 +34,6 @@ import { InfraConfigModule } from 'src/infra-config/infra-config.module';
|
|||||||
})
|
})
|
||||||
export class AuthModule {
|
export class AuthModule {
|
||||||
static async register() {
|
static async register() {
|
||||||
const isInfraConfigPopulated = await isInfraConfigTablePopulated();
|
|
||||||
if (!isInfraConfigPopulated) {
|
|
||||||
return { module: AuthModule };
|
|
||||||
}
|
|
||||||
|
|
||||||
const env = await loadInfraConfiguration();
|
const env = await loadInfraConfiguration();
|
||||||
const allowedAuthProviders = env.INFRA.VITE_ALLOWED_AUTH_PROVIDERS;
|
const allowedAuthProviders = env.INFRA.VITE_ALLOWED_AUTH_PROVIDERS;
|
||||||
|
|
||||||
|
|||||||
@@ -24,7 +24,7 @@ import {
|
|||||||
RefreshTokenPayload,
|
RefreshTokenPayload,
|
||||||
} from 'src/types/AuthTokens';
|
} from 'src/types/AuthTokens';
|
||||||
import { JwtService } from '@nestjs/jwt';
|
import { JwtService } from '@nestjs/jwt';
|
||||||
import { RESTError } from 'src/types/RESTError';
|
import { AuthError } from 'src/types/AuthError';
|
||||||
import { AuthUser, IsAdmin } from 'src/types/AuthUser';
|
import { AuthUser, IsAdmin } from 'src/types/AuthUser';
|
||||||
import { VerificationToken } from '@prisma/client';
|
import { VerificationToken } from '@prisma/client';
|
||||||
import { Origin } from './helper';
|
import { Origin } from './helper';
|
||||||
@@ -117,7 +117,7 @@ export class AuthService {
|
|||||||
userUid,
|
userUid,
|
||||||
);
|
);
|
||||||
if (E.isLeft(updatedUser))
|
if (E.isLeft(updatedUser))
|
||||||
return E.left(<RESTError>{
|
return E.left(<AuthError>{
|
||||||
message: updatedUser.left,
|
message: updatedUser.left,
|
||||||
statusCode: HttpStatus.NOT_FOUND,
|
statusCode: HttpStatus.NOT_FOUND,
|
||||||
});
|
});
|
||||||
@@ -255,7 +255,7 @@ export class AuthService {
|
|||||||
*/
|
*/
|
||||||
async verifyMagicLinkTokens(
|
async verifyMagicLinkTokens(
|
||||||
magicLinkIDTokens: VerifyMagicDto,
|
magicLinkIDTokens: VerifyMagicDto,
|
||||||
): Promise<E.Right<AuthTokens> | E.Left<RESTError>> {
|
): Promise<E.Right<AuthTokens> | E.Left<AuthError>> {
|
||||||
const passwordlessTokens = await this.validatePasswordlessTokens(
|
const passwordlessTokens = await this.validatePasswordlessTokens(
|
||||||
magicLinkIDTokens,
|
magicLinkIDTokens,
|
||||||
);
|
);
|
||||||
@@ -373,7 +373,7 @@ export class AuthService {
|
|||||||
if (usersCount === 1) {
|
if (usersCount === 1) {
|
||||||
const elevatedUser = await this.usersService.makeAdmin(user.uid);
|
const elevatedUser = await this.usersService.makeAdmin(user.uid);
|
||||||
if (E.isLeft(elevatedUser))
|
if (E.isLeft(elevatedUser))
|
||||||
return E.left(<RESTError>{
|
return E.left(<AuthError>{
|
||||||
message: elevatedUser.left,
|
message: elevatedUser.left,
|
||||||
statusCode: HttpStatus.NOT_FOUND,
|
statusCode: HttpStatus.NOT_FOUND,
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -1,10 +1,9 @@
|
|||||||
import { CanActivate, ExecutionContext, Injectable } from '@nestjs/common';
|
import { CanActivate, ExecutionContext, Injectable } from '@nestjs/common';
|
||||||
import { AuthGuard } from '@nestjs/passport';
|
import { AuthGuard } from '@nestjs/passport';
|
||||||
import { AuthProvider, authProviderCheck } from '../helper';
|
import { AuthProvider, authProviderCheck, throwHTTPErr } from '../helper';
|
||||||
import { Observable } from 'rxjs';
|
import { Observable } from 'rxjs';
|
||||||
import { AUTH_PROVIDER_NOT_SPECIFIED } from 'src/errors';
|
import { AUTH_PROVIDER_NOT_SPECIFIED } from 'src/errors';
|
||||||
import { ConfigService } from '@nestjs/config';
|
import { ConfigService } from '@nestjs/config';
|
||||||
import { throwHTTPErr } from 'src/utils';
|
|
||||||
|
|
||||||
@Injectable()
|
@Injectable()
|
||||||
export class GithubSSOGuard extends AuthGuard('github') implements CanActivate {
|
export class GithubSSOGuard extends AuthGuard('github') implements CanActivate {
|
||||||
|
|||||||
@@ -1,10 +1,9 @@
|
|||||||
import { CanActivate, ExecutionContext, Injectable } from '@nestjs/common';
|
import { CanActivate, ExecutionContext, Injectable } from '@nestjs/common';
|
||||||
import { AuthGuard } from '@nestjs/passport';
|
import { AuthGuard } from '@nestjs/passport';
|
||||||
import { AuthProvider, authProviderCheck } from '../helper';
|
import { AuthProvider, authProviderCheck, throwHTTPErr } from '../helper';
|
||||||
import { Observable } from 'rxjs';
|
import { Observable } from 'rxjs';
|
||||||
import { AUTH_PROVIDER_NOT_SPECIFIED } from 'src/errors';
|
import { AUTH_PROVIDER_NOT_SPECIFIED } from 'src/errors';
|
||||||
import { ConfigService } from '@nestjs/config';
|
import { ConfigService } from '@nestjs/config';
|
||||||
import { throwHTTPErr } from 'src/utils';
|
|
||||||
|
|
||||||
@Injectable()
|
@Injectable()
|
||||||
export class GoogleSSOGuard extends AuthGuard('google') implements CanActivate {
|
export class GoogleSSOGuard extends AuthGuard('google') implements CanActivate {
|
||||||
|
|||||||
@@ -1,10 +1,9 @@
|
|||||||
import { CanActivate, ExecutionContext, Injectable } from '@nestjs/common';
|
import { CanActivate, ExecutionContext, Injectable } from '@nestjs/common';
|
||||||
import { AuthGuard } from '@nestjs/passport';
|
import { AuthGuard } from '@nestjs/passport';
|
||||||
import { AuthProvider, authProviderCheck } from '../helper';
|
import { AuthProvider, authProviderCheck, throwHTTPErr } from '../helper';
|
||||||
import { Observable } from 'rxjs';
|
import { Observable } from 'rxjs';
|
||||||
import { AUTH_PROVIDER_NOT_SPECIFIED } from 'src/errors';
|
import { AUTH_PROVIDER_NOT_SPECIFIED } from 'src/errors';
|
||||||
import { ConfigService } from '@nestjs/config';
|
import { ConfigService } from '@nestjs/config';
|
||||||
import { throwHTTPErr } from 'src/utils';
|
|
||||||
|
|
||||||
@Injectable()
|
@Injectable()
|
||||||
export class MicrosoftSSOGuard
|
export class MicrosoftSSOGuard
|
||||||
|
|||||||
@@ -1,5 +1,6 @@
|
|||||||
import { HttpException, HttpStatus } from '@nestjs/common';
|
import { HttpException, HttpStatus } from '@nestjs/common';
|
||||||
import { DateTime } from 'luxon';
|
import { DateTime } from 'luxon';
|
||||||
|
import { AuthError } from 'src/types/AuthError';
|
||||||
import { AuthTokens } from 'src/types/AuthTokens';
|
import { AuthTokens } from 'src/types/AuthTokens';
|
||||||
import { Response } from 'express';
|
import { Response } from 'express';
|
||||||
import * as cookie from 'cookie';
|
import * as cookie from 'cookie';
|
||||||
@@ -24,6 +25,15 @@ export enum AuthProvider {
|
|||||||
EMAIL = 'EMAIL',
|
EMAIL = 'EMAIL',
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This function allows throw to be used as an expression
|
||||||
|
* @param errMessage Message present in the error message
|
||||||
|
*/
|
||||||
|
export function throwHTTPErr(errorData: AuthError): never {
|
||||||
|
const { message, statusCode } = errorData;
|
||||||
|
throw new HttpException(message, statusCode);
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Sets and returns the cookies in the response object on successful authentication
|
* Sets and returns the cookies in the response object on successful authentication
|
||||||
* @param res Express Response Object
|
* @param res Express Response Object
|
||||||
|
|||||||
@@ -17,8 +17,8 @@ export class GithubStrategy extends PassportStrategy(Strategy) {
|
|||||||
super({
|
super({
|
||||||
clientID: configService.get('INFRA.GITHUB_CLIENT_ID'),
|
clientID: configService.get('INFRA.GITHUB_CLIENT_ID'),
|
||||||
clientSecret: configService.get('INFRA.GITHUB_CLIENT_SECRET'),
|
clientSecret: configService.get('INFRA.GITHUB_CLIENT_SECRET'),
|
||||||
callbackURL: configService.get('INFRA.GITHUB_CALLBACK_URL'),
|
callbackURL: configService.get('GITHUB_CALLBACK_URL'),
|
||||||
scope: [configService.get('INFRA.GITHUB_SCOPE')],
|
scope: [configService.get('GITHUB_SCOPE')],
|
||||||
store: true,
|
store: true,
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -17,8 +17,8 @@ export class GoogleStrategy extends PassportStrategy(Strategy) {
|
|||||||
super({
|
super({
|
||||||
clientID: configService.get('INFRA.GOOGLE_CLIENT_ID'),
|
clientID: configService.get('INFRA.GOOGLE_CLIENT_ID'),
|
||||||
clientSecret: configService.get('INFRA.GOOGLE_CLIENT_SECRET'),
|
clientSecret: configService.get('INFRA.GOOGLE_CLIENT_SECRET'),
|
||||||
callbackURL: configService.get('INFRA.GOOGLE_CALLBACK_URL'),
|
callbackURL: configService.get('GOOGLE_CALLBACK_URL'),
|
||||||
scope: configService.get('INFRA.GOOGLE_SCOPE').split(','),
|
scope: configService.get('GOOGLE_SCOPE').split(','),
|
||||||
passReqToCallback: true,
|
passReqToCallback: true,
|
||||||
store: true,
|
store: true,
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -17,9 +17,9 @@ export class MicrosoftStrategy extends PassportStrategy(Strategy) {
|
|||||||
super({
|
super({
|
||||||
clientID: configService.get('INFRA.MICROSOFT_CLIENT_ID'),
|
clientID: configService.get('INFRA.MICROSOFT_CLIENT_ID'),
|
||||||
clientSecret: configService.get('INFRA.MICROSOFT_CLIENT_SECRET'),
|
clientSecret: configService.get('INFRA.MICROSOFT_CLIENT_SECRET'),
|
||||||
callbackURL: configService.get('INFRA.MICROSOFT_CALLBACK_URL'),
|
callbackURL: configService.get('MICROSOFT_CALLBACK_URL'),
|
||||||
scope: [configService.get('INFRA.MICROSOFT_SCOPE')],
|
scope: [configService.get('MICROSOFT_SCOPE')],
|
||||||
tenant: configService.get('INFRA.MICROSOFT_TENANT'),
|
tenant: configService.get('MICROSOFT_TENANT'),
|
||||||
store: true,
|
store: true,
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -10,14 +10,6 @@ export const DUPLICATE_EMAIL = 'email/both_emails_cannot_be_same' as const;
|
|||||||
export const ONLY_ONE_ADMIN_ACCOUNT =
|
export const ONLY_ONE_ADMIN_ACCOUNT =
|
||||||
'admin/only_one_admin_account_found' as const;
|
'admin/only_one_admin_account_found' as const;
|
||||||
|
|
||||||
/**
|
|
||||||
* Admin user can not be deleted
|
|
||||||
* To delete the admin user, first make the Admin user a normal user
|
|
||||||
* (AdminService)
|
|
||||||
*/
|
|
||||||
export const ADMIN_CAN_NOT_BE_DELETED =
|
|
||||||
'admin/admin_can_not_be_deleted' as const;
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Token Authorization failed (Check 'Authorization' Header)
|
* Token Authorization failed (Check 'Authorization' Header)
|
||||||
* (GqlAuthGuard)
|
* (GqlAuthGuard)
|
||||||
@@ -36,13 +28,6 @@ export const JSON_INVALID = 'json_invalid';
|
|||||||
*/
|
*/
|
||||||
export const AUTH_PROVIDER_NOT_SPECIFIED = 'auth/provider_not_specified';
|
export const AUTH_PROVIDER_NOT_SPECIFIED = 'auth/provider_not_specified';
|
||||||
|
|
||||||
/**
|
|
||||||
* Auth Provider not specified
|
|
||||||
* (Auth)
|
|
||||||
*/
|
|
||||||
export const AUTH_PROVIDER_NOT_CONFIGURED =
|
|
||||||
'auth/provider_not_configured_correctly';
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Environment variable "VITE_ALLOWED_AUTH_PROVIDERS" is not present in .env file
|
* Environment variable "VITE_ALLOWED_AUTH_PROVIDERS" is not present in .env file
|
||||||
*/
|
*/
|
||||||
@@ -84,12 +69,6 @@ export const USER_ALREADY_INVITED = 'admin/user_already_invited' as const;
|
|||||||
*/
|
*/
|
||||||
export const USER_UPDATE_FAILED = 'user/update_failed' as const;
|
export const USER_UPDATE_FAILED = 'user/update_failed' as const;
|
||||||
|
|
||||||
/**
|
|
||||||
* User display name validation failure
|
|
||||||
* (UserService)
|
|
||||||
*/
|
|
||||||
export const USER_SHORT_DISPLAY_NAME = 'user/short_display_name' as const;
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* User deletion failure
|
* User deletion failure
|
||||||
* (UserService)
|
* (UserService)
|
||||||
@@ -113,13 +92,6 @@ export const USER_IS_OWNER = 'user/is_owner' as const;
|
|||||||
*/
|
*/
|
||||||
export const USER_IS_ADMIN = 'user/is_admin' as const;
|
export const USER_IS_ADMIN = 'user/is_admin' as const;
|
||||||
|
|
||||||
/**
|
|
||||||
* User invite deletion failure error due to invitation not found
|
|
||||||
* (AdminService)
|
|
||||||
*/
|
|
||||||
export const USER_INVITATION_DELETION_FAILED =
|
|
||||||
'user/invitation_deletion_failed' as const;
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Teams not found
|
* Teams not found
|
||||||
* (TeamsService)
|
* (TeamsService)
|
||||||
@@ -234,12 +206,6 @@ export const TEAM_COL_NOT_SAME_PARENT =
|
|||||||
export const TEAM_COL_SAME_NEXT_COLL =
|
export const TEAM_COL_SAME_NEXT_COLL =
|
||||||
'team_coll/collection_and_next_collection_are_same';
|
'team_coll/collection_and_next_collection_are_same';
|
||||||
|
|
||||||
/**
|
|
||||||
* Team Collection search failed
|
|
||||||
* (TeamCollectionService)
|
|
||||||
*/
|
|
||||||
export const TEAM_COL_SEARCH_FAILED = 'team_coll/team_collection_search_failed';
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Team Collection Re-Ordering Failed
|
* Team Collection Re-Ordering Failed
|
||||||
* (TeamCollectionService)
|
* (TeamCollectionService)
|
||||||
@@ -295,13 +261,6 @@ export const TEAM_NOT_OWNER = 'team_coll/team_not_owner' as const;
|
|||||||
export const TEAM_COLL_DATA_INVALID =
|
export const TEAM_COLL_DATA_INVALID =
|
||||||
'team_coll/team_coll_data_invalid' as const;
|
'team_coll/team_coll_data_invalid' as const;
|
||||||
|
|
||||||
/**
|
|
||||||
* Team Collection parent tree generation failed
|
|
||||||
* (TeamCollectionService)
|
|
||||||
*/
|
|
||||||
export const TEAM_COLL_PARENT_TREE_GEN_FAILED =
|
|
||||||
'team_coll/team_coll_parent_tree_generation_failed';
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Tried to perform an action on a request that doesn't accept their member role level
|
* Tried to perform an action on a request that doesn't accept their member role level
|
||||||
* (GqlRequestTeamMemberGuard)
|
* (GqlRequestTeamMemberGuard)
|
||||||
@@ -327,19 +286,6 @@ export const TEAM_REQ_INVALID_TARGET_COLL_ID =
|
|||||||
*/
|
*/
|
||||||
export const TEAM_REQ_REORDERING_FAILED = 'team_req/reordering_failed' as const;
|
export const TEAM_REQ_REORDERING_FAILED = 'team_req/reordering_failed' as const;
|
||||||
|
|
||||||
/**
|
|
||||||
* Team Request search failed
|
|
||||||
* (TeamRequestService)
|
|
||||||
*/
|
|
||||||
export const TEAM_REQ_SEARCH_FAILED = 'team_req/team_request_search_failed';
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Team Request parent tree generation failed
|
|
||||||
* (TeamRequestService)
|
|
||||||
*/
|
|
||||||
export const TEAM_REQ_PARENT_TREE_GEN_FAILED =
|
|
||||||
'team_req/team_req_parent_tree_generation_failed';
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* No Postmark Sender Email defined
|
* No Postmark Sender Email defined
|
||||||
* (AuthService)
|
* (AuthService)
|
||||||
@@ -730,34 +676,9 @@ export const INFRA_CONFIG_RESET_FAILED = 'infra_config/reset_failed' as const;
|
|||||||
*/
|
*/
|
||||||
export const INFRA_CONFIG_INVALID_INPUT = 'infra_config/invalid_input' as const;
|
export const INFRA_CONFIG_INVALID_INPUT = 'infra_config/invalid_input' as const;
|
||||||
|
|
||||||
/**
|
|
||||||
* Infra Config service (auth provider/mailer/audit logs) not configured
|
|
||||||
* (InfraConfigService)
|
|
||||||
*/
|
|
||||||
export const INFRA_CONFIG_SERVICE_NOT_CONFIGURED =
|
|
||||||
'infra_config/service_not_configured' as const;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Infra Config update/fetch operation not allowed
|
|
||||||
* (InfraConfigService)
|
|
||||||
*/
|
|
||||||
export const INFRA_CONFIG_OPERATION_NOT_ALLOWED =
|
|
||||||
'infra_config/operation_not_allowed';
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Error message for when the database table does not exist
|
* Error message for when the database table does not exist
|
||||||
* (InfraConfigService)
|
* (InfraConfigService)
|
||||||
*/
|
*/
|
||||||
export const DATABASE_TABLE_NOT_EXIST =
|
export const DATABASE_TABLE_NOT_EXIST =
|
||||||
'Database migration not found. Please check the documentation for assistance: https://docs.hoppscotch.io/documentation/self-host/community-edition/install-and-build#running-migrations';
|
'Database migration not performed. Please check the FAQ for assistance: https://docs.hoppscotch.io/support/faq';
|
||||||
|
|
||||||
/**
|
|
||||||
* PostHog client is not initialized
|
|
||||||
* (InfraConfigService)
|
|
||||||
*/
|
|
||||||
export const POSTHOG_CLIENT_NOT_INITIALIZED = 'posthog/client_not_initialized';
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Inputs supplied are invalid
|
|
||||||
*/
|
|
||||||
export const INVALID_PARAMS = 'invalid_parameters' as const;
|
|
||||||
|
|||||||
@@ -1,44 +1,10 @@
|
|||||||
import { AuthProvider } from 'src/auth/helper';
|
|
||||||
import {
|
|
||||||
AUTH_PROVIDER_NOT_CONFIGURED,
|
|
||||||
DATABASE_TABLE_NOT_EXIST,
|
|
||||||
} from 'src/errors';
|
|
||||||
import { PrismaService } from 'src/prisma/prisma.service';
|
import { PrismaService } from 'src/prisma/prisma.service';
|
||||||
import { InfraConfigEnum } from 'src/types/InfraConfig';
|
|
||||||
import { throwErr } from 'src/utils';
|
|
||||||
import { randomBytes } from 'crypto';
|
|
||||||
|
|
||||||
export enum ServiceStatus {
|
export enum ServiceStatus {
|
||||||
ENABLE = 'ENABLE',
|
ENABLE = 'ENABLE',
|
||||||
DISABLE = 'DISABLE',
|
DISABLE = 'DISABLE',
|
||||||
}
|
}
|
||||||
|
|
||||||
const AuthProviderConfigurations = {
|
|
||||||
[AuthProvider.GOOGLE]: [
|
|
||||||
InfraConfigEnum.GOOGLE_CLIENT_ID,
|
|
||||||
InfraConfigEnum.GOOGLE_CLIENT_SECRET,
|
|
||||||
InfraConfigEnum.GOOGLE_CALLBACK_URL,
|
|
||||||
InfraConfigEnum.GOOGLE_SCOPE,
|
|
||||||
],
|
|
||||||
[AuthProvider.GITHUB]: [
|
|
||||||
InfraConfigEnum.GITHUB_CLIENT_ID,
|
|
||||||
InfraConfigEnum.GITHUB_CLIENT_SECRET,
|
|
||||||
InfraConfigEnum.GITHUB_CALLBACK_URL,
|
|
||||||
InfraConfigEnum.GITHUB_SCOPE,
|
|
||||||
],
|
|
||||||
[AuthProvider.MICROSOFT]: [
|
|
||||||
InfraConfigEnum.MICROSOFT_CLIENT_ID,
|
|
||||||
InfraConfigEnum.MICROSOFT_CLIENT_SECRET,
|
|
||||||
InfraConfigEnum.MICROSOFT_CALLBACK_URL,
|
|
||||||
InfraConfigEnum.MICROSOFT_SCOPE,
|
|
||||||
InfraConfigEnum.MICROSOFT_TENANT,
|
|
||||||
],
|
|
||||||
[AuthProvider.EMAIL]: [
|
|
||||||
InfraConfigEnum.MAILER_SMTP_URL,
|
|
||||||
InfraConfigEnum.MAILER_ADDRESS_FROM,
|
|
||||||
],
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Load environment variables from the database and set them in the process
|
* Load environment variables from the database and set them in the process
|
||||||
*
|
*
|
||||||
@@ -64,139 +30,6 @@ export async function loadInfraConfiguration() {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Read the default values from .env file and return them as an array
|
|
||||||
* @returns Array of default infra configs
|
|
||||||
*/
|
|
||||||
export async function getDefaultInfraConfigs(): Promise<
|
|
||||||
{ name: InfraConfigEnum; value: string }[]
|
|
||||||
> {
|
|
||||||
const prisma = new PrismaService();
|
|
||||||
|
|
||||||
// Prepare rows for 'infra_config' table with default values (from .env) for each 'name'
|
|
||||||
const infraConfigDefaultObjs: { name: InfraConfigEnum; value: string }[] = [
|
|
||||||
{
|
|
||||||
name: InfraConfigEnum.MAILER_SMTP_URL,
|
|
||||||
value: process.env.MAILER_SMTP_URL,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: InfraConfigEnum.MAILER_ADDRESS_FROM,
|
|
||||||
value: process.env.MAILER_ADDRESS_FROM,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: InfraConfigEnum.GOOGLE_CLIENT_ID,
|
|
||||||
value: process.env.GOOGLE_CLIENT_ID,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: InfraConfigEnum.GOOGLE_CLIENT_SECRET,
|
|
||||||
value: process.env.GOOGLE_CLIENT_SECRET,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: InfraConfigEnum.GOOGLE_CALLBACK_URL,
|
|
||||||
value: process.env.GOOGLE_CALLBACK_URL,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: InfraConfigEnum.GOOGLE_SCOPE,
|
|
||||||
value: process.env.GOOGLE_SCOPE,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: InfraConfigEnum.GITHUB_CLIENT_ID,
|
|
||||||
value: process.env.GITHUB_CLIENT_ID,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: InfraConfigEnum.GITHUB_CLIENT_SECRET,
|
|
||||||
value: process.env.GITHUB_CLIENT_SECRET,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: InfraConfigEnum.GITHUB_CALLBACK_URL,
|
|
||||||
value: process.env.GITHUB_CALLBACK_URL,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: InfraConfigEnum.GITHUB_SCOPE,
|
|
||||||
value: process.env.GITHUB_SCOPE,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: InfraConfigEnum.MICROSOFT_CLIENT_ID,
|
|
||||||
value: process.env.MICROSOFT_CLIENT_ID,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: InfraConfigEnum.MICROSOFT_CLIENT_SECRET,
|
|
||||||
value: process.env.MICROSOFT_CLIENT_SECRET,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: InfraConfigEnum.MICROSOFT_CALLBACK_URL,
|
|
||||||
value: process.env.MICROSOFT_CALLBACK_URL,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: InfraConfigEnum.MICROSOFT_SCOPE,
|
|
||||||
value: process.env.MICROSOFT_SCOPE,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: InfraConfigEnum.MICROSOFT_TENANT,
|
|
||||||
value: process.env.MICROSOFT_TENANT,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: InfraConfigEnum.VITE_ALLOWED_AUTH_PROVIDERS,
|
|
||||||
value: getConfiguredSSOProviders(),
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: InfraConfigEnum.ALLOW_ANALYTICS_COLLECTION,
|
|
||||||
value: false.toString(),
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: InfraConfigEnum.ANALYTICS_USER_ID,
|
|
||||||
value: generateAnalyticsUserId(),
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: InfraConfigEnum.IS_FIRST_TIME_INFRA_SETUP,
|
|
||||||
value: (await prisma.infraConfig.count()) === 0 ? 'true' : 'false',
|
|
||||||
},
|
|
||||||
];
|
|
||||||
|
|
||||||
return infraConfigDefaultObjs;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get the missing entries in the 'infra_config' table
|
|
||||||
* @returns Array of InfraConfig
|
|
||||||
*/
|
|
||||||
export async function getMissingInfraConfigEntries() {
|
|
||||||
const prisma = new PrismaService();
|
|
||||||
const [dbInfraConfigs, infraConfigDefaultObjs] = await Promise.all([
|
|
||||||
prisma.infraConfig.findMany(),
|
|
||||||
getDefaultInfraConfigs(),
|
|
||||||
]);
|
|
||||||
|
|
||||||
const missingEntries = infraConfigDefaultObjs.filter(
|
|
||||||
(config) =>
|
|
||||||
!dbInfraConfigs.some((dbConfig) => dbConfig.name === config.name),
|
|
||||||
);
|
|
||||||
|
|
||||||
return missingEntries;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Verify if 'infra_config' table is loaded with all entries
|
|
||||||
* @returns boolean
|
|
||||||
*/
|
|
||||||
export async function isInfraConfigTablePopulated(): Promise<boolean> {
|
|
||||||
const prisma = new PrismaService();
|
|
||||||
try {
|
|
||||||
const propsRemainingToInsert = await getMissingInfraConfigEntries();
|
|
||||||
|
|
||||||
if (propsRemainingToInsert.length > 0) {
|
|
||||||
console.log(
|
|
||||||
'Infra Config table is not populated with all entries. Populating now...',
|
|
||||||
);
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
|
|
||||||
return true;
|
|
||||||
} catch (error) {
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Stop the app after 5 seconds
|
* Stop the app after 5 seconds
|
||||||
* (Docker will re-start the app)
|
* (Docker will re-start the app)
|
||||||
@@ -209,51 +42,3 @@ export function stopApp() {
|
|||||||
process.kill(process.pid, 'SIGTERM');
|
process.kill(process.pid, 'SIGTERM');
|
||||||
}, 5000);
|
}, 5000);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Get the configured SSO providers
|
|
||||||
* @returns Array of configured SSO providers
|
|
||||||
*/
|
|
||||||
export function getConfiguredSSOProviders() {
|
|
||||||
const allowedAuthProviders: string[] =
|
|
||||||
process.env.VITE_ALLOWED_AUTH_PROVIDERS.split(',');
|
|
||||||
let configuredAuthProviders: string[] = [];
|
|
||||||
|
|
||||||
const addProviderIfConfigured = (provider) => {
|
|
||||||
const configParameters: string[] = AuthProviderConfigurations[provider];
|
|
||||||
|
|
||||||
const isConfigured = configParameters.every((configParameter) => {
|
|
||||||
return process.env[configParameter];
|
|
||||||
});
|
|
||||||
|
|
||||||
if (isConfigured) configuredAuthProviders.push(provider);
|
|
||||||
};
|
|
||||||
|
|
||||||
allowedAuthProviders.forEach((provider) => addProviderIfConfigured(provider));
|
|
||||||
|
|
||||||
if (configuredAuthProviders.length === 0) {
|
|
||||||
throwErr(AUTH_PROVIDER_NOT_CONFIGURED);
|
|
||||||
} else if (allowedAuthProviders.length !== configuredAuthProviders.length) {
|
|
||||||
const unConfiguredAuthProviders = allowedAuthProviders.filter(
|
|
||||||
(provider) => {
|
|
||||||
return !configuredAuthProviders.includes(provider);
|
|
||||||
},
|
|
||||||
);
|
|
||||||
console.log(
|
|
||||||
`${unConfiguredAuthProviders.join(
|
|
||||||
',',
|
|
||||||
)} SSO auth provider(s) are not configured properly. Do configure them from Admin Dashboard.`,
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
return configuredAuthProviders.join(',');
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Generate a hashed valued for analytics
|
|
||||||
* @returns Generated hashed value
|
|
||||||
*/
|
|
||||||
export function generateAnalyticsUserId() {
|
|
||||||
const hashedUserID = randomBytes(20).toString('hex');
|
|
||||||
return hashedUserID;
|
|
||||||
}
|
|
||||||
|
|||||||
@@ -1,47 +0,0 @@
|
|||||||
import { Controller, Get, HttpStatus, Put, UseGuards } from '@nestjs/common';
|
|
||||||
import { ThrottlerBehindProxyGuard } from 'src/guards/throttler-behind-proxy.guard';
|
|
||||||
import { InfraConfigService } from './infra-config.service';
|
|
||||||
import * as E from 'fp-ts/Either';
|
|
||||||
import { JwtAuthGuard } from 'src/auth/guards/jwt-auth.guard';
|
|
||||||
import { RESTAdminGuard } from 'src/admin/guards/rest-admin.guard';
|
|
||||||
import { RESTError } from 'src/types/RESTError';
|
|
||||||
import { InfraConfigEnum } from 'src/types/InfraConfig';
|
|
||||||
import { throwHTTPErr } from 'src/utils';
|
|
||||||
|
|
||||||
@UseGuards(ThrottlerBehindProxyGuard)
|
|
||||||
@Controller({ path: 'site', version: '1' })
|
|
||||||
export class SiteController {
|
|
||||||
constructor(private infraConfigService: InfraConfigService) {}
|
|
||||||
|
|
||||||
@Get('setup')
|
|
||||||
@UseGuards(JwtAuthGuard, RESTAdminGuard)
|
|
||||||
async fetchSetupInfo() {
|
|
||||||
const status = await this.infraConfigService.get(
|
|
||||||
InfraConfigEnum.IS_FIRST_TIME_INFRA_SETUP,
|
|
||||||
);
|
|
||||||
|
|
||||||
if (E.isLeft(status))
|
|
||||||
throwHTTPErr(<RESTError>{
|
|
||||||
message: status.left,
|
|
||||||
statusCode: HttpStatus.NOT_FOUND,
|
|
||||||
});
|
|
||||||
return status.right;
|
|
||||||
}
|
|
||||||
|
|
||||||
@Put('setup')
|
|
||||||
@UseGuards(JwtAuthGuard, RESTAdminGuard)
|
|
||||||
async setSetupAsComplete() {
|
|
||||||
const res = await this.infraConfigService.update(
|
|
||||||
InfraConfigEnum.IS_FIRST_TIME_INFRA_SETUP,
|
|
||||||
false.toString(),
|
|
||||||
false,
|
|
||||||
);
|
|
||||||
|
|
||||||
if (E.isLeft(res))
|
|
||||||
throwHTTPErr(<RESTError>{
|
|
||||||
message: res.left,
|
|
||||||
statusCode: HttpStatus.FORBIDDEN,
|
|
||||||
});
|
|
||||||
return res.right;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
import { Field, ObjectType, registerEnumType } from '@nestjs/graphql';
|
import { Field, ObjectType, registerEnumType } from '@nestjs/graphql';
|
||||||
import { AuthProvider } from 'src/auth/helper';
|
import { AuthProvider } from 'src/auth/helper';
|
||||||
import { InfraConfigEnum } from 'src/types/InfraConfig';
|
import { InfraConfigEnumForClient } from 'src/types/InfraConfig';
|
||||||
import { ServiceStatus } from './helper';
|
import { ServiceStatus } from './helper';
|
||||||
|
|
||||||
@ObjectType()
|
@ObjectType()
|
||||||
@@ -8,7 +8,7 @@ export class InfraConfig {
|
|||||||
@Field({
|
@Field({
|
||||||
description: 'Infra Config Name',
|
description: 'Infra Config Name',
|
||||||
})
|
})
|
||||||
name: InfraConfigEnum;
|
name: InfraConfigEnumForClient;
|
||||||
|
|
||||||
@Field({
|
@Field({
|
||||||
description: 'Infra Config Value',
|
description: 'Infra Config Value',
|
||||||
@@ -16,7 +16,7 @@ export class InfraConfig {
|
|||||||
value: string;
|
value: string;
|
||||||
}
|
}
|
||||||
|
|
||||||
registerEnumType(InfraConfigEnum, {
|
registerEnumType(InfraConfigEnumForClient, {
|
||||||
name: 'InfraConfigEnum',
|
name: 'InfraConfigEnum',
|
||||||
});
|
});
|
||||||
|
|
||||||
|
|||||||
@@ -1,12 +1,10 @@
|
|||||||
import { Module } from '@nestjs/common';
|
import { Module } from '@nestjs/common';
|
||||||
import { InfraConfigService } from './infra-config.service';
|
import { InfraConfigService } from './infra-config.service';
|
||||||
import { PrismaModule } from 'src/prisma/prisma.module';
|
import { PrismaModule } from 'src/prisma/prisma.module';
|
||||||
import { SiteController } from './infra-config.controller';
|
|
||||||
|
|
||||||
@Module({
|
@Module({
|
||||||
imports: [PrismaModule],
|
imports: [PrismaModule],
|
||||||
providers: [InfraConfigService],
|
providers: [InfraConfigService],
|
||||||
exports: [InfraConfigService],
|
exports: [InfraConfigService],
|
||||||
controllers: [SiteController],
|
|
||||||
})
|
})
|
||||||
export class InfraConfigModule {}
|
export class InfraConfigModule {}
|
||||||
|
|||||||
@@ -1,16 +1,13 @@
|
|||||||
import { mockDeep, mockReset } from 'jest-mock-extended';
|
import { mockDeep, mockReset } from 'jest-mock-extended';
|
||||||
import { PrismaService } from 'src/prisma/prisma.service';
|
import { PrismaService } from 'src/prisma/prisma.service';
|
||||||
import { InfraConfigService } from './infra-config.service';
|
import { InfraConfigService } from './infra-config.service';
|
||||||
import { InfraConfigEnum } from 'src/types/InfraConfig';
|
|
||||||
import {
|
import {
|
||||||
INFRA_CONFIG_NOT_FOUND,
|
InfraConfigEnum,
|
||||||
INFRA_CONFIG_OPERATION_NOT_ALLOWED,
|
InfraConfigEnumForClient,
|
||||||
INFRA_CONFIG_UPDATE_FAILED,
|
} from 'src/types/InfraConfig';
|
||||||
} from 'src/errors';
|
import { INFRA_CONFIG_NOT_FOUND, INFRA_CONFIG_UPDATE_FAILED } from 'src/errors';
|
||||||
import { ConfigService } from '@nestjs/config';
|
import { ConfigService } from '@nestjs/config';
|
||||||
import * as helper from './helper';
|
import * as helper from './helper';
|
||||||
import { InfraConfig as dbInfraConfig } from '@prisma/client';
|
|
||||||
import { InfraConfig } from './infra-config.model';
|
|
||||||
|
|
||||||
const mockPrisma = mockDeep<PrismaService>();
|
const mockPrisma = mockDeep<PrismaService>();
|
||||||
const mockConfigService = mockDeep<ConfigService>();
|
const mockConfigService = mockDeep<ConfigService>();
|
||||||
@@ -22,82 +19,12 @@ const infraConfigService = new InfraConfigService(
|
|||||||
mockConfigService,
|
mockConfigService,
|
||||||
);
|
);
|
||||||
|
|
||||||
const INITIALIZED_DATE_CONST = new Date();
|
|
||||||
const dbInfraConfigs: dbInfraConfig[] = [
|
|
||||||
{
|
|
||||||
id: '3',
|
|
||||||
name: InfraConfigEnum.GOOGLE_CLIENT_ID,
|
|
||||||
value: 'abcdefghijkl',
|
|
||||||
active: true,
|
|
||||||
createdOn: INITIALIZED_DATE_CONST,
|
|
||||||
updatedOn: INITIALIZED_DATE_CONST,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
id: '4',
|
|
||||||
name: InfraConfigEnum.VITE_ALLOWED_AUTH_PROVIDERS,
|
|
||||||
value: 'google',
|
|
||||||
active: true,
|
|
||||||
createdOn: INITIALIZED_DATE_CONST,
|
|
||||||
updatedOn: INITIALIZED_DATE_CONST,
|
|
||||||
},
|
|
||||||
];
|
|
||||||
const infraConfigs: InfraConfig[] = [
|
|
||||||
{
|
|
||||||
name: dbInfraConfigs[0].name as InfraConfigEnum,
|
|
||||||
value: dbInfraConfigs[0].value,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: dbInfraConfigs[1].name as InfraConfigEnum,
|
|
||||||
value: dbInfraConfigs[1].value,
|
|
||||||
},
|
|
||||||
];
|
|
||||||
|
|
||||||
beforeEach(() => {
|
beforeEach(() => {
|
||||||
mockReset(mockPrisma);
|
mockReset(mockPrisma);
|
||||||
});
|
});
|
||||||
|
|
||||||
describe('InfraConfigService', () => {
|
describe('InfraConfigService', () => {
|
||||||
describe('update', () => {
|
describe('update', () => {
|
||||||
it('should update the infra config without backend server restart', async () => {
|
|
||||||
const name = InfraConfigEnum.GOOGLE_CLIENT_ID;
|
|
||||||
const value = 'true';
|
|
||||||
|
|
||||||
mockPrisma.infraConfig.update.mockResolvedValueOnce({
|
|
||||||
id: '',
|
|
||||||
name,
|
|
||||||
value,
|
|
||||||
active: true,
|
|
||||||
createdOn: new Date(),
|
|
||||||
updatedOn: new Date(),
|
|
||||||
});
|
|
||||||
|
|
||||||
jest.spyOn(helper, 'stopApp').mockReturnValueOnce();
|
|
||||||
const result = await infraConfigService.update(name, value);
|
|
||||||
|
|
||||||
expect(helper.stopApp).not.toHaveBeenCalled();
|
|
||||||
expect(result).toEqualRight({ name, value });
|
|
||||||
});
|
|
||||||
|
|
||||||
it('should update the infra config with backend server restart', async () => {
|
|
||||||
const name = InfraConfigEnum.GOOGLE_CLIENT_ID;
|
|
||||||
const value = 'true';
|
|
||||||
|
|
||||||
mockPrisma.infraConfig.update.mockResolvedValueOnce({
|
|
||||||
id: '',
|
|
||||||
name,
|
|
||||||
value,
|
|
||||||
active: true,
|
|
||||||
createdOn: new Date(),
|
|
||||||
updatedOn: new Date(),
|
|
||||||
});
|
|
||||||
jest.spyOn(helper, 'stopApp').mockReturnValueOnce();
|
|
||||||
|
|
||||||
const result = await infraConfigService.update(name, value, true);
|
|
||||||
|
|
||||||
expect(helper.stopApp).toHaveBeenCalledTimes(1);
|
|
||||||
expect(result).toEqualRight({ name, value });
|
|
||||||
});
|
|
||||||
|
|
||||||
it('should update the infra config', async () => {
|
it('should update the infra config', async () => {
|
||||||
const name = InfraConfigEnum.GOOGLE_CLIENT_ID;
|
const name = InfraConfigEnum.GOOGLE_CLIENT_ID;
|
||||||
const value = 'true';
|
const value = 'true';
|
||||||
@@ -144,7 +71,7 @@ describe('InfraConfigService', () => {
|
|||||||
|
|
||||||
describe('get', () => {
|
describe('get', () => {
|
||||||
it('should get the infra config', async () => {
|
it('should get the infra config', async () => {
|
||||||
const name = InfraConfigEnum.GOOGLE_CLIENT_ID;
|
const name = InfraConfigEnumForClient.GOOGLE_CLIENT_ID;
|
||||||
const value = 'true';
|
const value = 'true';
|
||||||
|
|
||||||
mockPrisma.infraConfig.findUniqueOrThrow.mockResolvedValueOnce({
|
mockPrisma.infraConfig.findUniqueOrThrow.mockResolvedValueOnce({
|
||||||
@@ -160,7 +87,7 @@ describe('InfraConfigService', () => {
|
|||||||
});
|
});
|
||||||
|
|
||||||
it('should pass correct params to prisma findUnique', async () => {
|
it('should pass correct params to prisma findUnique', async () => {
|
||||||
const name = InfraConfigEnum.GOOGLE_CLIENT_ID;
|
const name = InfraConfigEnumForClient.GOOGLE_CLIENT_ID;
|
||||||
|
|
||||||
await infraConfigService.get(name);
|
await infraConfigService.get(name);
|
||||||
|
|
||||||
@@ -171,7 +98,7 @@ describe('InfraConfigService', () => {
|
|||||||
});
|
});
|
||||||
|
|
||||||
it('should throw an error if the infra config does not exist', async () => {
|
it('should throw an error if the infra config does not exist', async () => {
|
||||||
const name = InfraConfigEnum.GOOGLE_CLIENT_ID;
|
const name = InfraConfigEnumForClient.GOOGLE_CLIENT_ID;
|
||||||
|
|
||||||
mockPrisma.infraConfig.findUniqueOrThrow.mockRejectedValueOnce('null');
|
mockPrisma.infraConfig.findUniqueOrThrow.mockRejectedValueOnce('null');
|
||||||
|
|
||||||
@@ -179,45 +106,4 @@ describe('InfraConfigService', () => {
|
|||||||
expect(result).toEqualLeft(INFRA_CONFIG_NOT_FOUND);
|
expect(result).toEqualLeft(INFRA_CONFIG_NOT_FOUND);
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
describe('getMany', () => {
|
|
||||||
it('should throw error if any disallowed names are provided', async () => {
|
|
||||||
const disallowedNames = [InfraConfigEnum.VITE_ALLOWED_AUTH_PROVIDERS];
|
|
||||||
const result = await infraConfigService.getMany(disallowedNames);
|
|
||||||
|
|
||||||
expect(result).toEqualLeft(INFRA_CONFIG_OPERATION_NOT_ALLOWED);
|
|
||||||
});
|
|
||||||
it('should resolve right with disallowed names if `checkDisallowed` parameter passed', async () => {
|
|
||||||
const disallowedNames = [InfraConfigEnum.VITE_ALLOWED_AUTH_PROVIDERS];
|
|
||||||
|
|
||||||
const dbInfraConfigResponses = dbInfraConfigs.filter((dbConfig) =>
|
|
||||||
disallowedNames.includes(dbConfig.name as InfraConfigEnum),
|
|
||||||
);
|
|
||||||
mockPrisma.infraConfig.findMany.mockResolvedValueOnce(
|
|
||||||
dbInfraConfigResponses,
|
|
||||||
);
|
|
||||||
|
|
||||||
const result = await infraConfigService.getMany(disallowedNames, false);
|
|
||||||
|
|
||||||
expect(result).toEqualRight(
|
|
||||||
infraConfigs.filter((i) => disallowedNames.includes(i.name)),
|
|
||||||
);
|
|
||||||
});
|
|
||||||
|
|
||||||
it('should return right with infraConfigs if Prisma query succeeds', async () => {
|
|
||||||
const allowedNames = [InfraConfigEnum.GOOGLE_CLIENT_ID];
|
|
||||||
|
|
||||||
const dbInfraConfigResponses = dbInfraConfigs.filter((dbConfig) =>
|
|
||||||
allowedNames.includes(dbConfig.name as InfraConfigEnum),
|
|
||||||
);
|
|
||||||
mockPrisma.infraConfig.findMany.mockResolvedValueOnce(
|
|
||||||
dbInfraConfigResponses,
|
|
||||||
);
|
|
||||||
|
|
||||||
const result = await infraConfigService.getMany(allowedNames);
|
|
||||||
expect(result).toEqualRight(
|
|
||||||
infraConfigs.filter((i) => allowedNames.includes(i.name)),
|
|
||||||
);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -3,32 +3,23 @@ import { InfraConfig } from './infra-config.model';
|
|||||||
import { PrismaService } from 'src/prisma/prisma.service';
|
import { PrismaService } from 'src/prisma/prisma.service';
|
||||||
import { InfraConfig as DBInfraConfig } from '@prisma/client';
|
import { InfraConfig as DBInfraConfig } from '@prisma/client';
|
||||||
import * as E from 'fp-ts/Either';
|
import * as E from 'fp-ts/Either';
|
||||||
import { InfraConfigEnum } from 'src/types/InfraConfig';
|
import {
|
||||||
|
InfraConfigEnum,
|
||||||
|
InfraConfigEnumForClient,
|
||||||
|
} from 'src/types/InfraConfig';
|
||||||
import {
|
import {
|
||||||
AUTH_PROVIDER_NOT_SPECIFIED,
|
AUTH_PROVIDER_NOT_SPECIFIED,
|
||||||
DATABASE_TABLE_NOT_EXIST,
|
DATABASE_TABLE_NOT_EXIST,
|
||||||
INFRA_CONFIG_INVALID_INPUT,
|
INFRA_CONFIG_INVALID_INPUT,
|
||||||
INFRA_CONFIG_NOT_FOUND,
|
INFRA_CONFIG_NOT_FOUND,
|
||||||
|
INFRA_CONFIG_NOT_LISTED,
|
||||||
INFRA_CONFIG_RESET_FAILED,
|
INFRA_CONFIG_RESET_FAILED,
|
||||||
INFRA_CONFIG_UPDATE_FAILED,
|
INFRA_CONFIG_UPDATE_FAILED,
|
||||||
INFRA_CONFIG_SERVICE_NOT_CONFIGURED,
|
|
||||||
INFRA_CONFIG_OPERATION_NOT_ALLOWED,
|
|
||||||
} from 'src/errors';
|
} from 'src/errors';
|
||||||
import {
|
import { throwErr, validateEmail, validateSMTPUrl } from 'src/utils';
|
||||||
throwErr,
|
|
||||||
validateSMTPEmail,
|
|
||||||
validateSMTPUrl,
|
|
||||||
validateUrl,
|
|
||||||
} from 'src/utils';
|
|
||||||
import { ConfigService } from '@nestjs/config';
|
import { ConfigService } from '@nestjs/config';
|
||||||
import {
|
import { ServiceStatus, stopApp } from './helper';
|
||||||
ServiceStatus,
|
|
||||||
getDefaultInfraConfigs,
|
|
||||||
getMissingInfraConfigEntries,
|
|
||||||
stopApp,
|
|
||||||
} from './helper';
|
|
||||||
import { EnableAndDisableSSOArgs, InfraConfigArgs } from './input-args';
|
import { EnableAndDisableSSOArgs, InfraConfigArgs } from './input-args';
|
||||||
import { AuthProvider } from 'src/auth/helper';
|
|
||||||
|
|
||||||
@Injectable()
|
@Injectable()
|
||||||
export class InfraConfigService implements OnModuleInit {
|
export class InfraConfigService implements OnModuleInit {
|
||||||
@@ -37,31 +28,76 @@ export class InfraConfigService implements OnModuleInit {
|
|||||||
private readonly configService: ConfigService,
|
private readonly configService: ConfigService,
|
||||||
) {}
|
) {}
|
||||||
|
|
||||||
// Following fields are not updatable by `infraConfigs` Mutation. Use dedicated mutations for these fields instead.
|
|
||||||
EXCLUDE_FROM_UPDATE_CONFIGS = [
|
|
||||||
InfraConfigEnum.VITE_ALLOWED_AUTH_PROVIDERS,
|
|
||||||
InfraConfigEnum.ALLOW_ANALYTICS_COLLECTION,
|
|
||||||
InfraConfigEnum.ANALYTICS_USER_ID,
|
|
||||||
InfraConfigEnum.IS_FIRST_TIME_INFRA_SETUP,
|
|
||||||
];
|
|
||||||
// Following fields can not be fetched by `infraConfigs` Query. Use dedicated queries for these fields instead.
|
|
||||||
EXCLUDE_FROM_FETCH_CONFIGS = [
|
|
||||||
InfraConfigEnum.VITE_ALLOWED_AUTH_PROVIDERS,
|
|
||||||
InfraConfigEnum.ANALYTICS_USER_ID,
|
|
||||||
InfraConfigEnum.IS_FIRST_TIME_INFRA_SETUP,
|
|
||||||
];
|
|
||||||
|
|
||||||
async onModuleInit() {
|
async onModuleInit() {
|
||||||
await this.initializeInfraConfigTable();
|
await this.initializeInfraConfigTable();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
getDefaultInfraConfigs(): { name: InfraConfigEnum; value: string }[] {
|
||||||
|
// Prepare rows for 'infra_config' table with default values (from .env) for each 'name'
|
||||||
|
const infraConfigDefaultObjs: { name: InfraConfigEnum; value: string }[] = [
|
||||||
|
{
|
||||||
|
name: InfraConfigEnum.MAILER_SMTP_URL,
|
||||||
|
value: process.env.MAILER_SMTP_URL,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: InfraConfigEnum.MAILER_ADDRESS_FROM,
|
||||||
|
value: process.env.MAILER_ADDRESS_FROM,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: InfraConfigEnum.GOOGLE_CLIENT_ID,
|
||||||
|
value: process.env.GOOGLE_CLIENT_ID,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: InfraConfigEnum.GOOGLE_CLIENT_SECRET,
|
||||||
|
value: process.env.GOOGLE_CLIENT_SECRET,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: InfraConfigEnum.GITHUB_CLIENT_ID,
|
||||||
|
value: process.env.GITHUB_CLIENT_ID,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: InfraConfigEnum.GITHUB_CLIENT_SECRET,
|
||||||
|
value: process.env.GITHUB_CLIENT_SECRET,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: InfraConfigEnum.MICROSOFT_CLIENT_ID,
|
||||||
|
value: process.env.MICROSOFT_CLIENT_ID,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: InfraConfigEnum.MICROSOFT_CLIENT_SECRET,
|
||||||
|
value: process.env.MICROSOFT_CLIENT_SECRET,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: InfraConfigEnum.VITE_ALLOWED_AUTH_PROVIDERS,
|
||||||
|
value: process.env.VITE_ALLOWED_AUTH_PROVIDERS.toLocaleUpperCase(),
|
||||||
|
},
|
||||||
|
];
|
||||||
|
|
||||||
|
return infraConfigDefaultObjs;
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Initialize the 'infra_config' table with values from .env
|
* Initialize the 'infra_config' table with values from .env
|
||||||
* @description This function create rows 'infra_config' in very first time (only once)
|
* @description This function create rows 'infra_config' in very first time (only once)
|
||||||
*/
|
*/
|
||||||
async initializeInfraConfigTable() {
|
async initializeInfraConfigTable() {
|
||||||
try {
|
try {
|
||||||
const propsToInsert = await getMissingInfraConfigEntries();
|
// Get all the 'names' of the properties to be saved in the 'infra_config' table
|
||||||
|
const enumValues = Object.values(InfraConfigEnum);
|
||||||
|
|
||||||
|
// Fetch the default values (value in .env) for configs to be saved in 'infra_config' table
|
||||||
|
const infraConfigDefaultObjs = this.getDefaultInfraConfigs();
|
||||||
|
|
||||||
|
// Check if all the 'names' are listed in the default values
|
||||||
|
if (enumValues.length !== infraConfigDefaultObjs.length) {
|
||||||
|
throw new Error(INFRA_CONFIG_NOT_LISTED);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Eliminate the rows (from 'infraConfigDefaultObjs') that are already present in the database table
|
||||||
|
const dbInfraConfigs = await this.prisma.infraConfig.findMany();
|
||||||
|
const propsToInsert = infraConfigDefaultObjs.filter(
|
||||||
|
(p) => !dbInfraConfigs.find((e) => e.name === p.name),
|
||||||
|
);
|
||||||
|
|
||||||
if (propsToInsert.length > 0) {
|
if (propsToInsert.length > 0) {
|
||||||
await this.prisma.infraConfig.createMany({ data: propsToInsert });
|
await this.prisma.infraConfig.createMany({ data: propsToInsert });
|
||||||
@@ -88,31 +124,20 @@ export class InfraConfigService implements OnModuleInit {
|
|||||||
cast(dbInfraConfig: DBInfraConfig) {
|
cast(dbInfraConfig: DBInfraConfig) {
|
||||||
return <InfraConfig>{
|
return <InfraConfig>{
|
||||||
name: dbInfraConfig.name,
|
name: dbInfraConfig.name,
|
||||||
value: dbInfraConfig.value ?? '',
|
value: dbInfraConfig.value,
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Get all the InfraConfigs as map
|
|
||||||
* @returns InfraConfig map
|
|
||||||
*/
|
|
||||||
async getInfraConfigsMap() {
|
|
||||||
const infraConfigs = await this.prisma.infraConfig.findMany();
|
|
||||||
const infraConfigMap: Record<string, string> = {};
|
|
||||||
infraConfigs.forEach((config) => {
|
|
||||||
infraConfigMap[config.name] = config.value;
|
|
||||||
});
|
|
||||||
return infraConfigMap;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Update InfraConfig by name
|
* Update InfraConfig by name
|
||||||
* @param name Name of the InfraConfig
|
* @param name Name of the InfraConfig
|
||||||
* @param value Value of the InfraConfig
|
* @param value Value of the InfraConfig
|
||||||
* @param restartEnabled If true, restart the app after updating the InfraConfig
|
|
||||||
* @returns InfraConfig model
|
* @returns InfraConfig model
|
||||||
*/
|
*/
|
||||||
async update(name: InfraConfigEnum, value: string, restartEnabled = false) {
|
async update(
|
||||||
|
name: InfraConfigEnumForClient | InfraConfigEnum,
|
||||||
|
value: string,
|
||||||
|
) {
|
||||||
const isValidate = this.validateEnvValues([{ name, value }]);
|
const isValidate = this.validateEnvValues([{ name, value }]);
|
||||||
if (E.isLeft(isValidate)) return E.left(isValidate.left);
|
if (E.isLeft(isValidate)) return E.left(isValidate.left);
|
||||||
|
|
||||||
@@ -122,7 +147,7 @@ export class InfraConfigService implements OnModuleInit {
|
|||||||
data: { value },
|
data: { value },
|
||||||
});
|
});
|
||||||
|
|
||||||
if (restartEnabled) stopApp();
|
stopApp();
|
||||||
|
|
||||||
return E.right(this.cast(infraConfig));
|
return E.right(this.cast(infraConfig));
|
||||||
} catch (e) {
|
} catch (e) {
|
||||||
@@ -136,11 +161,6 @@ export class InfraConfigService implements OnModuleInit {
|
|||||||
* @returns InfraConfig model
|
* @returns InfraConfig model
|
||||||
*/
|
*/
|
||||||
async updateMany(infraConfigs: InfraConfigArgs[]) {
|
async updateMany(infraConfigs: InfraConfigArgs[]) {
|
||||||
for (let i = 0; i < infraConfigs.length; i++) {
|
|
||||||
if (this.EXCLUDE_FROM_UPDATE_CONFIGS.includes(infraConfigs[i].name))
|
|
||||||
return E.left(INFRA_CONFIG_OPERATION_NOT_ALLOWED);
|
|
||||||
}
|
|
||||||
|
|
||||||
const isValidate = this.validateEnvValues(infraConfigs);
|
const isValidate = this.validateEnvValues(infraConfigs);
|
||||||
if (E.isLeft(isValidate)) return E.left(isValidate.left);
|
if (E.isLeft(isValidate)) return E.left(isValidate.left);
|
||||||
|
|
||||||
@@ -162,62 +182,6 @@ export class InfraConfigService implements OnModuleInit {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Check if the service is configured or not
|
|
||||||
* @param service Service can be Auth Provider, Mailer, Audit Log etc.
|
|
||||||
* @param configMap Map of all the infra configs
|
|
||||||
* @returns Either true or false
|
|
||||||
*/
|
|
||||||
isServiceConfigured(
|
|
||||||
service: AuthProvider,
|
|
||||||
configMap: Record<string, string>,
|
|
||||||
) {
|
|
||||||
switch (service) {
|
|
||||||
case AuthProvider.GOOGLE:
|
|
||||||
return (
|
|
||||||
configMap.GOOGLE_CLIENT_ID &&
|
|
||||||
configMap.GOOGLE_CLIENT_SECRET &&
|
|
||||||
configMap.GOOGLE_CALLBACK_URL &&
|
|
||||||
configMap.GOOGLE_SCOPE
|
|
||||||
);
|
|
||||||
case AuthProvider.GITHUB:
|
|
||||||
return (
|
|
||||||
configMap.GITHUB_CLIENT_ID &&
|
|
||||||
configMap.GITHUB_CLIENT_SECRET &&
|
|
||||||
configMap.GITHUB_CALLBACK_URL &&
|
|
||||||
configMap.GITHUB_SCOPE
|
|
||||||
);
|
|
||||||
case AuthProvider.MICROSOFT:
|
|
||||||
return (
|
|
||||||
configMap.MICROSOFT_CLIENT_ID &&
|
|
||||||
configMap.MICROSOFT_CLIENT_SECRET &&
|
|
||||||
configMap.MICROSOFT_CALLBACK_URL &&
|
|
||||||
configMap.MICROSOFT_SCOPE &&
|
|
||||||
configMap.MICROSOFT_TENANT
|
|
||||||
);
|
|
||||||
case AuthProvider.EMAIL:
|
|
||||||
return configMap.MAILER_SMTP_URL && configMap.MAILER_ADDRESS_FROM;
|
|
||||||
default:
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Enable or Disable Analytics Collection
|
|
||||||
*
|
|
||||||
* @param status Status to enable or disable
|
|
||||||
* @returns Boolean of status of analytics collection
|
|
||||||
*/
|
|
||||||
async toggleAnalyticsCollection(status: ServiceStatus) {
|
|
||||||
const isUpdated = await this.update(
|
|
||||||
InfraConfigEnum.ALLOW_ANALYTICS_COLLECTION,
|
|
||||||
status === ServiceStatus.ENABLE ? 'true' : 'false',
|
|
||||||
);
|
|
||||||
|
|
||||||
if (E.isLeft(isUpdated)) return E.left(isUpdated.left);
|
|
||||||
return E.right(isUpdated.right.value === 'true');
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Enable or Disable SSO for login/signup
|
* Enable or Disable SSO for login/signup
|
||||||
* @param provider Auth Provider to enable or disable
|
* @param provider Auth Provider to enable or disable
|
||||||
@@ -231,14 +195,8 @@ export class InfraConfigService implements OnModuleInit {
|
|||||||
|
|
||||||
let updatedAuthProviders = allowedAuthProviders;
|
let updatedAuthProviders = allowedAuthProviders;
|
||||||
|
|
||||||
const infraConfigMap = await this.getInfraConfigsMap();
|
|
||||||
|
|
||||||
providerInfo.forEach(({ provider, status }) => {
|
providerInfo.forEach(({ provider, status }) => {
|
||||||
if (status === ServiceStatus.ENABLE) {
|
if (status === ServiceStatus.ENABLE) {
|
||||||
const isConfigured = this.isServiceConfigured(provider, infraConfigMap);
|
|
||||||
if (!isConfigured) {
|
|
||||||
throwErr(INFRA_CONFIG_SERVICE_NOT_CONFIGURED);
|
|
||||||
}
|
|
||||||
updatedAuthProviders.push(provider);
|
updatedAuthProviders.push(provider);
|
||||||
} else if (status === ServiceStatus.DISABLE) {
|
} else if (status === ServiceStatus.DISABLE) {
|
||||||
updatedAuthProviders = updatedAuthProviders.filter(
|
updatedAuthProviders = updatedAuthProviders.filter(
|
||||||
@@ -256,7 +214,6 @@ export class InfraConfigService implements OnModuleInit {
|
|||||||
const isUpdated = await this.update(
|
const isUpdated = await this.update(
|
||||||
InfraConfigEnum.VITE_ALLOWED_AUTH_PROVIDERS,
|
InfraConfigEnum.VITE_ALLOWED_AUTH_PROVIDERS,
|
||||||
updatedAuthProviders.join(','),
|
updatedAuthProviders.join(','),
|
||||||
true,
|
|
||||||
);
|
);
|
||||||
if (E.isLeft(isUpdated)) return E.left(isUpdated.left);
|
if (E.isLeft(isUpdated)) return E.left(isUpdated.left);
|
||||||
|
|
||||||
@@ -268,7 +225,7 @@ export class InfraConfigService implements OnModuleInit {
|
|||||||
* @param name Name of the InfraConfig
|
* @param name Name of the InfraConfig
|
||||||
* @returns InfraConfig model
|
* @returns InfraConfig model
|
||||||
*/
|
*/
|
||||||
async get(name: InfraConfigEnum) {
|
async get(name: InfraConfigEnumForClient) {
|
||||||
try {
|
try {
|
||||||
const infraConfig = await this.prisma.infraConfig.findUniqueOrThrow({
|
const infraConfig = await this.prisma.infraConfig.findUniqueOrThrow({
|
||||||
where: { name },
|
where: { name },
|
||||||
@@ -283,18 +240,9 @@ export class InfraConfigService implements OnModuleInit {
|
|||||||
/**
|
/**
|
||||||
* Get InfraConfigs by names
|
* Get InfraConfigs by names
|
||||||
* @param names Names of the InfraConfigs
|
* @param names Names of the InfraConfigs
|
||||||
* @param checkDisallowedKeys If true, check if the names are allowed to fetch by client
|
|
||||||
* @returns InfraConfig model
|
* @returns InfraConfig model
|
||||||
*/
|
*/
|
||||||
async getMany(names: InfraConfigEnum[], checkDisallowedKeys: boolean = true) {
|
async getMany(names: InfraConfigEnumForClient[]) {
|
||||||
if (checkDisallowedKeys) {
|
|
||||||
// Check if the names are allowed to fetch by client
|
|
||||||
for (let i = 0; i < names.length; i++) {
|
|
||||||
if (this.EXCLUDE_FROM_FETCH_CONFIGS.includes(names[i]))
|
|
||||||
return E.left(INFRA_CONFIG_OPERATION_NOT_ALLOWED);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
try {
|
try {
|
||||||
const infraConfigs = await this.prisma.infraConfig.findMany({
|
const infraConfigs = await this.prisma.infraConfig.findMany({
|
||||||
where: { name: { in: names } },
|
where: { name: { in: names } },
|
||||||
@@ -320,28 +268,14 @@ export class InfraConfigService implements OnModuleInit {
|
|||||||
* Reset all the InfraConfigs to their default values (from .env)
|
* Reset all the InfraConfigs to their default values (from .env)
|
||||||
*/
|
*/
|
||||||
async reset() {
|
async reset() {
|
||||||
// These are all the infra-configs that should not be reset
|
|
||||||
const RESET_EXCLUSION_LIST = [
|
|
||||||
InfraConfigEnum.IS_FIRST_TIME_INFRA_SETUP,
|
|
||||||
InfraConfigEnum.ANALYTICS_USER_ID,
|
|
||||||
InfraConfigEnum.ALLOW_ANALYTICS_COLLECTION,
|
|
||||||
];
|
|
||||||
try {
|
try {
|
||||||
const infraConfigDefaultObjs = await getDefaultInfraConfigs();
|
const infraConfigDefaultObjs = this.getDefaultInfraConfigs();
|
||||||
const updatedInfraConfigDefaultObjs = infraConfigDefaultObjs.filter(
|
|
||||||
(p) => RESET_EXCLUSION_LIST.includes(p.name) === false,
|
|
||||||
);
|
|
||||||
|
|
||||||
await this.prisma.infraConfig.deleteMany({
|
await this.prisma.infraConfig.deleteMany({
|
||||||
where: {
|
where: { name: { in: infraConfigDefaultObjs.map((p) => p.name) } },
|
||||||
name: {
|
|
||||||
in: updatedInfraConfigDefaultObjs.map((p) => p.name),
|
|
||||||
},
|
|
||||||
},
|
|
||||||
});
|
});
|
||||||
|
|
||||||
await this.prisma.infraConfig.createMany({
|
await this.prisma.infraConfig.createMany({
|
||||||
data: updatedInfraConfigDefaultObjs,
|
data: infraConfigDefaultObjs,
|
||||||
});
|
});
|
||||||
|
|
||||||
stopApp();
|
stopApp();
|
||||||
@@ -352,67 +286,22 @@ export class InfraConfigService implements OnModuleInit {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Validate the values of the InfraConfigs
|
|
||||||
*/
|
|
||||||
validateEnvValues(
|
validateEnvValues(
|
||||||
infraConfigs: {
|
infraConfigs: {
|
||||||
name: InfraConfigEnum;
|
name: InfraConfigEnumForClient | InfraConfigEnum;
|
||||||
value: string;
|
value: string;
|
||||||
}[],
|
}[],
|
||||||
) {
|
) {
|
||||||
for (let i = 0; i < infraConfigs.length; i++) {
|
for (let i = 0; i < infraConfigs.length; i++) {
|
||||||
switch (infraConfigs[i].name) {
|
switch (infraConfigs[i].name) {
|
||||||
case InfraConfigEnum.MAILER_SMTP_URL:
|
case InfraConfigEnumForClient.MAILER_SMTP_URL:
|
||||||
const isValidUrl = validateSMTPUrl(infraConfigs[i].value);
|
const isValidUrl = validateSMTPUrl(infraConfigs[i].value);
|
||||||
if (!isValidUrl) return E.left(INFRA_CONFIG_INVALID_INPUT);
|
if (!isValidUrl) return E.left(INFRA_CONFIG_INVALID_INPUT);
|
||||||
break;
|
break;
|
||||||
case InfraConfigEnum.MAILER_ADDRESS_FROM:
|
case InfraConfigEnumForClient.MAILER_ADDRESS_FROM:
|
||||||
const isValidEmail = validateSMTPEmail(infraConfigs[i].value);
|
const isValidEmail = validateEmail(infraConfigs[i].value);
|
||||||
if (!isValidEmail) return E.left(INFRA_CONFIG_INVALID_INPUT);
|
if (!isValidEmail) return E.left(INFRA_CONFIG_INVALID_INPUT);
|
||||||
break;
|
break;
|
||||||
case InfraConfigEnum.GOOGLE_CLIENT_ID:
|
|
||||||
if (!infraConfigs[i].value) return E.left(INFRA_CONFIG_INVALID_INPUT);
|
|
||||||
break;
|
|
||||||
case InfraConfigEnum.GOOGLE_CLIENT_SECRET:
|
|
||||||
if (!infraConfigs[i].value) return E.left(INFRA_CONFIG_INVALID_INPUT);
|
|
||||||
break;
|
|
||||||
case InfraConfigEnum.GOOGLE_CALLBACK_URL:
|
|
||||||
if (!validateUrl(infraConfigs[i].value))
|
|
||||||
return E.left(INFRA_CONFIG_INVALID_INPUT);
|
|
||||||
break;
|
|
||||||
case InfraConfigEnum.GOOGLE_SCOPE:
|
|
||||||
if (!infraConfigs[i].value) return E.left(INFRA_CONFIG_INVALID_INPUT);
|
|
||||||
break;
|
|
||||||
case InfraConfigEnum.GITHUB_CLIENT_ID:
|
|
||||||
if (!infraConfigs[i].value) return E.left(INFRA_CONFIG_INVALID_INPUT);
|
|
||||||
break;
|
|
||||||
case InfraConfigEnum.GITHUB_CLIENT_SECRET:
|
|
||||||
if (!infraConfigs[i].value) return E.left(INFRA_CONFIG_INVALID_INPUT);
|
|
||||||
break;
|
|
||||||
case InfraConfigEnum.GITHUB_CALLBACK_URL:
|
|
||||||
if (!validateUrl(infraConfigs[i].value))
|
|
||||||
return E.left(INFRA_CONFIG_INVALID_INPUT);
|
|
||||||
break;
|
|
||||||
case InfraConfigEnum.GITHUB_SCOPE:
|
|
||||||
if (!infraConfigs[i].value) return E.left(INFRA_CONFIG_INVALID_INPUT);
|
|
||||||
break;
|
|
||||||
case InfraConfigEnum.MICROSOFT_CLIENT_ID:
|
|
||||||
if (!infraConfigs[i].value) return E.left(INFRA_CONFIG_INVALID_INPUT);
|
|
||||||
break;
|
|
||||||
case InfraConfigEnum.MICROSOFT_CLIENT_SECRET:
|
|
||||||
if (!infraConfigs[i].value) return E.left(INFRA_CONFIG_INVALID_INPUT);
|
|
||||||
break;
|
|
||||||
case InfraConfigEnum.MICROSOFT_CALLBACK_URL:
|
|
||||||
if (!validateUrl(infraConfigs[i].value))
|
|
||||||
return E.left(INFRA_CONFIG_INVALID_INPUT);
|
|
||||||
break;
|
|
||||||
case InfraConfigEnum.MICROSOFT_SCOPE:
|
|
||||||
if (!infraConfigs[i].value) return E.left(INFRA_CONFIG_INVALID_INPUT);
|
|
||||||
break;
|
|
||||||
case InfraConfigEnum.MICROSOFT_TENANT:
|
|
||||||
if (!infraConfigs[i].value) return E.left(INFRA_CONFIG_INVALID_INPUT);
|
|
||||||
break;
|
|
||||||
default:
|
default:
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,14 +1,14 @@
|
|||||||
import { Field, InputType } from '@nestjs/graphql';
|
import { Field, InputType } from '@nestjs/graphql';
|
||||||
import { InfraConfigEnum } from 'src/types/InfraConfig';
|
import { InfraConfigEnumForClient } from 'src/types/InfraConfig';
|
||||||
import { ServiceStatus } from './helper';
|
import { ServiceStatus } from './helper';
|
||||||
import { AuthProvider } from 'src/auth/helper';
|
import { AuthProvider } from 'src/auth/helper';
|
||||||
|
|
||||||
@InputType()
|
@InputType()
|
||||||
export class InfraConfigArgs {
|
export class InfraConfigArgs {
|
||||||
@Field(() => InfraConfigEnum, {
|
@Field(() => InfraConfigEnumForClient, {
|
||||||
description: 'Infra Config Name',
|
description: 'Infra Config Name',
|
||||||
})
|
})
|
||||||
name: InfraConfigEnum;
|
name: InfraConfigEnumForClient;
|
||||||
|
|
||||||
@Field({
|
@Field({
|
||||||
description: 'Infra Config Value',
|
description: 'Infra Config Value',
|
||||||
|
|||||||
@@ -25,7 +25,7 @@ export class MailerService {
|
|||||||
): string {
|
): string {
|
||||||
switch (mailDesc.template) {
|
switch (mailDesc.template) {
|
||||||
case 'team-invitation':
|
case 'team-invitation':
|
||||||
return `A user has invited you to join a team workspace in Hoppscotch`;
|
return `${mailDesc.variables.invitee} invited you to join ${mailDesc.variables.invite_team_name} in Hoppscotch`;
|
||||||
|
|
||||||
case 'user-invitation':
|
case 'user-invitation':
|
||||||
return 'Sign in to Hoppscotch';
|
return 'Sign in to Hoppscotch';
|
||||||
|
|||||||
@@ -27,12 +27,6 @@
|
|||||||
color: #3869D4;
|
color: #3869D4;
|
||||||
}
|
}
|
||||||
|
|
||||||
a.nohighlight {
|
|
||||||
color: inherit !important;
|
|
||||||
text-decoration: none !important;
|
|
||||||
cursor: default !important;
|
|
||||||
}
|
|
||||||
|
|
||||||
a img {
|
a img {
|
||||||
border: none;
|
border: none;
|
||||||
}
|
}
|
||||||
@@ -464,7 +458,7 @@
|
|||||||
<td class="content-cell">
|
<td class="content-cell">
|
||||||
<div class="f-fallback">
|
<div class="f-fallback">
|
||||||
<h1>Hi there,</h1>
|
<h1>Hi there,</h1>
|
||||||
<p><a class="nohighlight" name="invitee" href="#">{{invitee}}</a> with <a class="nohighlight" name="invite_team_name" href="#">{{invite_team_name}}</a> has invited you to use Hoppscotch to collaborate with them. Click the button below to set up your account and get started:</p>
|
<p>{{invitee}} with {{invite_team_name}} has invited you to use Hoppscotch to collaborate with them. Click the button below to set up your account and get started:</p>
|
||||||
<!-- Action -->
|
<!-- Action -->
|
||||||
<table class="body-action" align="center" width="100%" cellpadding="0" cellspacing="0">
|
<table class="body-action" align="center" width="100%" cellpadding="0" cellspacing="0">
|
||||||
<tr>
|
<tr>
|
||||||
@@ -490,7 +484,7 @@
|
|||||||
Welcome aboard, <br />
|
Welcome aboard, <br />
|
||||||
Your friends at Hoppscotch
|
Your friends at Hoppscotch
|
||||||
</p>
|
</p>
|
||||||
<p><strong>P.S.</strong> If you don't associate with <a class="nohighlight" name="invitee" href="#">{{invitee}}</a> or <a class="nohighlight" name="invite_team_name" href="#">{{invite_team_name}}</a>, just ignore this email.</p>
|
<p><strong>P.S.</strong> If you don't associate with {{invitee}} or {{invite_team_name}}, just ignore this email.</p>
|
||||||
<!-- Sub copy -->
|
<!-- Sub copy -->
|
||||||
<table class="body-sub">
|
<table class="body-sub">
|
||||||
<tr>
|
<tr>
|
||||||
|
|||||||
@@ -14,7 +14,7 @@
|
|||||||
-->
|
-->
|
||||||
<style type="text/css" rel="stylesheet" media="all">
|
<style type="text/css" rel="stylesheet" media="all">
|
||||||
/* Base ------------------------------ */
|
/* Base ------------------------------ */
|
||||||
|
|
||||||
@import url("https://fonts.googleapis.com/css?family=Nunito+Sans:400,700&display=swap");
|
@import url("https://fonts.googleapis.com/css?family=Nunito+Sans:400,700&display=swap");
|
||||||
body {
|
body {
|
||||||
width: 100% !important;
|
width: 100% !important;
|
||||||
@@ -22,25 +22,19 @@
|
|||||||
margin: 0;
|
margin: 0;
|
||||||
-webkit-text-size-adjust: none;
|
-webkit-text-size-adjust: none;
|
||||||
}
|
}
|
||||||
|
|
||||||
a {
|
a {
|
||||||
color: #3869D4;
|
color: #3869D4;
|
||||||
}
|
}
|
||||||
|
|
||||||
a.nohighlight {
|
|
||||||
color: inherit !important;
|
|
||||||
text-decoration: none !important;
|
|
||||||
cursor: default !important;
|
|
||||||
}
|
|
||||||
|
|
||||||
a img {
|
a img {
|
||||||
border: none;
|
border: none;
|
||||||
}
|
}
|
||||||
|
|
||||||
td {
|
td {
|
||||||
word-break: break-word;
|
word-break: break-word;
|
||||||
}
|
}
|
||||||
|
|
||||||
.preheader {
|
.preheader {
|
||||||
display: none !important;
|
display: none !important;
|
||||||
visibility: hidden;
|
visibility: hidden;
|
||||||
@@ -53,13 +47,13 @@
|
|||||||
overflow: hidden;
|
overflow: hidden;
|
||||||
}
|
}
|
||||||
/* Type ------------------------------ */
|
/* Type ------------------------------ */
|
||||||
|
|
||||||
body,
|
body,
|
||||||
td,
|
td,
|
||||||
th {
|
th {
|
||||||
font-family: "Nunito Sans", Helvetica, Arial, sans-serif;
|
font-family: "Nunito Sans", Helvetica, Arial, sans-serif;
|
||||||
}
|
}
|
||||||
|
|
||||||
h1 {
|
h1 {
|
||||||
margin-top: 0;
|
margin-top: 0;
|
||||||
color: #333333;
|
color: #333333;
|
||||||
@@ -67,7 +61,7 @@
|
|||||||
font-weight: bold;
|
font-weight: bold;
|
||||||
text-align: left;
|
text-align: left;
|
||||||
}
|
}
|
||||||
|
|
||||||
h2 {
|
h2 {
|
||||||
margin-top: 0;
|
margin-top: 0;
|
||||||
color: #333333;
|
color: #333333;
|
||||||
@@ -75,7 +69,7 @@
|
|||||||
font-weight: bold;
|
font-weight: bold;
|
||||||
text-align: left;
|
text-align: left;
|
||||||
}
|
}
|
||||||
|
|
||||||
h3 {
|
h3 {
|
||||||
margin-top: 0;
|
margin-top: 0;
|
||||||
color: #333333;
|
color: #333333;
|
||||||
@@ -83,12 +77,12 @@
|
|||||||
font-weight: bold;
|
font-weight: bold;
|
||||||
text-align: left;
|
text-align: left;
|
||||||
}
|
}
|
||||||
|
|
||||||
td,
|
td,
|
||||||
th {
|
th {
|
||||||
font-size: 16px;
|
font-size: 16px;
|
||||||
}
|
}
|
||||||
|
|
||||||
p,
|
p,
|
||||||
ul,
|
ul,
|
||||||
ol,
|
ol,
|
||||||
@@ -97,25 +91,25 @@
|
|||||||
font-size: 16px;
|
font-size: 16px;
|
||||||
line-height: 1.625;
|
line-height: 1.625;
|
||||||
}
|
}
|
||||||
|
|
||||||
p.sub {
|
p.sub {
|
||||||
font-size: 13px;
|
font-size: 13px;
|
||||||
}
|
}
|
||||||
/* Utilities ------------------------------ */
|
/* Utilities ------------------------------ */
|
||||||
|
|
||||||
.align-right {
|
.align-right {
|
||||||
text-align: right;
|
text-align: right;
|
||||||
}
|
}
|
||||||
|
|
||||||
.align-left {
|
.align-left {
|
||||||
text-align: left;
|
text-align: left;
|
||||||
}
|
}
|
||||||
|
|
||||||
.align-center {
|
.align-center {
|
||||||
text-align: center;
|
text-align: center;
|
||||||
}
|
}
|
||||||
/* Buttons ------------------------------ */
|
/* Buttons ------------------------------ */
|
||||||
|
|
||||||
.button {
|
.button {
|
||||||
background-color: #3869D4;
|
background-color: #3869D4;
|
||||||
border-top: 10px solid #3869D4;
|
border-top: 10px solid #3869D4;
|
||||||
@@ -130,7 +124,7 @@
|
|||||||
-webkit-text-size-adjust: none;
|
-webkit-text-size-adjust: none;
|
||||||
box-sizing: border-box;
|
box-sizing: border-box;
|
||||||
}
|
}
|
||||||
|
|
||||||
.button--green {
|
.button--green {
|
||||||
background-color: #22BC66;
|
background-color: #22BC66;
|
||||||
border-top: 10px solid #22BC66;
|
border-top: 10px solid #22BC66;
|
||||||
@@ -138,7 +132,7 @@
|
|||||||
border-bottom: 10px solid #22BC66;
|
border-bottom: 10px solid #22BC66;
|
||||||
border-left: 18px solid #22BC66;
|
border-left: 18px solid #22BC66;
|
||||||
}
|
}
|
||||||
|
|
||||||
.button--red {
|
.button--red {
|
||||||
background-color: #FF6136;
|
background-color: #FF6136;
|
||||||
border-top: 10px solid #FF6136;
|
border-top: 10px solid #FF6136;
|
||||||
@@ -146,7 +140,7 @@
|
|||||||
border-bottom: 10px solid #FF6136;
|
border-bottom: 10px solid #FF6136;
|
||||||
border-left: 18px solid #FF6136;
|
border-left: 18px solid #FF6136;
|
||||||
}
|
}
|
||||||
|
|
||||||
@media only screen and (max-width: 500px) {
|
@media only screen and (max-width: 500px) {
|
||||||
.button {
|
.button {
|
||||||
width: 100% !important;
|
width: 100% !important;
|
||||||
@@ -154,21 +148,21 @@
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
/* Attribute list ------------------------------ */
|
/* Attribute list ------------------------------ */
|
||||||
|
|
||||||
.attributes {
|
.attributes {
|
||||||
margin: 0 0 21px;
|
margin: 0 0 21px;
|
||||||
}
|
}
|
||||||
|
|
||||||
.attributes_content {
|
.attributes_content {
|
||||||
background-color: #F4F4F7;
|
background-color: #F4F4F7;
|
||||||
padding: 16px;
|
padding: 16px;
|
||||||
}
|
}
|
||||||
|
|
||||||
.attributes_item {
|
.attributes_item {
|
||||||
padding: 0;
|
padding: 0;
|
||||||
}
|
}
|
||||||
/* Related Items ------------------------------ */
|
/* Related Items ------------------------------ */
|
||||||
|
|
||||||
.related {
|
.related {
|
||||||
width: 100%;
|
width: 100%;
|
||||||
margin: 0;
|
margin: 0;
|
||||||
@@ -177,31 +171,31 @@
|
|||||||
-premailer-cellpadding: 0;
|
-premailer-cellpadding: 0;
|
||||||
-premailer-cellspacing: 0;
|
-premailer-cellspacing: 0;
|
||||||
}
|
}
|
||||||
|
|
||||||
.related_item {
|
.related_item {
|
||||||
padding: 10px 0;
|
padding: 10px 0;
|
||||||
color: #CBCCCF;
|
color: #CBCCCF;
|
||||||
font-size: 15px;
|
font-size: 15px;
|
||||||
line-height: 18px;
|
line-height: 18px;
|
||||||
}
|
}
|
||||||
|
|
||||||
.related_item-title {
|
.related_item-title {
|
||||||
display: block;
|
display: block;
|
||||||
margin: .5em 0 0;
|
margin: .5em 0 0;
|
||||||
}
|
}
|
||||||
|
|
||||||
.related_item-thumb {
|
.related_item-thumb {
|
||||||
display: block;
|
display: block;
|
||||||
padding-bottom: 10px;
|
padding-bottom: 10px;
|
||||||
}
|
}
|
||||||
|
|
||||||
.related_heading {
|
.related_heading {
|
||||||
border-top: 1px solid #CBCCCF;
|
border-top: 1px solid #CBCCCF;
|
||||||
text-align: center;
|
text-align: center;
|
||||||
padding: 25px 0 10px;
|
padding: 25px 0 10px;
|
||||||
}
|
}
|
||||||
/* Discount Code ------------------------------ */
|
/* Discount Code ------------------------------ */
|
||||||
|
|
||||||
.discount {
|
.discount {
|
||||||
width: 100%;
|
width: 100%;
|
||||||
margin: 0;
|
margin: 0;
|
||||||
@@ -212,33 +206,33 @@
|
|||||||
background-color: #F4F4F7;
|
background-color: #F4F4F7;
|
||||||
border: 2px dashed #CBCCCF;
|
border: 2px dashed #CBCCCF;
|
||||||
}
|
}
|
||||||
|
|
||||||
.discount_heading {
|
.discount_heading {
|
||||||
text-align: center;
|
text-align: center;
|
||||||
}
|
}
|
||||||
|
|
||||||
.discount_body {
|
.discount_body {
|
||||||
text-align: center;
|
text-align: center;
|
||||||
font-size: 15px;
|
font-size: 15px;
|
||||||
}
|
}
|
||||||
/* Social Icons ------------------------------ */
|
/* Social Icons ------------------------------ */
|
||||||
|
|
||||||
.social {
|
.social {
|
||||||
width: auto;
|
width: auto;
|
||||||
}
|
}
|
||||||
|
|
||||||
.social td {
|
.social td {
|
||||||
padding: 0;
|
padding: 0;
|
||||||
width: auto;
|
width: auto;
|
||||||
}
|
}
|
||||||
|
|
||||||
.social_icon {
|
.social_icon {
|
||||||
height: 20px;
|
height: 20px;
|
||||||
margin: 0 8px 10px 8px;
|
margin: 0 8px 10px 8px;
|
||||||
padding: 0;
|
padding: 0;
|
||||||
}
|
}
|
||||||
/* Data table ------------------------------ */
|
/* Data table ------------------------------ */
|
||||||
|
|
||||||
.purchase {
|
.purchase {
|
||||||
width: 100%;
|
width: 100%;
|
||||||
margin: 0;
|
margin: 0;
|
||||||
@@ -247,7 +241,7 @@
|
|||||||
-premailer-cellpadding: 0;
|
-premailer-cellpadding: 0;
|
||||||
-premailer-cellspacing: 0;
|
-premailer-cellspacing: 0;
|
||||||
}
|
}
|
||||||
|
|
||||||
.purchase_content {
|
.purchase_content {
|
||||||
width: 100%;
|
width: 100%;
|
||||||
margin: 0;
|
margin: 0;
|
||||||
@@ -256,50 +250,50 @@
|
|||||||
-premailer-cellpadding: 0;
|
-premailer-cellpadding: 0;
|
||||||
-premailer-cellspacing: 0;
|
-premailer-cellspacing: 0;
|
||||||
}
|
}
|
||||||
|
|
||||||
.purchase_item {
|
.purchase_item {
|
||||||
padding: 10px 0;
|
padding: 10px 0;
|
||||||
color: #51545E;
|
color: #51545E;
|
||||||
font-size: 15px;
|
font-size: 15px;
|
||||||
line-height: 18px;
|
line-height: 18px;
|
||||||
}
|
}
|
||||||
|
|
||||||
.purchase_heading {
|
.purchase_heading {
|
||||||
padding-bottom: 8px;
|
padding-bottom: 8px;
|
||||||
border-bottom: 1px solid #EAEAEC;
|
border-bottom: 1px solid #EAEAEC;
|
||||||
}
|
}
|
||||||
|
|
||||||
.purchase_heading p {
|
.purchase_heading p {
|
||||||
margin: 0;
|
margin: 0;
|
||||||
color: #85878E;
|
color: #85878E;
|
||||||
font-size: 12px;
|
font-size: 12px;
|
||||||
}
|
}
|
||||||
|
|
||||||
.purchase_footer {
|
.purchase_footer {
|
||||||
padding-top: 15px;
|
padding-top: 15px;
|
||||||
border-top: 1px solid #EAEAEC;
|
border-top: 1px solid #EAEAEC;
|
||||||
}
|
}
|
||||||
|
|
||||||
.purchase_total {
|
.purchase_total {
|
||||||
margin: 0;
|
margin: 0;
|
||||||
text-align: right;
|
text-align: right;
|
||||||
font-weight: bold;
|
font-weight: bold;
|
||||||
color: #333333;
|
color: #333333;
|
||||||
}
|
}
|
||||||
|
|
||||||
.purchase_total--label {
|
.purchase_total--label {
|
||||||
padding: 0 15px 0 0;
|
padding: 0 15px 0 0;
|
||||||
}
|
}
|
||||||
|
|
||||||
body {
|
body {
|
||||||
background-color: #F2F4F6;
|
background-color: #F2F4F6;
|
||||||
color: #51545E;
|
color: #51545E;
|
||||||
}
|
}
|
||||||
|
|
||||||
p {
|
p {
|
||||||
color: #51545E;
|
color: #51545E;
|
||||||
}
|
}
|
||||||
|
|
||||||
.email-wrapper {
|
.email-wrapper {
|
||||||
width: 100%;
|
width: 100%;
|
||||||
margin: 0;
|
margin: 0;
|
||||||
@@ -309,7 +303,7 @@
|
|||||||
-premailer-cellspacing: 0;
|
-premailer-cellspacing: 0;
|
||||||
background-color: #F2F4F6;
|
background-color: #F2F4F6;
|
||||||
}
|
}
|
||||||
|
|
||||||
.email-content {
|
.email-content {
|
||||||
width: 100%;
|
width: 100%;
|
||||||
margin: 0;
|
margin: 0;
|
||||||
@@ -319,16 +313,16 @@
|
|||||||
-premailer-cellspacing: 0;
|
-premailer-cellspacing: 0;
|
||||||
}
|
}
|
||||||
/* Masthead ----------------------- */
|
/* Masthead ----------------------- */
|
||||||
|
|
||||||
.email-masthead {
|
.email-masthead {
|
||||||
padding: 25px 0;
|
padding: 25px 0;
|
||||||
text-align: center;
|
text-align: center;
|
||||||
}
|
}
|
||||||
|
|
||||||
.email-masthead_logo {
|
.email-masthead_logo {
|
||||||
width: 94px;
|
width: 94px;
|
||||||
}
|
}
|
||||||
|
|
||||||
.email-masthead_name {
|
.email-masthead_name {
|
||||||
font-size: 16px;
|
font-size: 16px;
|
||||||
font-weight: bold;
|
font-weight: bold;
|
||||||
@@ -337,7 +331,7 @@
|
|||||||
text-shadow: 0 1px 0 white;
|
text-shadow: 0 1px 0 white;
|
||||||
}
|
}
|
||||||
/* Body ------------------------------ */
|
/* Body ------------------------------ */
|
||||||
|
|
||||||
.email-body {
|
.email-body {
|
||||||
width: 100%;
|
width: 100%;
|
||||||
margin: 0;
|
margin: 0;
|
||||||
@@ -346,7 +340,7 @@
|
|||||||
-premailer-cellpadding: 0;
|
-premailer-cellpadding: 0;
|
||||||
-premailer-cellspacing: 0;
|
-premailer-cellspacing: 0;
|
||||||
}
|
}
|
||||||
|
|
||||||
.email-body_inner {
|
.email-body_inner {
|
||||||
width: 570px;
|
width: 570px;
|
||||||
margin: 0 auto;
|
margin: 0 auto;
|
||||||
@@ -356,7 +350,7 @@
|
|||||||
-premailer-cellspacing: 0;
|
-premailer-cellspacing: 0;
|
||||||
background-color: #FFFFFF;
|
background-color: #FFFFFF;
|
||||||
}
|
}
|
||||||
|
|
||||||
.email-footer {
|
.email-footer {
|
||||||
width: 570px;
|
width: 570px;
|
||||||
margin: 0 auto;
|
margin: 0 auto;
|
||||||
@@ -366,11 +360,11 @@
|
|||||||
-premailer-cellspacing: 0;
|
-premailer-cellspacing: 0;
|
||||||
text-align: center;
|
text-align: center;
|
||||||
}
|
}
|
||||||
|
|
||||||
.email-footer p {
|
.email-footer p {
|
||||||
color: #A8AAAF;
|
color: #A8AAAF;
|
||||||
}
|
}
|
||||||
|
|
||||||
.body-action {
|
.body-action {
|
||||||
width: 100%;
|
width: 100%;
|
||||||
margin: 30px auto;
|
margin: 30px auto;
|
||||||
@@ -380,25 +374,25 @@
|
|||||||
-premailer-cellspacing: 0;
|
-premailer-cellspacing: 0;
|
||||||
text-align: center;
|
text-align: center;
|
||||||
}
|
}
|
||||||
|
|
||||||
.body-sub {
|
.body-sub {
|
||||||
margin-top: 25px;
|
margin-top: 25px;
|
||||||
padding-top: 25px;
|
padding-top: 25px;
|
||||||
border-top: 1px solid #EAEAEC;
|
border-top: 1px solid #EAEAEC;
|
||||||
}
|
}
|
||||||
|
|
||||||
.content-cell {
|
.content-cell {
|
||||||
padding: 45px;
|
padding: 45px;
|
||||||
}
|
}
|
||||||
/*Media Queries ------------------------------ */
|
/*Media Queries ------------------------------ */
|
||||||
|
|
||||||
@media only screen and (max-width: 600px) {
|
@media only screen and (max-width: 600px) {
|
||||||
.email-body_inner,
|
.email-body_inner,
|
||||||
.email-footer {
|
.email-footer {
|
||||||
width: 100% !important;
|
width: 100% !important;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@media (prefers-color-scheme: dark) {
|
@media (prefers-color-scheme: dark) {
|
||||||
body,
|
body,
|
||||||
.email-body,
|
.email-body,
|
||||||
|
|||||||
@@ -17,8 +17,7 @@ async function bootstrap() {
|
|||||||
console.log(`Port: ${configService.get('PORT')}`);
|
console.log(`Port: ${configService.get('PORT')}`);
|
||||||
|
|
||||||
checkEnvironmentAuthProvider(
|
checkEnvironmentAuthProvider(
|
||||||
configService.get('INFRA.VITE_ALLOWED_AUTH_PROVIDERS') ??
|
configService.get('VITE_ALLOWED_AUTH_PROVIDERS'),
|
||||||
configService.get('VITE_ALLOWED_AUTH_PROVIDERS'),
|
|
||||||
);
|
);
|
||||||
|
|
||||||
app.use(
|
app.use(
|
||||||
|
|||||||
@@ -1,9 +0,0 @@
|
|||||||
import { Module } from '@nestjs/common';
|
|
||||||
import { PosthogService } from './posthog.service';
|
|
||||||
import { PrismaModule } from 'src/prisma/prisma.module';
|
|
||||||
|
|
||||||
@Module({
|
|
||||||
imports: [PrismaModule],
|
|
||||||
providers: [PosthogService],
|
|
||||||
})
|
|
||||||
export class PosthogModule {}
|
|
||||||
@@ -1,58 +0,0 @@
|
|||||||
import { Injectable } from '@nestjs/common';
|
|
||||||
import { PostHog } from 'posthog-node';
|
|
||||||
import { Cron, CronExpression, SchedulerRegistry } from '@nestjs/schedule';
|
|
||||||
import { ConfigService } from '@nestjs/config';
|
|
||||||
import { PrismaService } from 'src/prisma/prisma.service';
|
|
||||||
import { CronJob } from 'cron';
|
|
||||||
import { POSTHOG_CLIENT_NOT_INITIALIZED } from 'src/errors';
|
|
||||||
import { throwErr } from 'src/utils';
|
|
||||||
@Injectable()
|
|
||||||
export class PosthogService {
|
|
||||||
private postHogClient: PostHog;
|
|
||||||
private POSTHOG_API_KEY = 'phc_9CipPajQC22mSkk2wxe2TXsUA0Ysyupe8dt5KQQELqx';
|
|
||||||
|
|
||||||
constructor(
|
|
||||||
private readonly configService: ConfigService,
|
|
||||||
private readonly prismaService: PrismaService,
|
|
||||||
private schedulerRegistry: SchedulerRegistry,
|
|
||||||
) {}
|
|
||||||
|
|
||||||
async onModuleInit() {
|
|
||||||
if (this.configService.get('INFRA.ALLOW_ANALYTICS_COLLECTION') === 'true') {
|
|
||||||
console.log('Initializing PostHog');
|
|
||||||
this.postHogClient = new PostHog(this.POSTHOG_API_KEY, {
|
|
||||||
host: 'https://eu.posthog.com',
|
|
||||||
});
|
|
||||||
|
|
||||||
// Schedule the cron job only if analytics collection is allowed
|
|
||||||
this.scheduleCronJob();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
private scheduleCronJob() {
|
|
||||||
const job = new CronJob(CronExpression.EVERY_WEEK, async () => {
|
|
||||||
await this.capture();
|
|
||||||
});
|
|
||||||
|
|
||||||
this.schedulerRegistry.addCronJob('captureAnalytics', job);
|
|
||||||
job.start();
|
|
||||||
}
|
|
||||||
|
|
||||||
async capture() {
|
|
||||||
if (!this.postHogClient) {
|
|
||||||
throwErr(POSTHOG_CLIENT_NOT_INITIALIZED);
|
|
||||||
}
|
|
||||||
|
|
||||||
this.postHogClient.capture({
|
|
||||||
distinctId: this.configService.get('INFRA.ANALYTICS_USER_ID'),
|
|
||||||
event: 'sh_instance',
|
|
||||||
properties: {
|
|
||||||
type: 'COMMUNITY',
|
|
||||||
total_user_count: await this.prismaService.user.count(),
|
|
||||||
total_workspace_count: await this.prismaService.team.count(),
|
|
||||||
version: this.configService.get('npm_package_version'),
|
|
||||||
},
|
|
||||||
});
|
|
||||||
console.log('Sent event to PostHog');
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,14 +0,0 @@
|
|||||||
// Type of data returned from the query to obtain all search results
|
|
||||||
export type SearchQueryReturnType = {
|
|
||||||
id: string;
|
|
||||||
title: string;
|
|
||||||
type: 'collection' | 'request';
|
|
||||||
method?: string;
|
|
||||||
};
|
|
||||||
|
|
||||||
// Type of data returned from the query to obtain all parents
|
|
||||||
export type ParentTreeQueryReturnType = {
|
|
||||||
id: string;
|
|
||||||
parentID: string;
|
|
||||||
title: string;
|
|
||||||
};
|
|
||||||
@@ -1,54 +0,0 @@
|
|||||||
import {
|
|
||||||
Controller,
|
|
||||||
Get,
|
|
||||||
HttpStatus,
|
|
||||||
Param,
|
|
||||||
Query,
|
|
||||||
UseGuards,
|
|
||||||
} from '@nestjs/common';
|
|
||||||
import { TeamCollectionService } from './team-collection.service';
|
|
||||||
import * as E from 'fp-ts/Either';
|
|
||||||
import { ThrottlerBehindProxyGuard } from 'src/guards/throttler-behind-proxy.guard';
|
|
||||||
import { JwtAuthGuard } from 'src/auth/guards/jwt-auth.guard';
|
|
||||||
import { RequiresTeamRole } from 'src/team/decorators/requires-team-role.decorator';
|
|
||||||
import { TeamMemberRole } from '@prisma/client';
|
|
||||||
import { RESTTeamMemberGuard } from 'src/team/guards/rest-team-member.guard';
|
|
||||||
import { throwHTTPErr } from 'src/utils';
|
|
||||||
import { RESTError } from 'src/types/RESTError';
|
|
||||||
import { INVALID_PARAMS } from 'src/errors';
|
|
||||||
|
|
||||||
@UseGuards(ThrottlerBehindProxyGuard)
|
|
||||||
@Controller({ path: 'team-collection', version: '1' })
|
|
||||||
export class TeamCollectionController {
|
|
||||||
constructor(private readonly teamCollectionService: TeamCollectionService) {}
|
|
||||||
|
|
||||||
@Get('search/:teamID')
|
|
||||||
@RequiresTeamRole(
|
|
||||||
TeamMemberRole.VIEWER,
|
|
||||||
TeamMemberRole.EDITOR,
|
|
||||||
TeamMemberRole.OWNER,
|
|
||||||
)
|
|
||||||
@UseGuards(JwtAuthGuard, RESTTeamMemberGuard)
|
|
||||||
async searchByTitle(
|
|
||||||
@Query('searchQuery') searchQuery: string,
|
|
||||||
@Param('teamID') teamID: string,
|
|
||||||
@Query('take') take: string,
|
|
||||||
@Query('skip') skip: string,
|
|
||||||
) {
|
|
||||||
if (!teamID || !searchQuery) {
|
|
||||||
return <RESTError>{
|
|
||||||
message: INVALID_PARAMS,
|
|
||||||
statusCode: HttpStatus.BAD_REQUEST,
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
const res = await this.teamCollectionService.searchByTitle(
|
|
||||||
searchQuery.trim(),
|
|
||||||
teamID,
|
|
||||||
parseInt(take),
|
|
||||||
parseInt(skip),
|
|
||||||
);
|
|
||||||
if (E.isLeft(res)) throwHTTPErr(res.left);
|
|
||||||
return res.right;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -6,7 +6,6 @@ import { GqlCollectionTeamMemberGuard } from './guards/gql-collection-team-membe
|
|||||||
import { TeamModule } from '../team/team.module';
|
import { TeamModule } from '../team/team.module';
|
||||||
import { UserModule } from '../user/user.module';
|
import { UserModule } from '../user/user.module';
|
||||||
import { PubSubModule } from '../pubsub/pubsub.module';
|
import { PubSubModule } from '../pubsub/pubsub.module';
|
||||||
import { TeamCollectionController } from './team-collection.controller';
|
|
||||||
|
|
||||||
@Module({
|
@Module({
|
||||||
imports: [PrismaModule, TeamModule, UserModule, PubSubModule],
|
imports: [PrismaModule, TeamModule, UserModule, PubSubModule],
|
||||||
@@ -16,6 +15,5 @@ import { TeamCollectionController } from './team-collection.controller';
|
|||||||
GqlCollectionTeamMemberGuard,
|
GqlCollectionTeamMemberGuard,
|
||||||
],
|
],
|
||||||
exports: [TeamCollectionService, GqlCollectionTeamMemberGuard],
|
exports: [TeamCollectionService, GqlCollectionTeamMemberGuard],
|
||||||
controllers: [TeamCollectionController],
|
|
||||||
})
|
})
|
||||||
export class TeamCollectionModule {}
|
export class TeamCollectionModule {}
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
import { HttpStatus, Injectable } from '@nestjs/common';
|
import { Injectable } from '@nestjs/common';
|
||||||
import { PrismaService } from '../prisma/prisma.service';
|
import { PrismaService } from '../prisma/prisma.service';
|
||||||
import { TeamCollection } from './team-collection.model';
|
import { TeamCollection } from './team-collection.model';
|
||||||
import {
|
import {
|
||||||
@@ -14,21 +14,14 @@ import {
|
|||||||
TEAM_COL_SAME_NEXT_COLL,
|
TEAM_COL_SAME_NEXT_COLL,
|
||||||
TEAM_COL_REORDERING_FAILED,
|
TEAM_COL_REORDERING_FAILED,
|
||||||
TEAM_COLL_DATA_INVALID,
|
TEAM_COLL_DATA_INVALID,
|
||||||
TEAM_REQ_SEARCH_FAILED,
|
|
||||||
TEAM_COL_SEARCH_FAILED,
|
|
||||||
TEAM_REQ_PARENT_TREE_GEN_FAILED,
|
|
||||||
TEAM_COLL_PARENT_TREE_GEN_FAILED,
|
|
||||||
} from '../errors';
|
} from '../errors';
|
||||||
import { PubSubService } from '../pubsub/pubsub.service';
|
import { PubSubService } from '../pubsub/pubsub.service';
|
||||||
import { escapeSqlLikeString, isValidLength } from 'src/utils';
|
import { isValidLength } from 'src/utils';
|
||||||
import * as E from 'fp-ts/Either';
|
import * as E from 'fp-ts/Either';
|
||||||
import * as O from 'fp-ts/Option';
|
import * as O from 'fp-ts/Option';
|
||||||
import { Prisma, TeamCollection as DBTeamCollection } from '@prisma/client';
|
import { Prisma, TeamCollection as DBTeamCollection } from '@prisma/client';
|
||||||
import { CollectionFolder } from 'src/types/CollectionFolder';
|
import { CollectionFolder } from 'src/types/CollectionFolder';
|
||||||
import { stringToJson } from 'src/utils';
|
import { stringToJson } from 'src/utils';
|
||||||
import { CollectionSearchNode } from 'src/types/CollectionSearchNode';
|
|
||||||
import { ParentTreeQueryReturnType, SearchQueryReturnType } from './helper';
|
|
||||||
import { RESTError } from 'src/types/RESTError';
|
|
||||||
|
|
||||||
@Injectable()
|
@Injectable()
|
||||||
export class TeamCollectionService {
|
export class TeamCollectionService {
|
||||||
@@ -1063,285 +1056,4 @@ export class TeamCollectionService {
|
|||||||
return E.left(TEAM_COLL_NOT_FOUND);
|
return E.left(TEAM_COLL_NOT_FOUND);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Search for TeamCollections and TeamRequests by title
|
|
||||||
*
|
|
||||||
* @param searchQuery The search query
|
|
||||||
* @param teamID The Team ID
|
|
||||||
* @param take Number of items we want returned
|
|
||||||
* @param skip Number of items we want to skip
|
|
||||||
* @returns An Either of the search results
|
|
||||||
*/
|
|
||||||
async searchByTitle(
|
|
||||||
searchQuery: string,
|
|
||||||
teamID: string,
|
|
||||||
take = 10,
|
|
||||||
skip = 0,
|
|
||||||
) {
|
|
||||||
// Fetch all collections and requests that match the search query
|
|
||||||
const searchResults: SearchQueryReturnType[] = [];
|
|
||||||
|
|
||||||
const matchedCollections = await this.searchCollections(
|
|
||||||
searchQuery,
|
|
||||||
teamID,
|
|
||||||
take,
|
|
||||||
skip,
|
|
||||||
);
|
|
||||||
if (E.isLeft(matchedCollections))
|
|
||||||
return E.left(<RESTError>{
|
|
||||||
message: matchedCollections.left,
|
|
||||||
statusCode: HttpStatus.NOT_FOUND,
|
|
||||||
});
|
|
||||||
searchResults.push(...matchedCollections.right);
|
|
||||||
|
|
||||||
const matchedRequests = await this.searchRequests(
|
|
||||||
searchQuery,
|
|
||||||
teamID,
|
|
||||||
take,
|
|
||||||
skip,
|
|
||||||
);
|
|
||||||
if (E.isLeft(matchedRequests))
|
|
||||||
return E.left(<RESTError>{
|
|
||||||
message: matchedRequests.left,
|
|
||||||
statusCode: HttpStatus.NOT_FOUND,
|
|
||||||
});
|
|
||||||
searchResults.push(...matchedRequests.right);
|
|
||||||
|
|
||||||
// Generate the parent tree for searchResults
|
|
||||||
const searchResultsWithTree: CollectionSearchNode[] = [];
|
|
||||||
|
|
||||||
for (let i = 0; i < searchResults.length; i++) {
|
|
||||||
const fetchedParentTree = await this.fetchParentTree(searchResults[i]);
|
|
||||||
if (E.isLeft(fetchedParentTree))
|
|
||||||
return E.left(<RESTError>{
|
|
||||||
message: fetchedParentTree.left,
|
|
||||||
statusCode: HttpStatus.NOT_FOUND,
|
|
||||||
});
|
|
||||||
searchResultsWithTree.push({
|
|
||||||
type: searchResults[i].type,
|
|
||||||
title: searchResults[i].title,
|
|
||||||
method: searchResults[i].method,
|
|
||||||
id: searchResults[i].id,
|
|
||||||
path: !fetchedParentTree
|
|
||||||
? []
|
|
||||||
: (fetchedParentTree.right as CollectionSearchNode[]),
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
return E.right({ data: searchResultsWithTree });
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Search for TeamCollections by title
|
|
||||||
*
|
|
||||||
* @param searchQuery The search query
|
|
||||||
* @param teamID The Team ID
|
|
||||||
* @param take Number of items we want returned
|
|
||||||
* @param skip Number of items we want to skip
|
|
||||||
* @returns An Either of the search results
|
|
||||||
*/
|
|
||||||
private async searchCollections(
|
|
||||||
searchQuery: string,
|
|
||||||
teamID: string,
|
|
||||||
take: number,
|
|
||||||
skip: number,
|
|
||||||
) {
|
|
||||||
const query = Prisma.sql`
|
|
||||||
SELECT
|
|
||||||
id,title,'collection' AS type
|
|
||||||
FROM
|
|
||||||
"TeamCollection"
|
|
||||||
WHERE
|
|
||||||
"TeamCollection"."teamID"=${teamID}
|
|
||||||
AND
|
|
||||||
title ILIKE ${`%${escapeSqlLikeString(searchQuery)}%`}
|
|
||||||
ORDER BY
|
|
||||||
similarity(title, ${searchQuery})
|
|
||||||
LIMIT ${take}
|
|
||||||
OFFSET ${skip === 0 ? 0 : (skip - 1) * take};
|
|
||||||
`;
|
|
||||||
|
|
||||||
try {
|
|
||||||
const res = await this.prisma.$queryRaw<SearchQueryReturnType[]>(query);
|
|
||||||
return E.right(res);
|
|
||||||
} catch (error) {
|
|
||||||
return E.left(TEAM_COL_SEARCH_FAILED);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Search for TeamRequests by title
|
|
||||||
*
|
|
||||||
* @param searchQuery The search query
|
|
||||||
* @param teamID The Team ID
|
|
||||||
* @param take Number of items we want returned
|
|
||||||
* @param skip Number of items we want to skip
|
|
||||||
* @returns An Either of the search results
|
|
||||||
*/
|
|
||||||
private async searchRequests(
|
|
||||||
searchQuery: string,
|
|
||||||
teamID: string,
|
|
||||||
take: number,
|
|
||||||
skip: number,
|
|
||||||
) {
|
|
||||||
const query = Prisma.sql`
|
|
||||||
SELECT
|
|
||||||
id,title,request->>'method' as method,'request' AS type
|
|
||||||
FROM
|
|
||||||
"TeamRequest"
|
|
||||||
WHERE
|
|
||||||
"TeamRequest"."teamID"=${teamID}
|
|
||||||
AND
|
|
||||||
title ILIKE ${`%${escapeSqlLikeString(searchQuery)}%`}
|
|
||||||
ORDER BY
|
|
||||||
similarity(title, ${searchQuery})
|
|
||||||
LIMIT ${take}
|
|
||||||
OFFSET ${skip === 0 ? 0 : (skip - 1) * take};
|
|
||||||
`;
|
|
||||||
|
|
||||||
try {
|
|
||||||
const res = await this.prisma.$queryRaw<SearchQueryReturnType[]>(query);
|
|
||||||
return E.right(res);
|
|
||||||
} catch (error) {
|
|
||||||
return E.left(TEAM_REQ_SEARCH_FAILED);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Generate the parent tree of a search result
|
|
||||||
*
|
|
||||||
* @param searchResult The search result for which we want to generate the parent tree
|
|
||||||
* @returns The parent tree of the search result
|
|
||||||
*/
|
|
||||||
private async fetchParentTree(searchResult: SearchQueryReturnType) {
|
|
||||||
return searchResult.type === 'collection'
|
|
||||||
? await this.fetchCollectionParentTree(searchResult.id)
|
|
||||||
: await this.fetchRequestParentTree(searchResult.id);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Generate the parent tree of a collection
|
|
||||||
*
|
|
||||||
* @param id The ID of the collection
|
|
||||||
* @returns The parent tree of the collection
|
|
||||||
*/
|
|
||||||
private async fetchCollectionParentTree(id: string) {
|
|
||||||
try {
|
|
||||||
const query = Prisma.sql`
|
|
||||||
WITH RECURSIVE collection_tree AS (
|
|
||||||
SELECT tc.id, tc."parentID", tc.title
|
|
||||||
FROM "TeamCollection" AS tc
|
|
||||||
JOIN "TeamCollection" AS tr ON tc.id = tr."parentID"
|
|
||||||
WHERE tr.id = ${id}
|
|
||||||
|
|
||||||
UNION ALL
|
|
||||||
|
|
||||||
SELECT parent.id, parent."parentID", parent.title
|
|
||||||
FROM "TeamCollection" AS parent
|
|
||||||
JOIN collection_tree AS ct ON parent.id = ct."parentID"
|
|
||||||
)
|
|
||||||
SELECT * FROM collection_tree;
|
|
||||||
`;
|
|
||||||
const res = await this.prisma.$queryRaw<ParentTreeQueryReturnType[]>(
|
|
||||||
query,
|
|
||||||
);
|
|
||||||
|
|
||||||
const collectionParentTree = this.generateParentTree(res);
|
|
||||||
return E.right(collectionParentTree);
|
|
||||||
} catch (error) {
|
|
||||||
E.left(TEAM_COLL_PARENT_TREE_GEN_FAILED);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Generate the parent tree from the collections
|
|
||||||
*
|
|
||||||
* @param parentCollections The parent collections
|
|
||||||
* @returns The parent tree of the parent collections
|
|
||||||
*/
|
|
||||||
private generateParentTree(parentCollections: ParentTreeQueryReturnType[]) {
|
|
||||||
function findChildren(id: string): CollectionSearchNode[] {
|
|
||||||
const collection = parentCollections.filter((item) => item.id === id)[0];
|
|
||||||
if (collection.parentID == null) {
|
|
||||||
return <CollectionSearchNode[]>[
|
|
||||||
{
|
|
||||||
id: collection.id,
|
|
||||||
title: collection.title,
|
|
||||||
type: 'collection' as const,
|
|
||||||
path: [],
|
|
||||||
},
|
|
||||||
];
|
|
||||||
}
|
|
||||||
|
|
||||||
const res = <CollectionSearchNode[]>[
|
|
||||||
{
|
|
||||||
id: collection.id,
|
|
||||||
title: collection.title,
|
|
||||||
type: 'collection' as const,
|
|
||||||
path: findChildren(collection.parentID),
|
|
||||||
},
|
|
||||||
];
|
|
||||||
return res;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (parentCollections.length > 0) {
|
|
||||||
if (parentCollections[0].parentID == null) {
|
|
||||||
return <CollectionSearchNode[]>[
|
|
||||||
{
|
|
||||||
id: parentCollections[0].id,
|
|
||||||
title: parentCollections[0].title,
|
|
||||||
type: 'collection',
|
|
||||||
path: [],
|
|
||||||
},
|
|
||||||
];
|
|
||||||
}
|
|
||||||
|
|
||||||
return <CollectionSearchNode[]>[
|
|
||||||
{
|
|
||||||
id: parentCollections[0].id,
|
|
||||||
title: parentCollections[0].title,
|
|
||||||
type: 'collection',
|
|
||||||
path: findChildren(parentCollections[0].parentID),
|
|
||||||
},
|
|
||||||
];
|
|
||||||
}
|
|
||||||
|
|
||||||
return <CollectionSearchNode[]>[];
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Generate the parent tree of a request
|
|
||||||
*
|
|
||||||
* @param id The ID of the request
|
|
||||||
* @returns The parent tree of the request
|
|
||||||
*/
|
|
||||||
private async fetchRequestParentTree(id: string) {
|
|
||||||
try {
|
|
||||||
const query = Prisma.sql`
|
|
||||||
WITH RECURSIVE request_collection_tree AS (
|
|
||||||
SELECT tc.id, tc."parentID", tc.title
|
|
||||||
FROM "TeamCollection" AS tc
|
|
||||||
JOIN "TeamRequest" AS tr ON tc.id = tr."collectionID"
|
|
||||||
WHERE tr.id = ${id}
|
|
||||||
|
|
||||||
UNION ALL
|
|
||||||
|
|
||||||
SELECT parent.id, parent."parentID", parent.title
|
|
||||||
FROM "TeamCollection" AS parent
|
|
||||||
JOIN request_collection_tree AS ct ON parent.id = ct."parentID"
|
|
||||||
)
|
|
||||||
SELECT * FROM request_collection_tree;
|
|
||||||
|
|
||||||
`;
|
|
||||||
const res = await this.prisma.$queryRaw<ParentTreeQueryReturnType[]>(
|
|
||||||
query,
|
|
||||||
);
|
|
||||||
|
|
||||||
const requestParentTree = this.generateParentTree(res);
|
|
||||||
return E.right(requestParentTree);
|
|
||||||
} catch (error) {
|
|
||||||
return E.left(TEAM_REQ_PARENT_TREE_GEN_FAILED);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,47 +0,0 @@
|
|||||||
import { CanActivate, ExecutionContext, Injectable } from '@nestjs/common';
|
|
||||||
import { Reflector } from '@nestjs/core';
|
|
||||||
import { TeamService } from '../../team/team.service';
|
|
||||||
import { TeamMemberRole } from '../../team/team.model';
|
|
||||||
import {
|
|
||||||
BUG_TEAM_NO_REQUIRE_TEAM_ROLE,
|
|
||||||
BUG_AUTH_NO_USER_CTX,
|
|
||||||
BUG_TEAM_NO_TEAM_ID,
|
|
||||||
TEAM_MEMBER_NOT_FOUND,
|
|
||||||
TEAM_NOT_REQUIRED_ROLE,
|
|
||||||
} from 'src/errors';
|
|
||||||
import { throwHTTPErr } from 'src/utils';
|
|
||||||
|
|
||||||
@Injectable()
|
|
||||||
export class RESTTeamMemberGuard implements CanActivate {
|
|
||||||
constructor(
|
|
||||||
private readonly reflector: Reflector,
|
|
||||||
private readonly teamService: TeamService,
|
|
||||||
) {}
|
|
||||||
|
|
||||||
async canActivate(context: ExecutionContext): Promise<boolean> {
|
|
||||||
const requireRoles = this.reflector.get<TeamMemberRole[]>(
|
|
||||||
'requiresTeamRole',
|
|
||||||
context.getHandler(),
|
|
||||||
);
|
|
||||||
if (!requireRoles)
|
|
||||||
throwHTTPErr({ message: BUG_TEAM_NO_REQUIRE_TEAM_ROLE, statusCode: 400 });
|
|
||||||
|
|
||||||
const request = context.switchToHttp().getRequest();
|
|
||||||
|
|
||||||
const { user } = request;
|
|
||||||
if (user == undefined)
|
|
||||||
throwHTTPErr({ message: BUG_AUTH_NO_USER_CTX, statusCode: 400 });
|
|
||||||
|
|
||||||
const teamID = request.params.teamID;
|
|
||||||
if (!teamID)
|
|
||||||
throwHTTPErr({ message: BUG_TEAM_NO_TEAM_ID, statusCode: 400 });
|
|
||||||
|
|
||||||
const teamMember = await this.teamService.getTeamMember(teamID, user.uid);
|
|
||||||
if (!teamMember)
|
|
||||||
throwHTTPErr({ message: TEAM_MEMBER_NOT_FOUND, statusCode: 404 });
|
|
||||||
|
|
||||||
if (requireRoles.includes(teamMember.role)) return true;
|
|
||||||
|
|
||||||
throwHTTPErr({ message: TEAM_NOT_REQUIRED_ROLE, statusCode: 403 });
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,10 +1,10 @@
|
|||||||
import { HttpStatus } from '@nestjs/common';
|
import { HttpStatus } from '@nestjs/common';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
** Custom interface to handle errors for REST modules such as Auth, Admin modules
|
** Custom interface to handle errors specific to Auth module
|
||||||
** Since its REST we need to return the HTTP status code along with the error message
|
** Since its REST we need to return the HTTP status code along with the error message
|
||||||
*/
|
*/
|
||||||
export type RESTError = {
|
export type AuthError = {
|
||||||
message: string;
|
message: string;
|
||||||
statusCode: HttpStatus;
|
statusCode: HttpStatus;
|
||||||
};
|
};
|
||||||
@@ -1,17 +0,0 @@
|
|||||||
// Response type of results from the search query
|
|
||||||
export type CollectionSearchNode = {
|
|
||||||
/** Encodes the hierarchy of where the node is **/
|
|
||||||
path: CollectionSearchNode[];
|
|
||||||
} & (
|
|
||||||
| {
|
|
||||||
type: 'request';
|
|
||||||
title: string;
|
|
||||||
method: string;
|
|
||||||
id: string;
|
|
||||||
}
|
|
||||||
| {
|
|
||||||
type: 'collection';
|
|
||||||
title: string;
|
|
||||||
id: string;
|
|
||||||
}
|
|
||||||
);
|
|
||||||
@@ -4,23 +4,26 @@ export enum InfraConfigEnum {
|
|||||||
|
|
||||||
GOOGLE_CLIENT_ID = 'GOOGLE_CLIENT_ID',
|
GOOGLE_CLIENT_ID = 'GOOGLE_CLIENT_ID',
|
||||||
GOOGLE_CLIENT_SECRET = 'GOOGLE_CLIENT_SECRET',
|
GOOGLE_CLIENT_SECRET = 'GOOGLE_CLIENT_SECRET',
|
||||||
GOOGLE_CALLBACK_URL = 'GOOGLE_CALLBACK_URL',
|
|
||||||
GOOGLE_SCOPE = 'GOOGLE_SCOPE',
|
|
||||||
|
|
||||||
GITHUB_CLIENT_ID = 'GITHUB_CLIENT_ID',
|
GITHUB_CLIENT_ID = 'GITHUB_CLIENT_ID',
|
||||||
GITHUB_CLIENT_SECRET = 'GITHUB_CLIENT_SECRET',
|
GITHUB_CLIENT_SECRET = 'GITHUB_CLIENT_SECRET',
|
||||||
GITHUB_CALLBACK_URL = 'GITHUB_CALLBACK_URL',
|
|
||||||
GITHUB_SCOPE = 'GITHUB_SCOPE',
|
|
||||||
|
|
||||||
MICROSOFT_CLIENT_ID = 'MICROSOFT_CLIENT_ID',
|
MICROSOFT_CLIENT_ID = 'MICROSOFT_CLIENT_ID',
|
||||||
MICROSOFT_CLIENT_SECRET = 'MICROSOFT_CLIENT_SECRET',
|
MICROSOFT_CLIENT_SECRET = 'MICROSOFT_CLIENT_SECRET',
|
||||||
MICROSOFT_CALLBACK_URL = 'MICROSOFT_CALLBACK_URL',
|
|
||||||
MICROSOFT_SCOPE = 'MICROSOFT_SCOPE',
|
|
||||||
MICROSOFT_TENANT = 'MICROSOFT_TENANT',
|
|
||||||
|
|
||||||
VITE_ALLOWED_AUTH_PROVIDERS = 'VITE_ALLOWED_AUTH_PROVIDERS',
|
VITE_ALLOWED_AUTH_PROVIDERS = 'VITE_ALLOWED_AUTH_PROVIDERS',
|
||||||
|
}
|
||||||
ALLOW_ANALYTICS_COLLECTION = 'ALLOW_ANALYTICS_COLLECTION',
|
|
||||||
ANALYTICS_USER_ID = 'ANALYTICS_USER_ID',
|
export enum InfraConfigEnumForClient {
|
||||||
IS_FIRST_TIME_INFRA_SETUP = 'IS_FIRST_TIME_INFRA_SETUP',
|
MAILER_SMTP_URL = 'MAILER_SMTP_URL',
|
||||||
|
MAILER_ADDRESS_FROM = 'MAILER_ADDRESS_FROM',
|
||||||
|
|
||||||
|
GOOGLE_CLIENT_ID = 'GOOGLE_CLIENT_ID',
|
||||||
|
GOOGLE_CLIENT_SECRET = 'GOOGLE_CLIENT_SECRET',
|
||||||
|
|
||||||
|
GITHUB_CLIENT_ID = 'GITHUB_CLIENT_ID',
|
||||||
|
GITHUB_CLIENT_SECRET = 'GITHUB_CLIENT_SECRET',
|
||||||
|
|
||||||
|
MICROSOFT_CLIENT_ID = 'MICROSOFT_CLIENT_ID',
|
||||||
|
MICROSOFT_CLIENT_SECRET = 'MICROSOFT_CLIENT_SECRET',
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -17,21 +17,3 @@ export class PaginationArgs {
|
|||||||
})
|
})
|
||||||
take: number;
|
take: number;
|
||||||
}
|
}
|
||||||
|
|
||||||
@ArgsType()
|
|
||||||
@InputType()
|
|
||||||
export class OffsetPaginationArgs {
|
|
||||||
@Field({
|
|
||||||
nullable: true,
|
|
||||||
defaultValue: 0,
|
|
||||||
description: 'Number of items to skip',
|
|
||||||
})
|
|
||||||
skip: number;
|
|
||||||
|
|
||||||
@Field({
|
|
||||||
nullable: true,
|
|
||||||
defaultValue: 10,
|
|
||||||
description: 'Number of items to fetch',
|
|
||||||
})
|
|
||||||
take: number;
|
|
||||||
}
|
|
||||||
|
|||||||
@@ -56,22 +56,3 @@ export enum SessionType {
|
|||||||
registerEnumType(SessionType, {
|
registerEnumType(SessionType, {
|
||||||
name: 'SessionType',
|
name: 'SessionType',
|
||||||
});
|
});
|
||||||
|
|
||||||
@ObjectType()
|
|
||||||
export class UserDeletionResult {
|
|
||||||
@Field(() => ID, {
|
|
||||||
description: 'UID of the user',
|
|
||||||
})
|
|
||||||
userUID: string;
|
|
||||||
|
|
||||||
@Field(() => Boolean, {
|
|
||||||
description: 'Flag to determine if user deletion was successful or not',
|
|
||||||
})
|
|
||||||
isDeleted: Boolean;
|
|
||||||
|
|
||||||
@Field({
|
|
||||||
nullable: true,
|
|
||||||
description: 'Error message if user deletion was not successful',
|
|
||||||
})
|
|
||||||
errorMessage: String;
|
|
||||||
}
|
|
||||||
|
|||||||
@@ -58,29 +58,6 @@ export class UserResolver {
|
|||||||
if (E.isLeft(updatedUser)) throwErr(updatedUser.left);
|
if (E.isLeft(updatedUser)) throwErr(updatedUser.left);
|
||||||
return updatedUser.right;
|
return updatedUser.right;
|
||||||
}
|
}
|
||||||
|
|
||||||
@Mutation(() => User, {
|
|
||||||
description: 'Update a users display name',
|
|
||||||
})
|
|
||||||
@UseGuards(GqlAuthGuard)
|
|
||||||
async updateDisplayName(
|
|
||||||
@GqlUser() user: AuthUser,
|
|
||||||
@Args({
|
|
||||||
name: 'updatedDisplayName',
|
|
||||||
description: 'New name of user',
|
|
||||||
type: () => String,
|
|
||||||
})
|
|
||||||
updatedDisplayName: string,
|
|
||||||
) {
|
|
||||||
const updatedUser = await this.userService.updateUserDisplayName(
|
|
||||||
user.uid,
|
|
||||||
updatedDisplayName,
|
|
||||||
);
|
|
||||||
|
|
||||||
if (E.isLeft(updatedUser)) throwErr(updatedUser.left);
|
|
||||||
return updatedUser.right;
|
|
||||||
}
|
|
||||||
|
|
||||||
@Mutation(() => Boolean, {
|
@Mutation(() => Boolean, {
|
||||||
description: 'Delete an user account',
|
description: 'Delete an user account',
|
||||||
})
|
})
|
||||||
|
|||||||
@@ -1,9 +1,4 @@
|
|||||||
import {
|
import { JSON_INVALID, USER_NOT_FOUND } from 'src/errors';
|
||||||
JSON_INVALID,
|
|
||||||
USERS_NOT_FOUND,
|
|
||||||
USER_NOT_FOUND,
|
|
||||||
USER_SHORT_DISPLAY_NAME,
|
|
||||||
} from 'src/errors';
|
|
||||||
import { mockDeep, mockReset } from 'jest-mock-extended';
|
import { mockDeep, mockReset } from 'jest-mock-extended';
|
||||||
import { PrismaService } from 'src/prisma/prisma.service';
|
import { PrismaService } from 'src/prisma/prisma.service';
|
||||||
import { AuthUser } from 'src/types/AuthUser';
|
import { AuthUser } from 'src/types/AuthUser';
|
||||||
@@ -181,26 +176,6 @@ describe('UserService', () => {
|
|||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
describe('findUsersByIds', () => {
|
|
||||||
test('should successfully return users given valid user UIDs', async () => {
|
|
||||||
mockPrisma.user.findMany.mockResolvedValueOnce(users);
|
|
||||||
|
|
||||||
const result = await userService.findUsersByIds([
|
|
||||||
'123344',
|
|
||||||
'5555',
|
|
||||||
'6666',
|
|
||||||
]);
|
|
||||||
expect(result).toEqual(users);
|
|
||||||
});
|
|
||||||
|
|
||||||
test('should return empty array of users given a invalid user UIDs', async () => {
|
|
||||||
mockPrisma.user.findMany.mockResolvedValueOnce([]);
|
|
||||||
|
|
||||||
const result = await userService.findUsersByIds(['sdcvbdbr']);
|
|
||||||
expect(result).toEqual([]);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('createUserViaMagicLink', () => {
|
describe('createUserViaMagicLink', () => {
|
||||||
test('should successfully create user and account for magic-link given valid inputs', async () => {
|
test('should successfully create user and account for magic-link given valid inputs', async () => {
|
||||||
mockPrisma.user.create.mockResolvedValueOnce(user);
|
mockPrisma.user.create.mockResolvedValueOnce(user);
|
||||||
@@ -439,62 +414,6 @@ describe('UserService', () => {
|
|||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
describe('updateUserDisplayName', () => {
|
|
||||||
test('should resolve right and update user display name', async () => {
|
|
||||||
const newDisplayName = 'New Name';
|
|
||||||
mockPrisma.user.update.mockResolvedValueOnce({
|
|
||||||
...user,
|
|
||||||
displayName: newDisplayName,
|
|
||||||
});
|
|
||||||
|
|
||||||
const result = await userService.updateUserDisplayName(
|
|
||||||
user.uid,
|
|
||||||
newDisplayName,
|
|
||||||
);
|
|
||||||
expect(result).toEqualRight({
|
|
||||||
...user,
|
|
||||||
displayName: newDisplayName,
|
|
||||||
currentGQLSession: JSON.stringify(user.currentGQLSession),
|
|
||||||
currentRESTSession: JSON.stringify(user.currentRESTSession),
|
|
||||||
});
|
|
||||||
});
|
|
||||||
test('should resolve right and publish user updated subscription', async () => {
|
|
||||||
const newDisplayName = 'New Name';
|
|
||||||
mockPrisma.user.update.mockResolvedValueOnce({
|
|
||||||
...user,
|
|
||||||
displayName: newDisplayName,
|
|
||||||
});
|
|
||||||
|
|
||||||
await userService.updateUserDisplayName(user.uid, user.displayName);
|
|
||||||
expect(mockPubSub.publish).toHaveBeenCalledWith(
|
|
||||||
`user/${user.uid}/updated`,
|
|
||||||
{
|
|
||||||
...user,
|
|
||||||
displayName: newDisplayName,
|
|
||||||
currentGQLSession: JSON.stringify(user.currentGQLSession),
|
|
||||||
currentRESTSession: JSON.stringify(user.currentRESTSession),
|
|
||||||
},
|
|
||||||
);
|
|
||||||
});
|
|
||||||
test('should resolve left and error when invalid user uid is passed', async () => {
|
|
||||||
mockPrisma.user.update.mockRejectedValueOnce('NotFoundError');
|
|
||||||
|
|
||||||
const result = await userService.updateUserDisplayName(
|
|
||||||
'invalidUserUid',
|
|
||||||
user.displayName,
|
|
||||||
);
|
|
||||||
expect(result).toEqualLeft(USER_NOT_FOUND);
|
|
||||||
});
|
|
||||||
test('should resolve left and error when short display name is passed', async () => {
|
|
||||||
const newDisplayName = '';
|
|
||||||
const result = await userService.updateUserDisplayName(
|
|
||||||
user.uid,
|
|
||||||
newDisplayName,
|
|
||||||
);
|
|
||||||
expect(result).toEqualLeft(USER_SHORT_DISPLAY_NAME);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('fetchAllUsers', () => {
|
describe('fetchAllUsers', () => {
|
||||||
test('should resolve right and return 20 users when cursor is null', async () => {
|
test('should resolve right and return 20 users when cursor is null', async () => {
|
||||||
mockPrisma.user.findMany.mockResolvedValueOnce(users);
|
mockPrisma.user.findMany.mockResolvedValueOnce(users);
|
||||||
@@ -516,36 +435,6 @@ describe('UserService', () => {
|
|||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
describe('fetchAllUsersV2', () => {
|
|
||||||
test('should resolve right and return first 20 users when searchString is null', async () => {
|
|
||||||
mockPrisma.user.findMany.mockResolvedValueOnce(users);
|
|
||||||
|
|
||||||
const result = await userService.fetchAllUsersV2(null, {
|
|
||||||
take: 20,
|
|
||||||
skip: 0,
|
|
||||||
});
|
|
||||||
expect(result).toEqual(users);
|
|
||||||
});
|
|
||||||
test('should resolve right and return next 20 users when searchString is provided', async () => {
|
|
||||||
mockPrisma.user.findMany.mockResolvedValueOnce(users);
|
|
||||||
|
|
||||||
const result = await userService.fetchAllUsersV2('.com', {
|
|
||||||
take: 20,
|
|
||||||
skip: 0,
|
|
||||||
});
|
|
||||||
expect(result).toEqual(users);
|
|
||||||
});
|
|
||||||
test('should resolve left and return an empty array when users not found', async () => {
|
|
||||||
mockPrisma.user.findMany.mockResolvedValueOnce([]);
|
|
||||||
|
|
||||||
const result = await userService.fetchAllUsersV2('Unknown entry', {
|
|
||||||
take: 20,
|
|
||||||
skip: 0,
|
|
||||||
});
|
|
||||||
expect(result).toEqual([]);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('fetchAdminUsers', () => {
|
describe('fetchAdminUsers', () => {
|
||||||
test('should return a list of admin users', async () => {
|
test('should return a list of admin users', async () => {
|
||||||
mockPrisma.user.findMany.mockResolvedValueOnce(adminUsers);
|
mockPrisma.user.findMany.mockResolvedValueOnce(adminUsers);
|
||||||
@@ -667,17 +556,4 @@ describe('UserService', () => {
|
|||||||
expect(result).toEqual(10);
|
expect(result).toEqual(10);
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
describe('removeUsersAsAdmin', () => {
|
|
||||||
test('should resolve right and return true for valid user UIDs', async () => {
|
|
||||||
mockPrisma.user.updateMany.mockResolvedValueOnce({ count: 1 });
|
|
||||||
const result = await userService.removeUsersAsAdmin(['123344']);
|
|
||||||
expect(result).toEqualRight(true);
|
|
||||||
});
|
|
||||||
test('should resolve right and return false for invalid user UIDs', async () => {
|
|
||||||
mockPrisma.user.updateMany.mockResolvedValueOnce({ count: 0 });
|
|
||||||
const result = await userService.removeUsersAsAdmin(['123344']);
|
|
||||||
expect(result).toEqualLeft(USERS_NOT_FOUND);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -8,18 +8,13 @@ import * as T from 'fp-ts/Task';
|
|||||||
import * as A from 'fp-ts/Array';
|
import * as A from 'fp-ts/Array';
|
||||||
import { pipe, constVoid } from 'fp-ts/function';
|
import { pipe, constVoid } from 'fp-ts/function';
|
||||||
import { AuthUser } from 'src/types/AuthUser';
|
import { AuthUser } from 'src/types/AuthUser';
|
||||||
import {
|
import { USER_NOT_FOUND } from 'src/errors';
|
||||||
USERS_NOT_FOUND,
|
|
||||||
USER_NOT_FOUND,
|
|
||||||
USER_SHORT_DISPLAY_NAME,
|
|
||||||
} from 'src/errors';
|
|
||||||
import { SessionType, User } from './user.model';
|
import { SessionType, User } from './user.model';
|
||||||
import { USER_UPDATE_FAILED } from 'src/errors';
|
import { USER_UPDATE_FAILED } from 'src/errors';
|
||||||
import { PubSubService } from 'src/pubsub/pubsub.service';
|
import { PubSubService } from 'src/pubsub/pubsub.service';
|
||||||
import { stringToJson, taskEitherValidateArraySeq } from 'src/utils';
|
import { stringToJson, taskEitherValidateArraySeq } from 'src/utils';
|
||||||
import { UserDataHandler } from './user.data.handler';
|
import { UserDataHandler } from './user.data.handler';
|
||||||
import { User as DbUser } from '@prisma/client';
|
import { User as DbUser } from '@prisma/client';
|
||||||
import { OffsetPaginationArgs } from 'src/types/input-types.args';
|
|
||||||
|
|
||||||
@Injectable()
|
@Injectable()
|
||||||
export class UserService {
|
export class UserService {
|
||||||
@@ -93,20 +88,6 @@ export class UserService {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Find users with given IDs
|
|
||||||
* @param userUIDs User IDs
|
|
||||||
* @returns Array of found Users
|
|
||||||
*/
|
|
||||||
async findUsersByIds(userUIDs: string[]): Promise<AuthUser[]> {
|
|
||||||
const users = await this.prisma.user.findMany({
|
|
||||||
where: {
|
|
||||||
uid: { in: userUIDs },
|
|
||||||
},
|
|
||||||
});
|
|
||||||
return users;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Update User with new generated hashed refresh token
|
* Update User with new generated hashed refresh token
|
||||||
*
|
*
|
||||||
@@ -288,34 +269,6 @@ export class UserService {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Update a user's data
|
|
||||||
* @param userUID User UID
|
|
||||||
* @param displayName User's displayName
|
|
||||||
* @returns a Either of User or error
|
|
||||||
*/
|
|
||||||
async updateUserDisplayName(userUID: string, displayName: string) {
|
|
||||||
if (!displayName || displayName.length === 0) {
|
|
||||||
return E.left(USER_SHORT_DISPLAY_NAME);
|
|
||||||
}
|
|
||||||
|
|
||||||
try {
|
|
||||||
const dbUpdatedUser = await this.prisma.user.update({
|
|
||||||
where: { uid: userUID },
|
|
||||||
data: { displayName },
|
|
||||||
});
|
|
||||||
|
|
||||||
const updatedUser = this.convertDbUserToUser(dbUpdatedUser);
|
|
||||||
|
|
||||||
// Publish subscription for user updates
|
|
||||||
await this.pubsub.publish(`user/${updatedUser.uid}/updated`, updatedUser);
|
|
||||||
|
|
||||||
return E.right(updatedUser);
|
|
||||||
} catch (error) {
|
|
||||||
return E.left(USER_NOT_FOUND);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Validate and parse currentRESTSession and currentGQLSession
|
* Validate and parse currentRESTSession and currentGQLSession
|
||||||
* @param sessionData string of the session
|
* @param sessionData string of the session
|
||||||
@@ -333,7 +286,6 @@ export class UserService {
|
|||||||
* @param cursorID string of userUID or null
|
* @param cursorID string of userUID or null
|
||||||
* @param take number of users to query
|
* @param take number of users to query
|
||||||
* @returns an array of `User` object
|
* @returns an array of `User` object
|
||||||
* @deprecated use fetchAllUsersV2 instead
|
|
||||||
*/
|
*/
|
||||||
async fetchAllUsers(cursorID: string, take: number) {
|
async fetchAllUsers(cursorID: string, take: number) {
|
||||||
const fetchedUsers = await this.prisma.user.findMany({
|
const fetchedUsers = await this.prisma.user.findMany({
|
||||||
@@ -344,43 +296,6 @@ export class UserService {
|
|||||||
return fetchedUsers;
|
return fetchedUsers;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Fetch all the users in the `User` table based on cursor
|
|
||||||
* @param searchString search on user's displayName or email
|
|
||||||
* @param paginationOption pagination options
|
|
||||||
* @returns an array of `User` object
|
|
||||||
*/
|
|
||||||
async fetchAllUsersV2(
|
|
||||||
searchString: string,
|
|
||||||
paginationOption: OffsetPaginationArgs,
|
|
||||||
) {
|
|
||||||
const fetchedUsers = await this.prisma.user.findMany({
|
|
||||||
skip: paginationOption.skip,
|
|
||||||
take: paginationOption.take,
|
|
||||||
where: searchString
|
|
||||||
? {
|
|
||||||
OR: [
|
|
||||||
{
|
|
||||||
displayName: {
|
|
||||||
contains: searchString,
|
|
||||||
mode: 'insensitive',
|
|
||||||
},
|
|
||||||
},
|
|
||||||
{
|
|
||||||
email: {
|
|
||||||
contains: searchString,
|
|
||||||
mode: 'insensitive',
|
|
||||||
},
|
|
||||||
},
|
|
||||||
],
|
|
||||||
}
|
|
||||||
: undefined,
|
|
||||||
orderBy: [{ isAdmin: 'desc' }, { displayName: 'asc' }],
|
|
||||||
});
|
|
||||||
|
|
||||||
return fetchedUsers;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Fetch the number of users in db
|
* Fetch the number of users in db
|
||||||
* @returns a count (Int) of user records in DB
|
* @returns a count (Int) of user records in DB
|
||||||
@@ -411,23 +326,6 @@ export class UserService {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Change users to admins by toggling isAdmin param to true
|
|
||||||
* @param userUID user UIDs
|
|
||||||
* @returns a Either of true or error
|
|
||||||
*/
|
|
||||||
async makeAdmins(userUIDs: string[]) {
|
|
||||||
try {
|
|
||||||
await this.prisma.user.updateMany({
|
|
||||||
where: { uid: { in: userUIDs } },
|
|
||||||
data: { isAdmin: true },
|
|
||||||
});
|
|
||||||
return E.right(true);
|
|
||||||
} catch (error) {
|
|
||||||
return E.left(USER_UPDATE_FAILED);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Fetch all the admin users
|
* Fetch all the admin users
|
||||||
* @returns an array of admin users
|
* @returns an array of admin users
|
||||||
@@ -546,22 +444,4 @@ export class UserService {
|
|||||||
return E.left(USER_NOT_FOUND);
|
return E.left(USER_NOT_FOUND);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Change users from an admin by toggling isAdmin param to false
|
|
||||||
* @param userUIDs user UIDs
|
|
||||||
* @returns a Either of true or error
|
|
||||||
*/
|
|
||||||
async removeUsersAsAdmin(userUIDs: string[]) {
|
|
||||||
const data = await this.prisma.user.updateMany({
|
|
||||||
where: { uid: { in: userUIDs } },
|
|
||||||
data: { isAdmin: false },
|
|
||||||
});
|
|
||||||
|
|
||||||
if (data.count === 0) {
|
|
||||||
return E.left(USERS_NOT_FOUND);
|
|
||||||
}
|
|
||||||
|
|
||||||
return E.right(true);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
import { ExecutionContext, HttpException } from '@nestjs/common';
|
import { ExecutionContext } from '@nestjs/common';
|
||||||
import { Reflector } from '@nestjs/core';
|
import { Reflector } from '@nestjs/core';
|
||||||
import { GqlExecutionContext } from '@nestjs/graphql';
|
import { GqlExecutionContext } from '@nestjs/graphql';
|
||||||
import { pipe } from 'fp-ts/lib/function';
|
import { pipe } from 'fp-ts/lib/function';
|
||||||
@@ -16,7 +16,6 @@ import {
|
|||||||
JSON_INVALID,
|
JSON_INVALID,
|
||||||
} from './errors';
|
} from './errors';
|
||||||
import { AuthProvider } from './auth/helper';
|
import { AuthProvider } from './auth/helper';
|
||||||
import { RESTError } from './types/RESTError';
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* A workaround to throw an exception in an expression.
|
* A workaround to throw an exception in an expression.
|
||||||
@@ -28,15 +27,6 @@ export function throwErr(errMessage: string): never {
|
|||||||
throw new Error(errMessage);
|
throw new Error(errMessage);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* This function allows throw to be used as an expression
|
|
||||||
* @param errMessage Message present in the error message
|
|
||||||
*/
|
|
||||||
export function throwHTTPErr(errorData: RESTError): never {
|
|
||||||
const { message, statusCode } = errorData;
|
|
||||||
throw new HttpException(message, statusCode);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Prints the given value to log and returns the same value.
|
* Prints the given value to log and returns the same value.
|
||||||
* Used for debugging functional pipelines.
|
* Used for debugging functional pipelines.
|
||||||
@@ -141,28 +131,6 @@ export const validateEmail = (email: string) => {
|
|||||||
).test(email);
|
).test(email);
|
||||||
};
|
};
|
||||||
|
|
||||||
// Regular expressions for supported address object formats by nodemailer
|
|
||||||
// check out for more info https://nodemailer.com/message/addresses
|
|
||||||
const emailRegex1 = /^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$/;
|
|
||||||
const emailRegex2 =
|
|
||||||
/^[\w\s]* <([a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,})>$/;
|
|
||||||
const emailRegex3 =
|
|
||||||
/^"[\w\s]+" <([a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,})>$/;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Checks to see if the SMTP email is valid or not
|
|
||||||
* @param email
|
|
||||||
* @returns A Boolean depending on the format of the email
|
|
||||||
*/
|
|
||||||
export const validateSMTPEmail = (email: string) => {
|
|
||||||
// Check if the input matches any of the formats
|
|
||||||
return (
|
|
||||||
emailRegex1.test(email) ||
|
|
||||||
emailRegex2.test(email) ||
|
|
||||||
emailRegex3.test(email)
|
|
||||||
);
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Checks to see if the URL is valid or not
|
* Checks to see if the URL is valid or not
|
||||||
* @param url The URL to validate
|
* @param url The URL to validate
|
||||||
@@ -183,16 +151,6 @@ export const validateSMTPUrl = (url: string) => {
|
|||||||
return false;
|
return false;
|
||||||
};
|
};
|
||||||
|
|
||||||
/**
|
|
||||||
* Checks to see if the URL is valid or not
|
|
||||||
* @param url The URL to validate
|
|
||||||
* @returns boolean
|
|
||||||
*/
|
|
||||||
export const validateUrl = (url: string) => {
|
|
||||||
const urlRegex = /^(http|https):\/\/[^ "]+$/;
|
|
||||||
return urlRegex.test(url);
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* String to JSON parser
|
* String to JSON parser
|
||||||
* @param {str} str The string to parse
|
* @param {str} str The string to parse
|
||||||
@@ -250,39 +208,3 @@ export function checkEnvironmentAuthProvider(
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Adds escape backslashes to the input so that it can be used inside
|
|
||||||
* SQL LIKE/ILIKE queries. Inspired by PHP's `mysql_real_escape_string`
|
|
||||||
* function.
|
|
||||||
*
|
|
||||||
* Eg. "100%" -> "100\\%"
|
|
||||||
*
|
|
||||||
* Source: https://stackoverflow.com/a/32648526
|
|
||||||
*/
|
|
||||||
export function escapeSqlLikeString(str: string) {
|
|
||||||
if (typeof str != 'string') return str;
|
|
||||||
|
|
||||||
return str.replace(/[\0\x08\x09\x1a\n\r"'\\\%]/g, function (char) {
|
|
||||||
switch (char) {
|
|
||||||
case '\0':
|
|
||||||
return '\\0';
|
|
||||||
case '\x08':
|
|
||||||
return '\\b';
|
|
||||||
case '\x09':
|
|
||||||
return '\\t';
|
|
||||||
case '\x1a':
|
|
||||||
return '\\z';
|
|
||||||
case '\n':
|
|
||||||
return '\\n';
|
|
||||||
case '\r':
|
|
||||||
return '\\r';
|
|
||||||
case '"':
|
|
||||||
case "'":
|
|
||||||
case '\\':
|
|
||||||
case '%':
|
|
||||||
return '\\' + char; // prepends a backslash to backslash, percent,
|
|
||||||
// and double/single quotes
|
|
||||||
}
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|||||||
@@ -52,34 +52,11 @@ hopp [options or commands] arguments
|
|||||||
Taking the above example, `pw.env.get("ENV1")` will return `"value1"`
|
Taking the above example, `pw.env.get("ENV1")` will return `"value1"`
|
||||||
|
|
||||||
## Install
|
## Install
|
||||||
- Before you install Hoppscotch CLI you need to make sure you have the dependencies it requires to run.
|
|
||||||
- **Windows & macOS**: You will need `node-gyp` installed. Find instructions here: https://github.com/nodejs/node-gyp
|
|
||||||
- **Debian/Ubuntu derivatives**:
|
|
||||||
```sh
|
|
||||||
sudo apt-get install python g++ build-essential
|
|
||||||
```
|
|
||||||
- **Alpine Linux**:
|
|
||||||
```sh
|
|
||||||
sudo apk add python3 make g++
|
|
||||||
```
|
|
||||||
- **Amazon Linux (AMI)**
|
|
||||||
```sh
|
|
||||||
sudo yum install gcc72 gcc72-c++
|
|
||||||
```
|
|
||||||
- **Arch Linux**
|
|
||||||
```sh
|
|
||||||
sudo pacman -S make gcc python
|
|
||||||
```
|
|
||||||
- **RHEL/Fedora derivatives**:
|
|
||||||
```sh
|
|
||||||
sudo dnf install python3 make gcc gcc-c++ zlib-devel brotli-devel openssl-devel libuv-devel
|
|
||||||
```
|
|
||||||
|
|
||||||
|
Install [@hoppscotch/cli](https://www.npmjs.com/package/@hoppscotch/cli) from npm by running:
|
||||||
- Once the dependencies are installed, install [@hoppscotch/cli](https://www.npmjs.com/package/@hoppscotch/cli) from npm by running:
|
```
|
||||||
```
|
npm i -g @hoppscotch/cli
|
||||||
npm i -g @hoppscotch/cli
|
```
|
||||||
```
|
|
||||||
|
|
||||||
## **Developing:**
|
## **Developing:**
|
||||||
|
|
||||||
|
|||||||
3
packages/hoppscotch-cli/bin/hopp
Executable file
3
packages/hoppscotch-cli/bin/hopp
Executable file
@@ -0,0 +1,3 @@
|
|||||||
|
#!/usr/bin/env node
|
||||||
|
// * The entry point of the CLI
|
||||||
|
require("../dist").cli(process.argv);
|
||||||
@@ -1,31 +0,0 @@
|
|||||||
#!/usr/bin/env node
|
|
||||||
// * The entry point of the CLI
|
|
||||||
// @ts-check
|
|
||||||
|
|
||||||
import { cli } from "../dist/index.js";
|
|
||||||
|
|
||||||
import { spawnSync } from "child_process";
|
|
||||||
import { cloneDeep } from "lodash-es";
|
|
||||||
|
|
||||||
const nodeVersion = parseInt(process.versions.node.split(".")[0]);
|
|
||||||
|
|
||||||
// As per isolated-vm documentation, we need to supply `--no-node-snapshot` for node >= 20
|
|
||||||
// src: https://github.com/laverdet/isolated-vm?tab=readme-ov-file#requirements
|
|
||||||
if (nodeVersion >= 20 && !process.execArgv.includes("--no-node-snapshot")) {
|
|
||||||
const argCopy = cloneDeep(process.argv);
|
|
||||||
|
|
||||||
// Replace first argument with --no-node-snapshot
|
|
||||||
// We can get argv[0] from process.argv0
|
|
||||||
argCopy[0] = "--no-node-snapshot";
|
|
||||||
|
|
||||||
const result = spawnSync(
|
|
||||||
process.argv0,
|
|
||||||
argCopy,
|
|
||||||
{ stdio: "inherit" }
|
|
||||||
);
|
|
||||||
|
|
||||||
// Exit with the same status code as the spawned process
|
|
||||||
process.exit(result.status ?? 0);
|
|
||||||
} else {
|
|
||||||
cli(process.argv);
|
|
||||||
}
|
|
||||||
@@ -1,12 +1,11 @@
|
|||||||
{
|
{
|
||||||
"name": "@hoppscotch/cli",
|
"name": "@hoppscotch/cli",
|
||||||
"version": "0.8.0",
|
"version": "0.4.0",
|
||||||
"description": "A CLI to run Hoppscotch test scripts in CI environments.",
|
"description": "A CLI to run Hoppscotch test scripts in CI environments.",
|
||||||
"homepage": "https://hoppscotch.io",
|
"homepage": "https://hoppscotch.io",
|
||||||
"type": "module",
|
|
||||||
"main": "dist/index.js",
|
"main": "dist/index.js",
|
||||||
"bin": {
|
"bin": {
|
||||||
"hopp": "bin/hopp.js"
|
"hopp": "bin/hopp"
|
||||||
},
|
},
|
||||||
"publishConfig": {
|
"publishConfig": {
|
||||||
"access": "public"
|
"access": "public"
|
||||||
@@ -40,30 +39,27 @@
|
|||||||
},
|
},
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"private": false,
|
"private": false,
|
||||||
"dependencies": {
|
|
||||||
"axios": "1.6.7",
|
|
||||||
"chalk": "5.3.0",
|
|
||||||
"commander": "11.1.0",
|
|
||||||
"isolated-vm": "4.7.2",
|
|
||||||
"lodash-es": "4.17.21",
|
|
||||||
"qs": "6.11.2",
|
|
||||||
"verzod": "0.2.2",
|
|
||||||
"zod": "3.22.4"
|
|
||||||
},
|
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@hoppscotch/data": "workspace:^",
|
"@hoppscotch/data": "workspace:^",
|
||||||
"@hoppscotch/js-sandbox": "workspace:^",
|
"@hoppscotch/js-sandbox": "workspace:^",
|
||||||
"@relmify/jest-fp-ts": "2.1.1",
|
"@relmify/jest-fp-ts": "^2.1.1",
|
||||||
"@swc/core": "1.4.2",
|
"@swc/core": "^1.3.92",
|
||||||
"@types/jest": "29.5.12",
|
"@types/jest": "^29.5.5",
|
||||||
"@types/lodash-es": "4.17.12",
|
"@types/lodash": "^4.14.199",
|
||||||
"@types/qs": "6.9.12",
|
"@types/qs": "^6.9.8",
|
||||||
"fp-ts": "2.16.2",
|
"axios": "^0.21.4",
|
||||||
"jest": "29.7.0",
|
"chalk": "^4.1.2",
|
||||||
"prettier": "3.2.5",
|
"commander": "^11.0.0",
|
||||||
"qs": "6.11.2",
|
"esm": "^3.2.25",
|
||||||
"ts-jest": "29.1.2",
|
"fp-ts": "^2.16.1",
|
||||||
"tsup": "8.0.2",
|
"io-ts": "^2.2.20",
|
||||||
"typescript": "5.3.3"
|
"jest": "^29.7.0",
|
||||||
|
"lodash": "^4.17.21",
|
||||||
|
"prettier": "^3.0.3",
|
||||||
|
"qs": "^6.11.2",
|
||||||
|
"ts-jest": "^29.1.1",
|
||||||
|
"tsup": "^7.2.0",
|
||||||
|
"typescript": "^5.2.2",
|
||||||
|
"zod": "^3.22.4"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,344 +1,140 @@
|
|||||||
import { ExecException } from "child_process";
|
import { ExecException } from "child_process";
|
||||||
|
|
||||||
import { HoppErrorCode } from "../../types/errors";
|
import { HoppErrorCode } from "../../types/errors";
|
||||||
import { runCLI, getErrorCode, getTestJsonFilePath } from "../utils";
|
import { execAsync, getErrorCode, getTestJsonFilePath } from "../utils";
|
||||||
|
|
||||||
describe("Test `hopp test <file>` command:", () => {
|
describe("Test 'hopp test <file>' command:", () => {
|
||||||
describe("Argument parsing", () => {
|
test("No collection file path provided.", async () => {
|
||||||
test("Errors with the code `INVALID_ARGUMENT` for not supplying enough arguments", async () => {
|
const cmd = `node ./bin/hopp test`;
|
||||||
const args = "test";
|
const { stderr } = await execAsync(cmd);
|
||||||
const { stderr } = await runCLI(args);
|
const out = getErrorCode(stderr);
|
||||||
|
|
||||||
const out = getErrorCode(stderr);
|
expect(out).toBe<HoppErrorCode>("INVALID_ARGUMENT");
|
||||||
expect(out).toBe<HoppErrorCode>("INVALID_ARGUMENT");
|
|
||||||
});
|
|
||||||
|
|
||||||
test("Errors with the code `INVALID_ARGUMENT` for an invalid command", async () => {
|
|
||||||
const args = "invalid-arg";
|
|
||||||
const { stderr } = await runCLI(args);
|
|
||||||
|
|
||||||
const out = getErrorCode(stderr);
|
|
||||||
expect(out).toBe<HoppErrorCode>("INVALID_ARGUMENT");
|
|
||||||
});
|
|
||||||
});
|
});
|
||||||
|
|
||||||
describe("Supplied collection export file validations", () => {
|
test("Collection file not found.", async () => {
|
||||||
test("Errors with the code `FILE_NOT_FOUND` if the supplied collection export file doesn't exist", async () => {
|
const cmd = `node ./bin/hopp test notfound.json`;
|
||||||
const args = "test notfound.json";
|
const { stderr } = await execAsync(cmd);
|
||||||
const { stderr } = await runCLI(args);
|
const out = getErrorCode(stderr);
|
||||||
|
|
||||||
const out = getErrorCode(stderr);
|
expect(out).toBe<HoppErrorCode>("FILE_NOT_FOUND");
|
||||||
expect(out).toBe<HoppErrorCode>("FILE_NOT_FOUND");
|
|
||||||
});
|
|
||||||
|
|
||||||
test("Errors with the code UNKNOWN_ERROR if the supplied collection export file content isn't valid JSON", async () => {
|
|
||||||
const args = `test ${getTestJsonFilePath("malformed-coll.json", "collection")}`;
|
|
||||||
const { stderr } = await runCLI(args);
|
|
||||||
|
|
||||||
const out = getErrorCode(stderr);
|
|
||||||
expect(out).toBe<HoppErrorCode>("UNKNOWN_ERROR");
|
|
||||||
});
|
|
||||||
|
|
||||||
test("Errors with the code `MALFORMED_COLLECTION` if the supplied collection export file content is malformed", async () => {
|
|
||||||
const args = `test ${getTestJsonFilePath("malformed-coll-2.json", "collection")}`;
|
|
||||||
const { stderr } = await runCLI(args);
|
|
||||||
|
|
||||||
const out = getErrorCode(stderr);
|
|
||||||
expect(out).toBe<HoppErrorCode>("MALFORMED_COLLECTION");
|
|
||||||
});
|
|
||||||
|
|
||||||
test("Errors with the code `INVALID_FILE_TYPE` if the supplied collection export file doesn't end with the `.json` extension", async () => {
|
|
||||||
const args = `test ${getTestJsonFilePath("notjson-coll.txt", "collection")}`;
|
|
||||||
const { stderr } = await runCLI(args);
|
|
||||||
|
|
||||||
const out = getErrorCode(stderr);
|
|
||||||
expect(out).toBe<HoppErrorCode>("INVALID_FILE_TYPE");
|
|
||||||
});
|
|
||||||
|
|
||||||
test("Fails if the collection file includes scripts with incorrect API usage and failed assertions", async () => {
|
|
||||||
const args = `test ${getTestJsonFilePath("fails-coll.json", "collection")}`;
|
|
||||||
const { error } = await runCLI(args);
|
|
||||||
|
|
||||||
expect(error).not.toBeNull();
|
|
||||||
expect(error).toMatchObject(<ExecException>{
|
|
||||||
code: 1,
|
|
||||||
});
|
|
||||||
});
|
|
||||||
});
|
});
|
||||||
|
|
||||||
describe("Versioned entities", () => {
|
test("Collection file is invalid JSON.", async () => {
|
||||||
describe("Collections & Requests", () => {
|
const cmd = `node ./bin/hopp test ${getTestJsonFilePath(
|
||||||
const testFixtures = [
|
"malformed-collection.json"
|
||||||
{ fileName: "coll-v1-req-v0.json", collVersion: 1, reqVersion: 0 },
|
|
||||||
{ fileName: "coll-v1-req-v1.json", collVersion: 1, reqVersion: 1 },
|
|
||||||
{ fileName: "coll-v2-req-v2.json", collVersion: 2, reqVersion: 2 },
|
|
||||||
{ fileName: "coll-v2-req-v3.json", collVersion: 2, reqVersion: 3 },
|
|
||||||
];
|
|
||||||
|
|
||||||
testFixtures.forEach(({ collVersion, fileName, reqVersion }) => {
|
|
||||||
test(`Successfully processes a supplied collection export file where the collection is based on the "v${collVersion}" schema and the request following the "v${reqVersion}" schema`, async () => {
|
|
||||||
const args = `test ${getTestJsonFilePath(fileName, "collection")}`;
|
|
||||||
const { error } = await runCLI(args);
|
|
||||||
|
|
||||||
expect(error).toBeNull();
|
|
||||||
});
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe("Environments", () => {
|
|
||||||
const testFixtures = [
|
|
||||||
{ fileName: "env-v0.json", version: 0 },
|
|
||||||
{ fileName: "env-v1.json", version: 1 },
|
|
||||||
];
|
|
||||||
|
|
||||||
testFixtures.forEach(({ fileName, version }) => {
|
|
||||||
test(`Successfully processes the supplied collection and environment export files where the environment is based on the "v${version}" schema`, async () => {
|
|
||||||
const ENV_PATH = getTestJsonFilePath(fileName, "environment");
|
|
||||||
const args = `test ${getTestJsonFilePath("sample-coll.json", "collection")} --env ${ENV_PATH}`;
|
|
||||||
const { error } = await runCLI(args);
|
|
||||||
|
|
||||||
expect(error).toBeNull();
|
|
||||||
});
|
|
||||||
});
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
test("Successfully processes a supplied collection export file of the expected format", async () => {
|
|
||||||
const args = `test ${getTestJsonFilePath("passes-coll.json", "collection")}`;
|
|
||||||
const { error } = await runCLI(args);
|
|
||||||
|
|
||||||
expect(error).toBeNull();
|
|
||||||
});
|
|
||||||
|
|
||||||
test("Successfully inherits headers and authorization set at the root collection", async () => {
|
|
||||||
const args = `test ${getTestJsonFilePath(
|
|
||||||
"collection-level-headers-auth-coll.json",
|
|
||||||
"collection"
|
|
||||||
)}`;
|
)}`;
|
||||||
const { error } = await runCLI(args);
|
const { stderr } = await execAsync(cmd);
|
||||||
|
const out = getErrorCode(stderr);
|
||||||
|
|
||||||
expect(error).toBeNull();
|
expect(out).toBe<HoppErrorCode>("UNKNOWN_ERROR");
|
||||||
});
|
});
|
||||||
|
|
||||||
test("Persists environment variables set in the pre-request script for consumption in the test script", async () => {
|
test("Malformed collection file.", async () => {
|
||||||
const args = `test ${getTestJsonFilePath(
|
const cmd = `node ./bin/hopp test ${getTestJsonFilePath(
|
||||||
"pre-req-script-env-var-persistence-coll.json",
|
"malformed-collection2.json"
|
||||||
"collection"
|
|
||||||
)}`;
|
)}`;
|
||||||
const { error } = await runCLI(args);
|
const { stderr } = await execAsync(cmd);
|
||||||
|
const out = getErrorCode(stderr);
|
||||||
|
|
||||||
|
expect(out).toBe<HoppErrorCode>("MALFORMED_COLLECTION");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("Invalid arguement.", async () => {
|
||||||
|
const cmd = `node ./bin/hopp invalid-arg`;
|
||||||
|
const { stderr } = await execAsync(cmd);
|
||||||
|
const out = getErrorCode(stderr);
|
||||||
|
|
||||||
|
expect(out).toBe<HoppErrorCode>("INVALID_ARGUMENT");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("Collection file not JSON type.", async () => {
|
||||||
|
const cmd = `node ./bin/hopp test ${getTestJsonFilePath("notjson.txt")}`;
|
||||||
|
const { stderr } = await execAsync(cmd);
|
||||||
|
const out = getErrorCode(stderr);
|
||||||
|
|
||||||
|
expect(out).toBe<HoppErrorCode>("INVALID_FILE_TYPE");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("Some errors occured (exit code 1).", async () => {
|
||||||
|
const cmd = `node ./bin/hopp test ${getTestJsonFilePath("fails.json")}`;
|
||||||
|
const { error } = await execAsync(cmd);
|
||||||
|
|
||||||
|
expect(error).not.toBeNull();
|
||||||
|
expect(error).toMatchObject(<ExecException>{
|
||||||
|
code: 1,
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
test("No errors occured (exit code 0).", async () => {
|
||||||
|
const cmd = `node ./bin/hopp test ${getTestJsonFilePath("passes.json")}`;
|
||||||
|
const { error } = await execAsync(cmd);
|
||||||
|
|
||||||
expect(error).toBeNull();
|
expect(error).toBeNull();
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
describe("Test `hopp test <file> --env <file>` command:", () => {
|
describe("Test 'hopp test <file> --env <file>' command:", () => {
|
||||||
describe("Supplied environment export file validations", () => {
|
const VALID_TEST_CMD = `node ./bin/hopp test ${getTestJsonFilePath(
|
||||||
const VALID_TEST_ARGS = `test ${getTestJsonFilePath("passes-coll.json", "collection")}`;
|
"passes.json"
|
||||||
|
)}`;
|
||||||
|
|
||||||
test("Errors with the code `INVALID_ARGUMENT` if no file is supplied", async () => {
|
test("No env file path provided.", async () => {
|
||||||
const args = `${VALID_TEST_ARGS} --env`;
|
const cmd = `${VALID_TEST_CMD} --env`;
|
||||||
const { stderr } = await runCLI(args);
|
const { stderr } = await execAsync(cmd);
|
||||||
|
const out = getErrorCode(stderr);
|
||||||
|
|
||||||
const out = getErrorCode(stderr);
|
expect(out).toBe<HoppErrorCode>("INVALID_ARGUMENT");
|
||||||
expect(out).toBe<HoppErrorCode>("INVALID_ARGUMENT");
|
|
||||||
});
|
|
||||||
|
|
||||||
test("Errors with the code `INVALID_FILE_TYPE` if the supplied environment export file doesn't end with the `.json` extension", async () => {
|
|
||||||
const args = `${VALID_TEST_ARGS} --env ${getTestJsonFilePath(
|
|
||||||
"notjson-coll.txt",
|
|
||||||
"collection"
|
|
||||||
)}`;
|
|
||||||
const { stderr } = await runCLI(args);
|
|
||||||
|
|
||||||
const out = getErrorCode(stderr);
|
|
||||||
expect(out).toBe<HoppErrorCode>("INVALID_FILE_TYPE");
|
|
||||||
});
|
|
||||||
|
|
||||||
test("Errors with the code `FILE_NOT_FOUND` if the supplied environment export file doesn't exist", async () => {
|
|
||||||
const args = `${VALID_TEST_ARGS} --env notfound.json`;
|
|
||||||
const { stderr } = await runCLI(args);
|
|
||||||
|
|
||||||
const out = getErrorCode(stderr);
|
|
||||||
expect(out).toBe<HoppErrorCode>("FILE_NOT_FOUND");
|
|
||||||
});
|
|
||||||
|
|
||||||
test("Errors with the code `MALFORMED_ENV_FILE` on supplying a malformed environment export file", async () => {
|
|
||||||
const ENV_PATH = getTestJsonFilePath(
|
|
||||||
"malformed-envs.json",
|
|
||||||
"environment"
|
|
||||||
);
|
|
||||||
const args = `${VALID_TEST_ARGS} --env ${ENV_PATH}`;
|
|
||||||
const { stderr } = await runCLI(args);
|
|
||||||
|
|
||||||
const out = getErrorCode(stderr);
|
|
||||||
expect(out).toBe<HoppErrorCode>("MALFORMED_ENV_FILE");
|
|
||||||
});
|
|
||||||
|
|
||||||
test("Errors with the code `BULK_ENV_FILE` on supplying an environment export file based on the bulk environment export format", async () => {
|
|
||||||
const ENV_PATH = getTestJsonFilePath("bulk-envs.json", "environment");
|
|
||||||
const args = `${VALID_TEST_ARGS} --env ${ENV_PATH}`;
|
|
||||||
const { stderr } = await runCLI(args);
|
|
||||||
|
|
||||||
const out = getErrorCode(stderr);
|
|
||||||
expect(out).toBe<HoppErrorCode>("BULK_ENV_FILE");
|
|
||||||
});
|
|
||||||
});
|
});
|
||||||
|
|
||||||
test("Successfully resolves values from the supplied environment export file", async () => {
|
test("ENV file not JSON type.", async () => {
|
||||||
const TESTS_PATH = getTestJsonFilePath(
|
const cmd = `${VALID_TEST_CMD} --env ${getTestJsonFilePath("notjson.txt")}`;
|
||||||
"env-flag-tests-coll.json",
|
const { stderr } = await execAsync(cmd);
|
||||||
"collection"
|
const out = getErrorCode(stderr);
|
||||||
);
|
|
||||||
const ENV_PATH = getTestJsonFilePath("env-flag-envs.json", "environment");
|
expect(out).toBe<HoppErrorCode>("INVALID_FILE_TYPE");
|
||||||
const args = `test ${TESTS_PATH} --env ${ENV_PATH}`;
|
});
|
||||||
|
|
||||||
|
test("ENV file not found.", async () => {
|
||||||
|
const cmd = `${VALID_TEST_CMD} --env notfound.json`;
|
||||||
|
const { stderr } = await execAsync(cmd);
|
||||||
|
const out = getErrorCode(stderr);
|
||||||
|
|
||||||
|
expect(out).toBe<HoppErrorCode>("FILE_NOT_FOUND");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("No errors occured (exit code 0).", async () => {
|
||||||
|
const TESTS_PATH = getTestJsonFilePath("env-flag-tests.json");
|
||||||
|
const ENV_PATH = getTestJsonFilePath("env-flag-envs.json");
|
||||||
|
const cmd = `node ./bin/hopp test ${TESTS_PATH} --env ${ENV_PATH}`;
|
||||||
|
const { error, stdout } = await execAsync(cmd);
|
||||||
|
|
||||||
const { error } = await runCLI(args);
|
|
||||||
expect(error).toBeNull();
|
expect(error).toBeNull();
|
||||||
});
|
});
|
||||||
|
|
||||||
test("Successfully resolves environment variables referenced in the request body", async () => {
|
|
||||||
const COLL_PATH = getTestJsonFilePath(
|
|
||||||
"req-body-env-vars-coll.json",
|
|
||||||
"collection"
|
|
||||||
);
|
|
||||||
const ENVS_PATH = getTestJsonFilePath(
|
|
||||||
"req-body-env-vars-envs.json",
|
|
||||||
"environment"
|
|
||||||
);
|
|
||||||
const args = `test ${COLL_PATH} --env ${ENVS_PATH}`;
|
|
||||||
|
|
||||||
const { error } = await runCLI(args);
|
|
||||||
expect(error).toBeNull();
|
|
||||||
});
|
|
||||||
|
|
||||||
test("Works with shorth `-e` flag", async () => {
|
|
||||||
const TESTS_PATH = getTestJsonFilePath(
|
|
||||||
"env-flag-tests-coll.json",
|
|
||||||
"collection"
|
|
||||||
);
|
|
||||||
const ENV_PATH = getTestJsonFilePath("env-flag-envs.json", "environment");
|
|
||||||
const args = `test ${TESTS_PATH} -e ${ENV_PATH}`;
|
|
||||||
|
|
||||||
const { error } = await runCLI(args);
|
|
||||||
expect(error).toBeNull();
|
|
||||||
});
|
|
||||||
|
|
||||||
describe("Secret environment variables", () => {
|
|
||||||
jest.setTimeout(100000);
|
|
||||||
|
|
||||||
// Reads secret environment values from system environment
|
|
||||||
test("Successfully picks the values for secret environment variables from `process.env` and persists the variables set from the pre-request script", async () => {
|
|
||||||
const env = {
|
|
||||||
...process.env,
|
|
||||||
secretBearerToken: "test-token",
|
|
||||||
secretBasicAuthUsername: "test-user",
|
|
||||||
secretBasicAuthPassword: "test-pass",
|
|
||||||
secretQueryParamValue: "secret-query-param-value",
|
|
||||||
secretBodyValue: "secret-body-value",
|
|
||||||
secretHeaderValue: "secret-header-value",
|
|
||||||
};
|
|
||||||
|
|
||||||
const COLL_PATH = getTestJsonFilePath(
|
|
||||||
"secret-envs-coll.json",
|
|
||||||
"collection"
|
|
||||||
);
|
|
||||||
const ENVS_PATH = getTestJsonFilePath("secret-envs.json", "environment");
|
|
||||||
const args = `test ${COLL_PATH} --env ${ENVS_PATH}`;
|
|
||||||
|
|
||||||
const { error, stdout } = await runCLI(args, { env });
|
|
||||||
|
|
||||||
expect(stdout).toContain(
|
|
||||||
"https://httpbin.org/basic-auth/*********/*********"
|
|
||||||
);
|
|
||||||
expect(error).toBeNull();
|
|
||||||
});
|
|
||||||
|
|
||||||
// Prefers values specified in the environment export file over values set in the system environment
|
|
||||||
test("Successfully picks the values for secret environment variables set directly in the environment export file and persists the environment variables set from the pre-request script", async () => {
|
|
||||||
const COLL_PATH = getTestJsonFilePath(
|
|
||||||
"secret-envs-coll.json",
|
|
||||||
"collection"
|
|
||||||
);
|
|
||||||
const ENVS_PATH = getTestJsonFilePath(
|
|
||||||
"secret-supplied-values-envs.json",
|
|
||||||
"environment"
|
|
||||||
);
|
|
||||||
const args = `test ${COLL_PATH} --env ${ENVS_PATH}`;
|
|
||||||
|
|
||||||
const { error, stdout } = await runCLI(args);
|
|
||||||
|
|
||||||
expect(stdout).toContain(
|
|
||||||
"https://httpbin.org/basic-auth/*********/*********"
|
|
||||||
);
|
|
||||||
expect(error).toBeNull();
|
|
||||||
});
|
|
||||||
|
|
||||||
// Values set from the scripting context takes the highest precedence
|
|
||||||
test("Setting values for secret environment variables from the pre-request script overrides values set at the supplied environment export file", async () => {
|
|
||||||
const COLL_PATH = getTestJsonFilePath(
|
|
||||||
"secret-envs-persistence-coll.json",
|
|
||||||
"collection"
|
|
||||||
);
|
|
||||||
const ENVS_PATH = getTestJsonFilePath(
|
|
||||||
"secret-supplied-values-envs.json",
|
|
||||||
"environment"
|
|
||||||
);
|
|
||||||
const args = `test ${COLL_PATH} --env ${ENVS_PATH}`;
|
|
||||||
|
|
||||||
const { error, stdout } = await runCLI(args);
|
|
||||||
|
|
||||||
expect(stdout).toContain(
|
|
||||||
"https://httpbin.org/basic-auth/*********/*********"
|
|
||||||
);
|
|
||||||
expect(error).toBeNull();
|
|
||||||
});
|
|
||||||
|
|
||||||
test("Persists secret environment variable values set from the pre-request script for consumption in the request and post-request script context", async () => {
|
|
||||||
const COLL_PATH = getTestJsonFilePath(
|
|
||||||
"secret-envs-persistence-scripting-coll.json",
|
|
||||||
"collection"
|
|
||||||
);
|
|
||||||
const ENVS_PATH = getTestJsonFilePath(
|
|
||||||
"secret-envs-persistence-scripting-envs.json",
|
|
||||||
"environment"
|
|
||||||
);
|
|
||||||
const args = `test ${COLL_PATH} --env ${ENVS_PATH}`;
|
|
||||||
|
|
||||||
const { error } = await runCLI(args);
|
|
||||||
expect(error).toBeNull();
|
|
||||||
});
|
|
||||||
});
|
|
||||||
});
|
});
|
||||||
|
|
||||||
describe("Test `hopp test <file> --delay <delay_in_ms>` command:", () => {
|
describe("Test 'hopp test <file> --delay <delay_in_ms>' command:", () => {
|
||||||
const VALID_TEST_ARGS = `test ${getTestJsonFilePath("passes-coll.json", "collection")}`;
|
const VALID_TEST_CMD = `node ./bin/hopp test ${getTestJsonFilePath(
|
||||||
|
"passes.json"
|
||||||
|
)}`;
|
||||||
|
|
||||||
test("Errors with the code `INVALID_ARGUMENT` on not supplying a delay value", async () => {
|
test("No value passed to delay flag.", async () => {
|
||||||
const args = `${VALID_TEST_ARGS} --delay`;
|
const cmd = `${VALID_TEST_CMD} --delay`;
|
||||||
const { stderr } = await runCLI(args);
|
const { stderr } = await execAsync(cmd);
|
||||||
|
const out = getErrorCode(stderr);
|
||||||
|
|
||||||
|
expect(out).toBe<HoppErrorCode>("INVALID_ARGUMENT");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("Invalid value passed to delay flag.", async () => {
|
||||||
|
const cmd = `${VALID_TEST_CMD} --delay 'NaN'`;
|
||||||
|
const { stderr } = await execAsync(cmd);
|
||||||
const out = getErrorCode(stderr);
|
const out = getErrorCode(stderr);
|
||||||
expect(out).toBe<HoppErrorCode>("INVALID_ARGUMENT");
|
expect(out).toBe<HoppErrorCode>("INVALID_ARGUMENT");
|
||||||
});
|
});
|
||||||
|
|
||||||
test("Errors with the code `INVALID_ARGUMENT` on supplying an invalid delay value", async () => {
|
test("Valid value passed to delay flag.", async () => {
|
||||||
const args = `${VALID_TEST_ARGS} --delay 'NaN'`;
|
const cmd = `${VALID_TEST_CMD} --delay 1`;
|
||||||
const { stderr } = await runCLI(args);
|
const { error } = await execAsync(cmd);
|
||||||
|
|
||||||
const out = getErrorCode(stderr);
|
|
||||||
expect(out).toBe<HoppErrorCode>("INVALID_ARGUMENT");
|
|
||||||
});
|
|
||||||
|
|
||||||
test("Successfully performs delayed request execution for a valid delay value", async () => {
|
|
||||||
const args = `${VALID_TEST_ARGS} --delay 1`;
|
|
||||||
const { error } = await runCLI(args);
|
|
||||||
|
|
||||||
expect(error).toBeNull();
|
|
||||||
});
|
|
||||||
|
|
||||||
test("Works with the short `-d` flag", async () => {
|
|
||||||
const args = `${VALID_TEST_ARGS} -d 1`;
|
|
||||||
const { error } = await runCLI(args);
|
|
||||||
|
|
||||||
expect(error).toBeNull();
|
expect(error).toBeNull();
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -0,0 +1,84 @@
|
|||||||
|
import { isRESTCollection } from "../../../utils/checks";
|
||||||
|
|
||||||
|
describe("isRESTCollection", () => {
|
||||||
|
test("Undefined collection value.", () => {
|
||||||
|
expect(isRESTCollection(undefined)).toBeFalsy();
|
||||||
|
});
|
||||||
|
|
||||||
|
test("Invalid id value.", () => {
|
||||||
|
expect(
|
||||||
|
isRESTCollection({
|
||||||
|
v: 1,
|
||||||
|
name: "test",
|
||||||
|
id: 1,
|
||||||
|
})
|
||||||
|
).toBeFalsy();
|
||||||
|
});
|
||||||
|
|
||||||
|
test("Invalid requests value.", () => {
|
||||||
|
expect(
|
||||||
|
isRESTCollection({
|
||||||
|
v: 1,
|
||||||
|
name: "test",
|
||||||
|
id: "1",
|
||||||
|
requests: null,
|
||||||
|
})
|
||||||
|
).toBeFalsy();
|
||||||
|
});
|
||||||
|
|
||||||
|
test("Invalid folders value.", () => {
|
||||||
|
expect(
|
||||||
|
isRESTCollection({
|
||||||
|
v: 1,
|
||||||
|
name: "test",
|
||||||
|
id: "1",
|
||||||
|
requests: [],
|
||||||
|
folders: undefined,
|
||||||
|
})
|
||||||
|
).toBeFalsy();
|
||||||
|
});
|
||||||
|
|
||||||
|
test("Invalid RESTCollection(s) in folders.", () => {
|
||||||
|
expect(
|
||||||
|
isRESTCollection({
|
||||||
|
v: 1,
|
||||||
|
name: "test",
|
||||||
|
id: "1",
|
||||||
|
requests: [],
|
||||||
|
folders: [
|
||||||
|
{
|
||||||
|
v: 1,
|
||||||
|
name: "test1",
|
||||||
|
id: "2",
|
||||||
|
requests: undefined,
|
||||||
|
folders: [],
|
||||||
|
},
|
||||||
|
],
|
||||||
|
})
|
||||||
|
).toBeFalsy();
|
||||||
|
});
|
||||||
|
|
||||||
|
test("Invalid HoppRESTRequest(s) in requests.", () => {
|
||||||
|
expect(
|
||||||
|
isRESTCollection({
|
||||||
|
v: 1,
|
||||||
|
name: "test",
|
||||||
|
id: "1",
|
||||||
|
requests: [{}],
|
||||||
|
folders: [],
|
||||||
|
})
|
||||||
|
).toBeFalsy();
|
||||||
|
});
|
||||||
|
|
||||||
|
test("Valid RESTCollection.", () => {
|
||||||
|
expect(
|
||||||
|
isRESTCollection({
|
||||||
|
v: 1,
|
||||||
|
name: "test",
|
||||||
|
id: "1",
|
||||||
|
requests: [],
|
||||||
|
folders: [],
|
||||||
|
})
|
||||||
|
).toBeTruthy();
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -1,55 +0,0 @@
|
|||||||
{
|
|
||||||
"v": 1,
|
|
||||||
"name": "coll-v1",
|
|
||||||
"folders": [
|
|
||||||
{
|
|
||||||
"v": 1,
|
|
||||||
"name": "coll-v1-child",
|
|
||||||
"folders": [],
|
|
||||||
"requests": [
|
|
||||||
{
|
|
||||||
"url": "https://echo.hoppscotch.io",
|
|
||||||
"path": "/get",
|
|
||||||
"headers": [
|
|
||||||
{ "key": "Inactive-Header", "value": "Inactive Header", "active": false },
|
|
||||||
{ "key": "Authorization", "value": "Bearer token123", "active": true }
|
|
||||||
],
|
|
||||||
"params": [
|
|
||||||
{ "key": "key", "value": "value", "active": true },
|
|
||||||
{ "key": "inactive-key", "value": "inactive-param", "active": false }
|
|
||||||
],
|
|
||||||
"name": "req-v0-II",
|
|
||||||
"method": "GET",
|
|
||||||
"preRequestScript": "",
|
|
||||||
"testScript": "pw.test(\"Asserts request params\", () => {\n pw.expect(pw.response.body.args.key).toBe(\"value\")\n pw.expect(pw.response.body.args[\"inactive-key\"]).toBe(undefined)\n})\n\npw.test(\"Asserts request headers\", () => {\n pw.expect(pw.response.body.headers[\"authorization\"]).toBe(\"Bearer token123\")\n pw.expect(pw.response.body.headers[\"inactive-header\"]).toBe(undefined)\n})",
|
|
||||||
"contentType": "application/json",
|
|
||||||
"body": "",
|
|
||||||
"auth": "Bearer Token",
|
|
||||||
"bearerToken": "token123"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"requests": [
|
|
||||||
{
|
|
||||||
"url": "https://echo.hoppscotch.io",
|
|
||||||
"path": "/get",
|
|
||||||
"headers": [
|
|
||||||
{ "key": "Inactive-Header", "value": "Inactive Header", "active": false },
|
|
||||||
{ "key": "Authorization", "value": "Bearer token123", "active": true }
|
|
||||||
],
|
|
||||||
"params": [
|
|
||||||
{ "key": "key", "value": "value", "active": true },
|
|
||||||
{ "key": "inactive-key", "value": "inactive-param", "active": false }
|
|
||||||
],
|
|
||||||
"name": "req-v0",
|
|
||||||
"method": "GET",
|
|
||||||
"preRequestScript": "",
|
|
||||||
"testScript": "pw.test(\"Asserts request params\", () => {\n pw.expect(pw.response.body.args.key).toBe(\"value\")\n pw.expect(pw.response.body.args[\"inactive-key\"]).toBe(undefined)\n})\n\npw.test(\"Asserts request headers\", () => {\n pw.expect(pw.response.body.headers[\"authorization\"]).toBe(\"Bearer token123\")\n pw.expect(pw.response.body.headers[\"inactive-header\"]).toBe(undefined)\n})",
|
|
||||||
"contentType": "application/json",
|
|
||||||
"body": "",
|
|
||||||
"auth": "Bearer Token",
|
|
||||||
"bearerToken": "token123"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
@@ -1,97 +0,0 @@
|
|||||||
{
|
|
||||||
"v": 1,
|
|
||||||
"name": "coll-v1",
|
|
||||||
"folders": [
|
|
||||||
{
|
|
||||||
"v": 1,
|
|
||||||
"name": "coll-v1-child",
|
|
||||||
"folders": [],
|
|
||||||
"requests": [
|
|
||||||
{
|
|
||||||
"v": "1",
|
|
||||||
"endpoint": "https://echo.hoppscotch.io",
|
|
||||||
"headers": [
|
|
||||||
{
|
|
||||||
"key": "Inactive-Header",
|
|
||||||
"value": "Inactive Header",
|
|
||||||
"active": false
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"key": "Authorization",
|
|
||||||
"value": "Bearer token123",
|
|
||||||
"active": true
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"params": [
|
|
||||||
{
|
|
||||||
"key": "key",
|
|
||||||
"value": "value",
|
|
||||||
"active": true
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"key": "inactive-key",
|
|
||||||
"value": "inactive-param",
|
|
||||||
"active": false
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"name": "req-v1-II",
|
|
||||||
"method": "GET",
|
|
||||||
"preRequestScript": "",
|
|
||||||
"testScript": "pw.test(\"Asserts request params\", () => {\n pw.expect(pw.response.body.args.key).toBe(\"value\")\n pw.expect(pw.response.body.args[\"inactive-key\"]).toBe(undefined)\n})\n\npw.test(\"Asserts request headers\", () => {\n pw.expect(pw.response.body.headers[\"authorization\"]).toBe(\"Bearer token123\")\n pw.expect(pw.response.body.headers[\"inactive-header\"]).toBe(undefined)\n})",
|
|
||||||
"body": {
|
|
||||||
"contentType": null,
|
|
||||||
"body": null
|
|
||||||
},
|
|
||||||
"auth": {
|
|
||||||
"authType": "bearer",
|
|
||||||
"authActive": true,
|
|
||||||
"token": "token123"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"requests": [
|
|
||||||
{
|
|
||||||
"v": "1",
|
|
||||||
"endpoint": "https://echo.hoppscotch.io",
|
|
||||||
"headers": [
|
|
||||||
{
|
|
||||||
"key": "Inactive-Header",
|
|
||||||
"value": "Inactive Header",
|
|
||||||
"active": false
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"key": "Authorization",
|
|
||||||
"value": "Bearer token123",
|
|
||||||
"active": true
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"params": [
|
|
||||||
{
|
|
||||||
"key": "key",
|
|
||||||
"value": "value",
|
|
||||||
"active": true
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"key": "inactive-key",
|
|
||||||
"value": "inactive-param",
|
|
||||||
"active": false
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"name": "req-v1",
|
|
||||||
"method": "GET",
|
|
||||||
"preRequestScript": "",
|
|
||||||
"testScript": "pw.test(\"Asserts request params\", () => {\n pw.expect(pw.response.body.args.key).toBe(\"value\")\n pw.expect(pw.response.body.args[\"inactive-key\"]).toBe(undefined)\n})\n\npw.test(\"Asserts request headers\", () => {\n pw.expect(pw.response.body.headers[\"authorization\"]).toBe(\"Bearer token123\")\n pw.expect(pw.response.body.headers[\"inactive-header\"]).toBe(undefined)\n})",
|
|
||||||
"body": {
|
|
||||||
"contentType": null,
|
|
||||||
"body": null
|
|
||||||
},
|
|
||||||
"auth": {
|
|
||||||
"authType": "bearer",
|
|
||||||
"authActive": true,
|
|
||||||
"token": "token123"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
@@ -1,109 +0,0 @@
|
|||||||
{
|
|
||||||
"v": 2,
|
|
||||||
"name": "coll-v2",
|
|
||||||
"folders": [
|
|
||||||
{
|
|
||||||
"v": 2,
|
|
||||||
"name": "coll-v2-child",
|
|
||||||
"folders": [],
|
|
||||||
"requests": [
|
|
||||||
{
|
|
||||||
"v": "2",
|
|
||||||
"endpoint": "https://echo.hoppscotch.io",
|
|
||||||
"headers": [
|
|
||||||
{
|
|
||||||
"key": "Inactive-Header",
|
|
||||||
"value": "Inactive Header",
|
|
||||||
"active": false
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"key": "Authorization",
|
|
||||||
"value": "Bearer token123",
|
|
||||||
"active": true
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"params": [
|
|
||||||
{
|
|
||||||
"key": "key",
|
|
||||||
"value": "value",
|
|
||||||
"active": true
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"key": "inactive-key",
|
|
||||||
"value": "inactive-param",
|
|
||||||
"active": false
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"name": "req-v2-II",
|
|
||||||
"method": "GET",
|
|
||||||
"preRequestScript": "",
|
|
||||||
"testScript": "pw.test(\"Asserts request params\", () => {\n pw.expect(pw.response.body.args.key).toBe(\"value\")\n pw.expect(pw.response.body.args[\"inactive-key\"]).toBe(undefined)\n})\n\npw.test(\"Asserts request headers\", () => {\n pw.expect(pw.response.body.headers[\"authorization\"]).toBe(\"Bearer token123\")\n pw.expect(pw.response.body.headers[\"inactive-header\"]).toBe(undefined)\n})",
|
|
||||||
"body": {
|
|
||||||
"contentType": null,
|
|
||||||
"body": null
|
|
||||||
},
|
|
||||||
"auth": {
|
|
||||||
"authType": "bearer",
|
|
||||||
"authActive": true,
|
|
||||||
"token": "token123"
|
|
||||||
},
|
|
||||||
"requestVariables": []
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"auth": {
|
|
||||||
"authType": "inherit",
|
|
||||||
"authActive": true
|
|
||||||
},
|
|
||||||
"headers": []
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"requests": [
|
|
||||||
{
|
|
||||||
"v": "2",
|
|
||||||
"endpoint": "https://echo.hoppscotch.io",
|
|
||||||
"headers": [
|
|
||||||
{
|
|
||||||
"key": "Inactive-Header",
|
|
||||||
"value": "Inactive Header",
|
|
||||||
"active": false
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"key": "Authorization",
|
|
||||||
"value": "Bearer token123",
|
|
||||||
"active": true
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"params": [
|
|
||||||
{
|
|
||||||
"key": "key",
|
|
||||||
"value": "value",
|
|
||||||
"active": true
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"key": "inactive-key",
|
|
||||||
"value": "inactive-param",
|
|
||||||
"active": false
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"name": "req-v2",
|
|
||||||
"method": "GET",
|
|
||||||
"preRequestScript": "",
|
|
||||||
"testScript": "pw.test(\"Asserts request params\", () => {\n pw.expect(pw.response.body.args.key).toBe(\"value\")\n pw.expect(pw.response.body.args[\"inactive-key\"]).toBe(undefined)\n})\n\npw.test(\"Asserts request headers\", () => {\n pw.expect(pw.response.body.headers[\"authorization\"]).toBe(\"Bearer token123\")\n pw.expect(pw.response.body.headers[\"inactive-header\"]).toBe(undefined)\n})",
|
|
||||||
"body": {
|
|
||||||
"contentType": null,
|
|
||||||
"body": null
|
|
||||||
},
|
|
||||||
"auth": {
|
|
||||||
"authType": "bearer",
|
|
||||||
"authActive": true,
|
|
||||||
"token": "token123"
|
|
||||||
},
|
|
||||||
"requestVariables": []
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"auth": {
|
|
||||||
"authType": "inherit",
|
|
||||||
"authActive": true
|
|
||||||
},
|
|
||||||
"headers": []
|
|
||||||
}
|
|
||||||
@@ -1,109 +0,0 @@
|
|||||||
{
|
|
||||||
"v": 2,
|
|
||||||
"name": "coll-v2",
|
|
||||||
"folders": [
|
|
||||||
{
|
|
||||||
"v": 2,
|
|
||||||
"name": "coll-v2-child",
|
|
||||||
"folders": [],
|
|
||||||
"requests": [
|
|
||||||
{
|
|
||||||
"v": "3",
|
|
||||||
"endpoint": "https://echo.hoppscotch.io",
|
|
||||||
"headers": [
|
|
||||||
{
|
|
||||||
"key": "Inactive-Header",
|
|
||||||
"value": "Inactive Header",
|
|
||||||
"active": false
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"key": "Authorization",
|
|
||||||
"value": "Bearer token123",
|
|
||||||
"active": true
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"params": [
|
|
||||||
{
|
|
||||||
"key": "key",
|
|
||||||
"value": "value",
|
|
||||||
"active": true
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"key": "inactive-key",
|
|
||||||
"value": "inactive-param",
|
|
||||||
"active": false
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"name": "req-v3-II",
|
|
||||||
"method": "GET",
|
|
||||||
"preRequestScript": "",
|
|
||||||
"testScript": "pw.test(\"Asserts request params\", () => {\n pw.expect(pw.response.body.args.key).toBe(\"value\")\n pw.expect(pw.response.body.args[\"inactive-key\"]).toBe(undefined)\n})\n\npw.test(\"Asserts request headers\", () => {\n pw.expect(pw.response.body.headers[\"authorization\"]).toBe(\"Bearer token123\")\n pw.expect(pw.response.body.headers[\"inactive-header\"]).toBe(undefined)\n})",
|
|
||||||
"body": {
|
|
||||||
"contentType": null,
|
|
||||||
"body": null
|
|
||||||
},
|
|
||||||
"auth": {
|
|
||||||
"authType": "bearer",
|
|
||||||
"authActive": true,
|
|
||||||
"token": "token123"
|
|
||||||
},
|
|
||||||
"requestVariables": []
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"auth": {
|
|
||||||
"authType": "inherit",
|
|
||||||
"authActive": true
|
|
||||||
},
|
|
||||||
"headers": []
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"requests": [
|
|
||||||
{
|
|
||||||
"v": "3",
|
|
||||||
"endpoint": "https://echo.hoppscotch.io",
|
|
||||||
"headers": [
|
|
||||||
{
|
|
||||||
"key": "Inactive-Header",
|
|
||||||
"value": "Inactive Header",
|
|
||||||
"active": false
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"key": "Authorization",
|
|
||||||
"value": "Bearer token123",
|
|
||||||
"active": true
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"params": [
|
|
||||||
{
|
|
||||||
"key": "key",
|
|
||||||
"value": "value",
|
|
||||||
"active": true
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"key": "inactive-key",
|
|
||||||
"value": "inactive-param",
|
|
||||||
"active": false
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"name": "req-v3",
|
|
||||||
"method": "GET",
|
|
||||||
"preRequestScript": "",
|
|
||||||
"testScript": "pw.test(\"Asserts request params\", () => {\n pw.expect(pw.response.body.args.key).toBe(\"value\")\n pw.expect(pw.response.body.args[\"inactive-key\"]).toBe(undefined)\n})\n\npw.test(\"Asserts request headers\", () => {\n pw.expect(pw.response.body.headers[\"authorization\"]).toBe(\"Bearer token123\")\n pw.expect(pw.response.body.headers[\"inactive-header\"]).toBe(undefined)\n})",
|
|
||||||
"body": {
|
|
||||||
"contentType": null,
|
|
||||||
"body": null
|
|
||||||
},
|
|
||||||
"auth": {
|
|
||||||
"authType": "bearer",
|
|
||||||
"authActive": true,
|
|
||||||
"token": "token123"
|
|
||||||
},
|
|
||||||
"requestVariables": []
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"auth": {
|
|
||||||
"authType": "inherit",
|
|
||||||
"authActive": true
|
|
||||||
},
|
|
||||||
"headers": []
|
|
||||||
}
|
|
||||||
@@ -1,227 +0,0 @@
|
|||||||
[
|
|
||||||
{
|
|
||||||
"v": 2,
|
|
||||||
"name": "CollectionA",
|
|
||||||
"folders": [
|
|
||||||
{
|
|
||||||
"v": 2,
|
|
||||||
"name": "FolderA",
|
|
||||||
"folders": [
|
|
||||||
{
|
|
||||||
"v": 2,
|
|
||||||
"name": "FolderB",
|
|
||||||
"folders": [
|
|
||||||
{
|
|
||||||
"v": 2,
|
|
||||||
"name": "FolderC",
|
|
||||||
"folders": [],
|
|
||||||
"requests": [
|
|
||||||
{
|
|
||||||
"v": "3",
|
|
||||||
"endpoint": "https://echo.hoppscotch.io",
|
|
||||||
"name": "RequestD",
|
|
||||||
"params": [],
|
|
||||||
"headers": [
|
|
||||||
{
|
|
||||||
"active": true,
|
|
||||||
"key": "X-Test-Header",
|
|
||||||
"value": "Overriden at RequestD"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"method": "GET",
|
|
||||||
"auth": {
|
|
||||||
"authType": "basic",
|
|
||||||
"authActive": true,
|
|
||||||
"username": "username",
|
|
||||||
"password": "password"
|
|
||||||
},
|
|
||||||
"preRequestScript": "",
|
|
||||||
"testScript": "pw.test(\"Overrides auth and headers set at the parent folder\", ()=> {\n pw.expect(pw.response.body.headers[\"x-test-header\"]).toBe(\"Overriden at RequestD\");\n pw.expect(pw.response.body.headers[\"authorization\"]).toBe(\"Basic dXNlcm5hbWU6cGFzc3dvcmQ=\");\n});",
|
|
||||||
"body": {
|
|
||||||
"contentType": null,
|
|
||||||
"body": null
|
|
||||||
},
|
|
||||||
"requestVariables": []
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"auth": {
|
|
||||||
"authType": "inherit",
|
|
||||||
"authActive": true
|
|
||||||
},
|
|
||||||
"headers": []
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"requests": [
|
|
||||||
{
|
|
||||||
"v": "3",
|
|
||||||
"endpoint": "https://echo.hoppscotch.io",
|
|
||||||
"name": "RequestC",
|
|
||||||
"params": [],
|
|
||||||
"headers": [],
|
|
||||||
"method": "GET",
|
|
||||||
"auth": {
|
|
||||||
"authType": "inherit",
|
|
||||||
"authActive": true
|
|
||||||
},
|
|
||||||
"preRequestScript": "",
|
|
||||||
"testScript": "pw.test(\"Correctly inherits auth and headers from the parent folder\", ()=> {\n pw.expect(pw.response.body.headers[\"x-test-header\"]).toBe(\"Overriden at FolderB\");\n pw.expect(pw.response.body.headers[\"key\"]).toBe(\"test-key\");\n});",
|
|
||||||
"body": {
|
|
||||||
"contentType": null,
|
|
||||||
"body": null
|
|
||||||
},
|
|
||||||
"requestVariables": []
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"auth": {
|
|
||||||
"authType": "api-key",
|
|
||||||
"authActive": true,
|
|
||||||
"addTo": "HEADERS",
|
|
||||||
"key": "key",
|
|
||||||
"value": "test-key"
|
|
||||||
},
|
|
||||||
"headers": [
|
|
||||||
{
|
|
||||||
"active": true,
|
|
||||||
"key": "X-Test-Header",
|
|
||||||
"value": "Overriden at FolderB"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"requests": [
|
|
||||||
{
|
|
||||||
"v": "3",
|
|
||||||
"endpoint": "https://echo.hoppscotch.io",
|
|
||||||
"name": "RequestB",
|
|
||||||
"params": [],
|
|
||||||
"headers": [],
|
|
||||||
"method": "GET",
|
|
||||||
"auth": {
|
|
||||||
"authType": "inherit",
|
|
||||||
"authActive": true
|
|
||||||
},
|
|
||||||
"preRequestScript": "",
|
|
||||||
"testScript": "pw.test(\"Correctly inherits auth and headers from the parent folder\", ()=> {\n pw.expect(pw.response.body.headers[\"x-test-header\"]).toBe(\"Set at root collection\");\n pw.expect(pw.response.body.headers[\"authorization\"]).toBe(\"Bearer BearerToken\");\n});",
|
|
||||||
"body": {
|
|
||||||
"contentType": null,
|
|
||||||
"body": null
|
|
||||||
},
|
|
||||||
"requestVariables": [],
|
|
||||||
"id": "clpttpdq00003qp16kut6doqv"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"auth": {
|
|
||||||
"authType": "inherit",
|
|
||||||
"authActive": true
|
|
||||||
},
|
|
||||||
"headers": []
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"requests": [
|
|
||||||
{
|
|
||||||
"v": "3",
|
|
||||||
"endpoint": "https://echo.hoppscotch.io",
|
|
||||||
"name": "RequestA",
|
|
||||||
"params": [],
|
|
||||||
"headers": [],
|
|
||||||
"method": "GET",
|
|
||||||
"auth": {
|
|
||||||
"authType": "inherit",
|
|
||||||
"authActive": true
|
|
||||||
},
|
|
||||||
"preRequestScript": "",
|
|
||||||
"testScript": "pw.test(\"Correctly inherits auth and headers from the root collection\", ()=> {\n pw.expect(pw.response.body.headers[\"x-test-header\"]).toBe(\"Set at root collection\");\n pw.expect(pw.response.body.headers[\"authorization\"]).toBe(\"Bearer BearerToken\");\n});",
|
|
||||||
"body": {
|
|
||||||
"contentType": null,
|
|
||||||
"body": null
|
|
||||||
},
|
|
||||||
"requestVariables": [],
|
|
||||||
"id": "clpttpdq00003qp16kut6doqv"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"headers": [
|
|
||||||
{
|
|
||||||
"active": true,
|
|
||||||
"key": "X-Test-Header",
|
|
||||||
"value": "Set at root collection"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"auth": {
|
|
||||||
"authType": "bearer",
|
|
||||||
"authActive": true,
|
|
||||||
"token": "BearerToken"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"v": 2,
|
|
||||||
"name": "CollectionB",
|
|
||||||
"folders": [
|
|
||||||
{
|
|
||||||
"v": 2,
|
|
||||||
"name": "FolderA",
|
|
||||||
"folders": [],
|
|
||||||
"requests": [
|
|
||||||
{
|
|
||||||
"v": "3",
|
|
||||||
"endpoint": "https://echo.hoppscotch.io",
|
|
||||||
"name": "RequestB",
|
|
||||||
"params": [],
|
|
||||||
"headers": [],
|
|
||||||
"method": "GET",
|
|
||||||
"auth": {
|
|
||||||
"authType": "inherit",
|
|
||||||
"authActive": true
|
|
||||||
},
|
|
||||||
"preRequestScript": "",
|
|
||||||
"testScript": "pw.test(\"Correctly inherits auth and headers from the parent folder\", ()=> {\n pw.expect(pw.response.body.headers[\"x-test-header\"]).toBe(\"Set at root collection\");\n pw.expect(pw.response.body.headers[\"authorization\"]).toBe(\"Bearer BearerToken\");\n});",
|
|
||||||
"body": {
|
|
||||||
"contentType": null,
|
|
||||||
"body": null
|
|
||||||
},
|
|
||||||
"requestVariables": [],
|
|
||||||
"id": "clpttpdq00003qp16kut6doqv"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"auth": {
|
|
||||||
"authType": "inherit",
|
|
||||||
"authActive": true
|
|
||||||
},
|
|
||||||
"headers": []
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"requests": [
|
|
||||||
{
|
|
||||||
"v": "3",
|
|
||||||
"endpoint": "https://echo.hoppscotch.io",
|
|
||||||
"name": "RequestA",
|
|
||||||
"params": [],
|
|
||||||
"headers": [],
|
|
||||||
"method": "GET",
|
|
||||||
"auth": {
|
|
||||||
"authType": "inherit",
|
|
||||||
"authActive": true
|
|
||||||
},
|
|
||||||
"preRequestScript": "",
|
|
||||||
"testScript": "pw.test(\"Correctly inherits auth and headers from the root collection\", ()=> {\n pw.expect(pw.response.body.headers[\"x-test-header\"]).toBe(\"Set at root collection\");\n pw.expect(pw.response.body.headers[\"authorization\"]).toBe(\"Bearer BearerToken\");\n});",
|
|
||||||
"body": {
|
|
||||||
"contentType": null,
|
|
||||||
"body": null
|
|
||||||
},
|
|
||||||
"requestVariables": [],
|
|
||||||
"id": "clpttpdq00003qp16kut6doqv"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"headers": [
|
|
||||||
{
|
|
||||||
"active": true,
|
|
||||||
"key": "X-Test-Header",
|
|
||||||
"value": "Set at root collection"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"auth": {
|
|
||||||
"authType": "bearer",
|
|
||||||
"authActive": true,
|
|
||||||
"token": "BearerToken"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
]
|
|
||||||
@@ -1,22 +0,0 @@
|
|||||||
{
|
|
||||||
"v": 2,
|
|
||||||
"name": "pre-req-script-env-var-persistence-coll",
|
|
||||||
"folders": [],
|
|
||||||
"requests": [
|
|
||||||
{
|
|
||||||
"v": "3",
|
|
||||||
"auth": { "authType": "none", "authActive": true },
|
|
||||||
"body": { "body": null, "contentType": null },
|
|
||||||
"name": "sample-req",
|
|
||||||
"method": "GET",
|
|
||||||
"params": [],
|
|
||||||
"headers": [],
|
|
||||||
"endpoint": "https://echo.hoppscotch.io",
|
|
||||||
"testScript": "pw.expect(pw.env.get(\"variable\")).toBe(\"value\")",
|
|
||||||
"preRequestScript": "pw.env.set(\"variable\", \"value\");",
|
|
||||||
"requestVariables": []
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"auth": { "authType": "inherit", "authActive": true },
|
|
||||||
"headers": []
|
|
||||||
}
|
|
||||||
@@ -1,31 +0,0 @@
|
|||||||
{
|
|
||||||
"v": 2,
|
|
||||||
"name": "Test environment variables in request body",
|
|
||||||
"folders": [],
|
|
||||||
"requests": [
|
|
||||||
{
|
|
||||||
"v": "3",
|
|
||||||
"name": "test-request",
|
|
||||||
"endpoint": "https://echo.hoppscotch.io",
|
|
||||||
"method": "POST",
|
|
||||||
"headers": [],
|
|
||||||
"params": [],
|
|
||||||
"auth": {
|
|
||||||
"authType": "none",
|
|
||||||
"authActive": true
|
|
||||||
},
|
|
||||||
"body": {
|
|
||||||
"contentType": "application/json",
|
|
||||||
"body": "{\n \"firstName\": \"<<firstName>>\",\n \"lastName\": \"<<lastName>>\",\n \"greetText\": \"<<salutation>>, <<fullName>>\",\n \"fullName\": \"<<fullName>>\",\n \"id\": \"<<id>>\"\n}"
|
|
||||||
},
|
|
||||||
"preRequestScript": "",
|
|
||||||
"testScript": "pw.test(\"Status code is 200\", ()=> {\n pw.expect(pw.response.status).toBe(200);\n});\n\npw.test(\"Successfully resolves environments recursively\", ()=> {\n pw.expect(pw.env.getResolve(\"recursiveVarX\")).toBe(\"Hello\")\n pw.expect(pw.env.getResolve(\"recursiveVarY\")).toBe(\"Hello\")\n pw.expect(pw.env.getResolve(\"salutation\")).toBe(\"Hello\")\n});\n\npw.test(\"Successfully resolves environments referenced in the request body\", () => {\n const expectedId = \"7\"\n const expectedFirstName = \"John\"\n const expectedLastName = \"Doe\"\n const expectedFullName = `${expectedFirstName} ${expectedLastName}`\n const expectedGreetText = `Hello, ${expectedFullName}`\n\n pw.expect(pw.env.getResolve(\"recursiveVarX\")).toBe(\"Hello\")\n pw.expect(pw.env.getResolve(\"recursiveVarY\")).toBe(\"Hello\")\n pw.expect(pw.env.getResolve(\"salutation\")).toBe(\"Hello\")\n\n const { id, firstName, lastName, fullName, greetText } = JSON.parse(pw.response.body.data)\n\n pw.expect(id).toBe(expectedId)\n pw.expect(expectedFirstName).toBe(firstName)\n pw.expect(expectedLastName).toBe(lastName)\n pw.expect(fullName).toBe(expectedFullName)\n pw.expect(greetText).toBe(expectedGreetText)\n});",
|
|
||||||
"requestVariables": []
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"auth": {
|
|
||||||
"authType": "none",
|
|
||||||
"authActive": true
|
|
||||||
},
|
|
||||||
"headers": []
|
|
||||||
}
|
|
||||||
@@ -1,26 +0,0 @@
|
|||||||
{
|
|
||||||
"v": 1,
|
|
||||||
"name": "tests",
|
|
||||||
"folders": [],
|
|
||||||
"requests": [
|
|
||||||
{
|
|
||||||
"v": "2",
|
|
||||||
"endpoint": "<<baseURL>>",
|
|
||||||
"name": "",
|
|
||||||
"params": [],
|
|
||||||
"headers": [],
|
|
||||||
"method": "GET",
|
|
||||||
"auth": {
|
|
||||||
"authType": "none",
|
|
||||||
"authActive": true
|
|
||||||
},
|
|
||||||
"preRequestScript": "",
|
|
||||||
"testScript": "// Check status code is 200\npw.test(\"Status code is 200\", ()=> {\n pw.expect(pw.response.status).toBe(200);\n});\n\n// Check JSON response property\npw.test(\"Check JSON response property\", ()=> {\n pw.expect(pw.response.body.method).toBe(\"GET\");\n pw.expect(pw.response.body.headers).toBeType(\"object\");\n});",
|
|
||||||
"body": {
|
|
||||||
"contentType": null,
|
|
||||||
"body": null
|
|
||||||
},
|
|
||||||
"requestVariables": []
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
@@ -1,143 +0,0 @@
|
|||||||
{
|
|
||||||
"v": 2,
|
|
||||||
"name": "secret-envs-coll",
|
|
||||||
"folders": [],
|
|
||||||
"requests": [
|
|
||||||
{
|
|
||||||
"v": "3",
|
|
||||||
"auth": {
|
|
||||||
"authType": "none",
|
|
||||||
"authActive": true
|
|
||||||
},
|
|
||||||
"body": {
|
|
||||||
"body": null,
|
|
||||||
"contentType": null
|
|
||||||
},
|
|
||||||
"name": "test-secret-headers",
|
|
||||||
"method": "GET",
|
|
||||||
"params": [],
|
|
||||||
"headers": [
|
|
||||||
{
|
|
||||||
"key": "Secret-Header-Key",
|
|
||||||
"value": "<<secretHeaderValue>>",
|
|
||||||
"active": true
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"requestVariables": [],
|
|
||||||
"endpoint": "<<echoHoppBaseURL>>/headers",
|
|
||||||
"testScript": "pw.test(\"Successfully parses secret variable holding the header value\", () => {\n const secretHeaderValue = pw.env.get(\"secretHeaderValue\")\n pw.expect(secretHeaderValue).toBe(\"secret-header-value\")\n \n if (secretHeaderValue) {\n pw.expect(pw.response.body.headers[\"secret-header-key\"]).toBe(secretHeaderValue)\n }\n\n pw.expect(pw.env.get(\"secretHeaderValueFromPreReqScript\")).toBe(\"secret-header-value\")\n})",
|
|
||||||
"preRequestScript": "const secretHeaderValueFromPreReqScript = pw.env.get(\"secretHeaderValue\")\npw.env.set(\"secretHeaderValueFromPreReqScript\", secretHeaderValueFromPreReqScript)"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"v": "3",
|
|
||||||
"auth": {
|
|
||||||
"authType": "none",
|
|
||||||
"authActive": true
|
|
||||||
},
|
|
||||||
"body": {
|
|
||||||
"body": "{\n \"secretBodyKey\": \"<<secretBodyValue>>\"\n}",
|
|
||||||
"contentType": "application/json"
|
|
||||||
},
|
|
||||||
"name": "test-secret-body",
|
|
||||||
"method": "POST",
|
|
||||||
"params": [],
|
|
||||||
"headers": [],
|
|
||||||
"requestVariables": [],
|
|
||||||
"endpoint": "<<echoHoppBaseURL>>/post",
|
|
||||||
"testScript": "pw.test(\"Successfully parses secret variable holding the request body value\", () => {\n const secretBodyValue = pw.env.get(\"secretBodyValue\")\n pw.expect(secretBodyValue).toBe(\"secret-body-value\")\n \n if (secretBodyValue) {\n pw.expect(JSON.parse(pw.response.body.data).secretBodyKey).toBe(secretBodyValue)\n }\n\n pw.expect(pw.env.get(\"secretBodyValueFromPreReqScript\")).toBe(\"secret-body-value\")\n})",
|
|
||||||
"preRequestScript": "const secretBodyValueFromPreReqScript = pw.env.get(\"secretBodyValue\")\npw.env.set(\"secretBodyValueFromPreReqScript\", secretBodyValueFromPreReqScript)"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"v": "3",
|
|
||||||
"auth": {
|
|
||||||
"authType": "none",
|
|
||||||
"authActive": true
|
|
||||||
},
|
|
||||||
"body": {
|
|
||||||
"body": null,
|
|
||||||
"contentType": null
|
|
||||||
},
|
|
||||||
"name": "test-secret-query-params",
|
|
||||||
"method": "GET",
|
|
||||||
"params": [
|
|
||||||
{
|
|
||||||
"key": "secretQueryParamKey",
|
|
||||||
"value": "<<secretQueryParamValue>>",
|
|
||||||
"active": true
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"headers": [],
|
|
||||||
"requestVariables": [],
|
|
||||||
"endpoint": "<<echoHoppBaseURL>>",
|
|
||||||
"testScript": "pw.test(\"Successfully parses secret variable holding the query param value\", () => {\n const secretQueryParamValue = pw.env.get(\"secretQueryParamValue\")\n pw.expect(secretQueryParamValue).toBe(\"secret-query-param-value\")\n \n if (secretQueryParamValue) {\n pw.expect(pw.response.body.args.secretQueryParamKey).toBe(secretQueryParamValue)\n }\n\n pw.expect(pw.env.get(\"secretQueryParamValueFromPreReqScript\")).toBe(\"secret-query-param-value\")\n})",
|
|
||||||
"preRequestScript": "const secretQueryParamValueFromPreReqScript = pw.env.get(\"secretQueryParamValue\")\npw.env.set(\"secretQueryParamValueFromPreReqScript\", secretQueryParamValueFromPreReqScript)"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"v": "3",
|
|
||||||
"auth": {
|
|
||||||
"authType": "basic",
|
|
||||||
"password": "<<secretBasicAuthPassword>>",
|
|
||||||
"username": "<<secretBasicAuthUsername>>",
|
|
||||||
"authActive": true
|
|
||||||
},
|
|
||||||
"body": {
|
|
||||||
"body": null,
|
|
||||||
"contentType": null
|
|
||||||
},
|
|
||||||
"name": "test-secret-basic-auth",
|
|
||||||
"method": "GET",
|
|
||||||
"params": [],
|
|
||||||
"headers": [],
|
|
||||||
"requestVariables": [],
|
|
||||||
"endpoint": "<<httpbinBaseURL>>/basic-auth/<<secretBasicAuthUsername>>/<<secretBasicAuthPassword>>",
|
|
||||||
"testScript": "pw.test(\"Successfully parses secret variables holding basic auth credentials\", () => {\n\tconst secretBasicAuthUsername = pw.env.get(\"secretBasicAuthUsername\")\n \tconst secretBasicAuthPassword = pw.env.get(\"secretBasicAuthPassword\")\n\n pw.expect(secretBasicAuthUsername).toBe(\"test-user\")\n pw.expect(secretBasicAuthPassword).toBe(\"test-pass\")\n\n // The endpoint at times results in a `502` bad gateway\n if (pw.response.status !== 200) {\n return\n }\n\n if (secretBasicAuthUsername && secretBasicAuthPassword) {\n const { authenticated, user } = pw.response.body\n pw.expect(authenticated).toBe(true)\n pw.expect(user).toBe(secretBasicAuthUsername)\n }\n});",
|
|
||||||
"preRequestScript": ""
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"v": "3",
|
|
||||||
"auth": {
|
|
||||||
"token": "<<secretBearerToken>>",
|
|
||||||
"authType": "bearer",
|
|
||||||
"password": "testpassword",
|
|
||||||
"username": "testuser",
|
|
||||||
"authActive": true
|
|
||||||
},
|
|
||||||
"body": {
|
|
||||||
"body": null,
|
|
||||||
"contentType": null
|
|
||||||
},
|
|
||||||
"name": "test-secret-bearer-auth",
|
|
||||||
"method": "GET",
|
|
||||||
"params": [],
|
|
||||||
"headers": [],
|
|
||||||
"requestVariables": [],
|
|
||||||
"endpoint": "<<httpbinBaseURL>>/bearer",
|
|
||||||
"testScript": "pw.test(\"Successfully parses secret variable holding the bearer token\", () => {\n const secretBearerToken = pw.env.get(\"secretBearerToken\")\n const preReqSecretBearerToken = pw.env.get(\"preReqSecretBearerToken\")\n\n pw.expect(secretBearerToken).toBe(\"test-token\")\n\n // Safeguard to prevent test failures due to the endpoint\n if (pw.response.status !== 200) {\n return\n }\n\n if (secretBearerToken) { \n pw.expect(pw.response.body.token).toBe(secretBearerToken)\n pw.expect(preReqSecretBearerToken).toBe(\"test-token\")\n }\n});",
|
|
||||||
"preRequestScript": "const secretBearerToken = pw.env.get(\"secretBearerToken\")\npw.env.set(\"preReqSecretBearerToken\", secretBearerToken)"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"v": "3",
|
|
||||||
"auth": {
|
|
||||||
"authType": "none",
|
|
||||||
"authActive": true
|
|
||||||
},
|
|
||||||
"body": {
|
|
||||||
"body": null,
|
|
||||||
"contentType": null
|
|
||||||
},
|
|
||||||
"name": "test-secret-fallback",
|
|
||||||
"method": "GET",
|
|
||||||
"params": [],
|
|
||||||
"headers": [],
|
|
||||||
"requestVariables": [],
|
|
||||||
"endpoint": "<<echoHoppBaseURL>>",
|
|
||||||
"testScript": "pw.test(\"Returns an empty string if the value for a secret environment variable is not found in the system environment\", () => {\n pw.expect(pw.env.get(\"nonExistentValueInSystemEnv\")).toBe(\"\")\n})",
|
|
||||||
"preRequestScript": ""
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"auth": {
|
|
||||||
"authType": "inherit",
|
|
||||||
"authActive": false
|
|
||||||
},
|
|
||||||
"headers": []
|
|
||||||
}
|
|
||||||
@@ -1,149 +0,0 @@
|
|||||||
{
|
|
||||||
"v": 2,
|
|
||||||
"name": "secret-envs-persistence-coll",
|
|
||||||
"folders": [],
|
|
||||||
"requests": [
|
|
||||||
{
|
|
||||||
"v": "3",
|
|
||||||
"auth": {
|
|
||||||
"authType": "none",
|
|
||||||
"authActive": true
|
|
||||||
},
|
|
||||||
"body": {
|
|
||||||
"body": null,
|
|
||||||
"contentType": null
|
|
||||||
},
|
|
||||||
"name": "test-secret-headers",
|
|
||||||
"method": "GET",
|
|
||||||
"params": [],
|
|
||||||
"requestVariables": [],
|
|
||||||
"headers": [
|
|
||||||
{
|
|
||||||
"key": "Secret-Header-Key",
|
|
||||||
"value": "<<secretHeaderValue>>",
|
|
||||||
"active": true
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"endpoint": "<<echoHoppBaseURL>>",
|
|
||||||
"testScript": "pw.test(\"Successfully parses secret variable holding the header value\", () => {\n const secretHeaderValue = pw.env.getResolve(\"secretHeaderValue\")\n pw.expect(secretHeaderValue).toBe(\"secret-header-value\")\n \n if (secretHeaderValue) {\n pw.expect(pw.response.body.headers[\"secret-header-key\"]).toBe(secretHeaderValue)\n }\n\n pw.expect(pw.env.getResolve(\"secretHeaderValueFromPreReqScript\")).toBe(\"secret-header-value\")\n})",
|
|
||||||
"preRequestScript": "pw.env.set(\"secretHeaderValue\", \"secret-header-value\")\n\nconst secretHeaderValueFromPreReqScript = pw.env.getResolve(\"secretHeaderValue\")\npw.env.set(\"secretHeaderValueFromPreReqScript\", secretHeaderValueFromPreReqScript)"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"v": "3",
|
|
||||||
"auth": {
|
|
||||||
"authType": "none",
|
|
||||||
"authActive": true
|
|
||||||
},
|
|
||||||
"body": {
|
|
||||||
"body": null,
|
|
||||||
"contentType": null
|
|
||||||
},
|
|
||||||
"name": "test-secret-headers-overrides",
|
|
||||||
"method": "GET",
|
|
||||||
"params": [],
|
|
||||||
"requestVariables": [],
|
|
||||||
"headers": [
|
|
||||||
{
|
|
||||||
"key": "Secret-Header-Key",
|
|
||||||
"value": "<<secretHeaderValue>>",
|
|
||||||
"active": true
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"endpoint": "<<echoHoppBaseURL>>",
|
|
||||||
"testScript": "pw.test(\"Value set at the pre-request script takes precedence\", () => {\n const secretHeaderValue = pw.env.getResolve(\"secretHeaderValue\")\n pw.expect(secretHeaderValue).toBe(\"secret-header-value-overriden\")\n \n if (secretHeaderValue) {\n pw.expect(pw.response.body.headers[\"secret-header-key\"]).toBe(secretHeaderValue)\n }\n\n pw.expect(pw.env.getResolve(\"secretHeaderValueFromPreReqScript\")).toBe(\"secret-header-value-overriden\")\n})",
|
|
||||||
"preRequestScript": "pw.env.set(\"secretHeaderValue\", \"secret-header-value-overriden\")\n\nconst secretHeaderValueFromPreReqScript = pw.env.getResolve(\"secretHeaderValue\")\npw.env.set(\"secretHeaderValueFromPreReqScript\", secretHeaderValueFromPreReqScript)"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"v": "3",
|
|
||||||
"auth": {
|
|
||||||
"authType": "none",
|
|
||||||
"authActive": true
|
|
||||||
},
|
|
||||||
"body": {
|
|
||||||
"body": "{\n \"secretBodyKey\": \"<<secretBodyValue>>\"\n}",
|
|
||||||
"contentType": "application/json"
|
|
||||||
},
|
|
||||||
"name": "test-secret-body",
|
|
||||||
"method": "POST",
|
|
||||||
"params": [],
|
|
||||||
"requestVariables": [],
|
|
||||||
"headers": [],
|
|
||||||
"endpoint": "<<echoHoppBaseURL>>/post",
|
|
||||||
"testScript": "pw.test(\"Successfully parses secret variable holding the request body value\", () => {\n const secretBodyValue = pw.env.get(\"secretBodyValue\")\n pw.expect(secretBodyValue).toBe(\"secret-body-value\")\n \n if (secretBodyValue) {\n pw.expect(JSON.parse(pw.response.body.data).secretBodyKey).toBe(secretBodyValue)\n }\n\n pw.expect(pw.env.get(\"secretBodyValueFromPreReqScript\")).toBe(\"secret-body-value\")\n})",
|
|
||||||
"preRequestScript": "const secretBodyValue = pw.env.get(\"secretBodyValue\")\n\nif (!secretBodyValue) { \n pw.env.set(\"secretBodyValue\", \"secret-body-value\")\n}\n\nconst secretBodyValueFromPreReqScript = pw.env.get(\"secretBodyValue\")\npw.env.set(\"secretBodyValueFromPreReqScript\", secretBodyValueFromPreReqScript)"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"v": "3",
|
|
||||||
"auth": {
|
|
||||||
"authType": "none",
|
|
||||||
"authActive": true
|
|
||||||
},
|
|
||||||
"body": {
|
|
||||||
"body": null,
|
|
||||||
"contentType": null
|
|
||||||
},
|
|
||||||
"name": "test-secret-query-params",
|
|
||||||
"method": "GET",
|
|
||||||
"params": [
|
|
||||||
{
|
|
||||||
"key": "secretQueryParamKey",
|
|
||||||
"value": "<<secretQueryParamValue>>",
|
|
||||||
"active": true
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"requestVariables": [],
|
|
||||||
"headers": [],
|
|
||||||
"endpoint": "<<echoHoppBaseURL>>",
|
|
||||||
"testScript": "pw.test(\"Successfully parses secret variable holding the query param value\", () => {\n const secretQueryParamValue = pw.env.get(\"secretQueryParamValue\")\n pw.expect(secretQueryParamValue).toBe(\"secret-query-param-value\")\n \n if (secretQueryParamValue) {\n pw.expect(pw.response.body.args.secretQueryParamKey).toBe(secretQueryParamValue)\n }\n\n pw.expect(pw.env.get(\"secretQueryParamValueFromPreReqScript\")).toBe(\"secret-query-param-value\")\n})",
|
|
||||||
"preRequestScript": "const secretQueryParamValue = pw.env.get(\"secretQueryParamValue\")\n\nif (!secretQueryParamValue) {\n pw.env.set(\"secretQueryParamValue\", \"secret-query-param-value\")\n}\n\nconst secretQueryParamValueFromPreReqScript = pw.env.get(\"secretQueryParamValue\")\npw.env.set(\"secretQueryParamValueFromPreReqScript\", secretQueryParamValueFromPreReqScript)"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"v": "3",
|
|
||||||
"auth": {
|
|
||||||
"authType": "basic",
|
|
||||||
"password": "<<secretBasicAuthPassword>>",
|
|
||||||
"username": "<<secretBasicAuthUsername>>",
|
|
||||||
"authActive": true
|
|
||||||
},
|
|
||||||
"body": {
|
|
||||||
"body": null,
|
|
||||||
"contentType": null
|
|
||||||
},
|
|
||||||
"name": "test-secret-basic-auth",
|
|
||||||
"method": "GET",
|
|
||||||
"params": [],
|
|
||||||
"requestVariables": [],
|
|
||||||
"headers": [],
|
|
||||||
"endpoint": "<<httpbinBaseURL>>/basic-auth/<<secretBasicAuthUsername>>/<<secretBasicAuthPassword>>",
|
|
||||||
"testScript": "pw.test(\"Successfully parses secret variables holding basic auth credentials\", () => {\n\tconst secretBasicAuthUsername = pw.env.get(\"secretBasicAuthUsername\")\n \tconst secretBasicAuthPassword = pw.env.get(\"secretBasicAuthPassword\")\n\n pw.expect(secretBasicAuthUsername).toBe(\"test-user\")\n pw.expect(secretBasicAuthPassword).toBe(\"test-pass\")\n\n // The endpoint at times results in a `502` bad gateway\n if (pw.response.status !== 200) {\n return\n }\n\n if (secretBasicAuthUsername && secretBasicAuthPassword) {\n const { authenticated, user } = pw.response.body\n pw.expect(authenticated).toBe(true)\n pw.expect(user).toBe(secretBasicAuthUsername)\n }\n});",
|
|
||||||
"preRequestScript": "let secretBasicAuthUsername = pw.env.get(\"secretBasicAuthUsername\")\n\nlet secretBasicAuthPassword = pw.env.get(\"secretBasicAuthPassword\")\n\nif (!secretBasicAuthUsername) {\n pw.env.set(\"secretBasicAuthUsername\", \"test-user\")\n}\n\nif (!secretBasicAuthPassword) {\n pw.env.set(\"secretBasicAuthPassword\", \"test-pass\")\n}"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"v": "3",
|
|
||||||
"auth": {
|
|
||||||
"token": "<<secretBearerToken>>",
|
|
||||||
"authType": "bearer",
|
|
||||||
"password": "testpassword",
|
|
||||||
"username": "testuser",
|
|
||||||
"authActive": true
|
|
||||||
},
|
|
||||||
"body": {
|
|
||||||
"body": null,
|
|
||||||
"contentType": null
|
|
||||||
},
|
|
||||||
"name": "test-secret-bearer-auth",
|
|
||||||
"method": "GET",
|
|
||||||
"params": [],
|
|
||||||
"requestVariables": [],
|
|
||||||
"headers": [],
|
|
||||||
"endpoint": "<<httpbinBaseURL>>/bearer",
|
|
||||||
"testScript": "pw.test(\"Successfully parses secret variable holding the bearer token\", () => {\n const secretBearerToken = pw.env.resolve(\"<<secretBearerToken>>\")\n const preReqSecretBearerToken = pw.env.resolve(\"<<preReqSecretBearerToken>>\")\n\n pw.expect(secretBearerToken).toBe(\"test-token\")\n\n // Safeguard to prevent test failures due to the endpoint\n if (pw.response.status !== 200) {\n return\n }\n\n if (secretBearerToken) { \n pw.expect(pw.response.body.token).toBe(secretBearerToken)\n pw.expect(preReqSecretBearerToken).toBe(\"test-token\")\n }\n});",
|
|
||||||
"preRequestScript": "let secretBearerToken = pw.env.resolve(\"<<secretBearerToken>>\")\n\nif (!secretBearerToken) {\n pw.env.set(\"secretBearerToken\", \"test-token\")\n secretBearerToken = pw.env.resolve(\"<<secretBearerToken>>\")\n}\n\npw.env.set(\"preReqSecretBearerToken\", secretBearerToken)"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"auth": {
|
|
||||||
"authType": "inherit",
|
|
||||||
"authActive": false
|
|
||||||
},
|
|
||||||
"headers": []
|
|
||||||
}
|
|
||||||
@@ -1,31 +0,0 @@
|
|||||||
{
|
|
||||||
"v": 2,
|
|
||||||
"name": "secret-envs-persistence-scripting-req",
|
|
||||||
"folders": [],
|
|
||||||
"requests": [
|
|
||||||
{
|
|
||||||
"v": "3",
|
|
||||||
"endpoint": "https://echo.hoppscotch.io/post",
|
|
||||||
"name": "req",
|
|
||||||
"params": [],
|
|
||||||
"headers": [
|
|
||||||
{
|
|
||||||
"active": true,
|
|
||||||
"key": "Custom-Header",
|
|
||||||
"value": "<<customHeaderValueFromSecretVar>>"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"method": "POST",
|
|
||||||
"auth": { "authType": "none", "authActive": true },
|
|
||||||
"preRequestScript": "pw.env.set(\"preReqVarOne\", \"pre-req-value-one\")\n\npw.env.set(\"preReqVarTwo\", \"pre-req-value-two\")\n\npw.env.set(\"customHeaderValueFromSecretVar\", \"custom-header-secret-value\")\n\npw.env.set(\"customBodyValue\", \"custom-body-value\")",
|
|
||||||
"testScript": "pw.test(\"Secret environment value set from the pre-request script takes precedence\", () => {\n pw.expect(pw.env.get(\"preReqVarOne\")).toBe(\"pre-req-value-one\")\n})\n\npw.test(\"Successfully sets initial value for the secret variable from the pre-request script\", () => {\n pw.env.set(\"postReqVarTwo\", \"post-req-value-two\")\n pw.expect(pw.env.get(\"postReqVarTwo\")).toBe(\"post-req-value-two\")\n})\n\npw.test(\"Successfully resolves secret variable values referred in request headers that are set in pre-request script\", () => {\n pw.expect(pw.response.body.headers[\"custom-header\"]).toBe(\"custom-header-secret-value\")\n})\n\npw.test(\"Successfully resolves secret variable values referred in request body that are set in pre-request script\", () => {\n pw.expect(JSON.parse(pw.response.body.data).key).toBe(\"custom-body-value\")\n})\n\npw.test(\"Secret environment variable set from the post-request script takes precedence\", () => {\n pw.env.set(\"postReqVarOne\", \"post-req-value-one\")\n pw.expect(pw.env.get(\"postReqVarOne\")).toBe(\"post-req-value-one\")\n})\n\npw.test(\"Successfully sets initial value for the secret variable from the post-request script\", () => {\n pw.env.set(\"postReqVarTwo\", \"post-req-value-two\")\n pw.expect(pw.env.get(\"postReqVarTwo\")).toBe(\"post-req-value-two\")\n})\n\npw.test(\"Successfully removes environment variables via the pw.env.unset method\", () => {\n pw.env.unset(\"preReqVarOne\")\n pw.env.unset(\"postReqVarTwo\")\n\n pw.expect(pw.env.get(\"preReqVarOne\")).toBe(undefined)\n pw.expect(pw.env.get(\"postReqVarTwo\")).toBe(undefined)\n})",
|
|
||||||
"body": {
|
|
||||||
"contentType": "application/json",
|
|
||||||
"body": "{\n \"key\": \"<<customBodyValue>>\"\n}"
|
|
||||||
},
|
|
||||||
"requestVariables": []
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"auth": { "authType": "inherit", "authActive": false },
|
|
||||||
"headers": []
|
|
||||||
}
|
|
||||||
@@ -4,7 +4,7 @@
|
|||||||
"folders": [],
|
"folders": [],
|
||||||
"requests": [
|
"requests": [
|
||||||
{
|
{
|
||||||
"v": "3",
|
"v": "1",
|
||||||
"endpoint": "<<URL>>",
|
"endpoint": "<<URL>>",
|
||||||
"name": "test1",
|
"name": "test1",
|
||||||
"params": [],
|
"params": [],
|
||||||
@@ -16,8 +16,7 @@
|
|||||||
"body": {
|
"body": {
|
||||||
"contentType": "application/json",
|
"contentType": "application/json",
|
||||||
"body": "{\n \"<<BODY_KEY>>\":\"<<BODY_VALUE>>\"\n}"
|
"body": "{\n \"<<BODY_KEY>>\":\"<<BODY_VALUE>>\"\n}"
|
||||||
},
|
}
|
||||||
"requestVariables": []
|
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
@@ -1,32 +0,0 @@
|
|||||||
[
|
|
||||||
{
|
|
||||||
"v": 0,
|
|
||||||
"name": "Env-I",
|
|
||||||
"variables": [
|
|
||||||
{
|
|
||||||
"key": "firstName",
|
|
||||||
"value": "John"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"key": "lastName",
|
|
||||||
"value": "Doe"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"v": 1,
|
|
||||||
"id": "2",
|
|
||||||
"name": "Env-II",
|
|
||||||
"variables": [
|
|
||||||
{
|
|
||||||
"key": "baseUrl",
|
|
||||||
"value": "https://echo.hoppscotch.io",
|
|
||||||
"secret": false
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"key": "secretVar",
|
|
||||||
"secret": true
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
]
|
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
{
|
|
||||||
"name": "env-v0",
|
|
||||||
"variables": [
|
|
||||||
{
|
|
||||||
"key": "baseURL",
|
|
||||||
"value": "https://echo.hoppscotch.io"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
{
|
|
||||||
"name": "env-v0",
|
|
||||||
"variables": [
|
|
||||||
{
|
|
||||||
"key": "baseURL",
|
|
||||||
"value": "https://echo.hoppscotch.io",
|
|
||||||
"secret": false
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
@@ -1,16 +0,0 @@
|
|||||||
{
|
|
||||||
"id": 123,
|
|
||||||
"v": "1",
|
|
||||||
"name": "secret-envs",
|
|
||||||
"values": [
|
|
||||||
{
|
|
||||||
"key": "secretVar",
|
|
||||||
"secret": true
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"key": "regularVar",
|
|
||||||
"secret": false,
|
|
||||||
"value": "regular-variable"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
@@ -1,38 +0,0 @@
|
|||||||
{
|
|
||||||
"v": 0,
|
|
||||||
"name": "Response body sample",
|
|
||||||
"variables": [
|
|
||||||
{
|
|
||||||
"key": "firstName",
|
|
||||||
"value": "John"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"key": "lastName",
|
|
||||||
"value": "Doe"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"key": "id",
|
|
||||||
"value": "7"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"key": "fullName",
|
|
||||||
"value": "<<firstName>> <<lastName>>"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"key": "recursiveVarX",
|
|
||||||
"value": "<<recursiveVarY>>"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"key": "recursiveVarY",
|
|
||||||
"value": "<<salutation>>"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"key": "salutation",
|
|
||||||
"value": "Hello"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"key": "greetText",
|
|
||||||
"value": "<<salutation>> <<fullName>>"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
@@ -1,27 +0,0 @@
|
|||||||
{
|
|
||||||
"v": 1,
|
|
||||||
"id": "2",
|
|
||||||
"name": "secret-envs-persistence-scripting-envs",
|
|
||||||
"variables": [
|
|
||||||
{
|
|
||||||
"key": "preReqVarOne",
|
|
||||||
"secret": true
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"key": "preReqVarTwo",
|
|
||||||
"secret": true
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"key": "postReqVarOne",
|
|
||||||
"secret": true
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"key": "preReqVarTwo",
|
|
||||||
"secret": true
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"key": "customHeaderValueFromSecretVar",
|
|
||||||
"secret": true
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
@@ -1,45 +0,0 @@
|
|||||||
{
|
|
||||||
"id": "2",
|
|
||||||
"v": 1,
|
|
||||||
"name": "secret-envs",
|
|
||||||
"variables": [
|
|
||||||
{
|
|
||||||
"key": "secretBearerToken",
|
|
||||||
"secret": true
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"key": "secretBasicAuthUsername",
|
|
||||||
"secret": true
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"key": "secretBasicAuthPassword",
|
|
||||||
"secret": true
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"key": "secretQueryParamValue",
|
|
||||||
"secret": true
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"key": "secretBodyValue",
|
|
||||||
"secret": true
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"key": "secretHeaderValue",
|
|
||||||
"secret": true
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"key": "nonExistentValueInSystemEnv",
|
|
||||||
"secret": true
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"key": "echoHoppBaseURL",
|
|
||||||
"value": "https://echo.hoppscotch.io",
|
|
||||||
"secret": false
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"key": "httpbinBaseURL",
|
|
||||||
"value": "https://httpbin.org",
|
|
||||||
"secret": false
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
@@ -1,51 +0,0 @@
|
|||||||
{
|
|
||||||
"v": 1,
|
|
||||||
"id": "2",
|
|
||||||
"name": "secret-values-envs",
|
|
||||||
"variables": [
|
|
||||||
{
|
|
||||||
"key": "secretBearerToken",
|
|
||||||
"value": "test-token",
|
|
||||||
"secret": true
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"key": "secretBasicAuthUsername",
|
|
||||||
"value": "test-user",
|
|
||||||
"secret": true
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"key": "secretBasicAuthPassword",
|
|
||||||
"value": "test-pass",
|
|
||||||
"secret": true
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"key": "secretQueryParamValue",
|
|
||||||
"value": "secret-query-param-value",
|
|
||||||
"secret": true
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"key": "secretBodyValue",
|
|
||||||
"value": "secret-body-value",
|
|
||||||
"secret": true
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"key": "secretHeaderValue",
|
|
||||||
"value": "secret-header-value",
|
|
||||||
"secret": true
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"key": "nonExistentValueInSystemEnv",
|
|
||||||
"secret": true
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"key": "echoHoppBaseURL",
|
|
||||||
"value": "https://echo.hoppscotch.io",
|
|
||||||
"secret": false
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"key": "httpbinBaseURL",
|
|
||||||
"value": "https://httpbin.org",
|
|
||||||
"secret": false
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
@@ -5,7 +5,7 @@
|
|||||||
"folders": [],
|
"folders": [],
|
||||||
"requests": [
|
"requests": [
|
||||||
{
|
{
|
||||||
"v": "3",
|
"v": "1",
|
||||||
"endpoint": "https://echo.hoppscotch.io/<<HEADERS_TYPE1>>",
|
"endpoint": "https://echo.hoppscotch.io/<<HEADERS_TYPE1>>",
|
||||||
"name": "",
|
"name": "",
|
||||||
"params": [],
|
"params": [],
|
||||||
@@ -13,18 +13,20 @@
|
|||||||
"method": "GET",
|
"method": "GET",
|
||||||
"auth": {
|
"auth": {
|
||||||
"authType": "none",
|
"authType": "none",
|
||||||
"authActive": true
|
"authActive": true,
|
||||||
|
"addTo": "Headers",
|
||||||
|
"key": "",
|
||||||
|
"value": ""
|
||||||
},
|
},
|
||||||
"preRequestScript": "pw.env.set(\"HEADERS_TYPE1\", \"devblin_local1\");",
|
"preRequestScript": "pw.env.set(\"HEADERS_TYPE1\", \"devblin_local1\");",
|
||||||
"testScript": "// Check status code is 200\npwd.test(\"Status code is 200\", ()=> {\n pw.expect(pw.response.status).toBe(200);\n});\n\n// Check JSON response property\npw.test(\"Check JSON response property\", ()=> {\n pw.expect(pw.response.body.method).toBe(\"GET\");\n pw.expect(pw.response.body.headers).toBeType(\"string\");\n});",
|
"testScript": "// Check status code is 200\npwd.test(\"Status code is 200\", ()=> {\n pw.expect(pw.response.status).toBe(200);\n});\n\n// Check JSON response property\npw.test(\"Check JSON response property\", ()=> {\n pw.expect(pw.response.body.method).toBe(\"GET\");\n pw.expect(pw.response.body.headers).toBeType(\"string\");\n});",
|
||||||
"body": {
|
"body": {
|
||||||
"contentType": "application/json",
|
"contentType": "application/json",
|
||||||
"body": "{\n\"test\": \"<<HEADERS_TYPE1>>\"\n}"
|
"body": "{\n\"test\": \"<<HEADERS_TYPE1>>\"\n}"
|
||||||
},
|
}
|
||||||
"requestVariables": []
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"v": "3",
|
"v": "1",
|
||||||
"endpoint": "https://echo.hoppscotch.dio/<<HEADERS_TYPE2>>",
|
"endpoint": "https://echo.hoppscotch.dio/<<HEADERS_TYPE2>>",
|
||||||
"name": "success",
|
"name": "success",
|
||||||
"params": [],
|
"params": [],
|
||||||
@@ -32,15 +34,17 @@
|
|||||||
"method": "GET",
|
"method": "GET",
|
||||||
"auth": {
|
"auth": {
|
||||||
"authType": "none",
|
"authType": "none",
|
||||||
"authActive": true
|
"authActive": true,
|
||||||
|
"addTo": "Headers",
|
||||||
|
"key": "",
|
||||||
|
"value": ""
|
||||||
},
|
},
|
||||||
"preRequestScript": "pw.env.setd(\"HEADERS_TYPE2\", \"devblin_local2\");",
|
"preRequestScript": "pw.env.setd(\"HEADERS_TYPE2\", \"devblin_local2\");",
|
||||||
"testScript": "// Check status code is 200\npw.test(\"Status code is 200\", ()=> {\n pw.expect(pw.response.status).toBe(300);\n});\n\n// Check JSON response property\npw.test(\"Check JSON response property\", ()=> {\n pw.expect(pw.response.body.method).toBe(\"GET\");\n pw.expect(pw.response.body.headers).toBeType(\"object\");\n});",
|
"testScript": "// Check status code is 200\npw.test(\"Status code is 200\", ()=> {\n pw.expect(pw.response.status).toBe(300);\n});\n\n// Check JSON response property\npw.test(\"Check JSON response property\", ()=> {\n pw.expect(pw.response.body.method).toBe(\"GET\");\n pw.expect(pw.response.body.headers).toBeType(\"object\");\n});",
|
||||||
"body": {
|
"body": {
|
||||||
"contentType": "application/json",
|
"contentType": "application/json",
|
||||||
"body": "{\n\"test\": \"<<HEADERS_TYPE2>>\"\n}"
|
"body": "{\n\"test\": \"<<HEADERS_TYPE2>>\"\n}"
|
||||||
},
|
}
|
||||||
"requestVariables": []
|
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
@@ -2,9 +2,9 @@
|
|||||||
{
|
{
|
||||||
"v": 1,
|
"v": 1,
|
||||||
"folders": [],
|
"folders": [],
|
||||||
"requests":
|
"requests":
|
||||||
{
|
{
|
||||||
"v": "3",
|
"v": "1",
|
||||||
"endpoint": "https://echo.hoppscotch.io/<<HEADERS_TYPE1>>",
|
"endpoint": "https://echo.hoppscotch.io/<<HEADERS_TYPE1>>",
|
||||||
"name": "fail",
|
"name": "fail",
|
||||||
"params": [],
|
"params": [],
|
||||||
@@ -12,18 +12,20 @@
|
|||||||
"method": "GET",
|
"method": "GET",
|
||||||
"auth": {
|
"auth": {
|
||||||
"authType": "none",
|
"authType": "none",
|
||||||
"authActive": true
|
"authActive": true,
|
||||||
|
"addTo": "Headers",
|
||||||
|
"key": "",
|
||||||
|
"value": ""
|
||||||
},
|
},
|
||||||
"preRequestScript": "pw.env.set(\"HEADERS_TYPE1\", \"devblin_local1\");",
|
"preRequestScript": "pw.env.set(\"HEADERS_TYPE1\", \"devblin_local1\");",
|
||||||
"testScript": "// Check status code is 200\npw.test(\"Status code is 200\", ()=> {\n pw.expect(pw.response.status).toBe(200);\n});\n\n// Check JSON response property\npw.test(\"Check JSON response property\", ()=> {\n pw.expect(pw.response.body.method).toBe(\"GET\");\n pw.expect(pw.response.body.headers).toBeType(\"string\");\n});",
|
"testScript": "// Check status code is 200\npw.test(\"Status code is 200\", ()=> {\n pw.expect(pw.response.status).toBe(200);\n});\n\n// Check JSON response property\npw.test(\"Check JSON response property\", ()=> {\n pw.expect(pw.response.body.method).toBe(\"GET\");\n pw.expect(pw.response.body.headers).toBeType(\"string\");\n});",
|
||||||
"body": {
|
"body": {
|
||||||
"contentType": "application/json",
|
"contentType": "application/json",
|
||||||
"body": "{\n\"test\": \"<<HEADERS_TYPE1>>\"\n}"
|
"body": "{\n\"test\": \"<<HEADERS_TYPE1>>\"\n}"
|
||||||
},
|
}
|
||||||
"requestVariables": [],
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"v": "3",
|
"v": "1",
|
||||||
"endpoint": "https://echo.hoppscotch.io/<<HEADERS_TYPE2>>",
|
"endpoint": "https://echo.hoppscotch.io/<<HEADERS_TYPE2>>",
|
||||||
"name": "success",
|
"name": "success",
|
||||||
"params": [],
|
"params": [],
|
||||||
@@ -31,15 +33,17 @@
|
|||||||
"method": "GET",
|
"method": "GET",
|
||||||
"auth": {
|
"auth": {
|
||||||
"authType": "none",
|
"authType": "none",
|
||||||
"authActive": true
|
"authActive": true,
|
||||||
|
"addTo": "Headers",
|
||||||
|
"key": "",
|
||||||
|
"value": ""
|
||||||
},
|
},
|
||||||
"preRequestScript": "pw.env.set(\"HEADERS_TYPE2\", \"devblin_local2\");",
|
"preRequestScript": "pw.env.set(\"HEADERS_TYPE2\", \"devblin_local2\");",
|
||||||
"testScript": "// Check status code is 200\npw.test(\"Status code is 200\", ()=> {\n pw.expect(pw.response.status).toBe(300);\n});\n\n// Check JSON response property\npw.test(\"Check JSON response property\", ()=> {\n pw.expect(pw.response.body.method).toBe(\"GET\");\n pw.expect(pw.response.body.headers).toBeType(\"object\");\n});",
|
"testScript": "// Check status code is 200\npw.test(\"Status code is 200\", ()=> {\n pw.expect(pw.response.status).toBe(300);\n});\n\n// Check JSON response property\npw.test(\"Check JSON response property\", ()=> {\n pw.expect(pw.response.body.method).toBe(\"GET\");\n pw.expect(pw.response.body.headers).toBeType(\"object\");\n});",
|
||||||
"body": {
|
"body": {
|
||||||
"contentType": "application/json",
|
"contentType": "application/json",
|
||||||
"body": "{\n\"test\": \"<<HEADERS_TYPE2>>\"\n}"
|
"body": "{\n\"test\": \"<<HEADERS_TYPE2>>\"\n}"
|
||||||
},
|
}
|
||||||
"requestVariables": []
|
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
@@ -2,9 +2,9 @@
|
|||||||
{
|
{
|
||||||
"v": 1,
|
"v": 1,
|
||||||
"folders": [],
|
"folders": [],
|
||||||
"requests":
|
"requests":
|
||||||
{
|
{
|
||||||
"v": "2",
|
"v": "1",
|
||||||
"endpoint": "https://echo.hoppscotch.io/<<HEADERS_TYPE1>>",
|
"endpoint": "https://echo.hoppscotch.io/<<HEADERS_TYPE1>>",
|
||||||
"name": "fail",
|
"name": "fail",
|
||||||
"params": [],
|
"params": [],
|
||||||
@@ -22,8 +22,7 @@
|
|||||||
"body": {
|
"body": {
|
||||||
"contentType": "application/json",
|
"contentType": "application/json",
|
||||||
"body": "{\n\"test\": \"<<HEADERS_TYPE1>>\"\n}"
|
"body": "{\n\"test\": \"<<HEADERS_TYPE1>>\"\n}"
|
||||||
},
|
}
|
||||||
"requestVariables": []
|
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
@@ -5,7 +5,7 @@
|
|||||||
"folders": [],
|
"folders": [],
|
||||||
"requests": [
|
"requests": [
|
||||||
{
|
{
|
||||||
"v": "3",
|
"v": "1",
|
||||||
"endpoint": "https://echo.hoppscotch.io/<<HEADERS_TYPE1>>",
|
"endpoint": "https://echo.hoppscotch.io/<<HEADERS_TYPE1>>",
|
||||||
"name": "",
|
"name": "",
|
||||||
"params": [],
|
"params": [],
|
||||||
@@ -13,18 +13,20 @@
|
|||||||
"method": "GET",
|
"method": "GET",
|
||||||
"auth": {
|
"auth": {
|
||||||
"authType": "none",
|
"authType": "none",
|
||||||
"authActive": true
|
"authActive": true,
|
||||||
|
"addTo": "Headers",
|
||||||
|
"key": "",
|
||||||
|
"value": ""
|
||||||
},
|
},
|
||||||
"preRequestScript": "pw.env.set(\"HEADERS_TYPE1\", \"devblin_local1\");",
|
"preRequestScript": "pw.env.set(\"HEADERS_TYPE1\", \"devblin_local1\");",
|
||||||
"testScript": "// Check status code is 200\npw.test(\"Status code is 200\", ()=> {\n pw.expect(pw.response.status).toBe(200);\n});\n\n// Check JSON response property\npw.test(\"Check JSON response property\", ()=> {\n pw.expect(pw.response.body.method).toBe(\"GET\");\n pw.expect(pw.response.body.headers).toBeType(\"object\");\n});",
|
"testScript": "// Check status code is 200\npw.test(\"Status code is 200\", ()=> {\n pw.expect(pw.response.status).toBe(200);\n});\n\n// Check JSON response property\npw.test(\"Check JSON response property\", ()=> {\n pw.expect(pw.response.body.method).toBe(\"GET\");\n pw.expect(pw.response.body.headers).toBeType(\"object\");\n});",
|
||||||
"body": {
|
"body": {
|
||||||
"contentType": "application/json",
|
"contentType": "application/json",
|
||||||
"body": "{\n\"test\": \"<<HEADERS_TYPE1>>\"\n}"
|
"body": "{\n\"test\": \"<<HEADERS_TYPE1>>\"\n}"
|
||||||
},
|
}
|
||||||
"requestVariables": []
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"v": "3",
|
"v": "1",
|
||||||
"endpoint": "https://echo.hoppscotch.io/<<HEADERS_TYPE2>>",
|
"endpoint": "https://echo.hoppscotch.io/<<HEADERS_TYPE2>>",
|
||||||
"name": "success",
|
"name": "success",
|
||||||
"params": [],
|
"params": [],
|
||||||
@@ -32,15 +34,17 @@
|
|||||||
"method": "GET",
|
"method": "GET",
|
||||||
"auth": {
|
"auth": {
|
||||||
"authType": "none",
|
"authType": "none",
|
||||||
"authActive": true
|
"authActive": true,
|
||||||
|
"addTo": "Headers",
|
||||||
|
"key": "",
|
||||||
|
"value": ""
|
||||||
},
|
},
|
||||||
"preRequestScript": "pw.env.set(\"HEADERS_TYPE2\", \"devblin_local2\");",
|
"preRequestScript": "pw.env.set(\"HEADERS_TYPE2\", \"devblin_local2\");",
|
||||||
"testScript": "// Check status code is 200\npw.test(\"Status code is 200\", ()=> {\n pw.expect(pw.response.status).toBe(200);\n});\n\n// Check JSON response property\npw.test(\"Check JSON response property\", ()=> {\n pw.expect(pw.response.body.method).toBe(\"GET\");\n pw.expect(pw.response.body.headers).toBeType(\"object\");\n});",
|
"testScript": "// Check status code is 200\npw.test(\"Status code is 200\", ()=> {\n pw.expect(pw.response.status).toBe(200);\n});\n\n// Check JSON response property\npw.test(\"Check JSON response property\", ()=> {\n pw.expect(pw.response.body.method).toBe(\"GET\");\n pw.expect(pw.response.body.headers).toBeType(\"object\");\n});",
|
||||||
"body": {
|
"body": {
|
||||||
"contentType": "application/json",
|
"contentType": "application/json",
|
||||||
"body": "{\n\"test\": \"<<HEADERS_TYPE2>>\"\n}"
|
"body": "{\n\"test\": \"<<HEADERS_TYPE2>>\"\n}"
|
||||||
},
|
}
|
||||||
"requestVariables": []
|
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
@@ -1,18 +1,10 @@
|
|||||||
import { exec } from "child_process";
|
import { exec } from "child_process";
|
||||||
import { resolve } from "path";
|
|
||||||
|
|
||||||
import { ExecResponse } from "./types";
|
import { ExecResponse } from "./types";
|
||||||
|
|
||||||
export const runCLI = (args: string, options = {}): Promise<ExecResponse> => {
|
export const execAsync = (command: string): Promise<ExecResponse> =>
|
||||||
const CLI_PATH = resolve(__dirname, "../../bin/hopp.js");
|
new Promise((resolve) =>
|
||||||
const command = `node ${CLI_PATH} ${args}`;
|
exec(command, (error, stdout, stderr) => resolve({ error, stdout, stderr }))
|
||||||
|
|
||||||
return new Promise((resolve) =>
|
|
||||||
exec(command, options, (error, stdout, stderr) =>
|
|
||||||
resolve({ error, stdout, stderr })
|
|
||||||
)
|
|
||||||
);
|
);
|
||||||
};
|
|
||||||
|
|
||||||
export const trimAnsi = (target: string) => {
|
export const trimAnsi = (target: string) => {
|
||||||
const ansiRegex =
|
const ansiRegex =
|
||||||
@@ -23,21 +15,12 @@ export const trimAnsi = (target: string) => {
|
|||||||
|
|
||||||
export const getErrorCode = (out: string) => {
|
export const getErrorCode = (out: string) => {
|
||||||
const ansiTrimmedStr = trimAnsi(out);
|
const ansiTrimmedStr = trimAnsi(out);
|
||||||
|
|
||||||
return ansiTrimmedStr.split(" ")[0];
|
return ansiTrimmedStr.split(" ")[0];
|
||||||
};
|
};
|
||||||
|
|
||||||
export const getTestJsonFilePath = (
|
export const getTestJsonFilePath = (file: string) => {
|
||||||
file: string,
|
const filePath = `${process.cwd()}/src/__tests__/samples/${file}`;
|
||||||
kind: "collection" | "environment"
|
|
||||||
) => {
|
|
||||||
const kindDir = {
|
|
||||||
collection: "collections",
|
|
||||||
environment: "environments",
|
|
||||||
}[kind];
|
|
||||||
|
|
||||||
const filePath = resolve(
|
|
||||||
__dirname,
|
|
||||||
`../../src/__tests__/samples/${kindDir}/${file}`
|
|
||||||
);
|
|
||||||
return filePath;
|
return filePath;
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -1,7 +1,6 @@
|
|||||||
import chalk from "chalk";
|
import chalk from "chalk";
|
||||||
import { Command } from "commander";
|
import { program } from "commander";
|
||||||
import * as E from "fp-ts/Either";
|
import * as E from "fp-ts/Either";
|
||||||
|
|
||||||
import { version } from "../package.json";
|
import { version } from "../package.json";
|
||||||
import { test } from "./commands/test";
|
import { test } from "./commands/test";
|
||||||
import { handleError } from "./handlers/error";
|
import { handleError } from "./handlers/error";
|
||||||
@@ -21,8 +20,6 @@ const CLI_AFTER_ALL_TXT = `\nFor more help, head on to ${accent(
|
|||||||
"https://docs.hoppscotch.io/documentation/clients/cli"
|
"https://docs.hoppscotch.io/documentation/clients/cli"
|
||||||
)}`;
|
)}`;
|
||||||
|
|
||||||
const program = new Command();
|
|
||||||
|
|
||||||
program
|
program
|
||||||
.name("hopp")
|
.name("hopp")
|
||||||
.version(version, "-v, --ver", "see the current version of hopp-cli")
|
.version(version, "-v, --ver", "see the current version of hopp-cli")
|
||||||
|
|||||||
@@ -21,7 +21,6 @@ export interface RequestStack {
|
|||||||
*/
|
*/
|
||||||
export interface RequestConfig extends AxiosRequestConfig {
|
export interface RequestConfig extends AxiosRequestConfig {
|
||||||
supported: boolean;
|
supported: boolean;
|
||||||
displayUrl?: string
|
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface EffectiveHoppRESTRequest extends HoppRESTRequest {
|
export interface EffectiveHoppRESTRequest extends HoppRESTRequest {
|
||||||
@@ -31,7 +30,6 @@ export interface EffectiveHoppRESTRequest extends HoppRESTRequest {
|
|||||||
* This contains path, params and environment variables all applied to it
|
* This contains path, params and environment variables all applied to it
|
||||||
*/
|
*/
|
||||||
effectiveFinalURL: string;
|
effectiveFinalURL: string;
|
||||||
effectiveFinalDisplayURL?: string;
|
|
||||||
effectiveFinalHeaders: { key: string; value: string; active: boolean }[];
|
effectiveFinalHeaders: { key: string; value: string; active: boolean }[];
|
||||||
effectiveFinalParams: { key: string; value: string; active: boolean }[];
|
effectiveFinalParams: { key: string; value: string; active: boolean }[];
|
||||||
effectiveFinalBody: FormData | string | null;
|
effectiveFinalBody: FormData | string | null;
|
||||||
|
|||||||
@@ -1,56 +1,44 @@
|
|||||||
import { Environment } from "@hoppscotch/data";
|
|
||||||
import { entityReference } from "verzod";
|
|
||||||
import { z } from "zod";
|
|
||||||
|
|
||||||
import { error } from "../../types/errors";
|
import { error } from "../../types/errors";
|
||||||
import {
|
import {
|
||||||
HoppEnvKeyPairObject,
|
|
||||||
HoppEnvPair,
|
|
||||||
HoppEnvs,
|
HoppEnvs,
|
||||||
|
HoppEnvPair,
|
||||||
|
HoppEnvKeyPairObject,
|
||||||
|
HoppEnvExportObject,
|
||||||
|
HoppBulkEnvExportObject,
|
||||||
} from "../../types/request";
|
} from "../../types/request";
|
||||||
import { readJsonFile } from "../../utils/mutators";
|
import { readJsonFile } from "../../utils/mutators";
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Parses env json file for given path and validates the parsed env json object
|
* Parses env json file for given path and validates the parsed env json object.
|
||||||
* @param path Path of env.json file to be parsed
|
* @param path Path of env.json file to be parsed.
|
||||||
* @returns For successful parsing we get HoppEnvs object
|
* @returns For successful parsing we get HoppEnvs object.
|
||||||
*/
|
*/
|
||||||
export async function parseEnvsData(path: string) {
|
export async function parseEnvsData(path: string) {
|
||||||
const contents = await readJsonFile(path);
|
const contents = await readJsonFile(path);
|
||||||
const envPairs: Array<HoppEnvPair | Record<string, string>> = [];
|
const envPairs: Array<HoppEnvPair> = [];
|
||||||
|
|
||||||
// The legacy key-value pair format that is still supported
|
|
||||||
const HoppEnvKeyPairResult = HoppEnvKeyPairObject.safeParse(contents);
|
const HoppEnvKeyPairResult = HoppEnvKeyPairObject.safeParse(contents);
|
||||||
|
const HoppEnvExportObjectResult = HoppEnvExportObject.safeParse(contents);
|
||||||
|
const HoppBulkEnvExportObjectResult =
|
||||||
|
HoppBulkEnvExportObject.safeParse(contents);
|
||||||
|
|
||||||
// Shape of the single environment export object that is exported from the app
|
// CLI doesnt support bulk environments export.
|
||||||
const HoppEnvExportObjectResult = Environment.safeParse(contents);
|
// Hence we check for this case and throw an error if it matches the format.
|
||||||
|
|
||||||
// Shape of the bulk environment export object that is exported from the app
|
|
||||||
const HoppBulkEnvExportObjectResult = z
|
|
||||||
.array(entityReference(Environment))
|
|
||||||
.safeParse(contents);
|
|
||||||
|
|
||||||
// CLI doesnt support bulk environments export
|
|
||||||
// Hence we check for this case and throw an error if it matches the format
|
|
||||||
if (HoppBulkEnvExportObjectResult.success) {
|
if (HoppBulkEnvExportObjectResult.success) {
|
||||||
throw error({ code: "BULK_ENV_FILE", path, data: error });
|
throw error({ code: "BULK_ENV_FILE", path, data: error });
|
||||||
}
|
}
|
||||||
|
|
||||||
// Checks if the environment file is of the correct format
|
// Checks if the environment file is of the correct format.
|
||||||
// If it doesnt match either of them, we throw an error
|
// If it doesnt match either of them, we throw an error.
|
||||||
if (
|
if (!(HoppEnvKeyPairResult.success || HoppEnvExportObjectResult.success)) {
|
||||||
!HoppEnvKeyPairResult.success &&
|
|
||||||
HoppEnvExportObjectResult.type === "err"
|
|
||||||
) {
|
|
||||||
throw error({ code: "MALFORMED_ENV_FILE", path, data: error });
|
throw error({ code: "MALFORMED_ENV_FILE", path, data: error });
|
||||||
}
|
}
|
||||||
|
|
||||||
if (HoppEnvKeyPairResult.success) {
|
if (HoppEnvKeyPairResult.success) {
|
||||||
for (const [key, value] of Object.entries(HoppEnvKeyPairResult.data)) {
|
for (const [key, value] of Object.entries(HoppEnvKeyPairResult.data)) {
|
||||||
envPairs.push({ key, value, secret: false });
|
envPairs.push({ key, value });
|
||||||
}
|
}
|
||||||
} else if (HoppEnvExportObjectResult.type === "ok") {
|
} else if (HoppEnvExportObjectResult.success) {
|
||||||
envPairs.push(...HoppEnvExportObjectResult.value.variables);
|
const { key, value } = HoppEnvExportObjectResult.data.variables[0];
|
||||||
|
envPairs.push({ key, value });
|
||||||
}
|
}
|
||||||
|
|
||||||
return <HoppEnvs>{ global: [], selected: envPairs };
|
return <HoppEnvs>{ global: [], selected: envPairs };
|
||||||
|
|||||||
@@ -1,18 +1,31 @@
|
|||||||
import { Environment, HoppCollection, HoppRESTRequest } from "@hoppscotch/data";
|
import { HoppCollection, HoppRESTRequest } from "@hoppscotch/data";
|
||||||
import { z } from "zod";
|
|
||||||
|
|
||||||
import { TestReport } from "../interfaces/response";
|
import { TestReport } from "../interfaces/response";
|
||||||
import { HoppCLIError } from "./errors";
|
import { HoppCLIError } from "./errors";
|
||||||
|
import { z } from "zod";
|
||||||
|
|
||||||
export type FormDataEntry = {
|
export type FormDataEntry = {
|
||||||
key: string;
|
key: string;
|
||||||
value: string | Blob;
|
value: string | Blob;
|
||||||
};
|
};
|
||||||
|
|
||||||
export type HoppEnvPair = Environment["variables"][number];
|
export type HoppEnvPair = { key: string; value: string };
|
||||||
|
|
||||||
export const HoppEnvKeyPairObject = z.record(z.string(), z.string());
|
export const HoppEnvKeyPairObject = z.record(z.string(), z.string());
|
||||||
|
|
||||||
|
// Shape of the single environment export object that is exported from the app.
|
||||||
|
export const HoppEnvExportObject = z.object({
|
||||||
|
name: z.string(),
|
||||||
|
variables: z.array(
|
||||||
|
z.object({
|
||||||
|
key: z.string(),
|
||||||
|
value: z.string(),
|
||||||
|
})
|
||||||
|
),
|
||||||
|
});
|
||||||
|
|
||||||
|
// Shape of the bulk environment export object that is exported from the app.
|
||||||
|
export const HoppBulkEnvExportObject = z.array(HoppEnvExportObject);
|
||||||
|
|
||||||
export type HoppEnvs = {
|
export type HoppEnvs = {
|
||||||
global: HoppEnvPair[];
|
global: HoppEnvPair[];
|
||||||
selected: HoppEnvPair[];
|
selected: HoppEnvPair[];
|
||||||
|
|||||||
@@ -1,3 +1,5 @@
|
|||||||
|
import { HoppCollection, isHoppRESTRequest } from "@hoppscotch/data";
|
||||||
|
import * as A from "fp-ts/Array";
|
||||||
import { CommanderError } from "commander";
|
import { CommanderError } from "commander";
|
||||||
import { HoppCLIError, HoppErrnoException } from "../types/errors";
|
import { HoppCLIError, HoppErrnoException } from "../types/errors";
|
||||||
|
|
||||||
@@ -12,6 +14,48 @@ export const hasProperty = <P extends PropertyKey>(
|
|||||||
prop: P
|
prop: P
|
||||||
): target is Record<P, unknown> => prop in target;
|
): target is Record<P, unknown> => prop in target;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Typeguard to check valid Hoppscotch REST Collection.
|
||||||
|
* @param param The object to be checked.
|
||||||
|
* @returns True, if unknown parameter is valid Hoppscotch REST Collection;
|
||||||
|
* False, otherwise.
|
||||||
|
*/
|
||||||
|
export const isRESTCollection = (param: unknown): param is HoppCollection => {
|
||||||
|
if (!!param && typeof param === "object") {
|
||||||
|
if (!hasProperty(param, "v") || typeof param.v !== "number") {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
if (!hasProperty(param, "name") || typeof param.name !== "string") {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
if (hasProperty(param, "id") && typeof param.id !== "string") {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
if (!hasProperty(param, "requests") || !Array.isArray(param.requests)) {
|
||||||
|
return false;
|
||||||
|
} else {
|
||||||
|
// Checks each requests array to be valid HoppRESTRequest.
|
||||||
|
const checkRequests = A.every(isHoppRESTRequest)(param.requests);
|
||||||
|
if (!checkRequests) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if (!hasProperty(param, "folders") || !Array.isArray(param.folders)) {
|
||||||
|
return false;
|
||||||
|
} else {
|
||||||
|
// Checks each folder to be valid REST collection.
|
||||||
|
const checkFolders = A.every(isRESTCollection)(param.folders);
|
||||||
|
if (!checkFolders) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
return false;
|
||||||
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Checks if given error data is of type HoppCLIError, based on existence
|
* Checks if given error data is of type HoppCLIError, based on existence
|
||||||
* of code property.
|
* of code property.
|
||||||
|
|||||||
@@ -1,23 +1,21 @@
|
|||||||
import { HoppCollection, HoppRESTRequest } from "@hoppscotch/data";
|
|
||||||
import chalk from "chalk";
|
|
||||||
import { log } from "console";
|
|
||||||
import * as A from "fp-ts/Array";
|
import * as A from "fp-ts/Array";
|
||||||
import { pipe } from "fp-ts/function";
|
import { pipe } from "fp-ts/function";
|
||||||
import { round } from "lodash-es";
|
import { bold } from "chalk";
|
||||||
|
import { log } from "console";
|
||||||
import { CollectionRunnerParam } from "../types/collections";
|
import round from "lodash/round";
|
||||||
|
import { HoppCollection } from "@hoppscotch/data";
|
||||||
import {
|
import {
|
||||||
CollectionStack,
|
|
||||||
HoppEnvs,
|
HoppEnvs,
|
||||||
ProcessRequestParams,
|
CollectionStack,
|
||||||
RequestReport,
|
RequestReport,
|
||||||
|
ProcessRequestParams,
|
||||||
} from "../types/request";
|
} from "../types/request";
|
||||||
import {
|
import {
|
||||||
PreRequestMetrics,
|
getRequestMetrics,
|
||||||
RequestMetrics,
|
preProcessRequest,
|
||||||
TestMetrics,
|
processRequest,
|
||||||
} from "../types/response";
|
} from "./request";
|
||||||
import { DEFAULT_DURATION_PRECISION } from "./constants";
|
import { exceptionColors } from "./getters";
|
||||||
import {
|
import {
|
||||||
printErrorsReport,
|
printErrorsReport,
|
||||||
printFailedTestsReport,
|
printFailedTestsReport,
|
||||||
@@ -25,14 +23,15 @@ import {
|
|||||||
printRequestsMetrics,
|
printRequestsMetrics,
|
||||||
printTestsMetrics,
|
printTestsMetrics,
|
||||||
} from "./display";
|
} from "./display";
|
||||||
import { exceptionColors } from "./getters";
|
|
||||||
import { getPreRequestMetrics } from "./pre-request";
|
|
||||||
import {
|
import {
|
||||||
getRequestMetrics,
|
PreRequestMetrics,
|
||||||
preProcessRequest,
|
RequestMetrics,
|
||||||
processRequest,
|
TestMetrics,
|
||||||
} from "./request";
|
} from "../types/response";
|
||||||
import { getTestMetrics } from "./test";
|
import { getTestMetrics } from "./test";
|
||||||
|
import { DEFAULT_DURATION_PRECISION } from "./constants";
|
||||||
|
import { getPreRequestMetrics } from "./pre-request";
|
||||||
|
import { CollectionRunnerParam } from "../types/collections";
|
||||||
|
|
||||||
const { WARN, FAIL } = exceptionColors;
|
const { WARN, FAIL } = exceptionColors;
|
||||||
|
|
||||||
@@ -56,19 +55,19 @@ export const collectionsRunner = async (
|
|||||||
// Pop out top-most collection from stack to be processed.
|
// Pop out top-most collection from stack to be processed.
|
||||||
const { collection, path } = <CollectionStack>collectionStack.pop();
|
const { collection, path } = <CollectionStack>collectionStack.pop();
|
||||||
|
|
||||||
// Processing each request in collection
|
// Processing each request in collection
|
||||||
for (const request of collection.requests) {
|
for (const request of collection.requests) {
|
||||||
const _request = preProcessRequest(request as HoppRESTRequest, collection);
|
const _request = preProcessRequest(request);
|
||||||
const requestPath = `${path}/${_request.name}`;
|
const requestPath = `${path}/${_request.name}`;
|
||||||
const processRequestParams: ProcessRequestParams = {
|
const processRequestParams: ProcessRequestParams = {
|
||||||
path: requestPath,
|
path: requestPath,
|
||||||
request: _request,
|
request: _request,
|
||||||
envs,
|
envs,
|
||||||
delay,
|
delay,
|
||||||
};
|
};
|
||||||
|
|
||||||
// Request processing initiated message.
|
// Request processing initiated message.
|
||||||
log(WARN(`\nRunning: ${chalk.bold(requestPath)}`));
|
log(WARN(`\nRunning: ${bold(requestPath)}`));
|
||||||
|
|
||||||
// Processing current request.
|
// Processing current request.
|
||||||
const result = await processRequest(processRequestParams)();
|
const result = await processRequest(processRequestParams)();
|
||||||
@@ -78,35 +77,20 @@ export const collectionsRunner = async (
|
|||||||
envs.global = global;
|
envs.global = global;
|
||||||
envs.selected = selected;
|
envs.selected = selected;
|
||||||
|
|
||||||
// Storing current request's report.
|
// Storing current request's report.
|
||||||
const requestReport = result.report;
|
const requestReport = result.report;
|
||||||
requestsReport.push(requestReport);
|
requestsReport.push(requestReport);
|
||||||
}
|
|
||||||
|
|
||||||
// Pushing remaining folders realted collection to stack.
|
|
||||||
for (const folder of collection.folders) {
|
|
||||||
const updatedFolder: HoppCollection = { ...folder }
|
|
||||||
|
|
||||||
if (updatedFolder.auth?.authType === "inherit") {
|
|
||||||
updatedFolder.auth = collection.auth;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (collection.headers?.length) {
|
|
||||||
// Filter out header entries present in the parent collection under the same name
|
|
||||||
// This ensures the folder headers take precedence over the collection headers
|
|
||||||
const filteredHeaders = collection.headers.filter((collectionHeaderEntries) => {
|
|
||||||
return !updatedFolder.headers.some((folderHeaderEntries) => folderHeaderEntries.key === collectionHeaderEntries.key)
|
|
||||||
})
|
|
||||||
updatedFolder.headers.push(...filteredHeaders);
|
|
||||||
}
|
|
||||||
|
|
||||||
collectionStack.push({
|
|
||||||
path: `${path}/${updatedFolder.name}`,
|
|
||||||
collection: updatedFolder,
|
|
||||||
});
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Pushing remaining folders realted collection to stack.
|
||||||
|
for (const folder of collection.folders) {
|
||||||
|
collectionStack.push({
|
||||||
|
path: `${path}/${folder.name}`,
|
||||||
|
collection: folder,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
return requestsReport;
|
return requestsReport;
|
||||||
};
|
};
|
||||||
|
|
||||||
@@ -131,7 +115,7 @@ const getCollectionStack = (collections: HoppCollection[]): CollectionStack[] =>
|
|||||||
* path of each request within collection-json file, failed-tests-report, errors,
|
* path of each request within collection-json file, failed-tests-report, errors,
|
||||||
* total execution duration for requests, pre-request-scripts, test-scripts.
|
* total execution duration for requests, pre-request-scripts, test-scripts.
|
||||||
* @returns True, if collection runner executed without any errors or failed test-cases.
|
* @returns True, if collection runner executed without any errors or failed test-cases.
|
||||||
* False, if errors occurred or test-cases failed.
|
* False, if errors occured or test-cases failed.
|
||||||
*/
|
*/
|
||||||
export const collectionsRunnerResult = (
|
export const collectionsRunnerResult = (
|
||||||
requestsReport: RequestReport[]
|
requestsReport: RequestReport[]
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
import chalk from "chalk";
|
import { bold } from "chalk";
|
||||||
import { groupEnd, group, log } from "console";
|
import { groupEnd, group, log } from "console";
|
||||||
import { handleError } from "../handlers/error";
|
import { handleError } from "../handlers/error";
|
||||||
import { RequestConfig } from "../interfaces/request";
|
import { RequestConfig } from "../interfaces/request";
|
||||||
@@ -112,7 +112,7 @@ export const printTestsMetrics = (testsMetrics: TestMetrics) => {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Prints details of each reported error for a request with error code.
|
* Prints details of each reported error for a request with error code.
|
||||||
* @param path Request's path in collection for which errors occurred.
|
* @param path Request's path in collection for which errors occured.
|
||||||
* @param errorsReport List of errors reported.
|
* @param errorsReport List of errors reported.
|
||||||
*/
|
*/
|
||||||
export const printErrorsReport = (
|
export const printErrorsReport = (
|
||||||
@@ -120,7 +120,7 @@ export const printErrorsReport = (
|
|||||||
errorsReport: HoppCLIError[]
|
errorsReport: HoppCLIError[]
|
||||||
) => {
|
) => {
|
||||||
if (errorsReport.length > 0) {
|
if (errorsReport.length > 0) {
|
||||||
const REPORTED_ERRORS_TITLE = FAIL(`\n${chalk.bold(path)} reported errors:`);
|
const REPORTED_ERRORS_TITLE = FAIL(`\n${bold(path)} reported errors:`);
|
||||||
|
|
||||||
group(REPORTED_ERRORS_TITLE);
|
group(REPORTED_ERRORS_TITLE);
|
||||||
for (const errorReport of errorsReport) {
|
for (const errorReport of errorsReport) {
|
||||||
@@ -143,7 +143,7 @@ export const printFailedTestsReport = (
|
|||||||
|
|
||||||
// Only printing test-reports with failed test-cases.
|
// Only printing test-reports with failed test-cases.
|
||||||
if (failedTestsReport.length > 0) {
|
if (failedTestsReport.length > 0) {
|
||||||
const FAILED_TESTS_PATH = FAIL(`\n${chalk.bold(path)} failed tests:`);
|
const FAILED_TESTS_PATH = FAIL(`\n${bold(path)} failed tests:`);
|
||||||
group(FAILED_TESTS_PATH);
|
group(FAILED_TESTS_PATH);
|
||||||
|
|
||||||
for (const failedTestReport of failedTestsReport) {
|
for (const failedTestReport of failedTestsReport) {
|
||||||
@@ -176,7 +176,7 @@ export const printRequestRunner = {
|
|||||||
*/
|
*/
|
||||||
start: (requestConfig: RequestConfig) => {
|
start: (requestConfig: RequestConfig) => {
|
||||||
const METHOD = BG_INFO(` ${requestConfig.method} `);
|
const METHOD = BG_INFO(` ${requestConfig.method} `);
|
||||||
const ENDPOINT = requestConfig.displayUrl || requestConfig.url;
|
const ENDPOINT = requestConfig.url;
|
||||||
|
|
||||||
process.stdout.write(`${METHOD} ${ENDPOINT}`);
|
process.stdout.write(`${METHOD} ${ENDPOINT}`);
|
||||||
},
|
},
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
import { clone } from "lodash-es";
|
import { clone } from "lodash";
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Sorts the array based on the sort func.
|
* Sorts the array based on the sort func.
|
||||||
|
|||||||
@@ -11,7 +11,7 @@ import * as E from "fp-ts/Either";
|
|||||||
import * as S from "fp-ts/string";
|
import * as S from "fp-ts/string";
|
||||||
import * as O from "fp-ts/Option";
|
import * as O from "fp-ts/Option";
|
||||||
import { error } from "../types/errors";
|
import { error } from "../types/errors";
|
||||||
import { round } from "lodash-es";
|
import round from "lodash/round";
|
||||||
import { DEFAULT_DURATION_PRECISION } from "./constants";
|
import { DEFAULT_DURATION_PRECISION } from "./constants";
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|||||||
@@ -1,46 +1,8 @@
|
|||||||
import { HoppCollection, HoppRESTRequest } from "@hoppscotch/data";
|
|
||||||
import fs from "fs/promises";
|
import fs from "fs/promises";
|
||||||
import { entityReference } from "verzod";
|
|
||||||
import { z } from "zod";
|
|
||||||
|
|
||||||
import { error } from "../types/errors";
|
|
||||||
import { FormDataEntry } from "../types/request";
|
import { FormDataEntry } from "../types/request";
|
||||||
import { isHoppErrnoException } from "./checks";
|
import { error } from "../types/errors";
|
||||||
|
import { isRESTCollection, isHoppErrnoException } from "./checks";
|
||||||
const getValidRequests = (
|
import { HoppCollection } from "@hoppscotch/data";
|
||||||
collections: HoppCollection[],
|
|
||||||
collectionFilePath: string
|
|
||||||
) => {
|
|
||||||
return collections.map((collection) => {
|
|
||||||
// Validate requests using zod schema
|
|
||||||
const requestSchemaParsedResult = z
|
|
||||||
.array(entityReference(HoppRESTRequest))
|
|
||||||
.safeParse(collection.requests);
|
|
||||||
|
|
||||||
// Handle validation errors
|
|
||||||
if (!requestSchemaParsedResult.success) {
|
|
||||||
throw error({
|
|
||||||
code: "MALFORMED_COLLECTION",
|
|
||||||
path: collectionFilePath,
|
|
||||||
data: "Please check the collection data.",
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
// Recursively validate requests in nested folders
|
|
||||||
if (collection.folders.length > 0) {
|
|
||||||
collection.folders = getValidRequests(
|
|
||||||
collection.folders,
|
|
||||||
collectionFilePath
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
// Return validated collection
|
|
||||||
return {
|
|
||||||
...collection,
|
|
||||||
requests: requestSchemaParsedResult.data,
|
|
||||||
};
|
|
||||||
});
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Parses array of FormDataEntry to FormData.
|
* Parses array of FormDataEntry to FormData.
|
||||||
@@ -105,11 +67,7 @@ export async function parseCollectionData(
|
|||||||
? contents
|
? contents
|
||||||
: [contents];
|
: [contents];
|
||||||
|
|
||||||
const collectionSchemaParsedResult = z
|
if (maybeArrayOfCollections.some((x) => !isRESTCollection(x))) {
|
||||||
.array(entityReference(HoppCollection))
|
|
||||||
.safeParse(maybeArrayOfCollections);
|
|
||||||
|
|
||||||
if (!collectionSchemaParsedResult.success) {
|
|
||||||
throw error({
|
throw error({
|
||||||
code: "MALFORMED_COLLECTION",
|
code: "MALFORMED_COLLECTION",
|
||||||
path,
|
path,
|
||||||
@@ -117,5 +75,5 @@ export async function parseCollectionData(
|
|||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
return getValidRequests(collectionSchemaParsedResult.data, path);
|
return maybeArrayOfCollections as HoppCollection[];
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -36,10 +36,7 @@ import { toFormData } from "./mutators";
|
|||||||
export const preRequestScriptRunner = (
|
export const preRequestScriptRunner = (
|
||||||
request: HoppRESTRequest,
|
request: HoppRESTRequest,
|
||||||
envs: HoppEnvs
|
envs: HoppEnvs
|
||||||
): TE.TaskEither<
|
): TE.TaskEither<HoppCLIError, EffectiveHoppRESTRequest> =>
|
||||||
HoppCLIError,
|
|
||||||
{ effectiveRequest: EffectiveHoppRESTRequest } & { updatedEnvs: HoppEnvs }
|
|
||||||
> =>
|
|
||||||
pipe(
|
pipe(
|
||||||
TE.of(request),
|
TE.of(request),
|
||||||
TE.chain(({ preRequestScript }) =>
|
TE.chain(({ preRequestScript }) =>
|
||||||
@@ -71,10 +68,7 @@ export const preRequestScriptRunner = (
|
|||||||
export function getEffectiveRESTRequest(
|
export function getEffectiveRESTRequest(
|
||||||
request: HoppRESTRequest,
|
request: HoppRESTRequest,
|
||||||
environment: Environment
|
environment: Environment
|
||||||
): E.Either<
|
): E.Either<HoppCLIError, EffectiveHoppRESTRequest> {
|
||||||
HoppCLIError,
|
|
||||||
{ effectiveRequest: EffectiveHoppRESTRequest } & { updatedEnvs: HoppEnvs }
|
|
||||||
> {
|
|
||||||
const envVariables = environment.variables;
|
const envVariables = environment.variables;
|
||||||
|
|
||||||
// Parsing final headers with applied ENVs.
|
// Parsing final headers with applied ENVs.
|
||||||
@@ -109,40 +103,27 @@ export function getEffectiveRESTRequest(
|
|||||||
key: "Authorization",
|
key: "Authorization",
|
||||||
value: `Basic ${btoa(`${username}:${password}`)}`,
|
value: `Basic ${btoa(`${username}:${password}`)}`,
|
||||||
});
|
});
|
||||||
} else if (request.auth.authType === "bearer") {
|
} else if (
|
||||||
|
request.auth.authType === "bearer" ||
|
||||||
|
request.auth.authType === "oauth-2"
|
||||||
|
) {
|
||||||
effectiveFinalHeaders.push({
|
effectiveFinalHeaders.push({
|
||||||
active: true,
|
active: true,
|
||||||
key: "Authorization",
|
key: "Authorization",
|
||||||
value: `Bearer ${parseTemplateString(request.auth.token, envVariables)}`,
|
value: `Bearer ${parseTemplateString(
|
||||||
|
request.auth.token,
|
||||||
|
envVariables
|
||||||
|
)}`,
|
||||||
});
|
});
|
||||||
} else if (request.auth.authType === "oauth-2") {
|
|
||||||
const { addTo } = request.auth;
|
|
||||||
|
|
||||||
if (addTo === "HEADERS") {
|
|
||||||
effectiveFinalHeaders.push({
|
|
||||||
active: true,
|
|
||||||
key: "Authorization",
|
|
||||||
value: `Bearer ${parseTemplateString(request.auth.grantTypeInfo.token, envVariables)}`,
|
|
||||||
});
|
|
||||||
} else if (addTo === "QUERY_PARAMS") {
|
|
||||||
effectiveFinalParams.push({
|
|
||||||
active: true,
|
|
||||||
key: "access_token",
|
|
||||||
value: parseTemplateString(
|
|
||||||
request.auth.grantTypeInfo.token,
|
|
||||||
envVariables
|
|
||||||
),
|
|
||||||
});
|
|
||||||
}
|
|
||||||
} else if (request.auth.authType === "api-key") {
|
} else if (request.auth.authType === "api-key") {
|
||||||
const { key, value, addTo } = request.auth;
|
const { key, value, addTo } = request.auth;
|
||||||
if (addTo === "HEADERS") {
|
if (addTo === "Headers") {
|
||||||
effectiveFinalHeaders.push({
|
effectiveFinalHeaders.push({
|
||||||
active: true,
|
active: true,
|
||||||
key: parseTemplateString(key, envVariables),
|
key: parseTemplateString(key, envVariables),
|
||||||
value: parseTemplateString(value, envVariables),
|
value: parseTemplateString(value, envVariables),
|
||||||
});
|
});
|
||||||
} else if (addTo === "QUERY_PARAMS") {
|
} else if (addTo === "Query params") {
|
||||||
effectiveFinalParams.push({
|
effectiveFinalParams.push({
|
||||||
active: true,
|
active: true,
|
||||||
key: parseTemplateString(key, envVariables),
|
key: parseTemplateString(key, envVariables),
|
||||||
@@ -181,30 +162,12 @@ export function getEffectiveRESTRequest(
|
|||||||
}
|
}
|
||||||
const effectiveFinalURL = _effectiveFinalURL.right;
|
const effectiveFinalURL = _effectiveFinalURL.right;
|
||||||
|
|
||||||
// Secret environment variables referenced in the request endpoint should be masked
|
|
||||||
let effectiveFinalDisplayURL;
|
|
||||||
if (envVariables.some(({ secret }) => secret)) {
|
|
||||||
const _effectiveFinalDisplayURL = parseTemplateStringE(
|
|
||||||
request.endpoint,
|
|
||||||
envVariables,
|
|
||||||
true
|
|
||||||
);
|
|
||||||
|
|
||||||
if (E.isRight(_effectiveFinalDisplayURL)) {
|
|
||||||
effectiveFinalDisplayURL = _effectiveFinalDisplayURL.right;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return E.right({
|
return E.right({
|
||||||
effectiveRequest: {
|
...request,
|
||||||
...request,
|
effectiveFinalURL,
|
||||||
effectiveFinalURL,
|
effectiveFinalHeaders,
|
||||||
effectiveFinalDisplayURL,
|
effectiveFinalParams,
|
||||||
effectiveFinalHeaders,
|
effectiveFinalBody,
|
||||||
effectiveFinalParams,
|
|
||||||
effectiveFinalBody,
|
|
||||||
},
|
|
||||||
updatedEnvs: { global: [], selected: envVariables },
|
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -1,66 +1,34 @@
|
|||||||
import { Environment, HoppCollection, HoppRESTRequest } from "@hoppscotch/data";
|
|
||||||
import axios, { Method } from "axios";
|
import axios, { Method } from "axios";
|
||||||
import * as A from "fp-ts/Array";
|
|
||||||
import * as E from "fp-ts/Either";
|
|
||||||
import * as T from "fp-ts/Task";
|
|
||||||
import * as TE from "fp-ts/TaskEither";
|
|
||||||
import { pipe } from "fp-ts/function";
|
|
||||||
import * as S from "fp-ts/string";
|
|
||||||
import { hrtime } from "process";
|
|
||||||
import { URL } from "url";
|
import { URL } from "url";
|
||||||
import { EffectiveHoppRESTRequest, RequestConfig } from "../interfaces/request";
|
import * as S from "fp-ts/string";
|
||||||
|
import * as A from "fp-ts/Array";
|
||||||
|
import * as T from "fp-ts/Task";
|
||||||
|
import * as E from "fp-ts/Either";
|
||||||
|
import * as TE from "fp-ts/TaskEither";
|
||||||
|
import { HoppRESTRequest } from "@hoppscotch/data";
|
||||||
|
import { responseErrors } from "./constants";
|
||||||
|
import { getDurationInSeconds, getMetaDataPairs } from "./getters";
|
||||||
|
import { testRunner, getTestScriptParams, hasFailedTestCases } from "./test";
|
||||||
|
import { RequestConfig, EffectiveHoppRESTRequest } from "../interfaces/request";
|
||||||
import { RequestRunnerResponse } from "../interfaces/response";
|
import { RequestRunnerResponse } from "../interfaces/response";
|
||||||
import { HoppCLIError, error } from "../types/errors";
|
import { preRequestScriptRunner } from "./pre-request";
|
||||||
import {
|
import {
|
||||||
HoppEnvs,
|
HoppEnvs,
|
||||||
ProcessRequestParams,
|
ProcessRequestParams,
|
||||||
RequestReport,
|
RequestReport,
|
||||||
} from "../types/request";
|
} from "../types/request";
|
||||||
import { RequestMetrics } from "../types/response";
|
|
||||||
import { responseErrors } from "./constants";
|
|
||||||
import {
|
import {
|
||||||
printPreRequestRunner,
|
printPreRequestRunner,
|
||||||
printRequestRunner,
|
printRequestRunner,
|
||||||
printTestRunner,
|
printTestRunner,
|
||||||
} from "./display";
|
} from "./display";
|
||||||
import { getDurationInSeconds, getMetaDataPairs } from "./getters";
|
import { error, HoppCLIError } from "../types/errors";
|
||||||
import { preRequestScriptRunner } from "./pre-request";
|
import { hrtime } from "process";
|
||||||
import { getTestScriptParams, hasFailedTestCases, testRunner } from "./test";
|
import { RequestMetrics } from "../types/response";
|
||||||
|
import { pipe } from "fp-ts/function";
|
||||||
|
|
||||||
// !NOTE: The `config.supported` checks are temporary until OAuth2 and Multipart Forms are supported
|
// !NOTE: The `config.supported` checks are temporary until OAuth2 and Multipart Forms are supported
|
||||||
|
|
||||||
/**
|
|
||||||
* Processes given variable, which includes checking for secret variables
|
|
||||||
* and getting value from system environment
|
|
||||||
* @param variable Variable to be processed
|
|
||||||
* @returns Updated variable with value from system environment
|
|
||||||
*/
|
|
||||||
const processVariables = (variable: Environment["variables"][number]) => {
|
|
||||||
if (variable.secret) {
|
|
||||||
return {
|
|
||||||
...variable,
|
|
||||||
value:
|
|
||||||
"value" in variable ? variable.value : process.env[variable.key] || "",
|
|
||||||
};
|
|
||||||
}
|
|
||||||
return variable;
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Processes given envs, which includes processing each variable in global
|
|
||||||
* and selected envs
|
|
||||||
* @param envs Global + selected envs used by requests with in collection
|
|
||||||
* @returns Processed envs with each variable processed
|
|
||||||
*/
|
|
||||||
const processEnvs = (envs: HoppEnvs) => {
|
|
||||||
const processedEnvs = {
|
|
||||||
global: envs.global.map(processVariables),
|
|
||||||
selected: envs.selected.map(processVariables),
|
|
||||||
};
|
|
||||||
|
|
||||||
return processedEnvs;
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Transforms given request data to request-config used by request-runner to
|
* Transforms given request data to request-config used by request-runner to
|
||||||
* perform HTTP request.
|
* perform HTTP request.
|
||||||
@@ -70,7 +38,6 @@ const processEnvs = (envs: HoppEnvs) => {
|
|||||||
export const createRequest = (req: EffectiveHoppRESTRequest): RequestConfig => {
|
export const createRequest = (req: EffectiveHoppRESTRequest): RequestConfig => {
|
||||||
const config: RequestConfig = {
|
const config: RequestConfig = {
|
||||||
supported: true,
|
supported: true,
|
||||||
displayUrl: req.effectiveFinalDisplayURL,
|
|
||||||
};
|
};
|
||||||
const { finalBody, finalEndpoint, finalHeaders, finalParams } = getRequest;
|
const { finalBody, finalEndpoint, finalHeaders, finalParams } = getRequest;
|
||||||
const reqParams = finalParams(req);
|
const reqParams = finalParams(req);
|
||||||
@@ -131,7 +98,6 @@ export const requestRunner =
|
|||||||
let status: number;
|
let status: number;
|
||||||
const baseResponse = await axios(requestConfig);
|
const baseResponse = await axios(requestConfig);
|
||||||
const { config } = baseResponse;
|
const { config } = baseResponse;
|
||||||
// PR-COMMENT: type error
|
|
||||||
const runnerResponse: RequestRunnerResponse = {
|
const runnerResponse: RequestRunnerResponse = {
|
||||||
...baseResponse,
|
...baseResponse,
|
||||||
endpoint: getRequest.endpoint(config.url),
|
endpoint: getRequest.endpoint(config.url),
|
||||||
@@ -255,16 +221,9 @@ export const processRequest =
|
|||||||
effectiveFinalParams: [],
|
effectiveFinalParams: [],
|
||||||
effectiveFinalURL: "",
|
effectiveFinalURL: "",
|
||||||
};
|
};
|
||||||
let updatedEnvs = <HoppEnvs>{};
|
|
||||||
|
|
||||||
// Fetch values for secret environment variables from system environment
|
|
||||||
const processedEnvs = processEnvs(envs);
|
|
||||||
|
|
||||||
// Executing pre-request-script
|
// Executing pre-request-script
|
||||||
const preRequestRes = await preRequestScriptRunner(
|
const preRequestRes = await preRequestScriptRunner(request, envs)();
|
||||||
request,
|
|
||||||
processedEnvs
|
|
||||||
)();
|
|
||||||
if (E.isLeft(preRequestRes)) {
|
if (E.isLeft(preRequestRes)) {
|
||||||
printPreRequestRunner.fail();
|
printPreRequestRunner.fail();
|
||||||
|
|
||||||
@@ -272,8 +231,8 @@ export const processRequest =
|
|||||||
report.errors.push(preRequestRes.left);
|
report.errors.push(preRequestRes.left);
|
||||||
report.result = report.result && false;
|
report.result = report.result && false;
|
||||||
} else {
|
} else {
|
||||||
// Updating effective-request and consuming updated envs after pre-request script execution
|
// Updating effective-request
|
||||||
({ effectiveRequest, updatedEnvs } = preRequestRes.right);
|
effectiveRequest = preRequestRes.right;
|
||||||
}
|
}
|
||||||
|
|
||||||
// Creating request-config for request-runner.
|
// Creating request-config for request-runner.
|
||||||
@@ -311,7 +270,7 @@ export const processRequest =
|
|||||||
const testScriptParams = getTestScriptParams(
|
const testScriptParams = getTestScriptParams(
|
||||||
_requestRunnerRes,
|
_requestRunnerRes,
|
||||||
request,
|
request,
|
||||||
updatedEnvs
|
envs
|
||||||
);
|
);
|
||||||
|
|
||||||
// Executing test-runner.
|
// Executing test-runner.
|
||||||
@@ -350,12 +309,9 @@ export const processRequest =
|
|||||||
* @returns Updated request object free of invalid/missing data.
|
* @returns Updated request object free of invalid/missing data.
|
||||||
*/
|
*/
|
||||||
export const preProcessRequest = (
|
export const preProcessRequest = (
|
||||||
request: HoppRESTRequest,
|
request: HoppRESTRequest
|
||||||
collection: HoppCollection
|
|
||||||
): HoppRESTRequest => {
|
): HoppRESTRequest => {
|
||||||
const tempRequest = Object.assign({}, request);
|
const tempRequest = Object.assign({}, request);
|
||||||
const { headers: parentHeaders, auth: parentAuth } = collection;
|
|
||||||
|
|
||||||
if (!tempRequest.v) {
|
if (!tempRequest.v) {
|
||||||
tempRequest.v = "1";
|
tempRequest.v = "1";
|
||||||
}
|
}
|
||||||
@@ -371,33 +327,18 @@ export const preProcessRequest = (
|
|||||||
if (!tempRequest.params) {
|
if (!tempRequest.params) {
|
||||||
tempRequest.params = [];
|
tempRequest.params = [];
|
||||||
}
|
}
|
||||||
|
if (!tempRequest.headers) {
|
||||||
if (parentHeaders?.length) {
|
|
||||||
// Filter out header entries present in the parent (folder/collection) under the same name
|
|
||||||
// This ensures the child headers take precedence over the parent headers
|
|
||||||
const filteredEntries = parentHeaders.filter((parentHeaderEntries) => {
|
|
||||||
return !tempRequest.headers.some(
|
|
||||||
(reqHeaderEntries) => reqHeaderEntries.key === parentHeaderEntries.key
|
|
||||||
);
|
|
||||||
});
|
|
||||||
tempRequest.headers.push(...filteredEntries);
|
|
||||||
} else if (!tempRequest.headers) {
|
|
||||||
tempRequest.headers = [];
|
tempRequest.headers = [];
|
||||||
}
|
}
|
||||||
|
|
||||||
if (!tempRequest.preRequestScript) {
|
if (!tempRequest.preRequestScript) {
|
||||||
tempRequest.preRequestScript = "";
|
tempRequest.preRequestScript = "";
|
||||||
}
|
}
|
||||||
if (!tempRequest.testScript) {
|
if (!tempRequest.testScript) {
|
||||||
tempRequest.testScript = "";
|
tempRequest.testScript = "";
|
||||||
}
|
}
|
||||||
|
if (!tempRequest.auth) {
|
||||||
if (tempRequest.auth?.authType === "inherit") {
|
|
||||||
tempRequest.auth = parentAuth;
|
|
||||||
} else if (!tempRequest.auth) {
|
|
||||||
tempRequest.auth = { authActive: false, authType: "none" };
|
tempRequest.auth = { authActive: false, authType: "none" };
|
||||||
}
|
}
|
||||||
|
|
||||||
if (!tempRequest.body) {
|
if (!tempRequest.body) {
|
||||||
tempRequest.body = { contentType: null, body: null };
|
tempRequest.body = { contentType: null, body: null };
|
||||||
}
|
}
|
||||||
|
|||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user