Bump Node.js environment to 18.x

- Bump Node.js to version 18. This change is necessary as Node.js v16
  will reach end-of-life on 2023-09-11. It also ensure compatibility
  with dependencies requiring minimum of Node.js v18, such as `vite`,
  `@vitejs`plugin-legacy` and `icon-gen`.
- Bump `setup-node` action to v4.
- Recommend using the `nvm` tool for managing Node.js versions in the
  documentation.
- Update documentation to point to code reference for required Node.js
  version. This removes duplication of information, and keeps the code
  as single source of truth for required Node.js version.
- Refactor code to adopt the `node:` protocol for Node API imports as
  per Node.js 18 standards. This change addresses ambiguities and aligns
  with Node.js best practices (nodejs/node#38343). Currently, there is
  no ESLint rule to enforce this protocol, as noted in
  import-js/eslint-plugin-import#2717.
- Replace `cross-fetch` dependency with the native Node.js fetch API
  introduced in Node.js 18. Adjust type casting for async iterable read
  streams to align with the latest Node.js APIs, based on discussions in
  DefinitelyTyped/DefinitelyTyped#65542.
This commit is contained in:
undergroundwires
2023-12-28 11:57:38 +01:00
parent fc9dd234e9
commit 2f06043559
28 changed files with 60 additions and 148 deletions

View File

@@ -4,7 +4,7 @@
*/
/// <reference types="electron-vite/node" />
import { join } from 'path';
import { join } from 'node:path';
import appIcon from '@/presentation/public/icon.png?asset';
export const APP_ICON_PATH = appIcon;

View File

@@ -1,14 +1,12 @@
import { existsSync, createWriteStream } from 'fs';
import { unlink, mkdir } from 'fs/promises';
import path from 'path';
import { existsSync, createWriteStream, type WriteStream } from 'node:fs';
import { unlink, mkdir } from 'node:fs/promises';
import path from 'node:path';
import { app } from 'electron';
import { UpdateInfo } from 'electron-updater';
import fetch from 'cross-fetch';
import { ElectronLogger } from '@/infrastructure/Log/ElectronLogger';
import { UpdateProgressBar } from '../UpdateProgressBar';
import { retryFileSystemAccess } from './RetryFileSystemAccess';
import type { WriteStream } from 'fs';
import type { Readable } from 'stream';
import type { ReadableStream } from 'node:stream/web';
const MAX_PROGRESS_LOG_ENTRIES = 10;
const UNKNOWN_SIZE_LOG_INTERVAL_BYTES = 10 * 1024 * 1024; // 10 MB
@@ -128,13 +126,13 @@ function getContentLengthFromResponse(response: Response): ResponseContentLength
async function withReadableStream(
response: Response,
handler: (readStream: Readable) => Promise<void>,
handler: (readStream: ReadableStream) => Promise<void>,
) {
const reader = createReader(response);
try {
await handler(reader);
} finally {
reader.destroy();
reader.cancel();
}
}
@@ -152,7 +150,7 @@ async function withWriteStream(
async function streamWithProgress(
contentLength: ResponseContentLength,
readStream: Readable,
readStream: ReadableStream,
writeStream: WriteStream,
progressHandler: ProgressCallback,
): Promise<void> {
@@ -212,12 +210,13 @@ function shouldLogProgress(
return { shouldLog: false, nextLogThreshold: previousLogThreshold };
}
function createReader(response: Response): Readable {
function createReader(response: Response): ReadableStream {
if (!response.body) {
throw new Error('Response body is empty, cannot proceed with download.');
}
// On browser, we could use browser API response.body.getReader()
// But here, we use cross-fetch that gets node-fetch on a node application
// This API is node-fetch specific, see https://github.com/node-fetch/node-fetch#streams
return response.body as unknown as Readable;
// TypeScript has removed the async iterator type definition for ReadableStream due to
// limited browser support. Node.js, however, supports async iterable streams, allowing
// type casting to function properly in this context.
// https://github.com/DefinitelyTyped/DefinitelyTyped/discussions/65542#discussioncomment-6071004
return response.body as ReadableStream;
}

View File

@@ -1,5 +1,5 @@
import { createHash } from 'crypto';
import { createReadStream } from 'fs';
import { createHash } from 'node:crypto';
import { createReadStream } from 'node:fs';
import { ElectronLogger } from '@/infrastructure/Log/ElectronLogger';
import { retryFileSystemAccess } from './RetryFileSystemAccess';