strip input csv to only need clientName & APIM ID

Author: airatyusuff-nhs

packages/event-builder/README.md

@@ -21,7 +21,6 @@ CLI tool for client configuration using events.
 
 **Note:** All headers in the CSV file must be provided with values:
 
-- `Client ID` - the ID of the client you want to create. This can be generated with an online UUID generator.
 - `Client Name` - the name of the client.
 - `APIM ID` - the APIM Application ID for the client.
 

packages/event-builder/inputs/sample.csv

@@ -1,2 +1,2 @@
-Client ID,Client Name,APIM ID
-test-client-id-1,Test Client,test-apim-id-1
+Client Name,APIM ID
+Test Client,test-apim-id-1

packages/event-builder/src/__tests__/build-client-changed-event.spec.ts

@@ -3,7 +3,6 @@ import { buildEvent } from "../event-builder";
 describe("test clientChangedEvent builder function", () => {
   it("should successfully build a clientChangedEvent", () => {
     const testInput = {
-      clientId: "test-client-id",
       clientName: "Test Client",
       apimId: "test-apim-id",
     };
@@ -14,7 +13,6 @@ describe("test clientChangedEvent builder function", () => {
       "type",
       "uk.nhs.notify.client-config.ClientChanged.v1",
     );
-    expect(event.data.id).toBe("test-client-id");
     expect(event.data.name).toBe("Test Client");
     expect(event.data.apimApplication).toEqual(
       expect.objectContaining({

packages/event-builder/src/__tests__/convert-csv-to-client-input.spec.ts

@@ -4,7 +4,7 @@ import { convertCSV } from "../csv-to-client-input";
 const invalidCases = [
   { type: "invalid headers", relativePath: "test-data/invalid-headers.csv", msg: "CSV headers do not match expected." },
   { type: "empty rows", relativePath: "test-data/empty-rows.csv", msg: "No client data provided." },
-  { type: "missing data in row", relativePath: "test-data/missing-data.csv", msg: "Missing data in row for client ID: client-id-1." }
+  { type: "missing data in row", relativePath: "test-data/missing-data.csv", msg: "Missing data in row for client: Test Client 1." }
 ]
 
 describe("test that csv inputs get parsed as expected", () => {
@@ -17,7 +17,7 @@ describe("test that csv inputs get parsed as expected", () => {
     expect(() => convertCSV(filePath)).not.toThrow();
 
     expect(result).toHaveLength(4);
-    expect(result.map(item => item.clientId)).toEqual((["1","2","3","4"]));
+    expect(result.map(item => item.clientName)).toEqual(["Test Client 1", "Test Client 2", "Test Client 3", "Test Client 4"]);
   });
 
   it.each(invalidCases)('should throw error: "%s" for case: %s:', ({ msg, type, relativePath }) => {

packages/event-builder/src/__tests__/test-data/empty-rows.csv

@@ -1 +1 @@
-Client ID,Client Name,APIM ID
+Client Name,APIM ID

packages/event-builder/src/__tests__/test-data/invalid-headers.csv

@@ -1,2 +1,2 @@
-Invalid ID,Client Name,APIM ID
-client-id-1,Test Client 1,test-apim-id-1
+Invalid Name,APIM ID
+Test Client 1,test-apim-id-1

packages/event-builder/src/__tests__/test-data/missing-data.csv

@@ -1,2 +1,2 @@
-Client ID,Client Name,APIM ID
-client-id-1,Test Client 1,
+Client Name,APIM ID
+Test Client 1,

packages/event-builder/src/__tests__/test-data/valid.csv

@@ -1,5 +1,5 @@
-Client ID,Client Name,APIM ID
-1,Test Client 1,test-apim-id-1
-2,Test Client 2,test-apim-id-2
-3,Test Client 3,test-apim-id-3
-4,Test Client 4,test-apim-id-4
+Client Name,APIM ID
+Test Client 1,test-apim-id-1
+Test Client 2,test-apim-id-2
+Test Client 3,test-apim-id-3
+Test Client 4,test-apim-id-4

packages/event-builder/src/cli/index.ts

@@ -35,7 +35,7 @@ async function main() {
     .option('format', {
       type: 'string',
       choices: ['json', 'table'],
-      default: 'json',
+      default: 'table',
       global: true,
       demandOption: false,
     })
@@ -62,7 +62,13 @@ async function main() {
 
           sendSQSBatchMessages(results)
           .then(() => {
-            print("Event(s) successfully sent to queue");
+            const outputs = results.map(r => ({
+              "Client": r.data.name,
+              "ID": r.data.id
+            }));
+
+            console.log("Event(s) successfully sent to queue");
+            print(outputs);
           })
 
         } catch (err) {

packages/event-builder/src/csv-to-client-input.ts

@@ -3,13 +3,11 @@ import { parse } from "csv-parse/sync";
 import { ClientInput } from './input'
 
 type csvRow = {
-  'Client ID': string;
   'Client Name': string;
   'APIM ID': string;
 };
 
 const csvHeaders = [
-  "Client ID",
   "Client Name",
   "APIM ID"
 ]
@@ -35,11 +33,10 @@ const generateInputs = (input: string): ClientInput[] => {
 
   fileData.forEach((row: csvRow) => {
     if(!validateRow(row)) {
-      throw new Error(`Missing data in row for client ID: ${row["Client ID"]}.`)
+      throw new Error(`Missing data in row for client: ${row["Client Name"]}.`)
     }
 
     clients.push({
-      clientId: row["Client ID"],
       clientName: row["Client Name"],
       apimId: row["APIM ID"]
     });