Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

V2: Update migration versions #1245

Merged
merged 2 commits into from
Sep 20, 2024
Merged

V2: Update migration versions #1245

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0dedf53
V2: Update migration versions
timostamm Sep 20, 2024
3903f43
Disable migration for connect-query-es
timostamm Sep 20, 2024
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
4 changes: 2 additions & 2 deletions packages/connect-migrate/src/cli.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ import { scan } from "./lib/scan";
import { Logger } from "./lib/logger";
import { v0_13_1 } from "./migrations/v0.13.1";
import { v2_0_0 } from "./migrations/v2.0.0";
import { v1_16_0 } from "./migrations/v1.16.0";
import { v1_6_0 } from "./migrations/v1.6.0";
import type { Migration } from "./migration";

const usage = `USAGE: connect-migrate [flags]
Expand All @@ -35,7 +35,7 @@ Flags:
`;

const logger = new Logger();
const migrations = [v0_13_1, v1_16_0, v2_0_0];
const migrations = [v0_13_1, v1_6_0, v2_0_0];
void main();

async function main() {
Expand Down
2 changes: 1 addition & 1 deletion packages/connect-migrate/src/migrations/v0.13.1.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ describe("migration to v0.13.1", function () {
expect(packageJsonWritten.length).toBe(1);
expect(packageJsonWritten[0].pkg).toEqual({
dependencies: {
"@connectrpc/connect": "^1.1.2",
"@connectrpc/connect": "^1.6.0",
},
});
expect(lockFilesUpdated.length).toBe(1);
Expand Down
4 changes: 2 additions & 2 deletions packages/connect-migrate/src/migrations/v0.13.1.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ import {
import { migratePackages } from "../lib/migrate-packages";
import { migrateLockFiles } from "../lib/migrate-lock-files";

export const targetVersionConnectEs = "1.1.2";
export const targetVersionConnectQuery = "0.5.1";
export const targetVersionConnectEs = "1.6.0";
export const targetVersionConnectQuery = "1.4.2";

/**
* The latest available version of protoc-gen-connect-web is v0.11.0.
Expand Down
2 changes: 1 addition & 1 deletion .../src/migrations/v1.16.0-transform.spec.ts → ...e/src/migrations/v1.6.0-transform.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
// limitations under the License.

import jscodeshift from "jscodeshift";
import transform from "./v1.16.0-transform";
import transform from "./v1.6.0-transform";

function t(
source: string,
Expand Down
0 ...grate/src/migrations/v1.16.0-transform.ts → ...igrate/src/migrations/v1.6.0-transform.ts
View file
Open in desktop
File renamed without changes.
20 changes: 10 additions & 10 deletions ...ct-migrate/src/migrations/v1.16.0.spec.ts → ...ect-migrate/src/migrations/v1.6.0.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
// See the License for the specific language governing permissions and
// limitations under the License.

import { v1_16_0 } from "./v1.16.0";
import { v1_6_0 } from "./v1.6.0";
import type { PackageJson } from "../lib/package-json";
import type { MigrateOptions } from "../migration";

Expand Down Expand Up @@ -55,20 +55,20 @@ describe("migration", function () {
};
});
describe("should be applicable", function () {
it("for 1.16.0", () => {
it("for 1.6.0", () => {
opt.scanned.packageFiles = [
{
path: "package.json",
pkg: {
dependencies: {
"@connectrpc/connect": "^1.16.0",
"@connectrpc/connect": "^1.6.0",
},
},
},
];
expect(v1_16_0.applicable(opt.scanned)).toBeTrue();
expect(v1_6_0.applicable(opt.scanned)).toBeTrue();
});
it("after 1.16.0", () => {
it("after 1.6.0", () => {
opt.scanned.packageFiles = [
{
path: "package.json",
Expand All @@ -79,20 +79,20 @@ describe("migration", function () {
},
},
];
expect(v1_16_0.applicable(opt.scanned)).toBeTrue();
expect(v1_6_0.applicable(opt.scanned)).toBeTrue();
});
it("before 1.16.0", () => {
it("before 1.6.0", () => {
opt.scanned.packageFiles = [
{
path: "package.json",
pkg: {
dependencies: {
"@connectrpc/connect": "^1.15.0",
"@connectrpc/connect": "^1.5.0",
},
},
},
];
expect(v1_16_0.applicable(opt.scanned)).toBeTrue();
expect(v1_6_0.applicable(opt.scanned)).toBeTrue();
});
});
describe("should not be applicable", function () {
Expand All @@ -107,7 +107,7 @@ describe("migration", function () {
},
},
];
expect(v1_16_0.applicable(opt.scanned)).toBeFalse();
expect(v1_6_0.applicable(opt.scanned)).toBeFalse();
});
});
});
4 changes: 2 additions & 2 deletions ...connect-migrate/src/migrations/v1.16.0.ts → .../connect-migrate/src/migrations/v1.6.0.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
// limitations under the License.

import type { Scanned } from "../lib/scan";
import replaceCalls from "./v1.16.0-transform";
import replaceCalls from "./v1.6.0-transform";
import type { MigrateError, MigrateSuccess, Migration } from "../migration";
import {
migrateSourceFiles,
Expand All @@ -25,7 +25,7 @@ import * as semver from "semver";
* Migrates code to use new symbols `createClient` and `Client` instead
* of `createPromiseClient` and `PromiseClient`.
*/
export const v1_16_0: Migration = {
export const v1_6_0: Migration = {
applicable(scanned: Scanned) {
return getMatchingPackages(scanned.packageFiles).length > 0;
},
Expand Down
121 changes: 60 additions & 61 deletions packages/connect-migrate/src/migrations/v2.0.0.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ plugins:
expect(bufGenYamlWritten.length).toBe(1);
expect(bufGenYamlWritten[0]?.yaml).toEqual(`version: v2
plugins:
- remote: buf.build/bufbuild/es:v2.0.0
- remote: buf.build/bufbuild/es:v2.1.0
out: src/gen
`);
});
Expand Down Expand Up @@ -193,62 +193,63 @@ plugins:
`);
});
});
describe("for connect-query-es v1", () => {
beforeEach(function () {
opt.scanned.packageFiles = [
{
path: "package.json",
pkg: {
dependencies: {
"@connectrpc/connect-query": "^1.4.1",
"@connectrpc/protoc-gen-connect-query": "^1.4.1",
},
},
},
];
opt.scanned.bufGenYamlFiles = [
{
path: "buf.gen.yaml",
yaml: parseBufGenYaml(
`version: v2
plugins:
- remote: buf.build/connectrpc/query-es:v1.4.1
out: src/gen
`,
),
},
];
});
it("should be applicable", () => {
expect(v2_0_0.applicable(opt.scanned)).toBeTrue();
});
it("should migrate packages", () => {
const result = v2_0_0.migrate(opt);
expect(result).toEqual({
ok: true,
});
expect(packageJsonWritten.length).toBe(1);
expect(packageJsonWritten[0].pkg).toEqual({
dependencies: {
"@connectrpc/connect-query": `^${targetVersionConnectQuery}`,
"@connectrpc/protoc-gen-connect-query": `^${targetVersionConnectQuery}`,
},
});
expect(lockFilesUpdated.length).toBe(1);
});
it("should migrate buf.gen.yaml", () => {
const result = v2_0_0.migrate(opt);
expect(result).toEqual({
ok: true,
});
expect(bufGenYamlWritten.length).toBe(1);
expect(bufGenYamlWritten[0]?.yaml).toEqual(`version: v2
plugins:
- remote: buf.build/connectrpc/query-es:v2.0.0
out: src/gen
`);
});
});
// TODO
// describe("for connect-query-es v1", () => {
// beforeEach(function () {
// opt.scanned.packageFiles = [
// {
// path: "package.json",
// pkg: {
// dependencies: {
// "@connectrpc/connect-query": "^1.4.2",
// "@connectrpc/protoc-gen-connect-query": "^1.4.2",
// },
// },
// },
// ];
// opt.scanned.bufGenYamlFiles = [
// {
// path: "buf.gen.yaml",
// yaml: parseBufGenYaml(
// `version: v2
// plugins:
// - remote: buf.build/connectrpc/query-es:v1.4.1
// out: src/gen
// `,
// ),
// },
// ];
// });
// it("should be applicable", () => {
// expect(v2_0_0.applicable(opt.scanned)).toBeTrue();
// });
// it("should migrate packages", () => {
// const result = v2_0_0.migrate(opt);
// expect(result).toEqual({
// ok: true,
// });
// expect(packageJsonWritten.length).toBe(1);
// expect(packageJsonWritten[0].pkg).toEqual({
// dependencies: {
// "@connectrpc/connect-query": `^${targetVersionConnectQuery}`,
// "@connectrpc/protoc-gen-connect-query": `^${targetVersionConnectQuery}`,
// },
// });
// expect(lockFilesUpdated.length).toBe(1);
// });
// it("should migrate buf.gen.yaml", () => {
// const result = v2_0_0.migrate(opt);
// expect(result).toEqual({
// ok: true,
// });
// expect(bufGenYamlWritten.length).toBe(1);
// expect(bufGenYamlWritten[0]?.yaml).toEqual(`version: v2
// plugins:
// - remote: buf.build/connectrpc/query-es:v1.4.2
// out: src/gen
// `);
// });
// });
describe("for connect-playwright-es v1", () => {
beforeEach(function () {
opt.scanned.packageFiles = [
Expand Down Expand Up @@ -300,7 +301,6 @@ plugins:

"@connectrpc/connect-query": `^${targetVersionConnectQuery}`,
"@connectrpc/protoc-gen-connect-query": `^${targetVersionConnectQuery}`,
"@connectrpc/protoc-gen-connect-query-react": `^${targetVersionConnectQuery}`,

"@connectrpc/connect-playwright": `^${targetVersionConnectPlaywright}`,
},
Expand All @@ -322,7 +322,7 @@ plugins:
out: src/gen
- remote: buf.build/bufbuild/es:v2.0.0
out: src/gen
- remote: buf.build/connectrpc/query-es:v2.0.0
- remote: buf.build/connectrpc/query-es:v1.4.2
out: src/gen
`,
"buf.gen.yaml",
Expand All @@ -342,7 +342,7 @@ plugins:
out: src/gen
- plugin: buf.build/bufbuild/es:v2.0.0
out: src/gen
- plugin: buf.build/connectrpc/query-es:v2.0.0
- plugin: buf.build/connectrpc/query-es:v1.4.2
out: src/gen
`,
),
Expand Down Expand Up @@ -418,7 +418,6 @@ plugins:
dependencies: {
"@bufbuild/connect-query": "*",
"@bufbuild/protoc-gen-connect-query": "*",
"@bufbuild/protoc-gen-connect-query-react": "*",
},
},
},
Expand Down
42 changes: 19 additions & 23 deletions packages/connect-migrate/src/migrations/v2.0.0.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,10 @@ import {
} from "../lib/migrate-bufgenyaml";
import { writeBufGenYamlFile } from "../lib/bufgenyaml";

export const targetVersionProtobufEs = "2.0.0-beta.3";
export const targetVersionConnectEs = "2.0.0-alpha.1";
export const targetVersionConnectQuery = "2.0.0-alpha.1";
export const targetVersionConnectPlaywright = "0.4.0";
export const targetVersionProtobufEs = "2.1.0";
export const targetVersionConnectEs = "2.0.0-alpha.1"; // TODO
export const targetVersionConnectQuery = "2.0.0"; // TODO
export const targetVersionConnectPlaywright = "0.4.0"; // TODO

const dependencyMigrations: DependencyMigration[] = [
// https://github.com/bufbuild/protobuf-es
Expand Down Expand Up @@ -83,15 +83,16 @@ const dependencyMigrations: DependencyMigration[] = [
remove: { name: "@connectrpc/protoc-gen-connect-es", range: "^1.0.0" },
},

// https://github.com/connectrpc/connect-query-es
{
from: { name: "@connectrpc/connect-query", range: "^1.0.0" },
to: { version: targetVersionConnectQuery },
},
{
from: { name: "@connectrpc/protoc-gen-connect-query", range: "^1.0.0" },
to: { version: targetVersionConnectQuery },
},
// TODO
// // https://github.com/connectrpc/connect-query-es
// {
// from: { name: "@connectrpc/connect-query", range: "^1.0.0" },
// to: { version: targetVersionConnectQuery },
// },
// {
// from: { name: "@connectrpc/protoc-gen-connect-query", range: "^1.0.0" },
// to: { version: targetVersionConnectQuery },
// },

// https://github.com/connectrpc/connect-playwright-es
{
Expand All @@ -111,21 +112,14 @@ const bufGenYamlMigrations: BufGenYamlMigration[] = [
updatePlugin: {
remote: "buf.build/bufbuild/es",
from: "^1.0.0",
to: "2.0.0",
},
},
{
updatePlugin: {
remote: "buf.build/connectrpc/es",
from: "^1.0.0",
to: "2.0.0",
to: targetVersionProtobufEs,
},
},
{
updatePlugin: {
remote: "buf.build/connectrpc/query-es",
from: "^1.0.0",
to: "2.0.0",
to: "1.4.2", // TODO
},
},
];
Expand All @@ -140,7 +134,9 @@ export const v2_0_0: Migration = {
({ yaml }) => migrateBufGenYaml(yaml, bufGenYamlMigrations) !== null,
) ||
scanned.packageFiles.some(
({ pkg }) => migrateDependencies(pkg, dependencyMigrations) !== null,
({ pkg }) =>
migrateDependencies(structuredClone(pkg), dependencyMigrations) !==
null,
)
);
},
Expand Down