platformOS Core Module

This module aims to extend the platformOS module system's possibilities.

With the hook system, it's possible to use SOLID's Open/Closed Principle so you can modify the business logic in other modules in the application folder without changing the source of existing modules.

A variable storage can be used to set variables and get their value in the global scope.

Register your theme into the module registry with hook_module_info. In this info file, you can define your theme's name, version, type, and dependencies. Module registry will handle dependency management and outdated versions.

There are module helper functions to check if a module or theme exists in the system so that the other modules can use installed ones without complex dependencies.

The core module also provides a command and the graphql mutation for email sending.

Installation

This module is published in Partner Portal Modules Marketplace - https://partners.platformos.com/marketplace/pos_modules/126

To install it, you have to have pos-cli installed.

Go into your project directory and use pos-cli modules install command, which will create/update app/pos-modules.json:

pos-cli modules install core

Pulling the source code

Modules are compatible with platformOS Check, which we highly recommend you to install - it's compatible with any IDE supporting LSP. If you use VSCode, see VSCode platformOS Check Extension.

To be able to leverage LSP features like autocomplete for function/include/graphql tags, you will need to have the source code of the module in your project. We recommended adding modules/core into .gitignore (as you should not monkey patch module files, as it will make it hard to update the module to the newest version in the future) and pulling the source code via pos-cli:

pos-cli modules pull core

The default behavior of modules is that the files are never deleted. It is assumed that the developers might not have access to all of the files, and thanks to this feature they are still able to overwrite some of the module's files without breaking them. Because the core module is fully public, it is recommended to delete files on deployment. To do it, ensure your app/config.yml includes the core module in the list modules_that_allow_delete_on_deploy:

modules_that_allow_delete_on_deploy:
- core

Commands / business logic

We recommend using commands to encapsulate business rules. By following our recommendation, you will improve the consistency of your code, so it will be easy to onboard new developers to the project and easier to take over existing projects. The advantage of using this architecture is that it will be easy to re-use the command - you will be able to execute it both in a live web request, as well as a background job.

We recommend placing your commands in lib/commands directory.

The naming conventions that we use are <resource>/<action>, for example, users/create.liquid or order/cancel.liquid.

Commands are designed to be easily executed as background jobs [heavy commands - external API call, expensive operations computations, reports]. Each command might produce an Event

You can use the generator provided by the core module to quickly generate our recommended structure with the initial code:

pos-cli generate run modules/core/generators/command <command>

For example

pos-cli generate run modules/core/generators/command dummy/create

You can also scaffold the whole CRUD at once, for example:

pos-cli generate run modules/core/generators/crud dummy title:string uuid:string c__score:integer --include-views

The command consists of 3 stages, which we recommend to split into 3 separate files.

A typical dummy command placed in app/lib/commands/dummy/create.liquid would look like this:

{%  liquid
  function object = 'commands/dummy/create/build', object: object
  function object = 'commands/dummy/create/check', object: object

  if object.valid
    function object = 'commands/dummy/create/execute', object: object
  endif

  return object
%}

Build

This is the place where you build input for the command. The typical use case is to invoke it with context.params, which include input provided by the user via submitting <form>, to normalize the input, do necessary type conversions, whitelist properties that the user is allowed to provide to the command, etc.

Example app/lib/commands/dummy/build.liquid:

{% parse_json data %}
  {
    "title": {{ object.title | downcase | json }},
    "uuid": {{ object.uuid | json }},
    "c__score": 0
  }
{% endparse_json %}

{% liquid
  if data['uuid'] == blank
    hash_assign data["uuid"] = '' | uuid | json
  endif

  return data
%}

The example build command will generate uuid if not provided in params, will initiate the field c__score (c stands for cache) with 0 and will ensure that the title provided to the command is downcased.

Check

This is the place where you validate the input - for example, you ensure all required fields are provided, check uniqueness, check the format of the input, etc. This always returns a hash with two keys - valid being either true or false, and if false - errors with details of why validation has failed.

The core module has already quite a few built-in validators.

Example app/lib/commands/dummy/check.liquid:

{% liquid
  assign c = '{ "errors": {}, "valid": true }' | parse_json

  function c = 'modules/core/validations/presence', c: c, object: object, field_name: 'title'
  function c = 'modules/core/validations/presence', c: c, object: object, field_name: 'uuid'
  if object.title
    function c = 'modules/core/validations/presence', c: c, object: object, field_name: 'title'
    function c = 'modules/core/validations/length', c: c, object: object, field_name: 'title', minimum: 3
    function c = 'modules/core/validations/length', c: c, object: object, field_name: 'title', maximum: 130
  endif

  function c = 'modules/core/validations/uniqueness', c: c, object: object, field_name: 'uuid', table: 'dummy'

  assign object = object | hash_merge: c

  return object
%}

