[Workspace] feat: update workspace server to support data connection type

[raintygao]

Description

Update workspace server to support data connection type

This is a PR picked from #8013, as we want to separate frontend and server changes and merge server changes first for testing, so we extract server changes from #8013 and create this PR.

Testing the changes

Create workspace

post http://localhost:6601/api/workspaces

{
    "attributes": {
        "name": "workspace-name1",
        "color": "#54B399",
        "features": [
            "use-case-observability"
        ]
    },
    "settings": {
        "dataSources": [],
        "dataConnections": [
            "12345" // data connection object id
        ],
        "permissions": {
            "library_write": {
                "users": [
                    "%me%"
                ]
            },
            "write": {
                "users": [
                    "%me%"
                ]
            }
        }
    }
}

Result

{
    "success": true,
    "result": {
        "id": "_IlxNR"
    }
}

Update workspace

put http://localhost:6601/api/_IlxNR

{
    "attributes": {
        "name": "workspace-name1",
        "color": "#54B399",
        "features": [
            "use-case-observability"
        ]
    },
    "settings": {
        "dataSources": [],
        "dataConnections": [
            "12346" // new data connection object ids that you want to associate
        ],
        "permissions": {
            "library_write": {
                "users": [
                    "%me%"
                ]
            },
            "write": {
                "users": [
                    "%me%"
                ]
            }
        }
    }
}

Result

{
    "success": true,
    "result": true
}

Verify

get data-connection objects with workspace field
http://localhost:6601/api/saved_objects/_find?fields=id&fields=title&fields=workspaces&per_page=10000&type=data-connection&workspaces=*

Result

Changelog

• feat: update workspace server to support data connection type

Check List

• All tests pass
  • yarn test:jest
  • yarn test:jest_integration
• New functionality includes testing.
• New functionality has been documented.
• Update CHANGELOG.md
• Commits are signed per the DCO using --signoff

[codecov]

Codecov Report

Attention: Patch coverage is 97.50000% with 1 line in your changes missing coverage. Please review.

Project coverage is 64.05%. Comparing base (21f4218) to head (35996f2).
Report is 42 commits behind head on main.

Files with missing lines	Patch %	Lines
...ed_objects_wrapper_for_check_workspace_conflict.ts	50.00%	1 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #8200   +/-   ##
=======================================
  Coverage   64.04%   64.05%           
=======================================
  Files        3740     3741    +1     
  Lines       88608    88635   +27     
  Branches    13799    13803    +4     
=======================================
+ Hits        56746    56772   +26     
- Misses      31264    31265    +1     
  Partials      598      598           

Flag	Coverage Δ
Linux_1	30.06% <97.50%> (+0.02%)	⬆️
Linux_2	58.83% <ø> (ø)
Linux_3	40.37% <ø> (+<0.01%)	⬆️
Linux_4	31.46% <ø> (-0.01%)	⬇️
Windows_1	30.08% <97.50%> (+0.02%)	⬆️
Windows_2	58.78% <ø> (ø)
Windows_3	40.37% <ø> (+<0.01%)	⬆️
Windows_4	31.46% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[SuZhou-Joe]

Seems like a new pattern to me, so it will bypass the lint check?

[raintygao]

I suppose would, I checked some other usage before modified.
https://github.com/opensearch-project/OpenSearch-Dashboards/blob/main/src/plugins/data/opensearch_dashboards.json
https://github.com/opensearch-project/OpenSearch-Dashboards/blob/main/src/plugins/expressions/opensearch_dashboards.json

[SuZhou-Joe]

LGTM, so the permission on the data connections will be raised in another PR?

[raintygao]

LGTM, so the permission on the data connections will be raised in another PR?

Yes, this will be addressed and included in later PRs.

[SuZhou-Joe]

Nit: seems like the logic to handle the data connection are the same as data source, would it be possible to make it into a function like addOperationsToPromisesList(type: string)?

So the code here will be like

const promises = [];
const addOperationsToPromisesList = (type: string) => { xxx }

// Add data sources operations into promise
addOperationsToPromisesList(DATA_SOURCE_SAVED_OBJECT_TYPE);

// Add data connections operations into promise
addOperationsToPromisesList(DATA_CONNECTION_SAVED_OBJECT_TYPE);

[raintygao]

Sounds good, will optimize this part in #8013.

[ruanyl]

Why not reuse dataSources? It doesn't seem necessary to add an extra parameter dataConnections. Because for workspace, they are all data sources, I personally don't want it to be implemented in a way that every time adding new type of data source, it requires to change the API interface.

[ruanyl]

what's passed in here is just saved object ids, we could handle different type of data source internally.

[raintygao]

Yes, if we reuse dataSources field, we need to update this field from [‘id1’,‘id2’] to [{type:‘data-source’,id:‘id1’},{type:‘data-connection’,id:‘id2’], which would make a breaking change to existing API.