feat: add forms feature set

packages/backend/package.json

@@ -69,6 +69,7 @@
     "prettier": "^2.5.1",
     "raw-body": "^2.5.2",
     "showdown": "^2.1.0",
+    "slugify": "^1.6.6",
     "uuid": "^9.0.1",
     "winston": "^3.7.1",
     "xmlrpc": "^1.3.2"

packages/backend/src/apps/forms/assets/favicon.svg

@@ -0,0 +1 @@
+<svg xmlns:xlink="http://www.w3.org/1999/xlink" xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24"><path fill="#000000" d="M17 20v-9h-2V4h7l-2 5h2zm-2-7v7H4c-1.1 0-2-.9-2-2v-3c0-1.1.9-2 2-2zm-8.75 2.75h-1.5v1.5h1.5zM13 4v7H4c-1.1 0-2-.9-2-2V6c0-1.1.9-2 2-2zM6.25 6.75h-1.5v1.5h1.5z"></path></svg>

packages/backend/src/apps/forms/common/add-auth-header.js

@@ -0,0 +1,16 @@
+const addAuthHeader = ($, requestConfig) => {
+  requestConfig.headers['Content-Type'] = 'application/json';
+
+  if ($.auth.data?.apiKey && $.auth.data?.projectId) {
+    requestConfig.headers['X-Appwrite-Project'] = $.auth.data.projectId;
+    requestConfig.headers['X-Appwrite-Key'] = $.auth.data.apiKey;
+  }
+
+  if ($.auth.data?.host) {
+    requestConfig.headers['Host'] = $.auth.data.host;
+  }
+
+  return requestConfig;
+};
+
+export default addAuthHeader;

packages/backend/src/apps/forms/common/set-base-url.js

@@ -0,0 +1,13 @@
+const setBaseUrl = ($, requestConfig) => {
+  const instanceUrl = $.auth.data.instanceUrl;
+
+  if (instanceUrl) {
+    requestConfig.baseURL = instanceUrl;
+  } else if ($.app.apiBaseUrl) {
+    requestConfig.baseURL = $.app.apiBaseUrl;
+  }
+
+  return requestConfig;
+};
+
+export default setBaseUrl;

packages/backend/src/apps/forms/dynamic-data/index.js

@@ -0,0 +1,4 @@
+import listCollections from './list-collections/index.js';
+import listDatabases from './list-databases/index.js';
+
+export default [listCollections, listDatabases];

packages/backend/src/apps/forms/dynamic-data/list-collections/index.js

@@ -0,0 +1,44 @@
+export default {
+  name: 'List collections',
+  key: 'listCollections',
+
+  async run($) {
+    const collections = {
+      data: [],
+    };
+    const databaseId = $.step.parameters.databaseId;
+
+    if (!databaseId) {
+      return collections;
+    }
+
+    const params = {
+      queries: [
+        JSON.stringify({
+          method: 'orderAsc',
+          attribute: 'name',
+        }),
+        JSON.stringify({
+          method: 'limit',
+          values: [100],
+        }),
+      ],
+    };
+
+    const { data } = await $.http.get(
+      `/v1/databases/${databaseId}/collections`,
+      { params }
+    );
+
+    if (data?.collections) {
+      for (const collection of data.collections) {
+        collections.data.push({
+          value: collection.$id,
+          name: collection.name,
+        });
+      }
+    }
+
+    return collections;
+  },
+};

packages/backend/src/apps/forms/dynamic-data/list-databases/index.js

@@ -0,0 +1,36 @@
+export default {
+  name: 'List databases',
+  key: 'listDatabases',
+
+  async run($) {
+    const databases = {
+      data: [],
+    };
+
+    const params = {
+      queries: [
+        JSON.stringify({
+          method: 'orderAsc',
+          attribute: 'name',
+        }),
+        JSON.stringify({
+          method: 'limit',
+          values: [100],
+        }),
+      ],
+    };
+
+    const { data } = await $.http.get('/v1/databases', { params });
+
+    if (data?.databases) {
+      for (const database of data.databases) {
+        databases.data.push({
+          value: database.$id,
+          name: database.name,
+        });
+      }
+    }
+
+    return databases;
+  },
+};

packages/backend/src/apps/forms/index.js

