@sap-ux/odata-service-inquirer 2.2.33 → 2.2.34

package/dist/prompts/datasources/sap-system/service-selection/service-helper.d.ts

@@ -46,6 +46,11 @@ type ValidateServiceResult = {
     hasAnnotations?: boolean;
     convertedMetadata?: ConvertedMetadata;
 };
+/**
+ * If we are validating a v2 service and do not have a catalog connection, we may still attempt to get the annotations but need a catalog.
+ * This scenario occurs for full/partial url destinations.
+ *
+ */
 /**
  * Requests and sets the service details to the PromptState.odataService properties.
  * If an error occurs, the error message is returned for use in validators.

package/dist/prompts/datasources/sap-system/service-selection/service-helper.js

@@ -135,16 +135,40 @@ function sendDestinationServiceSuccessTelemetryEvent(destination) {
     (0, inquirer_common_1.sendTelemetryEvent)(exports.telemEventBASServiceSuccess, telemetryData);
 }
 /**
- * Gets the service metadata and annotations for the specified service path.
+ * Gets the service metadata and annotations for the specified service path. Validate that the service metadata is of the required OData version.
+ * If a catalog service is provided, it will be used to get the annotations for the specified service path.
+ * If the catalog service is not provided and the metadata is OData version 2, a catalog service will be created using the axios config to get the annotations.
+ * Note this is a best effort attempt to get the annotations and may fail if the catalog service cannot be created.
  *
  * @param servicePath service path
  * @param odataService the odata service used to get the metadata for the specified service path
  * @param catalog the catalog service used to get the annotations for the specified service path
- * @returns Promise<string | boolean>, string error message or true if successful
+ * @param axiosConfig the axios config which may be used to create the catalog service, if not provided (for v2 services),
+ * @param requiredOdataVersion the required OData version used to validate the service
+ * @returns the service metadata and annotations
  */
