Introspection

Introduction

ConanJs gives you the ability to check on its internal status so that you can leverage this information for common use cases. For instance:

The Meta Flow Statuses

These are the different statuses in the meta flow:
    starting. The Conan State is starting
    init. The Conan State has started and reached the first initial state.
    running. The Conan State is running at least one action (sync or async)
    idle. The Conan State is started but is not running anything at the moment.
    idleOnTransaction. Similar, but on a transaction, while on a transaction, the idle status only is reached when the transaction is closed. This is very handy for testing​
    error An error has occurred

The MetaInfo

The information for each status is encapsulated in a MetaInfo object, which has three properties:
    lastError: The last error raised
    transactionCount: The count of transactions opened at the moment.
    status: One of
1
export enum MetaStatus {
2
STARTING = 'STARTING',
3
INIT = "INIT",
4
RUNNING = "RUNNING",
5
ERROR = "ERROR",
6
IDLE = "IDLE",
7
IDLE_ON_TRANSACTION = "IDLE_ON_TRANSACTION",
8
}
Copied!

Transactions

Is possible to open a transaction for a ConanState​
1
numberValue$.openTransaction(`test-transaction`)
Copied!
When you open a transaction, the IDLE state will only be reached if all actions (sync and async) are fulfilled and the transaction is closed
1
numberValue$.closeTransaction()
Copied!
As of v1.0 transactions don't really honour their name, ie, they only let you group actions to know when they complete, which we think is very useful for testing​
In future releases we are hoping for transactions to be much powerful and let you perform operations like rollbacks / commits...
Stay tuned!
Working hard on the next version!

Accessing the Meta Flow

In every Conan State, you have a property to retrieve the meta Flow
1
numberValue$.metaFlow
Copied!
You can check our Conan Flows docs to see how you can normally access the different statuses.
We do have dedicated sections for error handling and testing state which are heavily connected to the Meta Flow

Stop / Start

ConanState objects can be stopped and started on demand. At the moment they always start up started.
Stopping / Starting Conan State can be useful if you need to work with streams of data or other similar use cases.
At the moment this is not something that you are going to fully leverage as our APIs need to be matured.

Error Handling

A particular use case to access the meta flow is to handle errors, every time an exception is thrown in your code, it is caught and the monitor is updated to reflect this.
This is handy if you want to then add a toast message or something similar.
We see error handling to be associated with the transactions, as mentioned above, this is something where we are expecting to provide with more features in the next releases/
Last modified 1yr ago