@@ -0,0 +1,14 @@
+import defineApp from '../../helpers/define-app.js';
+import triggers from './triggers/index.js';
+
+export default defineApp({
+  name: 'Forms',
+  key: 'forms',
+  iconUrl: '{BASE_URL}/apps/forms/assets/favicon.svg',
+  authDocUrl: '{DOCS_URL}/apps/forms/connection',
+  supportsConnections: false,
+  baseUrl: '',
+  apiBaseUrl: '',
+  primaryColor: '#0059F7',
+  triggers,
+});

packages/backend/src/apps/forms/triggers/form-submission/index.js

@@ -0,0 +1,64 @@
+import Crypto from 'crypto';
+import isEmpty from 'lodash/isEmpty.js';
+import defineTrigger from '../../../../helpers/define-trigger.js';
+
+export default defineTrigger({
+  name: 'New form submission',
+  key: 'newFormSubmission',
+  pollInterval: 15,
+  type: 'webhook',
+  description: 'Triggers when a new form is submitted.',
+  arguments: [
+    {
+      label: 'Fields',
+      key: 'fields',
+      type: 'dynamic',
+      required: false,
+      description: 'Add or remove fields as needed',
+      value: [],
+      fields: [
+        {
+          label: 'Field name',
+          key: 'fieldName',
+          type: 'string',
+          required: true,
+          description: 'Displayed name to the user',
+          variables: true,
+        },
+        {
+          label: 'Type',
+          key: 'fieldType',
+          type: 'dropdown',
+          required: true,
+          description: 'Field type',
+          variables: true,
+          options: [{ label: 'String', value: 'string' }],
+        },
+      ],
+    },
+  ],
+
+  async run($) {
+    const dataItem = {
+      raw: $.request.body,
+      meta: {
+        internalId: Crypto.randomUUID(),
+      },
+    };
+
+    $.pushTriggerItem(dataItem);
+  },
+
+  async testRun($) {
+    const lastExecutionStep = await $.getLastExecutionStep();
+
+    if (!isEmpty(lastExecutionStep?.dataOut)) {
+      $.pushTriggerItem({
+        raw: lastExecutionStep.dataOut,
+        meta: {
+          internalId: '',
+        },
+      });
+    }
+  },
+});

packages/backend/src/apps/forms/triggers/index.js

@@ -0,0 +1,3 @@
+import formSubmittion from './form-submission/index.js';
+
+export default [formSubmittion];

packages/backend/src/controllers/api/v1/forms/create-form-submission.ee.js

@@ -0,0 +1,21 @@
+import Flow from '../../../../models/flow.js';
+import logger from '../../../../helpers/logger.js';
+import handler from '../../../../helpers/form-handler.ee.js';
+
+export default async (request, response) => {
+  logger.debug(`Handling incoming form submission at ${request.originalUrl}.`);
+  logger.debug(JSON.stringify(request.body, null, 2));
+
+  const formId = request.params.formId;
+  const flow = await Flow.query().findById(formId).throwIfNotFound();
+  const triggerStep = await flow.getTriggerStep();
+
+  if (triggerStep.appKey !== 'forms') {
+    logger.error('Invalid trigger step');
+    return response.status(400).send('Invalid trigger step');
+  }
+
+  await handler(formId, request, response);
+
+  response.sendStatus(204);
+};

packages/backend/src/controllers/api/v1/forms/get-form.ee.js

@@ -0,0 +1,18 @@
+import { renderObject } from '../../../../helpers/renderer.js';
+import Flow from '../../../../models/flow.js';
+
+export default async (request, response) => {
+  const form = await Flow.query()
+    .withGraphJoined({ steps: true })
+    .orderBy('steps.position', 'asc')
+    .findById(request.params.formId)
+    .throwIfNotFound();
+
+  const triggerStep = await form.getTriggerStep();
+
+  if (triggerStep.appKey !== 'forms') {
+    throw new Error('Invalid trigger step');
+  }
+
+  renderObject(response, form, { serializer: 'Form' });
+};

packages/backend/src/helpers/form-handler.ee.js

