fix(ZMS): show alternative locations for offices

[ThomasAFink]

Pull Request Checklist (Feature Branch to next):

• Ich habe die neuesten Änderungen aus dem next Branch in meinen Feature-Branch gemergt.
• Das Code-Review wurde abgeschlossen.
• Fachliche Tests wurden durchgeführt und sind abgeschlossen.

Summary by CodeRabbit

• New Features

  • Introduced an optional flag to control the display of alternative office locations within office listings and calendars.

• Tests

  • Updated expected response structures to validate the new flag, ensuring consistency in how office information is presented.

• Documentation

  • Revised API and schema definitions to incorporate the new flag, providing clear guidance on its usage in office data representations.

[coderabbitai]

Walkthrough

This update introduces a new nullable boolean property, showAlternativeLocations, into the Office data model. The Office class now accepts this property via its constructor and includes it in its serialization method. Additionally, the MapperService and ZmsApiFacadeService methods have been updated to pass this new parameter when instantiating Office objects. Test cases and JSON schemas have also been revised to reflect the new field, ensuring that alternative location display information is consistently handled throughout the application.

Changes

File(s)	Change Summary
zmscitizenapi/.../Models/Office.php zmscitizenapi/.../Services/Core/MapperService.php zmscitizenapi/.../Services/Core/ZmsApiFacadeService.php	Added the showAlternativeLocations property to the Office model; updated the constructor, toArray method, and service methods to integrate the new parameter.
zmscitizenapi/tests/... (OfficeListByServiceControllerTest.php, OfficesListControllerTest.php, OfficesServicesRelationsControllerTest.php, ZmsApiFacadeServiceTest.php, GET_SourceGet_dldb.json)	Revised expected response structures in tests by replacing or supplementing displayNameAlternatives with showAlternativeLocations to reflect changes in the Office model.
zmsentities/schema/... (officeList.json, officeServiceAndRelationList.json, office.json)	Updated JSON schemas to include the showAlternativeLocations property (type: ["boolean", "null"]) and reformatted type declarations for consistency and improved readability.

Sequence Diagram(s)

sequenceDiagram
    participant Facade as ZmsApiFacadeService
    participant Mapper as MapperService
    participant Office as Office Model

    Facade->>Mapper: Request office data (getOffices, getOfficeListByServiceId, etc.)
    Mapper->>Office: Instantiate Office(..., showAlternativeLocations)
    Office-->>Mapper: Return Office instance with showAlternativeLocations set
    Mapper-->>Facade: Return OfficeList with updated property

Loading

Possibly related PRs

• feat(ZMS-3460): create endpoint for free appointments grouped by office #797: Introduces the showAlternativeLocations parameter in the office mapping, similar to the changes here.
• feat(ZMS-3459): return slotTimeInMinutes #779: Modifies the Office model by adding additional properties including slotTimeInMinutes alongside showAlternativeLocations.
• Feature mpdzbs 877 zmscitizenapi #778: Updates the constructor and serialization methods of the Office class, reflecting changes in handling new properties.

Suggested reviewers

• Fabinatix97

Poem

I hop through lines of code with glee,
Adding new fields as you can see.
showAlternativeLocations now takes the stage,
Guiding data through each service page.
With every hop and every byte,
I celebrate code by day and night!
🐇🌟

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

zmscitizenapi/tests/Zmscitizenapi/Services/Core/ZmsApiFacadeServiceTest.php (1)

67-68: Consider adding test coverage for true value.

While the current test covers the basic functionality with showAlternativeLocations set to false, consider adding another test case with showAlternativeLocations set to true for comprehensive coverage.

 public function testGetOfficesSuccess(): void
 {
     // ... existing test code ...
 }
+
+public function testGetOfficesWithAlternativeLocationsSuccess(): void
+{
+    $provider = new Provider();
+    $provider->id = 1;
+    $provider->name = 'Test Provider';
+    $provider->source = 'unittest';
+    $provider->data = [
+        'address' => [
+            'street' => 'Test Street',
+            'number' => '123',
+            'city' => 'Test City',
+            'postal_code' => '12345'
+        ],
+        'geo' => ['lat' => 48.137154, 'lon' => 11.576124],
+        'showAlternativeLocations' => true
+    ];
+
+    // ... rest of the test setup ...
+
+    $result = ZmsApiFacadeService::getOffices();
+    $this->assertInstanceOf(OfficeList::class, $result);
+    $this->assertCount(1, $result->offices);
+    
+    $office = $result->offices[0];
+    $this->assertTrue($office->showAlternativeLocations);
+}

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7fdf903 and 007a753.

📒 Files selected for processing (11)

• zmscitizenapi/src/Zmscitizenapi/Models/Office.php (4 hunks)
• zmscitizenapi/src/Zmscitizenapi/Services/Core/MapperService.php (1 hunks)
• zmscitizenapi/src/Zmscitizenapi/Services/Core/ZmsApiFacadeService.php (3 hunks)
• zmscitizenapi/tests/Zmscitizenapi/Controllers/Office/OfficeListByServiceControllerTest.php (3 hunks)
• zmscitizenapi/tests/Zmscitizenapi/Controllers/Office/OfficesListControllerTest.php (2 hunks)
• zmscitizenapi/tests/Zmscitizenapi/Controllers/Office/OfficesServicesRelationsControllerTest.php (2 hunks)
• zmscitizenapi/tests/Zmscitizenapi/Services/Core/ZmsApiFacadeServiceTest.php (1 hunks)
• zmscitizenapi/tests/Zmscitizenapi/fixtures/GET_SourceGet_dldb.json (2 hunks)
• zmsentities/schema/citizenapi/collections/officeList.json (3 hunks)
• zmsentities/schema/citizenapi/collections/officeServiceAndRelationList.json (2 hunks)
• zmsentities/schema/citizenapi/office.json (3 hunks)