-async function getServiceMetadata(servicePath, odataService, catalog) {
+async function getServiceMetadataAndValidate(servicePath, odataService, catalog, axiosConfig, requiredOdataVersion) {
     let annotations = [];
     try {
+        const metadata = await odataService.metadata();
+        const { validationMsg, version, convertedMetadata } = (0, validators_1.validateODataVersion)(metadata, requiredOdataVersion);
+        if (validationMsg) {
+            return { validationMsg };
+        }
+        // For non `odata_abap` (full/partial v2 urls) destinations we wont have a catalog defined, but the annotations may be available so we need to try or warn.
+        // Creation of the catalog service is a best effort and makes no assumptions about the existence of a real catalog service. The annotation call does not rely on it.
+        if (!catalog && version === odata_service_writer_1.OdataVersion.v2 && axiosConfig) {
+            try {
+                // Create an abap provider instance to get the annotations using the same request config
+                logger_helper_1.default.logger.debug('Creating a catalog service object for v2 service path to request annotations.');
+                const abapProvider = (0, axios_extension_1.createForAbap)(axiosConfig);
+                catalog = abapProvider.catalog(axios_extension_1.ODataVersion.v2);
+                logger_helper_1.default.attachAxiosLogger(catalog.interceptors);
+            }
+            catch (err) {
+                logger_helper_1.default.logger.warn((0, i18n_1.t)('error.v2CatalogServiceNoAnnotations', err));
+            }
+        }
         if (catalog) {
             try {
                 annotations = await catalog.getAnnotations({ path: servicePath });
@@ -153,15 +177,18 @@ async function getServiceMetadata(servicePath, odataService, catalog) {
                 logger_helper_1.default.logger.info((0, i18n_1.t)('prompts.validationMessages.noAnnotations'));
             }
         }
-        const metadata = await odataService.metadata();
         return {
             annotations,
-            metadata
+            metadata,
+            version,
+            convertedMetadata
         };
     }
     catch (error) {
         logger_helper_1.default.logger.error((0, i18n_1.t)('errors.serviceMetadataErrorLog', { servicePath, error }));
-        return (0, i18n_1.t)('errors.serviceMetadataErrorUI', { servicePath });
+        return {
+            validationMsg: (0, i18n_1.t)('errors.serviceMetadataErrorUI', { servicePath })
+        };
     }
 }
 /**
@@ -184,6 +211,11 @@ async function getServiceType(servicePath, serviceType, catalog) {
     }
     return resolvedServiceType ?? serviceType;
 }
+/**
+ * If we are validating a v2 service and do not have a catalog connection, we may still attempt to get the annotations but need a catalog.
+ * This scenario occurs for full/partial url destinations.
+ *
+ */
 /**
  * Requests and sets the service details to the PromptState.odataService properties.
  * If an error occurs, the error message is returned for use in validators.
@@ -204,11 +236,7 @@ async function validateService(service, connectionValidator, requiredOdataVersio
     if (!odataService) {
         odataService = connectionValidator.serviceProvider.service(service.servicePath);
     }
-    const serviceResult = await getServiceMetadata(service.servicePath, odataService, serviceCatalog);
-    if (typeof serviceResult === 'string') {
-        return { validationResult: serviceResult };
-    }
-    const { validationMsg, version, convertedMetadata } = (0, validators_1.validateODataVersion)(serviceResult.metadata, requiredOdataVersion);
+    const { validationMsg, version, convertedMetadata, annotations, metadata } = await getServiceMetadataAndValidate(service.servicePath, odataService, serviceCatalog, connectionValidator.axiosConfig, requiredOdataVersion);
     if (validationMsg) {
         return { validationResult: validationMsg };
     }
@@ -218,8 +246,8 @@ async function validateService(service, connectionValidator, requiredOdataVersio
     if (url) {
         origin = new URL(url).origin;
     }
-    utils_1.PromptState.odataService.annotations = serviceResult?.annotations;
-    utils_1.PromptState.odataService.metadata = serviceResult?.metadata;
+    utils_1.PromptState.odataService.annotations = annotations;
+    utils_1.PromptState.odataService.metadata = metadata;
     utils_1.PromptState.odataService.odataVersion =
         version ?? (service.serviceODataVersion === axios_extension_1.ODataVersion.v2 ? odata_service_writer_1.OdataVersion.v2 : odata_service_writer_1.OdataVersion.v4);
     utils_1.PromptState.odataService.servicePath = service.servicePath;

package/dist/translations/odata-service-inquirer.i18n.json

@@ -224,7 +224,8 @@
         "unparseableOdataVersion": "Unable to parse the odata version from the metadata.",
         "unparseableXML": "Unparseable XML was specified: {{-error}}",
         "noRelevantEntities": "The template and service selected have no relevant entities that you can use.",
-        "cfInstanceCredentialsNotReturned": "Could not retrieve credentials to access: {{serviceInstanceName}}"
+        "cfInstanceCredentialsNotReturned": "Could not retrieve credentials to access: {{serviceInstanceName}}",
+        "v2CatalogServiceNoAnnotations": "Error creating v2 catalog service object, annotations will not be available: {{-error}}"
     },
     "warnings": {
         "largeMetadataDocument": "The metadata for this OData service is significantly large. It may take some time before this operation completes."

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/odata-service-inquirer",
   "description": "Prompts module that can prompt users for inputs required for odata service writing",
-  "version": "2.2.33",
+  "version": "2.2.34",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -47,7 +47,7 @@
     "@types/lodash": "4.14.202",
     "jest-extended": "3.2.4",
     "@sap-ux/fiori-generator-shared": "0.10.2",
-    "@sap-ux/fiori-elements-writer": "2.1.38",
+    "@sap-ux/fiori-elements-writer": "2.1.40",
     "@sap-ux/fiori-freestyle-writer": "2.2.8",
     "@sap-ux/feature-toggle": "0.2.3",
     "@sap-ux/odata-service-writer": "0.26.13",