Merge branch 'v1.3-dev'

[websub-hub] / src / db / sqlite / index.js

diff --git a/src/db/sqlite/index.js b/src/db/sqlite/index.js
index cc4ea90af056db2c99f747f2705e25829801749a..6100d491a909547912cc6bdea61419706b4962e3 100644 (file)
--- a/src/db/sqlite/index.js
+++ b/src/db/sqlite/index.js
@@ -19,8 +19,8 @@ const schemaVersionsSupported = {
   },
   max: {
     major: 1,
   },
   max: {
     major: 1,

-    minor: 0,
-    patch: 3,
+    minor: 1,
+    patch: 0,

   },
 };
 
   },
 };
 


@@ -48,7 +48,7 @@ class DatabaseSQLite extends Database {
     this.db = new SQLite(dbFilename, sqliteOptions);
     this.schemaVersionsSupported = schemaVersionsSupported;
     this.changesSinceLastOptimize = BigInt(0);
     this.db = new SQLite(dbFilename, sqliteOptions);
     this.schemaVersionsSupported = schemaVersionsSupported;
     this.changesSinceLastOptimize = BigInt(0);

-    this.optimizeAfterChanges = options.db.connectionString.optimizeAfterChanges;
+    this.optimizeAfterChanges = options.db.optimizeAfterChanges;

     this.db.pragma('foreign_keys = on'); // Enforce consistency.
     this.db.pragma('journal_mode = WAL'); // Be faster, expect local filesystem.
     this.db.defaultSafeIntegers(true); // This probably isn't necessary, but by using these BigInts we keep weird floats out of the query logs.
     this.db.pragma('foreign_keys = on'); // Enforce consistency.
     this.db.pragma('journal_mode = WAL'); // Be faster, expect local filesystem.
     this.db.defaultSafeIntegers(true); // This probably isn't necessary, but by using these BigInts we keep weird floats out of the query logs.


@@ -70,7 +70,7 @@ class DatabaseSQLite extends Database {
     let metaExists = tableExists.get();
     if (metaExists === undefined) {
       const fPath = path.join(__dirname, 'sql', 'schema', 'init.sql');
     let metaExists = tableExists.get();
     if (metaExists === undefined) {
       const fPath = path.join(__dirname, 'sql', 'schema', 'init.sql');

-      // eslint-disable-next-line security/detect-non-literal-fs-filename
+       

       const fSql = fs.readFileSync(fPath, { encoding: 'utf8' });
       this.db.exec(fSql);
       metaExists = tableExists.get();
       const fSql = fs.readFileSync(fPath, { encoding: 'utf8' });
       this.db.exec(fSql);
       metaExists = tableExists.get();


@@ -131,7 +131,7 @@ class DatabaseSQLite extends Database {
       };
     };
 
       };
     };
 

-    // eslint-disable-next-line security/detect-non-literal-fs-filename
+     

     for (const f of fs.readdirSync(sqlDir)) {
       const fPath = path.join(sqlDir, f);
       const { name: fName, ext: fExt } = path.parse(f);
     for (const f of fs.readdirSync(sqlDir)) {
       const fPath = path.join(sqlDir, f);
       const { name: fName, ext: fExt } = path.parse(f);


@@ -241,7 +241,7 @@ class DatabaseSQLite extends Database {
         'verification_in_progress',
         'subscription',
         'subscription_delivery_in_progress',
         'verification_in_progress',
         'subscription',
         'subscription_delivery_in_progress',

-      ].map((table) => {
+      ].forEach((table) => {

         const result = this.db.prepare(`DELETE FROM ${table}`).run();
         this.logger.debug(_fileScope('_purgeTables'), 'success', { table, result });
       });
         const result = this.db.prepare(`DELETE FROM ${table}`).run();
         this.logger.debug(_fileScope('_purgeTables'), 'success', { table, result });
       });


@@ -290,19 +290,56 @@ class DatabaseSQLite extends Database {
   }
 
 
   }
 
 

-  authenticationUpsert(dbCtx, identifier, credential) {
+  authenticationUpsert(dbCtx, identifier, credential, otpKey) {

     const _scope = _fileScope('authenticationUpsert');
     const scrubbedCredential = '*'.repeat((credential || '').length);
     const _scope = _fileScope('authenticationUpsert');
     const scrubbedCredential = '*'.repeat((credential || '').length);

-    this.logger.debug(_scope, 'called', { identifier, scrubbedCredential });
+    const scrubbedOTPKey = '*'.repeat((otpKey || '').length) || null;
+    this.logger.debug(_scope, 'called', { identifier, scrubbedCredential, scrubbedOTPKey });

 
     let result;
     try {
 
     let result;
     try {

-      result = this.statement.authenticationUpsert.run({ identifier, credential });
+      result = this.statement.authenticationUpsert.run({ identifier, credential, otpKey });

       if (result.changes != 1) {
         throw new DBErrors.UnexpectedResult('did not upsert authentication');
       }
     } catch (e) {
       if (result.changes != 1) {
         throw new DBErrors.UnexpectedResult('did not upsert authentication');
       }
     } catch (e) {

-      this.logger.error(_scope, 'failed', { error: e, identifier, scrubbedCredential })
+      this.logger.error(_scope, 'failed', { error: e, identifier, scrubbedCredential, scrubbedOTPKey });
+      throw e;
+    }
+  }
+
+
+  authenticationUpdateOTPKey(dbCtx, identifier, otpKey) {
+    const _scope = _fileScope('authenticationUpdateOTPKey');
+    const scrubbedOTPKey = '*'.repeat((otpKey || '').length) || null;
+    this.logger.debug(_scope, 'called', { identifier, scrubbedOTPKey });
+
+    let result;
+    try {
+      result = this.statement.authenticationUpdateOtpKey.run({ identifier, otpKey });
+      if (result.changes != 1) {
+        throw new DBErrors.UnexpectedResult('did not update authentication otp key');
+      }
+    } catch (e) {
+      this.logger.error(_scope, 'failed', { error: e, identifier, scrubbedOTPKey });
+      throw e;
+    }
+  }
+
+
+  authenticationUpdateCredential(dbCtx, identifier, credential) {
+    const _scope = _fileScope('authenticationUpdateCredential');
+    const scrubbedCredential = '*'.repeat((credential || '').length);
+    this.logger.debug(_scope, 'called', { identifier, scrubbedCredential });
+
+    let result;
+    try {
+      result = this.statement.authenticationUpdateCredential.run({ identifier, credential });
+      if (result.changes != 1) {
+        throw new DBErrors.UnexpectedResult('did not update authentication credential');
+      }
+    } catch (e) {
+      this.logger.error(_scope, 'failed', { error: e, identifier, scrubbedCredential });

       throw e;
     }
   }
       throw e;
     }
   }


@@ -310,7 +347,8 @@ class DatabaseSQLite extends Database {
 
   /**
    * Converts engine subscription fields to native types.
 
   /**
    * Converts engine subscription fields to native types.

-   * @param {Object} data
+   * @param {object} data subscription data
+   * @returns {object} data

    */
   static _subscriptionDataToNative(data) {
     if (data) {
    */
   static _subscriptionDataToNative(data) {
     if (data) {


@@ -558,7 +596,7 @@ class DatabaseSQLite extends Database {
       httpRemoteAddr: null,
       httpFrom: null,
       ...data,
       httpRemoteAddr: null,
       httpFrom: null,
       ...data,

-    }
+    };

     this._subscriptionUpsertDataValidate(subscriptionData);
 
     let result;
     this._subscriptionUpsertDataValidate(subscriptionData);
 
     let result;


@@ -704,7 +742,8 @@ class DatabaseSQLite extends Database {
 
   /**
    * Converts engine topic fields to native types.
 
   /**
    * Converts engine topic fields to native types.

-   * @param {Object} data
+   * @param {object} data topic
+   * @returns {object} topic data

    */
   static _topicDataToNative(data) {
     if (data) {
    */
   static _topicDataToNative(data) {
     if (data) {


@@ -759,7 +798,7 @@ class DatabaseSQLite extends Database {
   }
 
 
   }
 
 

-  topicGetByUrl(dbCtx, topicUrl) {
+  topicGetByUrl(dbCtx, topicUrl, applyDefaults = true) {

     const _scope = _fileScope('topicGetByUrl');
     this.logger.debug(_scope, 'called', { topicUrl });
 
     const _scope = _fileScope('topicGetByUrl');
     this.logger.debug(_scope, 'called', { topicUrl });
 


@@ -767,7 +806,10 @@ class DatabaseSQLite extends Database {
     try {
       topic = this.statement.topicGetByUrl.get({ topicUrl });
       DatabaseSQLite._topicDataToNative(topic);
     try {
       topic = this.statement.topicGetByUrl.get({ topicUrl });
       DatabaseSQLite._topicDataToNative(topic);

-      return this._topicDefaults(topic);
+      if (applyDefaults) {
+        topic = this._topicDefaults(topic);
+      }
+      return topic;

     } catch (e) {
       this.logger.error(_scope, 'failed', { error: e, topic, topicUrl });
       throw e;
     } catch (e) {
       this.logger.error(_scope, 'failed', { error: e, topic, topicUrl });
       throw e;


@@ -824,11 +866,12 @@ class DatabaseSQLite extends Database {
 
   topicPublishHistory(dbCtx, topicId, days) {
     const _scope = _fileScope('topicPublishHistory');
 
   topicPublishHistory(dbCtx, topicId, days) {
     const _scope = _fileScope('topicPublishHistory');

-    this.logger.debug(_scope, 'called', { topicId, days })
+    this.logger.debug(_scope, 'called', { topicId, days });

 
     const events = this.statement.topicPublishHistory.all({ topicId, daysAgo: days });
     const history = Array.from({ length: days }, () => 0);
 
     const events = this.statement.topicPublishHistory.all({ topicId, daysAgo: days });
     const history = Array.from({ length: days }, () => 0);

-    events.forEach(({ daysAgo, contentUpdates }) => history[daysAgo] = contentUpdates);
+    // eslint-disable-next-line security/detect-object-injection
+    events.forEach(({ daysAgo, contentUpdates }) => history[daysAgo] = Number(contentUpdates));

 
     return history;
   }
 
     return history;
   }


@@ -865,6 +908,8 @@ class DatabaseSQLite extends Database {
     const _scope = _fileScope('topicSetContent');
     const topicSetContentData = {
       contentType: null,
     const _scope = _fileScope('topicSetContent');
     const topicSetContentData = {
       contentType: null,

+      httpETag: null,
+      httpLastModified: null,

       ...data,
     };
     const logData = {
       ...data,
     };
     const logData = {


@@ -881,7 +926,11 @@ class DatabaseSQLite extends Database {
       if (result.changes !=  1) {
         throw new DBErrors.UnexpectedResult('did not set topic content');
       }
       if (result.changes !=  1) {
         throw new DBErrors.UnexpectedResult('did not set topic content');
       }

-      result = this.statement.topicSetContentHistory.run({ topicId: data.topicId, contentHash: data.contentHash, contentSize: data.content.length });
+      result = this.statement.topicSetContentHistory.run({
+        topicId: data.topicId,
+        contentHash: data.contentHash,
+        contentSize: data.content.length,
+      });

       if (result.changes != 1) {
         throw new DBErrors.UnexpectedResult('did not set topic content history');
       }
       if (result.changes != 1) {
         throw new DBErrors.UnexpectedResult('did not set topic content history');
       }


@@ -982,7 +1031,7 @@ class DatabaseSQLite extends Database {
 
   /**
    * Converts engine verification fields to native types.
 
   /**
    * Converts engine verification fields to native types.

-   * @param {Object} data
+   * @param {object} data verification

    */
   static _verificationDataToNative(data) {
     if (data) {
    */
   static _verificationDataToNative(data) {
     if (data) {


@@ -1036,6 +1085,7 @@ class DatabaseSQLite extends Database {
 
   /**
    * Convert native verification fields to engine types.
 
   /**
    * Convert native verification fields to engine types.

+   * @param {object} data verification

    */
   static _verificationDataToEngine(data) {
     if (data) {
    */
   static _verificationDataToEngine(data) {
     if (data) {


@@ -1136,4 +1186,4 @@ class DatabaseSQLite extends Database {
 
 }
 
 
 }
 

-module.exports = DatabaseSQLite;
\ No newline at end of file
+module.exports = DatabaseSQLite;