Merge pull request #313 from opencomponents/add-env-as-private

ricardo-devis-agullo · web-flow · commit f497db239f77 · 2022-07-20T11:37:18.000+02:00
[IMPROVEMENT] Add .env as a private file for storage
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -2,7 +2,8 @@
   "parser": "@typescript-eslint/parser",
   "env": {
     "es6": true,
-    "node": true
+    "node": true,
+    "jest": true
   },
   "extends": [
     "eslint:recommended",
diff --git a/packages/oc-azure-storage-adapter/__mocks__/azure-storage.js b/packages/oc-azure-storage-adapter/__mocks__/azure-storage.js
@@ -26,9 +26,11 @@ jest.mock('node-dir', () => {
         files: [
           `${pathToDir}\\package.json`,
           `${pathToDir}\\server.js`,
+          `${pathToDir}\\.env`,
           `${pathToDir}\\template.js`,
           `${pathToDir}/package.json`,
           `${pathToDir}/server.js`,
+          `${pathToDir}/.env`,
           `${pathToDir}/template.js`
         ]
       });
diff --git a/packages/oc-azure-storage-adapter/__test__/privateFilesExclusion.test.js b/packages/oc-azure-storage-adapter/__test__/privateFilesExclusion.test.js
@@ -16,7 +16,7 @@ jest.mock('async', () => {
   };
 });
 
