10936222153

Committed 15 Sep 2024 03:34PM UTC coverage: 96.431% (-0.03%) from 96.458%

Build # 10936222153

Build Type

push

github

Committed by

web-flow

Commit Message

[Snapcraft] license (#10520)

* Add snapcraft license. Update snapcraft version to inherit from snapcraft-base class. Add snapcraft base url in configurations.

* Fix spec tests after making method static

* remove snapcraft configurations, move into base class

* Update services/snapcraft/snapcraft-base.js

---------

Co-authored-by: chris48s <chris48s@users.noreply.github.com>

Run Details

6297 of 6546 branches covered (96.2%)

78 of 82 new or added lines in 3 files covered. (95.12%)

14 existing lines in 2 files now uncovered.

47312 of 49063 relevant lines covered (96.43%)

119.49 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

85.11

/core/base-service/legacy-request-handler.js

import makeBadge from '../../badge-maker/lib/make-badge.js'
import { setCacheHeaders } from './cache-headers.js'
import { makeSend } from './legacy-result-sender.js'
import coalesceBadge from './coalesce-badge.js'

// These query parameters are available to any badge. They are handled by
// `coalesceBadge`.
const globalQueryParams = new Set([
  'label',
  'style',
  'link',
  'logo',
  'logoColor',
  'logoSize',
  'logoWidth',
  'link',
  'colorA',
  'colorB',
  'color',
  'labelColor',
])

function flattenQueryParams(queryParams) {
  const union = new Set(globalQueryParams)
  ;(queryParams || []).forEach(name => {
    union.add(name)
  })
  return Array.from(union).sort()
}

// handlerOptions can contain:
// - handler: The service's request handler function
// - queryParams: An array of the field names of any custom query parameters
//   the service uses
// - cacheLength: An optional badge or category-specific cache length
//   (in number of seconds) to be used in preference to the default
//
// For safety, the service must declare the query parameters it wants to use.
// Only the declared parameters (and the global parameters) are provided to
// the service. Consequently, failure to declare a parameter results in the
// parameter not working at all (which is undesirable, but easy to debug)
// rather than indeterminate behavior that depends on the cache state
// (undesirable and hard to debug).
//
// Pass just the handler function as shorthand.
function handleRequest(cacheHeaderConfig, handlerOptions) {
  if (!cacheHeaderConfig) {
    throw Error('cacheHeaderConfig is required')
  }

  if (typeof handlerOptions === 'function') {
    handlerOptions = { handler: handlerOptions }
  }

  const allowedKeys = flattenQueryParams(handlerOptions.queryParams)
  const { cacheLength: serviceDefaultCacheLengthSeconds } = handlerOptions

  return (queryParams, match, end, ask) => {
    /*
    This is here for legacy reasons. The badge server and frontend used to live
    on two different servers. When we merged them there was a conflict so we
    did this to avoid moving the endpoint docs to another URL.

    Never ever do this again.
    */
    if (match[0] === '/endpoint' && Object.keys(queryParams).length === 0) {
      ask.res.statusCode = 301
      ask.res.setHeader('Location', '/badges/endpoint-badge')
      ask.res.end()
      return
    }

    // `defaultCacheLengthSeconds` can be overridden by
    // `serviceDefaultCacheLengthSeconds` (either by category or on a badge-
    // by-badge basis). Then in turn that can be overridden by
    // `serviceOverrideCacheLengthSeconds`.
    // Then the `cacheSeconds` query param can also override both of those
    // but only if `cacheSeconds` is longer.
    //
    // When the legacy services have been rewritten, all the code in here
    // will go away, which should achieve this goal in a simpler way.
    //
    // Ref: https://github.com/badges/shields/pull/2755
    function setCacheHeadersOnResponse(res, serviceOverrideCacheLengthSeconds) {
      setCacheHeaders({
        cacheHeaderConfig,
        serviceDefaultCacheLengthSeconds,
        serviceOverrideCacheLengthSeconds,
        queryParams,
        res,
      })
    }

    const filteredQueryParams = {}
    allowedKeys.forEach(key => {
      filteredQueryParams[key] = queryParams[key]
    })

    // In case our vendor servers are unresponsive.
    let serverUnresponsive = false
    const serverResponsive = setTimeout(() => {
      serverUnresponsive = true
      ask.res.setHeader('Cache-Control', 'no-cache, no-store, must-revalidate')
      const badgeData = coalesceBadge(
        filteredQueryParams,
        { label: 'vendor', message: 'unresponsive' },
        {},
      )
      const svg = makeBadge(badgeData)
      const extension = (match.slice(-1)[0] || '.svg').replace(/^\./, '')
      setCacheHeadersOnResponse(ask.res)
      makeSend(extension, ask.res, end)(svg)
    }, 25000)

    const result = handlerOptions.handler(
      filteredQueryParams,
      match,
      // eslint-disable-next-line mocha/prefer-arrow-callback
      function sendBadge(format, badgeData) {
        if (serverUnresponsive) {
          return
        }
        clearTimeout(serverResponsive)
        // Add format to badge data.
        badgeData.format = format
        const svg = makeBadge(badgeData)
        setCacheHeadersOnResponse(ask.res, badgeData.cacheLengthSeconds)
        makeSend(format, ask.res, end)(svg)
      },
    )
    // eslint-disable-next-line promise/prefer-await-to-then
    if (result && result.catch) {
      // eslint-disable-next-line promise/prefer-await-to-then
      result.catch(err => {
        throw err
      })
    }
  }
}

export { handleRequest }

1	import makeBadge from '../../badge-maker/lib/make-badge.js'	3✔
2	import { setCacheHeaders } from './cache-headers.js'	3✔
3	import { makeSend } from './legacy-result-sender.js'	3✔
4	import coalesceBadge from './coalesce-badge.js'	3✔
5		3✔
6	// These query parameters are available to any badge. They are handled by	3✔
7	// `coalesceBadge`.	3✔
8	const globalQueryParams = new Set([	3✔
9	'label',	3✔
10	'style',	3✔
11	'link',	3✔
12	'logo',	3✔
13	'logoColor',	3✔
14	'logoSize',	3✔
15	'logoWidth',	3✔
16	'link',	3✔
17	'colorA',	3✔
18	'colorB',	3✔
19	'color',	3✔
20	'labelColor',	3✔
21	])	3✔
22		3✔
23	function flattenQueryParams(queryParams) {	4,420✔
24	const union = new Set(globalQueryParams)	4,420✔
25	;(queryParams \|\| []).forEach(name => {	4,420✔
26	union.add(name)	2,152✔
27	})	4,420✔
28	return Array.from(union).sort()	4,420✔
29	}	4,420✔
30		3✔
31	// handlerOptions can contain:	3✔
32	// - handler: The service's request handler function	3✔
33	// - queryParams: An array of the field names of any custom query parameters	3✔
34	// the service uses	3✔
35	// - cacheLength: An optional badge or category-specific cache length	3✔
36	// (in number of seconds) to be used in preference to the default	3✔
37	//	3✔
38	// For safety, the service must declare the query parameters it wants to use.	3✔
39	// Only the declared parameters (and the global parameters) are provided to	3✔
40	// the service. Consequently, failure to declare a parameter results in the	3✔
41	// parameter not working at all (which is undesirable, but easy to debug)	3✔
42	// rather than indeterminate behavior that depends on the cache state	3✔
43	// (undesirable and hard to debug).	3✔
44	//	3✔
45	// Pass just the handler function as shorthand.	3✔
46	function handleRequest(cacheHeaderConfig, handlerOptions) {	4,420✔
47	if (!cacheHeaderConfig) {	4,420!
48	throw Error('cacheHeaderConfig is required')	×
49	}	×
50		4,420✔
51	if (typeof handlerOptions === 'function') {	4,420✔
52	handlerOptions = { handler: handlerOptions }	8✔
53	}	8✔
54		4,420✔
55	const allowedKeys = flattenQueryParams(handlerOptions.queryParams)	4,420✔
56	const { cacheLength: serviceDefaultCacheLengthSeconds } = handlerOptions	4,420✔
57		4,420✔
58	return (queryParams, match, end, ask) => {	4,420✔
59	/*	2,186✔
60	This is here for legacy reasons. The badge server and frontend used to live	2,186✔
61	on two different servers. When we merged them there was a conflict so we	2,186✔
62	did this to avoid moving the endpoint docs to another URL.	2,186✔
63		2,186✔
64	Never ever do this again.	2,186✔
65	*/	2,186✔
66	if (match[0] === '/endpoint' && Object.keys(queryParams).length === 0) {	2,186!
67	ask.res.statusCode = 301	×
68	ask.res.setHeader('Location', '/badges/endpoint-badge')	×
69	ask.res.end()	×
70	return	×
71	}	×
72		2,186✔
73	// `defaultCacheLengthSeconds` can be overridden by	2,186✔
74	// `serviceDefaultCacheLengthSeconds` (either by category or on a badge-	2,186✔
75	// by-badge basis). Then in turn that can be overridden by	2,186✔
76	// `serviceOverrideCacheLengthSeconds`.	2,186✔
77	// Then the `cacheSeconds` query param can also override both of those	2,186✔
78	// but only if `cacheSeconds` is longer.	2,186✔
79	//	2,186✔
80	// When the legacy services have been rewritten, all the code in here	2,186✔
81	// will go away, which should achieve this goal in a simpler way.	2,186✔
82	//	2,186✔
83	// Ref: https://github.com/badges/shields/pull/2755	2,186✔
84	function setCacheHeadersOnResponse(res, serviceOverrideCacheLengthSeconds) {	2,186✔
85	setCacheHeaders({	2,186✔
86	cacheHeaderConfig,	2,186✔
87	serviceDefaultCacheLengthSeconds,	2,186✔
88	serviceOverrideCacheLengthSeconds,	2,186✔
89	queryParams,	2,186✔
90	res,	2,186✔
91	})	2,186✔
92	}	2,186✔
93		2,186✔
94	const filteredQueryParams = {}	2,186✔
95	allowedKeys.forEach(key => {	2,186✔
96	filteredQueryParams[key] = queryParams[key]	25,939✔
97	})	2,186✔
98		2,186✔
99	// In case our vendor servers are unresponsive.	2,186✔
100	let serverUnresponsive = false	2,186✔
101	const serverResponsive = setTimeout(() => {	2,186✔
UNCOV 102	serverUnresponsive = true	×
UNCOV 103	ask.res.setHeader('Cache-Control', 'no-cache, no-store, must-revalidate')	×
UNCOV 104	const badgeData = coalesceBadge(	×
UNCOV 105	filteredQueryParams,	×
UNCOV 106	{ label: 'vendor', message: 'unresponsive' },	×
UNCOV 107	{},	×
UNCOV 108	)	×
UNCOV 109	const svg = makeBadge(badgeData)	×
UNCOV 110	const extension = (match.slice(-1)[0] \|\| '.svg').replace(/^\./, '')	×
UNCOV 111	setCacheHeadersOnResponse(ask.res)	×
UNCOV 112	makeSend(extension, ask.res, end)(svg)	×
113	}, 25000)	2,186✔
114		2,186✔
115	const result = handlerOptions.handler(	2,186✔
116	filteredQueryParams,	2,186✔
117	match,	2,186✔
118	// eslint-disable-next-line mocha/prefer-arrow-callback	2,186✔
119	function sendBadge(format, badgeData) {	2,186✔
120	if (serverUnresponsive) {	2,186!
UNCOV 121	return	×
UNCOV 122	}	×
123	clearTimeout(serverResponsive)	2,186✔
124	// Add format to badge data.	2,186✔
125	badgeData.format = format	2,186✔
126	const svg = makeBadge(badgeData)	2,186✔
127	setCacheHeadersOnResponse(ask.res, badgeData.cacheLengthSeconds)	2,186✔
128	makeSend(format, ask.res, end)(svg)	2,186✔
129	},	2,186✔
130	)	2,186✔
131	// eslint-disable-next-line promise/prefer-await-to-then	2,186✔
132	if (result && result.catch) {	2,186✔
133	// eslint-disable-next-line promise/prefer-await-to-then	2,174✔
134	result.catch(err => {	2,174✔
135	throw err	×
136	})	2,174✔
137	}	2,174✔
138	}	2,186✔
139	}	4,420✔
140		3✔
141	export { handleRequest }	3✔

badges / shields / 10936222153

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous