CHANGE use eslint rule require-await to reduce build size

Author: pubkey

.eslintrc.json

@@ -17,7 +17,9 @@
   ],
   "parser": "@typescript-eslint/parser",
   "parserOptions": {
-    "extraFileExtensions": [".json"],
+    "extraFileExtensions": [
+      ".json"
+    ],
     "ecmaVersion": 2018,
     "sourceType": "module",
     "project": "./tsconfig.lint.json"
@@ -142,6 +144,10 @@
         ]
       }
     ],
+    // transpiling async-await produces a really big build size,
+    // so we try to not use async if we do not have an await.
+    "@typescript-eslint/require-await": "error",
+    "require-await": "error",
     // overrides
     // TODO: remove these rules one by one
     // to be better aligned with the recommended settings
@@ -156,14 +162,22 @@
     "@typescript-eslint/restrict-plus-operands": "off",
     "@typescript-eslint/await-thenable": "off",
     "@typescript-eslint/no-unnecessary-type-assertion": "off",
-    "@typescript-eslint/require-await": "off",
-    "require-await": "off",
     "@typescript-eslint/no-misused-promises": "off",
     "@typescript-eslint/restrict-template-expressions": "off",
     "no-prototype-builtins": "off",
     "@typescript-eslint/ban-types": "off",
-    "@typescript-eslint/no-unused-vars": ["error", { "argsIgnorePattern": "^_" }],
-    "no-unused-vars": ["error", { "argsIgnorePattern": "^_" }],
+    "@typescript-eslint/no-unused-vars": [
+      "error",
+      {
+        "argsIgnorePattern": "^_"
+      }
+    ],
+    "no-unused-vars": [
+      "error",
+      {
+        "argsIgnorePattern": "^_"
+      }
+    ],
     "@typescript-eslint/triple-slash-reference": "off",
     "@typescript-eslint/no-inferrable-types": "off",
     "@typescript-eslint/explicit-module-boundary-types": "off",

CHANGELOG.md

@@ -2,7 +2,7 @@
 # RxDB Changelog
 
 <!-- CHANGELOG NEWEST -->
-
+- CHANGE use eslint rule `require-await` to reduce build size.
 <!-- ADD new changes here! -->
 
 <!-- /CHANGELOG NEWEST -->

config/karma.conf.js

@@ -2,7 +2,7 @@
 
 // while the karma tests run, we need some things which we start here
 const GraphQLServer = require('../test_tmp/helper/graphql-server');
-async function thingsWeNeed() {
+function thingsWeNeed() {
     // we need one graphql server so the browser can sync to it
     GraphQLServer.spawn([], 18000);
 }

src/plugins/attachments.ts

@@ -5,7 +5,8 @@ import {
 import {
     blobBufferUtil,
     createRevision,
-    flatClone
+    flatClone,
+    PROMISE_RESOLVE_VOID
 } from './../util';
 import {
     newRxError
@@ -69,7 +70,7 @@ export class RxAttachment {
         _assignMethodsToAttachment(this);
     }
 
-    async remove(): Promise<void> {
+    remove(): Promise<void> {
         this.doc._atomicQueue = this.doc._atomicQueue
             .then(async () => {
                 const docWriteData: RxDocumentWriteData<{}> = flatCloneDocWithMeta(this.doc._data);
@@ -312,12 +313,12 @@ export async function preMigrateDocument<RxDocType>(
     }
 }
 
-export async function postMigrateDocument(_action: any): Promise<void> {
+export function postMigrateDocument(_action: any): Promise<void> {
     /**
      * No longer needed because
      * we store the attachemnts data buffers directly in the document.
      */
-    return;
+    return PROMISE_RESOLVE_VOID;
 }
 
 export const RxDBAttachmentsPlugin: RxPlugin = {

src/plugins/backup/file-util.ts

@@ -59,7 +59,7 @@ export function prepareFolders(
     });
 }
 
-export async function writeToFile(
+export function writeToFile(
     location: string,
     data: string | Buffer
 ): Promise<void> {
@@ -79,7 +79,7 @@ export async function writeToFile(
     });
 }
 
-export async function writeJsonToFile(
+export function writeJsonToFile(
     location: string,
     data: any
 ): Promise<void> {
@@ -96,7 +96,7 @@ export function metaFileLocation(options: BackupOptions): string {
     );
 }
 
-export async function getMeta(options: BackupOptions): Promise<BackupMetaFileContent> {
+export function getMeta(options: BackupOptions): Promise<BackupMetaFileContent> {
     const loc = metaFileLocation(options);
     return new Promise((res, rej) => {
         fs.readFile(loc, 'utf-8', (err, data) => {
@@ -110,7 +110,7 @@ export async function getMeta(options: BackupOptions): Promise<BackupMetaFileCon
     });
 }
 
-export async function setMeta(
+export function setMeta(
     options: BackupOptions,
     meta: BackupMetaFileContent
 ): Promise<void> {

src/plugins/backup/index.ts

@@ -122,7 +122,7 @@ export class RxBackupState {
      * Do not call this while it is already running.
      * Returns true if there are more documents to process
      */
-    public async persistOnce() {
+    public persistOnce() {
         return this.persistRunning = this.persistRunning.then(() => this._persistOnce());
     }
 

src/plugins/dexie/rx-storage-instance-dexie.ts

@@ -408,11 +408,12 @@ export class RxStorageInstanceDexie<RxDocType> implements RxStorageInstance<
         throw new Error('Attachments are not implemented in the dexie RxStorage. Make a pull request.');
     }
 
-    async close(): Promise<void> {
+    close(): Promise<void> {
         ensureNotClosed(this);
         this.closed = true;
         this.changes$.complete();
         closeDexieDb(this.internals);
+        return PROMISE_RESOLVE_VOID;
     }
 
     conflictResultionTasks(): Observable<RxConflictResultionTask<RxDocType>> {
@@ -423,7 +424,7 @@ export class RxStorageInstanceDexie<RxDocType> implements RxStorageInstance<
 }
 
 
-export async function createDexieStorageInstance<RxDocType>(
+export function createDexieStorageInstance<RxDocType>(
     storage: RxStorageDexie,
     params: RxStorageInstanceCreationParams<RxDocType, DexieSettings>,
     settings: DexieSettings
@@ -450,7 +451,7 @@ export async function createDexieStorageInstance<RxDocType>(
         instance
     );
 
-    return instance;
+    return Promise.resolve(instance);
 }
 
 

src/plugins/encryption.ts

@@ -221,7 +221,7 @@ export const RxDBEncryptionPlugin: RxPlugin = {
             }
         },
         preWriteAttachment: {
-            after: async (args) => {
+            after: (args) => {
                 const password = args.database.password;
                 const schema = args.schema
                 if (
@@ -236,7 +236,7 @@ export const RxDBEncryptionPlugin: RxPlugin = {
             }
         },
         postReadAttachment: {
-            after: async (args) => {
+            after: (args) => {
                 const password = args.database.password;
                 const schema = args.schema
                 if (

src/plugins/lokijs/rx-storage-instance-loki.ts

@@ -86,7 +86,7 @@ export class RxStorageInstanceLoki<RxDocType> implements RxStorageInstance<
             this.internals.leaderElector.awaitLeadership().then(() => {
                 // this instance is leader now, so it has to reply to queries from other instances
                 ensureNotFalsy(this.internals.leaderElector).broadcastChannel
-                    .addEventListener('message', async (msg) => handleRemoteRequest(this, msg));
+                    .addEventListener('message', (msg) => handleRemoteRequest(this, msg));
             });
         }
     }

src/plugins/memory/rx-storage-instance-memory.ts

@@ -29,6 +29,7 @@ import {
     getFromMapOrThrow,
     lastOfArray,
     now,
+    PROMISE_RESOLVE_TRUE,
     PROMISE_RESOLVE_VOID,
     RX_META_LWT_MINIMUM
 } from '../../util';
@@ -65,8 +66,8 @@ export class RxStorageInstanceMemory<RxDocType> implements RxStorageInstance<
 > {
 
     public readonly primaryPath: StringKeys<RxDocumentData<RxDocType>>;
-    private changes$: Subject<EventBulk<RxStorageChangeEvent<RxDocumentData<RxDocType>>, RxStorageDefaultCheckpoint>> = new Subject();
     public closed = false;
+    private changes$: Subject<EventBulk<RxStorageChangeEvent<RxDocumentData<RxDocType>>, RxStorageDefaultCheckpoint>> = new Subject();
 
     constructor(
         public readonly storage: RxStorageMemory,
@@ -167,7 +168,7 @@ export class RxStorageInstanceMemory<RxDocType> implements RxStorageInstance<
         return Promise.resolve(ret);
     }
 
-    async findDocumentsById(
+    findDocumentsById(
         docIds: string[],
         withDeleted: boolean
     ): Promise<RxDocumentDataById<RxDocType>> {
@@ -187,7 +188,7 @@ export class RxStorageInstanceMemory<RxDocType> implements RxStorageInstance<
         return Promise.resolve(ret);
     }
 
-    async query(preparedQuery: MemoryPreparedQuery<RxDocType>): Promise<RxStorageQueryResult<RxDocType>> {
+    query(preparedQuery: MemoryPreparedQuery<RxDocType>): Promise<RxStorageQueryResult<RxDocType>> {
         const queryPlan = preparedQuery.queryPlan;
         const query = preparedQuery.query;
         const skip = query.skip ? query.skip : 0;
@@ -261,12 +262,12 @@ export class RxStorageInstanceMemory<RxDocType> implements RxStorageInstance<
         // apply skip and limit boundaries.
         rows = rows.slice(skip, skipPlusLimit);
 
-        return {
+        return Promise.resolve({
             documents: rows
-        };
+        });
     }
 
-    async getChangedDocumentsSince(
+    getChangedDocumentsSince(
         limit: number,
         checkpoint?: RxStorageDefaultCheckpoint
     ): Promise<{
@@ -306,7 +307,7 @@ export class RxStorageInstanceMemory<RxDocType> implements RxStorageInstance<
         }
 
         const lastDoc = lastOfArray(rows);
-        return {
+        return Promise.resolve({
             documents: rows,
             checkpoint: lastDoc ? {
                 id: lastDoc[this.primaryPath] as any,
@@ -315,10 +316,10 @@ export class RxStorageInstanceMemory<RxDocType> implements RxStorageInstance<
                 id: '',
                 lwt: 0
             }
-        };
+        });
     }
 
-    async cleanup(minimumDeletedTime: number): Promise<boolean> {
+    cleanup(minimumDeletedTime: number): Promise<boolean> {
         const maxDeletionTime = now() - minimumDeletedTime;
         const index = ['_deleted', '_meta.lwt', this.primaryPath as any];
         const indexName = getMemoryIndexName(index);
@@ -357,7 +358,7 @@ export class RxStorageInstanceMemory<RxDocType> implements RxStorageInstance<
                 indexOfLower++;
             }
         }
-        return true;
+        return PROMISE_RESOLVE_TRUE;
     }
 
     getAttachmentData(documentId: string, attachmentId: string): Promise<string> {
@@ -384,12 +385,12 @@ export class RxStorageInstanceMemory<RxDocType> implements RxStorageInstance<
         await this.close();
     }
 
-    async close(): Promise<void> {
+    close(): Promise<void> {
         if (this.closed) {
-            throw newRxError('SNH', {
+            return Promise.reject(newRxError('SNH', {
                 database: this.databaseName,
                 collection: this.collectionName
-            });
+            }));
         }
         this.closed = true;
         this.changes$.complete();
@@ -400,6 +401,8 @@ export class RxStorageInstanceMemory<RxDocType> implements RxStorageInstance<
                 getMemoryCollectionKey(this.databaseName, this.collectionName)
             );
         }
+
+        return PROMISE_RESOLVE_VOID;
     }
 
     conflictResultionTasks(): Observable<RxConflictResultionTask<RxDocType>> {
@@ -410,7 +413,7 @@ export class RxStorageInstanceMemory<RxDocType> implements RxStorageInstance<
     }
 }
 
-export async function createMemoryStorageInstance<RxDocType>(
+export function createMemoryStorageInstance<RxDocType>(
     storage: RxStorageMemory,
     params: RxStorageInstanceCreationParams<RxDocType, RxStorageMemoryInstanceCreationOptions>,
     settings: RxStorageMemorySettings
@@ -442,5 +445,5 @@ export async function createMemoryStorageInstance<RxDocType>(
         params.options,
         settings
     );
-    return instance;
+    return Promise.resolve(instance);
 }

src/plugins/pouchdb/custom-events-plugin.ts

@@ -115,7 +115,7 @@ export function addCustomEventsPluginToPouch() {
     /**
      * Ensure we do not run bulkDocs() in parallel on the same PouchDB instance.
      */
-    const newBulkDocs = async function (
+    const newBulkDocs = function (
         this: PouchDBInstance,
         body: any[] | { docs: any[], new_edits?: boolean },
         options: PouchBulkDocOptions,

src/plugins/pouchdb/rx-storage-instance-pouch.ts

@@ -100,7 +100,7 @@ export class RxStorageInstancePouch<RxDocType> implements RxStorageInstance<
          */
         const emittedEventBulkIds: ObliviousSet<string> = new ObliviousSet(60 * 1000);
 
-        const eventSub = emitter.subject.subscribe(async (eventBulk) => {
+        const eventSub = emitter.subject.subscribe((eventBulk) => {
             if (
                 eventBulk.events.length === 0 ||
                 emittedEventBulkIds.has(eventBulk.id)

src/plugins/pouchdb/rx-storage-pouchdb.ts

@@ -47,7 +47,7 @@ export class RxStoragePouch implements RxStorage<PouchStorageInternals, PouchSet
         checkPouchAdapter(adapter);
     }
 
-    private async createPouch(
+    private createPouch(
         location: string,
         options: PouchSettings
     ): Promise<PouchDBInstance> {
@@ -75,7 +75,7 @@ export class RxStoragePouch implements RxStorage<PouchStorageInternals, PouchSet
          */
         // await pouch.info();
 
-        return pouch;
+        return Promise.resolve(pouch);
     }
 
     public async createStorageInstance<RxDocType>(
@@ -161,7 +161,7 @@ export async function createIndexesOnPouch(
     );
 
     await Promise.all(
-        schema.indexes.map(async (indexMaybeArray) => {
+        schema.indexes.map((indexMaybeArray) => {
             let indexArray: MaybeReadonly<string[]> = isMaybeReadonlyArray(indexMaybeArray) ? indexMaybeArray : [indexMaybeArray];
 
             /**

src/plugins/replication/index.ts

@@ -191,9 +191,9 @@ export class RxReplicationStateBase<RxDocType> {
     /**
      * Ensures that this._run() does not run in parallel
      */
-    async run(retryOnFail = true): Promise<void> {
+    run(retryOnFail = true): Promise<void> {
         if (this.isStopped()) {
-            return;
+            return PROMISE_RESOLVE_VOID;
         }
 
         if (this.runQueueCount > 2) {
@@ -231,7 +231,7 @@ export class RxReplicationStateBase<RxDocType> {
      * depending on when it is called and if another run() cycle is already
      * running.
      */
-    async notifyAboutRemoteChange() {
+    notifyAboutRemoteChange() {
         const callTime = now();
         return new Promise<void>(res => {
             this.runningPromise = this.runningPromise.then(() => {