Skip to content
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.

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

fix: copy app name if product name isn't provided #10490

Merged
merged 2 commits into from
Nov 6, 2024

Conversation

jvillafanez
Copy link
Member

Description

This is mostly to help with the upgrade from OCIS 6 to 7. The COLLABORATION_APP_PRODUCT is new in OCIS 7 and is needed in order to identify the target product (Collabora, OnlyOffice) and distinguish it from the app name, which could be a brand (CoolBox3, PrivateOffice, etc)

In OCIS 6, the COLLABORATION_APP_NAME acted as product name, so it was mostly limited to "Collabora", "OnlyOffice" and "Microsoft" values, but this won't be the case any longer.

The problem comes during the upgrade, where the product name might not be filled yet. This means that an "OnlyOffice" product (set in COLLABORATION_APP_NAME) might be mistakenly consider as a "Collabora" product (the default). This mistake could cause issues: so far we've detected that the "OnlyOffice" editor would open in view-only mode despite the user having enough permissions.

In order to make things easier, if the product name is not filled, the app name will be copied over.

  • For the upgrade scenario, this should work fine because the COLLABORATION_APP_NAME is expected to follow the name limitations from OCIS 6.
  • For new installations, both the app name and product name should be manually filled.

After the upgrade from 6 to 7, it is expected that, if there is a change in the COLLABORATION_APP_NAME, the COLLABORATION_APP_PRODUCT should be filled and / or adjusted.

Related Issue

Related to #10479

Motivation and Context

Less friction with the upgrade.

How Has This Been Tested?

Manually tested by removing the COLLABORATION_APP_PRODUCT env variable. The OnlyOffice installation (with "OnlyOffice" as COLLABORATION_APP_NAME) can edit the files.

Screenshots (if appropriate):

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Technical debt
  • Tests only (no source changes)

Checklist:

  • Code changes
  • Unit tests added
  • Acceptance tests added
  • Documentation ticket raised:

@jvillafanez jvillafanez self-assigned this Nov 6, 2024
Copy link

update-docs bot commented Nov 6, 2024

Thanks for opening this pull request! The maintainers of this repository would appreciate it if you would create a changelog item based on your changes.

@jvillafanez jvillafanez force-pushed the collaboration_config_upgrade_6to7 branch from 1281d14 to 3d65468 Compare November 6, 2024 14:27
@micbar
Copy link
Contributor

micbar commented Nov 6, 2024

@jvillafanez Can you add this PR URL to the changelog from the last PR please?

Other than that, good solution.

@micbar micbar enabled auto-merge November 6, 2024 15:57
Copy link

sonarqubecloud bot commented Nov 6, 2024

@micbar micbar merged commit 093e6f0 into master Nov 6, 2024
3 checks passed
@jvillafanez jvillafanez deleted the collaboration_config_upgrade_6to7 branch November 6, 2024 16:51
ownclouders pushed a commit that referenced this pull request Nov 6, 2024
…6to7

fix: copy app name if product name isn't provided
This was referenced Dec 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants