Add UnsupportedCommand: Handling unsupported additional behavior of git operations in JGit by rishabhBudhouliya · Pull Request #937 · jenkinsci/git-plugin

rishabhBudhouliya · 2020-08-05T05:26:04Z

Enabling GitToolChooser to recommend a git implementation knowing if the implementation is compatible with certain features of git

The introduction of UnsupportedCommand allows us to solve cases where JGit might not be supported and GitToolChooser might suggest JGit because of the size rule. The GitToolChooser can use this command to know if JGit can be user or not.

This working of this command and its usage has been explained below:

Using UnsupportedCommand in Git Plugin

Add a method in GitSCMExtension: determineSupportForJGit
This method acts as a way for the extensions to convey their support for JGit over certain functionalities.
Add implementation of determineSupportForGit for various extensions: GitLFSPull, SparseCheckoutPaths, SubmoduleOption, CheckoutOption etc.
These implementations will put information into an unsupportedCommand object about the compatibility of a certain extension feature with JGit.
An example of how GitToolChooser will work within the Git Plugin
Refer to this commit.

Checklist

Types of changes

New feature (non-breaking change which adds functionality)

Further comments

If this is a relatively large or complex change, start the discussion by explaining why you chose the solution you did and what alternatives you considered.

a "NONE" string Also, size which is decided to switch implementation has been increased to 50K because 5 MiB is experimentally an approximation where behavior of jgit starts to change.

Note: The current test cases target only the scenario with heuristic 1, i.e the cache determination option.

a "NONE" string Also, size which is decided to switch implementation has been increased to 50K because 5 MiB is experimentally an approximation where behavior of jgit starts to change.

Note: The current test cases target only the scenario with heuristic 1, i.e the cache determination option.

- Change in design of handling extension API results: Add the ability to throw exceptions for `getSizeOfRepository` in the Extension Point. Add additional checks on receiving the results from implemented extensions to look for a non-zero without exceptions "size" result from other plugins implementing the extension point.

- Having no cache but available extensions from other plugins - Having a cached directory to recommend the appropriate git implementation - In the event of having an extension: - Returning size > 5 MiB - Returning size < 5 MiB - Not applicable to the provided remote URL from git plugin - Throwing exceptions while estimating the size of repo

…/git-plugin into size-estimator

… repo URL, the plugin will get the size from the first one. Ideally, for a particular remote URL - only one plugin should return size of the repository.

The process of recommending an optimal git impl is in two stages: Stage 1: Determine if the user additional behavior contains a feature which is not supported by JGit - see UnsupportedCommand usage Stage 2: Instantiating GitToolChooser to recommend a git tool Here, the GitToolChooser uses the repository URL to determine a recommendation for the git implementation.

This method can be called by an extension to convey if a certain extension feature is supported by JGit or not. After this information is provided by the an extenions or multiple extensions, the command can determine if JGit is to be used or not. Even if one extension is not supporting a feature, JGit will not be recommended.

By implementing this method, this extension is conveying that in the case a user wants to use timeout, JGit will not be able to perform the git client operations as it is not yet supported.

…lone behavior

…tional behavior

…le feature While instantiating the class using a repo url, the class will also need a decision to determine if JGit has to be recommended in the case of a scenario where an extension is not supported by JGit.

MarkEWaite

Ready to use released git client plugin. Other comments are optional.

MarkEWaite · 2020-08-14T02:56:22Z

pom.xml

    <dependency>
      <groupId>org.jenkins-ci.plugins</groupId>
      <artifactId>git-client</artifactId>
+      <version>3.3.3-SNAPSHOT</version>


Released Aug 13, 2020.

Suggested change

<version>3.3.3-SNAPSHOT</version>

<version>3.4.0</version>

MarkEWaite · 2020-08-14T02:57:52Z

src/main/java/hudson/plugins/git/GitSCM.java

+            ext.determineSupportForJGit(this, unsupportedCommand);
+        }
+
+        listener.getLogger().println("Using Performance Improvement");


Isn't this inferred by the next message?

