500, adding entry point to inspect command #528

ErnestMatskevich · 2025-05-22T23:14:26Z

Renamed branch to #500 for tracking issue
Added test for Inspect.java file

Added: qulice plugin in pom.xml test_inspect.js file with unit test For testing installed in dev dependencies: sinon proxyquire

add stronger signatire for main() in Inspect.java add test for Inspect.java

ErnestMatskevich · 2025-05-22T23:45:35Z

I added simple test for Inspect.java file, but when run qulice I faced with tha same warnings as in previous PR:

[WARNING] Unused declared dependencies found:
org.eolang:eo-runtime:jar:0.56.2:compile
org.junit.jupiter:junit-jupiter-api:jar:5.12.2:compile
org.junit.jupiter:junit-jupiter-engine:jar:5.12.2:compile
org.takes:takes:jar:1.24.6:compile

Also I would like to clarify how to build inspect.jar with Maven. Since currently there is single pom.xml file, Maven makes eoc.jar file as it writen in its . For complete my task I need to create my own file inspect.jar. I would like to use <execution> in pom.xml to separate creating eoc.jar and my inspect.jar. Is it correct idea? I think that after separate creating inspect.jar there will be no more warning about unused dependencies, because qulice will be placed in <execution> of inspect part and will not see junit and eo-runtime dependecies. @yegor256 What do you think about use in pom.xml?

There is 1 falling check in eslint workflow Is it on my side? If it is how can I fix that?

yegor256 · 2025-05-23T07:42:13Z

@ErnestMatskevich I fixed eslint, please merge master into your branch

yegor256 · 2025-05-23T07:45:53Z

@ErnestMatskevich show what you are trying to do and show the error (in CI logs). We'll be able to provide help.

ErnestMatskevich · 2025-05-24T14:47:45Z

@yegor256 I merged master, now all cheks pass. I will try to edit pom.xml and show if any errors occurs in CI

Added profile section for creating independing inspect.jar file. Placed Takes and qulice inside profile

ErnestMatskevich · 2025-05-24T21:28:30Z

@yegor256 I made profile in pom.xml for creating inspect.jar, all cheks passed. Please, take a look, is it good solution?

I have some questions:

Should I create fat-jar (with takes dependency in inspect.jar)?
Why org.junit.jupiter:junit-jupiter-api and org.junit.jupiter:junit-jupiter-engine have scope compile? As I know they are need for testing

ErnestMatskevich · 2025-05-27T17:01:44Z

@yegor256 please take a look at my last commit in this PR. If there is no problem, let's merge? or close this PR and I will continue open new PR's with adding other functionality of inspect command. Moreover, I still interesing in questions wrote upper. Could you please clarify for me details about fat jar and scope of junit.

yegor256 · 2025-05-28T03:26:44Z

@ErnestMatskevich it's better to ask questions as separate tickets, see: https://www.yegor256.com/2025/05/25/bug-driven-development.html

yegor256 · 2025-05-28T03:28:15Z

@volodya-lombrozo can you please check this design?

volodya-lombrozo

@ErnestMatskevich

Thank you for the contribution! I have a few important notes related to the PR itself. Highly recommend reading "Helping others review your changes". Pay attention to the Write small pull requests and the Provide context and guidance sections. Could you also please make the title of this PR a bit more meaningful, rather than just "500", please?

volodya-lombrozo

@yegor256

`inspect` -> `debug`

As I understand it, you want to write a debugger. Why not call it eoc debug then? Why should we hide this information under the misleading inspect command?

Separate Project

Why do we need to implement the entire debugger in the eoc repository? Maybe it's better to move it to a separate repo, as other projects do?
Here, we can just leave a thin eoc debug command just to invoke this debugger.
Moreover, eoc is written in JS. Adding Java would create a some sort of mess.

What do you think?

yegor256 · 2025-05-28T14:18:00Z

@volodya-lombrozo how would you call a tool that allows you go into a working Java virtual machine, find any object and see its details? Would it be a debugger?

Indeed, this tool deserves a separate project/repository, but maybe a bit later, when its first version is ready. So far, it's an early draft.

volodya-lombrozo · 2025-05-28T14:30:49Z

@volodya-lombrozo how would you call a tool that allows you go into a working Java virtual machine, find any object and see its details? Would it be a debugger?

Yes, it's what debuggers allow me to do - to "inspect" runtime.

ErnestMatskevich · 2025-05-28T20:20:48Z

