Skip to content

fix(bigquery-firestore-export): remove unused service account plumbing #2957

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

Open
IzaakGough wants to merge 1 commit into
base: kits
Choose a base branch
from
Open

fix(bigquery-firestore-export): remove unused service account plumbing #2957

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
17 changes: 10 additions & 7 deletions kits/bigquery-firestore-export/src/dts.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,10 +65,16 @@ function stringField(value: string | undefined): { stringValue: string } {
return { stringValue: value ?? "" };
}

/** Creates the protobuf-shaped request used for a scheduled query. */
/**
* Creates the protobuf-shaped request used for a scheduled query.
*
* The query runs as whichever identity creates it, which is this function. To
* name a different account, `serviceAccountName` goes on the request rather
* than on the transfer config, and the caller needs `actAs` on the account it
* names, including its own.
*/
export function createTransferConfigRequest(
config: ResolvedBigqueryFirestoreExportConfig,
serviceAccountEmail?: string
config: ResolvedBigqueryFirestoreExportConfig
): bigqueryDataTransfer.protos.google.cloud.bigquery.datatransfer.v1.ICreateTransferConfigRequest {
return {
parent: `projects/${config.projectId}`,
Expand All @@ -88,9 +94,6 @@ export function createTransferConfigRequest(
},
schedule: config.schedule,
notificationPubsubTopic: `projects/${config.projectId}/topics/${config.pubSubTopic}`,
...(serviceAccountEmail
? { serviceAccountName: serviceAccountEmail }
: {}),
},
};
}
Expand Down Expand Up @@ -120,7 +123,7 @@ export async function createTransferConfig(
): Promise<TransferConfig> {
logs.createTransferConfig();
const [created] = await client.createTransferConfig(
createTransferConfigRequest(config, config.serviceAccount)
createTransferConfigRequest(config)
);
if (!created.name) {
throw new Error("BigQuery API returned a transfer config without a name");
Expand Down
4 changes: 0 additions & 4 deletions kits/bigquery-firestore-export/src/export-config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,6 @@ export interface BigqueryFirestoreExportConfig {
pubSubTopic?: string;
/** Root Firestore collection for configs and run output. */
firestoreCollection?: string;
/** Runtime identity used when creating a DTS config. */
serviceAccount?: string;
/** Log verbosity. Defaults to `info`. */
logLevel?: LogLevel;
}
Expand All @@ -65,7 +63,6 @@ export interface ResolvedBigqueryFirestoreExportConfig {
schedule: string;
pubSubTopic: string;
firestoreCollection: string;
serviceAccount?: string;
logLevel: LogLevel;
}

Expand Down Expand Up @@ -117,7 +114,6 @@ export function resolveConfig(
optional(config.pubSubTopic) ?? `kit-${instanceId}-processMessages`,
firestoreCollection:
optional(config.firestoreCollection) ?? "transferConfigs",
serviceAccount: optional(config.serviceAccount),
logLevel,
};
}
6 changes: 1 addition & 5 deletions kits/bigquery-firestore-export/tests/dts.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,10 +43,7 @@ function clientWithTransferConfig(transferConfig: object): DataTransferClient {

describe("createTransferConfigRequest", () => {
test("creates the scheduled-query request", () => {
const request = createTransferConfigRequest(
config,
"runtime@test-project.iam.gserviceaccount.com"
);
const request = createTransferConfigRequest(config);

expect(request).toMatchObject({
parent: "projects/test-project",
Expand All @@ -57,7 +54,6 @@ describe("createTransferConfigRequest", () => {
schedule: "every 24 hours",
notificationPubsubTopic:
"projects/test-project/topics/kit-users-export-processMessages",
serviceAccountName: "runtime@test-project.iam.gserviceaccount.com",
},
});
expect(
Expand Down
4 changes: 0 additions & 4 deletions kits/bigquery-firestore-export/tests/export-config.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,16 +46,12 @@ describe("resolveConfig", () => {
...minimal,
transferConfigName: " projects/p/locations/us/transferConfigs/c ",
partitioningField: " created_at ",
serviceAccount: " runtime@test-project.iam.gserviceaccount.com ",
});

expect(resolved.transferConfigName).toBe(
"projects/p/locations/us/transferConfigs/c"
);
expect(resolved.partitioningField).toBe("created_at");
expect(resolved.serviceAccount).toBe(
"runtime@test-project.iam.gserviceaccount.com"
);
});

test.each(["instanceId", "datasetId", "tableName", "queryString"] as const)(
Expand Down
Loading