plgd-dev / hub

Secure and Interoperable Internet of Things
https://plgd.dev
Apache License 2.0
171 stars 17 forks source link

Implement m2m-token for Trigger Command Execution via m2m-oauth-server #1336

Closed jkralik closed 3 months ago

jkralik commented 4 months ago

Description

This PR introduces the m2m-token functionality, enabling the execution of trigger commands from various services. The m2m-token is issued by the m2m-oauth-server through the credential flow.

To obtain the token, users can utilize a secret or another JWT token signed by an authority configured within the m2m-oauth-server.

Key highlights of this implementation include:

coderabbitai[bot] commented 4 months ago

[!IMPORTANT]

Review skipped

More than 25% of the files skipped due to max files limit. The review is being skipped to prevent a low-quality review.

22 files out of 79 files are above the max files limit of 50. Please upgrade to Pro plan to get higher limits.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
jkralik commented 3 months ago

https://github.com/plgd-dev/hub/pull/1336#discussion_r1663991640

This depends on the cluster where the hub is running. In production, each user needs to set up their own cluster. If we set the limits too low, the processes will be killed by OOM (Out of Memory) errors.

jkralik commented 3 months ago

@coderabbitai review

coderabbitai[bot] commented 3 months ago
Actions performed Review triggered. > Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.
jkralik commented 3 months ago

@coderabbitai summary

coderabbitai[bot] commented 3 months ago
Actions performed Summary regeneration triggered.
jkralik commented 3 months ago

@coderabbitai summary

coderabbitai[bot] commented 3 months ago
Actions performed Summary regeneration triggered.
coderabbitai[bot] commented 3 months ago

[!IMPORTANT]

Review skipped

More than 25% of the files skipped due to max files limit. The review is being skipped to prevent a low-quality review.

22 files out of 79 files are above the max files limit of 50. Please upgrade to Pro plan to get higher limits.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
jkralik commented 3 months ago

@coderabbitai create summary over files under m2m-oauth-server directory and helm chart

coderabbitai[bot] commented 3 months ago

[!TIP] For best results, initiate chat on the files or code changes.

@jkralik, here is the summary of the changes:

m2m-oauth-server Directory

Helm Chart

If you need further details or have any other requests, please let me know.

Analysis chain ---
Scripts executed The following scripts were executed for the analysis: Script: ```shell #!/bin/bash # List changes under the m2m-oauth-server directory echo "Changes in m2m-oauth-server directory:" git diff --name-only HEAD~1 HEAD | grep 'm2m-oauth-server' # List changes in Helm chart files echo "Changes in Helm chart files:" git diff --name-only HEAD~1 HEAD | grep 'helm' ``` Length of output: 289 --- Script: ```shell #!/bin/bash # Show the diff of the specific file that changed in the m2m-oauth-server directory echo "Diff for m2m-oauth-server/test/test.go:" git diff HEAD~1 HEAD m2m-oauth-server/test/test.go ``` Length of output: 2068

Learnings added ``` Learnt from: jkralik URL: https://github.com/plgd-dev/hub/pull/1336 Timestamp: 2024-07-04T17:35:40.654Z Learning: When summarizing changes in a pull request, include details from the specified directories and files, noting both modifications and absence of changes. ``` > Note: Learnings are effective only in the context of similar code segments. To apply general coding guidelines, please configure [review instructions](https://docs.coderabbit.ai/guides/review-instructions). You can manage existing learnings in the [app](https://app.coderabbit.ai/learnings).
jkralik commented 3 months ago

@coderabbitai create summary over all files under m2m-oauth-server and charts directories

coderabbitai[bot] commented 3 months ago

[!TIP] For best results, initiate chat on the files or code changes.

@jkralik, here is the updated summary of the changes:

m2m-oauth-server Directory

charts Directory

If you need further details or have any other requests, please let me know.

Analysis chain
Scripts executed The following scripts were executed for the analysis: Script: ```shell #!/bin/bash # List and show changes under the m2m-oauth-server directory echo "Changes in m2m-oauth-server directory:" git diff --name-only HEAD~1 HEAD | grep 'm2m-oauth-server' echo "Diffs for files in m2m-oauth-server directory:" for file in $(git diff --name-only HEAD~1 HEAD | grep 'm2m-oauth-server'); do echo "Diff for $file:" git diff HEAD~1 HEAD $file done # List and show changes under the charts directory echo "Changes in charts directory:" git diff --name-only HEAD~1 HEAD | grep 'charts' echo "Diffs for files in charts directory:" for file in $(git diff --name-only HEAD~1 HEAD | grep 'charts'); do echo "Diff for $file:" git diff HEAD~1 HEAD $file done ``` Length of output: 2734
jkralik commented 3 months ago

@coderabbitai create a description for whole pull request based on m2m-oauth-server and charts directories

coderabbitai[bot] commented 3 months ago

[!TIP] For best results, initiate chat on the files or code changes.

@jkralik, here is the comprehensive description of the pull request based on changes in the m2m-oauth-server and charts directories:

Pull Request Description

Objective

The primary objective of this pull request is to allow configuring multiple authorities for m2m-token.

Changes in m2m-oauth-server Directory

Changes in charts Directory

This cleanup in the m2m-oauth-server directory helps in maintaining a cleaner codebase and removing unused code. If there are any specific changes related to the configuration of multiple authorities for m2m-token that are not evident in the provided diffs, please let me know so I can include them in the description.

If you need further details or have any other requests, please let me know.

Analysis chain
Scripts executed The following scripts were executed for the analysis: Script: ```shell #!/bin/bash # List all files under the m2m-oauth-server and charts directories and show their diffs echo "Listing all files under m2m-oauth-server and charts directories:" git diff --name-only HEAD~1 HEAD | grep -E 'm2m-oauth-server|charts' echo "Diffs for files in m2m-oauth-server and charts directories:" for file in $(git diff --name-only HEAD~1 HEAD | grep -E 'm2m-oauth-server|charts'); do echo "Diff for $file:" git diff HEAD~1 HEAD $file done ``` Length of output: 2596
sonarcloud[bot] commented 3 months ago

Quality Gate Passed Quality Gate passed

Issues
0 New issues
1 Accepted issue

Measures
0 Security Hotspots
80.0% Coverage on New Code
1.4% Duplication on New Code

See analysis details on SonarCloud