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

chore: make all jobs params mandatory #14642

Merged
merged 2 commits into from
Feb 12, 2025
Merged

Conversation

mirkoSekulic
Copy link
Collaborator

@mirkoSekulic mirkoSekulic commented Feb 12, 2025

Description

Related Issue(s)

  • #{issue number}

Verification

  • Your code builds clean without any errors or warnings
  • Manual testing done (required)
  • Relevant automated test added (if you find this hard, leave it and we'll help out)

Documentation

  • User documentation is updated with a separate linked PR in altinn-studio-docs. (if applicable)

Summary by CodeRabbit

  • Refactor
    • Streamlined the extraction of key scheduling parameters by eliminating redundant checks.
    • Improved the internal handling of configuration values, enhancing overall clarity and system maintainability.
    • Corrected control flow in the repository's zip creation process to ensure accurate processing of changed files.

Copy link
Contributor

coderabbitai bot commented Feb 12, 2025

📝 Walkthrough

Walkthrough

The changes simplify how variables are retrieved in the DeploymentPipelinePollingJob.cs file. The previous conditional check for the PipelineType is removed and replaced with a direct call to Enum.Parse<PipelineType>(...) using a null-forgiving operator. Similarly, the assignment of the environment variable now directly extracts its value from the job data map. In the RepositoryController.cs file, a semicolon was removed from the ContentsZip method, allowing the subsequent foreach loop to execute correctly. No modifications to exported or public declarations were made.

Changes

Files Change Summary
backend/src/…/DeploymentPipelinePollingJob.cs Simplified variable retrieval by removing the conditional check for PipelineType (using Enum.Parse<PipelineType>(...) with a null-forgiving operator) and directly assigning the environment variable.
backend/src/…/RepositoryController.cs Removed a semicolon after an if statement in the ContentsZip method to ensure proper execution of the subsequent foreach loop for processing changedFiles.

Possibly related PRs

Suggested reviewers

  • framitdavid
  • github-actions

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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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 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 for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions github-actions bot added area/app-deploy Area: Related to deploying apps from Altinn Studio to Altinn Apps. solution/studio/designer Issues related to the Altinn Studio Designer solution. backend labels Feb 12, 2025
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🔭 Outside diff range comments (1)
backend/src/Designer/Scheduling/DeploymentPipelinePollingJob.cs (1)

35-38: 🛠️ Refactor suggestion

Apply consistent validation for all job parameters.

While making parameters mandatory, ensure consistent validation across all parameters. Currently, only buildId uses Guard.ArgumentNotNull.

Suggested approach to validate all parameters consistently:

-        string org = context.JobDetail.JobDataMap.GetString(DeploymentPipelinePollingJobConstants.Arguments.Org);
-        string app = context.JobDetail.JobDataMap.GetString(DeploymentPipelinePollingJobConstants.Arguments.App);
-        string developer = context.JobDetail.JobDataMap.GetString(DeploymentPipelinePollingJobConstants.Arguments.Developer);
-        var editingContext = AltinnRepoEditingContext.FromOrgRepoDeveloper(org, app, developer);
-        string buildId = context.JobDetail.JobDataMap.GetString(DeploymentPipelinePollingJobConstants.Arguments.BuildId);
-        Guard.ArgumentNotNull(buildId, nameof(buildId));
+        string org = context.JobDetail.JobDataMap.GetString(DeploymentPipelinePollingJobConstants.Arguments.Org);
+        Guard.ArgumentNotNullOrEmpty(org, nameof(DeploymentPipelinePollingJobConstants.Arguments.Org));
+        
+        string app = context.JobDetail.JobDataMap.GetString(DeploymentPipelinePollingJobConstants.Arguments.App);
+        Guard.ArgumentNotNullOrEmpty(app, nameof(DeploymentPipelinePollingJobConstants.Arguments.App));
+        
+        string developer = context.JobDetail.JobDataMap.GetString(DeploymentPipelinePollingJobConstants.Arguments.Developer);
+        Guard.ArgumentNotNullOrEmpty(developer, nameof(DeploymentPipelinePollingJobConstants.Arguments.Developer));
+        
+        var editingContext = AltinnRepoEditingContext.FromOrgRepoDeveloper(org, app, developer);
+        
+        string buildId = context.JobDetail.JobDataMap.GetString(DeploymentPipelinePollingJobConstants.Arguments.BuildId);
+        Guard.ArgumentNotNullOrEmpty(buildId, nameof(DeploymentPipelinePollingJobConstants.Arguments.BuildId));

Also applies to: 42-42

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7a7591e and 54cb730.

📒 Files selected for processing (1)
  • backend/src/Designer/Scheduling/DeploymentPipelinePollingJob.cs (1 hunks)
🧰 Additional context used
🧠 Learnings (1)
backend/src/Designer/Scheduling/DeploymentPipelinePollingJob.cs (1)
Learnt from: mirkoSekulic
PR: Altinn/altinn-studio#14627
File: backend/src/Designer/Scheduling/DeploymentPipelinePollingJob.cs:35-41
Timestamp: 2025-02-11T13:27:52.832Z
Learning: In the DeploymentPipelinePollingJob, validation of environment and pipeline type parameters is intentionally lenient to support already running tasks, with plans to strengthen validation in future iterations.
⏰ Context from checks skipped due to timeout of 90000ms (6)
  • GitHub Check: Run dotnet build and test (macos-latest)
  • GitHub Check: Build environment and run e2e test
  • GitHub Check: Run dotnet build and test (windows-latest)
  • GitHub Check: Run integration tests against actual gitea and db
  • GitHub Check: Run dotnet build and test (ubuntu-latest)
  • GitHub Check: Analyze

@mirkoSekulic mirkoSekulic added the skip-manual-testing PRs that do not need to be tested manually label Feb 12, 2025
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 54cb730 and 0384dc7.

📒 Files selected for processing (1)
  • backend/src/Designer/Controllers/RepositoryController.cs (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (6)
  • GitHub Check: Build environment and run e2e test
  • GitHub Check: Run dotnet build and test (macos-latest)
  • GitHub Check: Run dotnet build and test (windows-latest)
  • GitHub Check: Analyze
  • GitHub Check: Run dotnet build and test (ubuntu-latest)
  • GitHub Check: Run integration tests against actual gitea and db

@mirkoSekulic mirkoSekulic merged commit e734296 into main Feb 12, 2025
14 checks passed
@mirkoSekulic mirkoSekulic deleted the chore/job-mandatory-params branch February 12, 2025 09:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/app-deploy Area: Related to deploying apps from Altinn Studio to Altinn Apps. backend skip-manual-testing PRs that do not need to be tested manually solution/studio/designer Issues related to the Altinn Studio Designer solution.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants