Add Memory backend module

qqq-backend-core/src/main/java/com/kingsrook/qqq/backend/core/modules/backend/QBackendModuleDispatcher.java

@@ -72,6 +72,7 @@ public class QBackendModuleDispatcher
             // todo - let modules somehow "export" their types here?
             //  e.g., backend-core shouldn't need to "know" about the modules.
             "com.kingsrook.qqq.backend.core.modules.backend.implementations.mock.MockBackendModule",
+            "com.kingsrook.qqq.backend.core.modules.backend.implementations.memory.MemoryBackendModule",
             "com.kingsrook.qqq.backend.module.rdbms.RDBMSBackendModule",
             "com.kingsrook.qqq.backend.module.filesystem.local.FilesystemBackendModule",
             "com.kingsrook.qqq.backend.module.filesystem.s3.S3BackendModule"

qqq-backend-core/src/main/java/com/kingsrook/qqq/backend/core/modules/backend/implementations/memory/MemoryBackendModule.java

@@ -0,0 +1,116 @@
+/*
+ * QQQ - Low-code Application Framework for Engineers.
+ * Copyright (C) 2021-2022.  Kingsrook, LLC
+ * 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
+ * contact@kingsrook.com
+ * https://github.com/Kingsrook/
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+package com.kingsrook.qqq.backend.core.modules.backend.implementations.memory;
+
+
+import com.kingsrook.qqq.backend.core.actions.interfaces.CountInterface;
+import com.kingsrook.qqq.backend.core.actions.interfaces.DeleteInterface;
+import com.kingsrook.qqq.backend.core.actions.interfaces.InsertInterface;
+import com.kingsrook.qqq.backend.core.actions.interfaces.QueryInterface;
+import com.kingsrook.qqq.backend.core.actions.interfaces.UpdateInterface;
+import com.kingsrook.qqq.backend.core.model.metadata.QBackendMetaData;
+import com.kingsrook.qqq.backend.core.modules.backend.QBackendModuleInterface;
+
+
+/*******************************************************************************
+ ** A simple (probably only valid for testing?) implementation of the QModuleInterface,
+ ** that just stores its records in-memory.
+ **
+ *******************************************************************************/
+public class MemoryBackendModule implements QBackendModuleInterface
+{
+   /*******************************************************************************
+    ** Method where a backend module must be able to provide its type (name).
+    *******************************************************************************/
+   @Override
+   public String getBackendType()
+   {
+      return ("memory");
+   }
+
+
+
+   /*******************************************************************************
+    ** Method to identify the class used for backend meta data for this module.
+    *******************************************************************************/
+   @Override
+   public Class<? extends QBackendMetaData> getBackendMetaDataClass()
+   {
+      return (QBackendMetaData.class);
+   }
+
+
+
+   /*******************************************************************************
+    **
+    *******************************************************************************/
+   @Override
+   public CountInterface getCountInterface()
+   {
+      return new MemoryCountAction();
+   }
+
+
+
+   /*******************************************************************************
+    **
+    *******************************************************************************/
+   @Override
+   public QueryInterface getQueryInterface()
+   {
+      return new MemoryQueryAction();
+   }
+
+
+
+   /*******************************************************************************
+    **
+    *******************************************************************************/
+   @Override
+   public InsertInterface getInsertInterface()
+   {
+      return (new MemoryInsertAction());
+   }
+
+
+
+   /*******************************************************************************
+    **
+    *******************************************************************************/
+   @Override
+   public UpdateInterface getUpdateInterface()
+   {
+      return (new MemoryUpdateAction());
+   }
+
+
+
+   /*******************************************************************************
+    **
+    *******************************************************************************/
+   @Override
+   public DeleteInterface getDeleteInterface()
+   {
+      return (new MemoryDeleteAction());
+   }
+
+}

qqq-backend-core/src/main/java/com/kingsrook/qqq/backend/core/modules/backend/implementations/memory/MemoryCountAction.java