Suggested change

listener.getLogger().println("Using Performance Improvement");

MarkEWaite · 2020-08-14T02:58:37Z

src/main/java/hudson/plugins/git/extensions/GitSCMExtension.java

    }

+    /**
+     * Called when support of JGit for a particular or multiple extensions is to be determined


Suggested change

* Called when support of JGit for a particular or multiple extensions is to be determined

* Called when support of JGit for a particular or multiple extensions is to be determined.

* Updates the passed unsupportedCommand with the evaluation results.

MarkEWaite · 2020-08-14T03:05:22Z

src/main/java/hudson/plugins/git/extensions/GitSCMExtension.java

+    /**
+     * Called when support of JGit for a particular or multiple extensions is to be determined
+     * @param scm GitSCM object
+     * @param unsupportedCommand UnsupportedCommand object


Suggested change

* @param unsupportedCommand UnsupportedCommand object

* @param unsupportedCommand UnsupportedCommand used to report compatibility of requested extensions with the potential git implementations

MarkEWaite · 2020-08-14T03:09:22Z

src/main/java/hudson/plugins/git/extensions/impl/GitLFSPull.java

+    @Override
+    public void determineSupportForJGit(GitSCM scm, UnsupportedCommand cmd) {
+        List<RemoteConfig> repos = scm.getRepositories();
+        cmd.lfsRemote(repos.get(0).getName());


Since repos.get() returns a list of entries, shouldn't this iterate over the list?

Suggested change

cmd.lfsRemote(repos.get(0).getName());

cmd.lfsRemote(repos.get(0).getName());

MarkEWaite · 2020-08-14T03:11:11Z

src/main/java/hudson/plugins/git/extensions/impl/impl.plantuml

+title __IMPL's Class Diagram__\n
+
+  namespace  {
+    namespace udson.plugins.git {


If you're storing a UML representation like this, shouldn't the namespace match the package name?

Suggested change

namespace udson.plugins.git {

namespace hudson.plugins.git {

omkar-dsd · 2020-08-19T13:47:16Z

Carry Forwarded to #931 . This PR can be closed.

MarkEWaite · 2020-08-19T22:00:22Z

Closed in favor of #931

rishabhBudhouliya added 30 commits July 20, 2020 11:37

[GSoC'20] Git Repository Size Estimation API

f477da8

Add newline to EOF

e217116

Add Javadoc comments for better readability

2a879a8

Instead of providing null if no recommendation is provided, return

008a126

a "NONE" string Also, size which is decided to switch implementation has been increased to 50K because 5 MiB is experimentally an approximation where behavior of jgit starts to change.

Add two test cases for GitRepoSizeEstimator

c2a82f0

Note: The current test cases target only the scenario with heuristic 1, i.e the cache determination option.

Rename methods for better consistency and readability

14548cf

Improve assertion with containsString

766d5f0

Add filter to channel only required extension when calling ExtensionList

0fbdf85

Preserve older tests removed by mistake

5703a0c

Rearrange class methods to improve readability

58ca8e7

[GSoC'20] Git Repository Size Estimation API

7a2caeb

Add newline to EOF

f0d4433

Add Javadoc comments for better readability

c91f211

Instead of providing null if no recommendation is provided, return

3747e65

a "NONE" string Also, size which is decided to switch implementation has been increased to 50K because 5 MiB is experimentally an approximation where behavior of jgit starts to change.

Add two test cases for GitRepoSizeEstimator

90aa2c5

Note: The current test cases target only the scenario with heuristic 1, i.e the cache determination option.

Rename methods for better consistency and readability

b00c7c3

Improve assertion with containsString

a7e25dd

Add filter to channel only required extension when calling ExtensionList

b9d6d5f

Preserve older tests removed by mistake

af76286

Rearrange class methods to improve readability

a6b2d58

Merge branch 'size-estimator' of https://github.com/rishabhBudhouliya…

7d25b4f

…/git-plugin into size-estimator

Improve assertion

7408df2

Return inline long instead of declaring it

c2fc583

Change name from GitRepoSizeEstimator to GitToolChooser

6dfacf7

Remove duplicate code ->

b26e1b0

In the case of more than one implementer plugins accepting the remote…

6a9de6c

… repo URL, the plugin will get the size from the first one. Ideally, for a particular remote URL - only one plugin should return size of the repository.

Add a snapshot version for local development

be9b3ba

rishabhBudhouliya added 8 commits August 5, 2020 10:03

Add support to determine if JGit can be used or not

f1721a6

By implementing this method, this extension is conveying that in the case a user wants to use timeout, JGit will not be able to perform the git client operations as it is not yet supported.

Add support to determine validity of JGit over a certain additional c…

9096977

…lone behavior

Add support to determine the validity of JGit for a certain user addi…

e4a7657

…tional behavior

Add the ability to disable JGit if a user is demanding a non-compatib…

e4202cc

…le feature While instantiating the class using a repo url, the class will also need a decision to determine if JGit has to be recommended in the case of a scenario where an extension is not supported by JGit.

Update GitToolChooser constructor

d8838f9

remove additional(redundant) check in getGitTool

5aeac9e

replace estimator with chooser

00eb8a9

MarkEWaite added the enhancement Improvement or new feature label Aug 8, 2020

Change default value of JGIT flag to false instead of true

bc7b773

MarkEWaite requested changes Aug 14, 2020

View reviewed changes

MarkEWaite closed this Aug 19, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add UnsupportedCommand: Handling unsupported additional behavior of git operations in JGit#937

Add UnsupportedCommand: Handling unsupported additional behavior of git operations in JGit#937
rishabhBudhouliya wants to merge 39 commits intojenkinsci:masterfrom
rishabhBudhouliya:add-decorate-tool

rishabhBudhouliya commented Aug 5, 2020 •

edited

Loading

Uh oh!

MarkEWaite left a comment

Uh oh!

MarkEWaite Aug 14, 2020

Uh oh!

MarkEWaite Aug 14, 2020

Uh oh!

MarkEWaite Aug 14, 2020

Uh oh!

MarkEWaite Aug 14, 2020

Uh oh!

MarkEWaite Aug 14, 2020

Uh oh!

MarkEWaite Aug 14, 2020

Uh oh!

omkar-dsd commented Aug 19, 2020 •

edited

Loading

Uh oh!

MarkEWaite commented Aug 19, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	* Called when support of JGit for a particular or multiple extensions is to be determined
	* Called when support of JGit for a particular or multiple extensions is to be determined.
	* Updates the passed unsupportedCommand with the evaluation results.

	* @param unsupportedCommand UnsupportedCommand object
	* @param unsupportedCommand UnsupportedCommand used to report compatibility of requested extensions with the potential git implementations

	cmd.lfsRemote(repos.get(0).getName());
	cmd.lfsRemote(repos.get(0).getName());

Conversation

rishabhBudhouliya commented Aug 5, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Enabling GitToolChooser to recommend a git implementation knowing if the implementation is compatible with certain features of git

Using UnsupportedCommand in Git Plugin

Checklist

Types of changes

Further comments

Uh oh!

MarkEWaite left a comment

Choose a reason for hiding this comment

Uh oh!

MarkEWaite Aug 14, 2020

Choose a reason for hiding this comment

Uh oh!

MarkEWaite Aug 14, 2020

Choose a reason for hiding this comment

Uh oh!

MarkEWaite Aug 14, 2020

Choose a reason for hiding this comment

Uh oh!

MarkEWaite Aug 14, 2020

Choose a reason for hiding this comment

Uh oh!

MarkEWaite Aug 14, 2020

Choose a reason for hiding this comment

Uh oh!

MarkEWaite Aug 14, 2020

Choose a reason for hiding this comment

Uh oh!

omkar-dsd commented Aug 19, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

MarkEWaite commented Aug 19, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

rishabhBudhouliya commented Aug 5, 2020 •

edited

Loading

omkar-dsd commented Aug 19, 2020 •

edited

Loading