Sync/4.6.1 (#10)

Author: JesusTheHun

.github/workflows/tests.yml

@@ -1,6 +1,17 @@
 name: Tests
 on:
   workflow_dispatch:
+    inputs:
+      couchbase-server-version:
+        description: 'Couchbase Server version to test against'
+        type: choice
+        required: false
+        default: 'all'
+        options:
+          - 'all'
+          - 'enterprise-7.2.4'
+          - 'enterprise-7.6.4'
+          - 'enterprise-8.0.0'
   push:
     branches:
       - main
@@ -10,8 +21,8 @@ on:
 jobs:
   test:
     if: >
-      (github.event_name == 'push' 
-      && !contains(github.event.head_commit.message, 'skip ci') 
+      (github.event_name == 'push'
+      && !contains(github.event.head_commit.message, 'skip ci')
       && !startsWith(github.event.head_commit.message, 'docs')) ||
       (github.event.issue.pull_request && startsWith(github.event.comment.body, '/test') && github.actor == 'JesusTheHun') ||
       github.event_name == 'workflow_dispatch'
@@ -21,7 +32,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        couchbase-server-version: [ 'enterprise-7.2.4', 'enterprise-7.6.4', 'enterprise-8.0.0' ]
+        couchbase-server-version: ${{ github.event_name == 'workflow_dispatch' && inputs.couchbase-server-version != 'all' && fromJSON(format('["{0}"]', inputs.couchbase-server-version)) || fromJSON('["enterprise-7.2.4","enterprise-7.6.4","enterprise-8.0.0"]') }}
     services:
       couchbase:
         image: couchbase:${{ matrix.couchbase-server-version }}
@@ -69,17 +80,25 @@ jobs:
       - name: Initialize Couchbase cluster
         run: pnpm dlx tsx tests/scripts/initTestCluster.ts
 
-      - name: Vitest cache
-        uses: actions/cache@v4
+      - name: Restore vitest cache
+        uses: actions/cache/restore@v4
         with:
-          path: ./node_modules/.vite/vitest/results.json
-          key: vitest-cache-${{ github.ref_name }}
+          path: ./node_modules/.vite/results.json
+          key: vitest-cache-${{ matrix.couchbase-server-version }}-${{ github.ref_name }}-${{ github.run_id }}-${{ github.run_attempt }}
           restore-keys: |
-            vitest-cache-main
+            vitest-cache-${{ matrix.couchbase-server-version }}-${{ github.ref_name }}-
+            vitest-cache-${{ matrix.couchbase-server-version }}-main-
 
       - name: Run all tests
         run: pnpm vitest --run --bail 5
 
+      - name: Save vitest cache
+        if: always()
+        uses: actions/cache/save@v4
+        with:
+          path: ./node_modules/.vite/results.json
+          key: vitest-cache-${{ matrix.couchbase-server-version }}-${{ github.ref_name }}-${{ github.run_id }}-${{ github.run_attempt }}
+
       - name: Upload Tests Report
         if: always()
         uses: actions/upload-artifact@v4

packages/cbjs/src/bucketmanager.ts

@@ -374,6 +374,8 @@ export class BucketSettings implements IBucketSettings {
 
   /**
    * Specifies the number of vBuckets in this bucket
+   *
+   * @since Couchbase Server 7.6
    */
   numVBuckets?: number;
 

packages/cbjs/src/streamablepromises.ts

@@ -16,7 +16,7 @@
  */
 import { EventEmitter } from 'events';
 
-import { EventKey, EventListener, EventMap, TypedEmitter } from './utils/TypedEmitter.js';
+import { EventKey, EventMap, TypedEmitter } from './utils/TypedEmitter.js';
 
 /**
  * @internal
@@ -44,21 +44,19 @@ export class StreamablePromise<T, EM extends EventMap>
   })<EM>
   implements Promise<T>
 {
-  private _promise: Promise<T> | null = null;
-  private _promiseOns: [string | symbol, EventListener<any[]>][];
+  private _promise: Promise<T>;
+  protected _collectResults = true;
 
   /**
    * @internal
    */
   constructor(promisefyFn: PromisifyFunc<T, EM>) {
     super();
 
-    this._promiseOns = [];
     this._promise = new Promise((resolve, reject) => {
       promisefyFn(
         {
           on: <T extends EventKey<EM>>(eventName: T, listener: EM[T]) => {
-            this._promiseOns.push([eventName, listener]);
             void super.on(eventName, listener);
           },
         },
@@ -68,42 +66,30 @@ export class StreamablePromise<T, EM extends EventMap>
     });
   }
 
-  private get promise(): Promise<T> {
-    if (!this._promise) {
-      throw new Error('Cannot await a promise that is already registered for events');
-    }
-    return this._promise;
-  }
-
-  private _depromisify() {
-    this._promiseOns.forEach((e) => void this.off(...(e as [never, never])));
-    this._promise = null;
-  }
-
   then<TResult1 = T, TResult2 = never>(
     onfulfilled?: ((value: T) => TResult1 | PromiseLike<TResult1>) | undefined | null,
     onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | undefined | null
   ): Promise<TResult1 | TResult2> {
-    return this.promise.then<TResult1, TResult2>(onfulfilled, onrejected);
+    return this._promise.then<TResult1, TResult2>(onfulfilled, onrejected);
   }
 
   catch<TResult = never>(
     onrejected?: ((reason: any) => TResult | PromiseLike<TResult>) | undefined | null
   ): Promise<T | TResult> {
-    return this.promise.catch<TResult>(onrejected);
+    return this._promise.catch<TResult>(onrejected);
   }
 
   finally(onfinally?: (() => void) | undefined | null): Promise<T> {
-    return this.promise.finally(onfinally);
+    return this._promise.finally(onfinally);
   }
 
   override addListener<T extends EventKey<EM>>(eventName: T, listener: EM[T]): this {
-    this._depromisify();
+    this._collectResults = false;
     return super.on(eventName, listener);
   }
 
   override on<T extends EventKey<EM>>(eventName: T, listener: EM[T]): this {
-    this._depromisify();
+    this._collectResults = false;
     return super.on(eventName, listener);
   }
 
@@ -135,7 +121,9 @@ export class StreamableRowPromise<T, TRow, TMeta> extends StreamablePromise<
       const rows: TRow[] = [];
       let meta: TMeta | undefined;
 
-      void emitter.on('row', (r) => rows.push(r));
+      void emitter.on('row', (r) => {
+        if (this._collectResults) rows.push(r);
+      });
       void emitter.on('meta', (m) => (meta = m));
       void emitter.on('error', (e) => (err = e));
       void emitter.on('end', () => {
@@ -167,7 +155,9 @@ export class StreamableReplicasPromise<T, TRep> extends StreamablePromise<
       let err: Error | undefined;
       const replicas: TRep[] = [];
 
-      void emitter.on('replica', (r) => replicas.push(r));
+      void emitter.on('replica', (r) => {
+        if (this._collectResults) replicas.push(r);
+      });
       void emitter.on('error', (e) => (err = e));
       void emitter.on('end', () => {
         if (err) {
@@ -195,7 +185,9 @@ export class StreamableScanPromise<T, TRes> extends StreamablePromise<
       let err: Error | undefined;
       const results: TRes[] = [];
 
-      void emitter.on('result', (r) => results.push(r));
+      void emitter.on('result', (r) => {
+        if (this._collectResults) results.push(r);
+      });
       void emitter.on('error', (e) => (err = e));
       void emitter.on('end', () => {
         if (err) {

packages/deploy/src/clusterChanges/applyCouchbaseClusterChanges.ts

@@ -1,6 +1,6 @@
 import { retry } from 'ts-retry-promise';
 
-import { AnyCluster, Cluster, keyspacePath } from '@cbjsdev/cbjs';
+import { AnyCluster, keyspacePath } from '@cbjsdev/cbjs';
 import {
   CouchbaseHttpApiConfig,
   createQueryIndex,
@@ -651,15 +651,15 @@ async function applyUpsertSearchIndex(
     .searchIndexes()
     .getAllIndexes();
 
-  const searchIndex = searchIndexes.find((s) => s.name === change.name);
+  const searchIndex = searchIndexes.find((s) => s.name === config.name);
 
   if (searchIndex) {
     config.uuid = searchIndex.uuid;
     config.sourceUUID = searchIndex.sourceUuid;
   }
 
   console.log(
-    `${getTimePrefix()} Requesting creation of search index "${change.bucket} # ${change.name}"`
+    `${getTimePrefix()} Requesting upsert of search index "${change.bucket} # ${config.name}"`
   );
 
   await cluster
@@ -669,19 +669,19 @@ async function applyUpsertSearchIndex(
     .upsertIndex(config, opts);
 
   console.log(
-    `${getTimePrefix()} Waiting for search index "${change.bucket} # ${change.name}" to be created`
+    `${getTimePrefix()} Waiting for search index "${change.bucket} # ${config.name}" to be ready`
   );
   await waitForSearchIndex(
     apiConfig,
-    change.name,
+    config.name,
     {
       bucket: change.bucket,
       scope: change.scope,
     },
     opts
   );
   console.log(
-    `${getTimePrefix()} Search index "${change.bucket} # ${change.name}" created`
+    `${getTimePrefix()} Search index "${change.bucket} # ${config.name}" ready`
   );
 }
 
@@ -692,30 +692,31 @@ async function applyDropSearchIndex(
   opts: ChangeOptions
 ) {
   console.log(
-    `${getTimePrefix()} Requesting deletion of search index "${change.bucket} # ${change.name}"`
+    `${getTimePrefix()} Requesting deletion of search index "${change.bucket} # ${change.indexName}"`
   );
 
   await cluster
     .bucket(change.bucket)
     .scope(change.scope)
     .searchIndexes()
-    .dropIndex(change.name);
+    .dropIndex(change.indexName);
 
   console.log(
-    `${getTimePrefix()} Waiting for search index "${change.bucket} # ${change.name}" to be deleted`
+    `${getTimePrefix()} Waiting for search index "${change.bucket} # ${change.indexName}" to be deleted`
   );
   await waitForSearchIndex(
     apiConfig,
-    change.name,
+    change.indexName,
     {
       bucket: change.bucket,
+      scope: change.scope,
     },
     {
       ...opts,
       expectMissing: true,
     }
   );
   console.log(
-    `${getTimePrefix()} Search index "${change.bucket} # ${change.name}" deleted`
+    `${getTimePrefix()} Search index "${change.bucket} # ${change.indexName}" deleted`
   );
 }

packages/deploy/src/clusterChanges/getCouchbaseClusterChanges.spec.ts

@@ -681,6 +681,7 @@ describe('getCouchbaseClusterChanges', () => {
       {
         type: 'dropSearchIndex',
         name: 'searchIndex1',
+        indexName: 'searchIndex1',
         bucket: 'bucket1',
         scope: 'scope1',
       },

packages/deploy/src/clusterChanges/getCouchbaseClusterChanges.ts

@@ -685,12 +685,26 @@ function getObsoleteSearchIndexes(
 
   return currentIndexes
     .filter((b) => !requestedIndexes.includes(b))
-    .map((b) => ({
-      type: 'dropSearchIndex',
-      name: b,
-      bucket: bucketName,
-      scope: scopeName,
-    }));
+    .map((b) => {
+      const currentIndexFn =
+        currentConfig[bucketName]?.scopes[scopeName]?.searchIndexes?.[b];
+
+      invariant(currentIndexFn, 'Search index definition not found.');
+
+      const config = currentIndexFn({
+        sourceName: bucketName,
+        bucketName,
+        scopeName,
+      });
+
+      return {
+        type: 'dropSearchIndex' as const,
+        name: b,
+        indexName: config.name,
+        bucket: bucketName,
+        scope: scopeName,
+      };
+    });
 }
 
 function getNewSearchIndexes(

packages/deploy/src/clusterChanges/types.ts

@@ -187,6 +187,10 @@ export type CouchbaseClusterChangeDropSearchIndex = {
    * The config alias for the search index.
    */
   name: string;
+  /**
+   * The actual index name on the cluster.
+   */
+  indexName: string;
 };
 
 export type CouchbaseClusterConfig = {

packages/http-client/src/services/kv/getCollections.ts

@@ -29,7 +29,7 @@ export async function getCollections(
   }
 
   const body = (await response.json()) as ApiBucketScopes;
-  const scope = body.scopes.find((s) => s.name);
+  const scope = body.scopes.find((s) => s.name === scopeName);
 
   if (scope === undefined) {
     throw new Error(`Scope '${bucketName}'.'${scopeName}' not found`);