@@ -0,0 +1,54 @@
+/*
+ * QQQ - Low-code Application Framework for Engineers.
+ * Copyright (C) 2021-2022.  Kingsrook, LLC
+ * 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
+ * contact@kingsrook.com
+ * https://github.com/Kingsrook/
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+package com.kingsrook.qqq.backend.core.modules.backend.implementations.memory;
+
+
+import com.kingsrook.qqq.backend.core.actions.interfaces.CountInterface;
+import com.kingsrook.qqq.backend.core.exceptions.QException;
+import com.kingsrook.qqq.backend.core.model.actions.tables.count.CountInput;
+import com.kingsrook.qqq.backend.core.model.actions.tables.count.CountOutput;
+
+
+/*******************************************************************************
+ ** In-memory version of count action.
+ **
+ *******************************************************************************/
+public class MemoryCountAction implements CountInterface
+{
+
+   /*******************************************************************************
+    **
+    *******************************************************************************/
+   public CountOutput execute(CountInput countInput) throws QException
+   {
+      try
+      {
+         CountOutput countOutput = new CountOutput();
+         countOutput.setCount(MemoryRecordStore.getInstance().count(countInput));
+         return (countOutput);
+      }
+      catch(Exception e)
+      {
+         throw new QException("Error executing count", e);
+      }
+   }
+}

qqq-backend-core/src/main/java/com/kingsrook/qqq/backend/core/modules/backend/implementations/memory/MemoryDeleteAction.java

@@ -0,0 +1,55 @@
+/*
+ * QQQ - Low-code Application Framework for Engineers.
+ * Copyright (C) 2021-2022.  Kingsrook, LLC
+ * 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
+ * contact@kingsrook.com
+ * https://github.com/Kingsrook/
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+package com.kingsrook.qqq.backend.core.modules.backend.implementations.memory;
+
+
+import com.kingsrook.qqq.backend.core.actions.interfaces.DeleteInterface;
+import com.kingsrook.qqq.backend.core.exceptions.QException;
+import com.kingsrook.qqq.backend.core.model.actions.tables.delete.DeleteInput;
+import com.kingsrook.qqq.backend.core.model.actions.tables.delete.DeleteOutput;
+
+
+/*******************************************************************************
+ ** In-memory version of delete action.
+ **
+ *******************************************************************************/
+public class MemoryDeleteAction implements DeleteInterface
+{
+
+   /*******************************************************************************
+    **
+    *******************************************************************************/
+   public DeleteOutput execute(DeleteInput deleteInput) throws QException
+   {
+      try
+      {
+         DeleteOutput deleteOutput = new DeleteOutput();
+         deleteOutput.setDeletedRecordCount(MemoryRecordStore.getInstance().delete(deleteInput));
+         return (deleteOutput);
+      }
+      catch(Exception e)
+      {
+         throw new QException("Error executing delete: " + e.getMessage(), e);
+      }
+   }
+
+}

qqq-backend-core/src/main/java/com/kingsrook/qqq/backend/core/modules/backend/implementations/memory/MemoryInsertAction.java

@@ -0,0 +1,55 @@
+/*
+ * QQQ - Low-code Application Framework for Engineers.
+ * Copyright (C) 2021-2022.  Kingsrook, LLC
+ * 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
+ * contact@kingsrook.com
+ * https://github.com/Kingsrook/
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+package com.kingsrook.qqq.backend.core.modules.backend.implementations.memory;
+
+
+import com.kingsrook.qqq.backend.core.actions.interfaces.InsertInterface;
+import com.kingsrook.qqq.backend.core.exceptions.QException;
+import com.kingsrook.qqq.backend.core.model.actions.tables.insert.InsertInput;
+import com.kingsrook.qqq.backend.core.model.actions.tables.insert.InsertOutput;
+
+
+/*******************************************************************************
+ ** In-memory version of insert action.
+ **
+ *******************************************************************************/
+public class MemoryInsertAction implements InsertInterface
+{
+
+   /*******************************************************************************
+    **
+    *******************************************************************************/
+   public InsertOutput execute(InsertInput insertInput) throws QException
+   {
+      try
+      {
+         InsertOutput insertOutput = new InsertOutput();
+         insertOutput.setRecords(MemoryRecordStore.getInstance().insert(insertInput, true));
+         return (insertOutput);
+      }
+      catch(Exception e)
+      {
+         throw new QException("Error executing insert: " + e.getMessage(), e);
+      }
+   }
+
+}

qqq-backend-core/src/main/java/com/kingsrook/qqq/backend/core/modules/backend/implementations/memory/MemoryQueryAction.java

