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.

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

Jump to bottom

Update to CMCC 2406.1.0 #73

Merged
merged 134 commits into from
Jan 28, 2025
Merged

Update to CMCC 2406.1.0 #73

merged 134 commits into from
Jan 28, 2025

Conversation

mmichaelis
Copy link
Member

@mmichaelis mmichaelis commented Jan 6, 2025 •
edited
Loading

To-Dos

Development

  • Remove GitHub Action (using a new approach, updating ci/develop is no longer required)
  • Update Workflow State Overview for new state "Redelivered".
  • Check for required documentation updates for the new "Redelivered" state.
  • Update CHANGELOG.md
  • Update CHANGELOG.md with recent changes (submission not found, invalid connector key)
  • Manual tests: Add scenario for "submission not found" (switch to second connector key)
  • Manual tests: Add scenario for invalid connector key.
  • Manual tests: Test with "Submission Error" (instruction mode: html)
  • Release Note about (minor) breaking change regarding instructions.
  • Contract Test: Prefix all submission names with an easy to identify name.
  • Contract Test: Use results from Contract Test for validation, for example, of the instruction text and/or submitter.
  • Contract Test: Add test for "no submission" by switching connector keys (and skip tests, if there are not multiple connector keys available)
  • Continue Unicode Instructions. As it seems, Plane 1 and above characters are always unsupported.... what to do now?
  • Now that we have found a solution for submission instructions, it is the same with submission names that must only contain BMP characters. We may need to partially reinvent the wheel...

Review

  • Validate labels for "Redelivered" state.

After Release

  • Update Release Notes (Draft below)
  • Delete branch ci/develop (we do not need that anymore)

The following is the proposed release note, once merged to main.

GlobalLink Connect Cloud for CoreMedia Content Cloud v12.2406.1.0

Despite adapting the connector to CoreMedia Content Cloud v12.2406.1.0, we hardened the connector in these aspects:

  • Introduced a defined behavior for the undocumented submission status REDELIVERED.
  • Fixed submission instruction handling to deal with its features (HTML content) and limitations (character types).
  • Fixed submission name handling to deal with its limitations (character types).
  • Hardened the connector in case of submission errors (an extra state reachable in the GCC backend).
  • Hardened the connector for "submission not found" scenarios that may occur due to wrong or connector key settings.

More detailed information and upgrade notes are available within the Changelog hosted on GitHub Pages.

