Fix regressions during refactor of state accessor (#4471)

microsoft · Sep 18, 2024 · 94ff9d6 · 94ff9d6
1 parent 8df0a9f
commit 94ff9d6
Show file tree

Hide file tree

Showing 7 changed files with 29 additions and 9 deletions.
diff --git a/.chronus/changes/fix-invalid-or-2024-8-18-21-5-24.md b/.chronus/changes/fix-invalid-or-2024-8-18-21-5-24.md
@@ -0,0 +1,9 @@
+---
+# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking
+changeKind: internal
+packages:
+  - "@typespec/compiler"
+  - "@typespec/rest"
+---
+
+Fix regressions during refactor of state accessor
diff --git a/packages/compiler/src/lib/decorators.ts b/packages/compiler/src/lib/decorators.ts
@@ -1163,8 +1163,8 @@ export function isKey(program: Program, property: ModelProperty) {
   return getKey(program, property) !== undefined;
 }
 
-export function getKeyName(program: Program, property: ModelProperty): string {
-  return getKey(program, property) || property.name;
+export function getKeyName(program: Program, property: ModelProperty): string | undefined {
+  return getKey(program, property);
 }
 
 export const $withDefaultKeyVisibility: WithDefaultKeyVisibilityDecorator = (

diff --git a/packages/compiler/src/lib/service.ts b/packages/compiler/src/lib/service.ts
@@ -17,7 +17,7 @@ export interface Service extends ServiceDetails {
 }
 
 const [getService, setService, getServiceMap] = useStateMap<Namespace, Service>(
-  "@typespec/compiler.services",
+  Symbol.for("@typespec/compiler.services"),
 );
 
 /**

diff --git a/packages/compiler/src/lib/utils.ts b/packages/compiler/src/lib/utils.ts
@@ -5,10 +5,10 @@ function createStateSymbol(name: string) {
   return Symbol.for(`TypeSpec.${name}`);
 }
 
-export function useStateMap<K extends Type, V>(key: string) {
-  return unsafe_useStateMap<K, V>(createStateSymbol(key));
+export function useStateMap<K extends Type, V>(key: string | symbol) {
+  return unsafe_useStateMap<K, V>(typeof key === "string" ? createStateSymbol(key) : key);
 }
 
-export function useStateSet<K extends Type>(key: string) {
-  return unsafe_useStateSet<K>(createStateSymbol(key));
+export function useStateSet<K extends Type>(key: string | symbol) {
+  return unsafe_useStateSet<K>(typeof key === "string" ? createStateSymbol(key) : key);
 }
diff --git a/packages/compiler/test/decorators/decorators.test.ts b/packages/compiler/test/decorators/decorators.test.ts
@@ -569,6 +569,17 @@ describe("compiler: built-in decorators", () => {
       strictEqual(getKeyName(runner.program, prop), "alternateName");
     });
 
+    it("getKeyName returns undefined if used on property not annotated with @key", async () => {
+      const { prop } = await runner.compile(
+        `model M {
+          @test prop: string;
+        }`,
+      );
+
+      strictEqual(prop.kind, "ModelProperty" as const);
+      strictEqual(getKeyName(runner.program, prop), undefined);
+    });
+
     it("emits diagnostic when key property is marked as optional", async () => {
       const diagnostics = await runner.diagnose(
         `model M {

diff --git a/packages/rest/src/resource.ts b/packages/rest/src/resource.ts
@@ -109,7 +109,7 @@ function cloneKeyProperties(context: DecoratorContext, target: Model, resourceTy
   const resourceKey = getResourceTypeKey(program, resourceType);
   if (resourceKey) {
     const { keyProperty } = resourceKey;
-    const keyName = getKeyName(program, keyProperty);
+    const keyName = getKeyName(program, keyProperty)!;
 
     const decorators = [
       // Filter out the @visibility decorator because it might affect metadata

diff --git a/packages/rest/src/validate.ts b/packages/rest/src/validate.ts
@@ -24,7 +24,7 @@ function checkForDuplicateResourceKeyNames(program: Program) {
     while (currentType) {
       const resourceKey = getResourceTypeKey(program, currentType);
       if (resourceKey) {
-        const keyName = getKeyName(program, resourceKey.keyProperty);
+        const keyName = getKeyName(program, resourceKey.keyProperty)!;
         keyProperties.track(keyName, resourceKey);
       }