@sap/cli-core 2023.23.0 → 2023.24.0

package/CHANGELOG.md

@@ -5,6 +5,18 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 2023.24.0
+
+### Fixed
+
+- The defined HTTP protocol was not applied to calculated authorization URL and token URL. No matter which HTTP protocol (`http` or `https`) was used, the automatically calculated authorization URL and token URL always used the `https` protocol.
+
+### Added
+
+- HTTPS proxy support via environment variable `https_proxy`. When using an HTTPS proxy to communicate with the public internet, you can configure the environment variable `https_proxy`. The CLI uses the value from the environment variable to establish a correct connection to the HTTPS proxy.
+
+- Support for response header `x-sap-datasphere-cli-file-name`. When the user adds option `--output` and provides a path to a file location, this value is always used to store the response data, no matter whether response header `x-sap-datasphere-cli-file-name` is present. If the user adds option `--output` without providing a path to a file location and the response header `x-sap-datasphere-cli-file-name` is present, the response data is stored in the location mentioned in `x-sap-datasphere-cli-file-name`. In all other cases, the response data is printed to the console.
+
 ## 2023.23.0
 
 ### Fixed

package/commands/handler/fetch/utils.d.ts

@@ -8,7 +8,14 @@ export declare const buildParameters: (path: string, parameterMappings?: Paramet
     headers: KeyValuePair;
     body: any;
 };
-export declare const handleResponseData: (data: any) => Promise<void>;
+/**
+ * If --output is present: Return value of --output if defined, otherwise take value from outputPath.
+ * If --output is not present, print response to console
+ * @param outputPath Optional path defined by server
+ * @returns Path to output file
+ */
+export declare function getOutputFileName(outputPath?: string): string;
+export declare const handleResponseData: (data: any, outputPath?: string) => Promise<void>;
 export declare const handleResponse: (data: any, headers?: RawAxiosResponseHeaders | AxiosResponseHeaders) => Promise<void>;
 export declare const configRequiresBody: (method: HTTPMethod) => boolean;
 export declare const buildHttpConfig: (method: HTTPMethod, path: string, parameterMappings?: ParameterMappings) => HTTPConfig;

package/commands/handler/fetch/utils.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.buildHttpConfig = exports.configRequiresBody = exports.handleResponse = exports.handleResponseData = exports.buildParameters = exports.removeLeadingPathSegmentForPasscode = exports.checkConfiguration = void 0;
+exports.buildHttpConfig = exports.configRequiresBody = exports.handleResponse = exports.handleResponseData = exports.getOutputFileName = exports.buildParameters = exports.removeLeadingPathSegmentForPasscode = exports.checkConfiguration = void 0;
 const url_1 = require("url");
 const lodash_1 = __importDefault(require("lodash"));
 const fs_extra_1 = __importDefault(require("fs-extra"));
@@ -103,7 +103,22 @@ const buildParameters = (path, parameterMappings) => {
     };
 };
 exports.buildParameters = buildParameters;
