feat: Multiple service support #2499

broksy · 2024-10-25T15:54:13Z

Adds support for multiple services and multiple annotations per service. Includes updates for multiple packages.

odata-service-writer

Added remove(basePath, service, fs?) to handle service related data removal from manifest.json and YAML files
Added optional parameter for generateMockserverConfig: overwrite (if true, then mockserver services and annotations are overwritten based on manifest dataSources), else dataSources for services and annotations from manifest are collected and appended to the existing mockserver data
Manifest template enhanced with support for annotations used as object or array to have backward compatibility

mockserver-config-writer

Added removeMockDataFolders(fs, basePath) to remove all mock data paths during running of removeMockserverConfig.

ui5-config

Added addServiceToMockserverMiddleware(dataSourceConfig, appRoot?, annotationsConfig = []) to add service to mockserver
Added removeServiceFromMockServerMiddleware(servicePath, annotationsPaths) to delete service from mockserver including annotations related to this service
Added removeBackendFromFioriToolsProxydMiddleware(backendUrl) to delete back from fiori-tools-proxy

create

Added another question whether user wants to overwrite existing services when interactive mode is used for command. If true, then mockserver services will be overwritten based on manifest dataSources and only when ui5-mock.yaml is available.

fiori-freestyle-writer

Since merge with main branch snapshots on Windows started to fail, I changed hardcoded '/'(Unix like separator) to sep (universal separator) from path module during template generation in processDestinationPath(filePath) in order to make replace work also on Windows like paths.

changeset-bot · 2024-10-25T15:54:17Z

🦋 Changeset detected

Latest commit: 6da046a

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 35 packages

Name	Type
@sap-ux/mockserver-config-writer	Minor
@sap-ux/odata-service-writer	Minor
@sap-ux/ui5-config	Minor
@sap-ux/create	Minor
@sap-ux/fiori-elements-writer	Patch
@sap-ux/fiori-freestyle-writer	Patch
@sap-ux/odata-service-inquirer	Patch
@sap-ux/generator-simple-fe	Patch
@sap-ux/abap-deploy-config-inquirer	Patch
@sap-ux/abap-deploy-config-writer	Patch
@sap-ux/adp-tooling	Patch
@sap-ux/app-config-writer	Patch
@sap-ux/cards-editor-config-writer	Patch
@sap-ux/cf-deploy-config-writer	Patch
@sap-ux/deploy-tooling	Patch
@sap-ux/environment-check	Patch
@sap-ux/launch-config	Patch
@sap-ux/project-access	Patch
@sap-ux/telemetry	Patch
@sap-ux/ui5-application-writer	Patch
@sap-ux/ui5-library-reference-writer	Patch
@sap-ux/ui5-library-writer	Patch
@sap-ux/ui5-proxy-middleware	Patch
@sap-ux/preview-middleware	Patch
@sap-ux/annotation-generator	Patch
@sap-ux/cap-config-writer	Patch
@sap-ux/cards-editor-middleware	Patch
@sap-ux/fe-fpm-writer	Patch
@sap-ux/fiori-annotation-api	Patch
@sap-ux/fiori-generator-shared	Patch
@sap-ux/ui5-application-inquirer	Patch
@sap-ux/ui5-library-reference-inquirer	Patch
@sap-ux/ui5-library-reference-sub-generator	Patch
@sap-ux/ui5-library-sub-generator	Patch
@sap-ux/fe-fpm-cli	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

packages/ui5-config/src/ui5config.ts

heimwege · 2024-11-06T15:02:03Z

You fix for the fiori-freestyle-writer issue has been addressed in #2532 as it was blocking other PRs as well

heimwege

see comments. Some improvement suggestions, some nit-picks (sorry for that), some type issues but no major issues

packages/mockserver-config-writer/src/mockserver-config/ui5-mock-yaml.ts

packages/mockserver-config-writer/src/app-info.ts

packages/odata-service-writer/src/data/defaults.ts

packages/odata-service-writer/src/delete.ts

packages/odata-service-writer/src/index.ts

heimwege

