[Packagist] dependency version

services/packagist/packagist-base.js

@@ -6,9 +6,7 @@ const packageSchema = Joi.array().items(
   Joi.object({
     version: Joi.string().required(),
     require: Joi.alternatives(
-      Joi.object({
-        php: Joi.string(),
-      }).required(),
+      Joi.object().pattern(Joi.string(), Joi.string()).required(),
       Joi.string().valid('__unset')
     ),
   })
@@ -23,7 +21,7 @@ class BasePackagistService extends BaseJsonService {
   /**
    * Default fetch method.
    *
-   * This method utilize composer metadata API which
+   * This method utilizes composer metadata API which
    * "... is the preferred way to access the data as it is always up to date,
    * and dumped to static files so it is very efficient on our end." (comment from official documentation).
    * For more information please refer to https://packagist.org/apidoc#get-package-data.
@@ -47,7 +45,7 @@ class BasePackagistService extends BaseJsonService {
   /**
    * Fetch dev releases method.
    *
-   * This method utilize composer metadata API which
+   * This method utilizes composer metadata API which
    * "... is the preferred way to access the data as it is always up to date,
    * and dumped to static files so it is very efficient on our end." (comment from official documentation).
    * For more information please refer to https://packagist.org/apidoc#get-package-data.
@@ -165,8 +163,39 @@ class BasePackagistService extends BaseJsonService {
     }
     return versions.filter(version => version.version === release)[0]
   }
-}
 
+  // moved from packagist-php-version.service.js so that it can be reused in packagist-dependency-version.service.js
+  findVersionIndex(json, version) {
+    return json.findIndex(v => v.version === version)
+  }
+
+  // moved from packagist-php-version.service.js so that it can be reused in packagist-dependency-version.service.js
+  async findSpecifiedVersion(json, user, repo, version, server) {
+    let release
+
+    if ((release = json[this.findVersionIndex(json, version)])) {
+      return release
+    } else {
+      try {
+        const allData = await this.fetchDev({
+          user,
+          repo,
+          schema: allVersionsSchema,
+          server,
+        })
+
+        const versions = this.expandPackageVersions(
+          allData,
+          this.getPackageName(user, repo)
+        )
+
+        return versions[this.findVersionIndex(versions, version)]
+      } catch (e) {
+        return release
+      }
+    }
+  }
+}
 const customServerDocumentationFragment = `
     <p>
         Note that only network-accessible packagist.org and other self-hosted Packagist instances are supported.

services/packagist/packagist-dependency-version.service.js

@@ -0,0 +1,197 @@
+import Joi from 'joi'
+import { optionalUrl } from '../validators.js'
+import { NotFound } from '../index.js'
+import {
+  allVersionsSchema,
+  BasePackagistService,
+  customServerDocumentationFragment,
+} from './packagist-base.js'
+
+const queryParamSchema = Joi.object({
+  dependencyVendor: Joi.string(),
+  dependencyRepo: Joi.string(),
+  server: optionalUrl,
+}).required()
+
+export default class PackagistDependencyVersion extends BasePackagistService {
+  static category = 'platform-support'
+
+  static route = {
+    base: 'packagist/dependency-v',
+    pattern: ':user/:repo/:version?',
+    queryParamSchema,
+  }
+
+  static examples = [
+    {
+      title: 'Packagist Dependency Version Support',
+      pattern: ':user/:repo',
+      namedParams: {
+        user: 'symfony',
+        repo: 'symfony',
+      },
+      queryParams: {
+        dependencyVendor: 'twig',
+        dependencyRepo: 'twig',
+      },
+      staticPreview: this.render({
+        dependencyNameForLabel: 'twig/twig',
+        dependencyVersion: '2.13|^3.0.4',
+      }),
+    },
+    {
+      title: 'Packagist Dependency Version Support (specify version)',
+      pattern: ':user/:repo/:version',
+      namedParams: {
+        user: 'symfony',
+        repo: 'symfony',
+        version: 'v2.8.0',
+      },
+      queryParams: {
+        dependencyVendor: 'twig',
+        dependencyRepo: 'twig',
+      },
+      staticPreview: this.render({
+        dependencyNameForLabel: 'twig/twig',
+        dependencyVersion: '1.12',
+      }),
+    },
+    {
+      title: 'Packagist Dependency Version Support (custom server)',
+      pattern: ':user/:repo',
+      namedParams: {
+        user: 'symfony',
+        repo: 'symfony',
+      },
+      queryParams: {
+        dependencyVendor: 'twig',
+        dependencyRepo: 'twig',
+        server: 'https://packagist.org',
+      },
+      staticPreview: this.render({
+        dependencyNameForLabel: 'twig/twig',
+        dependencyVersion: '2.13|^3.0.4',
+      }),
+      documentation: customServerDocumentationFragment,
+    },
+  ]
+
+  static defaultBadgeData = {
+    label: 'dependency version',
+    color: 'blue',
+  }
+
+  static render({ dependencyNameForLabel, dependencyVersion }) {
+    return {
+      label: dependencyNameForLabel,
+      message: dependencyVersion,
+    }
+  }
+
+  determineDependencyNameForLabel({ dependencyVendor, dependencyRepo }) {
+    if (dependencyVendor && dependencyRepo) {
+      return `${dependencyVendor}/${dependencyRepo}`
+    } else if (dependencyVendor && !dependencyRepo) {
+      return dependencyVendor
+    } else if (!dependencyVendor && dependencyRepo) {
+      return dependencyRepo
+    }
+  }
+
+  async getDependencyVersion({
+    json,
+    user,
+    repo,
+    version = '',
+    server,
+    dependencyVendor,
+    dependencyRepo,
+  }) {
+    let packageVersion
+    const versions = BasePackagistService.expandPackageVersions(
+      json,
+      this.getPackageName(user, repo)
+    )
+
+    if (version === '') {
+      packageVersion = this.findLatestRelease(versions)
+    } else {
+      try {
+        packageVersion = await this.findSpecifiedVersion(
+          versions,
+          user,
+          repo,
+          version,
+          server
+        )
+      } catch (e) {
+        packageVersion = null
+      }
+    }
+
+    if (!packageVersion) {
+      throw new NotFound({ prettyMessage: 'invalid version' })
+    }
+
+    if (!packageVersion.require) {
+      throw new NotFound({ prettyMessage: 'version requirement not found' })
+    }
+
+    let dependencyIdentifier
+
+    const depVendLowercase = dependencyVendor?.toLowerCase()
+    const depRepoLowercase = dependencyRepo?.toLowerCase()
+
+    if (dependencyRepo || dependencyVendor) {
+      if (!!dependencyRepo & !dependencyVendor) {
+        dependencyIdentifier = depRepoLowercase
+      } else if (!dependencyRepo & !!dependencyVendor) {
+        dependencyIdentifier = depVendLowercase
+      } else {
+        dependencyIdentifier = `${depVendLowercase}/${depRepoLowercase}`
+      }
+    } else {
+      throw new NotFound({
+        prettyMessage: 'dependency vendor or repo not specified',
+      })
+    }
+
+    if (!packageVersion.require[dependencyIdentifier]) {
+      throw new NotFound({ prettyMessage: 'version requirement not found' })
+    }
+
+    return { dependencyVersion: packageVersion.require[dependencyIdentifier] }
+  }
+
+  async handle(
+    { user, repo, version = '' },
+    { dependencyVendor, dependencyRepo, server }
+  ) {
+    const allData = await this.fetch({
+      user,
+      repo,
+      schema: allVersionsSchema,
+      server,
+    })
+
+    const { dependencyVersion } = await this.getDependencyVersion({
+      json: allData,
+      user,
+      repo,
+      version,
+      server,
+      dependencyVendor,
+      dependencyRepo,
+    })
+
+    const dependencyNameForLabel = this.determineDependencyNameForLabel({
+      dependencyVendor,
+      dependencyRepo,
+    })
+
+    return this.constructor.render({
+      dependencyNameForLabel,
+      dependencyVersion,
+    })
+  }
+}

services/packagist/packagist-dependency-version.spec.js

@@ -0,0 +1,116 @@
+import chai from 'chai'
+import chaiAsPromised from 'chai-as-promised'
+import PackagistDependencyVersion from './packagist-dependency-version.service.js'
+const { expect } = chai
+chai.use(chaiAsPromised)
+
+// majority of tests below are copied from packagist-php-version.spec, since PackagistDependencyVersion should work very similarly to PackagistDependencyVersion (just with the option to specify the second dependency, instead of the hardoded 'php')
+describe('PackagistDependencyVersion', function () {
+  const fullPackagistJson = {
+    packages: {
+      'frodo/the-one-package': [
+        {
+          version: '3.0.0',
+          require: { php: '^7.4 || 8', 'twig/twig': '~1.28|~2.0' },
+        },
+        {
+          version: '2.0.0',
+          require: { php: '^7.2', 'twig/twig': '~1.20|~1.30' },
+        },
+        {
+          version: '1.0.0',
+          require: { php: '^5.6 || ^7', 'twig/twig': '~1.10|~1.0' },
+        },
+      ],
+    },
+  }
+
+  it('should throw NotFound when package version is missing', async function () {
+    await expect(
+      PackagistDependencyVersion.prototype.getDependencyVersion({
+        json: fullPackagistJson,
+        user: 'frodo',
+        repo: 'the-one-package',
+        version: '4.0.0',
+      })
+    ).to.be.rejectedWith('invalid version')
+  })
+
+  it('should throw NotFound when dependency version not found on package when using default release', async function () {
+    await expect(
+      PackagistDependencyVersion.prototype.getDependencyVersion({
+        json: fullPackagistJson,
+        user: 'frodo',
+        repo: 'the-one-package',
+      })
+    ).to.be.rejectedWith('dependency vendor or repo not specified')
+  })
+
+  it('should throw NotFound when dependency version not found on package when using specified release', async function () {
+    const fullPackagistJson = {
+      packages: {
+        'frodo/the-one-package': [
+          {
+            version: '3.0.0',
+            require: { php: '^7.4 || 8' },
+          },
+          {
+            version: '2.0.0',
+            require: { php: '^7.2' },
+          },
+          {
+            version: '1.0.0',
+            require: '__unset',
+          },
+        ],
+      },
+    }
+    await expect(
+      PackagistDependencyVersion.prototype.getDependencyVersion({
+        json: fullPackagistJson,
+        user: 'frodo',
+        repo: 'the-one-package',
+        version: '1.0.0',
+      })
+    ).to.be.rejectedWith('version requirement not found')
+  })
+
+  it('should throw NotFound if neither dependencyVendor nor dependencyRepo was specified', async function () {
+    await expect(
+      PackagistDependencyVersion.prototype.getDependencyVersion({
+        json: fullPackagistJson,
+        user: 'frodo',
+        repo: 'the-one-package',
+      })
+    ).to.be.rejectedWith('dependency vendor or repo not specified')
+  })
+
+  it('should return dependency version for the default release', async function () {
+    expect(
+      await PackagistDependencyVersion.prototype.getDependencyVersion({
+        json: fullPackagistJson,
+        user: 'frodo',
+        repo: 'the-one-package',
+        dependencyVendor: 'twig',
+        dependencyRepo: 'twig',
+      })
+    )
+      .to.have.property('dependencyVersion')
+      .that.equals('~1.28|~2.0')
+  })
+
+  it('should return dependency version for the specified release', async function () {
+    expect(
+      await PackagistDependencyVersion.prototype.getDependencyVersion({
+        json: fullPackagistJson,
+        user: 'frodo',
+        repo: 'the-one-package',
+        version: '2.0.0',
+        dependencyVendor: 'twig',
+        dependencyRepo: 'twig',
+      })
+    )
+      .to.have.property('dependencyVersion')
+      .that.equals('~1.20|~1.30')
+  })
+})