-const handleResponseData = async (data) => {
+/**
+ * If --output is present: Return value of --output if defined, otherwise take value from outputPath.
+ * If --output is not present, print response to console
+ * @param outputPath Optional path defined by server
+ * @returns Path to output file
+ */
+function getOutputFileName(outputPath = "") {
+    const config = (0, config_1.get)();
+    if (typeof config.options[constants_1.OPTION_OUTPUT.longName] === "boolean" &&
+        config.options[constants_1.OPTION_OUTPUT.longName]) {
+        return outputPath;
+    }
+    return config.options[constants_1.OPTION_OUTPUT.longName];
+}
+exports.getOutputFileName = getOutputFileName;
+const handleResponseData = async (data, outputPath) => {
     const config = (0, config_1.get)();
     if (!config.doNotStoreResult) {
         ResultHandlerFactory_1.ResultHandlerFactory.get().setResult(data);
@@ -112,8 +127,9 @@ const handleResponseData = async (data) => {
     const formatted = config.options.pretty
         ? JSON.stringify(data, null, 2)
         : JSON.stringify(data);
-    if (config.options[constants_1.OPTION_OUTPUT.longName]) {
-        await fs_extra_1.default.writeFile(config.options[constants_1.OPTION_OUTPUT.longName], formatted);
+    const outputFileName = getOutputFileName(outputPath);
+    if (outputFileName) {
+        await fs_extra_1.default.writeFile(outputFileName, formatted);
     }
     else {
         output(formatted);
@@ -125,7 +141,7 @@ const handleResponse = async (data, headers) => {
         (0, config_1.set)({ [constants_1.X_CSRF_TOKEN]: headers[constants_1.X_CSRF_TOKEN] });
     }
     else if (data) {
-        await (0, exports.handleResponseData)(data);
+        await (0, exports.handleResponseData)(data, headers?.[constants_1.X_OUTPUT_FILE_NAME]);
     }
 };
 exports.handleResponse = handleResponse;

package/constants.d.ts

@@ -18,6 +18,7 @@ export declare const CLI_GENERIC_OPTIONS_HELP = "cli-generic-options-help";
 export declare const SEGMENTS_TO_REMOVE_FOR_PASSCODE_AUTH: string[];
 export declare const DISCOVERY_METADATA_PATH = "discovery-metadata.json";
 export declare const X_CSRF_TOKEN = "x-csrf-token";
+export declare const X_OUTPUT_FILE_NAME = "x-sap-datasphere-cli-file-name";
 export declare const PATH_TO_SUCCESS_HTML: string;
 export declare const PATH_TO_ERROR_HTML: string;
 export declare const CACHE_SECRETS_FILE = "secrets.json";

package/constants.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.OPTION_INPUT = exports.OPTION_FILE_PATH = exports.OPTION_OPTIONS_FILE = exports.CONFIG_PASSCODE_FUNCTION = exports.OPTION_PASSCODE = exports.OPTION_CODE = exports.OPTION_SECRETS_FILE = exports.OPTION_EXPIRES_IN = exports.OPTION_REFRESH_TOKEN = exports.OPTION_ACCESS_TOKEN = exports.OPTION_TOKEN_URL = exports.OPTION_AUTHORIZATION_URL = exports.OPTION_CLIENT_SECRET = exports.OPTION_CLIENT_ID = exports.OPTION_FORCE = exports.OPTION_VERBOSE = exports.OPTION_NO_PRETTY = exports.OPTION_OUTPUT = exports.OPTION_LOGIN_ID = exports.OPTION_HOST = exports.OPTION_HELP = exports.OPTION_VERSION = exports.CACHE_SECRETS_FILE = exports.PATH_TO_ERROR_HTML = exports.PATH_TO_SUCCESS_HTML = exports.X_CSRF_TOKEN = exports.DISCOVERY_METADATA_PATH = exports.SEGMENTS_TO_REMOVE_FOR_PASSCODE_AUTH = exports.CLI_GENERIC_OPTIONS_HELP = exports.CLI_SUPPORTED_AUTHENTICATION_METHODS = exports.CLI_DEPRECATION_MESSAGE = exports.CLI_DEPRECATED = exports.CLI_VERSION = exports.CLI_SAP_HELP = exports.CLI_DISCOVERY_PATH = exports.CLI_DESCRIPTION = exports.CLI_PACKAGE_NAME = exports.CLI_NAME = exports.AuthenticationMethod = exports.DISCOVERY_DOCUMENT_PREFIX = exports.VERSION = void 0;
+exports.OPTION_INPUT = exports.OPTION_FILE_PATH = exports.OPTION_OPTIONS_FILE = exports.CONFIG_PASSCODE_FUNCTION = exports.OPTION_PASSCODE = exports.OPTION_CODE = exports.OPTION_SECRETS_FILE = exports.OPTION_EXPIRES_IN = exports.OPTION_REFRESH_TOKEN = exports.OPTION_ACCESS_TOKEN = exports.OPTION_TOKEN_URL = exports.OPTION_AUTHORIZATION_URL = exports.OPTION_CLIENT_SECRET = exports.OPTION_CLIENT_ID = exports.OPTION_FORCE = exports.OPTION_VERBOSE = exports.OPTION_NO_PRETTY = exports.OPTION_OUTPUT = exports.OPTION_LOGIN_ID = exports.OPTION_HOST = exports.OPTION_HELP = exports.OPTION_VERSION = exports.CACHE_SECRETS_FILE = exports.PATH_TO_ERROR_HTML = exports.PATH_TO_SUCCESS_HTML = exports.X_OUTPUT_FILE_NAME = exports.X_CSRF_TOKEN = exports.DISCOVERY_METADATA_PATH = exports.SEGMENTS_TO_REMOVE_FOR_PASSCODE_AUTH = exports.CLI_GENERIC_OPTIONS_HELP = exports.CLI_SUPPORTED_AUTHENTICATION_METHODS = exports.CLI_DEPRECATION_MESSAGE = exports.CLI_DEPRECATED = exports.CLI_VERSION = exports.CLI_SAP_HELP = exports.CLI_DISCOVERY_PATH = exports.CLI_DESCRIPTION = exports.CLI_PACKAGE_NAME = exports.CLI_NAME = exports.AuthenticationMethod = exports.DISCOVERY_DOCUMENT_PREFIX = exports.VERSION = void 0;
 const path_1 = __importDefault(require("path"));
 const utils_1 = require("./utils/utils");
 exports.VERSION = (0, utils_1.getVersion)();
@@ -26,6 +26,7 @@ exports.CLI_GENERIC_OPTIONS_HELP = "cli-generic-options-help";
 exports.SEGMENTS_TO_REMOVE_FOR_PASSCODE_AUTH = ["dwaas-core"];
 exports.DISCOVERY_METADATA_PATH = "discovery-metadata.json";
 exports.X_CSRF_TOKEN = "x-csrf-token";
+exports.X_OUTPUT_FILE_NAME = "x-sap-datasphere-cli-file-name";
 exports.PATH_TO_SUCCESS_HTML = path_1.default.join(__dirname, "assets", "success.html");
 exports.PATH_TO_ERROR_HTML = path_1.default.join(__dirname, "assets", "error.html");
 exports.CACHE_SECRETS_FILE = "secrets.json";
@@ -64,7 +65,7 @@ exports.OPTION_LOGIN_ID = {
 exports.OPTION_OUTPUT = {
     longName: "output",
     description: "specifies the file to store the output of the command",
-    args: [{ name: "output" }],
+    args: [{ name: "output", optional: true }],
     hidden: true,
 };
 exports.OPTION_NO_PRETTY = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sap/cli-core",
-  "version": "2023.23.0",
+  "version": "2023.24.0",
   "description": "Command-Line Interface (CLI) Core Module",
   "license": "SEE LICENSE IN LICENSE",
   "author": "SAP SE",
@@ -19,11 +19,12 @@
   "dependencies": {
     "ajv": "8.12.0",
     "axios": "1.5.1",
-    "commander": "11.0.0",
+    "commander": "11.1.0",
     "config": "3.3.9",
     "dotenv": "16.3.1",
     "fs-extra": "11.1.1",
     "https": "1.0.0",
+    "https-proxy-agent": "7.0.2",
     "lodash": "4.17.21",
     "open": "8.4.2",
     "path": "0.12.7",

package/utils/http/index.js

@@ -5,6 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.fetch = exports.DEFAULTS = void 0;
 const axios_1 = __importDefault(require("axios"));
+const https_proxy_agent_1 = require("https-proxy-agent");
 const config_1 = require("../../config");
 const logger_1 = require("../../logger");
 const constants_1 = require("../../constants");
@@ -13,10 +14,11 @@ const core_1 = require("../../config/core");
 exports.DEFAULTS = {
     maxBodyLength: -1,
     maxContentLength: -1,
-    maxRedirects: 0, // must be set to 0 because maxBodyLength: -1 won't work otherwise, see github.com/axios/axios/issues/4263
+    maxRedirects: 0, // must be set to 0 because maxBodyLength: -1 won't work otherwise, see github.com/axios/axios/issues/4263,
 };
 const HEADERS_ETAG = "x-sap-cli-core-discovery-etag";
 const getLogger = () => (0, logger_1.get)("http");
+const HTTPS_PROXY = process.env.https_proxy ?? process.env.HTTPS_PROXY;
 const setEtag = (headers) => {
     const { debug } = getLogger();
     if (headers?.[HEADERS_ETAG]) {
@@ -38,7 +40,16 @@ const fetch = async (config) => {
             output("%s %s", config.method.toUpperCase(), config.url);
         }
         debug("http config: %s", JSON.stringify(config));
+        const httpsAgent = HTTPS_PROXY ? new https_proxy_agent_1.HttpsProxyAgent(HTTPS_PROXY) : null;
+        if (httpsAgent && cnfg.verbose) {
+            output(`using https proxy agent for https proxy`);
+            debug(`using https proxy agent for https proxy ${HTTPS_PROXY}`);
+        }
+        else {
+            debug("no https proxy defined via environment variable https_proxy");
+        }
         const res = await (0, axios_1.default)({
+            httpsAgent,
             ...config,
             ...exports.DEFAULTS,
             headers: {

package/utils/utils.js

@@ -148,8 +148,8 @@ const getInfoFromTenant = (tenant, verbose, printOutput = true) => {
         host: `${protocol}//dwaas-core.sac${region}.cfapps.orca.net.sap`,
         publicfqdn: parsedTenant,
         passcodeUrl: `https://${hostname}.authentication.${region}.hana.ondemand.com/passcode`,
-        authorizationUrl: `https://${hostname}.authentication.${region}.hana.ondemand.com/oauth/authorize`,
-        tokenUrl: `https://${hostname}.authentication.${region}.hana.ondemand.com/oauth/token`,
+        authorizationUrl: `${protocol}//${hostname}.authentication.${region}.hana.ondemand.com/oauth/authorize`,
+        tokenUrl: `${protocol}//${hostname}.authentication.${region}.hana.ondemand.com/oauth/token`,
         tenantUrl: `${protocol}//${parsedTenant}`,
     };
 };