@volodya-lombrozo Thank you for your review feedback. I've made the following improvements:

Updated PR title to clearly state the functionality.
Will follow up with smaller, focused PRs containing detailed descriptions

For the current changes in pom.xml added Maven profile section to build self-contained inspect.jar.

inspect command can be run with help

node src/eoc.js inspect

or it is possible just build inspect.jar with help Maven and use -Pinspect for indepening package/compile.

Could you please review this profile configuration approach.

volodya-lombrozo · 2025-05-29T05:45:35Z

mvnw/src/test/java/org/eolang/InspectSmokeTest.java

+        server.start();
+        Thread.sleep(2000L);
+        server.interrupt();
+        server.join(1000L);


@ErnestMatskevich Could you add clear assert statements, please? Here is a good paragraph how you can do it.

volodya-lombrozo · 2025-05-29T06:00:58Z

mvnw/pom.xml

  <build>
    <finalName>eoc</finalName>
    <sourceDirectory>${eo.generatedDir}</sourceDirectory>
+    <resources>


@ErnestMatskevich Why do we need to add this directory to the resources?

volodya-lombrozo · 2025-05-29T06:03:35Z

mvnw/pom.xml

+        <finalName>inspect</finalName>
+        <plugins>
+          <plugin>
+            <groupId>com.qulice</groupId>


@ErnestMatskevich Why do we need to add qulice in this PR? It's a good tool, but it should be added in a dedicated PR.

volodya-lombrozo · 2025-05-29T06:09:20Z

src/commands/inspect.js

