Major serdes changes (#98)

* revamp of how codecs work

* cleanup of unused serdes stuff

* serdes code deduplication

* ctx.afterMap

* keytransformer overhaul

* colorized check scirpt

* internal serdes refactors + tests

* made table codec properly recursive

* serdes code deduplication/cleanup

* work on tests

* better detection of unit tests being skipped

Author: toptobes

etc/astra-db-ts.api.md

@@ -20,13 +20,9 @@ node scripts/utils/build-version-file.js > src/version.ts
 
 # Transpiles the project
 if [ "$light" = true ]; then
-  npx tsc --project tsconfig.production.json -d false --noCheck
+  npx tsc --project tsconfig.production.json -d false --noCheck || exit 10
 else
-  npx tsc --project tsconfig.production.json
-fi
-
-if [ ! -d ./dist ]; then
-  exit 10
+  npx tsc --project tsconfig.production.json || exit 10
 fi
 
 # Replaces alias paths with relative paths (e.g. `@/src/version` -> `../../src/version`)

scripts/build.sh

@@ -46,63 +46,99 @@ fi
 
 failed=false
 
+print_green() {
+  echo "$(tput setaf 2)$(tput bold)$1$(tput sgr0)"
+}
+
+print_green_with_status() {
+  if [ $failed = true ]; then
+    print_green "- $1 :/"
+  else
+    print_green "- $1 :)"
+  fi
+}
+
+print_error() {
+  echo "$(tput setaf 1)$1$(tput sgr0)"
+}
+
 for check_type in $check_types; do
   case $check_type in
     "tc")
-      echo "Running type-checker..."
-      npx tsc --noEmit || failed=true
+      print_green_with_status "Running type-checker..."
+
+      if ! npx tsc --noEmit > /dev/null; then
+        npx tsc --noEmit
+        failed=true
+      fi
       ;;
     "lint")
-      echo "Running linter..."
-      npm run lint -- --no-warn-ignored || failed=true
+      print_green_with_status "Running linter..."
+
+      if ! npm run lint -- --no-warn-ignored > /dev/null; then
+        npm run lint -- --no-warn-ignored
+        failed=true
+      fi
       ;;
     "licensing")
-      echo "Checking for missing licensing headers..."
+      print_green_with_status "Checking for missing licensing headers..."
       offenders=$(find tests/ src/ -type f -exec grep -L "^// Copyright DataStax, Inc." {} +)
 
       if [ -n "$offenders" ]; then
-        echo "The following files are missing licensing headers:"
-        echo "$offenders"
+        print_error "The following files are missing licensing headers:"
+        print_error "$offenders"
         failed=true
       fi
       ;;
     "lib-check")
-      echo "Checking library compiles..."
+      print_green_with_status "Ensuring library compiles with skipLibCheck: false..."
 
       tmp_dir="tmp-lib-check"
       rm -rf "$tmp_dir" "$main_dir/dist"
 
-      (scripts/build.sh -no-report \
-        && mkdir "$tmp_dir" \
-        && cd "$tmp_dir" \
-        && npm init -y \
-        && npm install typescript "$main_dir" \
-        && echo "import '@datastax/astra-db-ts'" > src.ts \
-        && npx tsc --init --skipLibCheck false --typeRoots "./node_modules/**" --target es2020 \
-        && npx tsc) || failed=true
+      scripts/build.sh -no-report > /dev/null
+
+      if [ ! $? ]; then
+        print_error "Could not build library for lib-check phase"
+        failed=true
+      else
+        mkdir "$tmp_dir" \
+          && cd "$tmp_dir" \
+          && npm init -y > /dev/null \
+          && npm install typescript "$main_dir" > /dev/null \
+          && echo "import '@datastax/astra-db-ts'" > src.ts \
+          && npx tsc --init --skipLibCheck false --typeRoots "./node_modules/**" --target es2020 > /dev/null
+
+        if [ -f tsconfig.json ]; then
+          npx tsc || failed=true
+        else
+          print_error "Could not set up library for lib-check phase"
+          failed=true
+        fi
+      fi
 
       cd "$main_dir" && rm -rf "$tmp_dir"
       ;;
     "test-ext")
-      echo "Checking test file extensions..."
+      print_green_with_status "Checking for test files that do not end in '.test.ts'..."
       offenders=$(find tests/unit tests/integration -type f -not -name "*.test.ts")
 
       if [ -n "$offenders" ]; then
-        echo "The following test files do not end in '.test.ts':"
-        echo "$offenders"
+        print_error "The following test files do not end in '.test.ts':"
+        print_error "$offenders"
         failed=true
       fi
       ;;
     "*")
-      echo "Invalid check type '$check_type'"
+      print_error "Invalid check type '$check_type'"
       exit 1
       ;;
   esac
 done
 
 if [ "$failed" = true ]; then
-  echo "Checks failed"
+  print_error "$(tput bold)Checks failed :("
   exit 1
 else
-  echo "Checks passed"
+  print_green "Checks passed :)"
 fi

scripts/check.sh

@@ -268,5 +268,7 @@ if [ -n "$CLIENT_RUN_VECTORIZE_TESTS" ] && [ "$test_type" != 'code' ]; then
   fi
 fi
 
+export CLIENT_DYNAMIC_JS_ENV_CHECK=1
+
 # Run it
 eval "$cmd_to_run"

scripts/test.sh

@@ -47,6 +47,7 @@ import { Timeouts } from '@/src/lib/api/timeouts';
  * @public
  */
 export const DataAPIClientEventEmitterBase = (() => {
+  /* istanbul ignore next: exceptional case that can't be manually reproduced */
   try {
     return (require('events') as { EventEmitter: (new () => TypedEmitter<DataAPIClientEventMap>) }).EventEmitter;
   } catch (_) {
@@ -55,6 +56,8 @@ export const DataAPIClientEventEmitterBase = (() => {
 })();
 
 /**
+ * ##### Overview
+ *
  * The main entrypoint into working with the Data API. It sits at the top of the
  * [conceptual hierarchy](https://github.com/datastax/astra-db-ts/tree/signature-cleanup?tab=readme-ov-file#abstraction-diagram)
  * of the SDK.
@@ -87,7 +90,7 @@ export const DataAPIClientEventEmitterBase = (() => {
  * const admin1 = client1.admin();
  * const admin2 = client1.admin({ adminToken: '<stronger_token>' });
  *
- * console.log(await coll.insertOne({ name: 'RATATATA' }));
+ * console.log(await coll.insertOne({ name: 'John Joe' }));
  * console.log(await admin1.listDatabases());
  * ```
  *

src/client/data-api-client.ts

@@ -24,7 +24,6 @@ export {
 } from './ser-des/ser-des';
 
 export {
-  CollCodecSerDesFns,
   CollCodecClass,
   CollCodecs,
   CollCodec,

src/documents/collections/index.ts

@@ -28,7 +28,7 @@ export type CollNumRep =
 /**
  * @public
  */
-export type GetCollNumRepFn = (path: readonly string[]) => CollNumRep;
+export type GetCollNumRepFn = (path: readonly (string | number)[]) => CollNumRep;
 
 /**
  * @public
@@ -45,7 +45,7 @@ interface NumRepTree {
 export const collNumRepFnFromCfg = (cfg: CollNumRepCfg): GetCollNumRepFn => {
   const tree = buildNumRepTree(cfg);
 
-  return (path: readonly string[]) => {
+  return (path) => {
     return findMatchingPath(path, tree) ?? 'number';
   };
 };
@@ -71,7 +71,7 @@ const buildNumRepTree = (cfg: CollNumRepCfg): NumRepTree => {
   return result;
 };
 
-const findMatchingPath = (path: readonly string[], tree: NumRepTree | undefined): CollNumRep | undefined => {
+const findMatchingPath = (path: readonly (string | number)[], tree: NumRepTree | undefined): CollNumRep | undefined => {
   let rep: CollNumRep | undefined = undefined;
 
   for (let i = 0; tree && i <= path.length; i++) {
@@ -96,7 +96,7 @@ const findMatchingPath = (path: readonly string[], tree: NumRepTree | undefined)
  * @public
  */
 export class NumCoercionError extends Error {
-  public readonly path: string[];
+  public readonly path: (string | number)[];
   public readonly value: number | BigNumber;
   public readonly from: 'number' | 'bignumber';
   public readonly to: CollNumRep;
@@ -106,7 +106,7 @@ export class NumCoercionError extends Error {
    *
    * @internal
    */
-  public constructor(path: string[], value: number | BigNumber, from: 'number' | 'bignumber', to: CollNumRep) {
+  public constructor(path: (string | number)[], value: number | BigNumber, from: 'number' | 'bignumber', to: CollNumRep) {
     super(`Failed to coerce value from ${from} to ${to} at path: ${path.join('.')}`);
     this.path = path;
     this.value = value;
@@ -124,19 +124,19 @@ export const coerceBigNumber = (value: BigNumber, ctx: CollDesCtx): readonly [0
         throw new NumCoercionError(ctx.path, value, 'bignumber', 'number');
       }
 
-      return ctx.next(asNum);
+      return ctx.recurse(asNum);
     }
     case 'bigint': {
       if (!value.isInteger()) {
         throw new NumCoercionError(ctx.path, value, 'bignumber', 'bigint');
       }
-      return ctx.next(BigInt(value.toFixed(0)));
+      return ctx.recurse(BigInt(value.toFixed(0)));
     }
     case 'bignumber':
-      return ctx.next(value);
+      return ctx.recurse(value);
     case 'string':
     case 'number_or_string':
-      return ctx.next(value.toString());
+      return ctx.recurse(value.toString());
   }
 };
 
@@ -146,14 +146,14 @@ export const coerceNumber = (value: number, ctx: CollDesCtx): readonly [0 | 1 |
       if (!Number.isInteger(value)) {
         throw new NumCoercionError(ctx.path, value, 'number', 'bigint');
       }
-      return ctx.next(BigInt(value));
+      return ctx.recurse(BigInt(value));
     }
     case 'bignumber':
-      return ctx.next(BigNumber(value));
+      return ctx.recurse(BigNumber(value));
     case 'string':
-      return ctx.next(value.toString());
+      return ctx.recurse(value.toString());
     case 'number':
     case 'number_or_string':
-      return ctx.next(value);
+      return ctx.recurse(value);
   }
 };