Reduce package size (#54)

toptobes · web-flow · commit 11e4cf365dc6 · 2024-06-11T18:54:04.000-05:00
* let data api deal with overlapping vector and vectorize

* deprecated vectorize

* update api report

* reduced pack size

* removed bson-objectid dependency

* add missing license bumf to rollup .d.ts file
diff --git a/.eslintrc.cjs b/.eslintrc.cjs
@@ -1,5 +1,6 @@
 /* eslint-env node */
 module.exports = {
+  ignorePatterns: ['dist/*', 'scripts/*'],
   extends: ['eslint:recommended', 'plugin:@typescript-eslint/recommended'],
   parser: '@typescript-eslint/parser',
   plugins: ['@typescript-eslint'],
diff --git a/etc/astra-db-ts.api.md b/etc/astra-db-ts.api.md
@@ -953,7 +953,7 @@ export interface NumFilterOps {
 
 // @public
 export class ObjectId {
-    constructor(id?: string | null, validate?: boolean);
+    constructor(id?: string | number | null, validate?: boolean);
     equals(other: unknown): boolean;
     getTimestamp(): Date;
     inspect(): string;
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -72,12 +72,12 @@
     "dotenv": "^16.0.1",
     "eslint": "^8.57.0",
     "nyc": "^15.1.0",
+    "strip-comments": "^2.0.1",
     "ts-mocha": "^10.0.0",
     "tsc-alias": "^1.8.8",
     "typescript": "^5.3.3"
   },
   "dependencies": {
-    "bson-objectid": "^2.0.4",
     "fetch-h2": "^3.0.2",
     "safe-stable-stringify": "^2.4.3",
     "typed-emitter": "^2.1.0",
diff --git a/scripts/add-license-bumf.js b/scripts/add-license-bumf.js
@@ -0,0 +1,33 @@
+const fs = require('fs');
+
+const bumf = `// Copyright DataStax, Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.`;
+
+const filePath = process.argv[2];
+
+if (!filePath) {
+  throw new Error('no file path provided');
+}
+
+fs.readFile(filePath, 'utf8', (err, data) => {
+  if (err) {
+    throw new Error('Error reading file ${filePath}: ${err}');
+  }
+
+  fs.writeFile(filePath, bumf + '\n\n' + data, 'utf8', (err) => {
+    if (err) {
+      throw new Error('Error writing file ${filePath}: ${err}');
+    }
+  });
+});
diff --git a/scripts/build.sh b/scripts/build.sh
@@ -12,11 +12,14 @@ yes | npx tsc --project tsconfig.build.json
 # Replaces alias paths with relative paths (e.g. `@/src/version` -> `../../src/version`)
 yes | npx tsc-alias -p tsconfig.build.json
 
-# Creates the rollup .d.ts and generates an API report in etc/
-npm run api-extractor
+# Creates the rollup .d.ts, generates an API report in etc/, and cleans up any temp files
+npm run api-extractor && rm -r ./temp
 
-# Deletes the temp folder that was created by API extractor
-rm -r ./temp
+# Uses a more succinct licence notice + removes block comments (the rollup .d.ts file already contains the ts-doc)
+find ./dist -type f -name '*.js' -exec node scripts/reduce-comments.js {} \;
+
+# Adds the missing license notice to the rollup .d.ts
+node scripts/add-license-bumf.js dist/astra-db-ts.d.ts
 
 # Removes all .d.ts files except the main rollup .d.ts
 cd dist || return 1
diff --git a/scripts/reduce-comments.js b/scripts/reduce-comments.js
@@ -0,0 +1,40 @@
+const fs = require('fs');
+const strip = require('strip-comments');
+
+const longBumf = `// Copyright DataStax, Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.`;
+
+const shortBumf = `// Copyright Datastax, Inc
+// SPDX-License-Identifier: Apache-2.0`;
+
+const filePath = process.argv[2];
+
+if (!filePath) {
+  throw new Error('no file path provided');
+}
+
+fs.readFile(filePath, 'utf8', (err, data) => {
+  if (err) {
+    throw new Error('Error reading file ${filePath}: ${err}');
+  }
+
+  const withShortenedLicense = data.replace(longBumf, shortBumf);
+  const withStrippedBlockComments = strip.block(withShortenedLicense);
+
+  fs.writeFile(filePath, withStrippedBlockComments, 'utf8', (err) => {
+    if (err) {
+      throw new Error('Error writing file ${filePath}: ${err}');
+    }
+  });
+});
diff --git a/src/common/token-providers/dse-token-providers.ts b/src/common/token-providers/dse-token-providers.ts
@@ -1,3 +1,17 @@
+// Copyright DataStax, Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
 import { TokenProvider } from '@/src/common/token-providers/token-provider';
 
 /**
@@ -38,7 +52,7 @@ export class DSEUsernamePasswordTokenProvider extends TokenProvider {
 
   private _encodeB64(input: string) {
     if (typeof window !== 'undefined' && typeof window.btoa === 'function') {
-      return window.btoa(decodeURIComponent(encodeURIComponent(input)));
+      return window.btoa(input);
     } else if (typeof Buffer === 'function') {
       return Buffer.from(input, 'utf-8').toString('base64');
     } else {
diff --git a/src/common/token-providers/static-token-provider.ts b/src/common/token-providers/static-token-provider.ts
@@ -1,3 +1,17 @@
+// Copyright DataStax, Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
 import { TokenProvider } from '@/src/common/token-providers/token-provider';
 
 /**
diff --git a/src/common/token-providers/token-provider.ts b/src/common/token-providers/token-provider.ts
@@ -1,3 +1,17 @@
+// Copyright DataStax, Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
 import { nullish, StaticTokenProvider } from '@/src/common';
 
 /**
diff --git a/src/data-api/ids.ts b/src/data-api/ids.ts
@@ -13,9 +13,7 @@
 // limitations under the License.
 
 import { UUID as UUIDv7, uuidv4, uuidv7 } from 'uuidv7';
-import MongoObjectId from 'bson-objectid';
 import { isNullish } from '@/src/common';
-import ObjectID from 'bson-objectid';
 
 /**
  * All possible types for a document ID. JSON scalar types, `Date`, `UUID`, and `ObjectId`.
@@ -217,7 +215,7 @@ const objectIdRegex = new RegExp('^[0-9a-fA-F]{24}$');
  * @public
  */
 export class ObjectId {
-  private readonly _objectId: MongoObjectId;
+  private readonly _objectId: string;
 
   /**
    * Creates a new ObjectId instance.
@@ -227,18 +225,18 @@ export class ObjectId {
    * @param id - The ObjectId string.
    * @param validate - Whether to validate the ObjectId string. Defaults to `true`.
    */
-  constructor(id?: string | null, validate = true) {
+  constructor(id?: string | number | null, validate = true) {
     if (validate) {
       if (typeof id === 'string') {
         if (id.length !== 24 || !objectIdRegex.test(id)) {
           throw new Error('ObjectId must be a 24-character hex string');
         }
-      } else if (!isNullish(id)) {
-        throw new Error('ObjectId must be a string');
+      } else if (typeof id !== 'number' && !isNullish(id)) {
+        throw new Error('ObjectId must be a string, number, or nullish');
       }
     }
 
-    this._objectId = (id) ? MongoObjectId(id) : MongoObjectId();
+    this._objectId = typeof id === 'string' ? id.toLowerCase() : genObjectId(id);
   }
 
   /**
@@ -253,7 +251,13 @@ export class ObjectId {
    * @returns `true` if the ObjectIds are equal, `false` otherwise.
    */
   public equals(other: unknown): boolean {
-    return this._objectId.equals((other && typeof other === 'object' && '_objectId' in other ? other._objectId : other) as ObjectID);
+    if (typeof other === 'string') {
+      return this._objectId.localeCompare(other, undefined, { sensitivity: 'accent' }) === 0;
+    }
+    if (other instanceof ObjectId) {
+      return this._objectId.localeCompare(other._objectId, undefined, { sensitivity: 'accent' }) === 0;
+    }
+    return false;
   }
 
   /**
@@ -262,14 +266,15 @@ export class ObjectId {
    * @returns The timestamp of the ObjectId.
    */
   public getTimestamp(): Date {
-    return this._objectId.getTimestamp();
+    const time = parseInt(this._objectId.slice(0, 8), 16);
+    return new Date(~~time * 1000);
   }
 
   /**
    * Returns the string representation of the ObjectId.
    */
   public toString(): string {
-    return this._objectId.toHexString();
+    return this._objectId;
   }
 
   /**
@@ -289,6 +294,39 @@ export class ObjectId {
   }
 }
 
+const MACHINE_ID = ~~(Math.random() * 0xFFFFFF);
+const PID = ((typeof process?.pid !== 'number') ? ~~(Math.random() * 100000) : process.pid) % 0xFFFF;
+
+const hexTable = Array.from({ length: 256 }, (_, i) => {
+  return (i <= 15 ? '0' : '') + i.toString(16);
+});
+
+let index = ~~(Math.random() * 0xFFFFFF);
+
+function genObjectId(time?: number | null): string {
+  time ??= ~~(Date.now() / 1000);
+  time = time % 0xFFFFFFFF;
+
+  index = (index + 1) % 0xFFFFFF
+
+  let hexString = '';
+
+  hexString += hexTable[((time >> 24) & 0xFF)]
+  hexString += hexTable[((time >> 16) & 0xFF)]
+  hexString += hexTable[((time >> 8) & 0xFF)]
+  hexString += hexTable[(time & 0xFF)]
+  hexString += hexTable[((MACHINE_ID >> 16) & 0xFF)]
+  hexString += hexTable[((MACHINE_ID >> 8) & 0xFF)]
+  hexString += hexTable[(MACHINE_ID & 0xFF)]
+  hexString += hexTable[((PID >> 8) & 0xFF)]
+  hexString += hexTable[(PID & 0xFF)]
+  hexString += hexTable[((index >> 16) & 0xFF)]
+  hexString += hexTable[((index >> 8) & 0xFF)]
+  hexString += hexTable[(index & 0xFF)]
+
+  return hexString;
+}
+
 function timestampFromUUID(uuid: UUID): Date | undefined {
   if (uuid.version !== 7) {
     return undefined;
diff --git a/tests/unit/data-api/ids.test.ts b/tests/unit/data-api/ids.test.ts
@@ -104,6 +104,7 @@ describe('unit.data-api.ids', () => {
 
     it('should properly serialize to JSON', () => {
       const uuid = new UUID('123e4567-e89b-12d3-a456-426614174000');
+      assert.deepStrictEqual(uuid.toJSON(), { $uuid: '123e4567-e89b-12d3-a456-426614174000' });
       assert.strictEqual(JSON.stringify(uuid), '{"$uuid":"123e4567-e89b-12d3-a456-426614174000"}');
     });
   });
@@ -114,6 +115,16 @@ describe('unit.data-api.ids', () => {
       assert.strictEqual(objectId.toString(), '507f191e810c19729de860ea');
     });
 
+    it('should properly generate an ObjectId', () => {
+      const objectId = new ObjectId();
+      assert.strictEqual(objectId.toString().length, 24);
+    });
+
+    it('should properly construct an ObjectId given timestamp', () => {
+      const objectId = new ObjectId(123123123);
+      assert.strictEqual(objectId.getTimestamp().toDateString(), new Date(123123123 * 1000).toDateString());
+    });
+
     it('should error on invalid ObjectId', () => {
       assert.throws(() => new ObjectId('507f191e810c19729de860e'));
     });
@@ -123,11 +134,13 @@ describe('unit.data-api.ids', () => {
     });
 
     it('should "allow" force construction on invalid ObjectId', () => {
-      assert.throws(() => new ObjectId('507f191e810c19729de860e', false), Error);
+      const objectId = new ObjectId('23d032jd', false);
+      assert.ok(objectId.equals('23d032jd'));
     });
 
     it('should "allow" force construction on invalid type', () => {
-      assert.throws(() => new ObjectId({} as any, false), Error);
+      const objectId = new ObjectId(<any>{}, false);
+      assert.ok(objectId.toString());
     });
 
     it('should properly parse an ObjectId', () => {
@@ -171,6 +184,7 @@ describe('unit.data-api.ids', () => {
 
     it('should properly serialize to JSON', () => {
       const objectId = new ObjectId('507f191e810c19729de860ea');
+      assert.deepStrictEqual(objectId.toJSON(), { $objectId: '507f191e810c19729de860ea' });
       assert.strictEqual(JSON.stringify(objectId), '{"$objectId":"507f191e810c19729de860ea"}');
     });
   });
diff --git a/tsconfig.json b/tsconfig.json
