Skip to content

[5947] Add support for publishing libraries from non-main editing context#6072

Merged
sbegaudeau merged 1 commit intomasterfrom
gda/enh/publish_current_semantic_data_as_library
Jan 21, 2026
Merged

[5947] Add support for publishing libraries from non-main editing context#6072
sbegaudeau merged 1 commit intomasterfrom
gda/enh/publish_current_semantic_data_as_library

Conversation

@gdaniel
Copy link
Contributor

@gdaniel gdaniel commented Jan 16, 2026

Bug: #5947
Fixes #5947

Pull request template

General purpose

What is the main goal of this pull request?

  • Bug fixes
  • New features
  • Documentation
  • Cleanup
  • Tests
  • Build / releng

Project management

  • Has the pull request been added to the relevant project and milestone? (Only if you know that your work is part of a specific iteration such as the current one)
  • Have the priority: and pr: labels been added to the pull request? (In case of doubt, start with the labels priority: low and pr: to review later)
  • Have the relevant issues been added to the pull request?
  • Have the relevant labels been added to the issues? (area:, difficulty:, type:)
  • Have the relevant issues been added to the same project and milestone as the pull request?
  • Has the CHANGELOG.adoc been updated to reference the relevant issues?
  • Have the relevant API breaks been described in the CHANGELOG.adoc? (Including changes in the GraphQL API)
  • In case of a change with a visual impact, are there any screenshots in the CHANGELOG.adoc? For example in doc/screenshots/2022.5.0-my-new-feature.png

Architectural decision records (ADR)

  • Does the title of the commit contributing the ADR start with [doc]?
  • Are the ADRs mentioned in the relevant section of the CHANGELOG.adoc?

Dependencies

  • Are the new / upgraded dependencies mentioned in the relevant section of the CHANGELOG.adoc?
  • Are the new dependencies justified in the CHANGELOG.adoc?

Frontend

This section is not relevant if your contribution does not come with changes to the frontend.

General purpose

  • Is the code properly tested? (Plain old JavaScript tests for business code and tests based on React Testing Library for the components)

Typing

We need to improve the typing of our code, as such, we require every contribution to come with proper TypeScript typing for both changes contributing new files and those modifying existing files.
Please ensure that the following statements are true for each file created or modified (this may require you to improve code outside of your contribution).

  • Variables have a proper type
  • Functions’ arguments have a proper type
  • Functions’ return type are specified
  • Hooks are properly typed:
    • useMutation<DATA_TYPE, VARIABLE_TYPE>(…)
    • useQuery<DATA_TYPE, VARIABLE_TYPE>(…)
    • useSubscription<DATA_TYPE, VARIABLE_TYPE>(…)
    • useMachine<CONTEXT_TYPE, EVENTS_TYPE>(…)
    • useState<STATE_TYPE>(…)
  • All components have a proper typing for their props
  • No useless optional chaining with ?. (if the GraphQL API specifies that a field cannot be null, do not treat it has potentially null for example)
  • Nullable values have a proper type (for example let diagram: Diagram | null = null;)

Backend

This section is not relevant if your contribution does not come with changes to the backend.

General purpose

  • Are all the event handlers tested?
  • Are the event processor tested?
  • Is the business code (services) tested?
  • Are diagram layout changes tested?

Architecture

  • Are data structure classes properly separated from behavioral classes?
  • Are all the relevant fields final?
  • Is any data structure mutable? If so, please write a comment indicating why
  • Are behavioral classes either stateless or side effect free?

Review

How to test this PR?

Please describe here the various use cases to test this pull request

  • Has the Kiwi TCMS test suite been updated with tests for this contribution?


Library library = Library.newLibrary()
.namespace(publishLibrariesInput.projectId())
.namespace(publishLibrariesInput.editingContextId())
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I am wondering if this is a good idea.
We can maybe still use the projectId as the namespace to ensure all the libraries published from the same project are published in the same namespace.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Looking back at it, it doesn't make sense to use the editingContextId as namespace of a library.
It should still be the projectId, even if the PublishLibrariesInput gives the editingContextId.
I'll fix that.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done.
Note that it is the StudioLibraryPublicationListener that is in charge of retrieving the projectId. This means that if, somehow, someone attempts to publish a library from an editing context not contained in a project, the StudioLibraryPublicationHandler will create the library SemanticData, but the Library itself won't be created.

I don't know if I need to do anything else in this PR (e.g. compute the namespace in the handler and pass it to the listener via StudioLibrarySemanticDataCreationRequested) , or if fixing #6075 will be good enough to ensure we never reach this state.

Copy link
Member

Choose a reason for hiding this comment

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

I think it's good for the scope of this PR

@gdaniel gdaniel force-pushed the gda/enh/publish_current_semantic_data_as_library branch from a52518e to 2531d55 Compare January 16, 2026 17:37
@gdaniel gdaniel marked this pull request as draft January 18, 2026 23:50
@gdaniel gdaniel force-pushed the gda/enh/publish_current_semantic_data_as_library branch from 2531d55 to eddf816 Compare January 19, 2026 09:43
@gdaniel gdaniel marked this pull request as ready for review January 19, 2026 09:50
// The shared component contains all its elements in its root, and its content may vary between version,
// it is more stable to use a fixed name as the resource identifier.
String resourceId = input.projectId() + ":" + "shared_components";
String resourceId = input.editingContextId() + ":" + "shared_components";
Copy link
Contributor Author

Choose a reason for hiding this comment

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

We should also keep the projectId here: we want a stable identifier for the shared_components resource, it should remain stable if the resource has been published from one editing context or another.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done

@gdaniel gdaniel force-pushed the gda/enh/publish_current_semantic_data_as_library branch from eddf816 to b4fc7d8 Compare January 19, 2026 14:04
Copy link
Member

@sbegaudeau sbegaudeau left a comment

Choose a reason for hiding this comment

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

This looks good, I'll merge it this week

@sbegaudeau sbegaudeau force-pushed the gda/enh/publish_current_semantic_data_as_library branch from b4fc7d8 to 1da0a9e Compare January 21, 2026 11:55
…text

Bug: #5947
Signed-off-by: Gwendal Daniel <gwendal.daniel@obeosoft.com>
@sbegaudeau sbegaudeau force-pushed the gda/enh/publish_current_semantic_data_as_library branch from 1da0a9e to 6e30b53 Compare January 21, 2026 13:04
@sbegaudeau sbegaudeau merged commit 6a2c753 into master Jan 21, 2026
4 of 5 checks passed
@sbegaudeau sbegaudeau deleted the gda/enh/publish_current_semantic_data_as_library branch January 21, 2026 14:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Library publication only handles the main semantic data of a project

2 participants