Overwrite featureId during packaging #909

mmajcica · 2024-06-02T09:28:33Z

In the contribution constraints, it is possible to reference the featureId's. FeatureId is composed of publisherId.extensionId.featureName. In case of extension tag being set, these fields do also need to be updated.

For further details check #172

This pull request introduces a new feature to update feature constraints in extension manifests and includes several related changes to the codebase. The most important updates involve adding the functionality to modify featureId properties in constraints, integrating this capability into the build and publish workflows, and updating the task configuration to support this feature.

New Feature: Update Feature Constraints in Extension Manifests

Added a new function, updateExtensionManifestsFeatureConstrains, to modify featureId properties in constraints within extension manifests. This function updates the featureId to include the correct extension ID and tag. (BuildTasks/Common/v5/Common.ts, BuildTasks/Common/v5/Common.tsR382-R410)

Workflow Integration

Updated the updateManifests function to include logic for updating feature constraints when the new updateFeatureConstraints input is enabled. (BuildTasks/Common/v5/Common.ts, [1] [2]
Renamed updateExtensionManifests to updateExtensionManifestsTaskIds for clarity, as it now specifically handles task IDs. (BuildTasks/Common/v5/Common.ts, BuildTasks/Common/v5/Common.tsL478-R520)

Publish Task Enhancements

Added a new boolean input, updateFeatureConstraints, to the publish task configuration (task.json). This input allows users to enable or disable the feature constraint update functionality. (BuildTasks/PublishExtension/v5/task.json, BuildTasks/PublishExtension/v5/task.jsonR179-R187)
Integrated the updateFeatureConstraints input into the PublishExtension task's workflow, ensuring the VSIX editor processes this new feature when enabled. (BuildTasks/PublishExtension/v5/PublishExtension.ts, [1] [2] [3]

VSIX Editor Updates

Added support for the updateFeatureConstraints option in the VSIXEditor class, including a new method editUpdateFeatureConstraints and logic to handle this option during VSIX file processing. (BuildTasks/PublishExtension/v5/vsixeditor.ts, [1] [2] [3]

These changes collectively enhance the flexibility and functionality of the extension publishing process by enabling automated updates to feature constraints in extension manifests.

jessehouwing · 2024-06-02T09:58:17Z

BuildTasks/Common/v5/Common.ts

+                    const parts = constraint.properties.featureId.split(".");
+                    parts[1] = extensionId;
+                    const newFeatureId = parts.join(".");
+                    constraint.properties.featureId = newFeatureId;


Are there any cases where people opt into someone else's feature Id? Say, the Microsoft new Boards Hub feature?

I haven't personally used these IDs, so there might be cases that we must keep in mind.

And I suspect the publisher may also be overwritten here.

Looks like ideally we'd loop over the feature contributions and then only overwrite the ones that match the same name at least.

https://github.com/gustavobergamim/azdevops-pipeline-approval/blob/master/vss-extension.json#L62-L99

jessehouwing · 2024-06-03T14:58:43Z

BuildTasks/Common/v5/Common.ts

+        await updateExtensionManifestsTaskIds(manifestPaths, tasksIds);
+    }
+
+    if (extensionTag && updateFeatureConstraints) {


if extensionId || extentionTag || publisherId

jessehouwing · 2024-06-03T14:59:09Z

BuildTasks/Common/v5/Common.ts

@@ -7,6 +7,7 @@ import { AzureRMEndpoint } from "azure-pipelines-tasks-azure-arm-rest/azure-arm-
 import fse from "fs-extra";
 import uuidv5 from "uuidv5";
 import tmp from "tmp";
+import { forEach } from "core-js/core/array";


Do we need this?

jessehouwing · 2024-06-10T14:34:29Z

BuildTasks/Common/v5/Common.ts

+                    const parts = constraint.properties.featureId.split(".");
+                    parts[1] = extensionId;
+                    const newFeatureId = parts.join(".");
+                    constraint.properties.featureId = newFeatureId;


Looks like ideally we'd loop over the feature contributions and then only overwrite the ones that match the same name at least.

https://github.com/gustavobergamim/azdevops-pipeline-approval/blob/master/vss-extension.json#L62-L99

mmajcica · 2024-06-10T15:22:26Z

Sorry i was busy this weekend, haven't found time for it. But it is on my list to wrap things up and test it.

…

On Mon, 10 Jun 2024, 16:34 Jesse Houwing, ***@***.***> wrote: ***@***.**** requested changes on this pull request. ------------------------------ In BuildTasks/Common/v5/Common.ts <#909 (comment)> : > + } + + const extensionTag = tl.getInput("extensionTag", false) || ""; + const extensionId = `${(tl.getInput("extensionId", false) || manifest.id)}${extensionTag}`; + + manifest.contributions + .filter((c: any) => c.constraints && c.constraints.length > 0) + .forEach((c: any) => { + c.constraints.forEach((constraint: any) => { + if (constraint.properties?.featureId) { + tl.debug(`Extension manifest featureId before: ${constraint.properties.featureId}`); + + const parts = constraint.properties.featureId.split("."); + parts[1] = extensionId; + const newFeatureId = parts.join("."); + constraint.properties.featureId = newFeatureId; Looks like ideally we'd loop over the feature contributions and then only overwrite the ones that match the same name at least. https://github.com/gustavobergamim/azdevops-pipeline-approval/blob/master/vss-extension.json#L62-L99 — Reply to this email directly, view it on GitHub <#909 (review)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAXC456AP2HIL4HFUY6QDCDZGW2RBAVCNFSM6AAAAABIU46IHKVHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMZDCMBXHE4DSMRVGE> . You are receiving this because you authored the thread.Message ID: ***@***.*** com>

jessehouwing · 2024-06-10T20:24:05Z

Sorry i was busy this weekend, haven't found time for it. But it is on my list to wrap things up and test it.

No problem! The release pipeline is still broken anyway ;). I was just exploring github how people were using features in the manifest to make sure this change won't break anyone.

jessehouwing · 2024-11-06T15:43:00Z

@mmajcica stil have plans to carry this forward, or shall we convert this to a draft PR for now?

Copilot

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

Copilot

Pull Request Overview

This PR introduces a new flag to update feature constraints during packaging and adjusts corresponding workflows and manifest updates.

Added "updateFeatureConstraints" flag and associated edit method in VSIXEditor.
Modified PublishExtension to pass through the new feature constraints update.
Updated Common utilities with a new manifest update function for feature constraints.

Reviewed Changes

Copilot reviewed 3 out of 4 changed files in this pull request and generated 3 comments.

File	Description
BuildTasks/PublishExtension/v5/vsixeditor.ts	Introduces new flag and method for updating feature constraints; conditional logic updated to include the new feature.
BuildTasks/PublishExtension/v5/PublishExtension.ts	Reads and passes the new "updateFeatureConstraints" parameter to VSIXEditor.
BuildTasks/Common/v5/Common.ts	Adds a new function to update feature IDs in extension manifests and renames an existing manifest update function.

Files not reviewed (1)

BuildTasks/PublishExtension/v5/task.json: Language not supported

Copilot · 2025-04-22T12:56:04Z

BuildTasks/PublishExtension/v5/vsixeditor.ts

-        if (this.versionNumber && this.updateTasksVersion || this.updateTasksId) {
+
+        if (this.versionNumber && this.updateTasksVersion || this.updateTasksId ||
+            this.editIdTag && this.editUpdateFeatureConstraints) {


The conditional block references 'this.editIdTag && this.editUpdateFeatureConstraints' which appears to be a mistake since there is no 'editUpdateFeatureConstraints' property; it is likely intended to use 'this.updateFeatureConstraints'.

Suggested change

this.editIdTag && this.editUpdateFeatureConstraints) {

this.editIdTag && this.updateFeatureConstraints) {

Copilot · 2025-04-22T12:56:04Z

BuildTasks/Common/v5/Common.ts

@@ -378,6 +379,35 @@ function updateExtensionManifestTaskIds(manifest: any, originalTaskId: string, n
    return manifest;
 }

+function updateExtensionManifestsFeatureConstrains(manifest: any): unknown {


The function name 'updateExtensionManifestsFeatureConstrains' appears to be misspelled. Consider renaming it to 'updateExtensionManifestsFeatureConstraints' for clarity.

Suggested change

function updateExtensionManifestsFeatureConstrains(manifest: any): unknown {

function updateExtensionManifestsFeatureConstraints(manifest: any): unknown {

Copilot · 2025-04-22T12:56:05Z

BuildTasks/Common/v5/Common.ts

+        await updateExtensionManifestsFeatureConstrains(manifestPaths);
    }


The function 'updateExtensionManifestsFeatureConstrains' is being passed 'manifestPaths' (an array) whereas it expects a manifest object. Consider iterating over 'manifestPaths' to load each manifest before processing.

Suggested change

await updateExtensionManifestsFeatureConstrains(manifestPaths);

}

for (const manifestPath of manifestPaths) {

const manifest = await getManifest(manifestPath);

await updateExtensionManifestsFeatureConstrains(manifest);

}

draft

b152236

mmajcica requested a review from jessehouwing as a code owner June 2, 2024 09:28

Mario Majcica added 3 commits June 2, 2024 11:31

minor

d42ab87

minor

447bb68

rollback

973aaff

jessehouwing requested changes Jun 3, 2024

View reviewed changes

jessehouwing requested changes Jun 10, 2024

View reviewed changes

jessehouwing added 2 commits June 10, 2024 22:24

Merge branch 'main' into feature/featureIdUpdate

12703ba

Merge branch 'main' into feature/featureIdUpdate

60b2eb1

jessehouwing requested a review from Copilot January 28, 2025 13:52

Merge branch 'main' into feature/featureIdUpdate

f58855c

Copilot AI reviewed Apr 1, 2025

View reviewed changes

jessehouwing requested a review from Copilot April 22, 2025 12:55

Copilot AI reviewed Apr 22, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Overwrite featureId during packaging #909

Overwrite featureId during packaging #909

Uh oh!

mmajcica commented Jun 2, 2024 •

edited by jessehouwing

Loading

Uh oh!

jessehouwing Jun 2, 2024

Uh oh!

jessehouwing Jun 3, 2024

Uh oh!

jessehouwing Jun 10, 2024

Uh oh!

jessehouwing Jun 3, 2024

Uh oh!

jessehouwing Jun 3, 2024

Uh oh!

jessehouwing Jun 10, 2024

Uh oh!

mmajcica commented Jun 10, 2024 via email

Uh oh!

jessehouwing commented Jun 10, 2024

Uh oh!

jessehouwing commented Nov 6, 2024

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Apr 22, 2025

Uh oh!

Copilot AI Apr 22, 2025

Uh oh!

Copilot AI Apr 22, 2025

Uh oh!

Uh oh!

	this.editIdTag && this.editUpdateFeatureConstraints) {
	this.editIdTag && this.updateFeatureConstraints) {

	function updateExtensionManifestsFeatureConstrains(manifest: any): unknown {
	function updateExtensionManifestsFeatureConstraints(manifest: any): unknown {

		await updateExtensionManifestsFeatureConstrains(manifestPaths);
		}

-        await updateExtensionManifestsFeatureConstrains(manifestPaths);
-    }
+        for (const manifestPath of manifestPaths) {
+            const manifest = await getManifest(manifestPath);
+            await updateExtensionManifestsFeatureConstrains(manifest);
+        }

Uh oh!

Overwrite featureId during packaging #909

Are you sure you want to change the base?

Overwrite featureId during packaging #909

Uh oh!

Conversation

mmajcica commented Jun 2, 2024 • edited by jessehouwing Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

New Feature: Update Feature Constraints in Extension Manifests

Workflow Integration

Publish Task Enhancements

VSIX Editor Updates

Uh oh!

jessehouwing Jun 2, 2024

Choose a reason for hiding this comment

Uh oh!

jessehouwing Jun 3, 2024

Choose a reason for hiding this comment

Uh oh!

jessehouwing Jun 10, 2024

Choose a reason for hiding this comment

Uh oh!

jessehouwing Jun 3, 2024

Choose a reason for hiding this comment

Uh oh!

jessehouwing Jun 3, 2024

Choose a reason for hiding this comment

Uh oh!

jessehouwing Jun 10, 2024

Choose a reason for hiding this comment

Uh oh!

mmajcica commented Jun 10, 2024 via email

Uh oh!

jessehouwing commented Jun 10, 2024

Uh oh!

jessehouwing commented Nov 6, 2024

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Apr 22, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 22, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 22, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

mmajcica commented Jun 2, 2024 •

edited by jessehouwing

Loading