AOI Feature Specification

[AliceR]

Context

While starting to investigate a bug related to the AOI (Area of Interest) feature, I noticed several other related issues that may be interconnected. To effectively address the root cause of these issues, it would be beneficial to clearly define the expected behavior of the AOI feature.

I used the Gherkin syntax, which will be helpful when writing tests for the code as well.

Acceptance Criteria

Feature: Area of Interest (AOI) Analysis

  Scenario: User selects a pre-defined AOI
    Given that I am on the map view (explore page)
    When I select the "Analyze an area" tool (Dropdown menu)
    And choose one of the listed regions
    Then map should display the selected area as the AOI
    And the AOI should not be editable when clicking on it
    And the analysis message should display the size of the area
    And the 'Delete all areas' button should be shown
    And the 'Run analysis' button should be shown

  Scenario: User tries to edit a pre-defined AOI
    Given that I am on the map view (explore page)
    When I add a pre-defined AOI
    And I click on the pre-defined AOI
    Then the AOI should remain un-editable (visually)

  Scenario: User draws an AOI when a pre-defined AOI exists
    Given that there is a pre-defined AOI on the map
    When I select the "Draw an area of interest" tool (Pen icon)
    Then the AOI from pre-defined AOIs should be deleted automatically 
    And the pre-defined selector should be reset and display the placeholder text

  Scenario: User draws an AOI
    Given that I am on the map view (explore page)
    When I select the "Draw an area of interest" tool (Pen icon)
    And I draw a polygon on the map
    Then map should display the drawn area as the AOI
    And the analysis message should display the size of the area

  Scenario: User selects an AOI
    Given that I am on the map view (explore page)
    And I have drawn one or several AOIs
    When I click on a currently unselected polygon on the map
    Then that AOI is selected 
    And all other AOIs are unselected
    And the button to delete says "Delete Area"

  Scenario: User selects multiple AOIs
    Given that I am on the map view (explore page)
    And I have drawn one or several AOIs
    When I hold shift and click on a currently unselected polygon on the map
    Then that AOI is selected 
    And all other AOIs previously selected remain selected

  Scenario: User _un_selects an AOI
    Given that I am on the map view (explore page)
    And I have drawn AOIs with at least one AOI selected
    When I click anywhere else on the map
    Then any selected AOI is unselected
    And the button to delete says "Delete all areas"

  Scenario: User runs the analysis with an AOI
    Given that I am on the map view (explore page)
    And that I have defined an AOI
    When I click the "Run analysis" button
    Then the map should zoom to the AOI
    And the timeline should display a loading animation while the system is fetching
    And, eventually, the timeline should display the results of the analysis

  Scenario: User views AOIs saved in url (by sharing the URL)
    Given that I am on the map view (explore page)
    And I have drawn one or several AOIs
    When I paste the url in a new window
    Then the map should load and display the AOI(s)
    And the map should zoom to center on the AOIs
    And it should show the previously selected AOI (if any) as selected still (note: only if it's not a pre-defined AOI like one of the states)

  Scenario: User deletes all AOIs
    Given that I am viewing AOIs on the map view 
    And there are no AOIs selected
    When I click the "Delete all areas" button
    Then all AOIs should be deleted
    And the analysis result should be removed from the timeline

  Scenario: User deletes the one existing AOI
    Given that I am viewing an AOI on the map view
    When I select the AOI
    And I click the "Delete area" button
    Then the selected AOI should be deleted
    And the analysis result should be removed from the timeline

  Scenario: User deletes one of many AOIs
    Given that I am viewing multiple AOIs on the map view
    When I select some AOI(s)
    And at least on AOI remains on the map 
    And I click the "Delete area" button
    Then the selected AOI(s) should be deleted
    And the analysis result should be **updated based on the remaining AOIs ?**

Request for Input: To ensure I cover all necessary scenarios, could the team help clarify the expected behavior of the AOI feature? Are there any additional scenarios or edge cases that I may have missed?

Next Steps: Once we establish a clear understanding of the expected behavior, I can proceed with troubleshooting the identified bugs more effectively.

Related Tickets

• Selected AOIs do not persist when E&A URL is shared US-GHG-Center/veda-config-ghg#406
• [E&A] Geometries sometimes do not render across page reloads #949
• [E&A] Preselection of presets and hand-drawn polygons across page reloads #950
• [Bug] AOI visualization disappears when map recenters in E&A #1093

cc @aboydnw @faustoperez @dzole0311 et al

[aboydnw]

@AliceR I made edits directly in the original comment, I hope that's okay. Let me know if you have any questions

[dzole0311]

I also made some edits.

@aboydnw I made a slight edit of your note:

And it should show the previously selected AOI as selected still (note: this last line is less important/optional)

To this:

And it should show the previously selected AOI (if any) as selected still (note: only if it's not a pre-defined AOI like one of the states)

We have a bug where the AOI is actually selected (internally, the app knows it's selected and analysis can be ran for that AOI), but visually it's not shown as selected. That's the bug reported here: US-GHG-Center/veda-config-ghg#406

I've also added only if it's not a pre-defined AOI like one of the states since we don't show pre-defined AOIs (like the states) as editable / selectable to the user.