Add document tracker to set `activeFileEntrypoint` context #1883

dotNomad · 2024-06-26T22:44:04Z

This PR adds a new context to the extension that tracks if the active document is an entrypoint with a ContentType that is known (aka not Unknown)

If the active document is an entrypoint - found via /api/inspect - we show a button which currently is non-functional, but will lead a user through deploying.

Note that licenses.md didn't need to change since vscode-uri is already included from dependencies.

Intent

Start of #1848

Type of Change

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

Approach

The approach here was to create a tracker that created all of the listeners needed itself, tracked the documents it needed to, and updated the context.

This way the extension could create a DocumentTracker and add it to its diposables with no other interaction between the two.

The DocumentTracker handles which documents need to be tracked via VSCode listeners, and TrackedEntrypointDocuments handle updating themselves if they are or are becoming the active document.

Everything else was broken off as a utility function.

Directions for Reviewers

Test the entrypoint context in a few cases:

open a non-entrypoint file
open an entrypoint file
open a file outside of the workspace entirely (I do this by running code some-file.txt from the Desktop for example)

Then do the same from a folder at a higher level. The dir and entrypoint query params should take care of the nested folder part for us.

Remove console logs Clean up disposable code

Correct params for entrypoint inspection Use vscode-uri utils for dirname and basename

dotNomad · 2024-07-03T01:54:30Z

extensions/vscode/package.json

@@ -685,6 +698,7 @@
    "eventsource": "^2.0.2",
    "get-port": "5.1.1",
    "mutexify": "^1.4.0",
-    "retry": "^0.13.1"
+    "retry": "^0.13.1",
+    "vscode-uri": "^3.0.8"


Added vscode-uri as a direct dependency to use the basename and dirname functions: https://github.com/microsoft/vscode-uri/blob/main/src/utils.ts

dotNomad · 2024-07-03T01:55:06Z

extensions/vscode/package.json