+module.exports = function(opts) {
+  return new Promise((resolve, reject) => {
+    const mvnDir = path.join(process.cwd(), 'mvnw');
+    console.info('Building EO inspect server with Maven...');


@ErnestMatskevich @yegor256 Do we really need to build a java server each time we execute the eoc inspect command? It's suboptimal. Moreover, it requires Maven to be installed on the machine. And I haven't even mentioned the execution time yet.

@volodya-lombrozo @ErnestMatskevich indeed, it's better to build it once, when we package eoc. Then, simply run it.

volodya-lombrozo · 2025-05-29T06:19:11Z

test/commands/test_inspect.js

+const proxyquire = require('proxyquire');
+describe('inspect command (mocked)', () => {
+  it('should send text and receive echoed response, then exit cleanly', async () => {
+    const mockStdout = new stream.PassThrough();


@ErnestMatskevich Can we simplify these variable names somehow? A Compound Name Is a Code Smell

Added asserts in InspectSmokeTest.java and changed Inspect.java to handle interrupt

Delete qulice plugin and redundant resources section in pom.xml

Delete unused import Remove redundant variable body Simplified FkRegex with lambda

ErnestMatskevich · 2025-05-30T22:33:08Z

@volodya-lombrozo I fixed feedback items from your review. I splitted them into 2 commits:

Fixed InspectTest.java at this commit

Renamed file to InspectTest.java
Wrote test with hamcrest
Rewrite from wait and see antipattern to adaptive waiting.

Updated Inspect.java at this commit

Deleted unused import org.takes.http.Exit since now server could be interrupt
Simplify code with lambda. It looks clearly now and has same functionality
Removed redundant variable body

There is 1 check falling with building on windows, but macoc and ubuntu cheks passed. Is workflow falled because of my changes? The error in foreign part, but I did not edit it.

Could you please check my commits and help to fix build

Add maven assembly plugin which build inspect.jar Refactor inspect.js - no more build inspect.jar, just run it Refacror test_inspect.jar - no more testing maven part since it is not job of inspect command now

ErnestMatskevich · 2025-06-01T18:14:13Z

@yegor256 @volodya-lombrozo I changed eoc inspect command behaviour. Now command mvn clean package creates inspect.jar with server and takes dependency inside. inspect.js just load inspect.jar and does not build it every time. Done in commit

I wrote descriptor src/assembly/inspect.xml for maven-assembly-plugin which I use for build inspect.jar and excluded .class files with my code in maven-jar-plugin for eoc.jar.

I deleted Maven part from inspect.js since inspect.jar is building by mvn clean package and deleted checks for Maven in test_inspect.js

There are problems in workflow with build and itests:

Build fails

dataize at 0.56.2 version
dataize with command-line argument
dataization for older version is passed, but this 2 steps fails. Is problem on my side? I did not edit default building except adding exclusions for files with my code to avoid include them in eoc.jar

itests fails

Could't find object 'Φ.org.eolang.io'

Could you please take a look for my commit and help to fix build

volodya-lombrozo

@ErnestMatskevich There are significant improvements. Thanks! Just a few small comments.

As for filling build, I suggest creating a new issue for that.

volodya-lombrozo · 2025-06-04T08:03:12Z

mvnw/src/main/java/org/eolang/Inspect.java

+    /**
+     * Private constructor.
+     */
+    private Inspect() {


@ErnestMatskevich Great thanks for the explanation. Now it's clear.

volodya-lombrozo · 2025-06-04T08:09:57Z

mvnw/src/test/java/org/eolang/InspectTest.java

+            server.isAlive(),
+            is(true)
+        );
+


@ErnestMatskevich Can we remove empty lines, please? It's a code smell.

volodya-lombrozo · 2025-06-04T08:12:07Z

mvnw/src/test/java/org/eolang/InspectTest.java

+        }
+        assertThat(
+            "Server thread should be running after start",
+            server.isAlive(),


@ErnestMatskevich Here you just check the the thread is alive. It tells nothing about the server availability.
https://docs.oracle.com/javase/8/docs/api/java/lang/Thread.html#isAlive--

@volodya-lombrozo Yes, the purpose of this test now is just check that server is starting without any errors. The availability of server is cheking in test_inspect.js file.

@ErnestMatskevich How do you know there aren't errors? It may be that the server didn't actually start, but the thread is still alive.

volodya-lombrozo · 2025-06-04T08:16:20Z

mvnw/src/test/java/org/eolang/InspectTest.java

+                }
+            }
+        );
+        server.setDaemon(false);


@ErnestMatskevich Why do we need this? From https://stackoverflow.com/a/17878439/10423604:

Any thread created by main thread, which runs main method in Java is by default non daemon because Thread inherits its daemon nature from the Thread which creates it i.e. parent Thread and since main thread is a non daemon thread, any other thread created from it will remain non-daemon until explicitly made daemon by calling setDaemon(true).

Remove empty lines as it code smell Remove .setDaemon(false) as children thread is not daemon by default

ErnestMatskevich · 2025-06-04T14:01:35Z

@volodya-lombrozo Thank you for your detail reviewes! I committed last changes.

In InspectTest.java:

Deleted empty lines
Deleted server.SetDaemon(false)

I opened issue for failing workflow

Could you please check last commit and help to understand reason of failing.

Set src/main/java directly to sourceDirectory to show Maven right path to Java code. Instead add <source>${eo.generatedDir}</source> to org.codehaus.mojo for opportunity run the tests

ErnestMatskevich · 2025-06-22T22:08:10Z

Summary for commit

Updated PR to make it satisfactory with current branch and fixed some errors.

There is a bug in CI/CD: itest part and build

The problem is same for both steps and looks like:
Can not find "foo.bar.simple" object (java path is "EOfoo.EObar.EOsimple").

There are such files in generated-source folder, but they do not include in eoc.jar

Will try to solve it

Add new execution to place EOfoo package to classes and inside eoc.jar

Write cleaner exclude for ignoring only package-info.class for Java code of Inspector

ErnestMatskevich · 2025-06-23T01:12:49Z

Fixed all errors

Updated package-lock.json for includes node-fetch - commit
Set src/main/java in <sourceDirectory> of <build> section in pom.xml for help Maven to see Java code of Inspector and avoid errors with unrecognising Java code, when run other commands which set different directories in <sourceDirectory>. For takes all previous functionality of other part of eoc source code, in build-helper-maven-plugin from pom.xml was set original <source>${eo.generatedDir}</source>. - commit
The main problem was this line: <exclude>**/package-info.class</exclude> in pom.xml.
The ** part exclude all package-info.class in project, but should excludes specific package-info.class for Inspect part.
After refactoring line is: <exclude>org/eolang/package-info.class</exclude> and all checks are passed. - commit

@yegor256 Please, take a look

yegor256 · 2025-06-23T11:36:39Z

src/commands/inspect.js

+  return new Promise((resolve, reject) => {
+    const mvnDir = path.join(process.cwd(), 'mvnw');
+    const jar = path.join(mvnDir, 'target', 'inspect.jar');
+


@ErnestMatskevich check this out, please: https://www.yegor256.com/2014/11/03/empty-line-code-smell.html

My bad, fixed in commit

yegor256 · 2025-06-23T11:38:56Z

@ErnestMatskevich looks good! I'm not sure though, it's a good idea to keep source files in the mvnw/ directory. Maybe we can create a new top-level directory called, for example, inspect/ and place src/main/java/ into it?

yegor256 · 2025-06-23T11:39:05Z

@volodya-lombrozo please, take a look one more time

ErnestMatskevich · 2025-06-23T11:53:40Z

@ErnestMatskevich looks good! I'm not sure though, it's a good idea to keep source files in the mvnw/ directory. Maybe we can create a new top-level directory called, for example, inspect/ and place src/main/java/ into it?

@yegor256 I think while there is only Java code of inspect in project, no need to create new directory and leave Java files in standart Maven path (src/main/java). Moreover since you wrote that is is like a draft and should be placed in different repository in future, I think it is not a problem that for now files in mvnw.

yegor256 · 2025-06-23T13:12:09Z

@ErnestMatskevich we don't know for how long these files will stay with us. Once they are merged, they are with us (forever). It's better to place them correctly. The mvnw/ is not a "Maven folder". It's "Maven wrapper". The files you commit have nothing to do with the wrapper, right?

Extract source code files from mvnw and place them in inspect folder

ErnestMatskevich · 2025-06-23T16:35:22Z

@ErnestMatskevich we don't know for how long these files will stay with us. Once they are merged, they are with us (forever). It's better to place them correctly. The mvnw/ is not a "Maven folder". It's "Maven wrapper". The files you commit have nothing to do with the wrapper, right?

@yegor256 Done in this commit

Yes, I do not work with wrapper directly, i just build JAR file for server

ErnestMatskevich · 2025-06-24T14:10:35Z

@volodya-lombrozo Please take a look. I added small commits described below. Also this commit about creating new top-level folder inspect with source code.

Fixed all errors

Updated package-lock.json for includes node-fetch - commit

Set src/main/java in <sourceDirectory> of <build> section in pom.xml for help Maven to see Java code of Inspector and avoid errors with unrecognising Java code, when run other commands which set different directories in <sourceDirectory>. For takes all previous functionality of other part of eoc source code, in build-helper-maven-plugin from pom.xml was set original <source>${eo.generatedDir}</source>. - commit

The main problem was this line: <exclude>**/package-info.class</exclude> in pom.xml.
The ** part exclude all package-info.class in project, but should excludes specific package-info.class for Inspect part.
After refactoring line is: <exclude>org/eolang/package-info.class</exclude> and all checks are passed. - commit

@yegor256 Please, take a look

volodya-lombrozo · 2025-06-24T14:32:21Z

inspect/src/test/java/org/eolang/InspectTest.java

+ *
+ * @since 0.29.0
+ */
+final class InspectTest {


@ErnestMatskevich It seems, that this test checks nothing. Moreover, it's too error prone. Can we just remove it?

volodya-lombrozo · 2025-06-24T14:35:00Z

src/commands/inspect.js

+        }
+        console.log('Sending request with body:', input);
+        try {
+          const response = await fetch('http://localhost:8080/echo', {


@ErnestMatskevich What if I already have another application running on 8080 port? Please, don't fix it here. Just leave a puzzle

volodya-lombrozo · 2025-06-24T14:41:59Z

mvnw/pom.xml

  </build>
+  <profiles>
+    <profile>
+      <id>inspect</id>


@ErnestMatskevich I can't find the place in the code where you use this Maven profile. Can you give me a link, please?

@ErnestMatskevich What about this one?

Fix puzzle description

ErnestMatskevich · 2025-06-25T13:11:50Z

@volodya-lombrozo Please, take a look. All tasks done, all checks passed

ErnestMatskevich and others added 6 commits May 21, 2025 02:29

feat: add inspection server with akes framework

3b8b2b5

Update pom.xml

3641685

Add unit test and qulice

9cb76ee

Added: qulice plugin in pom.xml test_inspect.js file with unit test For testing installed in dev dependencies: sinon proxyquire

add license in package-info.java

a22a974

Merge branch 'objectionary:master' into 500

1cf9618

Add simple test for Inspect.java

f649742

add stronger signatire for main() in Inspect.java add test for Inspect.java

Merge branch 'master' into 500

642cbea

Add profile to creating inspect.jar file

dd74c55

Added profile section for creating independing inspect.jar file. Placed Takes and qulice inside profile

yegor256 requested a review from volodya-lombrozo May 28, 2025 03:28

volodya-lombrozo suggested changes May 28, 2025

View reviewed changes

ErnestMatskevich changed the title ~~500~~ 500, adding entry point to inspect commands May 28, 2025

ErnestMatskevich changed the title ~~500, adding entry point to inspect commands~~ 500, adding entry point to inspect command May 28, 2025

ErnestMatskevich added 2 commits May 28, 2025 21:18

Merge branch 'master' into 500

9097c93

fix: add missing comma in package.json

5e205ea

volodya-lombrozo suggested changes May 29, 2025

View reviewed changes

ErnestMatskevich and others added 3 commits May 30, 2025 00:40

Merge branch 'objectionary:master' into 500

934ca18

Added asserts to test

e9382b5

Added asserts in InspectSmokeTest.java and changed Inspect.java to handle interrupt

Update pom.xml

057fee3

Delete qulice plugin and redundant resources section in pom.xml

Update Inspect.java

969012b

Delete unused import Remove redundant variable body Simplified FkRegex with lambda

Build inspect.jar once with Maven package

3e593de

Add maven assembly plugin which build inspect.jar Refactor inspect.js - no more build inspect.jar, just run it Refacror test_inspect.jar - no more testing maven part since it is not job of inspect command now

volodya-lombrozo suggested changes Jun 4, 2025

View reviewed changes

Clean up InspectTest.java

9f5edf8

Remove empty lines as it code smell Remove .setDaemon(false) as children thread is not daemon by default

ErnestMatskevich mentioned this pull request Jun 4, 2025

Changes in inspect break dataize in v0.56.2: cannot find EOfoo/EOorg.eolang.io #534

Open

ErnestMatskevich and others added 3 commits June 22, 2025 20:48

Merge branch 'master' into 500

0a74e73

Update package-lock.json

b6fca8b

Update pom.xml

cb7bcfa

Set src/main/java directly to sourceDirectory to show Maven right path to Java code. Instead add <source>${eo.generatedDir}</source> to org.codehaus.mojo for opportunity run the tests

ErnestMatskevich added 2 commits June 23, 2025 02:58

Update pom.xml

ca58081

Add new execution to place EOfoo package to classes and inside eoc.jar

Update pom.xml

5be56ca

Write cleaner exclude for ignoring only package-info.class for Java code of Inspector

Merge branch 'master' into 500

e0d206d

yegor256 reviewed Jun 23, 2025

View reviewed changes

Remove empty lines in inspect.js

5e873e8

Create new top-level folder inspect

956fa4f

Extract source code files from mvnw and place them in inspect folder

volodya-lombrozo suggested changes Jun 24, 2025

View reviewed changes

ErnestMatskevich added 3 commits June 24, 2025 22:45

Remove InspectTest.java

b33189f

Add puzzle in inspect.js

d6992f9

Update inspect.js

56a4e0b

Fix puzzle description

500, adding entry point to inspect command #528

Are you sure you want to change the base?

500, adding entry point to inspect command #528

Uh oh!

Conversation

ErnestMatskevich commented May 22, 2025

Uh oh!

ErnestMatskevich commented May 22, 2025

Uh oh!

yegor256 commented May 23, 2025

Uh oh!

yegor256 commented May 23, 2025

Uh oh!

ErnestMatskevich commented May 24, 2025

Uh oh!

ErnestMatskevich commented May 24, 2025

Uh oh!

ErnestMatskevich commented May 27, 2025

Uh oh!

yegor256 commented May 28, 2025

Uh oh!

yegor256 commented May 28, 2025

Uh oh!

volodya-lombrozo left a comment

Choose a reason for hiding this comment

Uh oh!

volodya-lombrozo left a comment

Choose a reason for hiding this comment

inspect -> debug

Separate Project

Uh oh!

yegor256 commented May 28, 2025

Uh oh!

volodya-lombrozo commented May 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ErnestMatskevich commented May 28, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

volodya-lombrozo May 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ErnestMatskevich commented May 30, 2025

Uh oh!

ErnestMatskevich commented Jun 1, 2025

Build fails

itests fails

Uh oh!

volodya-lombrozo left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ErnestMatskevich commented Jun 4, 2025

Uh oh!

ErnestMatskevich commented Jun 22, 2025

Summary for commit

Uh oh!

ErnestMatskevich commented Jun 23, 2025

Fixed all errors

`inspect` -> `debug`

volodya-lombrozo commented May 28, 2025 •

edited

Loading

volodya-lombrozo May 29, 2025 •

edited

Loading

ErnestMatskevich commented Jun 23, 2025 •

edited

Loading