@eyeseetea/d2-logger 1.2.0-beta.1 → 1.2.0-beta.3

package/README.md

@@ -13,16 +13,23 @@ There are three types of logger output:
     Therefore, the following configuration will be passed to the logger:
 
     ```typescript
-    import { initLogger, ProgramLogger } from "@eyeseetea/d2-logger";
+    import { initLogger, ProgramLogger, LoggerD2ApiOptions } from "@eyeseetea/d2-logger";
 
-    const logger: ProgramLogger = await initLogger({
-        type: "program",
-        debug: true,
+    const d2ApiOptions: LoggerD2ApiOptions = {
         baseUrl: "https://play.dhis2.org/40.2.2",
         auth: {
             username: "admin",
             password: "district",
         },
+        // backend?: "xhr" | "fetch"
+        // apiVersion?: number
+        // timeout?: number
+    };
+
+    const logger: ProgramLogger = await initLogger({
+        type: "program",
+        debug: true,
+        d2ApiOptions: d2ApiOptions,
         organisationUnitId: "", // Organisation unit Id where the program is registered
         programId: "", // Event program Id where register the logs as events
         dataElements: {
@@ -34,6 +41,7 @@ There are three types of logger output:
 
     Notice:
 
+    - `d2ApiOptions` corresponds to the `D2ApiOptions` type exported by `@eyeseetea/d2-logger`.
     - Please note that `auth` is not mandatory if it's used in the DHIS2 app instead of in a script.
     - If `debug` is `true`, then in addition to registering the logs in the DHIS2 program, they will also be displayed on the console.
 
@@ -93,21 +101,28 @@ There are three types of logger output:
 
 3. Using a DHIS2 tracker program to register the logs as events:
 
-    You will need to have and existing tracker program in DHIS2. In order to be able to log the log type (Error", "Warn", "Success", "Info" and "Debug") in the event, it would be necessary to create a data element and assign it to the program stages, and then add this data element id to the configuration.
+    You will need to have and existing tracker program in DHIS2. In order to be able to log the log type (Error", "Warn", "Success", "Info" and "Debug") in the event, it would be necessary to create a data element and assign it to the repeatable program stages, and then add this data element id to the configuration.
 
     Therefore, the following configuration will be passed to the logger:
 
     ```typescript
-    import { initLogger, TrackerProgramLogger } from "@eyeseetea/d2-logger";
+    import { initLogger, TrackerProgramLogger, LoggerD2ApiOptions } from "@eyeseetea/d2-logger";
 