Execute

If validation succeeds, proceed with executing the command - usually a single platformOS GraphQL Mutation. Any error raised here should be considered 500 server error. If you allow errors here, it means there is something wrong with the code organisation, as all checks to prevent errors should be done in the check step.

Example app/lib/commands/dummy/execute.liquid:

{% liquid
  graphql r = 'dummy/create', args: object

  assign object = r.record_create
  hash_assign object['valid'] = true

  return object
%}

Note: Usually the execute step is about invoking a GraphQL mutation - if that's the case for your new command, you can use the generic execute function provided by the core module, which is located at modules/core/public/lib/commands/execute.liquid. Example usage to invoke GraphQL mutation defined in app/graphql/dummy/create.graphql:

{%  liquid
  # ...

  if object.valid
    function object = 'modules/core/commands/execute', mutation_name: 'dummy/create', selection: 'record_create', object: object
  endif

  # ...
%}

Hooks

Hooks allow you and other developers to extend the functionality of your modules or applications without altering the existing code, but by writing a new one. It follows the Open/Close Principle. You achieve it by creating an entry point in a specific point in your application flow, which dynamically executes additional code implemented by matching hooks.

Hooks are defined via Liquid partials that start with hook_ prefix. We recommend placing them in lib/hooks directory. These partials (hooks) are executed via the core module's modules/core/commands/hooks/fire function described below.

Organize your hooks into appropriate folders to maintain a clean project structure:

Application Hooks: Located in app/lib/hooks/, e.g., hook_permission.liquid
Module Hooks: Located in modules/your-module/public/lib/hooks/, e.g., hook_permission.liquid

Implementing Hooks

Implementing a hook means providing the specific logic that should execute when the hook is fired. This is where you define what actually happens when a hook is triggered.

Create Hook Implementation: For the hook declared as hook_my-hook.liquid, create an implementation file in an appropriate directory, such as app/lib/hooks/hook_my-hook.liquid. In other words, create a Liquid file named after the hook, such as hook_HOOKNAME.liquid.
Add Logic to the Hook: In your hook implementation file, add the logic that should execute. This could include logging, data manipulation, or any other functionality.
Returning from Hooks: All hooks are invoked via function, which means that every hook must use return tag, even if it is return null.

Note: To execute the hook, fire it via modules/core/commands/hook/fire function and provide your hook name as an argument - my-hook; combination of a naming convention (hook_ prefix) and using the core module's function turns the Liquid partial into a hook.

Declaring and Configuring Hooks

To make a hook available for implementation by others, you need to declare and configure it within your project. This setup allows others to extend and customize your code without altering the core functionality.

To make a hook operational and integrate it into your application’s logic, you must explicitly call it using the modules/core/commands/hook/fire function. This involves specifying the hook's name (without hook_ prefix).

For example, if you have declared a hook named my-hook (for example by creating a file app/lib/hooks/hook_my-hook.liquid), you fire it as follows:

{% liquid
  function results = 'modules/core/commands/hook/fire', hook: 'my-hook'
%}

When you fire a hook using the modules/core/commands/hook/fire command, the system dynamically searches for all Liquid files that match the pattern hook_<hook_name>. If you fire my-hook, the system looks for partials whose path ends with /hook_my-hook.

Find the fire.liquid implementation here.

Parameters and Result Merging: When firing a hook, you can pass data using the params attribute, which will be forwarded to all implementations of the hook. The merge_to_object attribute can be used to combine results from different hook implementations into a single object.

Example for Demonstrating Purpose

To illustrate the dynamic nature of hooks, consider the following example. If you have code like this anywhere in your project, let's say in app/views/pages/test-hook.liquid:

{% liquid
  log "Hello"
  function results = 'modules/core/commands/hook/fire', hook: 'add-code-dynamically'
  log "Bye"
%}

And then you create a file app/lib/hooks/hook_add-code-dynamically.liquid with content:

{% log "I'm here" %}
{% return null %}

When you invoke https://example.com/test-hook and check the logs using pos-cli logs <env>, you should see:

[2024-07-15 14:48:24.413Z] - info: Hello
path: /test-hook page: test-hook
[2024-07-15 14:48:24.434Z] - info: I'm here
path: /test-hook page: test-hook partial: hooks/hook_add-code-dynamically
[2024-07-15 14:48:24.434Z] - info: Bye

