- {% if isSearchPage and plugin.installedVersion %}
+ {% if isSearchPage and plugin.isInstalled %}
{{ govukTag({
text: "Installed",
- classes: "govuk-tag--grey"
+ classes: "govuk-tag--grey govuk-prototype-kit-installed"
}) }}
{% endif %}
+ {% if plugin.updateAvailable %}
+
+
+ {{ govukTag({
+ html: 'Update available',
+ classes: "govuk-tag--grey govuk-prototype-kit-update-available"
+ }) }}
+
+ {% endif %}
{% if plugin.description %}
{{ plugin.description }}
@@ -117,27 +126,6 @@
{% endif %}
-
{% endblock %}
diff --git a/lib/nunjucks/views/manage-prototype/scripts.njk b/lib/nunjucks/views/manage-prototype/scripts.njk
index 92673dbc78..4b09283f9d 100644
--- a/lib/nunjucks/views/manage-prototype/scripts.njk
+++ b/lib/nunjucks/views/manage-prototype/scripts.njk
@@ -1,3 +1,3 @@
+
-
diff --git a/lib/nunjucks/views/manage-prototype/templates.njk b/lib/nunjucks/views/manage-prototype/templates.njk
index 492c97be31..3aaa5d0074 100644
--- a/lib/nunjucks/views/manage-prototype/templates.njk
+++ b/lib/nunjucks/views/manage-prototype/templates.njk
@@ -16,7 +16,7 @@
{{ govukButton({
text: 'Install common templates',
classes: "govuk-button--secondary",
- href: commonTemplatesDetails.installLink
+ href: commonTemplatesDetails.installLink + '?returnTo=templates'
}) }}
{% endif %}
diff --git a/lib/plugins/packages.js b/lib/plugins/packages.js
deleted file mode 100644
index 17ec890edf..0000000000
--- a/lib/plugins/packages.js
+++ /dev/null
@@ -1,279 +0,0 @@
-// core dependencies
-const path = require('path')
-
-// npm dependencies
-const fse = require('fs-extra')
-
-// local dependencies
-const { startPerformanceTimer, endPerformanceTimer } = require('../utils/performance')
-const { packageDir, projectDir } = require('../utils/paths')
-const { requestHttpsJson } = require('../utils/requestHttps')
-const { verboseLog } = require('../utils/verboseLogger')
-const knownPlugins = require(path.join(packageDir, 'known-plugins.json'))
-const projectPackage = require(path.join(projectDir, 'package.json'))
-const config = require('../config')
-const { getConfigForPackage } = require('../utils/requestHttps')
-const { getProxyPluginConfig } = require('./plugin-utils')
-const { sortByObjectKey } = require('../utils')
-
-let packageTrackerInterval
-
-const packagesCache = {}
-
-async function startPackageTracker () {
- await updatePackagesInfo()
- packageTrackerInterval = setInterval(updatePackagesInfo, 36000)
-}
-
-async function updatePackagesInfo () {
- const availablePlugins = knownPlugins?.plugins?.available || []
- const packagesRequired = [...availablePlugins, ...Object.keys(projectPackage.dependencies)]
- return Promise.all(packagesRequired.map(async (packageName) => refreshPackageInfo(packageName)))
-}
-
-async function readJson (filename) {
- return await fse.pathExists(filename) ? fse.readJson(filename) : undefined
-}
-
-async function requestRegistryInfo (packageName) {
- const timer = startPerformanceTimer()
- try {
- const registryInfoUrl = `https://registry.npmjs.org/${encodeURIComponent(packageName)}`
- verboseLog(`looking up ${registryInfoUrl}`)
- const registryInfo = await requestHttpsJson(registryInfoUrl)
- verboseLog(`retrieved ${registryInfoUrl}`)
- endPerformanceTimer('lookupPackageInfo (success)', timer)
- return registryInfo
- } catch (e) {
- endPerformanceTimer('lookupPackageInfo (failure)', timer)
- verboseLog('ignoring error', e.message)
- return undefined
- }
-}
-
-async function refreshPackageInfo (packageName, version) {
- const packageDir = path.join(projectDir, 'node_modules', packageName)
- const pluginConfigFile = path.join(packageDir, 'govuk-prototype-kit.config.json')
-
- const requiredPlugins = knownPlugins?.plugins?.required || []
-
- const required = (!(packageName === 'govuk-frontend' && config.getConfig().allowGovukFrontendUninstall)) && requiredPlugins.includes(packageName)
-
- let [
- packageJson,
- pluginConfig,
- registryInfo
- ] = await Promise.all([
- readJson(path.join(packageDir, 'package.json')),
- readJson(pluginConfigFile),
- requestRegistryInfo(packageName)
- ])
-
- if ([packageJson, pluginConfig, registryInfo, version].every(val => !val)) {
- return undefined
- }
-
- const distTags = registryInfo ? registryInfo['dist-tags'] : undefined
- let latestVersion = distTags?.latest
- if (distTags && config.getConfig().showPrereleases) {
- latestVersion = Object.values(distTags)
- .map(version => ({ version, date: registryInfo.time[version] }))
- .sort(sortByObjectKey('date'))
- .at(-1)
- .version
- }
- const versions = registryInfo ? Object.keys(registryInfo.versions) : []
-
- const installedPackageVersion = packageJson && projectPackage.dependencies[packageName]
- const installed = !!installedPackageVersion
- const installedLocally = installedPackageVersion?.startsWith('file:')
- const installedVersion = installed ? packageJson?.version : undefined
-
- let localVersion
-
- if (!installed) {
- // Retrieve the packageJson and pluginConfig from the registry if possible
- if (registryInfo) {
- packageJson = registryInfo?.versions ? registryInfo?.versions[latestVersion] : undefined
- pluginConfig = await getConfigForPackage(packageName)
- } else if (version) {
- packageJson = await readJson(path.join(path.relative(projectDir, version), 'package.json'))
- pluginConfig = await readJson(path.join(path.relative(projectDir, version), 'govuk-prototype-kit.config.json'))
- if (packageJson) {
- localVersion = version
- } else {
- return undefined
- }
- }
- }
-
- const available = !!knownPlugins?.plugins?.available.includes(packageName)
-
- if (!pluginConfig && getProxyPluginConfig(packageName)) {
- // Use the proxy pluginConfig if exists when no other plugin config can be found
- pluginConfig = getProxyPluginConfig(packageName)
- }
-
- if (installedLocally) {
- localVersion = path.resolve(installedPackageVersion.replace('file:', ''))
- }
-
- const pluginDependencies = pluginConfig?.pluginDependencies ? normaliseDependencies(pluginConfig.pluginDependencies) : undefined
-
- const packageInfo = {
- packageName,
- installed,
- installedVersion,
- installedLocally,
- available,
- required,
- latestVersion,
- versions,
- packageJson,
- pluginConfig,
- pluginDependencies,
- localVersion,
- installedPackageVersion
- }
-
- // Remove all undefined properties and save to cache
- packagesCache[packageName] = Object.fromEntries(Object.entries(packageInfo).filter(([_, value]) => value !== undefined))
-}
-
-async function lookupPackageInfo (packageName, version) {
- if (!packagesCache[packageName]) {
- await refreshPackageInfo(packageName, version)
- }
- return packagesCache[packageName]
-}
-
-const basePlugins = config.getConfig().basePlugins
-
-function emphasizeBasePlugins (plugins, nextPlugin) {
- if (basePlugins.includes(nextPlugin.packageName)) {
- return [nextPlugin, ...plugins]
- } else {
- return [...plugins, nextPlugin]
- }
-}
-
-function packageNameSort (pkgA, pkgB) {
- const nameA = pkgA.packageName.toLowerCase()
- const nameB = pkgB.packageName.toLowerCase()
- if (nameA > nameB) return 1
- if (nameA < nameB) return -1
- return 0
-}
-
-async function getInstalledPackages () {
- if (!Object.keys(packagesCache).length) {
- await startPackageTracker()
- }
- await waitForPackagesCache()
- return Object.values(packagesCache)
- .filter(({ installed }) => installed)
- .sort(packageNameSort)
- .reduce(emphasizeBasePlugins, [])
-}
-
-async function getAllPackages () {
- if (!Object.keys(packagesCache).length) {
- await startPackageTracker()
- }
- await waitForPackagesCache()
- return Object.values(packagesCache)
- .sort(packageNameSort)
- .reduce(emphasizeBasePlugins, [])
-}
-
-function sleep (ms) {
- return new Promise((resolve) => setTimeout(resolve, ms))
-}
-
-async function waitForPackagesCache () {
- let numberOfRetries = 20
- let waiting = !packageTrackerInterval
- while (waiting) {
- // If the packageTrackerInterval has been set, then packages cache has been populated at least once
- waiting = !packageTrackerInterval && numberOfRetries > 0
- numberOfRetries--
- if (numberOfRetries === 0) {
- console.log('Failed to load the package cache')
- } else {
- await sleep(250)
- }
- }
-}
-
-function normaliseDependencies (dependencies) {
- return dependencies.map((dependency) => {
- if (typeof dependency === 'string') {
- dependency = {
- packageName: dependency
- }
- }
- return dependency
- })
-}
-
-async function getDependentPackages (packageName, version, mode) {
- if (mode !== 'uninstall') {
- return []
- }
- if (!Object.keys(packagesCache).length) {
- await startPackageTracker()
- }
- await waitForPackagesCache()
- return Object.values(packagesCache)
- .filter(({ pluginDependencies }) => pluginDependencies?.some((pluginDependency) => pluginDependency === packageName || pluginDependency.packageName === packageName))
-}
-
-async function getDependencyPackages (packageName, version, mode) {
- if (!Object.keys(packagesCache).length) {
- await startPackageTracker()
- }
- await waitForPackagesCache()
- const pkg = await lookupPackageInfo(packageName, version)
- let pluginDependencies = pkg?.pluginDependencies
- if (version || mode === 'update') {
- const targetVersion = version || pkg.latestVersion
- if (targetVersion !== pkg.installedVersion) {
- const latestPluginConfig = await getConfigForPackage(pkg.packageName, version)
- if (latestPluginConfig) {
- pluginDependencies = latestPluginConfig.pluginDependencies
- }
- }
- }
- const dependencyPlugins = !pluginDependencies
- ? []
- : await Promise.all(normaliseDependencies(pluginDependencies).map((pluginDependency) => {
- return lookupPackageInfo(pluginDependency.packageName)
- }))
-
- return dependencyPlugins.filter(({ installed }) => !installed)
-}
-
-if (!config.getConfig().isTest) {
- startPackageTracker()
-}
-
-function setPackagesCache (packagesInfo) {
- // Only used for unit tests
- while (packagesCache.length) {
- packagesCache.pop()
- }
- packagesInfo.forEach((packageInfo) => {
- packagesCache[packageInfo.packageName] = packageInfo
- })
- packageTrackerInterval = true
-}
-
-module.exports = {
- setPackagesCache, // Only for unit testing purposes
- waitForPackagesCache,
- lookupPackageInfo,
- getInstalledPackages,
- getAllPackages,
- getDependentPackages,
- getDependencyPackages
-}
diff --git a/lib/plugins/packages.spec.js b/lib/plugins/packages.spec.js
deleted file mode 100644
index 3fbfbdb218..0000000000
--- a/lib/plugins/packages.spec.js
+++ /dev/null
@@ -1,282 +0,0 @@
-/* eslint-env jest */
-
-jest.mock('fs-extra')
-jest.mock('../utils/requestHttps')
-
-// node dependencies
-const path = require('path')
-
-// npm dependencies
-const fse = require('fs-extra')
-
-// local dependencies
-const packages = require('./packages')
-const { lookupPackageInfo } = packages
-const requestHttps = require('../utils/requestHttps')
-const {
- getInstalledPackages,
- setPackagesCache,
- getAllPackages,
- getDependentPackages,
- getDependencyPackages
-} = require('./packages')
-const registryUrl = 'https://registry.npmjs.org/'
-
-jest.mock('../../package.json', () => {
- return {
- dependencies: {
- '@govuk-prototype-kit/common-templates': '1.0.0'
- }
- }
-})
-
-describe('packages', () => {
- beforeEach(() => {
- setPackagesCache([])
- })
-
- afterEach(() => {
- jest.restoreAllMocks()
- })
-
- describe('get packages', () => {
- const availableInstalledPackage = {
- packageName: 'available-installed-package',
- installed: true,
- available: true,
- installedVersion: '1.0.0',
- latestVersion: '1.0.0'
- }
- const availableUninstalledPackage = {
- packageName: 'available-uninstalled-package',
- installed: false,
- available: true,
- latestVersion: '1.0.0'
- }
- const unavailableInstalledPackage = {
- packageName: 'unavailable-installed-package',
- installed: true,
- available: false,
- installedVersion: '1.0.0',
- latestVersion: '1.0.0',
- pluginDependencies: [availableInstalledPackage]
- }
- const unavailableUninstalledPackage = {
- packageName: 'unavailable-uninstalled-package',
- installed: false,
- available: false,
- latestVersion: '1.0.0',
- pluginDependencies: [availableUninstalledPackage]
- }
-
- beforeEach(() => {
- setPackagesCache([
- availableInstalledPackage,
- availableUninstalledPackage,
- unavailableInstalledPackage,
- unavailableUninstalledPackage])
- })
-
- describe('getInstalledPackages', () => {
- it('', async () => {
- const installedPackages = await getInstalledPackages()
- expect(installedPackages).toEqual([availableInstalledPackage, unavailableInstalledPackage])
- })
- })
-
- describe('getAllPackages', () => {
- it('', async () => {
- const allPackages = await getAllPackages()
- expect(allPackages).toEqual([
- availableInstalledPackage,
- availableUninstalledPackage,
- unavailableInstalledPackage,
- unavailableUninstalledPackage])
- })
- })
-
- describe('getDependentPackages', () => {
- it('when mode is uninstall', async () => {
- const dependentPackages = await getDependentPackages(availableInstalledPackage.packageName, undefined, 'uninstall')
- expect(dependentPackages).toEqual([unavailableInstalledPackage])
- })
-
- it('when mode is update', async () => {
- const dependentPackages = await getDependentPackages(availableInstalledPackage.packageName, '1.1.1', 'update')
- expect(dependentPackages).toEqual([])
- })
- })
-
- describe('getDependencyPackages', () => {
- it('', async () => {
- const dependencyPackages = await getDependencyPackages(unavailableUninstalledPackage.packageName)
- expect(dependencyPackages).toEqual([availableUninstalledPackage])
- })
- })
- })
-
- describe('lookupPackageInfo', () => {
- let packageJson, pluginJson
-
- async function mockReadJson (fullFileName) {
- const fileName = fullFileName.substring(fullFileName.lastIndexOf(path.sep) + 1)
- if (fileName === 'package.json') {
- return packageJson
- } else if (fileName === 'govuk-prototype-kit.config.json') {
- return pluginJson
- }
- }
-
- beforeEach(() => {
- packageJson = {
- local: true,
- version: '1.0.0'
- }
- pluginJson = {
- loaded: true
- }
- jest.spyOn(requestHttps, 'requestHttpsJson').mockImplementation(async (url) => {
- switch (decodeURIComponent(url.replace(registryUrl, ''))) {
- case 'jquery':
- return {
- 'dist-tags': { latest: '2.0.0' },
- versions: {
- '1.0.0': { version: '1.0.0' },
- '2.0.0': { version: '2.0.0' }
- }
- }
- case '@govuk-prototype-kit/common-templates':
- return {
- 'dist-tags': { latest: '1.0.1' },
- versions: {
- '1.0.0': { version: '1.0.0' },
- '1.0.1': { version: '1.0.1' }
- }
- }
- case '@govuk-prototype-kit/task-list':
- return {
- 'dist-tags': { latest: '1.0.0' },
- versions: {
- '1.0.0': { version: '1.0.0' }
- }
- }
- default:
- return undefined
- }
- })
- })
-
- it('lookup installed approved plugin', async () => {
- const packageName = '@govuk-prototype-kit/common-templates'
-
- jest.spyOn(fse, 'pathExists').mockResolvedValue(true)
- jest.spyOn(fse, 'readJson').mockImplementation(mockReadJson)
-
- const packageInfo = await lookupPackageInfo(packageName)
-
- expect(requestHttps.requestHttpsJson).toHaveBeenCalledWith(registryUrl + encodeURIComponent(packageName))
-
- expect(packageInfo).toEqual({
- packageName,
- available: true,
- installed: true,
- installedLocally: false,
- installedPackageVersion: '1.0.0',
- installedVersion: '1.0.0',
- latestVersion: '1.0.1',
- required: false,
- packageJson: {
- local: true,
- version: '1.0.0'
- },
- pluginConfig: {
- loaded: true
- },
- versions: [
- '1.0.0',
- '1.0.1'
- ]
- })
- })
-
- it('lookup uninstalled approved plugin', async () => {
- const packageName = '@govuk-prototype-kit/task-list'
- const packageInfo = await lookupPackageInfo(packageName)
-
- expect(requestHttps.requestHttpsJson).toHaveBeenCalledWith(registryUrl + encodeURIComponent(packageName))
-
- expect(packageInfo).toEqual({
- packageName,
- available: true,
- installed: false,
- latestVersion: '1.0.0',
- required: false,
- packageJson: {
- version: '1.0.0'
- },
- versions: [
- '1.0.0'
- ]
- })
- })
-
- it('lookup uninstalled approved proxy plugin', async () => {
- const packageName = 'jquery'
- const packageInfo = await lookupPackageInfo(packageName)
-
- expect(requestHttps.requestHttpsJson).toHaveBeenCalledWith(registryUrl + encodeURIComponent(packageName))
-
- expect(packageInfo).toEqual({
- packageName,
- available: true,
- installed: false,
- latestVersion: '2.0.0',
- required: false,
- packageJson: {
- version: '2.0.0'
- },
- pluginConfig: {
- assets: [
- '/dist'
- ],
- scripts: [
- '/dist/jquery.js'
- ],
- meta: {
- description: 'jQuery is a fast, small, and feature-rich JavaScript library. It makes things like HTML document traversal and manipulation, event handling, animation, and Ajax much simpler with an easy-to-use API that works across a multitude of browsers.'
- }
- },
- versions: [
- '1.0.0',
- '2.0.0'
- ]
- })
- })
-
- it('lookup uninstalled local plugin', async () => {
- const packageName = 'local-plugin'
- const version = '/local/folder/local-plugin'
- jest.spyOn(fse, 'pathExists').mockResolvedValue(true)
- jest.spyOn(fse, 'readJson').mockImplementation(mockReadJson)
- const packageInfo = await lookupPackageInfo(packageName, version)
-
- expect(requestHttps.requestHttpsJson).toHaveBeenCalledWith(registryUrl + encodeURIComponent(packageName))
-
- expect(packageInfo).toEqual({
- available: false,
- installed: false,
- localVersion: version,
- packageJson: {
- local: true,
- version: '1.0.0'
- },
- packageName,
- pluginConfig: {
- loaded: true
- },
- required: false,
- versions: []
- })
- })
- })
-})
diff --git a/lib/plugins/plugin-utils.js b/lib/plugins/plugin-utils.js
deleted file mode 100644
index 63154073d7..0000000000
--- a/lib/plugins/plugin-utils.js
+++ /dev/null
@@ -1,22 +0,0 @@
-// This allows npm modules to act as if they are plugins by providing the plugin config for them
-function getProxyPluginConfig (packageName) {
- const proxyPluginConfig = {
- jquery: {
- scripts: ['/dist/jquery.js'],
- assets: ['/dist'],
- meta: {
- description: 'jQuery is a fast, small, and feature-rich JavaScript library. It makes things like HTML document traversal and manipulation, event handling, animation, and Ajax much simpler with an easy-to-use API that works across a multitude of browsers.'
- }
- },
- 'notifications-node-client': {
- meta: {
- description: 'GOV.UK Notify makes it easy for public sector service teams to send emails, text messages and letters.'
- }
- }
- }
- return proxyPluginConfig[packageName] ? { ...proxyPluginConfig[packageName] } : undefined
-}
-
-module.exports = {
- getProxyPluginConfig
-}
diff --git a/lib/plugins/plugins.js b/lib/plugins/plugins.js
index 900468ed1b..773d90a098 100644
--- a/lib/plugins/plugins.js
+++ b/lib/plugins/plugins.js
@@ -45,7 +45,7 @@ const fse = require('fs-extra')
const appConfig = require('../config')
const { projectDir, shadowNunjucksDir } = require('../utils/paths')
const { startPerformanceTimer, endPerformanceTimer } = require('../utils/performance')
-const { getProxyPluginConfig } = require('./plugin-utils')
+const { plugins: { proxyConfig: proxyPluginConfig } } = require('../../known-plugins.json')
const pkgPath = path.join(projectDir, 'package.json')
const pkgLockPath = path.join(projectDir, 'package-lock.json')
@@ -71,10 +71,10 @@ function getPluginConfig (packageName) {
endPerformanceTimer('getPluginConfig (fileSystem)', timer)
return readJsonFile(pluginConfigFile)
}
- const proxyPluginConfig = getProxyPluginConfig(packageName)
- if (proxyPluginConfig) {
+ const proxyPluginConfigForPackage = proxyPluginConfig && proxyPluginConfig[packageName]
+ if (proxyPluginConfigForPackage) {
endPerformanceTimer('getPluginConfig (backup)', timer)
- return proxyPluginConfig
+ return proxyPluginConfigForPackage
}
endPerformanceTimer('getPluginConfig (empty)', timer)
return {}
@@ -205,7 +205,9 @@ const knownWordsToFormat = {
ho: 'HO',
ons: 'ONS',
jquery: 'jQuery',
- dwp: 'DWP'
+ dwp: 'DWP',
+ tpr: 'TPR',
+ ministryofjustice: 'Ministry of Justice'
}
function prepareWordForPackageNameDisplay (word) {
@@ -219,12 +221,15 @@ function prepareWordForPackageNameDisplay (word) {
}
function prepareName (name) {
+ if (name === 'x-govuk') {
+ return name
+ }
return name
.split('-')
.map(prepareWordForPackageNameDisplay).join(' ')
}
-function preparePackageNameForDisplay (packageName, version) {
+function preparePackageNameForDisplay (packageName) {
const safePackageName = (packageName || '')
const packageNameDetails = {}
@@ -236,10 +241,6 @@ function preparePackageNameForDisplay (packageName, version) {
packageNameDetails.name = prepareName(safePackageName)
}
- if (version) {
- packageNameDetails.version = version
- }
-
return packageNameDetails
}
diff --git a/lib/utils/functionCache.js b/lib/utils/functionCache.js
new file mode 100644
index 0000000000..2615a24252
--- /dev/null
+++ b/lib/utils/functionCache.js
@@ -0,0 +1,67 @@
+const fs = require('fs')
+const fsp = fs.promises
+const fse = require('fs-extra')
+const config = require('../config')
+
+function cacheFunctionCalls (fn, options = {}) {
+ const stored = {}
+ const loadResponsePromise = options.persistance?.load || ((signature) => stored[signature])
+ const savePromise = options.persistance?.save || ((signature, promise) => { stored[signature] = promise })
+ const remove = options.persistance?.remove || ((signature) => { delete stored[signature] })
+ return async function () {
+ if (config.getConfig().turnOffFunctionCaching) {
+ return await fn.apply(null, arguments)
+ }
+ const signature = Buffer.from(JSON.stringify([...arguments])).toString('base64')
+ const response = loadResponsePromise(signature)
+ if (response) {
+ return await response
+ }
+ await savePromise(signature, fn.apply(null, arguments))
+ if (options.maxTimeMinutes) {
+ setTimeout(() => {
+ remove(signature)
+ }, options.maxTimeMinutes * 60 * 1000)
+ }
+ return await loadResponsePromise(signature)
+ }
+}
+
+function createFSCache (getCachePath) {
+ const accessOnce = {}
+ return {
+ save: async (signature, promise) => {
+ const fileLocation = getCachePath(signature)
+ const value = await promise
+ if (value) {
+ await fsp.writeFile(fileLocation, JSON.stringify({ value })).catch(x => {
+ console.error('error writing to FS cache', signature)
+ console.error(x)
+ })
+ } else {
+ accessOnce[signature] = value
+ }
+ },
+ load: (signature) => {
+ const fileLocation = getCachePath(signature)
+ if (accessOnce[signature]) {
+ delete accessOnce[signature]
+ return accessOnce[signature]
+ }
+ if (fs.existsSync(fileLocation)) {
+ return fsp.readFile(fileLocation).then(x => JSON.parse(x)?.value)
+ }
+ },
+ delete: async (signature) => {
+ const fileLocation = getCachePath(signature)
+ if (await fse.exists(fileLocation)) {
+ await fsp.rm(fileLocation)
+ }
+ }
+ }
+}
+
+module.exports = {
+ cacheFunctionCalls,
+ createFSCache
+}
diff --git a/lib/utils/functionCache.spec.js b/lib/utils/functionCache.spec.js
new file mode 100644
index 0000000000..23b791ec2b
--- /dev/null
+++ b/lib/utils/functionCache.spec.js
@@ -0,0 +1,18 @@
+const { cacheFunctionCalls } = require('./functionCache')
+describe('function cache', () => {
+ it('should wrap a function without changing the behaviour', async () => {
+ const fn = jest.fn().mockReturnValueOnce('Hi there')
+
+ const wrapped = cacheFunctionCalls(fn)
+
+ expect(fn).not.toHaveBeenCalled()
+
+ const result = await wrapped('hello', 'world')
+
+ expect(fn).toHaveBeenCalledWith('hello', 'world')
+ expect(result).toBe('Hi there')
+
+ expect(await wrapped('hello', 'world2')).toBe(undefined)
+ expect(await wrapped('hello', 'world')).toBe('Hi there')
+ })
+})
diff --git a/lib/utils/packageDetails.js b/lib/utils/packageDetails.js
new file mode 100644
index 0000000000..183f660873
--- /dev/null
+++ b/lib/utils/packageDetails.js
@@ -0,0 +1,308 @@
+const fsp = require('fs').promises
+const path = require('path')
+const fse = require('fs-extra')
+const requestHttps = require('./requestHttps')
+const { preparePackageNameForDisplay } = require('../plugins/plugins')
+const { projectDir } = require('./paths')
+const encode = encodeURIComponent
+const { plugins: { available: availablePlugins, proxyConfig: pluginProxyConfig } } = require('../../known-plugins.json')
+const { cacheFunctionCalls } = require('./functionCache')
+const { getConfig } = require('../config')
+const { sortByObjectKey } = require('./index')
+
+const packageJsonFilePath = path.join(projectDir, 'package.json')
+const contextPath = 'manage-prototype'
+const doesntExistResponse = {
+ exists: false
+}
+
+const encodeRef = ref => encode(ref).replaceAll('%3A', ':')
+
+const requestJson = cacheFunctionCalls((url) => requestHttps.requestHttpsJson(url), { maxTimeMinutes: 20 })
+
+const errorResult = (errorDetails) => ({
+ error: true,
+ errorDetails
+})
+
+async function getPluginDetailsFromNpm (packageName, version) {
+ if (!version) {
+ throw new Error('No version specified, version must be specified')
+ }
+ try {
+ let registerEntry
+ try {
+ registerEntry = await requestJson(`https://registry.npmjs.org/${encode(packageName)}`)
+ } catch (e) {
+ if (e.statusCode === 404) {
+ return doesntExistResponse
+ }
+ console.error('non-404 error when requesting registry (a)')
+ throw e
+ }
+ const versionConfig = registerEntry.versions[version]
+ if (versionConfig) {
+ const npmIdentifier = `${registerEntry.name}@${version}`
+ return await addStandardDetails({
+ exists: true,
+ packageName: registerEntry.name,
+ version,
+ releaseDateTime: registerEntry.time[version],
+ npmIdentifier,
+ legacyInstallQueryString: `?package=${encode(packageName)}&version=${encode(version)}`,
+ internalRef: `npm:${packageName}:${version}`,
+ origin: 'NPM',
+ pluginConfig: await requestHttps.getPluginConfigContentsFromNodeModule(versionConfig.dist.tarball)
+ })
+ } else {
+ return doesntExistResponse
+ }
+ } catch (e) {
+ console.error('error looking up plugin from npm', e)
+ return errorResult(e)
+ }
+}
+
+async function getLatestPluginDetailsFromNpm (packageName) {
+ try {
+ let result
+ try {
+ const registerEntry = await requestJson(`https://registry.npmjs.org/${encode(packageName)}`)
+ let versionTag = 'latest'
+ if (getConfig().showPrereleases) {
+ versionTag = Object.keys(registerEntry['dist-tags']).map(tag => ({
+ tag,
+ date: registerEntry.time[registerEntry['dist-tags'][tag]]
+ })).sort(sortByObjectKey('date')).at(-1).tag
+ }
+ result = await self.getPluginDetailsFromNpm(packageName, registerEntry['dist-tags'][versionTag])
+ } catch (e) {
+ if (e.statusCode === 404) {
+ return doesntExistResponse
+ }
+ console.error('non-404 error when requesting registry (b)')
+ throw e
+ }
+ result.internalRef = `npm:${result.packageName}`
+ return addStandardDetails(result)
+ } catch (e) {
+ console.error('error looking up latest plugin from npm', e)
+ return errorResult(e)
+ }
+}
+
+async function getPluginDetailsFromGithub (org, project, branch) {
+ try {
+ let githubDetails
+ try {
+ githubDetails = await requestJson(`https://api.github.com/repos/${encode(org)}/${encode(project)}`)
+ } catch (e) {
+ if (e.statusCode === 404) {
+ return doesntExistResponse
+ }
+ console.log('Unexpected error when looking up in Github', e)
+ throw e
+ }
+ const chosenBranch = branch || githubDetails.default_branch
+ const updatedTimePromise = requestJson(githubDetails.branches_url.replace('{/branch}', '/' + chosenBranch))
+ .then(x => x.commit.commit.author.date)
+ .catch(_ => undefined)
+ const getJsonFileContentsFromGithubApi = async path => JSON.parse(await requestJson(githubDetails.contents_url.replace('{+path}', `${encode(path)}`) + `?ref=${encode(chosenBranch)}`).then(result => Buffer.from(result.content, 'base64').toString()))
+ const packageJsonContents = await getJsonFileContentsFromGithubApi('/package.json').catch(e => undefined)
+ const pluginConfig = await getJsonFileContentsFromGithubApi('/govuk-prototype-kit.config.json').catch(e => undefined)
+ if (!packageJsonContents) {
+ return doesntExistResponse
+ }
+ const npmIdentifier = `github:${org}/${project}` + (branch ? `#${chosenBranch}` : '')
+ const packageName = packageJsonContents.name
+ const version = packageJsonContents.version
+ const refParts = ['github', org, project]
+ if (branch) {
+ refParts.push(branch)
+ }
+ return await addStandardDetails({
+ exists: true,
+ packageName,
+ version,
+ releaseDateTime: await updatedTimePromise,
+ legacyInstallQueryString: `?package=${encode(packageName)}&version=${encode(npmIdentifier)}`,
+ npmIdentifier,
+ pluginConfig,
+ origin: 'Github',
+ internalRef: refParts.join(':')
+ })
+ } catch (e) {
+ console.error('error looking up plugin from Github', e)
+ return errorResult(e)
+ }
+}
+
+async function getPluginDetailsFromFileSystem (pluginPath) {
+ try {
+ const packageJsonText = await fsp.readFile(path.join(pluginPath, 'package.json'), 'utf8').catch(e => undefined)
+ const pluginConfigText = await fsp.readFile(path.join(pluginPath, 'govuk-prototype-kit.config.json'), 'utf8').catch(e => undefined)
+
+ if (!packageJsonText) {
+ return doesntExistResponse
+ }
+
+ const packageJson = JSON.parse(packageJsonText)
+ const pluginConfig = pluginConfigText && JSON.parse(pluginConfigText)
+
+ const internalRef = `fs:${pluginPath}`
+ return await addStandardDetails({
+ exists: true,
+ packageName: packageJson.name,
+ version: packageJson.version,
+ queryString: `?package=${encode(packageJson.name)}&version=${encode(pluginPath)}`,
+ npmIdentifier: `file:${pluginPath}`,
+ origin: 'File System',
+ internalRef,
+ pluginConfig
+ })
+ } catch (e) {
+ console.error('error looking up plugin from file system', e)
+ return errorResult(e)
+ }
+}
+
+async function addStandardDetails (config) {
+ const updatedConfig = { ...config, ...preparePackageNameForDisplay(config.packageName) }
+
+ updatedConfig.links = {
+ pluginDetails: ['', contextPath, 'plugin', updatedConfig.internalRef].map(encodeRef).join('/')
+ }
+ updatedConfig.links.install = [updatedConfig.links.pluginDetails, 'install'].join('/')
+ updatedConfig.links.uninstall = [updatedConfig.links.pluginDetails, 'uninstall'].join('/')
+ updatedConfig.links.update = [updatedConfig.links.pluginDetails, 'update'].join('/')
+
+ updatedConfig.commands = updatedConfig.commands || {}
+ updatedConfig.commands.uninstall = updatedConfig.commands.uninstall || `npm uninstall ${updatedConfig.packageName}`
+ updatedConfig.commands.update = updatedConfig.commands.update || `npm install ${updatedConfig.packageName}@latest --save-exact`
+ updatedConfig.commands.install = updatedConfig.commands.install || `npm install ${updatedConfig.npmIdentifier} --save-exact`
+
+ const proxyConfig = pluginProxyConfig[config.packageName] || {}
+
+ Object.keys(proxyConfig).forEach(key => {
+ if (!updatedConfig?.pluginConfig || !updatedConfig?.pluginConfig[key]) {
+ updatedConfig.pluginConfig = updatedConfig.pluginConfig || {}
+ updatedConfig.pluginConfig[key] = proxyConfig[key]
+ }
+ })
+
+ return updatedConfig
+}
+
+async function getInstalledPluginDetails (packageName) {
+ try {
+ const packageJson = await fse.readJson(packageJsonFilePath)
+ const npmId = packageJson.dependencies[packageName]
+
+ if (!npmId) {
+ return doesntExistResponse
+ }
+
+ const [prefix, id] = npmId.split(':')
+
+ if (prefix === 'github') {
+ const [ghid, branch] = id.split('#')
+ const [org, project] = ghid.split('/')
+ return await getPluginDetailsFromGithub(org, project, branch)
+ } else if (prefix === 'file') {
+ return await getPluginDetailsFromFileSystem(path.resolve(projectDir, id))
+ } else {
+ const packageJson = await fse.readJson(path.join(projectDir, 'node_modules', packageName, 'package.json'))
+ return await getPluginDetailsFromNpm(packageName, packageJson.version)
+ }
+ } catch (e) {
+ console.error('error looking up plugin details', e)
+ return errorResult(e)
+ }
+}
+
+async function getPluginDetailsFromRef (ref) {
+ try {
+ const refSafe = ref || ''
+ const [source, id, ...extra] = refSafe.split(':')
+ const everythingAfterSource = refSafe.substring(refSafe.indexOf(':') + 1)
+
+ if (source === 'installed') {
+ return await self.getInstalledPluginDetails(everythingAfterSource)
+ }
+ if (source === 'fs') {
+ return await self.getPluginDetailsFromFileSystem(everythingAfterSource)
+ }
+ if (source === 'github') {
+ if (extra[1]) {
+ return await self.getPluginDetailsFromGithub(id, extra[0], extra[1])
+ } else {
+ return await self.getPluginDetailsFromGithub(id, extra[0])
+ }
+ }
+ if (source === 'npm') {
+ if (extra[0]) {
+ return await self.getPluginDetailsFromNpm(id, extra[0])
+ } else {
+ return await self.getLatestPluginDetailsFromNpm(everythingAfterSource)
+ }
+ }
+ } catch (e) {
+ console.error('error looking up plugin from ref', e)
+ return errorResult(e)
+ }
+}
+
+async function getInstalledPackages () {
+ try {
+ const packageJson = await fse.readJson(packageJsonFilePath)
+
+ return await Promise.all(Object.keys(packageJson.dependencies).map(async packageName => {
+ const result = await getInstalledPluginDetails(packageName)
+ return result
+ }))
+ } catch (e) {
+ console.error('error looking up installed packages', e)
+ return errorResult(e)
+ }
+}
+
+async function getKnownPlugins () {
+ try {
+ return await Promise.all(availablePlugins.map(async packageName => getLatestPluginDetailsFromNpm(packageName)))
+ } catch (e) {
+ console.error('error getting known plugins', e)
+ return errorResult(e)
+ }
+}
+
+async function isInstalled (ref) {
+ try {
+ const plugin = await getPluginDetailsFromRef(ref)
+ if (!plugin || !plugin.exists) {
+ return false
+ }
+ const isInPackageJson = await fse.readJson(packageJsonFilePath).then(x => Object.keys(x.dependencies).includes(plugin.packageName))
+ const isInFileSystem = await fse.exists(path.join(projectDir, 'node_modules', plugin.packageName))
+ return isInPackageJson && isInFileSystem
+ } catch (e) {
+ console.error('error looking up plugin from npm', e)
+ return errorResult(e)
+ }
+}
+
+const self = {
+ getInstalledPackages,
+ getKnownPlugins,
+ getPluginDetailsFromFileSystem,
+ getInstalledPluginDetails,
+ getPluginDetailsFromRef,
+ isInstalled
+}
+
+self.getPluginDetailsFromGithub = cacheFunctionCalls(getPluginDetailsFromGithub, { maxTimeMinutes: 20 })
+self.getPluginDetailsFromNpm = cacheFunctionCalls(getPluginDetailsFromNpm, { maxTimeMinutes: 120 })
+self.getLatestPluginDetailsFromNpm = cacheFunctionCalls(getLatestPluginDetailsFromNpm, { maxTimeMinutes: 20 })
+self.getInstalledPackages = getInstalledPackages
+self.getKnownPlugins = getKnownPlugins
+
+module.exports = self
diff --git a/lib/utils/packageDetails.spec.js b/lib/utils/packageDetails.spec.js
new file mode 100644
index 0000000000..bb2510f097
--- /dev/null
+++ b/lib/utils/packageDetails.spec.js
@@ -0,0 +1,388 @@
+const requestHttps = require('./requestHttps')
+const packageDetails = require('./packageDetails')
+const {
+ getLatestPluginDetailsFromNpm,
+ getPluginDetailsFromGithub,
+ getPluginDetailsFromFileSystem
+} = require('./packageDetails')
+const { mockFileSystem } = require('../../__tests__/utils/mock-file-system')
+const path = require('path')
+const { getPluginDetailsFromNpm } = packageDetails
+const config = require('../config')
+
+function notFound (url) {
+ const error = new Error(`Bad response from ${url}`)
+ error.statusCode = 404
+ error.code = 'EBADRESPONSE'
+ return Promise.reject(error)
+}
+
+function addExpectedLinks (config) {
+ const pluginDetails = ['', 'manage-prototype', 'plugin', config.internalRef].map(encodeURIComponent).join('/').replaceAll('%3A', ':')
+ return {
+ ...config,
+ links: {
+ install: pluginDetails + '/install',
+ uninstall: pluginDetails + '/uninstall',
+ update: pluginDetails + '/update',
+ pluginDetails
+ }
+ }
+}
+
+describe.only('Package Details', () => {
+ let testScope
+ beforeEach(() => {
+ testScope = {
+ jsonResultForUrl: {
+ 'https://registry.npmjs.org/example-plugin': {
+ name: 'example-plugin',
+ description: 'An example NPM package',
+ 'dist-tags': {
+ latest: '1.0.1'
+ },
+ versions: {
+ '1.0.0': {
+ name: 'example-plugin',
+ version: '1.0.0',
+ description: 'An example NPM package',
+ dist: {
+ shasum: '8be6695eb2443505bb8fe1e1d3a01b7b8e639677',
+ tarball: 'https://registry.npmjs.org/example-plugin/-/example-plugin-1.0.0.tgz',
+ integrity: 'sha512-KZXSIpe+EQIrB4RBmLnL/FOI+g3QjAsuq4b0VVMhYkueW0esfa+rsAwsiCMGG4mWGy131Ejf5Jg61DeFC/PM9A==',
+ signatures: [
+ {
+ keyid: 'SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA',
+ sig: 'MEQCIGyCHSLow3MXz1cJogT8P2+NMtPleu9k0hkYqaDKMGdtAiAA88G0H+Gs6y88fFenFsnJm93+9AuENeO5XZSGMHHgUQ=='
+ }
+ ]
+ }
+ },
+ '1.0.1': {
+ name: 'example-plugin',
+ version: '1.0.1',
+ description: 'An example NPM package',
+ dist: {
+ shasum: '7f2872c10dbb30e2fa9fd95aabcb788ef39a223a',
+ tarball: 'https://registry.npmjs.org/example-plugin/-/example-plugin-1.0.1.tgz',
+ integrity: 'sha512-x+tWXVO6JFiwh+nykmGnCQqBzk+S4jh+aKiJ79uHXoouc1hkww+iqUzvjwfEhl7dW1kTie28+YakTbcmbITUzA==',
+ signatures: [
+ {
+ keyid: 'SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA',
+ sig: 'MEUCIDzMp4vQnulE7D1NSpvU62JenUqkj/ptiE1xH+JTg79iAiEA0Onsp3exZb7WPrE2NB7wd6gQ3NCY5jIhTQeytz5+YH4='
+ }
+ ]
+ }
+ }
+ },
+ time: {
+ modified: '2022-06-19T05:31:34.523Z',
+ created: '2015-02-01T00:43:35.034Z',
+ '1.0.0': '2015-02-01T00:43:35.034Z',
+ '1.0.2': '2015-04-03T16:05:22.839Z'
+ }
+ },
+ 'https://api.github.com/repos/x-govuk/example-plugin': {
+ name: 'example-plugin',
+ full_name: 'x-govuk/example-plugin',
+ contents_url: 'https://api.github.com/repos/x-govuk/example-plugin/contents/{+path}',
+ branches_url: 'https://api.github.com/repos/x-govuk/edit-prototype-in-browser/branches{/branch}',
+ default_branch: 'main'
+ },
+ 'https://api.github.com/repos/x-govuk/example-plugin/contents/%2Fpackage.json?ref=main': {
+ content: Buffer.from(JSON.stringify({
+ name: 'this-is-the-package-name',
+ version: '100.200.300'
+ })).toString('base64')
+ },
+ 'https://api.github.com/repos/x-govuk/example-plugin/contents/%2Fgovuk-prototype-kit.config.json?ref=main': {
+ content: Buffer.from(JSON.stringify({
+ hello: 'world'
+ })).toString('base64')
+ },
+ 'https://api.github.com/repos/x-govuk/example-plugin/contents/%2Fpackage.json?ref=my-spike': {
+ content: Buffer.from(JSON.stringify({
+ name: 'this-is-the-package-name',
+ version: '100.200.301'
+ })).toString('base64')
+ },
+ 'https://api.github.com/repos/x-govuk/example-plugin/contents/%2Fgovuk-prototype-kit.config.json?ref=my-spike': {
+ content: Buffer.from(JSON.stringify({
+ meta: {
+ description: 'This is the plugin description.'
+ }
+ })).toString('base64')
+ },
+ 'https://example.com/hello': 'Hi there'
+ },
+ getPluginConfigContentsFromNodeModule: {
+ 'https://registry.npmjs.org/example-plugin/-/example-plugin-1.0.0.tgz': {
+ scripts: ['/example.js']
+ },
+ 'https://registry.npmjs.org/example-plugin/-/example-plugin-1.0.1.tgz': {
+ assets: ['/all-the-assets']
+ }
+ }
+ }
+ jest.spyOn(config, 'getConfig').mockReturnValue({
+ turnOffFunctionCaching: true
+ })
+ jest.spyOn(requestHttps, 'requestHttpsJson').mockImplementation((url) => {
+ const result = testScope.jsonResultForUrl[url]
+ if (result) {
+ return Promise.resolve(result)
+ }
+ return notFound(url)
+ })
+ jest.spyOn(requestHttps, 'getPluginConfigContentsFromNodeModule').mockImplementation((url) => {
+ const result = testScope.getPluginConfigContentsFromNodeModule[url]
+ if (result) {
+ return Promise.resolve(result)
+ }
+ return notFound('some-url')
+ })
+ })
+ afterEach(() => {
+ jest.restoreAllMocks()
+ })
+
+ describe('httpMock', () => {
+ it('should show mock response', async () => {
+ expect(await requestHttps.requestHttpsJson('https://example.com/hello')).toEqual('Hi there')
+ })
+ })
+
+ describe('getPluginDetailsFromNpm', () => {
+ it('should represent an NPM dependency', async () => {
+ expect(await getPluginDetailsFromNpm('example-plugin', '1.0.0')).toEqual(addExpectedLinks({
+ exists: true,
+ packageName: 'example-plugin',
+ version: '1.0.0',
+ name: 'Example Plugin',
+ origin: 'NPM',
+ legacyInstallQueryString: '?package=example-plugin&version=1.0.0',
+ npmIdentifier: 'example-plugin@1.0.0',
+ internalRef: 'npm:example-plugin:1.0.0',
+ releaseDateTime: '2015-02-01T00:43:35.034Z',
+ pluginConfig: {
+ scripts: [
+ '/example.js'
+ ]
+ },
+ commands: {
+ install: 'npm install example-plugin@1.0.0 --save-exact',
+ uninstall: 'npm uninstall example-plugin',
+ update: 'npm install example-plugin@latest --save-exact'
+ }
+ }))
+ })
+ it('should error if the no version provided', async () => {
+ const expectedError = new Error('No version specified, version must be specified')
+
+ getPluginDetailsFromNpm('example-plugin')
+ .then(() => {
+ throw new Error('error expected, but no error thrown')
+ })
+ .catch(err => {
+ expect(err.message).toEqual(expectedError.message)
+ })
+ })
+ it('should fail if the version doesn\'t exist', async () => {
+ expect(await getPluginDetailsFromNpm('example-plugin', '1.0.3')).toEqual({
+ exists: false
+ })
+ })
+ it('should fail if package doesn\'t exist', async () => {
+ delete testScope.jsonResultForUrl['https://registry.npmjs.org/example-plugin']
+ expect(await getPluginDetailsFromNpm('example-plugin', '1.0.0')).toEqual({
+ exists: false
+ })
+ })
+ })
+
+ describe('getLatestPluginDetailsFromNpm', () => {
+ beforeEach(() => {
+ testScope.mockedResult = { packageName: 'example-plugin', npmIdentifier: 'example-plugin' }
+ jest.spyOn(packageDetails, 'getPluginDetailsFromNpm').mockReturnValue(testScope.mockedResult)
+ })
+ it('should get the latest package number and proxy', async () => {
+ const result = await getLatestPluginDetailsFromNpm('example-plugin')
+
+ expect(packageDetails.getPluginDetailsFromNpm).toHaveBeenCalledWith('example-plugin', '1.0.1')
+
+ expect(result).toEqual({
+ ...addExpectedLinks(testScope.mockedResult),
+ commands: {
+ install: 'npm install example-plugin --save-exact',
+ uninstall: 'npm uninstall example-plugin',
+ update: 'npm install example-plugin@latest --save-exact'
+ },
+ name: 'Example Plugin'
+ })
+ })
+ it('should use the latest from dist-tags', async () => {
+ testScope.jsonResultForUrl['https://registry.npmjs.org/example-plugin']['dist-tags'].latest = '1.0.0'
+ const result = await getLatestPluginDetailsFromNpm('example-plugin')
+
+ expect(packageDetails.getPluginDetailsFromNpm).toHaveBeenCalledWith('example-plugin', '1.0.0')
+
+ expect(result).toEqual({
+ ...addExpectedLinks(testScope.mockedResult),
+ commands: {
+ install: 'npm install example-plugin --save-exact',
+ uninstall: 'npm uninstall example-plugin',
+ update: 'npm install example-plugin@latest --save-exact'
+ },
+ name: 'Example Plugin'
+ })
+ })
+ it('should fail if package doesn\'t exist', async () => {
+ delete testScope.jsonResultForUrl['https://registry.npmjs.org/example-plugin']
+ expect(await getLatestPluginDetailsFromNpm('example-plugin')).toEqual({
+ exists: false
+ })
+ })
+ })
+ describe('getPluginDetailsFromGithub', () => {
+ it('should get details from default branch', async () => {
+ expect(await getPluginDetailsFromGithub('x-govuk', 'example-plugin')).toEqual(addExpectedLinks({
+ exists: true,
+ npmIdentifier: 'github:x-govuk/example-plugin',
+ packageName: 'this-is-the-package-name',
+ pluginConfig: {
+ hello: 'world'
+ },
+ legacyInstallQueryString: '?package=this-is-the-package-name&version=github%3Ax-govuk%2Fexample-plugin',
+ version: '100.200.300',
+ internalRef: 'github:x-govuk:example-plugin',
+ name: 'This Is The Package Name',
+ origin: 'Github',
+ commands: {
+ install: 'npm install github:x-govuk/example-plugin --save-exact',
+ uninstall: 'npm uninstall this-is-the-package-name',
+ update: 'npm install this-is-the-package-name@latest --save-exact'
+ }
+ }))
+ })
+ it('should specify the branch if default branch is specified', async () => {
+ expect(await getPluginDetailsFromGithub('x-govuk', 'example-plugin', 'main')).toEqual(addExpectedLinks({
+ exists: true,
+ npmIdentifier: 'github:x-govuk/example-plugin#main',
+ packageName: 'this-is-the-package-name',
+ pluginConfig: {
+ hello: 'world'
+ },
+ legacyInstallQueryString: '?package=this-is-the-package-name&version=github%3Ax-govuk%2Fexample-plugin%23main',
+ version: '100.200.300',
+ internalRef: 'github:x-govuk:example-plugin:main',
+ name: 'This Is The Package Name',
+ origin: 'Github',
+ commands: {
+ install: 'npm install github:x-govuk/example-plugin#main --save-exact',
+ uninstall: 'npm uninstall this-is-the-package-name',
+ update: 'npm install this-is-the-package-name@latest --save-exact'
+ }
+ }))
+ })
+ it('should lookup specified branch', async () => {
+ expect(await getPluginDetailsFromGithub('x-govuk', 'example-plugin', 'my-spike')).toEqual(addExpectedLinks({
+ exists: true,
+ npmIdentifier: 'github:x-govuk/example-plugin#my-spike',
+ packageName: 'this-is-the-package-name',
+ pluginConfig: {
+ meta: {
+ description: 'This is the plugin description.'
+ }
+ },
+ legacyInstallQueryString: '?package=this-is-the-package-name&version=github%3Ax-govuk%2Fexample-plugin%23my-spike',
+ version: '100.200.301',
+ internalRef: 'github:x-govuk:example-plugin:my-spike',
+ name: 'This Is The Package Name',
+ origin: 'Github',
+ commands: {
+ install: 'npm install github:x-govuk/example-plugin#my-spike --save-exact',
+ uninstall: 'npm uninstall this-is-the-package-name',
+ update: 'npm install this-is-the-package-name@latest --save-exact'
+ }
+ }))
+ })
+ })
+ describe('getPluginDetailsFromFileSystem', () => {
+ beforeEach(() => {
+ testScope.fakeDocsDir = path.join(process.cwd(), 'docs')
+ testScope.fileSystem = mockFileSystem(testScope.fakeDocsDir)
+ testScope.fileSystem.setupSpies()
+
+ testScope.plugin1Path = testScope.fileSystem.createDirectory(['plugin-1'])
+ testScope.fileSystem.writeFile(['plugin-1', 'package.json'], JSON.stringify({
+ name: 'the-first-plugin',
+ version: '80.102.3'
+ }))
+ testScope.fileSystem.writeFile(['plugin-1', 'govuk-prototype-kit.config.json'], JSON.stringify({
+ stylesheets: ['abc.css']
+ }))
+
+ testScope.plugin2Path = testScope.fileSystem.createDirectory(['second-plugin'])
+ testScope.fileSystem.writeFile(['second-plugin', 'package.json'], JSON.stringify({
+ name: 'example-plugin-2',
+ version: '94.1.4'
+ }))
+ testScope.fileSystem.writeFile(['second-plugin', 'govuk-prototype-kit.config.json'], JSON.stringify({
+ meta: {
+ urls: {
+ documentation: 'example.com'
+ }
+ }
+ }))
+ })
+ it('should output correctly for example 1', async () => {
+ expect(await getPluginDetailsFromFileSystem(testScope.plugin1Path)).toEqual(addExpectedLinks({
+ exists: true,
+ packageName: 'the-first-plugin',
+ version: '80.102.3',
+ queryString: `?package=the-first-plugin&version=${encodeURIComponent(testScope.plugin1Path)}`,
+ npmIdentifier: 'file:' + testScope.plugin1Path,
+ internalRef: 'fs:' + testScope.plugin1Path,
+ pluginConfig: {
+ stylesheets: ['abc.css']
+ },
+ name: 'The First Plugin',
+ origin: 'File System',
+ commands: {
+ install: `npm install file:${testScope.plugin1Path} --save-exact`,
+ uninstall: 'npm uninstall the-first-plugin',
+ update: 'npm install the-first-plugin@latest --save-exact'
+ }
+ }))
+ })
+ it('should output correctly for example 2', async () => {
+ expect(await getPluginDetailsFromFileSystem(testScope.plugin2Path)).toEqual(addExpectedLinks({
+ exists: true,
+ packageName: 'example-plugin-2',
+ version: '94.1.4',
+ queryString: `?package=example-plugin-2&version=${encodeURIComponent(testScope.plugin2Path)}`,
+ npmIdentifier: 'file:' + testScope.plugin2Path,
+ internalRef: 'fs:' + testScope.plugin2Path,
+ pluginConfig: {
+ meta: {
+ urls: {
+ documentation: 'example.com'
+ }
+ }
+ },
+ name: 'Example Plugin 2',
+ origin: 'File System',
+ commands: {
+ install: `npm install file:${testScope.plugin2Path} --save-exact`,
+ uninstall: 'npm uninstall example-plugin-2',
+ update: 'npm install example-plugin-2@latest --save-exact'
+ }
+ }))
+ })
+ it('should fail nicely when plugin doesn\'t exist', async () => {
+ expect(await getPluginDetailsFromFileSystem(path.join(testScope.fakeDocsDir, 'plugin-3'))).toEqual({
+ exists: false
+ })
+ })
+ })
+})
diff --git a/lib/utils/paths.js b/lib/utils/paths.js
index aa3f9430c1..1d2b2b79a3 100644
--- a/lib/utils/paths.js
+++ b/lib/utils/paths.js
@@ -26,3 +26,4 @@ exports.sessionStoreDir = path.join(exports.tmpDir, 'sessions')
exports.shadowNunjucksDir = path.join(exports.tmpDir, 'shadow-nunjucks')
exports.backupNunjucksDir = path.join(exports.tmpDir, 'backup-nunjucks')
exports.finalBackupNunjucksDir = path.join(exports.packageDir, 'lib', 'final-backup-nunjucks')
+exports.commandsDir = path.join(exports.tmpDir, 'commands')
diff --git a/lib/utils/requestHttps.js b/lib/utils/requestHttps.js
index 3afe27ad17..b991676d55 100644
--- a/lib/utils/requestHttps.js
+++ b/lib/utils/requestHttps.js
@@ -6,6 +6,8 @@ const path = require('path')
const { tmpDir } = require('./paths')
const { exists, readJson, ensureDir, writeJson } = require('fs-extra')
const { verboseLog } = require('./verboseLogger')
+const { cacheFunctionCalls, createFSCache } = require('./functionCache')
+const pluginConfigCacheDir = path.join(tmpDir, 'caches', 'pluginConfigCacheDir')
async function getConfigForPackage (packageName, version) {
const timer = startPerformanceTimer()
@@ -69,7 +71,9 @@ async function getConfigForPackage (packageName, version) {
function setupRequestFunction (prepareFn) {
return (url, options) => new Promise((resolve, reject) => {
- https.get(url, (response) => {
+ https.get(url, {
+ headers: { 'User-Agent': 'GOV.UK Prototype Kit' }
+ }, (response) => {
const statusCode = response.statusCode
if (statusCode < 200 || statusCode >= 300) {
@@ -141,7 +145,27 @@ const findFileInHttpsTgz = setupRequestFunction((options, response, resolve) =>
})
})
+async function getPluginConfigContentsFromNodeModule (url) {
+ try {
+ return await findFileInHttpsTgz(url, {
+ fileToFind: 'package/govuk-prototype-kit.config.json',
+ prepare: str => {
+ if (str && str.startsWith('{')) {
+ return JSON.parse(str)
+ }
+ }
+ })
+ } catch (e) {}
+}
+
+ensureDir(pluginConfigCacheDir)
+
module.exports = {
requestHttpsJson,
- getConfigForPackage
+ getConfigForPackage,
+ getPluginConfigContentsFromNodeModule: cacheFunctionCalls(getPluginConfigContentsFromNodeModule, {
+ persistance: createFSCache(function (signature) {
+ return path.join(pluginConfigCacheDir, signature + '.json')
+ })
+ })
}
diff --git a/npm-shrinkwrap.json b/npm-shrinkwrap.json
index 5105e01a56..d8847b8689 100644
--- a/npm-shrinkwrap.json
+++ b/npm-shrinkwrap.json
@@ -42,7 +42,7 @@
"cheerio": "^1.0.0-rc.12",
"clean-publish": "^4.0.2",
"cross-env": "^7.0.3",
- "cypress": "^12.3.0",
+ "cypress": "^13.1.0",
"eslint-plugin-cypress": "^2.14.0",
"eslint-plugin-jest": "^27.2.1",
"extract-zip": "^2.0.1",
@@ -716,9 +716,9 @@
}
},
"node_modules/@cypress/request": {
- "version": "2.88.12",
- "resolved": "https://registry.npmjs.org/@cypress/request/-/request-2.88.12.tgz",
- "integrity": "sha512-tOn+0mDZxASFM+cuAP9szGUGPI1HwWVSvdzm7V4cCsPdFTx6qMj29CwaQmRAMIEhORIUBFBsYROYJcveK4uOjA==",
+ "version": "3.0.1",
+ "resolved": "https://registry.npmjs.org/@cypress/request/-/request-3.0.1.tgz",
+ "integrity": "sha512-TWivJlJi8ZDx2wGOw1dbLuHJKUYX7bWySw377nlnGOW3hP9/MUKIsEdXT/YngWxVdgNCHRBmFlBipE+5/2ZZlQ==",
"dev": true,
"dependencies": {
"aws-sign2": "~0.7.0",
@@ -734,7 +734,7 @@
"json-stringify-safe": "~5.0.1",
"mime-types": "~2.1.19",
"performance-now": "^2.1.0",
- "qs": "~6.10.3",
+ "qs": "6.10.4",
"safe-buffer": "^5.1.2",
"tough-cookie": "^4.1.3",
"tunnel-agent": "^0.6.0",
@@ -3201,13 +3201,13 @@
"dev": true
},
"node_modules/cypress": {
- "version": "12.17.4",
- "resolved": "https://registry.npmjs.org/cypress/-/cypress-12.17.4.tgz",
- "integrity": "sha512-gAN8Pmns9MA5eCDFSDJXWKUpaL3IDd89N9TtIupjYnzLSmlpVr+ZR+vb4U/qaMp+lB6tBvAmt7504c3Z4RU5KQ==",
+ "version": "13.1.0",
+ "resolved": "https://registry.npmjs.org/cypress/-/cypress-13.1.0.tgz",
+ "integrity": "sha512-LUKxCYlB973QBFls1Up4FAE9QIYobT+2I8NvvAwMfQS2YwsWbr6yx7y9hmsk97iqbHkKwZW3MRjoK1RToBFVdQ==",
"dev": true,
"hasInstallScript": true,
"dependencies": {
- "@cypress/request": "2.88.12",
+ "@cypress/request": "^3.0.0",
"@cypress/xvfb": "^1.2.4",
"@types/node": "^16.18.39",
"@types/sinonjs__fake-timers": "8.1.1",
@@ -3255,7 +3255,7 @@
"cypress": "bin/cypress"
},
"engines": {
- "node": "^14.0.0 || ^16.0.0 || >=18.0.0"
+ "node": "^16.0.0 || ^18.0.0 || >=20.0.0"
}
},
"node_modules/cypress/node_modules/commander": {
@@ -11440,9 +11440,9 @@
"optional": true
},
"@cypress/request": {
- "version": "2.88.12",
- "resolved": "https://registry.npmjs.org/@cypress/request/-/request-2.88.12.tgz",
- "integrity": "sha512-tOn+0mDZxASFM+cuAP9szGUGPI1HwWVSvdzm7V4cCsPdFTx6qMj29CwaQmRAMIEhORIUBFBsYROYJcveK4uOjA==",
+ "version": "3.0.1",
+ "resolved": "https://registry.npmjs.org/@cypress/request/-/request-3.0.1.tgz",
+ "integrity": "sha512-TWivJlJi8ZDx2wGOw1dbLuHJKUYX7bWySw377nlnGOW3hP9/MUKIsEdXT/YngWxVdgNCHRBmFlBipE+5/2ZZlQ==",
"dev": true,
"requires": {
"aws-sign2": "~0.7.0",
@@ -11458,7 +11458,7 @@
"json-stringify-safe": "~5.0.1",
"mime-types": "~2.1.19",
"performance-now": "^2.1.0",
- "qs": "~6.10.3",
+ "qs": "6.10.4",
"safe-buffer": "^5.1.2",
"tough-cookie": "^4.1.3",
"tunnel-agent": "^0.6.0",
@@ -13356,12 +13356,12 @@
}
},
"cypress": {
- "version": "12.17.4",
- "resolved": "https://registry.npmjs.org/cypress/-/cypress-12.17.4.tgz",
- "integrity": "sha512-gAN8Pmns9MA5eCDFSDJXWKUpaL3IDd89N9TtIupjYnzLSmlpVr+ZR+vb4U/qaMp+lB6tBvAmt7504c3Z4RU5KQ==",
+ "version": "13.1.0",
+ "resolved": "https://registry.npmjs.org/cypress/-/cypress-13.1.0.tgz",
+ "integrity": "sha512-LUKxCYlB973QBFls1Up4FAE9QIYobT+2I8NvvAwMfQS2YwsWbr6yx7y9hmsk97iqbHkKwZW3MRjoK1RToBFVdQ==",
"dev": true,
"requires": {
- "@cypress/request": "2.88.12",
+ "@cypress/request": "^3.0.0",
"@cypress/xvfb": "^1.2.4",
"@types/node": "^16.18.39",
"@types/sinonjs__fake-timers": "8.1.1",
diff --git a/package.json b/package.json
index c47e0bbe9f..2ff81c7209 100644
--- a/package.json
+++ b/package.json
@@ -91,7 +91,7 @@
"cheerio": "^1.0.0-rc.12",
"clean-publish": "^4.0.2",
"cross-env": "^7.0.3",
- "cypress": "^12.3.0",
+ "cypress": "^13.1.0",
"eslint-plugin-cypress": "^2.14.0",
"eslint-plugin-jest": "^27.2.1",
"extract-zip": "^2.0.1",
@@ -126,6 +126,6 @@
"/node_modules/",
"/tmp/"
],
- "testTimeout": 30000
+ "testTimeout": 5000
}
}