Providers schema #53

johncalesp · 2023-03-28T20:35:11Z

Added a new setting so users can reference external JSON files about cloud instances
Added new JSON schema for cloud providers
Change references to pull data from centML S3 bucket
Changed README file to let users know about our JSON schema

… testing | changed parsers.js

codeclimate · 2023-03-28T20:35:36Z

skyline-vscode/react-ui/src/utils/parsers.js

+          code: `status: ${resp.statusText} | code: ${resp.status}`,
+        });
+      }
+    } else {


Identical blocks of code found in 2 locations. Consider refactoring.

codeclimate · 2023-03-28T20:35:36Z

skyline-vscode/react-ui/src/utils/parsers.js

+    this.errors = [];
+  }
+}
+export const loadJsonFiles = async (habitatData, additionalProviders) => {


Function loadJsonFiles has 77 lines of code (exceeds 25 allowed). Consider refactoring.

You could refactor by wrapping some repeated logic with helper functions

moved logic to utils.js

codeclimate · 2023-03-28T20:35:36Z

skyline-vscode/react-ui/src/utils/parsers.js

+              logo: cloudProvider.logo,
+              color: cloudProvider.color,
+            };
+            for (const instanceData of cloudProvider.instances) {


Avoid deeply nested control flow statements.

codeclimate · 2023-03-28T20:35:37Z

skyline-vscode/react-ui/src/sections/DeploymentTab.test.js

-    <DeploymentTab numIterations={numIterations} habitatData={data} />
-  );
+  // Mock fetch response
+  jest.spyOn(global, 'fetch').mockResolvedValue({


Identical blocks of code found in 3 locations. Consider refactoring.

codeclimate · 2023-03-28T20:35:37Z

skyline-vscode/react-ui/src/sections/ProviderPanel.test.js

  // ARRANGE
+  // Mock fetch response
+  jest.spyOn(global, 'fetch').mockResolvedValue({


Identical blocks of code found in 3 locations. Consider refactoring.

codeclimate · 2023-03-29T13:36:57Z

skyline-vscode/react-ui/src/sections/ProviderPanel.test.js


 const { ResizeObserver } = window;
 const numIterations = 10000;

-const data = [
+const habitatData = [


Similar blocks of code found in 3 locations. Consider refactoring.

codeclimate · 2023-03-29T13:36:57Z

skyline-vscode/react-ui/src/sections/ProviderPanel.test.js

  // ARRANGE
-  const { container } = render(<ProviderPanel numIterations={numIterations} habitatData={noHabitatData} />);
+  // Mock fetch response
+  jest.spyOn(global, 'fetch').mockResolvedValue({


Identical blocks of code found in 3 locations. Consider refactoring.

codeclimate · 2023-03-29T13:36:58Z

skyline-vscode/react-ui/src/utils/parsers.test.js

+  ["RTX4000", 20.2342],
+];
+
+const correctData = [


Identical blocks of code found in 2 locations. Consider refactoring.

codeclimate · 2023-03-29T13:36:58Z

skyline-vscode/react-ui/src/sections/ProviderPanel.test.js

@@ -19,6 +21,35 @@ const data = [
  ["RTX4000", 20.2342],
 ];

+const correctData = [


Identical blocks of code found in 2 locations. Consider refactoring.

codeclimate · 2023-03-29T13:36:58Z

skyline-vscode/react-ui/src/utils/parsers.js

+            })),
+          });
+        }
+      } catch (error) {


Identical blocks of code found in 2 locations. Consider refactoring.

You could encapsulate this into a helper function

michaelshin · 2023-03-29T14:19:45Z

README.md

@@ -29,14 +29,44 @@ To install, either:
 Once you have the vsix file, run `code --install-extension vscode*.vsix` to install the extension.
 **Note: the file [build_vsix_dev.sh] is only to be used for development**

+**Adding cloud instances to the Deployment Tab:** You can include information about the instances that you use thrugh the extension settings. There you will find an option named **providers** that accepts a list of urls separated by commas. Each url must be a JSON file that follows the schema speficied here : [schema](skyline-vscode/react-ui/src/schema/CloudProvidersSchema.js).<br/>


typo on "specified"

michaelshin · 2023-03-29T14:19:53Z

README.md

@@ -29,14 +29,44 @@ To install, either:
 Once you have the vsix file, run `code --install-extension vscode*.vsix` to install the extension.
 **Note: the file [build_vsix_dev.sh] is only to be used for development**

+**Adding cloud instances to the Deployment Tab:** You can include information about the instances that you use thrugh the extension settings. There you will find an option named **providers** that accepts a list of urls separated by commas. Each url must be a JSON file that follows the schema speficied here : [schema](skyline-vscode/react-ui/src/schema/CloudProvidersSchema.js).<br/>
+Addittionally, you need to add the necessary access so the extension can read the file.<br/>


Typo on Additionally

michaelshin · 2023-03-29T14:24:08Z

skyline-vscode/react-ui/src/utils/parsers.js

+export const loadJsonFiles = async (habitatData, additionalProviders) => {
+  const buffer = new ResponseBuffer();
+  let urlList = [
+    "https://deepview-explorer-public.s3.amazonaws.com/vscode-cloud-providers/providers.json",


This should be stored as a constant in properties.js

moved variable to properties.js

michaelshin · 2023-03-29T14:28:08Z

skyline-vscode/react-ui/src/utils/parsers.js

+const ajv = new Ajv({ allErrors: true }); // to report all validation errors (rather than failing on the first errors)
+const validate = ajv.compile(cloudProviderSchema);
+
+class ResponseBuffer {


Rename this so it is more clear what is used for

class was deleted

michaelshin · 2023-03-29T14:29:08Z

skyline-vscode/react-ui/src/utils/parsers.js

+            })),
+          });
+        }
+      } catch (error) {


You could encapsulate this into a helper function

michaelshin · 2023-03-29T14:31:32Z

skyline-vscode/react-ui/src/utils/parsers.js

+    this.errors = [];
+  }
+}
+export const loadJsonFiles = async (habitatData, additionalProviders) => {


You could refactor by wrapping some repeated logic with helper functions

codeclimate · 2023-03-29T15:54:42Z

skyline-vscode/react-ui/src/utils/parsers.js

+const ajv = new Ajv({ allErrors: true }); // to report all validation errors (rather than failing on the first errors)
+const validate = ajv.compile(cloudProviderSchema);
+
+export const loadJsonFiles = async (habitatData, additionalProviders) => {


Function loadJsonFiles has 68 lines of code (exceeds 25 allowed). Consider refactoring.

codeclimate · 2023-03-29T15:54:42Z

skyline-vscode/react-ui/src/utils/parsers.test.js

+    fill: "#ea4335",
+    z: 200,
+  });
+  expect(resp.instanceArray).toContainEqual({


Similar blocks of code found in 2 locations. Consider refactoring.

codeclimate · 2023-03-29T15:54:42Z

skyline-vscode/react-ui/src/utils/parsers.test.js

+import { enableFetchMocks } from "jest-fetch-mock";
+enableFetchMocks();
+
+const habitatData = [


Similar blocks of code found in 3 locations. Consider refactoring.

codeclimate · 2023-03-29T15:54:42Z

skyline-vscode/react-ui/src/utils/parsers.test.js

+    },
+  });
+  expect(resp.instanceArray.length).toEqual(2);
+  expect(resp.instanceArray).toContainEqual({


Similar blocks of code found in 2 locations. Consider refactoring.

codeclimate · 2023-03-29T15:54:43Z

skyline-vscode/react-ui/src/sections/DeploymentTab.test.js

+    json: jest.fn().mockResolvedValue(correctData)
+  })
+
+    const { container } = render(


Similar blocks of code found in 3 locations. Consider refactoring.

michaelshin · 2023-03-29T16:08:22Z

skyline-vscode/react-ui/src/utils/utils.js

+}
+
+export function fetchingURLErrors(type, response, validationErrors) {


I think this function should function is doing too much specific work and not general work. I think you should keep the general case. For the invalid schema error, you can revert that change and have this only handle errors when fetching URLs.

Also I think you should remain the function to the active voice (e.g. getErrMsgFromInvalidURL

codeclimate · 2023-03-29T16:33:17Z

skyline-vscode/react-ui/src/utils/parsers.js

+const ajv = new Ajv({ allErrors: true }); // to report all validation errors (rather than failing on the first errors)
+const validate = ajv.compile(cloudProviderSchema);
+
+export const loadJsonFiles = async (habitatData, additionalProviders) => {


Function loadJsonFiles has 74 lines of code (exceeds 25 allowed). Consider refactoring.

codeclimate · 2023-03-29T16:33:17Z

skyline-vscode/react-ui/src/sections/ProviderPanel.test.js

+    ok: true,
+    json: jest.fn().mockResolvedValue(correctData)
+  })
+  const { container } = render(<ProviderPanel numIterations={numIterations} habitatData={noHabitatData} additionalProviders={""}/>);


Similar blocks of code found in 3 locations. Consider refactoring.

codeclimate · 2023-03-29T16:33:17Z

skyline-vscode/react-ui/src/utils/parsers.js

+const ajv = new Ajv({ allErrors: true }); // to report all validation errors (rather than failing on the first errors)
+const validate = ajv.compile(cloudProviderSchema);
+
+export const loadJsonFiles = async (habitatData, additionalProviders) => {


Function loadJsonFiles has a Cognitive Complexity of 24 (exceeds 5 allowed). Consider refactoring.

codeclimate · 2023-03-29T16:33:17Z

skyline-vscode/react-ui/src/utils/parsers.test.js

+];
+
+test("Validate JSON file (URL) and return list of cloud providers and instances", async () => {
+  jest.spyOn(global, "fetch").mockResolvedValue({


Similar blocks of code found in 2 locations. Consider refactoring.

codeclimate · 2023-03-29T16:33:17Z

skyline-vscode/react-ui/src/utils/parsers.test.js

+});
+
+test("JSON file (URL) is not in the correct format", async () => {
+  jest.spyOn(global, "fetch").mockResolvedValue({


Similar blocks of code found in 2 locations. Consider refactoring.

codeclimate · 2023-03-29T16:33:20Z

Code Climate has analyzed commit 2349588 and detected 19 issues on this pull request.

Here's the issue category breakdown:

Category	Count
Complexity	4
Duplication	15

View more on Code Climate.

johncalesp added 19 commits March 6, 2023 09:17

read local yaml file

53a4eae

completed unit testing

19aecda

Merge branch 'main' into providers-schema

8af84cb

added general yaml schema for external cloud providers | changes unit…

0e103e4

… testing | changed parsers.js

changed URL providers to S3

c2a7157

get data from multiple urls

4d2c3c9

changed extension setting description

e62f776

merged with main

e000657

changed to centML S3

37dc1d8

local tests

5d990c2

local changes to skylinesession

d59ab65

merged changes from main

4239bcc

installation of json parser

906de83

Merge branch 'main' into providers-schema

9280ad0

changed to json schema

f85468d

Merge branch 'main' into providers-schema

16f7930

finished reading json from external urls and show incorrect data

0035587

Merge branch 'main' into providers-schema

4ba6544

changed unit testing and tested with build script

d36ae3b

johncalesp requested review from jimgao1 and michaelshin March 28, 2023 20:35

codeclimate bot reviewed Mar 28, 2023

View reviewed changes

changed default providers settings to empty string

5c7d0b3

codeclimate bot reviewed Mar 29, 2023

View reviewed changes

michaelshin reviewed Mar 29, 2023

View reviewed changes

PR review

5697d6e

codeclimate bot reviewed Mar 29, 2023

View reviewed changes

johncalesp requested a review from michaelshin March 29, 2023 15:55

michaelshin reviewed Mar 29, 2023

View reviewed changes

changed utils.js file

2349588

johncalesp requested a review from michaelshin March 29, 2023 16:32

codeclimate bot reviewed Mar 29, 2023

View reviewed changes

michaelshin approved these changes Mar 29, 2023

View reviewed changes

johncalesp merged commit 0d47046 into main Mar 29, 2023

johncalesp deleted the providers-schema branch March 29, 2023 16:43

		}

		export function fetchingURLErrors(type, response, validationErrors) {

Providers schema #53

Providers schema #53

Conversation

johncalesp commented Mar 28, 2023

codeclimate bot Mar 28, 2023

Choose a reason for hiding this comment

codeclimate bot Mar 28, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codeclimate bot Mar 28, 2023

Choose a reason for hiding this comment

codeclimate bot Mar 28, 2023

Choose a reason for hiding this comment

codeclimate bot Mar 28, 2023

Choose a reason for hiding this comment

codeclimate bot Mar 29, 2023

Choose a reason for hiding this comment

codeclimate bot Mar 29, 2023

Choose a reason for hiding this comment

codeclimate bot Mar 29, 2023

Choose a reason for hiding this comment

codeclimate bot Mar 29, 2023

Choose a reason for hiding this comment

codeclimate bot Mar 29, 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

codeclimate bot Mar 29, 2023

Choose a reason for hiding this comment

codeclimate bot Mar 29, 2023

Choose a reason for hiding this comment

codeclimate bot Mar 29, 2023

Choose a reason for hiding this comment

codeclimate bot Mar 29, 2023

Choose a reason for hiding this comment

codeclimate bot Mar 29, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codeclimate bot Mar 29, 2023

Choose a reason for hiding this comment

codeclimate bot Mar 29, 2023

Choose a reason for hiding this comment

codeclimate bot Mar 29, 2023

Choose a reason for hiding this comment

codeclimate bot Mar 29, 2023

Choose a reason for hiding this comment

codeclimate bot Mar 29, 2023

Choose a reason for hiding this comment

codeclimate bot commented Mar 29, 2023