oci-common - npm Package Compare versions

Comparing version 2.79.0 to 2.79.1

index.d.ts

@@ -16,3 +16,3 @@ /**
 import { EndpointBuilder } from "./lib/endpoint-builder";
-import { LOG } from "./lib/log";
+import { logger } from "./lib/log";
 import Constants from "./lib/constants";
@@ -54,2 +54,2 @@ import CircuitBreaker from "./lib/circuit-breaker";
 export import Range = range.Range;
-export { Region, Realm, EndpointBuilder, DelayStrategy, TerminationStrategy, ExponentialBackoffDelayStrategy, MaxTimeTerminationStrategy, genericWaiter, genericTerminalConditionWaiter, WaiterConfiguration, RequireOnlyOne, AuthParams, paginateRecords, paginatedResponsesWithLimit, paginatedRecordsWithLimit, genericPaginateRecords, paginateResponses, genericPaginateResponses, Method, composeRequest, Params, composeResponse, HttpRequest, ConfigFileAuthenticationDetailsProvider, SessionAuthDetailProvider, ConfigFileReader, InstancePrincipalsAuthenticationDetailsProviderBuilder, ResourcePrincipalAuthenticationDetailsProvider, LOG, GenericRetrier, FixedTimeDelayStrategy, MaxAttemptsTerminationStrategy, RetryConfiguration, NoRetryConfigurationDetails, OciSdkDefaultRetryConfiguration, BaseRequest, ClientConfiguration, Constants, CircuitBreaker, getChunk, utils, OkeWorkloadIdentityAuthenticationDetailsProvider, developerToolConfiguration };
+export { Region, Realm, EndpointBuilder, DelayStrategy, TerminationStrategy, ExponentialBackoffDelayStrategy, MaxTimeTerminationStrategy, genericWaiter, genericTerminalConditionWaiter, WaiterConfiguration, RequireOnlyOne, AuthParams, paginateRecords, paginatedResponsesWithLimit, paginatedRecordsWithLimit, genericPaginateRecords, paginateResponses, genericPaginateResponses, Method, composeRequest, Params, composeResponse, HttpRequest, ConfigFileAuthenticationDetailsProvider, SessionAuthDetailProvider, ConfigFileReader, InstancePrincipalsAuthenticationDetailsProviderBuilder, ResourcePrincipalAuthenticationDetailsProvider, GenericRetrier, FixedTimeDelayStrategy, MaxAttemptsTerminationStrategy, RetryConfiguration, NoRetryConfigurationDetails, OciSdkDefaultRetryConfiguration, BaseRequest, ClientConfiguration, Constants, CircuitBreaker, getChunk, utils, OkeWorkloadIdentityAuthenticationDetailsProvider, developerToolConfiguration, logger };

index.js

@@ -29,3 +29,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.developerToolConfiguration = exports.OkeWorkloadIdentityAuthenticationDetailsProvider = exports.utils = exports.getChunk = exports.CircuitBreaker = exports.Constants = exports.OciSdkDefaultRetryConfiguration = exports.NoRetryConfigurationDetails = exports.MaxAttemptsTerminationStrategy = exports.FixedTimeDelayStrategy = exports.GenericRetrier = exports.LOG = exports.ResourcePrincipalAuthenticationDetailsProvider = exports.InstancePrincipalsAuthenticationDetailsProviderBuilder = exports.ConfigFileReader = exports.SessionAuthDetailProvider = exports.ConfigFileAuthenticationDetailsProvider = exports.composeResponse = exports.composeRequest = exports.genericPaginateResponses = exports.paginateResponses = exports.genericPaginateRecords = exports.paginatedRecordsWithLimit = exports.paginatedResponsesWithLimit = exports.paginateRecords = exports.genericTerminalConditionWaiter = exports.genericWaiter = exports.MaxTimeTerminationStrategy = exports.ExponentialBackoffDelayStrategy = exports.EndpointBuilder = exports.Realm = exports.Region = exports.Range = exports.byteLength = exports.ObjectSerializer = exports.convertStringToType = exports.handleErrorBody = exports.mapContainer = exports.handleErrorResponse = exports.getStringFromResponseBody = exports.DefaultRequestSigner = exports.OciError = exports.FetchHttpClient = exports.isRegionProvider = exports.SimpleAuthenticationDetailsProvider = void 0;
+exports.logger = exports.developerToolConfiguration = exports.OkeWorkloadIdentityAuthenticationDetailsProvider = exports.utils = exports.getChunk = exports.CircuitBreaker = exports.Constants = exports.OciSdkDefaultRetryConfiguration = exports.NoRetryConfigurationDetails = exports.MaxAttemptsTerminationStrategy = exports.FixedTimeDelayStrategy = exports.GenericRetrier = exports.ResourcePrincipalAuthenticationDetailsProvider = exports.InstancePrincipalsAuthenticationDetailsProviderBuilder = exports.ConfigFileReader = exports.SessionAuthDetailProvider = exports.ConfigFileAuthenticationDetailsProvider = exports.composeResponse = exports.composeRequest = exports.genericPaginateResponses = exports.paginateResponses = exports.genericPaginateRecords = exports.paginatedRecordsWithLimit = exports.paginatedResponsesWithLimit = exports.paginateRecords = exports.genericTerminalConditionWaiter = exports.genericWaiter = exports.MaxTimeTerminationStrategy = exports.ExponentialBackoffDelayStrategy = exports.EndpointBuilder = exports.Realm = exports.Region = exports.Range = exports.byteLength = exports.ObjectSerializer = exports.convertStringToType = exports.handleErrorBody = exports.mapContainer = exports.handleErrorResponse = exports.getStringFromResponseBody = exports.DefaultRequestSigner = exports.OciError = exports.FetchHttpClient = exports.isRegionProvider = exports.SimpleAuthenticationDetailsProvider = void 0;
 const auth = __importStar(require("./lib/auth/auth"));
@@ -47,3 +47,3 @@ const error = __importStar(require("./lib/error"));
 const log_1 = require("./lib/log");
-Object.defineProperty(exports, "LOG", { enumerable: true, get: function () { return log_1.LOG; } });
+Object.defineProperty(exports, "logger", { enumerable: true, get: function () { return log_1.logger; } });
 const constants_1 = __importDefault(require("./lib/constants"));
@@ -50,0 +50,0 @@ exports.Constants = constants_1.default;

lib/endpoint-builder.js

@@ -10,2 +10,3 @@ "use strict";
 const realm_1 = require("./realm");
+const log_1 = require("./log");
 class EndpointBuilder {
@@ -39,7 +40,7 @@ static createEndpointFromRegion(template, region, endpointServiceName, serviceEndpointTemplatePerRealm, useRealmSpecificEndpointTemplate) {
             if (serviceEndpointTemplatePerRealm[realmId]) {
-                console.log(`Using ${serviceEndpointTemplatePerRealm[realmId]} as the realm specific endpoint template`);
+                log_1.logger.info(`Using ${serviceEndpointTemplatePerRealm[realmId]} as the realm specific endpoint template`);
                 return serviceEndpointTemplatePerRealm[realmId];
             }
         }
-        console.log(`Realm specific endpoint template for realm ${realmId} does not exist. Falling back to endpoint template : ${defaultTemplate}`);
+        log_1.logger.info(`Realm specific endpoint template for realm ${realmId} does not exist. Falling back to endpoint template : ${defaultTemplate}`);
         return defaultTemplate;
@@ -46,0 +47,0 @@ }

lib/log.d.ts

@@ -5,7 +5,4 @@ /**
  */