This demonstrates how the hook system dynamically integrates additional logic at runtime without altering the original code structure.

Additional Hook Options

Define alter hooks to modify data before it is processed further, such as before saving to the database or rendering to the user.
Parameters: Pass additional data to hooks using the params attribute. Params will be sent to all hook implementations.
Result Merging: Use the merge_to_object attribute to combine results from various hooks into a single object or collect them in an array.

Examples of Hook Implementations

Returning Arrays with Hooks

Consider the example of the Permission Module, which doesn't require parameters for its get_permissions function:

{% liquid
  function permissions = 'modules/core/commands/hook/fire', hook: 'permission'
  return permissions
%}

This function retrieves all available permissions in your application.

The Permission Module implements its hook with permission-related permissions, so in modules/permission/public/lib/hooks/hook_permission.liquid you can find this:

{% liquid
  assign permissions = '["permissions.manage"]' | parse_json
  return permissions
%}

Similarly, the User Module includes user-related permissions:

{% liquid
  assign permissions = '["user.create", "user.delete", "user.update"]' | parse_json
  return permissions
%}

You can create your own permissions by creating a hook_permission.liquid file, either in app/views/partials/hooks/ or within a custom module directory:

{% liquid
  assign permissions = '["custom_permission", "another_custom_perm"]' | parse_json
  return permissions
%}

When the permission hook is fired, it aggregates and returns the following array of permissions from all implementations:

["permissions.manage","user.create", "user.delete", "user.update","custom_permission","another_custom_perm"]

Passing Parameters to Hooks

For example, in the User Module, we created a hook called user_create. Here’s how it is set up:

assign params = '{}' | parse_json | hash_merge: created_user: user.user, hook_params: hook_params
function results = 'modules/core/commands/hook/fire', hook: 'user_create', params: params, merge_to_object: true
hash_assign user['hook_results'] = results

This configuration enables you to execute additional actions when a user is created. You need to create a file (or files) named hook_user_create.liquid in the appropriate directory (either within your app or a specific module). This file should contain the custom logic you wish to apply.

For example, you can store additional values in your custom profile structure and use the created user's ID as a reference.

Here’s how you could structure your app/lib/hooks/hook_user_create.liquid to achieve this:

{% parse_json args %}
  {
    "user_id": {{ params.created_user.id | json }},
    "first_name": {{ params.hook_params.first_name | json }},
    "last_name": {{ params.hook_params.last_name | json }},
    "dog_name": {{ params.hook_params.dog_name | json }},
    "favorite_color": {{ params.hook_params.favorite_color | json }}
  }
{% endparse_json %}
{% liquid
  graphql profile = 'profiles/create', args: args
  return profile
%}

This script processes additional parameters provided during user creation and updates the user's profile in the database.

Another practical use could be to subscribe the newly created user to a newsletter via an API of a third-party service. In this scenario, your hook_user_create.liquid file would look like this:

{% if params.hook_params.subscribe %}
  {% parse_json data_to_send %}
    {
      "email": {{ params.created_user.email | json }}
    }
  {% endparse_json %}
  {% graphql g, data: data_to_send %}
    mutation ($data: HashObject!)  {
      api_call: api_call_send(
        data: $data
        template: { name: "nl_subscribe" }
      ) {
        response{ status body }
        errors {
          message
        }
      }
    }
  {% endgraphql %}
{% endif %}

{% return nil %}

And here's how you can define the API call in app/api_calls/nl_subscribe.liquid:

---
request_type: "POST"
to: "https://your-api-call.com"
request_headers: '{
  "Content-Type": "application/json"
}'
---
{{ data | json }}

This configuration sends a POST request to the specified URL with the user’s email as JSON data, subscribing them to the newsletter.

Events

Eventsallow you to record that something has happened in the system. Think of them as logs that capture these actions. When an event occurs, other parts of the application might need to react to it. In platformOS, these events are stored using GraphQL mutations and can include various arguments detailing what happened. They enable you to add logic to existing commands and are executed asynchronously in the background.

Practical Uses of Events

Form Submissions: When a user submits a contact form, an event can log this action and trigger follow-up actions such as sending a confirmation email or updating a CRM system.
Data Processing Completion: Once a background job processes data, an event can signal completion, notifying other systems or updating the user interface to reflect the new data.
Real-Time Updates: Events can send real-time notifications to users, such as alerts for new messages, status updates, or system alerts.

Example Scenario

Imagine you have an e-commerce platform where users can place orders. When an order is placed, several things need to happen:

