feat(platform): Add support for JetBrains Space platform #29151

vooft · 2024-05-19T07:13:03Z

Changes

Hi All,

I implemented integration with the JetBrains Space platform.
Features supported:

Autodiscover
Creating PRs
Finding closed ones
Rebasing PRs (manual only via adding rebase! to the title)
Adding/removing comments
Changing PR body
Adding reviewers
Adding authors
Auto-merging if checks have passed (not available in free plan, but could be tested on trial)

Not everything is covered with tests yet, but, say, 70% of the new code. I would like to get some feedback on my code, please, before proceeding with the remaining tests. My background is in JVM world and, perhaps, some things were not implemented idiomatically.

Unfortunately, Space doesn't have public repositories, but I'm happy to give access for interested to my test environment.

Minimal config for testing would look like this:

module.exports = {
  token: '<your-personal-token>',
  repositories: ['main/my-repo'], // optional, goes like <project-key>/<repo-name>, default project key is "MAIN", but it seems that server doesn't care about casing
  platform: 'space',
  endpoint: '<your-org>.jetbrains.space',
};

Context

I was using Renovate for long time and wanted to contribute in some way, as well as to play with JetBrains Space.

Documentation (please check one with an [x])

I have updated the documentation, or
No documentation update is required

How I've tested my work (please select one)

I have verified these changes via:

Code inspection only, or
Newly added/modified unit tests, or
No unit tests but ran on a real repository, or
Both unit tests + ran on a real repository

rarkins

Thanks for this PR! The most important point would be to adopt Zod for validating all responses from the Space API. Right now you are casting any to typed values, which is risky for runtime faults. Instead we want to use Zod for all new code like this: https://github.com/renovatebot/renovate/blob/main/docs/development/zod.md

rarkins · 2024-05-19T07:17:22Z

lib/workers/repository/onboarding/branch/check.ts

