fix: feedback from #518 (#520)

Author: boorad

example/ios/Podfile.lock

@@ -323,7 +323,7 @@ PODS:
   - react-native-quick-base64 (2.1.2):
     - RCT-Folly (= 2021.07.22.00)
     - React-Core
-  - react-native-quick-crypto (0.7.9):
+  - react-native-quick-crypto (0.7.10):
     - OpenSSL-Universal
     - RCT-Folly (= 2021.07.22.00)
     - React
@@ -628,7 +628,7 @@ SPEC CHECKSUMS:
   React-logger: 8edc785c47c8686c7962199a307015e2ce9a0e4f
   react-native-fast-encoder: 6f59e9b08e2bc5a8bf1f36e1630cdcfd66dd18af
   react-native-quick-base64: 61228d753294ae643294a75fece8e0e80b7558a6
-  react-native-quick-crypto: d8c6ba8c31de79da1ebbbdb79cf16d1ee980b407
+  react-native-quick-crypto: 3126bf520d6ef977d103027d8287027ebea4d0d7
   react-native-safe-area-context: ab8f4a3d8180913bd78ae75dd599c94cce3d5e9a
   React-NativeModulesApple: b6868ee904013a7923128892ee4a032498a1024a
   React-perflogger: 31ea61077185eb1428baf60c0db6e2886f141a5a

example/src/testing/tests/RandomTests/randomTests.ts

@@ -73,22 +73,22 @@ describe('random', () => {
     });
   });
 
