Skip to content

Add API that debugger renderer can rely on to avoid breaking changes #1421

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 1, 2025
Merged

Add API that debugger renderer can rely on to avoid breaking changes #1421

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions dataframe-json/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,10 @@ tasks.withType<KotlinCompile> {
friendPaths.from(project(projects.core.path).projectDir)
}

tasks.withType<Javadoc> {
enabled = false
}

tasks.test {
useJUnitPlatform()
}
Expand Down
16 changes: 16 additions & 0 deletions dataframe-json/src/main/kotlin/org/jetbrains/kotlinx/dataframe/io/JsonFacadeForDebugger.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
package org.jetbrains.kotlinx.dataframe.io;

import org.jetbrains.kotlinx.dataframe.DataFrame;
import java.util.Collections;

class JsonFacadeForDebugger {
Copy link
Collaborator

@Jolanrensen Jolanrensen Sep 1, 2025

Choose a reason for hiding this comment

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

Any reason this is java? There's @JvmStatic() too if you need it :)

Copy link
Collaborator Author

@koperagen koperagen Sep 1, 2025

Choose a reason for hiding this comment

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

More straightforward ABI: avoiding false assumption that parameter with a default value can be added, file name, static method

Copy link
Collaborator

@Jolanrensen Jolanrensen Sep 1, 2025

Choose a reason for hiding this comment

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

okay, but we got a failing javadoc task because we never used to have java XD

Copy link
Collaborator

@Jolanrensen Jolanrensen Sep 1, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

I think we don't add java source files from gradle

Copy link
Collaborator Author

@koperagen koperagen Sep 1, 2025

Choose a reason for hiding this comment

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

pushed a fix disabling javadoc task. it was anyway an empty arfitact
image

Copy link
Collaborator

@Jolanrensen Jolanrensen Sep 1, 2025

Choose a reason for hiding this comment

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

Then the only issue I have left is #24 but then again, when it comes around to that we can always move it to the jvm specific module

/**
* utility for rendering dataframe as interactive table in the debugger - it needs json model
* Java class easier to discover in the debugger
* DO NOT BREAK ABI OF THIS METHOD!!
* Keep it for backward compatibility, create a new method if signature must change
*/
static String convertToJson(DataFrame<?> df, int rowLimit, Integer nestedRowLimit) {
return JsonKt.toJsonWithMetadata(df, rowLimit, nestedRowLimit, false, Collections.emptyList(), false);
}
}