Dependency fix on typescript CLI #1180

reebayroo · 2024-08-28T19:31:56Z

This PR contains the following:

Fixing the support for Http and File dependencies on the dependencies property of morphir.json file
Fixing the localDependencies compatibility
Integration tests for local and dependencies
Unit tests for the dependencies module

Terms

THIS SOFTWARE IS CONTRIBUTED SUBJECT TO THE TERMS OF THE TERMS OF THE CCLA DATED 2017-11-07 WITH FINOS/LINUX FOUNDATION (FORMERLY THE SYMPHONY SOFTWARE FOUNDATION CCLA).

THIS SOFTWARE IS LICENSED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE AND ANY WARRANTY OF NON-INFRINGEMENT, ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. THIS SOFTWARE MAY BE REDISTRIBUTED TO OTHERS ONLY BY EFFECTIVELY USING THIS OR ANOTHER EQUIVALENT DISCLAIMER IN ADDITION TO ANY OTHER REQUIRED LICENSE TERMS.

reebayroo · 2024-08-29T14:54:36Z

cli2/dependencies.test.ts

Unit test for the dependencies file

reebayroo · 2024-08-29T14:55:06Z

cli2/dependencies.ts

@@ -9,7 +11,7 @@ import { ResultAsync } from "neverthrow";
 const parseDataUrl = require("data-urls");
 const fsReadFile = util.promisify(fs.readFile);

-const DataUrl = z.string().trim().transform((val, ctx) => {
+export const DataUrl = z.string().trim().transform((val, ctx) => {


Exposing this objects so they can be unit tested

reebayroo · 2024-08-29T14:55:22Z

cli2/dependencies.ts

@@ -21,7 +23,7 @@ const DataUrl = z.string().trim().transform((val, ctx) => {
  return parsed;
 });

-const FileUrl = z.string().trim().url().transform((val, ctx) => {
+export const FileUrl = z.string().trim().url().transform((val, ctx) => {


Exposing this objects so they can be unit tested

reebayroo · 2024-08-29T14:56:43Z

cli2/dependencies.ts

  owner: z.string(),
  repo: z.string(),
  baseUrl: z.string().optional()
 });

 const GithubConfig = z.union([GithubData, z.string()]);

-const DependencySettings = z.union([DataUrl, FileUrl, z.string().trim()])
+// const DependencySettings = z.union([DataUrl, FileUrl, z.string().trim()])
+const DependencySettings =  z.string().trim();
 const Dependencies = z.array(DependencySettings).default([]);


This is the fix for the Dependencies

reebayroo · 2024-08-29T14:57:14Z

cli2/dependencies.ts

@@ -112,7 +129,7 @@ export async function loadAllDependencies(config: DependencyConfig) {
  const finalResults = await Promise.all(results);
  return finalResults.flatMap((result) => {
    if (result.isOk()) {
-      console.error("Successfully loaded dependency", result.value.dependency)
+      console.info("Successfully loaded dependency", result.value.dependency)


removing error messages for debugging purposes

reebayroo · 2024-09-03T13:13:36Z

cli2/cli.ts

@@ -46,7 +46,8 @@ async function make(
  const dependencyConfig = DependencyConfig.parse({
    dependencies: morphirJson.dependencies,
    localDependencies: morphirJson.localDependencies,
-    includes: includes
+    includes: includes, 
+    projectDir: projectDir
  })


ProjectDir preserves the project directory option passed through the command line

reebayroo · 2024-09-03T13:15:05Z

cli2/dependencies.test.ts

+            expect(fileData).toBeUndefined
+        });
+    });
+


The dependencies test helps enforce the business logic of those types, ie the Url type does not support anything but ftp and http(s)

reebayroo · 2024-09-03T13:15:19Z

cli2/dependencies.ts

 import { Readable } from "stream";
-import { ResultAsync } from "neverthrow";
+


Organizing imports

reebayroo · 2024-09-03T13:17:26Z

cli2/dependencies.ts

+  url?: URL,
+
+}
+


Used by LocalFile to keep track of the different forms of a path

reebayroo · 2024-09-03T13:24:57Z

cli2/dependencies.ts

 import { decode, labelToName } from "whatwg-encoding";
+import { z } from "zod";
+import { fetchUriToJson } from "./get-uri-wrapper";


get-uri-wrapper works a facade so HTTP types can be mocked.

reebayroo · 2024-09-03T13:26:54Z

gulpfile.js

@@ -214,7 +214,7 @@ async function testUnit(cb) {
 }

 async function compileCli2Ts() {
-    src('./cli2/*.ts').pipe(cliTsProject()).pipe(dest('./cli2/lib/'))
+    src(['./cli2/*.ts', '!./cli2/*.test.ts' ]).pipe(cliTsProject()).pipe(dest('./cli2/lib/'))
 }



Excluding unit tests from being copied to lib folder, otherwise the tes.js files will run , and fail, during integration tests

reebayroo · 2024-09-03T13:28:51Z

package.json

@@ -18,6 +18,7 @@
    "ncc-morphir": "ncc build cli/morphir.js -o dist/morphir",
    "ncc-morphir-server": "ncc build cli/morphir-elm-develop.js -o dist/morphir-server",
    "build": "gulp && npm run ncc-morphir && npm run ncc-morphir-server && npx jest && gulp test",
+    "build-cli2": "gulp buildCLI2",


To speed up process of running integration tests

DamianReeves

LGTM

reebayroo added 4 commits August 26, 2024 12:15

Fixing Tests

22450b0

Passing builds without skipping

c7f6232

output files ignored

9de3004

Dependencies fix (compatibility and dependencies issues)

44cb4dd

reebayroo commented Aug 29, 2024

View reviewed changes

cli2/dependencies.test.ts

Copy link

Contributor Author

reebayroo Aug 29, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unit test for the dependencies file

reebayroo commented Aug 29, 2024

View reviewed changes

reebayroo added 7 commits August 29, 2024 11:06

package json clean up

ab6ca8a

refactory moving common code to wrapper

09da540

Http Support Tests

33361e8

Url config type tests

f3e8e15

clean up and simplify

8c161b5

clean up and simplify

b919fa5

Support for ProjectDirectory option

0b7a63a

reebayroo marked this pull request as ready for review September 1, 2024 12:57

reebayroo commented Sep 3, 2024

View reviewed changes

cli2/dependencies.ts

import { Readable } from "stream";

import { ResultAsync } from "neverthrow";

Copy link

Contributor Author

reebayroo Sep 3, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Organizing imports

reebayroo commented Sep 3, 2024

View reviewed changes

cli2/dependencies.ts

url?: URL,

}

Copy link

Contributor Author

reebayroo Sep 3, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Used by LocalFile to keep track of the different forms of a path

reebayroo commented Sep 3, 2024

View reviewed changes

reebayroo added 3 commits September 3, 2024 10:05

clean up

f7bb69c

Unit tests for DataURL

4f00dc3

clean up text description

e42969d

DamianReeves approved these changes Sep 3, 2024

View reviewed changes

DamianReeves merged commit b7c43d6 into finos:main Sep 3, 2024
1 check passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Dependency fix on typescript CLI #1180

Dependency fix on typescript CLI #1180

reebayroo commented Aug 28, 2024 •

edited

Loading

reebayroo Aug 29, 2024

reebayroo Aug 29, 2024

reebayroo Aug 29, 2024

reebayroo Aug 29, 2024

reebayroo Aug 29, 2024

reebayroo Sep 3, 2024

reebayroo Sep 3, 2024

reebayroo Sep 3, 2024

reebayroo Sep 3, 2024

reebayroo Sep 3, 2024

reebayroo Sep 3, 2024

reebayroo Sep 3, 2024

DamianReeves left a comment

		import { Readable } from "stream";
		import { ResultAsync } from "neverthrow";

Dependency fix on typescript CLI #1180

Dependency fix on typescript CLI #1180

Conversation

reebayroo commented Aug 28, 2024 • edited Loading

Terms

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

DamianReeves left a comment

Choose a reason for hiding this comment

reebayroo commented Aug 28, 2024 •

edited

Loading