> ## Documentation Index
> Fetch the complete documentation index at: https://forest-docs-prd-616-workflow-webhook-trigger.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Upgrade to v7

> The purpose of this note is to help developers to upgrade their agent from v6 to v7. Please read carefully and integrate the following breaking changes to ensure a smooth update.​

<Warning>
  Please be aware that while Forest make every effort to ensure that our platform updates are broadly compatible and offer detailed instructions for upgrading, Forest cannot guarantee that custom code developed by the developers will always be compatible with new versions of our software. This includes any custom modifications or extensions to core functionalities, such as method overrides or custom integrations. It is the responsibility of the developers to review and test their custom code to ensure compatibility with each new version. Our team provides comprehensive upgrade guides to assist in this process, but these cannot encompass the unique customizations that may be present in each customer's environment. Therefore, Forest strongly recommend establishing a thorough testing protocol for your specific customizations to safeguard against potential issues during the upgrade process.
</Warning>

<Info>
  Please follow the recommended procedure to upgrade your agent version by following [this note](/legacy/ruby-agent/how-tos/maintain/push-your-new-version-to-production).
</Info>

## Upgrading to v7

<Warning>
  Before upgrading to v7, consider the below [**breaking changes**](/legacy/ruby-agent/how-tos/maintain/upgrade-notes-rails/upgrade-to-v7#breaking-change).
</Warning>

This upgrade unlocks the following feature:

* [Add/remove Smart action form fields dynamically](/legacy/ruby-agent/reference-guide/actions/create-and-manage-smart-actions/use-a-smart-action-form#add-remove-fields-dynamically)
* [Use hooks for bulk/global Smart actions](/legacy/ruby-agent/reference-guide/actions/create-and-manage-smart-actions/use-a-smart-action-form#get-selected-records-with-bulk-action)

To upgrade to v7, **update the version in your Gemfile**, then run the following and update your project as shown in the *Breaking Changes* section below.:

```javascript theme={null}
bundle install
```

<Info>
  In case of a regression introduced in Production after the upgrade, a rollback to your previous agent version 6 is the fastest way to restore your admin panel.
</Info>

## Breaking change

#### Smart actions

<Warning>
  The `values` endpoint is no longer supported.
</Warning>

The smart action `change` hook is no longer linked to `fieldName`. Now it need to set a `hook` property inside field definition.

<Warning>
  Before
</Warning>

```ruby theme={null}
action 'Test action',
  type: 'single',
  fields: [{
    field: 'a field',
    type: 'String',
  }],
  :hooks => {
    :change => {
      'a field' => -> (context) {
        # Do something ...
        return context[:fields];
      }
    }
  }
```

<Check>
  After
</Check>

```ruby theme={null}
action 'Test action',
  type: 'single',
  fields: [{
    field: 'a field',
    type: 'String',
    hook: 'onFieldChanged',
  }],
  :hooks => {
    :change => {
      'onFieldChanged' => -> (context) {
        # Do something ...
        return context[:fields];
      }
    }
  }
```

The signature of `hooks` function has changed.`fields` is now an array. You must change the way you access fields.

<Warning>
  Before
</Warning>

```ruby theme={null}
[...]
:hooks => {
  :load => -> (context) {
    field = context[:fields]['a field'];
    field[:value] = 'init your field';
    return context[:fields];
  },
  :change => {
    'onFieldChanged' => -> (context) {
      field = context[:fields]['a field'];
      field[:value] = 'what you want';
      return context[:fields];
    }
  }
}
[...]
```

<Check>
  After
</Check>

```ruby theme={null}
[...]
:hooks => {
  :load => -> (context) {
    field = context[:fields].find{|field| field[:field] == 'a field'}
    field[:value] = 'init your field';
    return context[:fields];
  },
  :change => {
    'onFieldChanged' => -> (context) {
      field = context[:fields].find{|field| field[:field] == 'a field'}
      field[:value] = 'what you want';
      return context[:fields];
    }
  }
}
[...]
```

The signature of `hooks` functions has changed. In order to support the hooks for **global** and **bulk** smart action, `record` is no longer sent to the hook. You must change the way you get the record information.

<Warning>
  Before
</Warning>

```ruby theme={null}
[...]
:hooks => {
  :load => -> (context) {
    field = context[:fields]['a field'];
    field[:value] = context[:record].a_props;
    return context[:fields];
  }
}
[...]
```

<Check>
  After
</Check>

```ruby theme={null}
[...]
:hooks => {
  :load => -> (context) {
    id = ForestLiana::ResourcesGetter.get_ids_from_request(context[:params])[0];
    # or
    id = context[:params][:data][:attributes][:ids][0];

    record = model.find(id)

    field = context[:fields].find{|field| field[:field] == 'a field'}
    field[:value] = record.a_props;

    return context[:fields];
  }
}
[...]
```

#### Scopes

Scopes have been revamped, from a convenient alternative to segments, to a security feature. They are now enforced by the agent (server-side).

This update comes with breaking changes in the prototype of helpers which are provided to access and modify data.

All occurrences of calls to `ResourcesGetter`, `ResourceGetter`, `ResourceUpdater` must be updated and now require the `forest_user` property to retrieve the relevant scope. The `forest_user` property is made accessible in your smart action controllers by inheriting from our controller: `ForestLiana::SmartActionsController`

<Warning>
  Before
</Warning>

```ruby theme={null}
ForestLiana::ResourcesGetter.new(resource, params).perform
ForestLiana::ResourcesGetter.get_ids_from_request(params)
ForestLiana::ResourceGetter.new(resource, params).perform
ForestLiana::ResourceUpdater.new(resource, params).perform
```

<Check>
  After
</Check>

```ruby theme={null}
ForestLiana::ResourcesGetter.new(resource, params, forest_user).perform
ForestLiana::ResourcesGetter.get_ids_from_request(params, forest_user)
ForestLiana::ResourceGetter.new(resource, params, forest_user).perform
ForestLiana::ResourceUpdater.new(resource, params, forest_user).perform
```