@@ -0,0 +1,55 @@
+/*
+ * QQQ - Low-code Application Framework for Engineers.
+ * Copyright (C) 2021-2022.  Kingsrook, LLC
+ * 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
+ * contact@kingsrook.com
+ * https://github.com/Kingsrook/
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+package com.kingsrook.qqq.backend.core.modules.backend.implementations.memory;
+
+
+import com.kingsrook.qqq.backend.core.actions.interfaces.QueryInterface;
+import com.kingsrook.qqq.backend.core.exceptions.QException;
+import com.kingsrook.qqq.backend.core.model.actions.tables.query.QueryInput;
+import com.kingsrook.qqq.backend.core.model.actions.tables.query.QueryOutput;
+
+
+/*******************************************************************************
+ ** In-memory version of query action.
+ **
+ *******************************************************************************/
+public class MemoryQueryAction implements QueryInterface
+{
+
+   /*******************************************************************************
+    **
+    *******************************************************************************/
+   public QueryOutput execute(QueryInput queryInput) throws QException
+   {
+      try
+      {
+         QueryOutput queryOutput = new QueryOutput(queryInput);
+         queryOutput.addRecords(MemoryRecordStore.getInstance().query(queryInput));
+         return (queryOutput);
+      }
+      catch(Exception e)
+      {
+         throw new QException("Error executing query", e);
+      }
+   }
+
+}

qqq-backend-core/src/main/java/com/kingsrook/qqq/backend/core/modules/backend/implementations/memory/MemoryRecordStore.java

@@ -0,0 +1,238 @@
+/*
+ * QQQ - Low-code Application Framework for Engineers.
+ * Copyright (C) 2021-2022.  Kingsrook, LLC
+ * 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
+ * contact@kingsrook.com
+ * https://github.com/Kingsrook/
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+package com.kingsrook.qqq.backend.core.modules.backend.implementations.memory;
+
+
+import java.io.Serializable;
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import com.kingsrook.qqq.backend.core.model.actions.tables.count.CountInput;
+import com.kingsrook.qqq.backend.core.model.actions.tables.delete.DeleteInput;
+import com.kingsrook.qqq.backend.core.model.actions.tables.insert.InsertInput;
+import com.kingsrook.qqq.backend.core.model.actions.tables.query.QueryInput;
+import com.kingsrook.qqq.backend.core.model.actions.tables.update.UpdateInput;
+import com.kingsrook.qqq.backend.core.model.data.QRecord;
+import com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldMetaData;
+import com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldType;
+import com.kingsrook.qqq.backend.core.model.metadata.tables.QTableMetaData;
+
+
+/*******************************************************************************
+ ** Storage provider for the MemoryBackendModule
+ *******************************************************************************/
+public class MemoryRecordStore
+{
+   private static MemoryRecordStore instance;
+
+   private Map<String, Map<Serializable, QRecord>> data;
+   private Map<String, Integer>                    nextSerials;
+
+
+
+   /*******************************************************************************
+    ** private singleton constructor
+    *******************************************************************************/
+   private MemoryRecordStore()
+   {
+      data = new HashMap<>();
+      nextSerials = new HashMap<>();
+   }
+
+
+
+   /*******************************************************************************
+    ** Forget all data in the memory store...
+    *******************************************************************************/
+   public void reset()
+   {
+      data.clear();
+      nextSerials.clear();
+   }
+
+
+
+   /*******************************************************************************
+    ** singleton accessor
+    *******************************************************************************/
+   public static MemoryRecordStore getInstance()
+   {
+      if(instance == null)
+      {
+         instance = new MemoryRecordStore();
+      }
+      return (instance);
+   }
+
+
+
+   /*******************************************************************************
+    **
+    *******************************************************************************/
+   private Map<Serializable, QRecord> getTableData(QTableMetaData table)
+   {
+      if(!data.containsKey(table.getName()))
+      {
+         data.put(table.getName(), new HashMap<>());
+      }
+      return (data.get(table.getName()));
+   }
+
+
+
+   /*******************************************************************************
+    **
+    *******************************************************************************/
+   public List<QRecord> query(QueryInput input)
+   {
+      Map<Serializable, QRecord> tableData = getTableData(input.getTable());
+      List<QRecord>              records   = new ArrayList<>(tableData.values());
+      // todo - filtering
+      return (records);
+   }
+
+
+
+   /*******************************************************************************
+    **
+    *******************************************************************************/
+   public Integer count(CountInput input)
+   {
+      Map<Serializable, QRecord> tableData = getTableData(input.getTable());
+      List<QRecord>              records   = new ArrayList<>(tableData.values());
+      // todo - filtering
+      return (records.size());
+   }
+
+
+
+   /*******************************************************************************
+    **
+    *******************************************************************************/
+   public List<QRecord> insert(InsertInput input, boolean returnInsertedRecords)
+   {
+      if(input.getRecords() == null)
+      {
+         return (new ArrayList<>());
+      }
+
+      QTableMetaData             table      = input.getTable();
+      Map<Serializable, QRecord> tableData  = getTableData(table);
+      Integer                    nextSerial = nextSerials.get(table.getName());
+      if(nextSerial == null)
+      {
+         nextSerial = 1;
+         while(tableData.containsKey(nextSerial))
+         {
+            nextSerial++;
+         }
+      }
+
+      List<QRecord>  outputRecords   = new ArrayList<>();
+      QFieldMetaData primaryKeyField = table.getField(table.getPrimaryKeyField());
+      for(QRecord record : input.getRecords())
+      {
+         if(record.getValue(primaryKeyField.getName()) == null && primaryKeyField.getType().equals(QFieldType.INTEGER))
+         {
+            record.setValue(primaryKeyField.getName(), nextSerial++);
+         }
+
+         tableData.put(record.getValue(primaryKeyField.getName()), record);
+         if(returnInsertedRecords)
+         {
+            outputRecords.add(record);
+         }
+      }
+
+      return (outputRecords);
+   }
+
+
+
+   /*******************************************************************************
+    **
+    *******************************************************************************/
+   public List<QRecord> update(UpdateInput input, boolean returnUpdatedRecords)
+   {
+      if(input.getRecords() == null)
+      {
+         return (new ArrayList<>());
+      }
+
+      QTableMetaData             table     = input.getTable();
+      Map<Serializable, QRecord> tableData = getTableData(table);
+
+      List<QRecord>  outputRecords   = new ArrayList<>();
+      QFieldMetaData primaryKeyField = table.getField(table.getPrimaryKeyField());
+      for(QRecord record : input.getRecords())
+      {
+         Serializable primaryKeyValue = record.getValue(primaryKeyField.getName());
+         if(tableData.containsKey(primaryKeyValue))
+         {
+            QRecord recordToUpdate = tableData.get(primaryKeyValue);
+            for(Map.Entry<String, Serializable> valueEntry : record.getValues().entrySet())
+            {
+               recordToUpdate.setValue(valueEntry.getKey(), valueEntry.getValue());
+            }
+
+            if(returnUpdatedRecords)
+            {
+               outputRecords.add(record);
+            }
+         }
+         else
+         {
+            outputRecords.add(record);
+         }
+      }
+
+      return (outputRecords);
+   }
+
+
+
+   /*******************************************************************************
+    **
+    *******************************************************************************/
+   public int delete(DeleteInput input)
+   {
+      if(input.getPrimaryKeys() == null)
+      {
+         return (0);
+      }
+
+      QTableMetaData             table       = input.getTable();
+      Map<Serializable, QRecord> tableData   = getTableData(table);
+      int                        rowsDeleted = 0;
+      for(Serializable primaryKeyValue : input.getPrimaryKeys())
+      {
+         if(tableData.containsKey(primaryKeyValue))
+         {
+            tableData.remove(primaryKeyValue);
+            rowsDeleted++;
+         }
+      }
+
+      return (rowsDeleted);
+   }
+}

