Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: merge latest docs and changelog #1383

Merged
merged 5 commits into from
Jun 4, 2024
Merged

docs: merge latest docs and changelog #1383

merged 5 commits into from
Jun 4, 2024

Conversation

zxkane
Copy link
Contributor

@zxkane zxkane commented May 24, 2024


By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

Summary

(describe what this merge request does)

Implementation highlights

(describe how the merge request does for feature changes, share the RFC link if it has)

Test checklist

  • add new test cases
  • all code changes are covered by unit tests
  • end-to-end tests
    • deploy web console with CloudFront + S3 + API gateway
    • deploy web console within VPC
    • deploy ingestion server
      • with MSK sink
      • with KDS sink
      • with S3 sink
    • deploy data processing
    • deploy data modeling
      • new Redshift Serverless
      • provisioned Redshift
      • Athena
    • deploy with reporting
    • streaming ingestion
      • with Redshift Serverless
      • with provisioned Redshift

Is it a breaking change

  • add parameters without default value in stack
  • introduce new service permission in stack
  • introduce new top level stack module

Miscellaneous

  • introduce new symbol link source file(s) to be shared among infra code, web console frontend, and web console backend

Copy link

Etl common library's test coverage

Overall Project 92.68% 🍏

There is no coverage information present for the Files changed

Copy link

Streaming ingestion flink application's test coverage

Overall Project 94.57% 🍏

There is no coverage information present for the Files changed

@zxkane zxkane requested a review from luorobin-a2z May 24, 2024 04:31
@zxkane zxkane marked this pull request as ready for review May 24, 2024 04:31
Copy link

Data Pipeline spark application's test coverage

Overall Project 98.15% 🍏

There is no coverage information present for the Files changed

@zxkane
Copy link
Contributor Author

zxkane commented May 24, 2024

SonarQube Quality Gate Result

  • Result: ✅ OK
  • Triggered by @zxkane on pull_request
Metric Status Value Error Threshold
Reliability rating ✅ OK 1 > 1
Security rating ✅ OK 1 > 1
Sqale rating ✅ OK 1 > 1
Coverage ✅ OK 83.60 < 80
Duplicated lines density ✅ OK 5.20 > 30
Blocker violations ✅ OK 0 > 0
Bugs ✅ OK 0 > 0
Code smells ✅ OK 8 > 40
Critical violations ✅ OK 0 > 0
Major violations ✅ OK 0 > 0
Vulnerabilities ✅ OK 0 > 0

View on SonarQube

updated: 5/24/2024, 04:54:46 (UTC+0)

@zxkane
Copy link
Contributor Author

zxkane commented May 24, 2024

SonarQube Code Analytics

Quality Gate passed

passed

Additional information

The following metrics might not affect the Quality Gate status but improving them will improve your project code quality.

Issues

bug 0 Bugs

vulnerability 0 Vulnerabilities

code_smell 0 Code Smells

Coverage and Duplications

No data Coverage

No data Duplication

Copy link

Etl common library's test coverage

Overall Project 92.68% 🍏

There is no coverage information present for the Files changed

Copy link

Streaming ingestion flink application's test coverage

Overall Project 94.57% 🍏

There is no coverage information present for the Files changed

Copy link

Data Pipeline spark application's test coverage

Overall Project 98.15% 🍏

There is no coverage information present for the Files changed

@zxkane
Copy link
Contributor Author

zxkane commented May 25, 2024

SonarQube Quality Gate Result

  • Result: ✅ OK
  • Triggered by @zxkane on pull_request
Metric Status Value Error Threshold
Reliability rating ✅ OK 1 > 1
Security rating ✅ OK 1 > 1
Sqale rating ✅ OK 1 > 1
Coverage ✅ OK 83.60 < 80
Duplicated lines density ✅ OK 5.20 > 30
Blocker violations ✅ OK 0 > 0
Bugs ✅ OK 0 > 0
Code smells ✅ OK 8 > 40
Critical violations ✅ OK 0 > 0
Major violations ✅ OK 0 > 0
Vulnerabilities ✅ OK 0 > 0

