Updated doc and node:fs on csv files

Author: nhsd-angel-pastor

scripts/nft-event-generator/README.md

@@ -7,6 +7,11 @@ It supports two event types, each invoked as a subcommand:
 - **`supplier-api-letter-event`** – generates `SupplierApiLetterEvent` events (mirrors the `LetterEvent` consumed by `print-status-handler`)
 - **`paper-letter-opt-out-event`** – generates `PaperLetterOptedOut` channel status events, reading input from a CSV file
 
+To execute the commands you need to:
+
+- Be located in the scripts/nft-event-generator directory
+- Have an active `aws sso login` in the account you want (e.g. `NHS Notify Suppliers Nonprod`)
+
 ## Common features
 
 - Custom environments (e.g. `pr293`, `main`, `nft`)
@@ -88,13 +93,13 @@ The `messageReference` field in each generated event is built as `<senderId>_<me
 Send opt-out events from a CSV file to the `nft` environment:
 
 ```shell
-npm start -- paper-letter-opt-out-event --environment nft --csvFile ./opt-outs.csv
+npm start -- paper-letter-opt-out-event --environment nft --csvFile /home/notify/git/nhs-notify-digital-letters/scripts/nft-event-generator/opt-outs.csv
 ```
 
 Send to a PR environment with a custom batch interval:
 
 ```shell
-npm start -- paper-letter-opt-out-event --environment pr293 --csvFile ./opt-outs.csv --interval 500
+npm start -- paper-letter-opt-out-event --environment pr293 --csvFile /home/notify/git/nhs-notify-digital-letters/scripts/nft-event-generator/opt-outs.csv --interval 500
 ```
 
 ---

scripts/nft-event-generator/src/__tests__/utils/csv-reader.test.ts

@@ -4,6 +4,12 @@ import { readCsvFile } from 'utils/csv-reader';
 const SAMPLE_CSV = path.join(__dirname, '../fixtures', 'sample-opt-outs.csv');
 
 describe('readCsvFile', () => {
+  it('should throw for a non-csv path', () => {
+    expect(() => readCsvFile('/etc/passwd')).toThrow(
+      'Invalid file path: must be a .csv file',
+    );
+  });
+
   it('should parse a CSV file into CsvRow objects', () => {
     const rows = readCsvFile(SAMPLE_CSV);
 

scripts/nft-event-generator/src/utils/csv-reader.ts

@@ -1,13 +1,21 @@
 import { parse } from 'csv-parse/sync';
 import { readFileSync } from 'node:fs';
+import path from 'node:path';
 
 export type PaperLetterOptOutRow = {
   messageReference: string;
   senderId: string;
 };
 
 export function readCsvFile(filePath: string): PaperLetterOptOutRow[] {
-  const fileContent = readFileSync(filePath, 'utf8');
+  const resolvedPath = path.resolve(filePath);
+
+  if (!resolvedPath.endsWith('.csv')) {
+    throw new Error(`Invalid file path: must be a .csv file`);
+  }
+
+  // eslint-disable-next-line security/detect-non-literal-fs-filename -- path is validated above
+  const fileContent = readFileSync(resolvedPath, 'utf8');
 
   return parse(fileContent, {
     columns: ['messageReference', 'senderId'],

scripts/package.json

@@ -24,7 +24,6 @@
     "lint": "eslint nft-event-generator/",
     "lint:fix": "eslint nft-event-generator/ --fix",
     "start": "tsx nft-event-generator/src/cli.ts",
-    "start:nft": "npm start -- supplier-api-letter-event --environment nft --numberOfEvents 2 --interval 2000",
     "test:unit": "jest",
     "typecheck": "tsc --noEmit"
   },