├── .eslintignore ├── .eslintrc.js ├── .github └── workflows │ └── test.yml ├── .gitignore ├── .prettierignore ├── @types ├── rehype-parse │ └── index.d.ts └── unist-util-find │ └── index.d.ts ├── LICENSE ├── README.md ├── __tests__ ├── fixtures │ ├── mdx │ │ └── pages │ │ │ ├── consul.mdx │ │ │ └── terraform │ │ │ └── getting-started.mdx │ └── mixed │ │ ├── content │ │ └── tutorials │ │ │ └── vault │ │ │ └── getting-started.mdx │ │ └── pages │ │ └── terraform │ │ └── install.mdx ├── lib.test.ts └── utils.test.ts ├── action.yml ├── dist └── index.js ├── jest.config.js ├── package-lock.json ├── package.json ├── pages └── test.mdx ├── prettier.config.js ├── src ├── lib.ts ├── main.ts └── utils.ts └── tsconfig.json /.eslintignore: -------------------------------------------------------------------------------- 1 | dist/ 2 | lib/ 3 | node_modules/ -------------------------------------------------------------------------------- /.eslintrc.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | ...require("@hashicorp/nextjs-scripts/.eslintrc.js"), 3 | /* Specify overrides here */ 4 | } 5 | -------------------------------------------------------------------------------- /.github/workflows/test.yml: -------------------------------------------------------------------------------- 1 | name: "C/I" 2 | 3 | on: 4 | pull_request: 5 | push: 6 | branches: 7 | - master 8 | - "releases/*" 9 | 10 | jobs: 11 | ci: 12 | name: Build / Test / Run 13 | runs-on: ubuntu-latest 14 | steps: 15 | - uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4.0.0 16 | 17 | - run: npm ci 18 | 19 | - name: Build / Test 20 | run: npm run all 21 | 22 | - name: Run 23 | id: action 24 | continue-on-error: true 25 | uses: ./ 26 | with: 27 | baseUrl: "https://hashicorp.com" 28 | files: "pages/test.mdx" 29 | 30 | - run: | 31 | echo ${{ toJson(steps.action.outputs.annotations) }} 32 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | .DS_Store 3 | npm-debug.log* 4 | lib/**/* 5 | -------------------------------------------------------------------------------- /.prettierignore: -------------------------------------------------------------------------------- 1 | node_modules/ 2 | dist/ 3 | lib/ 4 | -------------------------------------------------------------------------------- /@types/rehype-parse/index.d.ts: -------------------------------------------------------------------------------- 1 | declare module 'rehype-parse' 2 | -------------------------------------------------------------------------------- /@types/unist-util-find/index.d.ts: -------------------------------------------------------------------------------- 1 | declare module 'unist-util-find' 2 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Copyright (c) 2020 HashiCorp, Inc. 2 | 3 | Mozilla Public License Version 2.0 4 | ================================== 5 | 6 | 1. Definitions 7 | -------------- 8 | 9 | 1.1. "Contributor" 10 | means each individual or legal entity that creates, contributes to 11 | the creation of, or owns Covered Software. 12 | 13 | 1.2. "Contributor Version" 14 | means the combination of the Contributions of others (if any) used 15 | by a Contributor and that particular Contributor's Contribution. 16 | 17 | 1.3. "Contribution" 18 | means Covered Software of a particular Contributor. 19 | 20 | 1.4. "Covered Software" 21 | means Source Code Form to which the initial Contributor has attached 22 | the notice in Exhibit A, the Executable Form of such Source Code 23 | Form, and Modifications of such Source Code Form, in each case 24 | including portions thereof. 25 | 26 | 1.5. "Incompatible With Secondary Licenses" 27 | means 28 | 29 | (a) that the initial Contributor has attached the notice described 30 | in Exhibit B to the Covered Software; or 31 | 32 | (b) that the Covered Software was made available under the terms of 33 | version 1.1 or earlier of the License, but not also under the 34 | terms of a Secondary License. 35 | 36 | 1.6. "Executable Form" 37 | means any form of the work other than Source Code Form. 38 | 39 | 1.7. "Larger Work" 40 | means a work that combines Covered Software with other material, in 41 | a separate file or files, that is not Covered Software. 42 | 43 | 1.8. "License" 44 | means this document. 45 | 46 | 1.9. "Licensable" 47 | means having the right to grant, to the maximum extent possible, 48 | whether at the time of the initial grant or subsequently, any and 49 | all of the rights conveyed by this License. 50 | 51 | 1.10. "Modifications" 52 | means any of the following: 53 | 54 | (a) any file in Source Code Form that results from an addition to, 55 | deletion from, or modification of the contents of Covered 56 | Software; or 57 | 58 | (b) any new file in Source Code Form that contains any Covered 59 | Software. 60 | 61 | 1.11. "Patent Claims" of a Contributor 62 | means any patent claim(s), including without limitation, method, 63 | process, and apparatus claims, in any patent Licensable by such 64 | Contributor that would be infringed, but for the grant of the 65 | License, by the making, using, selling, offering for sale, having 66 | made, import, or transfer of either its Contributions or its 67 | Contributor Version. 68 | 69 | 1.12. "Secondary License" 70 | means either the GNU General Public License, Version 2.0, the GNU 71 | Lesser General Public License, Version 2.1, the GNU Affero General 72 | Public License, Version 3.0, or any later versions of those 73 | licenses. 74 | 75 | 1.13. "Source Code Form" 76 | means the form of the work preferred for making modifications. 77 | 78 | 1.14. "You" (or "Your") 79 | means an individual or a legal entity exercising rights under this 80 | License. For legal entities, "You" includes any entity that 81 | controls, is controlled by, or is under common control with You. For 82 | purposes of this definition, "control" means (a) the power, direct 83 | or indirect, to cause the direction or management of such entity, 84 | whether by contract or otherwise, or (b) ownership of more than 85 | fifty percent (50%) of the outstanding shares or beneficial 86 | ownership of such entity. 87 | 88 | 2. License Grants and Conditions 89 | -------------------------------- 90 | 91 | 2.1. Grants 92 | 93 | Each Contributor hereby grants You a world-wide, royalty-free, 94 | non-exclusive license: 95 | 96 | (a) under intellectual property rights (other than patent or trademark) 97 | Licensable by such Contributor to use, reproduce, make available, 98 | modify, display, perform, distribute, and otherwise exploit its 99 | Contributions, either on an unmodified basis, with Modifications, or 100 | as part of a Larger Work; and 101 | 102 | (b) under Patent Claims of such Contributor to make, use, sell, offer 103 | for sale, have made, import, and otherwise transfer either its 104 | Contributions or its Contributor Version. 105 | 106 | 2.2. Effective Date 107 | 108 | The licenses granted in Section 2.1 with respect to any Contribution 109 | become effective for each Contribution on the date the Contributor first 110 | distributes such Contribution. 111 | 112 | 2.3. Limitations on Grant Scope 113 | 114 | The licenses granted in this Section 2 are the only rights granted under 115 | this License. No additional rights or licenses will be implied from the 116 | distribution or licensing of Covered Software under this License. 117 | Notwithstanding Section 2.1(b) above, no patent license is granted by a 118 | Contributor: 119 | 120 | (a) for any code that a Contributor has removed from Covered Software; 121 | or 122 | 123 | (b) for infringements caused by: (i) Your and any other third party's 124 | modifications of Covered Software, or (ii) the combination of its 125 | Contributions with other software (except as part of its Contributor 126 | Version); or 127 | 128 | (c) under Patent Claims infringed by Covered Software in the absence of 129 | its Contributions. 130 | 131 | This License does not grant any rights in the trademarks, service marks, 132 | or logos of any Contributor (except as may be necessary to comply with 133 | the notice requirements in Section 3.4). 134 | 135 | 2.4. Subsequent Licenses 136 | 137 | No Contributor makes additional grants as a result of Your choice to 138 | distribute the Covered Software under a subsequent version of this 139 | License (see Section 10.2) or under the terms of a Secondary License (if 140 | permitted under the terms of Section 3.3). 141 | 142 | 2.5. Representation 143 | 144 | Each Contributor represents that the Contributor believes its 145 | Contributions are its original creation(s) or it has sufficient rights 146 | to grant the rights to its Contributions conveyed by this License. 147 | 148 | 2.6. Fair Use 149 | 150 | This License is not intended to limit any rights You have under 151 | applicable copyright doctrines of fair use, fair dealing, or other 152 | equivalents. 153 | 154 | 2.7. Conditions 155 | 156 | Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted 157 | in Section 2.1. 158 | 159 | 3. Responsibilities 160 | ------------------- 161 | 162 | 3.1. Distribution of Source Form 163 | 164 | All distribution of Covered Software in Source Code Form, including any 165 | Modifications that You create or to which You contribute, must be under 166 | the terms of this License. You must inform recipients that the Source 167 | Code Form of the Covered Software is governed by the terms of this 168 | License, and how they can obtain a copy of this License. You may not 169 | attempt to alter or restrict the recipients' rights in the Source Code 170 | Form. 171 | 172 | 3.2. Distribution of Executable Form 173 | 174 | If You distribute Covered Software in Executable Form then: 175 | 176 | (a) such Covered Software must also be made available in Source Code 177 | Form, as described in Section 3.1, and You must inform recipients of 178 | the Executable Form how they can obtain a copy of such Source Code 179 | Form by reasonable means in a timely manner, at a charge no more 180 | than the cost of distribution to the recipient; and 181 | 182 | (b) You may distribute such Executable Form under the terms of this 183 | License, or sublicense it under different terms, provided that the 184 | license for the Executable Form does not attempt to limit or alter 185 | the recipients' rights in the Source Code Form under this License. 186 | 187 | 3.3. Distribution of a Larger Work 188 | 189 | You may create and distribute a Larger Work under terms of Your choice, 190 | provided that You also comply with the requirements of this License for 191 | the Covered Software. If the Larger Work is a combination of Covered 192 | Software with a work governed by one or more Secondary Licenses, and the 193 | Covered Software is not Incompatible With Secondary Licenses, this 194 | License permits You to additionally distribute such Covered Software 195 | under the terms of such Secondary License(s), so that the recipient of 196 | the Larger Work may, at their option, further distribute the Covered 197 | Software under the terms of either this License or such Secondary 198 | License(s). 199 | 200 | 3.4. Notices 201 | 202 | You may not remove or alter the substance of any license notices 203 | (including copyright notices, patent notices, disclaimers of warranty, 204 | or limitations of liability) contained within the Source Code Form of 205 | the Covered Software, except that You may alter any license notices to 206 | the extent required to remedy known factual inaccuracies. 207 | 208 | 3.5. Application of Additional Terms 209 | 210 | You may choose to offer, and to charge a fee for, warranty, support, 211 | indemnity or liability obligations to one or more recipients of Covered 212 | Software. However, You may do so only on Your own behalf, and not on 213 | behalf of any Contributor. You must make it absolutely clear that any 214 | such warranty, support, indemnity, or liability obligation is offered by 215 | You alone, and You hereby agree to indemnify every Contributor for any 216 | liability incurred by such Contributor as a result of warranty, support, 217 | indemnity or liability terms You offer. You may include additional 218 | disclaimers of warranty and limitations of liability specific to any 219 | jurisdiction. 220 | 221 | 4. Inability to Comply Due to Statute or Regulation 222 | --------------------------------------------------- 223 | 224 | If it is impossible for You to comply with any of the terms of this 225 | License with respect to some or all of the Covered Software due to 226 | statute, judicial order, or regulation then You must: (a) comply with 227 | the terms of this License to the maximum extent possible; and (b) 228 | describe the limitations and the code they affect. Such description must 229 | be placed in a text file included with all distributions of the Covered 230 | Software under this License. Except to the extent prohibited by statute 231 | or regulation, such description must be sufficiently detailed for a 232 | recipient of ordinary skill to be able to understand it. 233 | 234 | 5. Termination 235 | -------------- 236 | 237 | 5.1. The rights granted under this License will terminate automatically 238 | if You fail to comply with any of its terms. However, if You become 239 | compliant, then the rights granted under this License from a particular 240 | Contributor are reinstated (a) provisionally, unless and until such 241 | Contributor explicitly and finally terminates Your grants, and (b) on an 242 | ongoing basis, if such Contributor fails to notify You of the 243 | non-compliance by some reasonable means prior to 60 days after You have 244 | come back into compliance. Moreover, Your grants from a particular 245 | Contributor are reinstated on an ongoing basis if such Contributor 246 | notifies You of the non-compliance by some reasonable means, this is the 247 | first time You have received notice of non-compliance with this License 248 | from such Contributor, and You become compliant prior to 30 days after 249 | Your receipt of the notice. 250 | 251 | 5.2. If You initiate litigation against any entity by asserting a patent 252 | infringement claim (excluding declaratory judgment actions, 253 | counter-claims, and cross-claims) alleging that a Contributor Version 254 | directly or indirectly infringes any patent, then the rights granted to 255 | You by any and all Contributors for the Covered Software under Section 256 | 2.1 of this License shall terminate. 257 | 258 | 5.3. In the event of termination under Sections 5.1 or 5.2 above, all 259 | end user license agreements (excluding distributors and resellers) which 260 | have been validly granted by You or Your distributors under this License 261 | prior to termination shall survive termination. 262 | 263 | ************************************************************************ 264 | * * 265 | * 6. Disclaimer of Warranty * 266 | * ------------------------- * 267 | * * 268 | * Covered Software is provided under this License on an "as is" * 269 | * basis, without warranty of any kind, either expressed, implied, or * 270 | * statutory, including, without limitation, warranties that the * 271 | * Covered Software is free of defects, merchantable, fit for a * 272 | * particular purpose or non-infringing. The entire risk as to the * 273 | * quality and performance of the Covered Software is with You. * 274 | * Should any Covered Software prove defective in any respect, You * 275 | * (not any Contributor) assume the cost of any necessary servicing, * 276 | * repair, or correction. This disclaimer of warranty constitutes an * 277 | * essential part of this License. No use of any Covered Software is * 278 | * authorized under this License except under this disclaimer. * 279 | * * 280 | ************************************************************************ 281 | 282 | ************************************************************************ 283 | * * 284 | * 7. Limitation of Liability * 285 | * -------------------------- * 286 | * * 287 | * Under no circumstances and under no legal theory, whether tort * 288 | * (including negligence), contract, or otherwise, shall any * 289 | * Contributor, or anyone who distributes Covered Software as * 290 | * permitted above, be liable to You for any direct, indirect, * 291 | * special, incidental, or consequential damages of any character * 292 | * including, without limitation, damages for lost profits, loss of * 293 | * goodwill, work stoppage, computer failure or malfunction, or any * 294 | * and all other commercial damages or losses, even if such party * 295 | * shall have been informed of the possibility of such damages. This * 296 | * limitation of liability shall not apply to liability for death or * 297 | * personal injury resulting from such party's negligence to the * 298 | * extent applicable law prohibits such limitation. Some * 299 | * jurisdictions do not allow the exclusion or limitation of * 300 | * incidental or consequential damages, so this exclusion and * 301 | * limitation may not apply to You. * 302 | * * 303 | ************************************************************************ 304 | 305 | 8. Litigation 306 | ------------- 307 | 308 | Any litigation relating to this License may be brought only in the 309 | courts of a jurisdiction where the defendant maintains its principal 310 | place of business and such litigation shall be governed by laws of that 311 | jurisdiction, without reference to its conflict-of-law provisions. 312 | Nothing in this Section shall prevent a party's ability to bring 313 | cross-claims or counter-claims. 314 | 315 | 9. Miscellaneous 316 | ---------------- 317 | 318 | This License represents the complete agreement concerning the subject 319 | matter hereof. If any provision of this License is held to be 320 | unenforceable, such provision shall be reformed only to the extent 321 | necessary to make it enforceable. Any law or regulation which provides 322 | that the language of a contract shall be construed against the drafter 323 | shall not be used to construe this License against a Contributor. 324 | 325 | 10. Versions of the License 326 | --------------------------- 327 | 328 | 10.1. New Versions 329 | 330 | Mozilla Foundation is the license steward. Except as provided in Section 331 | 10.3, no one other than the license steward has the right to modify or 332 | publish new versions of this License. Each version will be given a 333 | distinguishing version number. 334 | 335 | 10.2. Effect of New Versions 336 | 337 | You may distribute the Covered Software under the terms of the version 338 | of the License under which You originally received the Covered Software, 339 | or under the terms of any subsequent version published by the license 340 | steward. 341 | 342 | 10.3. Modified Versions 343 | 344 | If you create software not governed by this License, and you want to 345 | create a new license for such software, you may create and use a 346 | modified version of this License if you rename the license and remove 347 | any references to the name of the license steward (except to note that 348 | such modified license differs from this License). 349 | 350 | 10.4. Distributing Source Code Form that is Incompatible With Secondary 351 | Licenses 352 | 353 | If You choose to distribute Source Code Form that is Incompatible With 354 | Secondary Licenses under the terms of this version of the License, the 355 | notice described in Exhibit B of this License must be attached. 356 | 357 | Exhibit A - Source Code Form License Notice 358 | ------------------------------------------- 359 | 360 | This Source Code Form is subject to the terms of the Mozilla Public 361 | License, v. 2.0. If a copy of the MPL was not distributed with this 362 | file, You can obtain one at http://mozilla.org/MPL/2.0/. 363 | 364 | If it is not possible or desirable to put the notice in a particular 365 | file, then You may include the notice in a location (such as a LICENSE 366 | file in a relevant directory) where a recipient would be likely to look 367 | for such a notice. 368 | 369 | You may add additional accurate notices of copyright ownership. 370 | 371 | Exhibit B - "Incompatible With Secondary Licenses" Notice 372 | --------------------------------------------------------- 373 | 374 | This Source Code Form is "Incompatible With Secondary Licenses", as 375 | defined by the Mozilla Public License, v. 2.0. 376 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # HashiCorp's Link Checker 2 | 3 | ![C/I Status](https://github.com/hashicorp/gh-action-check-broken-links/workflows/C/I/badge.svg) 4 | 5 | A GitHub Action that reports all broken links found within a set of provided `.mdx` files 6 | 7 | - :warning: Currently only supports `.mdx` files 8 | - :warning: Assumes a Next.js project structure (i.e. links resolve from the `/pages` directory) 9 | 10 | ## Features 11 | 12 | Parses `.mdx` files, locating all links. Reports back any failed requests including those that contain a fragment identifier (i.e. https://example.com/page#identifier) but whose resulting markup does not. 13 | 14 | ## Example Usage 15 | 16 | ```yaml 17 | - name: HashiCorp's Link Checker 18 | uses: hashicorp/gh-action-check-broken-links@v1 19 | with: 20 | baseUrl: 'https://hashicorp.com' 21 | files: 'pages/foo.mdx pages/bar.mdx' 22 | whitelist: | 23 | https://google.com/whitelist 24 | https://yahoo.com/whitelist 25 | ``` 26 | -------------------------------------------------------------------------------- /__tests__/fixtures/mdx/pages/consul.mdx: -------------------------------------------------------------------------------- 1 | # Consul 2 | 3 | Here is some text 4 | 5 | Here is another paragraph with [a link](https://github.com) to GitHub. And another to [HashiCorp](https://hashicorp.com) 6 | -------------------------------------------------------------------------------- /__tests__/fixtures/mdx/pages/terraform/getting-started.mdx: -------------------------------------------------------------------------------- 1 | # Terraform 2 | 3 | ## Getting Started 4 | 5 | Here is some copy that will help you to [get started](/start) 6 | 7 | Great work! [You've completed the guide!](#terraform-success) 8 | -------------------------------------------------------------------------------- /__tests__/fixtures/mixed/content/tutorials/vault/getting-started.mdx: -------------------------------------------------------------------------------- 1 | # Tutorial 2 | 3 | [This is a link](/link) 4 | -------------------------------------------------------------------------------- /__tests__/fixtures/mixed/pages/terraform/install.mdx: -------------------------------------------------------------------------------- 1 | # Install 2 | 3 | Stuff here and a [link](/link) here -------------------------------------------------------------------------------- /__tests__/lib.test.ts: -------------------------------------------------------------------------------- 1 | jest.mock('node-fetch') 2 | import fetch from 'node-fetch' 3 | 4 | import path from 'path' 5 | import { Position } from 'unist' 6 | 7 | import * as lib from '../src/lib' 8 | import * as utils from '../src/utils' 9 | 10 | import pkg from '../package.json' 11 | 12 | const { Response } = jest.requireActual('node-fetch') 13 | 14 | describe(`${pkg.name} -- Library`, () => { 15 | afterAll(() => jest.restoreAllMocks()) 16 | 17 | describe('getLinkInfoFromFiles()', () => { 18 | it('should construct an array of objects that each contain both a filename and an array of its associated links', () => { 19 | const workspace = path.join(__dirname, 'fixtures/mdx') 20 | const files = ['pages/consul.mdx', 'pages/terraform/getting-started.mdx'] 21 | 22 | const actual = lib.getLinkInfoFromFiles(workspace, files) 23 | expect(actual).toEqual( 24 | expect.arrayContaining([ 25 | expect.objectContaining({ 26 | filename: 'pages/consul.mdx', 27 | links: expect.any(Array) 28 | }), 29 | expect.objectContaining({ 30 | filename: 'pages/terraform/getting-started.mdx', 31 | links: expect.any(Array) 32 | }) 33 | ]) 34 | ) 35 | }) 36 | 37 | it("should reject files outside the 'pages' or 'content' directories", () => { 38 | const workspace = path.join(__dirname, 'fixtures/mixed') 39 | const files = [ 40 | 'invalid/terraform/foo.mdx', 41 | 'content/tutorials/vault/getting-started.mdx', 42 | 'pages/terraform/install.mdx' 43 | ] 44 | 45 | const actual = lib.getLinkInfoFromFiles(workspace, files) 46 | 47 | expect(actual.length).toEqual(2) 48 | 49 | expect(actual).toEqual( 50 | expect.arrayContaining([ 51 | expect.objectContaining({ 52 | filename: 'content/tutorials/vault/getting-started.mdx' 53 | }), 54 | expect.objectContaining({ 55 | filename: 'pages/terraform/install.mdx' 56 | }) 57 | ]) 58 | ) 59 | }) 60 | }) 61 | 62 | describe('collectBrokenLinks()', () => { 63 | const mockedFetch = (fetch as unknown) as jest.Mock> 64 | 65 | beforeEach(() => { 66 | jest.resetAllMocks() 67 | }) 68 | 69 | it('should return an array of objects whose network request failed', async () => { 70 | const failedStatusCode = 555 71 | mockedFetch 72 | .mockReturnValueOnce( 73 | Promise.resolve(new Response(undefined, { status: failedStatusCode })) 74 | ) 75 | .mockReturnValue( 76 | Promise.resolve(new Response(undefined, { status: 200 })) 77 | ) 78 | 79 | const baseUrl = 'https://hashicorp.com' 80 | const linkInfo = [ 81 | { 82 | filename: 'pages/consul/getting-started/install.mdx', 83 | links: [ 84 | { url: '/foo', position: ({} as unknown) as Position }, 85 | { url: '/bar', position: ({} as unknown) as Position }, 86 | { url: '/baz', position: ({} as unknown) as Position } 87 | ] 88 | } 89 | ] 90 | 91 | const actual = await lib.collectBrokenLinks(baseUrl, linkInfo, []) 92 | 93 | expect(actual).toHaveLength(1) 94 | 95 | expect(actual).toEqual( 96 | expect.arrayContaining([ 97 | expect.objectContaining({ 98 | filename: 'pages/consul/getting-started/install.mdx', 99 | href: expect.objectContaining({ 100 | relativeHref: '/foo', 101 | qualifiedHref: 'https://hashicorp.com/foo' 102 | }), 103 | res: failedStatusCode, 104 | position: expect.any(Object) 105 | }) 106 | ]) 107 | ) 108 | }) 109 | 110 | it('should not report any urls that are in the provided whitelist', async () => { 111 | const failedStatusCode = 555 112 | mockedFetch.mockReturnValue( 113 | Promise.resolve(new Response(undefined, { status: failedStatusCode })) 114 | ) 115 | 116 | const baseUrl = 'https://hashicorp.com' 117 | 118 | const linkInfo = [ 119 | { 120 | filename: 'pages/consul/getting-started/install.mdx', 121 | links: [ 122 | { url: '/foo', position: ({} as unknown) as Position }, 123 | { url: '/bar', position: ({} as unknown) as Position }, 124 | { url: '/baz', position: ({} as unknown) as Position } 125 | ] 126 | } 127 | ] 128 | 129 | const whitelist = [ 130 | 'https://hashicorp.com/foo', 131 | 'https://hashicorp.com/baz' 132 | ] 133 | 134 | const actual = await lib.collectBrokenLinks(baseUrl, linkInfo, whitelist) 135 | 136 | expect(actual).toHaveLength(1) 137 | 138 | expect(actual).toEqual( 139 | expect.arrayContaining([ 140 | expect.objectContaining({ 141 | filename: 'pages/consul/getting-started/install.mdx', 142 | href: expect.objectContaining({ 143 | relativeHref: '/bar', 144 | qualifiedHref: 'https://hashicorp.com/bar' 145 | }), 146 | res: failedStatusCode, 147 | position: expect.any(Object) 148 | }) 149 | ]) 150 | ) 151 | }) 152 | 153 | it('should return an empty array if all urls returned successful network requests', async () => { 154 | mockedFetch.mockReturnValue( 155 | Promise.resolve(new Response(undefined, { status: 200 })) 156 | ) 157 | 158 | const baseUrl = 'https://hashicorp.com' 159 | 160 | const linkInfo = [ 161 | { 162 | filename: 'pages/consul/getting-started/install.mdx', 163 | links: [ 164 | { url: '/foo', position: ({} as unknown) as Position }, 165 | { url: '/bar', position: ({} as unknown) as Position }, 166 | { url: '/baz', position: ({} as unknown) as Position } 167 | ] 168 | } 169 | ] 170 | 171 | const actual = await lib.collectBrokenLinks(baseUrl, linkInfo, []) 172 | 173 | expect(actual).toStrictEqual([]) 174 | }) 175 | }) 176 | 177 | describe('resolveUrl()', () => { 178 | it('should handle an anchor', () => { 179 | const baseUrl = 'https://hashicorp.com' 180 | const filename = 'consul/getting-started/install.mdx' 181 | const href = '#anchor-link' 182 | 183 | const actual = lib.resolveUrl(baseUrl, filename, href) 184 | const expected = 185 | 'https://hashicorp.com/consul/getting-started/install#anchor-link' 186 | 187 | expect(actual).toBe(expected) 188 | }) 189 | 190 | it('should handle deep relative link', () => { 191 | const baseUrl = 'https://hashicorp.com' 192 | const filename = 'consul/getting-started/install.mdx' 193 | const href = '/foo' 194 | 195 | const actual = lib.resolveUrl(baseUrl, filename, href) 196 | const expected = 'https://hashicorp.com/foo' 197 | 198 | expect(actual).toBe(expected) 199 | }) 200 | }) 201 | 202 | describe('fetchStatusCode()', () => { 203 | const mockedFetch = (fetch as unknown) as jest.Mock> 204 | beforeEach(() => jest.restoreAllMocks()) 205 | 206 | it('should perform a network request given a url', async () => { 207 | const href = 'https://google.com' 208 | 209 | mockedFetch.mockReturnValue(Promise.resolve(new Response())) 210 | 211 | await lib.fetchStatusCode(href) 212 | 213 | expect(mockedFetch).toHaveBeenCalledTimes(1) 214 | }) 215 | 216 | it('should return the status code of the network request', async () => { 217 | const href = 'https://google.com' 218 | const statusCode = 301 219 | 220 | mockedFetch.mockReturnValueOnce( 221 | Promise.resolve(new Response(undefined, { status: statusCode })) 222 | ) 223 | 224 | const actual = await lib.fetchStatusCode(href) 225 | 226 | expect(actual).toEqual(statusCode) 227 | }) 228 | 229 | it('should perform a number of retries and finally return a status code of 503 if network cannot resolve', async () => { 230 | mockedFetch.mockReturnValue(Promise.reject()) 231 | 232 | const actual = await lib.fetchStatusCode('https://google.commmm') 233 | 234 | expect(mockedFetch).toBeCalledTimes(5) 235 | 236 | expect(actual).toEqual(503) 237 | }) 238 | 239 | describe('> with anchor links', () => { 240 | it('should return a status code of 502 when an anchor link is not present in the resulting markup', async () => { 241 | const anchor = 'inline-link-test' 242 | const hash = `#${anchor}` 243 | const markup = '