+      {
+        "command": "posit.publisher.deployWithEntrypoint",
+        "title": "Deploy with this Entrypoint",
+        "icon": "$(cloud-upload)",


Using a cloud-upload icon to avoid needing to deal with a PNG, or getting an SVG into a font for release.

As discussed, do we just want to use the PNG that we have for the old publisher icon, so we can replace both at once to the new one?

I tested this out and it does work, and doesn't look too bad even though it is being scaled down from 450x450 to 16x16

However since it is a png it doesn't get colored using the active theme. So even if I changed it to be white/gray/etc it would look incorrect depending on the theme used.

Personally I'd prefer to avoid the non-native look until we get that fixed.

If others disagree, it can be easily changed while I'm out with the below example:

{ "command": "posit.publisher.deployWithEntrypoint", "title": "Deploy with this Entrypoint", "icon": "assets/img/color/posit-publisher.png", "category": "Posit Publisher" }

dotNomad · 2024-07-03T01:55:51Z

extensions/vscode/src/extension.ts

+    new DocumentTracker(),
+    commands.registerCommand(Commands.DeployWithEntrypoint, () => {
+      commands.executeCommand(Commands.HomeView.Focus);
+      console.log("'Deploy with this Entrypoint' button hit!");


Currently the button only console logs.

Easily built upon! Great!

dotNomad · 2024-07-03T01:59:19Z

extensions/vscode/src/entrypointTracker.ts

+      dir: workspace.asRelativePath(dirname),
+      entrypoint: uriUtils.basename(document.uri),
+    });
+    return hasKnownContentType(response.data);


I'm only marking a document as an entrypoint if any of the inspections have a ContentType different than Unknown

dotNomad · 2024-07-03T02:36:10Z

extensions/vscode/src/utils/files.ts

+  if (dirname.fsPath === workspaceFolder.uri.fsPath) {
+    return ".";
+  }


workspace.asRelativePath(dirname) returns a path relative to the workspace folder, but if the path IS the workspace folder then it will return an absolute path.

That doesn't work for us, so here I check to see if the file system path is the same and return a ".".

dotNomad · 2024-07-03T02:38:58Z

extensions/vscode/src/entrypointTracker.ts

+ * @returns If the text document is an entrypoint
+ */
+async function isDocumentEntrypoint(document: TextDocument): Promise<boolean> {
+  const dir = relativeDir(document.uri);


This was quite tricky digging into what VSCode could do for us and what else is out there. I broke it out into its own utils function so we can get a dir path for any API requests.

dotNomad · 2024-07-03T02:41:28Z

extensions/vscode/src/entrypointTracker.ts

+   * @param options Options for the activation
+   * @param options.forceUpdate Whether to force the entrypoint to update
+   */
+  async activate(options?: { forceUpdate?: boolean }) {


The API calls only happen when we create a TrackedEntrypointDocument or when it is activated and needs an updated.

This occurs when the document is saved, or the document is re-opened.

TrackedEntrypointDocuments don't update if the file is open in VSCode, another file becomes active, then the original file is active again. That is because nothing has changed since the first API call.

dotNomad · 2024-07-03T02:42:52Z

extensions/vscode/src/entrypointTracker.ts

+  onTextDocumentClosed(document: TextDocument) {
+    this.removeDocument(document);
+  }


Documents are removed when closed since another editor could potentially change the document. This way when a document is re-opened we recheck just in case.

dotNomad · 2024-07-03T02:50:28Z

extensions/vscode/src/entrypointTracker.ts

+async function isDocumentEntrypoint(document: TextDocument): Promise<boolean> {
+  const dir = relativeDir(document.uri);
+  // If the file is outside the workspace, it cannot be an entrypoint
+  if (dir === undefined) {


If we don't want anything but . level entrypoints for now we can easily add that check here.

True, but I don't think we need to per our implementation plan.

sagerb

This looks really good and I think I have a handle on it.

If you could update the command to accept the document URI parameter that will be passed in, per my comment, and then output it in the console log, I think you'll have this PR at a good state. I'll approve it so you aren't blocked by me. Thanks!

sagerb · 2024-07-03T18:52:03Z

extensions/vscode/package.json

+      {
+        "command": "posit.publisher.deployWithEntrypoint",
+        "title": "Deploy with this Entrypoint",
+        "icon": "$(cloud-upload)",


As discussed, do we just want to use the PNG that we have for the old publisher icon, so we can replace both at once to the new one?

extensions/vscode/src/extension.ts

sagerb · 2024-07-03T19:02:03Z

extensions/vscode/src/entrypointTracker.ts

+async function isDocumentEntrypoint(document: TextDocument): Promise<boolean> {
+  const dir = relativeDir(document.uri);
+  // If the file is outside the workspace, it cannot be an entrypoint
+  if (dir === undefined) {


True, but I don't think we need to per our implementation plan.

sagerb · 2024-07-03T19:05:32Z

extensions/vscode/src/extension.ts

+    new DocumentTracker(),
+    commands.registerCommand(Commands.DeployWithEntrypoint, () => {
+      commands.executeCommand(Commands.HomeView.Focus);
+      console.log("'Deploy with this Entrypoint' button hit!");


Easily built upon! Great!

dotNomad changed the title ~~Dotnomad/entrypoint tracker~~ Add document tracker to set active file entrypoint context Jun 26, 2024

dotNomad changed the title ~~Add document tracker to set active file entrypoint context~~ Add document tracker to set activeFileEntrypoint context Jun 26, 2024

dotNomad force-pushed the dotnomad/entrypoint-tracker branch from bf49247 to c03b1b5 Compare July 2, 2024 21:45

Add DocumentTracker to set entrypoint context

0f4ddc0

dotNomad force-pushed the dotnomad/entrypoint-tracker branch 2 times, most recently from d475928 to a826fdd Compare July 3, 2024 02:04

dotNomad added 16 commits July 2, 2024 19:34

Add activeTextEditor on new DocumentTracker

db852fa

Remove console logs Clean up disposable code

Remove document from tracking when closed

d2d9280

Add isActiveDocument util function

c0c142d

Add on save updating to DocumentTracker

6df72c3

Add deployWithEntrypoint cmd to constants

3dd8867

Add built in home view focus cmd

b5bdee6

Register DeployWithEntrypoint wip command

1693223

Add hasKnownContentType util function

a467ef9

Add support for inspect entrypoint filtering

30f7a3e

Call inspect on active documents for context

9a3f6ae

Add copyright headers

1113b9a

Add parentDir and basename Uri utils

0f5ca1e

Correct params for entrypoint inspection Use vscode-uri utils for dirname and basename

Add try catch to isDocumentEntrypoint

a7d39dc

Move active file entrypoint context to constant

10e0121

Create relativeDir files util

1a02a5d

Correctly set dir param for entrypoint inspect

df6aca0

dotNomad force-pushed the dotnomad/entrypoint-tracker branch from a826fdd to df6aca0 Compare July 3, 2024 02:34

Quickly fail isDocumentEntrypoint

cf1a3e1

dotNomad commented Jul 3, 2024

View reviewed changes

dotNomad marked this pull request as ready for review July 3, 2024 02:49

dotNomad requested review from kgartland-rstudio, mmarchetti, sagerb and tdstein as code owners July 3, 2024 02:49

dotNomad commented Jul 3, 2024

View reviewed changes

sagerb approved these changes Jul 3, 2024

View reviewed changes

Include Uri param in command register callback

69d7a74

dotNomad merged commit c2e605c into main Jul 3, 2024
12 checks passed

dotNomad deleted the dotnomad/entrypoint-tracker branch July 3, 2024 21:28

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add document tracker to set `activeFileEntrypoint` context #1883

Add document tracker to set `activeFileEntrypoint` context #1883

dotNomad commented Jun 26, 2024 •

edited

Loading

dotNomad Jul 3, 2024

dotNomad Jul 3, 2024

sagerb Jul 3, 2024

dotNomad Jul 3, 2024

dotNomad Jul 3, 2024

sagerb Jul 3, 2024

dotNomad Jul 3, 2024

dotNomad Jul 3, 2024

dotNomad Jul 3, 2024

dotNomad Jul 3, 2024

dotNomad Jul 3, 2024

dotNomad Jul 3, 2024

sagerb Jul 3, 2024

sagerb left a comment

sagerb Jul 3, 2024

sagerb Jul 3, 2024

sagerb Jul 3, 2024

Add document tracker to set activeFileEntrypoint context #1883

Add document tracker to set activeFileEntrypoint context #1883

Conversation

dotNomad commented Jun 26, 2024 • edited Loading

Intent

Type of Change

Approach

Directions for Reviewers

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

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

sagerb left a 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

Add document tracker to set `activeFileEntrypoint` context #1883

Add document tracker to set `activeFileEntrypoint` context #1883

dotNomad commented Jun 26, 2024 •

edited

Loading