The order needs to be saved in the database.
An email confirmation needs to be sent to the user.
The inventory needs to be updated.
The sales team needs to be notified.

By creating an event when the order is placed, each of these actions can be handled separately by different parts of the application, ensuring a clean and manageable codebase.

Here's how you can record an event in platformOS:

{% function _ = 'modules/core/commands/events/publish', type: 'order_placed', object: order_object %}

This function logs an event of the type order_placed, which can then trigger other actions within the system. It's important to note that this method does not use the typical record_create but rather activity_create to log the event as an activity.

For more detailed information on how activities are handled in platformOS, please refer to the Activity Feeds documentation.

Defining the event

An event in platformOS has a type and structure. The event type must be unique and is not scoped. To define an event, create a file in app/lib/events/your_event_name. The event type should reflect an action that occurred in the past. The metadata section defines the structure of the data passed to the event, and you must validate that certain parameters are passed.

app/lib/events/something_happened

---
metadata:
  event:
    foo_id
---
{% liquid
  assign c = '{ "errors": {}, "valid": true }' | parse_json

  function c = 'modules/core/validations/presence', c: c, object: event, field_name: 'foo_id'

  # You can also enhance event object
  hash_assign event['bar'] = 'extra info'

  return c
%}

Publishing the Event

Once something happened in the application, you can publish the event. Events should be published directly from a page or a command.

app/views/pages/debug.liquid

{% liquid
  assign object = null | hash_merge: foo_id: "12345"
  function _ = 'modules/core/commands/events/publish', type: 'something_happened', object: object
%}

Upon publishing, the event is validated and stored in activities. However, to act upon this event, you need to write a consumer.

The publish command returns a BackgroundJob ID. You can view scheduled and running background jobs via pos-cli gui serve -> Background Jobs. Background jobs created through the publish command follow the naming convention modules/core/commands/events/create:<type>.

Note: Successfully processed jobs are deleted and are not visible in the UI anymore.

Handling Events

To execute code when a specific event occurs, you need to create a consumer. Multiple consumers can be associated with a single event. To create a consumer, follow these steps:

Create a file in the app/lib/consumers/<name_of_the_event>/<name_of_your_file> directory.
Define configuration options in the consumer file. Here are some options you can set:
- priority: (String, default: default) Defines the consumer's priority. Possible values: low, default, high.
- max_attempts: (Int, default: 9) If the consumer fails, platformOS will automatically retry it up to the specified number of attempts. This is useful for handling transient errors, such as network issues. To prevent any retries, set max_attempts to 0.
- delay: (Float, default: 0) Sets a delay (in minutes) before triggering the consumer. For delays less than a minute, use fractions (e.g., 0.5 for 30 seconds).

Example consumer file: app/lib/consumers/something_happened/do_something.liquid

---
metadata:
  priority: default
  max_attempts: 9
  delay: 0
---
{% liquid
  assign message = 'executed consumer for the event' | append: event
  log message
%}

For this example, the event object will look like:

{
  "id": "ActivityStreams::Activity.1382917",
  "uuid": "22ed7654-9521-42dd-b5f0-02e79c03f749",
  "foo_id": "12345",
  "type": "something_happened",
  "date": "2023-03-17T10:42:41.957Z"
  "bar": "extra info"
}

Events can be published and consumed by different parts of the application. You can write a consumer that reacts to events published by a module or other parts of your system.

Debugging Events

The core module provides a simple UI to help you preview published events, re-trigger them, and more. This UI is available only in the staging environment at /_events.

Status handling

You can create a new status with a command so you will have a status history in your entity. When you create a status, the status_created event will be published with the status object, so you can create your consumer and set your entity's status cache (for example c__status) field.

Creating a status

{% liquid
  function res = 'modules/core/commands/statuses/create', name: 'app.statuses.transactions.succeeded', reference_id: '2', requester_id: 'payment_webhook', reference_schema: 'modules/payments/transaction'
%}

You can also set timestamp and payload if you need.

Deleting a status

{% liquid
  function res = 'modules/core/commands/statuses/delete', id: '75'
%}

Loading a status

{% liquid
  function res = 'modules/core/queries/statuses/find', id: '76'
%}

Searching for statuses

{% liquid
  function res = 'modules/core/queries/statuses/search', name: 'app.statuses.transactions.succeeded', requester_id: 'stripe_webhook'
%}

Deleting a status

{% liquid
  function res = 'modules/core/commands/statuses/delete', id: '75'
%}

Variable storage

You can set a variable with

