Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"changes": [
{
"packageName": "@typespec/openapi3",
"comment": "",
"type": "none"
}
],
"packageName": "@typespec/openapi3"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"changes": [
{
"packageName": "@typespec/versioning",
"comment": "Raise error if versioned spec specifies a single service version.",
"type": "none"
}
],
"packageName": "@typespec/versioning"
}
2 changes: 1 addition & 1 deletion packages/openapi3/test/versioning.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ describe("openapi3: versioning", () => {
const { v1, v2, v3 } = await openApiFor(
`
@versioned(Versions)
@service({title: "My Service", version: "hi"})
@service({title: "My Service"})
namespace MyService {
enum Versions {
@useDependency(MyLibrary.Versions.A)
Expand Down
6 changes: 6 additions & 0 deletions packages/versioning/src/lib.ts
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,12 @@ const libDef = {
default: "@renamedFrom.oldName cannot be empty string.",
},
},
"no-service-fixed-version": {
severity: "error",
messages: {
default: paramMessage`Namespace '${"name"}' cannot specify a fixed service version with @service({version: ${"version"}}) while using @versioned. Remove the version argument from @service.`,
},
},
"incompatible-versioned-reference": {
severity: "error",
messages: {
Expand Down
13 changes: 13 additions & 0 deletions packages/versioning/src/validate.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import {
getNamespaceFullName,
getService,
getTypeName,
isTemplateInstance,
Namespace,
Expand Down Expand Up @@ -93,6 +94,18 @@ export function $onValidate(program: Program) {
}
},
namespace: (namespace) => {
const [_, versionMap] = getVersions(program, namespace);
const serviceProps = getService(program, namespace);
if (serviceProps?.version !== undefined && versionMap !== undefined) {
reportDiagnostic(program, {
code: "no-service-fixed-version",
format: {
name: getNamespaceFullName(namespace),
version: serviceProps.version,
},
target: namespace,
});
}
const versionedNamespace = findVersionedNamespace(program, namespace);
const dependencies = getVersionDependencies(program, namespace);
if (dependencies === undefined) {
Expand Down
37 changes: 37 additions & 0 deletions packages/versioning/test/incompatible-versioning.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,43 @@ import {
} from "@typespec/compiler/testing";
import { createVersioningTestHost, createVersioningTestRunner } from "./test-host.js";

describe("versioning: incompatible use of decorators", () => {
let runner: BasicTestRunner;
let host: TestHost;
const imports: string[] = [];

beforeEach(async () => {
host = await createVersioningTestHost();
runner = createTestWrapper(host, {
wrapper: (code) => `
import "@typespec/versioning";
${imports.map((i) => `import "${i}";`).join("\n")}
using TypeSpec.Versioning;
${code}`,
});
});

it("emit diagnostic when @service({version: 'X'}) is used with @versioned", async () => {
const diagnostics = await runner.diagnose(`
@versioned(Versions)
@service({
title: "Widget Service",
version: "v3"
})
namespace DemoService;

enum Versions {
v1,
v2,
}
`);
expectDiagnostics(diagnostics, {
code: "@typespec/versioning/no-service-fixed-version",
severity: "error",
});
});
});

describe("versioning: validate incompatible references", () => {
let runner: BasicTestRunner;
let host: TestHost;
Expand Down