danitseitlin / redis-cloud-api-sdk

Redis Cloud API SDK

💫 About Me:

A passionate coder with motivation to create

At least a cup of coffee per 20 lines of code ☕

💻 Tech Stack:

📊 GitHub Stats:

✍️ Random Dev Quote

---

redis-cloud-api-sdk's Issues

Add testing to determine schema changes in the API

Get a DB password is not supported

It will help to add the DB password to the db properties (when running the getDatabase call)

Version: 1.1.6

Split 'General' API's to seperate files

Deprecate and publish new package name

Rename the NPM package name to redis-cloud-api-sdk and deprecate rl-cloud-api-sdk

Add 'Subscription' type to index.d.ts

In order to get a subscription properties after using getSubscription() function, it will be helpful to have the type Subscription on the index.t.ts file.

Can't run updateDatabase on ROF cluster

Can't run updateDatabase on ROF cluster.

Steps:

1. created a gcp rof subscription with 50gb and 5k ops/sec, replication enabled2
2. Use the updateDatabase call with the following update params:
   dbGcpPreUpgradeUpdatedParameters = { memoryLimitInGb: 70, throughputMeasurement: { by: 'operations-per-second', value: 4000 }, supportOSSClusterApi: true, useExternalEndpointForOSSClusterApi: true, replication: false }
3. get the following:
   Request failed: 400, error_code: invalid_plan_request - average_value_size is required in ROF plans RCP_GKE_rcp-testing2_qa2 qa2.web-6ccc95bfd5-xhx4h [22/Mar/2021:17:19:46 +
   The average_value_size property isn't supported.

Version 1.1.6

Add 'wait for all database under subscription to be active' function

It will help if the Api will include the function- wait for all databases under subscription to be active.
(for a scenarios when the subscription is active but the databases are still pending)

Add API for users

Adding dynamic req function

Add ability to fetch and verify apis count to easily follow up on new endpoints

Use API endpoint https://api.redislabs.com/v1/v2/api-docs?group=Redis Labs Cloud API - Version 1

Add DatabaseStatus 'Sync'

In order to make the function: waitForDatabaseStatus
More accurate, will be helpful to add the status 'synced' of a database to DatabaseStatus.
(So the expected status could be synced)

Add waitingForAllSubscriptionsToReachState(x) function

It's might be a good idea to add -
wait for all subscriptions to reach state X

Adding TSDocs + Automatic deployment

Upgrade NPM packages

[Database APIs] Move all core code of database api related functions to seperate file.

Reference to existing PR
What needs to be done:

1. Copy all functions as is into a file called databases.ts, with a constructor that receives an Axios instance (client)
2. Update all usages in the database api related functions to use the ones from the new file.

[Subscription APIs] Move all core code of subscription api related functions to seperate file

Reference to existing PR
What needs to be done:

1. Copy all functions as is into a file called subscriptions.ts, with a constructor that receives an Axios instance (client)
2. Update all usages in the subscription api related functions to use the ones from the new file.

Add comparison between API endpoints to existing functions

Add a table to the README comparing between API endpoints and the functions relevant to them in the SDK

Database Creation: 'value' property under ThroughputMeasurement is doubled

Actual behavior
On Database type, we have the following property:
throughputMeasurement?: { by: DatabaseThroughputMeasurement; value: number; };
And DatabaseThroughputMeasurement is:
export declare type DatabaseThroughputMeasurement = { by: 'number-of-shards' | 'operations-per-second'; value: number; [key: string]: any; };
Which means we should add the value twice.

Expected behavior
The value type will appear one time under ThroughputMeasurement.

Implement deploy bot

We should implement a deploy bot using the npm-package-deployer for deployment on commit into the master branch.

Add support for AA API's

Functions in api/task.ts return an instance of the class instead of Type

Possible fix:
rename type Task to type TaskObject in types/task.ts

Wait for all subscription function

Description:
Missing a function: wait for all subscription's databases.

Expected behavior:
When waiting for a databases to be active status, we need to get each db uid, and then wait for the db status to be active. which can fail if we don't get the db id. also, it's a messy way.

rl-cloud-api-sdk version: 1.2.2

Additional context
Example for a code that can be failed:
await cloudApiSdk.waitForSubscriptionStatus(awsRorPreUpgradeClusterId, 'active') console.debug('The provisioning of \'Aws-Ror-Pre-Upgrade\' is successfully finished') await cloudApiSdk.waitForSubscriptionStatus(gcpRofPreUpgradeClusterId, 'active') console.debug('The provisioning of \'Gcp-Rof-Pre-Upgrade\' is successfully finished') awsPreUpgradeDatabaseId = (await cloudApiSdk.getDatabases(awsRorPreUpgradeClusterId))[0].databaseId gcpPreUpgradeDatabaseId = (await cloudApiSdk.getDatabases(gcpRofPreUpgradeClusterId))[0].databaseId await cloudApiSdk.waitForDatabaseStatus(awsRorPreUpgradeClusterId, awsPreUpgradeDatabaseId, 'active') await cloudApiSdk.waitForDatabaseStatus(gcpRofPreUpgradeClusterId, gcpPreUpgradeDatabaseId, 'active')
(If we don't get the DB ID this code will fail)