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

fix: Increase migration job timeout #1985

Merged
merged 1 commit into from
Feb 28, 2025

Conversation

oskogstad
Copy link
Collaborator

Description

Related Issue(s)

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

  • Documentation is updated (either in docs-directory, Altinnpedia or a separate linked PR in altinn-studio-docs., if applicable)

@oskogstad oskogstad requested review from a team as code owners February 28, 2025 13:21
Copy link
Contributor

coderabbitai bot commented Feb 28, 2025

📝 Walkthrough

Walkthrough

This pull request introduces a new integer parameter named replicaTimeOutInSeconds across several Bicep files. In the main Bicep files, the parameter is defined and passed as an argument to modules, replacing any hardcoded timeout values. In the environment-specific parameter files, the parameter is added with a default value of 36000 seconds. No other changes to logic or existing parameters have been made.

Changes

File(s) Change Summary
.azure/applications/.../main.bicep Added new parameter replicaTimeOutInSeconds (type int) with description and passed it to the migrationJob module.
.azure/applications/.../*.bicepparam (prod, staging, test, yt01) Introduced the replicaTimeOutInSeconds parameter with a default value of 36000 seconds.
.azure/modules/.../main.bicep Added new parameter replicaTimeOutInSeconds (type int), replacing the hardcoded replica timeout value (120 seconds) to allow dynamic configuration.

Suggested reviewers

  • arealmaas

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.
  • @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.

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.

@oskogstad oskogstad changed the title fix: Increase migration job timeout limit fix: Increase migration job timeout Feb 28, 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: 0

🧹 Nitpick comments (2)
.azure/applications/web-api-migration-job/main.bicep (1)

25-27: New Timeout Parameter Added: Consider Constraint Annotations

The new parameter replicaTimeOutInSeconds is introduced with a clear description. For added robustness, consider adding an annotation (e.g., @minValue(0)) to enforce that the value is non-negative. This can help avoid configuration errors when a negative timeout is inadvertently provided.

.azure/modules/containerAppJob/main.bicep (1)

32-34: New Timeout Parameter in Module: Validate Input Constraints

The replicaTimeOutInSeconds parameter is properly added with its description. As with the main file, consider adding a constraint (for example, @minValue(0)) to guarantee that only valid (non-negative) timeout values are used in the deployment.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7b80aa8 and 74a7329.

⛔ Files ignored due to path filters (1)
  • src/Digdir.Domain.Dialogporten.Infrastructure/Persistence/Migrations/DialogDbContextModelSnapshot.cs is excluded by !**/Migrations/DialogDbContextModelSnapshot.cs
📒 Files selected for processing (6)
  • .azure/applications/web-api-migration-job/main.bicep (2 hunks)
  • .azure/applications/web-api-migration-job/prod.bicepparam (1 hunks)
  • .azure/applications/web-api-migration-job/staging.bicepparam (1 hunks)
  • .azure/applications/web-api-migration-job/test.bicepparam (1 hunks)
  • .azure/applications/web-api-migration-job/yt01.bicepparam (1 hunks)
  • .azure/modules/containerAppJob/main.bicep (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: build / build-and-test
  • GitHub Check: build-infrastructure / Build infrastructure for test
🔇 Additional comments (6)
.azure/applications/web-api-migration-job/test.bicepparam (1)

6-6: New timeout parameter looks good.

The introduction of replicaTimeOutInSeconds with a value of 36000 seconds (10 hours) aligns with the PR objective to increase the migration job timeout limit.

.azure/applications/web-api-migration-job/staging.bicepparam (1)

6-6: New timeout parameter looks good.

The introduction of replicaTimeOutInSeconds with a value of 36000 seconds (10 hours) aligns with the PR objective to increase the migration job timeout limit.

.azure/applications/web-api-migration-job/yt01.bicepparam (1)

6-6: New timeout parameter looks good.

The introduction of replicaTimeOutInSeconds with a value of 36000 seconds (10 hours) aligns with the PR objective to increase the migration job timeout limit.

.azure/applications/web-api-migration-job/prod.bicepparam (1)

6-6: New timeout parameter looks good.

The introduction of replicaTimeOutInSeconds with a value of 36000 seconds (10 hours) aligns with the PR objective to increase the migration job timeout limit.

Consider documenting the reason for choosing this specific timeout value, perhaps in a comment or in related documentation, to provide context for future maintenance.

.azure/applications/web-api-migration-job/main.bicep (1)

69-80: Parameter Mapping in Module Deployment: Confirm Consistency

The new parameter is passed to the migrationJob module on line 79, ensuring that the dynamic timeout value is applied. Please verify that the target module correctly declares and expects an integer parameter named replicaTimeOutInSeconds—this will ensure end-to-end consistency.

.azure/modules/containerAppJob/main.bicep (1)

68-71: Replacing Hardcoded Timeout with Configurable Parameter

Replacing the previously hardcoded value with the newly introduced parameter (replicaTimeOutInSeconds) on line 70 is a good move. Ensure that all dependent logic within the job configuration interprets this value correctly.

@oskogstad oskogstad merged commit 393f151 into main Feb 28, 2025
17 checks passed
@oskogstad oskogstad deleted the fix/set-migration-timout-to-10-hours branch February 28, 2025 13:27
oskogstad pushed a commit that referenced this pull request Feb 28, 2025
🤖 I have created a release *beep* *boop*
---


##
[1.57.1](v1.57.0...v1.57.1)
(2025-02-28)


### Bug Fixes

* Add missing timeout parameter for sync jobs
([#1987](#1987))
([265bad0](265bad0))
* Increase migration job timeout
([#1985](#1985))
([393f151](393f151))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).
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.

2 participants