Merge pull request #27 from oracle/release_2020-10-13

Releasing version 1.6.0

Author: waruwaruwaru

CHANGELOG.md

@@ -3,6 +3,20 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/).
 
+## 1.6.0 - 2020-10-13
+### Added
+- Support for API definitions in the API Gateway service
+- Support for pattern-based logical entities, namespace-bound custom properties, and faceted search in the Data Catalog service
+- Support for autonomous Data Guard on autonomous infrastructure in the Database service
+- Support for creating a Data Guard association on an existing standby database home in the Database service
+- Support for upgrading cloud VM cluster grid infrastructure in the Database service
+- Support for Circuit Breakers
+
+
+### Breaking
+- Attribute `isQuickStart` in models `CreateLogSavedSearchDetails`, `LogSavedSearchSummary`,`UpdateLogSavedSearchDetails` and `LogSavedSearch` is removed from the Logging Management service
+- Lifecycle State `DELETED` is removed from the Logging Management service
+
 ## 1.5.7 - 2020-10-06
 ### Added
 - Support for calling Oracle Cloud Infrastructure services in the me-dubai-1 region

examples/javascript/circuit-breaker.js

@@ -0,0 +1,63 @@
+/**
+ * Copyright (c) 2020, Oracle and/or its affiliates.  All rights reserved.
+ * This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
+ */
+
+const common = require("oci-common");
+const identity = require("oci-identity");
+const audit = require("oci-audit");
+const configurationFilePath = "~/.oci/config";
+const configProfile = "DEFAULT";
+
+/* This script demostrates how to create a circuit breaker and share the circuit breaker among clients.
+ */
+const provider = new common.ConfigFileAuthenticationDetailsProvider(
+  configurationFilePath,
+  configProfile
+);
+const compartmentId = provider.getTenantId();
+
+(async () => {
+  // Options for creating a circuit breaker
+  const options = {
+    timeout: 10000, // If our function takes longer than 10 seconds, trigger a failure
+    errorThresholdPercentage: 50, // When 50% of requests fail, trip the circuit
+    resetTimeout: 30000 // After 30 seconds, try again.
+  };
+  const clientConfiguration = {
+    circuitBreaker: new common.CircuitBreaker(options)
+  };
+  // Use the circuitBreaker to create identity client
+  const identityClient = new identity.IdentityClient(
+    { authenticationDetailsProvider: provider },
+    clientConfiguration
+  );
+
+  // Share the same circuitBreaker to create audit client.
+  const auditClient = new audit.AuditClient(
+    { authenticationDetailsProvider: provider },
+    clientConfiguration
+  );
+
+  let listUserReq = {
+    compartmentId: compartmentId
+  };
+
+  const response = await identityClient.listUsers(listUserReq);
+  console.log("List User Repsonse: ", response);
+
+  const endTime = new Date();
+  const offset = new Date().setDate(new Date().getDate() - 5);
+  const startTime = new Date(offset);
+  const listEventRequest = {
+    compartmentId: compartmentId,
+    startTime: startTime,
+    endTime: endTime
+  };
+  try {
+    const listEventResponse = await auditClient.listEvents(listEventRequest);
+    console.log("response: ", listEventResponse);
+  } catch (err) {
+    console.log("what is err: ", err);
+  }
+})();

examples/typescript/circuit-breaker.ts

@@ -0,0 +1,66 @@
+/**
+ * Copyright (c) 2020, Oracle and/or its affiliates.  All rights reserved.
+ * This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
+ */
+
+import common = require("oci-common");
+import * as identity from "oci-identity";
+import * as audit from "oci-audit";
+
+const configurationFilePath = "~/.oci/config";
+const configProfile = "DEFAULT";
+
+/* This script demostrates how to create a circuit breaker and share the circuit breaker among clients.
+ */
+const provider: common.ConfigFileAuthenticationDetailsProvider = new common.ConfigFileAuthenticationDetailsProvider(
+  configurationFilePath,
+  configProfile
+);
+const compartmentId = provider.getTenantId();
+
+(async () => {
+  // Options for creating a circuit breaker
+  const options = {
+    timeout: 10000, // If our function takes longer than 10 seconds, trigger a failure
+    errorThresholdPercentage: 50, // When 50% of requests fail, trip the circuit
+    resetTimeout: 30000 // After 30 seconds, try again.
+  };
+  const clientConfiguration = {
+    circuitBreaker: new common.CircuitBreaker(options)
+  };
+
+  // Use the circuitBreaker to create identity client
+  const identityClient = new identity.IdentityClient(
+    { authenticationDetailsProvider: provider },
+    clientConfiguration
+  );
+
+  // Share the same circuitBreaker to create audit client.
+  const auditClient = new audit.AuditClient(
+    { authenticationDetailsProvider: provider },
+    clientConfiguration
+  );
+
+  let listUserReq: identity.requests.ListUsersRequest;
+  listUserReq = {
+    compartmentId: compartmentId
+  };
+
+  const response = await identityClient.listUsers(listUserReq);
+  console.log("List User Repsonse: ", response);
+
+  const endTime: Date = new Date();
+  const offset = new Date().setDate(new Date().getDate() - 5);
+  const startTime: Date = new Date(offset);
+  const listEventRequest: audit.requests.ListEventsRequest = {
+    compartmentId: compartmentId,
+    startTime: startTime,
+    endTime: endTime
+  };
+  try {
+    const listEventResponse = await auditClient.listEvents(listEventRequest);
+    console.log("response: ", listEventResponse);
+  } catch (err) {
+    console.log("what is err: ", err);
+  }
+})();

