feat: make configuration page as optional #1521

hetangmodi-crest · 2025-01-03T12:31:37Z

Issue number:
ADDON-76819

PR Type

What kind of change does this PR introduce?

Summary

Set configuration as an optional key in globalConfig.json.

Changes

Made configuration page optional in schema.json, So that users can have an add-on UI without Configuration page.
Also added a smoke testcase which captures this behaviour.

User experience

Now, user can build their add-on without specifying configuration in their globalConfig.json. Users now can have a UI without Configuration page for their add-on.

Checklist

If an item doesn't apply to your changes, leave it unchecked.

I have performed a self-review of this change according to the development guidelines
Tests have been added/modified to cover the changes (testing doc)
Changes are documented
PR title and description follows the contributing principles

soleksy-splunk

seems good just one minor thing that configuration page is technically handled, so there isn't any entry point but if you directly type url it displays empty page. We can handle it in separate PR

docs/generated_files.md

…iguration-page

Signed-off-by: Viktor Tsvetkov <[email protected]>

...expected_addon_no_configuration/Splunk_TA_UCCExample/appserver/static/js/build/entry_page.js

hetangmodi-crest · 2025-01-09T11:08:37Z

@soleksy-splunk

seems good just one minor thing that configuration page is technically handled, so there isn't any entry point but if you directly type url it displays empty page. We can handle it in separate PR

I had checked it in my VM, when we add configuration in the URL, Splunk web presents Page Not Found error.

soleksy-splunk · 2025-01-09T13:10:32Z

@soleksy-splunk

seems good just one minor thing that configuration page is technically handled, so there isn't any entry point but if you directly type url it displays empty page. We can handle it in separate PR

I had checked it in my VM, when we add configuration in the URL, Splunk web presents Page Not Found error.

Ok, then it has to be caching on my side, i will double check but thats a minor problem as there shouldn't be any access point to this page anyway.

vtsvetkov-splunk

🚀

artemrys · 2025-01-10T16:10:38Z

If configuration, inputs and dashboard pages are optional - should we make pages optional as well?

So that we can support globalConfig file like this?

{
    "meta": {
        "name": "<name>",
        "version": "<version>",
        "displayName": "<display name>",
        "schemaVersion": "0.0.9"
    }
}

EDIT: if we decide so - it deserves a separate small PR.

hetangmodi-crest · 2025-01-13T05:36:17Z

If configuration, inputs and dashboard pages are optional - should we make pages optional as well?

So that we can support globalConfig file like this?
{
    "meta": {
        "name": "<name>",
        "version": "<version>",
        "displayName": "<display name>",
        "schemaVersion": "0.0.9"
    }
}
EDIT: if we decide so - it deserves a separate small PR.

Yes, we will be covering that in .conf only TA PR.

kkedziak-splunk · 2025-01-13T14:50:17Z

splunk_add_on_ucc_framework/data_ui_generator.py

@@ -40,14 +43,20 @@ def generate_nav_default_xml(
    """
    nav = ET.Element("nav")
    if include_inputs:
-        if default_view == "inputs":
+        if (
+            not (include_configuration) and default_view == "configuration"


not (include_configuration) and default_view == "configuration"

This is a strange condition. It would be good to change _validate_meta_default_view method in global_config_validator.py to not allow this value when there is no configuration page and change this condition.

I agree with Kamil. _validate_meta_default_view already checks, for input and dashboard, if default view is present in the global config and raises an error if not, so in my opinion it would be the best to expand it to configuration as well.

Have updated the logic and added validation in _validate_meta_default_view function

sgoral-splunk · 2025-01-14T14:14:41Z

splunk_add_on_ucc_framework/data_ui_generator.py

@@ -40,14 +43,20 @@ def generate_nav_default_xml(
    """
    nav = ET.Element("nav")
    if include_inputs:
-        if default_view == "inputs":
+        if (
+            not (include_configuration) and default_view == "configuration"


I agree with Kamil. _validate_meta_default_view already checks, for input and dashboard, if default view is present in the global config and raises an error if not, so in my opinion it would be the best to expand it to configuration as well.

splunk_add_on_ucc_framework/generators/xml_files/create_configuration_xml.py

splunk_add_on_ucc_framework/global_config.py

splunk_add_on_ucc_framework/global_config_validator.py

sgoral-splunk · 2025-01-19T21:26:42Z

splunk_add_on_ucc_framework/global_config_validator.py

        )
+        if default_view == "configuration" and self._global_config.has_configuration():


Suggested change

if default_view == "configuration" and self._global_config.has_configuration():

if default_view == "configuration" and not self._global_config.has_configuration():

```?

Nice catch! Updated the condition.

splunk_add_on_ucc_framework/commands/rest_builder/global_config_builder_schema.py

splunk_add_on_ucc_framework/generators/html_files/create_alert_actions_html.py

artemrys · 2025-01-20T20:04:03Z

splunk_add_on_ucc_framework/global_config_validator.py

-        return [
-            resolve_tab(tab) for tab in self._config["pages"]["configuration"]["tabs"]
-        ]
+    def config_tabs(self) -> List[Any]:


Can this be a part of a globalConfig class logic?

It could resolve tabs if there are tabs in the globalConfig file, otherwise return an empty list. This way the validation logic below could be simplified and if pages.get("configuration") statements could be removed.

globalConfig class already has a similar tabs property (part of v5.30.0) and this method was existing since v5.40.0.
I think I'll have to merge, clear and clean-up both the functions and its tests. Making these changes as a part of this PR would be it make it bigger and would have two unrelated changes.

Ok, agree, please create a ticket for it and let's refactor it after this PR is merged.

...ddon_no_configuration/Splunk_TA_UCCExample/appserver/static/js/build/entry_page.licenses.txt

...expected_addon_no_configuration/Splunk_TA_UCCExample/appserver/static/js/build/entry_page.js

artemrys · 2025-01-20T20:10:26Z

tests/testdata/test_addons/package_global_config_no_configuration/globalConfig.json

@@ -0,0 +1,176 @@
+{
+    "pages": {
+        "inputs": {


That's a great example - should we require configuration page if inputs page is present?

No, I can think of a use case for add-ons like Nix and Windows, where the shell/batch scripts are present, and all users have to do is enable the inputs. Similarly, there could be other such add-on use cases where configuration page may not be required.

splunk_add_on_ucc_framework/data_ui_generator.py

artemrys · 2025-01-23T15:59:19Z

splunk_add_on_ucc_framework/global_config.py

-        for tab in self.tabs:
-            if "table" in tab:
-                configs.append(tab)
+        if self.has_configuration():


self.tabs would be an empty list if there is no configuration, we can remove this if statement as well.

Made the changes.

artemrys · 2025-01-23T16:02:26Z

splunk_add_on_ucc_framework/data_ui_generator.py

@@ -34,15 +33,15 @@ def generate_nav_default_xml(
    include_inputs: bool,
    include_dashboard: bool,
    include_configuration: bool,
-    default_view: str,
+    default_view: Union[str, None],


I was wondering about this syntax, I found https://google.github.io/styleguide/pyguide.html#3195-nonetype

Made the changes.

artemrys · 2025-01-23T16:06:25Z

splunk_add_on_ucc_framework/global_config_validator.py

-        return [
-            resolve_tab(tab) for tab in self._config["pages"]["configuration"]["tabs"]
-        ]
+    def config_tabs(self) -> List[Any]:


Ok, agree, please create a ticket for it and let's refactor it after this PR is merged.

artemrys · 2025-01-23T16:07:52Z

splunk_add_on_ucc_framework/global_config_update.py

-    _collapse_entities(
-        global_config.content["pages"]["configuration"].get("tabs"), entity_type
-    )
+    if global_config.has_configuration():


_collapse_entities does accept None as a first option and it immediately returns, we can remove this if statement.

Made the changes.

hetangmodi-crest and others added 5 commits December 31, 2024 17:54

feat: given support for optional configuration page

ad3bb71

feat: update ui files for optional configuration

1aba2ef

feat: update generation logic of configuration.xml

be85138

test: add unit test cases

b0c1d45

fix: resolve typescript issue in configuration

1bb56cc

hetangmodi-crest added the enhancement New feature or request label Jan 3, 2025

hetangmodi-crest self-assigned this Jan 3, 2025

pull-request-size bot added the size/XL label Jan 3, 2025

srv-rr-github-token and others added 4 commits January 3, 2025 12:32

docs: updated docs regarding generated conf, xml and html files

3995495

fix: fix congiguration.xml generation

50c7a48

tests: add unit and smoke test case

a4bc679

test: add expected addons ui files

7264003

pull-request-size bot added size/XXL and removed size/XL labels Jan 7, 2025

hetangmodi-crest and others added 4 commits January 7, 2025 12:58

Merge branch 'develop' into feat/optional-configuration-page

5a35c20

chore: lint fixes

2b3a9e8

tests: add test addon and expected addon for smoke test

5c1b6fc

test(smoke): update tests to capture not generated files

4898e85

hetangmodi-crest assigned rohanm-crest Jan 7, 2025

hetangmodi-crest marked this pull request as ready for review January 7, 2025 11:56

hetangmodi-crest requested review from a team as code owners January 7, 2025 11:56

hetangmodi-crest requested review from artemrys, vtsvetkov-splunk, soleksy-splunk and kkedziak-splunk January 7, 2025 11:56

soleksy-splunk previously approved these changes Jan 8, 2025

View reviewed changes

docs/generated_files.md Outdated Show resolved Hide resolved

docs/generated_files.md Outdated Show resolved Hide resolved

docs/generated_files.md Outdated Show resolved Hide resolved

vtsvetkov-splunk added 2 commits January 8, 2025 18:01

Merge remote-tracking branch 'origin/develop' into feat/optional-conf…

9e51759

…iguration-page

simplify ts code

ffbe04c

Signed-off-by: Viktor Tsvetkov <[email protected]>

vtsvetkov-splunk previously approved these changes Jan 8, 2025

View reviewed changes

...expected_addon_no_configuration/Splunk_TA_UCCExample/appserver/static/js/build/entry_page.js Outdated Show resolved Hide resolved

hetangmodi-crest added 2 commits January 9, 2025 13:40

chore: add validators in inputs

4f2d411

docs: updated docs

b8bdccd

hetangmodi-crest dismissed vtsvetkov-splunk’s stale review via b8bdccd January 9, 2025 08:10

srv-rr-github-token and others added 2 commits January 9, 2025 08:11

docs: updated docs regarding generated conf, xml and html files

0533e39

chore: update globalConfig file

fe160a6

hetangmodi-crest added 2 commits January 9, 2025 18:00

chore: maintain parity across codebase

1a41cd3

tests: updated unit and smoke test case

38da3f8

vtsvetkov-splunk previously approved these changes Jan 9, 2025

View reviewed changes

hetangmodi-crest requested a review from sgoral-splunk January 10, 2025 05:49

kkedziak-splunk reviewed Jan 13, 2025

View reviewed changes

sgoral-splunk reviewed Jan 14, 2025

View reviewed changes

chore: simplify handling of default_view

8e28fc9

hetangmodi-crest dismissed vtsvetkov-splunk’s stale review via 8e28fc9 January 15, 2025 10:28

Merge branch 'develop' into feat/optional-configuration-page

1e5d55d

sgoral-splunk reviewed Jan 19, 2025

View reviewed changes

artemrys requested changes Jan 20, 2025

View reviewed changes

hetangmodi-crest added 2 commits January 23, 2025 13:15

test: remove js files

9ad2216

chore: resolve review comments

a90c117

hetangmodi-crest requested a review from artemrys January 23, 2025 11:30

hetangmodi-crest added 2 commits January 23, 2025 17:25

test: add unit test for error

2d7f0fc

chore: merge branch 'develop' into feat/optional-configuration-page

edb5ac0

artemrys requested changes Jan 23, 2025

View reviewed changes

hetangmodi-crest and others added 3 commits January 24, 2025 17:44

chore: resolve review comments

2066867

chore: merge branch 'develop' into feat/optional-configuration-page

a8fa8aa

update screenshots

e610244

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: make configuration page as optional #1521

feat: make configuration page as optional #1521

hetangmodi-crest commented Jan 3, 2025

soleksy-splunk left a comment

hetangmodi-crest commented Jan 9, 2025

soleksy-splunk commented Jan 9, 2025

vtsvetkov-splunk left a comment

artemrys commented Jan 10, 2025 •

edited

Loading

hetangmodi-crest commented Jan 13, 2025

kkedziak-splunk Jan 13, 2025

sgoral-splunk Jan 14, 2025

hetangmodi-crest Jan 15, 2025

sgoral-splunk Jan 14, 2025

sgoral-splunk Jan 19, 2025

hetangmodi-crest Jan 23, 2025

artemrys Jan 20, 2025

artemrys Jan 20, 2025

hetangmodi-crest Jan 23, 2025 •

edited

Loading

artemrys Jan 23, 2025

artemrys Jan 20, 2025

hetangmodi-crest Jan 23, 2025

artemrys Jan 23, 2025

hetangmodi-crest Jan 24, 2025

artemrys Jan 23, 2025

hetangmodi-crest Jan 24, 2025

artemrys Jan 23, 2025

artemrys Jan 23, 2025

hetangmodi-crest Jan 24, 2025

		)
		if default_view == "configuration" and self._global_config.has_configuration():

	if default_view == "configuration" and self._global_config.has_configuration():
	if default_view == "configuration" and not self._global_config.has_configuration():
	```?

feat: make configuration page as optional #1521

Are you sure you want to change the base?

feat: make configuration page as optional #1521

Conversation

hetangmodi-crest commented Jan 3, 2025

PR Type

Summary

Changes

User experience

Checklist

soleksy-splunk left a comment

Choose a reason for hiding this comment

hetangmodi-crest commented Jan 9, 2025

soleksy-splunk commented Jan 9, 2025

vtsvetkov-splunk left a comment

Choose a reason for hiding this comment

artemrys commented Jan 10, 2025 • edited Loading

hetangmodi-crest commented Jan 13, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hetangmodi-crest Jan 23, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

artemrys commented Jan 10, 2025 •

edited

Loading

hetangmodi-crest Jan 23, 2025 •

edited

Loading