@@ -0,0 +1,71 @@
+import isEmpty from 'lodash/isEmpty.js';
+
+import Flow from '../models/flow.js';
+import { processTrigger } from '../services/trigger.js';
+import triggerQueue from '../queues/trigger.js';
+import globalVariable from './global-variable.js';
+import QuotaExceededError from '../errors/quote-exceeded.js';
+import {
+  REMOVE_AFTER_30_DAYS_OR_150_JOBS,
+  REMOVE_AFTER_7_DAYS_OR_50_JOBS,
+} from './remove-job-configuration.js';
+
+export default async (flowId, request, response) => {
+  const flow = await Flow.query().findById(flowId).throwIfNotFound();
+  const user = await flow.$relatedQuery('user');
+
+  const testRun = !flow.active;
+  const quotaExceeded = !testRun && !(await user.isAllowedToRunFlows());
+
+  if (quotaExceeded) {
+    throw new QuotaExceededError();
+  }
+
+  const triggerStep = await flow.getTriggerStep();
+  const app = await triggerStep.getApp();
+
+  const $ = await globalVariable({
+    flow,
+    app,
+    step: triggerStep,
+    testRun,
+    request,
+  });
+
+  const triggerCommand = await triggerStep.getTriggerCommand();
+  await triggerCommand.run($);
+
+  const triggerItem = $.triggerOutput.data?.[0];
+
+  if (isEmpty(triggerItem)) {
+    return response.status(204);
+  }
+
+  if (testRun) {
+    await processTrigger({
+      flowId,
+      stepId: triggerStep.id,
+      triggerItem,
+      testRun,
+    });
+
+    return response.status(204);
+  }
+
+  const jobName = `${triggerStep.id}-${triggerItem.meta.internalId}`;
+
+  const jobOptions = {
+    removeOnComplete: REMOVE_AFTER_7_DAYS_OR_50_JOBS,
+    removeOnFail: REMOVE_AFTER_30_DAYS_OR_150_JOBS,
+  };
+
+  const jobPayload = {
+    flowId,
+    stepId: triggerStep.id,
+    triggerItem,
+  };
+
+  await triggerQueue.add(jobName, jobPayload, jobOptions);
+
+  return response.status(204);
+};

packages/backend/src/helpers/global-variable.js

