fix(docdb): fix jscpd errors

Muzaffer Aydin · Muzaffer Aydin · commit b57b897a96e7 · 2025-01-09T18:53:30.000-08:00
diff --git a/packages/core/src/docdb/explorer/dbClusterNode.ts b/packages/core/src/docdb/explorer/dbClusterNode.ts
@@ -150,8 +150,8 @@ export class DBClusterNode extends DBResourceNode {
             getLogger().warn(`No cluster found for ARN: ${this.arn}`)
             return undefined
         }
-
         getLogger().debug(`Get Status: status ${cluster.Status} for cluster ${this.arn}`)
+
         this.cluster.Status = cluster.Status
         return cluster.Status
     }
diff --git a/packages/core/src/docdb/explorer/dbElasticClusterNode.ts b/packages/core/src/docdb/explorer/dbElasticClusterNode.ts
@@ -102,15 +102,14 @@ export class DBElasticClusterNode extends DBResourceNode {
 
     override refreshTree(): void {
         getLogger().debug(`(DBElasticClusterNode) Refreshing tree for instance: ${this.arn}`)
+
         this.refresh()
         this.parent.refresh()
     }
-
     override clearTimer(): void {
         this.pollingSet.delete(this.arn)
         this.pollingSet.clearTimer()
     }
-
     public override [inspect.custom](): string {
         return 'DBElasticClusterNode'
     }
diff --git a/packages/core/src/docdb/wizards/elasticClusterWizard.ts b/packages/core/src/docdb/wizards/elasticClusterWizard.ts
@@ -118,13 +118,13 @@ function createShardCapacityPrompter(title: string): Prompter<number> {
 
 function instanceCountItems(defaultCount: number, max: number = 16): DataQuickPickItem<number>[] {
     const items = []
-
     for (let index = 1; index <= max; index++) {
         const item: DataQuickPickItem<number> = {
             label: index.toString(),
             data: index,
             description: index === defaultCount ? '(recommended)' : undefined,
         }
+
         items.push(item)
     }
 
diff --git a/packages/core/src/test/docdb/commands/addRegion.test.ts b/packages/core/src/test/docdb/commands/addRegion.test.ts
@@ -80,13 +80,16 @@ describe('addRegionCommand', function () {
         const createGlobalClusterStub = sinon.stub().resolves({
             GlobalClusterIdentifier: globalClusterName,
         })
+
         const createClusterStub = sinon.stub().resolves({
             DBClusterIdentifier: clusterName,
         })
+
         const createInstanceStub = sinon.stub().resolves()
         docdb.createGlobalCluster = createGlobalClusterStub
         docdb.createCluster = createClusterStub
         docdb.createInstance = createInstanceStub
+
         setupWizard()
 
         // act
@@ -110,7 +113,6 @@ describe('addRegionCommand', function () {
                 })
             )
         )
-
         assert(
             createInstanceStub.calledOnceWith(
                 sinon.match({
@@ -175,7 +177,6 @@ describe('addRegionCommand', function () {
                 })
             )
         )
-
         sandbox.assert.calledWith(spyExecuteCommand, 'aws.refreshAwsExplorerNode', node)
 
         assertTelemetry('docdb_addRegion', { result: 'Succeeded' })
diff --git a/packages/core/src/test/docdb/commands/createCluster.test.ts b/packages/core/src/test/docdb/commands/createCluster.test.ts
@@ -14,8 +14,8 @@ import { createCluster } from '../../../docdb/commands/createCluster'
 
 describe('createClusterCommand', function () {
     const clusterName = 'docdb-1234'
-    const username = 'testuser'
-    const password = 'test-password'
+    const testUser = 'testuser'
+    const testPassword = 'test-password'
     let docdb: DocumentDBClient
     let node: DocumentDBNode
     let sandbox: sinon.SinonSandbox
@@ -43,17 +43,16 @@ describe('createClusterCommand', function () {
         getTestWindow().onDidShowInputBox((input) => {
             let value: string
             if (input.prompt?.includes('username')) {
-                value = username
+                value = testUser
             } else if (input.prompt?.includes('password')) {
-                value = password
+                value = testPassword
             } else if (input.prompt?.includes('cluster name')) {
                 value = clusterName
             } else {
                 value = ''
             }
             input.acceptValue(value)
         })
-
         getTestWindow().onDidShowQuickPick(async (picker) => {
             await picker.untilReady()
             picker.acceptItem(picker.items[0])
@@ -85,8 +84,8 @@ describe('createClusterCommand', function () {
                 Engine: 'docdb',
                 EngineVersion: 'test-version',
                 DBClusterIdentifier: clusterName,
-                MasterUsername: username,
-                MasterUserPassword: password,
+                MasterUsername: testUser,
+                MasterUserPassword: testPassword,
                 StorageEncrypted: true,
                 DBInstanceCount: 1,
                 DBInstanceClass: 'db.t3.medium',
diff --git a/packages/core/src/test/docdb/commands/createInstance.test.ts b/packages/core/src/test/docdb/commands/createInstance.test.ts
@@ -20,15 +20,17 @@ describe('createInstanceCommand', function () {
     let docdb: DocumentDBClient
     let cluster: DBCluster
     let node: DBClusterNode
-    let sandbox: sinon.SinonSandbox
     let spyExecuteCommand: sinon.SinonSpy
+    let sandbox: sinon.SinonSandbox
 
     beforeEach(function () {
         sandbox = sinon.createSandbox()
         spyExecuteCommand = sandbox.spy(vscode.commands, 'executeCommand')
 
         docdb = { regionCode: 'us-east-1' } as DocumentDBClient
+
         docdb.listInstances = sinon.stub().resolves([])
+
         docdb.listInstanceClassOptions = sinon
             .stub()
             .resolves([{ DBInstanceClass: 'db.t3.medium', StorageType: DBStorageType.Standard }])
@@ -42,7 +44,6 @@ describe('createInstanceCommand', function () {
         sandbox.restore()
         getTestWindow().dispose()
     })
-
     function setupWizard() {
         getTestWindow().onDidShowInputBox((input) => {
             input.acceptValue(instanceName)
diff --git a/packages/core/src/test/docdb/commands/deleteCluster.test.ts b/packages/core/src/test/docdb/commands/deleteCluster.test.ts
@@ -25,12 +25,10 @@ describe('deleteClusterCommand', function () {
         sandbox = sinon.createSandbox()
         spyExecuteCommand = sandbox.spy(vscode.commands, 'executeCommand')
     })
-
     afterEach(function () {
         sandbox.restore()
         getTestWindow().dispose()
     })
-
     function setupWizard() {
         getTestWindow().onDidShowInputBox((input) => {
             input.acceptValue(input.placeholder!)
@@ -93,34 +91,25 @@ describe('deleteClusterCommand', function () {
         })
 
         it('does nothing when prompt is cancelled', async function () {
-            // arrange
             const deleteClusterStub = sinon.stub()
             docdb.deleteCluster = deleteClusterStub
             getTestWindow().onDidShowQuickPick((picker) => picker.hide())
             getTestWindow().onDidShowInputBox((input) => input.hide())
 
-            // act
             await assert.rejects(deleteCluster(node))
-
-            // assert
             assert(deleteClusterStub.notCalled)
-
             assertTelemetry('docdb_deleteCluster', {
                 result: 'Cancelled',
             })
         })
 
         it('shows a warning when the cluster is stopped', async function () {
-            // arrange
             cluster.Status = 'stopped'
             const deleteClusterStub = sinon.stub()
             docdb.deleteCluster = deleteClusterStub
             setupWizard()
 
-            // act
             await assert.rejects(deleteCluster(node))
-
-            // assert
             getTestWindow()
                 .getFirstMessage()
                 .assertMessage(/Cluster must be running/)
@@ -131,15 +120,12 @@ describe('deleteClusterCommand', function () {
         })
 
         it('shows an error when cluster deletion fails', async function () {
-            // arrange
             const deleteClusterStub = sinon.stub().rejects()
             docdb.deleteCluster = deleteClusterStub
             setupWizard()
 
-            // act
             await assert.rejects(deleteCluster(node))
 
-            // assert
             getTestWindow()
                 .getFirstMessage()
                 .assertError(/Failed to delete cluster: test-cluster/)
@@ -156,7 +142,6 @@ describe('deleteClusterCommand', function () {
 
         beforeEach(function () {
             cluster = { clusterName, clusterArn: 'arn:test-cluster', status: 'ACTIVE' }
-
             docdb = { regionCode: 'us-east-1' } as DocumentDBClient
             docdb.listElasticClusters = sinon.stub().resolves([cluster])
 
diff --git a/packages/core/src/test/docdb/commands/deleteInstance.test.ts b/packages/core/src/test/docdb/commands/deleteInstance.test.ts
@@ -21,15 +21,13 @@ describe('deleteInstanceCommand', function () {
     let instance: DBInstance
     let parentNode: DBClusterNode
     let node: DBInstanceNode
-    let sandbox: sinon.SinonSandbox
     let spyExecuteCommand: sinon.SinonSpy
+    let sandbox: sinon.SinonSandbox
 
     beforeEach(function () {
         sandbox = sinon.createSandbox()
         spyExecuteCommand = sandbox.spy(vscode.commands, 'executeCommand')
-
         docdb = { regionCode: 'us-east-1' } as DocumentDBClient
-
         cluster = { Status: 'available' }
         instance = {
             DBInstanceIdentifier: instanceName,
@@ -39,12 +37,10 @@ describe('deleteInstanceCommand', function () {
         parentNode = new DBClusterNode(undefined!, cluster, docdb)
         node = new DBInstanceNode(parentNode, instance)
     })
-
     afterEach(function () {
         sandbox.restore()
         getTestWindow().dispose()
     })
-
     function setupWizard() {
         getTestWindow().onDidShowInputBox((input) => {
             input.acceptValue(instanceName)
diff --git a/packages/core/src/test/docdb/commands/renameCluster.test.ts b/packages/core/src/test/docdb/commands/renameCluster.test.ts
@@ -18,10 +18,10 @@ describe('renameClusterCommand', function () {
     const clusterName = 'test-cluster'
     const newClusterName = 'new-cluster-name'
     let docdb: DocumentDBClient
+    let spyExecuteCommand: sinon.SinonSpy
     let cluster: DBCluster
     let node: DBClusterNode
     let sandbox: sinon.SinonSandbox
-    let spyExecuteCommand: sinon.SinonSpy
 
     beforeEach(function () {
         sandbox = sinon.createSandbox()
diff --git a/packages/core/src/test/docdb/explorer/dbClusterNode.test.ts b/packages/core/src/test/docdb/explorer/dbClusterNode.test.ts
@@ -80,30 +80,33 @@ describe('DBClusterNode', function () {
         trackChangesSpy.restore()
     })
 
-    it('does not start tracking changes when status does not require polling', function () {
-        const clusterStatus = { ...cluster, Status: 'available' }
+    function assertNodeDoesNotPoll(clusterStatus: any, message: string) {
         const trackChangesSpy = sinon.spy(DBClusterNode.prototype, 'trackChanges')
         const node = new DBClusterNode(parentNode, clusterStatus, mockClient)
         const requiresPolling = node.isStatusRequiringPolling()
 
-        assert.strictEqual(requiresPolling, false, 'isStatusRequiringPolling should return false for available status')
-        assert.ok(trackChangesSpy.notCalled, 'trackChanges should not be called when polling is not required')
-        assert.strictEqual(node.isPolling, false, 'Node should not be in polling state')
+        assert.strictEqual(
+            requiresPolling,
+            false,
+            `${message}: isStatusRequiringPolling should return false for available status`
+        )
+        assert.ok(
+            trackChangesSpy.notCalled,
+            `${message}: trackChanges should not be called when polling is not required`
+        )
+        assert.strictEqual(node.isPolling, false, `${message}: Node should not be in polling state`)
 
         trackChangesSpy.restore()
+    }
+
+    it('does not start tracking changes when status does not require polling', function () {
+        const clusterStatus = { ...cluster, Status: 'available' }
+        assertNodeDoesNotPoll(clusterStatus, 'does not start tracking changes')
     })
 
     it('does not poll when status is available', function () {
         const clusterStatus = { ...cluster, Status: 'available' }
-        const trackChangesSpy = sinon.spy(DBClusterNode.prototype, 'trackChanges')
-        const node = new DBClusterNode(parentNode, clusterStatus, mockClient)
-        const requiresPolling = node.isStatusRequiringPolling()
-
-        assert.strictEqual(requiresPolling, false, 'isStatusRequiringPolling should return false for available status')
-        assert.ok(trackChangesSpy.notCalled, 'trackChanges should not be called when polling is not required')
-        assert.strictEqual(node.isPolling, false, 'Node should not be in polling state')
-
-        trackChangesSpy.restore()
+        assertNodeDoesNotPoll(clusterStatus, 'does not poll')
     })
 
     it('has isPolling set to false and getStatus returns available when status is available', async function () {
diff --git a/packages/core/src/test/shared/clients/defaultDocdbClient.test.ts b/packages/core/src/test/shared/clients/defaultDocdbClient.test.ts
@@ -38,7 +38,7 @@ describe('DefaultDocumentDBClient', function () {
             assert(sdkStub.calledOnce)
         })
 
-        it('throws an Error on failure', async function () {
+        it('throws an Error during listing clusters on failure', async function () {
             const client = createClient()
             client.getClient = sinon.stub().resolves({
                 send: sinon.stub().throws(),
@@ -58,7 +58,7 @@ describe('DefaultDocumentDBClient', function () {
             assert(sdkStub.calledOnce)
         })
 
-        it('throws an Error on failure', async function () {
+        it('throws an Error during listing instances on failure', async function () {
             const client = createClient()
             client.getClient = sinon.stub().resolves({
                 send: sinon.stub().throws(),

Original file line number	Diff line number	Diff line change
`@@ -150,8 +150,8 @@ export class DBClusterNode extends DBResourceNode {`
`150`	`150`	getLogger().warn(`No cluster found for ARN: ${this.arn}`)
`151`	`151`	`return undefined`
`152`	`152`	`}`
`153`		`-`
`154`	`153`	getLogger().debug(`Get Status: status ${cluster.Status} for cluster ${this.arn}`)
	`154`	`+`
`155`	`155`	`this.cluster.Status = cluster.Status`
`156`	`156`	`return cluster.Status`
`157`	`157`	`}`
Original file line number	Diff line number	Diff line change
`@@ -102,15 +102,14 @@ export class DBElasticClusterNode extends DBResourceNode {`
`102`	`102`
`103`	`103`	`override refreshTree(): void {`
`104`	`104`	getLogger().debug(`(DBElasticClusterNode) Refreshing tree for instance: ${this.arn}`)
	`105`	`+`
`105`	`106`	`this.refresh()`
`106`	`107`	`this.parent.refresh()`
`107`	`108`	`}`
`108`		`-`
`109`	`109`	`override clearTimer(): void {`
`110`	`110`	`this.pollingSet.delete(this.arn)`
`111`	`111`	`this.pollingSet.clearTimer()`
`112`	`112`	`}`
`113`		`-`
`114`	`113`	`public override [inspect.custom](): string {`
`115`	`114`	`return 'DBElasticClusterNode'`
`116`	`115`	`}`
Original file line number	Diff line number	Diff line change
`@@ -118,13 +118,13 @@ function createShardCapacityPrompter(title: string): Prompter<number> {`
`118`	`118`
`119`	`119`	`function instanceCountItems(defaultCount: number, max: number = 16): DataQuickPickItem<number>[] {`
`120`	`120`	`const items = []`
`121`		`-`
`122`	`121`	`for (let index = 1; index <= max; index++) {`
`123`	`122`	`const item: DataQuickPickItem<number> = {`
`124`	`123`	`label: index.toString(),`
`125`	`124`	`data: index,`
`126`	`125`	`description: index === defaultCount ? '(recommended)' : undefined,`
`127`	`126`	`}`
	`127`	`+`
`128`	`128`	`items.push(item)`
`129`	`129`	`}`
`130`	`130`