Zowe Suite v1.28.1

.github/workflows/build-core.yml

@@ -66,7 +66,7 @@ jobs:
       - name: '[Prep 2] Setup Node'
         uses: actions/setup-node@v2
         with:
-          node-version: 16
+          node-version: 14
 
       - name: '[Prep 3] Setup jFrog CLI'
         uses: jfrog/setup-jfrog-cli@v2

CHANGELOG.md

@@ -3,6 +3,10 @@
 All notable changes to the Zlux Server Framework package will be documented in this file.
 This repo is part of the app-server Zowe Component, and the change logs here may appear on Zowe.org in that section.
 
+## 1.28.1
+
+- Bugfix: call() on an external service would be missing the full URL, causing invalid response or hang
+
 ## 1.28.0
 
 - Bugfix: Pass through tlsOptions object when making a proxy from an 'external'-type service, and allow the services to individually control tls verification strictness of their own proxy.

lib/webapp.js

@@ -851,8 +851,8 @@ const staticHandlers = {
  *  This is passed to every other service of the plugin, so that 
  *  the service can be called by other services under the plugin
  */
-function WebServiceHandle(urlPrefix, environment, isAgentService, service) {
-  this.urlPrefix = urlPrefix;
+function WebServiceHandle(serviceRootUrl, environment, isAgentService, service) {
+  this.serviceRootUrl = serviceRootUrl;
   if (!environment.loopbackConfig.port) {
     installLog.severe(`ZWED0003E`, loopbackConfig); //installLog.severe(`loopback configuration not valid,`,loopbackConfig, `loopback calls will fail!`);
   }
@@ -862,28 +862,39 @@ function WebServiceHandle(urlPrefix, environment, isAgentService, service) {
 }
 WebServiceHandle.prototype = {
   constructor: WebServiceHandle,
-  //This is currently suboptimal: it makes an HTTP call
-  //to localhost for every service call. We could instead just call
-  //the corresponding router directly with mock request and
-  //response objects, but that's tricky, so let's do that
-  //later.
-
   //  router: null,
   port: 0,
-  urlPrefix: null,
 
+
+  // The route on this server to the service's root, such as
+  // /ZLUX/plugins/org.zowe.zlux.sample.angular/services/hello/1.0.1
+  serviceRootUrl: null,
+
+  /*
+    path: A path url on the destiation. Can be prefixed with the route to the service root conditional to service type.
+    options: An object containing options to modify the request behavior
+    originalRequest: the request object from the source service that issued call(). don't modify it!!
+    originalRes: the response object from the source service that issued call(). don't modify it!!
+  */
   call(path, options, originalRequest, originalRes) {
     let serviceModified = true;
     return new Promise((resolve, reject) => {
       if (typeof path === "object") {
         options = path;
         path = "";
       }
-      options = options || {};
-      let url = this.urlPrefix;
-      if (path) {
-        url += path.startsWith('/') ? path : '/' + path;
+      //can be changed if service is an import, will be resolved to source service
+      let rootUrl = this.serviceRootUrl;
+      if (typeof path != 'string') {
+        path="";
+      }      
+      if (path.length != 0 && !path.startsWith('/')) {
+        path = '/' + path; //ensure separation between serviceRootUrl and path
       }
+      //at this point path is a string that is either blank or starts with /
+      routingLog.debug(`in 'call()', path=%s`, path);
+
+      options = options || {};
       let rejectUnauthorized;
       let protocol;
       if (this.environment.loopbackConfig.isHttps) {
@@ -897,7 +908,6 @@ WebServiceHandle.prototype = {
         port: this.environment.loopbackConfig.port,
         method: options.method || "GET",
         protocol: protocol,
-        path: url,
         auth: options.auth,
         timeout: options.timeout,
         rejectUnauthorized: rejectUnauthorized
@@ -948,21 +958,26 @@ WebServiceHandle.prototype = {
       }
 
       if(this.service && this.service.imported) {
-        requestOptions.path = zLuxUrl.makePluginURL('ZLUX', this.service.sourcePlugin) + zLuxUrl.makeServiceSubURL(this.service, false, false, path);
-        routingLog.debug(`Call agent host=%s import resolved to path=%s`,requestOptions.hostname, requestOptions.path);
+        //reassign rootUrl which will be consumed in lines below for full url
+        rootUrl = zLuxUrl.makePluginURL('ZLUX', this.service.sourcePlugin) + zLuxUrl.makeServiceSubURL(this.service, false, false, undefined);
+        routingLog.debug(`Call agent host=%s port=%s import resolved to path=%s`,requestOptions.hostname, requestOptions.port, requestOptions.path);
       }
 
       let httpOrHttps;
       if (this.isAgentService || (this.service && (this.service.type === 'external' || this.service.type === 'service'))) {
         if(this.service && this.service.type === 'external') {
+          routingLog.debug(`adjusting requestOptions for service type=external`);
           requestOptions.hostname = this.service.host;
           requestOptions.port = this.service.port;
-          requestOptions.path = this.service.urlPrefix;
           requestOptions.protocol = this.service.isHttps ? 'https:': 'http:';
+          requestOptions.path = this.service.urlPrefix && this.service.urlPrefix.length > 0
+            ? this.service.urlPrefix + path : path; //could be empty string
         } else {
+          routingLog.debug(`adjusting requestOptions for service type=service`);
           requestOptions.hostname = this.environment.agentRequestOptions.host;
           requestOptions.port = this.environment.agentRequestOptions.port;
           requestOptions.protocol = this.environment.agentRequestOptions.protocol;
+          requestOptions.path = rootUrl + path; //path may be empty string and thats ok
           requestOptions.rejectUnauthorized = this.environment.agentRequestOptions.rejectUnauthorized;
           requestOptions.ca = this.environment.agentRequestOptions.ca;
           requestOptions.ciphers = this.environment.agentRequestOptions.ciphers;
@@ -972,15 +987,22 @@ WebServiceHandle.prototype = {
           }
         }
         httpOrHttps = requestOptions.protocol == 'http:' ? http : https;
-        routingLog.debug(`Call agent host=%s path=%s`,requestOptions.hostname, requestOptions.path);
+        // prevent double slashes in url, if you have more than double slash then good luck
+        requestOptions.path = requestOptions.path.replace(/\/\//g, '/');
+        routingLog.debug(`Call external server host=%s port=%s requestOptions.path=%s`,requestOptions.hostname, requestOptions.port, requestOptions.path);
       } else {
+        requestOptions.path = path ? rootUrl + path : rootUrl;
+        // prevent double slashes in url
+        requestOptions.path = requestOptions.path.replace(/\/\//g, '/');
+
+
         if (options.zluxLoopbackSecret) {
           //TODO use secret in a crypto scheme
           requestOptions.headers[ZLUX_LOOPBACK_HEADER] = options.zluxLoopbackSecret;
         }
 
         if (options.internalRouting) {
-          routingLog.debug(`Call internally path=%s`, requestOptions.path);
+          routingLog.debug(`Call internally requestOptions.path=%s`, requestOptions.path);
           //clone done to prevent original request alteration, but shallow so hope attributes arent altered
           let req = Object.assign({},originalRequest);
           let res = Object.assign({},originalRes);
@@ -1029,7 +1051,7 @@ WebServiceHandle.prototype = {
           }
 
           res.end = (body)=> {
-            utilLog.debug('router returned with body=',body.length);
+            routingLog.debug('router returned with body=',body.length);
             res.body = iconv.decode(body,'utf8');
             if (!res.statusMessage) {
               res.statusMessage = status[res.statusCode];
@@ -1064,24 +1086,24 @@ WebServiceHandle.prototype = {
         const request = httpOrHttps.request(requestOptions, (response) => {
           var chunks = [];
           response.on('data',(chunk)=> {
-            utilLog.debug('ZWED0194I'); //utilLog.debug('Callservice: Data received');
+            routingLog.debug('ZWED0194I'); //utilLog.debug('Callservice: Data received');
             chunks.push(chunk);
           });
           response.on('end',() => {
-            utilLog.debug('ZWED0195I'); //utilLog.debug('Callservice: Service call completed.');
+            routingLog.debug('ZWED0195I'); //utilLog.debug('Callservice: Service call completed.');
             response.body = Buffer.concat(chunks).toString();
             resolve(response);
           });
         }
                                            );
         request.on('error', (e) => {
-          utilLog.warn('ZWED0061W'); //utilLog.warn('Callservice: Service call failed.');
+          routingLog.warn('ZWED0061W'); //utilLog.warn('Callservice: Service call failed.');
           reject(e);
         });
         if (options.body) {
           request.write(options.body);
         }
-        utilLog.debug('ZWED0196I', JSON.stringify(requestOptions, null, 2)); //utilLog.debug('Callservice: Issuing request to service: ' 
+        routingLog.debug('ZWED0196I', JSON.stringify(requestOptions, null, 2)); //utilLog.debug('Callservice: Issuing request to service: ' 
         //+ JSON.stringify(requestOptions, null, 2));
         request.end();
       }