From bf209e97b8413997dded17064c4a6f55c959f555 Mon Sep 17 00:00:00 2001 From: Hector Alfaro Date: Fri, 28 Feb 2025 12:19:22 -0500 Subject: [PATCH] Move pageinfo into `src/article-api` (#54620) --- .github/workflows/test.yml | 7 +++---- package.json | 2 +- src/{pageinfo/README.md => article-api/README-pageinfo.md} | 0 .../middleware.ts => article-api/middleware/pageinfo.ts} | 0 .../scripts/precompute-pageinfo.ts | 2 +- src/{pageinfo => article-api}/tests/pageinfo.js | 0 src/frame/middleware/api.ts | 2 +- 7 files changed, 6 insertions(+), 7 deletions(-) rename src/{pageinfo/README.md => article-api/README-pageinfo.md} (100%) rename src/{pageinfo/middleware.ts => article-api/middleware/pageinfo.ts} (100%) rename src/{pageinfo => article-api}/scripts/precompute-pageinfo.ts (98%) rename src/{pageinfo => article-api}/tests/pageinfo.js (100%) diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index bbcd523614..f2375e95c6 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -66,7 +66,6 @@ jobs: # - links - observability # - open-source - - pageinfo # - pages - products - redirects @@ -176,7 +175,7 @@ jobs: - uses: ./.github/actions/precompute-pageinfo # Only the 'pageinfo' tests include end-to-end tests about this. - if: ${{ matrix.name == 'pageinfo' }} + if: ${{ matrix.name == 'article-api' }} env: ROOT: src/fixtures/fixtures @@ -194,6 +193,6 @@ jobs: # tests run only in English. The exception is the # `languages` suite which needs all languages to be set up. ENABLED_LANGUAGES: ${{ matrix.name == 'languages' && 'all' || '' }} - ROOT: ${{ (matrix.name == 'fixtures' || matrix.name == 'pageinfo' || matrix.name == 'landings' ) && 'src/fixtures/fixtures' || '' }} - TRANSLATIONS_FIXTURE_ROOT: ${{ (matrix.name == 'fixtures' || matrix.name == 'pageinfo') && 'src/fixtures/fixtures/translations' || '' }} + ROOT: ${{ (matrix.name == 'fixtures' || matrix.name == 'article-api' || matrix.name == 'landings' ) && 'src/fixtures/fixtures' || '' }} + TRANSLATIONS_FIXTURE_ROOT: ${{ (matrix.name == 'fixtures' || matrix.name == 'article-api') && 'src/fixtures/fixtures/translations' || '' }} run: npm test -- src/${{ matrix.name }}/tests/ diff --git a/package.json b/package.json index 81cfcf29b1..cb010b4d98 100644 --- a/package.json +++ b/package.json @@ -64,7 +64,7 @@ "playwright-test": "playwright test --config src/fixtures/playwright.config.ts --project=\"Google Chrome\"", "post-lints": "tsx src/content-linter/scripts/post-lints.js", "postinstall": "cp package-lock.json .installed.package-lock.json && echo \"Updated .installed.package-lock.json\" # see husky/post-checkout and husky/post-merge", - "precompute-pageinfo": "tsx src/pageinfo/scripts/precompute-pageinfo.ts", + "precompute-pageinfo": "tsx src/article-api/scripts/precompute-pageinfo.ts", "prepare": "husky src/workflows/husky", "prettier": "prettier -w \"**/*.{ts,tsx,js,mjs,scss,yml,yaml}\"", "prettier-check": "prettier -c \"**/*.{ts,tsx,js,mjs,scss,yml,yaml}\"", diff --git a/src/pageinfo/README.md b/src/article-api/README-pageinfo.md similarity index 100% rename from src/pageinfo/README.md rename to src/article-api/README-pageinfo.md diff --git a/src/pageinfo/middleware.ts b/src/article-api/middleware/pageinfo.ts similarity index 100% rename from src/pageinfo/middleware.ts rename to src/article-api/middleware/pageinfo.ts diff --git a/src/pageinfo/scripts/precompute-pageinfo.ts b/src/article-api/scripts/precompute-pageinfo.ts similarity index 98% rename from src/pageinfo/scripts/precompute-pageinfo.ts rename to src/article-api/scripts/precompute-pageinfo.ts index 2199d40103..2decd71a02 100644 --- a/src/pageinfo/scripts/precompute-pageinfo.ts +++ b/src/article-api/scripts/precompute-pageinfo.ts @@ -34,7 +34,7 @@ import { program, Option } from 'commander' import { languageKeys } from 'src/languages/lib/languages.js' import { loadPages, loadUnversionedTree } from 'src/frame/lib/page-data.js' -import { CACHE_FILE_PATH, getPageInfo } from '../middleware' +import { CACHE_FILE_PATH, getPageInfo } from '../middleware/pageinfo' program .description('Generates a JSON file with precompute pageinfo data by pathname') diff --git a/src/pageinfo/tests/pageinfo.js b/src/article-api/tests/pageinfo.js similarity index 100% rename from src/pageinfo/tests/pageinfo.js rename to src/article-api/tests/pageinfo.js diff --git a/src/frame/middleware/api.ts b/src/frame/middleware/api.ts index a5c4c04468..0c768845b4 100644 --- a/src/frame/middleware/api.ts +++ b/src/frame/middleware/api.ts @@ -5,7 +5,7 @@ import events from '@/events/middleware.js' import anchorRedirect from '@/rest/api/anchor-redirect.js' import aiSearch from '@/search/middleware/ai-search' import search from '@/search/middleware/search-routes.js' -import pageInfo from '@/pageinfo/middleware' +import pageInfo from '#src/article-api/middleware/pageinfo.ts' import pageList from '@/article-api/middleware/pagelist' import webhooks from '@/webhooks/middleware/webhooks.js' import { ExtendedRequest } from '@/types'