lighthouse4u

v1.10.1

LH4U provides Google Lighthouse as a service, surfaced by both a friendly UI+API, and backed by Elastic Search for all your query and visualization needs For more information about how to use this package see README

Latest version published 15 days ago

License: MIT

NPM

GitHub

Package Health Score

67 / 100

security
Security review needed
popularity
Limited
maintenance
Healthy
community
Sustainable

Explore Similar Packages

Security

Security review needed

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
1.10.1	\|	04/2024	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.9.0	\|	09/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.7.0	\|	12/2018		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.6.4	\|	11/2018		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.5.0	\|	10/2018		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Yes

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Limited

Weekly Downloads (4)

GitHub Stars: 55
Forks: 9
Contributors: 8

Direct Usage Popularity

The npm package lighthouse4u receives a total of 4 downloads a week. As such, we scored lighthouse4u popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package lighthouse4u, we found that it has been starred 55 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: No
Code of Conduct: Yes
Contributors: 8
Funding: No

This project has seen only 10 or less contributors.

Embed Package Health Score Badge

Maintenance

Healthy

Commit Frequency

Open Issues: 2
Open PR: 20
Last Release: 15 days ago
Last Commit: 15 days ago

Further analysis of the maintenance status of lighthouse4u based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that lighthouse4u demonstrates a positive version release cadence with at least one new version released in the past 3 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: >=8.8

Age: 6 years
Dependencies: 12 Direct
Versions: 51
Install Size: 697 kB
Dist-tags: 1
# of Files: 40
Maintainers: 1
TS Typings: No

lighthouse4u has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

Lighthouse4u

LH4U provides Google Lighthouse as a service, surfaced by both a friendly UI+API, and backed by various storage and queue clients to support a wide range of architectures.

Usage

Start server via CLI:

npm i -g lighthouse4u
lh4u server --config local --config-dir ./app/config --config-base defaults --secure-config ./app/config/secure --secure-file some-private.key