-test('put directory recognizes server.js to be private', done => {
+test('put directory recognizes server.js and .env to be private', done => {
   const client = new adapter({
     publicContainerName: 'pubcon',
     privateContainerName: 'privcon'
@@ -28,6 +28,7 @@ test('put directory recognizes server.js to be private', done => {
       expect(mockResult[`.${separator}server.js`].res.container).toBe(
         'privcon'
       );
+      expect(mockResult[`.${separator}.env`].res.container).toBe('privcon');
       expect(mockResult[`.${separator}package.json`].res.container).toBe(
         'pubcon'
       );
diff --git a/packages/oc-azure-storage-adapter/index.js b/packages/oc-azure-storage-adapter/index.js
@@ -198,8 +198,15 @@ module.exports = function (conf) {
           const relativeFile = file.substr(dirInput.length),
             url = (dirOutput + relativeFile).replace(/\\/g, '/');
 
-          const serverJsNames = ['/server.js', '\\server.js'];
-          putFile(file, url, serverJsNames.includes(relativeFile), cb);
+          const serverPattern = /(\\|\/)server\.js/;
+          const dotFilePattern = /(\\|\/)\..+/;
+          const privateFilePatterns = [serverPattern, dotFilePattern];
+          putFile(
+            file,
+            url,
+            privateFilePatterns.some(r => r.test(relativeFile)),
+            cb
+          );
         },
         callback
       );
diff --git a/packages/oc-gs-storage-adapter/__mocks__/@google-cloud/storage.js b/packages/oc-gs-storage-adapter/__mocks__/@google-cloud/storage.js
@@ -13,6 +13,7 @@ jest.mock('node-dir', () => {
         files: [
           `${pathToDir}${sep}package.json`,
           `${pathToDir}${sep}server.js`,
+          `${pathToDir}${sep}.env`,
           `${pathToDir}${sep}template.js`
         ]
       });
@@ -39,9 +40,15 @@ const _Storage = class {
                   {
                     name: 'components/image/1.0.0/server.js'
                   },
+                  {
+                    name: 'components/image/1.0.0/.env'
+                  },
                   {
                     name: 'components/image/1.0.1/new-server.js'
                   },
+                  {
+                    name: 'components/image/1.0.1/new-.env'
+                  },
                   {
                     name: 'components/image/1.0.1/new-app.js'
                   }
diff --git a/packages/oc-gs-storage-adapter/__test__/privateFilesExclusion.test.js b/packages/oc-gs-storage-adapter/__test__/privateFilesExclusion.test.js
@@ -7,9 +7,11 @@ jest.mock('node-dir', () => {
         files: [
           `${pathToDir}\\package.json`,
           `${pathToDir}\\server.js`,
+          `${pathToDir}\\.env`,
           `${pathToDir}\\template.js`,
           `${pathToDir}/package.json`,
           `${pathToDir}/server.js`,
+          `${pathToDir}/.env`,
           `${pathToDir}/template.js`
         ]
       });
@@ -33,7 +35,7 @@ jest.mock('async', () => {
   };
 });
 
-test('put directory recognizes server.js to be private', done => {
+test('put directory recognizes server.js and .env to be private', done => {
   const options = {
     bucket: 'test',
     projectId: '12345',
@@ -47,6 +49,9 @@ test('put directory recognizes server.js to be private', done => {
       expect(mockResult[`.${separator}server.js`].res.ACL).toBe(
         'authenticated-read'
       );
+      expect(mockResult[`.${separator}.env`].res.ACL).toBe(
+        'authenticated-read'
+      );
       expect(mockResult[`.${separator}package.json`].res.ACL).toBe(
         'public-read'
       );
diff --git a/packages/oc-gs-storage-adapter/index.js b/packages/oc-gs-storage-adapter/index.js
@@ -156,8 +156,15 @@ module.exports = function (conf) {
         (file, cb) => {
           const relativeFile = file.substr(dirInput.length);
           const url = (dirOutput + relativeFile).replace(/\\/g, '/');
-          const serverJsNames = ['/server.js', '\\server.js'];
-          putFile(file, url, serverJsNames.includes(relativeFile), cb);
+          const serverPattern = /(\\|\/)server\.js/;
+          const dotFilePattern = /(\\|\/)\..+/;
+          const privateFilePatterns = [serverPattern, dotFilePattern];
+          putFile(
+            file,
+            url,
+            privateFilePatterns.some(r => r.test(relativeFile)),
+            cb
+          );
         },
         callback
       );
diff --git a/packages/oc-s3-storage-adapter/__mocks__/aws-sdk.js b/packages/oc-s3-storage-adapter/__mocks__/aws-sdk.js
@@ -15,9 +15,11 @@ jest.mock('node-dir', () => {
         files: [
           `${pathToDir}\\package.json`,
           `${pathToDir}\\server.js`,
+          `${pathToDir}\\.env`,
           `${pathToDir}\\template.js`,
           `${pathToDir}/package.json`,
           `${pathToDir}/server.js`,
+          `${pathToDir}/.env`,
           `${pathToDir}/template.js`
         ]
       });
diff --git a/packages/oc-s3-storage-adapter/__test__/privateFilesExclusion.test.js b/packages/oc-s3-storage-adapter/__test__/privateFilesExclusion.test.js
@@ -16,7 +16,7 @@ jest.mock('async', () => {
   };
 });
 
-test('put directory recognizes server.js to be private', done => {
+test('put directory recognizes server.js and .env to be private', done => {
   const options = {
     bucket: 'test',
     region: 'region-test',
@@ -29,6 +29,9 @@ test('put directory recognizes server.js to be private', done => {
   client.putDir('.', '.', (_, mockResult) => {
     const separators = ['\\', '/'];
     for (let separator of separators) {
+      expect(mockResult[`.${separator}.env`].res.ACL).toBe(
+        'authenticated-read'
+      );
       expect(mockResult[`.${separator}server.js`].res.ACL).toBe(
         'authenticated-read'
       );
diff --git a/packages/oc-s3-storage-adapter/index.js b/packages/oc-s3-storage-adapter/index.js
@@ -196,8 +196,15 @@ module.exports = function (conf) {
           const relativeFile = file.substr(dirInput.length),
             url = (dirOutput + relativeFile).replace(/\\/g, '/');
 
-          const serverJsNames = ['/server.js', '\\server.js'];
-          putFile(file, url, serverJsNames.includes(relativeFile), cb);
+          const serverPattern = /(\\|\/)server\.js/;
+          const dotFilePattern = /(\\|\/)\..+/;
+          const privateFilePatterns = [serverPattern, dotFilePattern];
+          putFile(
+            file,
+            url,
+            privateFilePatterns.some(r => r.test(relativeFile)),
+            cb
+          );
         },
         callback
       );

Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,7 @@ jest.mock('node-dir', () => {`
`13`	`13`	`files: [`
`14`	`14`	`${pathToDir}${sep}package.json`,
`15`	`15`	`${pathToDir}${sep}server.js`,
	`16`	+ `${pathToDir}${sep}.env`,
`16`	`17`	`${pathToDir}${sep}template.js`
`17`	`18`	`]`
`18`	`19`	`});`
`@@ -39,9 +40,15 @@ const _Storage = class {`
`39`	`40`	`{`
`40`	`41`	`name: 'components/image/1.0.0/server.js'`
`41`	`42`	`},`
	`43`	`+ {`
	`44`	`+ name: 'components/image/1.0.0/.env'`
	`45`	`+ },`
`42`	`46`	`{`
`43`	`47`	`name: 'components/image/1.0.1/new-server.js'`
`44`	`48`	`},`
	`49`	`+ {`
	`50`	`+ name: 'components/image/1.0.1/new-.env'`
	`51`	`+ },`
`45`	`52`	`{`
`46`	`53`	`name: 'components/image/1.0.1/new-app.js'`
`47`	`54`	`}`