Adding the platform selector and refactoring the new credential code #2688

rodriin · 2025-06-28T02:01:04Z

This PR introduces the initial platform selector needed for adding Connect Cloud support into the Publisher plugin. The platform selector is hidden by default behind the enableConnectCloud config option and it is not meant to be used yet at all since there are more changes needed before it can be used. If the enableConnectCloud configuration option were to be tuned on by a user, they would see the platform selector with two options ("Posit Connect Cloud" & " Posit Connect") but selecting either option would still take them through the Connect flow for adding a new credential, so for now all roads lead to Rome.

The multi-stepper code has been refactored to "jump" steps accordingly with the value of the serverType instead of "falling through" the non-applicable steps when adding a new credential. These changes were made to facilitate adding support of new platforms into the plugin such as Connect Cloud.

A new icon has been added for the Posit logo using the npm run build-font script to generate the appropriate icon-font and CSS file to make the icon available to the multi-stepper.

Intent

Resolves #2685

Type of Change

- Bug Fix
- New Feature
- Breaking Change
- Documentation
- Refactor
- Tooling

Approach

As of today the Publisher plugin only supports deployments onto a Posit Connect server running on user hosted infrastructure or a Posit Connect server running on Snowflake's SPCS infrastructure. Each of these have different credential needs hence their serverType is different but both are supporting the same platform: Posit Connect.

I have introduced a platform selector so new platforms such as Posit Connect Cloud can be supported and differentiated. For all purposes the platform selector will treat a Posit Connect server running on user hosted infrastructure the same as a Posit Connect server running on Snowflake's SPCS infrastructure. In order words those two flavors of Connect will be a single choice in the platform selector: "Posit Connect". However, they will be treated differently when adding a new credential once the server URL has been provided as it is implemented today.

New platforms such as Posit Connect Cloud will have their own entry in the platform selector so all the different multi-stepper steps can be properly handled. Adding the platform selector and refactoring the multi-stepper code to "jump" directly to applicable steps will simplify adding new platforms to the plugin.

User Impact

These changes will not have any user impact since they are hidden by default behind a configuration option and the E2E tests have been run successfully against this branch.

Automated Tests

Unit tests have been added for the testable parts of this change. No new E2E tests have been added yet for the platform selector since it is hidden by default behind a configuration option. New E2E tests will be added later on when more bits are working for supporting multiple platforms.

Directions for Reviewers

Validation of the existing flow for adding a new credential should be tested and it is expected to be working correctly including adding a new credential separately from adding a new deployment or as part of adding a new deployment.

Checklist

I have updated CHANGELOG.md to cover notable changes.

rodriin · 2025-07-16T18:31:47Z

extensions/vscode/package.json

