README.md for saving index pattern relationship (opensearch-project#2276

)

Add readme for saved object and index pattern relationship

Signed-off-by: abbyhu2000 <[email protected]>
Signed-off-by: Sergey V. Osipov <[email protected]>

src/plugins/saved_objects/README.md

@@ -0,0 +1,119 @@
+# Saved object
+
+The saved object plugin provides all the core services and functionalities of saved objects. It is utilized by many core plugins such as [`visualization`](../visualizations/), [`dashboard`](../dashboard/) and [`wizard`](../wizard/), as well as external plugins. Saved object is the primary way to store app and plugin data in a standardized form in OpenSearch Dashboards. They allow plugin developers to manage creating, saving, editing and retrieving data for the application. They can also make reference to other saved objects and have useful features out of the box, such as migrations and strict typings. The saved objects can be managed by the Saved Object Management UI.
+
+## Save relationships to index pattern
+
+Saved objects that have relationships to index patterns are saved using the [`kibanaSavedObjectMeta`](https://github.com/opensearch-project/OpenSearch-Dashboards/blob/4a06f5a6fe404a65b11775d292afaff4b8677c33/src/plugins/saved_objects/public/saved_object/helpers/serialize_saved_object.ts#L59) attribute and the [`references`](https://github.com/opensearch-project/OpenSearch-Dashboards/blob/4a06f5a6fe404a65b11775d292afaff4b8677c33/src/plugins/saved_objects/public/saved_object/helpers/serialize_saved_object.ts#L60) array structure. Functions from the data plugin are used by the saved object plugin to manage this index pattern relationship. 
+
+A standard saved object and its index pattern relationship:
+
+```ts
+
+"kibanaSavedObjectMeta" : {
+    "searchSourceJSON" : """{"filter":[],"query":{"query":"","language":"kuery"},"indexRefName":"kibanaSavedObjectMeta.searchSourceJSON.index"}"""
+      }
+    },
+    "type" : "visualization",
+    "references" : [
+      {
+          "name" : "kibanaSavedObjectMeta.searchSourceJSON.index",
+          "type" : "index-pattern",
+          "id" : "90943e30-9a47-11e8-b64d-95841ca0b247"
+      }
+    ],
+
+```
+
+### Saving a saved object
+
+When saving a saved object and its relationship to the index pattern: 
+
+1. A saved object will be built using [`buildSavedObject`](https://github.com/opensearch-project/OpenSearch-Dashboards/blob/4a06f5a6fe404a65b11775d292afaff4b8677c33/src/plugins/saved_objects/public/saved_object/helpers/build_saved_object.ts#L46) function. Services such as hydrating index pattern, initializing and serializing the saved object are set, and configs such as saved object id, migration version are defined.
+2. The saved object will then be serialized by three steps: 
+
+    a. By using [`extractReferences`](https://github.com/opensearch-project/OpenSearch-Dashboards/blob/4a06f5a6fe404a65b11775d292afaff4b8677c33/src/plugins/data/common/search/search_source/extract_references.ts#L35) function from the data plugin, the index pattern information will be extracted using the index pattern id within the `kibanaSavedObjectMeta`, and the id will be replaced by a reference name, such as `indexRefName`. A corresponding index pattern object will then be created to include more detailed information of the index pattern: name (`kibanaSavedObjectMeta.searchSourceJSON.index`), type, and id.
+
+    ```ts
+     let searchSourceFields = { ...state };
+    const references = [];
+
+    if (searchSourceFields.index) {
+        const indexId = searchSourceFields.index.id || searchSourceFields.index;
+        const refName = 'kibanaSavedObjectMeta.searchSourceJSON.index';
+        references.push({
+            name: refName,
+            type: 'index-pattern',
+            id: indexId
+        });
+        searchSourceFields = { ...searchSourceFields,
+        indexRefName: refName,
+        index: undefined
+        };
+    }
+    ```
+
+    b. The `indexRefName` along with other information will be stringified and saved into `kibanaSavedObjectMeta.searchSourceJSON`. 
+
+    c. Saved object client will create the reference array attribute, and the index pattern object will be pushed into the  reference array.
+
+
+### Loading an existing or creating a new saved object
+
+1. When loading an existing object or creating a new saved object, [`initializeSavedObject`](https://github.com/opensearch-project/OpenSearch-Dashboards/blob/4a06f5a6fe404a65b11775d292afaff4b8677c33/src/plugins/saved_objects/public/saved_object/helpers/initialize_saved_object.ts#L38) function will be called. 
+2. The saved object will be deserialized in the [`applyOpenSearchResp`](https://github.com/opensearch-project/OpenSearch-Dashboards/blob/4a06f5a6fe404a65b11775d292afaff4b8677c33/src/plugins/saved_objects/public/saved_object/helpers/apply_opensearch_resp.ts#L50) function.
+
+    a. Using [`injectReferences`](https://github.com/opensearch-project/OpenSearch-Dashboards/blob/4a06f5a6fe404a65b11775d292afaff4b8677c33/src/plugins/data/common/search/search_source/inject_references.ts#L34) function from the data plugin, the index pattern reference name within the `kibanaSavedObject` will be substituted by the index pattern id and the corresponding index pattern reference object will be deleted if filters are applied.
+
+    ```ts
+    searchSourceReturnFields.index = reference.id;
+    delete searchSourceReturnFields.indexRefName;
+    ```
+
+### Others
+
+If a saved object type wishes to have additional custom functionalities when extracting/injecting references, or after OpenSearch's response, it can define functions in the class constructor when extending the `SavedObjectClass`. For example, visualization plugin's [`SavedVis`](https://github.com/opensearch-project/OpenSearch-Dashboards/blob/4a06f5a6fe404a65b11775d292afaff4b8677c33/src/plugins/visualizations/public/saved_visualizations/_saved_vis.ts#L91) class has additional `extractReferences`, `injectReferences` and `afterOpenSearchResp` functions defined in [`_saved_vis.ts`](../visualizations/public/saved_visualizations/_saved_vis.ts).
+
+```ts
+class SavedVis extends SavedObjectClass {
+    constructor(opts: Record<string, unknown> | string = {}) {
+      super({
+        ... ...
+        extractReferences,
+        injectReferences,
+        ... ...
+        afterOpenSearchResp: async (savedObject: SavedObject) => {
+          const savedVis = (savedObject as any) as ISavedVis;
+          ... ...
+          
+          return (savedVis as any) as SavedObject;
+        },
+```
+
+## Migration
+
+When a saved object is created using a previous version, the migration will trigger if there is a new way of saving the saved object and the migration functions alter the structure of the old saved object to follow the new structure. Migrations can be defined in the specific saved object type in the plugin's server folder. For example, 
+
+```ts
+export const visualizationSavedObjectType: SavedObjectsType = {
+  name: 'visualization',
+  management: {},
+  mappings: {},
+  migrations: visualizationSavedObjectTypeMigrations,
+};
+```
+
+```ts
+const visualizationSavedObjectTypeMigrations = {
+  '1.0.0': flow(migrateIndexPattern),
+```
+
+The migraton version will be saved as a `migrationVersion` attribute in the saved object, not to be confused with the other `verson` attribute.
+
+```ts
+"migrationVersion" : {
+    "visualization" : "1.0.0"
+},
+```
+
+For a more detailed explanation on the migration, refer to [`saved objects management`](src/core/server/saved_objects/migrations/README.md).