-  it('simple test (do sth)', () => {
+  it('simple test 1', () => {
     const buf = Buffer.alloc(10);
     const before = buf.toString('hex');
     const after = crypto.randomFillSync(buf).toString('hex');
     assert.notStrictEqual(before, after);
   });
 
-  it('simple test (do sth) 2', () => {
+  it('simple test 2', () => {
     const buf = new Uint8Array(new Array(10).fill(0));
     const before = Buffer.from(buf).toString('hex');
     crypto.randomFillSync(buf);
     const after = Buffer.from(buf).toString('hex');
     assert.notStrictEqual(before, after);
   });
 
-  it('simple test (do sth) 3', () => {
+  it('simple test 3', () => {
     [
       new Uint16Array(10),
       new Uint32Array(10),
@@ -103,7 +103,7 @@ describe('random', () => {
     });
   });
 
-  it('simple test (do sth) 4 - random Fill Sync AB', () => {
+  it('simple test 4 - random Fill Sync AB', () => {
     [new ArrayBuffer(10), new ArrayBuffer(10)].forEach((buf) => {
       const before = Buffer.from(buf).toString('hex');
       crypto.randomFillSync(buf);
@@ -112,7 +112,7 @@ describe('random', () => {
     });
   });
 
-  it('simple test (do sth) 5- random Fill ', (done: Done) => {
+  it('simple test 5- random Fill ', (done: Done) => {
     const buf = Buffer.alloc(10);
     const before = buf.toString('hex');
 
@@ -127,7 +127,7 @@ describe('random', () => {
     });
   });
 
-  it('simple test (do sth) 6 ', (done: Done) => {
+  it('simple test 6 ', (done: Done) => {
     const buf = new Uint8Array(new Array(10).fill(0));
     const before = Buffer.from(buf).toString('hex');
 
@@ -172,7 +172,7 @@ describe('random', () => {
     });
   });
 
-  it('simple test (do sth) 8', (done: Done) => {
+  it('simple test 8', (done: Done) => {
     let ctr = 0;
     [new ArrayBuffer(10), new ArrayBuffer(10)].forEach((buf) => {
       const before = Buffer.from(buf).toString('hex');
@@ -416,7 +416,7 @@ describe('random', () => {
   });
 
   it('randomInt - Synchronous API', () => {
-    const randomInts = [];
+    const randomInts: number[] = [];
     for (let i = 0; i < 100; i++) {
       const n = crypto.randomInt(3);
       assert.ok(n >= 0);
@@ -609,7 +609,6 @@ describe('random', () => {
   [true, NaN, null, {}, [], 10].forEach((val) => {
     it(`expect type error: ${val}`, () => {
       assert.throws(
-        // @ts-expect-error bad callback
         () => crypto.randomInt(0, 1, val),
         /callback must be a function or undefined/,
       );

package.json

@@ -107,6 +107,9 @@
     "github": {
       "release": true
     },
+    "hooks": {
+      "before:release": "bun install && bun pods && git add example/ios/Podfile.lock"
+    },
     "plugins": {
       "@release-it/conventional-changelog": {
         "preset": {

src/Utils.ts

@@ -1,6 +1,6 @@
 import { Buffer as CraftzdogBuffer } from '@craftzdog/react-native-buffer';
 import { Buffer as SafeBuffer } from 'safe-buffer';
-import { Buffer as FerossBuffer } from 'buffer';
+
 import type {
   AnyAlgorithm,
   DeriveBitsAlgorithm,
@@ -18,14 +18,12 @@ import { type CipherKey } from 'crypto'; // @types/node
 export type BufferLike =
   | ArrayBuffer
   | CraftzdogBuffer
-  | FerossBuffer
   | SafeBuffer
   | ArrayBufferView;
 export type BinaryLike =
   | string
   | ArrayBuffer
   | CraftzdogBuffer
-  | FerossBuffer
   | SafeBuffer
   | TypedArray
   | DataView;
@@ -91,6 +89,8 @@ export type TypedArray =
   | Float32Array
   | Float64Array;
 
+export type ABV = TypedArray | DataView | ArrayBufferLike | CraftzdogBuffer;
+
 type DOMName =
   | string
   | {
@@ -182,18 +182,38 @@ export const kEmptyObject = Object.freeze(Object.create(null));
 //   return slowCases(enc);
 // }
 
+/**
+ * Converts supplied argument to an ArrayBuffer.  Note this does not copy the
+ * data so it is faster than toArrayBuffer.  Not copying is important for
+ * functions like randomFill which need to be able to write to the underlying
+ * buffer.
+ * @param buf
+ * @returns ArrayBuffer
+ */
+export function abvToArrayBuffer(buffer: ABV): ArrayBuffer {
+  if (CraftzdogBuffer.isBuffer(buffer) || ArrayBuffer.isView(buffer)) {
+    return buffer.buffer as ArrayBuffer;
+  }
+  return buffer as ArrayBuffer;
+}
+
+/**
+ * Converts supplied argument to an ArrayBuffer.  Note this copies data if the
+ * supplied buffer has the .slice() method, so can be a bit slow.
+ * @param buf
+ * @returns ArrayBuffer
+ */
 export function toArrayBuffer(
-  buf: CraftzdogBuffer | FerossBuffer | SafeBuffer | ArrayBufferView,
+  buf: CraftzdogBuffer | SafeBuffer | ArrayBufferView,
 ): ArrayBuffer {
-  if (
-    CraftzdogBuffer.isBuffer(buf) ||
-    FerossBuffer.isBuffer(buf) ||
-    ArrayBuffer.isView(buf)
-  ) {
+  if (CraftzdogBuffer.isBuffer(buf) || ArrayBuffer.isView(buf)) {
     if (buf?.buffer?.slice) {
-      return buf.buffer.slice(buf.byteOffset, buf.byteOffset + buf.byteLength);
+      return buf.buffer.slice(
+        buf.byteOffset,
+        buf.byteOffset + buf.byteLength,
+      ) as ArrayBuffer;
     } else {
-      return buf.buffer;
+      throw new Error('This implementation of buffer does not implement slice');
     }
   }
   const ab = new ArrayBuffer(buf.length);
@@ -205,11 +225,7 @@ export function toArrayBuffer(
 }
 
 export function bufferLikeToArrayBuffer(buf: BufferLike): ArrayBuffer {
-  if (
-    CraftzdogBuffer.isBuffer(buf) ||
-    FerossBuffer.isBuffer(buf) ||
-    SafeBuffer.isBuffer(buf)
-  ) {
+  if (CraftzdogBuffer.isBuffer(buf) || SafeBuffer.isBuffer(buf)) {
     return toArrayBuffer(buf);
   }
   if (ArrayBuffer.isView(buf)) {
@@ -239,11 +255,7 @@ export function binaryLikeToArrayBuffer(
   }
 
   // Buffer
-  if (
-    CraftzdogBuffer.isBuffer(input) ||
-    FerossBuffer.isBuffer(input) ||
-    SafeBuffer.isBuffer(input)
-  ) {
+  if (CraftzdogBuffer.isBuffer(input) || SafeBuffer.isBuffer(input)) {
     return toArrayBuffer(input);
   }
 
@@ -778,16 +790,6 @@ export const bigIntArrayToUnsignedInt = (
   return result;
 };
 
-export function abvToArrayBuffer(buffer: ArrayBufferView): ArrayBuffer {
-  if (CraftzdogBuffer.isBuffer(buffer)) {
-    return buffer.buffer;
-  }
-  if (ArrayBuffer.isView(buffer)) {
-    return buffer.buffer;
-  }
-  return buffer;
-}
-
 // TODO: these used to be shipped by crypto-browserify in quickcrypto v0.6
 // could instead fetch from OpenSSL if needed and handle breaking changes
 export const getHashes = () => [

src/random.ts

@@ -1,31 +1,29 @@
 import { abvToArrayBuffer } from './Utils';
 import { NativeQuickCrypto } from './NativeQuickCrypto/NativeQuickCrypto';
 import { Buffer } from '@craftzdog/react-native-buffer';
-import type { TypedArray } from './Utils';
+import type { ABV } from './Utils';
 
 const random = NativeQuickCrypto.random;
 
-type RandomBuffer = TypedArray | DataView | ArrayBufferLike | Buffer;
-
-export function randomFill<T extends RandomBuffer>(
+export function randomFill<T extends ABV>(
   buffer: T,
   callback: (err: Error | null, buf: T) => void,
 ): void;
 
-export function randomFill<T extends RandomBuffer>(
+export function randomFill<T extends ABV>(
   buffer: T,
   offset: number,
   callback: (err: Error | null, buf: T) => void,
 ): void;
 
-export function randomFill<T extends RandomBuffer>(
+export function randomFill<T extends ABV>(
   buffer: T,
   offset: number,
   size: number,
   callback: (err: Error | null, buf: T) => void,
 ): void;
 
-export function randomFill(buffer: RandomBuffer, ...rest: unknown[]): void {
+export function randomFill(buffer: ABV, ...rest: unknown[]): void {
   if (typeof rest[rest.length - 1] !== 'function') {
     throw new Error('No callback provided to randomFill');
   }
@@ -47,31 +45,25 @@ export function randomFill(buffer: RandomBuffer, ...rest: unknown[]): void {
     offset = rest[0] as number;
   }
 
-  random
-    .randomFill(abvToArrayBuffer(buffer as ArrayBufferView), offset, size)
-    .then(
-      (res: ArrayBuffer) => {
-        callback(null, res);
-      },
-      (e: Error) => {
-        callback(e);
-      },
-    );
+  random.randomFill(abvToArrayBuffer(buffer), offset, size).then(
+    (res: ArrayBuffer) => {
+      callback(null, res);
+    },
+    (e: Error) => {
+      callback(e);
+    },
+  );
 }
 
-export function randomFillSync<T extends RandomBuffer>(
+export function randomFillSync<T extends ABV>(
   buffer: T,
   offset?: number,
   size?: number,
 ): T;
 
-export function randomFillSync(
-  buffer: RandomBuffer,
-  offset: number = 0,
-  size?: number,
-) {
+export function randomFillSync(buffer: ABV, offset: number = 0, size?: number) {
   return random.randomFillSync(
-    abvToArrayBuffer(buffer as ArrayBufferView),
+    abvToArrayBuffer(buffer),
     offset,
     size ?? buffer.byteLength,
   );