Reduce explicit any usage across automated contexts and tests (#58806)

Author: heiskr

eslint.config.ts

@@ -97,7 +97,7 @@ export default [
 
       // Disabled rules to review
       'no-console': 'off', // 800+
-      '@typescript-eslint/no-explicit-any': 'off', // 1000+
+      '@typescript-eslint/no-explicit-any': 'off',
     },
   },
 

src/automated-pipelines/components/AutomatedPageContext.tsx

@@ -1,6 +1,8 @@
 import { createContext, useContext } from 'react'
+import type { IncomingMessage } from 'http'
 import type { JSX } from 'react'
 import type { MiniTocItem } from '@/frame/components/context/ArticleContext'
+import type { Context } from '@/types'
 
 export type AutomatedPageContextT = {
   title: string
@@ -25,15 +27,35 @@ export const useAutomatedPageContext = (): AutomatedPageContextT => {
   return context
 }
 
-export const getAutomatedPageContextFromRequest = (req: any): AutomatedPageContextT => {
-  const page = req.context.page
+type AutomatedPageContextRequest = { context?: Partial<Context> } | IncomingMessage
+
+type AutomatedPage = {
+  title: string
+  intro: string
+  product?: string
+  permissions?: string
+  rawPermissions?: string
+}
+
+export const getAutomatedPageContextFromRequest = (
+  req: AutomatedPageContextRequest,
+): AutomatedPageContextT => {
+  const context = 'context' in req ? ((req.context as Partial<Context> | undefined) ?? {}) : {}
+  const page = context.page as AutomatedPage | undefined
+
+  if (!page) {
+    throw new Error('"getAutomatedPageContextFromRequest" requires req.context.page')
+  }
+
+  const renderedPage = context.renderedPage ?? ''
+  const miniTocItems = context.miniTocItems ?? []
 
   return {
     title: page.title,
     intro: page.intro,
-    renderedPage: req.context.renderedPage || '',
-    miniTocItems: req.context.miniTocItems || [],
-    product: page.product || '',
-    permissions: page.permissions || '',
+    renderedPage,
+    miniTocItems,
+    product: page.product ?? '',
+    permissions: page.permissions ?? page.rawPermissions ?? '',
   }
 }

src/fixtures/tests/annotations.ts

@@ -22,7 +22,7 @@ describe('annotations', () => {
       expect(annotation.find('.annotate-inline').length).toBe(1)
       expect(annotation.find('.annotate-row').length).toBe(3)
       const notes = $('.annotate-row .annotate-note p', annotation)
-      const noteTexts = notes.map((i: number, el: any) => $(el).text()).get()
+      const noteTexts = notes.map((_, el) => $(el).text()).get()
       expect(noteTexts).toEqual(["Let's get started", 'This is just a sample', 'End of the script'])
     }
     // Second code snippet block
@@ -33,7 +33,7 @@ describe('annotations', () => {
       expect(annotation.find('.annotate-inline').length).toBe(1)
       expect(annotation.find('.annotate-row').length).toBe(2)
       const notes = $('.annotate-row .annotate-note p', annotation)
-      const noteTexts = notes.map((i: number, el: any) => $(el).text()).get()
+      const noteTexts = notes.map((_, el) => $(el).text()).get()
       expect(noteTexts).toEqual(['Has to start with a comment.', 'This is the if statement'])
     }
     // Yaml code snippet that starts with an empty comment
@@ -44,7 +44,7 @@ describe('annotations', () => {
       expect(annotation.find('.annotate-inline').length).toBe(1)
       expect(annotation.find('.annotate-row').length).toBe(3)
       const notes = $('.annotate-row .annotate-note p', annotation)
-      const noteTexts = notes.map((i: number, el: any) => $(el).text()).get()
+      const noteTexts = notes.map((_, el) => $(el).text()).get()
       expect(noteTexts).toEqual([
         'Configures this workflow to run every time a change is pushed to the branch called release.',
         "This job checks out the repository contents ...\nAnd here's the second comment line.",

src/frame/tests/find-page-middleware.ts

@@ -1,45 +1,52 @@
 import { fileURLToPath } from 'url'
 import path from 'path'
 import http from 'http'
+import { Socket } from 'net'
 
 import { describe, expect, test } from 'vitest'
 import type { Response } from 'express'
 
 import Page from '@/frame/lib/page'
 import findPage from '@/frame/middleware/find-page'
-import type { ExtendedRequest } from '@/types'
+import type { ExtendedRequest, Context } from '@/types'
 
 const __dirname = path.dirname(fileURLToPath(import.meta.url))
 
+type TestResponse = Response & { _status?: number; _message?: string }
+
 function makeRequestResponse(
   url: string,
   currentVersion = 'free-pro-team@latest',
-): [ExtendedRequest, Response & { _status?: number; _message?: string }] {
-  const req = new http.IncomingMessage(null as any) as ExtendedRequest
+): [ExtendedRequest, TestResponse] {
+  const req = new http.IncomingMessage(new Socket()) as ExtendedRequest
+
+  Object.defineProperty(req, 'path', {
+    value: url,
+    writable: true,
+  })
+
   req.method = 'GET'
   req.url = url
-  // @ts-expect-error - path is read-only but we need to set it for testing
-  req.path = url
   req.cookies = {}
   req.headers = {}
 
-  // Custom keys on the request
+  const context: Context = {
+    currentVersion,
+    pages: {},
+  }
+
   req.pagePath = url
-  req.context = {}
-  req.context.currentVersion = currentVersion
-  req.context.pages = {}
+  req.context = context
 
-  const res = new http.ServerResponse(req) as Response & {
-    _status?: number
-    _message?: string
-  }
-  res.status = function (code: number) {
+  const res = new http.ServerResponse(req) as TestResponse
+  res.status = function status(this: TestResponse, code: number) {
     this._status = code
-    return {
+    return Object.assign(this, {
       send: (message: string) => {
         this._message = message
+        return this
       },
-    } as any
+    })
   }
 
   return [req, res]
@@ -56,7 +63,7 @@ describe('find page middleware', () => {
     })
     if (page && req.context) {
       req.context.pages = {
-        '/en/foo/bar': page as any,
+        '/en/foo/bar': page,
       }
     }
 
@@ -88,7 +95,7 @@ describe('find page middleware', () => {
     })
     if (page && req.context) {
       req.context.pages = {
-        '/en/page-with-redirects': page as any,
+        '/en/page-with-redirects': page,
       }
     }
 
@@ -98,6 +105,7 @@ describe('find page middleware', () => {
     })
     expect(req.context?.page).toBeInstanceOf(Page)
   })
+
   test('finds it for non-fpt version URLS', async () => {
     const [req, res] = makeRequestResponse('/en/page-with-redirects', 'enterprise-cloud@latest')
     const page = await Page.init({
@@ -107,7 +115,7 @@ describe('find page middleware', () => {
     })
     if (page && req.context) {
       req.context.pages = {
-        '/en/page-with-redirects': page as any,
+        '/en/page-with-redirects': page,
       }
     }
 
@@ -129,7 +137,7 @@ describe('find page middleware', () => {
     })
     if (page && req.context) {
       req.context.pages = {
-        '/en/page-with-redirects': page as any,
+        '/en/page-with-redirects': page,
       }
     }
 

src/frame/tests/resolve-recommended.test.ts

@@ -1,6 +1,6 @@
 import { describe, test, expect, vi, beforeEach } from 'vitest'
 import type { Response, NextFunction } from 'express'
-import type { ExtendedRequest } from '@/types'
+import type { ExtendedRequest, Page, ResolvedArticle } from '@/types'
 import findPage from '@/frame/lib/find-page'
 import resolveRecommended from '../middleware/resolve-recommended'
 
@@ -17,23 +17,38 @@ vi.mock('@/content-render/index', () => ({
 describe('resolveRecommended middleware', () => {
   const mockFindPage = vi.mocked(findPage)
 
-  const createMockRequest = (pageData: any = {}, contextData: any = {}): ExtendedRequest =>
-    ({
-      context: {
-        page: pageData,
-        pages: {
+  type TestPage = Partial<Page> & {
+    rawRecommended?: string[]
+    spotlight?: Array<{ article: string }>
+  }
+
+  const createMockRequest = (
+    pageData: TestPage = {},
+    contextData: Partial<ExtendedRequest['context']> & { pages?: Record<string, Page> } = {},
+  ): ExtendedRequest => {
+    const { pages: pagesOverride, ...restContext } = contextData
+    const hasPagesOverride = Object.prototype.hasOwnProperty.call(contextData, 'pages')
+    const pages = hasPagesOverride
+      ? pagesOverride
+      : ({
           '/test-article': {
             title: 'Test Article',
             intro: 'Test intro',
             relativePath: 'test/article.md',
-          },
-        },
+          } as unknown as Page,
+        } as Record<string, Page>)
+
+    return {
+      context: {
+        page: pageData as Page,
+        pages,
         redirects: {},
         currentVersion: 'free-pro-team@latest',
         currentLanguage: 'en',
-        ...contextData,
+        ...restContext,
       },
-    }) as ExtendedRequest
+    } as unknown as ExtendedRequest
+  }
 
   const mockRes = {} as Response
   const mockNext = vi.fn() as NextFunction
@@ -86,7 +101,7 @@ describe('resolveRecommended middleware', () => {
       applicableVersions: ['free-pro-team@latest'],
     }
 
-    mockFindPage.mockReturnValue(testPage as any)
+    mockFindPage.mockReturnValue(testPage as unknown as Page)
 
     const req = createMockRequest({ rawRecommended: ['/copilot/tutorials/article'] })
 
@@ -97,7 +112,7 @@ describe('resolveRecommended middleware', () => {
       req.context!.pages,
       req.context!.redirects,
     )
-    expect((req.context!.page as any).recommended).toEqual([
+    expect((req.context!.page as Page & { recommended?: ResolvedArticle[] }).recommended).toEqual([
       {
         title: 'Test Article',
         intro: '<p>Test intro</p>',
@@ -116,7 +131,7 @@ describe('resolveRecommended middleware', () => {
       applicableVersions: ['free-pro-team@latest'],
     }
 
-    mockFindPage.mockReturnValueOnce(testPage as any)
+    mockFindPage.mockReturnValueOnce(testPage as unknown as Page)
 
     const req = createMockRequest({
       rawRecommended: ['/copilot/tutorials/article'],
@@ -131,7 +146,7 @@ describe('resolveRecommended middleware', () => {
       req.context!.pages,
       req.context!.redirects,
     )
-    expect((req.context!.page as any).recommended).toEqual([
+    expect((req.context!.page as Page & { recommended?: ResolvedArticle[] }).recommended).toEqual([
       {
         title: 'Test Article',
         intro: '<p>Test intro</p>',
@@ -154,7 +169,9 @@ describe('resolveRecommended middleware', () => {
       req.context!.pages,
       req.context!.redirects,
     )
-    expect((req.context!.page as any).recommended).toEqual([])
+    expect((req.context!.page as Page & { recommended?: ResolvedArticle[] }).recommended).toEqual(
+      [],
+    )
     expect(mockNext).toHaveBeenCalled()
   })
 
@@ -163,11 +180,13 @@ describe('resolveRecommended middleware', () => {
       throw new Error('Test error')
     })
 
-    const req = createMockRequest({ rawRecommended: ['/error-article'] })
+    const req = createMockRequest({ rawRecommended: ['/error-article'] as string[] })
 
     await resolveRecommended(req, mockRes, mockNext)
 
-    expect((req.context!.page as any).recommended).toEqual([])
+    expect((req.context!.page as Page & { recommended?: ResolvedArticle[] }).recommended).toEqual(
+      [],
+    )
     expect(mockNext).toHaveBeenCalled()
   })
 
@@ -179,13 +198,13 @@ describe('resolveRecommended middleware', () => {
       applicableVersions: ['free-pro-team@latest'],
     }
 
-    mockFindPage.mockReturnValueOnce(testPage as any).mockReturnValueOnce(undefined)
+    mockFindPage.mockReturnValueOnce(testPage as unknown as Page).mockReturnValueOnce(undefined)
 
     const req = createMockRequest({ rawRecommended: ['/valid-article', '/invalid-article'] })
 
     await resolveRecommended(req, mockRes, mockNext)
 
-    expect((req.context!.page as any).recommended).toEqual([
+    expect((req.context!.page as Page & { recommended?: ResolvedArticle[] }).recommended).toEqual([
       {
         title: 'Valid Article',
         intro: '<p>Valid intro</p>',
@@ -205,7 +224,7 @@ describe('resolveRecommended middleware', () => {
     }
 
     // Mock findPage to fail on first call (content-relative) and succeed on second (page-relative)
-    mockFindPage.mockReturnValueOnce(undefined).mockReturnValueOnce(testPage as any)
+    mockFindPage.mockReturnValueOnce(undefined).mockReturnValueOnce(testPage as unknown as Page)
 
     const req = createMockRequest({
       rawRecommended: ['relative-article'],
@@ -225,7 +244,7 @@ describe('resolveRecommended middleware', () => {
       req.context!.pages,
       req.context!.redirects,
     )
-    expect((req.context!.page as any).recommended).toEqual([
+    expect((req.context!.page as Page & { recommended?: ResolvedArticle[] }).recommended).toEqual([
       {
         title: 'Relative Article',
         intro: '<p>Relative intro</p>',
@@ -244,7 +263,7 @@ describe('resolveRecommended middleware', () => {
       applicableVersions: ['free-pro-team@latest'],
     }
 
-    mockFindPage.mockReturnValue(testPage as any)
+    mockFindPage.mockReturnValue(testPage as unknown as Page)
 
     const req = createMockRequest({ rawRecommended: ['/copilot/tutorials/tutorial-page'] })
 
@@ -258,7 +277,7 @@ describe('resolveRecommended middleware', () => {
 
     // Verify that the href is a clean path without language/version, that gets
     // added on the React side.
-    expect((req.context!.page as any).recommended).toEqual([
+    expect((req.context!.page as Page & { recommended?: ResolvedArticle[] }).recommended).toEqual([
       {
         title: 'Tutorial Page',
         intro: '<p>Tutorial intro</p>',
@@ -278,7 +297,7 @@ describe('resolveRecommended middleware', () => {
       applicableVersions: ['free-pro-team@latest'], // Not available in ghec
     }
 
-    mockFindPage.mockReturnValue(fptOnlyPage as any)
+    mockFindPage.mockReturnValue(fptOnlyPage as unknown as Page)
 
     // Create a request context where we're viewing the GHEC version
     const req = createMockRequest(
@@ -292,7 +311,9 @@ describe('resolveRecommended middleware', () => {
     await resolveRecommended(req, mockRes, mockNext)
 
     // The recommended array should be empty since the article isn't available in enterprise-cloud
-    expect((req.context!.page as any).recommended).toEqual([])
+    expect((req.context!.page as Page & { recommended?: ResolvedArticle[] }).recommended).toEqual(
+      [],
+    )
     expect(mockNext).toHaveBeenCalled()
   })
 })