Merge pull request #288 from salesforce/wjh/fix-ts-ignores

Remove some @ts-ignore directives.

lib/__tests__/cookieJar.spec.ts

@@ -160,8 +160,9 @@ describe('CookieJar', () => {
     })
 
     it('should set a timestamp when storing or retrieving a cookie', async () => {
-      // @ts-ignore
-      cookie = Cookie.parse('a=b; Domain=example.com; Path=/')
+      // We know that we're passing a valid cookie, so we can use the non-null assertion
+      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+      cookie = Cookie.parse('a=b; Domain=example.com; Path=/')!
       const t0 = new Date()
 
       expect(cookie).toEqual(
@@ -1007,7 +1008,6 @@ describe('CookieJar', () => {
     })
 
     it('should remove all from matching domain', async () => {
-      // @ts-ignore
       await cookieJar.store.removeCookies('example.com', null)
 
       const exampleCookies = await cookieJar.store.findCookies(
@@ -1145,11 +1145,8 @@ describe('loose mode', () => {
 it('should fix issue #132', async () => {
   const cookieJar = new CookieJar()
   await expect(
-    cookieJar.setCookie(
-      // @ts-ignore
-      { key: 'x', value: 'y' },
-      'http://example.com/',
-    ),
+    // @ts-expect-error test case is explicitly testing invalid input
+    cookieJar.setCookie({ key: 'x', value: 'y' }, 'http://example.com/'),
   ).rejects.toThrowError(
     'First argument to setCookie must be a Cookie object or string',
   )
@@ -1177,15 +1174,12 @@ it('should fix issue #144', async () => {
   ])
 })
 
-it('should fix issue #145 - missing 2nd url parameter', async () => {
-  expect.assertions(1)
+it('should fix issue #145 - missing 2nd url parameter', () => {
   const cookieJar = new CookieJar()
-  try {
-    // @ts-ignore
-    await cookieJar.setCookie('x=y; Domain=example.com; Path=/')
-  } catch (e) {
-    expect(e).toBeInstanceOf(ParameterError)
-  }
+  expect(
+    // @ts-expect-error test case explicitly violates the expected function signature
+    () => cookieJar.setCookie('x=y; Domain=example.com; Path=/'),
+  ).toThrow(ParameterError)
 })
 
 it('should fix issue #197 - CookieJar().setCookie throws an error when empty cookie is passed', async () => {

lib/__tests__/defaultPath.spec.ts

@@ -24,7 +24,6 @@ describe('defaultPath', () => {
       output: '/',
     },
   ])('defaultPath("$input") => $output', ({ input, output }) => {
-    // @ts-ignore
     expect(defaultPath(input)).toBe(output)
   })
 })

lib/__tests__/domainMatch.spec.ts

@@ -70,7 +70,6 @@ describe('domainMatch', () => {
     ['com', 'com', true], // "are identical" rule
     ['NOTATLD', 'notaTLD', true], // "are identical" rule (after canonicalization)
   ])('domainMatch(%s, %s) => %s', (string, domain, expectedValue) => {
-    // @ts-ignore
     expect(domainMatch(string, domain)).toBe(expectedValue)
   })
 })

lib/cookie.ts

@@ -383,8 +383,8 @@ function canonicalDomain(str: string | null) {
 
 // S5.1.3 Domain Matching
 function domainMatch(
-  str?: string,
-  domStr?: string,
+  str?: string | null,
+  domStr?: string | null,
   canonicalize?: boolean,
 ): boolean | null {
   if (str == null || domStr == null) {
@@ -456,7 +456,7 @@ function domainMatch(
  *
  * Assumption: the path (and not query part or absolute uri) is passed in.
  */
-function defaultPath(path?: string): string {
+function defaultPath(path?: string | null): string {
   // "2. If the uri-path is empty or if the first character of the uri-path is not
   // a %x2F ("/") character, output %x2F ("/") and skip the remaining steps.
   if (!path || path.substr(0, 1) !== '/') {
@@ -757,9 +757,7 @@ function fromJSON(str: string | SerializedCookie | null | undefined) {
   }
 
   const c = new Cookie()
-  for (let i = 0; i < Cookie.serializableProperties.length; i++) {
-    const prop = Cookie.serializableProperties[i]
-    // @ts-ignore
+  for (const prop of Cookie.serializableProperties) {
     if (obj[prop] === undefined || obj[prop] === cookieDefaults[prop]) {
       continue // leave as prototype default
     }
@@ -771,7 +769,6 @@ function fromJSON(str: string | SerializedCookie | null | undefined) {
         c[prop] = obj[prop] == 'Infinity' ? 'Infinity' : new Date(obj[prop])
       }
     } else {
-      // @ts-ignore
       c[prop] = obj[prop]
     }
   }
@@ -926,7 +923,6 @@ export class Cookie {
     const obj: SerializedCookie = {}
 
     for (const prop of Cookie.serializableProperties) {
-      // @ts-ignore
       if (this[prop] === cookieDefaults[prop]) {
         continue // leave as prototype default
       }
@@ -957,9 +953,7 @@ export class Cookie {
               : maxAge
         }
       } else {
-        // @ts-ignore
         if (this[prop] !== cookieDefaults[prop]) {
-          // @ts-ignore
           obj[prop] = this[prop]
         }
       }
@@ -983,6 +977,7 @@ export class Cookie {
     ) {
       return false
     }
+    // @ts-ignore
     if (this.maxAge != null && this.maxAge <= 0) {
       return false // "Max-Age=" non-zero-digit *DIGIT
     }
@@ -1105,7 +1100,6 @@ export class Cookie {
       return Infinity
     }
 
-    // @ts-ignore
     if (typeof expires === 'string') {
       expires = parseDate(expires)
     }
@@ -1181,12 +1175,12 @@ export class Cookie {
     strict: 3,
     lax: 2,
     none: 1,
-  }
+  } as const
 
   static sameSiteCanonical = {
     strict: 'Strict',
     lax: 'Lax',
-  }
+  } as const
 
   static serializableProperties = [
     'key',
@@ -1203,7 +1197,7 @@ export class Cookie {
     'creation',
     'lastAccessed',
     'sameSite',
-  ]
+  ] as const
 }
 
 function getNormalizedPrefixSecurity(prefixSecurity: string) {

lib/store.ts

@@ -121,11 +121,15 @@ export class Store {
     throw new Error('removeCookie is not implemented')
   }
 
-  removeCookies(domain: string, path: string): Promise<void>
-  removeCookies(domain: string, path: string, callback: Callback<void>): void
+  removeCookies(domain: string, path: string | null): Promise<void>
+  removeCookies(
+    domain: string,
+    path: string | null,
+    callback: Callback<void>,
+  ): void
   removeCookies(
     _domain: string,
-    _path: string,
+    _path: string | null,
     _callback?: Callback<void>,
   ): unknown {
     throw new Error('removeCookies is not implemented')