lib/analytics/lib/client.ts

@@ -32,14 +32,22 @@ export class AnalyticsClient {
   protected "_defaultHeaders": any = {};
   protected "_waiters": AnalyticsWaiter;
   protected "_clientConfiguration": common.ClientConfiguration;
+  protected _circuitBreaker = null;
 
   protected _httpClient: common.HttpClient;
 
-  constructor(params: common.AuthParams) {
+  constructor(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration) {
     const requestSigner = params.authenticationDetailsProvider
       ? new common.DefaultRequestSigner(params.authenticationDetailsProvider)
       : null;
-    this._httpClient = params.httpClient || new common.FetchHttpClient(requestSigner);
+    if (clientConfiguration) {
+      this._clientConfiguration = clientConfiguration;
+      this._circuitBreaker = clientConfiguration.circuitBreaker
+        ? clientConfiguration.circuitBreaker!.circuit
+        : null;
+    }
+    this._httpClient =
+      params.httpClient || new common.FetchHttpClient(requestSigner, this._circuitBreaker);
 
     if (
       params.authenticationDetailsProvider &&
@@ -123,13 +131,6 @@ export class AnalyticsClient {
     throw Error("Waiters do not exist. Please create waiters.");
   }
 
-  /**
-   * Sets the client configuration for the client
-   */
-  public set clientConfiguration(clientConfiguration: common.ClientConfiguration) {
-    this._clientConfiguration = clientConfiguration;
-  }
-
   /**
    * Change the compartment of an Analytics instance. The operation is long-running
    * and creates a new WorkRequest.

lib/analytics/package.json

@@ -1,6 +1,6 @@
 {
   "name": "oci-analytics",
-  "version": "1.5.7",
+  "version": "1.6.0",
   "description": "OCI NodeJS client for Analytics Service",
   "repository": {
     "type": "git",

lib/announcementsservice/lib/client.ts

@@ -28,14 +28,22 @@ export class AnnouncementClient {
   protected "_endpoint": string = "";
   protected "_defaultHeaders": any = {};
   protected "_clientConfiguration": common.ClientConfiguration;
+  protected _circuitBreaker = null;
 
   protected _httpClient: common.HttpClient;
 
-  constructor(params: common.AuthParams) {
+  constructor(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration) {
     const requestSigner = params.authenticationDetailsProvider
       ? new common.DefaultRequestSigner(params.authenticationDetailsProvider)
       : null;
-    this._httpClient = params.httpClient || new common.FetchHttpClient(requestSigner);
+    if (clientConfiguration) {
+      this._clientConfiguration = clientConfiguration;
+      this._circuitBreaker = clientConfiguration.circuitBreaker
+        ? clientConfiguration.circuitBreaker!.circuit
+        : null;
+    }
+    this._httpClient =
+      params.httpClient || new common.FetchHttpClient(requestSigner, this._circuitBreaker);
 
     if (
       params.authenticationDetailsProvider &&
@@ -96,13 +104,6 @@ export class AnnouncementClient {
     );
   }
 
-  /**
-   * Sets the client configuration for the client
-   */
-  public set clientConfiguration(clientConfiguration: common.ClientConfiguration) {
-    this._clientConfiguration = clientConfiguration;
-  }
-
   /**
    * Gets the details of a specific announcement.
    *

lib/announcementsservice/package.json

@@ -1,6 +1,6 @@
 {
   "name": "oci-announcementsservice",
-  "version": "1.5.7",
+  "version": "1.6.0",
   "description": "OCI NodeJS client for Announcement Service",
   "repository": {
     "type": "git",

lib/apigateway/lib/apigateway-waiter.ts

@@ -26,6 +26,25 @@ export class ApiGatewayWaiter {
     private readonly config?: WaiterConfiguration
   ) {}
 
+  /**
+   * Waits forApi till it reaches any of the provided states
+   *
+   * @param request the request to send
+   * @param targetStates the desired states to wait for. The waiter will return once the resource reaches any of the provided states
+   * @return response returns GetApiResponse | null (null in case of 404 response)
+   */
+  public async forApi(
+    request: serviceRequests.GetApiRequest,
+    ...targetStates: models.Api.LifecycleState[]
+  ): Promise<serviceResponses.GetApiResponse | null> {
+    return genericTerminalConditionWaiter(
+      this.config,
+      () => this.client.getApi(request),
+      response => targetStates.exists(response.api.lifecycleState),
+      targetStates.includes(models.Api.LifecycleState.Deleted)
+    );
+  }
+
   /**
    * Waits forCertificate till it reaches any of the provided states
    *