added npm install

Author: fluxxBot

artifactory/commands/npm/common.go

@@ -10,6 +10,7 @@ type CommonArgs struct {
 	buildConfiguration *build.BuildConfiguration
 	npmArgs            []string
 	serverDetails      *config.ServerDetails
+	useNative          bool
 }
 
 func (ca *CommonArgs) SetServerDetails(serverDetails *config.ServerDetails) *CommonArgs {
@@ -31,3 +32,12 @@ func (ca *CommonArgs) SetRepo(repo string) *CommonArgs {
 	ca.repo = repo
 	return ca
 }
+
+func (ca *CommonArgs) UseNative() bool {
+	return ca.useNative
+}
+
+func (ca *CommonArgs) setUseNative(useNpmRc bool) *CommonArgs {
+	ca.useNative = useNpmRc
+	return ca
+}

artifactory/commands/npm/installHandler.go

@@ -0,0 +1,17 @@
+package npm
+
+type Installer interface {
+	PrepareInstallPrerequisites(repo string) error
+	Run() error
+	RestoreNpmrcFunc() error
+}
+
+// Get npm implementation
+func NpmInstallStrategy(shouldUseNpmRc bool, npmCommand *NpmCommand) Installer {
+
+	if shouldUseNpmRc {
+		return &npmInstall{npmCommand}
+	}
+
+	return &npmRtInstall{npmCommand}
+}

artifactory/commands/npm/npmInstallHandler.go

@@ -0,0 +1,25 @@
+package npm
+
+import "github.com/jfrog/jfrog-client-go/utils/log"
+
+type npmInstall struct {
+	*NpmCommand
+}
+
+func (ni *npmInstall) PrepareInstallPrerequisites(repo string) error {
+	log.Debug("Skip Preparing NPM installation for npm command, repo: ", repo)
+	return nil
+}
+
+func (ni *npmInstall) Run() (err error) {
+	if err = ni.prepareBuildInfoModule(); err != nil {
+		return
+	}
+	err = ni.collectDependencies()
+	return
+}
+
+func (ni *npmInstall) RestoreNpmrcFunc() error {
+	// No need to restore the npmrc file, since we are using user's npmrc
+	return nil
+}

artifactory/commands/npm/npmPublishHandler.go

@@ -17,13 +17,12 @@ type npmPublish struct {
 	*NpmPublishCommand
 }
 
-func (npu *npmPublish) upload() error {
+func (npu *npmPublish) upload() (err error) {
 	for _, packedFilePath := range npu.packedFilePaths {
-
+		log.Debug("Deploying npm package using npm upload.")
 		if err := npu.readPackageInfoFromTarball(packedFilePath); err != nil {
 			return err
 		}
-
 		repoConfig, err := npu.getRepoConfig()
 		if err != nil {
 			return err
@@ -47,7 +46,7 @@ func (npu *npmPublish) upload() error {
 }
 
 func (npu *npmPublish) getBuildArtifacts() ([]buildinfo.Artifact, error) {
-	return specutils.ConvertArtifactsSearchDetailsToBuildInfoArtifacts(npu.artifactsDetailsReader)
+	return utils.ConvertArtifactsSearchDetailsToBuildInfoArtifacts(npu.artifactsDetailsReader)
 }
 
 func (npu *npmPublish) publishPackage(executablePath, filePath string, serverDetails *config.ServerDetails, target string) error {

artifactory/commands/npm/npmcommand.go

@@ -55,6 +55,7 @@ type NpmCommand struct {
 	configFilePath      string
 	collectBuildInfo    bool
 	buildInfoModule     *build.NpmModule
+	installHandler      Installer
 }
 
 func NewNpmCommand(cmdName string, collectBuildInfo bool) *NpmCommand {
@@ -119,7 +120,12 @@ func (nc *NpmCommand) Init() error {
 	if err != nil {
 		return err
 	}
-	nc.SetRepoConfig(repoConfig).SetArgs(filteredNpmArgs).SetBuildConfiguration(buildConfiguration)
+	_, useNative, err := coreutils.ExtractUseNativeFromArgs(nc.npmArgs)
+	if err != nil {
+		return err
+	}
+	nc.SetRepoConfig(repoConfig).SetArgs(filteredNpmArgs).SetBuildConfiguration(buildConfiguration).setUseNative(useNative)
+	nc.installHandler = NpmInstallStrategy(nc.UseNative(), nc)
 	return nil
 }
 
@@ -168,15 +174,7 @@ func (nc *NpmCommand) PreparePrerequisites(repo string) error {
 		return err
 	}
 	log.Debug("Working directory set to:", nc.workingDirectory)
-	if err = nc.setArtifactoryAuth(); err != nil {
-		return err
-	}
-
-	if err = nc.setNpmAuthRegistry(repo); err != nil {
-		return err
-	}
-
-	return nc.setRestoreNpmrcFunc()
+	return nc.installHandler.PrepareInstallPrerequisites(repo)
 }
 
 func (nc *NpmCommand) setNpmAuthRegistry(repo string) (err error) {
@@ -309,17 +307,9 @@ func (nc *NpmCommand) Run() (err error) {
 		return
 	}
 	defer func() {
-		err = errors.Join(err, nc.restoreNpmrcFunc())
+		err = errors.Join(err, nc.installHandler.RestoreNpmrcFunc())
 	}()
-	if err = nc.CreateTempNpmrc(); err != nil {
-		return
-	}
-
-	if err = nc.prepareBuildInfoModule(); err != nil {
-		return
-	}
-
-	err = nc.collectDependencies()
+	err = nc.installHandler.Run()
 	return
 }
 

artifactory/commands/npm/publish.go

@@ -45,7 +45,6 @@ type NpmPublishCommandArgs struct {
 	xrayScan               bool
 	scanOutputFormat       format.OutputFormat
 	distTag                string
-	useNpmRc               bool
 }
 
 type NpmPublishCommand struct {
@@ -107,15 +106,6 @@ func (npc *NpmPublishCommand) Result() *commandsutils.Result {
 	return npc.result
 }
 
-func (nru *NpmPublishCommand) ShouldUseNpmRc() bool {
-	return nru.useNpmRc
-}
-
-func (npc *NpmPublishCommand) setUseNpmRc(useNpmRc bool) *NpmPublishCommand {
-	npc.useNpmRc = useNpmRc
-	return npc
-}
-
 func (npc *NpmPublishCommand) IsDetailedSummary() bool {
 	return npc.detailedSummary
 }
@@ -130,7 +120,7 @@ func (npc *NpmPublishCommand) Init() error {
 	if err != nil {
 		return err
 	}
-	filteredNpmArgs, useNpmRc, err := commandsutils.ExtractNpmConfigType(filteredNpmArgs)
+	filteredNpmArgs, useNative, err := coreutils.ExtractUseNativeFromArgs(filteredNpmArgs)
 	if err != nil {
 		return err
 	}
@@ -155,7 +145,7 @@ func (npc *NpmPublishCommand) Init() error {
 		}
 		npc.SetBuildConfiguration(buildConfiguration).SetRepo(deployerParams.TargetRepo()).SetNpmArgs(filteredNpmArgs).SetServerDetails(rtDetails)
 	}
-	npc.SetDetailedSummary(detailedSummary).SetXrayScan(xrayScan).SetScanOutputFormat(scanOutputFormat).SetDistTag(tag).setUseNpmRc(useNpmRc)
+	npc.SetDetailedSummary(detailedSummary).SetXrayScan(xrayScan).SetScanOutputFormat(scanOutputFormat).SetDistTag(tag).setUseNative(useNative)
 	return nil
 }
 
@@ -191,7 +181,7 @@ func (npc *NpmPublishCommand) Run() (err error) {
 		}
 	}
 
-	publishStrategy := NpmPublishStrategy(npc.ShouldUseNpmRc(), npc)
+	publishStrategy := NpmPublishStrategy(npc.UseNative(), npc)
 
 	err = publishStrategy.upload()
 	if err != nil {

artifactory/commands/npm/publishHandler.go

@@ -8,13 +8,13 @@ import (
 	"github.com/jfrog/jfrog-cli-core/v2/utils/config"
 )
 
-type Publish interface {
+type Publisher interface {
 	upload() error
 	getBuildArtifacts() ([]buildinfo.Artifact, error)
 }
 
 // Get npm implementation
-func NpmPublishStrategy(shouldUseNpmRc bool, npmPublishCommand *NpmPublishCommand) Publish {
+func NpmPublishStrategy(shouldUseNpmRc bool, npmPublishCommand *NpmPublishCommand) Publisher {
 
 	if shouldUseNpmRc {
 		return &npmPublish{npmPublishCommand}

artifactory/commands/npm/rtInstallHandler.go

@@ -0,0 +1,39 @@
+package npm
+
+import "github.com/jfrog/jfrog-client-go/utils/log"
+
+type npmRtInstall struct {
+	*NpmCommand
+}
+
+func (nri *npmRtInstall) PrepareInstallPrerequisites(repo string) (err error) {
+	log.Debug("Preparing NPM installation for npm rt command, repo: ", repo)
+	if err = nri.setArtifactoryAuth(); err != nil {
+		return err
+	}
+
+	if err = nri.setNpmAuthRegistry(repo); err != nil {
+		return err
+	}
+
+	return nri.setRestoreNpmrcFunc()
+}
+
+func (nri *npmRtInstall) Run() (err error) {
+	if err = nri.CreateTempNpmrc(); err != nil {
+		return
+	}
+	if err = nri.prepareBuildInfoModule(); err != nil {
+		return
+	}
+	err = nri.collectDependencies()
+	return
+}
+
+func (nri *npmRtInstall) RestoreNpmrcFunc() (err error) {
+	// Restore the npmrc file, since we are using our own npmrc
+	if err = nri.restoreNpmrcFunc(); err != nil {
+		return err
+	}
+	return
+}

artifactory/commands/npm/rtPublishHandler.go

@@ -20,7 +20,7 @@ type npmRtUpload struct {
 
 func (nru *npmRtUpload) upload() (err error) {
 	for _, packedFilePath := range nru.packedFilePaths {
-		log.Debug("Deploying npm package.")
+		log.Debug("Deploying npm package using rt upload.")
 		if err = nru.readPackageInfoFromTarball(packedFilePath); err != nil {
 			return
 		}

cliutils/flagkit/flags.go

@@ -341,6 +341,7 @@ const (
 	// Unique npm flags
 	npmPrefix          = "npm-"
 	npmDetailedSummary = npmPrefix + detailedSummary
+	clientNative       = "client-native"
 
 	// Unique nuget/dotnet config flags
 	nugetV2                  = "nuget-v2"
@@ -656,10 +657,10 @@ var commandFlags = map[string][]string{
 		global, serverIdResolve, serverIdDeploy, repoResolve, repoDeploy,
 	},
 	NpmInstallCi: {
-		BuildName, BuildNumber, module, Project,
+		BuildName, BuildNumber, module, Project, clientNative,
 	},
 	NpmPublish: {
-		BuildName, BuildNumber, module, Project, npmDetailedSummary, xrayScan, xrOutput,
+		BuildName, BuildNumber, module, Project, npmDetailedSummary, xrayScan, xrOutput, clientNative,
 	},
 	PnpmConfig: {
 		global, serverIdResolve, repoResolve,
@@ -800,6 +801,7 @@ var flagsMap = map[string]components.Flag{
 	bundle:            components.NewStringFlag(bundle, "[Optional] If specified, only artifacts of the specified bundle are matched. The value format is bundle-name/bundle-version.", components.SetMandatoryFalse()),
 	imageFile:         components.NewStringFlag(imageFile, "[Mandatory] Path to a file which includes one line in the following format: <IMAGE-TAG>@sha256:<MANIFEST-SHA256>.", components.SetMandatoryTrue()),
 	ocStartBuildRepo:  components.NewStringFlag(repo, "[Mandatory] The name of the repository to which the image was pushed.", components.SetMandatoryTrue()),
+	clientNative:      components.NewBoolFlag(clientNative, "[Default: false] Set to true if you'd like to use the native client configurations. Note: This flag would invoke native client behind the scenes, has performance implications and does not support deployment view and detailed summary.", components.WithBoolDefaultValueFalse()),
 
 	// Config specific commands flags
 	interactive:       components.NewBoolFlag(interactive, "[Default: true, unless $CI is true] Set to false if you do not want the config command to be interactive. If true, the --url option becomes optional.", components.WithBoolDefaultValueFalse()),