-/**
- * An interface defines the logger related APIs.
- */
 export interface Logger {
-    level: string;
+    log(message?: any, ...optionalParams: any[]): void;
     debug(message?: any, ...optionalParams: any[]): void;
@@ -17,4 +14,15 @@ info(message?: any, ...optionalParams: any[]): void;
 }
-export declare module LOG {
-    var logger: Logger;
+declare class DefaultSdkLogger implements Logger {
+    private static instance;
+    private _logger;
+    private constructor();
+    static getInstance(): DefaultSdkLogger;
+    log(message: string): void;
+    debug(message: string): void;
+    info(message: string): void;
+    warn(message: string): void;
+    error(message: string): void;
+    trace(message: string): void;
 }
+export declare const logger: DefaultSdkLogger;
+export {};

lib/log.js

@@ -6,16 +6,60 @@ "use strict";
  */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.LOG = void 0;
-var LOG;
-(function (LOG) {
-    var _logger;
-    Object.defineProperty(LOG, "logger", {
-        get: function () {
-            return _logger;
-        },
-        set: function (log) {
-            _logger = log;
+exports.logger = void 0;
+/**
+ * An interface defines the logger related APIs.
+ */
+const bunyan = __importStar(require("bunyan"));
+class DefaultSdkLogger {
+    constructor() {
+        const useBunyan = process.env.USE_BUNYAN === "true";
+        this._logger = useBunyan
+            ? bunyan.createLogger({ name: "OCI TypeScript SDK default logger", level: "info" })
+            : console;
+    }
+    static getInstance() {
+        if (!DefaultSdkLogger.instance) {
+            DefaultSdkLogger.instance = new DefaultSdkLogger();
         }
-    });
-})(LOG = exports.LOG || (exports.LOG = {}));
+        return DefaultSdkLogger.instance;
+    }
+    log(message) {
+        console.log(message);
+    }
+    debug(message) {
+        this._logger.debug(message);
+    }
+    info(message) {
+        this._logger.info(message);
+    }
+    warn(message) {
+        this._logger.warn(message);
+    }
+    error(message) {
+        this._logger.error(message);
+    }
+    trace(message) {
+        this._logger.trace(message);
+    }
+}
+exports.logger = DefaultSdkLogger.getInstance();
 //# sourceMappingURL=log.js.map

lib/retrier.d.ts

@@ -9,3 +9,2 @@ /**
 import { OciError } from "..";
-import { Logger } from "./log";
 /**
@@ -36,3 +35,2 @@ * This class implements the retrier
     private _retryConfiguration;
-    private _logger;
     private static OPC_CLIENT_RETRIES_HEADER;
@@ -45,4 +43,2 @@ private static OCI_SDK_DEFAULT_RETRY_ENABLED;
     static set defaultRetryConfiguration(retryConfig: RetryConfiguration | null);
-    set logger(logger: Logger);
-    get logger(): Logger;
     get backUpBinaryBody(): boolean;
@@ -49,0 +45,0 @@ get retryConfiguration(): RetryConfigurationDetails;

lib/retrier.js

@@ -20,2 +20,3 @@ "use strict";
 const __1 = require("..");
+const log_1 = require("./log");
 const constants_1 = require("./constants");
@@ -48,2 +49,4 @@ const TROUBLESHOOT_URL = "https://docs.oracle.com/en-us/iaas/Content/API/Concepts/sdk_troubleshooting.htm";
 const OCI_SDK_DEFAULT_RETRY_MAXIMUM_DELAY_IN_SECONDS = 30;
+const CONTENT_TYPE_HEADER = "content-type";
+const SERVER_SIDE_EVENT_TEXT_STREAM = "text/event-stream";
 exports.NoRetryConfigurationDetails = {
@@ -63,3 +66,2 @@ terminationStrategy: new waiter_1.MaxAttemptsTerminationStrategy(NO_RETRY_MAXIMUM_NUMBER_OF_ATTEMPTS),
     constructor(retryConfiguration) {
-        this._logger = undefined;
         const preferredRetryConfig = Object.assign(Object.assign({}, exports.NoRetryConfigurationDetails), retryConfiguration);
@@ -84,8 +86,2 @@ this._retryConfiguration = preferredRetryConfig;
     }
-    set logger(logger) {
-        this._logger = logger;
-    }
-    get logger() {
-        return this._logger;
-    }
     get backUpBinaryBody() {
@@ -123,5 +119,3 @@ return this.retryConfiguration.backupBinaryBody;
             }
-            if (this.logger) {
-                this.logger.debug(`Retry policy to use: MaximumNumberAttempts=${maxAttempts}, MaxSleepBetween=${maxDelayInSeconds}, ExponentialBackoffBase=2`);
-            }
+            log_1.logger.debug(`Retry policy to use: MaximumNumberAttempts=${maxAttempts}, MaxSleepBetween=${maxDelayInSeconds}, ExponentialBackoffBase=2`);
             while (true) {
@@ -131,8 +125,11 @@ try {
                     const response = yield httpClient.send(request, excludeBody, targetService, operationName, timestamp.toISOString(), endpoint, apiReferenceLink);
-                    if (response.status && response.status >= 200 && response.status <= 299) {
+                    if (response.headers &&
+                        response.headers.get(CONTENT_TYPE_HEADER) === SERVER_SIDE_EVENT_TEXT_STREAM) {
+                        shouldBeRetried = false;
+                        lastKnownError = new Error("streaming mode is currently not supported. Please use non-streaming mode for this API instead");
+                    }
+                    else if (response.status && response.status >= 200 && response.status <= 299) {
                         const currentTime = new Date().getTime();
                         const timeElapsed = currentTime - timestamp.getTime();
-                        if (this.logger) {
-                            this.logger.debug(`Total Latency for this API call is: ${timeElapsed} ms`);
-                        }
+                        log_1.logger.debug(`Total Latency for this API call is: ${timeElapsed} ms`);
                         return response;
@@ -168,5 +165,3 @@ }
                     console.warn(`Request cannot be retried. Not Retrying. Exception occurred : ${lastKnownError}`);
-                    if (this.logger) {
-                        this.logger.debug(`Total Latency for this API call is: ${timeElapsed} ms`);
-                    }
+                    log_1.logger.debug(`Total Latency for this API call is: ${timeElapsed} ms`);
                     throw lastKnownError;
@@ -177,5 +172,3 @@ }
                         1}. Last exception occurred : ${lastKnownError}`);
-                    if (this.logger) {
-                        this.logger.debug(`Total Latency for this API call is: ${timeElapsed} ms`);
-                    }
+                    log_1.logger.debug(`Total Latency for this API call is: ${timeElapsed} ms`);
                     throw lastKnownError;
@@ -189,7 +182,5 @@ }
                 attempt += 1;
-                if (this.logger) {
-                    lastKnownError instanceof __1.OciError
-                        ? this.logger.debug(`Http Status Code: ${lastKnownError.statusCode}, Error Code: ${lastKnownError.serviceCode}, Attempt: ${attempt}`)
-                        : this.logger.debug(`Code: ${lastKnownError.code}, Message: ${lastKnownError.message}, Attempt: ${attempt}`);
-                }
+                lastKnownError instanceof __1.OciError
+                    ? log_1.logger.debug(`Http Status Code: ${lastKnownError.statusCode}, Error Code: ${lastKnownError.serviceCode}, Attempt: ${attempt}`)
+                    : log_1.logger.debug(`Code: ${lastKnownError.code}, Message: ${lastKnownError.message}, Attempt: ${attempt}`);
             }
@@ -196,0 +187,0 @@ });

package.json

 {
   "name": "oci-common",
-  "version": "2.79.0",
+  "version": "2.79.1",
   "description": "OCI Common module for NodeJS",
@@ -5,0 +5,0 @@ "repository": {

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Environment variable access

Supply chain risk

Package accesses environment variables, which may be a sign of credential stuffing or data theft.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

513288

increased by0.49%

Lines of code

6986

increased by0.58%

Worsened metrics

Number of low supply chain risk alerts

29

increased by3.57%

No dependency changes