feat(deploy): split cluster changes into keyspace and access changes

Author: JesusTheHun

packages/deploy/src/clusterChanges/getCouchbaseClusterChanges.ts

@@ -29,21 +29,15 @@ import {
 } from './types.js';
 
 /**
- * Return the changes required to meet the nextConfig, given the currentConfig.
- * All changes are given in the order they should be applied, in order to minimize operational risks.
- *
- * @param currentConfig
- * @param nextConfig
+ * Return the keyspace changes (buckets, scopes, collections, indexes) required
+ * to meet the nextConfig, given the currentConfig.
  */
-export function getCouchbaseClusterChanges(
+export function getCouchbaseKeyspaceChanges(
   currentConfig: Partial<CouchbaseClusterConfig>,
   nextConfig: Partial<CouchbaseClusterConfig>
 ): CouchbaseClusterChange[] {
   const changes: CouchbaseClusterChange[] = [];
 
-  ///////////////
-  // KEYSPACES //
-  ///////////////
   const currentKeyspaceConfig = currentConfig.keyspaces ?? {};
   const nextKeyspaceConfig = nextConfig.keyspaces ?? {};
 
@@ -147,19 +141,42 @@ export function getCouchbaseClusterChanges(
     );
   });
 
-  ///////////
-  // USERS //
-  ///////////
+  return changes;
+}
+
+/**
+ * Return the access changes (users, and later roles) required
+ * to meet the nextConfig, given the currentConfig.
+ */
+export function getCouchbaseAccessChanges(
+  currentConfig: Partial<CouchbaseClusterConfig>,
+  nextConfig: Partial<CouchbaseClusterConfig>
+): CouchbaseClusterChange[] {
   const currentUsersConfig = currentConfig.users ?? [];
   const nextUsersConfig = nextConfig.users ?? [];
 
   const newUsers = getNewUsers(currentUsersConfig, nextUsersConfig);
   const updatedUsers = getUpdatedUsers(currentUsersConfig, nextUsersConfig);
   const obsoleteUsers = getObsoleteUsers(currentUsersConfig, nextUsersConfig);
 
-  changes.push(...newUsers, ...updatedUsers, ...obsoleteUsers);
+  return [...newUsers, ...updatedUsers, ...obsoleteUsers];
+}
 
-  return changes;
+/**
+ * Return all changes required to meet the nextConfig, given the currentConfig.
+ * All changes are given in the order they should be applied, in order to minimize operational risks.
+ *
+ * @param currentConfig
+ * @param nextConfig
+ */
+export function getCouchbaseClusterChanges(
+  currentConfig: Partial<CouchbaseClusterConfig>,
+  nextConfig: Partial<CouchbaseClusterConfig>
+): CouchbaseClusterChange[] {
+  return [
+    ...getCouchbaseKeyspaceChanges(currentConfig, nextConfig),
+    ...getCouchbaseAccessChanges(currentConfig, nextConfig),
+  ];
 }
 
 /**

packages/deploy/src/clusterChanges/types.ts

@@ -1,10 +1,10 @@
 import {
   IBucketSettings,
-  ICreateBucketSettings, ISearchIndex,
+  ICreateBucketSettings,
+  ISearchIndex,
   IUser,
   UpdateBucketSettings,
 } from '@cbjsdev/cbjs';
-import { ApiSearchIndexDefinition } from '@cbjsdev/http-client';
 
 export type CouchbaseClusterChange =
   | CouchbaseClusterChangeCreateBucket
@@ -27,8 +27,7 @@ export type CouchbaseClusterChange =
   | CouchbaseClusterChangeDropUser
   | CouchbaseClusterChangeCreateSearchIndex
   | CouchbaseClusterChangeUpdateSearchIndex
-  | CouchbaseClusterChangeDropSearchIndex
-;
+  | CouchbaseClusterChangeDropSearchIndex;
 
 export type CouchbaseClusterChangeCreateBucket = {
   type: 'createBucket';