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

WPB-3798 incorrect json field names #3518

Merged
merged 13 commits into from
Aug 22, 2023
Merged

WPB-3798 incorrect json field names #3518

merged 13 commits into from
Aug 22, 2023

Conversation

lepsa
Copy link
Contributor

@lepsa lepsa commented Aug 21, 2023 •
edited
Loading

Changes

Notable

The JSON schema for NonConnectedBackends has changed due to the changes in CustomEncoded, it is no longer dropping the "prefix" of non. @elland also noticed this issue in another ticket. #3489

newtype NonConnectedBackends = NonConnectedBackends
  { nonConnectedBackends :: Set Domain
  }

Other

  • Updating records that had prefix processing in their JSON schemas to remove leading prefixes from their fields, and updating code and tests to reflect these new field names.
  • federator dropped mtl as a direct dependency.

Open Questions: Answered, see Checklist

How do we deal with the API change around NonConnectedBackends? I can see a couple of options going forward.

  • Breaking the API.
  • We create a new API version for the routes that use it. This new version can have the correct field name of non_connected_backends. Older versions would need to keep their current semantics of connected_backends
  • We notify client developers about the change so they can make the parsing accept both field names, and make the backend also accept both names. However clients should send the old name for compatibility.

Checklist

  • [:heavy_check_mark:] Add a new entry in an appropriate subdirectory of changelog.d
  • [:heavy_check_mark:] Read and follow the PR guidelines
    • I've talked with @akshaymankar about how we might deal with the change in the federation API, and he mentioned that we can probably perform a breaking change in this particular instance as it is unlikely to affect anyone. Further investigation is warranted to ensure this, however it is a promising start.

@lepsa lepsa marked this pull request as ready for review August 21, 2023 08:34
@akshaymankar akshaymankar added the ok-to-test Approved for running tests in CI, overrides not-ok-to-test if both labels exist label Aug 21, 2023
@lepsa
WPB-3798: PR feedback.
99d1061
@lepsa
WPB-3798: Fixing an error with a field called data'
4f7a1ff 
The trailing ' would end up in the JSON representation. I've changed it
to use a leading `_` like other structures, and wrote a newtype to
handle the minimal prefix stripping.

