Refactor and move `Patterns` constructs. #376

MUzairS15 · 2023-09-28T15:55:45Z

Description

This PR

Refactors and moves Patterns constructs into meshkit, to ensure any component can use it.
This will also be helpful when we incorporate WASM, as some Pattern constructs would be required and importing the meshery server as a package is not ideal.
Adds description and icon attributes as HelmMetadata.
Notes for Reviewers

Signed commits

Yes, I signed my commits.

Signed-off-by: MUzairS15 <[email protected]>

leecalcote · 2023-09-28T20:25:46Z

utils/patterns/error.go

+}
+
+func ErrPatternFromCytoscape(err error) error {
+	return errors.New(ErrPatternFromCytoscapeCode, errors.Alert, []string{"Could not create design file from given cytoscape"}, []string{err.Error()}, []string{"Invalid cytoscape body", "Service name is empty for one or more services", "_data does not have correct data"}, []string{"Make sure cytoscape is valid", "Check if valid service name was passed in the request", "Make sure _data field has \"settings\" field"})


@MUzairS15 let's not speak to users in terms of the tech that we use. Please put on your user hat and re-write.

leecalcote · 2023-09-28T20:27:05Z

utils/patterns/utils.go

+	res := convertMapInterfaceMapString(in)
+	out, ok := res.(map[string]interface{})
+	if !ok {
+		fmt.Println("failed to cast")


We don't use Println...

leecalcote · 2023-09-28T20:27:33Z

utils/patterns/utils.go

+	return res
+}
+
+func GetRandomAlphabetsOfDigit(length int) (s string) {


Function description needed.

leecalcote · 2023-09-28T20:27:44Z

utils/utils.go

@@ -245,3 +245,19 @@ func Contains[G []K, K comparable](slice G, ele K) bool {
 	}
 	return false
 }
+
+func ManifestIsEmpty(manifests []string) bool {


Please add function description.

leecalcote · 2023-09-28T20:27:48Z

utils/utils.go

+	}
+	return true
+}
+


Please add function description.

leecalcote · 2023-09-28T22:45:01Z

models/events/database.go

@@ -19,7 +19,6 @@ func (e *Event) BeforeUpdate(tc *gorm.DB) (err error) {
 }

 func isEventStatusSupported(event *Event) error {
-
 	if event.Status != Read && event.Status != Unread {


Should this reference a struct/iota/enum from the Eventv2 schema?

It is referencing, if you see the schema Status is defined as an enum

leecalcote · 2023-09-28T22:47:12Z

utils/kubernetes/apply-helm-chart.go

-	AppVersion string `yaml:"appVersion"`
-	Name       string `yaml:"name"`
-	Version    string `yaml:"version"`
+	APIVersion  string `yaml:"apiVersion"`


Is there anyway for MeshKit to reference the Helm Controller model, using values ComponentDefinitions (granted that we wouldn't support all types of Helm connections immediately)?

This struct represents the index.yml and is used when deploying/fetching the helm charts. Referencing the Helm Controller model wouldn't serve the purpose here.

It would serve that purpose, but also many other purposes. I'm asking if we can reference that component, and only expose a single field.

leecalcote · 2023-09-28T22:48:26Z

utils/patterns/error.go

+}
+
+func ErrCreatePatternService(err error) error {
+	return errors.New(ErrCreatePatternServiceCode, errors.Alert, []string{"Failed to create design service from Manifest"}, []string{err.Error()}, []string{"Invalid Manifest", "Meshery doesn't identifies the Resource mentioned in the Manifest"}, []string{"Check if all of the meshery adapters are running", "Check if Meshery has successfully identified and registered Kubernetes components"})


Capitalize Meshery Adapters.

What type of Manifests are these? Kubernetes? If so, write "Kubernetes manifests".

Signed-off-by: Lee Calcote <[email protected]>

leecalcote · 2023-09-28T23:42:09Z

utils/patterns/pattern.go

+}
+
+// Service represents the services defined within the appfile
+type Service struct {


Outside of backwards compatibility and other changes that would be needed, there is no longer a need for Service, is there?

there is no longer a need for Service

Yes.
The pattern engine will also require changes.

leecalcote · 2023-09-28T23:49:03Z

utils/patterns/pattern.go

@@ -0,0 +1,698 @@
+package patterns


Where is the OpenAPI schema for this resource? Let's ensure that this package, structs, functions are based directly on that schema.

Below is the spec for Meshery Patterns, the structs defined here are internal (except DryRun).
https://github.com/meshery/meshery/blob/db401c30f56ff47eae6849bf19aad0c32d8dac2a/server/helpers/swagger.yaml#L2036

Let's put this PR on hold until the spec is properly defined.

Signed-off-by: MUzairS15 <[email protected]>

stale · 2023-11-14T00:28:57Z

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

stale · 2023-11-24T04:24:09Z

This issue is being automatically closed due to inactivity. However, you may choose to reopen this issue.

MUzairS15 added 2 commits September 28, 2023 21:08

refactor pattern code and add logic from server to meshkit

69bb3f5

Signed-off-by: MUzairS15 <[email protected]>

lint fixes

132b511

Signed-off-by: MUzairS15 <[email protected]>

MUzairS15 requested review from Yashsharma1911 and theBeginner86 September 28, 2023 15:56

MUzairS15 mentioned this pull request Sep 28, 2023

[Server] Add helm connection and move pattern constructs to meshkit for reuse meshery/meshery#8956

Open

1 task

fix lint issue

587410b

Signed-off-by: MUzairS15 <[email protected]>

leecalcote requested changes Sep 28, 2023

View reviewed changes

leecalcote added the area/patterns label Sep 28, 2023

leecalcote reviewed Sep 28, 2023

View reviewed changes

Error Code Updates. Renamed to "ErrPatternFromJSON"

fe43b4a

Signed-off-by: Lee Calcote <[email protected]>

leecalcote reviewed Sep 28, 2023

View reviewed changes

leecalcote requested changes Sep 28, 2023

View reviewed changes

MUzairS15 added 2 commits September 29, 2023 11:26

add comments and descriptions

075a3d2

Signed-off-by: MUzairS15 <[email protected]>

handle overrides for helm dry run

38670a7

Signed-off-by: MUzairS15 <[email protected]>

leecalcote added the pr/on hold PR/Issue on hold label Sep 29, 2023

leecalcote mentioned this pull request Sep 29, 2023

[Research] Generators, Templates, Scaffolding, Validators, and Docs from JSON Schema meshery/meshery#6870

Open

3 tasks

stale bot added the issue/stale Issue has not had any activity for an extended period of time label Nov 14, 2023

stale bot closed this Nov 24, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor and move `Patterns` constructs. #376

Refactor and move `Patterns` constructs. #376

MUzairS15 commented Sep 28, 2023

leecalcote Sep 28, 2023

leecalcote Sep 28, 2023

leecalcote Sep 28, 2023

leecalcote Sep 28, 2023

leecalcote Sep 28, 2023

leecalcote Sep 28, 2023

MUzairS15 Sep 29, 2023

leecalcote Sep 28, 2023

MUzairS15 Sep 29, 2023

leecalcote Sep 29, 2023

leecalcote Sep 28, 2023

leecalcote Sep 28, 2023

MUzairS15 Sep 29, 2023

leecalcote Sep 28, 2023

MUzairS15 Sep 29, 2023

leecalcote Sep 29, 2023

stale bot commented Nov 14, 2023

stale bot commented Nov 24, 2023

Refactor and move Patterns constructs. #376

Refactor and move Patterns constructs. #376

Conversation

MUzairS15 commented Sep 28, 2023

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

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

stale bot commented Nov 14, 2023

stale bot commented Nov 24, 2023

Refactor and move `Patterns` constructs. #376

Refactor and move `Patterns` constructs. #376