Enhancement/621 appstructure fields (#85)

Adds list of fields to appstructure file when getting app structure

Author: DnlLrssn

appstructure/appstructure.go

@@ -3,6 +3,7 @@ package appstructure
 import (
 	"encoding/json"
 
+	"github.com/qlik-oss/enigma-go"
 	"github.com/qlik-oss/gopherciser/enummap"
 )
 
@@ -98,13 +99,20 @@ type (
 		RawProperties json.RawMessage `json:"rawProperties,omitempty"`
 	}
 
+	// AppStructureField list of fields in the app
+	AppStructureField struct {
+		enigma.NxFieldDescription
+	}
+
 	// AppStructure of Sense app
 	AppStructure struct {
 		AppMeta AppStructureAppMeta `json:"meta"`
 		// Objects in Sense app
 		Objects map[string]AppStructureObject `json:"objects"`
 		// Bookmark list of bookmarks in the app
 		Bookmarks map[string]AppStructureBookmark `json:"bookmarks"`
+		// Fields list of all fields in the app
+		Fields map[string]AppStructureField `json:"fields"`
 	}
 
 	// AppStructurePopulatedObjects is the type returned by an action when prompted for selectable objects

config/appstructure.go

@@ -4,18 +4,18 @@ import (
 	"context"
 	"encoding/json"
 	"fmt"
-	"github.com/InVisionApp/tabular"
-	"github.com/qlik-oss/gopherciser/appstructure"
-	"github.com/qlik-oss/gopherciser/helpers"
 	"path/filepath"
 	"strconv"
 	"strings"
 	"sync"
 	"time"
 
+	"github.com/InVisionApp/tabular"
 	"github.com/pkg/errors"
 	"github.com/qlik-oss/enigma-go"
 	"github.com/qlik-oss/gopherciser/action"
+	"github.com/qlik-oss/gopherciser/appstructure"
+	"github.com/qlik-oss/gopherciser/helpers"
 	"github.com/qlik-oss/gopherciser/logger"
 	"github.com/qlik-oss/gopherciser/scenario"
 	"github.com/qlik-oss/gopherciser/scheduler"
@@ -676,6 +676,47 @@ func (structure *GeneratedAppStructure) handleBookmark(ctx context.Context, app
 	return nil
 }
 
+func (structure *GeneratedAppStructure) getFieldListAsync(sessionState *session.State, actionState *action.State, app *senseobjects.App) {
+	// Create fieldlist object and handle fields
+	sessionState.QueueRequest(func(ctx context.Context) error {
+		fieldlist, err := senseobjects.CreateFieldListObject(ctx, app.Doc)
+		if err != nil {
+			return err
+		}
+
+		sessionState.QueueRequestWithCallback(fieldlist.UpdateLayout, actionState, true, "", func(err error) {
+			properties := fieldlist.Layout()
+			if properties == nil {
+				actionState.AddErrors(errors.New("fieldlist layout is nil"))
+				return
+			}
+			if properties.FieldList == nil {
+				actionState.AddErrors(errors.New("FieldList missing from fieldlist layout"))
+				return
+			}
+			for _, field := range properties.FieldList.Items {
+				structure.addField(field)
+			}
+		})
+		return nil
+	}, actionState, true, "")
+}
+
+func (structure *GeneratedAppStructure) addField(field *enigma.NxFieldDescription) {
+	if field == nil {
+		return
+	}
+	structure.structureLock.Lock()
+	defer structure.structureLock.Unlock()
+
+	if structure.Fields == nil {
+		structure.Fields = make(map[string]appstructure.AppStructureField)
+	}
+	structure.Fields[field.Name] = appstructure.AppStructureField{
+		NxFieldDescription: *field,
+	}
+}
+
 func resolveTitle(obj *appstructure.AppStructureObject, properties json.RawMessage, paths []string) {
 	if obj.MetaDef.Title != "" {
 		return // We already have a title

config/getappstructure.go

@@ -4,14 +4,15 @@ import (
 	"context"
 	"encoding/json"
 	"fmt"
+	"os"
+	"sync"
+
 	"github.com/pkg/errors"
 	"github.com/qlik-oss/enigma-go"
 	"github.com/qlik-oss/gopherciser/action"
 	"github.com/qlik-oss/gopherciser/appstructure"
 	"github.com/qlik-oss/gopherciser/connection"
 	"github.com/qlik-oss/gopherciser/session"
-	"os"
-	"sync"
 )
 
 type (
@@ -74,10 +75,17 @@ func (settings *getAppStructureSettings) Execute(sessionState *session.State, ac
 		}
 	}
 
+	appStructure.getFieldListAsync(sessionState, actionState, app)
+
 	if sessionState.Wait(actionState) {
 		return // An error occurred
 	}
 
+	// TODO clicking the "Selections" tab in sense would normally create a fieldlist and a dimensionlist object
+	// to get dimensions and fields. We however already have master object dimensions in object list
+	// should these be moved to a combined field+dimension list? Leave this as is now and to be decided
+	// when implementing actions using fields and decide what works best for GUI.
+
 	raw, err := json.MarshalIndent(appStructure, "", "  ")
 	if err != nil {
 		actionState.AddErrors(errors.Wrap(err, "error marshaling app structure"))

senseobjects/fieldlist.go

@@ -0,0 +1,91 @@
+package senseobjects
+
+import (
+	"context"
+	"sync"
+
+	"github.com/pkg/errors"
+	"github.com/qlik-oss/enigma-go"
+)
+
+type (
+	FieldList struct {
+		enigmaObject *enigma.GenericObject
+		layout       *enigma.GenericObjectLayout
+		properties   *enigma.GenericObjectProperties
+		mutex        sync.Mutex
+	}
+)
+
+// CreateFieldListObject create fieldlist session object
+func CreateFieldListObject(ctx context.Context, doc *enigma.Doc) (*FieldList, error) {
+	properties := &enigma.GenericObjectProperties{
+		Info: &enigma.NxInfo{
+			Type: "FieldList",
+		},
+		FieldListDef: &enigma.FieldListDef{
+			ShowSystem:         false,
+			ShowHidden:         false,
+			ShowSemantic:       true,
+			ShowSrcTables:      true,
+			ShowDerivedFields:  true,
+			ShowImplicit:       false,
+			ShowDefinitionOnly: false,
+		},
+	}
+
+	obj, err := doc.CreateSessionObject(ctx, properties)
+	if err != nil {
+		return nil, errors.Wrapf(err, "Failed to create fieldlist session object in app<%s>", doc.GenericId)
+	}
+
+	return &FieldList{enigmaObject: obj, properties: properties}, nil
+}
+
+// UpdateLayout update object with new layout from engine
+func (fieldlist *FieldList) UpdateLayout(ctx context.Context) error {
+	layout, err := fieldlist.enigmaObject.GetLayout(ctx)
+	if err != nil {
+		return errors.WithStack(err)
+	}
+
+	fieldlist.setLayout(layout)
+	return nil
+}
+
+func (fieldlist *FieldList) setLayout(layout *enigma.GenericObjectLayout) {
+	fieldlist.mutex.Lock()
+	defer fieldlist.mutex.Unlock()
+	fieldlist.layout = layout
+}
+
+// Layout of fieldlist object
+func (fieldlist *FieldList) Layout() *enigma.GenericObjectLayout {
+	fieldlist.mutex.Lock()
+	defer fieldlist.mutex.Unlock()
+	return fieldlist.layout
+}
+
+// UpdateProperties update object with new properties from engine
+func (fieldlist *FieldList) UpdateProperties(ctx context.Context) error {
+	properties, err := fieldlist.enigmaObject.GetProperties(ctx)
+	if err != nil {
+		return errors.WithStack(err)
+	}
+
+	fieldlist.setProperties(properties)
+	return nil
+}
+
+func (fieldlist *FieldList) setProperties(properties *enigma.GenericObjectProperties) {
+	fieldlist.mutex.Lock()
+	defer fieldlist.mutex.Unlock()
+	fieldlist.properties = properties
+}
+
+// Properties of fieldlist object
+func (fieldlist *FieldList) Properties() *enigma.GenericObjectProperties {
+	fieldlist.mutex.Lock()
+	defer fieldlist.mutex.Unlock()
+	return fieldlist.properties
+}