changeset ok
review comments addressed
test coverage is very good
did NOT test manually

heimwege

re-approve

johannes-kolbe

Thanks @broksy - Review focused on:

Code review in general
odata-service-writer - generate command
- adding services to ui5-local|ui5-mock.yaml
- adding service to manifest.json
  - localUri path is not resolved to metadata.xml
  - first service in manifest should be sap.ui5/models/"": { … }, not sap.ui5/models/"serviceName"
Manual testing with tools-suite consumption
Did not test:
- Deletion of services
- Add command
- CDS annotation scenario

johannes-kolbe · 2024-11-11T19:18:01Z

packages/odata-service-writer/src/index.ts

-        );
-
+        // Create local copy of metadata and annotations
+        fs.write(join(webappPath, 'localService', 'metadata.xml'), prettifyXml(service.metadata, { indent: 4 }));


This doesn't seem to work hardcoded for adding multiple services - Adding a new service would delete the old metadata.

Done in 54a778d

johannes-kolbe · 2024-11-12T08:12:04Z

packages/odata-service-writer/templates/extend/manifest.json

+                        "<%- localAnnotationsName %>"
+                    <% } %>
+                    ]
+                    <% if (locals.metadata) { %>,
                    "localUri": "localService/metadata.xml" <% } %><%if (version === '4') {%>,


localUri also has to be dynamically rendered. It is dependent on the folder the service is moved/generated to.

Done in e5029f3

johannes-kolbe · 2024-11-12T08:12:16Z

packages/odata-service-writer/templates/extend/manifest.json

+                                "uri": "/sap/opu/odata/IWFND/CATALOGSERVICE;v=2/Annotations(TechnicalName='<%- encodeURIComponent(annotation.technicalName) %>',Version='0001')/$value/",
+                                "type": "ODataAnnotation",
+                                "settings": {
+                                    "localUri": "localService/<%- annotation.technicalName %>.xml"


Same here with localUri

Done in e5029f3

johannes-kolbe · 2024-11-12T08:12:21Z

packages/odata-service-writer/templates/extend/manifest.json

+                        "uri": "/sap/opu/odata/IWFND/CATALOGSERVICE;v=2/Annotations(TechnicalName='<%- encodeURIComponent(annotations.technicalName) %>',Version='0001')/$value/",
+                        "type": "ODataAnnotation",
+                        "settings": {
+                            "localUri": "localService/<%- annotations.technicalName %>.xml"


Same here with localUri

Done in e5029f3

broksy · 2024-11-13T12:30:24Z

first service in manifest should be sap.ui5/models/"": { … }, not sap.ui5/models/"serviceName"

Currently it's up to consumer.
It's handled in enhanceData(service) in odata-service-writer package right before manifest enhancements.
If service param for generate has a model name then it's used, otherwise default '' is set and later used for manifest enhancements.

However, I can enhance setDefaultServiceModel to this:

    const models = manifest['sap.ui5']?.models;
    if (models) {
        // Filter dataSource models by dataSource property
        const servicesModels = Object.values(models).filter((model) => model.dataSource);
        // First one is being added
        if (servicesModels.length === 0) {
            service.model = '';
        } else {
            service.model = service.model ?? service.name;
        }
    } else {
        service.model = '';
    }

In such case it will always make sure that:

'' will be used for first service
service.model ?? service.name for next services

Done in 6da046a

sonarcloud · 2024-11-13T16:57:22Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
90.8% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

broksy added 4 commits October 24, 2024 14:17

fix: resolve conflict in i18n instances

3c6e5bb

feat: array support for annotations

b08658e

fix: refactoring

b80ecb3

feat: handle services from manifest or generate parameter

f74255d

broksy requested review from a team as code owners October 25, 2024 15:54

broksy and others added 5 commits October 25, 2024 18:58

feat: changeset

814e77a

feat: service removal

22440a1

test: backend removal

0aeecc7

Linting auto fix commit

3070e73

feat: mockserver create command with overwrite option

a5c6b93

broksy requested a review from a team as a code owner October 25, 2024 16:55

broksy added 3 commits October 25, 2024 20:05

fix: code smells

43f470c

fix: duplications for services

47835f1

fix: code smells

5fa9081

broksy added mockserver-config-writer @sap-ux/mockserver-config-writer odata-service-writer @sap-ux/odata-servier-writer ui5-config @sap-ux/ui5-config create @sap-ux/create labels Oct 25, 2024

broksy added 7 commits October 25, 2024 20:47

test: service removal

14407d4

fix: complexity for adding services

7864090

chore: naming for service removal

d359abf

feat: mockdata path generation and removal

9375602

chore: test describe

f27023e

test: cds generate

c1bfc01

feat: removal of annotations for cds

8759444

tobiasqueck reviewed Nov 5, 2024

View reviewed changes

packages/ui5-config/src/ui5config.ts Outdated Show resolved Hide resolved

tobiasqueck requested a review from heimwege November 5, 2024 16:14

broksy added 2 commits November 6, 2024 13:51

fix: make dataSources config not optional and update params

7896e4b

fix: only add unique services

7958134

broksy and others added 5 commits November 6, 2024 17:17

Merge branch 'main' into feat/multiple-services

698fc4e

fix: snapshots

53cc73e

feat: remove annotations along with the service

f863b55

fix: refactored annotations removal

77731b1

fix: replaced snapshots with actual data check

33ab01a

heimwege reviewed Nov 8, 2024

View reviewed changes

broksy added 5 commits November 8, 2024 13:27

chore: review comments

76c6f64

fix: simplified removal

041d98b

fix: removed redundant parameters

568ded9

fix: refactored complex generate function

e567979

fix: type cast

db71430

broksy requested a review from heimwege November 8, 2024 14:12

fix: odata service types

72910e6

heimwege previously approved these changes Nov 8, 2024

View reviewed changes

broksy requested a review from johannes-kolbe November 8, 2024 17:37

fix: jsdoc and service comparison by paths

a9211c3

broksy dismissed heimwege’s stale review via a9211c3 November 12, 2024 11:49

feat: generate metadata file to service folder

54a778d

heimwege previously approved these changes Nov 12, 2024

View reviewed changes

johannes-kolbe requested changes Nov 12, 2024

View reviewed changes

fix(app-modeler): service path

e5029f3

broksy dismissed heimwege’s stale review via e5029f3 November 13, 2024 10:52

fix: check if first service and if so call it mainService

6da046a

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Multiple service support #2499

feat: Multiple service support #2499

broksy commented Oct 25, 2024 •

edited

Loading

changeset-bot bot commented Oct 25, 2024 •

edited

Loading

heimwege commented Nov 6, 2024

heimwege left a comment

heimwege left a comment

heimwege left a comment

johannes-kolbe left a comment •

edited

Loading

johannes-kolbe Nov 11, 2024

broksy Nov 13, 2024

johannes-kolbe Nov 12, 2024

broksy Nov 13, 2024

johannes-kolbe Nov 12, 2024

broksy Nov 13, 2024

johannes-kolbe Nov 12, 2024

broksy Nov 13, 2024

broksy commented Nov 13, 2024 •

edited

Loading

sonarcloud bot commented Nov 13, 2024

feat: Multiple service support #2499

Are you sure you want to change the base?

feat: Multiple service support #2499

Conversation

broksy commented Oct 25, 2024 • edited Loading

changeset-bot bot commented Oct 25, 2024 • edited Loading

🦋 Changeset detected

heimwege commented Nov 6, 2024

heimwege left a comment

Choose a reason for hiding this comment

heimwege left a comment

Choose a reason for hiding this comment

heimwege left a comment

Choose a reason for hiding this comment

johannes-kolbe left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

broksy commented Nov 13, 2024 • edited Loading

sonarcloud bot commented Nov 13, 2024

Quality Gate passed

broksy commented Oct 25, 2024 •

edited

Loading

changeset-bot bot commented Oct 25, 2024 •

edited

Loading

johannes-kolbe left a comment •

edited

Loading

broksy commented Nov 13, 2024 •

edited

Loading