Also cleaning up the diff in regards to imports.
@lepsa
WPB-3798: Cleaning up imports to minimise the diff
f0b7e99
@lepsa
Merge remote-tracking branch 'origin/develop' into WPB-3798-incorrect…
8682185 
…-json-field-names-foo
@elland elland merged commit 8344669 into wireapp:develop Aug 22, 2023
2 checks passed
pcapriotti added a commit that referenced this pull request Sep 27, 2023
@pcapriotti @smatting
@lepsa @akshaymankar @mdimjasevic @fisx @elland @battermann @jappeace @atomrc @supersven @arthurwolf
Merge develop into mls (#3597)
40a4adc 
* Fix bug: federatorInternal host not set for background-worker (#3516)

* WPB-3916: Filtering out duplicate members when sending defederation notifications (#3515)

* integration: Add test to verify behaviour with offline backends (#3501)

* background-worker: Make push backoff times configurable

* brig/getFederationStatus: Always return NonConnectedBackends as empty when fed policy is AllowAll

* integration: Use separate vHosts for backendA and B.

* integration/RunServices: Add hack to make federation work

* integration: Add test to verify behaviour with offline backends

* helm-var-integration: Workaround bug with federation

* integration-test.sh: Run new integration test suite first

---------

Co-authored-by: Marko Dimjašević <marko.dimjasevic@wire.com>

* Distinguish between update and upsert cassandra commands (#3513)

* Remove billing-team-member-backfill tool (#3520)

* dockerephemeral: Increase nofile ulimits for ES and Fake DynamoDB (#3521)

* [WPB 3842] Federation completeness check (#3514)

* WPB-3842: Improving checks for adding users to a conversation.

Added a check to `ensureAllowed` that checks for full federation
connections for domains in a conversation, including the domains for new
users.

* WPB-3842: Adding the changelog

* WPB-3842: Moving where the extra domain checks are being performed.

Updating integration tests to reflect the updated semantics of
conversation join semantics. Many of them weren't expecting errors
relating to unreachable domains, and had to be updated to reflect this.

* Fix asserted domains in an integration test

* Integration test: assert on non-federating domains

* WPB-3842: Changing parallel testing to sequential testing

---------

Co-authored-by: Marko Dimjašević <marko.dimjasevic@wire.com>

* WPB-3798 incorrect json field names (#3518)

* WPB-3798: Updating code and tests after renaming fields

* WPB-3798: More updates to names after finding more JSON prefix mangling

* WPB-3798: Fixing schema instances for SAML data

* WPB-3798: Fixing instances that had errors, found by tests

* WPB-3798: Adding changelogs

* WPB-3798: PR feedback.

* WPB-3798: Fixing an error with a field called `data'`

The trailing ' would end up in the JSON representation. I've changed it
to use a leading `_` like other structures, and wrote a newtype to
handle the minimal prefix stripping.

Also cleaning up the diff in regards to imports.

* WPB-3798: Cleaning up imports to minimise the diff

* nit-picks (#3519)

* Remove unneeded -Wwarn (re-enabeling -Werror in those modules).

* Makefile: fix hspec_options overloading in .envrc.local.

* integration: Fix testAddingUserNonFullyConnectedFederation and testNotificationsForOfflineBackends (#3529)

* integration: Fix testAddingUserNonFullyConnectedFederation

* integration: Don't allow adding users to conv when one of the pariticipating backends is down

* integration: Add retries to get around problem of federation domain sync threads

* Introduce API v5 (#3527)

* Introduce development version 5

* Specialise API to a specific version

* Use versioned swagger for galley

* Use version swagger for all other services

* Collect all service Swaggers into a typeclass

* Fix swagger integration tests

* Revert any changes to API versions before 5

* Remove promotion of isDevelopmentVersion

* Add CHANGELOG entry

* stern: Optimize RAM usage of /i/users/meta-info (#3522)

* stern: Fetch only the notifications that are needed

* stern: Fetch only the conversations that are needed

* Integration tests: use static ports (#3536)

* [WPB-3799] cannot fetch conversation details after connection request (#3538)

* brig-integration: Fix flaky tests for API.Federation (#3539)

* brig-integration: Don't assume only 1 result in search by display name

Display names are random strings from 2 to 128 characters. If a 2 string name gets generated it is likely that it matches some name generated in another test.

* brig-integration: Mark test not flaky

It didn't fail after runnning it 1000 times.

* Integration suite: Fix bug in local setup: wrong port for nginz http2 (#3543)

* [WPB-662] servantify brig provider bot api (#3540)

* Fix broken "we are hiring" link (#3549)

* Multi-ingress guest links (#3546)

* Check validity of notification IDs (#3550)

* Check validity of notification IDs

* Add CHANGELOG entry

* fixup! Add CHANGELOG entry

* fixup! fixup! Add CHANGELOG entry

* WPB-633 Servantify Brig/Provider.Service API (#3554)

* WPB-1214: Servantify Brig/Provider.Service API

- Moving the routes over to servant, and removing the old routing code.
- Adding new instances to types that needed them for servant.

* WPB-663: Removing a redundant TODO comment, adding changelog

* Fix ES migration script. (#3558)

* Revert "WPB-633 Servantify Brig/Provider.Service API (#3554)"

This reverts commit 3653d56.

* Integration tests: delete all rabbitmq queues during dynamic backends setup phase (#3523)

* [WPB-4406] federator improve logging (#3556)

* Makefile: Avoid executing the hint (#3564)

Backticks execute the command even when they are in quotes.

* Finalise v4 (#3545)

* Remove MLS endpoints from the API

They will be reintroduced when merging the mls branch. These endpoints
are not currently functional on develop, so removing them from here will
reduce the amount of conflicts.

* Finalise v4

* Add CHANGELOG entry

* Add pregenerated swagger for v4

* Delete MLS tests in brig

* Remove more MLS endpoints from v4

* Set default API version to 5 in integration tests

* Update the documentation on API versioning

---------

Co-authored-by: Marko Dimjašević <marko.dimjasevic@wire.com>

* Fix: SCIM user lookup after changing IdP issuer ID (#3473)

* doc: document webapp configuration for multi-ingress environments (#3569)


---------

Co-authored-by: Sven Tennie <sven.tennie@gmail.com>

* [WPB-4361] upgrade jwt-tools (#3559)

* cassandra: Add column and table names in parsing error messages (#3555)

* s/CORS/CSP/ as mentionned by Sven in WPB-2912

* Replace broken integrations with links

see WPB-3599

* replace all instances of example.com with wire.example as per wpb-2621, in charts only

* change back from wire.example to example.com as this was mistakenly commit to develop instead of to the proper branch

* add documentation on creating a first user

* reverting previous commit as sent to wrong branch

* Update sftd docs: include uri scheme in allowOrigin (#3584)

* Update sftd docs: include uri scheme in allowOrigin

* fixup

* WPB-4629 impossible to add users to a conversation if one of the members is from an offline backend (#3585)

* fake-aws-s3 chart: Upgrade to minio 5.0.13 (#3565)

* Disable de-federation to avoid running into a scalability issue (#3582)

https://wearezeta.atlassian.net/browse/WPB-4668

Co-authored-by: Akshay Mankar <akshay@wire.com>

* [WPB-3664] Bug fix: Notify remote backends of their users removed from conversation when reachable again (#3537)

* Formatting

* Test utilities for changing a conv name

* Add a test confirming the bug report

* An action to enqueue notifications concurrently

* Enqueue member removal notification for remotes

* Add a changelog

* Test case formatting

* Migrate test roleUpdateWithRemotesUnavailable

* Migrate test putReceiptModeWithRemotesOk

* Migrate test putReceiptModeWithRemotesUnavailable

* Migrate test testRoleUpdateWithRemotesOk

* Migrate test roleUpdateRemoteMember

* Migrate test putQualifiedConvRenameWithRemotesUnavailable

This one is already covered by testSynchroniseUserRemovalNotification

* Migrate test putQualifiedConvRenameWithRemotesOk

* Migrate test deleteLocalMemberConvLocalQualifiedOk

* Migrate test deleteRemoteMemberConvLocalQualifiedOk

* Migrate test deleteUnavailableRemoteMemberConvLocalQualifiedOk

* Add the copyright header to a test module

* Move a test utility (allPreds)

* Test utility: create a team with members

* Migrate test testAccessUpdateGuestRemoved

* Migrate test messageTimerChangeWithRemotes

* Migrate test messageTimerUnavailableRemotes

* Migrate test testAccessUpdateGuestRemovedRemotesUnavailable

* Migrate test accessUpdateWithRemotes

* Migrate test testAddRemoteMember

* Migrate test testDeleteTeamConversationWithRemoteMembers

* Migrate test testDeleteTeamConversationWithUnavailableRemoteMembers

* Move a test utility (assertLeaveNotification)

* Migrate test "POST /federation/leave-conversation : Success"

* Migrate test "POST /federation/on-user-deleted-conversations : Remove deleted remote user from local conversations"

* Migrate test updateConversationByRemoteAdmin

* Tests: support giving a role when adding

* Use cannon API for notifications when possible

* Use startDynamicBackends when possible

* Fix assertion

* Migrate test testAddRemoteUsersToLocalConv

* Test add member endpoint at version 1

* Add return value to enqueueNotification

* Use cannon assertions in offline backends test

* Check that remote notifications are received

* Test removal of users from unreachable backends

* Use correct domains for default backends

Taking the domains in the `backendA` and `backendB` resources only works
locally.

* fixup! Use cannon assertions in offline backends test

---------

Co-authored-by: Paolo Capriotti <paolo@capriotti.io>
Co-authored-by: Akshay Mankar <akshay@wire.com>

* WPB-4240: Migrate from swagger2 to openapi3 (#3570)


---------

Co-authored-by: Igor Ranieri Elland <54423+elland@users.noreply.github.com>
Co-authored-by: Igor Ranieri <igor@elland.me>

* Remove mocked MLS member add test

* Resolve conflict in pregenerated swagger

* Remove MLS end2end tests

---------

Co-authored-by: Stefan Matting <smatting@users.noreply.github.com>
Co-authored-by: Owen Harvey <owenlharvey@gmail.com>
Co-authored-by: Akshay Mankar <akshay@wire.com>
Co-authored-by: Marko Dimjašević <marko.dimjasevic@wire.com>
Co-authored-by: fisx <mf@zerobuzz.net>
Co-authored-by: Igor Ranieri Elland <54423+elland@users.noreply.github.com>
Co-authored-by: Leif Battermann <leif.battermann@wire.com>
Co-authored-by: Jappie Klooster <jappieklooster@hotmail.com>
Co-authored-by: Leif Battermann <leifbattermann@gmail.com>
Co-authored-by: Thomas Belin <thomasbelin4@gmail.com>
Co-authored-by: Sven Tennie <sven.tennie@gmail.com>
Co-authored-by: Arthur Wolf <wolf.arthur@gmail.com>
Co-authored-by: Igor Ranieri <igor@elland.me>
supersven pushed a commit that referenced this pull request Oct 5, 2023
@lepsa @supersven
WPB-3798 incorrect json field names (#3518)
5ca13c9 
* WPB-3798: Updating code and tests after renaming fields

* WPB-3798: More updates to names after finding more JSON prefix mangling

* WPB-3798: Fixing schema instances for SAML data

* WPB-3798: Fixing instances that had errors, found by tests

* WPB-3798: Adding changelogs

* WPB-3798: PR feedback.

* WPB-3798: Fixing an error with a field called `data'`

The trailing ' would end up in the JSON representation. I've changed it
to use a leading `_` like other structures, and wrote a newtype to
handle the minimal prefix stripping.

Also cleaning up the diff in regards to imports.

* WPB-3798: Cleaning up imports to minimise the diff
This was referenced Oct 19, 2023
Closed
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@elland elland elland approved these changes

Assignees
No one assigned
Labels
ok-to-test Approved for running tests in CI, overrides not-ok-to-test if both labels exist
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@lepsa @elland @akshaymankar