@@ -80,8 +80,9 @@ const globalVariable = async (options) => {
       $.triggerOutput.data.push(triggerItem);
 
       const isWebhookApp = app.key === 'webhook';
+      const isFormsApp = app.key === 'forms';
 
-      if ($.execution.testRun && !isWebhookApp) {
+      if ($.execution.testRun && !isWebhookApp && !isFormsApp) {
         // early exit after receiving one item as it is enough for test execution
         throw new EarlyExitError();
       }

packages/backend/src/routes/internal/api/index.js

@@ -21,6 +21,7 @@ import permissionsRouter from './v1/admin/permissions.ee.js';
 import adminUsersRouter from './v1/admin/users.ee.js';
 import installationUsersRouter from './v1/installation/users.js';
 import foldersRouter from './v1/folders.js';
+import formsRouter from './v1/forms.ee.js';
 
 const router = Router();
 
@@ -45,5 +46,6 @@ router.use('/v1/admin/api-tokens', adminApiTokensRouter);
 router.use('/v1/templates', templatesRouter);
 router.use('/v1/installation/users', installationUsersRouter);
 router.use('/v1/folders', foldersRouter);
+router.use('/v1/forms', formsRouter);
 
 export default router;

packages/backend/src/routes/internal/api/v1/forms.ee.js

@@ -0,0 +1,10 @@
+import { Router } from 'express';
+import getFormAction from '../../../../controllers/api/v1/forms/get-form.ee.js';
+import useCreateFormSubmission from '../../../../controllers/api/v1/forms/create-form-submission.ee.js';
+
+const router = Router();
+
+router.get('/:formId', getFormAction);
+router.post('/:formId', useCreateFormSubmission);
+
+export default router;

packages/backend/src/serializers/form.ee.js

@@ -0,0 +1,22 @@
+import stepSerializer from './step.js';
+import slugify from 'slugify';
+
+const formSerializer = (form) => {
+  const formData = {
+    id: form.id,
+    name: form.name,
+    fields: form.steps[0].parameters.fields.map((parameter) => ({
+      fieldKey: slugify(parameter.fieldName, {
+        lower: true,
+        strict: true,
+        replacement: '-',
+      }),
+      fieldName: parameter.fieldName,
+      fieldType: parameter.fieldType,
+    })),
+  };
+
+  return formData;
+};
+
+export default formSerializer;

packages/backend/src/serializers/index.js

@@ -26,6 +26,7 @@ import templateSerializer from './template.ee.js';
 import triggerSerializer from './trigger.js';
 import userAppSerializer from './user-app.js';
 import userSerializer from './user.js';
+import formSerializer from './form.ee.js';
 
 const serializers = {
   Action: actionSerializer,
@@ -34,6 +35,7 @@ const serializers = {
   AdminSamlAuthProvider: adminSamlAuthProviderSerializer,
   AdminTemplate: adminTemplateSerializer,
   AdminUser: adminUserSerializer,
+  Form: formSerializer,
   App: appSerializer,
   AppConfig: appConfigSerializer,
   Auth: authSerializer,

packages/backend/yarn.lock

@@ -4177,6 +4177,11 @@ simple-update-notifier@^1.0.7:
   dependencies:
     semver "~7.0.0"
 
+slugify@^1.6.6:
+  version "1.6.6"
+  resolved "https://registry.yarnpkg.com/slugify/-/slugify-1.6.6.tgz#2d4ac0eacb47add6af9e04d3be79319cbcc7924b"
+  integrity sha512-h+z7HKHYXj6wJU+AnS/+IH8Uh9fdcX1Lrhg1/VMdf9PwoBQXFcXiAdsy2tSK0P6gKwJLXp02r90ahUCqHk9rrw==
+
 smart-buffer@^4.2.0:
   version "4.2.0"
   resolved "https://registry.yarnpkg.com/smart-buffer/-/smart-buffer-4.2.0.tgz#6e1d71fa4f18c05f7d0ff216dd16a481d0e8d9ae"
@@ -4261,7 +4266,16 @@ streamsearch@^1.1.0:
   resolved "https://registry.yarnpkg.com/streamsearch/-/streamsearch-1.1.0.tgz#404dd1e2247ca94af554e841a8ef0eaa238da764"
   integrity sha512-Mcc5wHehp9aXz1ax6bZUyY5afg9u2rv5cqQI3mRrYkGC8rW2hM02jWuwjtL++LS5qinSyhj2QfLyNsuc+VsExg==
 
-"string-width-cjs@npm:string-width@^4.2.0", "string-width@^1.0.2 || 2 || 3 || 4", string-width@^4.1.0, string-width@^4.2.3:
+"string-width-cjs@npm:string-width@^4.2.0":
+  version "4.2.3"
+  resolved "https://registry.yarnpkg.com/string-width/-/string-width-4.2.3.tgz#269c7117d27b05ad2e536830a8ec895ef9c6d010"
+  integrity sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==
+  dependencies:
+    emoji-regex "^8.0.0"
+    is-fullwidth-code-point "^3.0.0"
+    strip-ansi "^6.0.1"
+
+"string-width@^1.0.2 || 2 || 3 || 4", string-width@^4.1.0, string-width@^4.2.3:
   version "4.2.3"
   resolved "https://registry.yarnpkg.com/string-width/-/string-width-4.2.3.tgz#269c7117d27b05ad2e536830a8ec895ef9c6d010"
   integrity sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==
@@ -4293,7 +4307,14 @@ string_decoder@~1.1.1:
   dependencies:
     safe-buffer "~5.1.0"
 
-"strip-ansi-cjs@npm:strip-ansi@^6.0.1", strip-ansi@^6.0.0, strip-ansi@^6.0.1:
+"strip-ansi-cjs@npm:strip-ansi@^6.0.1":
+  version "6.0.1"
+  resolved "https://registry.yarnpkg.com/strip-ansi/-/strip-ansi-6.0.1.tgz#9e26c63d30f53443e9489495b2105d37b67a85d9"
+  integrity sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==
+  dependencies:
+    ansi-regex "^5.0.1"
+
+strip-ansi@^6.0.0, strip-ansi@^6.0.1:
   version "6.0.1"
   resolved "https://registry.yarnpkg.com/strip-ansi/-/strip-ansi-6.0.1.tgz#9e26c63d30f53443e9489495b2105d37b67a85d9"
   integrity sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==