qqq-backend-core/src/main/java/com/kingsrook/qqq/backend/core/modules/backend/implementations/memory/MemoryUpdateAction.java

@@ -0,0 +1,55 @@
+/*
+ * QQQ - Low-code Application Framework for Engineers.
+ * Copyright (C) 2021-2022.  Kingsrook, LLC
+ * 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
+ * contact@kingsrook.com
+ * https://github.com/Kingsrook/
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+package com.kingsrook.qqq.backend.core.modules.backend.implementations.memory;
+
+
+import com.kingsrook.qqq.backend.core.actions.interfaces.UpdateInterface;
+import com.kingsrook.qqq.backend.core.exceptions.QException;
+import com.kingsrook.qqq.backend.core.model.actions.tables.update.UpdateInput;
+import com.kingsrook.qqq.backend.core.model.actions.tables.update.UpdateOutput;
+
+
+/*******************************************************************************
+ ** In-memory version of update action.
+ **
+ *******************************************************************************/
+public class MemoryUpdateAction implements UpdateInterface
+{
+
+   /*******************************************************************************
+    **
+    *******************************************************************************/
+   public UpdateOutput execute(UpdateInput updateInput) throws QException
+   {
+      try
+      {
+         UpdateOutput updateOutput = new UpdateOutput();
+         updateOutput.setRecords(MemoryRecordStore.getInstance().update(updateInput, true));
+         return (updateOutput);
+      }
+      catch(Exception e)
+      {
+         throw new QException("Error executing update: " + e.getMessage(), e);
+      }
+   }
+
+}