@sap-ux/deploy-tooling 0.2.9 → 0.2.10

package/dist/base/deploy.d.ts

@@ -22,7 +22,7 @@ export declare function getCredentials<T extends BasicAuth | ServiceAuth | undef
  */
 export declare function deploy(archive: Buffer, config: AbapDeployConfig, logger: Logger): Promise<void>;
 /**
- * Deploy the given archive to the given target using the given app description.
+ * Undeploy the given project from the given target using the given app name.
  *
  * @param config - deployment configuration
  * @param logger - reference to the logger instance

package/dist/base/deploy.js

@@ -16,6 +16,7 @@ const store_1 = require("@sap-ux/store");
 const fs_1 = require("fs");
 const config_1 = require("./config");
 const prompt_1 = require("./prompt");
+const deploymentCommands = { tryUndeploy, tryDeploy };
 /**
  * Check the secure storage if it has credentials for the given target.
  *
@@ -139,56 +140,54 @@ function createDeployService(config, logger) {
     });
 }
 /**
- * Try executing the deployment command and handle known errors.
+ * Handle exceptions thrown, in some cases we to retry them.
  *
- * @param archive - archive file that is to be deployed
+ * @param command - the request type deploy | undeploy
+ * @param error - thrown error object
  * @param service - instance of the axios-extension deployment service
- * @param config - deployment configuration
+ * @param config - configuration used for the previous request
  * @param logger - reference to the logger instance
+ * @param archive - archive file that is to be deployed
  */
