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.

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

chore!: drop keepAcl parameter in file copy #1166

Merged
merged 3 commits into from May 13, 2020
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
20 changes: 0 additions & 20 deletions src/file.ts
Expand Up @@ -304,7 +304,6 @@ export interface FileOptions {

export interface CopyOptions {
destinationKmsKeyName?: string;
keepAcl?: string;
predefinedAcl?: string;
token?: string;
userProject?: string;
Expand Down Expand Up @@ -840,8 +839,6 @@ class File extends ServiceObject<File> {
* `projects/my-project/locations/location/keyRings/my-kr/cryptoKeys/my-key`,
* that will be used to encrypt the object. Overwrites the object
* metadata's `kms_key_name` value, if any.
* @property {string} [keepAcl] This parameter is not supported and will be
* removed in the next major.
* @property {string} [predefinedAcl] Set the ACL for the new file.
* @property {string} [token] A previously-returned `rewriteToken` from an
* unfinished rewrite request.
Expand Down Expand Up @@ -968,12 +965,6 @@ class File extends ServiceObject<File> {
options = optionsOrCallback;
}

// eslint-disable-next-line no-prototype-builtins
if (options.hasOwnProperty('keepAcl')) {
// TODO: remove keepAcl from interface in next major.
emitWarning();
}

options = extend(true, {}, options);
callback = callback || util.noop;

Expand Down Expand Up @@ -3623,17 +3614,6 @@ promisifyAll(File, {
exclude: ['request', 'setEncryptionKey'],
});

let warned = false;
export function emitWarning() {
if (!warned) {
warned = true;
process.emitWarning(
'keepAcl parameter is not supported and will be removed in the next major',
'DeprecationWarning'
);
}
}

/**
* Reference to the {@link File} class.
* @name module:@google-cloud/storage.File
Expand Down
59 changes: 0 additions & 59 deletions test/file.ts
Expand Up @@ -350,65 +350,6 @@ describe('File', () => {
});

describe('copy', () => {
describe('depricate `keepAcl`', () => {
// eslint-disable-next-line
let STORAGE2: any;
// eslint-disable-next-line
let BUCKET2: any;
// eslint-disable-next-line @typescript-eslint/no-explicit-any
let file2: any;
beforeEach(() => {
STORAGE2 = {
createBucket: util.noop,
request: util.noop,
// eslint-disable-next-line @typescript-eslint/no-explicit-any
makeAuthenticatedRequest(req: {}, callback: any) {
if (callback) {
(callback.onAuthenticated || callback)(null, req);
}
},
bucket(name: string) {
return new Bucket(this, name);
},
};
BUCKET2 = new Bucket(STORAGE, 'bucket-name');
file2 = new File(BUCKET, FILE_NAME);
});

it('should warn if `keepAcl` parameter is passed', done => {
file.request = util.noop;

// since --throw-deprication is enabled using try=>catch block
try {
file.copy('newFile', {keepAcl: 'private'}, assert.ifError);
} catch (err) {
assert.strictEqual(
err.message,
'keepAcl parameter is not supported and will be removed in the next major'
);
assert.strictEqual(err.name, 'DeprecationWarning');
done();
}
});

it('should warn only once `keepAcl` parameter is passed', done => {
file.request = util.noop;

// since --throw-deprication is enabled using try=>catch block
try {
file.copy('newFile', {keepAcl: 'private'}, assert.ifError);
} catch (err) {
assert.strictEqual(
err.message,
'keepAcl parameter is not supported and will be removed in the next major'
);
assert.strictEqual(err.name, 'DeprecationWarning');
}
file2.copy('newFile2', {keepAcl: 'private'}, assert.ifError);
done();
});
});

it('should throw if no destination is provided', () => {
assert.throws(() => {
file.copy();
Expand Down