move google-cloud/dlp to peer dependency

[tbjers]

The Google Cloud DLP package contains a lot of dependencies, as such, if it isn't actively used, it shouldn't be included in the dependencies. Moved to peer dependencies. For instance, when using redact-pii in a Lambda function, size increases by at least 10 MB from the Google Cloud DLP package.

[tbjers]

@chaitanya-solvvy @JaredBett Sorry for direct mention, not sure why checks aren't running on this PR to redact-pii.

[geekflyer]

I think there's one problem with that change.
The compiled lib/index.js which is being loaded when you require('redact-pii') contains:

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
const SyncCompositeRedactor_1 = require("./SyncCompositeRedactor");
exports.SyncRedactor = SyncCompositeRedactor_1.SyncCompositeRedactor;
const AsyncCompositeRedactor_1 = require("./AsyncCompositeRedactor");
exports.AsyncRedactor = AsyncCompositeRedactor_1.AsyncCompositeRedactor;
const GoogleDLPRedactor_1 = require("./custom/GoogleDLPRedactor");
exports.GoogleDLPRedactor = GoogleDLPRedactor_1.GoogleDLPRedactor;
//# sourceMappingURL=index.js.map

As you can see it also load the GoogleDLPRedactor in this entry point and I believe this will fail if google cloud dlp is not installed, even if it's not actively used.
So in order to really make the google cloud dlp stuff optional we have to also remove it from the module entrypoint (src/index.ts) and update the docs accordingly

[geekflyer]

as for the checks not running: This seems to be an unfortunate limitation of github actions as of right now. Seems like the creator of the PR (@tbjers) has to be also part of the beta in order for the actions to run (see https://github.community/t5/GitHub-API-Development-and/Run-a-GitHub-action-on-pull-request-for-PR-opened-from-a-forked/td-p/15426).
I'll find a way to run them myself or maybe manually once the MR is in good shape if you can't get into the actions beta until then.

[tbjers]

as for the checks not running: This seems to be an unfortunate limitation of github actions as of right now. Seems like the creator of the PR (@tbjers) has to be also part of the beta in order for the actions to run (see https://github.community/t5/GitHub-API-Development-and/Run-a-GitHub-action-on-pull-request-for-PR-opened-from-a-forked/td-p/15426).
I'll find a way to run them myself or maybe manually once the MR is in good shape if you can't get into the actions beta until then.

@geekflyer I think I am part of the beta now. I can see the Actions tab on a few of my repos.

[tbjers]

I think there's one problem with that change.
The compiled lib/index.js which is being loaded when you require('redact-pii') contains:

@geekflyer How do you test this? Is this something we can automate? Or, at least something I can do locally to ensure that my changes are working as intended?

[geekflyer]

I think there's one problem with that change.
The compiled lib/index.js which is being loaded when you require('redact-pii') contains:

@geekflyer How do you test this? Is this something we can automate? Or, at least something I can do locally to ensure that my changes are working as intended?

idk. I think that's not that trivial to test automatically (honestly the value isn't probably worth the complexity of that).
You should be able to test it manually though by: building the package locally via npm run build, uninstall google cloud dlp via npm uninstall and then write some small dummy script in which you directly import the compiled the index.js via require('lib/index') then run that dummy script via node dummy.js . I bet this fails currently.

[tbjers]

@geekflyer I have pushed updates to the PR. Can you please review?

[geekflyer]

Hey, I still need you to address #25 (comment) .
Please also undo the changes in GoogleDLPRedactor since they're not necessary if you remove GoogleDLPRedactor from the module entry point.
Just to avoid confusion what I mean: module entry point === src/index.ts.

[tbjers]

Hey, I still need you to address #25 (comment) .
Please also undo the changes in GoogleDLPRedactor since they're not necessary if you remove GoogleDLPRedactor from the module entry point.

@geekflyer I have adjusted according to your recommendations. Thanks for being patient with me.

[geekflyer]

@JaredBett what do you think of this PR ? I think we should be good to merge this. We probably should bump the minor or possibly even the major, since this technically a breaking change (even for us) and we need to adapt our internal use of redact-pii in the sense that we need to add the DLP library (@google-cloud/dlp) explicitly to our apps then, but overall this seems like a good idea.

Also this would allow #29 to be merged without too much trouble.

[tbjers]

@geekflyer I have fixed the issues previously outlined, and it now passes checks in my fork.

See here: https://github.com/tbjers/redact-pii/commit/351fdf66c1a7e6916fcc832cb6ef9cb55918d7e5/checks?check_suite_id=363104856

[tHBp]

@geekflyer @JaredBett Any thoughts on this PR please?

[tHBp]

Created a new repository and published a new package till the time this PR is merged.

Thanks @tbjers for the PR.

[tbjers]

Can't believe this PR has been sitting here for two years now. Thanks for reviving, @tHBp.