✅ Files skipped from review due to trivial changes (1)

• zmsentities/schema/citizenapi/office.json

⏰ Context from checks skipped due to timeout of 90000ms (2)

• GitHub Check: call-unit-tests / zmsdb-test
• GitHub Check: call-unit-tests / zmsapi-test

🔇 Additional comments (17)

zmscitizenapi/src/Zmscitizenapi/Models/Office.php (3)

27-29: LGTM! Property declaration follows best practices.

The new property is properly typed and documented using PHP 7.4+ property typing.

---

83-97: LGTM! Serialization includes the new field.

The toArray method properly includes the new field in the serialized output.

---

45-67: LGTM! Constructor implementation is correct.

The new parameter is logically placed and properly initialized.

Verify that the schema has been updated to include the new field:

✅ Verification successful

🏁 Script executed:

#!/bin/bash
# Description: Check if the schema includes the new showAlternativeLocations field
cat citizenapi/office.json | jq '.properties.showAlternativeLocations'

Length of output: 125

---

I'm not getting a definitive answer from the initial command because the file citizenapi/office.json wasn't found. To further investigate the update to the schema, let's search for any JSON file in the repository that mentions "showAlternativeLocations". This should help us locate where the schema might be defined.

Please run this script and share the output so we can verify whether the schema update exists in the codebase.

---

🏁 Script executed:

#!/bin/bash
# Search for any JSON file that contains the "showAlternativeLocations" property.
rg --type json '"showAlternativeLocations"'

Length of output: 560

---

Schema Update Verification

The schema has been updated to include the new showAlternativeLocations field. The search results show that the property is defined in multiple schema files (e.g., in zmsentities/schema/citizenapi/office.json, officeList.json, and officeServiceAndRelationList.json). This confirms that the necessary schema update has been made.

zmscitizenapi/tests/Zmscitizenapi/Controllers/Office/OfficesListControllerTest.php (1)

44-45: LGTM! Test coverage is comprehensive.

The test data includes both true and false cases for the new showAlternativeLocations field, ensuring proper coverage of the feature.

Also applies to: 85-86

zmscitizenapi/tests/Zmscitizenapi/Controllers/Office/OfficesServicesRelationsControllerTest.php (1)

44-45: LGTM! Test implementation is consistent.

The test data structure and values are consistent with other test files in the suite.

Also applies to: 85-86

zmscitizenapi/tests/Zmscitizenapi/Controllers/Office/OfficeListByServiceControllerTest.php (1)

45-46: LGTM! Test cases properly validate the new property.

The test cases have been updated to include the new showAlternativeLocations property with appropriate values for different scenarios, ensuring proper validation of the feature.

Also applies to: 106-107, 144-145

zmscitizenapi/src/Zmscitizenapi/Services/Core/MapperService.php (1)

66-66: LGTM! Property mapping is implemented correctly.

The showAlternativeLocations property is properly mapped from provider data with appropriate null handling using the null coalescing operator.

zmscitizenapi/src/Zmscitizenapi/Services/Core/ZmsApiFacadeService.php (1)

66-66: LGTM! Consistent implementation across all methods.

The showAlternativeLocations property is consistently added to Office constructor calls across all relevant methods with proper null handling.

Also applies to: 255-256, 382-383

zmsentities/schema/citizenapi/collections/officeList.json (2)

28-34: LGTM! Schema properly defines the new property.

The showAlternativeLocations property is well-defined with:

• Appropriate type constraints (boolean or null)
• Clear description of its purpose

---

2-6: LGTM! Improved schema formatting.

The type declarations have been reformatted to a more readable multi-line style while maintaining the same functionality.

Also applies to: 73-76, 80-83, 87-90, 94-97

zmscitizenapi/tests/Zmscitizenapi/fixtures/GET_SourceGet_dldb.json (2)

27-28: New Boolean Field in Provider Data (id "9999998")
A new property, showAlternativeLocations with a value of false, has been added within the data section for the provider with id "9999998". This addition clarifies that alternative locations should not be shown for this provider. Please ensure that any consumers of this JSON structure are updated to handle the new field.

---

50-51: Consistent Boolean Assignment for Provider "9999999"
The property showAlternativeLocations is correctly included with a value of true for the provider with id "9999999". This mirrors the intended behavior for providers that should display alternative locations.

zmsentities/schema/citizenapi/collections/officeServiceAndRelationList.json (5)

29-35: New Schema Field: showAlternativeLocations
A new property showAlternativeLocations has been introduced in the Office schema. It is defined to accept a boolean or null value. This change aligns the JSON schema with the updated Office model and ensures that downstream consumers can correctly determine whether alternative office locations should be displayed.

---

73-77: Schema Formatting Update: displayNameAlternatives
The type declaration for displayNameAlternatives has been reformatted into a multi-line array structure. This update improves readability while preserving the original intended types (array or null).

---

81-84: Schema Formatting Update: organization
The organization property now uses a multi-line array format for its type definition ("string" or "null"). This change enhances consistency and clarity in the schema without altering its semantics.

---

88-91: Schema Formatting Update: organizationUnit
Reformatting of the organizationUnit property into a multi-line array improves the overall consistency of the schema. The allowed types remain unchanged ("string" or "null").

---

95-98: Schema Formatting Update: slotTimeInMinutes
The type declaration for slotTimeInMinutes has been reformatted to a multi-line array structure, which enhances clarity. This change does not affect the underlying type semantics (allowing both "integer" and "null").