function res = 'modules/core/commands/variable/set', name: 'VARIABLE_NAME', value: 'VARIABLE_VALUE'

This function will return the created variable's value.

And you can get a variable value with

function variable_va = 'modules/core/queries/variable/find', name: 'VARIABLE_NAME', default: 'DEFAULT_VALUE'

You can pass the type argument that can be an array, integer, float, boolean, or object.

Session storage

You can store small data in a session. A session is connected with the current browser session.

  assign data = null | hash_merge: bar: 'some value'

  function _ = 'modules/core/commands/session/set, key: 'foo', value: data
  function data = 'modules/core/commands/session/get', key: 'foo'
  function _ = 'modules/core/commands/session/clear', key: 'foo'

Module registry

You can register your module or theme by implementing hook_module_info under lib/hook/. An info file should look like this:

{% parse_json info %}
{
  "name": "pOS Admin",
  "machine_name": "admin",
  "type": "module",
  "version": "1.0.0",
  "dependencies": [
    "core"
  ]
}
{% endparse_json %}

{% return info %}

It is possible to list the registered modules and themes with

function modules = 'modules/core/queries/registry/search, type: 'module`
function themes = 'modules/core/queries/registry/search, type: 'theme`
function all = 'modules/core/queries/registry/search

Email sending

The core module provides a command for email sending that you can call in your app or other modules:

{% parse_json object %}
  {
    "to":      "[email protected]",
    "from":    "[email protected]",
    "cc": [],
    "bcc": [],
    "subject": "Hello there!",
    "layout": "path/to/my_layout",
    "partial": "path/to/email_partial",
    "data": { "user": " { "first_name:" "John" } }
  }
{% endparse_json %}
{% function _ = 'modules/core/commands/email/send', object: object %}

The code above will send an email from [email protected] to [email protected] with the subject of Hello there! using your liquid partial defined in app/views/partials/path/to/email_partial.liquid with the layout file defined in app/views/layouts/path/to/my_layout.liquid.

You can pass any additional data as part of the object and it'll be available in your app/views/partials/path/to/email_partial.liquid partial as data:

<h1>Hello {{ data.user.first_name }}!</h1>

Note: By default platformOS does not send real emails from staging environment - please ensure to Configure test email on your instance to be able to send emails from staging environment.

Headscripts hook

The core module provides a hook for other modules to register their head scripts (CSS, JS, metadata, etc). The modules can implement a hook_headscripts.liquid file that returns standard HTML, then you can render the aggregated head scripts in your layout using the headscripts/search query:

<!DOCTYPE html>
<html lang="en">
  <head>
    {% function headscripts = 'modules/core/queries/headscripts/search' %}
    {{ headscripts }}
  </head>

The Theme manager module uses the same hook to add theme-specific head scripts from the active theme.

Helpers

You can check if a module or theme is installed on the project:

function exists = 'modules/core/queries/module/exists', type: 'module'

Validators

The core module provides some basic helpers for data validation.

These validators can check if all required fields are provided, check uniqueness, data types (numbers are really numbers and not letters), etc. Validators always return a hash with two keys - valid being either true or false, and if false - errors with details of why the validation has failed.

You can find the core validators at modules/core/public/lib/validations

Generators

Core module provides useful generators to quickly create files.

command

Contribution

Please check .git/CONTRIBUTING.md

Name		Name	Last commit message	Last commit date
Latest commit History 160 Commits
.github		.github
docs		docs
modules/core		modules/core
.gitignore		.gitignore
CHANGELOG.md		CHANGELOG.md
CONTRIBUTE.md		CONTRIBUTE.md
LICENSE		LICENSE
README.md		README.md
changelog-template.hbs		changelog-template.hbs
pull_request_template.md		pull_request_template.md

License

simplykatsa/pos-module-core

Folders and files

Latest commit

History

Repository files navigation

platformOS Core Module

Installation

Pulling the source code

Commands / business logic

Build

Check

Execute

Hooks

Implementing Hooks

Declaring and Configuring Hooks

Example for Demonstrating Purpose

Additional Hook Options

Examples of Hook Implementations

Returning Arrays with Hooks

Passing Parameters to Hooks

Events

Practical Uses of Events

Example Scenario

Defining the event

Publishing the Event

Handling Events

Debugging Events

Status handling

Creating a status

Deleting a status

Loading a status

Searching for statuses

Deleting a status

Variable storage

Session storage

Module registry

Email sending

Headscripts hook

Helpers

Validators

Generators

Contribution

About

Resources

License

Stars

Watchers

Forks

Releases

Packages 0

Languages

Packages