neo4j / neo4j/aura-cli

Should we return all of the instance details when changing its configuration or status?

Open
#57 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
19
Forks
10
Avg merge
6d 9h
Merged PRs (30d)
6

Description

When changing an instances configuration or status, we return entire instance configuration. E.g

aura instance update 74fdfdba --memory 16GB

{
	"data": {
		"cdc_enrichment_mode": "OFF",
		"cloud_provider": "gcp",
		"connection_url": "neo4j+s://74fdfdba.databases.neo4j.io",
		"id": "74fdfdba",
		"memory": "8GB",
		"metrics_integration_url": "https://customer-metrics-api.neo4j.io/api/v1/ad69ee24-25fc-5a66-af02-ff8d3cc23611/74fdfdba/metrics",
		"name": "[JG]CLI]\n",
		"region": "europe-west1",
		"secondaries_count": 0,
		"status": "resizing",
		"storage": "16GB",
		"tenant_id": "ad69ee24-25fc-5a66-af02-ff8d3cc23611",
		"type": "enterprise-db"
	}
}

In this particular case, returning all of the information can cause confusion as the memory still shows the old value of 8gb rather than the new 16gb. The new value will only be shown when the resizing operation is completed.

When an instance is configuration is changed, paused or resumed, we should only return the 'status' value to the end user with the CLI ( yes the aura API returns way more, but we don't need to show that ).

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing the CLI commands for instance configuration changes, pause, and resume, using the aura instance update 74fdfdba --memory 16GB example as the behavior to reproduce. Check how their responses are formatted and change the CLI output so these operations expose only the instance status; verify that the updated status is shown without presenting stale configuration values.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
cli
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.