Compare commits
90 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
d328f08952 | ||
|
|
bcad357017 | ||
|
|
9845a7cd68 | ||
|
|
7c632f7388 | ||
|
|
1442f62633 | ||
|
|
7f7a84e3ba | ||
|
|
dee3279f85 | ||
|
|
094dbb01b8 | ||
|
|
e299d40fa1 | ||
|
|
cb42f11b97 | ||
|
|
4531645b4c | ||
|
|
bf3426f91b | ||
|
|
3864f04218 | ||
|
|
e541a35e86 | ||
|
|
bd383ed273 | ||
|
|
949fac1a7c | ||
|
|
7ab16ecccb | ||
|
|
58cd551a30 | ||
|
|
7770a9b521 | ||
|
|
aab0f7ea46 | ||
|
|
ea41f4f503 | ||
|
|
af7219f6e1 | ||
|
|
8ccaec7af6 | ||
|
|
b2ffc90da7 | ||
|
|
72e4d0b896 | ||
|
|
5bb13e34f8 | ||
|
|
0466b86f10 | ||
|
|
ca81f68ff1 | ||
|
|
4995e49c46 | ||
|
|
77123d8c92 | ||
|
|
e72c1c13ea | ||
|
|
e775d68a9b | ||
|
|
f8e5f1a5a2 | ||
|
|
f4a74f058d | ||
|
|
80821fca07 | ||
|
|
dfd4451561 | ||
|
|
8570b02dde | ||
|
|
d6da406c61 | ||
|
|
060e789662 | ||
|
|
e40b9a3cf5 | ||
|
|
237d9944f9 | ||
|
|
79b46bf210 | ||
|
|
98a26f9ae4 | ||
|
|
dbe3c5cfb9 | ||
|
|
25d7f7b2a4 | ||
|
|
b76e99ac0f | ||
|
|
67c3677621 | ||
|
|
bab6316e76 | ||
|
|
48730bca05 | ||
|
|
698b570ee6 | ||
|
|
a3f11dff18 | ||
|
|
5e359c2fb8 | ||
|
|
2147eae687 | ||
|
|
286295128d | ||
|
|
8501495c17 | ||
|
|
888c9166fc | ||
|
|
e5f6edf405 | ||
|
|
e8a52f717d | ||
|
|
d45750428c | ||
|
|
cf55ca9e28 | ||
|
|
3e5239f7d3 | ||
|
|
7669985f8e | ||
|
|
5047c9b6e7 | ||
|
|
bd2082e8c5 | ||
|
|
8f188acd3c | ||
|
|
0303ef2fd9 | ||
|
|
cb21a970b6 | ||
|
|
203daeb4a2 | ||
|
|
60dde11311 | ||
|
|
8b930fc57c | ||
|
|
f810ed0c14 | ||
|
|
53222fd83c | ||
|
|
a1f2497381 | ||
|
|
c27172c32e | ||
|
|
6e9b65d8b1 | ||
|
|
6d301f9961 | ||
|
|
659fea7afc | ||
|
|
e0303058a3 | ||
|
|
65f121c451 | ||
|
|
821cc62c4c | ||
|
|
4ce327eb6a | ||
|
|
4beb1bb574 | ||
|
|
0a2a1a026b | ||
|
|
eb096d07e2 | ||
|
|
19e42c9c52 | ||
|
|
f4d86fccfd | ||
|
|
ad0576a752 | ||
|
|
35be05df20 | ||
|
|
dae6d114da | ||
|
|
ecce47fdcd |
@@ -5,3 +5,7 @@ end_of_line = lf
|
|||||||
trim_trailing_whitespace = true
|
trim_trailing_whitespace = true
|
||||||
insert_final_newline = true
|
insert_final_newline = true
|
||||||
max_line_length = 100
|
max_line_length = 100
|
||||||
|
|
||||||
|
[{Dockerfile}]
|
||||||
|
indent_style = space
|
||||||
|
indent_size = 4
|
||||||
|
|||||||
@@ -1,2 +0,0 @@
|
|||||||
dist/
|
|
||||||
dist_electron/
|
|
||||||
@@ -10,7 +10,7 @@ module.exports = {
|
|||||||
},
|
},
|
||||||
extends: [
|
extends: [
|
||||||
// Vue specific rules, eslint-plugin-vue
|
// Vue specific rules, eslint-plugin-vue
|
||||||
'plugin:vue/essential',
|
'plugin:vue/vue3-recommended',
|
||||||
|
|
||||||
// Extends eslint-config-airbnb
|
// Extends eslint-config-airbnb
|
||||||
'@vue/eslint-config-airbnb-with-typescript',
|
'@vue/eslint-config-airbnb-with-typescript',
|
||||||
|
|||||||
12
.github/actions/npm-install-dependencies/action.yml
vendored
Normal file
12
.github/actions/npm-install-dependencies/action.yml
vendored
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
inputs:
|
||||||
|
working-directory:
|
||||||
|
required: false
|
||||||
|
default: '.'
|
||||||
|
runs:
|
||||||
|
using: composite
|
||||||
|
steps:
|
||||||
|
-
|
||||||
|
name: Run `npm ci` with retries
|
||||||
|
shell: bash
|
||||||
|
run: npm run install-deps -- --ci
|
||||||
|
working-directory: ${{ inputs.working-directory }}
|
||||||
2
.github/actions/setup-node/action.yml
vendored
2
.github/actions/setup-node/action.yml
vendored
@@ -3,6 +3,6 @@ runs:
|
|||||||
steps:
|
steps:
|
||||||
-
|
-
|
||||||
name: Setup node
|
name: Setup node
|
||||||
uses: actions/setup-node@v2
|
uses: actions/setup-node@v3
|
||||||
with:
|
with:
|
||||||
node-version: 16.x
|
node-version: 16.x
|
||||||
|
|||||||
53
.github/workflows/checks.build.yaml
vendored
53
.github/workflows/checks.build.yaml
vendored
@@ -1,4 +1,4 @@
|
|||||||
name: build-checks
|
name: checks.build
|
||||||
|
|
||||||
on:
|
on:
|
||||||
push:
|
push:
|
||||||
@@ -21,16 +21,19 @@ jobs:
|
|||||||
steps:
|
steps:
|
||||||
-
|
-
|
||||||
name: Checkout
|
name: Checkout
|
||||||
uses: actions/checkout@v2
|
uses: actions/checkout@v4
|
||||||
-
|
-
|
||||||
name: Setup node
|
name: Setup node
|
||||||
uses: ./.github/actions/setup-node
|
uses: ./.github/actions/setup-node
|
||||||
-
|
-
|
||||||
name: Install dependencies
|
name: Install dependencies
|
||||||
run: npm ci
|
uses: ./.github/actions/npm-install-dependencies
|
||||||
-
|
-
|
||||||
name: Build
|
name: Build web
|
||||||
run: npm run build -- --mode ${{ matrix.mode }}
|
run: npm run build -- --mode ${{ matrix.mode }}
|
||||||
|
-
|
||||||
|
name: Verify web build artifacts
|
||||||
|
run: npm run check:verify-build-artifacts -- --web
|
||||||
|
|
||||||
build-desktop:
|
build-desktop:
|
||||||
strategy:
|
strategy:
|
||||||
@@ -46,36 +49,52 @@ jobs:
|
|||||||
steps:
|
steps:
|
||||||
-
|
-
|
||||||
name: Checkout
|
name: Checkout
|
||||||
uses: actions/checkout@v2
|
uses: actions/checkout@v4
|
||||||
-
|
-
|
||||||
name: Setup node
|
name: Setup node
|
||||||
uses: ./.github/actions/setup-node
|
uses: ./.github/actions/setup-node
|
||||||
-
|
-
|
||||||
name: Install dependencies
|
name: Install dependencies
|
||||||
run: npm ci
|
uses: ./.github/actions/npm-install-dependencies
|
||||||
-
|
-
|
||||||
name: Prebuild
|
name: Prebuild desktop
|
||||||
run: npm run electron:prebuild -- --mode ${{ matrix.mode }}
|
run: npm run electron:prebuild -- --mode ${{ matrix.mode }}
|
||||||
-
|
-
|
||||||
name: Build
|
name: Verify unbundled desktop build artifacts
|
||||||
|
run: npm run check:verify-build-artifacts -- --electron-unbundled
|
||||||
|
-
|
||||||
|
name: Build (bundle and package) desktop application
|
||||||
run: npm run electron:build -- --publish never
|
run: npm run electron:build -- --publish never
|
||||||
|
-
|
||||||
|
name: Verify bundled desktop build artifacts
|
||||||
|
run: npm run check:verify-build-artifacts -- --electron-bundled
|
||||||
|
|
||||||
create-icons:
|
build-docker:
|
||||||
strategy:
|
strategy:
|
||||||
matrix:
|
matrix:
|
||||||
os: [ macos, ubuntu, windows ]
|
os: [ macos, ubuntu ] # Windows runners do not support Linux containers
|
||||||
fail-fast: false # Allows to see results from other combinations
|
fail-fast: false # Allows to see results from other combinations
|
||||||
runs-on: ${{ matrix.os }}-latest
|
runs-on: ${{ matrix.os }}-latest
|
||||||
steps:
|
steps:
|
||||||
-
|
-
|
||||||
name: Checkout
|
name: Checkout
|
||||||
uses: actions/checkout@v2
|
uses: actions/checkout@v4
|
||||||
-
|
-
|
||||||
name: Setup node
|
name: Install Docker on macOS
|
||||||
uses: ./.github/actions/setup-node
|
if: matrix.os == 'macos' # macOS runner is missing Docker
|
||||||
|
run: |-
|
||||||
|
# Install Docker
|
||||||
|
brew install docker
|
||||||
|
# Docker on macOS misses daemon due to licensing, so install colima as runtime
|
||||||
|
brew install colima
|
||||||
|
# Start the daemon
|
||||||
|
colima start
|
||||||
-
|
-
|
||||||
name: Install dependencies
|
name: Build Docker image
|
||||||
run: npm ci
|
run: docker build -t undergroundwires/privacy.sexy:latest .
|
||||||
-
|
-
|
||||||
name: Create icons
|
name: Run Docker image on port 8080
|
||||||
run: npm run icons:build
|
run: docker run -d -p 8080:80 --rm --name privacy.sexy undergroundwires/privacy.sexy:latest
|
||||||
|
-
|
||||||
|
name: Check server is up and returns HTTP 200
|
||||||
|
run: node ./scripts/verify-web-server-status.js --url http://localhost:8080
|
||||||
|
|||||||
@@ -6,7 +6,7 @@ on:
|
|||||||
pull_request:
|
pull_request:
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
build-desktop:
|
run-check:
|
||||||
strategy:
|
strategy:
|
||||||
matrix:
|
matrix:
|
||||||
os: [ macos, ubuntu, windows ]
|
os: [ macos, ubuntu, windows ]
|
||||||
@@ -15,10 +15,13 @@ jobs:
|
|||||||
steps:
|
steps:
|
||||||
-
|
-
|
||||||
name: Checkout
|
name: Checkout
|
||||||
uses: actions/checkout@v2
|
uses: actions/checkout@v4
|
||||||
-
|
-
|
||||||
name: Setup node
|
name: Setup node
|
||||||
uses: ./.github/actions/setup-node
|
uses: ./.github/actions/setup-node
|
||||||
|
-
|
||||||
|
name: Install dependencies
|
||||||
|
uses: ./.github/actions/npm-install-dependencies
|
||||||
-
|
-
|
||||||
name: Configure Ubuntu
|
name: Configure Ubuntu
|
||||||
if: matrix.os == 'ubuntu'
|
if: matrix.os == 'ubuntu'
|
||||||
@@ -57,7 +60,9 @@ jobs:
|
|||||||
-
|
-
|
||||||
name: Test
|
name: Test
|
||||||
shell: bash
|
shell: bash
|
||||||
run: node ./scripts/check-desktop-runtime-errors --screenshot
|
run: |-
|
||||||
|
export SCREENSHOT=true
|
||||||
|
npm run check:desktop
|
||||||
-
|
-
|
||||||
name: Upload screenshot
|
name: Upload screenshot
|
||||||
if: always() # Run even if previous step fails
|
if: always() # Run even if previous step fails
|
||||||
|
|||||||
22
.github/workflows/checks.external-urls.yaml
vendored
Normal file
22
.github/workflows/checks.external-urls.yaml
vendored
Normal file
@@ -0,0 +1,22 @@
|
|||||||
|
name: checks.external-urls
|
||||||
|
|
||||||
|
on:
|
||||||
|
schedule:
|
||||||
|
- cron: '0 0 * * 0' # at 00:00 on every Sunday
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
run-check:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
-
|
||||||
|
name: Checkout
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
-
|
||||||
|
name: Setup node
|
||||||
|
uses: ./.github/actions/setup-node
|
||||||
|
-
|
||||||
|
name: Install dependencies
|
||||||
|
uses: ./.github/actions/npm-install-dependencies
|
||||||
|
-
|
||||||
|
name: Test
|
||||||
|
run: npm run check:external-urls
|
||||||
16
.github/workflows/checks.quality.yaml
vendored
16
.github/workflows/checks.quality.yaml
vendored
@@ -16,11 +16,15 @@ jobs:
|
|||||||
os: [ macos, ubuntu, windows ]
|
os: [ macos, ubuntu, windows ]
|
||||||
fail-fast: false # Still interested to see results from other combinations
|
fail-fast: false # Still interested to see results from other combinations
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout
|
-
|
||||||
uses: actions/checkout@v2
|
name: Checkout
|
||||||
- name: Setup node
|
uses: actions/checkout@v4
|
||||||
|
-
|
||||||
|
name: Setup node
|
||||||
uses: ./.github/actions/setup-node
|
uses: ./.github/actions/setup-node
|
||||||
- name: Install dependencies
|
-
|
||||||
run: npm ci
|
name: Install dependencies
|
||||||
- name: Lint
|
uses: ./.github/actions/npm-install-dependencies
|
||||||
|
-
|
||||||
|
name: Lint
|
||||||
run: ${{ matrix.lint-command }}
|
run: ${{ matrix.lint-command }}
|
||||||
|
|||||||
55
.github/workflows/checks.scripts.yaml
vendored
Normal file
55
.github/workflows/checks.scripts.yaml
vendored
Normal file
@@ -0,0 +1,55 @@
|
|||||||
|
name: checks.scripts
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
pull_request:
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
icons-build:
|
||||||
|
runs-on: ${{ matrix.os }}-latest
|
||||||
|
strategy:
|
||||||
|
matrix:
|
||||||
|
os: [ macos, ubuntu, windows ]
|
||||||
|
fail-fast: false # Still interested to see results from other combinations
|
||||||
|
steps:
|
||||||
|
-
|
||||||
|
name: Checkout
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
-
|
||||||
|
name: Setup node
|
||||||
|
uses: ./.github/actions/setup-node
|
||||||
|
-
|
||||||
|
name: Install dependencies
|
||||||
|
uses: ./.github/actions/npm-install-dependencies
|
||||||
|
-
|
||||||
|
name: Create icons
|
||||||
|
run: npm run icons:build
|
||||||
|
|
||||||
|
install-deps:
|
||||||
|
runs-on: ${{ matrix.os }}-latest
|
||||||
|
strategy:
|
||||||
|
matrix:
|
||||||
|
install-deps-before: [true, false]
|
||||||
|
install-command:
|
||||||
|
- npm run install-deps
|
||||||
|
- npm run install-deps -- --no-errors
|
||||||
|
- npm run install-deps -- --ci
|
||||||
|
- npm run install-deps -- --fresh --non-deterministic
|
||||||
|
- npm run install-deps -- --fresh
|
||||||
|
- npm run install-deps -- --non-deterministic
|
||||||
|
os: [ macos, ubuntu, windows ]
|
||||||
|
fail-fast: false # Still interested to see results from other combinations
|
||||||
|
steps:
|
||||||
|
-
|
||||||
|
name: Checkout
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
-
|
||||||
|
name: Setup node
|
||||||
|
uses: ./.github/actions/setup-node
|
||||||
|
-
|
||||||
|
name: Install dependencies
|
||||||
|
if: matrix.install-deps-before == true
|
||||||
|
uses: ./.github/actions/npm-install-dependencies
|
||||||
|
-
|
||||||
|
name: Run install-deps
|
||||||
|
run: ${{ matrix.install-command }}
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
name: security-checks
|
name: checks.security.dependencies
|
||||||
|
|
||||||
on:
|
on:
|
||||||
push:
|
push:
|
||||||
@@ -13,7 +13,7 @@ jobs:
|
|||||||
steps:
|
steps:
|
||||||
-
|
-
|
||||||
name: Checkout
|
name: Checkout
|
||||||
uses: actions/checkout@v2
|
uses: actions/checkout@v4
|
||||||
-
|
-
|
||||||
name: Setup node
|
name: Setup node
|
||||||
uses: ./.github/actions/setup-node
|
uses: ./.github/actions/setup-node
|
||||||
42
.github/workflows/checks.security.sast.yaml
vendored
Normal file
42
.github/workflows/checks.security.sast.yaml
vendored
Normal file
@@ -0,0 +1,42 @@
|
|||||||
|
name: checks.security.sast
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
pull_request:
|
||||||
|
schedule:
|
||||||
|
- cron: '0 0 * * 0' # at 00:00 on every Sunday
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
analyze:
|
||||||
|
name: Analyze
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
permissions:
|
||||||
|
actions: read
|
||||||
|
contents: read
|
||||||
|
security-events: write
|
||||||
|
|
||||||
|
strategy:
|
||||||
|
fail-fast: false
|
||||||
|
matrix:
|
||||||
|
language: [
|
||||||
|
javascript # analyzes code written in JavaScript, TypeScript and both.
|
||||||
|
]
|
||||||
|
|
||||||
|
steps:
|
||||||
|
-
|
||||||
|
name: Checkout
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
-
|
||||||
|
name: Initialize CodeQL
|
||||||
|
uses: github/codeql-action/init@v2
|
||||||
|
with:
|
||||||
|
languages: ${{ matrix.language }}
|
||||||
|
queries: +security-and-quality
|
||||||
|
-
|
||||||
|
name: Autobuild
|
||||||
|
uses: github/codeql-action/autobuild@v2
|
||||||
|
-
|
||||||
|
name: Perform CodeQL Analysis
|
||||||
|
uses: github/codeql-action/analyze@v2
|
||||||
|
with:
|
||||||
|
category: "/language:${{ matrix.language }}"
|
||||||
4
.github/workflows/release.desktop.yaml
vendored
4
.github/workflows/release.desktop.yaml
vendored
@@ -14,7 +14,7 @@ jobs:
|
|||||||
runs-on: ${{ matrix.os }}-latest
|
runs-on: ${{ matrix.os }}-latest
|
||||||
steps:
|
steps:
|
||||||
-
|
-
|
||||||
uses: actions/checkout@v2
|
uses: actions/checkout@v4
|
||||||
with:
|
with:
|
||||||
ref: master # otherwise it defaults to the version tag missing bump commit
|
ref: master # otherwise it defaults to the version tag missing bump commit
|
||||||
fetch-depth: 0 # fetch all history
|
fetch-depth: 0 # fetch all history
|
||||||
@@ -26,7 +26,7 @@ jobs:
|
|||||||
uses: ./.github/actions/setup-node
|
uses: ./.github/actions/setup-node
|
||||||
-
|
-
|
||||||
name: Install dependencies
|
name: Install dependencies
|
||||||
run: npm ci
|
uses: ./.github/actions/npm-install-dependencies
|
||||||
-
|
-
|
||||||
name: Run unit tests
|
name: Run unit tests
|
||||||
run: npm run test:unit
|
run: npm run test:unit
|
||||||
|
|||||||
23
.github/workflows/release.site.yaml
vendored
23
.github/workflows/release.site.yaml
vendored
@@ -10,7 +10,7 @@ jobs:
|
|||||||
steps:
|
steps:
|
||||||
-
|
-
|
||||||
name: "Infrastructure: Checkout"
|
name: "Infrastructure: Checkout"
|
||||||
uses: actions/checkout@v2
|
uses: actions/checkout@v4
|
||||||
with:
|
with:
|
||||||
path: aws
|
path: aws
|
||||||
repository: undergroundwires/aws-static-site-with-cd
|
repository: undergroundwires/aws-static-site-with-cd
|
||||||
@@ -75,7 +75,7 @@ jobs:
|
|||||||
working-directory: aws
|
working-directory: aws
|
||||||
-
|
-
|
||||||
name: "App: Checkout"
|
name: "App: Checkout"
|
||||||
uses: actions/checkout@v2
|
uses: actions/checkout@v4
|
||||||
with:
|
with:
|
||||||
path: app
|
path: app
|
||||||
ref: master # otherwise we don't get version bump commit
|
ref: master # otherwise we don't get version bump commit
|
||||||
@@ -84,8 +84,9 @@ jobs:
|
|||||||
uses: ./app/.github/actions/setup-node
|
uses: ./app/.github/actions/setup-node
|
||||||
-
|
-
|
||||||
name: "App: Install dependencies"
|
name: "App: Install dependencies"
|
||||||
run: npm ci
|
uses: ./app/.github/actions/npm-install-dependencies
|
||||||
working-directory: app
|
with:
|
||||||
|
working-directory: app
|
||||||
-
|
-
|
||||||
name: "App: Run unit tests"
|
name: "App: Run unit tests"
|
||||||
run: npm run test:unit
|
run: npm run test:unit
|
||||||
@@ -94,11 +95,21 @@ jobs:
|
|||||||
name: "App: Build"
|
name: "App: Build"
|
||||||
run: npm run build
|
run: npm run build
|
||||||
working-directory: app
|
working-directory: app
|
||||||
|
-
|
||||||
|
name: "App: Verify web build artifacts"
|
||||||
|
run: npm run check:verify-build-artifacts -- --web
|
||||||
|
working-directory: app
|
||||||
-
|
-
|
||||||
name: "App: Deploy to S3"
|
name: "App: Deploy to S3"
|
||||||
run: >-
|
shell: bash
|
||||||
|
run: |-
|
||||||
|
declare web_output_dir
|
||||||
|
if ! web_output_dir=$(cd app && node scripts/print-dist-dir.js --web); then
|
||||||
|
echo 'Error: Could not determine distribution directory.'
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
bash "aws/scripts/deploy/deploy-to-s3.sh" \
|
bash "aws/scripts/deploy/deploy-to-s3.sh" \
|
||||||
--folder app/dist \
|
--folder "${web_output_dir}" \
|
||||||
--web-stack-name privacysexy-web-stack --web-stack-s3-name-output-name S3BucketName \
|
--web-stack-name privacysexy-web-stack --web-stack-s3-name-output-name S3BucketName \
|
||||||
--storage-class ONEZONE_IA \
|
--storage-class ONEZONE_IA \
|
||||||
--role-arn ${{secrets.AWS_S3_SITE_DEPLOYMENT_ROLE_ARN}} \
|
--role-arn ${{secrets.AWS_S3_SITE_DEPLOYMENT_ROLE_ARN}} \
|
||||||
|
|||||||
42
.github/workflows/tests.e2e.yaml
vendored
42
.github/workflows/tests.e2e.yaml
vendored
@@ -14,13 +14,51 @@ jobs:
|
|||||||
steps:
|
steps:
|
||||||
-
|
-
|
||||||
name: Checkout
|
name: Checkout
|
||||||
uses: actions/checkout@v2
|
uses: actions/checkout@v4
|
||||||
-
|
-
|
||||||
name: Setup node
|
name: Setup node
|
||||||
uses: ./.github/actions/setup-node
|
uses: ./.github/actions/setup-node
|
||||||
-
|
-
|
||||||
name: Install dependencies
|
name: Install dependencies
|
||||||
run: npm ci
|
uses: ./.github/actions/npm-install-dependencies
|
||||||
-
|
-
|
||||||
name: Run e2e tests
|
name: Run e2e tests
|
||||||
run: npm run test:cy:run
|
run: npm run test:cy:run
|
||||||
|
-
|
||||||
|
name: Output artifact directories
|
||||||
|
id: artifacts
|
||||||
|
if: always() # Run even if previous steps fail because test run video is always captured
|
||||||
|
shell: bash
|
||||||
|
run: |-
|
||||||
|
declare -r dirs_json_file='cypress-dirs.json'
|
||||||
|
if [ ! -f "${dirs_json_file}" ]; then
|
||||||
|
echo "${dirs_json_file} does not exist"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
SCREENSHOTS_DIR=$(jq -r '.screenshots' "${dirs_json_file}")
|
||||||
|
VIDEOS_DIR=$(jq -r '.videos' "${dirs_json_file}")
|
||||||
|
|
||||||
|
for dir in "${SCREENSHOTS_DIR}" "${VIDEOS_DIR}"; do
|
||||||
|
if [ "${dir}" = 'null' ] || [ -z "${dir}" ]; then
|
||||||
|
echo "One or more directories are null or not specified in cypress-dirs.json"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
|
||||||
|
echo "SCREENSHOTS_DIR=${SCREENSHOTS_DIR}" >> "${GITHUB_OUTPUT}"
|
||||||
|
echo "VIDEOS_DIR=${VIDEOS_DIR}" >> "${GITHUB_OUTPUT}"
|
||||||
|
-
|
||||||
|
name: Upload screenshots
|
||||||
|
if: failure() # Run only if previous steps fail because screenshots will be generated only if E2E test failed
|
||||||
|
uses: actions/upload-artifact@v3
|
||||||
|
with:
|
||||||
|
name: e2e-screenshots-${{ matrix.os }}
|
||||||
|
path: ${{ steps.artifacts.outputs.SCREENSHOTS_DIR }}
|
||||||
|
-
|
||||||
|
name: Upload videos
|
||||||
|
if: always() # Run even if previous steps fail because test run video is always captured
|
||||||
|
uses: actions/upload-artifact@v3
|
||||||
|
with:
|
||||||
|
name: e2e-videos-${{ matrix.os }}
|
||||||
|
path: ${{ steps.artifacts.outputs.VIDEOS_DIR }}
|
||||||
|
|||||||
4
.github/workflows/tests.integration.yaml
vendored
4
.github/workflows/tests.integration.yaml
vendored
@@ -16,13 +16,13 @@ jobs:
|
|||||||
steps:
|
steps:
|
||||||
-
|
-
|
||||||
name: Checkout
|
name: Checkout
|
||||||
uses: actions/checkout@v2
|
uses: actions/checkout@v4
|
||||||
-
|
-
|
||||||
name: Setup node
|
name: Setup node
|
||||||
uses: ./.github/actions/setup-node
|
uses: ./.github/actions/setup-node
|
||||||
-
|
-
|
||||||
name: Install dependencies
|
name: Install dependencies
|
||||||
run: npm ci
|
uses: ./.github/actions/npm-install-dependencies
|
||||||
-
|
-
|
||||||
name: Run integration tests
|
name: Run integration tests
|
||||||
run: npm run test:integration
|
run: npm run test:integration
|
||||||
|
|||||||
4
.github/workflows/tests.unit.yaml
vendored
4
.github/workflows/tests.unit.yaml
vendored
@@ -14,13 +14,13 @@ jobs:
|
|||||||
steps:
|
steps:
|
||||||
-
|
-
|
||||||
name: Checkout
|
name: Checkout
|
||||||
uses: actions/checkout@v2
|
uses: actions/checkout@v4
|
||||||
-
|
-
|
||||||
name: Set-up node
|
name: Set-up node
|
||||||
uses: ./.github/actions/setup-node
|
uses: ./.github/actions/setup-node
|
||||||
-
|
-
|
||||||
name: Install dependencies
|
name: Install dependencies
|
||||||
run: npm ci
|
uses: ./.github/actions/npm-install-dependencies
|
||||||
-
|
-
|
||||||
name: Run unit tests
|
name: Run unit tests
|
||||||
run: npm run test:unit
|
run: npm run test:unit
|
||||||
|
|||||||
14
.gitignore
vendored
14
.gitignore
vendored
@@ -1,7 +1,13 @@
|
|||||||
|
# Application build artifacts
|
||||||
|
/dist-*/
|
||||||
|
|
||||||
|
# npm
|
||||||
node_modules
|
node_modules
|
||||||
dist/
|
|
||||||
.vs
|
# Visual Studio Code
|
||||||
.vscode/**/*
|
.vscode/**/*
|
||||||
!.vscode/extensions.json
|
!.vscode/extensions.json
|
||||||
#Electron-builder output
|
|
||||||
/dist_electron
|
# draw.io
|
||||||
|
*.bkp
|
||||||
|
*.dtmp
|
||||||
|
|||||||
103
CHANGELOG.md
103
CHANGELOG.md
@@ -1,5 +1,108 @@
|
|||||||
# Changelog
|
# Changelog
|
||||||
|
|
||||||
|
## 0.12.7 (2023-11-07)
|
||||||
|
|
||||||
|
* Add winget download instructions | [b2ffc90](https://github.com/undergroundwires/privacy.sexy/commit/b2ffc90da70367b9e65c82556e8f440f865ceb98)
|
||||||
|
* Fix unresponsive copy button on instructions modal | [8ccaec7](https://github.com/undergroundwires/privacy.sexy/commit/8ccaec7af6ea3ecfd46bab5c13b90f71d55e32c1)
|
||||||
|
* Fix tree node check states not being updated | [af7219f](https://github.com/undergroundwires/privacy.sexy/commit/af7219f6e12ab4a65ce07190f691cf3234e87e35)
|
||||||
|
|
||||||
|
[compare](https://github.com/undergroundwires/privacy.sexy/compare/0.12.6...0.12.7)
|
||||||
|
|
||||||
|
## 0.12.6 (2023-11-03)
|
||||||
|
|
||||||
|
* Bump dependencies to latest | [25d7f7b](https://github.com/undergroundwires/privacy.sexy/commit/25d7f7b2a479e51e092881cc2751e67a7d3f179f)
|
||||||
|
* win: improve system app uninstall cleanup #73 | [dbe3c5c](https://github.com/undergroundwires/privacy.sexy/commit/dbe3c5cfb91ba8a1657838b69117858843c8fbc8)
|
||||||
|
* win: improve system app uninstall /w fallback #260 | [98a26f9](https://github.com/undergroundwires/privacy.sexy/commit/98a26f9ae47af2668aa53f39d1768983036048ce)
|
||||||
|
* Improve performance of rendering during search | [79b46bf](https://github.com/undergroundwires/privacy.sexy/commit/79b46bf21004d96d31551439e5db5d698a3f71f3)
|
||||||
|
* Fix YAML error for site release in CI/CD | [237d994](https://github.com/undergroundwires/privacy.sexy/commit/237d9944f900f5172366868d75219224ff0542b0)
|
||||||
|
* win: fix Microsoft Advertising app removal #200 | [e40b9a3](https://github.com/undergroundwires/privacy.sexy/commit/e40b9a3cf53c341f2e84023a9f0e9680ac08f3fa)
|
||||||
|
* win: improve directory cleanup security | [060e789](https://github.com/undergroundwires/privacy.sexy/commit/060e7896624309aebd25e8b190c127282de177e8)
|
||||||
|
* Centralize Electron entry file path configuration | [d6da406](https://github.com/undergroundwires/privacy.sexy/commit/d6da406c61e5b9f5408851d1302d6d7398157a2e)
|
||||||
|
* win: prevent updates from reinstalling apps #260 | [8570b02](https://github.com/undergroundwires/privacy.sexy/commit/8570b02dde14ffad64863f614682c3fc1f87b6c2)
|
||||||
|
* win: improve script environment robustness #221 | [dfd4451](https://github.com/undergroundwires/privacy.sexy/commit/dfd44515613f38abe5a806bda36f44e7b715b50b)
|
||||||
|
* Fix compiler failing with nested `with` expression | [80821fc](https://github.com/undergroundwires/privacy.sexy/commit/80821fca0769e5fd2c6338918fbdcea12fbe83d2)
|
||||||
|
* win: improve soft file/app delete security #260 | [f4a74f0](https://github.com/undergroundwires/privacy.sexy/commit/f4a74f058db9b5bcbcbe438785db5ec88ecc1657)
|
||||||
|
* Fix incorrect tooltip position after window resize | [f8e5f1a](https://github.com/undergroundwires/privacy.sexy/commit/f8e5f1a5a2afa1f18567e6d965359b6a1f082367)
|
||||||
|
* linux: fix string formatting of Firefox configs | [e775d68](https://github.com/undergroundwires/privacy.sexy/commit/e775d68a9b4a5f9e893ff0e3500dade036185193)
|
||||||
|
* win: improve file delete | [e72c1c1](https://github.com/undergroundwires/privacy.sexy/commit/e72c1c13ea2d73ebfc7a8da5a21254fdfc0e5b59)
|
||||||
|
* win: change system app removal to hard delete #260 | [77123d8](https://github.com/undergroundwires/privacy.sexy/commit/77123d8c929d23676a9cb21d7b697703fd1b6e82)
|
||||||
|
* Improve UI performance by optimizing reactivity | [4995e49](https://github.com/undergroundwires/privacy.sexy/commit/4995e49c469211404dac9fcb79b75eb121f80bce)
|
||||||
|
* Migrate to Vue 3.0 #230 | [ca81f68](https://github.com/undergroundwires/privacy.sexy/commit/ca81f68ff1c3bbe5b22981096ae9220b0b5851c7)
|
||||||
|
* win, linux: unify & improve Firefox clean-up #273 | [0466b86](https://github.com/undergroundwires/privacy.sexy/commit/0466b86f1013341c966a9bbf6513990337b16598)
|
||||||
|
* win: fix store revert for multiple installs #260 | [5bb13e3](https://github.com/undergroundwires/privacy.sexy/commit/5bb13e34f8de2e2a7ba943ff72b12c0569435e62)
|
||||||
|
|
||||||
|
[compare](https://github.com/undergroundwires/privacy.sexy/compare/0.12.5...0.12.6)
|
||||||
|
|
||||||
|
## 0.12.5 (2023-10-13)
|
||||||
|
|
||||||
|
* Fix Docker build and improve checks #220 | [7669985](https://github.com/undergroundwires/privacy.sexy/commit/7669985f8e1446e726a95626ecf35b3ce6b60a16)
|
||||||
|
* Add SAST security checks with SECURITY.md #178 | [3e5239f](https://github.com/undergroundwires/privacy.sexy/commit/3e5239f7d35e57749c01adf3dbbcd365aebb39c8)
|
||||||
|
* Add Scoop download instructions #174 | [cf55ca9](https://github.com/undergroundwires/privacy.sexy/commit/cf55ca9e28b064fa7a516077a9da23e3a8e3f534)
|
||||||
|
* win: fix and improve temp dir cleanup #176, #89 | [d457504](https://github.com/undergroundwires/privacy.sexy/commit/d45750428cca010daf2721b33a8ae3a01b28813b)
|
||||||
|
* win, linux: improve VSCode setting robustness #196 | [e8a52f7](https://github.com/undergroundwires/privacy.sexy/commit/e8a52f717dc799b34ceeb1c27c2b8219391dff6a)
|
||||||
|
* linux: fix obsolete Firefox DPI script #239 | [e5f6edf](https://github.com/undergroundwires/privacy.sexy/commit/e5f6edf405bcec7c29ea4d7932d1910620fa15f8)
|
||||||
|
* win: add removal of Edge assocations #64 | [888c916](https://github.com/undergroundwires/privacy.sexy/commit/888c9166fc66a2094137fa8be739cc21bafef5f6)
|
||||||
|
* win: improve Edge & OneDrive shortcut removal #73 | [8501495](https://github.com/undergroundwires/privacy.sexy/commit/8501495c170af61913288a63dbd369db5bbc5003)
|
||||||
|
* win: relocate and document SecHealthUI #190 | [2862951](https://github.com/undergroundwires/privacy.sexy/commit/286295128d0179358e0c6b7b6415d752175a1aed)
|
||||||
|
* Add developer toolkit UI component | [2147eae](https://github.com/undergroundwires/privacy.sexy/commit/2147eae687b82d05bc43bb4605d9068f148bb92a)
|
||||||
|
* win: fix and improve network data usage reset #265 | [5e359c2](https://github.com/undergroundwires/privacy.sexy/commit/5e359c2fb82a08e6acf7159b70ca86a8234b359b)
|
||||||
|
* win: improve app reversion and docs #260 | [a3f11df](https://github.com/undergroundwires/privacy.sexy/commit/a3f11dff187c821a00910c20dac05e285cda9073)
|
||||||
|
* Fix working directory in CI/CD web release | [698b570](https://github.com/undergroundwires/privacy.sexy/commit/698b570ee6e300d6703015464f4345b5e706f1cb)
|
||||||
|
* Implement new UI component for icons #230 | [48730bc](https://github.com/undergroundwires/privacy.sexy/commit/48730bca0506120bca4bf3a23545d59f2b1a9009)
|
||||||
|
* win: fix and improve AppCompat disabling #255 | [bab6316](https://github.com/undergroundwires/privacy.sexy/commit/bab6316e7625230cf4a4cf67c3aca417347db75c)
|
||||||
|
* win, linux, mac: fix typos and improve naming | [67c3677](https://github.com/undergroundwires/privacy.sexy/commit/67c3677621b201525a813e8a26f07d607176e89b)
|
||||||
|
|
||||||
|
[compare](https://github.com/undergroundwires/privacy.sexy/compare/0.12.4...0.12.5)
|
||||||
|
|
||||||
|
## 0.12.4 (2023-09-25)
|
||||||
|
|
||||||
|
* win: fix Windows spotlight revert, docs, recommend | [659fea7](https://github.com/undergroundwires/privacy.sexy/commit/659fea7afcabcd0ea273cfdcc8c4bae190c126f3)
|
||||||
|
* win: fix Edge telemetry disabling for v116+ #242 | [6d301f9](https://github.com/undergroundwires/privacy.sexy/commit/6d301f99616ed49975876803d0098eafe4d3cb2e)
|
||||||
|
* win: fix, improve disabling automatic updates #252 | [6e9b65d](https://github.com/undergroundwires/privacy.sexy/commit/6e9b65d8b1b481c1471dde90876c37838b4ac4e5)
|
||||||
|
* win: refactor `update.mode` key for VSCode #215 | [c27172c](https://github.com/undergroundwires/privacy.sexy/commit/c27172c32e7c316b7cb0f44cab611eed89ca034e)
|
||||||
|
* Fix wrong action path in website CI deployment | [a1f2497](https://github.com/undergroundwires/privacy.sexy/commit/a1f24973813ccbdd7e1f06c64e1912a991a6bb64)
|
||||||
|
* Fix compiler bug with nested optional arguments | [53222fd](https://github.com/undergroundwires/privacy.sexy/commit/53222fd83c2846089746a217482195806f960d18)
|
||||||
|
* Fix no spacing after lists in documentation text | [f810ed0](https://github.com/undergroundwires/privacy.sexy/commit/f810ed0c147c2a46cae3b70b635ed81128646fff)
|
||||||
|
* Rewrite tooltip UI for efficiency and Vue 3.0 #230 | [8b930fc](https://github.com/undergroundwires/privacy.sexy/commit/8b930fc57c8ee6691ed6165bcb27d97e64a1a0c0)
|
||||||
|
* win: fix uninstallation of newer Edge #236 | [60dde11](https://github.com/undergroundwires/privacy.sexy/commit/60dde11311a2409537f5965f370b0daaaec53339)
|
||||||
|
* win: fix delivery optimization side-effects #173 | [203daeb](https://github.com/undergroundwires/privacy.sexy/commit/203daeb4a2fca0a0295cbc2a736394f9f87725e6)
|
||||||
|
* win: fix Defender scan artifacts removal #246 | [cb21a97](https://github.com/undergroundwires/privacy.sexy/commit/cb21a970b6b867e1476a5eb8a72b9a7fdd53a744)
|
||||||
|
* Fix outdated and broken links in README #161 | [0303ef2](https://github.com/undergroundwires/privacy.sexy/commit/0303ef2fd98b36306523e2a0c5f5ae812a4c6c99)
|
||||||
|
* Fix loss of tree node state when switching views | [8f188ac](https://github.com/undergroundwires/privacy.sexy/commit/8f188acd3c2d93e40c89569c74bc5cff992f0052)
|
||||||
|
* Fix slow appearance of nodes on tree view | [bd2082e](https://github.com/undergroundwires/privacy.sexy/commit/bd2082e8c574db065bb4462f30ea3ace2cb028cb)
|
||||||
|
|
||||||
|
[compare](https://github.com/undergroundwires/privacy.sexy/compare/0.12.3...0.12.4)
|
||||||
|
|
||||||
|
## 0.12.3 (2023-09-09)
|
||||||
|
|
||||||
|
* linux: use user.js over prefs.js for Firefox #232 | [dae6d11](https://github.com/undergroundwires/privacy.sexy/commit/dae6d114daab6857d773071211eb57619b136281)
|
||||||
|
* win: fix typo in Defender retention script #213 | [35be05d](https://github.com/undergroundwires/privacy.sexy/commit/35be05df2094ea8bba4ee4725e6fa4956a79493d)
|
||||||
|
* Improve desktop runtime execution tests | [ad0576a](https://github.com/undergroundwires/privacy.sexy/commit/ad0576a752f8fd6ea2f917a59173fe61f9951246)
|
||||||
|
* Fix Windows artifact naming in desktop packaging | [f4d86fc](https://github.com/undergroundwires/privacy.sexy/commit/f4d86fccfd0e73e94c8c6e400a33514900bc5abe)
|
||||||
|
* Refactor and improve external URL checks | [19e42c9](https://github.com/undergroundwires/privacy.sexy/commit/19e42c9c52a18c813ded4265e687e01032cdd4c8)
|
||||||
|
* Fix memory leaks via auto-unsubscribing and DI | [eb096d0](https://github.com/undergroundwires/privacy.sexy/commit/eb096d07e276e1b4c8040220c47f186d02841e14)
|
||||||
|
* Refactor build configs and improve CI/CD checks | [0a2a1a0](https://github.com/undergroundwires/privacy.sexy/commit/0a2a1a026b0efb29624be82b06536c518c1ea439)
|
||||||
|
* Introduce retry mechanism for npm install in CI/CD | [4beb1bb](https://github.com/undergroundwires/privacy.sexy/commit/4beb1bb5748a60886210187ca3cdc7f4b41067c0)
|
||||||
|
* win: fix disable recent apps revert #211, #248 | [4ce327e](https://github.com/undergroundwires/privacy.sexy/commit/4ce327eb6af542ed2916d649553e5e1ba5833882)
|
||||||
|
* Change license to AGPLv3 | [821cc62](https://github.com/undergroundwires/privacy.sexy/commit/821cc62c4c8347cb76d041f82f574754e4d948c5)
|
||||||
|
* Introduce new TreeView UI component | [65f121c](https://github.com/undergroundwires/privacy.sexy/commit/65f121c451af87315e1c91df4198562e0445b2c2)
|
||||||
|
|
||||||
|
[compare](https://github.com/undergroundwires/privacy.sexy/compare/0.12.2...0.12.3)
|
||||||
|
|
||||||
|
## 0.12.2 (2023-08-25)
|
||||||
|
|
||||||
|
* Add automated checks for desktop app runtime #233 | [04b3133](https://github.com/undergroundwires/privacy.sexy/commit/04b3133500485d0d278a81a177a1677134131405)
|
||||||
|
* win: fix automatic updates revert #234 | [0873769](https://github.com/undergroundwires/privacy.sexy/commit/08737698c2283bdf535d1611a730031ebfc7c0df)
|
||||||
|
* Migrate unit/integration tests to Vitest with Vite | [5f11c8d](https://github.com/undergroundwires/privacy.sexy/commit/5f11c8d98f782dd7c77f27649a1685fb7bd06e13)
|
||||||
|
* Remove Vue ESLint plugin for Vite compatibility | [6e40edd](https://github.com/undergroundwires/privacy.sexy/commit/6e40edd3f8a063c1b7482c27d8368e14c2fbcfbf)
|
||||||
|
* Migrate web builds from Vue CLI to Vite | [7365905](https://github.com/undergroundwires/privacy.sexy/commit/736590558be51a09435bb87e78b6655e8533bc2e)
|
||||||
|
* Migrate Cypress (E2E) tests to Vite and TypeScript | [ec98d84](https://github.com/undergroundwires/privacy.sexy/commit/ec98d8417f779fa818ccdda6bb90f521e1738002)
|
||||||
|
* Migrate to `electron-vite` and `electron-builder` | [75c9b51](https://github.com/undergroundwires/privacy.sexy/commit/75c9b51bf2d1dc7269adfd7b5ed71acfb5031299)
|
||||||
|
* Fix searching/filtering bugs #235 | [62f8bfa](https://github.com/undergroundwires/privacy.sexy/commit/62f8bfac2f481c93598fe19a51594769f522d684)
|
||||||
|
* Improve desktop security by isolating Electron | [e9e0001](https://github.com/undergroundwires/privacy.sexy/commit/e9e0001ef845fa6935c59a4e20a89aac9e71756a)
|
||||||
|
|
||||||
|
[compare](https://github.com/undergroundwires/privacy.sexy/compare/0.12.1...0.12.2)
|
||||||
|
|
||||||
## 0.12.1 (2023-08-17)
|
## 0.12.1 (2023-08-17)
|
||||||
|
|
||||||
* Transition to eslint-config-airbnb-with-typescript | [ff84f56](https://github.com/undergroundwires/privacy.sexy/commit/ff84f5676e496dd7ec5b3599e34ec9627d181ea2)
|
* Transition to eslint-config-airbnb-with-typescript | [ff84f56](https://github.com/undergroundwires/privacy.sexy/commit/ff84f5676e496dd7ec5b3599e34ec9627d181ea2)
|
||||||
|
|||||||
@@ -43,6 +43,7 @@ You have two alternatives:
|
|||||||
|
|
||||||
1. [Create an issue](https://github.com/undergroundwires/privacy.sexy/issues/new/choose) and ask for someone else to add the script for you.
|
1. [Create an issue](https://github.com/undergroundwires/privacy.sexy/issues/new/choose) and ask for someone else to add the script for you.
|
||||||
2. Or send a PR yourself. This would make it faster to get your code into the project. You need to add scripts to related OS in [collections](src/application/collections/) folder. Then you'd sent a pull request, see [pull request process](#pull-request-process).
|
2. Or send a PR yourself. This would make it faster to get your code into the project. You need to add scripts to related OS in [collections](src/application/collections/) folder. Then you'd sent a pull request, see [pull request process](#pull-request-process).
|
||||||
|
- 💡 You should use existing shared functions for most of the operations, like `DisableService` for disabling services, to maintain code consistency and efficiency.
|
||||||
- 📖 If you're unsure about the syntax, check [collection-files.md](docs/collection-files.md).
|
- 📖 If you're unsure about the syntax, check [collection-files.md](docs/collection-files.md).
|
||||||
- 📖 If you wish to use templates, use [templating.md](./docs/templating.md).
|
- 📖 If you wish to use templates, use [templating.md](./docs/templating.md).
|
||||||
|
|
||||||
|
|||||||
17
Dockerfile
17
Dockerfile
@@ -1,13 +1,16 @@
|
|||||||
# Build
|
# Build
|
||||||
FROM node:lts-alpine as build-stage
|
FROM node:lts-alpine AS build-stage
|
||||||
WORKDIR /app
|
WORKDIR /app
|
||||||
COPY package*.json ./
|
|
||||||
RUN npm install
|
|
||||||
COPY . .
|
COPY . .
|
||||||
RUN npm run build
|
RUN npm run install-deps
|
||||||
|
RUN npm run build \
|
||||||
|
&& npm run check:verify-build-artifacts -- --web
|
||||||
|
RUN mkdir /dist \
|
||||||
|
&& dist_directory=$(node 'scripts/print-dist-dir.js' --web) \
|
||||||
|
&& cp -a "${dist_directory}/." '/dist'
|
||||||
|
|
||||||
# Production stage
|
# Production stage
|
||||||
FROM nginx:stable-alpine as production-stage
|
FROM nginx:stable-alpine AS production-stage
|
||||||
COPY --from=build-stage /app/dist /usr/share/nginx/html
|
COPY --from=build-stage /dist /usr/share/nginx/html
|
||||||
EXPOSE 80
|
EXPOSE 80
|
||||||
CMD ["nginx", "-g", "daemon off;"]
|
CMD ["nginx", "-g", "daemon off;"]
|
||||||
|
|||||||
141
LICENSE
141
LICENSE
@@ -1,5 +1,5 @@
|
|||||||
GNU GENERAL PUBLIC LICENSE
|
GNU AFFERO GENERAL PUBLIC LICENSE
|
||||||
Version 3, 29 June 2007
|
Version 3, 19 November 2007
|
||||||
|
|
||||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||||
Everyone is permitted to copy and distribute verbatim copies
|
Everyone is permitted to copy and distribute verbatim copies
|
||||||
@@ -7,17 +7,15 @@
|
|||||||
|
|
||||||
Preamble
|
Preamble
|
||||||
|
|
||||||
The GNU General Public License is a free, copyleft license for
|
The GNU Affero General Public License is a free, copyleft license for
|
||||||
software and other kinds of works.
|
software and other kinds of works, specifically designed to ensure
|
||||||
|
cooperation with the community in the case of network server software.
|
||||||
|
|
||||||
The licenses for most software and other practical works are designed
|
The licenses for most software and other practical works are designed
|
||||||
to take away your freedom to share and change the works. By contrast,
|
to take away your freedom to share and change the works. By contrast,
|
||||||
the GNU General Public License is intended to guarantee your freedom to
|
our General Public Licenses are intended to guarantee your freedom to
|
||||||
share and change all versions of a program--to make sure it remains free
|
share and change all versions of a program--to make sure it remains free
|
||||||
software for all its users. We, the Free Software Foundation, use the
|
software for all its users.
|
||||||
GNU General Public License for most of our software; it applies also to
|
|
||||||
any other work released this way by its authors. You can apply it to
|
|
||||||
your programs, too.
|
|
||||||
|
|
||||||
When we speak of free software, we are referring to freedom, not
|
When we speak of free software, we are referring to freedom, not
|
||||||
price. Our General Public Licenses are designed to make sure that you
|
price. Our General Public Licenses are designed to make sure that you
|
||||||
@@ -26,44 +24,34 @@ them if you wish), that you receive source code or can get it if you
|
|||||||
want it, that you can change the software or use pieces of it in new
|
want it, that you can change the software or use pieces of it in new
|
||||||
free programs, and that you know you can do these things.
|
free programs, and that you know you can do these things.
|
||||||
|
|
||||||
To protect your rights, we need to prevent others from denying you
|
Developers that use our General Public Licenses protect your rights
|
||||||
these rights or asking you to surrender the rights. Therefore, you have
|
with two steps: (1) assert copyright on the software, and (2) offer
|
||||||
certain responsibilities if you distribute copies of the software, or if
|
you this License which gives you legal permission to copy, distribute
|
||||||
you modify it: responsibilities to respect the freedom of others.
|
and/or modify the software.
|
||||||
|
|
||||||
For example, if you distribute copies of such a program, whether
|
A secondary benefit of defending all users' freedom is that
|
||||||
gratis or for a fee, you must pass on to the recipients the same
|
improvements made in alternate versions of the program, if they
|
||||||
freedoms that you received. You must make sure that they, too, receive
|
receive widespread use, become available for other developers to
|
||||||
or can get the source code. And you must show them these terms so they
|
incorporate. Many developers of free software are heartened and
|
||||||
know their rights.
|
encouraged by the resulting cooperation. However, in the case of
|
||||||
|
software used on network servers, this result may fail to come about.
|
||||||
|
The GNU General Public License permits making a modified version and
|
||||||
|
letting the public access it on a server without ever releasing its
|
||||||
|
source code to the public.
|
||||||
|
|
||||||
Developers that use the GNU GPL protect your rights with two steps:
|
The GNU Affero General Public License is designed specifically to
|
||||||
(1) assert copyright on the software, and (2) offer you this License
|
ensure that, in such cases, the modified source code becomes available
|
||||||
giving you legal permission to copy, distribute and/or modify it.
|
to the community. It requires the operator of a network server to
|
||||||
|
provide the source code of the modified version running there to the
|
||||||
|
users of that server. Therefore, public use of a modified version, on
|
||||||
|
a publicly accessible server, gives the public access to the source
|
||||||
|
code of the modified version.
|
||||||
|
|
||||||
For the developers' and authors' protection, the GPL clearly explains
|
An older license, called the Affero General Public License and
|
||||||
that there is no warranty for this free software. For both users' and
|
published by Affero, was designed to accomplish similar goals. This is
|
||||||
authors' sake, the GPL requires that modified versions be marked as
|
a different license, not a version of the Affero GPL, but Affero has
|
||||||
changed, so that their problems will not be attributed erroneously to
|
released a new version of the Affero GPL which permits relicensing under
|
||||||
authors of previous versions.
|
this license.
|
||||||
|
|
||||||
Some devices are designed to deny users access to install or run
|
|
||||||
modified versions of the software inside them, although the manufacturer
|
|
||||||
can do so. This is fundamentally incompatible with the aim of
|
|
||||||
protecting users' freedom to change the software. The systematic
|
|
||||||
pattern of such abuse occurs in the area of products for individuals to
|
|
||||||
use, which is precisely where it is most unacceptable. Therefore, we
|
|
||||||
have designed this version of the GPL to prohibit the practice for those
|
|
||||||
products. If such problems arise substantially in other domains, we
|
|
||||||
stand ready to extend this provision to those domains in future versions
|
|
||||||
of the GPL, as needed to protect the freedom of users.
|
|
||||||
|
|
||||||
Finally, every program is threatened constantly by software patents.
|
|
||||||
States should not allow patents to restrict development and use of
|
|
||||||
software on general-purpose computers, but in those that do, we wish to
|
|
||||||
avoid the special danger that patents applied to a free program could
|
|
||||||
make it effectively proprietary. To prevent this, the GPL assures that
|
|
||||||
patents cannot be used to render the program non-free.
|
|
||||||
|
|
||||||
The precise terms and conditions for copying, distribution and
|
The precise terms and conditions for copying, distribution and
|
||||||
modification follow.
|
modification follow.
|
||||||
@@ -72,7 +60,7 @@ modification follow.
|
|||||||
|
|
||||||
0. Definitions.
|
0. Definitions.
|
||||||
|
|
||||||
"This License" refers to version 3 of the GNU General Public License.
|
"This License" refers to version 3 of the GNU Affero General Public License.
|
||||||
|
|
||||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||||
works, such as semiconductor masks.
|
works, such as semiconductor masks.
|
||||||
@@ -549,35 +537,45 @@ to collect a royalty for further conveying from those to whom you convey
|
|||||||
the Program, the only way you could satisfy both those terms and this
|
the Program, the only way you could satisfy both those terms and this
|
||||||
License would be to refrain entirely from conveying the Program.
|
License would be to refrain entirely from conveying the Program.
|
||||||
|
|
||||||
13. Use with the GNU Affero General Public License.
|
13. Remote Network Interaction; Use with the GNU General Public License.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, if you modify the
|
||||||
|
Program, your modified version must prominently offer all users
|
||||||
|
interacting with it remotely through a computer network (if your version
|
||||||
|
supports such interaction) an opportunity to receive the Corresponding
|
||||||
|
Source of your version by providing access to the Corresponding Source
|
||||||
|
from a network server at no charge, through some standard or customary
|
||||||
|
means of facilitating copying of software. This Corresponding Source
|
||||||
|
shall include the Corresponding Source for any work covered by version 3
|
||||||
|
of the GNU General Public License that is incorporated pursuant to the
|
||||||
|
following paragraph.
|
||||||
|
|
||||||
Notwithstanding any other provision of this License, you have
|
Notwithstanding any other provision of this License, you have
|
||||||
permission to link or combine any covered work with a work licensed
|
permission to link or combine any covered work with a work licensed
|
||||||
under version 3 of the GNU Affero General Public License into a single
|
under version 3 of the GNU General Public License into a single
|
||||||
combined work, and to convey the resulting work. The terms of this
|
combined work, and to convey the resulting work. The terms of this
|
||||||
License will continue to apply to the part which is the covered work,
|
License will continue to apply to the part which is the covered work,
|
||||||
but the special requirements of the GNU Affero General Public License,
|
but the work with which it is combined will remain governed by version
|
||||||
section 13, concerning interaction through a network will apply to the
|
3 of the GNU General Public License.
|
||||||
combination as such.
|
|
||||||
|
|
||||||
14. Revised Versions of this License.
|
14. Revised Versions of this License.
|
||||||
|
|
||||||
The Free Software Foundation may publish revised and/or new versions of
|
The Free Software Foundation may publish revised and/or new versions of
|
||||||
the GNU General Public License from time to time. Such new versions will
|
the GNU Affero General Public License from time to time. Such new versions
|
||||||
be similar in spirit to the present version, but may differ in detail to
|
will be similar in spirit to the present version, but may differ in detail to
|
||||||
address new problems or concerns.
|
address new problems or concerns.
|
||||||
|
|
||||||
Each version is given a distinguishing version number. If the
|
Each version is given a distinguishing version number. If the
|
||||||
Program specifies that a certain numbered version of the GNU General
|
Program specifies that a certain numbered version of the GNU Affero General
|
||||||
Public License "or any later version" applies to it, you have the
|
Public License "or any later version" applies to it, you have the
|
||||||
option of following the terms and conditions either of that numbered
|
option of following the terms and conditions either of that numbered
|
||||||
version or of any later version published by the Free Software
|
version or of any later version published by the Free Software
|
||||||
Foundation. If the Program does not specify a version number of the
|
Foundation. If the Program does not specify a version number of the
|
||||||
GNU General Public License, you may choose any version ever published
|
GNU Affero General Public License, you may choose any version ever published
|
||||||
by the Free Software Foundation.
|
by the Free Software Foundation.
|
||||||
|
|
||||||
If the Program specifies that a proxy can decide which future
|
If the Program specifies that a proxy can decide which future
|
||||||
versions of the GNU General Public License can be used, that proxy's
|
versions of the GNU Affero General Public License can be used, that proxy's
|
||||||
public statement of acceptance of a version permanently authorizes you
|
public statement of acceptance of a version permanently authorizes you
|
||||||
to choose that version for the Program.
|
to choose that version for the Program.
|
||||||
|
|
||||||
@@ -635,40 +633,29 @@ the "copyright" line and a pointer to where the full notice is found.
|
|||||||
Copyright (C) <year> <name of author>
|
Copyright (C) <year> <name of author>
|
||||||
|
|
||||||
This program is free software: you can redistribute it and/or modify
|
This program is free software: you can redistribute it and/or modify
|
||||||
it under the terms of the GNU General Public License as published by
|
it under the terms of the GNU Affero General Public License as published by
|
||||||
the Free Software Foundation, either version 3 of the License, or
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
(at your option) any later version.
|
(at your option) any later version.
|
||||||
|
|
||||||
This program is distributed in the hope that it will be useful,
|
This program is distributed in the hope that it will be useful,
|
||||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
GNU General Public License for more details.
|
GNU Affero General Public License for more details.
|
||||||
|
|
||||||
You should have received a copy of the GNU General Public License
|
You should have received a copy of the GNU Affero General Public License
|
||||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
Also add information on how to contact you by electronic and paper mail.
|
Also add information on how to contact you by electronic and paper mail.
|
||||||
|
|
||||||
If the program does terminal interaction, make it output a short
|
If your software can interact with users remotely through a computer
|
||||||
notice like this when it starts in an interactive mode:
|
network, you should also make sure that it provides a way for users to
|
||||||
|
get its source. For example, if your program is a web application, its
|
||||||
<program> Copyright (C) <year> <name of author>
|
interface could display a "Source" link that leads users to an archive
|
||||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
of the code. There are many ways you could offer source, and different
|
||||||
This is free software, and you are welcome to redistribute it
|
solutions will be better for different programs; see section 13 for the
|
||||||
under certain conditions; type `show c' for details.
|
specific requirements.
|
||||||
|
|
||||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
|
||||||
parts of the General Public License. Of course, your program's commands
|
|
||||||
might be different; for a GUI interface, you would use an "about box".
|
|
||||||
|
|
||||||
You should also get your employer (if you work as a programmer) or school,
|
You should also get your employer (if you work as a programmer) or school,
|
||||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||||
For more information on this, and how to apply and follow the GNU GPL, see
|
For more information on this, and how to apply and follow the GNU AGPL, see
|
||||||
<https://www.gnu.org/licenses/>.
|
<https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
The GNU General Public License does not permit incorporating your program
|
|
||||||
into proprietary programs. If your program is a subroutine library, you
|
|
||||||
may consider it more useful to permit linking proprietary applications with
|
|
||||||
the library. If this is what you want to do, use the GNU Lesser General
|
|
||||||
Public License instead of this License. But first, please read
|
|
||||||
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
|
||||||
|
|||||||
69
README.md
69
README.md
@@ -16,14 +16,6 @@
|
|||||||
src="https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat"
|
src="https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat"
|
||||||
/>
|
/>
|
||||||
</a>
|
</a>
|
||||||
<!-- Code quality -->
|
|
||||||
<br />
|
|
||||||
<a href="https://lgtm.com/projects/g/undergroundwires/privacy.sexy/context:javascript" target="_blank" rel="noopener noreferrer">
|
|
||||||
<img
|
|
||||||
alt="Language grade: JavaScript/TypeScript"
|
|
||||||
src="https://img.shields.io/lgtm/grade/javascript/g/undergroundwires/privacy.sexy.svg?logo=lgtm&logoWidth=18"
|
|
||||||
/>
|
|
||||||
</a>
|
|
||||||
<a href="https://codeclimate.com/github/undergroundwires/privacy.sexy/maintainability" target="_blank" rel="noopener noreferrer">
|
<a href="https://codeclimate.com/github/undergroundwires/privacy.sexy/maintainability" target="_blank" rel="noopener noreferrer">
|
||||||
<img
|
<img
|
||||||
alt="Maintainability"
|
alt="Maintainability"
|
||||||
@@ -50,6 +42,20 @@
|
|||||||
src="https://github.com/undergroundwires/privacy.sexy/workflows/e2e-tests/badge.svg"
|
src="https://github.com/undergroundwires/privacy.sexy/workflows/e2e-tests/badge.svg"
|
||||||
/>
|
/>
|
||||||
</a>
|
</a>
|
||||||
|
<!-- Security checks -->
|
||||||
|
<br />
|
||||||
|
<a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/checks.security.sast.yaml" target="_blank" rel="noopener noreferrer">
|
||||||
|
<img
|
||||||
|
alt="Status of dependency security checks"
|
||||||
|
src="https://github.com/undergroundwires/privacy.sexy/workflows/checks.security.sast/badge.svg"
|
||||||
|
/>
|
||||||
|
</a>
|
||||||
|
<a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/checks.security.dependencies.yaml" target="_blank" rel="noopener noreferrer">
|
||||||
|
<img
|
||||||
|
alt="Status of Static Analysis Security Testing (SAST)"
|
||||||
|
src="https://github.com/undergroundwires/privacy.sexy/workflows/checks.security.dependencies/badge.svg"
|
||||||
|
/>
|
||||||
|
</a>
|
||||||
<!-- Checks -->
|
<!-- Checks -->
|
||||||
<br />
|
<br />
|
||||||
<a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/checks.quality.yaml" target="_blank" rel="noopener noreferrer">
|
<a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/checks.quality.yaml" target="_blank" rel="noopener noreferrer">
|
||||||
@@ -58,16 +64,10 @@
|
|||||||
src="https://github.com/undergroundwires/privacy.sexy/workflows/quality-checks/badge.svg"
|
src="https://github.com/undergroundwires/privacy.sexy/workflows/quality-checks/badge.svg"
|
||||||
/>
|
/>
|
||||||
</a>
|
</a>
|
||||||
<a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/checks.security.yaml" target="_blank" rel="noopener noreferrer">
|
|
||||||
<img
|
|
||||||
alt="Security checks status"
|
|
||||||
src="https://github.com/undergroundwires/privacy.sexy/workflows/security-checks/badge.svg"
|
|
||||||
/>
|
|
||||||
</a>
|
|
||||||
<a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/checks.build.yaml" target="_blank" rel="noopener noreferrer">
|
<a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/checks.build.yaml" target="_blank" rel="noopener noreferrer">
|
||||||
<img
|
<img
|
||||||
alt="Build checks status"
|
alt="Status of build checks"
|
||||||
src="https://github.com/undergroundwires/privacy.sexy/workflows/build-checks/badge.svg"
|
src="https://github.com/undergroundwires/privacy.sexy/workflows/checks.build/badge.svg"
|
||||||
/>
|
/>
|
||||||
</a>
|
</a>
|
||||||
<a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/checks.desktop-runtime-errors.yaml" target="_blank" rel="noopener noreferrer">
|
<a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/checks.desktop-runtime-errors.yaml" target="_blank" rel="noopener noreferrer">
|
||||||
@@ -76,6 +76,18 @@
|
|||||||
src="https://github.com/undergroundwires/privacy.sexy/workflows/checks.desktop-runtime-errors/badge.svg"
|
src="https://github.com/undergroundwires/privacy.sexy/workflows/checks.desktop-runtime-errors/badge.svg"
|
||||||
/>
|
/>
|
||||||
</a>
|
</a>
|
||||||
|
<a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/checks.scripts.yaml" target="_blank" rel="noopener noreferrer">
|
||||||
|
<img
|
||||||
|
alt="Status of script checks"
|
||||||
|
src="https://github.com/undergroundwires/privacy.sexy/workflows/checks.scripts/badge.svg"
|
||||||
|
/>
|
||||||
|
</a>
|
||||||
|
<a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/checks.external-urls.yaml" target="_blank" rel="noopener noreferrer">
|
||||||
|
<img
|
||||||
|
alt="Status of external URL checks"
|
||||||
|
src="https://github.com/undergroundwires/privacy.sexy/workflows/checks.external-urls/badge.svg"
|
||||||
|
/>
|
||||||
|
</a>
|
||||||
<!-- Release -->
|
<!-- Release -->
|
||||||
<br />
|
<br />
|
||||||
<a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/release.git.yaml" target="_blank" rel="noopener noreferrer">
|
<a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/release.git.yaml" target="_blank" rel="noopener noreferrer">
|
||||||
@@ -110,7 +122,7 @@
|
|||||||
## Get started
|
## Get started
|
||||||
|
|
||||||
- 🌍️ **Online**: [https://privacy.sexy](https://privacy.sexy).
|
- 🌍️ **Online**: [https://privacy.sexy](https://privacy.sexy).
|
||||||
- 🖥️ **Offline**: Check [releases page](https://github.com/undergroundwires/privacy.sexy/releases), or download directly for: [Windows](https://github.com/undergroundwires/privacy.sexy/releases/download/0.11.2/privacy.sexy-Setup-0.11.2.exe), [macOS](https://github.com/undergroundwires/privacy.sexy/releases/download/0.11.2/privacy.sexy-0.11.2.dmg), [Linux](https://github.com/undergroundwires/pr.vacy.sexy/releases/download/0.11.2/privacy.sexy-0.11.2.AppImage).
|
- 🖥️ **Offline**: Download directly for: [Windows](https://github.com/undergroundwires/privacy.sexy/releases/download/0.12.7/privacy.sexy-Setup-0.12.7.exe), [macOS](https://github.com/undergroundwires/privacy.sexy/releases/download/0.12.7/privacy.sexy-0.12.7.dmg), [Linux](https://github.com/undergroundwires/privacy.sexy/releases/download/0.12.7/privacy.sexy-0.12.7.AppImage). For more options, see [here](#additional-install-options).
|
||||||
|
|
||||||
Online version does not require to run any software on your computer. Offline version has more functions such as running the scripts directly.
|
Online version does not require to run any software on your computer. Offline version has more functions such as running the scripts directly.
|
||||||
|
|
||||||
@@ -138,6 +150,25 @@ Online version does not require to run any software on your computer. Offline ve
|
|||||||
|
|
||||||
**Contribute 👷**. Contributions of any type are welcome. See [CONTRIBUTING.md](./CONTRIBUTING.md) as the starting point. It includes useful information like [how to add new scripts](./CONTRIBUTING.md#extend-scripts).
|
**Contribute 👷**. Contributions of any type are welcome. See [CONTRIBUTING.md](./CONTRIBUTING.md) as the starting point. It includes useful information like [how to add new scripts](./CONTRIBUTING.md#extend-scripts).
|
||||||
|
|
||||||
|
## Additional Install Options
|
||||||
|
|
||||||
|
- Check the [releases page](https://github.com/undergroundwires/privacy.sexy/releases) for all available versions.
|
||||||
|
- Other unofficial channels (not maintained by privacy.sexy) for Windows include:
|
||||||
|
- [Scoop 🥄](https://scoop.sh/#/apps?q=privacy.sexy&s=2&d=1&o=true) (latest version):
|
||||||
|
|
||||||
|
```powershell
|
||||||
|
scoop bucket add extras
|
||||||
|
scoop install privacy.sexy
|
||||||
|
```
|
||||||
|
|
||||||
|
- [winget 🪟](https://winget.run/pkg/undergroundwires/privacy.sexy) (may be outdated):
|
||||||
|
|
||||||
|
```powershell
|
||||||
|
winget install -e --id undergroundwires.privacy.sexy
|
||||||
|
```
|
||||||
|
|
||||||
|
With winget, updates require manual submission; the auto-update feature within privacy.sexy will notify you of new releases post-installation.
|
||||||
|
|
||||||
## Development
|
## Development
|
||||||
|
|
||||||
Refer to [development.md](./docs/development.md) for Docker usage and reading more about setting up your development environment.
|
Refer to [development.md](./docs/development.md) for Docker usage and reading more about setting up your development environment.
|
||||||
@@ -145,3 +176,7 @@ Refer to [development.md](./docs/development.md) for Docker usage and reading mo
|
|||||||
Check [architecture.md](./docs/architecture.md) for an overview of design and how different parts and layers work together. You can refer to [application.md](./docs/application.md) for a closer look at application layer codebase and [presentation.md](./docs/presentation.md) for code related to GUI layer. [collection-files.md](./docs/collection-files.md) explains the YAML files that are the core of the application and [templating.md](./docs/templating.md) documents how to use templating language in those files. In [ci-cd.md](./docs/ci-cd.md), you can read more about the pipelines that automates maintenance tasks and ensures you get what see.
|
Check [architecture.md](./docs/architecture.md) for an overview of design and how different parts and layers work together. You can refer to [application.md](./docs/application.md) for a closer look at application layer codebase and [presentation.md](./docs/presentation.md) for code related to GUI layer. [collection-files.md](./docs/collection-files.md) explains the YAML files that are the core of the application and [templating.md](./docs/templating.md) documents how to use templating language in those files. In [ci-cd.md](./docs/ci-cd.md), you can read more about the pipelines that automates maintenance tasks and ensures you get what see.
|
||||||
|
|
||||||
[docs/](./docs/) folder includes all other documentation.
|
[docs/](./docs/) folder includes all other documentation.
|
||||||
|
|
||||||
|
## Security
|
||||||
|
|
||||||
|
Security is a top priority at privacy.sexy. An extensive commitment to security verification ensures this priority. For any security concerns or vulnerabilities, please consult the [Security Policy](./SECURITY.md).
|
||||||
|
|||||||
31
SECURITY.md
Normal file
31
SECURITY.md
Normal file
@@ -0,0 +1,31 @@
|
|||||||
|
# Security Policy
|
||||||
|
|
||||||
|
privacy.sexy takes security seriously. Commitment is made to address all security issues with urgency. Responsible reporting of any discovered vulnerabilities in the project is highly encouraged.
|
||||||
|
|
||||||
|
## Reporting a Vulnerability
|
||||||
|
|
||||||
|
Efforts to responsibly disclose findings are greatly appreciated. To report a security vulnerability, follow these steps:
|
||||||
|
|
||||||
|
- For general vulnerabilities, [open an issue](https://github.com/undergroundwires/privacy.sexy/issues/new/choose) using the bug report template.
|
||||||
|
- For sensitive matters, [contact the developer directly](https://undergroundwires.dev).
|
||||||
|
|
||||||
|
## Security Report Handling
|
||||||
|
|
||||||
|
Upon receipt of a security report, the following actions will be taken:
|
||||||
|
|
||||||
|
- The report will be confirmed, identifying the affected components.
|
||||||
|
- The impact and severity of the issue will be assessed.
|
||||||
|
- Work on a fix and plan a release to address the vulnerability will be initiated.
|
||||||
|
- The reporter will be kept updated about the progress.
|
||||||
|
|
||||||
|
## Testing
|
||||||
|
|
||||||
|
Regular and extensive testing is conducted to ensure robust security in the project. Information about testing practices can be found in the [Testing Documentation](./docs/tests.md).
|
||||||
|
|
||||||
|
## Support
|
||||||
|
|
||||||
|
For additional assistance or any unanswered questions, [submit a GitHub issue](https://github.com/undergroundwires/privacy.sexy/issues/new/choose). Security concerns are a priority, and necessary support to address them is assured.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
Active contribution to the safety and security of privacy.sexy is thanked. This collaborative effort keeps the project resilient and trustworthy for all.
|
||||||
5
cypress-dirs.json
Normal file
5
cypress-dirs.json
Normal file
@@ -0,0 +1,5 @@
|
|||||||
|
{
|
||||||
|
"base": "tests/e2e",
|
||||||
|
"videos": "tests/e2e/videos",
|
||||||
|
"screenshots": "tests/e2e/videos"
|
||||||
|
}
|
||||||
@@ -1,15 +1,31 @@
|
|||||||
import { defineConfig } from 'cypress';
|
import { defineConfig } from 'cypress';
|
||||||
import ViteConfig from './vite.config';
|
import ViteConfig from './vite.config';
|
||||||
|
import cypressDirs from './cypress-dirs.json' assert { type: 'json' };
|
||||||
const CYPRESS_BASE_DIR = 'tests/e2e/';
|
|
||||||
|
|
||||||
export default defineConfig({
|
export default defineConfig({
|
||||||
fixturesFolder: `${CYPRESS_BASE_DIR}/fixtures`,
|
fixturesFolder: `${cypressDirs.base}/fixtures`,
|
||||||
screenshotsFolder: `${CYPRESS_BASE_DIR}/screenshots`,
|
screenshotsFolder: cypressDirs.screenshots,
|
||||||
videosFolder: `${CYPRESS_BASE_DIR}/videos`,
|
|
||||||
|
video: true,
|
||||||
|
videosFolder: cypressDirs.videos,
|
||||||
|
|
||||||
e2e: {
|
e2e: {
|
||||||
baseUrl: `http://localhost:${ViteConfig.server.port}/`,
|
baseUrl: `http://localhost:${getApplicationPort()}/`,
|
||||||
specPattern: `${CYPRESS_BASE_DIR}/**/*.cy.{js,jsx,ts,tsx}`, // Default: cypress/e2e/**/*.cy.{js,jsx,ts,tsx}
|
specPattern: `${cypressDirs.base}/**/*.cy.{js,jsx,ts,tsx}`, // Default: cypress/e2e/**/*.cy.{js,jsx,ts,tsx}
|
||||||
supportFile: `${CYPRESS_BASE_DIR}/support/e2e.ts`,
|
supportFile: `${cypressDirs.base}/support/e2e.ts`,
|
||||||
},
|
},
|
||||||
|
|
||||||
|
/*
|
||||||
|
Disabling Chrome's web security to allow for faster DOM queries to access DOM earlier than
|
||||||
|
`cy.get()`. It bypasses the usual same-origin policy constraints
|
||||||
|
*/
|
||||||
|
chromeWebSecurity: false,
|
||||||
});
|
});
|
||||||
|
|
||||||
|
function getApplicationPort(): number {
|
||||||
|
const port = ViteConfig.server?.port;
|
||||||
|
if (port === undefined) {
|
||||||
|
throw new Error('Unknown application port');
|
||||||
|
}
|
||||||
|
return port;
|
||||||
|
}
|
||||||
|
|||||||
5
dist-dirs.json
Normal file
5
dist-dirs.json
Normal file
@@ -0,0 +1,5 @@
|
|||||||
|
{
|
||||||
|
"electronUnbundled": "dist-electron-unbundled",
|
||||||
|
"electronBundled": "dist-electron-bundled",
|
||||||
|
"web": "dist-web"
|
||||||
|
}
|
||||||
@@ -174,3 +174,19 @@
|
|||||||
- `endCode:` *`string`* (**required**)
|
- `endCode:` *`string`* (**required**)
|
||||||
- Code that'll be inserted at the end of user created script.
|
- Code that'll be inserted at the end of user created script.
|
||||||
- Global variables such as `$homepage`, `$version`, `$date` can be used using [parameter substitution](./templating.md#parameter-substitution) code syntax such as `Welcome to {{ $homepage }}!`
|
- Global variables such as `$homepage`, `$version`, `$date` can be used using [parameter substitution](./templating.md#parameter-substitution) code syntax such as `Welcome to {{ $homepage }}!`
|
||||||
|
|
||||||
|
## Naming guidelines
|
||||||
|
|
||||||
|
- Prioritize consistency throughout all names.
|
||||||
|
- Use an instruction format like "do this, do that" for clear, direct guidance. This approach reduces potential confusion and offers easy-to-follow steps. It provides specific, unambiguous instructions.
|
||||||
|
- Ensure brand names adhere to their official casing.
|
||||||
|
- Choose clear and uncomplicated language.
|
||||||
|
- Favor the terms:
|
||||||
|
- "Disable" over "Turn off"
|
||||||
|
- "Configure" over "Set up"
|
||||||
|
- "Clear" over "Erase" or "Clean"
|
||||||
|
- "Minimize" over "Limit" or "Reduce" (when it enhances clarity)
|
||||||
|
- "Remove" over "Uninstall"
|
||||||
|
- Structure your phrases for clarity.
|
||||||
|
- For instance, "Disable XX telemetry" or "Clear XX data" are preferred over "Clear data from XX", "Disable telemetry in XX", or "Clear data of XX".
|
||||||
|
- Use sentence case rather than Title Case.
|
||||||
|
|||||||
@@ -5,14 +5,16 @@ Before your commit, a good practice is to:
|
|||||||
1. [Run unit tests](#testing)
|
1. [Run unit tests](#testing)
|
||||||
2. [Lint your code](#linting)
|
2. [Lint your code](#linting)
|
||||||
|
|
||||||
You could run other types of tests as well, but they may take longer time and overkill for your changes. Automated actions executes the tests for a pull request or change in the main branch. See [ci-cd.md](./ci-cd.md) for more information.
|
You could run other types of tests as well, but they may take longer time and overkill for your changes.
|
||||||
|
Automated actions are set up to execute these tests as necessary.
|
||||||
|
See [ci-cd.md](./ci-cd.md) for more information.
|
||||||
|
|
||||||
## Commands
|
## Commands
|
||||||
|
|
||||||
### Prerequisites
|
### Prerequisites
|
||||||
|
|
||||||
- Install node >15.x.
|
- Install Node >16.x.
|
||||||
- Install dependencies using `npm install`.
|
- Install dependencies using `npm install` (or [`npm run install-deps`](#utility-scripts) for more options).
|
||||||
|
|
||||||
### Testing
|
### Testing
|
||||||
|
|
||||||
@@ -21,6 +23,10 @@ You could run other types of tests as well, but they may take longer time and ov
|
|||||||
- Run end-to-end (e2e) tests:
|
- Run end-to-end (e2e) tests:
|
||||||
- `npm run test:cy:open`: Run tests interactively using the development server with hot-reloading.
|
- `npm run test:cy:open`: Run tests interactively using the development server with hot-reloading.
|
||||||
- `npm run test:cy:run`: Run tests on the production build in a headless mode.
|
- `npm run test:cy:run`: Run tests on the production build in a headless mode.
|
||||||
|
- Run checks:
|
||||||
|
- `npm run check:desktop`: Run runtime checks for packaged desktop applications ([README.md](./../tests/checks/desktop-runtime-errors/check-desktop-runtime-errors/README.md)).
|
||||||
|
- You can set environment variables active its flags such as `BUILD=true SCREENSHOT=true npm run check:desktop`
|
||||||
|
- `npm run check:external-urls`: Test whether external URLs used in applications are alive.
|
||||||
|
|
||||||
📖 Read more about testing in [tests](./tests.md).
|
📖 Read more about testing in [tests](./tests.md).
|
||||||
|
|
||||||
@@ -54,6 +60,7 @@ You could run other types of tests as well, but they may take longer time and ov
|
|||||||
|
|
||||||
1. Build: `docker build -t undergroundwires/privacy.sexy:latest .`
|
1. Build: `docker build -t undergroundwires/privacy.sexy:latest .`
|
||||||
2. Run: `docker run -it -p 8080:80 --rm --name privacy.sexy undergroundwires/privacy.sexy:latest`
|
2. Run: `docker run -it -p 8080:80 --rm --name privacy.sexy undergroundwires/privacy.sexy:latest`
|
||||||
|
3. Application should be available at [`http://localhost:8080`](http://localhost:8080)
|
||||||
|
|
||||||
### Building
|
### Building
|
||||||
|
|
||||||
@@ -61,13 +68,27 @@ You could run other types of tests as well, but they may take longer time and ov
|
|||||||
- Build desktop application: `npm run electron:build`
|
- Build desktop application: `npm run electron:build`
|
||||||
- (Re)create icons (see [documentation](../img/README.md)): `npm run create-icons`
|
- (Re)create icons (see [documentation](../img/README.md)): `npm run create-icons`
|
||||||
|
|
||||||
### Utility Scripts
|
### Scripts
|
||||||
|
|
||||||
- Run fresh NPM install: [`./scripts/fresh-npm-install.sh`](../scripts/fresh-npm-install.sh)
|
📖 For detailed options and behavior for any of the following scripts, please refer to the script file itself.
|
||||||
- This script provides a clean NPM install, removing existing node modules and optionally the package-lock.json (when run with -n), then installs dependencies and runs unit tests.
|
|
||||||
- Configure VSCode: [`./scripts/configure-vscode.sh`](../scripts/configure-vscode.sh)
|
#### Utility scripts
|
||||||
|
|
||||||
|
- [**`npm run install-deps [-- <options>]`**](../scripts/npm-install.js):
|
||||||
|
- Manages NPM dependency installation, it offers capabilities like doing a fresh install, retries on network errors, and other features.
|
||||||
|
- For example, you can run `npm run install-deps -- --fresh` to do clean installation of dependencies.
|
||||||
|
- [**`./scripts/configure-vscode.sh`**](../scripts/configure-vscode.sh):
|
||||||
- This script checks and sets the necessary configurations for VSCode in `settings.json` file.
|
- This script checks and sets the necessary configurations for VSCode in `settings.json` file.
|
||||||
|
|
||||||
|
#### Automation scripts
|
||||||
|
|
||||||
|
- [**`node scripts/print-dist-dir.js [<options>]`**](../scripts/print-dist-dir.js):
|
||||||
|
- Determines the absolute path of a distribution directory based on CLI arguments and outputs its absolute path.
|
||||||
|
- [**`npm run check:verify-build-artifacts [-- <options>]`**](../scripts/verify-build-artifacts.js):
|
||||||
|
- Verifies the existence and content of build artifacts. Useful for ensuring that the build process is generating the expected output.
|
||||||
|
- [**`node scripts/verify-web-server-status.js --url [URL]`**](../scripts/verify-web-server-status.js):
|
||||||
|
- Checks if a specified server is up with retries and returns an HTTP 200 status code.
|
||||||
|
|
||||||
## Recommended extensions
|
## Recommended extensions
|
||||||
|
|
||||||
You should use EditorConfig to follow project style.
|
You should use EditorConfig to follow project style.
|
||||||
|
|||||||
@@ -11,18 +11,18 @@ The presentation layer uses an event-driven architecture for bidirectional react
|
|||||||
## Structure
|
## Structure
|
||||||
|
|
||||||
- [`/src/` **`presentation/`**](./../src/presentation/): Contains Vue and Electron code.
|
- [`/src/` **`presentation/`**](./../src/presentation/): Contains Vue and Electron code.
|
||||||
|
- [**`main.ts`**](./../src/presentation/main.ts): Starts Vue app.
|
||||||
|
- [**`index.html`**](./../src/presentation/index.html): The `index.html` entry file, located at the root of the project as required by Vite
|
||||||
- [**`bootstrapping/`**](./../src/presentation/bootstrapping/): Registers Vue components and plugins.
|
- [**`bootstrapping/`**](./../src/presentation/bootstrapping/): Registers Vue components and plugins.
|
||||||
- [**`components/`**](./../src/presentation/components/): Contains Vue components and helpers.
|
- [**`components/`**](./../src/presentation/components/): Contains Vue components and helpers.
|
||||||
- [**`Shared/`**](./../src/presentation/components/Shared): Contains shared Vue components and helpers.
|
- [**`Shared/`**](./../src/presentation/components/Shared): Contains shared Vue components and helpers.
|
||||||
- [**`hooks`**](../src/presentation/components/Shared/Hooks): Hooks used by components through [dependency injection](#dependency-injections).
|
- [**`Hooks`**](../src/presentation/components/Shared/Hooks): Hooks used by components through [dependency injection](#dependency-injections).
|
||||||
- [**`/public/`**](../src/presentation/public/): Contains static assets.
|
- [**`/public/`**](../src/presentation/public/): Contains static assets.
|
||||||
- [**`assets/`**](./../src/presentation/assets/styles/): Contains assets processed by Vite.
|
- [**`assets/`**](./../src/presentation/assets/styles/): Contains assets processed by Vite.
|
||||||
- [**`fonts/`**](./../src/presentation/assets/fonts/): Contains fonts.
|
- [**`fonts/`**](./../src/presentation/assets/fonts/): Contains fonts.
|
||||||
- [**`styles/`**](./../src/presentation/assets/styles/): Contains shared styles.
|
- [**`styles/`**](./../src/presentation/assets/styles/): Contains shared styles.
|
||||||
- [**`components/`**](./../src/presentation/assets/styles/components): Contains styles for Vue components.
|
- [**`components/`**](./../src/presentation/assets/styles/components): Contains styles coupled to Vue components.
|
||||||
- [**`vendors-extensions/`**](./../src/presentation/assets/styles/third-party-extensions): Contains styles for third-party components.
|
- [**`main.scss`**](./../src/presentation/assets/styles/main.scss): Main Sass file, imported by other components as single entrypoint..
|
||||||
- [**`main.scss`**](./../src/presentation/assets/styles/main.scss): Main Sass file, imported by other components as single entrypoint.
|
|
||||||
- [**`main.ts`**](./../src/presentation/main.ts): Starts Vue app.
|
|
||||||
- [**`electron/`**](./../src/presentation/electron/): Contains Electron code.
|
- [**`electron/`**](./../src/presentation/electron/): Contains Electron code.
|
||||||
- [`/main/` **`index.ts`**](./../src/presentation/main.ts): Main entry for Electron, managing application windows and lifecycle events.
|
- [`/main/` **`index.ts`**](./../src/presentation/main.ts): Main entry for Electron, managing application windows and lifecycle events.
|
||||||
- [`/preload/` **`index.ts`**](./../src/presentation/main.ts): Script executed before the renderer, securing Node.js features for renderer use.
|
- [`/preload/` **`index.ts`**](./../src/presentation/main.ts): Script executed before the renderer, securing Node.js features for renderer use.
|
||||||
@@ -71,10 +71,11 @@ To add a new dependency:
|
|||||||
1. **Define its symbol**: Define an associated symbol for every dependency in [`injectionSymbols.ts`](./../src/presentation/injectionSymbols.ts). Symbols are grouped into:
|
1. **Define its symbol**: Define an associated symbol for every dependency in [`injectionSymbols.ts`](./../src/presentation/injectionSymbols.ts). Symbols are grouped into:
|
||||||
- **Singletons**: Shared across components, instantiated once.
|
- **Singletons**: Shared across components, instantiated once.
|
||||||
- **Transients**: Factories yielding a new instance on every access.
|
- **Transients**: Factories yielding a new instance on every access.
|
||||||
2. **Provide the dependency**: Modify the [`provideDependencies`](./../src/presentation/bootstrapping/DependencyProvider.ts) function to include the new dependency. [`App.vue`](./../src/presentation/components/App.vue) calls this function within its `setup()` hook to register the dependencies.
|
2. **Provide the dependency**:
|
||||||
3. **Inject the dependency**: Use Vue's `inject` method alongside the defined symbol to incorporate the dependency into components.
|
Modify the [`provideDependencies`](./../src/presentation/bootstrapping/DependencyProvider.ts) function to include the new dependency.
|
||||||
- For singletons, invoke the factory method: `inject(symbolKey)()`.
|
[`App.vue`](./../src/presentation/components/App.vue) calls this function within its `setup()` hook to register the dependencies.
|
||||||
- For transients, directly inject: `inject(symbolKey)`.
|
3. **Inject the dependency**: Use `injectKey` to inject a dependency. Pass a selector function to `injectKey` that retrieves the appropriate symbol from the provided dependencies.
|
||||||
|
- Example usage: `injectKey((keys) => keys.useCollectionState)`;
|
||||||
|
|
||||||
## Shared UI components
|
## Shared UI components
|
||||||
|
|
||||||
@@ -91,7 +92,14 @@ Shared components include:
|
|||||||
|
|
||||||
Desktop builds uses `electron-vite` to bundle the code, and `electron-builder` to build and publish the packages.
|
Desktop builds uses `electron-vite` to bundle the code, and `electron-builder` to build and publish the packages.
|
||||||
|
|
||||||
## Sass naming convention
|
## Styles
|
||||||
|
|
||||||
|
### Style location
|
||||||
|
|
||||||
|
- **Global styles**: The [`assets/styles/`](#structure) directory is reserved for styles that have a broader scope, affecting multiple components or entire layouts. They are generic and should not be tightly coupled to a specific component's functionality.
|
||||||
|
- **Component-specific styles**: Styles closely tied to a particular component's functionality or appearance should reside near the component they are used by. This makes it easier to locate and modify styles when working on a specific component.
|
||||||
|
|
||||||
|
### Sass naming convention
|
||||||
|
|
||||||
- Use lowercase for variables/functions/mixins, e.g.:
|
- Use lowercase for variables/functions/mixins, e.g.:
|
||||||
- Variable: `$variable: value;`
|
- Variable: `$variable: value;`
|
||||||
|
|||||||
@@ -2,79 +2,142 @@
|
|||||||
|
|
||||||
## Benefits of templating
|
## Benefits of templating
|
||||||
|
|
||||||
- Generating scripts by sharing code to increase best-practice usage and maintainability.
|
- **Code sharing:** Share code across scripts for consistent practices and easier maintenance.
|
||||||
- Creating self-contained scripts without cross-dependencies.
|
- **Script independence:** Generate self-contained scripts, eliminating the need for external code.
|
||||||
- Use of pipes for writing cleaner code and letting pipes do dirty work.
|
- **Cleaner code:** Use pipes for complex operations, resulting in more readable and streamlined code.
|
||||||
|
|
||||||
## Expressions
|
## Expressions
|
||||||
|
|
||||||
- Expressions start and end with mustaches (double brackets, `{{` and `}}`).
|
**Syntax:**
|
||||||
- E.g. `Hello {{ $name }} !`
|
|
||||||
- Syntax is close to [Go Templates ❤️](https://pkg.go.dev/text/template) but not the same.
|
|
||||||
- Functions enables usage of expressions.
|
|
||||||
- In script definition parts of a function, see [`Function`](./collection-files.md#Function).
|
|
||||||
- When doing a call as argument values, see [`FunctionCall`](./collection-files.md#Function).
|
|
||||||
- Expressions inside expressions (nested templates) are supported.
|
|
||||||
- An expression can output another expression that will also be compiled.
|
|
||||||
- E.g. following would compile first [with expression](#with), and then [parameter substitution](#parameter-substitution) in its output.
|
|
||||||
|
|
||||||
```go
|
Expressions are enclosed within `{{` and `}}`.
|
||||||
{{ with $condition }}
|
Example: `Hello {{ $name }}!`.
|
||||||
echo {{ $text }}
|
They are a core component of templating, enhancing scripts with dynamic capabilities and functionality.
|
||||||
{{ end }}
|
|
||||||
```
|
**Syntax similarity:**
|
||||||
|
|
||||||
|
The syntax shares similarities with [Go Templates ❤️](https://pkg.go.dev/text/template), but with some differences:
|
||||||
|
|
||||||
|
**Function definitions:**
|
||||||
|
|
||||||
|
You can use expressions in function definition.
|
||||||
|
Refer to [Function](./collection-files.md#function) for more details.
|
||||||
|
|
||||||
|
Example usage:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
name: GreetFunction
|
||||||
|
parameters:
|
||||||
|
- name: name
|
||||||
|
code: Hello {{ $name }}!
|
||||||
|
```
|
||||||
|
|
||||||
|
If you assign `name` the value `world`, invoking `GreetFunction` would result in `Hello world!`.
|
||||||
|
|
||||||
|
**Function arguments:**
|
||||||
|
|
||||||
|
You can also use expressions in arguments in nested function calls.
|
||||||
|
Refer to [`Function | collection-files.md`](./collection-files.md#functioncall) for more details.
|
||||||
|
|
||||||
|
Example with nested function calls:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
-
|
||||||
|
name: PrintMessageFunction
|
||||||
|
parameters:
|
||||||
|
- name: message
|
||||||
|
code: echo "{{ $message }}"
|
||||||
|
-
|
||||||
|
name: GreetUserFunction
|
||||||
|
parameters:
|
||||||
|
- name: userName
|
||||||
|
call:
|
||||||
|
name: PrintMessageFunction
|
||||||
|
parameters:
|
||||||
|
argument: 'Hello, {{ $userName }}!'
|
||||||
|
```
|
||||||
|
|
||||||
|
Here, if `userName` is `Alice`, invoking `GreetUserFunction` would execute `echo "Hello, Alice!"`.
|
||||||
|
|
||||||
|
**Nested templates:**
|
||||||
|
|
||||||
|
You can nest expressions inside expressions (also called "nested templates").
|
||||||
|
This means that an expression can output another expression where compiler will compile both.
|
||||||
|
|
||||||
|
For example, following would compile first [with expression](#with), and then [parameter substitution](#parameter-substitution) in its output:
|
||||||
|
|
||||||
|
```go
|
||||||
|
{{ with $condition }}
|
||||||
|
echo {{ $text }}
|
||||||
|
{{ end }}
|
||||||
|
```
|
||||||
|
|
||||||
### Parameter substitution
|
### Parameter substitution
|
||||||
|
|
||||||
A simple function example:
|
Parameter substitution dynamically replaces variable references with their corresponding values in the script.
|
||||||
|
|
||||||
|
**Example function:**
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
function: EchoArgument
|
name: DisplayTextFunction
|
||||||
parameters:
|
parameters:
|
||||||
- name: 'argument'
|
- name: 'text'
|
||||||
code: Hello {{ $argument }} !
|
code: echo {{ $text }}
|
||||||
```
|
```
|
||||||
|
|
||||||
It would print "Hello world" if it's called in a [script](./collection-files.md#script) as following:
|
Invoking `DisplayTextFunction` with `text` set to `"Hello, world!"` would result in `echo "Hello, World!"`.
|
||||||
|
|
||||||
```yaml
|
|
||||||
script: Echo script
|
|
||||||
call:
|
|
||||||
function: EchoArgument
|
|
||||||
parameters:
|
|
||||||
argument: World
|
|
||||||
```
|
|
||||||
|
|
||||||
A function can call other functions such as:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
-
|
|
||||||
function: CallerFunction
|
|
||||||
parameters:
|
|
||||||
- name: 'value'
|
|
||||||
call:
|
|
||||||
function: EchoArgument
|
|
||||||
parameters:
|
|
||||||
argument: {{ $value }}
|
|
||||||
-
|
|
||||||
function: EchoArgument
|
|
||||||
parameters:
|
|
||||||
- name: 'argument'
|
|
||||||
code: Hello {{ $argument }} !
|
|
||||||
```
|
|
||||||
|
|
||||||
### with
|
### with
|
||||||
|
|
||||||
Skips its "block" if the variable is absent or empty. Its "block" is between `with` start (`{{ with .. }}`) and end (`{{ end }`}) expressions.
|
The `with` expression enables conditional rendering and provides a context variable for simpler code.
|
||||||
E.g. `{{ with $parameterName }} Hi, I'm a block! {{ end }}` would only output `Hi, I'm a block!` if `parameterName` has any value..
|
|
||||||
|
|
||||||
It binds its context (value of the provided parameter value) as arbitrary `.` value. It allows you to use the argument value of the given parameter when it is provided and not empty such as:
|
**Optional block rendering:**
|
||||||
|
|
||||||
|
If the provided variable is falsy (`false`, `null`, or empty), the compiler skips the enclosed block of code.
|
||||||
|
A "block" lies between the with start (`{{ with .. }}`) and end (`{{ end }}`) expressions, defining its boundaries.
|
||||||
|
|
||||||
|
Example:
|
||||||
|
|
||||||
|
```go
|
||||||
|
{{ with $optionalVariable }}
|
||||||
|
Hello
|
||||||
|
{{ end }}
|
||||||
|
```
|
||||||
|
|
||||||
|
This would display `Hello` if `$optionalVariable` is truthy.
|
||||||
|
|
||||||
|
**Parameter declaration:**
|
||||||
|
|
||||||
|
You should set `optional: true` for the argument if you use it like `{{ with $argument }} .. {{ end }}`.
|
||||||
|
|
||||||
|
Declare parameters used for `with` condition as optional such as:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
name: ConditionalOutputFunction
|
||||||
|
parameters:
|
||||||
|
- name: 'data'
|
||||||
|
optional: true
|
||||||
|
code: |-
|
||||||
|
{{ with $data }}
|
||||||
|
Data is: {{ . }}
|
||||||
|
{{ end }}
|
||||||
|
```
|
||||||
|
|
||||||
|
**Context variable:**
|
||||||
|
|
||||||
|
`with` statement binds its context (value of the provided parameter value) as arbitrary `.` value.
|
||||||
|
`{{ . }}` syntax gives you access to the context variable.
|
||||||
|
This is optional to use, and not required to use `with` expressions.
|
||||||
|
|
||||||
|
For example:
|
||||||
|
|
||||||
```go
|
```go
|
||||||
{{ with $parameterName }}Parameter value is {{ . }} here {{ end }}
|
{{ with $parameterName }}Parameter value is {{ . }} here {{ end }}
|
||||||
```
|
```
|
||||||
|
|
||||||
It supports multiline text inside the block. You can have something like:
|
**Multiline text:**
|
||||||
|
|
||||||
|
It supports multiline text inside the block. You can write something like:
|
||||||
|
|
||||||
```go
|
```go
|
||||||
{{ with $argument }}
|
{{ with $argument }}
|
||||||
@@ -83,7 +146,9 @@ It supports multiline text inside the block. You can have something like:
|
|||||||
{{ end }}
|
{{ end }}
|
||||||
```
|
```
|
||||||
|
|
||||||
You can also use other expressions inside its block, such as [parameter substitution](#parameter-substitution):
|
**Inner expressions:**
|
||||||
|
|
||||||
|
You can also embed other expressions inside its block, such as [parameter substitution](#parameter-substitution):
|
||||||
|
|
||||||
```go
|
```go
|
||||||
{{ with $condition }}
|
{{ with $condition }}
|
||||||
@@ -91,32 +156,44 @@ You can also use other expressions inside its block, such as [parameter substitu
|
|||||||
{{ end }}
|
{{ end }}
|
||||||
```
|
```
|
||||||
|
|
||||||
💡 Declare parameters used for `with` condition as optional. Set `optional: true` for the argument if you use it like `{{ with $argument }} .. {{ end }}`.
|
This also includes nesting `with` statements:
|
||||||
|
|
||||||
Example:
|
```go
|
||||||
|
{{ with $condition1 }}
|
||||||
```yaml
|
Value of $condition1: {{ . }}
|
||||||
function: FunctionThatOutputsConditionally
|
{{ with $condition2 }}
|
||||||
parameters:
|
Value of $condition2: {{ . }}
|
||||||
- name: 'argument'
|
|
||||||
optional: true
|
|
||||||
code: |-
|
|
||||||
{{ with $argument }}
|
|
||||||
Value is: {{ . }}
|
|
||||||
{{ end }}
|
{{ end }}
|
||||||
|
{{ end }}
|
||||||
```
|
```
|
||||||
|
|
||||||
### Pipes
|
### Pipes
|
||||||
|
|
||||||
- Pipes are functions available for handling text.
|
Pipes are functions designed for text manipulation.
|
||||||
- Allows stacking actions one after another also known as "chaining".
|
They allow for a sequential application of operations resembling [Unix pipelines](https://en.wikipedia.org/wiki/Pipeline_(Unix)), also known as "chaining".
|
||||||
- Like [Unix pipelines](https://en.wikipedia.org/wiki/Pipeline_(Unix)), the concept is simple: each pipeline's output becomes the input of the following pipe.
|
Each pipeline's output becomes the input of the following pipe.
|
||||||
- You cannot create pipes. [A dedicated compiler](./application.md#parsing-and-compiling) provides pre-defined pipes to consume in collection files.
|
|
||||||
- You can combine pipes with other expressions such as [parameter substitution](#parameter-substitution) and [with](#with) syntax.
|
**Pre-defined**:
|
||||||
- ❗ Pipe names must be camelCase without any space or special characters.
|
|
||||||
- **Existing pipes**
|
Pipes are pre-defined by the system.
|
||||||
- `inlinePowerShell`: Converts a multi-lined PowerShell script to a single line.
|
You cannot create pipes in [collection files](./collection-files.md).
|
||||||
- `escapeDoubleQuotes`: Escapes `"` characters, allows you to use them inside double quotes (`"`).
|
[A dedicated compiler](./application.md#parsing-and-compiling) provides pre-defined pipes to consume in collection files.
|
||||||
- **Example usages**
|
|
||||||
- `{{ with $code }} echo "{{ . | inlinePowerShell }}" {{ end }}`
|
**Compatibility:**
|
||||||
- `{{ with $code }} echo "{{ . | inlinePowerShell | escapeDoubleQuotes }}" {{ end }}`
|
|
||||||
|
You can combine pipes with other expressions such as [parameter substitution](#parameter-substitution) and [with](#with) syntax.
|
||||||
|
|
||||||
|
For example:
|
||||||
|
|
||||||
|
```go
|
||||||
|
{{ with $script }} echo "{{ . | inlinePowerShell | escapeDoubleQuotes }}" {{ end }}
|
||||||
|
```
|
||||||
|
|
||||||
|
**Naming:**
|
||||||
|
|
||||||
|
❗ Pipe names must be camelCase without any space or special characters.
|
||||||
|
|
||||||
|
**Available pipes:**
|
||||||
|
|
||||||
|
- `inlinePowerShell`: Converts a multi-lined PowerShell script to a single line.
|
||||||
|
- `escapeDoubleQuotes`: Escapes `"` characters for batch command execution, allows you to use them inside double quotes (`"`).
|
||||||
|
|||||||
@@ -56,6 +56,11 @@ These checks validate various qualities like runtime execution, building process
|
|||||||
- Use [various tools](./../package.json) and [scripts](./../scripts).
|
- Use [various tools](./../package.json) and [scripts](./../scripts).
|
||||||
- Are automatically executed as [GitHub workflows](./../.github/workflows).
|
- Are automatically executed as [GitHub workflows](./../.github/workflows).
|
||||||
|
|
||||||
|
### Security checks
|
||||||
|
|
||||||
|
- [`checks.security.sast`](./../.github/workflows/checks.security.sast.yaml): Utilizes CodeQL to conduct Static Analysis Security Testing (SAST) to ensure the secure integrity of the codebase.
|
||||||
|
- [`checks.security.dependencies`](./../.github/workflows/checks.security.dependencies.yaml): Performs audits on third-party dependencies to identify and mitigate potential vulnerabilities, safeguarding the project from exploitable weaknesses.
|
||||||
|
|
||||||
## Tests structure
|
## Tests structure
|
||||||
|
|
||||||
- [`package.json`](./../package.json): Defines test commands and includes tools used in tests.
|
- [`package.json`](./../package.json): Defines test commands and includes tools used in tests.
|
||||||
@@ -63,21 +68,23 @@ These checks validate various qualities like runtime execution, building process
|
|||||||
- [`./src/`](./../src/): Contains the code subject to testing.
|
- [`./src/`](./../src/): Contains the code subject to testing.
|
||||||
- [`./tests/shared/`](./../tests/shared/): Contains code shared by different test categories.
|
- [`./tests/shared/`](./../tests/shared/): Contains code shared by different test categories.
|
||||||
- [`bootstrap/setup.ts`](./../tests/shared/bootstrap/setup.ts): Initializes unit and integration tests.
|
- [`bootstrap/setup.ts`](./../tests/shared/bootstrap/setup.ts): Initializes unit and integration tests.
|
||||||
|
- [`Assertions/`](./../tests/shared/Assertions/): Contains common assertion functions, prefixed with `expect`.
|
||||||
- [`./tests/unit/`](./../tests/unit/)
|
- [`./tests/unit/`](./../tests/unit/)
|
||||||
- Stores unit test code.
|
- Stores unit test code.
|
||||||
- The directory structure mirrors [`./src/`](./../src).
|
- The directory structure mirrors [`./src/`](./../src).
|
||||||
- E.g., tests for [`./src/application/ApplicationFactory.ts`](./../src/application/ApplicationFactory.ts) reside in [`./tests/unit/application/ApplicationFactory.spec.ts`](./../tests/unit/application/ApplicationFactory.spec.ts).
|
- E.g., tests for [`./src/application/ApplicationFactory.ts`](./../src/application/ApplicationFactory.ts) reside in [`./tests/unit/application/ApplicationFactory.spec.ts`](./../tests/unit/application/ApplicationFactory.spec.ts).
|
||||||
- [`shared/`](./../tests/unit/shared/)
|
- [`shared/`](./../tests/unit/shared/)
|
||||||
- Contains shared unit test functionalities.
|
- Contains shared unit test functionalities.
|
||||||
- [`Assertions/`](./../tests/unit/shared/Assertions): Contains common assertion functions, prefixed with `expect`.
|
|
||||||
- [`TestCases/`](./../tests/unit/shared/TestCases/)
|
- [`TestCases/`](./../tests/unit/shared/TestCases/)
|
||||||
- Shared test cases.
|
- Shared test cases.
|
||||||
- Functions that calls `it()` from [Vitest](https://vitest.dev/) should have `it` prefix.
|
- Functions that calls `it()` from [Vitest](https://vitest.dev/) should have `it` prefix.
|
||||||
- [`Stubs/`](./../tests/unit/shared/Stubs): Maintains stubs for component isolation, equipped with basic functionalities and, when necessary, spying or mocking capabilities.
|
- [`Stubs/`](./../tests/unit/shared/Stubs): Maintains stubs for component isolation, equipped with basic functionalities and, when necessary, spying or mocking capabilities.
|
||||||
- [`./tests/integration/`](./../tests/integration/): Contains integration test files.
|
- [`./tests/integration/`](./../tests/integration/): Contains integration test files.
|
||||||
- [`cypress.config.ts`](./../cypress.config.ts): Cypress (E2E tests) configuration file.
|
- [`cypress.config.ts`](./../cypress.config.ts): Cypress (E2E tests) configuration file.
|
||||||
|
- [`cypress-dirs.json`](./../cypress-dirs.json): A central definition of directories used by Cypress, designed for reuse across different configurations.
|
||||||
- [`./tests/e2e/`](./../tests/e2e/): Base Cypress folder, includes tests with `.cy.ts` extension.
|
- [`./tests/e2e/`](./../tests/e2e/): Base Cypress folder, includes tests with `.cy.ts` extension.
|
||||||
- [`/support/e2e.ts`](./../tests/e2e/support/e2e.ts): Support file, runs before every single spec file.
|
|
||||||
- [`/tsconfig.json`]: TypeScript configuration for file Cypress code, improves IDE support, recommended to have by official documentation.
|
- [`/tsconfig.json`]: TypeScript configuration for file Cypress code, improves IDE support, recommended to have by official documentation.
|
||||||
- *(git ignored)* `/videos`: Asset folder for videos taken during tests.
|
- *(git ignored)* `/videos`: Asset folder for videos taken during tests.
|
||||||
- *(git ignored)* `/screenshots`: Asset folder for Screenshots taken during tests.
|
- *(git ignored)* `/screenshots`: Asset folder for Screenshots taken during tests.
|
||||||
|
- [`/support/e2e.ts`](./../tests/e2e/support/e2e.ts): Support file, runs before every single test file.
|
||||||
|
- [`/support/interactions/`](./../tests/e2e/support/interactions/): Contains reusable functions for simulating user interactions, enhancing test readability and maintainability.
|
||||||
|
|||||||
43
electron-builder.cjs
Normal file
43
electron-builder.cjs
Normal file
@@ -0,0 +1,43 @@
|
|||||||
|
/* eslint-disable no-template-curly-in-string */
|
||||||
|
|
||||||
|
const { join } = require('path');
|
||||||
|
const { electronBundled, electronUnbundled } = require('./dist-dirs.json');
|
||||||
|
|
||||||
|
module.exports = {
|
||||||
|
// Common options
|
||||||
|
publish: {
|
||||||
|
provider: 'github',
|
||||||
|
vPrefixedTagName: false, // default: true
|
||||||
|
releaseType: 'release', // default: draft
|
||||||
|
},
|
||||||
|
directories: {
|
||||||
|
output: electronBundled,
|
||||||
|
},
|
||||||
|
extraMetadata: {
|
||||||
|
main: join(electronUnbundled, 'main/index.cjs'), // do not `path.resolve`, it expects a relative path
|
||||||
|
},
|
||||||
|
|
||||||
|
// Windows
|
||||||
|
win: {
|
||||||
|
target: 'nsis',
|
||||||
|
},
|
||||||
|
nsis: {
|
||||||
|
artifactName: '${name}-Setup-${version}.${ext}',
|
||||||
|
},
|
||||||
|
|
||||||
|
// Linux
|
||||||
|
linux: {
|
||||||
|
target: 'AppImage',
|
||||||
|
},
|
||||||
|
appImage: {
|
||||||
|
artifactName: '${name}-${version}.${ext}',
|
||||||
|
},
|
||||||
|
|
||||||
|
// macOS
|
||||||
|
mac: {
|
||||||
|
target: 'dmg',
|
||||||
|
},
|
||||||
|
dmg: {
|
||||||
|
artifactName: '${name}-${version}.${ext}',
|
||||||
|
},
|
||||||
|
};
|
||||||
@@ -1,31 +0,0 @@
|
|||||||
# -------
|
|
||||||
# Windows
|
|
||||||
# -------
|
|
||||||
win:
|
|
||||||
target: nsis
|
|
||||||
nsis:
|
|
||||||
artifactName: ${name}-${version}-Setup.${ext}
|
|
||||||
|
|
||||||
# -----
|
|
||||||
# Linux
|
|
||||||
# -----
|
|
||||||
linux:
|
|
||||||
target: AppImage
|
|
||||||
appImage:
|
|
||||||
artifactName: ${name}-${version}.${ext}
|
|
||||||
|
|
||||||
# -----
|
|
||||||
# macOS
|
|
||||||
# -----
|
|
||||||
mac:
|
|
||||||
target: dmg
|
|
||||||
dmg:
|
|
||||||
artifactName: ${name}-${version}.${ext}
|
|
||||||
|
|
||||||
# ----------------
|
|
||||||
# Publish options
|
|
||||||
# ----------------
|
|
||||||
publish:
|
|
||||||
provider: 'github'
|
|
||||||
vPrefixedTagName: false # default: true
|
|
||||||
releaseType: release # default: draft
|
|
||||||
@@ -3,19 +3,26 @@ import { mergeConfig, UserConfig } from 'vite';
|
|||||||
import { defineConfig, externalizeDepsPlugin } from 'electron-vite';
|
import { defineConfig, externalizeDepsPlugin } from 'electron-vite';
|
||||||
import { getAliasesFromTsConfig, getClientEnvironmentVariables } from './vite-config-helper';
|
import { getAliasesFromTsConfig, getClientEnvironmentVariables } from './vite-config-helper';
|
||||||
import { createVueConfig } from './vite.config';
|
import { createVueConfig } from './vite.config';
|
||||||
|
import distDirs from './dist-dirs.json' assert { type: 'json' };
|
||||||
|
|
||||||
const MAIN_ENTRY_FILE = resolvePathFromProjectRoot('src/presentation/electron/main/index.ts');
|
const MAIN_ENTRY_FILE = resolvePathFromProjectRoot('src/presentation/electron/main/index.ts');
|
||||||
const PRELOAD_ENTRY_FILE = resolvePathFromProjectRoot('src/presentation/electron/preload/index.ts');
|
const PRELOAD_ENTRY_FILE = resolvePathFromProjectRoot('src/presentation/electron/preload/index.ts');
|
||||||
const WEB_INDEX_HTML_PATH = resolvePathFromProjectRoot('src/presentation/index.html');
|
const WEB_INDEX_HTML_PATH = resolvePathFromProjectRoot('src/presentation/index.html');
|
||||||
const DIST_DIR = resolvePathFromProjectRoot('dist_electron/');
|
const ELECTRON_DIST_SUBDIRECTORIES = {
|
||||||
|
main: resolveElectronDistSubdirectory('main'),
|
||||||
|
preload: resolveElectronDistSubdirectory('preload'),
|
||||||
|
renderer: resolveElectronDistSubdirectory('renderer'),
|
||||||
|
};
|
||||||
|
|
||||||
|
process.env.ELECTRON_ENTRY = resolve(ELECTRON_DIST_SUBDIRECTORIES.main, 'index.cjs');
|
||||||
|
|
||||||
export default defineConfig({
|
export default defineConfig({
|
||||||
main: getSharedElectronConfig({
|
main: getSharedElectronConfig({
|
||||||
distDirSubfolder: 'main',
|
distDirSubfolder: ELECTRON_DIST_SUBDIRECTORIES.main,
|
||||||
entryFilePath: MAIN_ENTRY_FILE,
|
entryFilePath: MAIN_ENTRY_FILE,
|
||||||
}),
|
}),
|
||||||
preload: getSharedElectronConfig({
|
preload: getSharedElectronConfig({
|
||||||
distDirSubfolder: 'preload',
|
distDirSubfolder: ELECTRON_DIST_SUBDIRECTORIES.preload,
|
||||||
entryFilePath: PRELOAD_ENTRY_FILE,
|
entryFilePath: PRELOAD_ENTRY_FILE,
|
||||||
}),
|
}),
|
||||||
renderer: mergeConfig(
|
renderer: mergeConfig(
|
||||||
@@ -24,7 +31,7 @@ export default defineConfig({
|
|||||||
}),
|
}),
|
||||||
{
|
{
|
||||||
build: {
|
build: {
|
||||||
outDir: resolve(DIST_DIR, 'renderer'),
|
outDir: ELECTRON_DIST_SUBDIRECTORIES.renderer,
|
||||||
rollupOptions: {
|
rollupOptions: {
|
||||||
input: {
|
input: {
|
||||||
index: WEB_INDEX_HTML_PATH,
|
index: WEB_INDEX_HTML_PATH,
|
||||||
@@ -41,7 +48,7 @@ function getSharedElectronConfig(options: {
|
|||||||
}): UserConfig {
|
}): UserConfig {
|
||||||
return {
|
return {
|
||||||
build: {
|
build: {
|
||||||
outDir: resolve(DIST_DIR, options.distDirSubfolder),
|
outDir: options.distDirSubfolder,
|
||||||
lib: {
|
lib: {
|
||||||
entry: options.entryFilePath,
|
entry: options.entryFilePath,
|
||||||
},
|
},
|
||||||
@@ -63,6 +70,11 @@ function getSharedElectronConfig(options: {
|
|||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
function resolvePathFromProjectRoot(pathSegment: string) {
|
function resolvePathFromProjectRoot(pathSegment: string): string {
|
||||||
return resolve(__dirname, pathSegment);
|
return resolve(__dirname, pathSegment);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
function resolveElectronDistSubdirectory(subDirectory: string): string {
|
||||||
|
const electronDistDir = resolvePathFromProjectRoot(distDirs.electronUnbundled);
|
||||||
|
return resolve(electronDistDir, subDirectory);
|
||||||
|
}
|
||||||
|
|||||||
Binary file not shown.
|
After Width: | Height: | Size: 100 KiB |
10705
package-lock.json
generated
10705
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
99
package.json
99
package.json
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "privacy.sexy",
|
"name": "privacy.sexy",
|
||||||
"version": "0.12.1",
|
"version": "0.12.7",
|
||||||
"private": true,
|
"private": true,
|
||||||
"slogan": "Now you have the choice",
|
"slogan": "Now you have the choice",
|
||||||
"description": "Enforce privacy & security best-practices on Windows, macOS and Linux, because privacy is sexy 🍑🍆",
|
"description": "Enforce privacy & security best-practices on Windows, macOS and Linux, because privacy is sexy 🍑🍆",
|
||||||
@@ -12,16 +12,19 @@
|
|||||||
"preview": "vite preview",
|
"preview": "vite preview",
|
||||||
"test:unit": "vitest run --dir tests/unit",
|
"test:unit": "vitest run --dir tests/unit",
|
||||||
"test:integration": "vitest run --dir tests/integration",
|
"test:integration": "vitest run --dir tests/integration",
|
||||||
"test:e2e": "vue-cli-service test:e2e",
|
|
||||||
"test:cy:run": "start-server-and-test \"vite build && vite preview --port 7070\" http://localhost:7070 \"cypress run --config baseUrl=http://localhost:7070\"",
|
"test:cy:run": "start-server-and-test \"vite build && vite preview --port 7070\" http://localhost:7070 \"cypress run --config baseUrl=http://localhost:7070\"",
|
||||||
"test:cy:open": "start-server-and-test \"vite --port 7070 --mode production\" http://localhost:7070 \"cypress open --config baseUrl=http://localhost:7070\"",
|
"test:cy:open": "start-server-and-test \"vite --port 7070 --mode production\" http://localhost:7070 \"cypress open --config baseUrl=http://localhost:7070\"",
|
||||||
"lint": "npm run lint:md && npm run lint:md:consistency && npm run lint:md:relative-urls && npm run lint:eslint && npm run lint:yaml",
|
"lint": "npm run lint:md && npm run lint:md:consistency && npm run lint:md:relative-urls && npm run lint:eslint && npm run lint:yaml",
|
||||||
|
"install-deps": "node scripts/npm-install.js",
|
||||||
"icons:build": "node scripts/logo-update.js",
|
"icons:build": "node scripts/logo-update.js",
|
||||||
|
"check:desktop": "vitest run --dir tests/checks/desktop-runtime-errors --environment node",
|
||||||
|
"check:external-urls": "vitest run --dir tests/checks/external-urls --environment node",
|
||||||
|
"check:verify-build-artifacts": "node scripts/verify-build-artifacts",
|
||||||
"electron:dev": "electron-vite dev",
|
"electron:dev": "electron-vite dev",
|
||||||
"electron:preview": "electron-vite preview",
|
"electron:preview": "electron-vite preview",
|
||||||
"electron:prebuild": "electron-vite build",
|
"electron:prebuild": "electron-vite build",
|
||||||
"electron:build": "electron-builder",
|
"electron:build": "electron-builder",
|
||||||
"lint:eslint": "eslint .",
|
"lint:eslint": "eslint . --max-warnings=0 --ignore-path .gitignore",
|
||||||
"lint:md": "markdownlint **/*.md --ignore node_modules",
|
"lint:md": "markdownlint **/*.md --ignore node_modules",
|
||||||
"lint:md:consistency": "remark . --frail --use remark-preset-lint-consistent",
|
"lint:md:consistency": "remark . --frail --use remark-preset-lint-consistent",
|
||||||
"lint:md:relative-urls": "remark . --frail --use remark-validate-links",
|
"lint:md:relative-urls": "remark . --frail --use remark-validate-links",
|
||||||
@@ -29,82 +32,76 @@
|
|||||||
"postinstall": "electron-builder install-app-deps",
|
"postinstall": "electron-builder install-app-deps",
|
||||||
"postuninstall": "electron-builder install-app-deps"
|
"postuninstall": "electron-builder install-app-deps"
|
||||||
},
|
},
|
||||||
"main": "./dist_electron/main/index.cjs",
|
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@fortawesome/fontawesome-svg-core": "^6.4.0",
|
"@floating-ui/vue": "^1.0.2",
|
||||||
"@fortawesome/free-brands-svg-icons": "^6.4.0",
|
|
||||||
"@fortawesome/free-regular-svg-icons": "^6.4.0",
|
|
||||||
"@fortawesome/free-solid-svg-icons": "^6.4.0",
|
|
||||||
"@fortawesome/vue-fontawesome": "^2.0.9",
|
|
||||||
"@juggle/resize-observer": "^3.4.0",
|
"@juggle/resize-observer": "^3.4.0",
|
||||||
"ace-builds": "^1.23.4",
|
"ace-builds": "^1.30.0",
|
||||||
"cross-fetch": "^4.0.0",
|
"cross-fetch": "^4.0.0",
|
||||||
|
"electron-log": "^4.4.8",
|
||||||
"electron-progressbar": "^2.1.0",
|
"electron-progressbar": "^2.1.0",
|
||||||
|
"electron-updater": "^6.1.4",
|
||||||
"file-saver": "^2.0.5",
|
"file-saver": "^2.0.5",
|
||||||
"install": "^0.13.0",
|
"markdown-it": "^13.0.2",
|
||||||
"liquor-tree": "^0.2.70",
|
"vue": "^3.3.7"
|
||||||
"markdown-it": "^13.0.1",
|
|
||||||
"npm": "^9.8.1",
|
|
||||||
"v-tooltip": "2.1.3",
|
|
||||||
"vue": "^2.7.14"
|
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@modyfi/vite-plugin-yaml": "^1.0.4",
|
"@modyfi/vite-plugin-yaml": "^1.0.4",
|
||||||
"@rushstack/eslint-patch": "^1.3.2",
|
"@rushstack/eslint-patch": "^1.5.1",
|
||||||
"@types/ace": "^0.0.48",
|
"@types/ace": "^0.0.49",
|
||||||
"@types/file-saver": "^2.0.5",
|
"@types/file-saver": "^2.0.5",
|
||||||
"@typescript-eslint/eslint-plugin": "^5.62.0",
|
"@typescript-eslint/eslint-plugin": "^5.62.0",
|
||||||
"@typescript-eslint/parser": "^5.62.0",
|
"@typescript-eslint/parser": "^5.62.0",
|
||||||
"@vitejs/plugin-legacy": "^4.1.1",
|
"@vitejs/plugin-legacy": "^4.1.1",
|
||||||
"@vitejs/plugin-vue2": "^2.2.0",
|
"@vitejs/plugin-vue": "^4.4.0",
|
||||||
"@vue/eslint-config-airbnb-with-typescript": "^7.0.0",
|
"@vue/eslint-config-airbnb-with-typescript": "^7.0.0",
|
||||||
"@vue/eslint-config-typescript": "^11.0.3",
|
"@vue/eslint-config-typescript": "^11.0.3",
|
||||||
"@vue/test-utils": "^1.3.6",
|
"@vue/test-utils": "^2.4.1",
|
||||||
"autoprefixer": "^10.4.15",
|
"autoprefixer": "^10.4.16",
|
||||||
"cypress": "^12.17.2",
|
"cypress": "^13.3.1",
|
||||||
"electron": "^25.3.2",
|
"electron": "^27.0.0",
|
||||||
"electron-builder": "^24.6.3",
|
"electron-builder": "^24.6.4",
|
||||||
"electron-devtools-installer": "^3.2.0",
|
"electron-devtools-installer": "^3.2.0",
|
||||||
"electron-icon-builder": "^2.0.1",
|
"electron-icon-builder": "^2.0.1",
|
||||||
"electron-log": "^4.4.8",
|
"electron-vite": "^1.0.28",
|
||||||
"electron-updater": "^6.1.4",
|
"eslint": "^8.51.0",
|
||||||
"electron-vite": "^1.0.27",
|
"eslint-plugin-cypress": "^2.15.1",
|
||||||
"eslint": "^8.46.0",
|
"eslint-plugin-vue": "^9.17.0",
|
||||||
"eslint-plugin-cypress": "^2.14.0",
|
"eslint-plugin-vuejs-accessibility": "^2.2.0",
|
||||||
"eslint-plugin-vue": "^9.6.0",
|
"icon-gen": "^4.0.0",
|
||||||
"eslint-plugin-vuejs-accessibility": "^1.2.0",
|
|
||||||
"icon-gen": "^3.0.1",
|
|
||||||
"jsdom": "^22.1.0",
|
"jsdom": "^22.1.0",
|
||||||
"markdownlint-cli": "^0.35.0",
|
"markdownlint-cli": "^0.37.0",
|
||||||
"postcss": "^8.4.28",
|
"postcss": "^8.4.31",
|
||||||
"remark-cli": "^11.0.0",
|
"remark-cli": "^12.0.0",
|
||||||
"remark-lint-no-dead-urls": "^1.1.0",
|
"remark-lint-no-dead-urls": "^1.1.0",
|
||||||
"remark-preset-lint-consistent": "^5.1.2",
|
"remark-preset-lint-consistent": "^5.1.2",
|
||||||
"remark-validate-links": "^12.1.1",
|
"remark-validate-links": "^13.0.0",
|
||||||
"sass": "^1.64.1",
|
"sass": "^1.69.3",
|
||||||
"start-server-and-test": "^2.0.0",
|
"start-server-and-test": "^2.0.1",
|
||||||
"svgexport": "^0.4.2",
|
"svgexport": "^0.4.2",
|
||||||
"terser": "^5.19.2",
|
"terser": "^5.21.0",
|
||||||
"tslib": "~2.4.0",
|
"tslib": "^2.6.2",
|
||||||
"typescript": "~4.6.2",
|
"typescript": "^5.2.2",
|
||||||
"vite": "^4.4.9",
|
"vite": "^4.4.11",
|
||||||
"vitest": "^0.34.2",
|
"vitest": "^0.34.6",
|
||||||
"vue-tsc": "^1.8.8",
|
"vue-tsc": "^1.8.19",
|
||||||
"yaml-lint": "^1.7.0"
|
"yaml-lint": "^1.7.0"
|
||||||
},
|
},
|
||||||
"//devDependencies": {
|
"//devDependencies": {
|
||||||
"terser": "Used by @vitejs/plugin-legacy for minification",
|
"terser": "Used by @vitejs/plugin-legacy for minification",
|
||||||
"typescript": [
|
"@rushstack/eslint-patch": "Needed by @vue/eslint-config-typescript",
|
||||||
"Cannot upgrade to 5.X.X due to unmaintained @vue/cli-plugin-typescript, https://github.com/vuejs/vue-cli/issues/7401",
|
"@vue/eslint-config-typescript": "Cannot upgrade to 12.X.X due to @vue/eslint-config-airbnb-with-typescript, https://github.com/vuejs/eslint-config-airbnb/issues/58",
|
||||||
"Cannot upgrade to > 4.6.X otherwise unit tests do not work, https://github.com/evanw/node-source-map-support/issues/252"
|
"@typescript-eslint/eslint-plugin": "Cannot upgrade to 6.X.X due to @vue/eslint-config-airbnb-with-typescript, https://github.com/vuejs/eslint-config-airbnb/issues/58",
|
||||||
],
|
"@typescript-eslint/parser": "Cannot upgrade to 6.X.X due to @vue/eslint-config-airbnb-with-typescript, https://github.com/vuejs/eslint-config-airbnb/issues/58"
|
||||||
"tslib": "Cannot upgrade to > 2.4.X otherwise unit tests do not work, https://github.com/evanw/node-source-map-support/issues/252",
|
|
||||||
"@typescript-eslint/eslint-plugin": "Cannot upgrade to 6.X.X due to @vue/eslint-config-typescript, https://github.com/vuejs/eslint-config-typescript/pull/60",
|
|
||||||
"@typescript-eslint/parser": "Cannot upgrade to 6.X.X due to @vue/eslint-config-typescript, https://github.com/vuejs/eslint-config-typescript/pull/60"
|
|
||||||
},
|
},
|
||||||
"homepage": "https://privacy.sexy",
|
"homepage": "https://privacy.sexy",
|
||||||
"repository": {
|
"repository": {
|
||||||
"type": "git",
|
"type": "git",
|
||||||
"url": "https://github.com/undergroundwires/privacy.sexy.git"
|
"url": "https://github.com/undergroundwires/privacy.sexy.git"
|
||||||
|
},
|
||||||
|
"optionalDependencies": {
|
||||||
|
"dmg-license": "^1.0.11"
|
||||||
|
},
|
||||||
|
"//optionalDependencies": {
|
||||||
|
"dmg-license": "Required by `electron-builder` for DMG builds on macOS, https://github.com/electron-userland/electron-builder/issues/6489, https://github.com/electron-userland/electron-builder/issues/6520"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,10 +0,0 @@
|
|||||||
require('@rushstack/eslint-patch/modern-module-resolution.js');
|
|
||||||
|
|
||||||
module.exports = {
|
|
||||||
env: {
|
|
||||||
node: true,
|
|
||||||
},
|
|
||||||
rules: {
|
|
||||||
'import/extensions': ['error', 'always'],
|
|
||||||
},
|
|
||||||
};
|
|
||||||
@@ -1,55 +0,0 @@
|
|||||||
import { unlink, readFile } from 'fs/promises';
|
|
||||||
import { join } from 'path';
|
|
||||||
import { log, die, LOG_LEVELS } from '../utils/log.js';
|
|
||||||
import { exists } from '../utils/io.js';
|
|
||||||
import { SUPPORTED_PLATFORMS, CURRENT_PLATFORM } from '../utils/platform.js';
|
|
||||||
import { getAppName } from '../utils/npm.js';
|
|
||||||
|
|
||||||
export async function clearAppLogFile(projectDir) {
|
|
||||||
if (!projectDir) { throw new Error('missing project directory'); }
|
|
||||||
const logPath = await determineLogPath(projectDir);
|
|
||||||
if (!logPath || !await exists(logPath)) {
|
|
||||||
log(`Skipping clearing logs, log file does not exist: ${logPath}.`);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
try {
|
|
||||||
await unlink(logPath);
|
|
||||||
log(`Successfully cleared the log file at: ${logPath}.`);
|
|
||||||
} catch (error) {
|
|
||||||
die(`Failed to clear the log file at: ${logPath}. Reason: ${error}`);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
export async function readAppLogFile(projectDir) {
|
|
||||||
if (!projectDir) { throw new Error('missing project directory'); }
|
|
||||||
const logPath = await determineLogPath(projectDir);
|
|
||||||
if (!logPath || !await exists(logPath)) {
|
|
||||||
log(`No log file at: ${logPath}`, LOG_LEVELS.WARN);
|
|
||||||
return undefined;
|
|
||||||
}
|
|
||||||
const logContent = await readLogFile(logPath);
|
|
||||||
return logContent;
|
|
||||||
}
|
|
||||||
|
|
||||||
async function determineLogPath(projectDir) {
|
|
||||||
if (!projectDir) { throw new Error('missing project directory'); }
|
|
||||||
const appName = await getAppName(projectDir);
|
|
||||||
if (!appName) {
|
|
||||||
die('App name not found.');
|
|
||||||
}
|
|
||||||
const logFilePaths = {
|
|
||||||
[SUPPORTED_PLATFORMS.MAC]: () => join(process.env.HOME, 'Library', 'Logs', appName, 'main.log'),
|
|
||||||
[SUPPORTED_PLATFORMS.LINUX]: () => join(process.env.HOME, '.config', appName, 'logs', 'main.log'),
|
|
||||||
[SUPPORTED_PLATFORMS.WINDOWS]: () => join(process.env.USERPROFILE, 'AppData', 'Roaming', appName, 'logs', 'main.log'),
|
|
||||||
};
|
|
||||||
const logFilePath = logFilePaths[CURRENT_PLATFORM]?.();
|
|
||||||
if (!logFilePath) {
|
|
||||||
log(`Cannot determine log path, unsupported OS: ${CURRENT_PLATFORM}`, LOG_LEVELS.WARN);
|
|
||||||
}
|
|
||||||
return logFilePath;
|
|
||||||
}
|
|
||||||
|
|
||||||
async function readLogFile(logFilePath) {
|
|
||||||
const content = await readFile(logFilePath, 'utf-8');
|
|
||||||
return content?.trim().length > 0 ? content : undefined;
|
|
||||||
}
|
|
||||||
@@ -1,126 +0,0 @@
|
|||||||
import { splitTextIntoLines, indentText } from '../utils/text.js';
|
|
||||||
import { die } from '../utils/log.js';
|
|
||||||
import { readAppLogFile } from './app-logs.js';
|
|
||||||
|
|
||||||
const ELECTRON_CRASH_TITLE = 'Error'; // Used by electron for early crashes
|
|
||||||
const LOG_ERROR_MARKER = '[error]'; // from electron-log
|
|
||||||
const EXPECTED_LOG_MARKERS = [
|
|
||||||
'[WINDOW_INIT]',
|
|
||||||
'[PRELOAD_INIT]',
|
|
||||||
'[APP_MOUNT_INIT]',
|
|
||||||
];
|
|
||||||
|
|
||||||
export async function checkForErrors(stderr, windowTitles, projectDir) {
|
|
||||||
if (!projectDir) { throw new Error('missing project directory'); }
|
|
||||||
const errors = await gatherErrors(stderr, windowTitles, projectDir);
|
|
||||||
if (errors.length) {
|
|
||||||
die(formatErrors(errors));
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
async function gatherErrors(stderr, windowTitles, projectDir) {
|
|
||||||
if (!projectDir) { throw new Error('missing project directory'); }
|
|
||||||
const logContent = await readAppLogFile(projectDir);
|
|
||||||
return [
|
|
||||||
verifyStdErr(stderr),
|
|
||||||
verifyApplicationLogsExist(logContent),
|
|
||||||
...EXPECTED_LOG_MARKERS.map((marker) => verifyLogMarkerExistsInLogs(logContent, marker)),
|
|
||||||
verifyWindowTitle(windowTitles),
|
|
||||||
verifyErrorsInLogs(logContent),
|
|
||||||
].filter(Boolean);
|
|
||||||
}
|
|
||||||
|
|
||||||
function formatErrors(errors) {
|
|
||||||
if (!errors || !errors.length) { throw new Error('missing errors'); }
|
|
||||||
return [
|
|
||||||
'Errors detected during execution:',
|
|
||||||
...errors.map(
|
|
||||||
(error) => formatError(error),
|
|
||||||
),
|
|
||||||
].join('\n---\n');
|
|
||||||
}
|
|
||||||
|
|
||||||
function formatError(error) {
|
|
||||||
if (!error) { throw new Error('missing error'); }
|
|
||||||
if (!error.reason) { throw new Error(`missing reason, error (${typeof error}): ${JSON.stringify(error)}`); }
|
|
||||||
let message = `Reason: ${indentText(error.reason, 1)}`;
|
|
||||||
if (error.description) {
|
|
||||||
message += `\nDescription:\n${indentText(error.description, 2)}`;
|
|
||||||
}
|
|
||||||
return message;
|
|
||||||
}
|
|
||||||
|
|
||||||
function verifyApplicationLogsExist(logContent) {
|
|
||||||
if (!logContent || !logContent.length) {
|
|
||||||
return describeError(
|
|
||||||
'Missing application logs',
|
|
||||||
'Application logs are empty not were not found.',
|
|
||||||
);
|
|
||||||
}
|
|
||||||
return undefined;
|
|
||||||
}
|
|
||||||
|
|
||||||
function verifyLogMarkerExistsInLogs(logContent, marker) {
|
|
||||||
if (!marker) {
|
|
||||||
throw new Error('missing marker');
|
|
||||||
}
|
|
||||||
if (!logContent?.includes(marker)) {
|
|
||||||
return describeError(
|
|
||||||
'Incomplete application logs',
|
|
||||||
`Missing identifier "${marker}" in application logs.`,
|
|
||||||
);
|
|
||||||
}
|
|
||||||
return undefined;
|
|
||||||
}
|
|
||||||
|
|
||||||
function verifyWindowTitle(windowTitles) {
|
|
||||||
const errorTitles = windowTitles.filter(
|
|
||||||
(title) => title.toLowerCase().includes(ELECTRON_CRASH_TITLE),
|
|
||||||
);
|
|
||||||
if (errorTitles.length) {
|
|
||||||
return describeError(
|
|
||||||
'Unexpected window title',
|
|
||||||
'One or more window titles suggest an error occurred in the application:'
|
|
||||||
+ `\nError Titles: ${errorTitles.join(', ')}`
|
|
||||||
+ `\nAll Titles: ${windowTitles.join(', ')}`,
|
|
||||||
);
|
|
||||||
}
|
|
||||||
return undefined;
|
|
||||||
}
|
|
||||||
|
|
||||||
function verifyStdErr(stderrOutput) {
|
|
||||||
if (stderrOutput && stderrOutput.length > 0) {
|
|
||||||
return describeError(
|
|
||||||
'Standard error stream (`stderr`) is not empty.',
|
|
||||||
stderrOutput,
|
|
||||||
);
|
|
||||||
}
|
|
||||||
return undefined;
|
|
||||||
}
|
|
||||||
|
|
||||||
function verifyErrorsInLogs(logContent) {
|
|
||||||
if (!logContent || !logContent.length) {
|
|
||||||
return undefined;
|
|
||||||
}
|
|
||||||
const logLines = getNonEmptyLines(logContent)
|
|
||||||
.filter((line) => line.includes(LOG_ERROR_MARKER));
|
|
||||||
if (!logLines.length) {
|
|
||||||
return undefined;
|
|
||||||
}
|
|
||||||
return describeError(
|
|
||||||
'Application log file',
|
|
||||||
logLines.join('\n'),
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
function describeError(reason, description) {
|
|
||||||
return {
|
|
||||||
reason,
|
|
||||||
description: `${description}\n\nThis might indicate an early crash or significant runtime issue.`,
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
function getNonEmptyLines(text) {
|
|
||||||
return splitTextIntoLines(text)
|
|
||||||
.filter((line) => line?.trim().length > 0);
|
|
||||||
}
|
|
||||||
@@ -1,34 +0,0 @@
|
|||||||
import { access, chmod } from 'fs/promises';
|
|
||||||
import { constants } from 'fs';
|
|
||||||
import { findSingleFileByExtension } from '../../utils/io.js';
|
|
||||||
import { log } from '../../utils/log.js';
|
|
||||||
|
|
||||||
export async function prepareLinuxApp(desktopDistPath) {
|
|
||||||
const { absolutePath: appFile } = await findSingleFileByExtension(
|
|
||||||
'AppImage',
|
|
||||||
desktopDistPath,
|
|
||||||
);
|
|
||||||
await makeExecutable(appFile);
|
|
||||||
return {
|
|
||||||
appExecutablePath: appFile,
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
async function makeExecutable(appFile) {
|
|
||||||
if (!appFile) { throw new Error('missing file'); }
|
|
||||||
if (await isExecutable(appFile)) {
|
|
||||||
log('AppImage is already executable.');
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
log('Making it executable...');
|
|
||||||
await chmod(appFile, 0o755);
|
|
||||||
}
|
|
||||||
|
|
||||||
async function isExecutable(file) {
|
|
||||||
try {
|
|
||||||
await access(file, constants.X_OK);
|
|
||||||
return true;
|
|
||||||
} catch {
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,66 +0,0 @@
|
|||||||
import { runCommand } from '../../utils/run-command.js';
|
|
||||||
import { findSingleFileByExtension, exists } from '../../utils/io.js';
|
|
||||||
import { log, die, LOG_LEVELS } from '../../utils/log.js';
|
|
||||||
|
|
||||||
export async function prepareMacOsApp(desktopDistPath) {
|
|
||||||
const { absolutePath: dmgPath } = await findSingleFileByExtension('dmg', desktopDistPath);
|
|
||||||
const { mountPath } = await mountDmg(dmgPath);
|
|
||||||
const appPath = await findMacAppExecutablePath(mountPath);
|
|
||||||
return {
|
|
||||||
appExecutablePath: appPath,
|
|
||||||
cleanup: async () => {
|
|
||||||
log('Cleaning up resources...');
|
|
||||||
await detachMount(mountPath);
|
|
||||||
},
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
async function mountDmg(dmgFile) {
|
|
||||||
const { stdout: hdiutilOutput, error } = await runCommand(`hdiutil attach '${dmgFile}'`);
|
|
||||||
if (error) {
|
|
||||||
die(`Failed to mount DMG file at ${dmgFile}.\n${error}`);
|
|
||||||
}
|
|
||||||
const mountPathMatch = hdiutilOutput.match(/\/Volumes\/[^\n]+/);
|
|
||||||
const mountPath = mountPathMatch ? mountPathMatch[0] : null;
|
|
||||||
return {
|
|
||||||
mountPath,
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
async function findMacAppExecutablePath(mountPath) {
|
|
||||||
const { stdout: findOutput, error } = await runCommand(
|
|
||||||
`find '${mountPath}' -maxdepth 1 -type d -name "*.app"`,
|
|
||||||
);
|
|
||||||
if (error) {
|
|
||||||
die(`Failed to find executable path at mount path ${mountPath}\n${error}`);
|
|
||||||
}
|
|
||||||
const appFolder = findOutput.trim();
|
|
||||||
const appName = appFolder.split('/').pop().replace('.app', '');
|
|
||||||
const appPath = `${appFolder}/Contents/MacOS/${appName}`;
|
|
||||||
if (await exists(appPath)) {
|
|
||||||
log(`Application is located at ${appPath}`);
|
|
||||||
} else {
|
|
||||||
die(`Application does not exist at ${appPath}`);
|
|
||||||
}
|
|
||||||
return appPath;
|
|
||||||
}
|
|
||||||
|
|
||||||
async function detachMount(mountPath, retries = 5) {
|
|
||||||
const { error } = await runCommand(`hdiutil detach '${mountPath}'`);
|
|
||||||
if (error) {
|
|
||||||
if (retries <= 0) {
|
|
||||||
log(`Failed to detach mount after multiple attempts: ${mountPath}\n${error}`, LOG_LEVELS.WARN);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
await sleep(500);
|
|
||||||
await detachMount(mountPath, retries - 1);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
log(`Successfully detached from ${mountPath}`);
|
|
||||||
}
|
|
||||||
|
|
||||||
function sleep(milliseconds) {
|
|
||||||
return new Promise((resolve) => {
|
|
||||||
setTimeout(resolve, milliseconds);
|
|
||||||
});
|
|
||||||
}
|
|
||||||
@@ -1,38 +0,0 @@
|
|||||||
import { mkdtemp, rmdir } from 'fs/promises';
|
|
||||||
import { join } from 'path';
|
|
||||||
import { tmpdir } from 'os';
|
|
||||||
import { findSingleFileByExtension, exists } from '../../utils/io.js';
|
|
||||||
import { log, die } from '../../utils/log.js';
|
|
||||||
import { runCommand } from '../../utils/run-command.js';
|
|
||||||
|
|
||||||
export async function prepareWindowsApp(desktopDistPath) {
|
|
||||||
const workdir = await mkdtemp(join(tmpdir(), 'win-nsis-installation-'));
|
|
||||||
if (await exists(workdir)) {
|
|
||||||
log(`Temporary directory ${workdir} already exists, cleaning up...`);
|
|
||||||
await rmdir(workdir, { recursive: true });
|
|
||||||
}
|
|
||||||
const { appExecutablePath } = await installNsis(workdir, desktopDistPath);
|
|
||||||
return {
|
|
||||||
appExecutablePath,
|
|
||||||
cleanup: async () => {
|
|
||||||
log(`Cleaning up working directory ${workdir}...`);
|
|
||||||
await rmdir(workdir, { recursive: true });
|
|
||||||
},
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
async function installNsis(installationPath, desktopDistPath) {
|
|
||||||
const { absolutePath: installerPath } = await findSingleFileByExtension('exe', desktopDistPath);
|
|
||||||
|
|
||||||
log(`Silently installing contents of ${installerPath} to ${installationPath}...`);
|
|
||||||
const { error } = await runCommand(`"${installerPath}" /S /D=${installationPath}`);
|
|
||||||
if (error) {
|
|
||||||
die(`Failed to install.\n${error}`);
|
|
||||||
}
|
|
||||||
|
|
||||||
const { absolutePath: appExecutablePath } = await findSingleFileByExtension('exe', installationPath);
|
|
||||||
|
|
||||||
return {
|
|
||||||
appExecutablePath,
|
|
||||||
};
|
|
||||||
}
|
|
||||||
@@ -1,20 +0,0 @@
|
|||||||
import { log } from './utils/log.js';
|
|
||||||
|
|
||||||
const PROCESS_ARGUMENTS = process.argv.slice(2);
|
|
||||||
|
|
||||||
export const COMMAND_LINE_FLAGS = Object.freeze({
|
|
||||||
FORCE_REBUILD: '--build',
|
|
||||||
TAKE_SCREENSHOT: '--screenshot',
|
|
||||||
});
|
|
||||||
|
|
||||||
export function logCurrentArgs() {
|
|
||||||
if (!PROCESS_ARGUMENTS.length) {
|
|
||||||
log('No additional arguments provided.');
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
log(`Arguments: ${PROCESS_ARGUMENTS.join(', ')}`);
|
|
||||||
}
|
|
||||||
|
|
||||||
export function hasCommandLineFlag(flag) {
|
|
||||||
return PROCESS_ARGUMENTS.includes(flag);
|
|
||||||
}
|
|
||||||
@@ -1,7 +0,0 @@
|
|||||||
import { join } from 'path';
|
|
||||||
|
|
||||||
export const DESKTOP_BUILD_COMMAND = 'npm run electron:prebuild && npm run electron:build -- --publish never';
|
|
||||||
export const PROJECT_DIR = process.cwd();
|
|
||||||
export const DESKTOP_DIST_PATH = join(PROJECT_DIR, 'dist');
|
|
||||||
export const APP_EXECUTION_DURATION_IN_SECONDS = 60; // Long enough for CI runners
|
|
||||||
export const SCREENSHOT_PATH = join(PROJECT_DIR, 'screenshot.png');
|
|
||||||
@@ -1,3 +0,0 @@
|
|||||||
import { main } from './main.js';
|
|
||||||
|
|
||||||
await main();
|
|
||||||
@@ -1,68 +0,0 @@
|
|||||||
import { logCurrentArgs, COMMAND_LINE_FLAGS, hasCommandLineFlag } from './cli-args.js';
|
|
||||||
import { log, die } from './utils/log.js';
|
|
||||||
import { ensureNpmProjectDir, npmInstall, npmBuild } from './utils/npm.js';
|
|
||||||
import { clearAppLogFile } from './app/app-logs.js';
|
|
||||||
import { checkForErrors } from './app/check-for-errors.js';
|
|
||||||
import { runApplication } from './app/runner.js';
|
|
||||||
import { CURRENT_PLATFORM, SUPPORTED_PLATFORMS } from './utils/platform.js';
|
|
||||||
import { prepareLinuxApp } from './app/extractors/linux.js';
|
|
||||||
import { prepareWindowsApp } from './app/extractors/windows.js';
|
|
||||||
import { prepareMacOsApp } from './app/extractors/macos.js';
|
|
||||||
import {
|
|
||||||
DESKTOP_BUILD_COMMAND,
|
|
||||||
PROJECT_DIR,
|
|
||||||
DESKTOP_DIST_PATH,
|
|
||||||
APP_EXECUTION_DURATION_IN_SECONDS,
|
|
||||||
SCREENSHOT_PATH,
|
|
||||||
} from './config.js';
|
|
||||||
|
|
||||||
export async function main() {
|
|
||||||
logCurrentArgs();
|
|
||||||
await ensureNpmProjectDir(PROJECT_DIR);
|
|
||||||
await npmInstall(PROJECT_DIR);
|
|
||||||
await npmBuild(
|
|
||||||
PROJECT_DIR,
|
|
||||||
DESKTOP_BUILD_COMMAND,
|
|
||||||
DESKTOP_DIST_PATH,
|
|
||||||
hasCommandLineFlag(COMMAND_LINE_FLAGS.FORCE_REBUILD),
|
|
||||||
);
|
|
||||||
await clearAppLogFile(PROJECT_DIR);
|
|
||||||
const {
|
|
||||||
stderr, stdout, isCrashed, windowTitles,
|
|
||||||
} = await extractAndRun();
|
|
||||||
if (stdout) {
|
|
||||||
log(`Output (stdout) from application execution:\n${stdout}`);
|
|
||||||
}
|
|
||||||
if (isCrashed) {
|
|
||||||
die('The application encountered an error during its execution.');
|
|
||||||
}
|
|
||||||
await checkForErrors(stderr, windowTitles, PROJECT_DIR);
|
|
||||||
log('🥳🎈 Success! Application completed without any runtime errors.');
|
|
||||||
process.exit(0);
|
|
||||||
}
|
|
||||||
|
|
||||||
async function extractAndRun() {
|
|
||||||
const extractors = {
|
|
||||||
[SUPPORTED_PLATFORMS.MAC]: () => prepareMacOsApp(DESKTOP_DIST_PATH),
|
|
||||||
[SUPPORTED_PLATFORMS.LINUX]: () => prepareLinuxApp(DESKTOP_DIST_PATH),
|
|
||||||
[SUPPORTED_PLATFORMS.WINDOWS]: () => prepareWindowsApp(DESKTOP_DIST_PATH),
|
|
||||||
};
|
|
||||||
const extractor = extractors[CURRENT_PLATFORM];
|
|
||||||
if (!extractor) {
|
|
||||||
throw new Error(`Platform not supported: ${CURRENT_PLATFORM}`);
|
|
||||||
}
|
|
||||||
const { appExecutablePath, cleanup } = await extractor();
|
|
||||||
try {
|
|
||||||
return await runApplication(
|
|
||||||
appExecutablePath,
|
|
||||||
APP_EXECUTION_DURATION_IN_SECONDS,
|
|
||||||
hasCommandLineFlag(COMMAND_LINE_FLAGS.TAKE_SCREENSHOT),
|
|
||||||
SCREENSHOT_PATH,
|
|
||||||
);
|
|
||||||
} finally {
|
|
||||||
if (cleanup) {
|
|
||||||
log('Cleaning up post-execution resources...');
|
|
||||||
await cleanup();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,48 +0,0 @@
|
|||||||
import { extname, join } from 'path';
|
|
||||||
import { readdir, access } from 'fs/promises';
|
|
||||||
import { constants } from 'fs';
|
|
||||||
import { log, die, LOG_LEVELS } from './log.js';
|
|
||||||
|
|
||||||
export async function findSingleFileByExtension(extension, directory) {
|
|
||||||
if (!directory) { throw new Error('Missing directory'); }
|
|
||||||
if (!extension) { throw new Error('Missing file extension'); }
|
|
||||||
|
|
||||||
if (!await exists(directory)) {
|
|
||||||
die(`Directory does not exist: ${directory}`);
|
|
||||||
return [];
|
|
||||||
}
|
|
||||||
|
|
||||||
const directoryContents = await readdir(directory);
|
|
||||||
const foundFileNames = directoryContents.filter((file) => extname(file) === `.${extension}`);
|
|
||||||
const withoutUninstaller = foundFileNames.filter(
|
|
||||||
(fileName) => !fileName.toLowerCase().includes('uninstall'), // NSIS build has `Uninstall {app-name}.exe`
|
|
||||||
);
|
|
||||||
if (!withoutUninstaller.length) {
|
|
||||||
die(`No ${extension} found in ${directory} directory.`);
|
|
||||||
}
|
|
||||||
if (withoutUninstaller.length > 1) {
|
|
||||||
log(`Found multiple ${extension} files: ${withoutUninstaller.join(', ')}. Using first occurrence`, LOG_LEVELS.WARN);
|
|
||||||
}
|
|
||||||
return {
|
|
||||||
absolutePath: join(directory, withoutUninstaller[0]),
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
export async function exists(path) {
|
|
||||||
if (!path) { throw new Error('Missing path'); }
|
|
||||||
try {
|
|
||||||
await access(path, constants.F_OK);
|
|
||||||
return true;
|
|
||||||
} catch {
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
export async function isDirMissingOrEmpty(dir) {
|
|
||||||
if (!dir) { throw new Error('Missing directory'); }
|
|
||||||
if (!await exists(dir)) {
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
const contents = await readdir(dir);
|
|
||||||
return contents.length === 0;
|
|
||||||
}
|
|
||||||
@@ -1,39 +0,0 @@
|
|||||||
export const LOG_LEVELS = Object.freeze({
|
|
||||||
INFO: 'INFO',
|
|
||||||
WARN: 'WARN',
|
|
||||||
ERROR: 'ERROR',
|
|
||||||
});
|
|
||||||
|
|
||||||
export function log(message, level = LOG_LEVELS.INFO) {
|
|
||||||
const timestamp = new Date().toISOString();
|
|
||||||
const config = LOG_LEVEL_CONFIG[level] || LOG_LEVEL_CONFIG[LOG_LEVELS.INFO];
|
|
||||||
const formattedMessage = `[${timestamp}][${config.color}${level}${COLOR_CODES.RESET}] ${message}`;
|
|
||||||
config.method(formattedMessage);
|
|
||||||
}
|
|
||||||
|
|
||||||
export function die(message) {
|
|
||||||
log(message, LOG_LEVELS.ERROR);
|
|
||||||
process.exit(1);
|
|
||||||
}
|
|
||||||
|
|
||||||
const COLOR_CODES = {
|
|
||||||
RESET: '\x1b[0m',
|
|
||||||
LIGHT_RED: '\x1b[91m',
|
|
||||||
YELLOW: '\x1b[33m',
|
|
||||||
LIGHT_BLUE: '\x1b[94m',
|
|
||||||
};
|
|
||||||
|
|
||||||
const LOG_LEVEL_CONFIG = {
|
|
||||||
[LOG_LEVELS.INFO]: {
|
|
||||||
color: COLOR_CODES.LIGHT_BLUE,
|
|
||||||
method: console.log,
|
|
||||||
},
|
|
||||||
[LOG_LEVELS.WARN]: {
|
|
||||||
color: COLOR_CODES.YELLOW,
|
|
||||||
method: console.warn,
|
|
||||||
},
|
|
||||||
[LOG_LEVELS.ERROR]: {
|
|
||||||
color: COLOR_CODES.LIGHT_RED,
|
|
||||||
method: console.error,
|
|
||||||
},
|
|
||||||
};
|
|
||||||
@@ -1,87 +0,0 @@
|
|||||||
import { join } from 'path';
|
|
||||||
import { rmdir, readFile } from 'fs/promises';
|
|
||||||
import { exists, isDirMissingOrEmpty } from './io.js';
|
|
||||||
import { runCommand } from './run-command.js';
|
|
||||||
import { LOG_LEVELS, die, log } from './log.js';
|
|
||||||
|
|
||||||
export async function ensureNpmProjectDir(projectDir) {
|
|
||||||
if (!projectDir) { throw new Error('missing project directory'); }
|
|
||||||
if (!await exists(join(projectDir, 'package.json'))) {
|
|
||||||
die(`'package.json' not found in project directory: ${projectDir}`);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
export async function npmInstall(projectDir) {
|
|
||||||
if (!projectDir) { throw new Error('missing project directory'); }
|
|
||||||
const npmModulesPath = join(projectDir, 'node_modules');
|
|
||||||
if (!await isDirMissingOrEmpty(npmModulesPath)) {
|
|
||||||
log(`Directory "${npmModulesPath}" exists and has content. Skipping \`npm install\`.`);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
log('Starting dependency installation...');
|
|
||||||
const { error } = await runCommand('npm install --loglevel=error', {
|
|
||||||
stdio: 'inherit',
|
|
||||||
cwd: projectDir,
|
|
||||||
});
|
|
||||||
if (error) {
|
|
||||||
die(error);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
export async function npmBuild(projectDir, buildCommand, distDir, forceRebuild) {
|
|
||||||
if (!projectDir) { throw new Error('missing project directory'); }
|
|
||||||
if (!buildCommand) { throw new Error('missing build command'); }
|
|
||||||
if (!distDir) { throw new Error('missing distribution directory'); }
|
|
||||||
|
|
||||||
const isMissingBuild = await isDirMissingOrEmpty(distDir);
|
|
||||||
|
|
||||||
if (!isMissingBuild && !forceRebuild) {
|
|
||||||
log(`Directory "${distDir}" exists and has content. Skipping build: '${buildCommand}'.`);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (forceRebuild) {
|
|
||||||
log(`Removing directory "${distDir}" for a clean build (triggered by --build flag).`);
|
|
||||||
await rmdir(distDir, { recursive: true });
|
|
||||||
}
|
|
||||||
|
|
||||||
log('Starting project build...');
|
|
||||||
const { error } = await runCommand(buildCommand, {
|
|
||||||
stdio: 'inherit',
|
|
||||||
cwd: projectDir,
|
|
||||||
});
|
|
||||||
if (error) {
|
|
||||||
log(error, LOG_LEVELS.WARN); // Cannot disable Vue CLI errors, stderr contains false-positives.
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
export async function getAppName(projectDir) {
|
|
||||||
if (!projectDir) { throw new Error('missing project directory'); }
|
|
||||||
const packageData = await readPackageJsonContents(projectDir);
|
|
||||||
try {
|
|
||||||
const packageJson = JSON.parse(packageData);
|
|
||||||
if (!packageJson.name) {
|
|
||||||
die(`The 'package.json' file doesn't specify a name: ${packageData}`);
|
|
||||||
}
|
|
||||||
return packageJson.name;
|
|
||||||
} catch (error) {
|
|
||||||
die(`Unable to parse 'package.json'. Error: ${error}\nContent: ${packageData}`, LOG_LEVELS.ERROR);
|
|
||||||
return undefined;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
async function readPackageJsonContents(projectDir) {
|
|
||||||
if (!projectDir) { throw new Error('missing project directory'); }
|
|
||||||
const packagePath = join(projectDir, 'package.json');
|
|
||||||
if (!await exists(packagePath)) {
|
|
||||||
die(`'package.json' file not found at ${packagePath}`);
|
|
||||||
}
|
|
||||||
try {
|
|
||||||
const packageData = await readFile(packagePath, 'utf8');
|
|
||||||
return packageData;
|
|
||||||
} catch (error) {
|
|
||||||
log(`Error reading 'package.json' from ${packagePath}.`, LOG_LEVELS.ERROR);
|
|
||||||
die(`Error detail: ${error}`, LOG_LEVELS.ERROR);
|
|
||||||
throw error;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
import { platform } from 'os';
|
|
||||||
|
|
||||||
export const SUPPORTED_PLATFORMS = {
|
|
||||||
MAC: 'darwin',
|
|
||||||
LINUX: 'linux',
|
|
||||||
WINDOWS: 'win32',
|
|
||||||
};
|
|
||||||
|
|
||||||
export const CURRENT_PLATFORM = platform();
|
|
||||||
@@ -1,95 +0,0 @@
|
|||||||
#!/usr/bin/env bash
|
|
||||||
|
|
||||||
# Description:
|
|
||||||
# This script ensures npm is available, removes existing node modules, optionally
|
|
||||||
# removes package-lock.json (when -n flag is used), installs dependencies and runs unit tests.
|
|
||||||
# Usage:
|
|
||||||
# ./fresh-npm-install.sh # Regular execution
|
|
||||||
# ./fresh-npm-install.sh -n # Non-deterministic mode (removes package-lock.json)
|
|
||||||
|
|
||||||
declare NON_DETERMINISTIC_FLAG=0
|
|
||||||
|
|
||||||
|
|
||||||
main() {
|
|
||||||
parse_args "$@"
|
|
||||||
ensure_npm_is_available
|
|
||||||
ensure_npm_root
|
|
||||||
remove_existing_modules
|
|
||||||
if [[ $NON_DETERMINISTIC_FLAG -eq 1 ]]; then
|
|
||||||
remove_package_lock_json
|
|
||||||
fi
|
|
||||||
install_dependencies
|
|
||||||
run_unit_tests
|
|
||||||
}
|
|
||||||
|
|
||||||
ensure_npm_is_available() {
|
|
||||||
if ! command -v npm &> /dev/null; then
|
|
||||||
log::fatal 'npm could not be found, please install it first.'
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
ensure_npm_root() {
|
|
||||||
if [ ! -f package.json ]; then
|
|
||||||
log::fatal 'Current directory is not a npm root. Please run the script in a npm root directory.'
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
remove_existing_modules() {
|
|
||||||
if [ -d ./node_modules ]; then
|
|
||||||
log::info 'Removing existing node modules...'
|
|
||||||
if ! rm -rf ./node_modules; then
|
|
||||||
log::fatal 'Could not remove existing node modules.'
|
|
||||||
fi
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
install_dependencies() {
|
|
||||||
log::info 'Installing dependencies...'
|
|
||||||
if ! npm install; then
|
|
||||||
log::fatal 'Failed to install dependencies.'
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
remove_package_lock_json() {
|
|
||||||
if [ -f ./package-lock.json ]; then
|
|
||||||
log::info 'Removing package-lock.json...'
|
|
||||||
if ! rm -rf ./package-lock.json; then
|
|
||||||
log::fatal 'Could not remove package-lock.json.'
|
|
||||||
fi
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
run_unit_tests() {
|
|
||||||
log::info 'Running unit tests...'
|
|
||||||
if ! npm run test:unit; then
|
|
||||||
pwd
|
|
||||||
log::fatal 'Failed to run unit tests.'
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
log::info() {
|
|
||||||
local -r message="$1"
|
|
||||||
echo "📣 ${message}"
|
|
||||||
}
|
|
||||||
|
|
||||||
log::fatal() {
|
|
||||||
local -r message="$1"
|
|
||||||
echo "❌ ${message}" >&2
|
|
||||||
exit 1
|
|
||||||
}
|
|
||||||
|
|
||||||
parse_args() {
|
|
||||||
while getopts "n" opt; do
|
|
||||||
case ${opt} in
|
|
||||||
n)
|
|
||||||
NON_DETERMINISTIC_FLAG=1
|
|
||||||
;;
|
|
||||||
\?)
|
|
||||||
echo "Invalid option: $OPTARG" 1>&2
|
|
||||||
exit 1
|
|
||||||
;;
|
|
||||||
esac
|
|
||||||
done
|
|
||||||
}
|
|
||||||
|
|
||||||
main "$1"
|
|
||||||
199
scripts/npm-install.js
Normal file
199
scripts/npm-install.js
Normal file
@@ -0,0 +1,199 @@
|
|||||||
|
/*
|
||||||
|
Description:
|
||||||
|
This script manages NPM dependencies for a project.
|
||||||
|
It offers capabilities like doing a fresh install, retries on network errors, and other features.
|
||||||
|
|
||||||
|
Usage:
|
||||||
|
npm run install-deps [-- <options>]
|
||||||
|
node scripts/npm-install.js [options]
|
||||||
|
|
||||||
|
Options:
|
||||||
|
--root-directory <path>
|
||||||
|
Specifies the root directory where package.json resides
|
||||||
|
Defaults to the current working directory.
|
||||||
|
Example: npm run install-deps -- --root-directory /your/path/here
|
||||||
|
|
||||||
|
--no-errors
|
||||||
|
Ignores errors and continues the execution.
|
||||||
|
Example: npm run install-deps -- --no-errors
|
||||||
|
|
||||||
|
--ci
|
||||||
|
Uses 'npm ci' for dependency installation instead of 'npm install'.
|
||||||
|
Example: npm run install-deps -- --ci
|
||||||
|
|
||||||
|
--fresh
|
||||||
|
Removes the existing node_modules directory before installing dependencies.
|
||||||
|
Example: npm run install-deps -- --fresh
|
||||||
|
|
||||||
|
--non-deterministic
|
||||||
|
Removes package-lock.json for a non-deterministic installation.
|
||||||
|
Example: npm run install-deps -- --non-deterministic
|
||||||
|
|
||||||
|
Note:
|
||||||
|
|
||||||
|
Flags can be combined as needed.
|
||||||
|
Example: npm run install-deps -- --fresh --non-deterministic
|
||||||
|
*/
|
||||||
|
|
||||||
|
import { exec } from 'child_process';
|
||||||
|
import { resolve } from 'path';
|
||||||
|
import { access, rm, unlink } from 'fs/promises';
|
||||||
|
import { constants } from 'fs';
|
||||||
|
|
||||||
|
const MAX_RETRIES = 5;
|
||||||
|
const RETRY_DELAY_IN_MS = 5 /* seconds */ * 1000;
|
||||||
|
const ARG_NAMES = {
|
||||||
|
rootDirectory: '--root-directory',
|
||||||
|
ignoreErrors: '--no-errors',
|
||||||
|
ci: '--ci',
|
||||||
|
fresh: '--fresh',
|
||||||
|
nonDeterministic: '--non-deterministic',
|
||||||
|
};
|
||||||
|
|
||||||
|
async function main() {
|
||||||
|
const options = getOptions();
|
||||||
|
console.log('Options:', options);
|
||||||
|
await ensureNpmRootDirectory(options.rootDirectory);
|
||||||
|
await ensureNpmIsAvailable();
|
||||||
|
if (options.fresh) {
|
||||||
|
await removeNodeModules(options.rootDirectory);
|
||||||
|
}
|
||||||
|
if (options.nonDeterministic) {
|
||||||
|
await removePackageLockJson(options.rootDirectory);
|
||||||
|
}
|
||||||
|
const command = buildCommand(options.ci, options.outputErrors);
|
||||||
|
console.log('Starting dependency installation...');
|
||||||
|
const exitCode = await executeWithRetry(
|
||||||
|
command,
|
||||||
|
options.workingDirectory,
|
||||||
|
MAX_RETRIES,
|
||||||
|
RETRY_DELAY_IN_MS,
|
||||||
|
);
|
||||||
|
if (exitCode === 0) {
|
||||||
|
console.log('🎊 Installed dependencies...');
|
||||||
|
} else {
|
||||||
|
console.error(`💀 Failed to install dependencies, exit code: ${exitCode}`);
|
||||||
|
}
|
||||||
|
process.exit(exitCode);
|
||||||
|
}
|
||||||
|
|
||||||
|
async function removeNodeModules(workingDirectory) {
|
||||||
|
const nodeModulesDirectory = resolve(workingDirectory, 'node_modules');
|
||||||
|
if (await exists('./node_modules')) {
|
||||||
|
console.log('Removing node_modules...');
|
||||||
|
await rm(nodeModulesDirectory, { recursive: true });
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async function removePackageLockJson(workingDirectory) {
|
||||||
|
const packageLockJsonFile = resolve(workingDirectory, 'package-lock.json');
|
||||||
|
if (await exists(packageLockJsonFile)) {
|
||||||
|
console.log('Removing package-lock.json...');
|
||||||
|
await unlink(packageLockJsonFile);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async function ensureNpmIsAvailable() {
|
||||||
|
const exitCode = await executeCommand('npm --version');
|
||||||
|
if (exitCode !== 0) {
|
||||||
|
throw new Error('`npm` in not available!');
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async function ensureNpmRootDirectory(workingDirectory) {
|
||||||
|
const packageJsonPath = resolve(workingDirectory, 'package.json');
|
||||||
|
if (!await exists(packageJsonPath)) {
|
||||||
|
throw new Error(`Not an NPM project root: ${workingDirectory}`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function buildCommand(ci, outputErrors) {
|
||||||
|
const baseCommand = ci ? 'npm ci' : 'npm install';
|
||||||
|
if (!outputErrors) {
|
||||||
|
return `${baseCommand} --loglevel=error`;
|
||||||
|
}
|
||||||
|
return baseCommand;
|
||||||
|
}
|
||||||
|
|
||||||
|
function getOptions() {
|
||||||
|
const processArgs = process.argv.slice(2); // Slice off the node and script name
|
||||||
|
return {
|
||||||
|
rootDirectory: processArgs.includes('--root-directory') ? processArgs[processArgs.indexOf('--root-directory') + 1] : process.cwd(),
|
||||||
|
outputErrors: !processArgs.includes(ARG_NAMES.ignoreErrors),
|
||||||
|
ci: processArgs.includes(ARG_NAMES.ci),
|
||||||
|
fresh: processArgs.includes(ARG_NAMES.fresh),
|
||||||
|
nonDeterministic: processArgs.includes(ARG_NAMES.nonDeterministic),
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
async function executeWithRetry(
|
||||||
|
command,
|
||||||
|
workingDirectory,
|
||||||
|
maxRetries,
|
||||||
|
retryDelayInMs,
|
||||||
|
currentAttempt = 1,
|
||||||
|
) {
|
||||||
|
const statusCode = await executeCommand(command, workingDirectory, true, true);
|
||||||
|
if (statusCode === 0 || currentAttempt >= maxRetries) {
|
||||||
|
return statusCode;
|
||||||
|
}
|
||||||
|
|
||||||
|
console.log(`⚠️🔄 Attempt ${currentAttempt} failed. Retrying in ${retryDelayInMs / 1000} seconds...`);
|
||||||
|
await sleep(retryDelayInMs);
|
||||||
|
|
||||||
|
const retryResult = await executeWithRetry(
|
||||||
|
command,
|
||||||
|
workingDirectory,
|
||||||
|
maxRetries,
|
||||||
|
retryDelayInMs,
|
||||||
|
currentAttempt + 1,
|
||||||
|
);
|
||||||
|
return retryResult;
|
||||||
|
}
|
||||||
|
|
||||||
|
async function executeCommand(
|
||||||
|
command,
|
||||||
|
workingDirectory = process.cwd(),
|
||||||
|
logStdout = false,
|
||||||
|
logCommand = false,
|
||||||
|
) {
|
||||||
|
if (logCommand) {
|
||||||
|
console.log(`▶️ Executing command "${command}" at "${workingDirectory}"`);
|
||||||
|
}
|
||||||
|
const process = exec(
|
||||||
|
command,
|
||||||
|
{
|
||||||
|
cwd: workingDirectory,
|
||||||
|
},
|
||||||
|
);
|
||||||
|
if (logStdout) {
|
||||||
|
process.stdout.on('data', (data) => {
|
||||||
|
console.log(data.toString());
|
||||||
|
});
|
||||||
|
}
|
||||||
|
process.stderr.on('data', (data) => {
|
||||||
|
console.error(data.toString());
|
||||||
|
});
|
||||||
|
return new Promise((resolve) => {
|
||||||
|
process.on('exit', (code) => {
|
||||||
|
resolve(code);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
function sleep(milliseconds) {
|
||||||
|
return new Promise((resolve) => {
|
||||||
|
setTimeout(resolve, milliseconds);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
async function exists(path) {
|
||||||
|
try {
|
||||||
|
await access(path, constants.F_OK);
|
||||||
|
return true;
|
||||||
|
} catch {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
await main();
|
||||||
58
scripts/print-dist-dir.js
Normal file
58
scripts/print-dist-dir.js
Normal file
@@ -0,0 +1,58 @@
|
|||||||
|
/**
|
||||||
|
* Description:
|
||||||
|
* This script determines the absolute path of a distribution directory based on CLI arguments
|
||||||
|
* and outputs its absolute path. It is designed to be run programmatically by other scripts.
|
||||||
|
*
|
||||||
|
* Usage:
|
||||||
|
* node scripts/print-dist-dir.js [options]
|
||||||
|
*
|
||||||
|
* Options:
|
||||||
|
* --electron-unbundled Path for the unbundled Electron application
|
||||||
|
* --electron-bundled Path for the bundled Electron application
|
||||||
|
* --web Path for the web application
|
||||||
|
*/
|
||||||
|
|
||||||
|
import { resolve } from 'path';
|
||||||
|
import { readFile } from 'fs/promises';
|
||||||
|
|
||||||
|
const DIST_DIRS_JSON_FILE_PATH = resolve(process.cwd(), 'dist-dirs.json'); // cannot statically import because ESLint does not support it https://github.com/eslint/eslint/discussions/15305
|
||||||
|
const CLI_ARGUMENTS = process.argv.slice(2);
|
||||||
|
|
||||||
|
async function main() {
|
||||||
|
const distDirs = await readDistDirsJsonFile(DIST_DIRS_JSON_FILE_PATH);
|
||||||
|
const relativeDistDir = determineRelativeDistDir(distDirs, CLI_ARGUMENTS);
|
||||||
|
const absoluteDistDir = resolve(process.cwd(), relativeDistDir);
|
||||||
|
console.log(absoluteDistDir);
|
||||||
|
}
|
||||||
|
|
||||||
|
function mapCliFlagsToDistDirs(distDirs) {
|
||||||
|
return {
|
||||||
|
'--electron-unbundled': distDirs.electronUnbundled,
|
||||||
|
'--electron-bundled': distDirs.electronBundled,
|
||||||
|
'--web': distDirs.web,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
function determineRelativeDistDir(distDirsJsonObject, cliArguments) {
|
||||||
|
const cliFlagDistDirMap = mapCliFlagsToDistDirs(distDirsJsonObject);
|
||||||
|
const availableCliFlags = Object.keys(cliFlagDistDirMap);
|
||||||
|
const requestedCliFlags = cliArguments.filter((arg) => {
|
||||||
|
return availableCliFlags.includes(arg);
|
||||||
|
});
|
||||||
|
if (!requestedCliFlags.length) {
|
||||||
|
throw new Error(`No distribution directory was requested. Please use one of these flags: ${availableCliFlags.join(', ')}`);
|
||||||
|
}
|
||||||
|
if (requestedCliFlags.length > 1) {
|
||||||
|
throw new Error(`Multiple distribution directories were requested, but this script only supports one: ${requestedCliFlags.join(', ')}`);
|
||||||
|
}
|
||||||
|
const selectedCliFlag = requestedCliFlags[0];
|
||||||
|
return cliFlagDistDirMap[selectedCliFlag];
|
||||||
|
}
|
||||||
|
|
||||||
|
async function readDistDirsJsonFile(absoluteConfigJsonFilePath) {
|
||||||
|
const fileContentAsText = await readFile(absoluteConfigJsonFilePath, 'utf8');
|
||||||
|
const parsedJsonData = JSON.parse(fileContentAsText);
|
||||||
|
return parsedJsonData;
|
||||||
|
}
|
||||||
|
|
||||||
|
await main();
|
||||||
133
scripts/verify-build-artifacts.js
Normal file
133
scripts/verify-build-artifacts.js
Normal file
@@ -0,0 +1,133 @@
|
|||||||
|
/**
|
||||||
|
* Description:
|
||||||
|
* This script verifies the existence and content of build artifacts based on the
|
||||||
|
* provided CLI flags. It exists with exit code `0` if all verifications pass, otherwise
|
||||||
|
* with exit code `1`.
|
||||||
|
*
|
||||||
|
* Usage:
|
||||||
|
* node scripts/verify-build-artifacts.js [options]
|
||||||
|
*
|
||||||
|
* Options:
|
||||||
|
* --electron-unbundled Verify artifacts for the unbundled Electron application.
|
||||||
|
* --electron-bundled Verify artifacts for the bundled Electron application.
|
||||||
|
* --web Verify artifacts for the web application.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import { access, readdir } from 'fs/promises';
|
||||||
|
import { exec } from 'child_process';
|
||||||
|
import { resolve } from 'path';
|
||||||
|
|
||||||
|
const PROCESS_ARGUMENTS = process.argv.slice(2);
|
||||||
|
const PRINT_DIST_DIR_SCRIPT_BASE_COMMAND = 'node scripts/print-dist-dir';
|
||||||
|
|
||||||
|
async function main() {
|
||||||
|
const buildConfigs = getBuildVerificationConfigs();
|
||||||
|
if (!anyCommandsFound(Object.keys(buildConfigs))) {
|
||||||
|
die(`No valid command found in process arguments. Expected one of: ${Object.keys(buildConfigs).join(', ')}`);
|
||||||
|
}
|
||||||
|
/* eslint-disable no-await-in-loop */
|
||||||
|
for (const [command, config] of Object.entries(buildConfigs)) {
|
||||||
|
if (PROCESS_ARGUMENTS.includes(command)) {
|
||||||
|
const distDir = await executePrintDistDirScript(config.printDistDirScriptArgument);
|
||||||
|
await verifyDirectoryExists(distDir);
|
||||||
|
await verifyNonEmptyDirectory(distDir);
|
||||||
|
await verifyFilesExist(distDir, config.filePatterns);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
/* eslint-enable no-await-in-loop */
|
||||||
|
console.log('✅ Build completed successfully and all expected artifacts are in place.');
|
||||||
|
process.exit(0);
|
||||||
|
}
|
||||||
|
|
||||||
|
function getBuildVerificationConfigs() {
|
||||||
|
return {
|
||||||
|
'--electron-unbundled': {
|
||||||
|
printDistDirScriptArgument: '--electron-unbundled',
|
||||||
|
filePatterns: [
|
||||||
|
/main[/\\]index\.cjs/,
|
||||||
|
/preload[/\\]index\.cjs/,
|
||||||
|
/renderer[/\\]index\.htm(l)?/,
|
||||||
|
],
|
||||||
|
},
|
||||||
|
'--electron-bundled': {
|
||||||
|
printDistDirScriptArgument: '--electron-bundled',
|
||||||
|
filePatterns: [
|
||||||
|
/latest.*\.yml/, // generates latest.yml for auto-updates
|
||||||
|
/.*-\d+\.\d+\.\d+\..*/, // a file with extension and semantic version (packaged application)
|
||||||
|
],
|
||||||
|
},
|
||||||
|
'--web': {
|
||||||
|
printDistDirScriptArgument: '--web',
|
||||||
|
filePatterns: [
|
||||||
|
/index\.htm(l)?/,
|
||||||
|
],
|
||||||
|
},
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
function anyCommandsFound(commands) {
|
||||||
|
return PROCESS_ARGUMENTS.some((arg) => commands.includes(arg));
|
||||||
|
}
|
||||||
|
|
||||||
|
async function verifyDirectoryExists(directoryPath) {
|
||||||
|
try {
|
||||||
|
await access(directoryPath);
|
||||||
|
} catch (error) {
|
||||||
|
die(`Directory does not exist at \`${directoryPath}\`:\n\t${error.message}`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async function verifyNonEmptyDirectory(directoryPath) {
|
||||||
|
const files = await readdir(directoryPath);
|
||||||
|
if (files.length === 0) {
|
||||||
|
die(`Directory is empty at \`${directoryPath}\``);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async function verifyFilesExist(directoryPath, filePatterns) {
|
||||||
|
const files = await listAllFilesRecursively(directoryPath);
|
||||||
|
for (const pattern of filePatterns) {
|
||||||
|
const match = files.some((file) => pattern.test(file));
|
||||||
|
if (!match) {
|
||||||
|
die(
|
||||||
|
`No file matches the pattern ${pattern.source} in directory \`${directoryPath}\``,
|
||||||
|
`\nFiles in directory:\n${files.map((file) => `\t- ${file}`).join('\n')}`,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async function listAllFilesRecursively(directoryPath) {
|
||||||
|
const dir = await readdir(directoryPath, { withFileTypes: true });
|
||||||
|
const files = await Promise.all(dir.map(async (dirent) => {
|
||||||
|
const absolutePath = resolve(directoryPath, dirent.name);
|
||||||
|
if (dirent.isDirectory()) {
|
||||||
|
return listAllFilesRecursively(absolutePath);
|
||||||
|
}
|
||||||
|
return absolutePath;
|
||||||
|
}));
|
||||||
|
return files.flat();
|
||||||
|
}
|
||||||
|
|
||||||
|
async function executePrintDistDirScript(flag) {
|
||||||
|
return new Promise((resolve, reject) => {
|
||||||
|
const commandToRun = `${PRINT_DIST_DIR_SCRIPT_BASE_COMMAND} ${flag}`;
|
||||||
|
|
||||||
|
exec(commandToRun, (error, stdout, stderr) => {
|
||||||
|
if (error) {
|
||||||
|
reject(new Error(`Execution failed with error: ${error}`));
|
||||||
|
} else if (stderr) {
|
||||||
|
reject(new Error(`Execution failed with stderr: ${stderr}`));
|
||||||
|
} else {
|
||||||
|
resolve(stdout.trim());
|
||||||
|
}
|
||||||
|
});
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
function die(...message) {
|
||||||
|
console.error(...message);
|
||||||
|
process.exit(1);
|
||||||
|
}
|
||||||
|
|
||||||
|
await main();
|
||||||
62
scripts/verify-web-server-status.js
Normal file
62
scripts/verify-web-server-status.js
Normal file
@@ -0,0 +1,62 @@
|
|||||||
|
/**
|
||||||
|
* Description:
|
||||||
|
* This script checks if a server, provided as a CLI argument, is up
|
||||||
|
* and returns an HTTP 200 status code.
|
||||||
|
* It is designed to provide easy verification of server availability
|
||||||
|
* and will retry a specified number of times.
|
||||||
|
*
|
||||||
|
* Usage:
|
||||||
|
* node ./scripts/verify-web-server-status.js --url [URL]
|
||||||
|
*
|
||||||
|
* Options:
|
||||||
|
* --url URL of the server to check
|
||||||
|
*/
|
||||||
|
|
||||||
|
import { get } from 'http';
|
||||||
|
|
||||||
|
const MAX_RETRIES = 30;
|
||||||
|
const RETRY_DELAY_IN_SECONDS = 3;
|
||||||
|
const URL_PARAMETER_NAME = '--url';
|
||||||
|
|
||||||
|
function checkServer(currentRetryCount = 1) {
|
||||||
|
const serverUrl = getServerUrl();
|
||||||
|
console.log(`Requesting ${serverUrl}...`);
|
||||||
|
get(serverUrl, (res) => {
|
||||||
|
if (res.statusCode === 200) {
|
||||||
|
console.log('🎊 Success: The server is up and returned HTTP 200.');
|
||||||
|
process.exit(0);
|
||||||
|
} else {
|
||||||
|
console.log(`Server returned HTTP status code ${res.statusCode}.`);
|
||||||
|
retry(currentRetryCount);
|
||||||
|
}
|
||||||
|
}).on('error', (err) => {
|
||||||
|
console.error('Error making the request:', err);
|
||||||
|
retry(currentRetryCount);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
function retry(currentRetryCount) {
|
||||||
|
console.log(`Attempt ${currentRetryCount}/${MAX_RETRIES}:`);
|
||||||
|
console.log(`Retrying in ${RETRY_DELAY_IN_SECONDS} seconds.`);
|
||||||
|
|
||||||
|
const remainingTime = (MAX_RETRIES - currentRetryCount) * RETRY_DELAY_IN_SECONDS;
|
||||||
|
console.log(`Time remaining before timeout: ${remainingTime}s`);
|
||||||
|
|
||||||
|
if (currentRetryCount < MAX_RETRIES) {
|
||||||
|
setTimeout(() => checkServer(currentRetryCount + 1), RETRY_DELAY_IN_SECONDS * 1000);
|
||||||
|
} else {
|
||||||
|
console.log('Failure: The server at did not return HTTP 200 within the allocated time. Exiting.');
|
||||||
|
process.exit(1);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function getServerUrl() {
|
||||||
|
const urlIndex = process.argv.indexOf(URL_PARAMETER_NAME);
|
||||||
|
if (urlIndex === -1 || urlIndex === process.argv.length - 1) {
|
||||||
|
console.error(`Parameter "${URL_PARAMETER_NAME}" is not provided.`);
|
||||||
|
process.exit(1);
|
||||||
|
}
|
||||||
|
return process.argv[urlIndex + 1];
|
||||||
|
}
|
||||||
|
|
||||||
|
checkServer();
|
||||||
@@ -1,6 +1,7 @@
|
|||||||
export type Constructible<T, TArgs extends unknown[] = never> = {
|
export type Constructible<T, TArgs extends unknown[] = never> = {
|
||||||
prototype: T;
|
prototype: T;
|
||||||
apply: (this: unknown, args: TArgs) => void;
|
apply: (this: unknown, args: TArgs) => void;
|
||||||
|
readonly name: string;
|
||||||
};
|
};
|
||||||
|
|
||||||
export type PropertyKeys<T> = {
|
export type PropertyKeys<T> = {
|
||||||
|
|||||||
@@ -12,9 +12,6 @@ export class ApplicationFactory implements IApplicationFactory {
|
|||||||
private readonly getter: AsyncLazy<IApplication>;
|
private readonly getter: AsyncLazy<IApplication>;
|
||||||
|
|
||||||
protected constructor(costlyGetter: ApplicationGetterType) {
|
protected constructor(costlyGetter: ApplicationGetterType) {
|
||||||
if (!costlyGetter) {
|
|
||||||
throw new Error('missing getter');
|
|
||||||
}
|
|
||||||
this.getter = new AsyncLazy<IApplication>(() => Promise.resolve(costlyGetter()));
|
this.getter = new AsyncLazy<IApplication>(() => Promise.resolve(costlyGetter()));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -1,7 +1,5 @@
|
|||||||
// Compares to Array<T> objects for equality, ignoring order
|
// Compares to Array<T> objects for equality, ignoring order
|
||||||
export function scrambledEqual<T>(array1: readonly T[], array2: readonly T[]) {
|
export function scrambledEqual<T>(array1: readonly T[], array2: readonly T[]) {
|
||||||
if (!array1) { throw new Error('missing first array'); }
|
|
||||||
if (!array2) { throw new Error('missing second array'); }
|
|
||||||
const sortedArray1 = sort(array1);
|
const sortedArray1 = sort(array1);
|
||||||
const sortedArray2 = sort(array2);
|
const sortedArray2 = sort(array2);
|
||||||
return sequenceEqual(sortedArray1, sortedArray2);
|
return sequenceEqual(sortedArray1, sortedArray2);
|
||||||
@@ -12,8 +10,6 @@ export function scrambledEqual<T>(array1: readonly T[], array2: readonly T[]) {
|
|||||||
|
|
||||||
// Compares to Array<T> objects for equality in same order
|
// Compares to Array<T> objects for equality in same order
|
||||||
export function sequenceEqual<T>(array1: readonly T[], array2: readonly T[]) {
|
export function sequenceEqual<T>(array1: readonly T[], array2: readonly T[]) {
|
||||||
if (!array1) { throw new Error('missing first array'); }
|
|
||||||
if (!array2) { throw new Error('missing second array'); }
|
|
||||||
if (array1.length !== array2.length) {
|
if (array1.length !== array2.length) {
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -20,23 +20,30 @@ export abstract class CustomError extends Error {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
export const Environment = {
|
interface ErrorPrototypeManipulation {
|
||||||
|
getSetPrototypeOf: () => (typeof Object.setPrototypeOf | undefined);
|
||||||
|
getCaptureStackTrace: () => (typeof Error.captureStackTrace | undefined);
|
||||||
|
}
|
||||||
|
|
||||||
|
export const PlatformErrorPrototypeManipulation: ErrorPrototypeManipulation = {
|
||||||
getSetPrototypeOf: () => Object.setPrototypeOf,
|
getSetPrototypeOf: () => Object.setPrototypeOf,
|
||||||
getCaptureStackTrace: () => Error.captureStackTrace,
|
getCaptureStackTrace: () => Error.captureStackTrace,
|
||||||
};
|
};
|
||||||
|
|
||||||
function fixPrototype(target: Error, prototype: CustomError) {
|
function fixPrototype(target: Error, prototype: CustomError) {
|
||||||
// https://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-2.html#support-for-newtarget
|
// This is recommended by TypeScript guidelines.
|
||||||
const setPrototypeOf = Environment.getSetPrototypeOf();
|
// Source: https://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-2.html#support-for-newtarget
|
||||||
if (!functionExists(setPrototypeOf)) {
|
// Snapshots: https://web.archive.org/web/20231111234849/https://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-2.html#support-for-newtarget, https://archive.ph/tr7cX#support-for-newtarget
|
||||||
|
const setPrototypeOf = PlatformErrorPrototypeManipulation.getSetPrototypeOf();
|
||||||
|
if (!isFunction(setPrototypeOf)) {
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
setPrototypeOf(target, prototype);
|
setPrototypeOf(target, prototype);
|
||||||
}
|
}
|
||||||
|
|
||||||
function ensureStackTrace(target: Error) {
|
function ensureStackTrace(target: Error) {
|
||||||
const captureStackTrace = Environment.getCaptureStackTrace();
|
const captureStackTrace = PlatformErrorPrototypeManipulation.getCaptureStackTrace();
|
||||||
if (!functionExists(captureStackTrace)) {
|
if (!isFunction(captureStackTrace)) {
|
||||||
// captureStackTrace is only available on V8, if it's not available
|
// captureStackTrace is only available on V8, if it's not available
|
||||||
// modern JS engines will usually generate a stack trace on error objects when they're thrown.
|
// modern JS engines will usually generate a stack trace on error objects when they're thrown.
|
||||||
return;
|
return;
|
||||||
@@ -44,7 +51,7 @@ function ensureStackTrace(target: Error) {
|
|||||||
captureStackTrace(target, target.constructor);
|
captureStackTrace(target, target.constructor);
|
||||||
}
|
}
|
||||||
|
|
||||||
function functionExists(func: unknown): boolean {
|
// eslint-disable-next-line @typescript-eslint/ban-types
|
||||||
// Not doing truthy/falsy check i.e. if(func) as most values are truthy in JS for robustness
|
function isFunction(func: unknown): func is Function {
|
||||||
return typeof func === 'function';
|
return typeof func === 'function';
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -54,9 +54,6 @@ export function assertInRange<T extends EnumType, TEnumValue extends EnumType>(
|
|||||||
value: TEnumValue,
|
value: TEnumValue,
|
||||||
enumVariable: EnumVariable<T, TEnumValue>,
|
enumVariable: EnumVariable<T, TEnumValue>,
|
||||||
) {
|
) {
|
||||||
if (value === undefined || value === null) {
|
|
||||||
throw new Error('absent enum value');
|
|
||||||
}
|
|
||||||
if (!(value in enumVariable)) {
|
if (!(value in enumVariable)) {
|
||||||
throw new RangeError(`enum value "${value}" is out of range`);
|
throw new RangeError(`enum value "${value}" is out of range`);
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -9,19 +9,16 @@ export abstract class ScriptingLanguageFactory<T> implements IScriptingLanguageF
|
|||||||
|
|
||||||
public create(language: ScriptingLanguage): T {
|
public create(language: ScriptingLanguage): T {
|
||||||
assertInRange(language, ScriptingLanguage);
|
assertInRange(language, ScriptingLanguage);
|
||||||
if (!this.getters.has(language)) {
|
const getter = this.getters.get(language);
|
||||||
|
if (!getter) {
|
||||||
throw new RangeError(`unknown language: "${ScriptingLanguage[language]}"`);
|
throw new RangeError(`unknown language: "${ScriptingLanguage[language]}"`);
|
||||||
}
|
}
|
||||||
const getter = this.getters.get(language);
|
|
||||||
const instance = getter();
|
const instance = getter();
|
||||||
return instance;
|
return instance;
|
||||||
}
|
}
|
||||||
|
|
||||||
protected registerGetter(language: ScriptingLanguage, getter: Getter<T>) {
|
protected registerGetter(language: ScriptingLanguage, getter: Getter<T>) {
|
||||||
assertInRange(language, ScriptingLanguage);
|
assertInRange(language, ScriptingLanguage);
|
||||||
if (!getter) {
|
|
||||||
throw new Error('missing getter');
|
|
||||||
}
|
|
||||||
if (this.getters.has(language)) {
|
if (this.getters.has(language)) {
|
||||||
throw new Error(`${ScriptingLanguage[language]} is already registered`);
|
throw new Error(`${ScriptingLanguage[language]} is already registered`);
|
||||||
}
|
}
|
||||||
|
|||||||
27
src/application/Common/Timing/BatchedDebounce.ts
Normal file
27
src/application/Common/Timing/BatchedDebounce.ts
Normal file
@@ -0,0 +1,27 @@
|
|||||||
|
import { PlatformTimer } from './PlatformTimer';
|
||||||
|
import { TimeoutType, Timer } from './Timer';
|
||||||
|
|
||||||
|
export function batchedDebounce<T>(
|
||||||
|
callback: (batches: readonly T[]) => void,
|
||||||
|
waitInMs: number,
|
||||||
|
timer: Timer = PlatformTimer,
|
||||||
|
): (arg: T) => void {
|
||||||
|
let lastTimeoutId: TimeoutType | undefined;
|
||||||
|
let batches: Array<T> = [];
|
||||||
|
|
||||||
|
return (arg: T) => {
|
||||||
|
batches.push(arg);
|
||||||
|
|
||||||
|
const later = () => {
|
||||||
|
callback(batches);
|
||||||
|
batches = [];
|
||||||
|
lastTimeoutId = undefined;
|
||||||
|
};
|
||||||
|
|
||||||
|
if (lastTimeoutId !== undefined) {
|
||||||
|
timer.clearTimeout(lastTimeoutId);
|
||||||
|
}
|
||||||
|
|
||||||
|
lastTimeoutId = timer.setTimeout(later, waitInMs);
|
||||||
|
};
|
||||||
|
}
|
||||||
7
src/application/Common/Timing/PlatformTimer.ts
Normal file
7
src/application/Common/Timing/PlatformTimer.ts
Normal file
@@ -0,0 +1,7 @@
|
|||||||
|
import { Timer } from './Timer';
|
||||||
|
|
||||||
|
export const PlatformTimer: Timer = {
|
||||||
|
setTimeout: (callback, ms) => setTimeout(callback, ms),
|
||||||
|
clearTimeout: (timeoutId) => clearTimeout(timeoutId),
|
||||||
|
dateNow: () => Date.now(),
|
||||||
|
};
|
||||||
@@ -1,47 +1,29 @@
|
|||||||
|
import { Timer, TimeoutType } from './Timer';
|
||||||
|
import { PlatformTimer } from './PlatformTimer';
|
||||||
|
|
||||||
export type CallbackType = (..._: unknown[]) => void;
|
export type CallbackType = (..._: unknown[]) => void;
|
||||||
|
|
||||||
export function throttle(
|
export function throttle(
|
||||||
callback: CallbackType,
|
callback: CallbackType,
|
||||||
waitInMs: number,
|
waitInMs: number,
|
||||||
timer: ITimer = NodeTimer,
|
timer: Timer = PlatformTimer,
|
||||||
): CallbackType {
|
): CallbackType {
|
||||||
const throttler = new Throttler(timer, waitInMs, callback);
|
const throttler = new Throttler(timer, waitInMs, callback);
|
||||||
return (...args: unknown[]) => throttler.invoke(...args);
|
return (...args: unknown[]) => throttler.invoke(...args);
|
||||||
}
|
}
|
||||||
|
|
||||||
// Allows aligning with both NodeJs (NodeJs.Timeout) and Window type (number)
|
class Throttler {
|
||||||
export type TimeoutType = ReturnType<typeof setTimeout>;
|
private queuedExecutionId: TimeoutType | undefined;
|
||||||
|
|
||||||
export interface ITimer {
|
|
||||||
setTimeout: (callback: () => void, ms: number) => TimeoutType;
|
|
||||||
clearTimeout: (timeoutId: TimeoutType) => void;
|
|
||||||
dateNow(): number;
|
|
||||||
}
|
|
||||||
|
|
||||||
const NodeTimer: ITimer = {
|
|
||||||
setTimeout: (callback, ms) => setTimeout(callback, ms),
|
|
||||||
clearTimeout: (timeoutId) => clearTimeout(timeoutId),
|
|
||||||
dateNow: () => Date.now(),
|
|
||||||
};
|
|
||||||
|
|
||||||
interface IThrottler {
|
|
||||||
invoke: CallbackType;
|
|
||||||
}
|
|
||||||
|
|
||||||
class Throttler implements IThrottler {
|
|
||||||
private queuedExecutionId: TimeoutType;
|
|
||||||
|
|
||||||
private previouslyRun: number;
|
private previouslyRun: number;
|
||||||
|
|
||||||
constructor(
|
constructor(
|
||||||
private readonly timer: ITimer,
|
private readonly timer: Timer,
|
||||||
private readonly waitInMs: number,
|
private readonly waitInMs: number,
|
||||||
private readonly callback: CallbackType,
|
private readonly callback: CallbackType,
|
||||||
) {
|
) {
|
||||||
if (!timer) { throw new Error('missing timer'); }
|
|
||||||
if (!waitInMs) { throw new Error('missing delay'); }
|
if (!waitInMs) { throw new Error('missing delay'); }
|
||||||
if (waitInMs < 0) { throw new Error('negative delay'); }
|
if (waitInMs < 0) { throw new Error('negative delay'); }
|
||||||
if (!callback) { throw new Error('missing callback'); }
|
|
||||||
}
|
}
|
||||||
|
|
||||||
public invoke(...args: unknown[]): void {
|
public invoke(...args: unknown[]): void {
|
||||||
8
src/application/Common/Timing/Timer.ts
Normal file
8
src/application/Common/Timing/Timer.ts
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
// Allows aligning with both NodeJs (NodeJs.Timeout) and Window type (number)
|
||||||
|
export type TimeoutType = ReturnType<typeof setTimeout>;
|
||||||
|
|
||||||
|
export interface Timer {
|
||||||
|
setTimeout: (callback: () => void, ms: number) => TimeoutType;
|
||||||
|
clearTimeout: (timeoutId: TimeoutType) => void;
|
||||||
|
dateNow(): number;
|
||||||
|
}
|
||||||
@@ -26,7 +26,6 @@ export class ApplicationContext implements IApplicationContext {
|
|||||||
public readonly app: IApplication,
|
public readonly app: IApplication,
|
||||||
initialContext: OperatingSystem,
|
initialContext: OperatingSystem,
|
||||||
) {
|
) {
|
||||||
validateApp(app);
|
|
||||||
this.states = initializeStates(app);
|
this.states = initializeStates(app);
|
||||||
this.changeContext(initialContext);
|
this.changeContext(initialContext);
|
||||||
}
|
}
|
||||||
@@ -36,10 +35,8 @@ export class ApplicationContext implements IApplicationContext {
|
|||||||
if (this.currentOs === os) {
|
if (this.currentOs === os) {
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
this.collection = this.app.getCollection(os);
|
const collection = this.app.getCollection(os);
|
||||||
if (!this.collection) {
|
this.collection = collection;
|
||||||
throw new Error(`os "${OperatingSystem[os]}" is not defined in application`);
|
|
||||||
}
|
|
||||||
const event: IApplicationContextChangedEvent = {
|
const event: IApplicationContextChangedEvent = {
|
||||||
newState: this.states[os],
|
newState: this.states[os],
|
||||||
oldState: this.states[this.currentOs],
|
oldState: this.states[this.currentOs],
|
||||||
@@ -49,12 +46,6 @@ export class ApplicationContext implements IApplicationContext {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
function validateApp(app: IApplication) {
|
|
||||||
if (!app) {
|
|
||||||
throw new Error('missing app');
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
function initializeStates(app: IApplication): StateMachine {
|
function initializeStates(app: IApplication): StateMachine {
|
||||||
const machine = new Map<OperatingSystem, ICategoryCollectionState>();
|
const machine = new Map<OperatingSystem, ICategoryCollectionState>();
|
||||||
for (const collection of app.collections) {
|
for (const collection of app.collections) {
|
||||||
|
|||||||
@@ -1,29 +1,32 @@
|
|||||||
import { IApplicationContext } from '@/application/Context/IApplicationContext';
|
import { IApplicationContext } from '@/application/Context/IApplicationContext';
|
||||||
import { OperatingSystem } from '@/domain/OperatingSystem';
|
import { OperatingSystem } from '@/domain/OperatingSystem';
|
||||||
import { IApplication } from '@/domain/IApplication';
|
import { IApplication } from '@/domain/IApplication';
|
||||||
import { Environment } from '@/infrastructure/Environment/Environment';
|
import { RuntimeEnvironment } from '@/infrastructure/RuntimeEnvironment/RuntimeEnvironment';
|
||||||
import { IEnvironment } from '@/infrastructure/Environment/IEnvironment';
|
|
||||||
import { IApplicationFactory } from '../IApplicationFactory';
|
import { IApplicationFactory } from '../IApplicationFactory';
|
||||||
import { ApplicationFactory } from '../ApplicationFactory';
|
import { ApplicationFactory } from '../ApplicationFactory';
|
||||||
import { ApplicationContext } from './ApplicationContext';
|
import { ApplicationContext } from './ApplicationContext';
|
||||||
|
|
||||||
export async function buildContext(
|
export async function buildContext(
|
||||||
factory: IApplicationFactory = ApplicationFactory.Current,
|
factory: IApplicationFactory = ApplicationFactory.Current,
|
||||||
environment = Environment.CurrentEnvironment,
|
environment = RuntimeEnvironment.CurrentEnvironment,
|
||||||
): Promise<IApplicationContext> {
|
): Promise<IApplicationContext> {
|
||||||
if (!factory) { throw new Error('missing factory'); }
|
|
||||||
if (!environment) { throw new Error('missing environment'); }
|
|
||||||
const app = await factory.getApp();
|
const app = await factory.getApp();
|
||||||
const os = getInitialOs(app, environment);
|
const os = getInitialOs(app, environment.os);
|
||||||
return new ApplicationContext(app, os);
|
return new ApplicationContext(app, os);
|
||||||
}
|
}
|
||||||
|
|
||||||
function getInitialOs(app: IApplication, environment: IEnvironment): OperatingSystem {
|
function getInitialOs(
|
||||||
const currentOs = environment.os;
|
app: IApplication,
|
||||||
|
currentOs: OperatingSystem | undefined,
|
||||||
|
): OperatingSystem {
|
||||||
const supportedOsList = app.getSupportedOsList();
|
const supportedOsList = app.getSupportedOsList();
|
||||||
if (supportedOsList.includes(currentOs)) {
|
if (currentOs !== undefined && supportedOsList.includes(currentOs)) {
|
||||||
return currentOs;
|
return currentOs;
|
||||||
}
|
}
|
||||||
|
return getMostSupportedOs(supportedOsList, app);
|
||||||
|
}
|
||||||
|
|
||||||
|
function getMostSupportedOs(supportedOsList: OperatingSystem[], app: IApplication) {
|
||||||
supportedOsList.sort((os1, os2) => {
|
supportedOsList.sort((os1, os2) => {
|
||||||
const getPriority = (os: OperatingSystem) => app.getCollection(os).totalScripts;
|
const getPriority = (os: OperatingSystem) => app.getCollection(os).totalScripts;
|
||||||
return getPriority(os2) - getPriority(os1);
|
return getPriority(os2) - getPriority(os1);
|
||||||
|
|||||||
@@ -4,23 +4,48 @@ import { UserFilter } from './Filter/UserFilter';
|
|||||||
import { IUserFilter } from './Filter/IUserFilter';
|
import { IUserFilter } from './Filter/IUserFilter';
|
||||||
import { ApplicationCode } from './Code/ApplicationCode';
|
import { ApplicationCode } from './Code/ApplicationCode';
|
||||||
import { UserSelection } from './Selection/UserSelection';
|
import { UserSelection } from './Selection/UserSelection';
|
||||||
import { IUserSelection } from './Selection/IUserSelection';
|
|
||||||
import { ICategoryCollectionState } from './ICategoryCollectionState';
|
import { ICategoryCollectionState } from './ICategoryCollectionState';
|
||||||
import { IApplicationCode } from './Code/IApplicationCode';
|
import { IApplicationCode } from './Code/IApplicationCode';
|
||||||
|
import { UserSelectionFacade } from './Selection/UserSelectionFacade';
|
||||||
|
|
||||||
export class CategoryCollectionState implements ICategoryCollectionState {
|
export class CategoryCollectionState implements ICategoryCollectionState {
|
||||||
public readonly os: OperatingSystem;
|
public readonly os: OperatingSystem;
|
||||||
|
|
||||||
public readonly code: IApplicationCode;
|
public readonly code: IApplicationCode;
|
||||||
|
|
||||||
public readonly selection: IUserSelection;
|
public readonly selection: UserSelection;
|
||||||
|
|
||||||
public readonly filter: IUserFilter;
|
public readonly filter: IUserFilter;
|
||||||
|
|
||||||
public constructor(readonly collection: ICategoryCollection) {
|
public constructor(
|
||||||
this.selection = new UserSelection(collection, []);
|
public readonly collection: ICategoryCollection,
|
||||||
this.code = new ApplicationCode(this.selection, collection.scripting);
|
selectionFactory = DefaultSelectionFactory,
|
||||||
this.filter = new UserFilter(collection);
|
codeFactory = DefaultCodeFactory,
|
||||||
|
filterFactory = DefaultFilterFactory,
|
||||||
|
) {
|
||||||
|
this.selection = selectionFactory(collection, []);
|
||||||
|
this.code = codeFactory(this.selection.scripts, collection.scripting);
|
||||||
|
this.filter = filterFactory(collection);
|
||||||
this.os = collection.os;
|
this.os = collection.os;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export type CodeFactory = (
|
||||||
|
...params: ConstructorParameters<typeof ApplicationCode>
|
||||||
|
) => IApplicationCode;
|
||||||
|
|
||||||
|
const DefaultCodeFactory: CodeFactory = (...params) => new ApplicationCode(...params);
|
||||||
|
|
||||||
|
export type SelectionFactory = (
|
||||||
|
...params: ConstructorParameters<typeof UserSelectionFacade>
|
||||||
|
) => UserSelection;
|
||||||
|
|
||||||
|
const DefaultSelectionFactory: SelectionFactory = (
|
||||||
|
...params
|
||||||
|
) => new UserSelectionFacade(...params);
|
||||||
|
|
||||||
|
export type FilterFactory = (
|
||||||
|
...params: ConstructorParameters<typeof UserFilter>
|
||||||
|
) => IUserFilter;
|
||||||
|
|
||||||
|
const DefaultFilterFactory: FilterFactory = (...params) => new UserFilter(...params);
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
import { SelectedScript } from '@/application/Context/State/Selection/SelectedScript';
|
|
||||||
import { IReadOnlyUserSelection } from '@/application/Context/State/Selection/IUserSelection';
|
|
||||||
import { EventSource } from '@/infrastructure/Events/EventSource';
|
import { EventSource } from '@/infrastructure/Events/EventSource';
|
||||||
import { IScriptingDefinition } from '@/domain/IScriptingDefinition';
|
import { IScriptingDefinition } from '@/domain/IScriptingDefinition';
|
||||||
|
import { SelectedScript } from '@/application/Context/State/Selection/Script/SelectedScript';
|
||||||
|
import { ReadonlyScriptSelection } from '@/application/Context/State/Selection/Script/ScriptSelection';
|
||||||
import { CodeChangedEvent } from './Event/CodeChangedEvent';
|
import { CodeChangedEvent } from './Event/CodeChangedEvent';
|
||||||
import { CodePosition } from './Position/CodePosition';
|
import { CodePosition } from './Position/CodePosition';
|
||||||
import { ICodeChangedEvent } from './Event/ICodeChangedEvent';
|
import { ICodeChangedEvent } from './Event/ICodeChangedEvent';
|
||||||
@@ -17,15 +17,12 @@ export class ApplicationCode implements IApplicationCode {
|
|||||||
private scriptPositions = new Map<SelectedScript, CodePosition>();
|
private scriptPositions = new Map<SelectedScript, CodePosition>();
|
||||||
|
|
||||||
constructor(
|
constructor(
|
||||||
userSelection: IReadOnlyUserSelection,
|
selection: ReadonlyScriptSelection,
|
||||||
private readonly scriptingDefinition: IScriptingDefinition,
|
private readonly scriptingDefinition: IScriptingDefinition,
|
||||||
private readonly generator: IUserScriptGenerator = new UserScriptGenerator(),
|
private readonly generator: IUserScriptGenerator = new UserScriptGenerator(),
|
||||||
) {
|
) {
|
||||||
if (!userSelection) { throw new Error('missing userSelection'); }
|
this.setCode(selection.selectedScripts);
|
||||||
if (!scriptingDefinition) { throw new Error('missing scriptingDefinition'); }
|
selection.changed.on((scripts) => {
|
||||||
if (!generator) { throw new Error('missing generator'); }
|
|
||||||
this.setCode(userSelection.selectedScripts);
|
|
||||||
userSelection.changed.on((scripts) => {
|
|
||||||
this.setCode(scripts);
|
this.setCode(scripts);
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
import { IScript } from '@/domain/IScript';
|
import { IScript } from '@/domain/IScript';
|
||||||
import { ICodePosition } from '@/application/Context/State/Code/Position/ICodePosition';
|
import { ICodePosition } from '@/application/Context/State/Code/Position/ICodePosition';
|
||||||
import { SelectedScript } from '../../Selection/SelectedScript';
|
import { SelectedScript } from '@/application/Context/State/Selection/Script/SelectedScript';
|
||||||
import { ICodeChangedEvent } from './ICodeChangedEvent';
|
import { ICodeChangedEvent } from './ICodeChangedEvent';
|
||||||
|
|
||||||
export class CodeChangedEvent implements ICodeChangedEvent {
|
export class CodeChangedEvent implements ICodeChangedEvent {
|
||||||
@@ -36,7 +36,18 @@ export class CodeChangedEvent implements ICodeChangedEvent {
|
|||||||
}
|
}
|
||||||
|
|
||||||
public getScriptPositionInCode(script: IScript): ICodePosition {
|
public getScriptPositionInCode(script: IScript): ICodePosition {
|
||||||
return this.scripts.get(script);
|
return this.getPositionById(script.id);
|
||||||
|
}
|
||||||
|
|
||||||
|
private getPositionById(scriptId: string): ICodePosition {
|
||||||
|
const position = [...this.scripts.entries()]
|
||||||
|
.filter(([s]) => s.id === scriptId)
|
||||||
|
.map(([, pos]) => pos)
|
||||||
|
.at(0);
|
||||||
|
if (!position) {
|
||||||
|
throw new Error('Unknown script: Position could not be found for the script');
|
||||||
|
}
|
||||||
|
return position;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -3,9 +3,9 @@ import { ICodePosition } from '@/application/Context/State/Code/Position/ICodePo
|
|||||||
|
|
||||||
export interface ICodeChangedEvent {
|
export interface ICodeChangedEvent {
|
||||||
readonly code: string;
|
readonly code: string;
|
||||||
addedScripts: ReadonlyArray<IScript>;
|
readonly addedScripts: ReadonlyArray<IScript>;
|
||||||
removedScripts: ReadonlyArray<IScript>;
|
readonly removedScripts: ReadonlyArray<IScript>;
|
||||||
changedScripts: ReadonlyArray<IScript>;
|
readonly changedScripts: ReadonlyArray<IScript>;
|
||||||
isEmpty(): boolean;
|
isEmpty(): boolean;
|
||||||
getScriptPositionInCode(script: IScript): ICodePosition;
|
getScriptPositionInCode(script: IScript): ICodePosition;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -16,7 +16,9 @@ export abstract class CodeBuilder implements ICodeBuilder {
|
|||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
const lines = code.match(/[^\r\n]+/g);
|
const lines = code.match(/[^\r\n]+/g);
|
||||||
this.lines.push(...lines);
|
if (lines) {
|
||||||
|
this.lines.push(...lines);
|
||||||
|
}
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
import { SelectedScript } from '@/application/Context/State/Selection/SelectedScript';
|
|
||||||
import { ICodePosition } from '@/application/Context/State/Code/Position/ICodePosition';
|
import { ICodePosition } from '@/application/Context/State/Code/Position/ICodePosition';
|
||||||
|
import { SelectedScript } from '@/application/Context/State/Selection/Script/SelectedScript';
|
||||||
|
|
||||||
export interface IUserScript {
|
export interface IUserScript {
|
||||||
code: string;
|
readonly code: string;
|
||||||
scriptPositions: Map<SelectedScript, ICodePosition>;
|
readonly scriptPositions: Map<SelectedScript, ICodePosition>;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,9 +1,10 @@
|
|||||||
import { SelectedScript } from '@/application/Context/State/Selection/SelectedScript';
|
|
||||||
import { IScriptingDefinition } from '@/domain/IScriptingDefinition';
|
import { IScriptingDefinition } from '@/domain/IScriptingDefinition';
|
||||||
|
import { SelectedScript } from '@/application/Context/State/Selection/Script/SelectedScript';
|
||||||
import { IUserScript } from './IUserScript';
|
import { IUserScript } from './IUserScript';
|
||||||
|
|
||||||
export interface IUserScriptGenerator {
|
export interface IUserScriptGenerator {
|
||||||
buildCode(
|
buildCode(
|
||||||
selectedScripts: ReadonlyArray<SelectedScript>,
|
selectedScripts: ReadonlyArray<SelectedScript>,
|
||||||
scriptingDefinition: IScriptingDefinition): IUserScript;
|
scriptingDefinition: IScriptingDefinition,
|
||||||
|
): IUserScript;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
import { SelectedScript } from '@/application/Context/State/Selection/SelectedScript';
|
|
||||||
import { ICodePosition } from '@/application/Context/State/Code/Position/ICodePosition';
|
import { ICodePosition } from '@/application/Context/State/Code/Position/ICodePosition';
|
||||||
import { IScriptingDefinition } from '@/domain/IScriptingDefinition';
|
import { IScriptingDefinition } from '@/domain/IScriptingDefinition';
|
||||||
|
import { SelectedScript } from '@/application/Context/State/Selection/Script/SelectedScript';
|
||||||
import { CodePosition } from '../Position/CodePosition';
|
import { CodePosition } from '../Position/CodePosition';
|
||||||
import { IUserScriptGenerator } from './IUserScriptGenerator';
|
import { IUserScriptGenerator } from './IUserScriptGenerator';
|
||||||
import { IUserScript } from './IUserScript';
|
import { IUserScript } from './IUserScript';
|
||||||
@@ -17,8 +17,6 @@ export class UserScriptGenerator implements IUserScriptGenerator {
|
|||||||
selectedScripts: ReadonlyArray<SelectedScript>,
|
selectedScripts: ReadonlyArray<SelectedScript>,
|
||||||
scriptingDefinition: IScriptingDefinition,
|
scriptingDefinition: IScriptingDefinition,
|
||||||
): IUserScript {
|
): IUserScript {
|
||||||
if (!selectedScripts) { throw new Error('missing scripts'); }
|
|
||||||
if (!scriptingDefinition) { throw new Error('missing definition'); }
|
|
||||||
if (!selectedScripts.length) {
|
if (!selectedScripts.length) {
|
||||||
return { code: '', scriptPositions: new Map<SelectedScript, ICodePosition>() };
|
return { code: '', scriptPositions: new Map<SelectedScript, ICodePosition>() };
|
||||||
}
|
}
|
||||||
@@ -68,8 +66,19 @@ function appendSelection(
|
|||||||
function appendCode(selection: SelectedScript, builder: ICodeBuilder): ICodeBuilder {
|
function appendCode(selection: SelectedScript, builder: ICodeBuilder): ICodeBuilder {
|
||||||
const { script } = selection;
|
const { script } = selection;
|
||||||
const name = selection.revert ? `${script.name} (revert)` : script.name;
|
const name = selection.revert ? `${script.name} (revert)` : script.name;
|
||||||
const scriptCode = selection.revert ? script.code.revert : script.code.execute;
|
const scriptCode = getSelectedCode(selection);
|
||||||
return builder
|
return builder
|
||||||
.appendLine()
|
.appendLine()
|
||||||
.appendFunction(name, scriptCode);
|
.appendFunction(name, scriptCode);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
function getSelectedCode(selection: SelectedScript): string {
|
||||||
|
const { code } = selection.script;
|
||||||
|
if (!selection.revert) {
|
||||||
|
return code.execute;
|
||||||
|
}
|
||||||
|
if (!code.revert) {
|
||||||
|
throw new Error('Reverted script lacks revert code.');
|
||||||
|
}
|
||||||
|
return code.revert;
|
||||||
|
}
|
||||||
|
|||||||
@@ -1,37 +1,37 @@
|
|||||||
import { IFilterResult } from '@/application/Context/State/Filter/IFilterResult';
|
import { IFilterResult } from '@/application/Context/State/Filter/IFilterResult';
|
||||||
import { FilterActionType } from './FilterActionType';
|
import { FilterActionType } from './FilterActionType';
|
||||||
import { IFilterChangeDetails, IFilterChangeDetailsVisitor } from './IFilterChangeDetails';
|
import {
|
||||||
|
IFilterChangeDetails, IFilterChangeDetailsVisitor,
|
||||||
|
ApplyFilterAction, ClearFilterAction,
|
||||||
|
} from './IFilterChangeDetails';
|
||||||
|
|
||||||
export class FilterChange implements IFilterChangeDetails {
|
export class FilterChange implements IFilterChangeDetails {
|
||||||
public static forApply(filter: IFilterResult) {
|
public static forApply(
|
||||||
if (!filter) {
|
filter: IFilterResult,
|
||||||
throw new Error('missing filter');
|
): IFilterChangeDetails {
|
||||||
}
|
return new FilterChange({ type: FilterActionType.Apply, filter });
|
||||||
return new FilterChange(FilterActionType.Apply, filter);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
public static forClear() {
|
public static forClear(): IFilterChangeDetails {
|
||||||
return new FilterChange(FilterActionType.Clear);
|
return new FilterChange({ type: FilterActionType.Clear });
|
||||||
}
|
}
|
||||||
|
|
||||||
private constructor(
|
private constructor(public readonly action: ApplyFilterAction | ClearFilterAction) { }
|
||||||
public readonly actionType: FilterActionType,
|
|
||||||
public readonly filter?: IFilterResult,
|
|
||||||
) { }
|
|
||||||
|
|
||||||
public visit(visitor: IFilterChangeDetailsVisitor): void {
|
public visit(visitor: IFilterChangeDetailsVisitor): void {
|
||||||
if (!visitor) {
|
switch (this.action.type) {
|
||||||
throw new Error('missing visitor');
|
|
||||||
}
|
|
||||||
switch (this.actionType) {
|
|
||||||
case FilterActionType.Apply:
|
case FilterActionType.Apply:
|
||||||
visitor.onApply(this.filter);
|
if (visitor.onApply) {
|
||||||
|
visitor.onApply(this.action.filter);
|
||||||
|
}
|
||||||
break;
|
break;
|
||||||
case FilterActionType.Clear:
|
case FilterActionType.Clear:
|
||||||
visitor.onClear();
|
if (visitor.onClear) {
|
||||||
|
visitor.onClear();
|
||||||
|
}
|
||||||
break;
|
break;
|
||||||
default:
|
default:
|
||||||
throw new Error(`Unknown action type: ${this.actionType}`);
|
throw new Error(`Unknown action: ${this.action}`);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -2,13 +2,22 @@ import { IFilterResult } from '@/application/Context/State/Filter/IFilterResult'
|
|||||||
import { FilterActionType } from './FilterActionType';
|
import { FilterActionType } from './FilterActionType';
|
||||||
|
|
||||||
export interface IFilterChangeDetails {
|
export interface IFilterChangeDetails {
|
||||||
readonly actionType: FilterActionType;
|
readonly action: FilterAction;
|
||||||
readonly filter?: IFilterResult;
|
|
||||||
|
|
||||||
visit(visitor: IFilterChangeDetailsVisitor): void;
|
visit(visitor: IFilterChangeDetailsVisitor): void;
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface IFilterChangeDetailsVisitor {
|
export interface IFilterChangeDetailsVisitor {
|
||||||
onClear(): void;
|
readonly onClear?: () => void;
|
||||||
onApply(filter: IFilterResult): void;
|
readonly onApply?: (filter: IFilterResult) => void;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export type ApplyFilterAction = {
|
||||||
|
readonly type: FilterActionType.Apply,
|
||||||
|
readonly filter: IFilterResult;
|
||||||
|
};
|
||||||
|
|
||||||
|
export type ClearFilterAction = {
|
||||||
|
readonly type: FilterActionType.Clear,
|
||||||
|
};
|
||||||
|
|
||||||
|
export type FilterAction = ApplyFilterAction | ClearFilterAction;
|
||||||
|
|||||||
@@ -9,8 +9,6 @@ export class FilterResult implements IFilterResult {
|
|||||||
public readonly query: string,
|
public readonly query: string,
|
||||||
) {
|
) {
|
||||||
if (!query) { throw new Error('Query is empty or undefined'); }
|
if (!query) { throw new Error('Query is empty or undefined'); }
|
||||||
if (!scriptMatches) { throw new Error('Script matches is undefined'); }
|
|
||||||
if (!categoryMatches) { throw new Error('Category matches is undefined'); }
|
|
||||||
}
|
}
|
||||||
|
|
||||||
public hasAnyMatches(): boolean {
|
public hasAnyMatches(): boolean {
|
||||||
|
|||||||
@@ -1,18 +1,18 @@
|
|||||||
import { ICategoryCollection } from '@/domain/ICategoryCollection';
|
import { ICategoryCollection } from '@/domain/ICategoryCollection';
|
||||||
import { OperatingSystem } from '@/domain/OperatingSystem';
|
import { OperatingSystem } from '@/domain/OperatingSystem';
|
||||||
import { IReadOnlyUserFilter, IUserFilter } from './Filter/IUserFilter';
|
import { IReadOnlyUserFilter, IUserFilter } from './Filter/IUserFilter';
|
||||||
import { IReadOnlyUserSelection, IUserSelection } from './Selection/IUserSelection';
|
import { ReadonlyUserSelection, UserSelection } from './Selection/UserSelection';
|
||||||
import { IApplicationCode } from './Code/IApplicationCode';
|
import { IApplicationCode } from './Code/IApplicationCode';
|
||||||
|
|
||||||
export interface IReadOnlyCategoryCollectionState {
|
export interface IReadOnlyCategoryCollectionState {
|
||||||
readonly code: IApplicationCode;
|
readonly code: IApplicationCode;
|
||||||
readonly os: OperatingSystem;
|
readonly os: OperatingSystem;
|
||||||
readonly filter: IReadOnlyUserFilter;
|
readonly filter: IReadOnlyUserFilter;
|
||||||
readonly selection: IReadOnlyUserSelection;
|
readonly selection: ReadonlyUserSelection;
|
||||||
readonly collection: ICategoryCollection;
|
readonly collection: ICategoryCollection;
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface ICategoryCollectionState extends IReadOnlyCategoryCollectionState {
|
export interface ICategoryCollectionState extends IReadOnlyCategoryCollectionState {
|
||||||
readonly filter: IUserFilter;
|
readonly filter: IUserFilter;
|
||||||
readonly selection: IUserSelection;
|
readonly selection: UserSelection;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,11 @@
|
|||||||
|
import { ICategory } from '@/domain/ICategory';
|
||||||
|
import { CategorySelectionChangeCommand } from './CategorySelectionChange';
|
||||||
|
|
||||||
|
export interface ReadonlyCategorySelection {
|
||||||
|
areAllScriptsSelected(category: ICategory): boolean;
|
||||||
|
isAnyScriptSelected(category: ICategory): boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface CategorySelection extends ReadonlyCategorySelection {
|
||||||
|
processChanges(action: CategorySelectionChangeCommand): void;
|
||||||
|
}
|
||||||
@@ -0,0 +1,15 @@
|
|||||||
|
type CategorySelectionStatus = {
|
||||||
|
readonly isSelected: true;
|
||||||
|
readonly isReverted: boolean;
|
||||||
|
} | {
|
||||||
|
readonly isSelected: false;
|
||||||
|
};
|
||||||
|
|
||||||
|
export interface CategorySelectionChange {
|
||||||
|
readonly categoryId: number;
|
||||||
|
readonly newStatus: CategorySelectionStatus;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface CategorySelectionChangeCommand {
|
||||||
|
readonly changes: readonly CategorySelectionChange[];
|
||||||
|
}
|
||||||
@@ -0,0 +1,60 @@
|
|||||||
|
import { ICategory } from '@/domain/ICategory';
|
||||||
|
import { ICategoryCollection } from '@/domain/ICategoryCollection';
|
||||||
|
import { ScriptSelection } from '../Script/ScriptSelection';
|
||||||
|
import { ScriptSelectionChange } from '../Script/ScriptSelectionChange';
|
||||||
|
import { CategorySelection } from './CategorySelection';
|
||||||
|
import { CategorySelectionChange, CategorySelectionChangeCommand } from './CategorySelectionChange';
|
||||||
|
|
||||||
|
export class ScriptToCategorySelectionMapper implements CategorySelection {
|
||||||
|
constructor(
|
||||||
|
private readonly scriptSelection: ScriptSelection,
|
||||||
|
private readonly collection: ICategoryCollection,
|
||||||
|
) {
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
public areAllScriptsSelected(category: ICategory): boolean {
|
||||||
|
const { selectedScripts } = this.scriptSelection;
|
||||||
|
if (selectedScripts.length === 0) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
const scripts = category.getAllScriptsRecursively();
|
||||||
|
if (selectedScripts.length < scripts.length) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
return scripts.every(
|
||||||
|
(script) => selectedScripts.some((selected) => selected.id === script.id),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
public isAnyScriptSelected(category: ICategory): boolean {
|
||||||
|
const { selectedScripts } = this.scriptSelection;
|
||||||
|
if (selectedScripts.length === 0) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
return selectedScripts.some((s) => category.includes(s.script));
|
||||||
|
}
|
||||||
|
|
||||||
|
public processChanges(action: CategorySelectionChangeCommand): void {
|
||||||
|
const scriptChanges = action.changes.reduce((changes, change) => {
|
||||||
|
changes.push(...this.collectScriptChanges(change));
|
||||||
|
return changes;
|
||||||
|
}, new Array<ScriptSelectionChange>());
|
||||||
|
this.scriptSelection.processChanges({
|
||||||
|
changes: scriptChanges,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
private collectScriptChanges(change: CategorySelectionChange): ScriptSelectionChange[] {
|
||||||
|
const category = this.collection.getCategory(change.categoryId);
|
||||||
|
const scripts = category.getAllScriptsRecursively();
|
||||||
|
const scriptsChangesInCategory = scripts
|
||||||
|
.map((script): ScriptSelectionChange => ({
|
||||||
|
scriptId: script.id,
|
||||||
|
newStatus: {
|
||||||
|
...change.newStatus,
|
||||||
|
},
|
||||||
|
}));
|
||||||
|
return scriptsChangesInCategory;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,23 +0,0 @@
|
|||||||
import { IScript } from '@/domain/IScript';
|
|
||||||
import { ICategory } from '@/domain/ICategory';
|
|
||||||
import { IEventSource } from '@/infrastructure/Events/IEventSource';
|
|
||||||
import { SelectedScript } from './SelectedScript';
|
|
||||||
|
|
||||||
export interface IReadOnlyUserSelection {
|
|
||||||
readonly changed: IEventSource<ReadonlyArray<SelectedScript>>;
|
|
||||||
readonly selectedScripts: ReadonlyArray<SelectedScript>;
|
|
||||||
isSelected(scriptId: string): boolean;
|
|
||||||
areAllSelected(category: ICategory): boolean;
|
|
||||||
isAnySelected(category: ICategory): boolean;
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface IUserSelection extends IReadOnlyUserSelection {
|
|
||||||
removeAllInCategory(categoryId: number): void;
|
|
||||||
addOrUpdateAllInCategory(categoryId: number, revert: boolean): void;
|
|
||||||
addSelectedScript(scriptId: string, revert: boolean): void;
|
|
||||||
addOrUpdateSelectedScript(scriptId: string, revert: boolean): void;
|
|
||||||
removeSelectedScript(scriptId: string): void;
|
|
||||||
selectOnly(scripts: ReadonlyArray<IScript>): void;
|
|
||||||
selectAll(): void;
|
|
||||||
deselectAll(): void;
|
|
||||||
}
|
|
||||||
@@ -0,0 +1,171 @@
|
|||||||
|
import { InMemoryRepository } from '@/infrastructure/Repository/InMemoryRepository';
|
||||||
|
import { IScript } from '@/domain/IScript';
|
||||||
|
import { EventSource } from '@/infrastructure/Events/EventSource';
|
||||||
|
import { ReadonlyRepository, Repository } from '@/application/Repository/Repository';
|
||||||
|
import { ICategoryCollection } from '@/domain/ICategoryCollection';
|
||||||
|
import { batchedDebounce } from '@/application/Common/Timing/BatchedDebounce';
|
||||||
|
import { ScriptSelection } from './ScriptSelection';
|
||||||
|
import { ScriptSelectionChange, ScriptSelectionChangeCommand } from './ScriptSelectionChange';
|
||||||
|
import { SelectedScript } from './SelectedScript';
|
||||||
|
import { UserSelectedScript } from './UserSelectedScript';
|
||||||
|
|
||||||
|
const DEBOUNCE_DELAY_IN_MS = 100;
|
||||||
|
|
||||||
|
export type DebounceFunction = typeof batchedDebounce<ScriptSelectionChangeCommand>;
|
||||||
|
|
||||||
|
export class DebouncedScriptSelection implements ScriptSelection {
|
||||||
|
public readonly changed = new EventSource<ReadonlyArray<SelectedScript>>();
|
||||||
|
|
||||||
|
private readonly scripts: Repository<string, SelectedScript>;
|
||||||
|
|
||||||
|
public readonly processChanges: ScriptSelection['processChanges'];
|
||||||
|
|
||||||
|
constructor(
|
||||||
|
private readonly collection: ICategoryCollection,
|
||||||
|
selectedScripts: ReadonlyArray<SelectedScript>,
|
||||||
|
debounce: DebounceFunction = batchedDebounce,
|
||||||
|
) {
|
||||||
|
this.scripts = new InMemoryRepository<string, SelectedScript>();
|
||||||
|
for (const script of selectedScripts) {
|
||||||
|
this.scripts.addItem(script);
|
||||||
|
}
|
||||||
|
this.processChanges = debounce(
|
||||||
|
(batchedRequests: readonly ScriptSelectionChangeCommand[]) => {
|
||||||
|
const consolidatedChanges = batchedRequests.flatMap((request) => request.changes);
|
||||||
|
this.processScriptChanges(consolidatedChanges);
|
||||||
|
},
|
||||||
|
DEBOUNCE_DELAY_IN_MS,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
public isSelected(scriptId: string): boolean {
|
||||||
|
return this.scripts.exists(scriptId);
|
||||||
|
}
|
||||||
|
|
||||||
|
public get selectedScripts(): readonly SelectedScript[] {
|
||||||
|
return this.scripts.getItems();
|
||||||
|
}
|
||||||
|
|
||||||
|
public selectAll(): void {
|
||||||
|
const scriptsToSelect = this.collection
|
||||||
|
.getAllScripts()
|
||||||
|
.filter((script) => !this.scripts.exists(script.id))
|
||||||
|
.map((script) => new UserSelectedScript(script, false));
|
||||||
|
if (scriptsToSelect.length === 0) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
this.processChanges({
|
||||||
|
changes: scriptsToSelect.map((script): ScriptSelectionChange => ({
|
||||||
|
scriptId: script.id,
|
||||||
|
newStatus: {
|
||||||
|
isSelected: true,
|
||||||
|
isReverted: false,
|
||||||
|
},
|
||||||
|
})),
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
public deselectAll(): void {
|
||||||
|
if (this.scripts.length === 0) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
const selectedScriptIds = this.scripts.getItems().map((script) => script.id);
|
||||||
|
this.processChanges({
|
||||||
|
changes: selectedScriptIds.map((scriptId): ScriptSelectionChange => ({
|
||||||
|
scriptId,
|
||||||
|
newStatus: {
|
||||||
|
isSelected: false,
|
||||||
|
},
|
||||||
|
})),
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
public selectOnly(scripts: readonly IScript[]): void {
|
||||||
|
if (scripts.length === 0) {
|
||||||
|
throw new Error('Provided script array is empty. To deselect all scripts, please use the deselectAll() method instead.');
|
||||||
|
}
|
||||||
|
this.processChanges({
|
||||||
|
changes: [
|
||||||
|
...getScriptIdsToBeDeselected(this.scripts, scripts)
|
||||||
|
.map((scriptId): ScriptSelectionChange => ({
|
||||||
|
scriptId,
|
||||||
|
newStatus: {
|
||||||
|
isSelected: false,
|
||||||
|
},
|
||||||
|
})),
|
||||||
|
...getScriptIdsToBeSelected(this.scripts, scripts)
|
||||||
|
.map((scriptId): ScriptSelectionChange => ({
|
||||||
|
scriptId,
|
||||||
|
newStatus: {
|
||||||
|
isSelected: true,
|
||||||
|
isReverted: false,
|
||||||
|
},
|
||||||
|
})),
|
||||||
|
],
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
private processScriptChanges(changes: readonly ScriptSelectionChange[]): void {
|
||||||
|
let totalChanged = 0;
|
||||||
|
for (const change of changes) {
|
||||||
|
totalChanged += this.applyChange(change);
|
||||||
|
}
|
||||||
|
if (totalChanged > 0) {
|
||||||
|
this.changed.notify(this.scripts.getItems());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private applyChange(change: ScriptSelectionChange): number {
|
||||||
|
const script = this.collection.getScript(change.scriptId);
|
||||||
|
if (change.newStatus.isSelected) {
|
||||||
|
return this.addOrUpdateScript(script.id, change.newStatus.isReverted);
|
||||||
|
}
|
||||||
|
return this.removeScript(script.id);
|
||||||
|
}
|
||||||
|
|
||||||
|
private addOrUpdateScript(scriptId: string, revert: boolean): number {
|
||||||
|
const script = this.collection.getScript(scriptId);
|
||||||
|
const selectedScript = new UserSelectedScript(script, revert);
|
||||||
|
if (!this.scripts.exists(selectedScript.id)) {
|
||||||
|
this.scripts.addItem(selectedScript);
|
||||||
|
return 1;
|
||||||
|
}
|
||||||
|
const existingSelectedScript = this.scripts.getById(selectedScript.id);
|
||||||
|
if (equals(selectedScript, existingSelectedScript)) {
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
this.scripts.addOrUpdateItem(selectedScript);
|
||||||
|
return 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
private removeScript(scriptId: string): number {
|
||||||
|
if (!this.scripts.exists(scriptId)) {
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
this.scripts.removeItem(scriptId);
|
||||||
|
return 1;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function getScriptIdsToBeSelected(
|
||||||
|
existingItems: ReadonlyRepository<string, SelectedScript>,
|
||||||
|
desiredScripts: readonly IScript[],
|
||||||
|
): string[] {
|
||||||
|
return desiredScripts
|
||||||
|
.filter((script) => !existingItems.exists(script.id))
|
||||||
|
.map((script) => script.id);
|
||||||
|
}
|
||||||
|
|
||||||
|
function getScriptIdsToBeDeselected(
|
||||||
|
existingItems: ReadonlyRepository<string, SelectedScript>,
|
||||||
|
desiredScripts: readonly IScript[],
|
||||||
|
): string[] {
|
||||||
|
return existingItems
|
||||||
|
.getItems()
|
||||||
|
.filter((existing) => !desiredScripts.some((script) => existing.id === script.id))
|
||||||
|
.map((script) => script.id);
|
||||||
|
}
|
||||||
|
|
||||||
|
function equals(a: SelectedScript, b: SelectedScript): boolean {
|
||||||
|
return a.script.equals(b.script.id) && a.revert === b.revert;
|
||||||
|
}
|
||||||
@@ -0,0 +1,17 @@
|
|||||||
|
import { IEventSource } from '@/infrastructure/Events/IEventSource';
|
||||||
|
import { IScript } from '@/domain/IScript';
|
||||||
|
import { SelectedScript } from './SelectedScript';
|
||||||
|
import { ScriptSelectionChangeCommand } from './ScriptSelectionChange';
|
||||||
|
|
||||||
|
export interface ReadonlyScriptSelection {
|
||||||
|
readonly changed: IEventSource<readonly SelectedScript[]>;
|
||||||
|
readonly selectedScripts: readonly SelectedScript[];
|
||||||
|
isSelected(scriptId: string): boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ScriptSelection extends ReadonlyScriptSelection {
|
||||||
|
selectOnly(scripts: readonly IScript[]): void;
|
||||||
|
selectAll(): void;
|
||||||
|
deselectAll(): void;
|
||||||
|
processChanges(action: ScriptSelectionChangeCommand): void;
|
||||||
|
}
|
||||||
@@ -0,0 +1,15 @@
|
|||||||
|
export type ScriptSelectionStatus = {
|
||||||
|
readonly isSelected: true;
|
||||||
|
readonly isReverted: boolean;
|
||||||
|
} | {
|
||||||
|
readonly isSelected: false;
|
||||||
|
};
|
||||||
|
|
||||||
|
export interface ScriptSelectionChange {
|
||||||
|
readonly scriptId: string;
|
||||||
|
readonly newStatus: ScriptSelectionStatus;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ScriptSelectionChangeCommand {
|
||||||
|
readonly changes: ReadonlyArray<ScriptSelectionChange>;
|
||||||
|
}
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
import { IEntity } from '@/infrastructure/Entity/IEntity';
|
||||||
|
import { IScript } from '@/domain/IScript';
|
||||||
|
|
||||||
|
type ScriptId = IScript['id'];
|
||||||
|
|
||||||
|
export interface SelectedScript extends IEntity<ScriptId> {
|
||||||
|
readonly script: IScript;
|
||||||
|
readonly revert: boolean;
|
||||||
|
}
|
||||||
@@ -1,14 +1,17 @@
|
|||||||
import { BaseEntity } from '@/infrastructure/Entity/BaseEntity';
|
import { BaseEntity } from '@/infrastructure/Entity/BaseEntity';
|
||||||
import { IScript } from '@/domain/IScript';
|
import { IScript } from '@/domain/IScript';
|
||||||
|
import { SelectedScript } from './SelectedScript';
|
||||||
|
|
||||||
export class SelectedScript extends BaseEntity<string> {
|
type SelectedScriptId = SelectedScript['id'];
|
||||||
|
|
||||||
|
export class UserSelectedScript extends BaseEntity<SelectedScriptId> {
|
||||||
constructor(
|
constructor(
|
||||||
public readonly script: IScript,
|
public readonly script: IScript,
|
||||||
public readonly revert: boolean,
|
public readonly revert: boolean,
|
||||||
) {
|
) {
|
||||||
super(script.id);
|
super(script.id);
|
||||||
if (revert && !script.canRevert()) {
|
if (revert && !script.canRevert()) {
|
||||||
throw new Error('cannot revert an irreversible script');
|
throw new Error(`The script with ID '${script.id}' is not reversible and cannot be reverted.`);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -1,167 +1,12 @@
|
|||||||
import { InMemoryRepository } from '@/infrastructure/Repository/InMemoryRepository';
|
import { CategorySelection, ReadonlyCategorySelection } from './Category/CategorySelection';
|
||||||
import { IScript } from '@/domain/IScript';
|
import { ReadonlyScriptSelection, ScriptSelection } from './Script/ScriptSelection';
|
||||||
import { EventSource } from '@/infrastructure/Events/EventSource';
|
|
||||||
import { IRepository } from '@/infrastructure/Repository/IRepository';
|
|
||||||
import { ICategory } from '@/domain/ICategory';
|
|
||||||
import { ICategoryCollection } from '@/domain/ICategoryCollection';
|
|
||||||
import { IUserSelection } from './IUserSelection';
|
|
||||||
import { SelectedScript } from './SelectedScript';
|
|
||||||
|
|
||||||
export class UserSelection implements IUserSelection {
|
export interface ReadonlyUserSelection {
|
||||||
public readonly changed = new EventSource<ReadonlyArray<SelectedScript>>();
|
readonly categories: ReadonlyCategorySelection;
|
||||||
|
readonly scripts: ReadonlyScriptSelection;
|
||||||
private readonly scripts: IRepository<string, SelectedScript>;
|
}
|
||||||
|
|
||||||
constructor(
|
export interface UserSelection extends ReadonlyUserSelection {
|
||||||
private readonly collection: ICategoryCollection,
|
readonly categories: CategorySelection;
|
||||||
selectedScripts: ReadonlyArray<SelectedScript>,
|
readonly scripts: ScriptSelection;
|
||||||
) {
|
|
||||||
this.scripts = new InMemoryRepository<string, SelectedScript>();
|
|
||||||
for (const script of selectedScripts) {
|
|
||||||
this.scripts.addItem(script);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
public areAllSelected(category: ICategory): boolean {
|
|
||||||
if (this.selectedScripts.length === 0) {
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
const scripts = category.getAllScriptsRecursively();
|
|
||||||
if (this.selectedScripts.length < scripts.length) {
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
return scripts.every(
|
|
||||||
(script) => this.selectedScripts.some((selected) => selected.id === script.id),
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
public isAnySelected(category: ICategory): boolean {
|
|
||||||
if (this.selectedScripts.length === 0) {
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
return this.selectedScripts.some((s) => category.includes(s.script));
|
|
||||||
}
|
|
||||||
|
|
||||||
public removeAllInCategory(categoryId: number): void {
|
|
||||||
const category = this.collection.findCategory(categoryId);
|
|
||||||
const scriptsToRemove = category.getAllScriptsRecursively()
|
|
||||||
.filter((script) => this.scripts.exists(script.id));
|
|
||||||
if (!scriptsToRemove.length) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
for (const script of scriptsToRemove) {
|
|
||||||
this.scripts.removeItem(script.id);
|
|
||||||
}
|
|
||||||
this.changed.notify(this.scripts.getItems());
|
|
||||||
}
|
|
||||||
|
|
||||||
public addOrUpdateAllInCategory(categoryId: number, revert = false): void {
|
|
||||||
const scriptsToAddOrUpdate = this.collection
|
|
||||||
.findCategory(categoryId)
|
|
||||||
.getAllScriptsRecursively()
|
|
||||||
.filter(
|
|
||||||
(script) => !this.scripts.exists(script.id)
|
|
||||||
|| this.scripts.getById(script.id).revert !== revert,
|
|
||||||
)
|
|
||||||
.map((script) => new SelectedScript(script, revert));
|
|
||||||
if (!scriptsToAddOrUpdate.length) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
for (const script of scriptsToAddOrUpdate) {
|
|
||||||
this.scripts.addOrUpdateItem(script);
|
|
||||||
}
|
|
||||||
this.changed.notify(this.scripts.getItems());
|
|
||||||
}
|
|
||||||
|
|
||||||
public addSelectedScript(scriptId: string, revert: boolean): void {
|
|
||||||
const script = this.collection.findScript(scriptId);
|
|
||||||
if (!script) {
|
|
||||||
throw new Error(`Cannot add (id: ${scriptId}) as it is unknown`);
|
|
||||||
}
|
|
||||||
const selectedScript = new SelectedScript(script, revert);
|
|
||||||
this.scripts.addItem(selectedScript);
|
|
||||||
this.changed.notify(this.scripts.getItems());
|
|
||||||
}
|
|
||||||
|
|
||||||
public addOrUpdateSelectedScript(scriptId: string, revert: boolean): void {
|
|
||||||
const script = this.collection.findScript(scriptId);
|
|
||||||
const selectedScript = new SelectedScript(script, revert);
|
|
||||||
this.scripts.addOrUpdateItem(selectedScript);
|
|
||||||
this.changed.notify(this.scripts.getItems());
|
|
||||||
}
|
|
||||||
|
|
||||||
public removeSelectedScript(scriptId: string): void {
|
|
||||||
this.scripts.removeItem(scriptId);
|
|
||||||
this.changed.notify(this.scripts.getItems());
|
|
||||||
}
|
|
||||||
|
|
||||||
public isSelected(scriptId: string): boolean {
|
|
||||||
return this.scripts.exists(scriptId);
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Get users scripts based on his/her selections */
|
|
||||||
public get selectedScripts(): ReadonlyArray<SelectedScript> {
|
|
||||||
return this.scripts.getItems();
|
|
||||||
}
|
|
||||||
|
|
||||||
public selectAll(): void {
|
|
||||||
const scriptsToSelect = this.collection
|
|
||||||
.getAllScripts()
|
|
||||||
.filter((script) => !this.scripts.exists(script.id))
|
|
||||||
.map((script) => new SelectedScript(script, false));
|
|
||||||
if (scriptsToSelect.length === 0) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
for (const script of scriptsToSelect) {
|
|
||||||
this.scripts.addItem(script);
|
|
||||||
}
|
|
||||||
this.changed.notify(this.scripts.getItems());
|
|
||||||
}
|
|
||||||
|
|
||||||
public deselectAll(): void {
|
|
||||||
if (this.scripts.length === 0) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
const selectedScriptIds = this.scripts.getItems().map((script) => script.id);
|
|
||||||
for (const scriptId of selectedScriptIds) {
|
|
||||||
this.scripts.removeItem(scriptId);
|
|
||||||
}
|
|
||||||
this.changed.notify([]);
|
|
||||||
}
|
|
||||||
|
|
||||||
public selectOnly(scripts: readonly IScript[]): void {
|
|
||||||
if (!scripts || scripts.length === 0) {
|
|
||||||
throw new Error('Scripts are empty. Use deselectAll() if you want to deselect everything');
|
|
||||||
}
|
|
||||||
let totalChanged = 0;
|
|
||||||
totalChanged += this.unselectMissingWithoutNotifying(scripts);
|
|
||||||
totalChanged += this.selectNewWithoutNotifying(scripts);
|
|
||||||
if (totalChanged > 0) {
|
|
||||||
this.changed.notify(this.scripts.getItems());
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
private unselectMissingWithoutNotifying(scripts: readonly IScript[]): number {
|
|
||||||
if (this.scripts.length === 0 || scripts.length === 0) {
|
|
||||||
return 0;
|
|
||||||
}
|
|
||||||
const existingItems = this.scripts.getItems();
|
|
||||||
const missingIds = existingItems
|
|
||||||
.filter((existing) => !scripts.some((script) => existing.id === script.id))
|
|
||||||
.map((script) => script.id);
|
|
||||||
for (const id of missingIds) {
|
|
||||||
this.scripts.removeItem(id);
|
|
||||||
}
|
|
||||||
return missingIds.length;
|
|
||||||
}
|
|
||||||
|
|
||||||
private selectNewWithoutNotifying(scripts: readonly IScript[]): number {
|
|
||||||
const unselectedScripts = scripts
|
|
||||||
.filter((script) => !this.scripts.exists(script.id))
|
|
||||||
.map((script) => new SelectedScript(script, false));
|
|
||||||
for (const newScript of unselectedScripts) {
|
|
||||||
this.scripts.addItem(newScript);
|
|
||||||
}
|
|
||||||
return unselectedScripts.length;
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,39 @@
|
|||||||
|
import { ICategoryCollection } from '@/domain/ICategoryCollection';
|
||||||
|
import { CategorySelection } from './Category/CategorySelection';
|
||||||
|
import { ScriptToCategorySelectionMapper } from './Category/ScriptToCategorySelectionMapper';
|
||||||
|
import { DebouncedScriptSelection } from './Script/DebouncedScriptSelection';
|
||||||
|
import { ScriptSelection } from './Script/ScriptSelection';
|
||||||
|
import { UserSelection } from './UserSelection';
|
||||||
|
import { SelectedScript } from './Script/SelectedScript';
|
||||||
|
|
||||||
|
export class UserSelectionFacade implements UserSelection {
|
||||||
|
public readonly categories: CategorySelection;
|
||||||
|
|
||||||
|
public readonly scripts: ScriptSelection;
|
||||||
|
|
||||||
|
constructor(
|
||||||
|
collection: ICategoryCollection,
|
||||||
|
selectedScripts: readonly SelectedScript[],
|
||||||
|
scriptsFactory = DefaultScriptsFactory,
|
||||||
|
categoriesFactory = DefaultCategoriesFactory,
|
||||||
|
) {
|
||||||
|
this.scripts = scriptsFactory(collection, selectedScripts);
|
||||||
|
this.categories = categoriesFactory(this.scripts, collection);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export type ScriptsFactory = (
|
||||||
|
...params: ConstructorParameters<typeof DebouncedScriptSelection>
|
||||||
|
) => ScriptSelection;
|
||||||
|
|
||||||
|
const DefaultScriptsFactory: ScriptsFactory = (
|
||||||
|
...params
|
||||||
|
) => new DebouncedScriptSelection(...params);
|
||||||
|
|
||||||
|
export type CategoriesFactory = (
|
||||||
|
...params: ConstructorParameters<typeof ScriptToCategorySelectionMapper>
|
||||||
|
) => CategorySelection;
|
||||||
|
|
||||||
|
const DefaultCategoriesFactory: CategoriesFactory = (
|
||||||
|
...params
|
||||||
|
) => new ScriptToCategorySelectionMapper(...params);
|
||||||
@@ -7,14 +7,14 @@ import MacOsData from '@/application/collections/macos.yaml';
|
|||||||
import LinuxData from '@/application/collections/linux.yaml';
|
import LinuxData from '@/application/collections/linux.yaml';
|
||||||
import { parseProjectInformation } from '@/application/Parser/ProjectInformationParser';
|
import { parseProjectInformation } from '@/application/Parser/ProjectInformationParser';
|
||||||
import { Application } from '@/domain/Application';
|
import { Application } from '@/domain/Application';
|
||||||
import { IAppMetadata } from '@/infrastructure/Metadata/IAppMetadata';
|
import { IAppMetadata } from '@/infrastructure/EnvironmentVariables/IAppMetadata';
|
||||||
import { AppMetadataFactory } from '@/infrastructure/Metadata/AppMetadataFactory';
|
import { EnvironmentVariablesFactory } from '@/infrastructure/EnvironmentVariables/EnvironmentVariablesFactory';
|
||||||
import { parseCategoryCollection } from './CategoryCollectionParser';
|
import { parseCategoryCollection } from './CategoryCollectionParser';
|
||||||
|
|
||||||
export function parseApplication(
|
export function parseApplication(
|
||||||
categoryParser = parseCategoryCollection,
|
categoryParser = parseCategoryCollection,
|
||||||
informationParser = parseProjectInformation,
|
informationParser = parseProjectInformation,
|
||||||
metadata: IAppMetadata = AppMetadataFactory.Current.instance,
|
metadata: IAppMetadata = EnvironmentVariablesFactory.Current.instance,
|
||||||
collectionsData = PreParsedCollections,
|
collectionsData = PreParsedCollections,
|
||||||
): IApplication {
|
): IApplication {
|
||||||
validateCollectionsData(collectionsData);
|
validateCollectionsData(collectionsData);
|
||||||
@@ -32,10 +32,7 @@ const PreParsedCollections: readonly CollectionData [] = [
|
|||||||
];
|
];
|
||||||
|
|
||||||
function validateCollectionsData(collections: readonly CollectionData[]) {
|
function validateCollectionsData(collections: readonly CollectionData[]) {
|
||||||
if (!collections?.length) {
|
if (!collections.length) {
|
||||||
throw new Error('missing collections');
|
throw new Error('missing collections');
|
||||||
}
|
}
|
||||||
if (collections.some((collection) => !collection)) {
|
|
||||||
throw new Error('missing collection provided');
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -28,10 +28,7 @@ export function parseCategoryCollection(
|
|||||||
}
|
}
|
||||||
|
|
||||||
function validate(content: CollectionData): void {
|
function validate(content: CollectionData): void {
|
||||||
if (!content) {
|
if (!content.actions.length) {
|
||||||
throw new Error('missing content');
|
|
||||||
}
|
|
||||||
if (!content.actions || content.actions.length <= 0) {
|
|
||||||
throw new Error('content does not define any action');
|
throw new Error('content does not define any action');
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
import type {
|
import type {
|
||||||
CategoryData, ScriptData, CategoryOrScriptData, InstructionHolder,
|
CategoryData, ScriptData, CategoryOrScriptData,
|
||||||
} from '@/application/collections/';
|
} from '@/application/collections/';
|
||||||
import { Script } from '@/domain/Script';
|
import { Script } from '@/domain/Script';
|
||||||
import { Category } from '@/domain/Category';
|
import { Category } from '@/domain/Category';
|
||||||
@@ -16,7 +16,6 @@ export function parseCategory(
|
|||||||
context: ICategoryCollectionParseContext,
|
context: ICategoryCollectionParseContext,
|
||||||
factory: CategoryFactoryType = CategoryFactory,
|
factory: CategoryFactoryType = CategoryFactory,
|
||||||
): Category {
|
): Category {
|
||||||
if (!context) { throw new Error('missing context'); }
|
|
||||||
return parseCategoryRecursively({
|
return parseCategoryRecursively({
|
||||||
categoryData: category,
|
categoryData: category,
|
||||||
context,
|
context,
|
||||||
@@ -30,8 +29,8 @@ interface ICategoryParseContext {
|
|||||||
readonly factory: CategoryFactoryType,
|
readonly factory: CategoryFactoryType,
|
||||||
readonly parentCategory?: CategoryData,
|
readonly parentCategory?: CategoryData,
|
||||||
}
|
}
|
||||||
// eslint-disable-next-line consistent-return
|
|
||||||
function parseCategoryRecursively(context: ICategoryParseContext): Category {
|
function parseCategoryRecursively(context: ICategoryParseContext): Category | never {
|
||||||
ensureValidCategory(context.categoryData, context.parentCategory);
|
ensureValidCategory(context.categoryData, context.parentCategory);
|
||||||
const children: ICategoryChildren = {
|
const children: ICategoryChildren = {
|
||||||
subCategories: new Array<Category>(),
|
subCategories: new Array<Category>(),
|
||||||
@@ -55,7 +54,7 @@ function parseCategoryRecursively(context: ICategoryParseContext): Category {
|
|||||||
/* scripts: */ children.subScripts,
|
/* scripts: */ children.subScripts,
|
||||||
);
|
);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
new NodeValidator({
|
return new NodeValidator({
|
||||||
type: NodeType.Category,
|
type: NodeType.Category,
|
||||||
selfNode: context.categoryData,
|
selfNode: context.categoryData,
|
||||||
parentNode: context.parentCategory,
|
parentNode: context.parentCategory,
|
||||||
@@ -72,7 +71,7 @@ function ensureValidCategory(category: CategoryData, parentCategory?: CategoryDa
|
|||||||
.assertDefined(category)
|
.assertDefined(category)
|
||||||
.assertValidName(category.category)
|
.assertValidName(category.category)
|
||||||
.assert(
|
.assert(
|
||||||
() => category.children && category.children.length > 0,
|
() => category.children.length > 0,
|
||||||
`"${category.category}" has no children.`,
|
`"${category.category}" has no children.`,
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
@@ -94,14 +93,14 @@ function parseNode(context: INodeParseContext) {
|
|||||||
validator.assertDefined(context.nodeData);
|
validator.assertDefined(context.nodeData);
|
||||||
if (isCategory(context.nodeData)) {
|
if (isCategory(context.nodeData)) {
|
||||||
const subCategory = parseCategoryRecursively({
|
const subCategory = parseCategoryRecursively({
|
||||||
categoryData: context.nodeData as CategoryData,
|
categoryData: context.nodeData,
|
||||||
context: context.context,
|
context: context.context,
|
||||||
factory: context.factory,
|
factory: context.factory,
|
||||||
parentCategory: context.parent,
|
parentCategory: context.parent,
|
||||||
});
|
});
|
||||||
context.children.subCategories.push(subCategory);
|
context.children.subCategories.push(subCategory);
|
||||||
} else if (isScript(context.nodeData)) {
|
} else if (isScript(context.nodeData)) {
|
||||||
const script = parseScript(context.nodeData as ScriptData, context.context);
|
const script = parseScript(context.nodeData, context.context);
|
||||||
context.children.subScripts.push(script);
|
context.children.subScripts.push(script);
|
||||||
} else {
|
} else {
|
||||||
validator.throw('Node is neither a category or a script.');
|
validator.throw('Node is neither a category or a script.');
|
||||||
@@ -109,19 +108,18 @@ function parseNode(context: INodeParseContext) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
function isScript(data: CategoryOrScriptData): data is ScriptData {
|
function isScript(data: CategoryOrScriptData): data is ScriptData {
|
||||||
const holder = (data as InstructionHolder);
|
return hasCode(data) || hasCall(data);
|
||||||
return hasCode(holder) || hasCall(holder);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
function isCategory(data: CategoryOrScriptData): data is CategoryData {
|
function isCategory(data: CategoryOrScriptData): data is CategoryData {
|
||||||
return hasProperty(data, 'category');
|
return hasProperty(data, 'category');
|
||||||
}
|
}
|
||||||
|
|
||||||
function hasCode(data: InstructionHolder): boolean {
|
function hasCode(data: unknown): boolean {
|
||||||
return hasProperty(data, 'code');
|
return hasProperty(data, 'code');
|
||||||
}
|
}
|
||||||
|
|
||||||
function hasCall(data: InstructionHolder) {
|
function hasCall(data: unknown) {
|
||||||
return hasProperty(data, 'call');
|
return hasProperty(data, 'call');
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -1,9 +1,6 @@
|
|||||||
import type { DocumentableData, DocumentationData } from '@/application/collections/';
|
import type { DocumentableData, DocumentationData } from '@/application/collections/';
|
||||||
|
|
||||||
export function parseDocs(documentable: DocumentableData): readonly string[] {
|
export function parseDocs(documentable: DocumentableData): readonly string[] {
|
||||||
if (!documentable) {
|
|
||||||
throw new Error('missing documentable');
|
|
||||||
}
|
|
||||||
const { docs } = documentable;
|
const { docs } = documentable;
|
||||||
if (!docs) {
|
if (!docs) {
|
||||||
return [];
|
return [];
|
||||||
|
|||||||
@@ -32,7 +32,7 @@ export class NodeValidator {
|
|||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
|
|
||||||
public throw(errorMessage: string) {
|
public throw(errorMessage: string): never {
|
||||||
throw new NodeDataError(errorMessage, this.context);
|
throw new NodeDataError(errorMessage, this.context);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,13 +1,13 @@
|
|||||||
import { IProjectInformation } from '@/domain/IProjectInformation';
|
import { IProjectInformation } from '@/domain/IProjectInformation';
|
||||||
import { ProjectInformation } from '@/domain/ProjectInformation';
|
import { ProjectInformation } from '@/domain/ProjectInformation';
|
||||||
import { IAppMetadata } from '@/infrastructure/Metadata/IAppMetadata';
|
import { IAppMetadata } from '@/infrastructure/EnvironmentVariables/IAppMetadata';
|
||||||
import { Version } from '@/domain/Version';
|
import { Version } from '@/domain/Version';
|
||||||
import { AppMetadataFactory } from '@/infrastructure/Metadata/AppMetadataFactory';
|
import { EnvironmentVariablesFactory } from '@/infrastructure/EnvironmentVariables/EnvironmentVariablesFactory';
|
||||||
import { ConstructorArguments } from '@/TypeHelpers';
|
import { ConstructorArguments } from '@/TypeHelpers';
|
||||||
|
|
||||||
export function
|
export function
|
||||||
parseProjectInformation(
|
parseProjectInformation(
|
||||||
metadata: IAppMetadata = AppMetadataFactory.Current.instance,
|
metadata: IAppMetadata = EnvironmentVariablesFactory.Current.instance,
|
||||||
createProjectInformation: ProjectInformationFactory = (
|
createProjectInformation: ProjectInformationFactory = (
|
||||||
...args
|
...args
|
||||||
) => new ProjectInformation(...args),
|
) => new ProjectInformation(...args),
|
||||||
|
|||||||
@@ -17,8 +17,7 @@ export class CategoryCollectionParseContext implements ICategoryCollectionParseC
|
|||||||
scripting: IScriptingDefinition,
|
scripting: IScriptingDefinition,
|
||||||
syntaxFactory: ISyntaxFactory = new SyntaxFactory(),
|
syntaxFactory: ISyntaxFactory = new SyntaxFactory(),
|
||||||
) {
|
) {
|
||||||
if (!scripting) { throw new Error('missing scripting'); }
|
|
||||||
this.syntax = syntaxFactory.create(scripting.language);
|
this.syntax = syntaxFactory.create(scripting.language);
|
||||||
this.compiler = new ScriptCompiler(functionsData, this.syntax);
|
this.compiler = new ScriptCompiler(functionsData ?? [], this.syntax);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -15,19 +15,10 @@ export class Expression implements IExpression {
|
|||||||
public readonly evaluator: ExpressionEvaluator,
|
public readonly evaluator: ExpressionEvaluator,
|
||||||
parameters?: IReadOnlyFunctionParameterCollection,
|
parameters?: IReadOnlyFunctionParameterCollection,
|
||||||
) {
|
) {
|
||||||
if (!position) {
|
|
||||||
throw new Error('missing position');
|
|
||||||
}
|
|
||||||
if (!evaluator) {
|
|
||||||
throw new Error('missing evaluator');
|
|
||||||
}
|
|
||||||
this.parameters = parameters ?? new FunctionParameterCollection();
|
this.parameters = parameters ?? new FunctionParameterCollection();
|
||||||
}
|
}
|
||||||
|
|
||||||
public evaluate(context: IExpressionEvaluationContext): string {
|
public evaluate(context: IExpressionEvaluationContext): string {
|
||||||
if (!context) {
|
|
||||||
throw new Error('missing context');
|
|
||||||
}
|
|
||||||
validateThatAllRequiredParametersAreSatisfied(this.parameters, context.args);
|
validateThatAllRequiredParametersAreSatisfied(this.parameters, context.args);
|
||||||
const args = filterUnusedArguments(this.parameters, context.args);
|
const args = filterUnusedArguments(this.parameters, context.args);
|
||||||
const filteredContext = new ExpressionEvaluationContext(args, context.pipelineCompiler);
|
const filteredContext = new ExpressionEvaluationContext(args, context.pipelineCompiler);
|
||||||
|
|||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user