Skip to content

Only allow directories to be passed to crashlytics sourcemap upload #10472

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
tonybaroneee wants to merge 1 commit into
base: crashlytics2
Choose a base branch
from
+52 −46
Open

Only allow directories to be passed to crashlytics sourcemap upload #10472

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
78 changes: 49 additions & 29 deletions src/commands/crashlytics-sourcemap-upload.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ describe("crashlytics:sourcemap:upload", () => {
});

it("should create the default cloud storage bucket", async () => {
await command.runner()(FILE_PATH, {
await command.runner()(DIR_PATH, {
app: "test-app",
});
expect(gcsMock.upsertBucket).to.be.calledOnce;
Expand All @@ -86,7 +86,7 @@ describe("crashlytics:sourcemap:upload", () => {
app: "test-app",
bucketLocation: "a-different-LoCaTiOn",
};
await command.runner()(FILE_PATH, options);
await command.runner()(DIR_PATH, options);
expect(gcsMock.upsertBucket).to.be.calledOnce;
const args = gcsMock.upsertBucket.firstCall.args;
expect(args[0].req.baseName).to.equal(
Expand All @@ -100,18 +100,15 @@ describe("crashlytics:sourcemap:upload", () => {
command.runner()("invalid/path", {
app: "test-app",
}),
).to.be.rejectedWith(FirebaseError, "provide a valid file path or directory");
).to.be.rejectedWith(FirebaseError, "provide a valid directory to mapping file(s)");
});

it("should upload a single mapping file", async () => {
await command.runner()(FILE_PATH, {
app: "test-app",
});
expect(gcsMock.uploadObject).to.be.calledOnce;
expect(gcsMock.uploadObject).to.be.calledWith(sinon.match.any, BUCKET_NAME);
expect(gcsMock.uploadObject.firstCall.args[0].file).to.match(
/test-app-.*-src-test-fixtures-mapping-files-mock_mapping\.js\.map\.zip/,
);
it("should throw an error if the mapping file path is not a directory", async () => {
expect(
command.runner()(FILE_PATH, {
app: "test-app",
}),
).to.be.rejectedWith(FirebaseError, "provide a valid directory to mapping file(s)");
});

it("should find and upload mapping files in a directory", async () => {
Expand Down Expand Up @@ -182,20 +179,28 @@ describe("crashlytics:sourcemap:upload", () => {
});

it("should use the provided app version", async () => {
await command.runner()(FILE_PATH, {
await command.runner()(DIR_PATH, {
app: "test-app",
appVersion: "1.0.0",
});
expect(gcsMock.uploadObject.firstCall.args[0].file).to.eq(
const uploadedFiles = gcsMock.uploadObject
.getCalls()
.map((call) => call.args[0].file)
.sort();
expect(uploadedFiles[0]).to.eq(
"test-app-1.0.0-src-test-fixtures-mapping-files-mock_mapping.js.map.zip",
);
});

it("should fall back to the git commit for app version", async () => {
await command.runner()(FILE_PATH, {
await command.runner()(DIR_PATH, {
app: "test-app",
});
expect(gcsMock.uploadObject.firstCall.args[0].file).to.match(
const uploadedFiles = gcsMock.uploadObject
.getCalls()
.map((call) => call.args[0].file)
.sort();
expect(uploadedFiles[0]).to.match(
/test-app-a{40}-src-test-fixtures-mapping-files-mock_mapping.js.map.zip/,
);
});
Expand All @@ -206,10 +211,14 @@ describe("crashlytics:sourcemap:upload", () => {
commandExistsSyncStub.withArgs("npm").returns(true);
execSyncStub.withArgs("npm pkg get version").returns(Buffer.from("1.2.3"));

await command.runner()(FILE_PATH, {
await command.runner()(DIR_PATH, {
app: "test-app",
});
expect(gcsMock.uploadObject.firstCall.args[0].file).to.eq(
const uploadedFiles = gcsMock.uploadObject
.getCalls()
.map((call) => call.args[0].file)
.sort();
expect(uploadedFiles[0]).to.eq(
"test-app-1.2.3-src-test-fixtures-mapping-files-mock_mapping.js.map.zip",
);
});
Expand All @@ -218,38 +227,49 @@ describe("crashlytics:sourcemap:upload", () => {
commandExistsSyncStub.withArgs("git").returns(false);
commandExistsSyncStub.withArgs("npm").returns(false);

await command.runner()(FILE_PATH, {
await command.runner()(DIR_PATH, {
app: "test-app",
});
expect(gcsMock.uploadObject.firstCall.args[0].file).to.eq(
const uploadedFiles = gcsMock.uploadObject
.getCalls()
.map((call) => call.args[0].file)
.sort();
expect(uploadedFiles[0]).to.eq(
"test-app-unset-src-test-fixtures-mapping-files-mock_mapping.js.map.zip",
);
});

it("should register the source map after upload", async () => {
await command.runner()(FILE_PATH, {
await command.runner()(DIR_PATH, {
app: "test-app",
});
expect(clientPatchStub).to.be.calledOnce;
const args = clientPatchStub.firstCall.args;
expect(args[0]).to.match(/projects\/test-project\/locations\/global\/mappingFiles\/2906062618/);
expect(args[1]).to.deep.equal({
expect(clientPatchStub).to.be.calledTwice;
const payloads = clientPatchStub
.getCalls()
.map((call) => call.args[1])
.sort((a, b) => a.obfuscatedFilePath.localeCompare(b.obfuscatedFilePath));
expect(payloads[0].name).to.match(
/projects\/test-project\/locations\/global\/mappingFiles\/2906062618/,
);
expect(payloads[0]).to.deep.equal({
name: "projects/test-project/locations/global/mappingFiles/2906062618",
appId: "test-app",
version: "a".repeat(40),
obfuscatedFilePath: "/src/test/fixtures/mapping-files/mock_mapping.js.map",
fileUri: `gs://${BUCKET_NAME}/test-object`,
});
expect(args[2].queryParams).to.deep.equal({ allowMissing: "true" });
expect(clientPatchStub.firstCall.args[2].queryParams).to.deep.equal({ allowMissing: "true" });
Comment thread
tonybaroneee marked this conversation as resolved.
});

it("should warn if registration fails", async () => {
clientPatchStub.rejects(new Error("Registration failed"));
await command.runner()(FILE_PATH, {
await command.runner()(DIR_PATH, {
app: "test-app",
retryDelay: 10,
});
expect(clientPatchStub).to.be.calledOnce;
expect(logLabeledWarningStub).to.be.calledOnceWith(
expect(clientPatchStub.callCount).to.equal(4);
expect(logLabeledWarningStub).to.be.calledTwice;
expect(logLabeledWarningStub).to.be.calledWith(
"crashlytics",
sinon.match(/Failed to upload mapping file/),
);
Comment thread
tonybaroneee marked this conversation as resolved.
Expand Down
20 changes: 3 additions & 17 deletions src/commands/crashlytics-sourcemap-upload.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,26 +81,12 @@ export const command = new Command("crashlytics:sourcemap:upload [mappingFiles]"
fstat = statSync(filePath);
} catch (e) {
throw new FirebaseError(
"provide a valid file path or directory to mapping file(s), e.g. app/build/outputs/app.js.map or app/build/outputs",
"provide a valid directory to mapping file(s), e.g. app/build/outputs",
);
}
let successCount = 0;
const failedFiles: string[] = [];
if (fstat.isFile()) {
const success = await uploadMap({
projectId,
mappingFile: filePath,
obfuscatedFilePath: filePath,
bucketName,
appVersion,
options,
});
if (success) {
successCount++;
} else {
failedFiles.push(filePath);
}
} else if (fstat.isDirectory()) {
if (fstat.isDirectory()) {
logLabeledBullet("crashlytics", "Looking for mapping files in your directory...");
const files = await readdirRecursive({
path: filePath,
Expand Down Expand Up @@ -142,7 +128,7 @@ export const command = new Command("crashlytics:sourcemap:upload [mappingFiles]"
});
} else {
throw new FirebaseError(
"provide a valid file path or directory to mapping file(s), e.g. app/build/outputs/app.js.map or app/build/outputs",
"provide a valid directory to mapping file(s), e.g. app/build/outputs",
);
}
logLabeledBullet(
Expand Down
Loading