@mmichaelis
chore: Update README.md
ee10a67 
Change referenced versions to 2406.1.
@mmichaelis
chore: Update license-maven-plugin
e180cf9 
Now using up-to-date version 2.5.0.
@mmichaelis
chore: Update studio-client
9012404 
* Use version 2406.1.0
* Align Jangaroo dependencies with 2406.1.0 release.
@mmichaelis
chore: Update development.md
63bbe55 
Change referenced versions to 2406.1.
@mmichaelis
chore: Update workflow-server POM
4c6cd91 
Update to version 2406.1.0.
@mmichaelis
refactor: Utilize workspace protocol in studio-client
1204617
@mmichaelis
chore: (Temporary) Commit Extension Tool Adaptations
c2432a5 
This commit should be dropped prior to merge.
@mmichaelis
chore: Weaken Type
6ab0479 
Applying static code analysis fixes.
@mmichaelis
chore: Declare Utility Classes As Private
c0cb627 
Applying static code analysis fixes.
@mmichaelis
chore: Replace Equals on Enums with ==
ecc7baf 
Applying static code analysis fixes.
@mmichaelis
chore: Make Fields Final
789ea74 
Applying static code analysis fixes.
@mmichaelis
chore: Remove Redundant Field Initialization With null
f7e466e 
Applying static code analysis fixes.
@mmichaelis
chore: Simplify Annotations
63a1f3a 
Applying static code analysis fixes.
@mmichaelis
chore: Prefer Collection.isEmpty()
6a6d32d 
Applying static code analysis fixes.
@mmichaelis
chore: Remove Unnecessary Qualified Static Access
f66e9d0 
Applying static code analysis fixes.
@mmichaelis
chore: Remove Unnecessary "final"
6617b20 
Applying static code analysis fixes.
@mmichaelis
chore: Remove Unnecessary "this"
dd23c5b 
Applying static code analysis fixes.
@mmichaelis
chore: Remove Redundant Suppressions
1e30907 
Applying static code analysis fixes.
@mmichaelis
chore: Remove Deprecated API Usage
95b1d32 
Applying static code analysis fixes.
@mmichaelis
chore: Make Field Final
35b114d 
Applying static code analysis fixes.
@mmichaelis
chore: Remove Unused Import
7377146 
Applying static code analysis fixes.
@mmichaelis
chore: Fix Implicit Platform Default Charset Usage
9f924f2 
Applying static code analysis fixes.
@mmichaelis
chore: Prefer Text Block (Java 15)
310e674 
Applying static code analysis fixes.
@mmichaelis
chore: Prefer Records (Java 16)
da58d2b 
Applying static code analysis fixes.
@mmichaelis
chore: Fix Javadoc Issues
eaa1345 
Applying static code analysis fixes.
@mmichaelis
chore: Fix non-constant string concatenation for logging
43c8ad9 
Applying static code analysis fixes.
@mmichaelis
chore: Fix Missing NonNull (inherited from 3rd-party)
2f67a05 
Applying static code analysis fixes.
@mmichaelis
chore: Fix Possible NullPointerExceptions (in test code)
157475d 
Applying static code analysis fixes.
@mmichaelis
chore: Use @serial Annotation (Java 14)
96825f7 
Applying static code analysis fixes.
@mmichaelis
chore: Remove Redundant Cast
33cb4cb 
Applying static code analysis fixes.
@mmichaelis mmichaelis changed the base branch from main to develop January 23, 2025 08:03
@mmichaelis
fixup! docs: Prefer YAML for Structs
923b662
@mmichaelis
feat(workflow-server): Add Replacement Strategy "none"
77fc9ca 
For consistency, a replacement strategy `none` seems to make sense.
While the same could be achieved setting `characterType` to
`unicode` (as this just ignores replacement strategies), looking
at both enums from an independent perspective, the "none" replacement
type is missing.
@mmichaelis
docs(changelog): Add Note About Unicode Character Type
ec599b7 
At least when using this adapter also for other translation agencies
or as soon as GlobalLink supports Unicode, a hint should exist, how
to configure the adapter. Added an upgrade note for that.
@mmichaelis
test(workflow-server): CharacterReplacementStrategyTest
98451e3
@mmichaelis
fix(workflow-server): CharacterReplacementStrategy Empty Result Handling
2718440 
While artificial if used "as intended", the replacement strategy should
be able not to provide unexpected results for unexpected successful
empty matches, like for `.*`.
@mmichaelis
feat(gcc-facade): Respect indents by spaces
1d8b9f3 
As the HTML instructions would just ignore leading spaces, we make them
non-breaking-spaces instead, now.
@mmichaelis
docs(changelog): Add Note About Hardened Error Handling
149a1ac
@mmichaelis
refactor(gcc-facade): Prefer textTransform over textType
c4109a8 
`textTransform` is easier to read and understand (especially, if you
need to adjust it), compared to the previous `textType`.
@mmichaelis
refactor(gcc-facade): Remove Unused GCUtil Methods
976035b 
Replacement operations moved to other classes now.
@mmichaelis
fix(gcc-facade): Should Replace by Same Amount of Spaces
f4f2226 
Before, all leading spaces got transformed to one ` `. Instead,
we should keep the same number of characters.
@mmichaelis
test(gcc-facade): Test TextTransform
7d4ef5f
@mmichaelis
refactor(gcc-facade): Keep Constructors Together
c81843c 
Just moving connector key validation.
@mmichaelis
docs(gcc-facade): Fix TEXT_TO_HTML Javadoc
95283b3
@mmichaelis mmichaelis marked this pull request as ready for review January 27, 2025 08:41
@mmichaelis
test(gcc-facade): Don't Log GCC Message to Console
c701b81 
The GCC logging is much too verbose to include it into our stdout.
Just logging it to file now.
@mmichaelis
test(gcc-facade): Bracket Around Constructor Tests
48298c7
@mmichaelis
test(gcc-facade): Test Available Connector Key Validation
70b2034
@mmichaelis
refactor(gcc-facade): Remove Obfuscation
8c919c7 
The only relevant authorization item that should not appear is the
API-Key. A connector key is no real secret. Also, it should be the
task of the `GCFacade` to hide secrets, if any, not ours.

Removing this extra effort.
@mmichaelis
refactor(gcc-facade): GCC Logging - Reduce Verbosity
b35ecc1 
The GCC API is very verbose on INFO level. Decided to reduce the
verbosity on delegation to `debug`.

Also, added the original log-level for information purpose.
@mmichaelis
test(gcc-facade): Add Unit Test for isSendSubmitter
141720a
@mmichaelis
test(gcc-facade): Add Unit Test for Submission Name Sanitizing
e59d42b
@mmichaelis
test(gcc-facade): Add Unit Test for Submission Instructions Sanitizing
0a6613e
@mmichaelis
test(gcc-facade): Add Unit Test for CharacterType
dae051f
@mmichaelis
test(gcc-facade): Update CharacterReplacementStrategyTest
b2958f2 
Aligning with other configuration tests.
@mmichaelis
test(gcc-facade): Add Unit Tests For Submission Error Propagation
90cdda7
@mmichaelis
test(gcc-facade): Add Unit Tests For Submission Not Found Exception
fba01e8
@mmichaelis
docs(gcc-facade): Add @SInCE to SLF4JHandler
5c7c26c
@mmichaelis mmichaelis merged commit 0da43cb into develop Jan 28, 2025
3 checks passed
@mmichaelis mmichaelis deleted the gcc-cmcc-12-2406.1.0 branch January 28, 2025 11:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@mmichaelis