sparse checkout feature - Load the package after downloading the entire repository #452

officialasishkumar · 2024-08-14T14:17:01Z

1. Does this PR affect any open issues?(Y/N) and add issue references (e.g. "fix #123", "re #123".):

N
Y

2. What is the scope of this PR (e.g. component or file name):

3. Provide a description of the PR(e.g. more details, effects, motivations or doc link):

4. Are there any breaking changes?(Y/N) and describe the breaking changes(e.g. more details, motivations or doc link):

N
Y

5. Are there test cases for these changes?(Y/N) select and add more details, references or doc links:

Signed-off-by: Asish Kumar <[email protected]>

officialasishkumar · 2024-08-14T14:17:13Z

PTAL @zong-zhe @Peefy

Peefy · 2024-08-14T14:18:30Z

cc @zong-zhe Could you help review it?

officialasishkumar · 2024-08-14T14:36:12Z

By mistake i defined the package in https://github.com/kcl-lang/kcl-go/blob/1460c5ca64b0d9ef3c10d7a7b1dcc7f98991bd87/pkg/kcl/opt.go#L15 and it worked locally. I didn't realised that and pushed it. I was wondering do i have to make changes to that repo too?

There is another option to pass package here https://github.com/kcl-lang/kcl-go/blob/1460c5ca64b0d9ef3c10d7a7b1dcc7f98991bd87/pkg/spec/gpyrpc/gpyrpc.pb.go#L1497

lmk which sounds good

cc: @Peefy @zong-zhe

zong-zhe · 2024-08-15T02:39:21Z

By mistake i defined the package in https://github.com/kcl-lang/kcl-go/blob/1460c5ca64b0d9ef3c10d7a7b1dcc7f98991bd87/pkg/kcl/opt.go#L15 and it worked locally. I didn't realised that and pushed it. I was wondering do i have to make changes to that repo too?

There is another option to pass package here https://github.com/kcl-lang/kcl-go/blob/1460c5ca64b0d9ef3c10d7a7b1dcc7f98991bd87/pkg/spec/gpyrpc/gpyrpc.pb.go#L1497

lmk which sounds good

cc: @Peefy @zong-zhe

Hi @officialasishkumar 😄

At present, define the package field in the kpm project because the current definition of KCL-GO is the go-sdk of KCL language; from the language side, the compiler can not understand the concept of package; all package-related content should be managed by kpm. Although they all work well, having a clear division of responsibility for each project is more helpful.

Signed-off-by: Asish Kumar <[email protected]>

officialasishkumar · 2024-08-15T18:35:21Z

Hi @zong-zhe ,

Thanks for the response. I have changed the code accordingly. Please have a look : )

coveralls · 2024-08-15T18:37:15Z

Pull Request Test Coverage Report for Build 10433442117

Details

1 of 53 (1.89%) changed or added relevant lines in 3 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage decreased (-0.3%) to 40.105%

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
pkg/client/client.go	1	9	11.11%
pkg/cmd/cmd_run.go	0	8	0.0%
pkg/utils/utils.go	0	36	0.0%

Totals
Change from base Build 10383495256:	-0.3%
Covered Lines:	3129
Relevant Lines:	7802

💛 - Coveralls

pkg/utils/utils.go

Signed-off-by: Asish Kumar <[email protected]>

Peefy · 2024-08-17T15:28:48Z

pkg/utils/utils.go

+	}
+
+	var modFile ModFile
+	_, err := toml.DecodeFile(kclModPath, &modFile)


Why not use the loadpackage function?

Where is it? Can you share the link of the code or the docs?

Peefy · 2024-08-17T15:29:11Z

pkg/utils/utils.go

@@ -599,3 +600,48 @@ func AbsTarPath(tarPath string) (string, error) {

 	return absTarPath, nil
 }
+
+func FindPackage(root, targetPackage string) (string, error) {


Could you please add more documents and unit tests?

Peefy · 2024-08-17T15:29:27Z

pkg/utils/utils.go

+			return err
+		}
+		if info.IsDir() {
+			kclModPath := filepath.Join(path, "kcl.mod")


Use the kcl.mod constant defined in the repo.

Peefy · 2024-08-17T15:32:12Z

cc @zong-zhe Could you help review it?

@officialasishkumar I am not sure if this PR can meet all the requirements of LFX, but you should at least provide complete PR information for the functionality according to your changed code. Therefore, I only left some comments on the content of this PR.

However, I believe that there is still a lot of work to be done to complete the entire topic and enable users to add Git dependent submodules using kcl mod add.

Peefy · 2024-08-17T15:33:55Z

#335

Additionally, the PR for this plan has been four months and it has still not been merged... cc @Zongzhe @officialasishkumar

officialasishkumar · 2024-08-17T15:36:44Z

Thanks for the review. Will look into it!

I am not sure if this PR can meet all the requirements of LFX,

Could you please clarify all the requirements so that I can start working on it?

cc: @Peefy @zong-zhe

Signed-off-by: Asish Kumar <[email protected]>

Peefy · 2024-08-17T15:46:28Z

@officialasishkumar

The two most important things:

The design document is correct and merged
Develop corresponding features and tests, merge this PR, users can use kcl mod add <sub_package> --git foo or set sub package in the kcl.mod file to add sub modules for a git dependency.

The problem I currently see is that your design doc and code do not match, and I believe you should first design the correct solution.

cc @zong-zhe

officialasishkumar · 2024-08-17T15:48:52Z

@Peefy

The implementation of my design docs was in #387

Peefy · 2024-08-17T15:56:11Z

@Peefy

The implementation of my design docs was in #387

Can you provide detailed information on the association between PR and Issue? Why is it confusing that all your PR titles are the same?

officialasishkumar · 2024-08-17T16:03:28Z

Sure thing, I have updated the title.

kcl mod add <sub_package> --git foo

Since the idea was changed that is to download the entire repo, I asked in slack whether to use package command in add or run. I found run to be more suitable since the repo is download entirely and the user can change it whenever they want while running their program. So, I implemented it the same way.

Peefy · 2024-08-17T16:04:48Z

I think you should update design in this PR #335 and merge it firstly. I don't think user interfaces are right in this doc.

officialasishkumar · 2024-08-17T16:15:18Z

@Peefy
Okay, So which idea should I write down in the design doc?

kcl mod run --package test

or

kcl mod add --git <git-url> --commit <commit-hash> --package test

Will also put the package name in kcl.mod file.

I will update the code accordingly.

Peefy · 2024-08-20T07:25:10Z

#453 is merged. Do we still need to keep this PR? @officialasishkumar

officialasishkumar · 2024-08-20T07:42:41Z

No @Peefy

sparse checkout feature

32ddefb

Signed-off-by: Asish Kumar <[email protected]>

define subpackage internally

88ba144

Signed-off-by: Asish Kumar <[email protected]>

zong-zhe reviewed Aug 16, 2024

View reviewed changes

pkg/utils/utils.go Outdated Show resolved Hide resolved

search for package name inside kcl.mod file

aaa4610

Signed-off-by: Asish Kumar <[email protected]>

Peefy reviewed Aug 17, 2024

View reviewed changes

add comments on functions and use constant variables

f4bb91a

Signed-off-by: Asish Kumar <[email protected]>

officialasishkumar changed the title ~~sparse checkout feature~~ sparse checkout feature - Load the package after downloading the entire repository Aug 17, 2024

Peefy closed this Aug 22, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

sparse checkout feature - Load the package after downloading the entire repository #452

sparse checkout feature - Load the package after downloading the entire repository #452

officialasishkumar commented Aug 14, 2024

officialasishkumar commented Aug 14, 2024

Peefy commented Aug 14, 2024

officialasishkumar commented Aug 14, 2024 •

edited

Loading

zong-zhe commented Aug 15, 2024

officialasishkumar commented Aug 15, 2024

coveralls commented Aug 15, 2024 •

edited

Loading

Peefy Aug 17, 2024

officialasishkumar Aug 17, 2024

Peefy Aug 17, 2024

Peefy Aug 17, 2024

officialasishkumar Aug 17, 2024

Peefy commented Aug 17, 2024

Peefy commented Aug 17, 2024

officialasishkumar commented Aug 17, 2024 •

edited

Loading

Peefy commented Aug 17, 2024

officialasishkumar commented Aug 17, 2024

Peefy commented Aug 17, 2024

officialasishkumar commented Aug 17, 2024

Peefy commented Aug 17, 2024 •

edited

Loading

officialasishkumar commented Aug 17, 2024 •

edited

Loading

Peefy commented Aug 20, 2024

officialasishkumar commented Aug 20, 2024

sparse checkout feature - Load the package after downloading the entire repository #452

sparse checkout feature - Load the package after downloading the entire repository #452

Conversation

officialasishkumar commented Aug 14, 2024

1. Does this PR affect any open issues?(Y/N) and add issue references (e.g. "fix #123", "re #123".):

2. What is the scope of this PR (e.g. component or file name):

3. Provide a description of the PR(e.g. more details, effects, motivations or doc link):

4. Are there any breaking changes?(Y/N) and describe the breaking changes(e.g. more details, motivations or doc link):

5. Are there test cases for these changes?(Y/N) select and add more details, references or doc links:

officialasishkumar commented Aug 14, 2024

Peefy commented Aug 14, 2024

officialasishkumar commented Aug 14, 2024 • edited Loading

zong-zhe commented Aug 15, 2024

officialasishkumar commented Aug 15, 2024

coveralls commented Aug 15, 2024 • edited Loading

Pull Request Test Coverage Report for Build 10433442117

Details

💛 - Coveralls

Peefy Aug 17, 2024

Choose a reason for hiding this comment

officialasishkumar Aug 17, 2024

Choose a reason for hiding this comment

Peefy Aug 17, 2024

Choose a reason for hiding this comment

Peefy Aug 17, 2024

Choose a reason for hiding this comment

officialasishkumar Aug 17, 2024

Choose a reason for hiding this comment

Peefy commented Aug 17, 2024

Peefy commented Aug 17, 2024

officialasishkumar commented Aug 17, 2024 • edited Loading

Peefy commented Aug 17, 2024

officialasishkumar commented Aug 17, 2024

Peefy commented Aug 17, 2024

officialasishkumar commented Aug 17, 2024

Peefy commented Aug 17, 2024 • edited Loading

officialasishkumar commented Aug 17, 2024 • edited Loading

Peefy commented Aug 20, 2024

officialasishkumar commented Aug 20, 2024

officialasishkumar commented Aug 14, 2024 •

edited

Loading

coveralls commented Aug 15, 2024 •

edited

Loading

officialasishkumar commented Aug 17, 2024 •

edited

Loading

Peefy commented Aug 17, 2024 •

edited

Loading

officialasishkumar commented Aug 17, 2024 •

edited

Loading