-    const logger: TrackerProgramLogger = await initLogger({
-        type: "trackerProgram",
-        debug: true,
+    const d2ApiOptions: LoggerD2ApiOptions = {
         baseUrl: "https://play.dhis2.org/40.2.2",
         auth: {
             username: "admin",
             password: "district",
         },
+        // backend?: "xhr" | "fetch"
+        // apiVersion?: number
+        // timeout?: number
+    };
+
+    const logger: TrackerProgramLogger = await initLogger({
+        type: "trackerProgram",
+        debug: true,
+        d2ApiOptions: d2ApiOptions,
         trackerProgramId: "", // Tracker program Id where register the logs as events
         messageTypeId: "", // Id of the data element which is the types of log
     });

package/data/repositories/ProgramD2Repository.js

@@ -8,8 +8,8 @@ var ProgramD2Repository = /** @class */ (function () {
     function ProgramD2Repository() {
     }
     ProgramD2Repository.prototype.checkConfig = function (config) {
-        var baseUrl = config.baseUrl, auth = config.auth, programId = config.programId, dataElements = config.dataElements;
-        var d2Api = new d2_api_1.D2Api({ baseUrl: baseUrl, auth: auth });
+        var d2ApiOptions = config.d2ApiOptions, programId = config.programId, dataElements = config.dataElements;
+        var d2Api = new d2_api_1.D2Api(d2ApiOptions);
         return this.checkProgramIsOk(d2Api, programId, dataElements).flatMap(function (programIsOk) {
             if (programIsOk) {
                 return Future_1.Future.success(programIsOk);

package/data/repositories/ProgramLoggerD2Repository.js

@@ -51,13 +51,14 @@ exports.ProgramLoggerD2Repository = void 0;
 var d2_api_1 = require("../../types/d2-api");
 var api_futures_1 = require("../api-futures");
 var Future_1 = require("../../domain/entities/generic/Future");
+var getErrorMessage_1 = require("../../loggers/utils/getErrorMessage");
 var IMPORT_STRATEGY_CREATE = "CREATE";
 var TRACKER_IMPORT_JOB = "TRACKER_IMPORT_JOB";
 var EVENT_PROGRAM_STATUS = "COMPLETED";
 var ProgramLoggerD2Repository = /** @class */ (function () {
     function ProgramLoggerD2Repository(config, d2ProgramStage) {
-        var baseUrl = config.baseUrl, auth = config.auth, programId = config.programId, dataElements = config.dataElements, organisationUnitId = config.organisationUnitId;
-        this.api = new d2_api_1.D2Api({ baseUrl: baseUrl, auth: auth });
+        var d2ApiOptions = config.d2ApiOptions, programId = config.programId, dataElements = config.dataElements, organisationUnitId = config.organisationUnitId;
+        this.api = new d2_api_1.D2Api(d2ApiOptions);
         this.programId = programId;
         this.messageId = dataElements.messageId;
         this.messageTypeId = dataElements.messageTypeId;
@@ -70,8 +71,12 @@ var ProgramLoggerD2Repository = /** @class */ (function () {
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        api = new d2_api_1.D2Api({ baseUrl: config.baseUrl, auth: config.auth });
-                        return [4 /*yield*/, ProgramLoggerD2Repository.getProgramStage(api, config.programId).toPromise()];
+                        api = new d2_api_1.D2Api(config.d2ApiOptions);
+                        return [4 /*yield*/, ProgramLoggerD2Repository.getProgramStage(api, config.programId)
+                                .toPromise()
+                                .catch(function (error) {
+                                throw new Error("Error fetching program stage of program with id ".concat(config.programId, ": ").concat((0, getErrorMessage_1.getErrorMessage)(error)));
+                            })];
                     case 1:
                         d2ProgramStage = _a.sent();
                         return [2 /*return*/, new ProgramLoggerD2Repository(config, d2ProgramStage)];

package/data/repositories/TrackerProgramD2Repository.js

@@ -8,8 +8,8 @@ var TrackerProgramD2Repository = /** @class */ (function () {
     function TrackerProgramD2Repository() {
     }
     TrackerProgramD2Repository.prototype.checkConfig = function (config) {
-        var baseUrl = config.baseUrl, auth = config.auth, trackerProgramId = config.trackerProgramId;
-        var d2Api = new d2_api_1.D2Api({ baseUrl: baseUrl, auth: auth });
+        var d2ApiOptions = config.d2ApiOptions, trackerProgramId = config.trackerProgramId;
+        var d2Api = new d2_api_1.D2Api(d2ApiOptions);
         return (0, api_futures_1.apiToFuture)(d2Api.models.programs.get({
             fields: trackerProgramFields,
             filter: { id: { eq: trackerProgramId } },

package/data/repositories/TrackerProgramLoggerD2Repository.js

@@ -30,8 +30,8 @@ var TRACKER_EVENT_DEFAULT_STATUS = "ACTIVE";
 var TRACKER_ORG_UNIT_ALL_MODE = "ALL";
 var TrackerProgramLoggerD2Repository = /** @class */ (function () {
     function TrackerProgramLoggerD2Repository(config) {
-        var baseUrl = config.baseUrl, auth = config.auth, trackerProgramId = config.trackerProgramId, messageTypeId = config.messageTypeId;
-        this.api = new d2_api_1.D2Api({ baseUrl: baseUrl, auth: auth });
+        var d2ApiOptions = config.d2ApiOptions, trackerProgramId = config.trackerProgramId, messageTypeId = config.messageTypeId;
+        this.api = new d2_api_1.D2Api(d2ApiOptions);
         this.trackerProgramId = trackerProgramId;
         this.messageTypeId = messageTypeId;
     }
@@ -76,10 +76,7 @@ var TrackerProgramLoggerD2Repository = /** @class */ (function () {
             enrollment: enrollmentId,
         })).flatMap(function (response) {
             var _a;
-            // Temporal fix while we wait for PR#156 to be merged in d2-api
-            // https://github.com/EyeSeeTea/d2-api/pull/156
-            var newResponse = response;
-            var instances = newResponse.instances || newResponse.enrollments;
+            var instances = response.instances;
             var orgUnitId = (_a = instances[0]) === null || _a === void 0 ? void 0 : _a.orgUnit;
             if (orgUnitId) {
                 return Future_1.Future.success(orgUnitId);

package/domain/entities/LoggerConfig.d.ts

@@ -1,3 +1,4 @@
+import { D2ApiOptions } from "../../types/d2-api";
 import { Maybe } from "../../utils/ts-utils";
 import { Id } from "./Base";
 interface LoggerConfigBase {
@@ -9,24 +10,18 @@ export interface ConsoleLoggerConfig extends LoggerConfigBase {
 }
 export interface ProgramLoggerConfig extends LoggerConfigBase {
     type: "program";
-    baseUrl: string;
-    auth: Maybe<Auth>;
+    d2ApiOptions: D2ApiOptions;
     programId: Id;
     dataElements: DataElements;
     organisationUnitId: Id;
 }
-type Auth = {
-    username: string;
-    password: string;
-};
 export type DataElements = {
     messageId: Id;
     messageTypeId: Id;
 };
 export interface TrackerProgramLoggerConfig extends LoggerConfigBase {
     type: "trackerProgram";
-    baseUrl: string;
-    auth: Maybe<Auth>;
+    d2ApiOptions: D2ApiOptions;
     trackerProgramId: Id;
     messageTypeId: Maybe<Id>;
 }

package/index.d.ts

@@ -32,4 +32,6 @@ type LoggerType = {
     console: ConsoleLogger;
 };
 declare function initLogger<Config extends LoggerConfig>(config: Config): Promise<LoggerType[Config["type"]]>;
-export { ConsoleLogger, ProgramLogger, TrackerProgramLogger, initLogger, BatchLogContent };
+export type { D2ApiOptions as LoggerD2ApiOptions } from "./types/d2-api";
+export type { BatchLogContent };
+export { ConsoleLogger, ProgramLogger, TrackerProgramLogger, initLogger };

package/loggers/ConsoleLogger.js

@@ -41,6 +41,7 @@ var LogMessageUseCase_1 = require("../domain/usecases/LogMessageUseCase");
 var ConsoleLoggerRepository_1 = require("../data/repositories/ConsoleLoggerRepository");
 var BatchLogMessageUseCase_1 = require("../domain/usecases/BatchLogMessageUseCase");
 var mapContentToLog_1 = require("./utils/mapContentToLog");
+var logErrorInConsole_1 = require("./utils/logErrorInConsole");
 // TODO: homogenize the use of Promises or Futures
 var ConsoleLogger = /** @class */ (function () {
     function ConsoleLogger(loggerRepository) {
@@ -72,12 +73,20 @@ var ConsoleLogger = /** @class */ (function () {
     };
     ConsoleLogger.prototype.batchLog = function (content) {
         var logs = content.map(function (content) { return (0, mapContentToLog_1.mapContentToLog)(content.content, content.messageType); });
-        return new BatchLogMessageUseCase_1.BatchLogMessageUseCase(this.loggerRepository).execute(logs).toPromise();
+        return new BatchLogMessageUseCase_1.BatchLogMessageUseCase(this.loggerRepository)
+            .execute(logs)
+            .toPromise()
+            .catch(function (error) {
+            (0, logErrorInConsole_1.logErrorInConsole)(error, "Error while processing batch logs");
+        });
     };
     ConsoleLogger.prototype.log = function (content, messageType) {
         return new LogMessageUseCase_1.LogMessageUseCase(this.loggerRepository)
             .execute({ message: content, messageType: messageType })
-            .toPromise();
+            .toPromise()
+            .catch(function (error) {
+            (0, logErrorInConsole_1.logErrorInConsole)(error, "Error while logging message");
+        });
     };
     return ConsoleLogger;
 }());

package/loggers/ProgramLogger.js

@@ -43,6 +43,8 @@ var ProgramD2Repository_1 = require("../data/repositories/ProgramD2Repository");
 var ProgramLoggerD2Repository_1 = require("../data/repositories/ProgramLoggerD2Repository");
 var BatchLogMessageUseCase_1 = require("../domain/usecases/BatchLogMessageUseCase");
 var mapContentToLog_1 = require("./utils/mapContentToLog");
+var logErrorInConsole_1 = require("./utils/logErrorInConsole");
+var getErrorMessage_1 = require("./utils/getErrorMessage");
 // TODO: homogenize the use of Promises or Futures
 var ProgramLogger = /** @class */ (function () {
     function ProgramLogger(loggerRepository, isDebug) {
@@ -56,7 +58,10 @@ var ProgramLogger = /** @class */ (function () {
                 switch (_a.label) {
                     case 0: return [4 /*yield*/, new CheckConfigProgramLoggerUseCase_1.CheckConfigProgramLoggerUseCase(new ProgramD2Repository_1.ProgramD2Repository())
                             .execute(config)
-                            .toPromise()];
+                            .toPromise()
+                            .catch(function (error) {
+                            throw new Error("Error checking program configuration for program with id ".concat(config.programId, ": ").concat((0, getErrorMessage_1.getErrorMessage)(error)));
+                        })];
                     case 1:
                         isConfigOk = _a.sent();
                         if (!isConfigOk) return [3 /*break*/, 3];
@@ -87,12 +92,22 @@ var ProgramLogger = /** @class */ (function () {
     ProgramLogger.prototype.batchLog = function (content) {
         var options = { isDebug: this.isDebug };
         var logs = content.map(function (content) { return (0, mapContentToLog_1.mapContentToLog)(content.content, content.messageType); });
-        return new BatchLogMessageUseCase_1.BatchLogMessageUseCase(this.loggerRepository).execute(logs, options).toPromise();
+        return new BatchLogMessageUseCase_1.BatchLogMessageUseCase(this.loggerRepository)
+            .execute(logs, options)
+            .toPromise()
+            .catch(function (error) {
+            (0, logErrorInConsole_1.logErrorInConsole)(error, "Error while processing batch logs");
+        });
     };
     ProgramLogger.prototype.log = function (content, messageType) {
         var options = { isDebug: this.isDebug };
         var log = (0, mapContentToLog_1.mapContentToLog)(content, messageType);
-        return new LogMessageUseCase_1.LogMessageUseCase(this.loggerRepository).execute(log, options).toPromise();
+        return new LogMessageUseCase_1.LogMessageUseCase(this.loggerRepository)
+            .execute(log, options)
+            .toPromise()
+            .catch(function (error) {
+            (0, logErrorInConsole_1.logErrorInConsole)(error, "Error while logging message");
+        });
     };
     return ProgramLogger;
 }());

package/loggers/TrackerProgramLogger.js

@@ -41,6 +41,8 @@ var CheckConfigProgramLoggerUseCase_1 = require("../domain/usecases/CheckConfigP
 var LogMessageUseCase_1 = require("../domain/usecases/LogMessageUseCase");
 var TrackerProgramD2Repository_1 = require("../data/repositories/TrackerProgramD2Repository");
 var TrackerProgramLoggerD2Repository_1 = require("../data/repositories/TrackerProgramLoggerD2Repository");
+var logErrorInConsole_1 = require("./utils/logErrorInConsole");
+var getErrorMessage_1 = require("./utils/getErrorMessage");
 // TODO: homogenize the use of Promises or Futures
 var TrackerProgramLogger = /** @class */ (function () {
     function TrackerProgramLogger(loggerRepository, isDebug) {
@@ -54,7 +56,10 @@ var TrackerProgramLogger = /** @class */ (function () {
                 switch (_a.label) {
                     case 0: return [4 /*yield*/, new CheckConfigProgramLoggerUseCase_1.CheckConfigProgramLoggerUseCase(new TrackerProgramD2Repository_1.TrackerProgramD2Repository())
                             .execute(config)
-                            .toPromise()];
+                            .toPromise()
+                            .catch(function (error) {
+                            throw new Error("Error checking program configuration for program with id ".concat(config.trackerProgramId, ": ").concat((0, getErrorMessage_1.getErrorMessage)(error)));
+                        })];
                     case 1:
                         isConfigOk = _a.sent();
                         if (isConfigOk) {
@@ -91,7 +96,12 @@ var TrackerProgramLogger = /** @class */ (function () {
     TrackerProgramLogger.prototype.log = function (content, messageType) {
         var options = { isDebug: this.isDebug };
         var log = this.mapContentToLog(content, messageType);
-        return new LogMessageUseCase_1.LogMessageUseCase(this.loggerRepository).execute(log, options).toPromise();
+        return new LogMessageUseCase_1.LogMessageUseCase(this.loggerRepository)
+            .execute(log, options)
+            .toPromise()
+            .catch(function (error) {
+            (0, logErrorInConsole_1.logErrorInConsole)(error, "Error while logging message");
+        });
     };
     TrackerProgramLogger.prototype.mapContentToLog = function (content, messageType) {
         var config = content.config, messages = content.messages;

package/loggers/utils/getErrorMessage.d.ts

@@ -0,0 +1 @@
+export declare function getErrorMessage(error: unknown): string;

package/loggers/utils/getErrorMessage.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getErrorMessage = void 0;
+function getErrorMessage(error) {
+    return error instanceof Error ? error.message : String(error);
+}
+exports.getErrorMessage = getErrorMessage;

package/loggers/utils/logErrorInConsole.d.ts

@@ -0,0 +1 @@
+export declare function logErrorInConsole(error: unknown, contextMessage: string): void;

package/loggers/utils/logErrorInConsole.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.logErrorInConsole = void 0;
+var getErrorMessage_1 = require("./getErrorMessage");
+function logErrorInConsole(error, contextMessage) {
+    var date = new Date().toISOString();
+    var errorMessage = (0, getErrorMessage_1.getErrorMessage)(error);
+    console.error("[ERROR] [".concat(date, "] (d2-logger) ").concat(contextMessage, ": ").concat(errorMessage, "\n"));
+}
+exports.logErrorInConsole = logErrorInConsole;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@eyeseetea/d2-logger",
-    "version": "1.2.0-beta.1",
+    "version": "1.2.0-beta.3",
     "description": "DHIS2 library that allows a certain application to register logs as events in a DHIS2 event program, tracker program or simply display logs on the console.",
     "author": "EyeSeeTea team <info@eyeseetea.com>",
     "license": "GPL-3.0",
@@ -27,7 +27,7 @@
     },
     "dependencies": {
         "@babel/runtime": "^7.5.4",
-        "@eyeseetea/d2-api": "1.14.0",
+        "@eyeseetea/d2-api": "1.20.0",
         "cmd-ts": "0.13.0",
         "real-cancellable-promise": "^1.1.2",
         "typed-immutable-map": "0.2.0"

package/scripts/commands/programLogger.js

@@ -83,7 +83,7 @@ function getCommand() {
             }),
         },
         handler: function (args) { return __awaiter(_this, void 0, void 0, function () {
-            var url, auth, orgUnitId, programId, messageTypeId, messageId, debug, logger, api, info, e_1;
+            var url, auth, orgUnitId, programId, messageTypeId, messageId, debug, d2ApiOptions, logger, api, info, e_1;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
@@ -91,11 +91,15 @@ function getCommand() {
                         _a.label = 1;
                     case 1:
                         _a.trys.push([1, 5, , 6]);
+                        d2ApiOptions = {
+                            baseUrl: url,
+                            auth: auth,
+                            backend: "xhr",
+                        };
                         return [4 /*yield*/, (0, __1.initLogger)({
                                 type: "program",
                                 debug: debug,
-                                baseUrl: url,
-                                auth: auth,
+                                d2ApiOptions: d2ApiOptions,
                                 organisationUnitId: orgUnitId,
                                 programId: programId,
                                 dataElements: {

package/scripts/commands/trackerProgramLogger.js

@@ -93,7 +93,7 @@ function getCommand() {
             }),
         },
         handler: function (args) { return __awaiter(_this, void 0, void 0, function () {
-            var url, auth, trackerProgramId, trackedEntityId, programStageId, enrollmentId, messageTypeId, messageId, debug, logger, api, info, e_1;
+            var url, auth, trackerProgramId, trackedEntityId, programStageId, enrollmentId, messageTypeId, messageId, debug, d2ApiOptions, logger, api, info, e_1;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
@@ -101,11 +101,15 @@ function getCommand() {
                         _a.label = 1;
                     case 1:
                         _a.trys.push([1, 4, , 5]);
+                        d2ApiOptions = {
+                            baseUrl: url,
+                            auth: auth,
+                            backend: "xhr",
+                        };
                         return [4 /*yield*/, (0, __1.initLogger)({
                                 type: "trackerProgram",
                                 debug: debug,
-                                baseUrl: url,
-                                auth: auth,
+                                d2ApiOptions: d2ApiOptions,
                                 trackerProgramId: trackerProgramId,
                                 messageTypeId: messageTypeId,
                             })];

package/scripts/common.js

@@ -59,7 +59,7 @@ function getD2ApiFromArgs(args) {
     var _a = args.auth
         ? { baseUrl: args.url, auth: args.auth }
         : getApiOptionsFromUrl(args.url), baseUrl = _a.baseUrl, auth = _a.auth;
-    return new d2_api_1.D2Api({ baseUrl: baseUrl, auth: auth });
+    return new d2_api_1.D2Api({ baseUrl: baseUrl, auth: auth, backend: "xhr" });
 }
 exports.getD2ApiFromArgs = getD2ApiFromArgs;
 function getApiUrlOption(options) {

package/types/d2-api.d.ts

@@ -1,4 +1,5 @@
 export { CancelableResponse } from "@eyeseetea/d2-api";
-export { D2Api } from "@eyeseetea/d2-api/2.36";
-export type { MetadataPick } from "@eyeseetea/d2-api/2.36";
-export type { D2TrackerEvent, DataValue } from "@eyeseetea/d2-api/api/trackerEvents";
+export { D2Api } from "@eyeseetea/d2-api/2.40";
+export type { MetadataPick } from "@eyeseetea/d2-api/2.40";
+export type { D2TrackerEventToPost, DataValue } from "@eyeseetea/d2-api/api/trackerEvents";
+export type { D2ApiOptions } from "@eyeseetea/d2-api/api/d2Api";

package/types/d2-api.js

@@ -3,5 +3,5 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.D2Api = exports.CancelableResponse = void 0;
 var d2_api_1 = require("@eyeseetea/d2-api");
 Object.defineProperty(exports, "CancelableResponse", { enumerable: true, get: function () { return d2_api_1.CancelableResponse; } });
-var _2_36_1 = require("@eyeseetea/d2-api/2.36");
-Object.defineProperty(exports, "D2Api", { enumerable: true, get: function () { return _2_36_1.D2Api; } });
+var _2_40_1 = require("@eyeseetea/d2-api/2.40");
+Object.defineProperty(exports, "D2Api", { enumerable: true, get: function () { return _2_40_1.D2Api; } });