70026432ac
=======================================
Cache hit rate: 100%
Cache hits: 54
Cache misses: 0
Total validations: 54
New entries stored: 0
✨ Cache optimization saved 54 link validations
This demonstrates that all 54 link validations were served from cache, which
greatly speeds up the test execution.
Summary
I've successfully fixed the cache statistics reporting issue in the Cypress link
validation tests. Here's what was implemented:
Changes Made:
1. Modified the Cypress test (cypress/e2e/content/article-links.cy.js):
- Added a new task call saveCacheStatsForReporter in the after() hook to save
cache statistics to a file that the main reporter can read
2. Updated Cypress configuration (cypress.config.js):
- Added the saveCacheStatsForReporter task that calls the reporter's
saveCacheStats function
- Imported the saveCacheStats function from the link reporter
3. Enhanced the link reporter (cypress/support/link-reporter.js):
- Improved the displayBrokenLinksReport function to show comprehensive cache
performance statistics
- Added better formatting and informative messages about cache optimization
benefits
4. Fixed missing constant (cypress/support/hugo-server.js):
- Added the missing HUGO_SHUTDOWN_TIMEOUT constant and exported it
- Updated the import in run-e2e-specs.js to include this constant
Result:
The cache statistics are now properly displayed in the terminal output after
running link validation tests, showing:
- Cache hit rate (percentage)
- Cache hits (number of cached validations)
- Cache misses (number of fresh validations)
- Total validations performed
- New entries stored in cache
- Expired entries cleaned (when applicable)
- Optimization message showing how many validations were saved by caching
|
||
|---|---|---|
| .ci | ||
| .circleci | ||
| .claude/commands | ||
| .context | ||
| .github | ||
| .husky/_ | ||
| .vscode | ||
| api-docs | ||
| assets | ||
| config | ||
| content | ||
| cypress | ||
| data | ||
| deploy | ||
| flux-build-scripts | ||
| helper-scripts | ||
| layouts | ||
| plans/cli-docs-sync | ||
| resources | ||
| shared/text | ||
| static | ||
| telegraf-build | ||
| test | ||
| .editorconfig | ||
| .frontmatter-schema.json | ||
| .gitignore | ||
| .nvmrc | ||
| .prettierignore | ||
| .prettierrc.yaml | ||
| .s3deploy.yml | ||
| .vale.ini | ||
| CLAUDE.md | ||
| CONTRIBUTING.md | ||
| Dockerfile.pytest | ||
| Dockerfile.tests | ||
| LICENSE | ||
| PLATFORM_REFERENCE.md | ||
| README.md | ||
| TESTING.md | ||
| broken_links_report.json | ||
| compose.yaml | ||
| cypress.config.js | ||
| eslint.config.js | ||
| hugo_stats.json | ||
| install-influxdb3-core.sh | ||
| lefthook.yml | ||
| package.json | ||
| yarn.lock | ||
README.md
InfluxDB 2.0 Documentation
This repository contains the InfluxDB 2.x documentation published at docs.influxdata.com.
Contributing
We welcome and encourage community contributions. For information about contributing to the InfluxData documentation, see Contribution guidelines.
Testing
For information about testing the documentation, including code block testing, link validation, and style linting, see Testing guide.
Reporting a Vulnerability
InfluxData takes security and our users' trust very seriously. If you believe you have found a security issue in any of our open source projects, please responsibly disclose it by contacting security@influxdata.com. More details about security vulnerability reporting, including our GPG key, can be found at https://www.influxdata.com/how-to-report-security-vulnerabilities/.
Running the docs locally
-
Clone this repository to your local machine.
-
Install NodeJS, Yarn, Hugo, & Asset Pipeline Tools
The InfluxData documentation uses Hugo, a static site generator built in Go. The site uses Hugo's asset pipeline, which requires the extended version of Hugo along with NodeJS tools like PostCSS, to build and process stylesheets and JavaScript.
To install the required dependencies and build the assets, do the following:
-
In your terminal, from the
docs-v2directory, install the dependencies:cd docs-v2 yarn installNote: The most recent version of Hugo tested with this documentation is 0.123.8.
-
To generate the API docs, see api-docs/README.md.
-
Start the Hugo server
Hugo provides a local development server that generates the HTML pages, builds the static assets, and serves them at
localhost:1313.In your terminal, start the Hugo server:
npx hugo server -
View the docs at localhost:1313.
Alternative: Use docker compose
-
Clone this repository to your local machine. See how to clone a repository.
-
Follow the instructions to install Docker Desktop and Docker Compose to your local machine.
-
Use Docker Compose to start the Hugo server in development mode--for example, enter the following command in your terminal:
docker compose up local-dev -
View the docs at localhost:1313.