Or locally to this repo via npm start (you'll need to create test/config/local.json5 by copying test/config/COPY.json5).

Architectures

With the release of v1, we've decoupled compute and storage into multiple tiers to permit a diverse set of architectures. Not only are custom storage and queue clients supported, but compute can even be run serverless.

Queue Architecture

This most closely resembles that of v0.7, but without the restrictions of being locked into Elasticsearch and RabbitMQ.

{  
  reader: {
    module: 'lighthouse4u-elasticsearch', options: { /* ... */ }
  },
  writer: {
    module: 'lighthouse4u-elasticsearch', options: { /* ... */ }
  },
  queue: { // rabbit
    module: 'lighthouse4u-amqp', options: { /* ... */ }
  }
}

Note: The lighthouse4u-elasticsearch storage client is not yet available. Happy to take contributions!

Serverless Architecture

Same as above, you're not tied to Elasticsearch. Use whatever storage and queue client fits your needs. Due to the nature of AWS Lambda, your Lighthouse "runner" (triggered via SQS) is separate from the Lighthouse4u UI+API.

Serverless example via AWS Lambda

Configuration Options

Option	Type	Default	Desc
store	reader	writer
->.module	`string`	required	Path of client module to import. See storage clients
->.options	`object`		Collection of options supplied to storage client
queue			Queue configuration
->.module	`string`	required	Path of client module to import. See queue clients
->.idleDelayMs	`number`	`1000`	Time (in MS) between queue checks when queue is empty
->.enabled	`boolean`	`true`	Consuming queue may be disabled
->.options	`object`		Collection of options supplied to queue client
http			HTTP(S) Server options
->.bindings	`Hash`		An object of named bindings
->.bindings.{name}	`HttpBinding`		With `{name}` being the name of the binding -- can be anything, ex: `myMagicBinding`. See value to `false` if you want to disable this binding.
->.bindings.{name}.port	`number`	`8994`	Port to bind to
->.bindings.{name}.ssl	TLS Options	`undefined`	Required to bind HTTPS/2
->.auth			Zero or more authorization options
->.auth.{authName}	`HttpAuth`		A set of auth options keyed by any custom `{authName}`
->.auth.{authName}.type	`basic	custom`	required
->.auth.{authName}.groups	`string	array`	`*`
->.auth.{authName}.customPath	`string`		Path of the custom module
->.auth.{authName}.options			Options provided to the auth module
->.authRedirect		`undefined`	URL to redirect UI to if auth is enabled and fails
->.routes			Optional set of custom routes
->.routes.{name}	`string	HttpRoute`
->.routes.{name}.path	`string`		Path to resolve to connect middleware, relative to current working directory
->.routes.{name}.method	`string`	`GET`	Method to bind to
->.routes.{name}.route	`string`	Uses `{name}` if undefined	Route to map, ala `/api/test`
->.staticFiles			Optional to bind routes to static assets
->.staticFiles.{route}	Express Static		Options to supply to static middleware
lighthouse			Options related to Lighthouse usage
->.config	LighthouseOptions		Google Lighthouse configuration options
->.config.extends	`string`	`lighthouse:default`	What options to default to
->.config.logLevel	`string`	`warn`	Level of logging
->.config.chromeFlags	`array`	`[ '--headless', '--disable-gpu', '--no-sandbox' ]`	Array of CLI arguments
->.config.settings	LighthouseSettings	See Defaults	Settings applied to Lighthouse
->.validate	`hash`		Zero or more validators
->.validate.{groupName}	`string`		Path of validation module used to determine if the response is coming from the intended server. Useful in cases where you only want to measure results coming from an intended infrastructure
->.concurrency	`number`	`1`	Number of concurrently processed tasks permitted
->.report	`bool`	`true`	Save the full report, viewable in LH viewer
->.samples			After N lighthouse samples are taken, only the best result is recorded
->.samples.default	`number`	`3`	Default number of lighthouse tests performed
->.samples.range	`tuple`	`[1, 5]`	Minimum and maximum samples taken before returning result
->.attempts			Number of attempts at running Google Lighthouse before giving up due to failures
->.attempts.default	`number`	`2`	Default number of attempts before giving up
->.attempts.range	`tuple`	`[1, 10]`	Minimum and maximum attempts before giving up
->.attempts.delayMsPerExponent	`number`	`1000`	Exponential backoff after failure
->.delay			Time (in ms) before a test is executed
->.delay.default	`number`	`0`	Default time to wait before test can be run
->.delay.range	`tuple`	`[0, 1000 * 60 * 60]`	Minimum and maximum time before test can be run
->.delay.delayMsPerExponent	`number`	`1000 * 30`	Maximum time before delayed messages will be requeued

API

API - `GET /api/website`

Fetch zero or more website results matching the criteria.

Query String Options

Option	Type	Default	Desc
format	`string`	`json`	Format of results, be it `json`, `svg`, `reportHtml`, or `reportJson`
scale	`number`	`1`	Scale of `svg`
q	`string`	optional	Query by URL or document ID
top	`number`	`1`	Maximum records to return. Only applicable for `json` format

API - `GET /api/website/compare`

Similar to the single website GET, but instead compares results from q1 with q2.

Query String Options

Option	Type	Default	Desc
format	`string`	`json`	Format of results, be it `json` or `svg`
scale	`number`	`1`	Scale of `svg`
q1	`string`	required	First query by URL or document ID
q2	`string`	required	Second query by URL or document ID

API - `POST /api/website`

Submit to process website with Google Lighthouse.

JSON Body Options

Option	Type	Default	Desc
url	`string`	required	URL to process via Google Lighthouse
wait	`number`	optional	Block returning until job is complete, or the `wait` time (in ms) has elapsed, resulting in a partial 206 response
headers	`hash`	optional	Collection of HTTP headers to supply in request
secureHeaders	hash	optional	Same use as `headers`, but stored securely in queue, and never persisted to ElasticSearch
samples	`number`	(See `options.lighthouse.samples`)	Number of samples to take before recording result
attempts	`number`	(See `options.lighthouse.attempts`)	Number of failure attempts before giving up
hostOverride	`string`	optional	Map host of request to an explicit IP. Not yet supported by Chrome in Headless mode
delay	`number`	(See `options.lighthouse.delay`)	Delay (in milliseconds) before test will be performed. Useful if the intended service or domain is not expected to be available for some time
group	`string`	`unknown`	Group to categorize result to. Useful when searching/filtering on different groups of results
report	`bool`	`true`	If the full report should be stored, allowing for viewing in LH Viewer
auditMode	`false	'simple'	'details'
cookies	`array<{name=string	Cookie}>`	optional
cookies[idx].value	`string`	required	Value to set for cookie
cookies[idx].domain	`string`	optional	Domain to apply cookie to. Defaults to root of `requestedUrl` domain
cookies[idx].url	`string`	optional	If the page required to apply cookie to differs from the `requestedUrl` you can set that here
cookies[idx].path	`string`	optional	Path to apply to cookie
cookies[idx].secure	`boolean`	optional	Is cookie secured
cookies[idx].httpOnly	`boolean`	optional	HTTP only
commands	`array`	optional	DevTool Commands to be executed prior to running Lighthouse
commands[idx].command	`string`	required	DevTool Command to execute
commands[idx].options	`object`	required	DevTool Command Options to supply command
meta	`object`	optional	Object containing metadata that will be attached to final lighthouse results

Command

Storage Clients

AWS S3 - Store and basic query support via S3 buckets.
File System - Not recommended for production usage. Good for local testing.
Elasticsearch - Store and query support via Elasticsearch.

Queue Clients

AWS SQS - Support for Simple Queue Service.
AMQP - Support for RabbitMQ and other AMQP compatible queues.

Secure Configuration

Optionally you may run LH4U with the --secure-config {secureConfigPath} and --secure-file {securePrivateFile} powered by Config Shield.

npm i -g config-shield
cshield ./app/config/secure some-private.key
&gt; help
&gt; set queue { options: { url: 'amqp://lh4u_user:someSuperSecretPassword@rmq.on-my-domain.com:5672/lh4u' } }
&gt; get queue
: { "options": { "url": "amqp://lh4u_user:someSuperSecretPassword@rmq.on-my-domain.com:5672/lh4u" } }
&gt; save
&gt; exit

The example above will allow you to merge sensitive credentials with your existing public configuration. Only options defined in the secure config will be deeply merged.

lighthouse4u dependencies

basic-auth chrome-launcher config-shield cross-fetch ejs express json5 lighthouse lodash papaparse tldjs yargs

lighthouse4u development dependencies

amqplib chai eslint eslint-config-godaddy eslint-plugin-json eslint-plugin-mocha fs-extra mocha nyc proxyquire sinon sinon-chai

FAQs

What is lighthouse4u?

LH4U provides Google Lighthouse as a service, surfaced by both a friendly UI+API, and backed by Elastic Search for all ... Visit Snyk Advisor to see a full health score report for lighthouse4u, including popularity, security, maintenance & community analysis.

Is lighthouse4u popular?

The npm package lighthouse4u receives a total of 4 weekly downloads. As such, lighthouse4u popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is lighthouse4u well maintained?

We found that lighthouse4u demonstrated a healthy version release cadence and project activity. It has a community of 8 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is lighthouse4u safe to use?

While scanning the latest version of lighthouse4u, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 26 April-2024, at 11:37 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (4)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

Lighthouse4u

Usage

Architectures

Queue Architecture

Serverless Architecture

Configuration Options

API

API - GET /api/website

Query String Options

API - GET /api/website/compare

Query String Options

API - POST /api/website

JSON Body Options

Command

Storage Clients

Queue Clients

Secure Configuration

lighthouse4u dependencies

lighthouse4u development dependencies

FAQs

What is lighthouse4u?

Is lighthouse4u popular?

Is lighthouse4u well maintained?

Is lighthouse4u safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues

API - `GET /api/website`

API - `GET /api/website/compare`

API - `POST /api/website`