Description

Artifactory and Bintray

Investigation report

There are two JFrog products: Artifactory and Bintray. At first glance they seem very similar. They both:

• aggregate functionalities of different repositories: maven, npy, debian - and it's possible to connect them separately in native way (e.g. using maven - in pom or settings.xml we just provide URL to Artifactory/Bintray repo)
• expose unified rest API for all those aggregated repositories and management operations - common for all repos

But the difference between Artifactory and Bintray (nicely described here: https://stackoverflow.com/a/38979659/4703098) is that 

• Artifactory is a development-time tool - mainly focused on inside-company facilities like: sharing snapshots, proxying external repositories and caching artifacts, sharing 3rd party non-public artifacts, etc.
• Bintray is a release, distribution-time tool - focused on hosting released version of artifacts for public or controlled usage, assuring load balancing, access...

Bintray and Artifactory can store in their repositories all types of binaries. But not all types have native support:

• in Artifactory the list of natively supported packages and so built-in repositories covers (almost) ALL popular types (much more than XWiki needs):  https://www.jfrog.com/artifactory/features/#addon-maven
• in Bintray the list of built-in repositories and supported package types is much more narrow: https://bintray.com/docs/usermanual/intro/intro_supportedpackageformats.html supported are e.g. maven, npm; missing is e.g. pypi

So we can upload to Bintray .egg package but it won't support connecting Bintray with pypi. (With Artifactory it's possible)

So from XWiki perspective of view

• integration with Artifactory would make sense for those XWiki users that are quite big companies using XWiki for their own needs and producing many private XWiki extensions that they want to host in their Artifactory instance. The other beneficiary may be in the future XWiki community if it decides to migrate from Nexus to Artifactory.
• integration with Bintray makes general sense - since there are public Bintray repositories like: https://jcenter.bintray.com, https://dl.bintray.com (moreover JCenter repository - according to what JFrog claims - is a superset of artifacts stored on maven central)

Problems:

• I couldn't upload SNAPSHOT packages
• It's strange - but when uploading package it's put in the root catalog instead of e.g. ''org/xwiki/contrib/....'' So if package should be later accessible from XWiki via bintray - you need to specify the "Target Repository Path" to proper value. Only then there will be flawless import from xwiki 
• you need to remember - that after uploading packages form bintray UI - you need to publish them - only after publishing the package is available for download

Design questions