@@ -60,7 +60,7 @@ async function closedPrExists(config: RenovateConfig): Promise<Pr | null> {
 }

 export async function isOnboarded(config: RenovateConfig): Promise<boolean> {
-  logger.debug('isOnboarded()');
+  logger.debug(`isOnboarded(${JSON.stringify(config)})`);


Needs reverting

rarkins · 2024-05-19T07:18:35Z

lib/workers/repository/update/pr/index.ts

+            existingPrBodyHash,
+            newPrBodyHash,


Is this actually helpful to the user? We don't intend for these hashes to be meaningful to anyone

No, I added it when was debugging, removed

rarkins · 2024-05-19T07:20:28Z

lib/modules/platform/space/utils.ts

+    case 'Opened':
+      return 'open';
+    case 'Closed':
+      if (canBeReopened) {


Is this a kind of "hack" to determine whether a closed PR was merged or not? Would be good to document it so that others don't need to guess in future

Added a comment explaining why need this flag

rarkins · 2024-05-19T07:22:01Z

lib/modules/platform/space/index.ts

+  logger.debug(
+    `SPACE findPr(${JSON.stringify(findPRConfig)}, ${refreshCache})`,
+  );


Just a general note that logging like this will need to be lowered or removed before merge

Right, I'll clean up most of the debug logs, thanks

Replaced most of logs with trace or simply removed, kept a couple that might be useful for general user debugging

…hanges in the common code

…Space

vooft · 2024-05-19T08:23:34Z

@rarkins thank you for checking it out! Will read about ZOD and make required changes.

viceice · 2024-05-21T21:14:47Z

I think space is to general, the platform should probably be jetbrains-space or something similar

HonkingGoose · 2024-05-27T08:51:50Z

lib/modules/platform/space/client/code-review-read.spec.ts

+  type SpaceMergeRequestRecordPredicate,
+} from './code-review-read';
+
+const spaceEndpointUrl = 'https://myorg.jetbrains.space';


I think something like jetbrainsSpaceEndpointUrl is easier to understand.

lib/config/presets/local/index.ts

viceice

Spaces is deprecated¹!

@rarkins @secustor Should we add a deprecated platform? Support will be fully stoped on 2025-05-31.

They currently have a new platform in preview SpaceCode.
I'm sure it's totally different.

https://blog.jetbrains.com/space/2024/05/27/the-future-of-space/ ↩

viceice · 2024-05-27T13:36:11Z

lib/config/presets/local/index.ts

@@ -26,6 +26,7 @@ const resolvers = {
  github,
  gitlab,
  local: null,
+  space: local, // TODO: not sure what this means


Suggested change

space: local, // TODO: not sure what this means

space: local,

loading presets from local platform

viceice · 2024-05-27T13:40:21Z

lib/modules/platform/space/types.ts

@@ -0,0 +1,169 @@
+export interface SpacePaginatedResult {}


Use zod schema for types

https://github.com/renovatebot/renovate/blob/main/docs/development/zod.md#L1

vooft · 2024-05-27T15:47:03Z

@viceice that's very unfortunate lol, I chose the perfect time to start building this integration :)
I imagine they will probably reuse part of the code from Space in the new platform, so potentially the api will be similar.

viceice · 2024-05-27T15:50:25Z

@viceice that's very unfortunate lol, I chose the perfect time to start building this integration :)
I imagine they will probably reuse part of the code from Space in the new platform, so potentially the api will be similar.

it's already in preview, so you can check it.

vooft · 2024-05-27T16:59:41Z

The API feels mostly the same, looks like they removed chats, but some chat-related APIs are still there.
I will probably pause for now until they release it to public.

HonkingGoose · 2024-05-27T20:50:46Z

They currently have a new platform in preview SpaceCode.
I'm sure it's totally different.

I found some more info about the differences between the old Space and the upcoming SpaceCode. The Jetbrain docs, migrate from Space to SpaceCode, what will not stay in SpaceCode says:

What will NOT stay in SpaceCode

Automation. You will be able to convert and transfer your Automation jobs to JetBrains TeamCity and continue using them for your CI/CD needs.

Issues. You will be able to move your issues to an alternative planning tool — JetBrains YouTrack.

Documents. Project documents can be exported to YouTrack Knowledge Base.

Checklists. Can be extracted via HTTP API.

Blog posts. Can be extracted via HTTP API.

Chats. Messages can be retrieved in batch via HTTP API.

Packages. Package repository source data can be accessed and retrieved via HTTP API.

Calendars and calendar events such as Meetings, Absences, Holidays. Personal calendars can be exported to .ICS files.

To-do lists.

Locations.

Work schedule.

Availability status.

I'll let the maintainers decide if it's worth it to support a now deprecated platform.

vooft added 30 commits May 19, 2024 10:09

wip

7eb1553

retrieve default branch

4f030cb

wip

3c8e957

removed global state from client

d0ac584

removed global state from client

1a76414

wip

b8c5fbf

wip

44d7eaa

wip

6d99349

wip

0c2b4bc

wip

6c237d0

Added updatePr

4ec09a8

working check for build status

222f983

working merge

c54aedb

wip

cd42ac0

wip

fe022b8

wip

701f5b5

reviewers/assignees

59cb31b

wip

b3225f7

wip

c38ad29

working ensure comment

46b4891

ensure comment removal

56afcea

wip

efcf05b

Removed remainings of gerrit

c19ba03

added test for getSpaceRepoUrl

835a85c

added tests for utils

0ed5930

cleanup

aff8b08

wip tests

79b24c4

wip iterator test

24be1ec

wip iterator test

0b60e2e

wip iterator test

634a7b7

vooft added 12 commits May 19, 2024 10:09

fix tests

90a36f9

fix autodiscover

a4960a4

add tests for code-review-write.ts

c2e1cab

add tests for code-review-read.ts

6740fb9

wip

334ba6d

wip

0d28ceb

wip

e28ee48

wip

38ac8fe

wip

ab15047

wip

10e62e3

Add more tests to dao

bc3efa7

lint

d48a1e9

vooft changed the title ~~WIP Add support for JetBrians Space platform~~ feat(jetbrains-space): Add support for JetBrians Space platform May 19, 2024

vooft changed the title ~~feat(jetbrains-space): Add support for JetBrians Space platform~~ feat(platform/space): Add support for JetBrians Space platform May 19, 2024

rarkins requested changes May 19, 2024

View reviewed changes

vooft added 3 commits May 19, 2024 11:27

minor cleanup

4564287

Replace most of logger.debug with logger.trace, revert some logging c…

f0a69b1

…hanges in the common code

Add a comment to explain difference between closed and merged PRs in …

744b30a

…Space

viceice self-requested a review May 21, 2024 21:01

HonkingGoose suggested changes May 27, 2024

View reviewed changes

viceice changed the title ~~feat(platform/space): Add support for JetBrians Space platform~~ feat(platform): Add support for JetBrians Space platform May 27, 2024

viceice changed the title ~~feat(platform): Add support for JetBrians Space platform~~ feat(platform): Add support for JetBrains Space platform May 27, 2024

viceice requested changes May 27, 2024

View reviewed changes

rarkins marked this pull request as draft May 28, 2024 04:36

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(platform): Add support for JetBrains Space platform #29151

feat(platform): Add support for JetBrains Space platform #29151

vooft commented May 19, 2024 •

edited

rarkins left a comment

rarkins May 19, 2024

rarkins May 19, 2024

vooft May 19, 2024

rarkins May 19, 2024

vooft May 19, 2024

rarkins May 19, 2024

vooft May 19, 2024

vooft May 19, 2024

vooft commented May 19, 2024

viceice commented May 21, 2024

HonkingGoose May 27, 2024

viceice left a comment

viceice May 27, 2024

viceice May 27, 2024

vooft commented May 27, 2024

viceice commented May 27, 2024

vooft commented May 27, 2024

HonkingGoose commented May 27, 2024

	space: local, // TODO: not sure what this means
	space: local,

feat(platform): Add support for JetBrains Space platform #29151

Are you sure you want to change the base?

feat(platform): Add support for JetBrains Space platform #29151

Conversation

vooft commented May 19, 2024 • edited

Changes

Context

Documentation (please check one with an [x])

How I've tested my work (please select one)

rarkins left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vooft commented May 19, 2024

viceice commented May 21, 2024

Choose a reason for hiding this comment

viceice left a comment

Choose a reason for hiding this comment

Footnotes

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vooft commented May 27, 2024

viceice commented May 27, 2024

vooft commented May 27, 2024

HonkingGoose commented May 27, 2024

vooft commented May 19, 2024 •

edited