storage: acl: refactor #360

stephenplusplus · 2015-01-21T19:05:28Z

Fixes #351

This introduces support for a nicer API to ACL manipulations. The new methods are broken into groups representing a permission level, owners, readers, and writers. Each group has access methods to add or delete various entities: allAuthenticatedUsers, allUsers, domains, groups, projects, and users.

The full list of methods:

var acl = (myFile || myBucket).(acl || acl.default).(owners || readers || writers);

acl.addAllAuthenticatedUsers(function(err, aclObject) {});
acl.deleteAllAuthenticatedUsers(function(err) {});

acl.addAllUsers(function(err, aclObject) {});
acl.deleteAllUsers(function(err) {});

acl.addDomain(function(err, aclObject) {});
acl.deleteDomain(function(err) {});

acl.addGroup(function(err, aclObject) {});
acl.deleteGroup(function(err) {});

acl.addProject(function(err, aclObject) {});
acl.deleteProject(function(err) {});

acl.addUser(function(err, aclObject) {});
acl.deleteUser(function(err) {});

Additionally, a couple methods were added to simplify common operations; making a bucket or file publicly readable or the inverse.

(myFile || myBucket).makePrivate(function(err) {});
(myFile || myBucket).makePublic(function(err) {});

This will run setMetadata with a predefinedAcl value set to private or publicRead.

