Compare commits
1 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
d49d5c81c1 |
1
.eslintignore
Normal file
1
.eslintignore
Normal file
@@ -0,0 +1 @@
|
|||||||
|
dist/
|
||||||
@@ -6,10 +6,10 @@ module.exports = {
|
|||||||
root: true,
|
root: true,
|
||||||
env: {
|
env: {
|
||||||
node: true,
|
node: true,
|
||||||
es2022: true, // add globals and sets parserOptions.ecmaVersion to 2022
|
|
||||||
},
|
},
|
||||||
extends: [
|
extends: [
|
||||||
// Vue specific rules, eslint-plugin-vue
|
// Vue specific rules, eslint-plugin-vue
|
||||||
|
// Added by Vue CLI
|
||||||
'plugin:vue/essential',
|
'plugin:vue/essential',
|
||||||
|
|
||||||
// Extends eslint-config-airbnb
|
// Extends eslint-config-airbnb
|
||||||
@@ -17,14 +17,42 @@ module.exports = {
|
|||||||
|
|
||||||
// Extends @typescript-eslint/recommended
|
// Extends @typescript-eslint/recommended
|
||||||
// Uses the recommended rules from the @typescript-eslint/eslint-plugin
|
// Uses the recommended rules from the @typescript-eslint/eslint-plugin
|
||||||
|
// Added by Vue CLI
|
||||||
'@vue/typescript/recommended',
|
'@vue/typescript/recommended',
|
||||||
],
|
],
|
||||||
|
parserOptions: {
|
||||||
|
ecmaVersion: 12, // ECMA 2021
|
||||||
|
/*
|
||||||
|
Having 'latest' leads to:
|
||||||
|
```
|
||||||
|
Parsing error: ecmaVersion must be a number. Received value of type string instead
|
||||||
|
```
|
||||||
|
For .js files in the project
|
||||||
|
*/
|
||||||
|
},
|
||||||
rules: {
|
rules: {
|
||||||
...getOwnRules(),
|
...getOwnRules(),
|
||||||
...getTurnedOffBrokenRules(),
|
...getTurnedOffBrokenRules(),
|
||||||
...getOpinionatedRuleOverrides(),
|
...getOpinionatedRuleOverrides(),
|
||||||
...getTodoRules(),
|
...getTodoRules(),
|
||||||
},
|
},
|
||||||
|
overrides: [
|
||||||
|
{
|
||||||
|
files: [
|
||||||
|
'**/__tests__/*.{j,t}s?(x)',
|
||||||
|
'**/tests/unit/**/*.spec.{j,t}s?(x)',
|
||||||
|
],
|
||||||
|
env: {
|
||||||
|
mocha: true,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
files: ['**/tests/**/*.{j,t}s?(x)'],
|
||||||
|
rules: {
|
||||||
|
'no-console': 'off',
|
||||||
|
},
|
||||||
|
},
|
||||||
|
],
|
||||||
};
|
};
|
||||||
|
|
||||||
function getOwnRules() {
|
function getOwnRules() {
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
inputs:
|
|
||||||
working-directory:
|
|
||||||
required: false
|
|
||||||
default: '.'
|
|
||||||
runs:
|
|
||||||
using: composite
|
|
||||||
steps:
|
|
||||||
-
|
|
||||||
name: Run `npm ci` with retries
|
|
||||||
shell: bash
|
|
||||||
run: npm run install-deps -- --ci --root-directory "${{ inputs.working-directory }}"
|
|
||||||
57
.github/workflows/checks.build.yaml
vendored
57
.github/workflows/checks.build.yaml
vendored
@@ -9,13 +9,7 @@ jobs:
|
|||||||
strategy:
|
strategy:
|
||||||
matrix:
|
matrix:
|
||||||
os: [ macos, ubuntu, windows ]
|
os: [ macos, ubuntu, windows ]
|
||||||
mode: [
|
mode: [ development, test, production ]
|
||||||
# Vite mode: https://vitejs.dev/guide/env-and-mode.html
|
|
||||||
development, # Used by `dev` command
|
|
||||||
production, # Used by `build` command
|
|
||||||
# Vitest mode: https://vitest.dev/guide/cli.html
|
|
||||||
test, # Used by Vitest
|
|
||||||
]
|
|
||||||
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:
|
||||||
@@ -27,23 +21,17 @@ jobs:
|
|||||||
uses: ./.github/actions/setup-node
|
uses: ./.github/actions/setup-node
|
||||||
-
|
-
|
||||||
name: Install dependencies
|
name: Install dependencies
|
||||||
uses: ./.github/actions/npm-install-dependencies
|
run: npm ci
|
||||||
-
|
-
|
||||||
name: Build web
|
name: Build
|
||||||
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
|
|
||||||
|
|
||||||
|
# A new job is used due to environments/modes different from Vue CLI, https://github.com/nklayman/vue-cli-plugin-electron-builder/issues/1626
|
||||||
build-desktop:
|
build-desktop:
|
||||||
strategy:
|
strategy:
|
||||||
matrix:
|
matrix:
|
||||||
os: [ macos, ubuntu, windows ]
|
os: [ macos, ubuntu, windows ]
|
||||||
mode: [
|
mode: [ development, production ] # "test" is not supported https://github.com/nklayman/vue-cli-plugin-electron-builder/issues/1627
|
||||||
# electron-vite modes: https://electron-vite.org/guide/env-and-mode.html#global-env-variables
|
|
||||||
development, # Used by `dev` command
|
|
||||||
production, # Used by `build` and `preview` commands
|
|
||||||
]
|
|
||||||
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:
|
||||||
@@ -55,16 +43,33 @@ jobs:
|
|||||||
uses: ./.github/actions/setup-node
|
uses: ./.github/actions/setup-node
|
||||||
-
|
-
|
||||||
name: Install dependencies
|
name: Install dependencies
|
||||||
uses: ./.github/actions/npm-install-dependencies
|
run: npm ci
|
||||||
-
|
-
|
||||||
name: Prebuild desktop
|
name: Install cross-env
|
||||||
run: npm run electron:prebuild -- --mode ${{ matrix.mode }}
|
# Used to set NODE_ENV due to https://github.com/nklayman/vue-cli-plugin-electron-builder/issues/1626
|
||||||
|
run: npm install --global cross-env
|
||||||
-
|
-
|
||||||
name: Verify unbundled desktop build artifacts
|
name: Build
|
||||||
run: npm run check:verify-build-artifacts -- --electron-unbundled
|
run: |-
|
||||||
|
cross-env-shell NODE_ENV=${{ matrix.mode }}
|
||||||
|
npm run electron:build -- --publish never --mode ${{ matrix.mode }}
|
||||||
|
|
||||||
|
create-icons:
|
||||||
|
strategy:
|
||||||
|
matrix:
|
||||||
|
os: [ macos, ubuntu, windows ]
|
||||||
|
fail-fast: false # Allows to see results from other combinations
|
||||||
|
runs-on: ${{ matrix.os }}-latest
|
||||||
|
steps:
|
||||||
-
|
-
|
||||||
name: Build (bundle and package) desktop application
|
name: Checkout
|
||||||
run: npm run electron:build -- --publish never
|
uses: actions/checkout@v2
|
||||||
-
|
-
|
||||||
name: Verify bundled desktop build artifacts
|
name: Setup node
|
||||||
run: npm run check:verify-build-artifacts -- --electron-bundled
|
uses: ./.github/actions/setup-node
|
||||||
|
-
|
||||||
|
name: Install dependencies
|
||||||
|
run: npm ci
|
||||||
|
-
|
||||||
|
name: Create icons
|
||||||
|
run: npm run create-icons
|
||||||
|
|||||||
@@ -1,72 +0,0 @@
|
|||||||
name: checks.desktop-runtime-errors
|
|
||||||
# Verifies desktop builds for Electron applications across multiple OS platforms (macOS ,Ubuntu, and Windows).
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
pull_request:
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
run-check:
|
|
||||||
strategy:
|
|
||||||
matrix:
|
|
||||||
os: [ macos, ubuntu, windows ]
|
|
||||||
fail-fast: false # Allows to see results from other combinations
|
|
||||||
runs-on: ${{ matrix.os }}-latest
|
|
||||||
steps:
|
|
||||||
-
|
|
||||||
name: Checkout
|
|
||||||
uses: actions/checkout@v2
|
|
||||||
-
|
|
||||||
name: Setup node
|
|
||||||
uses: ./.github/actions/setup-node
|
|
||||||
-
|
|
||||||
name: Install dependencies
|
|
||||||
uses: ./.github/actions/npm-install-dependencies
|
|
||||||
-
|
|
||||||
name: Configure Ubuntu
|
|
||||||
if: matrix.os == 'ubuntu'
|
|
||||||
shell: bash
|
|
||||||
run: |-
|
|
||||||
sudo apt update
|
|
||||||
|
|
||||||
# Configure AppImage dependencies
|
|
||||||
sudo apt install -y libfuse2
|
|
||||||
|
|
||||||
# Configure DBUS (fixes `Failed to connect to the bus: Could not parse server address: Unknown address type`)
|
|
||||||
if ! command -v 'dbus-launch' &> /dev/null; then
|
|
||||||
echo 'DBUS does not exist, installing...'
|
|
||||||
sudo apt install -y dbus-x11 # Gives both dbus and dbus-launch utility
|
|
||||||
fi
|
|
||||||
sudo systemctl start dbus
|
|
||||||
DBUS_LAUNCH_OUTPUT=$(dbus-launch)
|
|
||||||
if [ $? -eq 0 ]; then
|
|
||||||
echo "${DBUS_LAUNCH_OUTPUT}" >> $GITHUB_ENV
|
|
||||||
else
|
|
||||||
echo 'Error: dbus-launch command did not execute successfully. Exiting.' >&2
|
|
||||||
echo "${DBUS_LAUNCH_OUTPUT}" >&2
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Configure fake (virtual) display
|
|
||||||
sudo apt install -y xvfb
|
|
||||||
sudo Xvfb :99 -screen 0 1024x768x24 > /dev/null 2>&1 &
|
|
||||||
echo "DISPLAY=:99" >> $GITHUB_ENV
|
|
||||||
|
|
||||||
# Install ImageMagick for screenshots
|
|
||||||
sudo apt install -y imagemagick
|
|
||||||
|
|
||||||
# Install xdotool and xprop (from x11-utils) for window title capturing
|
|
||||||
sudo apt install -y xdotool x11-utils
|
|
||||||
-
|
|
||||||
name: Test
|
|
||||||
shell: bash
|
|
||||||
run: |-
|
|
||||||
export SCREENSHOT=true
|
|
||||||
npm run check:desktop
|
|
||||||
-
|
|
||||||
name: Upload screenshot
|
|
||||||
if: always() # Run even if previous step fails
|
|
||||||
uses: actions/upload-artifact@v3
|
|
||||||
with:
|
|
||||||
name: screenshot-${{ matrix.os }}
|
|
||||||
path: screenshot.png
|
|
||||||
22
.github/workflows/checks.external-urls.yaml
vendored
22
.github/workflows/checks.external-urls.yaml
vendored
@@ -1,22 +0,0 @@
|
|||||||
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@v2
|
|
||||||
-
|
|
||||||
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
|
|
||||||
14
.github/workflows/checks.quality.yaml
vendored
14
.github/workflows/checks.quality.yaml
vendored
@@ -16,15 +16,11 @@ 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
|
||||||
name: Checkout
|
|
||||||
uses: actions/checkout@v2
|
uses: actions/checkout@v2
|
||||||
-
|
- 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: Lint
|
||||||
-
|
|
||||||
name: Lint
|
|
||||||
run: ${{ matrix.lint-command }}
|
run: ${{ matrix.lint-command }}
|
||||||
|
|||||||
55
.github/workflows/checks.scripts.yaml
vendored
55
.github/workflows/checks.scripts.yaml
vendored
@@ -1,55 +0,0 @@
|
|||||||
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@v2
|
|
||||||
-
|
|
||||||
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@v2
|
|
||||||
-
|
|
||||||
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 }}
|
|
||||||
2
.github/workflows/checks.security.yaml
vendored
2
.github/workflows/checks.security.yaml
vendored
@@ -19,4 +19,4 @@ jobs:
|
|||||||
uses: ./.github/actions/setup-node
|
uses: ./.github/actions/setup-node
|
||||||
-
|
-
|
||||||
name: NPM audit
|
name: NPM audit
|
||||||
run: npm audit --omit=dev
|
run: exit "$(npm audit)" # Since node 15.x, it does not fail with error if we don't explicitly exit
|
||||||
|
|||||||
25
.github/workflows/release.desktop.yaml
vendored
25
.github/workflows/release.desktop.yaml
vendored
@@ -13,29 +13,20 @@ jobs:
|
|||||||
fail-fast: false # So publish runs for other OSes if one fails
|
fail-fast: false # So publish runs for other OSes if one fails
|
||||||
runs-on: ${{ matrix.os }}-latest
|
runs-on: ${{ matrix.os }}-latest
|
||||||
steps:
|
steps:
|
||||||
-
|
- uses: actions/checkout@v2
|
||||||
uses: actions/checkout@v2
|
|
||||||
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
|
||||||
-
|
- name: Checkout to bump commit
|
||||||
name: Checkout to bump commit
|
|
||||||
run: git checkout "$(git rev-list "${{ github.event.release.tag_name }}"..master | tail -1)"
|
run: git checkout "$(git rev-list "${{ github.event.release.tag_name }}"..master | tail -1)"
|
||||||
-
|
- 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 unit tests
|
||||||
-
|
|
||||||
name: Run unit tests
|
|
||||||
run: npm run test:unit
|
run: npm run test:unit
|
||||||
-
|
- name: Publish desktop app
|
||||||
name: Prebuild
|
run: npm run electron:build -- -p always # https://nklayman.github.io/vue-cli-plugin-electron-builder/guide/recipes.html#upload-release-to-github
|
||||||
run: npm run electron:prebuild
|
|
||||||
-
|
|
||||||
name: Build and publish
|
|
||||||
run: npm run electron:build -- --publish always
|
|
||||||
env:
|
env:
|
||||||
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
EP_GH_IGNORE_TIME: true # Otherwise publishing fails if GitHub release is more than 2 hours old https://github.com/electron-userland/electron-builder/issues/2074
|
EP_GH_IGNORE_TIME: true # Otherwise publishing fails if GitHub release is more than 2 hours old https://github.com/electron-userland/electron-builder/issues/2074
|
||||||
|
|||||||
17
.github/workflows/release.site.yaml
vendored
17
.github/workflows/release.site.yaml
vendored
@@ -84,9 +84,8 @@ jobs:
|
|||||||
uses: ./app/.github/actions/setup-node
|
uses: ./app/.github/actions/setup-node
|
||||||
-
|
-
|
||||||
name: "App: Install dependencies"
|
name: "App: Install dependencies"
|
||||||
uses: ./app/.github/actions/npm-install-dependencies
|
run: npm ci
|
||||||
with:
|
working-directory: app
|
||||||
working-directory: app
|
|
||||||
-
|
-
|
||||||
name: "App: Run unit tests"
|
name: "App: Run unit tests"
|
||||||
run: npm run test:unit
|
run: npm run test:unit
|
||||||
@@ -95,21 +94,11 @@ 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"
|
||||||
shell: bash
|
|
||||||
run: >-
|
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 "${web_output_dir}" \
|
--folder app/dist \
|
||||||
--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}} \
|
||||||
|
|||||||
4
.github/workflows/tests.e2e.yaml
vendored
4
.github/workflows/tests.e2e.yaml
vendored
@@ -20,7 +20,7 @@ jobs:
|
|||||||
uses: ./.github/actions/setup-node
|
uses: ./.github/actions/setup-node
|
||||||
-
|
-
|
||||||
name: Install dependencies
|
name: Install dependencies
|
||||||
uses: ./.github/actions/npm-install-dependencies
|
run: npm ci
|
||||||
-
|
-
|
||||||
name: Run e2e tests
|
name: Run e2e tests
|
||||||
run: npm run test:cy:run
|
run: npm run test:e2e -- --headless
|
||||||
|
|||||||
2
.github/workflows/tests.integration.yaml
vendored
2
.github/workflows/tests.integration.yaml
vendored
@@ -22,7 +22,7 @@ jobs:
|
|||||||
uses: ./.github/actions/setup-node
|
uses: ./.github/actions/setup-node
|
||||||
-
|
-
|
||||||
name: Install dependencies
|
name: Install dependencies
|
||||||
uses: ./.github/actions/npm-install-dependencies
|
run: npm ci
|
||||||
-
|
-
|
||||||
name: Run integration tests
|
name: Run integration tests
|
||||||
run: npm run test:integration
|
run: npm run test:integration
|
||||||
|
|||||||
2
.github/workflows/tests.unit.yaml
vendored
2
.github/workflows/tests.unit.yaml
vendored
@@ -20,7 +20,7 @@ jobs:
|
|||||||
uses: ./.github/actions/setup-node
|
uses: ./.github/actions/setup-node
|
||||||
-
|
-
|
||||||
name: Install dependencies
|
name: Install dependencies
|
||||||
uses: ./.github/actions/npm-install-dependencies
|
run: npm ci
|
||||||
-
|
-
|
||||||
name: Run unit tests
|
name: Run unit tests
|
||||||
run: npm run test:unit
|
run: npm run test:unit
|
||||||
|
|||||||
9
.gitignore
vendored
9
.gitignore
vendored
@@ -1,5 +1,10 @@
|
|||||||
node_modules
|
node_modules
|
||||||
/dist-*/
|
dist/
|
||||||
.vs
|
.vs
|
||||||
.vscode/**/*
|
.vscode/**/*
|
||||||
!.vscode/extensions.json
|
!.vscode/extensions.json
|
||||||
|
#Electron-builder output
|
||||||
|
/dist_electron
|
||||||
|
# Cypress
|
||||||
|
/tests/e2e/screenshots
|
||||||
|
/tests/e2e/videos
|
||||||
|
|||||||
4
.vscode/extensions.json
vendored
4
.vscode/extensions.json
vendored
@@ -11,8 +11,8 @@
|
|||||||
"dbaeumer.vscode-eslint", // Lints JavaScript/TypeScript.
|
"dbaeumer.vscode-eslint", // Lints JavaScript/TypeScript.
|
||||||
"pmneo.tsimporter", // Provides better auto-complete for TypeScripts imports.
|
"pmneo.tsimporter", // Provides better auto-complete for TypeScripts imports.
|
||||||
// Vue
|
// Vue
|
||||||
"Vue.volar", // Official Vue extensions
|
"jcbuisson.vue", // Highlights syntax.
|
||||||
"Vue.vscode-typescript-vue-plugin", // Official TypeScript Vue Plugin
|
"octref.vetur", // Adds Vetur, Vue tooling support.
|
||||||
// Scripting
|
// Scripting
|
||||||
"timonwong.shellcheck", // Lints bash files.
|
"timonwong.shellcheck", // Lints bash files.
|
||||||
"ms-vscode.powershell", // Lints PowerShell files.
|
"ms-vscode.powershell", // Lints PowerShell files.
|
||||||
|
|||||||
47
CHANGELOG.md
47
CHANGELOG.md
@@ -1,52 +1,5 @@
|
|||||||
# Changelog
|
# Changelog
|
||||||
|
|
||||||
## 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)
|
|
||||||
|
|
||||||
* Transition to eslint-config-airbnb-with-typescript | [ff84f56](https://github.com/undergroundwires/privacy.sexy/commit/ff84f5676e496dd7ec5b3599e34ec9627d181ea2)
|
|
||||||
* Improve user privacy with secure outbound links | [3a594ac](https://github.com/undergroundwires/privacy.sexy/commit/3a594ac7fd708dc1e98155ffb9b21acd4e1fcf2d)
|
|
||||||
* Refactor Vue components using Composition API #230 | [1b9be8f](https://github.com/undergroundwires/privacy.sexy/commit/1b9be8fe2d72d8fb5cf1fed6dcc0b9777171aa98)
|
|
||||||
* Fix failing security tests | [3bc8da4](https://github.com/undergroundwires/privacy.sexy/commit/3bc8da4cbf1e2bd758dc3fffe4b1e62dc3beb7b3)
|
|
||||||
* Improve Defender scripts #201 | [061afad](https://github.com/undergroundwires/privacy.sexy/commit/061afad9673a41454c2421c318898f2b4f4cf504)
|
|
||||||
* Fix failing tests due to failed error logging | [986ba07](https://github.com/undergroundwires/privacy.sexy/commit/986ba078a643de6acbee50fff9cf77494ca7ea7f)
|
|
||||||
* Implement custom lightweight modal #230 | [9e5491f](https://github.com/undergroundwires/privacy.sexy/commit/9e5491fdbf2d9d40d974f5ad0e879a6d5c6d1e55)
|
|
||||||
* Refactor usage of tooltips for flexibility | [bc91237](https://github.com/undergroundwires/privacy.sexy/commit/bc91237d7c54bdcd15c5c39a55def50d172bb659)
|
|
||||||
* Fix revert toggle partial rendering | [39e650c](https://github.com/undergroundwires/privacy.sexy/commit/39e650cf110bee6b1b21d9b2902b36b0e2568d54)
|
|
||||||
* Increase testability through dependency injection | [ae75059](https://github.com/undergroundwires/privacy.sexy/commit/ae75059cc14db41f55dd2056f528442c7d319dd2)
|
|
||||||
* Refactor filter (search query) event handling | [6a20d80](https://github.com/undergroundwires/privacy.sexy/commit/6a20d804dc365d22c1248d787f9912271f508eeb)
|
|
||||||
* Migrate to ES6 modules | [a14929a](https://github.com/undergroundwires/privacy.sexy/commit/a14929a13cc6260b514692d9b4f1cdf5fb85d8b2)
|
|
||||||
|
|
||||||
[compare](https://github.com/undergroundwires/privacy.sexy/compare/0.12.0...0.12.1)
|
|
||||||
|
|
||||||
## 0.12.0 (2023-08-03)
|
## 0.12.0 (2023-08-03)
|
||||||
|
|
||||||
* Improve script/category name validation | [b210aad](https://github.com/undergroundwires/privacy.sexy/commit/b210aaddf26629179f77fe19f62f65d8a0ca2b87)
|
* Improve script/category name validation | [b210aad](https://github.com/undergroundwires/privacy.sexy/commit/b210aaddf26629179f77fe19f62f65d8a0ca2b87)
|
||||||
|
|||||||
141
LICENSE
141
LICENSE
@@ -1,5 +1,5 @@
|
|||||||
GNU AFFERO GENERAL PUBLIC LICENSE
|
GNU GENERAL PUBLIC LICENSE
|
||||||
Version 3, 19 November 2007
|
Version 3, 29 June 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,15 +7,17 @@
|
|||||||
|
|
||||||
Preamble
|
Preamble
|
||||||
|
|
||||||
The GNU Affero General Public License is a free, copyleft license for
|
The GNU General Public License is a free, copyleft license for
|
||||||
software and other kinds of works, specifically designed to ensure
|
software and other kinds of works.
|
||||||
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,
|
||||||
our General Public Licenses are intended to guarantee your freedom to
|
the GNU General Public License is 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.
|
software for all its users. We, the Free Software Foundation, use the
|
||||||
|
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
|
||||||
@@ -24,34 +26,44 @@ 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.
|
||||||
|
|
||||||
Developers that use our General Public Licenses protect your rights
|
To protect your rights, we need to prevent others from denying you
|
||||||
with two steps: (1) assert copyright on the software, and (2) offer
|
these rights or asking you to surrender the rights. Therefore, you have
|
||||||
you this License which gives you legal permission to copy, distribute
|
certain responsibilities if you distribute copies of the software, or if
|
||||||
and/or modify the software.
|
you modify it: responsibilities to respect the freedom of others.
|
||||||
|
|
||||||
A secondary benefit of defending all users' freedom is that
|
For example, if you distribute copies of such a program, whether
|
||||||
improvements made in alternate versions of the program, if they
|
gratis or for a fee, you must pass on to the recipients the same
|
||||||
receive widespread use, become available for other developers to
|
freedoms that you received. You must make sure that they, too, receive
|
||||||
incorporate. Many developers of free software are heartened and
|
or can get the source code. And you must show them these terms so they
|
||||||
encouraged by the resulting cooperation. However, in the case of
|
know their rights.
|
||||||
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.
|
|
||||||
|
|
||||||
The GNU Affero General Public License is designed specifically to
|
Developers that use the GNU GPL protect your rights with two steps:
|
||||||
ensure that, in such cases, the modified source code becomes available
|
(1) assert copyright on the software, and (2) offer you this License
|
||||||
to the community. It requires the operator of a network server to
|
giving you legal permission to copy, distribute and/or modify it.
|
||||||
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.
|
|
||||||
|
|
||||||
An older license, called the Affero General Public License and
|
For the developers' and authors' protection, the GPL clearly explains
|
||||||
published by Affero, was designed to accomplish similar goals. This is
|
that there is no warranty for this free software. For both users' and
|
||||||
a different license, not a version of the Affero GPL, but Affero has
|
authors' sake, the GPL requires that modified versions be marked as
|
||||||
released a new version of the Affero GPL which permits relicensing under
|
changed, so that their problems will not be attributed erroneously to
|
||||||
this license.
|
authors of previous versions.
|
||||||
|
|
||||||
|
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.
|
||||||
@@ -60,7 +72,7 @@ modification follow.
|
|||||||
|
|
||||||
0. Definitions.
|
0. Definitions.
|
||||||
|
|
||||||
"This License" refers to version 3 of the GNU Affero General Public License.
|
"This License" refers to version 3 of the GNU 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.
|
||||||
@@ -537,45 +549,35 @@ 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. Remote Network Interaction; Use with the GNU General Public License.
|
13. Use with the GNU Affero 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 General Public License into a single
|
under version 3 of the GNU Affero 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 work with which it is combined will remain governed by version
|
but the special requirements of the GNU Affero General Public License,
|
||||||
3 of the GNU General Public License.
|
section 13, concerning interaction through a network will apply to the
|
||||||
|
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 Affero General Public License from time to time. Such new versions
|
the GNU General Public License from time to time. Such new versions will
|
||||||
will be similar in spirit to the present version, but may differ in detail to
|
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 Affero General
|
Program specifies that a certain numbered version of the GNU 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 Affero General Public License, you may choose any version ever published
|
GNU 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 Affero General Public License can be used, that proxy's
|
versions of the GNU 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.
|
||||||
|
|
||||||
@@ -633,29 +635,40 @@ 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 Affero General Public License as published by
|
it under the terms of the GNU 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 Affero General Public License for more details.
|
GNU General Public License for more details.
|
||||||
|
|
||||||
You should have received a copy of the GNU Affero General Public License
|
You should have received a copy of the GNU 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 your software can interact with users remotely through a computer
|
If the program does terminal interaction, make it output a short
|
||||||
network, you should also make sure that it provides a way for users to
|
notice like this when it starts in an interactive mode:
|
||||||
get its source. For example, if your program is a web application, its
|
|
||||||
interface could display a "Source" link that leads users to an archive
|
<program> Copyright (C) <year> <name of author>
|
||||||
of the code. There are many ways you could offer source, and different
|
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||||
solutions will be better for different programs; see section 13 for the
|
This is free software, and you are welcome to redistribute it
|
||||||
specific requirements.
|
under certain conditions; type `show c' for details.
|
||||||
|
|
||||||
|
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 AGPL, see
|
For more information on this, and how to apply and follow the GNU GPL, 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>.
|
||||||
|
|||||||
48
README.md
48
README.md
@@ -4,13 +4,13 @@
|
|||||||
|
|
||||||
<!-- markdownlint-disable MD033 -->
|
<!-- markdownlint-disable MD033 -->
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<a href="https://undergroundwires.dev/donate?project=privacy.sexy" target="_blank" rel="noopener noreferrer">
|
<a href="https://undergroundwires.dev/donate?project=privacy.sexy">
|
||||||
<img
|
<img
|
||||||
alt="donation badge"
|
alt="donation badge"
|
||||||
src="https://undergroundwires.dev/img/badges/donate/flat.svg"
|
src="https://undergroundwires.dev/img/badges/donate/flat.svg"
|
||||||
/>
|
/>
|
||||||
</a>
|
</a>
|
||||||
<a href="https://github.com/undergroundwires/privacy.sexy/blob/master/CONTRIBUTING.md" target="_blank" rel="noopener noreferrer">
|
<a href="https://github.com/undergroundwires/privacy.sexy/blob/master/CONTRIBUTING.md">
|
||||||
<img
|
<img
|
||||||
alt="contributions are welcome"
|
alt="contributions are welcome"
|
||||||
src="https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat"
|
src="https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat"
|
||||||
@@ -18,13 +18,13 @@
|
|||||||
</a>
|
</a>
|
||||||
<!-- Code quality -->
|
<!-- Code quality -->
|
||||||
<br />
|
<br />
|
||||||
<a href="https://lgtm.com/projects/g/undergroundwires/privacy.sexy/context:javascript" target="_blank" rel="noopener noreferrer">
|
<a href="https://lgtm.com/projects/g/undergroundwires/privacy.sexy/context:javascript">
|
||||||
<img
|
<img
|
||||||
alt="Language grade: JavaScript/TypeScript"
|
alt="Language grade: JavaScript/TypeScript"
|
||||||
src="https://img.shields.io/lgtm/grade/javascript/g/undergroundwires/privacy.sexy.svg?logo=lgtm&logoWidth=18"
|
src="https://img.shields.io/lgtm/grade/javascript/g/undergroundwires/privacy.sexy.svg?logo=lgtm&logoWidth=18"
|
||||||
/>
|
/>
|
||||||
</a>
|
</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">
|
||||||
<img
|
<img
|
||||||
alt="Maintainability"
|
alt="Maintainability"
|
||||||
src="https://api.codeclimate.com/v1/badges/3a70b7ef602e2264342c/maintainability"
|
src="https://api.codeclimate.com/v1/badges/3a70b7ef602e2264342c/maintainability"
|
||||||
@@ -32,19 +32,19 @@
|
|||||||
</a>
|
</a>
|
||||||
<!-- Tests -->
|
<!-- Tests -->
|
||||||
<br />
|
<br />
|
||||||
<a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/tests.unit.yaml" target="_blank" rel="noopener noreferrer">
|
<a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/tests.unit.yaml">
|
||||||
<img
|
<img
|
||||||
alt="Unit tests status"
|
alt="Unit tests status"
|
||||||
src="https://github.com/undergroundwires/privacy.sexy/workflows/unit-tests/badge.svg"
|
src="https://github.com/undergroundwires/privacy.sexy/workflows/unit-tests/badge.svg"
|
||||||
/>
|
/>
|
||||||
</a>
|
</a>
|
||||||
<a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/tests.integration.yaml" target="_blank" rel="noopener noreferrer">
|
<a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/tests.integration.yaml">
|
||||||
<img
|
<img
|
||||||
alt="Integration tests status"
|
alt="Integration tests status"
|
||||||
src="https://github.com/undergroundwires/privacy.sexy/workflows/integration-tests/badge.svg"
|
src="https://github.com/undergroundwires/privacy.sexy/workflows/integration-tests/badge.svg"
|
||||||
/>
|
/>
|
||||||
</a>
|
</a>
|
||||||
<a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/tests.e2e.yaml" target="_blank" rel="noopener noreferrer">
|
<a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/tests.e2e.yaml">
|
||||||
<img
|
<img
|
||||||
alt="E2E tests status"
|
alt="E2E tests status"
|
||||||
src="https://github.com/undergroundwires/privacy.sexy/workflows/e2e-tests/badge.svg"
|
src="https://github.com/undergroundwires/privacy.sexy/workflows/e2e-tests/badge.svg"
|
||||||
@@ -52,57 +52,39 @@
|
|||||||
</a>
|
</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">
|
||||||
<img
|
<img
|
||||||
alt="Quality checks status"
|
alt="Quality checks status"
|
||||||
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">
|
<a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/checks.security.yaml">
|
||||||
<img
|
<img
|
||||||
alt="Security checks status"
|
alt="Security checks status"
|
||||||
src="https://github.com/undergroundwires/privacy.sexy/workflows/security-checks/badge.svg"
|
src="https://github.com/undergroundwires/privacy.sexy/workflows/security-checks/badge.svg"
|
||||||
/>
|
/>
|
||||||
</a>
|
</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">
|
||||||
<img
|
<img
|
||||||
alt="Build checks status"
|
alt="Build checks status"
|
||||||
src="https://github.com/undergroundwires/privacy.sexy/workflows/build-checks/badge.svg"
|
src="https://github.com/undergroundwires/privacy.sexy/workflows/build-checks/badge.svg"
|
||||||
/>
|
/>
|
||||||
</a>
|
</a>
|
||||||
<a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/checks.desktop-runtime-errors.yaml" target="_blank" rel="noopener noreferrer">
|
|
||||||
<img
|
|
||||||
alt="Status of runtime error checks for the desktop application"
|
|
||||||
src="https://github.com/undergroundwires/privacy.sexy/workflows/checks.desktop-runtime-errors/badge.svg"
|
|
||||||
/>
|
|
||||||
</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">
|
||||||
<img
|
<img
|
||||||
alt="Git release status"
|
alt="Git release status"
|
||||||
src="https://github.com/undergroundwires/privacy.sexy/workflows/release-git/badge.svg"
|
src="https://github.com/undergroundwires/privacy.sexy/workflows/release-git/badge.svg"
|
||||||
/>
|
/>
|
||||||
</a>
|
</a>
|
||||||
<a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/release.site.yaml" target="_blank" rel="noopener noreferrer">
|
<a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/release.site.yaml">
|
||||||
<img
|
<img
|
||||||
alt="Site release status"
|
alt="Site release status"
|
||||||
src="https://github.com/undergroundwires/privacy.sexy/workflows/release-site/badge.svg"
|
src="https://github.com/undergroundwires/privacy.sexy/workflows/release-site/badge.svg"
|
||||||
/>
|
/>
|
||||||
</a>
|
</a>
|
||||||
<a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/release.desktop.yaml" target="_blank" rel="noopener noreferrer">
|
<a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/release.desktop.yaml">
|
||||||
<img
|
<img
|
||||||
alt="Desktop application release status"
|
alt="Desktop application release status"
|
||||||
src="https://github.com/undergroundwires/privacy.sexy/workflows/release-desktop/badge.svg"
|
src="https://github.com/undergroundwires/privacy.sexy/workflows/release-desktop/badge.svg"
|
||||||
@@ -110,7 +92,7 @@
|
|||||||
</a>
|
</a>
|
||||||
<!-- Others -->
|
<!-- Others -->
|
||||||
<br />
|
<br />
|
||||||
<a href="https://github.com/undergroundwires/bump-everywhere" target="_blank" rel="noopener noreferrer">
|
<a href="https://github.com/undergroundwires/bump-everywhere">
|
||||||
<img
|
<img
|
||||||
alt="Auto-versioned by bump-everywhere"
|
alt="Auto-versioned by bump-everywhere"
|
||||||
src="https://github.com/undergroundwires/bump-everywhere/blob/master/badge.svg?raw=true"
|
src="https://github.com/undergroundwires/bump-everywhere/blob/master/badge.svg?raw=true"
|
||||||
@@ -122,7 +104,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.12.3/privacy.sexy-Setup-0.12.3.exe), [macOS](https://github.com/undergroundwires/privacy.sexy/releases/download/0.12.3/privacy.sexy-0.12.3.dmg), [Linux](https://github.com/undergroundwires/privacy.sexy/releases/download/0.12.3/privacy.sexy-0.12.3.AppImage).
|
- 🖥️ **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).
|
||||||
|
|
||||||
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.
|
||||||
|
|
||||||
|
|||||||
5
babel.config.js
Normal file
5
babel.config.js
Normal file
@@ -0,0 +1,5 @@
|
|||||||
|
module.exports = {
|
||||||
|
presets: [
|
||||||
|
'@vue/cli-plugin-babel/preset',
|
||||||
|
],
|
||||||
|
};
|
||||||
@@ -1,15 +1,14 @@
|
|||||||
import { defineConfig } from 'cypress';
|
import { defineConfig } from 'cypress'
|
||||||
import ViteConfig from './vite.config';
|
|
||||||
|
|
||||||
const CYPRESS_BASE_DIR = 'tests/e2e/';
|
|
||||||
|
|
||||||
export default defineConfig({
|
export default defineConfig({
|
||||||
fixturesFolder: `${CYPRESS_BASE_DIR}/fixtures`,
|
fixturesFolder: 'tests/e2e/fixtures',
|
||||||
screenshotsFolder: `${CYPRESS_BASE_DIR}/screenshots`,
|
screenshotsFolder: 'tests/e2e/screenshots',
|
||||||
videosFolder: `${CYPRESS_BASE_DIR}/videos`,
|
videosFolder: 'tests/e2e/videos',
|
||||||
e2e: {
|
e2e: {
|
||||||
baseUrl: `http://localhost:${ViteConfig.server.port}/`,
|
setupNodeEvents(on, config) {
|
||||||
specPattern: `${CYPRESS_BASE_DIR}/**/*.cy.{js,jsx,ts,tsx}`, // Default: cypress/e2e/**/*.cy.{js,jsx,ts,tsx}
|
return require('./tests/e2e/plugins/index.js')(on, config)
|
||||||
supportFile: `${CYPRESS_BASE_DIR}/support/e2e.ts`,
|
},
|
||||||
|
specPattern: 'tests/e2e/specs/**/*.cy.{js,jsx,ts,tsx}',
|
||||||
|
supportFile: 'tests/e2e/support/index.js',
|
||||||
},
|
},
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -1,5 +0,0 @@
|
|||||||
{
|
|
||||||
"electronUnbundled": "dist-electron-unbundled",
|
|
||||||
"electronBundled": "dist-electron-bundled",
|
|
||||||
"web": "dist-web"
|
|
||||||
}
|
|
||||||
@@ -35,7 +35,7 @@ Application layer enables [data-driven programming](https://en.wikipedia.org/wik
|
|||||||
|
|
||||||
Application layer parses the application data to compile the domain object [`Application.ts`](./../src/domain/Application.ts).
|
Application layer parses the application data to compile the domain object [`Application.ts`](./../src/domain/Application.ts).
|
||||||
|
|
||||||
The build tool loads (or injects) application data ([collection yaml files](./../src/application/collections/)) into the application layer in compile time. Application layer ([`ApplicationFactory.ts`](./../src/application/ApplicationFactory.ts)) parses and compiles this data in runtime.
|
A webpack loader loads (or injects) application data ([collection yaml files](./../src/application/collections/)) into the application layer in compile time. Application layer ([`ApplicationFactory.ts`](./../src/application/ApplicationFactory.ts)) parses and compiles this data in runtime.
|
||||||
|
|
||||||
Application layer compiles templating syntax during parsing to create the end scripts. You can read more about templating syntax in [templating.md](./templating.md) and how application data uses them through functions in [collection-files.md | Function](./collection-files.md#function).
|
Application layer compiles templating syntax during parsing to create the end scripts. You can read more about templating syntax in [templating.md](./templating.md) and how application data uses them through functions in [collection-files.md | Function](./collection-files.md#function).
|
||||||
|
|
||||||
|
|||||||
@@ -15,23 +15,11 @@ Application is
|
|||||||
|
|
||||||
Application uses highly decoupled models & services in different DDD layers:
|
Application uses highly decoupled models & services in different DDD layers:
|
||||||
|
|
||||||
**Application layer** (see [application.md](./application.md)):
|
- presentation layer (see [presentation.md](./presentation.md)),
|
||||||
|
- application layer (see [application.md](./application.md)),
|
||||||
|
- and domain layer.
|
||||||
|
|
||||||
- Coordinates application activities and consumes the domain layer.
|
Application layer depends on and consumes domain layer. [Presentation layer](./presentation.md) consumes and depends on application layer along with domain layer. Application and presentation layers can communicate through domain model.
|
||||||
|
|
||||||
**Presentation layer** (see [presentation.md](./presentation.md)):
|
|
||||||
|
|
||||||
- Handles UI/UX, consumes both the application and domain layers.
|
|
||||||
- May communicate directly with the infrastructure layer for technical needs, but avoids domain logic.
|
|
||||||
|
|
||||||
**Domain layer**:
|
|
||||||
|
|
||||||
- Serves as the system's core and central truth.
|
|
||||||
- Facilitates communication between the application and presentation layers through the domain model.
|
|
||||||
|
|
||||||
**Infrastructure layer**:
|
|
||||||
|
|
||||||
- Manages technical implementations without dependencies on other layers or domain knowledge.
|
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
@@ -39,8 +27,6 @@ Application uses highly decoupled models & services in different DDD layers:
|
|||||||
|
|
||||||
State handling uses an event-driven subscription model to signal state changes and special functions to register changes. It does not depend on third party packages.
|
State handling uses an event-driven subscription model to signal state changes and special functions to register changes. It does not depend on third party packages.
|
||||||
|
|
||||||
The presentation layer can read and modify state through the context. State changes trigger events that components can subscribe to for reactivity.
|
|
||||||
|
|
||||||
Each layer treat application layer differently.
|
Each layer treat application layer differently.
|
||||||
|
|
||||||

|

|
||||||
@@ -59,7 +45,7 @@ Each layer treat application layer differently.
|
|||||||
- So state is mutable, and fires related events when mutated.
|
- So state is mutable, and fires related events when mutated.
|
||||||
- 📖 Read more: [application.md | Application state](./application.md#application-state).
|
- 📖 Read more: [application.md | Application state](./application.md#application-state).
|
||||||
|
|
||||||
It's comparable with `flux`, `vuex`, and `pinia`. A difference is that mutable application layer state in privacy.sexy is mutable and lies in single "store" that holds app state and logic. The "actions" mutate the state directly which in turns act as dispatcher to notify its own event subscriptions (callbacks).
|
It's comparable with flux ([`redux`](https://redux.js.org/)) or flux-like ([`vuex`](https://vuex.vuejs.org/)) patterns. Flux component "view" is [presentation layer](./presentation.md) in Vue. Flux functions "dispatcher", "store" and "action creation" functions lie in the [application layer](./application.md). A difference is that application state in privacy.sexy is mutable and lies in single flux "store" that holds app state and logic. The "actions" mutate the state directly which in turns act as dispatcher to notify its own event subscriptions (callbacks).
|
||||||
|
|
||||||
## AWS infrastructure
|
## AWS infrastructure
|
||||||
|
|
||||||
|
|||||||
@@ -5,28 +5,22 @@ 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.
|
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.
|
||||||
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 >16.x.
|
- Install node >15.x.
|
||||||
- Install dependencies using `npm install` (or [`npm run install-deps`](#utility-scripts) for more options).
|
- Install dependencies using `npm install`.
|
||||||
|
|
||||||
### Testing
|
### Testing
|
||||||
|
|
||||||
- Run unit tests: `npm run test:unit`
|
- Run unit tests: `npm run test:unit`
|
||||||
- Run integration tests: `npm run test:integration`
|
- Run integration tests: `npm run test:integration`
|
||||||
- Run end-to-end (e2e) tests:
|
- Run e2e (end-to-end) tests
|
||||||
- `npm run test:cy:open`: Run tests interactively using the development server with hot-reloading.
|
- Interactive mode with GUI: `npm run test:e2e`
|
||||||
- `npm run test:cy:run`: Run tests on the production build in a headless mode.
|
- Headless mode without GUI: `npm run test:e2e -- --headless`
|
||||||
- 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).
|
||||||
|
|
||||||
@@ -41,25 +35,11 @@ See [ci-cd.md](./ci-cd.md) for more information.
|
|||||||
|
|
||||||
### Running
|
### Running
|
||||||
|
|
||||||
**Web:**
|
- Run in local server: `npm run serve`
|
||||||
|
|
||||||
- Run in local server: `npm run dev`
|
|
||||||
- 💡 Meant for local development with features such as hot-reloading.
|
- 💡 Meant for local development with features such as hot-reloading.
|
||||||
- Preview production build: `npm run preview`
|
- Run using Docker:
|
||||||
- Start a local web server that serves the built solution from `./dist`.
|
1. Build: `docker build -t undergroundwires/privacy.sexy:latest .`
|
||||||
- 💡 Run `npm run build` before `npm run preview`.
|
2. Run: `docker run -it -p 8080:80 --rm --name privacy.sexy undergroundwires/privacy.sexy:latest`
|
||||||
|
|
||||||
**Desktop apps:**
|
|
||||||
|
|
||||||
- `npm run electron:dev`: The command will build the main process and preload scripts source code, and start a dev server for the renderer, and start the Electron app.
|
|
||||||
- `npm run electron:preview`: The command will build the main process, preload scripts and renderer source code, and start the Electron app to preview.
|
|
||||||
- `npm run electron:prebuild`: The command will build the main process, preload scripts and renderer source code. Usually before packaging the Electron application, you need to execute this command.
|
|
||||||
- `npm run electron:build`: Prebuilds the Electron application, packages and publishes it through `electron-builder`.
|
|
||||||
|
|
||||||
**Docker:**
|
|
||||||
|
|
||||||
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`
|
|
||||||
|
|
||||||
### Building
|
### Building
|
||||||
|
|
||||||
@@ -67,26 +47,13 @@ See [ci-cd.md](./ci-cd.md) for more information.
|
|||||||
- 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`
|
||||||
|
|
||||||
### Scripts
|
### Utility Scripts
|
||||||
|
|
||||||
📖 For detailed options and behavior for any of the following scripts, please refer to the script file itself.
|
- Run fresh NPM install: [`./scripts/fresh-npm-install.sh`](../scripts/fresh-npm-install.sh)
|
||||||
|
- 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.
|
||||||
#### Utility scripts
|
- Configure VSCode: [`./scripts/configure-vscode.sh`](../scripts/configure-vscode.sh)
|
||||||
|
|
||||||
- [**`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.
|
|
||||||
- Primarily used by automation scripts.
|
|
||||||
- [**`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.
|
|
||||||
|
|
||||||
## Recommended extensions
|
## Recommended extensions
|
||||||
|
|
||||||
You should use EditorConfig to follow project style.
|
You should use EditorConfig to follow project style.
|
||||||
|
|||||||
@@ -1,33 +1,30 @@
|
|||||||
# Presentation layer
|
# Presentation layer
|
||||||
|
|
||||||
The presentation layer handles UI concerns using Vue as JavaScript framework and Electron to provide desktop functionality.
|
Presentation layer consists of UI-related code. It uses Vue.js as JavaScript framework and includes Vue.js components. It also includes [Electron](https://www.electronjs.org/) to provide functionality to desktop application.
|
||||||
|
|
||||||
It reflects the [application state](./application.md#application-state) and allows user interactions to modify it. Components manage their own local UI state.
|
It's designed event-driven from bottom to top. It listens user events (from top) and state events (from bottom) to update state or the GUI.
|
||||||
|
|
||||||
The presentation layer uses an event-driven architecture for bidirectional reactivity between the application state and UI. State change events flow bottom-up to trigger UI updates, while user events flow top-down through components, some ultimately modifying the application state.
|
|
||||||
|
|
||||||
📖 Refer to [architecture.md (Layered Application)](./architecture.md#layered-application) to read more about the layered architecture.
|
📖 Refer to [architecture.md (Layered Application)](./architecture.md#layered-application) to read more about the layered architecture.
|
||||||
|
|
||||||
## Structure
|
## Structure
|
||||||
|
|
||||||
- [`/src/` **`presentation/`**](./../src/presentation/): Contains Vue and Electron code.
|
- [`/src/` **`presentation/`**](./../src/presentation/): Contains all presentation related code including Vue and Electron configurations
|
||||||
- [**`bootstrapping/`**](./../src/presentation/bootstrapping/): Registers Vue components and plugins.
|
- [**`bootstrapping/`**](./../src/presentation/bootstrapping/): Registers Vue global objects including components and plugins.
|
||||||
- [**`components/`**](./../src/presentation/components/): Contains Vue components and helpers.
|
- [**`components/`**](./../src/presentation/components/): Contains all Vue components and their helper classes.
|
||||||
- [**`Shared/`**](./../src/presentation/components/Shared): Contains shared Vue components and helpers.
|
- [**`Shared/`**](./../src/presentation/components/Shared): Contains Vue components and component helpers that other components share.
|
||||||
- [**`Hooks`**](../src/presentation/components/Shared/Hooks): Hooks used by components through [dependency injection](#dependency-injections).
|
- [**`assets/`**](./../src/presentation/assets/styles/): Contains assets that webpack will process.
|
||||||
- [**`/public/`**](../src/presentation/public/): Contains static assets.
|
- [**`fonts/`**](./../src/presentation/assets/fonts/): Contains fonts
|
||||||
- [**`assets/`**](./../src/presentation/assets/styles/): Contains assets processed by Vite.
|
- [**`styles/`**](./../src/presentation/assets/styles/): Contains shared styles used throughout different components.
|
||||||
- [**`fonts/`**](./../src/presentation/assets/fonts/): Contains fonts.
|
- [**`components/`**](./../src/presentation/assets/styles/components): Contains reusable styles coupled to a Vue/HTML component.
|
||||||
- [**`styles/`**](./../src/presentation/assets/styles/): Contains shared styles.
|
- [**`vendors-extensions/`**](./../src/presentation/assets/styles/third-party-extensions): Contains styles that override third-party components used.
|
||||||
- [**`components/`**](./../src/presentation/assets/styles/components): Contains styles coupled to Vue components.
|
- [**`main.scss`**](./../src/presentation/assets/styles/main.scss): Primary Sass file, passes along all other styles, should be the single file used from other components.
|
||||||
- [**`main.scss`**](./../src/presentation/assets/styles/main.scss): Main Sass file, imported by other components as single entrypoint.
|
- [**`main.ts`**](./../src/presentation/main.ts): Application entry point that mounts and starts Vue application.
|
||||||
- [**`main.ts`**](./../src/presentation/main.ts): Starts Vue app.
|
- [**`electron/`**](./../src/presentation/electron/): Electron configuration for the desktop application.
|
||||||
- [**`electron/`**](./../src/presentation/electron/): Contains Electron code.
|
- [**`main.ts`**](./../src/presentation/main.ts): Main process of Electron, started as first thing when app starts.
|
||||||
- [`/main/` **`index.ts`**](./../src/presentation/main.ts): Main entry for Electron, managing application windows and lifecycle events.
|
- [**`/public/`**](./../public/): Contains static assets that are directly copied and do not go through webpack.
|
||||||
- [`/preload/` **`index.ts`**](./../src/presentation/main.ts): Script executed before the renderer, securing Node.js features for renderer use.
|
- [**`/vue.config.js`**](./../vue.config.js): Global Vue CLI configurations loaded by `@vue/cli-service`.
|
||||||
- [**`/vite.config.ts`**](./../vite.config.ts): Contains Vite configurations for building web application.
|
- [**`/postcss.config.js`**](./../postcss.config.js): PostCSS configurations used by Vue CLI internally.
|
||||||
- [**`/electron.vite.config.ts`**](./../electron.vite.config.ts): Contains Vite configurations for building desktop applications.
|
- [**`/babel.config.js`**](./../babel.config.js): Babel configurations for polyfills used by `@vue/cli-plugin-babel`.
|
||||||
- [**`/postcss.config.cjs`**](./../postcss.config.cjs): Contains PostCSS configurations for Vite.
|
|
||||||
|
|
||||||
## Visual design best-practices
|
## Visual design best-practices
|
||||||
|
|
||||||
@@ -35,7 +32,7 @@ Add visual clues for clickable items. It should be as clear as possible that the
|
|||||||
|
|
||||||
## Application data
|
## Application data
|
||||||
|
|
||||||
Components (should) use [`UseApplication`](./../src/presentation/components/Shared/Hooks/UseApplication.ts) to reach the application domain to avoid [parsing and compiling](./application.md#parsing-and-compiling) the application again.
|
Components (should) use [ApplicationFactory](./../src/application/ApplicationFactory.ts) singleton to reach the application domain to avoid [parsing and compiling](./application.md#parsing-and-compiling) the application again.
|
||||||
|
|
||||||
[Application.ts](../src/domain/Application.ts) is an immutable domain model that represents application state. It includes:
|
[Application.ts](../src/domain/Application.ts) is an immutable domain model that represents application state. It includes:
|
||||||
|
|
||||||
@@ -46,58 +43,34 @@ You can read more about how application layer provides application data to he pr
|
|||||||
|
|
||||||
## Application state
|
## Application state
|
||||||
|
|
||||||
This project uses a singleton instance of the application state, making it available to all Vue components.
|
Inheritance of a Vue components marks whether it uses application state . Components that does not handle application state extends `Vue`. Stateful components mutate or/and react to state changes (such as user selection or search queries) in [ApplicationContext](./../src/application/Context/ApplicationContext.ts) extend [`StatefulVue`](./../src/presentation/components/Shared/StatefulVue.ts) class to access the context / state.
|
||||||
|
|
||||||
The decision to not use third-party state management libraries like [`vuex`](https://web.archive.org/web/20230801191617/https://vuex.vuejs.org/) or [`pinia`](https://web.archive.org/web/20230801191743/https://pinia.vuejs.org/) was made to promote code independence and enhance portability.
|
[`StatefulVue`](./../src/presentation/components/Shared/StatefulVue.ts) functions include:
|
||||||
|
|
||||||
Stateful components can mutate and/or react to state changes (e.g., user selection, search queries) in the [ApplicationContext](./../src/application/Context/ApplicationContext.ts). Vue components import [`CollectionState.ts`](./../src/presentation/components/Shared/Hooks/UseCollectionState.ts) to access both the application context and the state.
|
- Creating a singleton of the state and makes it available to presentation layer as single source of truth.
|
||||||
|
- Providing virtual abstract `handleCollectionState` callback that it calls when
|
||||||
|
- the Vue loads the component,
|
||||||
|
- and also every time when state changes.
|
||||||
|
- Providing `events` member to make lifecycling of state subscriptions events easier because it ensures that components unsubscribe from listening to state events when
|
||||||
|
- the component is no longer used (destroyed),
|
||||||
|
- an if [ApplicationContext](./../src/application/Context/ApplicationContext.ts) changes the active [collection](./collection-files.md) to a different one.
|
||||||
|
|
||||||
[`UseCollectionState.ts`](./../src/presentation/components/Shared/Hooks/UseCollectionState.ts) provides several functionalities including:
|
📖 Refer to [architecture.md | Application State](./architecture.md#application-state) to get an overview of event handling and [application.md | Application State](./presentation.md#application-state) for deeper look into how the application layer manages state.
|
||||||
|
|
||||||
- **Singleton State Instance**: It creates a singleton instance of the state, which is shared across the presentation layer. The singleton instance ensures that there's a single source of truth for the application's state.
|
## Modals
|
||||||
- **State Change Callback and Lifecycle Management**: It offers a mechanism to register callbacks, which will be invoked when the state initializes or mutates. It ensures that components unsubscribe from state events when they are no longer in use or when [ApplicationContext](./../src/application/Context/ApplicationContext.ts) switches the active [collection](./collection-files.md).
|
|
||||||
- **State Access and Modification**: It provides functions to read and mutate for accessing and modifying the state, encapsulating the details of these operations.
|
|
||||||
- **Event Subscription Lifecycle Management**: Includes an `events` member that simplifies state subscription lifecycle events. This ensures that components unsubscribe from state events when they are no longer in use, or when [ApplicationContext](./../src/application/Context/ApplicationContext.ts) switches the active [collection](./collection-files.md).
|
|
||||||
|
|
||||||
📖 Refer to [architecture.md | Application State](./architecture.md#application-state) for an overview of event handling and [application.md | Application State](./presentation.md#application-state) for an in-depth understanding of state management in the application layer.
|
[Dialog.vue](./../src/presentation/components/Shared/Dialog.vue) is a shared component that other components used to show modal windows.
|
||||||
|
|
||||||
## Dependency injections
|
You can use it by wrapping the content inside of its `slot` and call `.show()` function on its reference. For example:
|
||||||
|
|
||||||
The presentation layer uses Vue's native dependency injection system to increase testability and decouple components.
|
```html
|
||||||
|
<Dialog ref="testDialog">
|
||||||
|
<div>Hello world</div>
|
||||||
|
</Dialog>
|
||||||
|
<div @click="$refs.testDialog.show()">Show dialog</div>
|
||||||
|
```
|
||||||
|
|
||||||
To add a new dependency:
|
## Sass naming convention
|
||||||
|
|
||||||
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.
|
|
||||||
- **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.
|
|
||||||
3. **Inject the dependency**: Use Vue's `inject` method alongside the defined symbol to incorporate the dependency into components.
|
|
||||||
- For singletons, invoke the factory method: `inject(symbolKey)()`.
|
|
||||||
- For transients, directly inject: `inject(symbolKey)`.
|
|
||||||
|
|
||||||
## Shared UI components
|
|
||||||
|
|
||||||
Shared UI components promote consistency and simplifies the creation of the front-end.
|
|
||||||
|
|
||||||
In order to maintain portability and easy maintainability, the preference is towards using homegrown components over third-party ones or comprehensive UI frameworks like Quasar.
|
|
||||||
|
|
||||||
Shared components include:
|
|
||||||
|
|
||||||
- [ModalDialog.vue](./../src/presentation/components/Shared/Modal/ModalDialog.vue) is utilized for rendering modal windows.
|
|
||||||
- [TooltipWrapper.vue](./../src/presentation/components/Shared/TooltipWrapper.vue) acts as a wrapper for rendering tooltips.
|
|
||||||
|
|
||||||
## Desktop builds
|
|
||||||
|
|
||||||
Desktop builds uses `electron-vite` to bundle the code, and `electron-builder` to build and publish the packages.
|
|
||||||
|
|
||||||
## 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;`
|
||||||
|
|||||||
122
docs/tests.md
122
docs/tests.md
@@ -5,79 +5,77 @@ There are different types of tests executed:
|
|||||||
1. [Unit tests](#unit-tests)
|
1. [Unit tests](#unit-tests)
|
||||||
2. [Integration tests](#integration-tests)
|
2. [Integration tests](#integration-tests)
|
||||||
3. [End-to-end (E2E) tests](#e2e-tests)
|
3. [End-to-end (E2E) tests](#e2e-tests)
|
||||||
4. [Automated checks](#automated-checks)
|
|
||||||
|
|
||||||
## Unit and integration tests
|
Common aspects for all tests:
|
||||||
|
|
||||||
- They utilize [Vitest](https://vitest.dev/).
|
- They use [Mocha](https://mochajs.org/) and [Chai](https://www.chaijs.com/).
|
||||||
- Test files are suffixed with `.spec.ts`.
|
- Their files end with `.spec.{ts|js}` suffix.
|
||||||
|
|
||||||
|
💡 You can use path/module alias `@/tests` in import statements.
|
||||||
|
|
||||||
|
## Unit tests
|
||||||
|
|
||||||
|
- Unit tests test each component in isolation.
|
||||||
|
- All unit tests goes under [`./tests/unit`](./../tests/unit).
|
||||||
|
- They rely on [stubs](./../tests/unit/shared/Stubs) for isolation.
|
||||||
|
|
||||||
|
### Unit tests structure
|
||||||
|
|
||||||
|
- [`./src/`](./../src/)
|
||||||
|
- Includes source code that unit tests will test.
|
||||||
|
- [`./tests/unit/`](./../tests/unit/)
|
||||||
|
- Includes test code.
|
||||||
|
- Tests follow same folder structure as [`./src/`](./../src).
|
||||||
|
- E.g. if system under test lies in [`./src/application/ApplicationFactory.ts`](./../src/application/ApplicationFactory.ts) then its tests would be in test would be at [`./tests/unit/application/ApplicationFactory.spec.ts`](./../tests/unit/application/ApplicationFactory.spec.ts).
|
||||||
|
- [`shared/`](./../tests/unit/shared/)
|
||||||
|
- Includes common functionality that's shared across unit tests.
|
||||||
|
- [`Assertions/`](./../tests/unit/shared/Assertions):
|
||||||
|
- Common assertions that extend [Chai Assertion Library](https://www.chaijs.com/).
|
||||||
|
- Asserting functions should start with `expect` prefix.
|
||||||
|
- [`TestCases/`](./../tests/unit/shared/TestCases/)
|
||||||
|
- Shared test cases.
|
||||||
|
- Functions that calls `it()` from [Mocha test framework](https://mochajs.org/) should have `it` prefix.
|
||||||
|
- E.g. `itEachAbsentCollectionValue()`.
|
||||||
|
- [`Stubs/`](./../tests/unit/shared/Stubs)
|
||||||
|
- Includes stubs to be able to test components in isolation.
|
||||||
|
- Stubs have minimal and dummy behavior to be functional, they may also have spying or mocking functions.
|
||||||
|
|
||||||
|
### Unit tests naming
|
||||||
|
|
||||||
|
- Each test suite first describe the system under test.
|
||||||
|
- E.g. tests for class `Application.ts` are all inside `Application.spec.ts`.
|
||||||
|
- `describe` blocks tests for same function (if applicable).
|
||||||
|
- E.g. test for `run()` are inside `describe('run', () => ..)`.
|
||||||
|
|
||||||
### Act, arrange, assert
|
### Act, arrange, assert
|
||||||
|
|
||||||
- Tests implement the act, arrange, and assert (AAA) pattern.
|
- Tests use act, arrange and assert (AAA) pattern when applicable.
|
||||||
- **Arrange**
|
- **Arrange**
|
||||||
- Sets up the test scenario and environment.
|
- Sets up the test case.
|
||||||
- Begins with comment line `// arrange`.
|
- Starts with comment line `// arrange`.
|
||||||
- **Act**
|
- **Act**
|
||||||
- Executes the actual test.
|
- Executes the actual test.
|
||||||
- Begins with comment line `// act`.
|
- Starts with comment line `// act`.
|
||||||
- **Assert**
|
- **Assert**
|
||||||
- Sets an expectation for the test's outcome.
|
- Elicit some sort of expectation.
|
||||||
- Begins with comment line `// assert`.
|
- Starts with comment line `// assert`.
|
||||||
|
|
||||||
### Unit tests
|
## Integration tests
|
||||||
|
|
||||||
- Evaluate individual components in isolation.
|
- Tests functionality of a component in combination with others (not isolated).
|
||||||
- Located in [`./tests/unit`](./../tests/unit).
|
- Ensure dependencies to third parties work as expected.
|
||||||
- Achieve isolation using [stubs](./../tests/unit/shared/Stubs).
|
- Defined in [./tests/integration](./../tests/integration).
|
||||||
- Include Vue component tests, enabled by `@vue/test-utils`.
|
|
||||||
|
|
||||||
#### Unit tests naming
|
|
||||||
|
|
||||||
- Test suites start with a description of the component or system under test.
|
|
||||||
- E.g., tests for `Application.ts` are contained in `Application.spec.ts`.
|
|
||||||
- Whenever possible, `describe` blocks group tests of the same function.
|
|
||||||
- E.g., tests for `run()` are inside `describe('run', () => ...)`.
|
|
||||||
|
|
||||||
### Integration tests
|
|
||||||
|
|
||||||
- Assess the combined functionality of components.
|
|
||||||
- They verify that third-party dependencies function as anticipated.
|
|
||||||
|
|
||||||
## E2E tests
|
## E2E tests
|
||||||
|
|
||||||
- Examine the live web application's functionality and performance.
|
- Test the functionality and performance of a running application.
|
||||||
- Uses Cypress to run the tests.
|
- Vue CLI plugin [`e2e-cypress`](https://github.com/vuejs/vue-cli/tree/dev/packages/@vue/cli-plugin-e2e-cypress#readme) configures E2E tests.
|
||||||
|
- Test names and folders have logical structure based on tests executed.
|
||||||
## Automated checks
|
- The structure is following:
|
||||||
|
- [`cypress.config.ts`](./../cypress.config.ts): Cypress configuration file.
|
||||||
These checks validate various qualities like runtime execution, building process, security testing, etc.
|
- [`./tests/e2e/`](./../tests/e2e/): Base Cypress folder.
|
||||||
|
- [`/specs/`](./../tests/e2e/specs/): Test files named with `.spec.js` extension.
|
||||||
- Use [various tools](./../package.json) and [scripts](./../scripts).
|
- [`/plugins/index.js`](./../tests/e2e/plugins/index.js): Plugin file executed before loading project.
|
||||||
- Are automatically executed as [GitHub workflows](./../.github/workflows).
|
- [`/support/index.js`](./../tests/e2e/support/index.js): Support file, runs before every single spec file.
|
||||||
|
- *(Ignored)* `/videos`: Asset folder for videos taken during tests.
|
||||||
## Tests structure
|
- *(Ignored)* `/screenshots`: Asset folder for Screenshots taken during tests.
|
||||||
|
|
||||||
- [`package.json`](./../package.json): Defines test commands and includes tools used in tests.
|
|
||||||
- [`vite.config.ts`](./../vite.config.ts): Configures `vitest` for unit and integration tests.
|
|
||||||
- [`./src/`](./../src/): Contains the code subject to testing.
|
|
||||||
- [`./tests/shared/`](./../tests/shared/): Contains code shared by different test categories.
|
|
||||||
- [`bootstrap/setup.ts`](./../tests/shared/bootstrap/setup.ts): Initializes unit and integration tests.
|
|
||||||
- [`./tests/unit/`](./../tests/unit/)
|
|
||||||
- Stores unit test code.
|
|
||||||
- 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).
|
|
||||||
- [`shared/`](./../tests/unit/shared/)
|
|
||||||
- Contains shared unit test functionalities.
|
|
||||||
- [`Assertions/`](./../tests/unit/shared/Assertions): Contains common assertion functions, prefixed with `expect`.
|
|
||||||
- [`TestCases/`](./../tests/unit/shared/TestCases/)
|
|
||||||
- Shared test cases.
|
|
||||||
- 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.
|
|
||||||
- [`./tests/integration/`](./../tests/integration/): Contains integration test files.
|
|
||||||
- [`cypress.config.ts`](./../cypress.config.ts): Cypress (E2E tests) configuration file.
|
|
||||||
- [`./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.
|
|
||||||
- *(git ignored)* `/videos`: Asset folder for videos taken during tests.
|
|
||||||
- *(git ignored)* `/screenshots`: Asset folder for Screenshots taken during tests.
|
|
||||||
|
|||||||
@@ -1,43 +0,0 @@
|
|||||||
/* 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,69 +0,0 @@
|
|||||||
import { resolve } from 'path';
|
|
||||||
import { mergeConfig, UserConfig } from 'vite';
|
|
||||||
import { defineConfig, externalizeDepsPlugin } from 'electron-vite';
|
|
||||||
import { getAliasesFromTsConfig, getClientEnvironmentVariables } from './vite-config-helper';
|
|
||||||
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 PRELOAD_ENTRY_FILE = resolvePathFromProjectRoot('src/presentation/electron/preload/index.ts');
|
|
||||||
const WEB_INDEX_HTML_PATH = resolvePathFromProjectRoot('src/presentation/index.html');
|
|
||||||
const DIST_DIR = resolvePathFromProjectRoot(distDirs.electronUnbundled);
|
|
||||||
|
|
||||||
export default defineConfig({
|
|
||||||
main: getSharedElectronConfig({
|
|
||||||
distDirSubfolder: 'main',
|
|
||||||
entryFilePath: MAIN_ENTRY_FILE,
|
|
||||||
}),
|
|
||||||
preload: getSharedElectronConfig({
|
|
||||||
distDirSubfolder: 'preload',
|
|
||||||
entryFilePath: PRELOAD_ENTRY_FILE,
|
|
||||||
}),
|
|
||||||
renderer: mergeConfig(
|
|
||||||
createVueConfig({
|
|
||||||
supportLegacyBrowsers: false,
|
|
||||||
}),
|
|
||||||
{
|
|
||||||
build: {
|
|
||||||
outDir: resolve(DIST_DIR, 'renderer'),
|
|
||||||
rollupOptions: {
|
|
||||||
input: {
|
|
||||||
index: WEB_INDEX_HTML_PATH,
|
|
||||||
},
|
|
||||||
},
|
|
||||||
},
|
|
||||||
},
|
|
||||||
),
|
|
||||||
});
|
|
||||||
|
|
||||||
function getSharedElectronConfig(options: {
|
|
||||||
readonly distDirSubfolder: string;
|
|
||||||
readonly entryFilePath: string;
|
|
||||||
}): UserConfig {
|
|
||||||
return {
|
|
||||||
build: {
|
|
||||||
outDir: resolve(DIST_DIR, options.distDirSubfolder),
|
|
||||||
lib: {
|
|
||||||
entry: options.entryFilePath,
|
|
||||||
},
|
|
||||||
rollupOptions: {
|
|
||||||
output: {
|
|
||||||
entryFileNames: '[name].cjs', // This is needed so `type="module"` works
|
|
||||||
},
|
|
||||||
},
|
|
||||||
},
|
|
||||||
plugins: [externalizeDepsPlugin()],
|
|
||||||
define: {
|
|
||||||
...getClientEnvironmentVariables(),
|
|
||||||
},
|
|
||||||
resolve: {
|
|
||||||
alias: {
|
|
||||||
...getAliasesFromTsConfig(),
|
|
||||||
},
|
|
||||||
},
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
function resolvePathFromProjectRoot(pathSegment: string) {
|
|
||||||
return resolve(__dirname, pathSegment);
|
|
||||||
}
|
|
||||||
@@ -4,6 +4,9 @@ This folder contains image files and other resources related to images.
|
|||||||
|
|
||||||
## logo.svg
|
## logo.svg
|
||||||
|
|
||||||
[`logo.svg`](./logo.svg) serves as the primary logo from which all other icons and images are derived.
|
[logo.svg](./logo.svg) is the master logo from which all other icons or images are created from.
|
||||||
Only modify this file manually.
|
It should be the only file that will be changed manually.
|
||||||
After making changes, execute `npm run build:icons` to regenerate logo files in various formats.
|
|
||||||
|
[`logo-update.mjs`](./logo-update.mjs) script in this folder updates all the logo files.
|
||||||
|
It should be executed everytime the logo is changed.
|
||||||
|
It automates recreation of logo files in different formats.
|
||||||
|
|||||||
@@ -8,7 +8,7 @@ class Paths {
|
|||||||
constructor(selfDirectory) {
|
constructor(selfDirectory) {
|
||||||
const projectRoot = resolve(selfDirectory, '../');
|
const projectRoot = resolve(selfDirectory, '../');
|
||||||
this.sourceImage = join(projectRoot, 'img/logo.svg');
|
this.sourceImage = join(projectRoot, 'img/logo.svg');
|
||||||
this.publicDirectory = join(projectRoot, 'src/presentation/public');
|
this.publicDirectory = join(projectRoot, 'public');
|
||||||
this.electronBuildDirectory = join(projectRoot, 'build');
|
this.electronBuildDirectory = join(projectRoot, 'build');
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -61,7 +61,7 @@ async function updateDesktopIcons(sourceImage, electronIconsDir) {
|
|||||||
await ensureFolderExists(electronIconsDir);
|
await ensureFolderExists(electronIconsDir);
|
||||||
const temporaryDir = await mkdtemp('icon-');
|
const temporaryDir = await mkdtemp('icon-');
|
||||||
const temporaryPngFile = join(temporaryDir, 'icon.png');
|
const temporaryPngFile = join(temporaryDir, 'icon.png');
|
||||||
console.log(`Converting from SVG (${sourceImage}) to PNG: ${temporaryPngFile}`); // required by `icon-builder`
|
console.log(`Converting from SVG (${sourceImage}) to PNG: ${temporaryPngFile}`); // required by icon-builder
|
||||||
await runCommand(
|
await runCommand(
|
||||||
'npx',
|
'npx',
|
||||||
'svgexport',
|
'svgexport',
|
||||||
26169
package-lock.json
generated
26169
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
81
package.json
81
package.json
@@ -1,40 +1,30 @@
|
|||||||
{
|
{
|
||||||
"name": "privacy.sexy",
|
"name": "privacy.sexy",
|
||||||
"version": "0.12.3",
|
"version": "0.12.0",
|
||||||
"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 🍑🍆",
|
||||||
"author": "undergroundwires",
|
"author": "undergroundwires",
|
||||||
"type": "module",
|
|
||||||
"main": "./dist-electron-unbundled/main/index.cjs",
|
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"dev": "vite",
|
"serve": "vue-cli-service serve",
|
||||||
"build": "vue-tsc --noEmit && vite build",
|
"build": "vue-cli-service build",
|
||||||
"preview": "vite preview",
|
"test:unit": "vue-cli-service test:unit",
|
||||||
"test:unit": "vitest run --dir tests/unit",
|
"test:e2e": "vue-cli-service test:e2e",
|
||||||
"test:integration": "vitest run --dir tests/integration",
|
|
||||||
"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\"",
|
|
||||||
"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",
|
"create-icons": "node img/logo-update.mjs",
|
||||||
"icons:build": "node scripts/logo-update.js",
|
"electron:build": "vue-cli-service electron:build",
|
||||||
"check:desktop": "vitest run --dir tests/checks/desktop-runtime-errors --environment node",
|
"electron:serve": "vue-cli-service electron:serve",
|
||||||
"check:external-urls": "vitest run --dir tests/checks/external-urls --environment node",
|
"lint:eslint": "vue-cli-service lint --no-fix --mode production",
|
||||||
"check:verify-build-artifacts": "node scripts/verify-build-artifacts",
|
|
||||||
"electron:dev": "electron-vite dev",
|
|
||||||
"electron:preview": "electron-vite preview",
|
|
||||||
"electron:prebuild": "electron-vite build",
|
|
||||||
"electron:build": "electron-builder",
|
|
||||||
"lint:eslint": "eslint . --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",
|
||||||
"lint:yaml": "yamllint **/*.yaml --ignore=node_modules/**/*.yaml",
|
"lint:yaml": "yamllint **/*.yaml --ignore=node_modules/**/*.yaml",
|
||||||
"postinstall": "electron-builder install-app-deps",
|
"postinstall": "electron-builder install-app-deps",
|
||||||
"postuninstall": "electron-builder install-app-deps"
|
"postuninstall": "electron-builder install-app-deps",
|
||||||
|
"test:integration": "vue-cli-service test:unit \"tests/integration/**/*.spec.ts\""
|
||||||
},
|
},
|
||||||
|
"main": "index.js",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@floating-ui/vue": "^1.0.2",
|
|
||||||
"@fortawesome/fontawesome-svg-core": "^6.4.0",
|
"@fortawesome/fontawesome-svg-core": "^6.4.0",
|
||||||
"@fortawesome/free-brands-svg-icons": "^6.4.0",
|
"@fortawesome/free-brands-svg-icons": "^6.4.0",
|
||||||
"@fortawesome/free-regular-svg-icons": "^6.4.0",
|
"@fortawesome/free-regular-svg-icons": "^6.4.0",
|
||||||
@@ -42,26 +32,37 @@
|
|||||||
"@fortawesome/vue-fontawesome": "^2.0.9",
|
"@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.23.4",
|
||||||
|
"core-js": "^3.32.0",
|
||||||
"cross-fetch": "^4.0.0",
|
"cross-fetch": "^4.0.0",
|
||||||
"electron-progressbar": "^2.1.0",
|
"electron-progressbar": "^2.1.0",
|
||||||
"file-saver": "^2.0.5",
|
"file-saver": "^2.0.5",
|
||||||
|
"install": "^0.13.0",
|
||||||
|
"liquor-tree": "^0.2.70",
|
||||||
"markdown-it": "^13.0.1",
|
"markdown-it": "^13.0.1",
|
||||||
"npm": "^9.8.1",
|
"npm": "^9.8.1",
|
||||||
"vue": "^2.7.14"
|
"v-tooltip": "2.1.3",
|
||||||
|
"vue": "^2.7.14",
|
||||||
|
"vue-class-component": "^7.2.6",
|
||||||
|
"vue-js-modal": "^2.0.1",
|
||||||
|
"vue-property-decorator": "^9.1.2"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@modyfi/vite-plugin-yaml": "^1.0.4",
|
|
||||||
"@rushstack/eslint-patch": "^1.3.2",
|
"@rushstack/eslint-patch": "^1.3.2",
|
||||||
"@types/ace": "^0.0.48",
|
"@types/ace": "^0.0.48",
|
||||||
|
"@types/chai": "^4.3.5",
|
||||||
"@types/file-saver": "^2.0.5",
|
"@types/file-saver": "^2.0.5",
|
||||||
|
"@types/mocha": "^10.0.1",
|
||||||
"@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",
|
"@vue/cli-plugin-babel": "~5.0.8",
|
||||||
"@vitejs/plugin-vue2": "^2.2.0",
|
"@vue/cli-plugin-e2e-cypress": "~5.0.8",
|
||||||
|
"@vue/cli-plugin-eslint": "~5.0.8",
|
||||||
|
"@vue/cli-plugin-typescript": "~5.0.8",
|
||||||
|
"@vue/cli-plugin-unit-mocha": "~5.0.8",
|
||||||
|
"@vue/cli-service": "~5.0.8",
|
||||||
"@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",
|
"chai": "^4.3.7",
|
||||||
"autoprefixer": "^10.4.15",
|
|
||||||
"cypress": "^12.17.2",
|
"cypress": "^12.17.2",
|
||||||
"electron": "^25.3.2",
|
"electron": "^25.3.2",
|
||||||
"electron-builder": "^24.6.3",
|
"electron-builder": "^24.6.3",
|
||||||
@@ -69,32 +70,32 @@
|
|||||||
"electron-icon-builder": "^2.0.1",
|
"electron-icon-builder": "^2.0.1",
|
||||||
"electron-log": "^4.4.8",
|
"electron-log": "^4.4.8",
|
||||||
"electron-updater": "^6.1.4",
|
"electron-updater": "^6.1.4",
|
||||||
"electron-vite": "^1.0.27",
|
|
||||||
"eslint": "^8.46.0",
|
"eslint": "^8.46.0",
|
||||||
"eslint-plugin-cypress": "^2.14.0",
|
"eslint-plugin-import": "^2.26.0",
|
||||||
"eslint-plugin-vue": "^9.6.0",
|
"eslint-plugin-vue": "^9.6.0",
|
||||||
"eslint-plugin-vuejs-accessibility": "^1.2.0",
|
"eslint-plugin-vuejs-accessibility": "^1.2.0",
|
||||||
"icon-gen": "^3.0.1",
|
"icon-gen": "^3.0.1",
|
||||||
"jsdom": "^22.1.0",
|
"js-yaml-loader": "^1.2.2",
|
||||||
"markdownlint-cli": "^0.35.0",
|
"markdownlint-cli": "^0.35.0",
|
||||||
"postcss": "^8.4.28",
|
|
||||||
"remark-cli": "^11.0.0",
|
"remark-cli": "^11.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": "^12.1.1",
|
||||||
"sass": "^1.64.1",
|
"sass": "^1.64.1",
|
||||||
"start-server-and-test": "^2.0.0",
|
"sass-loader": "^13.3.2",
|
||||||
"svgexport": "^0.4.2",
|
"svgexport": "^0.4.2",
|
||||||
"terser": "^5.19.2",
|
"ts-loader": "^9.4.4",
|
||||||
"tslib": "~2.4.0",
|
|
||||||
"typescript": "~4.6.2",
|
"typescript": "~4.6.2",
|
||||||
"vite": "^4.4.9",
|
"vue-cli-plugin-electron-builder": "^3.0.0-alpha.4",
|
||||||
"vitest": "^0.34.2",
|
"yaml-lint": "^1.7.0",
|
||||||
"vue-tsc": "^1.8.8",
|
"tslib": "~2.4.0"
|
||||||
"yaml-lint": "^1.7.0"
|
},
|
||||||
|
"overrides": {
|
||||||
|
"vue-cli-plugin-electron-builder": {
|
||||||
|
"electron-builder": "^24.6.3"
|
||||||
|
}
|
||||||
},
|
},
|
||||||
"//devDependencies": {
|
"//devDependencies": {
|
||||||
"terser": "Used by @vitejs/plugin-legacy for minification",
|
|
||||||
"typescript": [
|
"typescript": [
|
||||||
"Cannot upgrade to 5.X.X due to unmaintained @vue/cli-plugin-typescript, https://github.com/vuejs/vue-cli/issues/7401",
|
"Cannot upgrade to 5.X.X due to unmaintained @vue/cli-plugin-typescript, https://github.com/vuejs/vue-cli/issues/7401",
|
||||||
"Cannot upgrade to > 4.6.X otherwise unit tests do not work, https://github.com/evanw/node-source-map-support/issues/252"
|
"Cannot upgrade to > 4.6.X otherwise unit tests do not work, https://github.com/evanw/node-source-map-support/issues/252"
|
||||||
|
|||||||
@@ -1,9 +0,0 @@
|
|||||||
const autoprefixer = require('autoprefixer');
|
|
||||||
|
|
||||||
module.exports = () => {
|
|
||||||
return {
|
|
||||||
plugins: [
|
|
||||||
autoprefixer(),
|
|
||||||
],
|
|
||||||
};
|
|
||||||
};
|
|
||||||
5
postcss.config.js
Normal file
5
postcss.config.js
Normal file
@@ -0,0 +1,5 @@
|
|||||||
|
module.exports = {
|
||||||
|
plugins: {
|
||||||
|
autoprefixer: {},
|
||||||
|
},
|
||||||
|
};
|
||||||
|
Before Width: | Height: | Size: 353 KiB After Width: | Height: | Size: 353 KiB |
|
Before Width: | Height: | Size: 16 KiB After Width: | Height: | Size: 16 KiB |
@@ -1,4 +1,13 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html lang="en">
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<meta name="viewport" content="width=device-width,initial-scale=1.0">
|
||||||
|
<title>Privacy is sexy 🍑🍆 - Enforce privacy & security on Windows, macOS and Linux</title>
|
||||||
|
<meta name="robots" content="index,follow" />
|
||||||
|
<meta name="description" content="Web tool to generate scripts for enforcing privacy & security best-practices such as stopping data collection of Windows and different softwares on it."/>
|
||||||
|
<link rel="icon" href="<%= BASE_URL %>favicon.ico">
|
||||||
|
</head>
|
||||||
<body>
|
<body>
|
||||||
<noscript>
|
<noscript>
|
||||||
<style>
|
<style>
|
||||||
@@ -19,5 +28,7 @@
|
|||||||
<p>The page does not work without JavaScript enabled. Please enable it to use privacy.sexy. There's no shady stuff as 100% of the website is open source.</p>
|
<p>The page does not work without JavaScript enabled. Please enable it to use privacy.sexy. There's no shady stuff as 100% of the website is open source.</p>
|
||||||
</div>
|
</div>
|
||||||
</noscript>
|
</noscript>
|
||||||
<script type="module" src="/src/main.js"></script>
|
<div id="app"></div>
|
||||||
|
<!-- built files will be auto injected -->
|
||||||
</body>
|
</body>
|
||||||
|
</html>
|
||||||
95
scripts/fresh-npm-install.sh
Executable file
95
scripts/fresh-npm-install.sh
Executable file
@@ -0,0 +1,95 @@
|
|||||||
|
#!/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"
|
||||||
@@ -1,199 +0,0 @@
|
|||||||
/*
|
|
||||||
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();
|
|
||||||
@@ -1,58 +0,0 @@
|
|||||||
/**
|
|
||||||
* 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();
|
|
||||||
@@ -1,133 +0,0 @@
|
|||||||
/**
|
|
||||||
* 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();
|
|
||||||
@@ -1,16 +0,0 @@
|
|||||||
export type Constructible<T, TArgs extends unknown[] = never> = {
|
|
||||||
prototype: T;
|
|
||||||
apply: (this: unknown, args: TArgs) => void;
|
|
||||||
readonly name: string;
|
|
||||||
};
|
|
||||||
|
|
||||||
export type PropertyKeys<T> = {
|
|
||||||
[K in keyof T]: T[K] extends (...args: unknown[]) => unknown ? never : K;
|
|
||||||
}[keyof T];
|
|
||||||
|
|
||||||
export type ConstructorArguments<T> =
|
|
||||||
T extends new (...args: infer U) => unknown ? U : never;
|
|
||||||
|
|
||||||
export type FunctionKeys<T> = {
|
|
||||||
[K in keyof T]: T[K] extends (...args: unknown[]) => unknown ? K : never;
|
|
||||||
}[keyof T];
|
|
||||||
@@ -1,50 +0,0 @@
|
|||||||
/*
|
|
||||||
Provides a unified and resilient way to extend errors across platforms.
|
|
||||||
|
|
||||||
Rationale:
|
|
||||||
- Babel:
|
|
||||||
> "Built-in classes cannot be properly subclassed due to limitations in ES5"
|
|
||||||
> https://web.archive.org/web/20230810014108/https://babeljs.io/docs/caveats#classes
|
|
||||||
- TypeScript:
|
|
||||||
> "Extending built-ins like Error, Array, and Map may no longer work"
|
|
||||||
> https://web.archive.org/web/20230810014143/https://github.com/Microsoft/TypeScript-wiki/blob/main/Breaking-Changes.md#extending-built-ins-like-error-array-and-map-may-no-longer-work
|
|
||||||
*/
|
|
||||||
export abstract class CustomError extends Error {
|
|
||||||
constructor(message?: string, options?: ErrorOptions) {
|
|
||||||
super(message, options);
|
|
||||||
|
|
||||||
fixPrototype(this, new.target.prototype);
|
|
||||||
ensureStackTrace(this);
|
|
||||||
|
|
||||||
this.name = this.constructor.name;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
export const Environment = {
|
|
||||||
getSetPrototypeOf: () => Object.setPrototypeOf,
|
|
||||||
getCaptureStackTrace: () => Error.captureStackTrace,
|
|
||||||
};
|
|
||||||
|
|
||||||
function fixPrototype(target: Error, prototype: CustomError) {
|
|
||||||
// https://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-2.html#support-for-newtarget
|
|
||||||
const setPrototypeOf = Environment.getSetPrototypeOf();
|
|
||||||
if (!functionExists(setPrototypeOf)) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
setPrototypeOf(target, prototype);
|
|
||||||
}
|
|
||||||
|
|
||||||
function ensureStackTrace(target: Error) {
|
|
||||||
const captureStackTrace = Environment.getCaptureStackTrace();
|
|
||||||
if (!functionExists(captureStackTrace)) {
|
|
||||||
// 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.
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
captureStackTrace(target, target.constructor);
|
|
||||||
}
|
|
||||||
|
|
||||||
function functionExists(func: unknown): boolean {
|
|
||||||
// Not doing truthy/falsy check i.e. if(func) as most values are truthy in JS for robustness
|
|
||||||
return typeof func === 'function';
|
|
||||||
}
|
|
||||||
@@ -1,23 +1,25 @@
|
|||||||
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 { RuntimeEnvironment } from '@/infrastructure/RuntimeEnvironment/RuntimeEnvironment';
|
import { Environment } from '../Environment/Environment';
|
||||||
|
import { IEnvironment } from '../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 = RuntimeEnvironment.CurrentEnvironment,
|
environment = Environment.CurrentEnvironment,
|
||||||
): Promise<IApplicationContext> {
|
): Promise<IApplicationContext> {
|
||||||
if (!factory) { throw new Error('missing factory'); }
|
if (!factory) { throw new Error('missing factory'); }
|
||||||
if (!environment) { throw new Error('missing environment'); }
|
if (!environment) { throw new Error('missing environment'); }
|
||||||
const app = await factory.getApp();
|
const app = await factory.getApp();
|
||||||
const os = getInitialOs(app, environment.os);
|
const os = getInitialOs(app, environment);
|
||||||
return new ApplicationContext(app, os);
|
return new ApplicationContext(app, os);
|
||||||
}
|
}
|
||||||
|
|
||||||
function getInitialOs(app: IApplication, currentOs: OperatingSystem): OperatingSystem {
|
function getInitialOs(app: IApplication, environment: IEnvironment): OperatingSystem {
|
||||||
|
const currentOs = environment.os;
|
||||||
const supportedOsList = app.getSupportedOsList();
|
const supportedOsList = app.getSupportedOsList();
|
||||||
if (supportedOsList.includes(currentOs)) {
|
if (supportedOsList.includes(currentOs)) {
|
||||||
return currentOs;
|
return currentOs;
|
||||||
|
|||||||
@@ -1,4 +0,0 @@
|
|||||||
export enum FilterActionType {
|
|
||||||
Apply,
|
|
||||||
Clear,
|
|
||||||
}
|
|
||||||
@@ -1,37 +0,0 @@
|
|||||||
import { IFilterResult } from '@/application/Context/State/Filter/IFilterResult';
|
|
||||||
import { FilterActionType } from './FilterActionType';
|
|
||||||
import { IFilterChangeDetails, IFilterChangeDetailsVisitor } from './IFilterChangeDetails';
|
|
||||||
|
|
||||||
export class FilterChange implements IFilterChangeDetails {
|
|
||||||
public static forApply(filter: IFilterResult) {
|
|
||||||
if (!filter) {
|
|
||||||
throw new Error('missing filter');
|
|
||||||
}
|
|
||||||
return new FilterChange(FilterActionType.Apply, filter);
|
|
||||||
}
|
|
||||||
|
|
||||||
public static forClear() {
|
|
||||||
return new FilterChange(FilterActionType.Clear);
|
|
||||||
}
|
|
||||||
|
|
||||||
private constructor(
|
|
||||||
public readonly actionType: FilterActionType,
|
|
||||||
public readonly filter?: IFilterResult,
|
|
||||||
) { }
|
|
||||||
|
|
||||||
public visit(visitor: IFilterChangeDetailsVisitor): void {
|
|
||||||
if (!visitor) {
|
|
||||||
throw new Error('missing visitor');
|
|
||||||
}
|
|
||||||
switch (this.actionType) {
|
|
||||||
case FilterActionType.Apply:
|
|
||||||
visitor.onApply(this.filter);
|
|
||||||
break;
|
|
||||||
case FilterActionType.Clear:
|
|
||||||
visitor.onClear();
|
|
||||||
break;
|
|
||||||
default:
|
|
||||||
throw new Error(`Unknown action type: ${this.actionType}`);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,14 +0,0 @@
|
|||||||
import { IFilterResult } from '@/application/Context/State/Filter/IFilterResult';
|
|
||||||
import { FilterActionType } from './FilterActionType';
|
|
||||||
|
|
||||||
export interface IFilterChangeDetails {
|
|
||||||
readonly actionType: FilterActionType;
|
|
||||||
readonly filter?: IFilterResult;
|
|
||||||
|
|
||||||
visit(visitor: IFilterChangeDetailsVisitor): void;
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface IFilterChangeDetailsVisitor {
|
|
||||||
onClear(): void;
|
|
||||||
onApply(filter: IFilterResult): void;
|
|
||||||
}
|
|
||||||
@@ -1,13 +1,13 @@
|
|||||||
import { IEventSource } from '@/infrastructure/Events/IEventSource';
|
import { IEventSource } from '@/infrastructure/Events/IEventSource';
|
||||||
import { IFilterResult } from './IFilterResult';
|
import { IFilterResult } from './IFilterResult';
|
||||||
import { IFilterChangeDetails } from './Event/IFilterChangeDetails';
|
|
||||||
|
|
||||||
export interface IReadOnlyUserFilter {
|
export interface IReadOnlyUserFilter {
|
||||||
readonly currentFilter: IFilterResult | undefined;
|
readonly currentFilter: IFilterResult | undefined;
|
||||||
readonly filterChanged: IEventSource<IFilterChangeDetails>;
|
readonly filtered: IEventSource<IFilterResult>;
|
||||||
|
readonly filterRemoved: IEventSource<void>;
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface IUserFilter extends IReadOnlyUserFilter {
|
export interface IUserFilter extends IReadOnlyUserFilter {
|
||||||
applyFilter(filter: string): void;
|
setFilter(filter: string): void;
|
||||||
clearFilter(): void;
|
removeFilter(): void;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -4,11 +4,11 @@ import { ICategoryCollection } from '@/domain/ICategoryCollection';
|
|||||||
import { FilterResult } from './FilterResult';
|
import { FilterResult } from './FilterResult';
|
||||||
import { IFilterResult } from './IFilterResult';
|
import { IFilterResult } from './IFilterResult';
|
||||||
import { IUserFilter } from './IUserFilter';
|
import { IUserFilter } from './IUserFilter';
|
||||||
import { IFilterChangeDetails } from './Event/IFilterChangeDetails';
|
|
||||||
import { FilterChange } from './Event/FilterChange';
|
|
||||||
|
|
||||||
export class UserFilter implements IUserFilter {
|
export class UserFilter implements IUserFilter {
|
||||||
public readonly filterChanged = new EventSource<IFilterChangeDetails>();
|
public readonly filtered = new EventSource<IFilterResult>();
|
||||||
|
|
||||||
|
public readonly filterRemoved = new EventSource<void>();
|
||||||
|
|
||||||
public currentFilter: IFilterResult | undefined;
|
public currentFilter: IFilterResult | undefined;
|
||||||
|
|
||||||
@@ -16,9 +16,9 @@ export class UserFilter implements IUserFilter {
|
|||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
public applyFilter(filter: string): void {
|
public setFilter(filter: string): void {
|
||||||
if (!filter) {
|
if (!filter) {
|
||||||
throw new Error('Filter must be defined and not empty. Use clearFilter() to remove the filter');
|
throw new Error('Filter must be defined and not empty. Use removeFilter() to remove the filter');
|
||||||
}
|
}
|
||||||
const filterLowercase = filter.toLocaleLowerCase();
|
const filterLowercase = filter.toLocaleLowerCase();
|
||||||
const filteredScripts = this.collection.getAllScripts().filter(
|
const filteredScripts = this.collection.getAllScripts().filter(
|
||||||
@@ -33,12 +33,12 @@ export class UserFilter implements IUserFilter {
|
|||||||
filter,
|
filter,
|
||||||
);
|
);
|
||||||
this.currentFilter = matches;
|
this.currentFilter = matches;
|
||||||
this.filterChanged.notify(FilterChange.forApply(this.currentFilter));
|
this.filtered.notify(matches);
|
||||||
}
|
}
|
||||||
|
|
||||||
public clearFilter(): void {
|
public removeFilter(): void {
|
||||||
this.currentFilter = undefined;
|
this.currentFilter = undefined;
|
||||||
this.filterChanged.notify(FilterChange.forClear());
|
this.filterRemoved.notify();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
89
src/application/Environment/Environment.ts
Normal file
89
src/application/Environment/Environment.ts
Normal file
@@ -0,0 +1,89 @@
|
|||||||
|
import { OperatingSystem } from '@/domain/OperatingSystem';
|
||||||
|
import { BrowserOsDetector } from './BrowserOs/BrowserOsDetector';
|
||||||
|
import { IBrowserOsDetector } from './BrowserOs/IBrowserOsDetector';
|
||||||
|
import { IEnvironment } from './IEnvironment';
|
||||||
|
|
||||||
|
export interface IEnvironmentVariables {
|
||||||
|
readonly window: Window & typeof globalThis;
|
||||||
|
readonly process: NodeJS.Process;
|
||||||
|
readonly navigator: Navigator;
|
||||||
|
}
|
||||||
|
|
||||||
|
export class Environment implements IEnvironment {
|
||||||
|
public static readonly CurrentEnvironment: IEnvironment = new Environment({
|
||||||
|
window,
|
||||||
|
process: typeof process !== 'undefined' ? process /* electron only */ : undefined,
|
||||||
|
navigator,
|
||||||
|
});
|
||||||
|
|
||||||
|
public readonly isDesktop: boolean;
|
||||||
|
|
||||||
|
public readonly os: OperatingSystem;
|
||||||
|
|
||||||
|
protected constructor(
|
||||||
|
variables: IEnvironmentVariables,
|
||||||
|
browserOsDetector: IBrowserOsDetector = new BrowserOsDetector(),
|
||||||
|
) {
|
||||||
|
if (!variables) {
|
||||||
|
throw new Error('variables is null or empty');
|
||||||
|
}
|
||||||
|
this.isDesktop = isDesktop(variables);
|
||||||
|
if (this.isDesktop) {
|
||||||
|
this.os = getDesktopOsType(getProcessPlatform(variables));
|
||||||
|
} else {
|
||||||
|
const userAgent = getUserAgent(variables);
|
||||||
|
this.os = !userAgent ? undefined : browserOsDetector.detect(userAgent);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function getUserAgent(variables: IEnvironmentVariables): string {
|
||||||
|
if (!variables.window || !variables.window.navigator) {
|
||||||
|
return undefined;
|
||||||
|
}
|
||||||
|
return variables.window.navigator.userAgent;
|
||||||
|
}
|
||||||
|
|
||||||
|
function getProcessPlatform(variables: IEnvironmentVariables): string {
|
||||||
|
if (!variables.process || !variables.process.platform) {
|
||||||
|
return undefined;
|
||||||
|
}
|
||||||
|
return variables.process.platform;
|
||||||
|
}
|
||||||
|
|
||||||
|
function getDesktopOsType(processPlatform: string): OperatingSystem | undefined {
|
||||||
|
// https://nodejs.org/api/process.html#process_process_platform
|
||||||
|
switch (processPlatform) {
|
||||||
|
case 'darwin':
|
||||||
|
return OperatingSystem.macOS;
|
||||||
|
case 'win32':
|
||||||
|
return OperatingSystem.Windows;
|
||||||
|
case 'linux':
|
||||||
|
return OperatingSystem.Linux;
|
||||||
|
default:
|
||||||
|
return undefined;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function isDesktop(variables: IEnvironmentVariables): boolean {
|
||||||
|
// More: https://github.com/electron/electron/issues/2288
|
||||||
|
// Renderer process
|
||||||
|
if (variables.window
|
||||||
|
&& variables.window.process
|
||||||
|
&& variables.window.process.type === 'renderer') {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
// Main process
|
||||||
|
if (variables.process
|
||||||
|
&& variables.process.versions
|
||||||
|
&& Boolean(variables.process.versions.electron)) {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
// Detect the user agent when the `nodeIntegration` option is set to true
|
||||||
|
if (variables.navigator
|
||||||
|
&& variables.navigator.userAgent
|
||||||
|
&& variables.navigator.userAgent.includes('Electron')) {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
return false;
|
||||||
|
}
|
||||||
6
src/application/Environment/IEnvironment.ts
Normal file
6
src/application/Environment/IEnvironment.ts
Normal file
@@ -0,0 +1,6 @@
|
|||||||
|
import { OperatingSystem } from '@/domain/OperatingSystem';
|
||||||
|
|
||||||
|
export interface IEnvironment {
|
||||||
|
readonly isDesktop: boolean;
|
||||||
|
readonly os: OperatingSystem;
|
||||||
|
}
|
||||||
@@ -7,19 +7,16 @@ 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/EnvironmentVariables/IAppMetadata';
|
|
||||||
import { EnvironmentVariablesFactory } from '@/infrastructure/EnvironmentVariables/EnvironmentVariablesFactory';
|
|
||||||
import { parseCategoryCollection } from './CategoryCollectionParser';
|
import { parseCategoryCollection } from './CategoryCollectionParser';
|
||||||
|
|
||||||
export function parseApplication(
|
export function parseApplication(
|
||||||
categoryParser = parseCategoryCollection,
|
parser = CategoryCollectionParser,
|
||||||
informationParser = parseProjectInformation,
|
processEnv: NodeJS.ProcessEnv = process.env,
|
||||||
metadata: IAppMetadata = EnvironmentVariablesFactory.Current.instance,
|
|
||||||
collectionsData = PreParsedCollections,
|
collectionsData = PreParsedCollections,
|
||||||
): IApplication {
|
): IApplication {
|
||||||
validateCollectionsData(collectionsData);
|
validateCollectionsData(collectionsData);
|
||||||
const information = informationParser(metadata);
|
const information = parseProjectInformation(processEnv);
|
||||||
const collections = collectionsData.map((collection) => categoryParser(collection, information));
|
const collections = collectionsData.map((collection) => parser(collection, information));
|
||||||
const app = new Application(information, collections);
|
const app = new Application(information, collections);
|
||||||
return app;
|
return app;
|
||||||
}
|
}
|
||||||
@@ -27,12 +24,16 @@ export function parseApplication(
|
|||||||
export type CategoryCollectionParserType
|
export type CategoryCollectionParserType
|
||||||
= (file: CollectionData, info: IProjectInformation) => ICategoryCollection;
|
= (file: CollectionData, info: IProjectInformation) => ICategoryCollection;
|
||||||
|
|
||||||
|
const CategoryCollectionParser: CategoryCollectionParserType = (file, info) => {
|
||||||
|
return parseCategoryCollection(file, info);
|
||||||
|
};
|
||||||
|
|
||||||
const PreParsedCollections: readonly CollectionData [] = [
|
const PreParsedCollections: readonly CollectionData [] = [
|
||||||
WindowsData, MacOsData, LinuxData,
|
WindowsData, MacOsData, LinuxData,
|
||||||
];
|
];
|
||||||
|
|
||||||
function validateCollectionsData(collections: readonly CollectionData[]) {
|
function validateCollectionsData(collections: readonly CollectionData[]) {
|
||||||
if (!collections?.length) {
|
if (!collections || !collections.length) {
|
||||||
throw new Error('missing collections');
|
throw new Error('missing collections');
|
||||||
}
|
}
|
||||||
if (collections.some((collection) => !collection)) {
|
if (collections.some((collection) => !collection)) {
|
||||||
|
|||||||
@@ -1,10 +1,11 @@
|
|||||||
import { CustomError } from '@/application/Common/CustomError';
|
|
||||||
import { NodeType } from './NodeType';
|
import { NodeType } from './NodeType';
|
||||||
import { NodeData } from './NodeData';
|
import { NodeData } from './NodeData';
|
||||||
|
|
||||||
export class NodeDataError extends CustomError {
|
export class NodeDataError extends Error {
|
||||||
constructor(message: string, public readonly context: INodeDataErrorContext) {
|
constructor(message: string, public readonly context: INodeDataErrorContext) {
|
||||||
super(createMessage(message, context));
|
super(createMessage(message, context));
|
||||||
|
Object.setPrototypeOf(this, new.target.prototype); // https://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-2.html#support-for-newtarget
|
||||||
|
this.name = new.target.name;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -1,29 +1,28 @@
|
|||||||
import { IProjectInformation } from '@/domain/IProjectInformation';
|
import { IProjectInformation } from '@/domain/IProjectInformation';
|
||||||
import { ProjectInformation } from '@/domain/ProjectInformation';
|
import { ProjectInformation } from '@/domain/ProjectInformation';
|
||||||
import { IAppMetadata } from '@/infrastructure/EnvironmentVariables/IAppMetadata';
|
|
||||||
import { Version } from '@/domain/Version';
|
import { Version } from '@/domain/Version';
|
||||||
import { EnvironmentVariablesFactory } from '@/infrastructure/EnvironmentVariables/EnvironmentVariablesFactory';
|
|
||||||
import { ConstructorArguments } from '@/TypeHelpers';
|
|
||||||
|
|
||||||
export function
|
export function parseProjectInformation(
|
||||||
parseProjectInformation(
|
environment: NodeJS.ProcessEnv | VueAppEnvironment,
|
||||||
metadata: IAppMetadata = EnvironmentVariablesFactory.Current.instance,
|
|
||||||
createProjectInformation: ProjectInformationFactory = (
|
|
||||||
...args
|
|
||||||
) => new ProjectInformation(...args),
|
|
||||||
): IProjectInformation {
|
): IProjectInformation {
|
||||||
const version = new Version(
|
const version = new Version(environment[VueAppEnvironmentKeys.VUE_APP_VERSION]);
|
||||||
metadata.version,
|
return new ProjectInformation(
|
||||||
);
|
environment[VueAppEnvironmentKeys.VUE_APP_NAME],
|
||||||
return createProjectInformation(
|
|
||||||
metadata.name,
|
|
||||||
version,
|
version,
|
||||||
metadata.slogan,
|
environment[VueAppEnvironmentKeys.VUE_APP_SLOGAN],
|
||||||
metadata.repositoryUrl,
|
environment[VueAppEnvironmentKeys.VUE_APP_REPOSITORY_URL],
|
||||||
metadata.homepageUrl,
|
environment[VueAppEnvironmentKeys.VUE_APP_HOMEPAGE_URL],
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
export type ProjectInformationFactory = (
|
export const VueAppEnvironmentKeys = {
|
||||||
...args: ConstructorArguments<typeof ProjectInformation>
|
VUE_APP_VERSION: 'VUE_APP_VERSION',
|
||||||
) => IProjectInformation;
|
VUE_APP_NAME: 'VUE_APP_NAME',
|
||||||
|
VUE_APP_SLOGAN: 'VUE_APP_SLOGAN',
|
||||||
|
VUE_APP_REPOSITORY_URL: 'VUE_APP_REPOSITORY_URL',
|
||||||
|
VUE_APP_HOMEPAGE_URL: 'VUE_APP_HOMEPAGE_URL',
|
||||||
|
} as const;
|
||||||
|
|
||||||
|
export type VueAppEnvironment = {
|
||||||
|
[K in keyof typeof VueAppEnvironmentKeys]: string;
|
||||||
|
};
|
||||||
|
|||||||
@@ -1,5 +0,0 @@
|
|||||||
import { CompiledCode } from '../CompiledCode';
|
|
||||||
|
|
||||||
export interface CodeSegmentMerger {
|
|
||||||
mergeCodeParts(codeSegments: readonly CompiledCode[]): CompiledCode;
|
|
||||||
}
|
|
||||||
@@ -1,20 +0,0 @@
|
|||||||
import { CompiledCode } from '../CompiledCode';
|
|
||||||
import { CodeSegmentMerger } from './CodeSegmentMerger';
|
|
||||||
|
|
||||||
export class NewlineCodeSegmentMerger implements CodeSegmentMerger {
|
|
||||||
public mergeCodeParts(codeSegments: readonly CompiledCode[]): CompiledCode {
|
|
||||||
if (!codeSegments?.length) {
|
|
||||||
throw new Error('missing segments');
|
|
||||||
}
|
|
||||||
return {
|
|
||||||
code: joinCodeParts(codeSegments.map((f) => f.code)),
|
|
||||||
revertCode: joinCodeParts(codeSegments.map((f) => f.revertCode)),
|
|
||||||
};
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
function joinCodeParts(codeSegments: readonly string[]): string {
|
|
||||||
return codeSegments
|
|
||||||
.filter((segment) => segment?.length > 0)
|
|
||||||
.join('\n');
|
|
||||||
}
|
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
import { ISharedFunctionCollection } from '@/application/Parser/Script/Compiler/Function/ISharedFunctionCollection';
|
|
||||||
import { FunctionCall } from '../FunctionCall';
|
|
||||||
import type { SingleCallCompiler } from './SingleCall/SingleCallCompiler';
|
|
||||||
|
|
||||||
export interface FunctionCallCompilationContext {
|
|
||||||
readonly allFunctions: ISharedFunctionCollection;
|
|
||||||
readonly rootCallSequence: readonly FunctionCall[];
|
|
||||||
readonly singleCallCompiler: SingleCallCompiler;
|
|
||||||
}
|
|
||||||
@@ -1,10 +1,149 @@
|
|||||||
import { ISharedFunctionCollection } from '@/application/Parser/Script/Compiler/Function/ISharedFunctionCollection';
|
import { IReadOnlyFunctionCallArgumentCollection } from '@/application/Parser/Script/Compiler/Function/Call/Argument/IFunctionCallArgumentCollection';
|
||||||
|
import { IFunctionCall } from '@/application/Parser/Script/Compiler/Function/Call/IFunctionCall';
|
||||||
|
import { FunctionCallArgument } from '@/application/Parser/Script/Compiler/Function/Call/Argument/FunctionCallArgument';
|
||||||
|
import { ISharedFunctionCollection } from '../../ISharedFunctionCollection';
|
||||||
|
import { IExpressionsCompiler } from '../../../Expressions/IExpressionsCompiler';
|
||||||
|
import { ExpressionsCompiler } from '../../../Expressions/ExpressionsCompiler';
|
||||||
|
import { ISharedFunction, IFunctionCode } from '../../ISharedFunction';
|
||||||
import { FunctionCall } from '../FunctionCall';
|
import { FunctionCall } from '../FunctionCall';
|
||||||
import { CompiledCode } from './CompiledCode';
|
import { FunctionCallArgumentCollection } from '../Argument/FunctionCallArgumentCollection';
|
||||||
|
import { IFunctionCallCompiler } from './IFunctionCallCompiler';
|
||||||
|
import { ICompiledCode } from './ICompiledCode';
|
||||||
|
|
||||||
export interface FunctionCallCompiler {
|
export class FunctionCallCompiler implements IFunctionCallCompiler {
|
||||||
compileFunctionCalls(
|
public static readonly instance: IFunctionCallCompiler = new FunctionCallCompiler();
|
||||||
calls: readonly FunctionCall[],
|
|
||||||
|
protected constructor(
|
||||||
|
private readonly expressionsCompiler: IExpressionsCompiler = new ExpressionsCompiler(),
|
||||||
|
) {
|
||||||
|
}
|
||||||
|
|
||||||
|
public compileCall(
|
||||||
|
calls: IFunctionCall[],
|
||||||
functions: ISharedFunctionCollection,
|
functions: ISharedFunctionCollection,
|
||||||
): CompiledCode;
|
): ICompiledCode {
|
||||||
|
if (!functions) { throw new Error('missing functions'); }
|
||||||
|
if (!calls) { throw new Error('missing calls'); }
|
||||||
|
if (calls.some((f) => !f)) { throw new Error('missing function call'); }
|
||||||
|
const context: ICompilationContext = {
|
||||||
|
allFunctions: functions,
|
||||||
|
callSequence: calls,
|
||||||
|
expressionsCompiler: this.expressionsCompiler,
|
||||||
|
};
|
||||||
|
const code = compileCallSequence(context);
|
||||||
|
return code;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
interface ICompilationContext {
|
||||||
|
allFunctions: ISharedFunctionCollection;
|
||||||
|
callSequence: readonly IFunctionCall[];
|
||||||
|
expressionsCompiler: IExpressionsCompiler;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface ICompiledFunctionCall {
|
||||||
|
readonly code: string;
|
||||||
|
readonly revertCode: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
function compileCallSequence(context: ICompilationContext): ICompiledFunctionCall {
|
||||||
|
const compiledFunctions = context.callSequence
|
||||||
|
.flatMap((call) => compileSingleCall(call, context));
|
||||||
|
return {
|
||||||
|
code: merge(compiledFunctions.map((f) => f.code)),
|
||||||
|
revertCode: merge(compiledFunctions.map((f) => f.revertCode)),
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
function compileSingleCall(
|
||||||
|
call: IFunctionCall,
|
||||||
|
context: ICompilationContext,
|
||||||
|
): ICompiledFunctionCall[] {
|
||||||
|
const func = context.allFunctions.getFunctionByName(call.functionName);
|
||||||
|
ensureThatCallArgumentsExistInParameterDefinition(func, call.args);
|
||||||
|
if (func.body.code) { // Function with inline code
|
||||||
|
const compiledCode = compileCode(func.body.code, call.args, context.expressionsCompiler);
|
||||||
|
return [compiledCode];
|
||||||
|
}
|
||||||
|
// Function with inner calls
|
||||||
|
return func.body.calls
|
||||||
|
.map((innerCall) => {
|
||||||
|
const compiledArgs = compileArgs(innerCall.args, call.args, context.expressionsCompiler);
|
||||||
|
const compiledCall = new FunctionCall(innerCall.functionName, compiledArgs);
|
||||||
|
return compileSingleCall(compiledCall, context);
|
||||||
|
})
|
||||||
|
.flat();
|
||||||
|
}
|
||||||
|
|
||||||
|
function compileCode(
|
||||||
|
code: IFunctionCode,
|
||||||
|
args: IReadOnlyFunctionCallArgumentCollection,
|
||||||
|
compiler: IExpressionsCompiler,
|
||||||
|
): ICompiledFunctionCall {
|
||||||
|
return {
|
||||||
|
code: compiler.compileExpressions(code.execute, args),
|
||||||
|
revertCode: compiler.compileExpressions(code.revert, args),
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
function compileArgs(
|
||||||
|
argsToCompile: IReadOnlyFunctionCallArgumentCollection,
|
||||||
|
args: IReadOnlyFunctionCallArgumentCollection,
|
||||||
|
compiler: IExpressionsCompiler,
|
||||||
|
): IReadOnlyFunctionCallArgumentCollection {
|
||||||
|
return argsToCompile
|
||||||
|
.getAllParameterNames()
|
||||||
|
.map((parameterName) => {
|
||||||
|
const { argumentValue } = argsToCompile.getArgument(parameterName);
|
||||||
|
const compiledValue = compiler.compileExpressions(argumentValue, args);
|
||||||
|
return new FunctionCallArgument(parameterName, compiledValue);
|
||||||
|
})
|
||||||
|
.reduce((compiledArgs, arg) => {
|
||||||
|
compiledArgs.addArgument(arg);
|
||||||
|
return compiledArgs;
|
||||||
|
}, new FunctionCallArgumentCollection());
|
||||||
|
}
|
||||||
|
|
||||||
|
function merge(codeParts: readonly string[]): string {
|
||||||
|
return codeParts
|
||||||
|
.filter((part) => part?.length > 0)
|
||||||
|
.join('\n');
|
||||||
|
}
|
||||||
|
|
||||||
|
function ensureThatCallArgumentsExistInParameterDefinition(
|
||||||
|
func: ISharedFunction,
|
||||||
|
args: IReadOnlyFunctionCallArgumentCollection,
|
||||||
|
): void {
|
||||||
|
const callArgumentNames = args.getAllParameterNames();
|
||||||
|
const functionParameterNames = func.parameters.all.map((param) => param.name) || [];
|
||||||
|
const unexpectedParameters = findUnexpectedParameters(callArgumentNames, functionParameterNames);
|
||||||
|
throwIfNotEmpty(func.name, unexpectedParameters, functionParameterNames);
|
||||||
|
}
|
||||||
|
|
||||||
|
function findUnexpectedParameters(
|
||||||
|
callArgumentNames: string[],
|
||||||
|
functionParameterNames: string[],
|
||||||
|
): string[] {
|
||||||
|
if (!callArgumentNames.length && !functionParameterNames.length) {
|
||||||
|
return [];
|
||||||
|
}
|
||||||
|
return callArgumentNames
|
||||||
|
.filter((callParam) => !functionParameterNames.includes(callParam));
|
||||||
|
}
|
||||||
|
|
||||||
|
function throwIfNotEmpty(
|
||||||
|
functionName: string,
|
||||||
|
unexpectedParameters: string[],
|
||||||
|
expectedParameters: string[],
|
||||||
|
) {
|
||||||
|
if (!unexpectedParameters.length) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
throw new Error(
|
||||||
|
// eslint-disable-next-line prefer-template
|
||||||
|
`Function "${functionName}" has unexpected parameter(s) provided: `
|
||||||
|
+ `"${unexpectedParameters.join('", "')}"`
|
||||||
|
+ '. Expected parameter(s): '
|
||||||
|
+ (expectedParameters.length ? `"${expectedParameters.join('", "')}"` : 'none'),
|
||||||
|
);
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,36 +0,0 @@
|
|||||||
import { FunctionCall } from '@/application/Parser/Script/Compiler/Function/Call/FunctionCall';
|
|
||||||
import { ISharedFunctionCollection } from '../../ISharedFunctionCollection';
|
|
||||||
import { FunctionCallCompiler } from './FunctionCallCompiler';
|
|
||||||
import { CompiledCode } from './CompiledCode';
|
|
||||||
import { FunctionCallCompilationContext } from './FunctionCallCompilationContext';
|
|
||||||
import { SingleCallCompiler } from './SingleCall/SingleCallCompiler';
|
|
||||||
import { AdaptiveFunctionCallCompiler } from './SingleCall/AdaptiveFunctionCallCompiler';
|
|
||||||
import { CodeSegmentMerger } from './CodeSegmentJoin/CodeSegmentMerger';
|
|
||||||
import { NewlineCodeSegmentMerger } from './CodeSegmentJoin/NewlineCodeSegmentMerger';
|
|
||||||
|
|
||||||
export class FunctionCallSequenceCompiler implements FunctionCallCompiler {
|
|
||||||
public static readonly instance: FunctionCallCompiler = new FunctionCallSequenceCompiler();
|
|
||||||
|
|
||||||
/* The constructor is protected to enforce the singleton pattern. */
|
|
||||||
protected constructor(
|
|
||||||
private readonly singleCallCompiler: SingleCallCompiler = new AdaptiveFunctionCallCompiler(),
|
|
||||||
private readonly codeSegmentMerger: CodeSegmentMerger = new NewlineCodeSegmentMerger(),
|
|
||||||
) { }
|
|
||||||
|
|
||||||
public compileFunctionCalls(
|
|
||||||
calls: readonly FunctionCall[],
|
|
||||||
functions: ISharedFunctionCollection,
|
|
||||||
): CompiledCode {
|
|
||||||
if (!functions) { throw new Error('missing functions'); }
|
|
||||||
if (!calls?.length) { throw new Error('missing calls'); }
|
|
||||||
if (calls.some((f) => !f)) { throw new Error('missing function call'); }
|
|
||||||
const context: FunctionCallCompilationContext = {
|
|
||||||
allFunctions: functions,
|
|
||||||
rootCallSequence: calls,
|
|
||||||
singleCallCompiler: this.singleCallCompiler,
|
|
||||||
};
|
|
||||||
const codeSegments = context.rootCallSequence
|
|
||||||
.flatMap((call) => this.singleCallCompiler.compileSingleCall(call, context));
|
|
||||||
return this.codeSegmentMerger.mergeCodeParts(codeSegments);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
export interface CompiledCode {
|
export interface ICompiledCode {
|
||||||
readonly code: string;
|
readonly code: string;
|
||||||
readonly revertCode?: string;
|
readonly revertCode?: string;
|
||||||
}
|
}
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
import { ISharedFunctionCollection } from '@/application/Parser/Script/Compiler/Function/ISharedFunctionCollection';
|
||||||
|
import { IFunctionCall } from '../IFunctionCall';
|
||||||
|
import { ICompiledCode } from './ICompiledCode';
|
||||||
|
|
||||||
|
export interface IFunctionCallCompiler {
|
||||||
|
compileCall(
|
||||||
|
calls: IFunctionCall[],
|
||||||
|
functions: ISharedFunctionCollection): ICompiledCode;
|
||||||
|
}
|
||||||
@@ -1,78 +0,0 @@
|
|||||||
import { FunctionCall } from '../../FunctionCall';
|
|
||||||
import { CompiledCode } from '../CompiledCode';
|
|
||||||
import { FunctionCallCompilationContext } from '../FunctionCallCompilationContext';
|
|
||||||
import { IReadOnlyFunctionCallArgumentCollection } from '../../Argument/IFunctionCallArgumentCollection';
|
|
||||||
import { ISharedFunction } from '../../../ISharedFunction';
|
|
||||||
import { SingleCallCompiler } from './SingleCallCompiler';
|
|
||||||
import { SingleCallCompilerStrategy } from './SingleCallCompilerStrategy';
|
|
||||||
import { InlineFunctionCallCompiler } from './Strategies/InlineFunctionCallCompiler';
|
|
||||||
import { NestedFunctionCallCompiler } from './Strategies/NestedFunctionCallCompiler';
|
|
||||||
|
|
||||||
export class AdaptiveFunctionCallCompiler implements SingleCallCompiler {
|
|
||||||
public constructor(
|
|
||||||
private readonly strategies: SingleCallCompilerStrategy[] = [
|
|
||||||
new InlineFunctionCallCompiler(),
|
|
||||||
new NestedFunctionCallCompiler(),
|
|
||||||
],
|
|
||||||
) {
|
|
||||||
}
|
|
||||||
|
|
||||||
public compileSingleCall(
|
|
||||||
call: FunctionCall,
|
|
||||||
context: FunctionCallCompilationContext,
|
|
||||||
): CompiledCode[] {
|
|
||||||
const func = context.allFunctions.getFunctionByName(call.functionName);
|
|
||||||
ensureThatCallArgumentsExistInParameterDefinition(func, call.args);
|
|
||||||
const strategy = this.findStrategy(func);
|
|
||||||
return strategy.compileFunction(func, call, context);
|
|
||||||
}
|
|
||||||
|
|
||||||
private findStrategy(func: ISharedFunction): SingleCallCompilerStrategy {
|
|
||||||
const strategies = this.strategies.filter((strategy) => strategy.canCompile(func));
|
|
||||||
if (strategies.length > 1) {
|
|
||||||
throw new Error('Multiple strategies found to compile the function call.');
|
|
||||||
}
|
|
||||||
if (strategies.length === 0) {
|
|
||||||
throw new Error('No strategies found to compile the function call.');
|
|
||||||
}
|
|
||||||
return strategies[0];
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
function ensureThatCallArgumentsExistInParameterDefinition(
|
|
||||||
func: ISharedFunction,
|
|
||||||
callArguments: IReadOnlyFunctionCallArgumentCollection,
|
|
||||||
): void {
|
|
||||||
const callArgumentNames = callArguments.getAllParameterNames();
|
|
||||||
const functionParameterNames = func.parameters.all.map((param) => param.name) || [];
|
|
||||||
const unexpectedParameters = findUnexpectedParameters(callArgumentNames, functionParameterNames);
|
|
||||||
throwIfUnexpectedParametersExist(func.name, unexpectedParameters, functionParameterNames);
|
|
||||||
}
|
|
||||||
|
|
||||||
function findUnexpectedParameters(
|
|
||||||
callArgumentNames: string[],
|
|
||||||
functionParameterNames: string[],
|
|
||||||
): string[] {
|
|
||||||
if (!callArgumentNames.length && !functionParameterNames.length) {
|
|
||||||
return [];
|
|
||||||
}
|
|
||||||
return callArgumentNames
|
|
||||||
.filter((callParam) => !functionParameterNames.includes(callParam));
|
|
||||||
}
|
|
||||||
|
|
||||||
function throwIfUnexpectedParametersExist(
|
|
||||||
functionName: string,
|
|
||||||
unexpectedParameters: string[],
|
|
||||||
expectedParameters: string[],
|
|
||||||
) {
|
|
||||||
if (!unexpectedParameters.length) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
throw new Error(
|
|
||||||
// eslint-disable-next-line prefer-template
|
|
||||||
`Function "${functionName}" has unexpected parameter(s) provided: `
|
|
||||||
+ `"${unexpectedParameters.join('", "')}"`
|
|
||||||
+ '. Expected parameter(s): '
|
|
||||||
+ (expectedParameters.length ? `"${expectedParameters.join('", "')}"` : 'none'),
|
|
||||||
);
|
|
||||||
}
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
import { FunctionCall } from '../../FunctionCall';
|
|
||||||
import { CompiledCode } from '../CompiledCode';
|
|
||||||
import { FunctionCallCompilationContext } from '../FunctionCallCompilationContext';
|
|
||||||
|
|
||||||
export interface SingleCallCompiler {
|
|
||||||
compileSingleCall(
|
|
||||||
call: FunctionCall,
|
|
||||||
context: FunctionCallCompilationContext,
|
|
||||||
): CompiledCode[];
|
|
||||||
}
|
|
||||||
@@ -1,13 +0,0 @@
|
|||||||
import { ISharedFunction } from '@/application/Parser/Script/Compiler/Function/ISharedFunction';
|
|
||||||
import { FunctionCall } from '@/application/Parser/Script/Compiler/Function/Call/FunctionCall';
|
|
||||||
import { CompiledCode } from '../CompiledCode';
|
|
||||||
import { FunctionCallCompilationContext } from '../FunctionCallCompilationContext';
|
|
||||||
|
|
||||||
export interface SingleCallCompilerStrategy {
|
|
||||||
canCompile(func: ISharedFunction): boolean;
|
|
||||||
compileFunction(
|
|
||||||
calledFunction: ISharedFunction,
|
|
||||||
callToFunction: FunctionCall,
|
|
||||||
context: FunctionCallCompilationContext,
|
|
||||||
): CompiledCode[],
|
|
||||||
}
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
import { FunctionCall } from '@/application/Parser/Script/Compiler/Function/Call/FunctionCall';
|
|
||||||
import { FunctionCallCompilationContext } from '@/application/Parser/Script/Compiler/Function/Call/Compiler/FunctionCallCompilationContext';
|
|
||||||
|
|
||||||
export interface ArgumentCompiler {
|
|
||||||
createCompiledNestedCall(
|
|
||||||
nestedFunctionCall: FunctionCall,
|
|
||||||
parentFunctionCall: FunctionCall,
|
|
||||||
context: FunctionCallCompilationContext,
|
|
||||||
): FunctionCall;
|
|
||||||
}
|
|
||||||
@@ -1,109 +0,0 @@
|
|||||||
import { IReadOnlyFunctionCallArgumentCollection } from '@/application/Parser/Script/Compiler/Function/Call/Argument/IFunctionCallArgumentCollection';
|
|
||||||
import { FunctionCallArgument } from '@/application/Parser/Script/Compiler/Function/Call/Argument/FunctionCallArgument';
|
|
||||||
import { FunctionCallArgumentCollection } from '@/application/Parser/Script/Compiler/Function/Call/Argument/FunctionCallArgumentCollection';
|
|
||||||
import { ExpressionsCompiler } from '@/application/Parser/Script/Compiler/Expressions/ExpressionsCompiler';
|
|
||||||
import { IExpressionsCompiler } from '@/application/Parser/Script/Compiler/Expressions/IExpressionsCompiler';
|
|
||||||
import { FunctionCall } from '@/application/Parser/Script/Compiler/Function/Call/FunctionCall';
|
|
||||||
import { FunctionCallCompilationContext } from '@/application/Parser/Script/Compiler/Function/Call/Compiler/FunctionCallCompilationContext';
|
|
||||||
import { ParsedFunctionCall } from '@/application/Parser/Script/Compiler/Function/Call/ParsedFunctionCall';
|
|
||||||
import { ArgumentCompiler } from './ArgumentCompiler';
|
|
||||||
|
|
||||||
export class NestedFunctionArgumentCompiler implements ArgumentCompiler {
|
|
||||||
constructor(
|
|
||||||
private readonly expressionsCompiler: IExpressionsCompiler = new ExpressionsCompiler(),
|
|
||||||
) { }
|
|
||||||
|
|
||||||
public createCompiledNestedCall(
|
|
||||||
nestedFunction: FunctionCall,
|
|
||||||
parentFunction: FunctionCall,
|
|
||||||
context: FunctionCallCompilationContext,
|
|
||||||
): FunctionCall {
|
|
||||||
const compiledArgs = compileNestedFunctionArguments(
|
|
||||||
nestedFunction,
|
|
||||||
parentFunction.args,
|
|
||||||
context,
|
|
||||||
this.expressionsCompiler,
|
|
||||||
);
|
|
||||||
const compiledCall = new ParsedFunctionCall(nestedFunction.functionName, compiledArgs);
|
|
||||||
return compiledCall;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
function compileNestedFunctionArguments(
|
|
||||||
nestedFunction: FunctionCall,
|
|
||||||
parentFunctionArgs: IReadOnlyFunctionCallArgumentCollection,
|
|
||||||
context: FunctionCallCompilationContext,
|
|
||||||
expressionsCompiler: IExpressionsCompiler,
|
|
||||||
): IReadOnlyFunctionCallArgumentCollection {
|
|
||||||
const requiredParameterNames = context
|
|
||||||
.allFunctions
|
|
||||||
.getRequiredParameterNames(nestedFunction.functionName);
|
|
||||||
const compiledArguments = nestedFunction.args
|
|
||||||
.getAllParameterNames()
|
|
||||||
// Compile each argument value
|
|
||||||
.map((paramName) => ({
|
|
||||||
parameterName: paramName,
|
|
||||||
compiledArgumentValue: compileArgument(
|
|
||||||
paramName,
|
|
||||||
nestedFunction,
|
|
||||||
parentFunctionArgs,
|
|
||||||
expressionsCompiler,
|
|
||||||
),
|
|
||||||
}))
|
|
||||||
// Filter out arguments with absent values
|
|
||||||
.filter(({
|
|
||||||
parameterName,
|
|
||||||
compiledArgumentValue,
|
|
||||||
}) => isValidNonAbsentArgumentValue(
|
|
||||||
parameterName,
|
|
||||||
compiledArgumentValue,
|
|
||||||
requiredParameterNames,
|
|
||||||
))
|
|
||||||
/*
|
|
||||||
Create argument object with non-absent values.
|
|
||||||
This is done after eliminating absent values because otherwise creating argument object
|
|
||||||
with absent values throws error.
|
|
||||||
*/
|
|
||||||
.map(({
|
|
||||||
parameterName,
|
|
||||||
compiledArgumentValue,
|
|
||||||
}) => new FunctionCallArgument(parameterName, compiledArgumentValue));
|
|
||||||
return buildArgumentCollectionFromArguments(compiledArguments);
|
|
||||||
}
|
|
||||||
|
|
||||||
function isValidNonAbsentArgumentValue(
|
|
||||||
parameterName: string,
|
|
||||||
argumentValue: string | undefined,
|
|
||||||
requiredParameterNames: string[],
|
|
||||||
): boolean {
|
|
||||||
if (argumentValue) {
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
if (!requiredParameterNames.includes(parameterName)) {
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
throw new Error(`Compilation resulted in empty value for required parameter: "${parameterName}"`);
|
|
||||||
}
|
|
||||||
|
|
||||||
function compileArgument(
|
|
||||||
parameterName: string,
|
|
||||||
nestedFunction: FunctionCall,
|
|
||||||
parentFunctionArgs: IReadOnlyFunctionCallArgumentCollection,
|
|
||||||
expressionsCompiler: IExpressionsCompiler,
|
|
||||||
): string {
|
|
||||||
try {
|
|
||||||
const { argumentValue: codeInArgument } = nestedFunction.args.getArgument(parameterName);
|
|
||||||
return expressionsCompiler.compileExpressions(codeInArgument, parentFunctionArgs);
|
|
||||||
} catch (err) {
|
|
||||||
throw new AggregateError([err], `Error when compiling argument for "${parameterName}"`);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
function buildArgumentCollectionFromArguments(
|
|
||||||
args: FunctionCallArgument[],
|
|
||||||
): FunctionCallArgumentCollection {
|
|
||||||
return args.reduce((compiledArgs, arg) => {
|
|
||||||
compiledArgs.addArgument(arg);
|
|
||||||
return compiledArgs;
|
|
||||||
}, new FunctionCallArgumentCollection());
|
|
||||||
}
|
|
||||||
@@ -1,31 +0,0 @@
|
|||||||
import { ExpressionsCompiler } from '@/application/Parser/Script/Compiler/Expressions/ExpressionsCompiler';
|
|
||||||
import { IExpressionsCompiler } from '@/application/Parser/Script/Compiler/Expressions/IExpressionsCompiler';
|
|
||||||
import { ISharedFunction } from '@/application/Parser/Script/Compiler/Function/ISharedFunction';
|
|
||||||
import { FunctionCall } from '@/application/Parser/Script/Compiler/Function/Call/FunctionCall';
|
|
||||||
import { CompiledCode } from '@/application/Parser/Script/Compiler/Function/Call/Compiler/CompiledCode';
|
|
||||||
import { SingleCallCompilerStrategy } from '../SingleCallCompilerStrategy';
|
|
||||||
|
|
||||||
export class InlineFunctionCallCompiler implements SingleCallCompilerStrategy {
|
|
||||||
public constructor(
|
|
||||||
private readonly expressionsCompiler: IExpressionsCompiler = new ExpressionsCompiler(),
|
|
||||||
) {
|
|
||||||
}
|
|
||||||
|
|
||||||
public canCompile(func: ISharedFunction): boolean {
|
|
||||||
return func.body.code !== undefined;
|
|
||||||
}
|
|
||||||
|
|
||||||
public compileFunction(
|
|
||||||
calledFunction: ISharedFunction,
|
|
||||||
callToFunction: FunctionCall,
|
|
||||||
): CompiledCode[] {
|
|
||||||
const { code } = calledFunction.body;
|
|
||||||
const { args } = callToFunction;
|
|
||||||
return [
|
|
||||||
{
|
|
||||||
code: this.expressionsCompiler.compileExpressions(code.execute, args),
|
|
||||||
revertCode: this.expressionsCompiler.compileExpressions(code.revert, args),
|
|
||||||
},
|
|
||||||
];
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,37 +0,0 @@
|
|||||||
import { ISharedFunction } from '@/application/Parser/Script/Compiler/Function/ISharedFunction';
|
|
||||||
import { FunctionCall } from '@/application/Parser/Script/Compiler/Function/Call/FunctionCall';
|
|
||||||
import { FunctionCallCompilationContext } from '@/application/Parser/Script/Compiler/Function/Call/Compiler/FunctionCallCompilationContext';
|
|
||||||
import { CompiledCode } from '@/application/Parser/Script/Compiler/Function/Call/Compiler/CompiledCode';
|
|
||||||
import { SingleCallCompilerStrategy } from '../SingleCallCompilerStrategy';
|
|
||||||
import { ArgumentCompiler } from './Argument/ArgumentCompiler';
|
|
||||||
import { NestedFunctionArgumentCompiler } from './Argument/NestedFunctionArgumentCompiler';
|
|
||||||
|
|
||||||
export class NestedFunctionCallCompiler implements SingleCallCompilerStrategy {
|
|
||||||
public constructor(
|
|
||||||
private readonly argumentCompiler: ArgumentCompiler = new NestedFunctionArgumentCompiler(),
|
|
||||||
) {
|
|
||||||
}
|
|
||||||
|
|
||||||
public canCompile(func: ISharedFunction): boolean {
|
|
||||||
return func.body.calls !== undefined;
|
|
||||||
}
|
|
||||||
|
|
||||||
public compileFunction(
|
|
||||||
calledFunction: ISharedFunction,
|
|
||||||
callToFunction: FunctionCall,
|
|
||||||
context: FunctionCallCompilationContext,
|
|
||||||
): CompiledCode[] {
|
|
||||||
const nestedCalls = calledFunction.body.calls;
|
|
||||||
return nestedCalls.map((nestedCall) => {
|
|
||||||
try {
|
|
||||||
const compiledParentCall = this.argumentCompiler
|
|
||||||
.createCompiledNestedCall(nestedCall, callToFunction, context);
|
|
||||||
const compiledNestedCall = context.singleCallCompiler
|
|
||||||
.compileSingleCall(compiledParentCall, context);
|
|
||||||
return compiledNestedCall;
|
|
||||||
} catch (err) {
|
|
||||||
throw new AggregateError([err], `Error with call to "${nestedCall.functionName}" function from "${callToFunction.functionName}" function`);
|
|
||||||
}
|
|
||||||
}).flat();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,6 +1,16 @@
|
|||||||
import { IReadOnlyFunctionCallArgumentCollection } from './Argument/IFunctionCallArgumentCollection';
|
import { IReadOnlyFunctionCallArgumentCollection } from './Argument/IFunctionCallArgumentCollection';
|
||||||
|
import { IFunctionCall } from './IFunctionCall';
|
||||||
|
|
||||||
export interface FunctionCall {
|
export class FunctionCall implements IFunctionCall {
|
||||||
readonly functionName: string;
|
constructor(
|
||||||
readonly args: IReadOnlyFunctionCallArgumentCollection;
|
public readonly functionName: string,
|
||||||
|
public readonly args: IReadOnlyFunctionCallArgumentCollection,
|
||||||
|
) {
|
||||||
|
if (!functionName) {
|
||||||
|
throw new Error('missing function name in function call');
|
||||||
|
}
|
||||||
|
if (!args) {
|
||||||
|
throw new Error('missing args');
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,10 +1,10 @@
|
|||||||
import type { FunctionCallData, FunctionCallsData, FunctionCallParametersData } from '@/application/collections/';
|
import type { FunctionCallData, FunctionCallsData, FunctionCallParametersData } from '@/application/collections/';
|
||||||
import { FunctionCall } from './FunctionCall';
|
import { IFunctionCall } from './IFunctionCall';
|
||||||
import { FunctionCallArgumentCollection } from './Argument/FunctionCallArgumentCollection';
|
import { FunctionCallArgumentCollection } from './Argument/FunctionCallArgumentCollection';
|
||||||
import { FunctionCallArgument } from './Argument/FunctionCallArgument';
|
import { FunctionCallArgument } from './Argument/FunctionCallArgument';
|
||||||
import { ParsedFunctionCall } from './ParsedFunctionCall';
|
import { FunctionCall } from './FunctionCall';
|
||||||
|
|
||||||
export function parseFunctionCalls(calls: FunctionCallsData): FunctionCall[] {
|
export function parseFunctionCalls(calls: FunctionCallsData): IFunctionCall[] {
|
||||||
if (calls === undefined) {
|
if (calls === undefined) {
|
||||||
throw new Error('missing call data');
|
throw new Error('missing call data');
|
||||||
}
|
}
|
||||||
@@ -22,12 +22,12 @@ function getCallSequence(calls: FunctionCallsData): FunctionCallData[] {
|
|||||||
return [calls as FunctionCallData];
|
return [calls as FunctionCallData];
|
||||||
}
|
}
|
||||||
|
|
||||||
function parseFunctionCall(call: FunctionCallData): FunctionCall {
|
function parseFunctionCall(call: FunctionCallData): IFunctionCall {
|
||||||
if (!call) {
|
if (!call) {
|
||||||
throw new Error('missing call data');
|
throw new Error('missing call data');
|
||||||
}
|
}
|
||||||
const callArgs = parseArgs(call.parameters);
|
const callArgs = parseArgs(call.parameters);
|
||||||
return new ParsedFunctionCall(call.function, callArgs);
|
return new FunctionCall(call.function, callArgs);
|
||||||
}
|
}
|
||||||
|
|
||||||
function parseArgs(
|
function parseArgs(
|
||||||
|
|||||||
@@ -0,0 +1,6 @@
|
|||||||
|
import { IReadOnlyFunctionCallArgumentCollection } from './Argument/IFunctionCallArgumentCollection';
|
||||||
|
|
||||||
|
export interface IFunctionCall {
|
||||||
|
readonly functionName: string;
|
||||||
|
readonly args: IReadOnlyFunctionCallArgumentCollection;
|
||||||
|
}
|
||||||
@@ -1,16 +0,0 @@
|
|||||||
import { IReadOnlyFunctionCallArgumentCollection } from './Argument/IFunctionCallArgumentCollection';
|
|
||||||
import { FunctionCall } from './FunctionCall';
|
|
||||||
|
|
||||||
export class ParsedFunctionCall implements FunctionCall {
|
|
||||||
constructor(
|
|
||||||
public readonly functionName: string,
|
|
||||||
public readonly args: IReadOnlyFunctionCallArgumentCollection,
|
|
||||||
) {
|
|
||||||
if (!functionName) {
|
|
||||||
throw new Error('missing function name in function call');
|
|
||||||
}
|
|
||||||
if (!args) {
|
|
||||||
throw new Error('missing args');
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,5 +1,5 @@
|
|||||||
import { IReadOnlyFunctionParameterCollection } from './Parameter/IFunctionParameterCollection';
|
import { IReadOnlyFunctionParameterCollection } from './Parameter/IFunctionParameterCollection';
|
||||||
import { FunctionCall } from './Call/FunctionCall';
|
import { IFunctionCall } from './Call/IFunctionCall';
|
||||||
|
|
||||||
export interface ISharedFunction {
|
export interface ISharedFunction {
|
||||||
readonly name: string;
|
readonly name: string;
|
||||||
@@ -9,8 +9,8 @@ export interface ISharedFunction {
|
|||||||
|
|
||||||
export interface ISharedFunctionBody {
|
export interface ISharedFunctionBody {
|
||||||
readonly type: FunctionBodyType;
|
readonly type: FunctionBodyType;
|
||||||
readonly code: IFunctionCode | undefined;
|
readonly code: IFunctionCode;
|
||||||
readonly calls: readonly FunctionCall[] | undefined;
|
readonly calls: readonly IFunctionCall[];
|
||||||
}
|
}
|
||||||
|
|
||||||
export enum FunctionBodyType {
|
export enum FunctionBodyType {
|
||||||
|
|||||||
@@ -2,5 +2,4 @@ import { ISharedFunction } from './ISharedFunction';
|
|||||||
|
|
||||||
export interface ISharedFunctionCollection {
|
export interface ISharedFunctionCollection {
|
||||||
getFunctionByName(name: string): ISharedFunction;
|
getFunctionByName(name: string): ISharedFunction;
|
||||||
getRequiredParameterNames(functionName: string): string[];
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
import { FunctionCall } from './Call/FunctionCall';
|
import { IFunctionCall } from './Call/IFunctionCall';
|
||||||
|
|
||||||
import {
|
import {
|
||||||
FunctionBodyType, IFunctionCode, ISharedFunction, ISharedFunctionBody,
|
FunctionBodyType, IFunctionCode, ISharedFunction, ISharedFunctionBody,
|
||||||
@@ -8,7 +8,7 @@ import { IReadOnlyFunctionParameterCollection } from './Parameter/IFunctionParam
|
|||||||
export function createCallerFunction(
|
export function createCallerFunction(
|
||||||
name: string,
|
name: string,
|
||||||
parameters: IReadOnlyFunctionParameterCollection,
|
parameters: IReadOnlyFunctionParameterCollection,
|
||||||
callSequence: readonly FunctionCall[],
|
callSequence: readonly IFunctionCall[],
|
||||||
): ISharedFunction {
|
): ISharedFunction {
|
||||||
if (!callSequence || !callSequence.length) {
|
if (!callSequence || !callSequence.length) {
|
||||||
throw new Error(`missing call sequence in function "${name}"`);
|
throw new Error(`missing call sequence in function "${name}"`);
|
||||||
@@ -38,7 +38,7 @@ class SharedFunction implements ISharedFunction {
|
|||||||
constructor(
|
constructor(
|
||||||
public readonly name: string,
|
public readonly name: string,
|
||||||
public readonly parameters: IReadOnlyFunctionParameterCollection,
|
public readonly parameters: IReadOnlyFunctionParameterCollection,
|
||||||
content: IFunctionCode | readonly FunctionCall[],
|
content: IFunctionCode | readonly IFunctionCall[],
|
||||||
bodyType: FunctionBodyType,
|
bodyType: FunctionBodyType,
|
||||||
) {
|
) {
|
||||||
if (!name) { throw new Error('missing function name'); }
|
if (!name) { throw new Error('missing function name'); }
|
||||||
@@ -46,7 +46,7 @@ class SharedFunction implements ISharedFunction {
|
|||||||
this.body = {
|
this.body = {
|
||||||
type: bodyType,
|
type: bodyType,
|
||||||
code: bodyType === FunctionBodyType.Code ? content as IFunctionCode : undefined,
|
code: bodyType === FunctionBodyType.Code ? content as IFunctionCode : undefined,
|
||||||
calls: bodyType === FunctionBodyType.Calls ? content as readonly FunctionCall[] : undefined,
|
calls: bodyType === FunctionBodyType.Calls ? content as readonly IFunctionCall[] : undefined,
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -21,15 +21,6 @@ export class SharedFunctionCollection implements ISharedFunctionCollection {
|
|||||||
return func;
|
return func;
|
||||||
}
|
}
|
||||||
|
|
||||||
public getRequiredParameterNames(functionName: string): string[] {
|
|
||||||
return this
|
|
||||||
.getFunctionByName(functionName)
|
|
||||||
.parameters
|
|
||||||
.all
|
|
||||||
.filter((parameter) => !parameter.isOptional)
|
|
||||||
.map((parameter) => parameter.name);
|
|
||||||
}
|
|
||||||
|
|
||||||
private has(functionName: string) {
|
private has(functionName: string) {
|
||||||
return this.functionsByName.has(functionName);
|
return this.functionsByName.has(functionName);
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -7,12 +7,12 @@ import { NoEmptyLines } from '@/application/Parser/Script/Validation/Rules/NoEmp
|
|||||||
import { ICodeValidator } from '@/application/Parser/Script/Validation/ICodeValidator';
|
import { ICodeValidator } from '@/application/Parser/Script/Validation/ICodeValidator';
|
||||||
import { IScriptCompiler } from './IScriptCompiler';
|
import { IScriptCompiler } from './IScriptCompiler';
|
||||||
import { ISharedFunctionCollection } from './Function/ISharedFunctionCollection';
|
import { ISharedFunctionCollection } from './Function/ISharedFunctionCollection';
|
||||||
import { FunctionCallSequenceCompiler } from './Function/Call/Compiler/FunctionCallSequenceCompiler';
|
import { IFunctionCallCompiler } from './Function/Call/Compiler/IFunctionCallCompiler';
|
||||||
import { FunctionCallCompiler } from './Function/Call/Compiler/FunctionCallCompiler';
|
import { FunctionCallCompiler } from './Function/Call/Compiler/FunctionCallCompiler';
|
||||||
import { ISharedFunctionsParser } from './Function/ISharedFunctionsParser';
|
import { ISharedFunctionsParser } from './Function/ISharedFunctionsParser';
|
||||||
import { SharedFunctionsParser } from './Function/SharedFunctionsParser';
|
import { SharedFunctionsParser } from './Function/SharedFunctionsParser';
|
||||||
import { parseFunctionCalls } from './Function/Call/FunctionCallParser';
|
import { parseFunctionCalls } from './Function/Call/FunctionCallParser';
|
||||||
import { CompiledCode } from './Function/Call/Compiler/CompiledCode';
|
import { ICompiledCode } from './Function/Call/Compiler/ICompiledCode';
|
||||||
|
|
||||||
export class ScriptCompiler implements IScriptCompiler {
|
export class ScriptCompiler implements IScriptCompiler {
|
||||||
private readonly functions: ISharedFunctionCollection;
|
private readonly functions: ISharedFunctionCollection;
|
||||||
@@ -21,7 +21,7 @@ export class ScriptCompiler implements IScriptCompiler {
|
|||||||
functions: readonly FunctionData[] | undefined,
|
functions: readonly FunctionData[] | undefined,
|
||||||
syntax: ILanguageSyntax,
|
syntax: ILanguageSyntax,
|
||||||
sharedFunctionsParser: ISharedFunctionsParser = SharedFunctionsParser.instance,
|
sharedFunctionsParser: ISharedFunctionsParser = SharedFunctionsParser.instance,
|
||||||
private readonly callCompiler: FunctionCallCompiler = FunctionCallSequenceCompiler.instance,
|
private readonly callCompiler: IFunctionCallCompiler = FunctionCallCompiler.instance,
|
||||||
private readonly codeValidator: ICodeValidator = CodeValidator.instance,
|
private readonly codeValidator: ICodeValidator = CodeValidator.instance,
|
||||||
) {
|
) {
|
||||||
if (!syntax) { throw new Error('missing syntax'); }
|
if (!syntax) { throw new Error('missing syntax'); }
|
||||||
@@ -40,7 +40,7 @@ export class ScriptCompiler implements IScriptCompiler {
|
|||||||
if (!script) { throw new Error('missing script'); }
|
if (!script) { throw new Error('missing script'); }
|
||||||
try {
|
try {
|
||||||
const calls = parseFunctionCalls(script.call);
|
const calls = parseFunctionCalls(script.call);
|
||||||
const compiledCode = this.callCompiler.compileFunctionCalls(calls, this.functions);
|
const compiledCode = this.callCompiler.compileCall(calls, this.functions);
|
||||||
validateCompiledCode(compiledCode, this.codeValidator);
|
validateCompiledCode(compiledCode, this.codeValidator);
|
||||||
return new ScriptCode(
|
return new ScriptCode(
|
||||||
compiledCode.code,
|
compiledCode.code,
|
||||||
@@ -52,7 +52,7 @@ export class ScriptCompiler implements IScriptCompiler {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
function validateCompiledCode(compiledCode: CompiledCode, validator: ICodeValidator): void {
|
function validateCompiledCode(compiledCode: ICompiledCode, validator: ICodeValidator): void {
|
||||||
[compiledCode.code, compiledCode.revertCode].forEach(
|
[compiledCode.code, compiledCode.revertCode].forEach(
|
||||||
(code) => validator.throwIfInvalid(code, [new NoEmptyLines()]),
|
(code) => validator.throwIfInvalid(code, [new NoEmptyLines()]),
|
||||||
);
|
);
|
||||||
|
|||||||
@@ -3558,98 +3558,82 @@ functions:
|
|||||||
parameters:
|
parameters:
|
||||||
- name: prefName
|
- name: prefName
|
||||||
- name: jsonValue
|
- name: jsonValue
|
||||||
docs: |-
|
# prefs.js file (https://web.archive.org/web/20221029211757/https://kb.mozillazine.org/Prefs.js_file) exists at
|
||||||
This script either creates or updates the `user.js` file to set specific Mozilla Firefox preferences.
|
# - Default installation:
|
||||||
|
# ~/.mozilla/firefox/<profile-name>/prefs.js
|
||||||
The `user.js` file can be found in a Firefox profile folder [1] and its location depends on the type of installation:
|
# - Flatpak installation:
|
||||||
|
# ~/.var/app/org.mozilla.firefox/.mozilla/firefox/<profile-name>/prefs.js
|
||||||
- Default: `~/.mozilla/firefox/<profile-name>/user.js`
|
# - Snap installation:
|
||||||
- Flatpak: `~/.var/app/org.mozilla.firefox/.mozilla/firefox/<profile-name>/user.js`
|
# ~/snap/firefox/common/.mozilla/firefox/<profile-name>/prefs.js
|
||||||
- Snap: `~/snap/firefox/common/.mozilla/firefox/<profile-name>/user.js`
|
|
||||||
|
|
||||||
While the `user.js` file is optional [2], if it's present, the Firefox application will prioritize its settings over
|
|
||||||
those in `prefs.js` upon startup [1][2]. To prevent potential profile corruption, Mozilla advises against editing
|
|
||||||
`prefs.js` directly [2].
|
|
||||||
|
|
||||||
[1]: https://web.archive.org/web/20230811005205/https://kb.mozillazine.org/User.js_file "User.js file - MozillaZine Knowledge Base"
|
|
||||||
[2]: https://web.archive.org/web/20221029211757/https://kb.mozillazine.org/Prefs.js_file "Prefs.js file - MozillaZine Knowledge Base"
|
|
||||||
code: |-
|
code: |-
|
||||||
pref_name='{{ $prefName }}'
|
pref_name='{{ $prefName }}'
|
||||||
pref_value='{{ $jsonValue }}'
|
pref_value='{{ $jsonValue }}'
|
||||||
echo "Setting preference \"$pref_name\" to \"$pref_value\"."
|
echo "Setting preference \"$pref_name\" to \"$pref_value\"."
|
||||||
declare -a profile_paths=(
|
pref_file_paths=(
|
||||||
~/.mozilla/firefox/*/
|
~/.mozilla/firefox/*/prefs.js
|
||||||
~/.var/app/org.mozilla.firefox/.mozilla/firefox/*/
|
~/.var/app/org.mozilla.firefox/.mozilla/firefox/*/prefs.js
|
||||||
~/snap/firefox/common/.mozilla/firefox/*/
|
~/snap/firefox/common/.mozilla/firefox/*/prefs.js
|
||||||
)
|
)
|
||||||
declare -i total_profiles_found=0
|
declare -i total_files_found=0
|
||||||
for profile_dir in "${profile_paths[@]}"; do
|
for pref_file in "${pref_file_paths[@]}"; do
|
||||||
if [ ! -d "$profile_dir" ]; then
|
if [ -f "$pref_file" ]; then
|
||||||
continue
|
((total_files_found++))
|
||||||
fi
|
echo "$pref_file:"
|
||||||
if [[ ! "$(basename "$profile_dir")" =~ ^[a-z0-9]{8}\..+ ]]; then
|
pref_start="user_pref(\"$pref_name\","
|
||||||
continue # Not a profile folder
|
pref_line="user_pref(\"$pref_name\", $pref_value);"
|
||||||
fi
|
if ! grep --quiet "^$pref_start" "${pref_file}"; then
|
||||||
((total_profiles_found++))
|
echo $'\t'"Preference is not configured before."
|
||||||
user_js_file="${profile_dir}user.js"
|
echo -n $'\n'"$pref_line" >> "$pref_file"
|
||||||
echo "$user_js_file:"
|
echo $'\t'"Successfully configured."
|
||||||
if [ ! -f "$user_js_file" ]; then
|
else
|
||||||
touch "$user_js_file"
|
if grep --quiet "^$pref_line$" "${pref_file}"; then
|
||||||
echo $'\t''Created new user.js file'
|
echo $'\t'"Skipping. Preference is already configured as expected."
|
||||||
fi
|
else
|
||||||
pref_start="user_pref(\"$pref_name\","
|
sed --in-place "/^$pref_start/d" "$pref_file"
|
||||||
pref_line="user_pref(\"$pref_name\", $pref_value);"
|
echo $'\t'"Deleted assignment with unexpected value."
|
||||||
if ! grep --quiet "^$pref_start" "${user_js_file}"; then
|
echo -n $'\n'"$pref_line" >> "$pref_file"
|
||||||
echo -n $'\n'"$pref_line" >> "$user_js_file"
|
echo $'\t'"Successfully reconfigured with expected value."
|
||||||
echo $'\t'"Successfully added a new preference in $user_js_file."
|
fi
|
||||||
elif grep --quiet "^$pref_line$" "$user_js_file"; then
|
fi
|
||||||
echo $'\t'"Skipping, preference is already set as expected in $user_js_file."
|
|
||||||
else
|
|
||||||
sed --in-place "/^$pref_start/c\\$pref_line" "$user_js_file"
|
|
||||||
echo $'\t'"Successfully replaced the existing incorrect preference in $user_js_file."
|
|
||||||
fi
|
fi
|
||||||
done
|
done
|
||||||
if [ "$total_profiles_found" -eq 0 ]; then
|
if [ "$total_files_found" -eq 0 ]; then
|
||||||
echo 'No profile folders are found, no changes are made.'
|
echo "No changes, no preference file is found."
|
||||||
else
|
else
|
||||||
echo "Preferences verified in $total_profiles_found profiles."
|
echo "Ensured that $total_files_found profiles are compilant."
|
||||||
fi
|
fi
|
||||||
revertCode: |-
|
revertCode: |-
|
||||||
pref_name='{{ $prefName }}'
|
pref_name='{{ $prefName }}'
|
||||||
pref_value='{{ $jsonValue }}'
|
pref_value='{{ $jsonValue }}'
|
||||||
echo "Reverting preference: \"$pref_name\" to its default."
|
echo "Restoring \"$pref_name\" to its default."
|
||||||
declare -a profile_paths=(
|
pref_file_paths=(
|
||||||
~/.mozilla/firefox/*/
|
~/.mozilla/firefox/*/prefs.js
|
||||||
~/.var/app/org.mozilla.firefox/.mozilla/firefox/*/
|
~/.var/app/org.mozilla.firefox/.mozilla/firefox/*/prefs.js
|
||||||
~/snap/firefox/common/.mozilla/firefox/*/
|
~/snap/firefox/common/.mozilla/firefox/*/prefs.js
|
||||||
)
|
)
|
||||||
declare -i total_profiles_found=0
|
declare -i total_files_found=0
|
||||||
for profile_dir in "${profile_paths[@]}"; do
|
for pref_file in "${pref_file_paths[@]}"; do
|
||||||
user_js_file="${profile_dir}user.js"
|
if [ -f "$pref_file" ]; then
|
||||||
if [ ! -f "$user_js_file" ]; then
|
((total_files_found++))
|
||||||
continue
|
echo "$pref_file:"
|
||||||
fi
|
pref_start="user_pref(\"$pref_name\","
|
||||||
((total_profiles_found++))
|
pref_line="user_pref(\"$pref_name\", $pref_value);"
|
||||||
echo "$user_js_file:"
|
if ! grep --quiet "^$pref_start" "${pref_file}"; then
|
||||||
pref_start="user_pref(\"$pref_name\","
|
echo $'\t'"Skipping. Preference is not configured before."
|
||||||
pref_line="user_pref(\"$pref_name\", $pref_value);"
|
else
|
||||||
if ! grep --quiet "^$pref_start" "${user_js_file}"; then
|
if grep --quiet "^$pref_line$" "${pref_file}"; then
|
||||||
echo $'\t''Skipping, preference was not configured before.'
|
sed --in-place "/^$pref_line/d" "$pref_file"
|
||||||
elif grep --quiet "^$pref_line$" "${user_js_file}"; then
|
echo $'\t'"Successfully restored preference value to its default."
|
||||||
sed --in-place "/^$pref_line/d" "$user_js_file"
|
else
|
||||||
echo $'\t''Successfully reverted preference to default.'
|
echo $'\t'"Skipping, the preference has value that is not configured by privacy.sexy."
|
||||||
if ! grep --quiet '[^[:space:]]' "$user_js_file"; then
|
fi
|
||||||
rm "$user_js_file"
|
|
||||||
echo $'\t''Removed user.js file as it became empty.'
|
|
||||||
fi
|
fi
|
||||||
else
|
|
||||||
echo $'\t''Skipping, the preference has value that is not configured by privacy.sexy.'
|
|
||||||
fi
|
fi
|
||||||
done
|
done
|
||||||
if [ "$total_profiles_found" -eq 0 ]; then
|
if [ "$total_files_found" -eq 0 ]; then
|
||||||
echo 'No reversion was necessary.'
|
echo "No changes, no preference file is found."
|
||||||
else
|
else
|
||||||
echo "Preferences verified in $total_profiles_found profiles."
|
echo "Ensured that $total_files_found profiles are compilant."
|
||||||
fi
|
fi
|
||||||
-
|
-
|
||||||
name: RenameFile
|
name: RenameFile
|
||||||
|
|||||||
File diff suppressed because it is too large
Load Diff
@@ -1,37 +1,31 @@
|
|||||||
import { RuntimeEnvironment } from '@/infrastructure/RuntimeEnvironment/RuntimeEnvironment';
|
import os from 'os';
|
||||||
|
import path from 'path';
|
||||||
|
import fs from 'fs';
|
||||||
|
// eslint-disable-next-line camelcase
|
||||||
|
import child_process from 'child_process';
|
||||||
|
import { Environment } from '@/application/Environment/Environment';
|
||||||
import { OperatingSystem } from '@/domain/OperatingSystem';
|
import { OperatingSystem } from '@/domain/OperatingSystem';
|
||||||
import { getWindowInjectedSystemOperations } from './SystemOperations/WindowInjectedSystemOperations';
|
|
||||||
|
|
||||||
export class CodeRunner {
|
export class CodeRunner {
|
||||||
constructor(
|
constructor(
|
||||||
private readonly system = getWindowInjectedSystemOperations(),
|
private readonly node = getNodeJs(),
|
||||||
private readonly environment = RuntimeEnvironment.CurrentEnvironment,
|
private readonly environment = Environment.CurrentEnvironment,
|
||||||
) {
|
) {
|
||||||
if (!system) {
|
|
||||||
throw new Error('missing system operations');
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
public async runCode(code: string, folderName: string, fileExtension: string): Promise<void> {
|
public async runCode(code: string, folderName: string, fileExtension: string): Promise<void> {
|
||||||
const { os } = this.environment;
|
const dir = this.node.path.join(this.node.os.tmpdir(), folderName);
|
||||||
const dir = this.system.location.combinePaths(
|
await this.node.fs.promises.mkdir(dir, { recursive: true });
|
||||||
this.system.operatingSystem.getTempDirectory(),
|
const filePath = this.node.path.join(dir, `run.${fileExtension}`);
|
||||||
folderName,
|
await this.node.fs.promises.writeFile(filePath, code);
|
||||||
);
|
await this.node.fs.promises.chmod(filePath, '755');
|
||||||
await this.system.fileSystem.createDirectory(dir, true);
|
const command = getExecuteCommand(filePath, this.environment);
|
||||||
const filePath = this.system.location.combinePaths(dir, `run.${fileExtension}`);
|
this.node.child_process.exec(command);
|
||||||
await this.system.fileSystem.writeToFile(filePath, code);
|
|
||||||
await this.system.fileSystem.setFilePermissions(filePath, '755');
|
|
||||||
const command = getExecuteCommand(filePath, os);
|
|
||||||
this.system.command.execute(command);
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
function getExecuteCommand(
|
function getExecuteCommand(scriptPath: string, environment: Environment): string {
|
||||||
scriptPath: string,
|
switch (environment.os) {
|
||||||
currentOperatingSystem: OperatingSystem,
|
|
||||||
): string {
|
|
||||||
switch (currentOperatingSystem) {
|
|
||||||
case OperatingSystem.Linux:
|
case OperatingSystem.Linux:
|
||||||
return `x-terminal-emulator -e '${scriptPath}'`;
|
return `x-terminal-emulator -e '${scriptPath}'`;
|
||||||
case OperatingSystem.macOS:
|
case OperatingSystem.macOS:
|
||||||
@@ -42,6 +36,46 @@ function getExecuteCommand(
|
|||||||
case OperatingSystem.Windows:
|
case OperatingSystem.Windows:
|
||||||
return scriptPath;
|
return scriptPath;
|
||||||
default:
|
default:
|
||||||
throw Error(`unsupported os: ${OperatingSystem[currentOperatingSystem]}`);
|
throw Error(`unsupported os: ${OperatingSystem[environment.os]}`);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
function getNodeJs(): INodeJs {
|
||||||
|
return {
|
||||||
|
os, path, fs, child_process,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface INodeJs {
|
||||||
|
os: INodeOs;
|
||||||
|
path: INodePath;
|
||||||
|
fs: INodeFs;
|
||||||
|
// eslint-disable-next-line camelcase
|
||||||
|
child_process: INodeChildProcess;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface INodeOs {
|
||||||
|
tmpdir(): string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface INodePath {
|
||||||
|
join(...paths: string[]): string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface INodeChildProcess {
|
||||||
|
exec(command: string): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface INodeFs {
|
||||||
|
readonly promises: INodeFsPromises;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface INodeFsPromisesMakeDirectoryOptions {
|
||||||
|
recursive?: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface INodeFsPromises { // https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/node/v13/fs.d.ts
|
||||||
|
chmod(path: string, mode: string | number): Promise<void>;
|
||||||
|
mkdir(path: string, options: INodeFsPromisesMakeDirectoryOptions): Promise<string>;
|
||||||
|
writeFile(path: string, data: string): Promise<void>;
|
||||||
|
}
|
||||||
|
|||||||
@@ -1,18 +0,0 @@
|
|||||||
import { IEnvironmentVariablesFactory } from './IEnvironmentVariablesFactory';
|
|
||||||
import { validateEnvironmentVariables } from './EnvironmentVariablesValidator';
|
|
||||||
import { ViteEnvironmentVariables } from './Vite/ViteEnvironmentVariables';
|
|
||||||
import { IEnvironmentVariables } from './IEnvironmentVariables';
|
|
||||||
|
|
||||||
export class EnvironmentVariablesFactory implements IEnvironmentVariablesFactory {
|
|
||||||
public static readonly Current = new EnvironmentVariablesFactory();
|
|
||||||
|
|
||||||
public readonly instance: IEnvironmentVariables;
|
|
||||||
|
|
||||||
protected constructor(validator: EnvironmentVariablesValidator = validateEnvironmentVariables) {
|
|
||||||
const environment = new ViteEnvironmentVariables();
|
|
||||||
validator(environment);
|
|
||||||
this.instance = environment;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
export type EnvironmentVariablesValidator = typeof validateEnvironmentVariables;
|
|
||||||
@@ -1,50 +0,0 @@
|
|||||||
import { IEnvironmentVariables } from './IEnvironmentVariables';
|
|
||||||
|
|
||||||
/* Validation is externalized to keep the environment objects simple */
|
|
||||||
export function validateEnvironmentVariables(environment: IEnvironmentVariables): void {
|
|
||||||
if (!environment) {
|
|
||||||
throw new Error('missing environment');
|
|
||||||
}
|
|
||||||
const keyValues = capturePropertyValues(environment);
|
|
||||||
if (!Object.keys(keyValues).length) {
|
|
||||||
throw new Error('Unable to capture key/value pairs');
|
|
||||||
}
|
|
||||||
const keysMissingValue = getKeysMissingValues(keyValues);
|
|
||||||
if (keysMissingValue.length > 0) {
|
|
||||||
throw new Error(`Environment keys missing: ${keysMissingValue.join(', ')}`);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
function getKeysMissingValues(keyValuePairs: Record<string, unknown>): string[] {
|
|
||||||
return Object.entries(keyValuePairs)
|
|
||||||
.reduce((acc, [key, value]) => {
|
|
||||||
if (!value && typeof value !== 'boolean') {
|
|
||||||
acc.push(key);
|
|
||||||
}
|
|
||||||
return acc;
|
|
||||||
}, new Array<string>());
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Captures values of properties and getters from the provided instance.
|
|
||||||
* Necessary because code transformations can make class getters non-enumerable during bundling.
|
|
||||||
* This ensures that even if getters are non-enumerable, their values are still captured and used.
|
|
||||||
*/
|
|
||||||
function capturePropertyValues(instance: unknown): Record<string, unknown> {
|
|
||||||
const obj: Record<string, unknown> = {};
|
|
||||||
const descriptors = Object.getOwnPropertyDescriptors(instance.constructor.prototype);
|
|
||||||
|
|
||||||
// Capture regular properties from the instance
|
|
||||||
for (const [key, value] of Object.entries(instance)) {
|
|
||||||
obj[key] = value;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Capture getter properties from the instance's prototype
|
|
||||||
for (const [key, descriptor] of Object.entries(descriptors)) {
|
|
||||||
if (typeof descriptor.get === 'function') {
|
|
||||||
obj[key] = descriptor.get.call(instance);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return obj;
|
|
||||||
}
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
/**
|
|
||||||
* Represents essential metadata about the application.
|
|
||||||
*/
|
|
||||||
export interface IAppMetadata {
|
|
||||||
readonly version: string;
|
|
||||||
readonly name: string;
|
|
||||||
readonly slogan: string;
|
|
||||||
readonly repositoryUrl: string;
|
|
||||||
readonly homepageUrl: string;
|
|
||||||
}
|
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
import { IAppMetadata } from './IAppMetadata';
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Designed to decouple the process of retrieving environment variables
|
|
||||||
* (e.g., from the build environment) from the rest of the application.
|
|
||||||
*/
|
|
||||||
export interface IEnvironmentVariables extends IAppMetadata {
|
|
||||||
readonly isNonProduction: boolean;
|
|
||||||
}
|
|
||||||
@@ -1,5 +0,0 @@
|
|||||||
import { IEnvironmentVariables } from './IEnvironmentVariables';
|
|
||||||
|
|
||||||
export interface IEnvironmentVariablesFactory {
|
|
||||||
readonly instance: IEnvironmentVariables;
|
|
||||||
}
|
|
||||||
@@ -1,13 +0,0 @@
|
|||||||
// Only variables prefixed with VITE_ are exposed to Vite-processed code
|
|
||||||
export const VITE_USER_DEFINED_ENVIRONMENT_KEYS = {
|
|
||||||
VERSION: 'VITE_APP_VERSION',
|
|
||||||
NAME: 'VITE_APP_NAME',
|
|
||||||
SLOGAN: 'VITE_APP_SLOGAN',
|
|
||||||
REPOSITORY_URL: 'VITE_APP_REPOSITORY_URL',
|
|
||||||
HOMEPAGE_URL: 'VITE_APP_HOMEPAGE_URL',
|
|
||||||
} as const;
|
|
||||||
|
|
||||||
export const VITE_ENVIRONMENT_KEYS = {
|
|
||||||
...VITE_USER_DEFINED_ENVIRONMENT_KEYS,
|
|
||||||
DEV: 'DEV',
|
|
||||||
} as const;
|
|
||||||
@@ -1,33 +0,0 @@
|
|||||||
import { IEnvironmentVariables } from '../IEnvironmentVariables';
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Provides the application's environment variables.
|
|
||||||
*/
|
|
||||||
export class ViteEnvironmentVariables implements IEnvironmentVariables {
|
|
||||||
// Ensure the use of import.meta.env prefix for the following properties.
|
|
||||||
// Vue will replace these statically during production builds.
|
|
||||||
|
|
||||||
public get version(): string {
|
|
||||||
return import.meta.env.VITE_APP_VERSION;
|
|
||||||
}
|
|
||||||
|
|
||||||
public get name(): string {
|
|
||||||
return import.meta.env.VITE_APP_NAME;
|
|
||||||
}
|
|
||||||
|
|
||||||
public get slogan(): string {
|
|
||||||
return import.meta.env.VITE_APP_SLOGAN;
|
|
||||||
}
|
|
||||||
|
|
||||||
public get repositoryUrl(): string {
|
|
||||||
return import.meta.env.VITE_APP_REPOSITORY_URL;
|
|
||||||
}
|
|
||||||
|
|
||||||
public get homepageUrl(): string {
|
|
||||||
return import.meta.env.VITE_APP_HOMEPAGE_URL;
|
|
||||||
}
|
|
||||||
|
|
||||||
public get isNonProduction(): boolean {
|
|
||||||
return import.meta.env.DEV;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
/// <reference types="vite/client" />
|
|
||||||
|
|
||||||
import { VITE_ENVIRONMENT_KEYS } from './ViteEnvironmentKeys';
|
|
||||||
|
|
||||||
export type ViteEnvironmentVariables = {
|
|
||||||
readonly [K in keyof typeof VITE_ENVIRONMENT_KEYS]: string;
|
|
||||||
};
|
|
||||||
|
|
||||||
interface ImportMeta {
|
|
||||||
readonly env: ViteEnvironmentVariables
|
|
||||||
}
|
|
||||||
@@ -1,20 +1,9 @@
|
|||||||
import { IEventSubscriptionCollection } from './IEventSubscriptionCollection';
|
|
||||||
import { IEventSubscription } from './IEventSource';
|
import { IEventSubscription } from './IEventSource';
|
||||||
|
|
||||||
export class EventSubscriptionCollection implements IEventSubscriptionCollection {
|
export class EventSubscriptionCollection {
|
||||||
private readonly subscriptions = new Array<IEventSubscription>();
|
private readonly subscriptions = new Array<IEventSubscription>();
|
||||||
|
|
||||||
public get subscriptionCount() {
|
public register(...subscriptions: IEventSubscription[]) {
|
||||||
return this.subscriptions.length;
|
|
||||||
}
|
|
||||||
|
|
||||||
public register(subscriptions: IEventSubscription[]) {
|
|
||||||
if (!subscriptions || subscriptions.length === 0) {
|
|
||||||
throw new Error('missing subscriptions');
|
|
||||||
}
|
|
||||||
if (subscriptions.some((subscription) => !subscription)) {
|
|
||||||
throw new Error('missing subscription in list');
|
|
||||||
}
|
|
||||||
this.subscriptions.push(...subscriptions);
|
this.subscriptions.push(...subscriptions);
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -22,9 +11,4 @@ export class EventSubscriptionCollection implements IEventSubscriptionCollection
|
|||||||
this.subscriptions.forEach((listener) => listener.unsubscribe());
|
this.subscriptions.forEach((listener) => listener.unsubscribe());
|
||||||
this.subscriptions.splice(0, this.subscriptions.length);
|
this.subscriptions.splice(0, this.subscriptions.length);
|
||||||
}
|
}
|
||||||
|
|
||||||
public unsubscribeAllAndRegister(subscriptions: IEventSubscription[]) {
|
|
||||||
this.unsubscribeAll();
|
|
||||||
this.register(subscriptions);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,9 +0,0 @@
|
|||||||
import { IEventSubscription } from '@/infrastructure/Events/IEventSource';
|
|
||||||
|
|
||||||
export interface IEventSubscriptionCollection {
|
|
||||||
readonly subscriptionCount: number;
|
|
||||||
|
|
||||||
register(subscriptions: IEventSubscription[]): void;
|
|
||||||
unsubscribeAll(): void;
|
|
||||||
unsubscribeAllAndRegister(subscriptions: IEventSubscription[]);
|
|
||||||
}
|
|
||||||
@@ -1,13 +0,0 @@
|
|||||||
import { ILogger } from './ILogger';
|
|
||||||
|
|
||||||
export class ConsoleLogger implements ILogger {
|
|
||||||
constructor(private readonly globalConsole: Partial<Console> = console) {
|
|
||||||
if (!globalConsole) {
|
|
||||||
throw new Error('missing console');
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
public info(...params: unknown[]): void {
|
|
||||||
this.globalConsole.info(...params);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,12 +0,0 @@
|
|||||||
import { ElectronLog } from 'electron-log';
|
|
||||||
import { ILogger } from './ILogger';
|
|
||||||
|
|
||||||
// Using plain-function rather than class so it can be used in Electron's context-bridging.
|
|
||||||
export function createElectronLogger(logger: Partial<ElectronLog>): ILogger {
|
|
||||||
if (!logger) {
|
|
||||||
throw new Error('missing logger');
|
|
||||||
}
|
|
||||||
return {
|
|
||||||
info: (...params) => logger.info(...params),
|
|
||||||
};
|
|
||||||
}
|
|
||||||
@@ -1,3 +0,0 @@
|
|||||||
export interface ILogger {
|
|
||||||
info (...params: unknown[]): void;
|
|
||||||
}
|
|
||||||
@@ -1,5 +0,0 @@
|
|||||||
import { ILogger } from './ILogger';
|
|
||||||
|
|
||||||
export interface ILoggerFactory {
|
|
||||||
readonly logger: ILogger;
|
|
||||||
}
|
|
||||||
@@ -1,5 +0,0 @@
|
|||||||
import { ILogger } from './ILogger';
|
|
||||||
|
|
||||||
export class NoopLogger implements ILogger {
|
|
||||||
public info(): void { /* NOOP */ }
|
|
||||||
}
|
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user