+          "positPublisher.enableConnectCloud": {
+            "markdownDescription": "Controls whether Connect Cloud support is available. This is an experimental feature and it is currently unstable. Please wait until it reaches alpha stage to turn it on.",
+            "type": "boolean",
+            "default": false


New configuration option to enable feature flagging for adding Connect Cloud support

rodriin · 2025-07-16T18:33:43Z

extensions/vscode/package.json

+      },
+      "posit-publisher-posit-logo": {
+        "description": "posit logo icon",
+        "default": {
+          "fontPath": "dist/posit-publisher-icons.woff2",
+          "fontCharacter": "\\f102"
+        }


New Posit logo icon used for both "Posit Connect" and "Posit Connect Cloud" until new product specific logos become available for general use.

rodriin · 2025-07-16T18:37:56Z

extensions/vscode/src/multiStepInputs/common.ts

+// Fetch the list of all available snowflake connections
+export const fetchSnowflakeConnections = async (serverUrl: string) => {
+  let connections: SnowflakeConnection[] = [];
+  let connectionQuickPicks: QuickPickItemWithIndex[];
+
+  try {
+    const api = await useApi();
+    const connsResponse = await api.snowflakeConnections.list(serverUrl);
+    connections = connsResponse.data;
+    connectionQuickPicks = connections.map((connection, i) => ({
+      label: connection.name,
+      index: i,
+    }));
+  } catch (error: unknown) {
+    if (isAxiosErrorWithJson(error)) {
+      throw error;
+    }
+    const summary = getSummaryStringFromError(
+      "newCredentials, snowflakeConnections.list",
+      error,
+    );
+    window.showErrorMessage(
+      `Unable to query Snowflake connections. ${summary}`,
+    );
+    throw error;
+  }
+
+  if (!connectionQuickPicks.length) {
+    const msg = `No working Snowflake connections found for ${serverUrl}. Please configure a connection in your environment before creating a credential.`;
+    window.showErrorMessage(msg);
+    throw new Error(msg);
+  }
+
+  return { connections, connectionQuickPicks };
+};


This is a very small attempt at refactoring common code used in the multi-stepper newCredential.ts and newDeployment.ts files.

Thanks for doing this! Having shared code is so much better it is greatly appreciated.

rodriin · 2025-07-16T18:41:12Z

extensions/vscode/src/multiStepInputs/newCredential.ts

+      platformName = pick.label as PlatformName;
+      state.lastStep = thisStepNumber;
+
+      return (input: MultiStepInput) => inputServerUrl(input, state);


In the very near future this will be the point where we either go the "Posit Connect Cloud" route or the "Posit Connect" route. For now we are going the "Posit Connect" route always since we are still working on the "Posit Connect Cloud" integration bits.

rodriin · 2025-07-16T18:43:31Z

extensions/vscode/src/multiStepInputs/newCredential.ts

+    if (isConnect(serverType)) {
+      return (input: MultiStepInput) => inputAPIKey(input, state);
+    }
+
+    if (isSnowflake(serverType)) {
+      return (input: MultiStepInput) => inputSnowflakeConnection(input, state);
+    }


This is one example of code refactor to "jump" directly to applicable steps rather than visiting every step and "falling through" when it does not apply.

Thats a great refactor. Thank you for calling it out here I would have been confused otherwise why this change was made. Perhaps in the future we can separate out these quick improvements / refactors into separate PRs aside from the new feature work.

rodriin · 2025-07-16T18:49:12Z

extensions/vscode/src/multiStepInputs/newDeployment.ts

+    // Two credentials for the same URL is not allowed so clear the default if one is found
+    if (
+      currentURL !== "" &&
+      findExistingCredentialByURL(credentials, currentURL)


Bringing parity between newCredential.ts and newDeployment.ts

Thank you! I hope we are able to refactor these in the future to more easily share functionality as you did with some of the Snowflake logic.

That's my plan, but it will come in later PRs.

rodriin · 2025-07-16T18:49:23Z

extensions/vscode/src/multiStepInputs/newDeployment.ts

            return Promise.resolve({
-              message: `Error: Invalid URL (${getMessageFromError(e)}).`,
+              message: `Unexpected error within NewCredential::inputSeverUrl.finalValidation: ${JSON.stringify(e)}`,


Bringing parity between newCredential.ts and newDeployment.ts

rodriin · 2025-07-16T18:49:53Z

extensions/vscode/src/multiStepInputs/newDeployment.ts

+          const err = testResult.data.error;
+          if (err) {
+            if (err.code === "errorCertificateVerification") {
              return Promise.resolve({
-                message: `Error: Invalid URL (unable to validate connectivity with Server URL - API Call result: ${testResult.status} - ${testResult.statusText}).`,
+                message: `Error: URL Not Accessible - ${err.msg}. If applicable, consider disabling [Verify TLS Certificates](${openConfigurationCommand}).`,
                severity: InputBoxValidationSeverity.Error,
              });
            }
-            if (testResult.data.error) {
-              return Promise.resolve({
-                message: `Error: Invalid URL (${testResult.data.error.msg}).`,
-                severity: InputBoxValidationSeverity.Error,
-              });
-            }
-
-            if (testResult.data.serverType) {
-              serverType = testResult.data.serverType;
-            }
-          } catch (e) {
            return Promise.resolve({
-              message: `Error: Invalid URL (unable to validate connectivity with Server URL - ${getMessageFromError(e)}).`,
+              message: `Error: Invalid URL (unable to validate connectivity with Server URL - ${getMessageFromError(err)}).`,


Bringing parity between newCredential.ts and newDeployment.ts

rodriin · 2025-07-16T18:54:44Z

@dotNomad and @sagerb This PR is now ready for review. Please have a look when you get sometime, thank you so much 🙇‍♀️.

dotNomad

Overall this looks great. I tried setting the Connect Cloud setting and playing around with the new Credential and Deployment flows and the new platform selector works great. The new logo looks good too 👌

I do have the worry of moving this into main which we try to keep release-able (if possible). I think we can get this merged without any worry about releasing the code if we remove the config item and set an internal feature flag in the area I outlined.

I had a couple other questions in here too. I did a full careful review so we should be able to get this merged in quickly once those are addressed or discussed.

Wanted to note that I really appreciated the refactor here, but it lead to a lot of whitespace changes in the multiStepInputs that made the PR a bit tricky to review.

I want to keep doing refactors like that when we notice areas for improvement, but we can split them up a bit when making commits / PRs to make them easier to review, verify, and get into main. Separating the refactor and platform selection work here would had been very helpful from my end.

extensions/vscode/CHANGELOG.md

dotNomad · 2025-07-16T20:59:04Z

extensions/vscode/package.json

+      },
+      "posit-publisher-posit-logo": {
+        "description": "posit logo icon",
+        "default": {
+          "fontPath": "dist/posit-publisher-icons.woff2",
+          "fontCharacter": "\\f102"
+        }


extensions/vscode/src/extension.ts

extensions/vscode/src/api/types/contentRecords.ts

extensions/vscode/src/multiStepInputs/common.ts

dotNomad · 2025-07-16T21:16:46Z

extensions/vscode/src/multiStepInputs/common.ts

+// Fetch the list of all available snowflake connections
+export const fetchSnowflakeConnections = async (serverUrl: string) => {
+  let connections: SnowflakeConnection[] = [];
+  let connectionQuickPicks: QuickPickItemWithIndex[];
+
+  try {
+    const api = await useApi();
+    const connsResponse = await api.snowflakeConnections.list(serverUrl);
+    connections = connsResponse.data;
+    connectionQuickPicks = connections.map((connection, i) => ({
+      label: connection.name,
+      index: i,
+    }));
+  } catch (error: unknown) {
+    if (isAxiosErrorWithJson(error)) {
+      throw error;
+    }
+    const summary = getSummaryStringFromError(
+      "newCredentials, snowflakeConnections.list",
+      error,
+    );
+    window.showErrorMessage(
+      `Unable to query Snowflake connections. ${summary}`,
+    );
+    throw error;
+  }
+
+  if (!connectionQuickPicks.length) {
+    const msg = `No working Snowflake connections found for ${serverUrl}. Please configure a connection in your environment before creating a credential.`;
+    window.showErrorMessage(msg);
+    throw new Error(msg);
+  }
+
+  return { connections, connectionQuickPicks };
+};


Thanks for doing this! Having shared code is so much better it is greatly appreciated.

extensions/vscode/src/multiStepInputs/newCredential.ts

dotNomad · 2025-07-16T21:25:25Z

extensions/vscode/src/multiStepInputs/newCredential.ts

+    if (isConnect(serverType)) {
+      return (input: MultiStepInput) => inputAPIKey(input, state);
+    }
+
+    if (isSnowflake(serverType)) {
+      return (input: MultiStepInput) => inputSnowflakeConnection(input, state);
+    }


Thats a great refactor. Thank you for calling it out here I would have been confused otherwise why this change was made. Perhaps in the future we can separate out these quick improvements / refactors into separate PRs aside from the new feature work.

extensions/vscode/src/multiStepInputs/newCredential.ts

dotNomad · 2025-07-16T21:32:58Z

extensions/vscode/src/multiStepInputs/newDeployment.ts

+    // Two credentials for the same URL is not allowed so clear the default if one is found
+    if (
+      currentURL !== "" &&
+      findExistingCredentialByURL(credentials, currentURL)


Thank you! I hope we are able to refactor these in the future to more easily share functionality as you did with some of the Snowflake logic.

rodriin · 2025-07-16T22:59:57Z

@dotNomad Thank you for reviewing my PR! I'm sorry about the white spaces. I know those can be annoying when reviewing a PR and I'll try to make an effort to separate code changes more intentionally moving forward.

I always use the "Hide whitespace" feature in GitHub and that helps me deal with the white spaces. I wanted to ask if you used it and still found it too heavy on the changes? Or maybe you did not use it. Just curious. Thanks again!

rodriin · 2025-07-16T23:04:58Z

@dotNomad I just pushed some changes to address your feedback. It's ready for round 2 of review, thank you!

dotNomad · 2025-07-16T23:26:10Z

I always use the "Hide whitespace" feature in GitHub and that helps me deal with the white spaces. I wanted to ask if you used it and still found it too heavy on the changes? Or maybe you did not use it. Just curious. Thanks again!

I use it sparingly. I toggled it on for this PR since there were some nesting changes, but I still saw quite a few changes on the multiStepInputs. Thanks for bringing that up though, if I didn't know about it it would have been super helpful for this PR.

I just pushed some changes to address your feedback. It's ready for round 2 of review, thank you!

Awesome taking a look! 👀

dotNomad

Thank you for those changes to the config. This is looking great 👍

I noted some potential improvements for avoiding the enum dance, but due to type safety achieving it is a bigger lift and not one I'd recommend doing inside of an already in progress PR

extensions/vscode/src/multiStepInputs/newCredential.ts

Adding the product selector and refactoring the new credential code

6912eac

rodriin mentioned this pull request Jun 30, 2025

add support for adding/retrieving Connect Cloud credentials #2684

Merged

7 tasks

rodriin added 11 commits July 7, 2025 15:53

Re-introducing serverType and refactoring code

f0e8c27

Merge remote-tracking branch 'origin/main' into ingrid-product-selector

9045685

Running prettier

6c1b61f

Fixing prettier

8dc5011

Test fix

ce16259

Refactoring and removing Snowflake from the product selector

7c42073

Merge remote-tracking branch 'origin/main' into ingrid-product-selector

9ae868b

Removing the snowflake icon

a65cc18

Clean-up

292d38e

Adding unit tests and a change log

a942a27

Merge remote-tracking branch 'origin/main' into ingrid-product-selector

ec265dc

rodriin changed the title ~~Adding the product selector and refactoring the new credential code~~ Adding the platform selector and refactoring the new credential code Jul 16, 2025

rodriin marked this pull request as ready for review July 16, 2025 18:26

rodriin requested review from dotNomad, sagerb and marcosnav as code owners July 16, 2025 18:26

Merge remote-tracking branch 'origin/main' into ingrid-product-selector

6ceafa5

rodriin requested a review from mslynch July 16, 2025 18:29

rodriin commented Jul 16, 2025

View reviewed changes

dotNomad reviewed Jul 16, 2025

View reviewed changes

Addressing PR feedback

93deb98

dotNomad approved these changes Jul 16, 2025

View reviewed changes

extensions/vscode/src/multiStepInputs/newCredential.ts Show resolved Hide resolved

dotNomad mentioned this pull request Jul 16, 2025

Make MutliStepState more generic for easier data references #1081

Open

rodriin merged commit 9e0a2e9 into main Jul 18, 2025
12 checks passed

rodriin deleted the ingrid-product-selector branch July 18, 2025 16:31

Adding the platform selector and refactoring the new credential code #2688

Adding the platform selector and refactoring the new credential code #2688

Conversation

rodriin commented Jun 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Intent

Type of Change

Approach

User Impact

Automated Tests

Directions for Reviewers

Checklist

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rodriin Jul 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rodriin commented Jul 16, 2025

Uh oh!

dotNomad left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rodriin commented Jul 16, 2025

Uh oh!

rodriin commented Jul 16, 2025

Uh oh!

dotNomad commented Jul 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dotNomad left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

rodriin commented Jun 28, 2025 •

edited

Loading

rodriin Jul 16, 2025 •

edited

Loading

dotNomad left a comment •

edited

Loading

dotNomad commented Jul 16, 2025 •

edited

Loading

dotNomad left a comment •

edited

Loading