Implement access tracking for containingUrl

sass · Apr 12, 2024 · 722db47 · 722db47
1 parent 0432b4c
commit 722db47
Show file tree

Hide file tree

Showing 2 changed files with 40 additions and 13 deletions.
diff --git a/lib/src/importer-registry.ts b/lib/src/importer-registry.ts
@@ -14,6 +14,31 @@ import {catchOr, thenOr, PromiseOr} from './utils';
 
 const entryPointDirectoryKey = Symbol();
 
+class CanonicalizeContext {
+  readonly fromImport: boolean;
+
+  private readonly _containingUrl: URL | null;
+
+  get containingUrl(): URL | null {
+    this.containingUrlAccessed = true;
+    return this._containingUrl;
+  }
+
+  /**
+   * Whether the `containingUrl` getter has been accessed.
+   *
+   * This is marked as public so that the importer registry can access it, but
+   * it's not part of the package's public API and should not be accessed by
+   * user code. It may be renamed or removed without warning in the future.
+   */
+  containingUrlAccessed = false;
+
+  constructor(containingUrl: URL | null, fromImport: boolean) {
+    this._containingUrl = containingUrl;
+    this.fromImport = fromImport;
+  }
+}
+
 export class NodePackageImporter {
   readonly [entryPointDirectoryKey]: string;
 
@@ -115,21 +140,22 @@ export class ImporterRegistry<sync extends 'sync' | 'async'> {
       throw utils.compilerError('Unknown CanonicalizeRequest.importer_id');
     }
 
+    const canonicalizeContext = new CanonicalizeContext(
+      request.containingUrl ? new URL(request.containingUrl) : null,
+      request.fromImport
+    );
+
     return catchOr(
       () => {
         return thenOr(
-          importer.canonicalize(request.url, {
-            fromImport: request.fromImport,
-            containingUrl: request.containingUrl
-              ? new URL(request.containingUrl)
-              : null,
-          }),
+          importer.canonicalize(request.url, canonicalizeContext),
           url =>
             new proto.InboundMessage_CanonicalizeResponse({
               result:
                 url === null
                   ? {case: undefined}
                   : {case: 'url', value: url.toString()},
+              containingUrlAccessed: canonicalizeContext.containingUrlAccessed,
             })
         );
       },
@@ -197,15 +223,15 @@ export class ImporterRegistry<sync extends 'sync' | 'async'> {
       throw utils.compilerError('Unknown FileImportRequest.importer_id');
     }
 
+    const canonicalizeContext = new CanonicalizeContext(
+      request.containingUrl ? new URL(request.containingUrl) : null,
+      request.fromImport
+    );
+
     return catchOr(
       () => {
         return thenOr(
-          importer.findFileUrl(request.url, {
-            fromImport: request.fromImport,
-            containingUrl: request.containingUrl
-              ? new URL(request.containingUrl)
-              : null,
-          }),
+          importer.findFileUrl(request.url, canonicalizeContext),
           url => {
             if (!url) return new proto.InboundMessage_FileImportResponse();
             if (url.protocol !== 'file:') {
@@ -216,6 +242,7 @@ export class ImporterRegistry<sync extends 'sync' | 'async'> {
             }
             return new proto.InboundMessage_FileImportResponse({
               result: {case: 'fileUrl', value: url.toString()},
+              containingUrlAccessed: canonicalizeContext.containingUrlAccessed,
             });
           }
         );

diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "sass-embedded",
   "version": "1.75.0",
-  "protocol-version": "2.6.0",
+  "protocol-version": "2.7.0",
   "compiler-version": "1.75.0",
   "description": "Node.js library that communicates with Embedded Dart Sass using the Embedded Sass protocol",
   "repository": "sass/embedded-host-node",