@travetto/web 7.0.0-rc.2 → 7.0.0-rc.3

package/src/util/header.ts

@@ -19,8 +19,8 @@ export class WebHeaderUtil {
    * Parse cookie header
    */
   static parseCookieHeader(header: string): Cookie[] {
-    const val = header.trim();
-    return !val ? [] : val.split(SPLIT_SEMI).map(item => {
+    const text = header.trim();
+    return !text ? [] : text.split(SPLIT_SEMI).map(item => {
       const [name, value] = item.split(SPLIT_EQ);
       return { name, value };
     });
@@ -32,17 +32,17 @@ export class WebHeaderUtil {
   static parseSetCookieHeader(header: string): Cookie {
     const parts = header.split(SPLIT_SEMI);
     const [name, value] = parts[0].split(SPLIT_EQ);
-    const c: Cookie = { name, value };
-    for (const p of parts.slice(1)) {
-      const [k, pv = ''] = p.toLowerCase().split(SPLIT_EQ);
-      const v = pv.charCodeAt(0) === QUOTE ? pv.slice(1, -1) : pv;
-      if (k === 'expires') {
-        c[k] = new Date(v);
+    const result: Cookie = { name, value };
+    for (const part of parts.slice(1)) {
+      const [key, partValue = ''] = part.toLowerCase().split(SPLIT_EQ);
+      const cleanedValue = partValue.charCodeAt(0) === QUOTE ? partValue.slice(1, -1) : partValue;
+      if (key === 'expires') {
+        result[key] = new Date(cleanedValue);
       } else {
-        c[castKey(k)] = castTo(v || true);
+        result[castKey(key)] = castTo(cleanedValue || true);
       }
     }
-    return c;
+    return result;
   }
 
   /**
@@ -53,20 +53,20 @@ export class WebHeaderUtil {
     if (!input) {
       return { value: '', parameters: {} };
     }
-    const [rv, ...parts] = input.split(SPLIT_SEMI);
+    const [rawValue, ...parts] = input.split(SPLIT_SEMI);
     const item: WebParsedHeader = { value: '', parameters: {} };
-    const value = rv.charCodeAt(0) === QUOTE ? rv.slice(1, -1) : rv;
+    const value = rawValue.charCodeAt(0) === QUOTE ? rawValue.slice(1, -1) : rawValue;
     if (value.includes('=')) {
       parts.unshift(value);
     } else {
       item.value = value;
     }
     for (const part of parts) {
-      const [k, pv = ''] = part.split(SPLIT_EQ);
-      const v = (pv.charCodeAt(0) === QUOTE) ? pv.slice(1, -1) : pv;
-      item.parameters[k] = v;
-      if (k === 'q') {
-        item.q = parseFloat(v);
+      const [key, partValue = ''] = part.split(SPLIT_EQ);
+      const cleanedValue = (partValue.charCodeAt(0) === QUOTE) ? partValue.slice(1, -1) : partValue;
+      item.parameters[key] = cleanedValue;
+      if (key === 'q') {
+        item.q = parseFloat(cleanedValue);
       }
     }
     return item;
@@ -76,24 +76,24 @@ export class WebHeaderUtil {
    * Parse full header
    */
   static parseHeader(input: string): WebParsedHeader[] {
-    const v = input.trim();
+    const value = input.trim();
     if (!input) { return []; }
-    return v.split(SPLIT_COMMA).map(x => this.parseHeaderSegment(x));
+    return value.split(SPLIT_COMMA).map(part => this.parseHeaderSegment(part));
   }
 
   /**
    * Build cookie suffix
    */
-  static buildCookieSuffix(c: Cookie): string[] {
+  static buildCookieSuffix(cookie: Cookie): string[] {
     const parts = [];
-    if (c.path) { parts.push(`path=${c.path}`); }
-    if (c.expires) { parts.push(`expires=${c.expires.toUTCString()}`); }
-    if (c.domain) { parts.push(`domain=${c.domain}`); }
-    if (c.priority) { parts.push(`priority=${c.priority.toLowerCase()}`); }
-    if (c.sameSite) { parts.push(`samesite=${c.sameSite.toLowerCase()}`); }
-    if (c.secure) { parts.push('secure'); }
-    if (c.httponly) { parts.push('httponly'); }
-    if (c.partitioned) { parts.push('partitioned'); }
+    if (cookie.path) { parts.push(`path=${cookie.path}`); }
+    if (cookie.expires) { parts.push(`expires=${cookie.expires.toUTCString()}`); }
+    if (cookie.domain) { parts.push(`domain=${cookie.domain}`); }
+    if (cookie.priority) { parts.push(`priority=${cookie.priority.toLowerCase()}`); }
+    if (cookie.sameSite) { parts.push(`samesite=${cookie.sameSite.toLowerCase()}`); }
+    if (cookie.secure) { parts.push('secure'); }
+    if (cookie.httponly) { parts.push('httponly'); }
+    if (cookie.partitioned) { parts.push('partitioned'); }
     return parts;
   }
 
@@ -104,7 +104,10 @@ export class WebHeaderUtil {
     if (header === '*' || header === '*/*') {
       return values[0];
     }
-    const sorted = this.parseHeader(header.toLowerCase()).filter(x => (x.q ?? 1) > 0).toSorted((a, b) => (b.q ?? 1) - (a.q ?? 1));
+    const sorted = this.parseHeader(header.toLowerCase())
+      .filter(item => (item.q ?? 1) > 0)
+      .toSorted((a, b) => (b.q ?? 1) - (a.q ?? 1));
+
     const set = new Set(values);
     for (const { value } of sorted) {
       const vk: K = castKey(value);
@@ -127,7 +130,7 @@ export class WebHeaderUtil {
     const { parameters } = this.parseHeaderSegment(headers.get('Range'));
     if ('bytes' in parameters) {
       const [start, end] = parameters.bytes.split('-')
-        .map(x => x ? parseInt(x, 10) : undefined);
+        .map(value => value ? parseInt(value, 10) : undefined);
       if (start !== undefined) {
         return { start, end: end ?? (start + chunkSize) };
       }
@@ -137,20 +140,20 @@ export class WebHeaderUtil {
   /**
    * Check freshness of the response using request and response headers.
    */
-  static isFresh(req: WebHeaders, res: WebHeaders): boolean {
-    const cacheControl = req.get('Cache-Control');
+  static isFresh(request: WebHeaders, response: WebHeaders): boolean {
+    const cacheControl = request.get('Cache-Control');
     if (cacheControl?.includes('no-cache')) {
       return false;
     }
 
-    const noneMatch = req.get('If-None-Match');
+    const noneMatch = request.get('If-None-Match');
     if (noneMatch) {
-      const etag = res.get('ETag');
-      const validTag = (v: string): boolean => v === etag || v === `W/${etag}` || `W/${v}` === etag;
+      const etag = response.get('ETag');
+      const validTag = (value: string): boolean => value === etag || value === `W/${etag}` || `W/${value}` === etag;
       return noneMatch === '*' || (!!etag && noneMatch.split(SPLIT_COMMA).some(validTag));
     } else {
-      const modifiedSince = req.get('If-Modified-Since');
-      const lastModified = res.get('Last-Modified');
+      const modifiedSince = request.get('If-Modified-Since');
+      const lastModified = response.get('Last-Modified');
       if (!modifiedSince || !lastModified) {
         return false;
       }

package/src/util/keygrip.ts

@@ -30,7 +30,7 @@ export class KeyGrip {
       .createHmac(this.#algorithm, key ?? this.#keys[0])
       .update(data)
       .digest(this.#encoding)
-      .replace(/[/+=]/g, x => CHAR_MAPPING[castKey(x)]);
+      .replace(/[/+=]/g, ch => CHAR_MAPPING[castKey(ch)]);
   }
 
   verify(data: string, digest: string): boolean {

package/src/util/net.ts

@@ -8,25 +8,25 @@ import { ExecUtil } from '@travetto/runtime';
 export class NetUtil {
 
   /** Is an error an address in use error */
-  static isPortUsedError(err: unknown): err is Error & { port: number } {
-    return !!err && err instanceof Error && err.message.includes('EADDRINUSE');
+  static isPortUsedError(error: unknown): error is Error & { port: number } {
+    return !!error && error instanceof Error && error.message.includes('EADDRINUSE');
   }
 
   /** Get the port process id */
   static async getPortProcessId(port: number): Promise<number | undefined> {
-    const proc = spawn('lsof', ['-t', '-i', `tcp:${port}`]);
-    const result = await ExecUtil.getResult(proc, { catch: true });
-    const [pid] = result.stdout.trim().split(/\n/g);
-    if (pid && +pid > 0) {
-      return +pid;
+    const subProcess = spawn('lsof', ['-t', '-i', `tcp:${port}`]);
+    const result = await ExecUtil.getResult(subProcess, { catch: true });
+    const [processId] = result.stdout.trim().split(/\n/g);
+    if (processId && +processId > 0) {
+      return +processId;
     }
   }
 
   /** Free port if in use */
   static async freePort(port: number): Promise<void> {
-    const pid = await this.getPortProcessId(port);
-    if (pid) {
-      process.kill(pid);
+    const processId = await this.getPortProcessId(port);
+    if (processId) {
+      process.kill(processId);
     }
   }
 
@@ -54,19 +54,19 @@ export class NetUtil {
    */
   static getLocalAddress(): string {
     const useIPv4 = !![...Object.values(os.networkInterfaces())]
-      .find(interfaces => interfaces?.find(nic => nic.family === 'IPv4'));
+      .find(interfaces => interfaces?.find(item => item.family === 'IPv4'));
 
     return useIPv4 ? '0.0.0.0' : '::';
   }
 
   /**
    * Free a port if it is in use, typically used to resolve port conflicts.
-   * @param err The error that may indicate a port conflict
+   * @param error The error that may indicate a port conflict
    * @returns Returns true if the port was freed, false if not handled
    */
-  static async freePortOnConflict(err: unknown): Promise<boolean> {
-    if (NetUtil.isPortUsedError(err) && typeof err.port === 'number') {
-      await NetUtil.freePort(err.port);
+  static async freePortOnConflict(error: unknown): Promise<boolean> {
+    if (NetUtil.isPortUsedError(error) && typeof error.port === 'number') {
+      await NetUtil.freePort(error.port);
       return true;
     } else {
       return false;

package/support/test/suite/base.ts

@@ -2,7 +2,7 @@ import { Registry } from '@travetto/registry';
 import { castTo, Class } from '@travetto/runtime';
 import { AfterAll, BeforeAll } from '@travetto/test';
 import { DependencyRegistryIndex, Injectable } from '@travetto/di';
-import { ConfigSource, ConfigSpec } from '@travetto/config';
+import { ConfigSource, ConfigPayload } from '@travetto/config';
 import { Schema } from '@travetto/schema';
 
 import { WebDispatcher } from '../../../src/types/dispatch.ts';
@@ -12,7 +12,7 @@ import { WebMessageInit } from '../../../src/types/message.ts';
 
 @Injectable()
 export class WebTestConfig implements ConfigSource {
-  async get(): Promise<ConfigSpec> {
+  async get(): Promise<ConfigPayload> {
     return {
       data: {
         web: {