-function tryDeploy(archive, service, config, logger) {
+function handleError(command, error, service, config, logger, archive) {
     return __awaiter(this, void 0, void 0, function* () {
-        try {
-            yield service.deploy({ archive, bsp: config.app, testMode: config.test, safeMode: config.safe });
-        }
-        catch (e) {
-            if (!config.noRetry && (0, axios_extension_1.isAxiosError)(e)) {
-                const success = yield handleAxiosError(e.response, archive, service, config, logger);
-                if (success) {
-                    return;
-                }
-            }
-            logger.error('Deployment has failed.');
-            logger.debug((0, config_1.getConfigForLogging)(config));
-            if (!config.verbose) {
-                logger.error('Change logging level to debug your issue\n\t(see examples https://github.com/SAP/open-ux-tools/tree/main/packages/deploy-tooling#configuration-with-logging-enabled)');
+        if (!config.noRetry && (0, axios_extension_1.isAxiosError)(error)) {
+            const success = yield handleAxiosError(command, error.response, service, config, logger, archive);
+            if (success) {
+                return;
             }
-            throw e;
         }
+        logger.error(`${command === "tryDeploy" /* TryCommands.Deploy */ ? 'Deployment' : 'Undeployment'} has failed.`);
+        logger.debug((0, config_1.getConfigForLogging)(config));
+        if (!config.verbose) {
+            logger.error('Change logging level to debug your issue\n\t(see examples https://github.com/SAP/open-ux-tools/tree/main/packages/deploy-tooling#configuration-with-logging-enabled)');
+        }
+        throw error;
     });
 }
 /**
  * Main function for different deploy retry handling.
  *
+ * @param command - the request type deploy | undeploy
  * @param response - response of that triggered and axios error
- * @param archive - archive file that is to be deployed
  * @param service - instance of the axios-extension deployment service
  * @param config - configuration used for the previous request
  * @param logger - reference to the logger instance
+ * @param archive - archive file that is to be deployed
  * @returns true if the error was handled otherwise false is return or an error is raised
  */
-function handleAxiosError(response, archive, service, config, logger) {
+function handleAxiosError(command, response, service, config, logger, archive) {
     var _a;
     return __awaiter(this, void 0, void 0, function* () {
         switch (response === null || response === void 0 ? void 0 : response.status) {
             case 401:
-                logger.warn('Deployment failed with authentication error.');
+                logger.warn(`${command === "tryDeploy" /* TryCommands.Deploy */ ? 'Deployment' : 'Undeployment'} failed with authentication error.`);
                 logger.info('Please maintain correct credentials to avoid seeing this error\n\t(see help: https://www.npmjs.com/package/@sap/ux-ui5-tooling#setting-environment-variables-in-a-env-file)');
-                logger.info('Please enter your credentials for this deployment.');
+                logger.info('Please enter your credentials.');
                 const credentials = yield (0, prompt_1.promptCredentials)((_a = service.defaults.auth) === null || _a === void 0 ? void 0 : _a.username);
                 if (Object.keys(credentials).length) {
                     service.defaults.auth = credentials;
-                    yield tryDeploy(archive, service, config, logger);
+                    yield deploymentCommands[command](service, config, logger, archive);
                     return true;
                 }
                 else {
@@ -197,7 +196,7 @@ function handleAxiosError(response, archive, service, config, logger) {
             case 412:
                 logger.warn('An app in the same repository with different sap app id found.');
                 if (config.yes || (yield (0, prompt_1.promptConfirmation)('Do you want to overwrite (Y/n)?'))) {
-                    yield tryDeploy(archive, service, Object.assign(Object.assign({}, config), { safe: false, noRetry: true }), logger);
+                    yield deploymentCommands[command](service, Object.assign(Object.assign({}, config), { safe: false, noRetry: true }), logger, archive);
                     return true;
                 }
                 else {
@@ -209,51 +208,110 @@ function handleAxiosError(response, archive, service, config, logger) {
     });
 }
 /**
- * Deploy the given archive to the given target using the given app description.
+ * Generate a Ui5AbapRepositoryService instance from the supplied deployment config.
  *
- * @param archive - archive file that is to be deployed
  * @param config - deployment configuration
  * @param logger - reference to the logger instance
+ * @returns service returns the UI5 ABAP Repository service
  */
-function deploy(archive, config, logger) {
+function getAbapService(config, logger) {
     return __awaiter(this, void 0, void 0, function* () {
-        if (config.keep) {
-            (0, fs_1.writeFileSync)(`archive.zip`, archive);
-        }
         const service = yield createDeployService(config, logger);
         service.log = logger;
         if (!config.strictSsl) {
             logger.warn('You chose not to validate SSL certificate. Please verify the server certificate is trustful before proceeding. See documentation for recommended configuration (https://help.sap.com/viewer/17d50220bcd848aa854c9c182d65b699/Latest/en-US/4b318bede7eb4021a8be385c46c74045.html).');
         }
-        logger.info(`Starting to deploy${config.test === true ? ' in test mode' : ''}.`);
-        yield tryDeploy(archive, service, config, logger);
-        if (config.test === true) {
-            logger.info('Deployment in TestMode completed. A successful TestMode execution does not necessarily mean that your upload will be successful.');
+        return service;
+    });
+}
+/**
+ * Generic method to run the deployment request i.e. deploy | undeploy.
+ *
+ * @param command - the request type deploy | undeploy to be executed
+ * @param config - deployment configuration
+ * @param logger - reference to the logger instance
+ * @param archive - archive file that is to be deployed
+ */
+function runCommand(command, config, logger, archive = Buffer.from('')) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const service = yield getAbapService(config, logger);
+        logger.info(`Starting to ${command === "tryDeploy" /* TryCommands.Deploy */ ? 'deploy' : 'undeploy'}${config.test === true ? ' in test mode' : ''}.`);
+        yield deploymentCommands[command](service, config, logger, archive);
+    });
+}
+/**
+ * Try executing the deployment command and handle known errors.
+ *
+ * @param service - instance of the axios-extension deployment service
+ * @param config - deployment configuration
+ * @param logger - reference to the logger instance
+ * @param archive - archive file that is to be deployed
+ */
+function tryDeploy(service, config, logger, archive) {
+    return __awaiter(this, void 0, void 0, function* () {
+        try {
+            yield service.deploy({ archive, bsp: config.app, testMode: config.test, safeMode: config.safe });
+            if (config.test === true) {
+                logger.info('Deployment in TestMode completed. A successful TestMode execution does not necessarily mean that your upload will be successful.');
+            }
+            else {
+                logger.info('Successfully deployed.');
+            }
         }
-        else {
-            logger.info('Successfully deployed.');
+        catch (error) {
+            yield handleError("tryDeploy" /* TryCommands.Deploy */, error, service, config, logger, archive);
         }
     });
 }
-exports.deploy = deploy;
 /**
  * Deploy the given archive to the given target using the given app description.
  *
+ * @param archive - archive file that is to be deployed
  * @param config - deployment configuration
  * @param logger - reference to the logger instance
  */
-function undeploy(config, logger) {
+function deploy(archive, config, logger) {
     return __awaiter(this, void 0, void 0, function* () {
-        const service = yield createDeployService(config, logger);
-        service.log = logger;
-        if (!config.strictSsl) {
-            logger.warn('You chose not to validate SSL certificate. Please verify the server certificate is trustful before proceeding. See documentation for recommended configuration (https://help.sap.com/viewer/17d50220bcd848aa854c9c182d65b699/Latest/en-US/4b318bede7eb4021a8be385c46c74045.html).');
+        if (config.keep) {
+            (0, fs_1.writeFileSync)(`archive.zip`, archive);
         }
-        logger.info(`Starting to undeploy${config.test === true ? ' in test mode' : ''}.`);
-        if (yield service.undeploy({ bsp: config.app, testMode: config.test })) {
-            logger.info('Successfully undeployed.');
+        yield runCommand("tryDeploy" /* TryCommands.Deploy */, config, logger, archive);
+    });
+}
+exports.deploy = deploy;
+/**
+ * Try executing the undeployment command and handle known errors.
+ *
+ * @param service - instance of the axios-extension deployment service
+ * @param config - deployment configuration
+ * @param logger - reference to the logger instance
+ */
+function tryUndeploy(service, config, logger) {
+    return __awaiter(this, void 0, void 0, function* () {
+        try {
+            yield service.undeploy({ bsp: config.app, testMode: config.test });
+            if (config.test === true) {
+                logger.info('Undeployment in TestMode completed. A successful TestMode execution does not necessarily mean that your undeploy will be successful.');
+            }
+            else {
+                logger.info('Successfully undeployed.');
+            }
+        }
+        catch (error) {
+            yield handleError("tryUndeploy" /* TryCommands.UnDeploy */, error, service, config, logger, Buffer.from(''));
         }
     });
 }
+/**
+ * Undeploy the given project from the given target using the given app name.
+ *
+ * @param config - deployment configuration
+ * @param logger - reference to the logger instance
+ */
+function undeploy(config, logger) {
+    return __awaiter(this, void 0, void 0, function* () {
+        yield runCommand("tryUndeploy" /* TryCommands.UnDeploy */, config, logger);
+    });
+}
 exports.undeploy = undeploy;
 //# sourceMappingURL=deploy.js.map

package/package.json

@@ -9,7 +9,7 @@
   "bugs": {
     "url": "https://github.com/SAP/open-ux-tools/issues?q=is%3Aopen+is%3Aissue+label%3Abug+label%3Adeploy-tooling"
   },
-  "version": "0.2.9",
+  "version": "0.2.10",
   "license": "Apache-2.0",
   "author": "@SAP/ux-tools-team",
   "main": "dist/index.js",
@@ -31,7 +31,7 @@
     "dotenv": "16.0.0",
     "prompts": "2.4.2",
     "yazl": "2.5.1",
-    "@sap-ux/axios-extension": "1.2.5",
+    "@sap-ux/axios-extension": "1.2.6",
     "@sap-ux/btp-utils": "0.11.5",
     "@sap-ux/logger": "0.3.5",
     "@sap-ux/store": "0.3.10",