Maven SCM

enhance scm api to support limited number of returned changesets by changelog command

Details

  • Complexity:
    Intermediate
  • Testcase included:
    yes
  • Patch Submitted:
    Yes
  • Number of attachments :
    2

Description

The current api returns changesets between specified/unspecified dates/revisions.
This leaves some important usecases unsupported; some of them are:

  • get last changeset on given repository/path
  • get last n changesets there ("first page" when browsing changes)

The only workarround currently possible is, list all commits and filter them - but this is very time consuming.
For this reason, I propose attached enhancement which overloads the changeLog method, adding the limit parameter:

    ChangeLogScmResult changeLog( ScmRepository repository, ScmFileSet fileSet, Date startDate, Date endDate,
                                  int numDays, ScmBranch branch, String datePattern, Integer limit )
        throws ScmException;

For the "last changeset" usecase, the client sets limit = 1.

For "paged browsing", it can specify null startDate/endDate on firstPage, and then work with dates for next/previous pages, still using the limit to specify page size.

Note that the limit parameter can be null (as it is "Integer", not "int") to specify unlimited number of returned changesets.

The suggested patch includes deprecations of enhanced methods, I hope this is a good way to reduce the number of actively used overloaded variants of "changelog" in future.

  1. Text File
    scm-changelog-limit.patch
    19/Jun/12 7:57 PM
    33 kB
    Petr Kozelka
  2. Text File
    scm-changelog-limit-wrapped.patch
    20/Jun/12 4:10 PM
    51 kB
    Petr Kozelka

Activity

Ascending order - Click to sort in descending order
Hide
Permalink
Olivier Lamy added a comment -

Hi,
Instead of adding more and more parameters (and new methods) what about changing to something like :

ChangeLogScmResult changeLog( ChangeLogScmRequest changeLogScmRequest )
        throws ScmException;

Will be more easy to add features.
WDYT ?

Show
Olivier Lamy added a comment - Hi, Instead of adding more and more parameters (and new methods) what about changing to something like : ChangeLogScmResult changeLog( ChangeLogScmRequest changeLogScmRequest ) throws ScmException; Will be more easy to add features. WDYT ?
Hide
Permalink
Petr Kozelka added a comment -

good idea, I will rewrite the patch

Show
Petr Kozelka added a comment - good idea, I will rewrite the patch
Hide
Permalink
Petr Kozelka added a comment -

request style patch

Show
Petr Kozelka added a comment - request style patch
Hide
Permalink
Petr Kozelka added a comment -

Hi Olivier,
attached scm-changelog-limit-wrapped.patch contains the request-style as you suggested.

Few implementation notes:

  • to keep the changes minimalistic, especially in the implementation part, I am reusing as much of existing "argument rich" methods code as possible; rewriting these might require heavy testing, so it's perhaps better to leave it up to separate contributions
  • on the API side, I deprecated all other "changelog" overloads to clearly indicate the (as I suppose) preferred calling style
  • ScmRequest holds all the data, most of them within a CommandParameters object; this simplifies passing the data down to the implementation side
  • no method chaining introduced yet but it might be a nice next improvement
  • this request/result style of passing api parameters might be similarly useful for other commands, I will keep that in mind when submitting patches in future
Show
Petr Kozelka added a comment - Hi Olivier, attached scm-changelog-limit-wrapped.patch contains the request-style as you suggested. Few implementation notes: to keep the changes minimalistic, especially in the implementation part, I am reusing as much of existing "argument rich" methods code as possible; rewriting these might require heavy testing, so it's perhaps better to leave it up to separate contributions on the API side, I deprecated all other "changelog" overloads to clearly indicate the (as I suppose) preferred calling style ScmRequest holds all the data, most of them within a CommandParameters object; this simplifies passing the data down to the implementation side no method chaining introduced yet but it might be a nice next improvement this request/result style of passing api parameters might be similarly useful for other commands, I will keep that in mind when submitting patches in future
Hide
Permalink
Olivier Lamy added a comment -

applied.
Thanks!

Show
Olivier Lamy added a comment - applied. Thanks!

People

  • Assignee:
    Olivier Lamy
    Reporter:
    Petr Kozelka
Vote (0)
Watch (2)

Dates

  • Created:
    Updated:
    Resolved: