IllegalStateException due to unavailable lock files

[soul2zimate]

What happened?

IntelliJ IDEA error occurred from JavaScriptProviderFactory due to unavailable lock files

Please provide runtime information.

See this IllegalStateException for JS project analysis.

java.lang.IllegalStateException: No known lock file found for /var/folders/jw/xs558bkj7sd7rylcmmdxhfxm0000gn/T/rhda-idea7828926534968074069/package.json. Supported lock files: 
	at com.redhat.exhort.providers.JavaScriptProviderFactory.create(JavaScriptProviderFactory.java:42)
	at com.redhat.exhort.tools.Ecosystem.resolveProvider(Ecosystem.java:92)
	at com.redhat.exhort.tools.Ecosystem.getProvider(Ecosystem.java:81)
	at com.redhat.exhort.impl.ExhortApi.componentAnalysis(ExhortApi.java:457)
	at org.jboss.tools.intellij.exhort.ApiService.getComponentAnalysis(ApiService.java:97)
	at org.jboss.tools.intellij.componentanalysis.CAService.performAnalysis(CAService.java:88)
	at org.jboss.tools.intellij.componentanalysis.CAAnnotator.lambda$doAnnotate$1(CAAnnotator.java:64)
	at com.intellij.openapi.application.impl.ApplicationImpl$2.run(ApplicationImpl.java:265)
	at java.base/java.util.concurrent.Executors$RunnableAdapter.call(Executors.java:572)
	at com.intellij.util.concurrency.ContextCallable.lambda$call$1(ContextCallable.java:86)
	at com.intellij.util.concurrency.ContextCallable.call(ContextCallable.java:95)
	at java.base/java.util.concurrent.FutureTask.run(FutureTask.java:317)
	at com.intellij.util.concurrency.ChildContext$runInChildContext$1.invoke(propagation.kt:102)
	at com.intellij.util.concurrency.ChildContext$runInChildContext$1.invoke(propagation.kt:102)
	at com.intellij.util.concurrency.ChildContext.runInChildContext(propagation.kt:108)
	at com.intellij.util.concurrency.ChildContext.runInChildContext(propagation.kt:102)
	at com.intellij.util.concurrency.ContextRunnable.run(ContextRunnable.java:27)
	at java.base/java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1144)
	at java.base/java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:642)
	at java.base/java.util.concurrent.Executors$PrivilegedThreadFactory$1$1.run(Executors.java:735)
	at java.base/java.util.concurrent.Executors$PrivilegedThreadFactory$1$1.run(Executors.java:732)
	at java.base/java.security.AccessController.doPrivileged(AccessController.java:400)
	at java.base/java.util.concurrent.Executors$PrivilegedThreadFactory$1.run(Executors.java:732)
	at java.base/java.lang.Thread.run(Thread.java:1583)

Relevant log output

How can this issue be reproduced?

No response

[soul2zimate]

@ruromero any thought how should we handle this ?

[ruromero]

We should handle the error and tell the user to generate the lock file. Lock files are a requirement because we can't generate them anymore. It depends on the package manager they're using (npm, pnpm, yarn, etc.)

[soul2zimate]

I agree a more user friendly warning is needed, but the strange thing is IntelliJ checks against this file java.lang.IllegalStateException: No known lock file found for /var/folders/jw/xs558bkj7sd7rylcmmdxhfxm0000gn/T/rhda-idea7828926534968074069/package.json. It's not from users source directory.(actually, inside user source folder, the lock file exists)

[ruromero]

it is copied to a temporary folder, maybe this is not needed either. I think the JS version of the SDK doesn't copy the files anymore.

[soul2zimate]

The tmp file is a solution made in redhat-developer/intellij-dependency-analytics#161 for https://issues.redhat.com/browse/TC-1631

IMHO, we can also copy the lock file too into the tmp folder, it seems harmless to me. e.g. redhat-developer/intellij-dependency-analytics#185

[ruromero]

Will the lockfiles be in sync with the package.json file? Can you investigate what's better? a) make sure the file is in sync in disk or b) copy the lock file

[soul2zimate]

What could be the scenario to get an async lock file during the analysis?

Can you investigate what's better? a) make sure the file is in sync in disk or b) copy the lock file

sorry, I don't follow you on this. What's the better between a and b ?

[ruromero]

that's what I need you to check. I don't know the answer

[soul2zimate]

@ruromero May I ask why the lockfile synchronization matters here? AFAIU, the plugin just analyzes upon the package.json file. It doesn't care about the lock file content.

EDIT!: Actually, the Plugin itself only cares package.json file and sends it to exhort-java-api to create package lock file at lines https://github.com/trustification/exhort-java-api/blob/main/src/main/java/com/redhat/exhort/providers/JavaScriptProvider.java#L225-L227

For instance, command for NPM npm i --package-lock-only --prefix /private/var/folders/jw/xs558bkj7sd7rylcmmdxhfxm0000gn/T/rhda-idea1413382511526502117

So the lock file copied from the project source folder into the tmp folder will be overrode by the new created lock from above command.

[ruromero]

I would like to follow the same behaviour than for the JS API. There the npm ls command is executed on the same folder, no temp folders are created. The lock file should not be generated if it doesn't exist. The lock file sync matters for the stack analysis only.