No anchor links here!

' 244 | 245 | const isAnchorLinkPresentSpy = jest 246 | .spyOn(utils, 'isAnchorLinkPresent') 247 | .mockImplementation(() => false) 248 | 249 | mockedFetch.mockReturnValue( 250 | Promise.resolve( 251 | new Response(markup, { 252 | status: 200 253 | }) 254 | ) 255 | ) 256 | 257 | const actual = await lib.fetchStatusCode(`https://hashicorp.com${hash}`) 258 | 259 | expect(isAnchorLinkPresentSpy).toBeCalledWith(hash, markup) 260 | 261 | expect(actual).toEqual(502) 262 | }) 263 | 264 | it('should return the status code of the initial request when the anchor link is present in the resulting markup', async () => { 265 | const anchor = 'inline-link' 266 | const hash = `#${anchor}` 267 | const markup = `

Inline link present!

` 268 | const status = 301 269 | 270 | mockedFetch.mockReturnValue( 271 | Promise.resolve( 272 | new Response(markup, { 273 | status 274 | }) 275 | ) 276 | ) 277 | 278 | const isAnchorLinkPresentSpy = jest 279 | .spyOn(utils, 'isAnchorLinkPresent') 280 | .mockImplementation(() => true) 281 | 282 | const actual = await lib.fetchStatusCode(`https://hashicorp.com${hash}`) 283 | 284 | expect(isAnchorLinkPresentSpy).toBeCalledWith(hash, markup) 285 | 286 | expect(actual).toEqual(status) 287 | }) 288 | 289 | it('should not treat shebang url fragments as anchor links', async () => { 290 | mockedFetch.mockReturnValue( 291 | Promise.resolve(new Response(undefined, { status: 200 })) 292 | ) 293 | 294 | const isAnchorLinkPresentSpy = jest.spyOn(utils, 'isAnchorLinkPresent') 295 | 296 | await lib.fetchStatusCode( 297 | 'https://groups.google.com/forum/#!forum/vault-tool' 298 | ) 299 | 300 | expect(isAnchorLinkPresentSpy).not.toHaveBeenCalled() 301 | }) 302 | }) 303 | }) 304 | }) 305 | -------------------------------------------------------------------------------- /__tests__/utils.test.ts: -------------------------------------------------------------------------------- 1 | import path from 'path' 2 | 3 | import * as utils from '../src/utils' 4 | 5 | import pkg from '../package.json' 6 | 7 | describe(`${pkg.name} -- Utilities`, () => { 8 | describe('findAllLinks()', () => { 9 | it('should return an array of objects with all link information given a file', () => { 10 | const consulFile = path.join( 11 | __dirname, 12 | 'fixtures/mdx/pages', 13 | 'consul.mdx' 14 | ) 15 | const terraformFile = path.join( 16 | __dirname, 17 | 'fixtures/mdx/pages', 18 | 'terraform/getting-started.mdx' 19 | ) 20 | 21 | expect(utils.findAllLinks(consulFile)).toEqual( 22 | expect.arrayContaining([ 23 | expect.objectContaining({ 24 | url: 'https://github.com', 25 | position: expect.objectContaining({ 26 | start: expect.any(Object), 27 | end: expect.any(Object) 28 | }) 29 | }), 30 | expect.objectContaining({ 31 | url: 'https://hashicorp.com', 32 | position: expect.objectContaining({ 33 | start: expect.any(Object), 34 | end: expect.any(Object) 35 | }) 36 | }) 37 | ]) 38 | ) 39 | 40 | expect(utils.findAllLinks(terraformFile)).toEqual( 41 | expect.arrayContaining([ 42 | expect.objectContaining({ 43 | url: '/start', 44 | position: expect.objectContaining({ 45 | start: expect.any(Object), 46 | end: expect.any(Object) 47 | }) 48 | }), 49 | expect.objectContaining({ 50 | url: '#terraform-success', 51 | position: expect.objectContaining({ 52 | start: expect.any(Object), 53 | end: expect.any(Object) 54 | }) 55 | }) 56 | ]) 57 | ) 58 | }) 59 | }) 60 | 61 | describe('isAnchorLinkPresent()', () => { 62 | it('should return true when the anchor link is present on "name" property of an anchor tag', async () => { 63 | const anchor = 'internal-link' 64 | const hash = `#${anchor}` 65 | const markup = ` 66 | 67 | 68 |

Hello World!

69 | ` 70 | const actual = utils.isAnchorLinkPresent(hash, markup) 71 | expect(actual).toBe(true) 72 | }) 73 | 74 | it('should return true when the anchor link is present on any element\'s "id" property', async () => { 75 | const anchor = 'my-cool-internal-link' 76 | const hash = `#${anchor}` 77 | const markup = ` 78 | 79 |

Hello World!

80 |