1. Both: Artifactory and Bintray can be accessed natively using maven, npm, pypi (currently only artifactory) - is there a need/advantage of integrating those repositories via their REST API? (Assuming that either way we're going to develop specialized connectors with NPM and Pypi)

• to check if connection is already working via maven connecor:
  • add following configuration in xwiki properties (it's a repo created by myself):
      ''extension.repositories=bintray:maven:http://dl.bintray.com/cristof/xwiki-test''
  • in your local xwiki instance you can import following extensions (that I uploaded to this bintray repo):
     ''org.xwiki.contrib:application-office365''  version: ''1.0.12345'' (current version of contrib application-office365 app with intentionally modified version)
     ''org.xwiki.contrib:hello-world-bintray-test''   version: ''0.1234'' (pure hello world component generated from xwiki archetype)
  • you can import them via ''Extension Manager'' or in ''Extension Repository App''

Update 09.06.2017

Summary of mail discussion

• if rest apis of Bintary and Artifactory are simillar it'll be better to create one extension with functionality for connecting both
• connecting Bintray will make sense mostly as connecting JCenter public repo and the best way will be to set such connection as default implementing ExtensionRepositorySource (like its done with extensions.xwiki.org or nexus.xwiki.org)
• the advantage of using Rest API is that we can make use of searching features that are absent in native maven connection

Investigation report 2

General:

Potentially created ArtifactoryRepositoryManager BintrayRepositoryManager may implement apart from RespositoryManager interface, also Searchable interface. Currently only XWikiExtensionManager implements Searchable (AetherExtensionManager does not - Maven native operations does not provide searching options).

To implement RepositoryManager it's required to implement following operations:

• resolve of extension (having its maven id and version e.g. org.xwiki.contrib:application-office365:1.0.123456
• obtaining available versions of extension (having its maven id e.g. org.xwiki.contrib:application-office365

To implement Searchable it's required to implement following operation:

• search of extensions giving pattern to search, offset and maximum search results

Artifactory and Bintray API

• Artifactory Rest API and Bintray API are totally different apis (only single methods are similar)
• Artifactory Rest API is much richer then Bintrays
• there's SDK for connecting Artifactory Rest API https://github.com/JFrogDev/artifactory-client-java (seems reliable and useful)
• Artifactory in general seems to be more functional, better designed, more stable, and better supported then Bintray
• links:
  
  • Artifactory Rest API docs: https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API
  • Bintray Rest API docs: https://bintray.com/docs/api/

Implementation design with reference to Artifactory and Bintray API

Resolving extension

• dedicated paths for downloads
• Artifactory
  
  • Path: GET /repo-key/path/to/artifact.ext
  • Example: GET http://localhost:8080/artifactory/libs-release-local/ch/qos/logback/logback-classic/0.9.9/logback-classic-0.9.9.jar
• Bintray
  
  • Path: GET https://dl.bintray.com/:subject/:repo/:file_path
  • https://dl.bintray.com/cristof/xwiki-test/org/xwiki/contrib/application-office365/1.0.12345/:application-office365-1.0.12345.xar

Obtaining available versions of extension

• Artifactory
  
  • special path for obtaining versions
  • Path: GET /api/search/versions?[g=groupId][&a=artifactId][&v=version][&remote=0/1][&repos=x[,y]]
  • Example: GET /api/search/versions?g=org.xwiki.contrib&a=application-office365
• Bintray
  
  • possible to obtain versions via searching packages (see docs for details)
  • Path: GET /search/packages/maven?g=:groupId&a=:artifactId&q=:query
  • Example: GET /search/packages/maven?g=org.xwiki.contrib&a=application-office365

Searching:

This is the biggest deal. Possible it should work as it does currently with XWikiExtensionManager.
How does searching in XWikiExtensionManager look like:XWikiExtensionManager utilizes Extension Repository Application API for searching: http://extensions.xwiki.org/xwiki/bin/view/Extension/Repository%20Module. Extension Repository Application doing search operation queries XWiki database (since during import of each extension to ERA - extension document page is created and extension's meta data is retrieved from pom and persisted in document xobjects in database). So the ERA search goes through extension metadata taken previously from pom properties like: or

Artifactory provides multiple package search methods (https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-SEARCHES) - for the scope of project following are interesting : 

• by name (in Artifactory GUI - Quick search): GET /api/search/artifact?name=name[&repos=x[,y]]
  
  • the name parameter is supposed to somehow match the name of factual extension file e.g. '*office365*' matches 'application-office365-1.0.123456.xar'
  • but groupId is not taken into consideration e.g. name='*contrib*' will return no results
• by maven coordinates (in Artifactory GUI - Maven GAVC Search)
  
  • GET /api/search/gavc?[g=groupId][&a=artifactId][&v=version][&c=classifier][&repos=x[,y]]
  • we don't need to specify all parameters (maven coordinates) e.g. we just put: g=*contrib* and it'll return all contrib extensions
• by properties:
  
  • GET /api/search/prop?[p1=v1,v2][&p2=v3][&repos=x[,y]]
  • to each uploaded package (to specific version or generally package as set of all versions) - you can specify in artifactory custom properties in form of Name:value and so you can later search packages according to those properties

Bintray provides searching facilities only by name and/or description

• GET /search/packages[?name=:name&desc=:desc]
• but those name and description are not imported from uploaded pom, but are inserted manually whilst uploading each package to Bintray

Questions:

• Is it important to provide searching in ArtifactoryRepositoryManager and BintrayRepositoryManager? If so how to design it's logic using described above Artifactory/Bintray api?
• How to cope with the fact, that artifactory/bintray repo may contain also other artifacts apart from Xwiki Extension. (In maven connection is not the problem - since maven does not expose searching feature and to download extension you need to specify its full id)
  
  • Possible solution is that: on Artifactory/Bintray you may have plenty different, logically different maven repos. So prerequisite for connecting Artifactory/Bintray will be providing url to repo containing only xwiki valid extensions.

Update 14.06.2017

Discussion on riot summary

• when DefaultExtensionRepositoryManager is initialized and ConfigurationExtensionRepositorySource is used to add ExtensionRepositories basing on configuration in xwiki.properties - components from extensions are not yet loaded. So BintrayMavenExtensionRepository currently cannot be configured in xwiki.properties the same way as other repositories e.g.  extension.repositories=maven:xwiki:http://nexus.xwiki.org/nexus/content/groups/public
• for the current moment configuration of connection to bintray maven repositories will be done by custom properties in xwiki.properties. How will they look like - it'll be announced
• bintray-repository extension will contain JCenterBintrayRepositorySource which will be automatically processed on installment of extension (it'll be possible after fix of Thomas Mortagne in xwiki-commons - creating listener to ComponentAddEvent for role ExtensionRepositorySource). That means installment of bintray-repository extension by default will add JCenter Extension Repository. Probably it will be set up to specify special property in xwiki.properties to disable connection to JCenter