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

HPCC-29768 Protect updates with a dali lock when fetching a git repo #18574

Merged
merged 1 commit into from
Apr 29, 2024

Conversation

ghalliday
Copy link
Member

@ghalliday ghalliday commented Apr 23, 2024

Type of change:

  • This change is a bug fix (non-breaking change which fixes an issue).
  • This change is a new feature (non-breaking change which adds functionality).
  • This change improves the code (refactor or other change that does not change the functionality)
  • This change fixes warnings (the fix does not alter the functionality or the generated code)
  • This change is a breaking change (fix or feature that will cause existing behavior to change).
  • This change alters the query API (existing queries will have to be recompiled)

Checklist:

  • My code follows the code style of this project.
    • My code does not create any new warnings from compiler, build system, or lint.
  • The commit message is properly formatted and free of typos.
    • The commit message title makes sense in a changelog, by itself.
    • The commit is signed.
  • My change requires a change to the documentation.
    • I have updated the documentation accordingly, or...
    • I have created a JIRA ticket to update the documentation.
    • Any new interfaces or exported functions are appropriately commented.
  • I have read the CONTRIBUTORS document.
  • The change has been fully tested:
    • I have added tests to cover my changes.
    • All new and existing tests passed.
    • I have checked that this change does not introduce memory leaks.
    • I have used Valgrind or similar tools to check for potential issues.
  • I have given due consideration to all of the following potential concerns:
    • Scalability
    • Performance
    • Security
    • Thread-safety
    • Cloud-compatibility
    • Premature optimization
    • Existing deployed queries will not be broken
    • This change fixes the problem, not just the symptom
    • The target branch of this pull request is appropriate for such a change.
  • There are no similar instances of the same problem that should be addressed
    • I have addressed them here
    • I have raised JIRA issues to address them separately
  • This is a user interface / front-end modification
    • I have tested my changes in multiple modern browsers
    • The component(s) render as expected

Smoketest:

  • Send notifications about my Pull Request position in Smoketest queue.
  • Test my draft Pull Request.

Testing:

@ghalliday ghalliday requested a review from jakesmith April 23, 2024 14:17
@ghalliday
Copy link
Member Author

@jakesmith for initial review. See the jira for details of the change. I will add some more changes in a different PR to i) pre-cache the repo and ii) delete old lock files.

Copy link

Jira Issue: https://hpccsystems.atlassian.net//browse/HPCC-29768

Jirabot Action Result:
Workflow Transition: Merge Pending
Updated PR

Copy link
Member

@jakesmith jakesmith left a comment

Choose a reason for hiding this comment

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

@ghalliday - looks good afaics, a few trivial comments.

@@ -1421,6 +1421,10 @@
"type": "string",
"description": "The default repo version used if not supplied for the defaultRepo"
},
"guardGitUpdates": {
"type": "boolean",
"description": "If enabled all updates of the git repositories is protected by holding a lock in dali"
Copy link
Member

Choose a reason for hiding this comment

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

trivial: .. 'are' protected?

@@ -27,6 +27,7 @@ Pass in dict with root and me
*/}}
{{- define "hpcc.eclccServerConfigMap" -}}
{{- $compileJobName := printf "compile-job-_HPCC_JOBNAME_" }}
{{- $gitPlane := .me.gitPlane | default (include "hpcc.getDefaultGitPlane" .root) -}}
Copy link
Member

Choose a reason for hiding this comment

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

trivial: I notice the pre-existing line above didn't/doesn't have a whitespace chomping char , but this new line ahead of the content does.. Don't think it's problematic, perhaps make both lines same.

Copy link
Member Author

Choose a reason for hiding this comment

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

I will change to match

@@ -96,6 +96,7 @@ const char * const helpText[] = {
"?! --fastsyntax Delay expanding functions when parsing. May speed up processing for some queries",
"? --fetchrepos Automatically download missing repositories associated with dependencies",
"! --gituser=x Which user should be used for accessing git repositories (for servers)",
"! --gitlock=key The dali key (e.g. plane name) that should be used to project updates to git repositories",
Copy link
Member

Choose a reason for hiding this comment

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

typo: project -> protect.

}

if (!gitLockKey.isEmpty())
guardGitUpdates = true;
Copy link
Member

Choose a reason for hiding this comment

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

trivial: any point to non-empty gitLockKey and a boolean? i.e. could just test if (!gitLockKey.isEmpty()) below:

Copy link
Member Author

Choose a reason for hiding this comment

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

Could do, but it is arguably slightly easier to read the code below. I'm not sure it is worth changing.

@ghalliday ghalliday requested a review from jakesmith April 26, 2024 13:58
Copy link
Member

@jakesmith jakesmith left a comment

Choose a reason for hiding this comment

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

@ghalliday - looks good, ready to squash.

@ghalliday ghalliday merged commit 62b4f47 into hpcc-systems:candidate-9.6.x Apr 29, 2024
21 checks passed
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