Versioning support for Synapse Artifacts

[SanojPunchihewa]

Problem

Currently, we can assign a version when creating a project. However, the Synapse artifacts do not inherit this version. As a result, if we have two projects with CApps (v1 and v2), we cannot deploy the second CAR file because the Synapse artifact names are identical in both CApps, even though they belong to different versions. This becomes problematic when exposing different API versions with separate integration logic. At present, users must manually rename all artifacts to avoid conflicts during deployment.

Proposed Solution

Incorporate the Project/CApp version into the creation and deployment process of Synapse artifacts. This will allow users to deploy artifacts with the same name across different versions of the CApp without conflicts

Alternatives

No response

Version

4.5.0

[SanojPunchihewa]

Progress Update

• Had 2 discussions regarding the requirement and the suggested approach
• Following is the proposed design

Update the deployers and Synapse artifact references to incorporate the project/CApp version. This should require no user intervention—users create projects in VS Code as usual.
To maintain backward compatibility, provide a config option to enable versioned deployment.

With versioned deployment, the api context will be prefixed by the fully qualified name of the CAR/Project. Consider the following,

Project POM

<project xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <modelVersion>4.0.0</modelVersion>
    <groupId>org.example</groupId>
    <artifactId>HelloWorldService</artifactId>
    <version>1.0.5</version>
    <packaging>pom</packaging>
    <name>HelloWorldService</name>
    <description>HelloWorldService</description>
---

Sample API

<?xml version="1.0" encoding="UTF-8"?>
<api context="/HelloWorld" name="HelloWorldAPI" xmlns="http://ws.apache.org/ns/synapse">
    <resource methods="GET">
        <inSequence>
            <sequence key="sequence_in_call"/>
            <http.get configKey="LocalMock">
                <relativePath>/abc</relativePath>
                <headers>[]</headers>
                <forceScAccepted>false</forceScAccepted>
                <disableChunking>false</disableChunking>
                <forceHttp10>false</forceHttp10>
                <noKeepAlive>false</noKeepAlive>
                <responseVariable>http_get_1</responseVariable>
                <overwriteBody>true</overwriteBody>
            </http.get>
            <respond/>
        </inSequence>
        <faultSequence/>
    </resource>
</api>

API Invocation URL

http://localhost:8290/<GROUP_ID.ARTIFACT_ID>/<API_CONTEXT>

http://localhost:8290/org.example.HelloWorldService/1.0.5/HelloWorld

If the user has provided an API version, the invocation URL will be as follows:

http://localhost:8290/org.example.HelloWorldService/1.0.5/HelloWorld/v1.0

When the API is invoked, the specific artifact will be referred using considering the parent’s fully qualified name. In the following example, the sequence sequence_in_call will be deployed as org.example.HelloWorldService/1.0.5/sequence_in_call and the Sequence mediator will construct it using the sequence key (sequence_in_call) and the org.example.HelloWorldService/1.0.5 fully qualified name.

To deploy a new version of the project/CAR, the user needs to only change the project version in the POM file.