diff --git a/.github/workflows/build-and-test-oauth.yml b/.github/workflows/build-and-test-oauth.yml new file mode 100644 index 00000000..d2ceccf2 --- /dev/null +++ b/.github/workflows/build-and-test-oauth.yml @@ -0,0 +1,128 @@ +# Copyright 2020 SkillTree +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +name: Continuous Integration with OAuth + +#on: +# push: +# paths-ignore: +# - 'README.md' +# pull_request: +# paths-ignore: +# - 'README.md' +on: + schedule: + - cron: '0 6 * * *' + + +jobs: + ci: + runs-on: ubuntu-latest + + steps: + - name: Install Emoji Support + run: sudo apt-get install fonts-noto-color-emoji + + - uses: actions/checkout@v2 + + - name: Checkout skills-client + uses: actions/checkout@v2 + with: + repository: NationalSecurityAgency/skills-client + path: skills-client + + - uses: actions/setup-node@v2-beta + with: + node-version: '14' + + - uses: actions/setup-java@v1 + with: + java-version: '11.X.X' # The JDK version to make available on the path. + + - name: Print Versions + run: | + mvn --version + java -version + + - name: Cache local Maven repository + uses: actions/cache@v2 + with: + path: ~/.m2/repository + key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }} + restore-keys: | + ${{ runner.os }}-maven- + + - name: Build skills-service + run: mvn --batch-mode install -DskipTests + + - name: run hyrda oauth service + run: | + cd skills-client/ + ./.github/workflows/scripts/runHydra.sh + cd ../ + + - name: Check running containers + run: docker ps -a + + - name: Caputre Hydra Oauth Service logs + run: | + mkdir -p ./e2e-tests/logs + docker logs hydra > ./e2e-tests/logs/hydra.out & + docker container logs -f hydra_consent > ./e2e-tests/logs/hydra_consent.out & + docker container logs -f hydra_postgres > ./e2e-tests/logs/hydra_postgres.out & + + - name: Register hydra client + run: | + docker-compose -f ./skills-client/skills-client-integration/skills-int-e2e-test/hydra/quickstart.yml exec -T hydra \ + hydra clients create \ + --endpoint http://localhost:4445/ \ + --id skilltree-test \ + --secret client-secret \ + --grant-types authorization_code,refresh_token \ + --response-types code \ + --scope openid \ + --callbacks http://localhost:8080/login/oauth2/code/hydra + + - name: Start services for Cypress tests + run: | + cd e2e-tests + npm install + npm run cyServices:start:skills-service:oauth + npm run cyServices:start:client-display:oauth + cd .. + + - name: Run Cypress tests + uses: cypress-io/github-action@v2 + with: + working-directory: e2e-tests + record: true + parallel: false + group: 'skills-service with OAuth' + tag: "${{ github.workflow }}" + env: oauthMode=true + env: + # pass the Dashboard record key as an environment variable + CYPRESS_RECORD_KEY: ${{ secrets.CYPRESS_RECORD_KEY }} + # pass GitHub token to allow accurately detecting a build vs a re-run build + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + + - name: upload result artifacts + if: ${{ always() }} + uses: actions/upload-artifact@v2 + with: + name: CI result artifacts + path: | + ./service/target/*.jar + ./service/target/*.log + ./e2e-tests/logs diff --git a/.github/workflows/build-and-test-postgres.yml b/.github/workflows/build-and-test-postgres.yml new file mode 100644 index 00000000..27e4e6be --- /dev/null +++ b/.github/workflows/build-and-test-postgres.yml @@ -0,0 +1,113 @@ +# Copyright 2020 SkillTree +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +name: Test against PostgreSQL + +#on: +# push: +# paths-ignore: +# - 'README.md' +# pull_request: +# paths-ignore: +# - 'README.md' +on: + schedule: + - cron: '0 5 * * *' + + +jobs: + ci: + runs-on: ubuntu-latest + + services: + postgres: + # Docker Hub image + image: postgres + # Provide the password for postgres + env: + POSTGRES_PASSWORD: skillsPassword + POSTGRES_DB: skills + # Set health checks to wait until postgres has started + options: >- + --health-cmd pg_isready + --health-interval 10s + --health-timeout 5s + --health-retries 5 + ports: + # Maps tcp port 5432 on service container to the host + - 5432:5432 + + steps: + - name: Install Emoji Support + run: sudo apt-get install fonts-noto-color-emoji + + - uses: actions/checkout@v2 + + - uses: actions/setup-node@v2-beta + with: + node-version: '14' + + - uses: actions/setup-java@v1 + with: + java-version: '11.X.X' # The JDK version to make available on the path. + + - name: Print Versions + run: | + mvn --version + java -version + + - name: Cache local Maven repository + uses: actions/cache@v2 + with: + path: ~/.m2/repository + key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }} + restore-keys: | + ${{ runner.os }}-maven- + + - name: Build skills-service + run: mvn --batch-mode install -Dspring.datasource.url=jdbc:postgresql://localhost:5432/skills -Dspring.datasource.username=postgres -Dspring.datasource.password=skillsPassword + + - name: Start Services for Cypress tests + run: | + cd e2e-tests + npm install + npm run backend:dropAllDBTables:postgres + npm run cyServices:start:skills-service:postgresql + npm run cyServices:start:client-display + cd .. + + - name: Run Cypress tests + uses: cypress-io/github-action@v2 + with: + working-directory: e2e-tests + record: true + parallel: false + group: 'skills-service against postgres' + tag: "${{ github.workflow }}" + env: db=postgres + env: + # pass the Dashboard record key as an environment variable + CYPRESS_RECORD_KEY: ${{ secrets.CYPRESS_RECORD_KEY }} + # pass GitHub token to allow accurately detecting a build vs a re-run build + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + + - name: upload result artifacts + if: ${{ always() }} + uses: actions/upload-artifact@v2 + with: + name: CI result artifacts + path: | + ./service/target/*.jar + ./service/target/*.log + ./e2e-tests/logs diff --git a/.github/workflows/build-and-test-rabbitmq.yml b/.github/workflows/build-and-test-rabbitmq.yml new file mode 100644 index 00000000..d3cbd5fe --- /dev/null +++ b/.github/workflows/build-and-test-rabbitmq.yml @@ -0,0 +1,102 @@ +# Copyright 2020 SkillTree +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +name: Test Web Sockets over STOMP using RabbitMQ + +#on: +# push: +# paths-ignore: +# - 'README.md' +# pull_request: +# paths-ignore: +# - 'README.md' +on: + schedule: + - cron: '0 6 * * *' + + +jobs: + ci: + runs-on: ubuntu-latest + + services: + rabbitmq: + image: skilltree/skills-stomp-broker:1.0.0 + ports: + # Maps port 15672 and 61613 on service container to the host + - 15672:15672 + - 61613:61613 + + steps: + - name: Install Emoji Support + run: sudo apt-get install fonts-noto-color-emoji + + - uses: actions/checkout@v2 + + - uses: actions/setup-node@v2-beta + with: + node-version: '14' + + - uses: actions/setup-java@v1 + with: + java-version: '11.X.X' # The JDK version to make available on the path. + + - name: Print Versions + run: | + mvn --version + java -version + + - name: Cache local Maven repository + uses: actions/cache@v2 + with: + path: ~/.m2/repository + key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }} + restore-keys: | + ${{ runner.os }}-maven- + + - name: Build skills-service + run: mvn --batch-mode install -DskipTests + + - name: Start services for Cypress tests + run: | + cd e2e-tests + npm install + npm run cyServices:start:skills-service:rabbitmq + npm run cyServices:start:client-display + cd .. + + - name: Run Cypress tests + uses: cypress-io/github-action@v2 + with: + working-directory: e2e-tests + record: true + parallel: false + group: 'skills-service with STOMP using RabbitMQ' + tag: "${{ github.workflow }}" + env: + # pass the Dashboard record key as an environment variable + CYPRESS_RECORD_KEY: ${{ secrets.CYPRESS_RECORD_KEY }} + # pass GitHub token to allow accurately detecting a build vs a re-run build + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + + + - name: upload result artifacts + if: ${{ always() }} + uses: actions/upload-artifact@v2 + with: + name: CI result artifacts + path: | + ./service/target/*.jar + ./service/target/*.log + ./e2e-tests/logs diff --git a/.github/workflows/build-and-test-redis.yml b/.github/workflows/build-and-test-redis.yml new file mode 100644 index 00000000..bfbba637 --- /dev/null +++ b/.github/workflows/build-and-test-redis.yml @@ -0,0 +1,106 @@ +# Copyright 2020 SkillTree +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +name: Test storing HttpSession in Redis + +#on: +# push: +# paths-ignore: +# - 'README.md' +# pull_request: +# paths-ignore: +# - 'README.md' +on: + schedule: + - cron: '0 6 * * *' + + +jobs: + ci: + runs-on: ubuntu-latest + + services: + redis: + image: redis + # Set health checks to wait until redis has started + options: >- + --health-cmd "redis-cli ping" + --health-interval 10s + --health-timeout 5s + --health-retries 5 + ports: + # Maps port 6379 on service container to the host + - 6379:6379 + + steps: + - name: Install Emoji Support + run: sudo apt-get install fonts-noto-color-emoji + + - uses: actions/checkout@v2 + + - uses: actions/setup-node@v2-beta + with: + node-version: '14' + + - uses: actions/setup-java@v1 + with: + java-version: '11.X.X' # The JDK version to make available on the path. + + - name: Print Versions + run: | + mvn --version + java -version + + - name: Cache local Maven repository + uses: actions/cache@v2 + with: + path: ~/.m2/repository + key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }} + restore-keys: | + ${{ runner.os }}-maven- + + - name: Build skills-service + run: mvn --batch-mode install -DskipTests + + - name: Start services for Cypress tests + run: | + cd e2e-tests + npm install + npm run cyServices:start:skills-service:redis + npm run cyServices:start:client-display + cd .. + + - name: Run Cypress tests + uses: cypress-io/github-action@v2 + with: + working-directory: e2e-tests + record: true + parallel: false + group: 'skills-service with Redis' + tag: "${{ github.workflow }}" + env: + # pass the Dashboard record key as an environment variable + CYPRESS_RECORD_KEY: ${{ secrets.CYPRESS_RECORD_KEY }} + # pass GitHub token to allow accurately detecting a build vs a re-run build + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + + - name: upload result artifacts + if: ${{ always() }} + uses: actions/upload-artifact@v2 + with: + name: CI result artifacts + path: | + ./service/target/*.jar + ./service/target/*.log + ./e2e-tests/logs diff --git a/.github/workflows/build-and-test-ssl.yml b/.github/workflows/build-and-test-ssl.yml new file mode 100644 index 00000000..da2dfb47 --- /dev/null +++ b/.github/workflows/build-and-test-ssl.yml @@ -0,0 +1,135 @@ +# Copyright 2020 SkillTree +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +name: Run integration tests using two way ssl + +on: + schedule: + - cron: '0 7 * * *' +#on: +# push: +# paths-ignore: +# - 'README.md' +# - '.github/workflows/build-and-test-postgres.yml' +# - '.github/workflows/build-and-test-redis.yml' +# - '.gitlab-ci.yml' +# pull_request: +# paths-ignore: +# - 'README.md' +# - '.github/workflows/build-and-test-postgres.yml' +# - '.github/workflows/build-and-test-redis.yml' +# - '.gitlab-ci.yml' + + +jobs: + service-tests-against-h2: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v2 + + - uses: actions/setup-node@v2-beta + with: + node-version: '14' + + - uses: actions/setup-java@v1 + with: + java-version: '11.X.X' # The JDK version to make available on the path. + + - name: Print Versions + run: | + mvn --version + java -version + + - name: Cache local Maven repository + uses: actions/cache@v2 + with: + path: ~/.m2/repository + key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }} + restore-keys: | + ${{ runner.os }}-maven- + + - name: Build skills-service + run: mvn --batch-mode install + env: + SPRING_PROFILES_ACTIVE: pki + + - name: upload result artifacts + if: ${{ always() }} + uses: actions/upload-artifact@v2 + with: + name: CI result artifacts + path: | + ./service/target/*.log + + + service-against-postgresql: + runs-on: ubuntu-latest + + services: + postgres: + image: postgres + # Provide the password for postgres + env: + POSTGRES_PASSWORD: skillsPassword + POSTGRES_DB: skills + # Set health checks to wait until postgres has started + options: >- + --health-cmd pg_isready + --health-interval 10s + --health-timeout 5s + --health-retries 5 + ports: + # Maps tcp port 5432 on service container to the host + - 5432:5432 + + steps: + - uses: actions/checkout@v2 + + - uses: actions/setup-node@v2-beta + with: + node-version: '14' + + - uses: actions/setup-java@v1 + with: + java-version: '11.X.X' # The JDK version to make available on the path. + + - name: Print Versions + run: | + mvn --version + java -version + + - name: Cache local Maven repository + uses: actions/cache@v2 + with: + path: ~/.m2/repository + key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }} + restore-keys: | + ${{ runner.os }}-maven- + + - name: Build skills-service + run: mvn --batch-mode test -Dspring.datasource.url=jdbc:postgresql://localhost:5432/skills -Dspring.datasource.username=postgres -Dspring.datasource.password=skillsPassword + env: + SPRING_PROFILES_ACTIVE: pki + + - name: upload result artifacts + if: ${{ always() }} + uses: actions/upload-artifact@v2 + with: + name: CI result artifacts + path: | + ./service/target/*.log + + + diff --git a/.github/workflows/build-and-test.yml b/.github/workflows/build-and-test.yml new file mode 100644 index 00000000..d8ad6ec0 --- /dev/null +++ b/.github/workflows/build-and-test.yml @@ -0,0 +1,268 @@ +# Copyright 2020 SkillTree +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +name: Continuous Integration + +on: + push: + paths-ignore: + - 'README.md' + - '.github/workflows/build-and-test-postgres.yml' + - '.github/workflows/build-and-test-redis.yml' + - '.gitlab-ci.yml' + pull_request: + paths-ignore: + - 'README.md' + - '.github/workflows/build-and-test-postgres.yml' + - '.github/workflows/build-and-test-redis.yml' + - '.gitlab-ci.yml' + +jobs: + pre_job: + # continue-on-error: true # Uncomment once integration is finished + runs-on: ubuntu-latest + # Map a step output to a job output + outputs: + should_skip: ${{ steps.skip_check.outputs.should_skip }} + steps: + - id: skip_check + uses: fkirc/skip-duplicate-actions@master + with: + github_token: ${{ github.token }} + paths_ignore: '["**/README.md"]' + + service-tests-against-h2: + needs: pre_job + if: ${{ needs.pre_job.outputs.should_skip != 'true' }} + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v2 + + - uses: actions/setup-node@v2-beta + with: + node-version: '14' + + - uses: actions/setup-java@v1 + with: + java-version: '11.X.X' # The JDK version to make available on the path. + + - name: Print Versions + run: | + mvn --version + java -version + + - name: Cache local Maven repository + uses: actions/cache@v2 + with: + path: ~/.m2/repository + key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }} + restore-keys: | + ${{ runner.os }}-maven- + + - name: Build skills-service + run: mvn --batch-mode install + + - name: upload result artifacts + if: ${{ always() }} + uses: actions/upload-artifact@v2 + with: + name: CI result artifacts + path: | + ./service/target/*.log + + build-skills-service-for-ui-tests: + needs: pre_job + if: ${{ needs.pre_job.outputs.should_skip != 'true' }} + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v2 + + - uses: actions/setup-node@v2-beta + with: + node-version: '14' + + - uses: actions/setup-java@v1 + with: + java-version: '11.X.X' # The JDK version to make available on the path. + + - name: Print Versions + run: | + mvn --version + java -version + + - name: Cache local Maven repository + uses: actions/cache@v2 + with: + path: ~/.m2/repository + key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }} + restore-keys: | + ${{ runner.os }}-maven- + + - name: Build skills-service + run: mvn --batch-mode install -DskipTests + + - name: upload service jar + uses: actions/upload-artifact@v2 + with: + name: service jar + path: ./service/target/*.jar + + ui-tests-against-h2: + runs-on: ubuntu-latest + needs: [build-skills-service-for-ui-tests] + strategy: + # when one test fails, DO NOT cancel the other + # containers, because this will kill Cypress processes + # leaving the Dashboard hanging ... + # https://github.com/cypress-io/github-action/issues/48 + fail-fast: false + matrix: + # run 4 copies of the current job in parallel + containers: [1, 2, 3, 4] + + steps: + - name: Install Emoji Support + run: sudo apt-get install fonts-noto-color-emoji + + - uses: actions/checkout@v2 + + - uses: actions/setup-node@v2-beta + with: + node-version: '14' + + - uses: actions/setup-java@v1 + with: + java-version: '11.X.X' # The JDK version to make available on the path. + + - name: Print Versions + run: | + mvn --version + java -version + + - uses: actions/download-artifact@v2 + with: + name: service jar + path: ./service/target/ + + - name: Prep Services for Cypress tests + run: | + cd e2e-tests + npm install + npm run cyServices:start + cd .. + + - name: Run Cypress tests + uses: cypress-io/github-action@v2 + with: + working-directory: e2e-tests + record: true + parallel: true + group: 'skills-service tests' + tag: "${{ github.workflow }}" + env: + # pass the Dashboard record key as an environment variable + CYPRESS_RECORD_KEY: ${{ secrets.CYPRESS_RECORD_KEY }} + # pass GitHub token to allow accurately detecting a build vs a re-run build + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + + - name: upload result artifacts + if: ${{ always() }} + uses: actions/upload-artifact@v2 + with: + name: CI result artifacts ${{ matrix.container }} + path: | + ./service/target/*.log + ./e2e-tests/logs + + service-against-postgresql: + needs: pre_job + if: ${{ needs.pre_job.outputs.should_skip != 'true' }} + runs-on: ubuntu-latest + + services: + postgres: + image: postgres + # Provide the password for postgres + env: + POSTGRES_PASSWORD: skillsPassword + POSTGRES_DB: skills + # Set health checks to wait until postgres has started + options: >- + --health-cmd pg_isready + --health-interval 10s + --health-timeout 5s + --health-retries 5 + ports: + # Maps tcp port 5432 on service container to the host + - 5432:5432 + + steps: + - uses: actions/checkout@v2 + + - uses: actions/setup-node@v2-beta + with: + node-version: '14' + + - uses: actions/setup-java@v1 + with: + java-version: '11.X.X' # The JDK version to make available on the path. + + - name: Print Versions + run: | + mvn --version + java -version + + - name: Cache local Maven repository + uses: actions/cache@v2 + with: + path: ~/.m2/repository + key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }} + restore-keys: | + ${{ runner.os }}-maven- + + - name: Build skills-service + run: mvn --batch-mode test -Dspring.datasource.url=jdbc:postgresql://localhost:5432/skills -Dspring.datasource.username=postgres -Dspring.datasource.password=skillsPassword + + - name: upload result artifacts + if: ${{ always() }} + uses: actions/upload-artifact@v2 + with: + name: CI result artifacts + path: | + ./service/target/*.log + ./e2e-tests/logs + + publish-snapshot-docker-image: + runs-on: ubuntu-latest + if: github.event_name == 'push' && github.ref == 'refs/heads/master' + needs: [ui-tests-against-h2, service-against-postgresql] + steps: + - uses: actions/checkout@v2 + + - uses: actions/download-artifact@v2 + with: + name: service jar + path: ./service/target/ + + - name: Build image + env: + docker_username: ${{ secrets.DOCKERUSERNAME }} + docker_password: ${{ secrets.DOCKERPASSWORD }} + run: | + cd docker + bash build-and-push.sh "skilltree/skills-service-ci" + + diff --git a/.gitignore b/.gitignore index 2dc5545d..afc5f3e4 100644 --- a/.gitignore +++ b/.gitignore @@ -39,6 +39,11 @@ target rebel.xml rebel.xml.lock package-lock.json -backend/src/main/resources/public/** +service/src/main/resources/public/** .vscode +.history +/e2e-tests/cypress/screenshots/ +/e2e-tests/cypress/snapshots/**/__diff_output__ + +/dashboard/build/ diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml deleted file mode 100644 index 1b07cd2e..00000000 --- a/.gitlab-ci.yml +++ /dev/null @@ -1,154 +0,0 @@ -stages: - - build - - testCypress - - pushToNexus - - deploy - - -build: - except: - variables: - - $TYPE == "postgrestest" - image: maven:3.6.0-jdk-11 - stage: build - before_script: - - ./ci/installNode.sh - - ./ci/setupRepos.sh - script: - - mvn --batch-mode install - artifacts: - paths: - - backend/pom.xml - - backend/target/backend-*.jar - - backend/target/skills-service-tests.log - -postgres-test:on-schedule: - only: - variables: - - $TYPE == "postgrestest" - image: maven:3.6.0-jdk-11 - stage: build - services: - - postgres:latest - variables: - POSTGRES_PASSWORD: skillsPassword - POSTGRES_DB: skills - before_script: - - ./ci/installNode.sh - - ./ci/setupRepos.sh - script: - - mvn --batch-mode test -Dspring.datasource.url=jdbc:postgresql://postgres:5432/skills -Dspring.datasource.username=postgres -Dspring.datasource.password=skillsPassword - artifacts: - paths: - - backend/target/backend-*.jar - - backend/target/skills-service-tests.log - -# all jobs that actually run tests can use the same definition -cypress_test: - except: - variables: - - $TYPE == "postgrestest" - image: amazonlinux:2 - stage: testCypress - before_script: - - cat /etc/os-release - - uname -a - # install packaged fonts - - yum install -y fontconfig - - cp -r e2e-tests/cypress/fonts/* /usr/share/fonts/ - - fc-cache -fv - - fc-list | wc - - fc-list -# - yum install -y gtk2.x86_64 - - yum install -y which - - yum update -y - - yum install -y gtk3 - - yum install -y libnotify-devel - - yum install -y GConf2 - - yum install -y libXScrnSaver -# - yum install -y libnss3 -# - yum install -y libxss1 - - yum install -y nss -# - yum install -y libasound2 - - yum install -y xorg-x11-server-Xvfb - - amazon-linux-extras install -y java-openjdk11 - - java --version - - yum install -y gcc-c++ make - - curl -sL https://rpm.nodesource.com/setup_12.x | bash - - - yum install -y nodejs - - node -v - - npm -v - - echo "@skills:registry=http://$NEXUS_SERVER/repository/skills-registry/" > ~/.npmrc - - cat ~/.npmrc - script: - # start the server in the background - - cd e2e-tests - - npm run backend:start:ci & - - cd ../client-display - - npm install - - npm run serve & - - cd ../e2e-tests - - npm install - - npm run backend:waitToStart - - npx wait-on -t 40000 http://localhost:8083 - # run tests - - npm run cy:run - artifacts: - when: always - paths: - - e2e-tests/cypress/videos/*.mp4 - - e2e-tests/cypress/videos/**/*.mp4 - - e2e-tests/cypress/screenshots/*.png - - e2e-tests/cypress/screenshots/**/*.png - - e2e-tests/cypress/snapshots/**/* - - e2e-tests/cypress/snapshots/client-display/**/* - - e2e-tests/cypress/snapshots/client-display/**/__diff_output__/* - expire_in: 1 day - -pushToNexus: - except: - variables: - - $TYPE == "postgrestest" - image: maven:3.6.0-jdk-11 - stage: pushToNexus - script: - - echo "@skills:registry=http://$NEXUS_SERVER/repository/skills-registry/" > ~/.npmrc - - cat ~/.npmrc - - echo "nexus-snapshotsadmin$NEXUS_PASSnexus-releasesadmin$NEXUS_PASScentralcentralhttp://$NEXUS_SERVER/repository/maven-public/*" > ~/.m2/settings.xml - - cat ~/.m2/settings.xml - - backendJar=$(ls backend/target/backend-*.jar) - - echo $backendJar - - mvn --batch-mode deploy:deploy-file -DpomFile=backend/pom.xml -Dfile=${backendJar} -Durl=http://ip-10-113-80-244.evoforge.org/repository/maven-snapshots/ -DrepositoryId=nexus-snapshots - artifacts: - paths: - - backend/target/backend-*.jar - - backend/target/skills-service-tests.log - only: - refs: - - branches - variables: - - $BRANCH_TO_DEPLOY_SKILLS_SERVICE == $CI_COMMIT_REF_NAME - -deploy: - except: - variables: - - $TYPE == "postgrestest" - image: alpine:latest - stage: deploy - before_script: - - apk --update --no-cache add sshpass openssh git - script: - - git clone https://${GITLAB_DEPLOY_USERNAME}:${GITLAB_DEPLOY_PASSWORD}@gitlab.evoforge.org/skills/skills-deploy.git - - TIMESTAMP=`date +%s` - - TMP_DIR="deploy_${TIMESTAMP}" - - DEST_PATH="/home/${CI_USERNAME}/$TMP_DIR" - - sshpass -p $CI_PASSWORD ssh -o StrictHostKeyChecking=no -o PreferredAuthentications=password -o PubkeyAuthentication=no $CI_USERNAME@$CI_IP "rm -rf /home/${CI_USERNAME}/deploy_* && mkdir -p ${DEST_PATH}" - - cp backend/target/backend-*.jar backend.jar - - sshpass -p $CI_PASSWORD scp -r skills-deploy ${CI_USERNAME}@${CI_IP}:${DEST_PATH} - - sshpass -p $CI_PASSWORD scp -r backend.jar ${CI_USERNAME}@${CI_IP}:${DEST_PATH}/skills-deploy - - sshpass -p $CI_PASSWORD ssh -o StrictHostKeyChecking=no -o PreferredAuthentications=password -o PubkeyAuthentication=no $CI_USERNAME@$CI_IP "cd ${DEST_PATH}/skills-deploy && ./runDeploy.sh" - only: - refs: - - branches - variables: - - $BRANCH_TO_DEPLOY_SKILLS_SERVICE == $CI_COMMIT_REF_NAME diff --git a/CONTRIBUTING_IO.md b/CONTRIBUTING_IO.md new file mode 100644 index 00000000..0231ca28 --- /dev/null +++ b/CONTRIBUTING_IO.md @@ -0,0 +1,12 @@ + +## Legal + +Consistent with Section D.6. of the GitHub Terms of Service as of 2019, and Section 5. of the Apache License, Version 2.0, the project maintainer for this project accepts contributions using the inbound=outbound model. +When you submit a pull request to this repository (inbound), you are agreeing to license your contribution under the same terms as specified in [LICENSE] (outbound). + +This is an open source project. +Contributions you make to this public U.S. Government ("USG") repository are completely voluntary. +When you submit an issue, bug report, question, enhancement, pull request, etc., you are offering your contribution without expectation of payment, you expressly waive any future pay claims against the USG related to your contribution, and you acknowledge that this does not create an obligation on the part of the USG of any kind. +Furthermore, your contributing to this project does not create an employer-employee relationship between the United States ("U.S.") Government and the contributor. + +[LICENSE]: LICENSE.txt \ No newline at end of file diff --git a/DISCLAIMER.md b/DISCLAIMER.md new file mode 100644 index 00000000..a33b5994 --- /dev/null +++ b/DISCLAIMER.md @@ -0,0 +1,13 @@ +# Disclaimer of Warranty + +This Work is provided "AS IS." +Any express or implied warranties, including but not limited to, the implied warranties of merchantability and fitness for a particular purpose are disclaimed. +In no event shall the United States Government be liable for any direct, indirect, incidental, special, exemplary or consequential damages (including, but not limited to, procurement of substitute goods or services, loss of use, data or profits, or business interruption) however caused and on any theory of liability, whether in contract, strict liability, or tort (including negligence or otherwise) arising in any way out of the use of this Work, even if advised of the possibility of such damage. + +The User of this Work agrees to hold harmless and indemnify the United States Government, its agents and employees from every claim or liability (whether in tort or in contract), including attorney's fees, court costs, and expenses, arising in direct consequence of Recipient's use of the item, including, but not limited to, claims or liabilities made for injury to or death of personnel of User or third parties, damage to or destruction of property of User or third parties, and infringement or other violations of intellectual property or technical data rights. + +# Disclaimer of Endorsement + +Nothing in this Work is intended to constitute an endorsement, explicit or implied, by the United States Government of any particular manufacturer's product or service. + +Reference herein to any specific commercial product, process, or service by trade name, trademark, manufacturer, or otherwise, in this Work does not constitute an endorsement, recommendation, or favoring by the United States Government and shall not be used for advertising or product endorsement purposes. diff --git a/INTENT.md b/INTENT.md new file mode 100644 index 00000000..e8015369 --- /dev/null +++ b/INTENT.md @@ -0,0 +1,19 @@ +## Licensing Intent + +The intent is that this software and documentation ("Project") should be treated +as if it is licensed under the license associated with the Project ("License") +in the LICENSE file. However, because we are part of the United States (U.S.) +Federal Government, it is not that simple. + +The portions of this Project written by U.S. Federal Government employees within +the scope of their federal employment are ineligible for copyright protection in +the U.S.; this is generally understood to mean that these portions of the +Project are placed in the public domain. + +In countries where copyright protection is available (which does not include the +U.S.), contributions made by U.S. Federal Government employees are released +under the License. Merged contributions from private contributors are released +under the License. + +The SkillTree software is released under the Apache License, Version 2.0 +("Apache 2.0"). \ No newline at end of file diff --git a/README.md b/README.md index e69de29b..a9cf9acc 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,21 @@ +![SkillTree](skilltree_logo.png) + +# SkillTree Service, Dashboard and Client Display +SkillTree is a micro-learning gamification platform providing out-of-the-box UI visualizations, convenient client integration libaries, and a dashboard for mananging the creation and administration of Gamified Training Profiles. + +To learn more about the SkillTree platform please visit our [Official Documentation](https://code.nsa.gov/skills-docs/). +These pages provide in-depth guidance on installation, usage and contribution. + + +# Workflows Status + +[![CI Badge](https://github.com/NationalSecurityAgency/skills-service/workflows/Continuous%20Integration/badge.svg)](https://github.com/NationalSecurityAgency/skills-service/actions?query=workflow%3A%22Continuous+Integration%22) + + +[![DB Test Badge](https://github.com/NationalSecurityAgency/skills-service/workflows/Test%20against%20PostgreSQL/badge.svg)](https://github.com/NationalSecurityAgency/skills-service/actions?query=workflow%3A%22Test+against+PostgreSQL%22) + +[![Test storing HttpSession in Redis](https://github.com/NationalSecurityAgency/skills-service/workflows/Test%20storing%20HttpSession%20in%20Redis/badge.svg)](https://github.com/NationalSecurityAgency/skills-service/actions?query=workflow%3A%22Test+storing+HttpSession+in+Redis%22) + +[![Test Web Sockets over STOMP using RabbitMQ](https://github.com/NationalSecurityAgency/skills-service/workflows/Test%20Web%20Sockets%20over%20STOMP%20using%20RabbitMQ/badge.svg)](https://github.com/NationalSecurityAgency/skills-service/actions?query=workflow%3A%22Test+Web+Sockets+over+STOMP+using+RabbitMQ%22) + +[![Run integration tests using two way ssl](https://github.com/NationalSecurityAgency/skills-service/workflows/Run%20integration%20tests%20using%20two%20way%20ssl/badge.svg)](https://github.com/NationalSecurityAgency/skills-service/actions?query=workflow%3A%22Run+integration+tests+using+two+way+ssl%22) diff --git a/backend/src/main/java/skills/WebSocketConfig.groovy b/backend/src/main/java/skills/WebSocketConfig.groovy deleted file mode 100644 index aa183008..00000000 --- a/backend/src/main/java/skills/WebSocketConfig.groovy +++ /dev/null @@ -1,149 +0,0 @@ -/** - * Copyright 2020 SkillTree - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * https://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package skills - -import groovy.util.logging.Slf4j -import org.springframework.beans.factory.annotation.Value -import org.springframework.context.annotation.Configuration -import org.springframework.core.annotation.Order -import org.springframework.messaging.Message -import org.springframework.messaging.MessageChannel -import org.springframework.messaging.simp.config.ChannelRegistration -import org.springframework.messaging.simp.config.MessageBrokerRegistry -import org.springframework.messaging.simp.stomp.StompCommand -import org.springframework.messaging.simp.stomp.StompHeaderAccessor -import org.springframework.messaging.support.ChannelInterceptor -import org.springframework.messaging.support.MessageHeaderAccessor -import org.springframework.security.authentication.AbstractAuthenticationToken -import org.springframework.security.authentication.AuthenticationDetailsSource -import org.springframework.security.core.Authentication -import org.springframework.security.oauth2.provider.authentication.BearerTokenExtractor -import org.springframework.security.oauth2.provider.authentication.OAuth2AuthenticationDetails -import org.springframework.security.oauth2.provider.authentication.OAuth2AuthenticationDetailsSource -import org.springframework.security.oauth2.provider.authentication.TokenExtractor -import org.springframework.security.web.UnsupportedOperationExceptionInvocationHandler -import org.springframework.web.socket.config.annotation.EnableWebSocketMessageBroker -import org.springframework.web.socket.config.annotation.StompEndpointRegistry -import org.springframework.web.socket.config.annotation.WebSocketMessageBrokerConfigurer -import skills.auth.AuthMode -import skills.auth.form.oauth2.SkillsOAuth2AuthenticationManager - -import javax.servlet.http.HttpServletRequest -import javax.servlet.http.HttpServletRequestWrapper -import javax.servlet.http.HttpSession -import java.lang.reflect.Proxy - -@Configuration -@Slf4j -@Order(-2147483549) // Ordered.HIGHEST_PRECEDENCE + 99 (see https://github.com/spring-projects/spring-framework/blob/master/src/docs/asciidoc/web/websocket.adoc#token-authentication) -@EnableWebSocketMessageBroker -class WebSocketConfig implements WebSocketMessageBrokerConfigurer { - - static final String AUTHORIZATION = 'Authorization' - - @Value('#{"${skills.websocket.enableStompBrokerRelay:false}"}') - Boolean enableStompBrokerRelay - - @Value('#{"${skills.websocket.relayHost:skills-stomp-broker}"}') - String relayHost - - @Value('#{"${skills.websocket.relayPort:61613}"}') - Integer relayPort - - // injected by the SkillsOAuth2AuthenticationManager itself (only when using SecurityMode.FormAuth) - SkillsOAuth2AuthenticationManager oAuth2AuthenticationManager - - @Value('${skills.authorization.authMode:#{T(skills.auth.AuthMode).DEFAULT_AUTH_MODE}}') - AuthMode authMode - - @Override - void configureMessageBroker(MessageBrokerRegistry registry) { - if (enableStompBrokerRelay) { - registry.enableStompBrokerRelay('/topic', '/queue') - .setRelayHost(relayHost) - .setRelayPort(relayPort) - .setUserRegistryBroadcast('/topic/registry') - .setUserDestinationBroadcast('/topic/unresolved-user-destination') - } else { - registry.enableSimpleBroker('/topic', '/queue') - } - registry.setApplicationDestinationPrefixes('/app') - } - - @Override - void registerStompEndpoints(StompEndpointRegistry registry) { - registry.addEndpoint('/skills-websocket') - .setAllowedOrigins("*") - .withSockJS() - } - - @Override - void configureClientInboundChannel(ChannelRegistration registration) { - if (authMode == AuthMode.FORM) { // only injected when using SecurityMode.FormAuth - log.info('Initializing websocket registration interceptor.') - registration.interceptors(new ChannelInterceptor() { - TokenExtractor tokenExtractor = new BearerTokenExtractor() - AuthenticationDetailsSource authenticationDetailsSource = new OAuth2AuthenticationDetailsSource(); - - @Override - Message preSend(Message message, MessageChannel channel) { - StompHeaderAccessor accessor = MessageHeaderAccessor.getAccessor(message, StompHeaderAccessor.class) - if (StompCommand.CONNECT == accessor.getCommand()) { - List authHeaders = accessor.getNativeHeader(AUTHORIZATION) - if (authHeaders) { - log.debug("Found Authorization headers on websocket connection: [{}]", authHeaders) - WebSocketHttpServletRequest request = new WebSocketHttpServletRequest(headers: [(AUTHORIZATION): Collections.enumeration(authHeaders)]) - Authentication authentication = tokenExtractor.extract(request) - if (authentication) { - request.setAttribute(OAuth2AuthenticationDetails.ACCESS_TOKEN_VALUE, authentication.getPrincipal()); - if (authentication instanceof AbstractAuthenticationToken) { - AbstractAuthenticationToken needsDetails = (AbstractAuthenticationToken) authentication; - needsDetails.setDetails(authenticationDetailsSource.buildDetails(request)); - } - Authentication authResult = oAuth2AuthenticationManager.authenticate(authentication); - if (authResult.authenticated) { - log.debug("Setting OAuth user [{}] on websocket connection", authResult) - accessor.setUser(authResult) - } - } - } - } - return message - } - }) - } - } - - static class WebSocketHttpServletRequest extends HttpServletRequestWrapper { - private static final HttpServletRequest UNSUPPORTED_REQUEST = (HttpServletRequest) Proxy - .newProxyInstance(WebSocketHttpServletRequest.class.getClassLoader(), - [ HttpServletRequest.class ] as Class[], - new UnsupportedOperationExceptionInvocationHandler()) - - String remoteAddr - Map attributes = [:] - Map> headers = [:] - - WebSocketHttpServletRequest() { super(UNSUPPORTED_REQUEST) } - - Object getAttribute(String attributeName) { return attributes.get(attributeName) } - void setAttribute(String name, Object o) { attributes.put(name, o) } - - Enumeration getHeaders(String name) { return headers.get(name) } - - HttpSession getSession(boolean create) { return null } - } -} diff --git a/backend/src/main/java/skills/auth/PortalWebSecurityHelper.groovy b/backend/src/main/java/skills/auth/PortalWebSecurityHelper.groovy deleted file mode 100644 index d65c094f..00000000 --- a/backend/src/main/java/skills/auth/PortalWebSecurityHelper.groovy +++ /dev/null @@ -1,38 +0,0 @@ -/** - * Copyright 2020 SkillTree - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * https://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package skills.auth - -import org.springframework.security.config.annotation.web.builders.HttpSecurity -import org.springframework.stereotype.Component -import skills.storage.model.auth.RoleName - -@Component -class PortalWebSecurityHelper { - HttpSecurity configureHttpSecurity(HttpSecurity http) { - http - .csrf().disable() - .authorizeRequests() - .antMatchers("/", "/favicon.ico", "/icons/**", "/static/**", "/skills.ico", "/skills.jpeg", "/error", "/oauth/**", "/app/oAuthProviders", "/login*", "/bootstrap/**", "/performLogin", "/createAccount", "/createRootAccount", '/grantFirstRoot', '/userExists/**', "/app/userInfo", "/app/users/validExistingDashboardUserId/*", "/app/oAuthProviders", "index.html", "/public/**", "/skills-websocket/**").permitAll() - .antMatchers('/admin/**').hasRole('PROJECT_ADMIN') - .antMatchers('/supervisor/**').hasAnyAuthority(RoleName.ROLE_SUPERVISOR.name(), RoleName.ROLE_SUPER_DUPER_USER.name()) - .antMatchers('/root/isRoot').hasAnyAuthority(RoleName.values().collect {it.name()}.toArray(new String[0])) - .antMatchers('/root/**').hasRole('SUPER_DUPER_USER') - .anyRequest().authenticated() - http.headers().frameOptions().disable() - - return http - } -} diff --git a/backend/src/main/java/skills/auth/form/oauth2/OAuth2UserConverterService.groovy b/backend/src/main/java/skills/auth/form/oauth2/OAuth2UserConverterService.groovy deleted file mode 100644 index e2db3a27..00000000 --- a/backend/src/main/java/skills/auth/form/oauth2/OAuth2UserConverterService.groovy +++ /dev/null @@ -1,110 +0,0 @@ -/** - * Copyright 2020 SkillTree - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * https://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package skills.auth.form.oauth2 - -import org.springframework.beans.factory.annotation.Autowired -import org.springframework.context.annotation.Conditional -import org.springframework.security.oauth2.core.user.OAuth2User -import org.springframework.stereotype.Component -import skills.auth.SecurityMode -import skills.auth.SkillsAuthorizationException -import skills.auth.UserAuthService -import skills.auth.UserInfo - -import javax.annotation.Resource - -@Component -@Conditional(SecurityMode.FormAuth) -class OAuth2UserConverterService { - - @Autowired - UserAuthService userAuthService - - @Resource(name='oauth2UserConverters') - Map lookup = [:] - - UserInfo convert(String clientId, OAuth2User oAuth2User) { - UserInfo userInfo - OAuth2UserConverter converter = lookup.get(clientId.toLowerCase()) - if (converter) { - userInfo = converter.convert(clientId, oAuth2User) - } else { - throw new SkillsAuthorizationException("No OAuth2UserConverter configured for clientId [${clientId}]") - } - return userInfo - } - - static interface OAuth2UserConverter { - String getClientId() - UserInfo convert(String clientId, OAuth2User oAuth2User) - } - - static class GitHubUserConverter implements OAuth2UserConverter { - static final String NAME = 'name' - static final String EMAIL = 'email' - - String clientId = 'github' - - @Override - UserInfo convert(String clientId, OAuth2User oAuth2User) { - String username = oAuth2User.getName() - assert username, "Error getting name attribute of oAuth2User [${oAuth2User}] from clientId [$clientId]" - String email = oAuth2User.attributes.get(EMAIL) - if (!email) { - throw new SkillsAuthorizationException("Email must be available in your public Github profile") - } - String name = oAuth2User.attributes.get(NAME) - if (!name) { - throw new SkillsAuthorizationException("Name must be available in your public Github profile") - } - String firstName = name?.tokenize()?.first() - List tokens = name?.tokenize() - tokens?.pop() - String lastName = tokens?.join(' ') - return new UserInfo( - username: "${username}-${clientId}", - email:email, - firstName: firstName, - lastName: lastName, - ) - } - } - - static class GoogleUserConverter implements OAuth2UserConverter { - static final String FIRST_NAME = 'given_name' - static final String LAST_NAME = 'family_name' - static final String EMAIL = 'email' - - String clientId = 'google' - - @Override - UserInfo convert(String clientId, OAuth2User oAuth2User) { - String username = oAuth2User.getName() - assert username, "Error getting name attribute of oAuth2User [${oAuth2User}] from clientId [$clientId]" - String firstName = oAuth2User.attributes.get(FIRST_NAME) - String lastName = oAuth2User.attributes.get(LAST_NAME) - String email = oAuth2User.attributes.get(EMAIL) - assert firstName && lastName && email, "First Name [$firstName], Last Name [$lastName], and email [$email] must be available in your public Google profile" - - return new UserInfo( - username: "${username}-${clientId}", - email:email, - firstName: firstName, - lastName: lastName, - ) - } - } -} diff --git a/backend/src/main/java/skills/controller/AdminMetricsController.groovy b/backend/src/main/java/skills/controller/AdminMetricsController.groovy deleted file mode 100644 index beef5324..00000000 --- a/backend/src/main/java/skills/controller/AdminMetricsController.groovy +++ /dev/null @@ -1,59 +0,0 @@ -/** - * Copyright 2020 SkillTree - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * https://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package skills.controller - -import groovy.util.logging.Slf4j -import org.springframework.beans.factory.annotation.Autowired -import org.springframework.web.bind.annotation.* -import skills.services.AdminUsersService -import skills.metrics.ChartParams -import skills.metrics.MetricsService -import skills.metrics.model.MetricsChart -import skills.metrics.model.Section -import skills.profile.EnableCallStackProf - -@RestController -@RequestMapping("/admin") -@Slf4j -@EnableCallStackProf -class AdminMetricsController { - - @Autowired - AdminUsersService adminUsersService - - @Autowired - MetricsService metricsService - - @RequestMapping(value = "/projects/{projectId}/{section}/{sectionId}/metrics", method = RequestMethod.GET, produces = "application/json") - List getAllSectionMetricsCharts(@PathVariable("projectId") String projectId, - @PathVariable("section") Section section, - @PathVariable(ChartParams.SECTION_ID) String sectionId, - @RequestParam Map chartProps) { - chartProps.put(ChartParams.SECTION_ID, sectionId) - return metricsService.loadChartsForSection(section, projectId, chartProps) - } - - @RequestMapping(value = "/projects/{projectId}/{section}/{sectionId}/metrics/{chartBuilderId}", method = RequestMethod.GET, produces = "application/json") - MetricsChart getSectionMetricsChart(@PathVariable("projectId") String projectId, - @PathVariable("section") Section section, - @PathVariable(ChartParams.SECTION_ID) String sectionId, - @PathVariable(ChartParams.CHART_BUILDER_ID) String chartBuilderId, - @RequestParam Map chartProps) { - chartProps.put(ChartParams.SECTION_ID, sectionId) - return metricsService.loadChartForSection(chartBuilderId, section, projectId, chartProps) - } - -} diff --git a/backend/src/main/java/skills/controller/GlobalMetricsController.groovy b/backend/src/main/java/skills/controller/GlobalMetricsController.groovy deleted file mode 100644 index dfdcd325..00000000 --- a/backend/src/main/java/skills/controller/GlobalMetricsController.groovy +++ /dev/null @@ -1,54 +0,0 @@ -/** - * Copyright 2020 SkillTree - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * https://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package skills.controller - -import groovy.util.logging.Slf4j -import org.springframework.beans.factory.annotation.Autowired -import org.springframework.web.bind.annotation.* -import skills.metrics.ChartParams -import skills.metrics.MetricsService -import skills.metrics.model.MetricsChart -import skills.metrics.model.Section -import skills.profile.EnableCallStackProf -import skills.services.AdminUsersService - -@RestController -@RequestMapping("/metrics") -@Slf4j -@EnableCallStackProf -class GlobalMetricsController { - - @Autowired - AdminUsersService adminUsersService - - @Autowired - MetricsService metricsService - - @RequestMapping(value = "/{section}", method = RequestMethod.GET, produces = "application/json") - List getAllGlobalSectionMetricsCharts(@PathVariable("section") Section section){ - return metricsService.loadChartsForSection(section, null, [:]) - } - - @RequestMapping(value = "/{section}/{sectionId}/metric/{chartBuilderId}", method = RequestMethod.GET, produces = "application/json") - MetricsChart getGlobalSectionMetricsChart(@PathVariable("section") Section section, - @PathVariable(ChartParams.SECTION_ID) String sectionId, - @PathVariable(ChartParams.CHART_BUILDER_ID) String chartBuilderId, - @RequestParam Map chartProps){ - - chartProps.put(ChartParams.SECTION_ID, sectionId) - return metricsService.loadChartForSection(chartBuilderId, section, null, chartProps) - } -} diff --git a/backend/src/main/java/skills/controller/PublicConfigController.groovy b/backend/src/main/java/skills/controller/PublicConfigController.groovy deleted file mode 100644 index ba4e0ab8..00000000 --- a/backend/src/main/java/skills/controller/PublicConfigController.groovy +++ /dev/null @@ -1,58 +0,0 @@ -/** - * Copyright 2020 SkillTree - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * https://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package skills.controller - -import groovy.util.logging.Slf4j -import org.springframework.beans.factory.annotation.Autowired -import org.springframework.web.bind.annotation.CrossOrigin -import org.springframework.web.bind.annotation.RequestMapping -import org.springframework.web.bind.annotation.RequestMethod -import org.springframework.web.bind.annotation.ResponseBody -import org.springframework.web.bind.annotation.RestController -import skills.HealthChecker -import skills.UIConfigProperties -import skills.profile.EnableCallStackProf - -@RestController -@RequestMapping("/public") -@Slf4j -@EnableCallStackProf -class PublicConfigController { - - @Autowired - HealthChecker healthChecker - - @Autowired - UIConfigProperties uiConfigProperties - - @RequestMapping(value = "/config", method = RequestMethod.GET, produces = "application/json") - @ResponseBody - Map getConfig(){ - return uiConfigProperties.ui - } - - final private static Map statusRes = [ - status: "OK", - ] - - @CrossOrigin - @RequestMapping(value = "/status", method = RequestMethod.GET, produces = "application/json") - @ResponseBody - def status() { - healthChecker.checkRequiredServices() - return statusRes - } -} diff --git a/backend/src/main/java/skills/controller/UserTokenController.groovy b/backend/src/main/java/skills/controller/UserTokenController.groovy deleted file mode 100644 index 90ec9079..00000000 --- a/backend/src/main/java/skills/controller/UserTokenController.groovy +++ /dev/null @@ -1,73 +0,0 @@ -/** - * Copyright 2020 SkillTree - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * https://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package skills.controller - -import org.springframework.beans.factory.annotation.Autowired -import org.springframework.context.annotation.Conditional -import org.springframework.http.MediaType -import org.springframework.http.ResponseEntity -import org.springframework.security.authentication.UsernamePasswordAuthenticationToken -import org.springframework.security.oauth2.common.OAuth2AccessToken -import org.springframework.security.oauth2.provider.endpoint.TokenEndpoint -import org.springframework.web.bind.annotation.PathVariable -import org.springframework.web.bind.annotation.RequestMapping -import org.springframework.web.bind.annotation.RequestMethod -import org.springframework.web.bind.annotation.ResponseBody -import org.springframework.web.bind.annotation.RestController -import skills.auth.SecurityMode -import skills.services.InceptionProjectService - -@Conditional(SecurityMode.FormAuth) -@RestController -@skills.profile.EnableCallStackProf -class UserTokenController { - - @Autowired - TokenEndpoint tokenEndpoint - - /** - * token for inception - * @param userId - * @return - */ - @RequestMapping(value = "/app/projects/Inception/users/{userId}/token", method = RequestMethod.GET, produces = MediaType.APPLICATION_JSON_VALUE) - @ResponseBody - ResponseEntity getUserToken(@PathVariable("userId") String userId) { - return createToken(InceptionProjectService.inceptionProjectId, userId) - } - - - /** - * utilized by client-display within a project that previews that project's points - * @param projectId - * @param userId - * @return - */ - @RequestMapping(value = "/admin/projects/{projectId}/token/{userId}", method = RequestMethod.GET, produces = MediaType.APPLICATION_JSON_VALUE) - @ResponseBody - ResponseEntity getUserToken(@PathVariable("projectId") String projectId, @PathVariable("userId") String userId) { - return createToken(projectId, userId) - } - - private ResponseEntity createToken(String projectId, String userId) { - skills.controller.exceptions.SkillsValidator.isNotBlank(projectId, "Project Id") - skills.controller.exceptions.SkillsValidator.isNotBlank(userId, "User Id") - - UsernamePasswordAuthenticationToken principal = new UsernamePasswordAuthenticationToken(projectId, null, []) - Map parameters = [grant_type: 'client_credentials', proxy_user: userId] - return tokenEndpoint.postAccessToken(principal, parameters) - } -} diff --git a/backend/src/main/java/skills/metrics/ChartParams.groovy b/backend/src/main/java/skills/metrics/ChartParams.groovy deleted file mode 100644 index 29c1e1f1..00000000 --- a/backend/src/main/java/skills/metrics/ChartParams.groovy +++ /dev/null @@ -1,43 +0,0 @@ -/** - * Copyright 2020 SkillTree - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * https://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package skills.metrics - -import groovy.transform.CompileStatic - -@CompileStatic -class ChartParams { - public static final String CHART_BUILDER_ID = 'chartBuilderId' - public static final String NUM_DAYS = 'numDays' // limit data to X days - public static final String NUM_MONTHS = 'numMonths' // limit data to X months - public static final String LOAD_DATA_FOR_FIRST = 'loadDataForFirst' // only load the first X charts data for a section - public static final String SECTION_ID = 'sectionId' - - static String getValue(Map props, String key, String defaultVal=null) { - String value = defaultVal - if (props.get(key)) { - value = props.get(key) - } - return value - } - - static Integer getIntValue(Map props, String key, Integer defaultVal=null) { - Integer value = defaultVal - if (props.get(key)?.isInteger()) { - value = props.get(key).toInteger() - } - return value - } -} diff --git a/backend/src/main/java/skills/metrics/MetricsService.groovy b/backend/src/main/java/skills/metrics/MetricsService.groovy deleted file mode 100644 index 10c1730d..00000000 --- a/backend/src/main/java/skills/metrics/MetricsService.groovy +++ /dev/null @@ -1,91 +0,0 @@ -/** - * Copyright 2020 SkillTree - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * https://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package skills.metrics - -import groovy.transform.CompileStatic -import groovy.util.logging.Slf4j -import org.springframework.beans.factory.annotation.Autowired -import org.springframework.context.ApplicationContext -import org.springframework.stereotype.Service -import skills.controller.exceptions.ErrorCode -import skills.controller.exceptions.SkillException -import skills.metrics.model.ChartOption -import skills.metrics.model.MetricsChart -import skills.metrics.builders.MetricsChartBuilder -import skills.metrics.model.Section - -import javax.annotation.PostConstruct - -@Service -@Slf4j -@CompileStatic -class MetricsService { - - @Autowired - ApplicationContext appContext - - Map> chartBuildersMap - - @PostConstruct - void init() { - chartBuildersMap = appContext.getBeansOfType(MetricsChartBuilder).values().groupBy { it.section } - chartBuildersMap.each { section, builders -> - assert builders.size() == builders.collect { it.displayOrder }.unique().size() - builders.sort { it.displayOrder } - } - } - - List loadChartsForSection(Section section, String projectId, Map props) { - int loadFirst = ChartParams.getIntValue(props, ChartParams.LOAD_DATA_FOR_FIRST, -1) - int i = 0 - return chartBuildersMap.get(section)?.collect { builder -> - boolean loadData = loadFirst < 0 || ++i <= loadFirst - MetricsChart chart = builder.build(projectId, props, loadData) - if(chart != null) { - chart.dataLoaded = loadData - if (loadData) { - clearDataItemsIfAllValuesZero(chart) - } - chart.chartOptions.put(ChartOption.chartBuilderId, builder.class.name) - } - return chart - }?.findAll { it != null } - } - - MetricsChart loadChartForSection(String builderId, Section section, String projectId, Map props) { - MetricsChartBuilder chartBuilder = chartBuildersMap.get(section).find { it.class.name == builderId} - if (!chartBuilder) { - SkillException ex = new SkillException("Unknown chart builder id [$builderId]") - ex.errorCode = ErrorCode.BadParam - throw ex - } - MetricsChart chart = chartBuilder.build(projectId, props, true) - if (chart != null) { - chart.chartOptions.put(ChartOption.chartBuilderId, chartBuilder.class.name) - chart.dataLoaded = true - clearDataItemsIfAllValuesZero(chart) - } - return chart - } - - private void clearDataItemsIfAllValuesZero(MetricsChart chart) { - if (chart.dataItems) { - if (chart.dataItems?.collect({ it.count })?.unique() == [0]) { - chart.dataItems.clear() - } - } - } -} diff --git a/backend/src/main/java/skills/metrics/builders/badges/AchievedPerMonthChartBuilder.groovy b/backend/src/main/java/skills/metrics/builders/badges/AchievedPerMonthChartBuilder.groovy deleted file mode 100644 index 84b3e029..00000000 --- a/backend/src/main/java/skills/metrics/builders/badges/AchievedPerMonthChartBuilder.groovy +++ /dev/null @@ -1,71 +0,0 @@ -/** - * Copyright 2020 SkillTree - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * https://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package skills.metrics.builders.badges - -import groovy.transform.CompileStatic -import org.springframework.beans.factory.annotation.Autowired -import org.springframework.stereotype.Component -import skills.controller.result.model.CountItem -import skills.metrics.ChartParams -import skills.metrics.model.ChartOption -import skills.metrics.model.ChartType -import skills.metrics.model.MetricsChart -import skills.metrics.model.Section -import skills.services.AdminUsersService - -@Component('badges-AchievedPerMonthChartBuilder') -@CompileStatic -class AchievedPerMonthChartBuilder implements skills.metrics.builders.MetricsChartBuilder { - - static final Integer NUM_MONTHS_DEFAULT = 6 - - final Integer displayOrder = 1 - - @Autowired - AdminUsersService adminUsersService - - @Override - Section getSection() { - return Section.badges - } - - @Override - MetricsChart build(String projectId, Map props, boolean loadData=true) { - Integer numMonths = skills.metrics.ChartParams.getIntValue(props, skills.metrics.ChartParams.NUM_MONTHS, NUM_MONTHS_DEFAULT) - assert numMonths > 1, "Property [${skills.metrics.ChartParams.NUM_MONTHS}] with value [${numMonths}] must be greater than 1" - - String badgeId = ChartParams.getValue(props, ChartParams.SECTION_ID) - assert badgeId, "badgeId must be specified via ${skills.metrics.ChartParams.SECTION_ID} url param" - - List dataItems = (loadData ? adminUsersService.getBadgesPerMonth(projectId, badgeId, numMonths) : []) as List - - MetricsChart metricsChart = new MetricsChart( - chartType: ChartType.VerticalBar, - dataItems: dataItems, - chartOptions: getChartOptions(), - ) - return metricsChart - } - - private Map getChartOptions() { - Map chartOptions = [ - (ChartOption.title) : 'Distinct # of Users per Month', - (ChartOption.yAxisLabel): 'Distinct # of Users', - (ChartOption.dataLabel) : 'Distinct Users', - ] as Map - return chartOptions - } -} diff --git a/backend/src/main/java/skills/metrics/builders/badges/DistinctUsersOverTimeChartBuilder.groovy b/backend/src/main/java/skills/metrics/builders/badges/DistinctUsersOverTimeChartBuilder.groovy deleted file mode 100644 index 3aca9887..00000000 --- a/backend/src/main/java/skills/metrics/builders/badges/DistinctUsersOverTimeChartBuilder.groovy +++ /dev/null @@ -1,66 +0,0 @@ -/** - * Copyright 2020 SkillTree - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * https://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package skills.metrics.builders.badges - -import groovy.transform.CompileStatic -import org.springframework.beans.factory.annotation.Autowired -import org.springframework.stereotype.Component -import skills.services.AdminUsersService - -@Component('badges-DistinctUsersOverTimeChartBuilder') -@CompileStatic -class DistinctUsersOverTimeChartBuilder implements skills.metrics.builders.MetricsChartBuilder { - - static final Integer NUM_DAYS_DEFAULT = 120 - - final Integer displayOrder = 0 - - @Autowired - AdminUsersService adminUsersService - - @Override - skills.metrics.model.Section getSection() { - return skills.metrics.model.Section.badges - } - - @Override - skills.metrics.model.MetricsChart build(String projectId, Map props, boolean loadData=true) { - Integer numDays = skills.metrics.ChartParams.getIntValue(props, skills.metrics.ChartParams.NUM_DAYS, NUM_DAYS_DEFAULT) - assert numDays > 1, "Property [${skills.metrics.ChartParams.NUM_DAYS}] with value [${numDays}] must be greater than 1" - - String badgeId = skills.metrics.ChartParams.getValue(props, skills.metrics.ChartParams.SECTION_ID) - assert badgeId, "badgeId must be specified via ${skills.metrics.ChartParams.SECTION_ID} url param" - - List dataItems = (loadData ? adminUsersService.getBadgesPerDay(projectId, badgeId, numDays) : []) as List - - skills.metrics.model.MetricsChart metricsChart = new skills.metrics.model.MetricsChart( - chartType: skills.metrics.model.ChartType.Line, - dataItems: dataItems, - chartOptions: getChartOptions(), - ) - return metricsChart - } - - private Map getChartOptions() { - Map chartOptions = [ - (skills.metrics.model.ChartOption.title) : 'Distinct # of Users over Time', - (skills.metrics.model.ChartOption.xAxisType) : 'datetime', - (skills.metrics.model.ChartOption.yAxisLabel): 'Distinct # of Users', - (skills.metrics.model.ChartOption.dataLabel) : 'Distinct Users', - ] as Map - return chartOptions - } -} diff --git a/backend/src/main/java/skills/metrics/builders/global/NumUsersPerProjectBuilder.groovy b/backend/src/main/java/skills/metrics/builders/global/NumUsersPerProjectBuilder.groovy deleted file mode 100644 index 677313f6..00000000 --- a/backend/src/main/java/skills/metrics/builders/global/NumUsersPerProjectBuilder.groovy +++ /dev/null @@ -1,85 +0,0 @@ -/** - * Copyright 2020 SkillTree - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * https://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package skills.metrics.builders.global - -import groovy.transform.CompileStatic -import org.springframework.beans.factory.annotation.Autowired -import org.springframework.stereotype.Component -import skills.controller.result.model.CountItem -import skills.controller.result.model.LabelCountItem -import skills.controller.result.model.ProjectResult -import skills.metrics.builders.MetricsChartBuilder -import skills.metrics.model.ChartOption -import skills.metrics.model.ChartType -import skills.metrics.model.MetricsChart -import skills.metrics.model.Section -import skills.services.AdminUsersService -import skills.services.admin.ProjAdminService - -@Component -@CompileStatic -class NumUsersPerProjectBuilder implements MetricsChartBuilder{ - - @Autowired - AdminUsersService usersService - - @Autowired - ProjAdminService projAdminService - - @Override - Section getSection() { - return Section.global - } - - @Override - Integer getDisplayOrder() { - return 8 - } - - @Override - MetricsChart build(String projectId, Map props, boolean loadData) { - - List projectResults = projAdminService.getProjects() - if (projectResults.size() < 2){ - return null - } - - List chartData = [] - projectResults.each { - LabelCountItem item = new LabelCountItem() - item.value = it.name - item.count = (int)usersService.countTotalProjUsers(it.projectId) - chartData.add(item) - } - - MetricsChart chart = new MetricsChart( - dataItems: chartData, - chartType: ChartType.HorizontalBar, - chartOptions: getChartOptions() - ) - - return chart - } - - private Map getChartOptions() { - Map chartOptions = [ - (ChartOption.title) : 'Number of users per project', - (ChartOption.showDataLabels): true, - (ChartOption.sort) : 'asc', - ] as Map - return chartOptions - } -} diff --git a/backend/src/main/java/skills/metrics/builders/global/SkillCountPerProjectBuilder.groovy b/backend/src/main/java/skills/metrics/builders/global/SkillCountPerProjectBuilder.groovy deleted file mode 100644 index f259604e..00000000 --- a/backend/src/main/java/skills/metrics/builders/global/SkillCountPerProjectBuilder.groovy +++ /dev/null @@ -1,84 +0,0 @@ -/** - * Copyright 2020 SkillTree - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * https://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package skills.metrics.builders.global - -import groovy.transform.CompileStatic -import org.springframework.beans.factory.annotation.Autowired -import org.springframework.stereotype.Component -import skills.controller.result.model.CountItem -import skills.controller.result.model.LabelCountItem -import skills.metrics.builders.MetricsChartBuilder -import skills.metrics.model.ChartOption -import skills.metrics.model.ChartType -import skills.metrics.model.MetricsChart -import skills.metrics.model.Section -import skills.services.AdminUsersService -import skills.services.admin.ProjAdminService - -@Component -@CompileStatic -class SkillCountPerProjectBuilder implements MetricsChartBuilder{ - - @Autowired - AdminUsersService usersService - - @Autowired - ProjAdminService projAdminService - - @Override - Section getSection() { - return Section.global - } - - @Override - Integer getDisplayOrder() { - return 9 - } - - @Override - MetricsChart build(String projectId, Map props, boolean loadData) { - - def projectResults = projAdminService.getProjects() - if (projectResults.size() < 2){ - return null - } - - List chartData = [] - - projectResults.each{ - def item = new LabelCountItem(count: (int) projAdminService.countNumberOfSkills(it.projectId), value: it.name) - chartData.add(item) - } - - MetricsChart chart = new MetricsChart( - dataItems: chartData, - chartType: ChartType.VerticalBar, - chartOptions: getChartOptions() - ) - - return chart - } - - private Map getChartOptions() { - Map chartOptions = [ - (ChartOption.title) : 'Number of Skills per project', - (ChartOption.showDataLabels): true, - (ChartOption.sort) : 'asc', - (ChartOption.dataLabel) : 'Number of Skills' - ] as Map - return chartOptions - } -} diff --git a/backend/src/main/java/skills/metrics/builders/projects/AchievedSkillsChartBuilder.groovy b/backend/src/main/java/skills/metrics/builders/projects/AchievedSkillsChartBuilder.groovy deleted file mode 100644 index 3c6bede5..00000000 --- a/backend/src/main/java/skills/metrics/builders/projects/AchievedSkillsChartBuilder.groovy +++ /dev/null @@ -1,67 +0,0 @@ -/** - * Copyright 2020 SkillTree - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * https://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package skills.metrics.builders.projects - -import groovy.transform.CompileStatic -import org.springframework.beans.factory.annotation.Autowired -import org.springframework.stereotype.Component -import skills.controller.result.model.CountItem -import skills.metrics.builders.MetricsChartBuilder -import skills.metrics.model.ChartOption -import skills.metrics.model.ChartType -import skills.metrics.model.MetricsChart -import skills.metrics.model.Section -import skills.services.AdminUsersService - -@Component -@CompileStatic -class AchievedSkillsChartBuilder implements MetricsChartBuilder { - - final Integer displayOrder = 2 - - @Autowired - AdminUsersService adminUsersService - - @Override - Section getSection() { - return Section.projects - } - - @Override - MetricsChart build(String projectId, Map props, boolean loadData=true) { - List dataItems = (loadData ? adminUsersService.getAchievementCountsPerSubject(projectId, 5) : []) as List - - MetricsChart metricsChart = new MetricsChart( - chartType: ChartType.HorizontalBar, - dataItems: dataItems, - chartOptions: getChartOptions(), - ) - return metricsChart - } - - private Map getChartOptions() { - Map chartOptions = [ - (ChartOption.title) : 'Achieved Skills By Subject (for ALL users)', - (ChartOption.showDataLabels) : true, - (ChartOption.dataLabel) : 'Achieved Skills', - (ChartOption.distributed) : true, - (ChartOption.dataLabelPosition): 'top', - (ChartOption.sort) : 'asc', - (ChartOption.palette) : 'palette2', - ] as Map - return chartOptions - } -} diff --git a/backend/src/main/java/skills/metrics/builders/projects/ContinuedUsageChartBuilder.groovy b/backend/src/main/java/skills/metrics/builders/projects/ContinuedUsageChartBuilder.groovy deleted file mode 100644 index 4e185572..00000000 --- a/backend/src/main/java/skills/metrics/builders/projects/ContinuedUsageChartBuilder.groovy +++ /dev/null @@ -1,65 +0,0 @@ -/** - * Copyright 2020 SkillTree - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * https://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package skills.metrics.builders.projects - -import groovy.transform.CompileStatic -import org.springframework.beans.factory.annotation.Autowired -import org.springframework.stereotype.Component -import skills.controller.result.model.CountItem -import skills.metrics.builders.MetricsChartBuilder -import skills.metrics.model.ChartOption -import skills.metrics.model.ChartType -import skills.metrics.model.MetricsChart -import skills.metrics.model.Section -import skills.services.AdminUsersService - -@Component -@CompileStatic -class ContinuedUsageChartBuilder implements MetricsChartBuilder { - - final Integer displayOrder = 6 - - @Autowired - AdminUsersService adminUsersService - - @Override - Section getSection() { - return Section.projects - } - - @Override - MetricsChart build(String projectId, Map props, boolean loadData=true) { - List dataItems = [] //(loadData ? adminUsersService.getUserCountsPerLevel(projectId) : []) as List - - MetricsChart metricsChart = new MetricsChart( - chartType: ChartType.VerticalBar, - dataItems: dataItems, - chartOptions: getChartOptions(), - ) - return metricsChart - } - - private Map getChartOptions() { - Map chartOptions = [ - (ChartOption.title) : 'Continued Usage', - (ChartOption.subtitle) : 'Do they stick around?', - (ChartOption.icon) : 'fa fa-suitcase', - (ChartOption.description): 'Once a particular skill is achieve, do users continue using that skill?', - (ChartOption.sort) : 'asc', - ] as Map - return chartOptions - } -} diff --git a/backend/src/main/java/skills/metrics/builders/projects/DistinctUsersOverTimeChartBuilder.groovy b/backend/src/main/java/skills/metrics/builders/projects/DistinctUsersOverTimeChartBuilder.groovy deleted file mode 100644 index bb0c810a..00000000 --- a/backend/src/main/java/skills/metrics/builders/projects/DistinctUsersOverTimeChartBuilder.groovy +++ /dev/null @@ -1,70 +0,0 @@ -/** - * Copyright 2020 SkillTree - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * https://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package skills.metrics.builders.projects - -import groovy.transform.CompileStatic -import org.springframework.beans.factory.annotation.Autowired -import org.springframework.stereotype.Component -import skills.controller.result.model.CountItem -import skills.metrics.ChartParams -import skills.metrics.builders.MetricsChartBuilder -import skills.metrics.model.ChartOption -import skills.metrics.model.ChartType -import skills.metrics.model.MetricsChart -import skills.metrics.model.Section -import skills.services.AdminUsersService - -@Component -@CompileStatic -class DistinctUsersOverTimeChartBuilder implements MetricsChartBuilder { - - static final Integer NUM_DAYS_DEFAULT = 120 - - final Integer displayOrder = 0 - - @Autowired - AdminUsersService adminUsersService - - @Override - Section getSection() { - return Section.projects - } - - @Override - MetricsChart build(String projectId, Map props, boolean loadData=true) { - Integer numDays = ChartParams.getIntValue(props, ChartParams.NUM_DAYS, NUM_DAYS_DEFAULT) - assert numDays > 1, "Property [${ChartParams.NUM_DAYS}] with value [${numDays}] must be greater than 1" - - List dataItems = (loadData ? adminUsersService.getProjectUsage(projectId, numDays) : []) as List - - MetricsChart metricsChart = new MetricsChart( - chartType: ChartType.Line, - dataItems: dataItems, - chartOptions: getChartOptions(), - ) - return metricsChart - } - - private Map getChartOptions() { - Map chartOptions = [ - (ChartOption.title) : 'Distinct # of Users over Time', - (ChartOption.xAxisType) : 'datetime', - (ChartOption.yAxisLabel): 'Distinct # of Users', - (ChartOption.dataLabel) : 'Distinct Users', - ] as Map - return chartOptions - } -} diff --git a/backend/src/main/java/skills/metrics/builders/projects/NumUsersPerBadgeChartBuilder.groovy b/backend/src/main/java/skills/metrics/builders/projects/NumUsersPerBadgeChartBuilder.groovy deleted file mode 100644 index e8985041..00000000 --- a/backend/src/main/java/skills/metrics/builders/projects/NumUsersPerBadgeChartBuilder.groovy +++ /dev/null @@ -1,65 +0,0 @@ -/** - * Copyright 2020 SkillTree - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * https://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package skills.metrics.builders.projects - -import groovy.transform.CompileStatic -import org.springframework.beans.factory.annotation.Autowired -import org.springframework.stereotype.Component -import skills.controller.result.model.CountItem -import skills.metrics.builders.MetricsChartBuilder -import skills.metrics.model.ChartOption -import skills.metrics.model.ChartType -import skills.metrics.model.MetricsChart -import skills.metrics.model.Section -import skills.services.AdminUsersService - -@Component -@CompileStatic -class NumUsersPerBadgeChartBuilder implements MetricsChartBuilder { - - final Integer displayOrder = 7 - - @Autowired - AdminUsersService adminUsersService - - @Override - Section getSection() { - return Section.projects - } - - @Override - MetricsChart build(String projectId, Map props, boolean loadData=true) { - List dataItems = [] //(loadData ? adminUsersService.getUserCountsPerLevel(projectId) : []) as List - - MetricsChart metricsChart = new MetricsChart( - chartType: ChartType.VerticalBar, - dataItems: dataItems, - chartOptions: getChartOptions(), - ) - return metricsChart - } - - private Map getChartOptions() { - Map chartOptions = [ - (ChartOption.title) : 'Badges', - (ChartOption.subtitle) : 'Number of users per badge', - (ChartOption.icon) : 'fa fa-award', - (ChartOption.description): 'Breakdown of number of users per badge.', - (ChartOption.sort) : 'asc', - ] as Map - return chartOptions - } -} diff --git a/backend/src/main/java/skills/metrics/builders/projects/NumUsersPerLevelChartBuilder.groovy b/backend/src/main/java/skills/metrics/builders/projects/NumUsersPerLevelChartBuilder.groovy deleted file mode 100644 index 74ce2bfa..00000000 --- a/backend/src/main/java/skills/metrics/builders/projects/NumUsersPerLevelChartBuilder.groovy +++ /dev/null @@ -1,64 +0,0 @@ -/** - * Copyright 2020 SkillTree - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * https://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package skills.metrics.builders.projects - -import groovy.transform.CompileStatic -import org.springframework.beans.factory.annotation.Autowired -import org.springframework.stereotype.Component -import skills.controller.result.model.CountItem -import skills.controller.result.model.LabelCountItem -import skills.metrics.builders.MetricsChartBuilder -import skills.metrics.model.ChartOption -import skills.metrics.model.ChartType -import skills.metrics.model.MetricsChart -import skills.metrics.model.Section -import skills.services.AdminUsersService - -@Component -@CompileStatic -class NumUsersPerLevelChartBuilder implements MetricsChartBuilder { - - final Integer displayOrder = 1 - - @Autowired - AdminUsersService adminUsersService - - @Override - Section getSection() { - return Section.projects - } - - @Override - MetricsChart build(String projectId, Map props, boolean loadData = true) { - List dataItems = loadData ? adminUsersService.getUserCountsPerLevel(projectId) : [] - - MetricsChart metricsChart = new MetricsChart( - chartType: ChartType.VerticalBar, - dataItems: dataItems as List, - chartOptions: getChartOptions(), - ) - return metricsChart - } - - private Map getChartOptions() { - Map chartOptions = [ - (ChartOption.title) : 'Number Users for each Level', - (ChartOption.showDataLabels): false, - (ChartOption.sort) : 'asc', - ] as Map - return chartOptions - } -} diff --git a/backend/src/main/java/skills/metrics/builders/projects/OverlookedSkillsChartBuilder.groovy b/backend/src/main/java/skills/metrics/builders/projects/OverlookedSkillsChartBuilder.groovy deleted file mode 100644 index 561b2485..00000000 --- a/backend/src/main/java/skills/metrics/builders/projects/OverlookedSkillsChartBuilder.groovy +++ /dev/null @@ -1,65 +0,0 @@ -/** - * Copyright 2020 SkillTree - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * https://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package skills.metrics.builders.projects - -import groovy.transform.CompileStatic -import org.springframework.beans.factory.annotation.Autowired -import org.springframework.stereotype.Component -import skills.controller.result.model.CountItem -import skills.metrics.builders.MetricsChartBuilder -import skills.metrics.model.ChartOption -import skills.metrics.model.ChartType -import skills.metrics.model.MetricsChart -import skills.metrics.model.Section -import skills.services.AdminUsersService - -@Component -@CompileStatic -class OverlookedSkillsChartBuilder implements MetricsChartBuilder { - - final Integer displayOrder = 4 - - @Autowired - AdminUsersService adminUsersService - - @Override - Section getSection() { - return Section.projects - } - - @Override - MetricsChart build(String projectId, Map props, boolean loadData=true) { - List dataItems = [] //(loadData ? adminUsersService.getUserCountsPerLevel(projectId) : []) as List - - MetricsChart metricsChart = new MetricsChart( - chartType: ChartType.VerticalBar, - dataItems: dataItems, - chartOptions: getChartOptions(), - ) - return metricsChart - } - - private Map getChartOptions() { - Map chartOptions = [ - (ChartOption.title) : 'Overlooked skills', - (ChartOption.subtitle) : 'Users seem to ignore these', - (ChartOption.icon) : 'fas fa-sad-tear', - (ChartOption.description): 'These skills have low to no usage at all. Explore these skills and see if they need to be improved or removed.', - (ChartOption.sort) : 'asc', - ] as Map - return chartOptions - } -} diff --git a/backend/src/main/java/skills/metrics/builders/projects/TimeToAchieveChartBuilder.groovy b/backend/src/main/java/skills/metrics/builders/projects/TimeToAchieveChartBuilder.groovy deleted file mode 100644 index 7f6d8274..00000000 --- a/backend/src/main/java/skills/metrics/builders/projects/TimeToAchieveChartBuilder.groovy +++ /dev/null @@ -1,65 +0,0 @@ -/** - * Copyright 2020 SkillTree - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * https://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package skills.metrics.builders.projects - -import groovy.transform.CompileStatic -import org.springframework.beans.factory.annotation.Autowired -import org.springframework.stereotype.Component -import skills.controller.result.model.CountItem -import skills.metrics.builders.MetricsChartBuilder -import skills.metrics.model.ChartOption -import skills.metrics.model.ChartType -import skills.metrics.model.MetricsChart -import skills.metrics.model.Section -import skills.services.AdminUsersService - -@Component -@CompileStatic -class TimeToAchieveChartBuilder implements MetricsChartBuilder { - - final Integer displayOrder = 5 - - @Autowired - AdminUsersService adminUsersService - - @Override - Section getSection() { - return Section.projects - } - - @Override - MetricsChart build(String projectId, Map props, boolean loadData=true) { - List dataItems = [] //(loadData ? adminUsersService.getUserCountsPerLevel(projectId) : []) as List - - MetricsChart metricsChart = new MetricsChart( - chartType: ChartType.VerticalBar, - dataItems: dataItems, - chartOptions: getChartOptions(), - ) - return metricsChart - } - - private Map getChartOptions() { - Map chartOptions = [ - (ChartOption.title) : 'Time to Achieve', - (ChartOption.subtitle) : 'How long did it take them?', - (ChartOption.icon) : 'fa fa-calendar-alt', - (ChartOption.description): 'Provides a breakdown of how long it takes users to achieve each level.', - (ChartOption.sort) : 'asc', - ] as Map - return chartOptions - } -} diff --git a/backend/src/main/java/skills/metrics/builders/projects/TopAchievedChartBuilder.groovy b/backend/src/main/java/skills/metrics/builders/projects/TopAchievedChartBuilder.groovy deleted file mode 100644 index cbbdb50c..00000000 --- a/backend/src/main/java/skills/metrics/builders/projects/TopAchievedChartBuilder.groovy +++ /dev/null @@ -1,65 +0,0 @@ -/** - * Copyright 2020 SkillTree - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * https://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package skills.metrics.builders.projects - -import groovy.transform.CompileStatic -import org.springframework.beans.factory.annotation.Autowired -import org.springframework.stereotype.Component -import skills.controller.result.model.CountItem -import skills.metrics.builders.MetricsChartBuilder -import skills.metrics.model.ChartOption -import skills.metrics.model.ChartType -import skills.metrics.model.MetricsChart -import skills.metrics.model.Section -import skills.services.AdminUsersService - -@Component -@CompileStatic -class TopAchievedChartBuilder implements MetricsChartBuilder { - - final Integer displayOrder = 3 - - @Autowired - AdminUsersService adminUsersService - - @Override - Section getSection() { - return Section.projects - } - - @Override - MetricsChart build(String projectId, Map props, boolean loadData=true) { - List dataItems = [] //(loadData ? adminUsersService.getUserCountsPerLevel(projectId) : []) as List - - MetricsChart metricsChart = new MetricsChart( - chartType: ChartType.VerticalBar, - dataItems: dataItems, - chartOptions: getChartOptions(), - ) - return metricsChart - } - - private Map getChartOptions() { - Map chartOptions = [ - (ChartOption.title) : 'Top Achieved', - (ChartOption.subtitle) : 'The Olympians of Skills', - (ChartOption.icon) : 'fa fa-trophy', - (ChartOption.description): 'This stat depicts most achieved skills. It will display top skills and number of users that achieved those skills.', - (ChartOption.sort) : 'asc', - ] as Map - return chartOptions - } -} diff --git a/backend/src/main/java/skills/metrics/builders/skills/DistinctUsersOverTimeChartBuilder.groovy b/backend/src/main/java/skills/metrics/builders/skills/DistinctUsersOverTimeChartBuilder.groovy deleted file mode 100644 index 9e38a026..00000000 --- a/backend/src/main/java/skills/metrics/builders/skills/DistinctUsersOverTimeChartBuilder.groovy +++ /dev/null @@ -1,66 +0,0 @@ -/** - * Copyright 2020 SkillTree - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * https://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package skills.metrics.builders.skills - -import groovy.transform.CompileStatic -import org.springframework.beans.factory.annotation.Autowired -import org.springframework.stereotype.Component -import skills.services.AdminUsersService - -@Component('skills-DistinctUsersOverTimeChartBuilder') -@CompileStatic -class DistinctUsersOverTimeChartBuilder implements skills.metrics.builders.MetricsChartBuilder { - - static final Integer NUM_DAYS_DEFAULT = 120 - - final Integer displayOrder = 0 - - @Autowired - AdminUsersService adminUsersService - - @Override - skills.metrics.model.Section getSection() { - return skills.metrics.model.Section.skills - } - - @Override - skills.metrics.model.MetricsChart build(String projectId, Map props, boolean loadData=true) { - Integer numDays = skills.metrics.ChartParams.getIntValue(props, skills.metrics.ChartParams.NUM_DAYS, NUM_DAYS_DEFAULT) - assert numDays > 1, "Property [${skills.metrics.ChartParams.NUM_DAYS}] with value [${numDays}] must be greater than 1" - - String skillId = skills.metrics.ChartParams.getValue(props, skills.metrics.ChartParams.SECTION_ID) - assert skillId, "skillId must be specified via ${skills.metrics.ChartParams.SECTION_ID} url param" - - List dataItems = (loadData ? adminUsersService.getSubjectUsage(projectId, skillId, numDays) : []) as List - - skills.metrics.model.MetricsChart metricsChart = new skills.metrics.model.MetricsChart( - chartType: skills.metrics.model.ChartType.Line, - dataItems: dataItems, - chartOptions: getChartOptions(), - ) - return metricsChart - } - - private Map getChartOptions() { - Map chartOptions = [ - (skills.metrics.model.ChartOption.title) : 'Distinct # of Users over Time', - (skills.metrics.model.ChartOption.xAxisType) : 'datetime', - (skills.metrics.model.ChartOption.yAxisLabel): 'Distinct # of Users', - (skills.metrics.model.ChartOption.dataLabel) : 'Distinct Users', - ] as Map - return chartOptions - } -} diff --git a/backend/src/main/java/skills/metrics/builders/subjects/AchievedSkillsChartBuilder.groovy b/backend/src/main/java/skills/metrics/builders/subjects/AchievedSkillsChartBuilder.groovy deleted file mode 100644 index f9b0f09e..00000000 --- a/backend/src/main/java/skills/metrics/builders/subjects/AchievedSkillsChartBuilder.groovy +++ /dev/null @@ -1,75 +0,0 @@ -/** - * Copyright 2020 SkillTree - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * https://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package skills.metrics.builders.subjects - - -import groovy.transform.CompileStatic -import org.springframework.beans.factory.annotation.Autowired -import org.springframework.data.domain.PageRequest -import org.springframework.data.domain.Sort -import org.springframework.stereotype.Component -import skills.controller.result.model.CountItem -import skills.metrics.model.ChartOption -import skills.metrics.model.ChartType -import skills.metrics.model.MetricsChart -import skills.metrics.model.Section -import skills.services.AdminUsersService - -@Component('subjects-AchievedSkillsChartBuilder') -@CompileStatic -class AchievedSkillsChartBuilder implements skills.metrics.builders.MetricsChartBuilder { - - final Integer displayOrder = 2 - - @Autowired - AdminUsersService adminUsersService - - @Override - Section getSection() { - return Section.subjects - } - - @Override - MetricsChart build(String projectId, Map props, boolean loadData=true) { - - String subjectId = skills.metrics.ChartParams.getValue(props, skills.metrics.ChartParams.SECTION_ID) - assert subjectId, "subjectId must be specified via ${skills.metrics.ChartParams.SECTION_ID} url param" - - List dataItems = (loadData ? adminUsersService.getAchievementCountsPerSkill(projectId, subjectId, 5) : []) as List - // filter empty - dataItems = dataItems.findAll({it.count > 0}) - - MetricsChart metricsChart = new MetricsChart( - chartType: ChartType.HorizontalBar, - dataItems: dataItems, - chartOptions: getChartOptions(), - ) - return metricsChart - } - - private Map getChartOptions() { - Map chartOptions = [ - (ChartOption.title) : 'Top 5 Achieved Skills', - (ChartOption.showDataLabels) : true, - (ChartOption.dataLabel) : 'Achieved Skills', - (ChartOption.distributed) : true, - (ChartOption.dataLabelPosition): 'top', - (ChartOption.sort) : 'asc', - (ChartOption.palette) : 'palette2', - ] as Map - return chartOptions - } -} diff --git a/backend/src/main/java/skills/metrics/builders/subjects/DistinctUsersOverTimeChartBuilder.groovy b/backend/src/main/java/skills/metrics/builders/subjects/DistinctUsersOverTimeChartBuilder.groovy deleted file mode 100644 index 7c20009d..00000000 --- a/backend/src/main/java/skills/metrics/builders/subjects/DistinctUsersOverTimeChartBuilder.groovy +++ /dev/null @@ -1,66 +0,0 @@ -/** - * Copyright 2020 SkillTree - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * https://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package skills.metrics.builders.subjects - -import groovy.transform.CompileStatic -import org.springframework.beans.factory.annotation.Autowired -import org.springframework.stereotype.Component -import skills.services.AdminUsersService - -@Component('subjects-DistinctUsersOverTimeChartBuilder') -@CompileStatic -class DistinctUsersOverTimeChartBuilder implements skills.metrics.builders.MetricsChartBuilder { - - static final Integer NUM_DAYS_DEFAULT = 120 - - final Integer displayOrder = 0 - - @Autowired - AdminUsersService adminUsersService - - @Override - skills.metrics.model.Section getSection() { - return skills.metrics.model.Section.subjects - } - - @Override - skills.metrics.model.MetricsChart build(String projectId, Map props, boolean loadData=true) { - Integer numDays = skills.metrics.ChartParams.getIntValue(props, skills.metrics.ChartParams.NUM_DAYS, NUM_DAYS_DEFAULT) - assert numDays > 1, "Property [${skills.metrics.ChartParams.NUM_DAYS}] with value [${numDays}] must be greater than 1" - - String subjectId = skills.metrics.ChartParams.getValue(props, skills.metrics.ChartParams.SECTION_ID) - assert subjectId, "subjectId must be specified via ${skills.metrics.ChartParams.SECTION_ID} url param" - - List dataItems = (loadData ? adminUsersService.getSubjectUsage(projectId, subjectId, numDays) : []) as List - - skills.metrics.model.MetricsChart metricsChart = new skills.metrics.model.MetricsChart( - chartType: skills.metrics.model.ChartType.Line, - dataItems: dataItems, - chartOptions: getChartOptions(), - ) - return metricsChart - } - - private Map getChartOptions() { - Map chartOptions = [ - (skills.metrics.model.ChartOption.title) : 'Distinct # of Users over Time', - (skills.metrics.model.ChartOption.xAxisType) : 'datetime', - (skills.metrics.model.ChartOption.yAxisLabel): 'Distinct # of Users', - (skills.metrics.model.ChartOption.dataLabel) : 'Distinct Users', - ] as Map - return chartOptions - } -} diff --git a/backend/src/main/java/skills/metrics/builders/subjects/NumUsersPerLevelChartBuilder.groovy b/backend/src/main/java/skills/metrics/builders/subjects/NumUsersPerLevelChartBuilder.groovy deleted file mode 100644 index 542058b3..00000000 --- a/backend/src/main/java/skills/metrics/builders/subjects/NumUsersPerLevelChartBuilder.groovy +++ /dev/null @@ -1,67 +0,0 @@ -/** - * Copyright 2020 SkillTree - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * https://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package skills.metrics.builders.subjects - -import groovy.transform.CompileStatic -import org.springframework.beans.factory.annotation.Autowired -import org.springframework.stereotype.Component -import skills.controller.result.model.CountItem -import skills.controller.result.model.LabelCountItem -import skills.metrics.model.ChartOption -import skills.metrics.model.ChartType -import skills.metrics.model.MetricsChart -import skills.metrics.model.Section -import skills.services.AdminUsersService - -@Component('subjects-NumUsersPerLevelChartBuilder') -@CompileStatic -class NumUsersPerLevelChartBuilder implements skills.metrics.builders.MetricsChartBuilder { - - final Integer displayOrder = 1 - - @Autowired - AdminUsersService adminUsersService - - @Override - Section getSection() { - return Section.subjects - } - - @Override - MetricsChart build(String projectId, Map props, boolean loadData=true) { - - String subjectId = skills.metrics.ChartParams.getValue(props, skills.metrics.ChartParams.SECTION_ID) - assert subjectId, "subjectId must be specified via ${skills.metrics.ChartParams.SECTION_ID} url param" - - List dataItems = loadData ? adminUsersService.getUserCountsPerLevel(projectId, subjectId) : [] - - MetricsChart metricsChart = new MetricsChart( - chartType: ChartType.VerticalBar, - dataItems: dataItems as List, - chartOptions: getChartOptions(), - ) - return metricsChart - } - - private Map getChartOptions() { - Map chartOptions = [ - (ChartOption.title) : 'Number Users for each Level', - (ChartOption.showDataLabels): false, -// (ChartOption.sort) : 'asc', - ] as Map - return chartOptions - } -} diff --git a/backend/src/main/java/skills/metrics/builders/users/PointHistoryChartBuilder.groovy b/backend/src/main/java/skills/metrics/builders/users/PointHistoryChartBuilder.groovy deleted file mode 100644 index 9ad5fcfc..00000000 --- a/backend/src/main/java/skills/metrics/builders/users/PointHistoryChartBuilder.groovy +++ /dev/null @@ -1,76 +0,0 @@ -/** - * Copyright 2020 SkillTree - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * https://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package skills.metrics.builders.users - -import groovy.transform.CompileStatic -import org.springframework.beans.factory.annotation.Autowired -import org.springframework.stereotype.Component -import skills.services.AdminUsersService -import skills.skillLoading.SkillsLoader - -@Component('user-PointHistoryChartBuilder') -@CompileStatic -class PointHistoryChartBuilder implements skills.metrics.builders.MetricsChartBuilder { - - static final Integer NUM_DAYS_DEFAULT = 365 - - final Integer displayOrder = 0 - - @Autowired - AdminUsersService adminUsersService - - @Autowired - SkillsLoader skillsLoader - - @Override - skills.metrics.model.Section getSection() { - return skills.metrics.model.Section.users - } - - @Override - skills.metrics.model.MetricsChart build(String projectId, Map props, boolean loadData=true) { - Integer numDays = skills.metrics.ChartParams.getIntValue(props, skills.metrics.ChartParams.NUM_DAYS, NUM_DAYS_DEFAULT) - assert numDays > 1, "Property [${skills.metrics.ChartParams.NUM_DAYS}] with value [${numDays}] must be greater than 1" - - String userId = skills.metrics.ChartParams.getValue(props, skills.metrics.ChartParams.SECTION_ID) - assert userId, "userId must be specified via ${skills.metrics.ChartParams.SECTION_ID} url param" - - List dataItems = [] - if (loadData) { - dataItems = skillsLoader.loadPointHistorySummary(projectId, userId, numDays).pointsHistory.collect { - new skills.controller.result.model.TimestampCountItem(value: it.dayPerformed.time, count: it.points) - } as List - } - - skills.metrics.model.MetricsChart metricsChart = new skills.metrics.model.MetricsChart( - chartType: skills.metrics.model.ChartType.Area, - dataItems: dataItems, - chartOptions: getChartOptions(), - ) - return metricsChart - } - - private Map getChartOptions() { - Map chartOptions = [ - (skills.metrics.model.ChartOption.title) : 'Point History', - (skills.metrics.model.ChartOption.xAxisType) : 'datetime', -// (ChartOption.yAxisLabel) : '# of Points', - (skills.metrics.model.ChartOption.dataLabel) : 'Points', - (skills.metrics.model.ChartOption.showDataLabels): false, - ] as Map - return chartOptions - } -} diff --git a/backend/src/main/java/skills/metrics/model/ChartOption.java b/backend/src/main/java/skills/metrics/model/ChartOption.java deleted file mode 100644 index d0a5e3d5..00000000 --- a/backend/src/main/java/skills/metrics/model/ChartOption.java +++ /dev/null @@ -1,38 +0,0 @@ -/** - * Copyright 2020 SkillTree - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * https://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package skills.metrics.model; - -public enum ChartOption { - chartBuilderId, - description, - title, - titleSize, // ex: 16px - titleColor, // ex: #008FFB - titlePosition, // left, center, right - subtitle, - xAxisLabel, - xAxisType, // datetime, ? - yAxisLabel, - yAxisType, // datetime, ? - distributed, // true/false - dataLabel, - showDataLabels, // true/false - dataLabelPosition, // top, center, bottom - sort, // asc, desc - palette, // ex. palette2 - icon, - labels -} diff --git a/backend/src/main/java/skills/services/events/pointsAndAchievements/PointsAndAchievementsHandler.groovy b/backend/src/main/java/skills/services/events/pointsAndAchievements/PointsAndAchievementsHandler.groovy deleted file mode 100644 index 84c0813f..00000000 --- a/backend/src/main/java/skills/services/events/pointsAndAchievements/PointsAndAchievementsHandler.groovy +++ /dev/null @@ -1,221 +0,0 @@ -/** - * Copyright 2020 SkillTree - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * https://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package skills.services.events.pointsAndAchievements - -import callStack.profiler.Profile -import groovy.transform.CompileStatic -import groovy.util.logging.Slf4j -import org.springframework.beans.factory.annotation.Autowired -import org.springframework.stereotype.Component -import skills.services.LevelDefinitionStorageService -import skills.services.events.CompletionItem -import skills.services.events.CompletionTypeUtil -import skills.services.events.SkillEventResult -import skills.storage.model.* -import skills.storage.repos.SkillEventsSupportRepo -import skills.storage.repos.SkillRelDefRepo -import skills.storage.repos.UserAchievedLevelRepo -import skills.storage.repos.UserPointsRepo - -@Component -@Slf4j -@CompileStatic -class PointsAndAchievementsHandler { - - @Autowired - UserPointsRepo userPointsRepo - - @Autowired - UserAchievedLevelRepo userAchievedLevelRepo - - @Autowired - UserAchievedLevelRepo achievedLevelRepo - - @Autowired - SkillRelDefRepo skillRelDefRepo - - @Autowired - LevelDefinitionStorageService levelDefService - - @Autowired - SkillEventsSupportRepo skillEventsSupportRepo - - @Autowired - PointsAndAchievementsSaver saver - - @Autowired - PointsAndAchievementsDataLoader dataLoader - - @Profile - List updatePointsAndAchievements(String userId, SkillEventsSupportRepo.SkillDefMin skillDef, Date incomingSkillDate){ - LoadedData loadedData = dataLoader.loadData(skillDef.projectId, userId, incomingSkillDate, skillDef) - - PointsAndAchievementsBuilder builder = new PointsAndAchievementsBuilder( - userId: userId, - projectId: skillDef.projectId, - skillId: skillDef.skillId, - skillRefId: skillDef.id, - loadedData: loadedData, - pointIncrement: skillDef.pointIncrement, - incomingSkillDate: incomingSkillDate, - levelDefService: levelDefService, - ) - PointsAndAchievementsBuilder.PointsAndAchievementsResult result = builder.build() - saver.save(result.dataToSave) - return result.completionItems - } - - - - @Profile - void checkParentGraph(Date incomingSkillDate, SkillEventResult res, String userId, SkillEventsSupportRepo.SkillDefMin skillDef, boolean decrement) { - updateByTraversingUpSkillDefs(incomingSkillDate, res, skillDef, skillDef, userId, decrement) - - // updated project level - UserPoints totalPoints = updateUserPoints(userId, skillDef, incomingSkillDate, null, decrement) - if (!decrement) { - List levelDefs = skillEventsSupportRepo.findLevelsByProjectId(skillDef.projectId) - SkillEventsSupportRepo.TinyProjectDef totalProjectPoints = skillEventsSupportRepo.getTinyProjectDef(skillDef.projectId) - LevelDefinitionStorageService.LevelInfo levelInfo = levelDefService.getLevelInfo(skillDef.projectId, levelDefs, totalProjectPoints.totalPoints, totalPoints.points) - CompletionItem completionItem = calculateLevels(levelInfo, totalPoints, null, userId, "OVERALL", decrement) - if (completionItem?.level && completionItem?.level > 0) { - res.completed.add(completionItem) - } - } - } - - /** - * @param skillId if null then will document it at overall project level - */ - UserPoints updateUserPoints(String userId, SkillEventsSupportRepo.SkillDefMin requestedSkill, Date incomingSkillDate, String skillId = null, boolean decrement) { - doUpdateUserPoints(requestedSkill, userId, incomingSkillDate, skillId, decrement) - UserPoints res = doUpdateUserPoints(requestedSkill, userId, null, skillId, decrement) - return res - } - - @Profile - private UserPoints doUpdateUserPoints(SkillEventsSupportRepo.SkillDefMin requestedSkill, String userId, Date incomingSkillDate, String skillId, boolean decrement) { - Date day = incomingSkillDate ? new Date(incomingSkillDate.time).clearTime() : null - UserPoints userPoints = getUserPoints(requestedSkill, userId, skillId, day) - if (!userPoints) { - assert !decrement - userPoints = new UserPoints(userId: userId?.toLowerCase(), projectId: requestedSkill.projectId, - skillId: skillId, - skillRefId: skillId ? requestedSkill.id : null, - points: requestedSkill.pointIncrement, day: day) - } else { - if (decrement) { - userPoints.points -= requestedSkill.pointIncrement - } else { - userPoints.points += requestedSkill.pointIncrement - } - } - - UserPoints res - if (decrement && userPoints.points <= 0) { - userPointsRepo.delete(userPoints) - res = new UserPoints(userId: userId?.toLowerCase(), projectId: requestedSkill.projectId, - skillId: skillId, - skillRefId: skillId ? requestedSkill.id : null, - points: 0, day: day) - } else { - res = saveUserPoints(userPoints) - log.debug("Updated points [{}]", res) - } - res - } - - @Profile - private UserPoints saveUserPoints(UserPoints subjectPoints) { - userPointsRepo.save(subjectPoints) - } - - @Profile - private UserPoints getUserPoints(SkillEventsSupportRepo.SkillDefMin requestedSkill, String userId, String skillId, Date day) { - userPointsRepo.findByProjectIdAndUserIdAndSkillIdAndDay(requestedSkill.projectId, userId, skillId, day) - } - - @Profile - private void updateByTraversingUpSkillDefs(Date incomingSkillDate, SkillEventResult res, - SkillEventsSupportRepo.SkillDefMin currentDef, - SkillEventsSupportRepo.SkillDefMin requesterDef, - String userId, boolean decrement) { - if (shouldEvaluateForAchievement(currentDef)) { - UserPoints updatedPoints = updateUserPoints(userId, requesterDef, incomingSkillDate, currentDef.skillId, decrement) - - List levelDefs = skillEventsSupportRepo.findLevelsBySkillId(currentDef.id) - if (!levelDefs) { - if (!decrement && updatedPoints.points >= currentDef.totalPoints) { - UserAchievement groupAchievement = new UserAchievement(userId: userId.toLowerCase(), projectId: currentDef.projectId, skillId: currentDef.skillId, skillRefId: currentDef?.id, - pointsWhenAchieved: updatedPoints.points) - achievedLevelRepo.save(groupAchievement) - - res.completed.add(new CompletionItem(type: CompletionTypeUtil.getCompletionType(currentDef.type), id: currentDef.skillId, name: currentDef.name)) - } else if (decrement && updatedPoints.points <= currentDef.totalPoints) { - // we are decrementing, there are no levels defined and points are less that total points so we need - // to delete previously added achievement if it exists - achievedLevelRepo.deleteByProjectIdAndSkillIdAndUserIdAndLevel(currentDef.projectId, currentDef.skillId, userId, null) - } - } else { - int currentScore = decrement ? updatedPoints.points + requesterDef.pointIncrement : updatedPoints.points - LevelDefinitionStorageService.LevelInfo levelInfo = levelDefService.getLevelInfo(currentDef.projectId, levelDefs, currentDef.totalPoints, currentScore) - CompletionItem completionItem = calculateLevels(levelInfo, updatedPoints, currentDef, userId, currentDef.name, decrement) - if (!decrement && completionItem?.level && completionItem?.level > 0) { - res.completed.add(completionItem) - } - } - } - - List parentsRels = skillEventsSupportRepo.findParentSkillsByChildIdAndType(currentDef.id, SkillRelDef.RelationshipType.RuleSetDefinition) - parentsRels?.each { - updateByTraversingUpSkillDefs(incomingSkillDate, res, it, requesterDef, userId, decrement) - } - } - - private boolean shouldEvaluateForAchievement(SkillEventsSupportRepo.SkillDefMin skillDef) { - skillDef.type == SkillDef.ContainerType.Subject - } - - @Profile - private CompletionItem calculateLevels(LevelDefinitionStorageService.LevelInfo levelInfo, UserPoints userPts, SkillEventsSupportRepo.SkillDefMin skillDef, String userId, String name, boolean decrement) { - CompletionItem res - - List userAchievedLevels = achievedLevelRepo.findAllByUserIdAndProjectIdAndSkillId(userId, userPts.projectId, userPts.skillId) - boolean levelAlreadyAchieved = userAchievedLevels?.find { it.level == levelInfo.level } - if (!levelAlreadyAchieved && !decrement) { - UserAchievement newLevel = new UserAchievement(userId: userId.toLowerCase(), projectId: userPts.projectId, skillId: userPts.skillId, skillRefId: skillDef?.id, - level: levelInfo.level, pointsWhenAchieved: userPts.points) - achievedLevelRepo.save(newLevel) - log.debug("Achieved new level [{}]", newLevel) - - res = new CompletionItem( - level: newLevel.level, name: name, - id: userPts.skillId ?: "OVERALL", - type: userPts.skillId ? CompletionItem.CompletionItemType.Subject : CompletionItem.CompletionItemType.Overall) - } else if (decrement) { - // we are decrementing, so we need to remove any level that is greater than the current level (there should only be one) - List levelsToRemove = userAchievedLevels?.findAll { it.level >= levelInfo.level } - if (levelsToRemove) { - assert levelsToRemove.size() == 1, "we are decrementing a single skill so we should not be remove multiple (${levelsToRemove.size()} levels)" - achievedLevelRepo.delete(levelsToRemove.first()) - } - } - - return res - } - - -} diff --git a/backend/src/test/java/skills/intTests/metrics/MetricsSpec.groovy b/backend/src/test/java/skills/intTests/metrics/MetricsSpec.groovy deleted file mode 100644 index 10e11a4b..00000000 --- a/backend/src/test/java/skills/intTests/metrics/MetricsSpec.groovy +++ /dev/null @@ -1,294 +0,0 @@ -/** - * Copyright 2020 SkillTree - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * https://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package skills.intTests.metrics - -import groovy.util.logging.Slf4j -import org.springframework.http.HttpStatus -import skills.intTests.utils.DefaultIntSpec -import skills.intTests.utils.SkillsClientException -import skills.intTests.utils.SkillsFactory -import skills.intTests.utils.TestUtils - -@Slf4j -class MetricsSpec extends DefaultIntSpec { - - TestUtils testUtils = new TestUtils() - - def badge - - static final String projId = "TestProject1" - static final String projId2 = "TestProject2" - - static final Map> sectionBuilders = [ - projects : [ - 'skills.metrics.builders.projects.AchievedSkillsChartBuilder', - 'skills.metrics.builders.projects.ContinuedUsageChartBuilder', - 'skills.metrics.builders.projects.DistinctUsersOverTimeChartBuilder', - 'skills.metrics.builders.projects.NumUsersPerBadgeChartBuilder', - 'skills.metrics.builders.projects.NumUsersPerLevelChartBuilder', - 'skills.metrics.builders.projects.OverlookedSkillsChartBuilder', - 'skills.metrics.builders.projects.TimeToAchieveChartBuilder', - 'skills.metrics.builders.projects.TopAchievedChartBuilder', - ], - subjects : [ - 'skills.metrics.builders.subjects.AchievedSkillsChartBuilder', - 'skills.metrics.builders.subjects.DistinctUsersOverTimeChartBuilder', - 'skills.metrics.builders.subjects.NumUsersPerLevelChartBuilder', - - ], - badges : [ - 'skills.metrics.builders.badges.AchievedPerMonthChartBuilder', - 'skills.metrics.builders.badges.DistinctUsersOverTimeChartBuilder', - ], - skills : [ - 'skills.metrics.builders.skills.DistinctUsersOverTimeChartBuilder', - ], - users : [ - 'skills.metrics.builders.users.PointHistoryChartBuilder', - ], - ] - - static final Map sectionIds = [ - projects : "TestProject1", - subjects : "subj1", - badges : "badge1", - skills : "s12", - users : "User0", - ] - - def setup() { - List subj1 = (1..5).collect { [projectId: projId, subjectId: "subj1", skillId: "s1${it}".toString(), name: "subj1 ${it}".toString(), type: "Skill", pointIncrement: 20, numPerformToCompletion: 1, pointIncrementInterval: 0, numMaxOccurrencesIncrementInterval: 1] } - List subj2 = (1..4).collect { [projectId: projId, subjectId: "subj2", skillId: "s2${it}".toString(), name: "subj2 ${it}".toString(), type: "Skill", pointIncrement: 5, numPerformToCompletion: 10, pointIncrementInterval: 8*60, numMaxOccurrencesIncrementInterval: 1] } - List subj3 = (1..5).collect { [projectId: projId, subjectId: "subj3", skillId: "23${it}".toString(), name: "subj3 ${it}".toString(), type: "Skill", pointIncrement: 20, numPerformToCompletion: 10, pointIncrementInterval: 8*60, numMaxOccurrencesIncrementInterval: 1] } - - - badge = [projectId: projId, badgeId: 'badge1', name: 'Test Badge 1'] - - skillsService.createSchema([subj1, subj2, subj3]) - subj1.each { - it.projectId = projId2 - } - subj2.each{ - it.projectId = projId2 - } - subj3.each{ - it.projectId = projId2 - } - skillsService.createSchema([subj1, subj2, subj3]) - - skillsService.createBadge(badge) - skillsService.assignSkillToBadge(projectId: projId, badgeId: badge.badgeId, skillId: subj1.get(1).skillId) - - List dates = testUtils.getLastNDays(5) - List addSkillRes = [] - (0..3).each { userNum -> - String userId = "User${userNum}" - (0..4).each { - addSkillRes << skillsService.addSkill([projectId: projId, skillId: subj1.get(1).skillId], userId, dates.get(it)) - if (userNum == 2) { - skillsService.addSkill([projectId: projId2, skillId: subj1.get(1).skillId], userId, dates.get(it)) - } - } - } - } - - def "load individual chart via chart builder id for each section type"() { - - when: - Map resultsForSections = [:] - sectionBuilders.each { section, builders -> - log.info("Building section ${section}...") - List results = [] - builders.each { builder -> - def chart = skillsService.getMetricsChart(projId, builder, section, sectionIds[section]) - results.add(chart) - } - resultsForSections[section] = results - } - - then: - resultsForSections - - sectionBuilders.keySet().each { section -> - List chartsForSection = resultsForSections[section] - assert chartsForSection - chartsForSection.each { chart -> - assert chart.dataLoaded == true // data is always loaded loading individual chart - } - } - } - - def "load all charts for each section type"() { - - when: - Set sections = sectionBuilders.keySet() - Map resultsForSections = [:] - sections.each { section -> - log.info("Building section ${section}...") - def charts = skillsService.getAllMetricsChartsForSection(projId, section, sectionIds[section]) - resultsForSections[section] = charts - } - - then: - resultsForSections - - sections.each { section -> - List chartsForSection = resultsForSections[section] - assert chartsForSection && chartsForSection.size() == sectionBuilders[section].size() // all charts for the section are built - chartsForSection.each { chart -> - assert chart.dataLoaded == true // data is loaded for all charts by default - } - } - } - - def "load all charts for each section type, but limit loading data to first 2 chart types"() { - - when: - Set sections = sectionBuilders.keySet() - Map props = [loadDataForFirst : '2'] - Map resultsForSections = [:] - sections.each { section -> - log.info("Building section ${section}...") - def charts = skillsService.getAllMetricsChartsForSection(projId, section, sectionIds[section], props) - resultsForSections[section] = charts - } - - then: - resultsForSections - - sections.each { section -> - List chartsForSection = resultsForSections[section] - assert chartsForSection && chartsForSection.size() == sectionBuilders[section].size() // all charts for the section are built - chartsForSection.eachWithIndex { chart, idx -> - assert chart.dataLoaded == idx < 2 // data should only be loaded for the first 2 charts - } - } - } - - def "returns error for unknown chart builder id"() { - - when: - skillsService.getMetricsChart(projId, "unknown.builder.id", "projects", projId) - - then: - SkillsClientException skillsClientException = thrown() - skillsClientException.httpStatus == HttpStatus.BAD_REQUEST - } - - def "data is always loaded when loading individual chart builder id"() { - - when: - String section = 'projects' - Map props = [loadDataForFirst : '0'] - def chart = skillsService.getMetricsChart(projId, sectionBuilders[section].first(), section, projId, props) - - then: - chart - chart.dataLoaded == true - } - - def "numDays loaded defaults to 120"() { - when: - String chartBuilderId = 'skills.metrics.builders.projects.DistinctUsersOverTimeChartBuilder' - String section = 'projects' - def chart = skillsService.getMetricsChart(projId, chartBuilderId, section, projId) - - then: - chart - chart.dataLoaded == true - chart.dataItems.size() == 120 - } - - def "limit numDays loaded"() { - when: - String chartBuilderId = 'skills.metrics.builders.projects.DistinctUsersOverTimeChartBuilder' - String section = 'projects' - Map props = [numDays : '10'] - def chart = skillsService.getMetricsChart(projId, chartBuilderId, section, projId, props) - - then: - chart - chart.dataLoaded == true - chart.dataItems.size() == 10 - } - - def "numMonths loaded defaults to 6"() { - when: - String chartBuilderId = 'skills.metrics.builders.badges.AchievedPerMonthChartBuilder' - String section = 'badges' - def chart = skillsService.getMetricsChart(projId, chartBuilderId, section, badge.badgeId) - - then: - chart - chart.dataLoaded == true - chart.dataItems.size() == 6 - } - - def "limit numMonths loaded"() { - when: - String chartBuilderId = 'skills.metrics.builders.badges.AchievedPerMonthChartBuilder' - String section = 'badges' - Map props = [numMonths : '3'] - def chart = skillsService.getMetricsChart(projId, chartBuilderId, section, badge.badgeId, props) - - then: - chart - chart.dataLoaded == true - chart.dataItems.size() == 3 - } - - def "Loads all global charts for section type"() { - when: - def charts = skillsService.getAllGlobalMetricsChartsForSection("global") - - then: - charts - charts.size() == 2 - charts[0].dataLoaded == true - charts[0].dataItems.size() == 2 - charts[0].dataItems[0].count == 4 - charts[0].dataItems[1].count == 1 - charts[1].dataLoaded == true - charts[1].dataItems.size() == 2 - charts[1].dataItems[0].count == 14 - charts[1].dataItems[1].count == 14 - } - - def "Does not load global charts if less then 2 projects"() { - - skillsService.deleteAllMyProjects() - skillsService.createProject(SkillsFactory.createProject(99)) - - when: - def charts = skillsService.getAllGlobalMetricsChartsForSection("global") - - then: - !charts - } - - def "Loads global chart for chart builder id and section"() { - when: - def chart = skillsService.getGlobalMetricsChart("skills.metrics.builders.global.SkillCountPerProjectBuilder", "global","global") - - then: - chart - chart.dataLoaded == true - chart.dataItems.size() == 2 - chart.dataItems[0].count == 14 - chart.dataItems[1].count == 14 - } - -} diff --git a/backend/src/test/java/skills/intTests/reportSkills/ReportSkills_BadgeSkillsSpecs.groovy b/backend/src/test/java/skills/intTests/reportSkills/ReportSkills_BadgeSkillsSpecs.groovy deleted file mode 100644 index 01ef467a..00000000 --- a/backend/src/test/java/skills/intTests/reportSkills/ReportSkills_BadgeSkillsSpecs.groovy +++ /dev/null @@ -1,177 +0,0 @@ -/** - * Copyright 2020 SkillTree - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * https://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package skills.intTests.reportSkills - -import skills.intTests.utils.DefaultIntSpec -import skills.intTests.utils.SkillsClientException -import skills.intTests.utils.SkillsFactory - -class ReportSkills_BadgeSkillsSpecs extends DefaultIntSpec { - - String projId = SkillsFactory.defaultProjId - - def setup(){ - skillsService.deleteProjectIfExist(projId) - } - - def "give credit if all dependencies were fulfilled"(){ - String subj = "testSubj" - - Map skill1 = [projectId: projId, subjectId: subj, skillId: "skill1", name : "Test Skill 1", type: "Skill", - pointIncrement: 25, numPerformToCompletion: 1, pointIncrementInterval: 8*60, numMaxOccurrencesIncrementInterval: 1] - Map skill2 = [projectId: projId, subjectId: subj, skillId: "skill2", name : "Test Skill 2", type: "Skill", - pointIncrement: 25, numPerformToCompletion: 1, pointIncrementInterval: 8*60, numMaxOccurrencesIncrementInterval: 1] - Map skill3 = [projectId: projId, subjectId: subj, skillId: "skill3", name : "Test Skill 3", type: "Skill", - pointIncrement: 25, numPerformToCompletion: 1, pointIncrementInterval: 8*60, numMaxOccurrencesIncrementInterval: 1] - Map skill4 = [projectId: projId, subjectId: subj, skillId: "skill4", name : "Test Skill 4", type: "Skill", - pointIncrement: 25, numPerformToCompletion: 1, pointIncrementInterval: 8*60, numMaxOccurrencesIncrementInterval: 1*60, numMaxOccurrencesIncrementInterval: 1, dependentSkillsIds: [skill1.skillId, skill2.skillId, skill3.skillId]] - - Map badge = [projectId: projId, badgeId: 'badge1', name: 'Test Badge 1'] - List requiredSkillsIds = [skill1.skillId, skill2.skillId, skill3.skillId, skill4.skillId] - - - when: - skillsService.createProject([projectId: projId, name: "Test Project"]) - skillsService.createSubject([projectId: projId, subjectId: subj, name: "Test Subject"]) - skillsService.createSkill(skill1) - skillsService.createSkill(skill2) - skillsService.createSkill(skill3) - skillsService.createSkill(skill4) - skillsService.createBadge(badge) - requiredSkillsIds.each { skillId -> - skillsService.assignSkillToBadge(projectId: projId, badgeId: badge.badgeId, skillId: skillId) - } - - def resSkill1 = skillsService.addSkill([projectId: projId, skillId: skill1.skillId]).body - def resSkill3 = skillsService.addSkill([projectId: projId, skillId: skill3.skillId]).body - def resSkill2 = skillsService.addSkill([projectId: projId, skillId: skill2.skillId]).body - def resSkill4 = skillsService.addSkill([projectId: projId, skillId: skill4.skillId]).body - - then: - resSkill1.skillApplied && !resSkill1.completed.find { it.id == 'badge1'} - resSkill2.skillApplied && !resSkill2.completed.find { it.id == 'badge1'} - resSkill3.skillApplied && !resSkill3.completed.find { it.id == 'badge1'} - resSkill4.skillApplied && resSkill4.completed.find { it.id == 'badge1'} - } - - def "give credit if all dependencies were fulfilled, but the badge/gem is active"(){ - String subj = "testSubj" - - Map skill1 = [projectId: projId, subjectId: subj, skillId: "skill1", name : "Test Skill 1", type: "Skill", - pointIncrement: 25, numPerformToCompletion: 1, pointIncrementInterval: 8*60, numMaxOccurrencesIncrementInterval: 1] - Map skill2 = [projectId: projId, subjectId: subj, skillId: "skill2", name : "Test Skill 2", type: "Skill", - pointIncrement: 25, numPerformToCompletion: 1, pointIncrementInterval: 8*60, numMaxOccurrencesIncrementInterval: 1] - Map skill3 = [projectId: projId, subjectId: subj, skillId: "skill3", name : "Test Skill 3", type: "Skill", - pointIncrement: 25, numPerformToCompletion: 1, pointIncrementInterval: 8*60, numMaxOccurrencesIncrementInterval: 1] - Map skill4 = [projectId: projId, subjectId: subj, skillId: "skill4", name : "Test Skill 4", type: "Skill", - pointIncrement: 25, numPerformToCompletion: 1, pointIncrementInterval: 8*60, numMaxOccurrencesIncrementInterval: 1, dependentSkillsIds: [skill1.skillId, skill2.skillId, skill3.skillId]] - - Date tomorrow = new Date()+1 - Date twoWeeksAgo = new Date()-14 - Map badge = [projectId: projId, badgeId: 'badge1', name: 'Test Badge 1', startDate: twoWeeksAgo, endDate: tomorrow] - List requiredSkillsIds = [skill1.skillId, skill2.skillId, skill3.skillId, skill4.skillId] - - when: - skillsService.createProject([projectId: projId, name: "Test Project"]) - skillsService.createSubject([projectId: projId, subjectId: subj, name: "Test Subject"]) - skillsService.createSkill(skill1) - skillsService.createSkill(skill2) - skillsService.createSkill(skill3) - skillsService.createSkill(skill4) - skillsService.createBadge(badge) - requiredSkillsIds.each { skillId -> - skillsService.assignSkillToBadge(projectId: projId, badgeId: badge.badgeId, skillId: skillId) - } - - - def resSkill1 = skillsService.addSkill([projectId: projId, skillId: skill1.skillId]).body - def resSkill3 = skillsService.addSkill([projectId: projId, skillId: skill3.skillId]).body - def resSkill2 = skillsService.addSkill([projectId: projId, skillId: skill2.skillId]).body - def resSkill4 = skillsService.addSkill([projectId: projId, skillId: skill4.skillId]).body - - then: - resSkill1.skillApplied && !resSkill1.completed.find { it.id == 'badge1'} - resSkill2.skillApplied && !resSkill2.completed.find { it.id == 'badge1'} - resSkill3.skillApplied && !resSkill3.completed.find { it.id == 'badge1'} - resSkill4.skillApplied && resSkill4.completed.find { it.id == 'badge1'} - } - - def "do not give credit if all dependencies were fulfilled, but the badge/gem is not active"(){ - String subj = "testSubj" - - Map skill1 = [projectId: projId, subjectId: subj, skillId: "skill1", name : "Test Skill 1", type: "Skill", - pointIncrement: 25, numPerformToCompletion: 1, pointIncrementInterval: 8*60, numMaxOccurrencesIncrementInterval: 1] - Map skill2 = [projectId: projId, subjectId: subj, skillId: "skill2", name : "Test Skill 2", type: "Skill", - pointIncrement: 25, numPerformToCompletion: 1, pointIncrementInterval: 8*60, numMaxOccurrencesIncrementInterval: 1] - Map skill3 = [projectId: projId, subjectId: subj, skillId: "skill3", name : "Test Skill 3", type: "Skill", - pointIncrement: 25, numPerformToCompletion: 1, pointIncrementInterval: 8*60, numMaxOccurrencesIncrementInterval: 1] - Map skill4 = [projectId: projId, subjectId: subj, skillId: "skill4", name : "Test Skill 4", type: "Skill", - pointIncrement: 25, numPerformToCompletion: 1, pointIncrementInterval: 8*60, numMaxOccurrencesIncrementInterval: 1, dependentSkillsIds: [skill1.skillId, skill2.skillId, skill3.skillId]] - - Date oneWeekAgo = new Date()-7 - Date twoWeeksAgo = new Date()-14 - Map badge = [projectId: projId, badgeId: 'badge1', name: 'Test Badge 1', startDate: twoWeeksAgo, endDate: oneWeekAgo] - - when: - skillsService.createProject([projectId: projId, name: "Test Project"]) - skillsService.createSubject([projectId: projId, subjectId: subj, name: "Test Subject"]) - skillsService.createSkill(skill1) - skillsService.createSkill(skill2) - skillsService.createSkill(skill3) - skillsService.createSkill(skill4) - skillsService.createBadge(badge) - - def resSkill1 = skillsService.addSkill([projectId: projId, skillId: skill1.skillId]).body - def resSkill3 = skillsService.addSkill([projectId: projId, skillId: skill3.skillId]).body - def resSkill2 = skillsService.addSkill([projectId: projId, skillId: skill2.skillId]).body - def resSkill4 = skillsService.addSkill([projectId: projId, skillId: skill4.skillId]).body - - List requiredSkillsIds = [skill1.skillId, skill2.skillId, skill3.skillId, skill4.skillId] - requiredSkillsIds.each { String skillId -> - skillsService.assignSkillToBadge(projectId: projId, badgeId: badge.badgeId, skillId: skillId) - } - - then: - resSkill1.skillApplied && !resSkill1.completed.find { it.id == 'badge1'} - resSkill2.skillApplied && !resSkill2.completed.find { it.id == 'badge1'} - resSkill3.skillApplied && !resSkill3.completed.find { it.id == 'badge1'} - resSkill4.skillApplied && !resSkill4.completed.find { it.id == 'badge1'} - } - - def 'validate that if one gem date is provided both dates need to be provided - start provided'() { - when: - skillsService.createProject([projectId: projId, name: "Test Project"]) - Map badge = [projectId: projId, badgeId: 'badge1', name: 'Test Badge 1', startDate: new Date()] - skillsService.createBadge(badge) - - then: - SkillsClientException e = thrown() - e.message.contains("explanation:If one date is provided then both start and end dates must be provided") - e.message.contains("errorCode:BadParam") - } - - def 'validate that if one gem date is provided both dates need to be provided - end provided'() { - when: - skillsService.createProject([projectId: projId, name: "Test Project"]) - Map badge = [projectId: projId, badgeId: 'badge1', name: 'Test Badge 1', startDate: new Date()] - skillsService.createBadge(badge) - - then: - SkillsClientException e = thrown() - e.message.contains("explanation:If one date is provided then both start and end dates must be provided") - e.message.contains("errorCode:BadParam") - } -} diff --git a/backend/src/test/java/skills/intTests/reportSkills/ReportSkills_GlobalBadgeSkillsSpecs.groovy b/backend/src/test/java/skills/intTests/reportSkills/ReportSkills_GlobalBadgeSkillsSpecs.groovy deleted file mode 100644 index f0a1f458..00000000 --- a/backend/src/test/java/skills/intTests/reportSkills/ReportSkills_GlobalBadgeSkillsSpecs.groovy +++ /dev/null @@ -1,94 +0,0 @@ -/** - * Copyright 2020 SkillTree - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * https://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package skills.intTests.reportSkills - -import org.joda.time.DateTime -import skills.intTests.utils.DefaultIntSpec -import skills.intTests.utils.SkillsFactory -import skills.intTests.utils.SkillsService - -class ReportSkills_GlobalBadgeSkillsSpecs extends DefaultIntSpec { - - String projId = SkillsFactory.defaultProjId - String badgeId = 'GlobalBadge1' - - String ultimateRoot = 'jh@dojo.com' - SkillsService rootSkillsService - String nonRootUserId = 'foo@bar.com' - SkillsService nonSupervisorSkillsService - - def setup(){ - skillsService.deleteProjectIfExist(projId) - rootSkillsService = createService(ultimateRoot, 'aaaaaaaa') - nonSupervisorSkillsService = createService(nonRootUserId) - - if (!rootSkillsService.isRoot()) { - rootSkillsService.grantRoot() - } - rootSkillsService.grantSupervisorRole(skillsService.wsHelper.username) - } - - def cleanup() { - rootSkillsService?.removeSupervisorRole(skillsService.wsHelper.username) - } - - def "give credit if all dependencies were fulfilled"(){ - String subj = "testSubj" - - Map skill1 = [projectId: projId, subjectId: subj, skillId: "skill1", name : "Test Skill 1", type: "Skill", - pointIncrement: 25, numPerformToCompletion: 1, pointIncrementInterval: 8*60, numMaxOccurrencesIncrementInterval: 1] - Map skill2 = [projectId: projId, subjectId: subj, skillId: "skill2", name : "Test Skill 2", type: "Skill", - pointIncrement: 25, numPerformToCompletion: 1, pointIncrementInterval: 8*60, numMaxOccurrencesIncrementInterval: 1] - Map skill3 = [projectId: projId, subjectId: subj, skillId: "skill3", name : "Test Skill 3", type: "Skill", - pointIncrement: 25, numPerformToCompletion: 1, pointIncrementInterval: 8*60, numMaxOccurrencesIncrementInterval: 1] - Map skill4 = [projectId: projId, subjectId: subj, skillId: "skill4", name : "Test Skill 4", type: "Skill", - pointIncrement: 25, numPerformToCompletion: 1, pointIncrementInterval: 8*60, numMaxOccurrencesIncrementInterval: 1*60, numMaxOccurrencesIncrementInterval: 1, dependentSkillsIds: [skill1.skillId, skill2.skillId, skill3.skillId]] - - Map badge = [badgeId: badgeId, name: 'Test Global Badge 1'] - List requiredSkillsIds = [skill1.skillId, skill2.skillId, skill3.skillId, skill4.skillId] - - when: - skillsService.createProject([projectId: projId, name: "Test Project"]) - skillsService.createSubject([projectId: projId, subjectId: subj, name: "Test Subject"]) - skillsService.createSkill(skill1) - skillsService.createSkill(skill2) - skillsService.createSkill(skill3) - skillsService.createSkill(skill4) - skillsService.createGlobalBadge(badge) - skillsService.assignProjectLevelToGlobalBadge(projectId: projId, badgeId: badge.badgeId, level: "3") - requiredSkillsIds.each { skillId -> - skillsService.assignSkillToGlobalBadge(projectId: projId, badgeId: badge.badgeId, skillId: skillId) - } - - DateTime dt = new DateTime().minusDays(4) - - def resSkill1 = skillsService.addSkill([projectId: projId, skillId: skill1.skillId], "user1", dt.toDate()).body - def resSkill3 = skillsService.addSkill([projectId: projId, skillId: skill3.skillId], "user1", dt.plusDays(1).toDate()).body - def resSkill2 = skillsService.addSkill([projectId: projId, skillId: skill2.skillId], "user1", dt.plusDays(2).toDate()).body - def resSkill4 = skillsService.addSkill([projectId: projId, skillId: skill4.skillId], "user1", dt.plusDays(3).toDate()).body - - then: - resSkill1.skillApplied && !resSkill1.completed.find { it.id == badgeId} - resSkill2.skillApplied && !resSkill2.completed.find { it.id == badgeId} - resSkill3.skillApplied && !resSkill3.completed.find { it.id == badgeId} - resSkill4.skillApplied && resSkill4.completed.find { it.id == badgeId} - - cleanup: - skillsService.deleteGlobalBadge(badgeId) - } - - -} diff --git a/call-stack-profiler/LICENSE.txt b/call-stack-profiler/LICENSE.txt new file mode 100644 index 00000000..d6456956 --- /dev/null +++ b/call-stack-profiler/LICENSE.txt @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/call-stack-profiler/README.md b/call-stack-profiler/README.md new file mode 100644 index 00000000..52a7b076 --- /dev/null +++ b/call-stack-profiler/README.md @@ -0,0 +1,371 @@ +# Call Stack Profiler for Groovy + +> Profile your code with negligible performance and memory overhead. + +This profiler keeps track of the method calls and outputs method call hierarchy, allowing developers +to quickly comprehend execution time breakdown. +- The profiler is **fast** and is appropriate to have track and output enabled in a production system +- Use ``@Profile`` to easily annotate Groovy methods OR wrap logic in a closure OR manually start/stop events +- Naturally fits into a service based architecture +- Provides support for delegating concurrent tasks to a Thread Pool + +Consider the following class where methods are annotated with the ``@Profile`` annotation: +```groovy +class Example { + @Profile + void m1() { + m2() + } + + @Profile + void m2() { + 5.times { + m3() + } + } + + @Profile + void m3() { + Thread.sleep(100) + } +} +``` + +and then + +```groovy +static void main(String[] args) { + new Example().m1() + println CProf.prettyPrint() +} +``` + +then the output is: +``` +|-> Example.m1 (1) : 501ms [000ms] +| |-> Example.m2 (1) : 501ms [000ms] +| | |-> Example.m3 (5) : 501ms +``` + +The output provides method call hierarchy as well as the following information: +- Total method execution time: number in ms, seconds and/or minutes +- ``(N)``: number of times method was called, m2() was called once and m3() called 5 times +- ``[N ms]``: execution time which was not accounted for by child methods/logic; this happens when either not all of the child methods/logic is profiled OR there is a GC or JVM overhead + +## Features + +### Custom Profile Name + +When using the ``@Profile`` annotation, by default, profile names are derived from the method name and its parameters. +You can supply a custom name by setting the ``name`` attribute on the ``@Profile`` annotation: + +```groovy +class Example { + @Profile(name = 'veryCustomName') + void m1() { + m2() + } + + @Profile + void m2() { + Thread.sleep(20) + } +} +``` + +Then the output is: + +``` +|-> veryCustomName (1) : 020ms [000ms] +| |-> Example.m2 (1) : 020ms +``` + +### Closure based Profiling + +You can easily profile (and name) any bit of code by wrapping it in a closure: + +```groovy +class Example { + @Profile + void m1() { + m2() + CProf.prof("Another Long Action") { + // great logic + Thread.sleep(1000) + } + } + + @Profile + void m2() { + Thread.sleep(20) + } +} +``` + +Then the output is: +``` +|-> Example.m1 (1) : 1s 020ms [000ms] +| |-> Example.m2 (1) : 020ms +| |-> Another Long Action (1) : 1s +``` + +### Manually start/stop events + +Start and stop profiling events can be managed manually: + +```groovy +class Example { + @Profile + void m1() { + m2() + String name = "Another Long Action" + CProf.start(name) + try { + // great logic + Thread.sleep(1000) + } finally { + CProf.stop(name) + } + } + + @Profile + void m2() { + Thread.sleep(20) + } +} +``` + +Then the output is: +``` +|-> Example.m1 (1) : 1s 020ms [000ms] +| |-> Example.m2 (1) : 020ms +| |-> Another Long Action (1) : 1s +``` + +If you select to manually manage start/stop events then please: +- always wrap logic in a ``try/catch`` block to ensure the event is closed +- verify that the same name is used to start and end the event + +### Delegate concurrent tasks to a Thread Pool + +Call Stack Profiler supplies a thread pool implementation ``ProfThreadPool`` +which makes it seamless to execute and profile concurrent tasks. + +Below is an example of executing methods ``m1()`` and ``(m2)`` concurrently: + +```groovy +class Example { + @Profile + void runConcurrent() { + ProfThreadPool threadPool = new ProfThreadPool("Threads", 2, 2) + threadPool.warnIfFull = false + List> callables = [ + ThreadPoolUtils.callable { + m1() + }, + ThreadPoolUtils.callable { + m2() + }, + ] + List res = threadPool.asyncExec(callables) + println "Result: ${res}" + } + + @Profile + int m1() { + 5.times { m2() } + return 10 + } + + @Profile() + int m2() { + Thread.sleep(20) + return 5 + } +} +``` + +Then the output is: +``` +Result: [10, 5] +|-> Example.runConcurrent (1) : 104ms [003ms] +| ||-> Example.m1-Threads-1 (1) : 101ms [000ms] +| || |-> Example.m2 (5) : 101ms +| ||-> Example.m2-Threads-2 (1) : 020ms +``` + +``||`` depicts that the code is being executed concurrently + +### Each Call as its own event + +If you are calling a method within a loop AND the loop has a reasonable (for display purposes) number of elements, +then you may want to opt for displaying each method call as its own profiling event. + +Set attribute ``aggregateIntoSingleEvent = false`` for the ``@Profile`` annotation, for example: + +```groovy +class Example { + @Profile + void m1() { + 5.times { + m2() + } + } + + @Profile(aggregateIntoSingleEvent = false) + void m2() { + Thread.sleep(20) + } +} +``` + +Then the output is: +``` +|-> Example.m1 (1) : 102ms [000ms] +| |-> Example.m20_24 (1) : 021ms +| |-> Example.m20_23 (1) : 020ms +| |-> Example.m20_22 (1) : 020ms +| |-> Example.m20_21 (1) : 021ms +| |-> Example.m20_20 (1) : 020ms +``` + +### Exceptions + +Exceptions are propagated as expected. For example: + +```groovy +class Example { + @Profile + int m1() { + 5.times { m2() } + return 10 + } + + @Profile() + int m2() { + throw new RuntimeException("It's fun to fail!") + } +} +``` + +Then the output is: +``` +Exception in thread "main" java.lang.RuntimeException: It's fun to fail! + at callStack.profiler.examples.Example.m2(Example.groovy:15) +... +... +``` + +### Entry method + +At runtime, profiling starts when the very first profiling artifact is encountered, which can be one of these: +- ``@Profile`` annotation +- ``Cprof.prof`` method +- ``CProf.start`` method + +If the same entry point is encountered again then the profiling restarts/resets (there can only be one entry point). +Please consider: + +```groovy +class Example { + @Profile + int entryPoint() { + 5.times { m2() } + return 10 + } + + @Profile() + int m2() { + Thread.sleep(200) + return 5 + } +} +``` +and then: +```groovy +class ForDocs { + static void main(String[] args) { + 5.times { + new Example().entryPoint() + } + println CProf.prettyPrint() + } +} +``` + +The output is then: +``` +|-> Example.entryPoint (1) : 1s 001ms [000ms] +| |-> Example.m2 (5) : 1s 001ms +``` + +``entryPoint()`` is the first time a profiling event is discovered, so each time the profiler encounters the entry point method it resets its profiling stack. +Let's move ``CProf.prettyPrint()`` into the loop: +```groovy +class ForDocs { + static void main(String[] args) { + 5.times { + new Example().entryPoint() + println CProf.prettyPrint() + } + } +} +``` +Now the output is: +``` +|-> Example.entryPoint (1) : 1s 011ms [001ms] +| |-> Example.m2 (5) : 1s 010ms +|-> Example.entryPoint (1) : 1s 001ms [000ms] +| |-> Example.m2 (5) : 1s 001ms +|-> Example.entryPoint (1) : 1s 001ms [000ms] +| |-> Example.m2 (5) : 1s 001ms +|-> Example.entryPoint (1) : 1s 003ms [001ms] +| |-> Example.m2 (5) : 1s 002ms +|-> Example.entryPoint (1) : 1s 001ms [000ms] +| |-> Example.m2 (5) : 1s 001ms +``` + +### Access Profile Stack Programmatically + +Instead of using ``CProf.prettyPrint()`` you can get a hold of the entry event programmatically via ``CProf.rootEvent`` and then store the results anywhere you want. +For example: +```groovy +ProfileEvent entryEvent = CProf.rootEvent +// grab child events +entryEvent.children.each { + // use these accessors + it.getName() + it.getNumOfInvocations() + it.getRuntimeInMillis() + it.isConcurrent() + it.isRemote() +} +``` + +## How does it work? + +Call Stack profiler utilizes Groovy's (Abstract Syntax Tree) AST Transformation to inject profiling code into the annotated methods. +Profiling code is injected during the compilation phase so there is no introspection at runtime which accounts for the minimal overhead. + +For example take the following code: + +```groovy + @Profile() + int m2() { + return 5 + } +``` + +will be compiled into something like this: + +```groovy + int m2() { + String profName = "m2" + CProf.start(profName) + try { + return 5 + } finally { + CProf.stop(profName) + } + } +``` diff --git a/call-stack-profiler/pom.xml b/call-stack-profiler/pom.xml new file mode 100644 index 00000000..8cbd59b6 --- /dev/null +++ b/call-stack-profiler/pom.xml @@ -0,0 +1,314 @@ + + + 4.0.0 + + + skills-service-parent + skill-tree + 1.3.0-SNAPSHOT + + + call-stack-profiler + + + + Apache License, Version 2.0 + https://www.apache.org/licenses/LICENSE-2.0.txt + repo + + + + + 3.0.5 + 2.0-M3-groovy-3.0 + + 3.6.0-03 + + 3.0.5-01 + + 3.8.1 + 3.11 + 2.10.6 + 2.13.3 + + 2.7 + 1.11.2 + + + + + org.codehaus.groovy + groovy-all + ${groovy.version} + provided + pom + + + org.codehaus.groovy + groovy-testng + + + + + + org.apache.commons + commons-lang3 + ${commons.lang3.version} + + + joda-time + joda-time + ${joda.time.version} + + + + org.apache.logging.log4j + log4j-bom + ${log4j.version} + pom + import + + + org.apache.logging.log4j + log4j-slf4j-impl + ${log4j.version} + + + + org.spockframework + spock-core + ${spock.myVersion} + test + + + + org.codehaus.groovy + groovy + ${groovy.version} + provided + + + + + + + + + + org.apache.maven.plugins + maven-deploy-plugin + 2.8.2 + + + + + + + + maven-compiler-plugin + ${maven.compiler.plugin.version} + + 11 + 11 + groovy-eclipse-compiler + + + config.groovy + + + + + org.codehaus.groovy + groovy-eclipse-compiler + ${groovy.eclipse.compiler.version} + + + org.codehaus.groovy + groovy-eclipse-batch + ${groovy.eclipse.batch.version} + + + org.codehaus.groovy + groovy-all + ${groovy.version} + pom + + + org.codehaus.groovy + groovy-testng + + + + + + + + org.codehaus.mojo + versions-maven-plugin + ${versions.maven.plugin} + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + org.apache.maven.plugins + maven-surefire-plugin + 3.0.0-M3 + + + **/*Spec*.java + **/*Test.java + **/*Tests.java + **/*Spec*.groovy + **/*Test.groovy + **/*Tests.groovy + + + + + + org.apache.maven.plugins + maven-deploy-plugin + + + + + org.codehaus.mojo + license-maven-plugin + 2.0.0 + + + default-cli + package + + add-third-party + + + + true + + + true + test,provided + + + true + true + + The Apache Software License, Version 2.0 + MIT License + Eclipse Public License - Version 1.0 + Eclipse Public License - Version 2.0 + The 3-Clause BSD License + + + The Apache Software License, Version 2.0|Apache License, Version 2.0|The Apache License, Version 2.0 + Eclipse Public License - Version 1.0|Eclipse Public License 1.0 + Eclipse Public License - Version 2.0|Eclipse Public License v2.0 + The 3-Clause BSD License|New BSD License|BSD Licence 3|BSD License 3 + + + + + + + + + com.mycila + license-maven-plugin + 3.0 + +
${basedir}/src/license/LICENSE-HEADER.txt
+ + **/*.xml + **/*.jks + **/*.ftl + src/main/resources/public/** + **/license/*.properties + LICENSE.txt + + + + + package + + check + + + + + + + + + + src/main/resources + true + + + + + + + + + nexus-releases + Release Repository + + ${nexusServer}/repository/maven-releases/ + + + + nexus-snapshots + Snapshot Repository + + ${nexusServer}/repository/maven-snapshots/ + + + + + diff --git a/call-stack-profiler/src/license/LICENSE-HEADER.txt b/call-stack-profiler/src/license/LICENSE-HEADER.txt new file mode 100644 index 00000000..641df477 --- /dev/null +++ b/call-stack-profiler/src/license/LICENSE-HEADER.txt @@ -0,0 +1,13 @@ +Copyright 2020 SkillTree + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + https://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. diff --git a/call-stack-profiler/src/main/java/callStack/profiler/AsyncProcess.groovy b/call-stack-profiler/src/main/java/callStack/profiler/AsyncProcess.groovy new file mode 100644 index 00000000..80b84975 --- /dev/null +++ b/call-stack-profiler/src/main/java/callStack/profiler/AsyncProcess.groovy @@ -0,0 +1,75 @@ +/** + * Copyright 2020 SkillTree + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package callStack.profiler + +import groovy.util.logging.Slf4j +import java.util.concurrent.ArrayBlockingQueue +import java.util.concurrent.BlockingQueue +import java.util.concurrent.TimeUnit +import java.util.concurrent.atomic.AtomicBoolean + +@Slf4j +class AsyncProcess { + + int secondsToPoll = 2 + int queueSize = 1000 + boolean dropIfFull = false + + BlockingQueue toProcess + Thread thread + AtomicBoolean stopped = new AtomicBoolean(false) + + AsyncProcess start(){ + assert !toProcess, "already started" + + toProcess = new ArrayBlockingQueue(queueSize) + log.info("Starting with queue size of [{}]", queueSize) + thread = Thread.start("${this.class.simpleName}(${this.hashCode()})") { + while(!stopped.get()){ + Closure closure = toProcess.poll(secondsToPoll, TimeUnit.SECONDS) + try { + if (closure != null) { + closure.call() + } + } catch (Throwable t){ + log.error("Failed to process async task", t) + } + } + } + return this + } + + boolean async(Closure executeMe ){ + assert toProcess != null + boolean res = true + if(dropIfFull){ + res = toProcess.offer(executeMe) + if(!res){ + log.warn("Async queue is full!!!! \n" + + " Investigate why internal thread isn't servicing requests in a timely manner.\n" + + " Dropping incoming request for class [{}]", executeMe.class) + } + } else { + toProcess.add(executeMe) + } + + return res + } + + void stop() { + stopped.set(true) + } +} diff --git a/call-stack-profiler/src/main/java/callStack/profiler/CProf.java b/call-stack-profiler/src/main/java/callStack/profiler/CProf.java new file mode 100644 index 00000000..0e061de8 --- /dev/null +++ b/call-stack-profiler/src/main/java/callStack/profiler/CProf.java @@ -0,0 +1,194 @@ +/** + * Copyright 2020 SkillTree + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package callStack.profiler; + +import groovy.lang.Closure; +import groovy.transform.CompileStatic; + +import java.util.ArrayDeque; +import java.util.Deque; +import java.util.concurrent.atomic.AtomicBoolean; +import java.util.concurrent.atomic.AtomicLong; + +import static org.apache.commons.lang3.Validate.notNull; + +@CompileStatic +public class CProf { + public static final AtomicBoolean turnTreeProfilingOff = new AtomicBoolean(false); + + final static ThreadLocal> profileEventStack = new ThreadLocal>(); + final static ThreadLocal rootEventThreadLocal = new ThreadLocal(); + final static AtomicLong counter = new AtomicLong(0); + final static ProfileEvent EMPTY = new ProfileEvent(); + static { + EMPTY.setName("treeProfilingDisabled"); + } + + public static void clear(){ + rootEventThreadLocal.set(null); + profileEventStack.set(null); + counter.set(0); + } + + public static void start(String name) { + notNull(name); + + Deque stack = profileEventStack.get(); + if (stack == null) { + stack = new ArrayDeque(); + profileEventStack.set(stack); + } + + ProfileEvent event = null; + ProfileEvent parent = getParent(); + if (parent != null && turnTreeProfilingOff.get()) { + //if tree profiling is disabled, don't start any new ProfileEvents if there + //is already a parent/root event + return; + }else if (parent != null) { + event = parent.getEvent(name); + } + + if (event == null) { + event = new ProfileEvent(); + event.setName(name); + if (parent != null) { + parent.addChild(event); + } + } + + // if stack is empty then consider this to be an entry point + if (stack.isEmpty()) { + rootEventThreadLocal.set(event); + } + stack.push(event); + event.startEvent(); + } + + public static ProfileEvent getParent() { + ProfileEvent parent = null; + Deque stack = profileEventStack.get(); + if (stack != null) { + parent = stack.peek(); + } + return parent; + } + + public static ProfileEvent stop(String name) { + return stop(name, true); + } + + public static ProfileEvent stop(String name, boolean aggregate) { + notNull(name); + ProfileEvent rootEvent = getRootEvent(); + boolean stoppingRoot = rootEvent != null && rootEvent.getName().equals(name); + if(turnTreeProfilingOff.get() && !stoppingRoot){ + //if tree profiling is turned off and the call isn't to stop the rootEvent, return null + + //if disable gets set in between a start and stop call + //we'll end up with invalid elements in the event stack, we need to clear those out + Deque stack = profileEventStack.get(); + while (stack.size() > 1) { + //remove any ProfilingEvents that were started in between tree profiling being disabled and enabled + ProfileEvent pe = stack.pop(); + } + return EMPTY; + } + Deque stack = profileEventStack.get(); + + if(!stoppingRoot && stack.size() == 1){ + //tree profiling must have been re-enabled in between start and stop call + //we can't stop this event as it was never started, return EMPTY results rather than throwing an exception. + return EMPTY; + } + + if (stack == null) { + notNull(stack, "Must call start prior calling stop. Name [" + name + "]"); + } + ProfileEvent event = stack.pop(); + notNull(event, "Must call start prior calling stop. Name=$name"); + if(!event.getName().equals(name)){ + throw new IllegalArgumentException("Current event's name=["+event.getName()+"] but stop name=["+name+"]"); + } + event.endEvent(); + if (!aggregate) { + String previousName = event.getName(); + event.setName(event.getName() + "_" + counter.getAndIncrement()); + if (event.getParent()!=null) { + event.getParent().replaceChild(previousName, event); + } + } + return event; + } + + public static ProfileEvent prof(String name, Closure profileMe){ + return prof(name, true, profileMe); + } + + public static ProfileEvent prof(String name, boolean aggregate, Closure profileMe) { + if (!aggregate) { + name = name + "_" + counter.getAndIncrement(); + } + + ProfileEvent res = null; + start(name); + boolean hadExcetpion = false; + try { + profileMe.call(); + } catch (Throwable t){ + hadExcetpion = true; + throw t; + } finally { + try { + res = stop(name); + } catch (Throwable stopT){ + + // the stack is officially broken since we couldn't stop a profiling event + // the only thing to do is clear the stack so next profiling session is correct + clear(); + + // if stop method itself throws an exception it will hide the original exception + if(!hadExcetpion) { + throw stopT; + } + } + } + return res; + } + + public static String prettyPrint() { + ProfileEvent profileEvent = getRootEvent(); + if(profileEvent!= null){ + return profileEvent.prettyPrint(); + } + return "No profiling events"; + } + + public static ProfileEvent getRootEvent() { + return rootEventThreadLocal.get(); + } + + public static void initRootEvent(ProfileEvent rootEvent) { + ProfileEvent existing = getRootEvent(); + if(existing != null ){ + throw new IllegalArgumentException("Root event is already set. Event name is [" + existing.getName() + "]" ); + } + rootEventThreadLocal.set(rootEvent); + ArrayDeque stack = new ArrayDeque(); + stack.push(rootEvent); + profileEventStack.set(stack); + } +} \ No newline at end of file diff --git a/backend/src/main/java/skills/metrics/model/ChartType.java b/call-stack-profiler/src/main/java/callStack/profiler/ProfAsyncResult.groovy similarity index 85% rename from backend/src/main/java/skills/metrics/model/ChartType.java rename to call-stack-profiler/src/main/java/callStack/profiler/ProfAsyncResult.groovy index c3fc24b2..30725190 100644 --- a/backend/src/main/java/skills/metrics/model/ChartType.java +++ b/call-stack-profiler/src/main/java/callStack/profiler/ProfAsyncResult.groovy @@ -13,8 +13,9 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -package skills.metrics.model; +package callStack.profiler -public enum ChartType { - Line, Area, HorizontalBar, VerticalBar, Pie +class ProfAsyncResult { + T res + ProfileEvent profileEvent } diff --git a/call-stack-profiler/src/main/java/callStack/profiler/ProfFuture.groovy b/call-stack-profiler/src/main/java/callStack/profiler/ProfFuture.groovy new file mode 100644 index 00000000..0e4f5381 --- /dev/null +++ b/call-stack-profiler/src/main/java/callStack/profiler/ProfFuture.groovy @@ -0,0 +1,65 @@ +/** + * Copyright 2020 SkillTree + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package callStack.profiler + +import groovy.transform.CompileStatic + +import java.util.concurrent.ExecutionException +import java.util.concurrent.Future +import java.util.concurrent.TimeUnit +import java.util.concurrent.TimeoutException + +@CompileStatic +class ProfFuture implements Future { + + Future> underlyingFuture + + @Override + boolean cancel(boolean mayInterruptIfRunning) { + return underlyingFuture.cancel(mayInterruptIfRunning) + } + + @Override + boolean isCancelled() { + return underlyingFuture.cancelled + } + + @Override + boolean isDone() { + return underlyingFuture.done + } + + @Override + T get() throws InterruptedException, ExecutionException { + ProfAsyncResult profAsyncResult = underlyingFuture.get() + documentProfiling(profAsyncResult) + return profAsyncResult.res + } + + @Override + T get(long timeout, TimeUnit unit) throws InterruptedException, ExecutionException, TimeoutException { + ProfAsyncResult profAsyncResult = underlyingFuture.get(timeout,unit) + documentProfiling(profAsyncResult) + return profAsyncResult.res + } + + private void documentProfiling(ProfAsyncResult profAsyncResult) { + profAsyncResult.profileEvent.concurrent = true + if (CProf?.parent) { + CProf?.parent.addChild(profAsyncResult.profileEvent) + } + } +} diff --git a/call-stack-profiler/src/main/java/callStack/profiler/ProfThreadPool.groovy b/call-stack-profiler/src/main/java/callStack/profiler/ProfThreadPool.groovy new file mode 100644 index 00000000..7179370e --- /dev/null +++ b/call-stack-profiler/src/main/java/callStack/profiler/ProfThreadPool.groovy @@ -0,0 +1,127 @@ +/** + * Copyright 2020 SkillTree + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package callStack.profiler + +import callStack.utils.CachedThreadPool +import groovy.transform.CompileStatic +import groovy.util.logging.Slf4j + +import java.util.concurrent.Callable +import java.util.concurrent.Future + +@Slf4j +@CompileStatic +class ProfThreadPool { + + CachedThreadPool cachedThreadPool + boolean assignUniqueNameToEachRootEvent = false + final String poolName + boolean warnIfFull = true + + public ProfThreadPool(String name) { + cachedThreadPool = new CachedThreadPool(name) + this.poolName = name + } + + public ProfThreadPool(final String name, int numThreads) { + this(name, numThreads, numThreads) + } + + public ProfThreadPool(final String name, int minNumOfThreads, int maxNumOfThreads) { + cachedThreadPool = new CachedThreadPool(name, minNumOfThreads, maxNumOfThreads) + this.poolName = name + } + + static class ProfCallable implements Callable { + Callable callable + boolean uniqueName = false + + @Override + ProfAsyncResult call() throws Exception { + CProf.clear() + final String threadName = Thread.currentThread().name + String rootEventName = threadName + if (uniqueName) { + rootEventName = "${rootEventName}-${UUID.randomUUID().toString()}" + } + Object o + ProfileEvent rootEvent = CProf.prof(rootEventName) { + o = callable.call() + } + + // use the interinal impl root event if there is one defined + if (rootEvent && rootEvent?.children.size() == 1) { + rootEvent = rootEvent.children.first() + rootEvent.name = rootEvent.name + "-" + threadName + } + return new ProfAsyncResult(res: o, profileEvent: rootEvent) + } + } + + public List asyncExec(List> listToSubmit) { + assert listToSubmit + + warnIfFull(listToSubmit.size()) + List> profCallables = [] + listToSubmit.each { + profCallables.add((Callable) new ProfCallable(callable: it, uniqueName: assignUniqueNameToEachRootEvent)) + } + + List profAsyncResults = (List) cachedThreadPool.submitAndGetResults(profCallables) + List res = [] + profAsyncResults.each { + res.add((T) it.res) + it.profileEvent.concurrent = true + if (CProf?.parent) { + CProf?.parent.addChild(it.profileEvent) + } + } + + return res + } + + private void warnIfFull(int numToSubmit) { + if (warnIfFull) { + double currentPoolSize = (double) (cachedThreadPool.activePoolSize + numToSubmit) + double percentFull = currentPoolSize / cachedThreadPool.maximumPoolSize + if (percentFull > 0.9) { + log.warn("[{}] pool is > 90% full, [{}] current threads", poolName, ((int) currentPoolSize - 1)) + } + } + } + + public Future submit(Callable callable) { + warnIfFull(1) + List futures = cachedThreadPool.submit(new ProfCallable(callable: callable, uniqueName: assignUniqueNameToEachRootEvent), 1) + return new ProfFuture(underlyingFuture: futures.first()) + } + + int getMaximumPoolSize() { + return cachedThreadPool.maximumPoolSize + } + + int getCurrentPoolSize() { + return cachedThreadPool.currentPoolSize + } + + int getActivePoolSize() { + return cachedThreadPool.activePoolSize + } + + void shutdown() { + cachedThreadPool.shutdown() + } +} diff --git a/call-stack-profiler/src/main/java/callStack/profiler/Profile.java b/call-stack-profiler/src/main/java/callStack/profiler/Profile.java new file mode 100644 index 00000000..77f21acc --- /dev/null +++ b/call-stack-profiler/src/main/java/callStack/profiler/Profile.java @@ -0,0 +1,33 @@ +/** + * Copyright 2020 SkillTree + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package callStack.profiler; + +import org.codehaus.groovy.transform.GroovyASTTransformationClass; + +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +@java.lang.annotation.Documented +@Retention(RetentionPolicy.SOURCE) +@Target({ElementType.METHOD, ElementType.TYPE}) +@GroovyASTTransformationClass("callStack.profiler.ProfileASTTransformation") +public @interface Profile { + String name() default ""; + boolean aggregateIntoSingleEvent() default true; +} + diff --git a/call-stack-profiler/src/main/java/callStack/profiler/ProfileASTTransformation.groovy b/call-stack-profiler/src/main/java/callStack/profiler/ProfileASTTransformation.groovy new file mode 100644 index 00000000..068e0c36 --- /dev/null +++ b/call-stack-profiler/src/main/java/callStack/profiler/ProfileASTTransformation.groovy @@ -0,0 +1,138 @@ +/** + * Copyright 2020 SkillTree + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package callStack.profiler + +import groovy.util.logging.Slf4j +import org.codehaus.groovy.ast.* +import org.codehaus.groovy.ast.expr.ArgumentListExpression +import org.codehaus.groovy.ast.expr.ConstantExpression +import org.codehaus.groovy.ast.expr.Expression +import org.codehaus.groovy.ast.expr.StaticMethodCallExpression +import org.codehaus.groovy.ast.stmt.BlockStatement +import org.codehaus.groovy.ast.stmt.ExpressionStatement +import org.codehaus.groovy.ast.stmt.Statement +import org.codehaus.groovy.ast.stmt.TryCatchStatement +import org.codehaus.groovy.control.CompilePhase +import org.codehaus.groovy.control.SourceUnit +import org.codehaus.groovy.transform.AbstractASTTransformation +import org.codehaus.groovy.transform.GroovyASTTransformation + +import java.util.concurrent.atomic.AtomicLong + +@GroovyASTTransformation(phase = CompilePhase.SEMANTIC_ANALYSIS) +@Slf4j +public class ProfileASTTransformation extends AbstractASTTransformation { + final static AtomicLong counter = new AtomicLong(0) + public void visit(ASTNode[] nodes, SourceUnit sourceUnit) { + if (!nodes) return + if (!nodes[0]) return + if (!nodes[1]) return + if (!nodes[0] instanceof AnnotatedNode) return + if (!nodes[1] instanceof MethodNode) return + + MethodNode annotatedMethod = nodes[1] + List annotationNodeList = annotatedMethod.getAnnotations(new ClassNode(Profile)) + if (!annotationNodeList) { + return + } + String profileKey = getMemberStringValue(annotationNodeList, "name") + boolean aggregateIntoSingleEvent = getMemberBooleanValue(annotationNodeList, "aggregateIntoSingleEvent", true) + + if (!profileKey) { + ClassNode declaringClass = annotatedMethod.declaringClass + profileKey = declaringClass.nameWithoutPackage + "." + annotatedMethod.name + + // add the parameter types to the profile key if more than one method exists with the same name + if (declaringClass.getMethods(annotatedMethod.name).size() > 1) { + for (Parameter parameter : annotatedMethod.parameters) { + profileKey += '_' + parameter.type.nameWithoutPackage + } + } + } + if(!aggregateIntoSingleEvent){ + profileKey = profileKey+counter.getAndIncrement() + } + + log.info('profile key is {}', profileKey) + Statement startMessage = createProfileCallAst("start", profileKey) + Statement endMessage = createProfileCallAst("stop", profileKey, aggregateIntoSingleEvent) + wrapWithTryFinally(annotatedMethod, startMessage, endMessage) + } + + private static void wrapWithTryFinally(MethodNode methodNode, Statement startProf, Statement stopProf) { + BlockStatement code = (BlockStatement) methodNode.getCode() + BlockStatement newCode = new BlockStatement() + newCode.addStatement(startProf) + + TryCatchStatement tryCatchStatement = new TryCatchStatement(code, new BlockStatement()) + newCode.addStatement(tryCatchStatement) + methodNode.setCode(newCode) + tryCatchStatement.setFinallyStatement(stopProf) + } + + private Statement createProfileCallAst(String method, String message) { + return new ExpressionStatement( + new StaticMethodCallExpression( + ClassHelper.make(CProf), + method, + new ArgumentListExpression( + new ConstantExpression(message) + ) + ) + ) + } + private Statement createProfileCallAst(String method, String message, boolean aggregateIntoSingleEvent) { + return new ExpressionStatement( + new StaticMethodCallExpression( + ClassHelper.make(CProf), + method, + new ArgumentListExpression( + new ConstantExpression(message), + new ConstantExpression(aggregateIntoSingleEvent) + ) + ) + ) + } + + protected String getMemberStringValue(List annotationNodeList, String name){ + annotationLoop: for (AnnotationNode annotationNode : annotationNodeList) { + String res = getMemberStringValue(annotationNode, name) + if(res){ + return res + } + } + return null + } + + protected Boolean getMemberBooleanValue(List annotationNodeList, String name, boolean defaultVal){ + annotationLoop: for (AnnotationNode annotationNode : annotationNodeList) { + Boolean res = getMemberBooleanValue(annotationNode, name) + if(res!=null){ + return res + } + } + defaultVal + } + + protected Boolean getMemberBooleanValue(AnnotationNode node, String name) { + final Expression member = node.getMember(name); + if (member != null && member instanceof ConstantExpression) { + Object result = ((ConstantExpression) member).getValue(); + if (result != null) return (boolean)result; + } + return null; + } +} \ No newline at end of file diff --git a/call-stack-profiler/src/main/java/callStack/profiler/ProfileEvent.java b/call-stack-profiler/src/main/java/callStack/profiler/ProfileEvent.java new file mode 100644 index 00000000..b2fa43d4 --- /dev/null +++ b/call-stack-profiler/src/main/java/callStack/profiler/ProfileEvent.java @@ -0,0 +1,262 @@ +/** + * Copyright 2020 SkillTree + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package callStack.profiler; + +import org.apache.commons.lang3.Validate; +import org.joda.time.Period; +import org.joda.time.format.PeriodFormatter; +import org.joda.time.format.PeriodFormatterBuilder; + +import java.io.Serializable; +import java.text.NumberFormat; +import java.util.Collection; +import java.util.Collections; +import java.util.List; +import java.util.Map; +import java.util.concurrent.ConcurrentHashMap; +import java.util.stream.Collectors; + +import static org.apache.commons.lang3.Validate.notNull; + +public class ProfileEvent implements Serializable { + static final long serialVersionUID = 1l; + + long runtimeInMillis = 0; + int numOfInvocations = 0; + String name; + + // interal use only please + long start = -1; + // these are display only + boolean isConcurrent = false; + boolean isRemote = false; + ProfileEvent parent; + // --------------------------------- + Map childrenAsMap; + + public Collection getChildren() { + if (childrenAsMap == null) { + return Collections.emptyList(); + } + return childrenAsMap.values(); + } + + public synchronized void addChild(ProfileEvent child) { + notNull(child); + notNull(child.getName()); + + if (childrenAsMap == null) { + childrenAsMap = new ConcurrentHashMap(); + } + childrenAsMap.put(child.getName(), child); + child.setParent(this); + } + + synchronized void replaceChild(String previousName, ProfileEvent child) { + childrenAsMap.remove(previousName); + childrenAsMap.put(child.getName(), child); + } + + + public ProfileEvent getEvent(String str) { + notNull(str); + ProfileEvent res = null; + if (childrenAsMap != null) { + res = childrenAsMap.get(str); + } + return res; + } + + public void startEvent() { + if (start != -1) { + Validate.isTrue(start == -1, "Can not start event twice. Event [" + name + "] has already been started"); + } + + start = System.currentTimeMillis(); + } + + public void endEvent() { + if (start == -1) { + throw new IllegalArgumentException("Must call startEvent first"); + } + numOfInvocations++; + runtimeInMillis = runtimeInMillis + (System.currentTimeMillis() - start); + start = -1; + } + + public String prettyPrint() { + StringBuilder res = new StringBuilder(); + buildPrettyString(res, this, ""); + return res.toString(); + } + + private final static NumberFormat NUMBER_FORMAT = NumberFormat.getInstance(); + + private void buildPrettyString(StringBuilder res, ProfileEvent node, String pre) { + if (res.length() > 0) { + res.append("\n"); + } + StringBuilder preBuilder = new StringBuilder(pre); + if (node.isConcurrent) { + preBuilder.append("|"); + } + if (node.isRemote) { + preBuilder.append("||"); + } + preBuilder.append("|"); + res.append(preBuilder.toString()); + + res.append("-> "); + res.append(node.getName()); + res.append(" ("); + res.append(NUMBER_FORMAT.format(node.getNumOfInvocations())); + res.append(") : "); + addRuntime(res, node.getRuntimeInMillis()); + + boolean hasChildren = node != null && !isEmpty(node.getChildrenAsMap()); + if (hasChildren) { + handleUnaccountedTime(res, node); + } + if (hasChildren) { + preBuilder.append(" "); + for (ProfileEvent profileEvent : node.getChildrenAsMap().values()) { + buildPrettyString(res, profileEvent, preBuilder.toString()); + } + } + } + + private static boolean isEmpty(Map map) { + return map == null || map.isEmpty(); + } + + private void handleUnaccountedTime(StringBuilder res, ProfileEvent node) { + Collection values = node.getChildrenAsMap().values(); + + long childrenSum = 0; + List syncEvents = values.stream().filter(p-> !isConcurrent(p)).collect(Collectors.toList()); + if(!syncEvents.isEmpty()){ + childrenSum += syncEvents.stream().mapToLong(ProfileEvent::getRuntimeInMillis).sum(); + } + List asyncEvents = values.stream().filter(p-> isConcurrent(p)).collect(Collectors.toList()); + if(!asyncEvents.isEmpty()){ + childrenSum += asyncEvents.stream().mapToLong(ProfileEvent::getRuntimeInMillis).max().getAsLong(); + } + + long diff = node.getRuntimeInMillis() - childrenSum; + res.append(" ["); + res.append(periodFormatter.print(new Period(diff))); + res.append("]"); + } + private boolean isConcurrent(ProfileEvent p){ + return p.isRemote() || p.isConcurrent(); + } + + private final static long SECOND = 1000; + private final static long MINUTE = 60 * SECOND; + private final static long HOUR = 60 * MINUTE; + + + private static final PeriodFormatter periodFormatter = new PeriodFormatterBuilder() + .appendHours() + .appendSuffix("h") + .appendSeparatorIfFieldsBefore(" ") + .appendMinutes() + .appendSuffix("m") + .appendSeparatorIfFieldsBefore(" ") + .appendSeconds() + .appendSuffix("s") + .appendSeparatorIfFieldsBefore(" ") + .appendMillis3Digit() + .appendSuffix("ms").toFormatter(); + + private void addRuntime(StringBuilder res, long runtime) { + res.append(periodFormatter.print(new Period(runtime))); + } + + public boolean isEnded() { + return start == -1; + } + + @Override + public String toString() { + return prettyPrint(); + } + + public long getRuntimeInMillis() { + return runtimeInMillis; + } + + public void setRuntimeInMillis(long runtimeInMillis) { + this.runtimeInMillis = runtimeInMillis; + } + + public int getNumOfInvocations() { + return numOfInvocations; + } + + public void setNumOfInvocations(int numOfInvocations) { + this.numOfInvocations = numOfInvocations; + } + + public String getName() { + return name; + } + + public void setName(String name) { + this.name = name; + } + + public long getStart() { + return start; + } + + public void setStart(long start) { + this.start = start; + } + + public boolean isConcurrent() { + return isConcurrent; + } + + public void setConcurrent(boolean concurrent) { + isConcurrent = concurrent; + } + + public boolean isRemote() { + return isRemote; + } + + public void setRemote(boolean remote) { + isRemote = remote; + } + + public ProfileEvent getParent() { + return parent; + } + + public void setParent(ProfileEvent parent) { + this.parent = parent; + } + + public Map getChildrenAsMap() { + return childrenAsMap; + } + + public void setChildrenAsMap(Map childrenAsMap) { + this.childrenAsMap = childrenAsMap; + } +} + diff --git a/call-stack-profiler/src/main/java/callStack/utils/AbstractThreadPool.java b/call-stack-profiler/src/main/java/callStack/utils/AbstractThreadPool.java new file mode 100644 index 00000000..537f4789 --- /dev/null +++ b/call-stack-profiler/src/main/java/callStack/utils/AbstractThreadPool.java @@ -0,0 +1,301 @@ +/** + * Copyright 2020 SkillTree + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package callStack.utils; + +import org.apache.commons.lang3.Validate; + +import java.io.PrintWriter; +import java.io.StringWriter; +import java.util.ArrayList; +import java.util.List; +import java.util.concurrent.*; +import java.util.concurrent.atomic.AtomicInteger; + +public abstract class AbstractThreadPool implements ThreadPoolStats { + + protected ExecutorService m_pool = null; + + public List submitAndGetExceptions(Callable submitMe, + int numOfSubmissions) { + List allExceptions = submitAndGetExceptions(m_pool, submitMe, + numOfSubmissions); + return allExceptions; + } + + public List submitAndGetExceptions(List> submitList) { + List allExceptions = submitAndGetExceptions(m_pool, submitList); + return allExceptions; + } + + public List> submit(Callable submitMe, int numOfSubmissions) { + return submit(m_pool, submitMe, numOfSubmissions); + } + + public List> submit(List> listToSubmit) { + return submitAll(m_pool, listToSubmit); + } + + public List submitAndGetResults(List> listToSubmit) { + List> futures = submitAll(m_pool, listToSubmit); + + List results = pullOutResults(futures); + return results; + } + + private List pullOutResults(List> futures) { + List results = new ArrayList(); + for (Future future : futures) { + try { + T result = future.get(); + if (result != null) { + results.add(result); + } + } catch (Throwable e) { + throw new RuntimeException("Failed to execute callable.", e); + } + } + return results; + } + + public List submitAndGetResults(Callable callable, + int numOfSubmissions) { + Validate.notNull(callable); + Validate.isTrue(numOfSubmissions > 0, + "Must at submit at least 1 callable"); + + List> futures = submit(callable, numOfSubmissions); + return pullOutResults(futures); + } + + public void shutdown() { + m_pool.shutdown(); + } + + /** + * The default thread factory + * + * Code borrowed from JDK, named was added to the constructor + */ + static class NamedThreadFactory implements ThreadFactory { + final ThreadGroup group; + + final AtomicInteger threadNumber = new AtomicInteger(1); + + final String namePrefix; + + NamedThreadFactory(String name) { + SecurityManager s = System.getSecurityManager(); + group = (s != null) ? s.getThreadGroup() : Thread.currentThread() + .getThreadGroup(); + namePrefix = name + "-"; + } + + @Override + public Thread newThread(Runnable r) { + Thread t = new Thread(group, r, namePrefix + + threadNumber.getAndIncrement(), 0); + if (t.isDaemon()) + t.setDaemon(false); + if (t.getPriority() != Thread.NORM_PRIORITY) + t.setPriority(Thread.NORM_PRIORITY); + return t; + } + } + + /** + * Submit provided {@link Callable} numOfSubmissions times, wait for ALL the + * threads to finish and return a list of the exceptions generated by the + * threads. If there are no exceptions then an empty list is returned. + * + * @param + * @param executor + * - executor service to use + * @param callable + * - {@link Callable} to submit numOfSubmissions times + * @param numOfSubmissions + * number of times to submit the provided callable + * @return + */ + private List submitAndGetExceptions( + final ExecutorService executor, final Callable callable, + final int numOfSubmissions) { + List> futures = submit(executor, callable, numOfSubmissions); + return getExceptionsInList(futures); + } + + /** + * Submit provided {@link Callable} numOfSubmissions times and return the + * futures + * + * @param + * @param executor + * - executor service to use + * @param callable + * - {@link Callable} to submit numOfSubmissions times + * @param numOfSubmissions + * number of times to submit the provided callable + * @return a list of futures + */ + private List> submit( + final ExecutorService executor, final Callable callable, + final int numOfSubmissions) { + List> futures = new ArrayList>(numOfSubmissions); + for (int i = 0; i < numOfSubmissions; i++) { + futures.add(executor.submit(callable)); + } + + return futures; + } + + /** + * Retrieves all Exceptions from the List of Future objects and puts them in + * a list of Strings. Note: will halt the calling thread till all the + * futures/threads are completed. + * + * @param + * @param futures + * @return the List of Strings, one element for each Future's Exception + */ + private List getExceptionsInList( + final List> futures) { + List exceptions = new ArrayList(futures.size()); + + for (Future future : futures) { + try { + future.get(); + } catch (Throwable append) { + exceptions.add(getStackTraceFromThrowable(append)); + } + } + + return exceptions; + } + + private String getStackTraceFromThrowable(Throwable t) { + if (t != null) { + StringWriter writer = new StringWriter(); + PrintWriter printWriter = new PrintWriter(writer); + t.printStackTrace(printWriter); + String stackTrace = writer.toString(); + printWriter.close(); + return stackTrace; + } else { + return null; + } + } + + /** + * Submit a list of {@link Callable}s, wait for them to execute and return + * exceptions + * + * @param + * @param executor + * - executor service to use + * @param callables + * - a list o {@link Callable}s to submit + * @return + */ + private List submitAndGetExceptions( + final ExecutorService executor, final List> callables) { + List> futures = submitAll(executor, callables); + return getExceptionsInList(futures); + } + + /** + * Submits all {@link Callable} tasks in the list using the provided + * ExecutorService + * + * @param + * @param executor + * @param callables + * @return a list of Future objects, one for each submitted task + */ + private List> submitAll( + final ExecutorService executor, final List> callables) { + List> futures = new ArrayList>(callables.size()); + for (Callable callable : callables) { + futures.add(executor.submit(callable)); + } + return futures; + } + + /** + * Retrieves all Exceptions from the List of Future objects and appends them + * to a String. Note: will halt the calling thread till all the + * futures/threads are completed. + * + * @param + * @param futures + * @return a String containing all Exceptions thrown from the Future tasks + */ + public String getExceptions(final List> futures) { + StringBuilder builder = new StringBuilder(); + for (Future future : futures) { + try { + future.get(); + } catch (Throwable append) { + builder.append(getStackTraceFromThrowable(append)); + } + } + + return builder.toString(); + } + + /** + * (U) Returns the maximum size of this thread pool. Some implementations of + * the underlying Executor may not expose the thread pool sizes. If this + * occurs, zero will be returned. + * + * @return The maximum size of this thread pool. + */ + public int getMaximumPoolSize() { + if (m_pool instanceof ThreadPoolExecutor) { + return ((ThreadPoolExecutor) m_pool).getMaximumPoolSize(); + } else { + return 0; + } + } + + /** + * (U) Returns the current size of this thread pool. Some implementations of + * the underlying Executor may not expose the thread pool sizes. If this + * occurs, zero will be returned. + * + * @return The current size of this thread pool. + */ + public int getCurrentPoolSize() { + if (m_pool instanceof ThreadPoolExecutor) { + return ((ThreadPoolExecutor) m_pool).getPoolSize(); + } else { + return 0; + } + } + + /** + * (U) Returns the number of actively running threads in this thread pool. + * Some implementations of the underlying Executor may not expose the thread + * pool sizes. If this occurs, zero will be returned. + * + * @return The active size of this thread pool. + */ + public int getActivePoolSize() { + if (m_pool instanceof ThreadPoolExecutor) { + return ((ThreadPoolExecutor) m_pool).getActiveCount(); + } else { + return 0; + } + } +} diff --git a/call-stack-profiler/src/main/java/callStack/utils/CachedThreadPool.java b/call-stack-profiler/src/main/java/callStack/utils/CachedThreadPool.java new file mode 100644 index 00000000..f9978ecd --- /dev/null +++ b/call-stack-profiler/src/main/java/callStack/utils/CachedThreadPool.java @@ -0,0 +1,35 @@ +/** + * Copyright 2020 SkillTree + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package callStack.utils; + +import java.util.concurrent.Executors; +import java.util.concurrent.LinkedBlockingQueue; +import java.util.concurrent.ThreadPoolExecutor; +import java.util.concurrent.TimeUnit; + +public class CachedThreadPool extends AbstractThreadPool { + + public CachedThreadPool(String name) { + m_pool = Executors.newCachedThreadPool(new NamedThreadFactory(name)); + } + + public CachedThreadPool(final String name, int minNumOfThreads, int maxNumOfThreads) { + m_pool = new ThreadPoolExecutor(minNumOfThreads, maxNumOfThreads, + 60L, TimeUnit.SECONDS, + new LinkedBlockingQueue(), + new NamedThreadFactory(name)); + } +} diff --git a/call-stack-profiler/src/main/java/callStack/utils/ClosureCallable.groovy b/call-stack-profiler/src/main/java/callStack/utils/ClosureCallable.groovy new file mode 100644 index 00000000..b9515290 --- /dev/null +++ b/call-stack-profiler/src/main/java/callStack/utils/ClosureCallable.groovy @@ -0,0 +1,26 @@ +/** + * Copyright 2020 SkillTree + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package callStack.utils + +import java.util.concurrent.Callable + +class ClosureCallable implements Callable{ + Closure closure + @Override + T call() throws Exception { + return closure.call() + } +} diff --git a/backend/src/main/java/skills/storage/repos/LevelDefRepo.groovy b/call-stack-profiler/src/main/java/callStack/utils/ThreadPoolStats.java similarity index 70% rename from backend/src/main/java/skills/storage/repos/LevelDefRepo.groovy rename to call-stack-profiler/src/main/java/callStack/utils/ThreadPoolStats.java index 57469bb7..d18dbe7b 100644 --- a/backend/src/main/java/skills/storage/repos/LevelDefRepo.groovy +++ b/call-stack-profiler/src/main/java/callStack/utils/ThreadPoolStats.java @@ -13,13 +13,13 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -package skills.storage.repos +package callStack.utils; -import org.springframework.data.repository.CrudRepository -import skills.storage.model.LevelDef +public interface ThreadPoolStats { -interface LevelDefRepo extends CrudRepository{ + public int getMaximumPoolSize(); - List findAllByProjectRefId(Integer projectId) + public int getCurrentPoolSize(); + public int getActivePoolSize(); } diff --git a/backend/src/test/java/skills/intTests/PublicConfigSpecs.groovy b/call-stack-profiler/src/main/java/callStack/utils/ThreadPoolUtils.groovy similarity index 67% rename from backend/src/test/java/skills/intTests/PublicConfigSpecs.groovy rename to call-stack-profiler/src/main/java/callStack/utils/ThreadPoolUtils.groovy index 99f7ffd3..0545283d 100644 --- a/backend/src/test/java/skills/intTests/PublicConfigSpecs.groovy +++ b/call-stack-profiler/src/main/java/callStack/utils/ThreadPoolUtils.groovy @@ -13,17 +13,13 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -package skills.intTests +package callStack.utils -import skills.intTests.utils.DefaultIntSpec +import java.util.concurrent.Callable -class PublicConfigSpecs extends DefaultIntSpec { +class ThreadPoolUtils { - def "retrieve public configs"() { - when: - def config = skillsService.getPublicConfigs() - then: - config - config.descriptionMaxLength == "2000" + static Callable callable(Closure closure) { + return new ClosureCallable(closure: closure) } } diff --git a/call-stack-profiler/src/test/java/callStack/profiler/AsyncProcessSpecification.groovy b/call-stack-profiler/src/test/java/callStack/profiler/AsyncProcessSpecification.groovy new file mode 100644 index 00000000..92a14dfa --- /dev/null +++ b/call-stack-profiler/src/test/java/callStack/profiler/AsyncProcessSpecification.groovy @@ -0,0 +1,154 @@ +/** + * Copyright 2020 SkillTree + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package callStack.profiler + +import callStack.profiler.AsyncProcess +import groovy.util.logging.Slf4j +import spock.lang.Specification + +import java.util.concurrent.TimeUnit +import java.util.concurrent.atomic.AtomicInteger + + +@Slf4j +class AsyncProcessSpecification extends Specification{ + + AsyncProcess asyncProcess + void cleanup(){ + asyncProcess.stop() + } + + def "Able to async process closure code"(){ + AtomicInteger count = new AtomicInteger() + + asyncProcess = new AsyncProcess() + asyncProcess.start() + when: + asyncProcess.async { + count.andIncrement + } + asyncProcess.async { + count.andIncrement + } + asyncProcess.async { + count.andIncrement + } + waitFor(count, 3) + + then: + count.get() == 3 + } + + private void waitFor(AtomicInteger count, int numToWait) { + int num = 0 + while (count.get() != numToWait && num < 10) { + Thread.sleep(200) + num++ + } + } + + def "Async code may throw exceptions"(){ + AtomicInteger count = new AtomicInteger() + + asyncProcess = new AsyncProcess() + asyncProcess.start() + when: + asyncProcess.async { + if(true){throw new IllegalArgumentException("fail")} + count.andIncrement + } + asyncProcess.async { + count.andIncrement + } + asyncProcess.async { + count.andIncrement + } + waitFor(count, 2) + + then: + count.get() == 2 + } + + def "Execute real slow closure"(){ + AtomicInteger count = new AtomicInteger(0) + + asyncProcess = new AsyncProcess() + asyncProcess.start() + when: + long start = System.currentTimeMillis() + asyncProcess.async { + Thread.sleep(5000) + count.getAndIncrement() + } + + long diff = System.currentTimeMillis()-start + int num = 0 + while (count.get() != 1 && num < 10) { + Thread.sleep(1000) + num++ + } + then: + diff < 1000 + count.get() == 1 + } + + + def "throw an exception if async queue is full"(){ + + asyncProcess = new AsyncProcess(queueSize:2) + asyncProcess.start() + + asyncProcess.async { Thread.sleep(50000) } + asyncProcess.async { Thread.sleep(1) } + + Throwable t + when: + try { + asyncProcess.async { Thread.sleep(50000) } + asyncProcess.async { Thread.sleep(50000) } + } catch (IllegalStateException e){ + e.printStackTrace() + t = e + } + + then: + asyncProcess.stop() + t.message == "Queue full" + } + + + def "support drop-if-full option"(){ + AtomicInteger count = new AtomicInteger(0) + + asyncProcess = new AsyncProcess(queueSize:1, dropIfFull:true) + asyncProcess.start() + + int numAttempts = 100 + when: + List res = (1..numAttempts).collect { + asyncProcess.async { + count.incrementAndGet() + } + } + + // we need to sleep so async tasks execute + TimeUnit.SECONDS.sleep(5) + then: + count.get().intValue() < numAttempts + res.findAll ( { it.equals(false) }).size() > 0 + } + +} diff --git a/call-stack-profiler/src/test/java/callStack/profiler/CProfSpecification.groovy b/call-stack-profiler/src/test/java/callStack/profiler/CProfSpecification.groovy new file mode 100644 index 00000000..9283f93f --- /dev/null +++ b/call-stack-profiler/src/test/java/callStack/profiler/CProfSpecification.groovy @@ -0,0 +1,392 @@ +/** + * Copyright 2020 SkillTree + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package callStack.profiler + +import callStack.profiler.CProf +import callStack.profiler.Profile +import callStack.profiler.ProfileEvent +import org.apache.commons.lang3.time.StopWatch +import spock.lang.Specification + +class CProfSpecification extends Specification { + + + def setup() { + CProf.clear() + } + + + class C1 { + C2 c2 = new C2() + + void callC2(boolean disableTree) { + CProf.prof("callC2") { + c2.callC3(disableTree) + } + } + } + + class C2 { + C3 c3 = new C3() + + void callC3(boolean disableTree) { + CProf.prof("callC3") { + Thread.sleep(100) + c3.some(disableTree) + c3.m2(disableTree) + } + } + } + + class C3 { + void some(boolean disableTree) { + CProf.prof("some") { + Thread.sleep(150) + } + + CProf.prof("anotherSome") { + Thread.sleep(200) + } + } + + void m2(boolean disableTree) { + CProf.prof("m2") { + Thread.sleep(50) + CProf.turnTreeProfilingOff.set(disableTree) + } + + CProf.prof("m3") { + Thread.sleep(350) + } + + (0..5).each { + CProf.prof("forLoop") { + Thread.sleep(50) + } + } + } + } + + class C8 { + + @Profile + void m2() { + + Thread.sleep(50) + m2("blah") + + } + @Profile + void m2(String s) { + + Thread.sleep(50) + + } + + } + + def "call stack should propagate exceptions"() { + when: + new ThrowExceptionClass().profAndThrow() + then: + thrown(RuntimeException) + } + + def "Test Simple Hierarchy Profiling"() { + setup: + C1 c1 = new C1() + ProfileEvent event + when: + c1.callC2(false) + then: + CProf.rootEvent.name == "callC2" + CProf.rootEvent.runtimeInMillis >= 1000 + CProf.rootEvent.children.size() == 1 + CProf.rootEvent.children.first().name == "callC3" + CProf.rootEvent.children.first().runtimeInMillis >= 1000 + CProf.rootEvent.children.first().children.size() == 5 + Map> eventsByName = CProf.rootEvent.children.first().children.groupBy { it.name } + eventsByName["some"].first().runtimeInMillis >= 150 + eventsByName["anotherSome"].first().runtimeInMillis >= 200 + eventsByName["m2"].first().runtimeInMillis >= 50 + eventsByName["m3"].first().runtimeInMillis >= 350 + eventsByName["forLoop"].first().runtimeInMillis >= (50 * 5) + eventsByName["forLoop"].first().numOfInvocations == 6 + } + + def "Test Simple Hierarchy Profiling - tree profiling disabled mid profiling"() { + setup: + C1 c1 = new C1() + ProfileEvent event + when: + c1.callC2(true) + CProf.turnTreeProfilingOff.set(false) + then: + CProf.rootEvent.name == "callC2" +// println CProf.prettyPrint() + } + + def "Test Simple Hierarchy Profiling - tree profiling disabled"() { + setup: + C4 c4 = new C4() + ProfileEvent event + when: + CProf.turnTreeProfilingOff.set(true) + c4.m() + CProf.turnTreeProfilingOff.set(false) + then: + CProf.rootEvent.name == "root" + CProf.rootEvent.children.size() == 0 +// println CProf.prettyPrint() + } + + + class C4 { + void m() { + CProf.prof("root") { + (0..5).each { + CProf.prof("call", false) { + Thread.sleep(50) + } + } + } + } + } + + def "Allow for events to not be aggregated on the same hierarchy level with the same name"() { + setup: + C4 c4 = new C4() + ProfileEvent event + when: + c4.m() +// println CProf.prettyPrint() + then: + CProf.rootEvent.name == "root" + CProf.rootEvent.runtimeInMillis >= 300 + CProf.rootEvent.children.size() == 6 + } + + + class C5 { + void m() { + CProf.prof("root") { + (0..5).each { + CProf.start("call") + Thread.sleep(50) + CProf.stop("call", false) + } + } + } + } + + def "Allow for events to not be aggregated on the same hierarchy level with the same name - use stopProf Method"() { + setup: + C5 c5 = new C5() + ProfileEvent event + when: + c5.m() +// println CProf.prettyPrint() + then: + CProf.rootEvent.name == "root" + CProf.rootEvent.runtimeInMillis >= 300 + CProf.rootEvent.children.size() == 6 + CProf.rootEvent.children.first().name.startsWith("call") + } + + def "Print out should look good for large hierarchy"() { + setup: + when: + CProf.prof("l1") { + CProf.prof("l2") { + CProf.prof("l3") { + CProf.prof("l4") { + CProf.prof("l5") { + CProf.prof("l6") { + CProf.prof("l7") { + CProf.prof("l8") { + (0..10).each { + CProf.prof("l9-${it}") { + + } + } + } + } + } + } + } + } + } + + CProf.prof("l2-1") { + (0..10).each { + CProf.prof("l3-${it}") { + CProf.prof("l4") { + + } + } + } + } + CProf.prof("l2-3") { + CProf.prof("l3") { + CProf.prof("l4") { + + } + } + } + } + then: + CProf.prettyPrint() +// println CProf.prettyPrint() + } + + + def "Profiling must be fast in a for-loop"() { + when: + CProf.prof("load") {} + StopWatch watch = new StopWatch() + watch.start() + CProf.prof("top") { + (0..1000).each { + CProf.prof("forLoop") { + } + } + } + watch.stop() + +// println watch.time +// println CProf.prettyPrint() + then: + watch.time < 1000 + } + + def "Pretty print large numbers"() { + + when: + CProf.prof("pretty") {} + CProf.rootEvent.numOfInvocations = 10000 + String prettyPrint = CProf.prettyPrint() + then: + prettyPrint.startsWith("|-> pretty (10,000) :") + } + + + def "Pretty print should not be too slow"() { + setup: + when: + CProf.prof("l1") { + CProf.prof("l2") { + CProf.prof("l3") { + CProf.prof("l4") { + CProf.prof("l5") { + CProf.prof("l6") { + CProf.prof("l7") { + CProf.prof("l8") { + (0..10).each { + CProf.prof("l9-${it}") { + + } + } + } + } + } + } + } + } + } + + CProf.prof("l2-1") { + (0..10).each { + CProf.prof("l3-${it}") { + CProf.prof("l4") { + + } + } + } + } + CProf.prof("l2-3") { + CProf.prof("l3") { + CProf.prof("l4") { + + } + } + } + } + StopWatch stopWatch = new StopWatch() + stopWatch.start() + CProf.prettyPrint() + stopWatch.stop() + +// println stopWatch.time + then: + CProf.prettyPrint() +// println CProf.prettyPrint() + } + + def "Call stack profiler should properly propagate exceptions"() { + + when: + CProf.prof("with exception"){ + throw new IllegalArgumentException("fail") + } + then: thrown (IllegalArgumentException) + + } + + def "Should be able to handle overloaded methods when profiling is off"() { + + setup: + CProf?.turnTreeProfilingOff.set(true) + when: + new C8().m2() + then: + CProf?.turnTreeProfilingOff.set(false) + + } + + static class ThrowExceptionClass { + void profAndThrow() { + CProf.prof("m1") { + Thread.sleep(50) + throwException("blah") + } + + } + + void throwException(String s) { + CProf.start("m2") + Thread.sleep(50) + throw new RuntimeException("Exception") + } + + } + + def "ability to preserve root ProfileEvent object for later utilization"(){ + List events = [] + + when: + 2.times { + CProf.prof("prof"){ + Thread.sleep(50) + } + events.add(CProf.rootEvent) + } + then: + events.size() == 2 + events.first().hashCode() != events.last().hashCode() + } + + +} diff --git a/call-stack-profiler/src/test/java/callStack/profiler/ProfileAnnotationSpecification.groovy b/call-stack-profiler/src/test/java/callStack/profiler/ProfileAnnotationSpecification.groovy new file mode 100644 index 00000000..07411369 --- /dev/null +++ b/call-stack-profiler/src/test/java/callStack/profiler/ProfileAnnotationSpecification.groovy @@ -0,0 +1,277 @@ +/** + * Copyright 2020 SkillTree + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package callStack.profiler + +import callStack.profiler.CProf +import callStack.profiler.Profile +import spock.lang.Specification + + +class ProfileAnnotationSpecification extends Specification { + class C1 { + @Profile + void m1() { + Thread.sleep(50) + new C2().m2() + } + + @Profile + void willThrow(){ + new C2().willThrow() + } + + @Profile + void willThrowAsWell(){ + new C2().willThrowAsWell() + } + } + class C2 { + @Profile + void m2() { + Thread.sleep(50) + } + + @Profile + void willThrow(){ + new C3().m4() + } + + @Profile + void willThrowAsWell(){ + new C3().willThrowAsWell() + } + } + + def "Profile annotation must add profiling to the annotation method"() { + setup: + + when: + new C1().m1() + then: + CProf.rootEvent + CProf.rootEvent.name == "ProfileAnnotationSpecification\$C1.m1" + CProf.rootEvent.runtimeInMillis > 0 + + CProf.rootEvent.children + CProf.rootEvent.children.size() == 1 + CProf.rootEvent.children.first().name == "ProfileAnnotationSpecification\$C2.m2" + CProf.rootEvent.children.first().runtimeInMillis > 0 + CProf.rootEvent.ended + } + + + class C3 { + @Profile + String m3() { + Thread.sleep(200) + return "string" + } + + @Profile + String m4() { + Thread.sleep(200) + throw new IllegalArgumentException("aljaljfljaljf") + return "string" + } + + @Profile + String willThrowAsWell() { + Thread.sleep(200) + try { + (0..10).each { + List list = [new WithAttr(attr: "blja"), ["aljl", "lajlakj"]] + // this should throw an exception + def groupBy = list.groupBy { it.attr } + } + return "groupBy" + } catch (Throwable throwable) { +// throwable.printStackTrace() + throw throwable + } + } + } + + class WithAttr{ + String attr + } + + def "Profile method's return must be properly propagated"() { + String res + when: + res = new C3().m3() + then: + CProf.rootEvent + CProf.rootEvent.name == "ProfileAnnotationSpecification\$C3.m3" + CProf.rootEvent.runtimeInMillis >= 0 + CProf.rootEvent.ended + res == "string" + } + + def "Thrown exception does NOT stop profiling from completing"() { + String res + Exception thrownE + when: + try { + res = new C3().m4() + fail "should never get here" + } catch (Exception e) { thrownE = e} + then: + CProf.rootEvent + CProf.rootEvent.name == "ProfileAnnotationSpecification\$C3.m4" + CProf.rootEvent.runtimeInMillis >= 200 + CProf.rootEvent.ended + !res + thrownE instanceof IllegalArgumentException + thrownE.message == "aljaljfljaljf" + } + + def "Nested exception does NOT stop profiling from completing"() { + String res + Exception thrownE + when: + try { + res = new C1().willThrow() + fail "should never get here" + } catch (Exception e) { thrownE = e} + then: + CProf.rootEvent + CProf.rootEvent.name == "ProfileAnnotationSpecification\$C1.willThrow" + CProf.rootEvent.runtimeInMillis >= 200 + CProf.rootEvent.ended + !res + thrownE instanceof IllegalArgumentException + thrownE.message == "aljaljfljaljf" + } + + def "Nested odd exception does NOT stop profiling from completing"() { + String res + Exception thrownE + when: + try { + res = new C1().willThrowAsWell() + fail "should never get here" + } catch (Exception e) { thrownE = e} + + thrownE.printStackTrace() + + println CProf.prettyPrint() + then: +// CProf.rootEvent +// CProf.rootEvent.name == "ProfileAnnotationSpecification\$C1.willThrow" +// CProf.rootEvent.runtimeInMillis >= 200 +// CProf.rootEvent.ended + !res +// thrownE instanceof IllegalArgumentException +// thrownE.message == "aljaljfljaljf" + } + + + def "Can the entry method multiple times and time should be properly re-set on each call"() { + when: + (0..10).each { + new C3().m3() + } + then: + CProf.rootEvent + CProf.rootEvent.name == "ProfileAnnotationSpecification\$C3.m3" + CProf.rootEvent.runtimeInMillis >= 200 + CProf.rootEvent.runtimeInMillis < 1000 + CProf.rootEvent.ended + } + + class C4 { + @Profile(name = "CustomName") + void m1() { + Thread.sleep(50) + } + } + + def "Annotation allows to change the name of the profile event"() { + when: + new C4().m1() + then: + CProf.rootEvent + CProf.rootEvent.name == "CustomName" + CProf.rootEvent.ended + CProf.rootEvent.runtimeInMillis >= 50 + } + + + class C5 { + @Profile + void empty() { + } + } + + def "Should be able to profile empty method, for some odd reason"() { + when: + new C5().empty() + then: + CProf.rootEvent + CProf.rootEvent.name == "ProfileAnnotationSpecification\$C5.empty" + CProf.rootEvent.ended + } + + class C6 { + boolean b = true + + @Profile(name = "multi-return") + void multiReturn() { + if (b) { + Thread.sleep(50) + return + } + Thread.sleep(10) + return + } + } + + def "Profile methods that have multiple returns"() { + when: + new C6().multiReturn() + then: + CProf.rootEvent + CProf.rootEvent.name == "multi-return" + CProf.rootEvent.ended + CProf.rootEvent.runtimeInMillis >= 50 + } + + class C7 { + boolean b = true + @Profile + void callMethod() { + dontAggregate() + dontAggregate() + dontAggregate() + } + + @Profile(aggregateIntoSingleEvent = false) + void dontAggregate() { + Thread.sleep(50) + } + } + + def "Allow each call to be a separate profile event"() { + when: + new C7().callMethod() +// println CProf.rootEvent.prettyPrint() + then: + CProf.rootEvent + CProf.rootEvent.name == "ProfileAnnotationSpecification\$C7.callMethod" + CProf.rootEvent.children.size() == 3 + CProf.rootEvent.runtimeInMillis >= 150 + } +} diff --git a/call-stack-profiler/src/test/java/callStack/profiler/ProfileEventSpecification.groovy b/call-stack-profiler/src/test/java/callStack/profiler/ProfileEventSpecification.groovy new file mode 100644 index 00000000..94df36e5 --- /dev/null +++ b/call-stack-profiler/src/test/java/callStack/profiler/ProfileEventSpecification.groovy @@ -0,0 +1,187 @@ +/** + * Copyright 2020 SkillTree + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package callStack.profiler + +import callStack.profiler.ProfileEvent +import spock.lang.Specification + +class ProfileEventSpecification extends Specification{ +// def "Must be able to Kryo serDer"(){ +// +// ProfileEvent child1 = new ProfileEvent(name: "test", runtimeInMillis: 10) +// ProfileEvent child2 = new ProfileEvent(name: "test", runtimeInMillis: 10) +// ProfileEvent event = new ProfileEvent(name: "test", runtimeInMillis: 10) +// event.addChild(child1) +// event.addChild(child2) +// +// ProfileEvent res +// when: +// byte [] ser = KryoSerializer.instance.serialize(event) +// res = KryoSerializer.instance.deserialize(ser) +// +// then: +// res +// res.name == event.name +// } + + def "toString call with hierarchy should not throw exceptions :) "(){ + ProfileEvent child1 = new ProfileEvent(name: "test", runtimeInMillis: 10) + ProfileEvent child2 = new ProfileEvent(name: "test", runtimeInMillis: 10) + ProfileEvent event = new ProfileEvent(name: "test", runtimeInMillis: 10) + event.addChild(child1) + event.addChild(child2) + + + when: + event.toString() + then: + event + } + + def "Pretty print long running events - 1,000 ms"() { + expect: + profileEvent.prettyPrint() == result + + where: + profileEvent | result + new ProfileEvent(name: "p", runtimeInMillis: 1000, numOfInvocations: 1) | "|-> p (1) : 1s " + new ProfileEvent(name: "p", runtimeInMillis: 10*1000, numOfInvocations: 1) | "|-> p (1) : 10s " + new ProfileEvent(name: "p", runtimeInMillis: 29999, numOfInvocations: 1) | "|-> p (1) : 29s 999ms" + new ProfileEvent(name: "p", runtimeInMillis: 30*1000, numOfInvocations: 1) | "|-> p (1) : 30s " + new ProfileEvent(name: "p", runtimeInMillis: 60*1000 + 1000, numOfInvocations: 1) | "|-> p (1) : 1m 1s " + new ProfileEvent(name: "p", runtimeInMillis: 59*60*1000 + 59*1000, numOfInvocations: 1) | "|-> p (1) : 59m 59s " + new ProfileEvent(name: "p", runtimeInMillis: 62*60*1000 + 59*1000, numOfInvocations: 1) | "|-> p (1) : 1h 2m 59s " + new ProfileEvent(name: "p", runtimeInMillis: 143*60*1000 + 199, numOfInvocations: 1) | "|-> p (1) : 2h 23m 199ms" + } + + def "serialize should not throw exceptions :) "(){ + ProfileEvent child1 = new ProfileEvent(name: "child1", runtimeInMillis: 10) + ProfileEvent child2 = new ProfileEvent(name: "child2", runtimeInMillis: 10) + ProfileEvent event = new ProfileEvent(name: "test", runtimeInMillis: 10) + event.addChild(child1) + event.addChild(child2) + + ProfileEvent serialized + + when: + ByteArrayOutputStream baos = new ByteArrayOutputStream() + ObjectOutputStream oos = new ObjectOutputStream(baos) + oos.writeObject(event) + oos.close() + + ByteArrayInputStream bais = new ByteArrayInputStream(baos.toByteArray()) + ObjectInputStream ois = new ObjectInputStream(bais) + serialized = ois.readObject() + ois.close() + + then: + serialized + } + + def "demonstrate how much time is unaccounted for within its children"() { + ProfileEvent child1 = new ProfileEvent(name: "child1", runtimeInMillis: 4) + ProfileEvent child2 = new ProfileEvent(name: "child2", runtimeInMillis: 5) + ProfileEvent event = new ProfileEvent(name: "test", runtimeInMillis: 10) + event.addChild(child1) + event.addChild(child2) + + when: + String pretty = event.prettyPrint() + then: + pretty.toString().trim() == ''' +|-> test (0) : 010ms [001ms] +| |-> child2 (0) : 005ms +| |-> child1 (0) : 004ms'''.toString().trim() + } + + def "demonstrate how much time is unaccounted for within its concurrent children"() { + ProfileEvent child1 = new ProfileEvent(name: "child1", runtimeInMillis: 4, isConcurrent: true) + ProfileEvent child2 = new ProfileEvent(name: "child2", runtimeInMillis: 5, isConcurrent: true) + ProfileEvent event = new ProfileEvent(name: "test", runtimeInMillis: 10) + event.addChild(child1) + event.addChild(child2) + + when: + String pretty = event.prettyPrint() + then: + pretty + pretty.toString().trim() == ''' +|-> test (0) : 010ms [005ms] +| ||-> child2 (0) : 005ms +| ||-> child1 (0) : 004ms'''.toString().trim() + } + + def "demonstrate how much time is unaccounted for within its concurrent children and synchronous children"() { + ProfileEvent child1 = new ProfileEvent(name: "child1", runtimeInMillis: 4, isConcurrent: false) + ProfileEvent child2 = new ProfileEvent(name: "child2", runtimeInMillis: 5, isConcurrent: true) + ProfileEvent child3 = new ProfileEvent(name: "child3", runtimeInMillis: 5, isConcurrent: true) + ProfileEvent event = new ProfileEvent(name: "test", runtimeInMillis: 10) + event.addChild(child1) + event.addChild(child2) + event.addChild(child3) + + when: + String pretty = event.prettyPrint() + then: + pretty + pretty.toString().trim() == ''' +|-> test (0) : 010ms [001ms] +| ||-> child2 (0) : 005ms +| ||-> child3 (0) : 005ms +| |-> child1 (0) : 004ms'''.toString().trim() + } + + def "demonstrate how much time is unaccounted for within its concurrent children and several synchronous children"() { + ProfileEvent child1 = new ProfileEvent(name: "child1", runtimeInMillis: 4, isConcurrent: true) + ProfileEvent child2 = new ProfileEvent(name: "child2", runtimeInMillis: 5, isConcurrent: false) + ProfileEvent child3 = new ProfileEvent(name: "child3", runtimeInMillis: 6, isConcurrent: true) + ProfileEvent child4 = new ProfileEvent(name: "child4", runtimeInMillis: 7, isConcurrent: false) + ProfileEvent event = new ProfileEvent(name: "test", runtimeInMillis: 20) + event.addChild(child1) + event.addChild(child2) + event.addChild(child3) + event.addChild(child4) + + when: + String pretty = event.prettyPrint() + then: + pretty + pretty.toString().trim() == ''' +|-> test (0) : 020ms [002ms] +| |-> child4 (0) : 007ms +| |-> child2 (0) : 005ms +| ||-> child3 (0) : 006ms +| ||-> child1 (0) : 004ms'''.toString().trim() + } + + + def "demonstrate how much time is unaccounted for within its remote children"() { + ProfileEvent child1 = new ProfileEvent(name: "child1", runtimeInMillis: 4, isRemote: true) + ProfileEvent child2 = new ProfileEvent(name: "child2", runtimeInMillis: 5, isRemote: true) + ProfileEvent event = new ProfileEvent(name: "test", runtimeInMillis: 10) + event.addChild(child1) + event.addChild(child2) + + when: + String pretty = event.prettyPrint() + then: + pretty + pretty.toString().trim() == ''' +|-> test (0) : 010ms [005ms] +| |||-> child2 (0) : 005ms +| |||-> child1 (0) : 004ms'''.toString().trim() + } +} diff --git a/call-stack-profiler/src/test/java/callStack/utils/ProfThreadPoolSpecification.groovy b/call-stack-profiler/src/test/java/callStack/utils/ProfThreadPoolSpecification.groovy new file mode 100644 index 00000000..43ce60a3 --- /dev/null +++ b/call-stack-profiler/src/test/java/callStack/utils/ProfThreadPoolSpecification.groovy @@ -0,0 +1,264 @@ +/** + * Copyright 2020 SkillTree + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package callStack.utils + +import callStack.profiler.CProf +import callStack.profiler.ProfThreadPool +import callStack.utils.ThreadPoolUtils +import spock.lang.Specification + +import java.util.concurrent.Future + +class ProfThreadPoolSpecification extends Specification { + + + String poolName = "pool" + ProfThreadPool profThreadPool = new ProfThreadPool(poolName, 2, 5) + def setup() { + CProf.clear() + } + + def "Thread pool usage where underlying exec does NOT name events"() { + List res + when: + CProf.prof("l1") { + res = profThreadPool.asyncExec([ + ThreadPoolUtils.callable { return "1" }, + ThreadPoolUtils.callable { return "2" } + ]) + } + + then: + res + res.size() == 2 + res.contains("1") + res.contains("2") + CProf.rootEvent.name == "l1" + CProf.rootEvent.children.size() == 2 + CProf.rootEvent.children.collect({it.name}).sort() == ["$poolName-1", "$poolName-2"] + } + + + + def "Thread pool allows to assign unique name to each event"() { + ProfThreadPool profThreadPool = new ProfThreadPool(poolName, 2, 5) + profThreadPool.assignUniqueNameToEachRootEvent = true + + List res + when: + CProf.prof("l1") { + res = profThreadPool.asyncExec([ + ThreadPoolUtils.callable { return "1" }, + ThreadPoolUtils.callable { return "2" } + ]) + } + + println CProf.prettyPrint() + + then: + res + res.size() == 2 + res.contains("1") + res.contains("2") + CProf.rootEvent.name == "l1" + CProf.rootEvent.children.size() == 2 + List names = CProf.rootEvent.children.collect({it.name}).sort() + names.first().startsWith("$poolName-1") + names.last().startsWith("$poolName-2") + } + + + def "Threadpool shouldn't fail if there is not profile event on the parent thread"() { + List res + when: + res = profThreadPool.asyncExec([ + ThreadPoolUtils.callable { return "1" }, + ThreadPoolUtils.callable { return "2" } + ]) + then: + res + res.size() == 2 + res.contains("1") + res.contains("2") + !CProf.rootEvent + } + + + def "Thread pool usage where underlying exec name events"() { + List res + when: + CProf.prof("l1") { + res = profThreadPool.asyncExec([ + ThreadPoolUtils.callable { CProf.prof("1") {}; return "1" }, + ThreadPoolUtils.callable { CProf.prof("2") {}; return "2" } + ]) + } + then: + res + res.size() == 2 + res.contains("1") + res.contains("2") +// println CProf.rootEvent.prettyPrint() + CProf.rootEvent.name == "l1" + CProf.rootEvent.children.size() == 2 + List names = CProf.rootEvent.children.collect({ it.name }).sort() + names.find({ it.startsWith("1-pool") }) + names.find({ it.startsWith("2-pool") }) + } + + def "Thread pool usage in multi-level call stack"() { + List res + when: + CProf.prof("l1") { + CProf.prof("l2") { + res = profThreadPool.asyncExec([ + ThreadPoolUtils.callable { CProf.prof("l3") { CProf.prof("l4") { CProf.prof("l5") {} } }; return "1" }, + ThreadPoolUtils.callable { CProf.prof("l3") { CProf.prof("l4") {} }; return "2" } + ]) + } + } + then: +// println CProf.rootEvent.prettyPrint() + res + res.size() == 2 + res.contains("1") + res.contains("2") + + CProf.rootEvent.name == "l1" + CProf.rootEvent.children.size() == 1 + CProf.rootEvent.children.first().name == "l2" + CProf.rootEvent.children.first().children.size() == 2 + CProf.rootEvent.children.first().children.find({ it.name == "l3-pool-1" }) + CProf.rootEvent.children.first().children.find({ it.name == "l3-pool-1" }).children.size() == 1 + CProf.rootEvent.children.first().children.find({ it.name == "l3-pool-1" }).children.first().name == "l4" + CProf.rootEvent.children.first().children.find({ it.name == "l3-pool-1" }).children.first().children.size() == 1 + CProf.rootEvent.children.first().children.find({ it.name == "l3-pool-1" }).children.first().children.first().name == "l5" + !CProf.rootEvent.children.first().children.find({ it.name == "l3-pool-1" }).children.first().children.first().children + + CProf.rootEvent.children.first().children.find({ it.name == "l3-pool-2" }) + CProf.rootEvent.children.first().children.find({ it.name == "l3-pool-2" }).children.size() == 1 + CProf.rootEvent.children.first().children.find({ it.name == "l3-pool-2" }).children.first().name == "l4" + !CProf.rootEvent.children.first().children.find({ it.name == "l3-pool-2" }).children.first().children + } + + def "can use futures with the pool"() { + List res = [] + when: + CProf.prof("l1") { + Future futureRes = profThreadPool.submit(ThreadPoolUtils.callable { return "1" }) + Future futureRes1 = profThreadPool.submit(ThreadPoolUtils.callable { return "2" }) + + res.add(futureRes.get()) + res.add(futureRes1.get()) + } + println CProf.rootEvent.prettyPrint() + then: + res + res.size() == 2 + res.sort() == ["1", "2"] + CProf.rootEvent.name == "l1" + CProf.rootEvent.children.size() == 2 + } + + def "Thread pool usage in multi-level call stack via futures"() { + List res = [] + when: + CProf.prof("l1") { + CProf.prof("l2") { + Future f1 = profThreadPool.submit(ThreadPoolUtils.callable { CProf.prof("l3") { CProf.prof("l4") { CProf.prof("l5") {} } }; return "1" }) + Future f2 = profThreadPool.submit( ThreadPoolUtils.callable { CProf.prof("l3") { CProf.prof("l4") {} }; return "2" }) + res.add(f1.get()) + res.add(f2.get()) + } + } + then: + println CProf.rootEvent.prettyPrint() + res + res.size() == 2 + res.contains("1") + res.contains("2") + + CProf.rootEvent.name == "l1" + CProf.rootEvent.children.size() == 1 + CProf.rootEvent.children.first().name == "l2" + CProf.rootEvent.children.first().children.size() == 2 + CProf.rootEvent.children.first().children.find({ it.name == "l3-pool-1" }) + CProf.rootEvent.children.first().children.find({ it.name == "l3-pool-1" }).children.size() == 1 + CProf.rootEvent.children.first().children.find({ it.name == "l3-pool-1" }).children.first().name == "l4" + CProf.rootEvent.children.first().children.find({ it.name == "l3-pool-1" }).children.first().children.size() == 1 + CProf.rootEvent.children.first().children.find({ it.name == "l3-pool-1" }).children.first().children.first().name == "l5" + !CProf.rootEvent.children.first().children.find({ it.name == "l3-pool-1" }).children.first().children.first().children + + CProf.rootEvent.children.first().children.find({ it.name == "l3-pool-2" }) + CProf.rootEvent.children.first().children.find({ it.name == "l3-pool-2" }).children.size() == 1 + CProf.rootEvent.children.first().children.find({ it.name == "l3-pool-2" }).children.first().name == "l4" + !CProf.rootEvent.children.first().children.find({ it.name == "l3-pool-2" }).children.first().children + } + + + def "Warn when usage reaches high percentage"() { + ProfThreadPool threadPool = new ProfThreadPool(poolName, 5, 5) + List futures = [] + when: + (0..4).each { + futures.add(threadPool.submit(ThreadPoolUtils.callable { (0..2).each{Thread.sleep(500)} })) + } + + + (0..2).each { + threadPool.asyncExec([ThreadPoolUtils.callable { Thread.sleep(500) }]) + } + + futures.each { + it.get() + } + then: + true + + // nothing go validate, look for warn messages + } + + + def "Do not warn after the pool went below threshold"() { + ProfThreadPool threadPool = new ProfThreadPool(poolName, 5) + List futures = [] + when: + futures.add(threadPool.submit(ThreadPoolUtils.callable { (0..2).each{Thread.sleep(500)} })) + futures.add(threadPool.submit(ThreadPoolUtils.callable { (0..2).each{Thread.sleep(500)} })) + futures.add(threadPool.submit(ThreadPoolUtils.callable { (0..2).each{Thread.sleep(500)} })) + futures.add(threadPool.submit(ThreadPoolUtils.callable { (0..2).each{Thread.sleep(500)} })) + futures.add(threadPool.submit(ThreadPoolUtils.callable { (0..2).each{Thread.sleep(500)} })) + futures.add(threadPool.submit(ThreadPoolUtils.callable { (0..2).each{Thread.sleep(500)} })) + + futures.each { + it.get() + } + futures.clear() + + futures.add(threadPool.submit(ThreadPoolUtils.callable { (0..2).each{Thread.sleep(500)} })) + futures.add(threadPool.submit(ThreadPoolUtils.callable { (0..2).each{Thread.sleep(500)} })) + futures.each { + it.get() + } + + then: + true + + // nothing go validate, look for warn messages + } + +} + diff --git a/call-stack-profiler/src/test/resources/logback.xml b/call-stack-profiler/src/test/resources/logback.xml new file mode 100644 index 00000000..9df180f4 --- /dev/null +++ b/call-stack-profiler/src/test/resources/logback.xml @@ -0,0 +1,12 @@ + + + + + %d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n + + + + + + + diff --git a/ci/installNode.sh b/ci/installNode.sh deleted file mode 100755 index 444e913a..00000000 --- a/ci/installNode.sh +++ /dev/null @@ -1,23 +0,0 @@ -# Copyright 2020 SkillTree -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# https://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#!/usr/bin/env bash - -cat /etc/os-release -apt-get update -apt-get install -y build-essential -curl -sL https://deb.nodesource.com/setup_12.x | bash - -apt-get install -y nodejs -nodejs -v -npm -v - diff --git a/ci/setupRepos.sh b/ci/setupRepos.sh deleted file mode 100755 index 9705916a..00000000 --- a/ci/setupRepos.sh +++ /dev/null @@ -1,20 +0,0 @@ -# Copyright 2020 SkillTree -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# https://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#!/usr/bin/env bash - -echo "@skills:registry=http://$NEXUS_SERVER/repository/skills-registry/" > ~/.npmrc -cat ~/.npmrc -echo "centralcentralhttp://$NEXUS_SERVER/repository/maven-public/*" > ~/.m2/settings.xml -cat ~/.m2/settings.xml - diff --git a/client-display/.eslintrc.js b/client-display/.eslintrc.js index 71318378..33872dfa 100644 --- a/client-display/.eslintrc.js +++ b/client-display/.eslintrc.js @@ -1,30 +1,91 @@ +// https://eslint.org/docs/user-guide/configuring + module.exports = { root: true, + + parserOptions: { + parser: 'babel-eslint', + }, + env: { + browser: true, node: true, }, - extends: [ - 'plugin:vue/essential', - '@vue/airbnb', + + // https://github.com/vuejs/eslint-plugin-vue#priority-a-essential-error-prevention + // consider switching to `plugin:vue/strongly-recommended` or `plugin:vue/recommended` for stricter rules. + extends: ['plugin:vue/essential', '@vue/airbnb'], + + // required to lint *.vue files + plugins: [ + 'vue', ], + + settings: { + 'import/resolver': { + webpack: { + config: require.resolve('@vue/cli-service/webpack.config.js'), + }, + }, + }, + + // check if imports actually resolve + // add your custom rules here rules: { - 'no-console': process.env.NODE_ENV === 'production' ? 'error' : 'off', + 'import/extensions': [ + 'error', + 'always', + { + js: 'never', + vue: 'never', + }, + ], + 'no-param-reassign': [ + 'error', + { + props: true, + ignorePropertyModificationsFor: [ + 'state', + 'acc', + 'e', + ], + }, + ], + 'import/no-extraneous-dependencies': [ + 'error', + { + optionalDependencies: [ + 'test/unit/index.js', + ], + }, + ], 'no-debugger': process.env.NODE_ENV === 'production' ? 'error' : 'off', - 'indent': ['error', 2], - 'max-len': ['error', { 'code': 300 }], - 'no-underscore-dangle': 0, - 'no-new': 0, - 'vue/script-indent': 0, // I have to disable this for now. It makes your newline then blocks look real dumb - }, - 'overrides': [ - { - 'files': ['*.vue'], - 'rules': { - 'indent': 'off' - } - } - ], - parserOptions: { - parser: 'babel-eslint', + indent: 'off', + 'vue/script-indent': [ + 'error', + 2, + { + baseIndent: 1, + switchCase: 0, + ignores: [], + }, + ], + 'vue/max-attributes-per-line': [ + 2, + { + singleline: 5, + multiline: { + max: 5, + allowFirstLine: true, + }, + }, + ], + 'max-len': [ + 'error', + { + code: 300, + }, + ], + 'no-console': process.env.NODE_ENV === 'production' ? 'error' : 'off', }, }; diff --git a/client-display/package.json b/client-display/package.json index 829fb72c..2a47d041 100644 --- a/client-display/package.json +++ b/client-display/package.json @@ -1,7 +1,7 @@ { - "name": "@skills/user-skills", + "name": "@skilltree/skills-client-display", "main": "./dist/userSkills.common.js", - "version": "0.0.6", + "version": "1.0.0", "license": "Apache-2.0", "description": "SkillTree Client Display UI", "author": "SkillTree Team", @@ -11,56 +11,58 @@ "licenseHeaderCheck": "license-check-and-add check -f '../license-add/license-add-config.json'", "licenseHeaderAdd": "license-check-and-add add -f ../license-add/license-add-config.json", "licenseCheck": "npm run licenseHeaderCheck && npm run licenseDepCheck", - "build": "npm run licenseCheck && vue-cli-service build", + "build": "npm run licenseCheck && npm run test:unit && vue-cli-service build", "build-lib": "NODE_ENV='production' && rm -rfv dist && vue-cli-service build --target lib --name userSkills './src/index.js'", "deploy": "npm run build && rm -rf ../backend/src/main/resources/public/static/clientPortal && cp -rT dist ../backend/src/main/resources/public/static/clientPortal && cp -rT dist ../backend/target/classes/public/static/clientPortal ", "lint": "vue-cli-service lint", "test:unit": "vue-cli-service test:unit" }, "dependencies": { - "@fortawesome/fontawesome-free": "5.11.2", - "animate.css": "3.7.2", - "apexcharts": "3.8.6", - "axios": "0.19.0", - "axios-auth-refresh": "1.0.7", - "bootstrap": "4.3.1", - "lodash": "4.17.15", - "marked": "0.7.0", + "@fortawesome/fontawesome-free": "5.14.0", + "animate.css": "4.1.1", + "apexcharts": "3.20.2", + "axios": "0.20.0", + "axios-auth-refresh": "3.0.0", + "bootstrap": "4.5.2", + "dompurify": "2.0.15", + "lodash": "4.17.20", + "marked": "1.1.1", "material-icons": "0.3.1", + "node-emoji": "1.10.0", "numeral": "2.0.6", - "postmate": "1.5.1", + "postmate": "1.5.2", "q": "1.5.1", "tinycolor2": "1.4.1", - "url-search-params-polyfill": "7.0.0", + "url-search-params-polyfill": "8.1.0", "vis": "4.21.0", - "vue": "2.6.10", - "vue-apexcharts": "1.5.0", - "vue-js-toggle-button": "1.3.2", - "vue-moment": "4.0.0", - "vue-radial-progress": "0.2.10", - "vue-router": "3.0.6", - "vue-simple-progress": "1.1.0", - "vue-simple-spinner": "1.2.8", - "vuex": "3.1.1", - "dompurify": "2.0.3" + "vue": "2.6.12", + "vue-apexcharts": "1.6.0", + "vue-js-toggle-button": "1.3.3", + "vue-moment": "4.1.0", + "vue-radial-progress": "0.3.2", + "vue-router": "3.4.3", + "vue-simple-progress": "1.1.1", + "vue-simple-spinner": "1.2.10", + "vuex": "3.5.1" }, "devDependencies": { - "@vue/cli-plugin-babel": "4.1.0", - "@vue/cli-plugin-eslint": "4.1.0", - "@vue/cli-plugin-unit-jest": "4.1.0", - "@vue/cli-service": "4.1.0", - "@vue/eslint-config-airbnb": "4.0.1", - "@vue/test-utils": "1.0.0-beta.29", - "babel-core": "7.0.0-bridge.0", - "babel-eslint": "10.0.3", - "babel-jest": "24.9.0", - "eslint": "5.16.0", - "eslint-plugin-vue": "5.0.0", + "@babel/core": "7.11.6", + "@vue/cli-plugin-babel": "4.5.6", + "@vue/cli-plugin-eslint": "4.5.6", + "@vue/cli-plugin-unit-jest": "4.5.6", + "@vue/cli-service": "4.5.6", + "@vue/eslint-config-airbnb": "5.1.0", + "@vue/test-utils": "1.1.0", + "babel-eslint": "10.1.0", + "babel-jest": "26.3.0", + "eslint": "7.8.1", + "eslint-plugin-vue": "6.2.2", "license-check-and-add": "3.0.4", "license-checker": "25.0.1", - "node-sass": "4.12.0", - "sass-loader": "8.0.0", - "vue-template-compiler": "2.6.10" + "moment-timezone": "0.5.31", + "node-sass": "4.14.1", + "sass-loader": "10.0.2", + "vue-template-compiler": "2.6.12" }, "peerDependencies": { "font-awesome": "4.7.0" diff --git a/client-display/pom.xml b/client-display/pom.xml index ae5d5fba..46806899 100644 --- a/client-display/pom.xml +++ b/client-display/pom.xml @@ -3,9 +3,9 @@ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> - skills-service - skills - 1.1.4-SNAPSHOT + skills-service-parent + skill-tree + 1.3.0-SNAPSHOT 4.0.0 diff --git a/client-display/src/App.vue b/client-display/src/App.vue index 4c396995..088c9cd8 100644 --- a/client-display/src/App.vue +++ b/client-display/src/App.vue @@ -31,8 +31,8 @@ limitations under the License. import UserSkillsService from '@/userSkills/service/UserSkillsService'; import store from '@/store'; - import NewSoftwareVersionComponent from '@/common/softwareVersion/NewSoftwareVersion.vue'; - import DevModeMixin from '@/dev/DevModeMixin.vue'; + import NewSoftwareVersionComponent from '@/common/softwareVersion/NewSoftwareVersion'; + import DevModeMixin from '@/dev/DevModeMixin'; import ThemeHelper from './common/theme/ThemeHelper'; const getDocumentHeight = () => { diff --git a/client-display/src/SkillsEntry.vue b/client-display/src/SkillsEntry.vue index bb43b195..2fca49b8 100644 --- a/client-display/src/SkillsEntry.vue +++ b/client-display/src/SkillsEntry.vue @@ -23,7 +23,7 @@ limitations under the License. diff --git a/client-display/src/common/utilities/NoDataYet.vue b/client-display/src/common/utilities/NoDataYet.vue index d4703b86..58749b35 100644 --- a/client-display/src/common/utilities/NoDataYet.vue +++ b/client-display/src/common/utilities/NoDataYet.vue @@ -34,13 +34,13 @@ limitations under the License. - - diff --git a/client-display/src/userSkills/SkillDisplayDataLoadingMixin.vue b/client-display/src/userSkills/SkillDisplayDataLoadingMixin.vue index 5ca2911e..b4f14272 100644 --- a/client-display/src/userSkills/SkillDisplayDataLoadingMixin.vue +++ b/client-display/src/userSkills/SkillDisplayDataLoadingMixin.vue @@ -14,61 +14,52 @@ See the License for the specific language governing permissions and limitations under the License. */ diff --git a/client-display/src/userSkills/badge/ProjectLevelRow.vue b/client-display/src/userSkills/badge/ProjectLevelRow.vue index 83dcc812..50cec845 100644 --- a/client-display/src/userSkills/badge/ProjectLevelRow.vue +++ b/client-display/src/userSkills/badge/ProjectLevelRow.vue @@ -49,7 +49,7 @@ limitations under the License. diff --git a/client-display/src/userSkills/pointProgress/PointProgressChart.vue b/client-display/src/userSkills/pointProgress/PointProgressChart.vue new file mode 100644 index 00000000..df281046 --- /dev/null +++ b/client-display/src/userSkills/pointProgress/PointProgressChart.vue @@ -0,0 +1,263 @@ +/* +Copyright 2020 SkillTree + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + https://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ + + + + + + + diff --git a/client-display/src/userSkills/pointProgress/PointProgressHelper.js b/client-display/src/userSkills/pointProgress/PointProgressHelper.js new file mode 100644 index 00000000..d54d821a --- /dev/null +++ b/client-display/src/userSkills/pointProgress/PointProgressHelper.js @@ -0,0 +1,52 @@ +/* + * Copyright 2020 SkillTree + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +export default { + calculateXAxisMaxTimestamp(histResult) { + // only perform this calculation if there are at least 2 months of points + if (!histResult || !histResult.pointsHistory || histResult.pointsHistory.length < 60) { + return null; + } + const pointHistory = histResult.pointsHistory; + const maxAchievedTimeStamp = this.getMaxAchievedTimestamp(histResult); + + // start at the end + let resPosition = pointHistory.length - 1; + const maxPoints = pointHistory[resPosition].points; + + // tolerate 2% of point gained + const pointsThreshold = Math.trunc(maxPoints * 0.98); + for (let i = resPosition; i > 30; i -= 1) { + resPosition = i; + const pointsToCompare = pointHistory[i].points; + if (pointsThreshold > pointsToCompare) { + break; + } + } + let maxTimestampRes = new Date(pointHistory[resPosition].dayPerformed).getTime(); + if (maxAchievedTimeStamp) { + maxTimestampRes = Math.max(maxTimestampRes, maxAchievedTimeStamp); + } + return maxTimestampRes; + }, + getMaxAchievedTimestamp(histResult) { + let maxAchievedTimeStamp = -1; + if (histResult.achievements && histResult.achievements.length > 0) { + const timestamps = histResult.achievements.map((item) => new Date(item.achievedOn).getTime()); + maxAchievedTimeStamp = Math.max(...timestamps); + } + return maxAchievedTimeStamp; + }, +}; diff --git a/client-display/src/userSkills/service/TokenReauthorizer.js b/client-display/src/userSkills/service/TokenReauthorizer.js index c78e8e13..633934c3 100644 --- a/client-display/src/userSkills/service/TokenReauthorizer.js +++ b/client-display/src/userSkills/service/TokenReauthorizer.js @@ -21,7 +21,6 @@ import store from '@/store'; // eslint-disable-next-line let service = {}; - const refreshAuthorization = (failedRequest) => { if (store.state.authToken === 'pki') { router.push({ @@ -66,7 +65,7 @@ const getErrorMsg = (errorResponse) => { return response; }; -axios.interceptors.response.use(response => response, (error) => { +axios.interceptors.response.use((response) => response, (error) => { if (!error || !error.response || (error.response && error.response.status !== 401)) { const errorMessage = getErrorMsg(error); router.push({ @@ -84,7 +83,7 @@ service = { if (!store.state.isAuthenticating) { store.commit('isAuthenticating', true); if (process.env.NODE_ENV === 'development') { - this.authenticatingPromise = axios.get(store.state.authenticator); + this.authenticatingPromise = axios.get(store.state.authenticator); } else { store.state.parentFrame.emit('needs-authentication'); this.authenticatingPromise = new Promise((resolve) => { diff --git a/client-display/src/userSkills/service/UserSkillsService.js b/client-display/src/userSkills/service/UserSkillsService.js index 18b8cb05..a103209d 100644 --- a/client-display/src/userSkills/service/UserSkillsService.js +++ b/client-display/src/userSkills/service/UserSkillsService.js @@ -53,34 +53,34 @@ export default { let response = null; response = axios.get(`${store.state.serviceUrl}${this.getServicePath()}/${store.state.projectId}/summary`, { params: this.getUserIdAndVersionParams(), - }).then(result => result.data); + }).then((result) => result.data); return response; }, getCustomIconCss() { let response = null; response = axios.get(`${store.state.serviceUrl}${this.getServicePath()}/${store.state.projectId}/customIconCss`, { - }).then(result => result.data); + }).then((result) => result.data); return response; }, getCustomGlobalIconCss() { let response = null; response = axios.get(`${store.state.serviceUrl}/api/icons/customIconCss`, { - }).then(result => result.data); + }).then((result) => result.data); return response; }, getSubjectSummary(subjectId) { return axios.get(`${store.state.serviceUrl}${this.getServicePath()}/${store.state.projectId}/subjects/${subjectId}/summary`, { params: this.getUserIdAndVersionParams(), - }).then(result => result.data); + }).then((result) => result.data); }, getSkillDependencies(skillId) { return axios.get(`${store.state.serviceUrl}${this.getServicePath()}/${store.state.projectId}/skills/${skillId}/dependencies`, { params: this.getUserIdParams(), - }).then(result => result.data); + }).then((result) => result.data); }, getSkillSummary(skillId, optionalCrossProjectId) { @@ -91,7 +91,7 @@ export default { return axios.get(url, { params: this.getUserIdParams(), withCredentials: true, - }).then(result => result.data); + }).then((result) => result.data); }, getBadgeSkills(badgeId, global) { @@ -99,13 +99,13 @@ export default { requestParams.global = global; return axios.get(`${store.state.serviceUrl}${this.getServicePath()}/${store.state.projectId}/badges/${badgeId}/summary`, { params: requestParams, - }).then(result => result.data); + }).then((result) => result.data); }, getBadgeSummaries() { return axios.get(`${store.state.serviceUrl}${this.getServicePath()}/${store.state.projectId}/badges/summary`, { params: this.getUserIdAndVersionParams(), - }).then(result => result.data); + }).then((result) => result.data); }, getPointsHistory(subjectId) { @@ -116,7 +116,7 @@ export default { } response = axios.get(url, { params: this.getUserIdAndVersionParams(), - }).then(result => result.data.pointsHistory); + }).then((result) => result.data); return response; }, @@ -124,7 +124,7 @@ export default { let response = null; response = axios.get(`${store.state.serviceUrl}${this.getServicePath()}/${store.state.projectId}/addSkill/${userSkillId}`, { params: this.getUserIdParams(), - }).then(result => result.data); + }).then((result) => result.data); return response; }, @@ -136,7 +136,7 @@ export default { } response = axios.get(url, { params: this.getUserIdParams(), - }).then(result => result.data); + }).then((result) => result.data); return response; }, @@ -150,7 +150,7 @@ export default { requestParams.subjectId = subjectId; response = axios.get(url, { params: requestParams, - }).then(result => result.data); + }).then((result) => result.data); return response; }, @@ -164,7 +164,7 @@ export default { params: { subjectId, }, - }).then(result => result.data); + }).then((result) => result.data); return response; }, @@ -178,7 +178,7 @@ export default { version: this.version, global: type === 'global-badge', }, - }).then(result => result.data); + }).then((result) => result.data); return response; }, diff --git a/client-display/src/userSkills/skill/AchievementDate.vue b/client-display/src/userSkills/skill/AchievementDate.vue new file mode 100644 index 00000000..872420fc --- /dev/null +++ b/client-display/src/userSkills/skill/AchievementDate.vue @@ -0,0 +1,39 @@ +/* +Copyright 2020 SkillTree + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + https://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ + + + + + diff --git a/client-display/src/userSkills/skill/PartialPointsAlert.vue b/client-display/src/userSkills/skill/PartialPointsAlert.vue new file mode 100644 index 00000000..2963d434 --- /dev/null +++ b/client-display/src/userSkills/skill/PartialPointsAlert.vue @@ -0,0 +1,54 @@ +/* +Copyright 2020 SkillTree + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + https://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ + + + + + diff --git a/client-display/src/userSkills/skill/SkillDetails.vue b/client-display/src/userSkills/skill/SkillDetails.vue index 22f33603..449479d3 100644 --- a/client-display/src/userSkills/skill/SkillDetails.vue +++ b/client-display/src/userSkills/skill/SkillDetails.vue @@ -28,69 +28,69 @@ limitations under the License. - +
diff --git a/dashboard/public/skilltree.ico b/dashboard/public/skilltree.ico new file mode 100644 index 00000000..06274270 Binary files /dev/null and b/dashboard/public/skilltree.ico differ diff --git a/dashboard/public/static/img/skilltree_logo.png b/dashboard/public/static/img/skilltree_logo.png new file mode 100644 index 00000000..5a5b7ac0 Binary files /dev/null and b/dashboard/public/static/img/skilltree_logo.png differ diff --git a/dashboard/public/static/img/skilltree_logo_v1.png b/dashboard/public/static/img/skilltree_logo_v1.png new file mode 100644 index 00000000..df0c1007 Binary files /dev/null and b/dashboard/public/static/img/skilltree_logo_v1.png differ diff --git a/frontend/src/App.vue b/dashboard/src/App.vue similarity index 71% rename from frontend/src/App.vue rename to dashboard/src/App.vue index 15f158d3..8e80474f 100644 --- a/frontend/src/App.vue +++ b/dashboard/src/App.vue @@ -14,21 +14,26 @@ See the License for the specific language governing permissions and limitations under the License. */ @@ -42,16 +47,20 @@ limitations under the License. import InceptionConfigurer from './InceptionConfigurer'; import InceptionProgressMessagesMixin from './components/inception/InceptionProgressMessagesMixin'; import NewSoftwareVersionComponent from './components/header/NewSoftwareVersion'; + import PkiAppBootstrap from '@//components/access/PkiAppBootstrap'; + import DashboardFooter from './components/header/DashboardFooter'; export default { name: 'App', mixins: [InceptionProgressMessagesMixin], components: { + DashboardFooter, NewSoftwareVersionComponent, CustomizableFooter, CustomizableHeader, HeaderView, LoadingContainer, + PkiAppBootstrap, }, data() { return { @@ -69,6 +78,9 @@ limitations under the License. userInfo() { return this.$store.getters.userInfo; }, + isPkiAndNeedsToBootstrap() { + return this.$store.getters.isPkiAuthenticated && this.$store.getters.config.needToBootstrap; + }, }, created() { if (this.isAuthenticatedUser) { @@ -76,6 +88,7 @@ limitations under the License. this.isSupervisor = result; this.addCustomIconCSS(); }); + this.$store.dispatch('access/isRoot'); } }, mounted() { @@ -93,6 +106,7 @@ limitations under the License. this.isSupervisor = result; }); this.addCustomIconCSS(); + this.$store.dispatch('access/isRoot'); } }, userInfo(newUserInfo) { @@ -109,10 +123,14 @@ limitations under the License. }; - diff --git a/frontend/src/components/access/AccessService.js b/dashboard/src/components/access/AccessService.js similarity index 67% rename from frontend/src/components/access/AccessService.js rename to dashboard/src/components/access/AccessService.js index 224a8cef..52a866c5 100644 --- a/frontend/src/components/access/AccessService.js +++ b/dashboard/src/components/access/AccessService.js @@ -19,11 +19,11 @@ export default { getUserRoles(projectId, roleName) { if (projectId) { return axios.get(`/admin/projects/${projectId}/userRoles`) - .then(response => response.data); + .then((response) => response.data); } if (roleName === 'ROLE_SUPER_DUPER_USER' || roleName === 'ROLE_SUPERVISOR') { return axios.get(`/root/users/roles/${roleName}`) - .then(response => response.data); + .then((response) => response.data); } throw new Error(`unexpected user role [${roleName}]`); }, @@ -36,14 +36,14 @@ export default { userId = userKey; } if (projectId) { - return axios.put(`/admin/projects/${projectId}/users/${userKey}/roles/${roleName}`, null, { headers: { 'x-handleError': false } }) + return axios.put(`/admin/projects/${projectId}/users/${userKey}/roles/${roleName}`, null, { handleError: false }) .then(() => axios.get(`/admin/projects/${projectId}/users/${userId}/roles`) - .then(response => response.data.find(element => element.roleName === roleName))); + .then((response) => response.data.find((element) => element.roleName === roleName))); } if (roleName === 'ROLE_SUPER_DUPER_USER' || roleName === 'ROLE_SUPERVISOR') { - return axios.put(`/root/users/${userKey}/roles/${roleName}`, null, { headers: { 'x-handleError': false } }) + return axios.put(`/root/users/${userKey}/roles/${roleName}`, null, { handleError: false }) .then(() => axios.get(`/root/users/roles/${roleName}`) - .then(response => response.data.find(element => element.userIdForDisplay.toLowerCase() === origUserId.toLowerCase()))); + .then((response) => response.data.find((element) => element.userIdForDisplay.toLowerCase() === origUserId.toLowerCase()))); } throw new Error(`unexpected user role [${roleName}]`); }, @@ -52,13 +52,13 @@ export default { return axios.delete(`/admin/projects/${projectId}/users/${userId}/roles/${encodeURIComponent(roleName)}`); } if (roleName === 'ROLE_SUPER_DUPER_USER' || roleName === 'ROLE_SUPERVISOR') { - return axios.delete(`/root/users/${userId}/roles/${roleName}`).then(response => response.data); + return axios.delete(`/root/users/${userId}/roles/${roleName}`).then((response) => response.data); } throw new Error(`unexpected user role [${roleName}]`); }, getOAuthProviders() { return axios.get('/app/oAuthProviders') - .then(response => response.data); + .then((response) => response.data); }, resetClientSecret(projectId) { return axios.put(`/admin/projects/${projectId}/resetClientSecret`) @@ -66,12 +66,23 @@ export default { }, getClientSecret(projectId) { return axios.get(`/admin/projects/${projectId}/clientSecret`) - .then(response => response.data); + .then((response) => response.data); }, userWithEmailExists(email) { - return axios.get(`/userExists/${email}`).then(response => !response.data); + return axios.get(`/userExists/${email}`).then((response) => !response.data); }, hasRole(roleName) { - return axios.get(`/app/userInfo/hasRole/${roleName}`).then(response => response.data); + return axios.get(`/app/userInfo/hasRole/${roleName}`).then((response) => response.data); + }, + requestPasswordReset(userId) { + const formData = new FormData(); + formData.append('userId', userId); + return axios.post('/resetPassword', formData, { handleError: false }).then((response) => response.data); + }, + resetPassword(reset) { + return axios.post('/performPasswordReset', reset, { handleError: false }).then((response) => response.data); + }, + isResetSupported() { + return axios.get('/public/isFeatureSupported?feature=passwordreset').then((response) => response.data); }, }; diff --git a/frontend/src/components/access/AccessSettings.vue b/dashboard/src/components/access/AccessSettings.vue similarity index 100% rename from frontend/src/components/access/AccessSettings.vue rename to dashboard/src/components/access/AccessSettings.vue diff --git a/dashboard/src/components/access/BootstrapService.js b/dashboard/src/components/access/BootstrapService.js new file mode 100644 index 00000000..9ff9326a --- /dev/null +++ b/dashboard/src/components/access/BootstrapService.js @@ -0,0 +1,22 @@ +/* + * Copyright 2020 SkillTree + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +import axios from 'axios'; + +export default { + grantRoot() { + return axios.post('/grantFirstRoot').then((response) => response.data); + }, +}; diff --git a/dashboard/src/components/access/Login.vue b/dashboard/src/components/access/Login.vue new file mode 100644 index 00000000..623ebec7 --- /dev/null +++ b/dashboard/src/components/access/Login.vue @@ -0,0 +1,218 @@ +/* +Copyright 2020 SkillTree + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + https://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ + + + + + diff --git a/dashboard/src/components/access/PkiAppBootstrap.vue b/dashboard/src/components/access/PkiAppBootstrap.vue new file mode 100644 index 00000000..9f44e243 --- /dev/null +++ b/dashboard/src/components/access/PkiAppBootstrap.vue @@ -0,0 +1,69 @@ +/* +Copyright 2020 SkillTree + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + https://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ + + + + + diff --git a/dashboard/src/components/access/RequestAccess.vue b/dashboard/src/components/access/RequestAccess.vue new file mode 100644 index 00000000..56bd22b8 --- /dev/null +++ b/dashboard/src/components/access/RequestAccess.vue @@ -0,0 +1,184 @@ +/* +Copyright 2020 SkillTree + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + https://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ + + + + + diff --git a/dashboard/src/components/access/RequestPasswordReset.vue b/dashboard/src/components/access/RequestPasswordReset.vue new file mode 100644 index 00000000..02da7341 --- /dev/null +++ b/dashboard/src/components/access/RequestPasswordReset.vue @@ -0,0 +1,144 @@ +/* +Copyright 2020 SkillTree + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + https://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ + + + + + diff --git a/dashboard/src/components/access/RequestResetConfirmation.vue b/dashboard/src/components/access/RequestResetConfirmation.vue new file mode 100644 index 00000000..04f8dd21 --- /dev/null +++ b/dashboard/src/components/access/RequestResetConfirmation.vue @@ -0,0 +1,65 @@ +/* +Copyright 2020 SkillTree + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + https://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ + + + diff --git a/dashboard/src/components/access/ResetConfirmation.vue b/dashboard/src/components/access/ResetConfirmation.vue new file mode 100644 index 00000000..4d3ae119 --- /dev/null +++ b/dashboard/src/components/access/ResetConfirmation.vue @@ -0,0 +1,65 @@ +/* +Copyright 2020 SkillTree + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + https://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ + + + diff --git a/dashboard/src/components/access/ResetNotSupportedPage.vue b/dashboard/src/components/access/ResetNotSupportedPage.vue new file mode 100644 index 00000000..631090fb --- /dev/null +++ b/dashboard/src/components/access/ResetNotSupportedPage.vue @@ -0,0 +1,42 @@ +/* +Copyright 2020 SkillTree + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + https://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ + + + diff --git a/dashboard/src/components/access/ResetPassword.vue b/dashboard/src/components/access/ResetPassword.vue new file mode 100644 index 00000000..d2acebba --- /dev/null +++ b/dashboard/src/components/access/ResetPassword.vue @@ -0,0 +1,148 @@ +/* +Copyright 2020 SkillTree + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + https://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ + + + + + diff --git a/frontend/src/components/access/RoleManager.vue b/dashboard/src/components/access/RoleManager.vue similarity index 93% rename from frontend/src/components/access/RoleManager.vue rename to dashboard/src/components/access/RoleManager.vue index e5718b4f..afb7b5b7 100644 --- a/frontend/src/components/access/RoleManager.vue +++ b/dashboard/src/components/access/RoleManager.vue @@ -21,14 +21,15 @@ limitations under the License. v-model="selectedUser"/>
- Add
- + Error! Request could not be completed! {{ errNotification.msg }} @@ -79,7 +80,7 @@ limitations under the License. role: { type: String, default: 'ROLE_PROJECT_ADMIN', - validator: value => ([ROLE_APP_USER, ROLE_PROJECT_ADMIN, ROLE_SUPERVISOR, ROLE_SUPER_DUPER_USER].indexOf(value) >= 0), + validator: (value) => ([ROLE_APP_USER, ROLE_PROJECT_ADMIN, ROLE_SUPERVISOR, ROLE_SUPER_DUPER_USER].indexOf(value) >= 0), }, roleDescription: { type: String, @@ -145,8 +146,8 @@ limitations under the License. deleteUserRole(row) { AccessService.deleteUserRole(row.projectId, row.userId, row.roleName) .then(() => { - this.data = this.data.filter(item => item.userId !== row.userId); - this.userIds = this.userIds.filter(userId => userId !== row.userIdForDisplay); + this.data = this.data.filter((item) => item.userId !== row.userId); + this.userIds = this.userIds.filter((userId) => userId !== row.userIdForDisplay); this.$emit('role-deleted', { userId: row.userId, role: row.roleName }); }); }, diff --git a/frontend/src/components/access/TrustedClientProps.vue b/dashboard/src/components/access/TrustedClientProps.vue similarity index 100% rename from frontend/src/components/access/TrustedClientProps.vue rename to dashboard/src/components/access/TrustedClientProps.vue diff --git a/frontend/src/components/badges/Badge.vue b/dashboard/src/components/badges/Badge.vue similarity index 57% rename from frontend/src/components/badges/Badge.vue rename to dashboard/src/components/badges/Badge.vue index 7d595c85..d62c42ba 100644 --- a/frontend/src/components/badges/Badge.vue +++ b/dashboard/src/components/badges/Badge.vue @@ -23,10 +23,22 @@ limitations under the License.
- - Manage - +
+ + Manage + +
+
+
+ + Status: + Disabled | Go Live + + + Status: Live + +
@@ -54,11 +66,16 @@ limitations under the License. data() { return { isLoading: false, - badgeInternal: Object.assign({}, this.badge), + badgeInternal: { ...this.badge }, cardOptions: {}, showEditBadge: false, }; }, + computed: { + live() { + return this.badgeInternal.enabled !== 'false'; + }, + }, watch: { badge: function badgeWatch(newBadge, oldBadge) { if (oldBadge) { @@ -91,6 +108,8 @@ limitations under the License. icon: this.badgeInternal.iconClass, title: this.badgeInternal.name, subTitle: `ID: ${this.badgeInternal.badgeId}`, + warn: this.badgeInternal.enabled === 'false', + warnMsg: this.badgeInternal.enabled === 'false' ? 'This badge cannot be achieved until it is live' : '', stats, }; }, @@ -125,11 +144,56 @@ limitations under the License. moveDown() { this.$emit('move-badge-down', this.badgeInternal); }, + canPublish() { + if (this.global) { + return this.badgeInternal.numSkills > 0 || this.badgeInternal.requiredProjectLevels.length > 0; + } + + return this.badgeInternal.numSkills > 0; + }, + getNoPublishMsg() { + let msg = 'This Badge has no assigned Skills. A Badge cannot be published without at least one assigned Skill.'; + if (this.global) { + msg = 'This Global Badge has no assigned Skills or Project Levels. A Global Badge cannot be published without at least one Skill or Project Level.'; + } + + return msg; + }, + handlePublish() { + if (this.canPublish()) { + const msg = `While this Badge is disabled, user's cannot see the Badge or achieve it. Once the Badge is live, it will be visible to users. + Please note that once the badge is live, it cannot be disabled.`; + this.msgConfirm(msg, 'Please Confirm!', 'Yes, Go Live!') + .then((res) => { + if (res) { + this.badgeInternal.enabled = 'true'; + const toSave = { ...this.badgeInternal }; + if (!toSave.originalBadgeId) { + toSave.originalBadgeId = toSave.badgeId; + } + toSave.startDate = this.toDate(toSave.startDate); + toSave.endDate = this.toDate(toSave.endDate); + this.badgeEdited(toSave); + } + }); + } else { + this.msgOk(this.getNoPublishMsg(), 'Empty Badge!'); + } + }, + toDate(value) { + let dateVal = value; + if (value && !(value instanceof Date)) { + dateVal = new Date(Date.parse(value.replace(/-/g, '/'))); + } + return dateVal; + }, }, }; - diff --git a/frontend/src/components/badges/BadgePage.vue b/dashboard/src/components/badges/BadgePage.vue similarity index 87% rename from frontend/src/components/badges/BadgePage.vue rename to dashboard/src/components/badges/BadgePage.vue index 6c4b50ca..963fe802 100644 --- a/frontend/src/components/badges/BadgePage.vue +++ b/dashboard/src/components/badges/BadgePage.vue @@ -21,11 +21,9 @@ limitations under the License. -
@@ -68,15 +66,17 @@ limitations under the License. return {}; } return { - icon: 'fas fa-award', + icon: 'fas fa-award skills-color-badges', title: `BADGE: ${this.badge.name}`, subTitle: `ID: ${this.badge.badgeId}`, stats: [{ label: 'Skills', count: this.badge.numSkills, + icon: 'fas fa-graduation-cap skills-color-skills', }, { label: 'Points', count: this.badge.totalPoints, + icon: 'far fa-arrow-alt-circle-up skills-color-points', }], }; }, diff --git a/frontend/src/components/badges/BadgeSkills.vue b/dashboard/src/components/badges/BadgeSkills.vue similarity index 90% rename from frontend/src/components/badges/BadgeSkills.vue rename to dashboard/src/components/badges/BadgeSkills.vue index 76069c9a..a0ec3a6e 100644 --- a/frontend/src/components/badges/BadgeSkills.vue +++ b/dashboard/src/components/badges/BadgeSkills.vue @@ -35,7 +35,7 @@ limitations under the License. diff --git a/dashboard/src/components/customization/CustomizableFooter.vue b/dashboard/src/components/customization/CustomizableFooter.vue new file mode 100644 index 00000000..01b3b18b --- /dev/null +++ b/dashboard/src/components/customization/CustomizableFooter.vue @@ -0,0 +1,38 @@ +/* +Copyright 2020 SkillTree + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + https://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ + + + + + diff --git a/dashboard/src/components/customization/CustomizableHeader.vue b/dashboard/src/components/customization/CustomizableHeader.vue new file mode 100644 index 00000000..336ff7bc --- /dev/null +++ b/dashboard/src/components/customization/CustomizableHeader.vue @@ -0,0 +1,38 @@ +/* +Copyright 2020 SkillTree + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + https://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ + + + + + diff --git a/dashboard/src/components/customization/DynamicVariableReplacementMixin.vue b/dashboard/src/components/customization/DynamicVariableReplacementMixin.vue new file mode 100644 index 00000000..8fe64528 --- /dev/null +++ b/dashboard/src/components/customization/DynamicVariableReplacementMixin.vue @@ -0,0 +1,39 @@ +/* +Copyright 2020 SkillTree + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + https://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ + diff --git a/frontend/src/components/header/Breadcrumb.vue b/dashboard/src/components/header/Breadcrumb.vue similarity index 85% rename from frontend/src/components/header/Breadcrumb.vue rename to dashboard/src/components/header/Breadcrumb.vue index d4477240..de4451ed 100644 --- a/frontend/src/components/header/Breadcrumb.vue +++ b/dashboard/src/components/header/Breadcrumb.vue @@ -25,16 +25,16 @@ limitations under the License. meta: { breadcrumb: 'Add Skill Event' }, --> - - diff --git a/dashboard/src/components/utils/MarkdownText.vue b/dashboard/src/components/utils/MarkdownText.vue new file mode 100644 index 00000000..5d302b1a --- /dev/null +++ b/dashboard/src/components/utils/MarkdownText.vue @@ -0,0 +1,63 @@ +/* +Copyright 2020 SkillTree + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + https://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ + + + + + diff --git a/dashboard/src/components/utils/Navigation.vue b/dashboard/src/components/utils/Navigation.vue new file mode 100644 index 00000000..4dd11a08 --- /dev/null +++ b/dashboard/src/components/utils/Navigation.vue @@ -0,0 +1,171 @@ +/* +Copyright 2020 SkillTree + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + https://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ + + + + + diff --git a/frontend/src/components/utils/NoContent2.vue b/dashboard/src/components/utils/NoContent2.vue similarity index 97% rename from frontend/src/components/utils/NoContent2.vue rename to dashboard/src/components/utils/NoContent2.vue index bc03386d..c864eead 100644 --- a/frontend/src/components/utils/NoContent2.vue +++ b/dashboard/src/components/utils/NoContent2.vue @@ -43,7 +43,7 @@ limitations under the License. message: String, icon: { type: String, - default: 'fas fa-heart-broken', + default: 'fas fa-dragon', }, }, }; diff --git a/frontend/src/components/utils/NoContent3.vue b/dashboard/src/components/utils/NoContent3.vue similarity index 100% rename from frontend/src/components/utils/NoContent3.vue rename to dashboard/src/components/utils/NoContent3.vue diff --git a/frontend/src/components/utils/NotAuthorizedPage.vue b/dashboard/src/components/utils/NotAuthorizedPage.vue similarity index 88% rename from frontend/src/components/utils/NotAuthorizedPage.vue rename to dashboard/src/components/utils/NotAuthorizedPage.vue index 53c1397d..bf40bda8 100644 --- a/frontend/src/components/utils/NotAuthorizedPage.vue +++ b/dashboard/src/components/utils/NotAuthorizedPage.vue @@ -26,8 +26,11 @@ limitations under the License.
-
-

+

+

+ {{ explanation }} +

+

You are not authorized to view this resource.

@@ -40,6 +43,9 @@ limitations under the License. export default { name: 'NotAuthorized', + props: { + explanation: String, + }, }; diff --git a/dashboard/src/components/utils/NotFoundPage.vue b/dashboard/src/components/utils/NotFoundPage.vue new file mode 100644 index 00000000..d045c323 --- /dev/null +++ b/dashboard/src/components/utils/NotFoundPage.vue @@ -0,0 +1,77 @@ +/* +Copyright 2020 SkillTree + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + https://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ + + + + + + diff --git a/frontend/src/components/utils/RequestOrderMixin.vue b/dashboard/src/components/utils/RequestOrderMixin.vue similarity index 95% rename from frontend/src/components/utils/RequestOrderMixin.vue rename to dashboard/src/components/utils/RequestOrderMixin.vue index 1b40acdd..7d094f32 100644 --- a/frontend/src/components/utils/RequestOrderMixin.vue +++ b/dashboard/src/components/utils/RequestOrderMixin.vue @@ -23,7 +23,7 @@ limitations under the License. }, methods: { getRequestId() { - this.requestId = this.requestId + 1; + this.requestId += 1; return this.requestId; }, ensureOrderlyResultHandling(requestId, closure) { diff --git a/frontend/src/components/utils/ServerTableLoadingMask.vue b/dashboard/src/components/utils/ServerTableLoadingMask.vue similarity index 100% rename from frontend/src/components/utils/ServerTableLoadingMask.vue rename to dashboard/src/components/utils/ServerTableLoadingMask.vue diff --git a/frontend/src/components/utils/SkillsSpinner.vue b/dashboard/src/components/utils/SkillsSpinner.vue similarity index 100% rename from frontend/src/components/utils/SkillsSpinner.vue rename to dashboard/src/components/utils/SkillsSpinner.vue diff --git a/dashboard/src/components/utils/SupervisorService.js b/dashboard/src/components/utils/SupervisorService.js new file mode 100644 index 00000000..cb5a4cb0 --- /dev/null +++ b/dashboard/src/components/utils/SupervisorService.js @@ -0,0 +1,27 @@ +/* + * Copyright 2020 SkillTree + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +import axios from 'axios'; + +export default { + getAllProjects() { + return axios.get('/supervisor/projects') + .then((remoteRes) => remoteRes.data); + }, + getProjectLevels(projectId) { + return axios.get(`/supervisor/projects/${projectId}/levels`) + .then((remoteRes) => remoteRes.data); + }, +}; diff --git a/frontend/src/components/utils/ToastSupport.vue b/dashboard/src/components/utils/ToastSupport.vue similarity index 100% rename from frontend/src/components/utils/ToastSupport.vue rename to dashboard/src/components/utils/ToastSupport.vue diff --git a/frontend/src/components/utils/cards/MediaInfoCard.vue b/dashboard/src/components/utils/cards/MediaInfoCard.vue similarity index 100% rename from frontend/src/components/utils/cards/MediaInfoCard.vue rename to dashboard/src/components/utils/cards/MediaInfoCard.vue diff --git a/frontend/src/components/utils/cards/SimpleCard.vue b/dashboard/src/components/utils/cards/SimpleCard.vue similarity index 100% rename from frontend/src/components/utils/cards/SimpleCard.vue rename to dashboard/src/components/utils/cards/SimpleCard.vue diff --git a/dashboard/src/components/utils/iconPicker/GroupedIcons.js b/dashboard/src/components/utils/iconPicker/GroupedIcons.js new file mode 100644 index 00000000..3e792a1d --- /dev/null +++ b/dashboard/src/components/utils/iconPicker/GroupedIcons.js @@ -0,0 +1,26 @@ +/* + * Copyright 2020 SkillTree + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +export default class GroupedIcons { + row = []; + + constructor(row) { + this.row = row; + } + + get id() { + return this.row.reduce((accumulator, currentVal) => accumulator + currentVal.cssClass, ''); + } +} diff --git a/frontend/src/components/utils/iconPicker/IconManager.vue b/dashboard/src/components/utils/iconPicker/IconManager.vue similarity index 70% rename from frontend/src/components/utils/iconPicker/IconManager.vue rename to dashboard/src/components/utils/iconPicker/IconManager.vue index b2f209a9..71363896 100644 --- a/frontend/src/components/utils/iconPicker/IconManager.vue +++ b/dashboard/src/components/utils/iconPicker/IconManager.vue @@ -15,7 +15,8 @@ limitations under the License. */ No icons matched your search - -
-
- - - - -
- {{ item.name }} -
-
+ @@ -45,43 +40,39 @@ limitations under the License. {{ materialIcons.iconPack }} No icons matched your search - -
-
- - - - -
- {{ item.name }} -
-
+ - -

