Fixed not enumerating documents with keys starting with \xff

Author: keijokapp

lib/adapter.js

@@ -47,6 +47,41 @@ const UUID_KEY = '_local_uuid';
 
 const MD5_PREFIX = 'md5-';
 
+const nullBuffer = Buffer.alloc(1);
+const ffBuffer = Buffer.from([0xff]);
+const startOfKeyspace = Symbol('start of keyspace');
+const endOfKeyspace = Symbol('end of keyspace');
+
+/**
+ * A custom encoder is needed due to https://github.com/josephg/node-foundationdb/issues/78
+ * @type {import('foundationdb/dist/lib/transformer.js').Transformer<
+ *   import('./types.js').Id | typeof startOfKeyspace | typeof endOfKeyspace,
+ *   import('./types.js').Id
+ * >}
+ */
+const idEncoder = {
+	pack(id) {
+		if (id === startOfKeyspace) {
+			return nullBuffer;
+		}
+
+		if (id === endOfKeyspace) {
+			return ffBuffer;
+		}
+
+		const idBuffer = Buffer.from(id, 'binary');
+
+		return Buffer.concat([nullBuffer, idBuffer]);
+	},
+	unpack(idBuffer) {
+		if (idBuffer[0] !== 0 && idBuffer.length > 1) {
+			throw new Error('Invalid ID');
+		}
+
+		return /** @type {import('./types.js').Id} */(idBuffer.subarray(1).toString('binary'));
+	}
+};
+
 /**
  * @type {import('foundationdb/dist/lib/transformer.js').Transformer<number, number>}
  */
@@ -125,11 +160,11 @@ export default function FoundationdbAdapter(api, { db, name, revs_limit: revLimi
 
 	const stores = {
 		/* eslint-disable max-len */
-		docStore: /** @type {fdb.Subspace<import('./types.js').Id, import('./types.js').Id, import('./types.js').Metadata, import('./types.js').Metadata>} */(
-			/** @type {unknown} */(subspace.at(fdb.tuple.pack(DOC_STORE), undefined, fdb.encoders.json))
+		docStore: /** @type {fdb.Subspace<import('./types.js').Id | typeof startOfKeyspace | typeof endOfKeyspace, import('./types.js').Id, import('./types.js').Metadata, import('./types.js').Metadata>} */(
+			subspace.at(fdb.tuple.pack(DOC_STORE), idEncoder, fdb.encoders.json)
 		),
 		bySeqStore: /** @type {fdb.Subspace<number, number, import('./types.js').Doc, import('./types.js').Doc>} */(
-			/** @type {unknown} */(subspace.at(fdb.tuple.pack(BY_SEQ_STORE), seqEncoder, fdb.encoders.json))
+			subspace.at(fdb.tuple.pack(BY_SEQ_STORE), seqEncoder, fdb.encoders.json)
 		),
 		attachmentStore: /** @type {fdb.Subspace<import('./types.js').Digest, import('./types.js').Digest, import('./types.js').AttachmentRef, import('./types.js').AttachmentRef>} */(
 			/** @type {unknown} */(subspace.at(fdb.tuple.pack(ATTACHMENT_STORE), undefined, fdb.encoders.json))
@@ -640,15 +675,15 @@ export default function FoundationdbAdapter(api, { db, name, revs_limit: revLimi
 		// eslint-disable-next-line no-nested-ternary
 		const start = gte !== undefined
 			? (!inclusiveEnd && reverse ? ks.firstGreaterThan(gte) : gte)
-			: '';
+			: startOfKeyspace;
 		// eslint-disable-next-line no-nested-ternary
 		const end = lte !== undefined
 			? (!inclusiveEnd && !reverse ? lte : ks.firstGreaterThan(lte))
-			: '\xff'; // TODO: make sure that ID-s starting with 0xff are also included
+			: endOfKeyspace;
 
 		const it = tn.at(stores.docStore).getRange(
-			/** @type {any} */(start),
-			/** @type {any} */(end),
+			start,
+			end,
 			reverse ? { reverse: true } : undefined
 		);