Customize partition key validation rule for Gremlin DB (#2184)

microsoft · Sep 21, 2023 · 9bbf104 · 9bbf104
1 parent 10fd538
commit 9bbf104
Show file tree

Hide file tree

Showing 2 changed files with 47 additions and 15 deletions.
diff --git a/src/docdb/tree/DocDBDatabaseTreeItemBase.ts b/src/docdb/tree/DocDBDatabaseTreeItemBase.ts
@@ -77,16 +77,7 @@ export abstract class DocDBDatabaseTreeItemBase extends DocDBTreeItemBase<Contai
             id: containerName
         };
 
-        let partitionKey: string | undefined = await context.ui.showInputBox({
-            prompt: 'Enter the partition key for the collection, or leave blank for fixed size.',
-            stepName: 'partitionKeyForCollection',
-            validateInput: validatePartitionKey,
-            placeHolder: 'e.g. address/zipCode'
-        });
-
-        if (partitionKey && partitionKey.length && partitionKey[0] !== '/') {
-            partitionKey = '/' + partitionKey;
-        }
+        const partitionKey = await this.getNewPartitionKey(context);
         if (partitionKey) {
             containerDefinition.partitionKey = {
                 paths: [partitionKey]
@@ -113,13 +104,28 @@ export abstract class DocDBDatabaseTreeItemBase extends DocDBTreeItemBase<Contai
 
         return this.initChild(nonNullProp(container, 'resource'));
     }
-}
 
-function validatePartitionKey(key: string): string | undefined | null {
-    if (/[#?\\]/.test(key)) {
-        return "Cannot contain these characters: ?,#,\\, etc.";
+    protected async getNewPartitionKey(context: IActionContext): Promise<string | undefined> {
+        let partitionKey: string | undefined = await context.ui.showInputBox({
+            prompt: 'Enter the partition key for the collection, or leave blank for fixed size.',
+            stepName: 'partitionKeyForCollection',
+            validateInput: this.validatePartitionKey,
+            placeHolder: 'e.g. /address/zipCode'
+        });
+
+        if (partitionKey && partitionKey.length && partitionKey[0] !== '/') {
+            partitionKey = '/' + partitionKey;
+        }
+
+        return partitionKey;
+    }
+
+    protected validatePartitionKey(key: string): string | undefined {
+        if (/[#?\\]/.test(key)) {
+            return "Cannot contain these characters: ?,#,\\, etc.";
+        }
+        return undefined;
     }
-    return undefined;
 }
 
 function validateThroughput(isFixed: boolean, input: string): string | undefined | null {

diff --git a/src/graph/tree/GraphDatabaseTreeItem.ts b/src/graph/tree/GraphDatabaseTreeItem.ts
@@ -4,6 +4,7 @@
  *--------------------------------------------------------------------------------------------*/
 
 import { ContainerDefinition, CosmosClient, Database, DatabaseDefinition, Resource } from '@azure/cosmos';
+import { IActionContext } from '@microsoft/vscode-azext-utils';
 import { DocDBDatabaseTreeItemBase } from '../../docdb/tree/DocDBDatabaseTreeItemBase';
 import { IGremlinEndpoint } from '../../vscode-cosmosdbgraph.api';
 import { getPossibleGremlinEndpoints } from '../gremlinEndpoints';
@@ -36,4 +37,29 @@ export class GraphDatabaseTreeItem extends DocDBDatabaseTreeItemBase {
         return client.database(this.id);
 
     }
+
+    protected override async getNewPartitionKey(context: IActionContext): Promise<string | undefined> {
+        let partitionKey: string | undefined = await context.ui.showInputBox({
+            prompt: 'Enter the partition key for the collection, or leave blank for fixed size.',
+            stepName: 'partitionKeyForCollection',
+            validateInput: this.validatePartitionKey,
+            placeHolder: 'e.g. /address'
+        });
+
+        if (partitionKey && partitionKey.length && partitionKey[0] !== '/') {
+            partitionKey = '/' + partitionKey;
+        }
+
+        return partitionKey;
+    }
+
+    protected validatePartitionKey(key: string): string | undefined {
+        if (/[#?\\]/.test(key)) {
+            return "Cannot contain these characters: ?,#,\\, etc.";
+        }
+        if (/.+\//.test(key)) {
+            return "Cannot be a nested path";
+        }
+        return undefined;
+    }
 }