* custom icons must be between 48px X 48px and 100px X 100px

- - - {{ errors.first('customIcon') }} - + + +

* custom icons must be between 48px X 48px and 100px X 100px

+ + + {{ errors[0] }} + +
@@ -107,14 +98,16 @@ limitations under the License. import debounce from 'lodash.debounce'; import VirtualList from 'vue-virtual-scroll-list'; import enquire from 'enquire.js'; - import { Validator } from 'vee-validate'; + import { extend } from 'vee-validate'; + import { image } from 'vee-validate/dist/rules'; import FileUpload from '../upload/FileUpload'; import FileUploadService from '../upload/FileUploadService'; import fontAwesomeIconsCanonical from './font-awesome-index'; import materialIconsCanonical from './material-index'; import IconManagerService from './IconManagerService'; import ToastSupport from '../ToastSupport'; - + import IconRow from './IconRow'; + import GroupedIcons from './GroupedIcons'; const faIconList = fontAwesomeIconsCanonical.icons.slice(); const matIconList = materialIconsCanonical.icons.slice(); @@ -132,20 +125,20 @@ limitations under the License. let self = null; function groupIntoRows(array, rl) { - let subArr = []; + let grouped = new GroupedIcons([]); const result = []; for (let i = 0; i < array.length; i += 1) { if (i > 0 && i % rl === 0) { - result.push(subArr); - subArr = []; + result.push(grouped); + grouped = new GroupedIcons([]); } const item = array[i]; - subArr.push(item); + grouped.row.push(item); } - if (subArr.length > 0) { - result.push(subArr); + if (grouped.row.length > 0) { + result.push(grouped); } return result; @@ -163,43 +156,33 @@ limitations under the License. return isValid; }; - Validator.extend('imageDimensions', { - getMessage(field, params, data) { - return (data && data.message) || `Custom Icon must be ${self.customIconHeight} X ${self.customIconWidth}`; - }, + extend('image', { + ...image, + message: 'File is not an image format', + }); + extend('imageDimensions', { + message: () => `Invalid image dimensions, dimensions must be square and must be between ${self.minCustomIconDimensions.width} x ${self.minCustomIconDimensions.width} and ${self.maxCustomIconDimensions.width} x ${self.maxCustomIconDimensions.width}`, validate(value) { return new Promise((resolve) => { if (value) { - const file = value.get('customIcon'); - const isImageType = file.type.startsWith('image/'); - if (!isImageType) { - resolve({ - valid: false, - data: { message: 'File is not an image format' }, - }); - } else { - const image = new Image(); - image.src = window.URL.createObjectURL(file); - image.onload = () => { - const width = image.naturalWidth; - const height = image.naturalHeight; - window.URL.revokeObjectURL(image.src); - - if (!isValidCustomIconDimensions(self, width, height)) { - const dimensionRange = { min: self.minCustomIconDimensions.width, max: self.maxCustomIconDimensions.width }; - resolve({ - valid: false, - data: { - message: `Invalid image dimensions, dimensions must be square and must be between ${dimensionRange.min} x ${dimensionRange.min} and ${dimensionRange.max} x ${dimensionRange.max} for ${file.name} `, - }, - }); - } else { - resolve({ - valid: true, - }); - } - }; - } + const file = value.form.get('customIcon'); + const customIcon = new Image(); + customIcon.src = window.URL.createObjectURL(file); + customIcon.onload = () => { + const width = customIcon.naturalWidth; + const height = customIcon.naturalHeight; + window.URL.revokeObjectURL(customIcon.src); + + if (!isValidCustomIconDimensions(self, width, height)) { + resolve({ + valid: false, + }); + } else { + resolve({ + valid: true, + }); + } + }; } else { resolve({ valid: true, @@ -207,24 +190,19 @@ limitations under the License. } }); }, - }, { - immediate: false, }); - Validator.extend('duplicateFilename', { - getMessage(field, params, data) { - return (data && data.message) || 'Custom Icon with this filename already exists'; - }, + extend('duplicateFilename', { + message: 'Custom Icon with this filename already exists', validate(value) { return new Promise((resolve) => { if (value) { - const file = value.get('customIcon'); + const file = value.form.get('customIcon'); - const index = definitiveCustomIconList.findIndex(item => item.filename === file.name); + const index = definitiveCustomIconList.findIndex((item) => item.filename === file.name); if (index >= 0) { resolve({ valid: false, - data: { message: `Custom Icon with filename ${file.name} already exists` }, }); return; } @@ -232,8 +210,6 @@ limitations under the License. resolve({ valid: true }); }); }, - }, { - immediate: false, }); const validateIconDimensions = (dimensions) => { @@ -241,15 +217,11 @@ limitations under the License. let isValid = true; if (!width || !height) { - console.error('width and height are required dimensions'); isValid = false; } if (isValid) { isValid = width / height === 1; - if (!isValid) { - console.error('Icon dimensions must be square'); - } } return isValid; @@ -293,6 +265,7 @@ limitations under the License. materialIcons: materialIconsCanonical, customIconList, disableCustomUpload: false, + rowItemComponent: IconRow, }; }, computed: { @@ -349,19 +322,24 @@ limitations under the License. this.resetIcons(); }, methods: { - getIcon(icon, iconCss, iconPack) { - this.selected = icon; - this.selectedCss = iconCss; + uniqueIdGenerator(groupedIcons) { + return groupedIcons.id; + }, + getIcon(event, iconPack) { + this.selected = event.icon; + this.selectedCss = event.cssClass; this.selectedIconPack = iconPack; - this.selectIcon(icon, iconCss, iconPack); + this.selectIcon(event.icon, event.cssClass, iconPack); }, onChange(tabIndex) { const { value } = this.$refs.iconFilterInput; if (tabIndex === 0) { + this.$refs.fontAwesomeVirtualList.reset(); this.activePack = fontAwesomeIconsCanonical.iconPack; this.filter(value); } else if (tabIndex === 1) { + this.$refs.materialVirtualList.reset(); this.activePack = materialIconsCanonical.iconPack; this.filter(value); } else if (tabIndex === 2) { @@ -372,7 +350,7 @@ limitations under the License. const value = val.trim(); const iconPack = this.activePack; const regex = new RegExp(value, 'gi'); - const filter = icon => icon.name.match(regex); + const filter = (icon) => icon.name.match(regex); if (iconPack === fontAwesomeIconsCanonical.iconPack) { const filtered = value.length === 0 ? groupIntoRows(faIconList, rowLength) : groupIntoRows(faIconList.filter(filter), rowLength); @@ -394,7 +372,7 @@ limitations under the License. }, deleteIcon(iconName, projectId) { IconManagerService.deleteIcon(iconName, projectId).then(() => { - definitiveCustomIconList = definitiveCustomIconList.filter(element => element.filename !== iconName); + definitiveCustomIconList = definitiveCustomIconList.filter((element) => element.filename !== iconName); this.customIconList = definitiveCustomIconList; }); }, @@ -408,7 +386,7 @@ limitations under the License. this.$emit('selected-icon', result); }, customIconUploadRequest(event) { - this.$validator.validate().then((res) => { + this.$refs.validationProvider.validate(event).then((res) => { if (res) { this.disableCustomUpload = true; FileUploadService.upload(this.uploadUrl, event.form, (response) => { @@ -433,7 +411,9 @@ limitations under the License. this.fontAwesomeIcons.icons = groupIntoRows(faIconList, rowLength); this.materialIcons.icons = groupIntoRows(matIconList, rowLength); this.customIconList = definitiveCustomIconList; - this.$refs.iconFilterInput.value = ''; + if (this.$refs.iconFilterInput) { + this.$refs.iconFilterInput.value = ''; + } }, 100); } }, @@ -495,4 +475,9 @@ limitations under the License. display: inline-block; visibility: visible; } + + .virtual-container { + height: 320px; + overflow-y: auto; + } diff --git a/frontend/src/components/utils/iconPicker/IconManagerService.js b/dashboard/src/components/utils/iconPicker/IconManagerService.js similarity index 96% rename from frontend/src/components/utils/iconPicker/IconManagerService.js rename to dashboard/src/components/utils/iconPicker/IconManagerService.js index d7b97f6c..96a32d9b 100644 --- a/frontend/src/components/utils/iconPicker/IconManagerService.js +++ b/dashboard/src/components/utils/iconPicker/IconManagerService.js @@ -37,7 +37,7 @@ export default { if (!projectId) { url = '/supervisor/icons/customIcons'; } - return axios.get(url).then(response => response.data); + return axios.get(url).then((response) => response.data); }, deleteIcon(iconName, projectId) { let url = `/admin/projects/${projectId}/icons/${iconName}`; diff --git a/frontend/src/components/utils/iconPicker/IconPicker.vue b/dashboard/src/components/utils/iconPicker/IconPicker.vue similarity index 100% rename from frontend/src/components/utils/iconPicker/IconPicker.vue rename to dashboard/src/components/utils/iconPicker/IconPicker.vue diff --git a/dashboard/src/components/utils/iconPicker/IconRow.vue b/dashboard/src/components/utils/iconPicker/IconRow.vue new file mode 100644 index 00000000..93570cd3 --- /dev/null +++ b/dashboard/src/components/utils/iconPicker/IconRow.vue @@ -0,0 +1,105 @@ +/* +Copyright 2020 SkillTree + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + https://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ + + + + + diff --git a/frontend/src/components/utils/iconPicker/font-awesome-index.js b/dashboard/src/components/utils/iconPicker/font-awesome-index.js similarity index 100% rename from frontend/src/components/utils/iconPicker/font-awesome-index.js rename to dashboard/src/components/utils/iconPicker/font-awesome-index.js diff --git a/frontend/src/components/utils/iconPicker/material-index.js b/dashboard/src/components/utils/iconPicker/material-index.js similarity index 100% rename from frontend/src/components/utils/iconPicker/material-index.js rename to dashboard/src/components/utils/iconPicker/material-index.js diff --git a/frontend/src/components/utils/inputForm/FormTextInput.vue b/dashboard/src/components/utils/inputForm/FormTextInput.vue similarity index 100% rename from frontend/src/components/utils/inputForm/FormTextInput.vue rename to dashboard/src/components/utils/inputForm/FormTextInput.vue diff --git a/frontend/src/components/utils/inputForm/IdInput.vue b/dashboard/src/components/utils/inputForm/IdInput.vue similarity index 71% rename from frontend/src/components/utils/inputForm/IdInput.vue rename to dashboard/src/components/utils/inputForm/IdInput.vue index d0a8e23f..9e46461f 100644 --- a/frontend/src/components/utils/inputForm/IdInput.vue +++ b/dashboard/src/components/utils/inputForm/IdInput.vue @@ -14,11 +14,11 @@ See the License for the specific language governing permissions and limitations under the License. */ diff --git a/frontend/src/components/utils/modal/MsgBoxMixin.vue b/dashboard/src/components/utils/modal/MsgBoxMixin.vue similarity index 100% rename from frontend/src/components/utils/modal/MsgBoxMixin.vue rename to dashboard/src/components/utils/modal/MsgBoxMixin.vue diff --git a/dashboard/src/components/utils/pages/PageHeader.vue b/dashboard/src/components/utils/pages/PageHeader.vue new file mode 100644 index 00000000..1c00a5f7 --- /dev/null +++ b/dashboard/src/components/utils/pages/PageHeader.vue @@ -0,0 +1,88 @@ +/* +Copyright 2020 SkillTree + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + https://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ + + + + + diff --git a/frontend/src/components/utils/pages/PagePreviewCard.vue b/dashboard/src/components/utils/pages/PagePreviewCard.vue similarity index 84% rename from frontend/src/components/utils/pages/PagePreviewCard.vue rename to dashboard/src/components/utils/pages/PagePreviewCard.vue index f85cb951..8bddce1e 100644 --- a/frontend/src/components/utils/pages/PagePreviewCard.vue +++ b/dashboard/src/components/utils/pages/PagePreviewCard.vue @@ -17,21 +17,22 @@ limitations under the License.
-
+
-
{{ options.title }}
+
{{ options.title }} + +
{{ options.subTitle }}
+
+ +
- -
- -
@@ -58,6 +59,8 @@ limitations under the License. options: { icon: String, title: String, + warn: Boolean, + warnMsg: String, subTitle: String, stats: [], }, diff --git a/frontend/src/components/utils/pages/SubPageHeader.vue b/dashboard/src/components/utils/pages/SubPageHeader.vue similarity index 77% rename from frontend/src/components/utils/pages/SubPageHeader.vue rename to dashboard/src/components/utils/pages/SubPageHeader.vue index 05929783..580d555c 100644 --- a/frontend/src/components/utils/pages/SubPageHeader.vue +++ b/dashboard/src/components/utils/pages/SubPageHeader.vue @@ -14,15 +14,17 @@ See the License for the specific language governing permissions and limitations under the License. */