Merge pull request #100 from lucy66hw/xil/fix-termslookup-oneof-compat

Xil/fix termslookup oneof compat

Author: lucy66hw

.github/workflows/convert-proto.yml

@@ -3,6 +3,18 @@ name: Auto Proto Convert
 on:
   workflow_dispatch:
     inputs:
+      artifact_download_url:
+        description: 'Download URL for the api-spec build artifact zip.'
+        required: true
+        type: string
+      api_spec_commit:
+        description: 'Optional api-spec commit SHA for PR metadata.'
+        required: false
+        type: string
+      api_spec_run_id:
+        description: 'Optional api-spec workflow run ID for PR metadata.'
+        required: false
+        type: string
       opensearch_version:
         description: 'OpenSearch version. Leave empty to fetch latest.'
         required: false
@@ -32,32 +44,42 @@ jobs:
           distribution: temurin
           java-version: 17
 
-      - name: Download Release Assets
-        uses: robinraju/release-downloader@28fc21f50d76778e7023361aa1f863e717d3d56f # v1
-        with:
-          repository: 'opensearch-project/opensearch-api-specification'
-          latest: true
-          fileName: 'opensearch-openapi.yaml'
-          tag: 'main-latest'
-          preRelease: true
-
-      - name: Get Latest Commit ID
-        id: get_commit
-        uses: actions/github-script@d7906e4ad0b1822421a7e6a35d5ca353c962f410 # v6
-        with:
-          github-token: ${{ secrets.GITHUB_TOKEN }}
-          script: |
-            const owner = "opensearch-project";
-            const repo = "opensearch-api-specification";
-            const commits = await github.rest.repos.listCommits({
-              owner,
-              repo,
-              sha: "main",
-              per_page: 1
-            });
-            const latestCommit = commits.data[0].sha;
-            core.setOutput("latest_commit", latestCommit);
-            console.log("Latest commit: " + latestCommit);
+      - name: Resolve provided artifact metadata
+        id: api_spec_artifact
+        env:
+          ARTIFACT_DOWNLOAD_URL: ${{ inputs.artifact_download_url || github.event.client_payload.artifact_download_url || '' }}
+          API_SPEC_COMMIT: ${{ inputs.api_spec_commit || github.event.client_payload.api_spec_commit || '' }}
+          API_SPEC_RUN_ID: ${{ inputs.api_spec_run_id || github.event.client_payload.api_spec_run_id || '' }}
+        run: |
+          if [ -z "$ARTIFACT_DOWNLOAD_URL" ]; then
+            echo "artifact_download_url is required for both workflow_dispatch and repository_dispatch."
+            exit 1
+          fi
+
+          echo "artifact_download_url=$ARTIFACT_DOWNLOAD_URL" >> "$GITHUB_OUTPUT"
+          echo "source_commit=${API_SPEC_COMMIT:-unknown}" >> "$GITHUB_OUTPUT"
+          echo "run_id=${API_SPEC_RUN_ID:-unknown}" >> "$GITHUB_OUTPUT"
+
+      - name: Download API spec build artifact
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          curl -L \
+            -H "Authorization: Bearer $GH_TOKEN" \
+            -H "Accept: application/vnd.github+json" \
+            -o api-spec-build.zip \
+            "${{ steps.api_spec_artifact.outputs.artifact_download_url }}"
+
+          rm -rf api-spec-build
+          unzip -q api-spec-build.zip -d api-spec-build
+
+          SPEC_PATH=$(find api-spec-build -name opensearch-openapi.yaml -print -quit)
+          if [ -z "$SPEC_PATH" ]; then
+            echo "Could not find opensearch-openapi.yaml in downloaded artifact"
+            exit 1
+          fi
+
+          cp "$SPEC_PATH" opensearch-openapi.yaml
 
       - name: Get Latest OpenSearch Core Version
         id: get_opensearch_version
@@ -164,7 +186,7 @@ jobs:
           token: ${{ secrets.GITHUB_TOKEN }}
           branch: auto-pr-branch
           commit-message: "Protobuf schema change detected"
-          title: "[Automated PR]: Update generated protobuf schema (OpenSearch: ${{ steps.get_opensearch_version.outputs.version }}, spec commit: ${{ steps.get_commit.outputs.latest_commit }})"
+          title: "[Automated PR]: Update generated protobuf schema (OpenSearch: ${{ steps.get_opensearch_version.outputs.version }}, spec commit: ${{ steps.api_spec_artifact.outputs.source_commit }})"
           signoff: true
           base: main
           delete-branch: true
@@ -173,7 +195,8 @@ jobs:
             This pull request was automatically generated by GitHub Actions.
 
             **OpenSearch Version**: ${{ steps.get_opensearch_version.outputs.version }}
-            **API Spec Commit**: ${{ steps.get_commit.outputs.latest_commit }}
+            **API Spec Commit**: ${{ steps.api_spec_artifact.outputs.source_commit }}
+            **API Spec Build Run**: ${{ steps.api_spec_artifact.outputs.run_id }}
 
             ---
 

CHANGELOG.md

@@ -10,6 +10,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 - Add PIT RPCs to `SearchService` ([#469](https://github.com/opensearch-project/opensearch-protobufs/pull/469)).
 
 ### Changed
+- Improve protobuf compatibility handling for optional and `oneof` field migrations ([#479](https://github.com/opensearch-project/opensearch-protobufs/pull/479)).
 
 ### Removed
 

tools/proto-convert/src/SchemaModifier.ts

@@ -749,23 +749,38 @@ export class SchemaModifier {
             return;
         }
 
+        const existingProperties = schema.properties ? { ...schema.properties } : {};
+        const existingRequired = Array.isArray(schema.required) ? [...schema.required] : undefined;
         const mergedProperties: any = {};
 
         for (const item of schema.oneOf) {
             if (item && item.properties) {
-                Object.assign(mergedProperties, item.properties);
+                for (const [name, property] of Object.entries(item.properties)) {
+                    mergedProperties[name] = {
+                        ...(property as Record<string, unknown>),
+                        'x-oneof-property': true
+                    };
+                }
             }
         }
 
-        schema.properties = mergedProperties;
+        schema.properties = {
+            ...existingProperties,
+            ...mergedProperties
+        };
         schema.minProperties = 1;
         schema.maxProperties = 1;
+        if (existingRequired) {
+            schema.required = existingRequired;
+        }
 
         if ('unevaluatedProperties' in schema) {
             delete schema.unevaluatedProperties;
         }
         delete schema.oneOf;
-        delete schema.required;
+        if (!existingRequired) {
+            delete schema.required;
+        }
     }
 
     /**
@@ -783,9 +798,12 @@ export class SchemaModifier {
 
         if (hasDirectPattern) {
             if (schema.properties) {
+                const hasPreMarkedProperties = Object.values(schema.properties).some(prop =>
+                    prop && typeof prop === 'object' && 'x-oneof-property' in (prop as Record<string, unknown>)
+                );
                 for (const propName in schema.properties) {
                     const prop = schema.properties[propName] as any;
-                    if (prop && typeof prop === 'object') {
+                    if (prop && typeof prop === 'object' && (!hasPreMarkedProperties || prop['x-oneof-property'])) {
                         prop['x-oneof-property'] = true;
                     }
                 }