View on SonarQube

updated: 5/25/2024, 07:16:43 (UTC+0)

@zxkane zxkane marked this pull request as draft May 26, 2024 06:41
@zxkane zxkane marked this pull request as ready for review May 27, 2024 05:00
Copy link

Etl common library's test coverage

Overall Project 92.68% 🍏

There is no coverage information present for the Files changed

Copy link

Streaming ingestion flink application's test coverage

Overall Project 94.57% 🍏

There is no coverage information present for the Files changed

Copy link

Data Pipeline spark application's test coverage

Overall Project 98.15% 🍏

There is no coverage information present for the Files changed

@zxkane
Copy link
Contributor Author

zxkane commented May 27, 2024

SonarQube Quality Gate Result

  • Result: ✅ OK
  • Triggered by @zxkane on pull_request
Metric Status Value Error Threshold
Reliability rating ✅ OK 1 > 1
Security rating ✅ OK 1 > 1
Sqale rating ✅ OK 1 > 1
Coverage ✅ OK 83.70 < 80
Duplicated lines density ✅ OK 5.20 > 30
Blocker violations ✅ OK 0 > 0
Bugs ✅ OK 0 > 0
Code smells ✅ OK 8 > 40
Critical violations ✅ OK 0 > 0
Major violations ✅ OK 0 > 0
Vulnerabilities ✅ OK 0 > 0

View on SonarQube

updated: 5/27/2024, 05:33:48 (UTC+0)