lib/storage/acl.js

 * Transform API responses to a consistent object format.
 *
 * @private
 */
 Acl.prototype.makeAclObject_ = function(accessControlObject) {
  var obj = {
-    scope: accessControlObject.scope,
+    scope: accessControlObject.entity,


ryanseys · 2015-01-21T20:20:02Z

hmm... do you like delete or remove more? I'm feeling remove more because acl.writers.removeUser sounds more realistic than acl.writers.deleteUser but because we already have delete it might make sense to keep it that way... tough call.

stephenplusplus · 2015-01-21T20:24:41Z

I prefer delete for consistency across our library. Files, buckets, datasets, etc. are all deleted, and as you pointed out, we have acl.delete as well.

ryanseys · 2015-01-21T20:25:39Z

Works for me! I've been writing too much ruby recently.

stephenplusplus · 2015-01-21T20:26:05Z

ha_ha()

ryanseys · 2015-01-21T20:28:55Z

ha_ha()

No brackets necessary.

stephenplusplus · 2015-01-21T20:29:46Z

I think we have PR review inception here.

lib/storage/acl.js

+
+        that[accessMethod]({
+          scope: scope,
+          role: role


ryanseys · 2015-01-21T21:08:38Z

Looks good to me :)

lib/storage/acl.js

+ * @alias acl.makePublic
+ *
+ * @example
+ * myBucket.acl.makePublic(function(err, aclObject) {});


ryanseys · 2015-01-21T21:32:17Z

I think this is acceptable for merge. Should probably wait for sign-off by @jgeewax for the makePrivate and makePublic however.

stephenplusplus · 2015-01-22T20:20:00Z

Updated makePublic() and makePrivate(): stephenplusplus@fd35f27

They are now on the File and Bucket object themselves.

ryanseys · 2015-01-23T16:17:59Z

Is this ready for another look?

stephenplusplus · 2015-01-23T16:28:34Z

Yes, and I should have explained the new makePublic() and makePrivate() methods use a shorthand "predefinedAcl" value that Ryan found. When a user makes an object public or private, it updates the "predefinedAcl" value as a metadata request to publicRead or private.

test/storage/acl.js

@@ -20,7 +20,8 @@

 var Acl = require('../../lib/storage/acl.js');
 var assert = require('assert');
-var storage = require('../../lib/storage/index.js');
+var async = require('async');
+var Storage = require('../../lib/storage/index.js');


ryanseys · 2015-01-27T15:43:25Z

@stephenplusplus For now, you should just remove makePublic and makePrivate and we can land these changes. Those methods are going to be more troublesome and are special cases and thus should be treated separately.

stephenplusplus · 2015-01-27T15:49:06Z

Sounds good. 👍

jgeewax · 2015-01-27T15:52:49Z

Cool - can we create a ticket to make sure we don't forget those two methods?

ryanseys · 2015-01-27T16:07:57Z

@jgeewax Done: #364

stephenplusplus · 2015-01-27T16:29:48Z

This is now updated to remove makePublic() and makePrivate() as well as change scope -> entity.

lib/storage/acl.js

  this.makeReq = options.makeReq;
  this.pathPrefix = options.pathPrefix;
 }

 /**
+ * A convenience object of methods to add or delete ACL permissions from an


This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [@types/mocha](https://github.com/DefinitelyTyped/DefinitelyTyped) | devDependencies | major | [`^7.0.0` -> `^8.0.0`](https://renovatebot.com/diffs/npm/@types%2fmocha/7.0.2/8.0.0) | --- ### Renovate configuration :date: **Schedule**: "after 9am and before 3pm" (UTC). :vertical_traffic_light: **Automerge**: Disabled by config. Please merge this manually once you are satisfied. :recycle: **Rebasing**: Whenever PR is behind base branch, or you tick the rebase/retry checkbox. :no_bell: **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [WhiteSource Renovate](https://renovate.whitesourcesoftware.com). View repository job log [here](https://app.renovatebot.com/dashboard#googleapis/nodejs-cloud-container).

* feat: monitoring conversion by delete js file and add ts from generator * upgrade package.json * fixed samples test by modify the matched path * prelint, add eslint for samples test * fix upstream proto links, get rid of synth hack Co-authored-by: Benjamin E. Coe <bencoe@google.com>

gcr.io/repo-automation-bots/owlbot-nodejs:latest@sha256:f93bb861d6f12574437bb9aee426b71eafd63b419669ff0ed029f4b7e7162e3f

Update .repo-metadata.json as required by go/library-data-integrity

* chore(main): release 4.1.1 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com> Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>

This PR was generated using Autosynth. 🌈 Synth log will be available here: https://source.cloud.google.com/results/invocations/cc99acfa-05b8-434b-9500-2f6faf2eaa02/targets - [ ] To automatically regenerate this PR, check this box. Source-Link: googleapis/synthtool@799d8e6

Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>

This PR was generated using Autosynth. 🌈 Synth log will be available here: https://source.cloud.google.com/results/invocations/cb5a7bf7-f080-4698-bd24-ff5880d64fc8/targets - [ ] To automatically regenerate this PR, check this box. PiperOrigin-RevId: 361273630 Source-Link: googleapis/googleapis@5477122

[![WhiteSource Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [sinon](https://sinonjs.org/) ([source](https://github.com/sinonjs/sinon)) | [`^13.0.0` -> `^14.0.0`](https://renovatebot.com/diffs/npm/sinon/13.0.2/14.0.0) | [![age](https://badges.renovateapi.com/packages/npm/sinon/14.0.0/age-slim)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://badges.renovateapi.com/packages/npm/sinon/14.0.0/adoption-slim)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://badges.renovateapi.com/packages/npm/sinon/14.0.0/compatibility-slim/13.0.2)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://badges.renovateapi.com/packages/npm/sinon/14.0.0/confidence-slim/13.0.2)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>sinonjs/sinon</summary> ### [`v14.0.0`](https://github.com/sinonjs/sinon/blob/HEAD/CHANGES.md#1400) [Compare Source](https://github.com/sinonjs/sinon/compare/v13.0.2...v14.0.0) - [`c2bbd826`](https://github.com/sinonjs/sinon/commit/c2bbd82641444eb5b32822489ae40f185afbbf00) Drop node 12 (Morgan Roderick) > And embrace Node 18 > > See https://nodejs.org/en/about/releases/ *Released by Morgan Roderick on 2022-05-07.* </details> --- ### Configuration 📅 **Schedule**: "after 9am and before 3pm" (UTC). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR is behind base branch, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, click this checkbox. --- This PR has been generated by [WhiteSource Renovate](https://renovate.whitesourcesoftware.com). View repository job log [here](https://app.renovatebot.com/dashboard#github/googleapis/nodejs-datacatalog).

This PR was generated using Autosynth. 🌈 <details><summary>Log from Synthtool</summary> ``` 2020-03-22 04:26:07,149 synthtool > Executing /tmpfs/src/git/autosynth/working_repo/synth.py. .eslintignore .eslintrc.yml .github/ISSUE_TEMPLATE/bug_report.md .github/ISSUE_TEMPLATE/feature_request.md .github/ISSUE_TEMPLATE/support_request.md .github/PULL_REQUEST_TEMPLATE.md .github/publish.yml .github/release-please.yml .github/workflows/ci.yaml .kokoro/common.cfg .kokoro/continuous/node10/common.cfg .kokoro/continuous/node10/docs.cfg .kokoro/continuous/node10/lint.cfg .kokoro/continuous/node10/samples-test.cfg .kokoro/continuous/node10/system-test.cfg .kokoro/continuous/node10/test.cfg .kokoro/continuous/node12/common.cfg .kokoro/continuous/node12/test.cfg .kokoro/continuous/node8/common.cfg .kokoro/continuous/node8/test.cfg .kokoro/docs.sh .kokoro/lint.sh .kokoro/presubmit/node10/common.cfg .kokoro/presubmit/node10/docs.cfg .kokoro/presubmit/node10/lint.cfg .kokoro/presubmit/node10/samples-test.cfg .kokoro/presubmit/node10/system-test.cfg .kokoro/presubmit/node10/test.cfg .kokoro/presubmit/node12/common.cfg .kokoro/presubmit/node12/test.cfg .kokoro/presubmit/node8/common.cfg .kokoro/presubmit/node8/test.cfg .kokoro/presubmit/windows/common.cfg .kokoro/presubmit/windows/test.cfg .kokoro/publish.sh .kokoro/release/docs.cfg .kokoro/release/docs.sh .kokoro/release/publish.cfg .kokoro/samples-test.sh .kokoro/system-test.sh .kokoro/test.bat .kokoro/test.sh .kokoro/trampoline.sh .mocharc.js .nycrc .prettierignore .prettierrc CODE_OF_CONDUCT.md CONTRIBUTING.md LICENSE README.md codecov.yaml renovate.json samples/README.md 2020-03-22 04:26:07,632 synthtool > Wrote metadata to synth.metadata. ``` </details>

googlebot added the cla: yes This human has signed the Contributor License Agreement. label Jan 21, 2015

stephenplusplus force-pushed the spp--storage-acl-refactor branch from b0c41f6 to 32590bb Compare January 21, 2015 19:09

stephenplusplus reviewed Jan 21, 2015
View reviewed changes

stephenplusplus added the api: storage Issues related to the Cloud Storage API. label Jan 21, 2015

ryanseys reviewed Jan 21, 2015
View reviewed changes

lib/storage/acl.js

that[accessMethod]({

scope: scope,

role: role

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

ryanseys reviewed Jan 21, 2015
View reviewed changes

jgeewax reviewed Jan 23, 2015
View reviewed changes

ryanseys mentioned this pull request Jan 27, 2015

makePublic and makePrivate for buckets and files. #364

Closed

ryanseys reviewed Jan 30, 2015
View reviewed changes

lib/storage/acl.js

this.makeReq = options.makeReq;

this.pathPrefix = options.pathPrefix;

}

/**

* A convenience object of methods to add or delete ACL permissions from an

This comment was marked as spam.

Sign in to view

sofisl mentioned this pull request Nov 11, 2022

migrate code from googleapis/nodejs-cloud-container #3543

Merged

4 tasks

This was referenced Nov 11, 2022

migrate code from googleapis/nodejs-iot #3544

Merged

migrate code from googleapis/nodejs-monitoring #3545

Merged

sofisl pushed a commit that referenced this pull request Nov 11, 2022

fix(deps): update dependency googleapis to v54 (#360)

57ecc84

sofisl mentioned this pull request Nov 11, 2022

migrate code from googleapis/nodejs-dialogflow #3546

Merged

4 tasks

sofisl pushed a commit that referenced this pull request Nov 11, 2022

build: ignore proto files in test coverage (#360)

33f9efe

sofisl mentioned this pull request Nov 11, 2022

migrate code from googleapis/nodejs-scheduler #3547

Merged

4 tasks

sofisl pushed a commit that referenced this pull request Nov 11, 2022

chore: new owl bot post processor docker image (#360)

e80f5e8

gcr.io/repo-automation-bots/owlbot-nodejs:latest@sha256:f93bb861d6f12574437bb9aee426b71eafd63b419669ff0ed029f4b7e7162e3f

sofisl mentioned this pull request Nov 11, 2022

migrate code from googleapis/nodejs-datalabeling #3548

Merged

4 tasks

sofisl pushed a commit that referenced this pull request Nov 11, 2022

chore: add api_shortname and library_type to repo metadata (#360)

663da98

Update .repo-metadata.json as required by go/library-data-integrity

sofisl mentioned this pull request Nov 11, 2022

migrate code from googleapis/nodejs-containeranalysis #3550

Merged

4 tasks

sofisl mentioned this pull request Nov 11, 2022

migrate code from googleapis/nodejs-grafeas #3551

Merged

4 tasks

This was referenced Nov 11, 2022

migrate code from googleapis/nodejs-asset #3567

Merged

migrate code from googleapis/nodejs-talent #3568

Merged

sofisl pushed a commit that referenced this pull request Nov 11, 2022

chore: release 3.4.0 (#360)

42431b4

Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>

sofisl mentioned this pull request Nov 18, 2022

migrate code from googleapis/nodejs-security-center #3669

Merged

4 tasks

sofisl mentioned this pull request Nov 30, 2022

migrate code from googleapis/nodejs-datacatalog #3689

Merged

4 tasks

sofisl mentioned this pull request Jan 17, 2023

migrate code from googleapis/nodejs-vision #3860

Merged

4 tasks

sofisl pushed a commit that referenced this pull request Jan 17, 2023

chore: update formatting for generated code (#360)

e25558b

sofisl pushed a commit that referenced this pull request Jan 24, 2023

refactor: drop dependency on lodash.merge and update links (#360)

628eae0

sofisl pushed a commit that referenced this pull request Jan 25, 2023

refactor: drop dependency on lodash.merge and update links (#360)

18aec33

sofisl mentioned this pull request Sep 14, 2023

migrate code from googleapis/nodejs-dns #4657

Merged

4 tasks

storage: acl: refactor #360

storage: acl: refactor #360

Conversation

stephenplusplus commented Jan 21, 2015

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

ryanseys commented Jan 21, 2015

stephenplusplus commented Jan 21, 2015

ryanseys commented Jan 21, 2015

stephenplusplus commented Jan 21, 2015

ryanseys commented Jan 21, 2015

stephenplusplus commented Jan 21, 2015

This comment was marked as spam.

This comment was marked as spam.

ryanseys commented Jan 21, 2015

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

ryanseys commented Jan 21, 2015

stephenplusplus commented Jan 22, 2015

ryanseys commented Jan 23, 2015

stephenplusplus commented Jan 23, 2015

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

ryanseys commented Jan 27, 2015

stephenplusplus commented Jan 27, 2015

jgeewax commented Jan 27, 2015

ryanseys commented Jan 27, 2015

stephenplusplus commented Jan 27, 2015

This comment was marked as spam.