Support for additional fields in the error message format (#63)

* Additional message fields

Author: plavjanik

.circleci/config.yml

@@ -10,8 +10,8 @@ jobs:
       - checkout
       - restore_cache: &keys
           keys:
-            - v1-zowe-sdk-{{ .Branch }}
-            - v1-zowe-sdk-master
+            - v2-zowe-sdk-{{ .Branch }}
+            - v2-zowe-sdk-master
       - run: &build_jarpatcher
           name: Building JAR Patcher using Gradle
           command: ./gradlew :jarpatcher:build
@@ -24,6 +24,7 @@ jobs:
       - run: &zosbuild
           name: Building Native z/OS Code
           command: |
+            npm uninstall zowe-api-dev
             npm install
             source .circleci/river.env
             npm run zosbuild
@@ -64,7 +65,7 @@ jobs:
             - ~/code/zowe-api-dev/node_modules
             - ~/code/zowe-rest-api-sample-spring/.gradle
             - ~/code/gradle/wrapper/gradle-wrapper.jar
-          key: v1-zowe-sdk-{{ .Branch }}-{{ epoch }}
+          key: v2-zowe-sdk-{{ .Branch }}-{{ epoch }}
   publish_all:
     docker:
       - image: circleci/openjdk:8-jdk-node

scripts/run-integration-tests-zos.sh

@@ -2,7 +2,7 @@
 scripts/lock-port.sh
 
 cd zowe-rest-api-sample-spring
-zowe-api-dev deploy
+zowe-api-dev deploy --force
 zowe-api-dev config --name zos -p port=$TEST_PORT
 zowe-api-dev start --job
 

zowe-api-dev/src/commands/deploy.ts

@@ -8,7 +8,7 @@ export default class Deploy extends Command {
     static description = "deploy the API service artifacts to z/OS";
 
     static flags = {
-        force: flags.boolean({ char: "f", description: "forces full deployment even if there is not change" }),
+        force: flags.boolean({ char: "f", description: "forces full deployment even if there is not change", default: true }),
     };
 
     async run() {

zowe-api-dev/src/files.ts

@@ -58,6 +58,7 @@ export function transferFiles(
     console.time("transferFile");
     checkZoweProfileName(userConfig);
     for (const [file, options] of Object.entries(files)) {
+        debug("options", options);
         const zosFile = `${zosTargetDir}/${options.target}`;
         const zosDir = dirname(zosFile);
         let soUpdated = true;
@@ -106,12 +107,13 @@ export function transferFiles(
             }
         }
         const postCommands: string[] = [];
-        if (soUpdated && options.postSoUpdateCommands) {
+        if ((soUpdated || force) && options.postSoUpdateCommands) {
             postCommands.push(...options.postSoUpdateCommands);
         }
         if (options.postCommands) {
             postCommands.push(...options.postCommands);
         }
+        debug("postCommands", postCommands);
         for (const postCommand of postCommands) {
             let finalCommand = postCommand;
             if (postCommand.startsWith("java") && userConfig.javaHome) {

zowe-rest-api-commons-spring/build.gradle

@@ -82,7 +82,7 @@ task zosbuild(type: Exec) {
     if (System.getProperty('os.name').toLowerCase(Locale.ROOT).contains('windows')) {
         commandLine 'zowe-api-dev.cmd', 'zosbuild'
     } else {
-        commandLine 'zowe-api-dev', 'zosbuild'
+        commandLine 'npx', 'zowe-api-dev', 'zosbuild'
     }
 }
 

zowe-rest-api-commons-spring/src/main/java/org/zowe/commons/error/ErrorMessage.java

@@ -11,51 +11,23 @@
 
 import org.zowe.commons.rest.response.MessageType;
 
+import lombok.AllArgsConstructor;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+@Data
+@AllArgsConstructor
+@NoArgsConstructor
 public class ErrorMessage {
     private String key;
     private String number;
     private MessageType type;
     private String text;
-
-    public ErrorMessage() {
-    }
+    private String reason;
+    private String action;
+    private String component;
 
     public ErrorMessage(String key, String number, MessageType type, String text) {
-        this.key = key;
-        this.number = number;
-        this.type = type;
-        this.text = text;
-    }
-
-    public String getKey() {
-        return key;
-    }
-
-    public void setKey(String key) {
-        this.key = key;
-    }
-
-    public String getNumber() {
-        return number;
-    }
-
-    public void setNumber(String number) {
-        this.number = number;
-    }
-
-    public MessageType getType() {
-        return type;
-    }
-
-    public void setType(MessageType type) {
-        this.type = type;
-    }
-
-    public String getText() {
-        return text;
-    }
-
-    public void setText(String text) {
-        this.text = text;
+       this(key, number, type, text, null, null, null);
     }
 }

zowe-rest-api-commons-spring/src/main/java/org/zowe/commons/error/ErrorService.java

@@ -9,10 +9,10 @@
  */
 package org.zowe.commons.error;
 
-import org.zowe.commons.rest.response.ApiMessage;
-
 import java.util.List;
 
+import org.zowe.commons.rest.response.ApiMessage;
+
 /**
  * Service for creating {@link ApiMessage} by string key and list of parameters.
  * See default implementation {@link org.zowe.commons.error.ErrorServiceImpl}.
@@ -56,4 +56,19 @@ public interface ErrorService {
      * @return Readable text for the given message key.
      */
     String getReadableMessage(String key, Object... parameters);
+
+    /**
+     * @return Returns the value of the default message source attribute that is
+     *         added to every error message. It is a string that identifies the
+     *         source service. For example: myhost:8080:serviceid
+     */
+    String getDefaultMessageSource();
+
+    /**
+     * @param defaultMessageSource The value of the default message source attribute
+     *                             that is added to every error message. It is a
+     *                             string that identifies the source service. For
+     *                             example: myhost:8080:serviceid
+     */
+    void setDefaultMessageSource(String defaultMessageSource);
 }

zowe-rest-api-commons-spring/src/main/java/org/zowe/commons/error/ErrorServiceImpl.java

@@ -36,8 +36,10 @@ public class ErrorServiceImpl implements ErrorService {
     private static final String INVALID_KEY_MESSAGE = "org.zowe.commons.error.invalidMessageKey";
     private static final String INVALID_MESSAGE_TEXT_FORMAT = "org.zowe.commons.error.invalidMessageTextFormat";
     private static final Logger LOGGER = LoggerFactory.getLogger(ErrorServiceImpl.class);
+    private static final int STACK_TRACE_ELEMENT_ABOVE_CREATEAPIMESSAGE_METHOD = 3;
 
     private final ErrorMessageStorage messageStorage;
+    private String defaultMessageSource;
 
     /**
      * Constructor that creates only common messages.
@@ -103,6 +105,16 @@ public void loadMessages(String messagesFilePath) {
         }
     }
 
+    @Override
+    public String getDefaultMessageSource() {
+        return defaultMessageSource;
+    }
+
+    @Override
+    public void setDefaultMessageSource(String defaultMessageSource) {
+        this.defaultMessageSource = defaultMessageSource;
+    }
+
     /**
      * Internal method that call {@link ErrorMessageStorage} to get message by key.
      *
@@ -125,8 +137,13 @@ private Message createMessage(String key, Object... parameters) {
             messageParameters = validateParameters(message, key, parameters);
             text = String.format(message.getText(), messageParameters);
         }
-
-        return new BasicMessage(key, message.getType(), message.getNumber(), text);
+        if (message.getComponent() == null) {
+            StackTraceElement[] stackTrace = Thread.currentThread().getStackTrace();
+            String className = stackTrace[STACK_TRACE_ELEMENT_ABOVE_CREATEAPIMESSAGE_METHOD].getClassName();
+            message.setComponent(className);
+        }
+        return new BasicMessage(message.getType(), message.getNumber(), text, message.getReason(), message.getAction(),
+                key, null, BasicMessage.generateMessageInstanceId(), defaultMessageSource, message.getComponent());
     }
 
     /**
@@ -146,7 +163,7 @@ private ErrorMessage validateMessage(ErrorMessage message, String key) {
 
         if (message == null) {
             String text = "Internal error: Invalid message key '%s' provided. No default message found. Please contact support of further assistance.";
-            message = new ErrorMessage(INVALID_KEY_MESSAGE, "ZWEAS001", MessageType.ERROR, text);
+            message = new ErrorMessage(INVALID_KEY_MESSAGE, "ZWEAS001", MessageType.ERROR, text, null, null, null);
         }
 
         return message;

zowe-rest-api-commons-spring/src/main/java/org/zowe/commons/rest/response/BasicMessage.java

@@ -9,15 +9,14 @@
  */
 package org.zowe.commons.rest.response;
 
-import org.zowe.commons.rest.response.Message;
-import org.zowe.commons.rest.response.MessageType;
-import com.fasterxml.jackson.annotation.JsonCreator;
-import com.fasterxml.jackson.annotation.JsonProperty;
-
 import java.util.List;
 import java.util.Objects;
 import java.util.UUID;
 
+import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.fasterxml.jackson.annotation.JsonPropertyOrder;
+
 /**
  * Holds information about a {@link Message}. This class is immutable.
  * <p>
@@ -32,6 +31,7 @@
  *
  * @author Greg Berres, Petr Plavjanik
  */
+@JsonPropertyOrder({ "messageType", "messageNumber", "messageContent", "messageReason", "messageAction", "messageKey", "messageParameters", "messageInstanceId", "messageComponent", "messageSource"})
 public class BasicMessage implements Message {
     private final MessageType messageType;
     private final String messageNumber;
@@ -80,7 +80,7 @@ public BasicMessage(@JsonProperty("messageKey") String messageKey,
         this(messageType, messageNumber, messageContent, null, null, messageKey, null, generateMessageInstanceId(), null, null);
     }
 
-    private static String generateMessageInstanceId() {
+    public static String generateMessageInstanceId() {
         return UUID.randomUUID().toString();
     }
 

zowe-rest-api-commons-spring/src/main/java/org/zowe/commons/spring/DefaultMessageSource.java

@@ -0,0 +1,51 @@
+/*
+ * This program and the accompanying materials are made available under the terms of the
+ * Eclipse Public License v2.0 which accompanies this distribution, and is available at
+ * https://www.eclipse.org/legal/epl-v20.html
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Copyright Contributors to the Zowe Project.
+ */
+package org.zowe.commons.spring;
+
+import java.net.InetAddress;
+import java.net.UnknownHostException;
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.context.event.ApplicationReadyEvent;
+import org.springframework.context.ApplicationListener;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.core.env.Environment;
+import org.zowe.commons.error.CommonsErrorService;
+import org.zowe.commons.error.ErrorService;
+
+import lombok.extern.slf4j.Slf4j;
+
+@Configuration
+@Slf4j
+public class DefaultMessageSource implements ApplicationListener<ApplicationReadyEvent> {
+    private final Environment environment;
+    private final ErrorService errorService;
+
+    @Autowired
+    public DefaultMessageSource(ErrorService errorService, Environment environment) {
+        this.errorService = errorService;
+        this.environment = environment;
+    }
+
+    @Override
+    public void onApplicationEvent(ApplicationReadyEvent event) {
+        String hostname;
+        try {
+            hostname = InetAddress.getLocalHost().getCanonicalHostName();
+        } catch (UnknownHostException e) {
+            log.warn("Could not obtain hostname", e);
+            hostname = "?";
+        }
+        String serviceId = environment.getProperty("apiml.service.serviceId");
+        String messageSource = String.format("%s:%s:%s", hostname, environment.getProperty("server.port"), serviceId);
+        errorService.setDefaultMessageSource(messageSource);
+        CommonsErrorService.get().setDefaultMessageSource(messageSource);
+    }
+}