…manual (#1402)

Co-authored-by: xiaoweii <xiaoweii@amazom.com>
Copy link

github-actions bot commented Jun 4, 2024

Etl common library's test coverage

Overall Project 92.68% 🍏

There is no coverage information present for the Files changed

Copy link

github-actions bot commented Jun 4, 2024

Streaming ingestion flink application's test coverage

Overall Project 94.57% 🍏

There is no coverage information present for the Files changed

Copy link

github-actions bot commented Jun 4, 2024

Data Pipeline spark application's test coverage

Overall Project 98.12% 🍏

There is no coverage information present for the Files changed

Copy link

github-actions bot commented Jun 4, 2024

Code Coverage

Package Line Rate Branch Rate Health
src 100% 82%
src.analytics 100% 100%
src.analytics.lambdas 92% 88%
src.analytics.lambdas.clear-expired-events-workflow 100% 100%
src.analytics.lambdas.custom-resource 96% 87%
src.analytics.lambdas.load-data-workflow 99% 90%
src.analytics.lambdas.refresh-materialized-views-workflow 96% 85%
src.analytics.lambdas.scan-metadata-workflow 97% 88%
src.analytics.lambdas.sql-execution-sfn 93% 60%
src.analytics.lambdas.user-segments-workflow 96% 77%
src.analytics.private 100% 92%
src.analytics.private.athena 100% 100%
src.analytics.private.segments 100% 100%
src.base-lib.src 100% 100%
src.base-lib.src.auth 89% 65%
src.base-lib.src.common 97% 72%
src.base-lib.src.constant 100% 100%
src.base-lib.src.model 100% 100%
src.common 98% 80%
src.common.lambda 97% 86%
src.control-plane 99% 71%
src.control-plane.auth 93% 12%
src.control-plane.backend 100% 84%
src.control-plane.backend.lambda.api 97% 33%
src.control-plane.backend.lambda.api.common 92% 80%
src.control-plane.backend.lambda.api.middle-ware 89% 82%
src.control-plane.backend.lambda.api.model 96% 56%
src.control-plane.backend.lambda.api.router 98% 97%
src.control-plane.backend.lambda.api.service 85% 67%
src.control-plane.backend.lambda.api.service.quicksight 93% 81%
src.control-plane.backend.lambda.api.service.segments 95% 76%
src.control-plane.backend.lambda.api.store.aws 87% 56%
src.control-plane.backend.lambda.api.store.dynamodb 90% 80%
src.control-plane.backend.lambda.api.test.api 99% 81%
src.control-plane.backend.lambda.api.test.api.segments 100% 100%
src.control-plane.backend.lambda.batch-insert-ddb 94% 86%
src.control-plane.backend.lambda.listen-stack-status 81% 52%
src.control-plane.backend.lambda.listen-state-status 91% 50%
src.control-plane.backend.lambda.sfn-action 88% 50%
src.control-plane.backend.lambda.sfn-workflow 80% 67%
src.control-plane.backend.layer.lambda-web-adapter 98% 40%
src.control-plane.private 100% 100%
src.data-pipeline 100% 100%
src.data-pipeline.lambda.copy-assets 97% 90%
src.data-pipeline.lambda.emr-job-state-listener 96% 91%
src.data-pipeline.lambda.emr-job-submitter 100% 78%
src.data-pipeline.lambda.emr-serverless-app 96% 86%
src.data-pipeline.lambda.partition-syncer 98% 89%
src.data-pipeline.tables 100% 100%
src.data-pipeline.utils 100% 97%
src.ingestion-server.custom-resource 100% 100%
src.ingestion-server.custom-resource.delete-ecs-cluster 98% 90%
src.ingestion-server.custom-resource.update-alb-rules 100% 78%
src.ingestion-server.kafka-s3-connector 100% 100%
src.ingestion-server.kafka-s3-connector.custom-resource.kafka-s3-sink-connector 96% 82%
src.ingestion-server.kinesis-data-stream 100% 100%
src.ingestion-server.kinesis-data-stream.kinesis-to-s3-lambda 100% 100%
src.ingestion-server.kinesis-data-stream.private 100% 100%
src.ingestion-server.server 98% 89%
src.ingestion-server.server-v2 100% 79%
src.ingestion-server.server-v2.private 100% 82%
src.ingestion-server.server.private 100% 89%
src.metrics 100% 100%
src.metrics.custom-resource.add-sns-subscription 95% 86%
src.metrics.custom-resource.get-interval 99% 97%
src.metrics.custom-resource.put-dashboard 97% 84%
src.metrics.custom-resource.set-metrics-widgets 98% 93%
src.private 96% 73%
src.reporting 100% 80%
src.reporting.lambda.custom-resource.quicksight 94% 81%
src.reporting.private 90% 54%
src.streaming-ingestion 100% 100%
src.streaming-ingestion.lambdas.custom-resource 86% 63%
src.streaming-ingestion.private 99% 89%
src.streaming-ingestion.redshift 100% 100%
test 96% 83%
test.common 93% 100%
test.control-plane 97% 64%
test.ingestion-server.server 97% 88%
Summary 96% (75513 / 78629) 75% (6400 / 8573)

Minimum allowed line rate is 60%

@zxkane
Copy link
Contributor Author

zxkane commented Jun 4, 2024

SonarQube Quality Gate Result

  • Result: ✅ OK
  • Triggered by @zxkane on pull_request
Metric Status Value Error Threshold
Reliability rating ✅ OK 1 > 1
Security rating ✅ OK 1 > 1
Sqale rating ✅ OK 1 > 1
Coverage ✅ OK 83.80 < 80
Duplicated lines density ✅ OK 5.20 > 30
Blocker violations ✅ OK 0 > 0
Bugs ✅ OK 0 > 0
Code smells ✅ OK 8 > 40
Critical violations ✅ OK 0 > 0
Major violations ✅ OK 0 > 0
Vulnerabilities ✅ OK 0 > 0

View on SonarQube

updated: 6/4/2024, 04:45:32 (UTC+0)

@zxkane zxkane added this pull request to the merge queue Jun 4, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Jun 4, 2024
@zxkane zxkane added this pull request to the merge queue Jun 4, 2024
Merged via the queue into main with commit 7a05b13 Jun 4, 2024
18 checks passed
@zxkane zxkane deleted the doc-merge-back branch June 4, 2024 07:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants