tests #8

Author: vlad-ignatov

README.md

@@ -128,6 +128,10 @@ The Bulk Data Client uses `js` configuration files, but you can think of them as
 - *string* **`awsRegion`** - Example: `us-east-1`. Only used if `destination` points to S3. The AWS SDK will first look for this in the shared config file (`~/.aws/config`). Then the SDK will look for an `AWS_REGION` environment variable. Finally, you can override both of these if you set the `awsRegion` variable in your bulk-data client config file. 
 - *string* **`awsAccessKeyId`** - Only used if `destination` points to S3. The AWS SDK will first look for this in the shared credentials file (`~/.aws/credentials`). You can override this if you set the `awsAccessKeyId` variable in your bulk-data client config file, but only if you also set the `awsSecretAccessKey`. 
 - *string* **`awsSecretAccessKey`** - Only needed if `destination` points to S3. The AWS SDK will first look for this in the shared credentials file (`~/.aws/credentials`). You can override this if you set the `awsSecretAccessKey` variable in your bulk-data client config file, but only if you also set the `awsAccessKeyId`.
+- *object* **`log`** - Optional logging options (see below)
+- *boolean* **`log.enabled`** - Set this to false to disable logging. Optional (defaults to true).
+- *string* **`log.file`** - Path to the log file. Absolute, or relative to process CWD. If not provided, the file will be called log.ndjson and will be stored in the downloads folder.
+- *object* **`log.metadata`** - Key/value pairs to be added to every log entry. Can be used to add useful information (for example which site imported this data).
 
 
 ### Environment Variables
@@ -194,5 +198,6 @@ Features
 - [x] Destination directory path
 - [x] Destination http
 - [x] multiple config files
-- [ ] tests
+- [ ] tests (~64% coverage)
 - [x] Custom kick-off params
+- [x] Logging

built/app.js

@@ -12,6 +12,7 @@ const utils_1 = require("./lib/utils");
 const BulkDataClient_1 = __importDefault(require("./lib/BulkDataClient"));
 const cli_1 = __importDefault(require("./reporters/cli"));
 const text_1 = __importDefault(require("./reporters/text"));
+const loggers_1 = require("./loggers");
 const reporters = {
     cli: cli_1.default,
     text: text_1.default
@@ -79,9 +80,93 @@ APP.action(async (args) => {
             return;
         }
     }
-    // console.log(args)
+    options.log = {
+        enabled: true,
+        ...(options.log || {})
+    };
     const client = new BulkDataClient_1.default(options);
     const reporter = reporters[options.reporter](client);
+    if (options.log.enabled) {
+        const logger = (0, loggers_1.createLogger)(options.log);
+        const startTime = Date.now();
+        // kickoff -----------------------------------------------------------------
+        client.on("kickOffEnd", ({ requestParameters, capabilityStatement, response }) => {
+            logger.log("info", {
+                eventId: "kickoff",
+                eventDetail: {
+                    exportUrl: response.requestUrl,
+                    errorCode: response.statusCode >= 400 ? response.statusCode : null,
+                    errorBody: response.statusCode >= 400 ? response.body : null,
+                    softwareName: capabilityStatement.software?.name || null,
+                    softwareVersion: capabilityStatement.software?.version || null,
+                    softwareReleaseDate: capabilityStatement.software?.releaseDate || null,
+                    fhirVersion: capabilityStatement.fhirVersion || null,
+                    requestParameters
+                }
+            });
+        });
+        // status_progress ---------------------------------------------------------
+        client.on("exportProgress", e => {
+            if (!e.virtual) { // skip the artificially triggered 100% event
+                logger.log("info", {
+                    eventId: "status_progress",
+                    eventDetail: {
+                        body: e.body,
+                        xProgress: e.xProgressHeader,
+                        retryAfter: e.retryAfterHeader
+                    }
+                });
+            }
+        });
+        // status_error ------------------------------------------------------------
+        client.on("exportError", eventDetail => {
+            logger.log("error", {
+                eventId: "status_error",
+                eventDetail
+            });
+        });
+        // status_complete ---------------------------------------------------------
+        client.on("exportComplete", manifest => {
+            logger.log("info", {
+                eventId: "status_complete",
+                eventDetail: {
+                    transactionTime: manifest.transactionTime,
+                    outputFileCount: manifest.output.length,
+                    deletedFileCount: manifest.deleted?.length || 0,
+                    errorFileCount: manifest.error.length
+                }
+            });
+        });
+        // download_request --------------------------------------------------------
+        client.on("downloadStart", eventDetail => {
+            logger.log("info", { eventId: "download_request", eventDetail });
+        });
+        // download_complete -------------------------------------------------------
+        client.on("downloadComplete", eventDetail => {
+            logger.log("info", { eventId: "download_complete", eventDetail });
+        });
+        // download_error ----------------------------------------------------------
+        client.on("downloadError", eventDetail => {
+            logger.log("info", { eventId: "download_error", eventDetail });
+        });
+        // export_complete ---------------------------------------------------------
+        client.on("allDownloadsComplete", downloads => {
+            const eventDetail = {
+                files: 0,
+                resources: 0,
+                bytes: 0,
+                attachments: 0,
+                duration: Date.now() - startTime
+            };
+            downloads.forEach(d => {
+                eventDetail.files += 1;
+                eventDetail.resources += d.resources;
+                eventDetail.bytes += d.uncompressedBytes;
+                eventDetail.attachments += d.attachments;
+            });
+            logger.log("info", { eventId: "export_complete", eventDetail });
+        });
+    }
     process.on("SIGINT", () => {
         console.log("\nExport canceled.".magenta.bold);
         reporter.detach();

built/lib/Broadcaster.js

@@ -0,0 +1,9 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const events_1 = __importDefault(require("events"));
+class BroadCaster extends events_1.default {
+}
+exports.default = new BroadCaster();