@actions/cache 3.3.0 → 4.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (53) hide show
  1. package/README.md +14 -2
  2. package/lib/cache.d.ts +2 -2
  3. package/lib/cache.js +222 -7
  4. package/lib/cache.js.map +1 -1
  5. package/lib/generated/google/protobuf/timestamp.d.ts +158 -0
  6. package/lib/generated/google/protobuf/timestamp.js +136 -0
  7. package/lib/generated/google/protobuf/timestamp.js.map +1 -0
  8. package/lib/generated/google/protobuf/wrappers.d.ts +307 -0
  9. package/lib/generated/google/protobuf/wrappers.js +614 -0
  10. package/lib/generated/google/protobuf/wrappers.js.map +1 -0
  11. package/lib/generated/results/api/v1/cache.d.ts +378 -0
  12. package/lib/generated/results/api/v1/cache.js +730 -0
  13. package/lib/generated/results/api/v1/cache.js.map +1 -0
  14. package/lib/generated/results/api/v1/cache.twirp.d.ts +53 -0
  15. package/lib/generated/results/api/v1/cache.twirp.js +602 -0
  16. package/lib/generated/results/api/v1/cache.twirp.js.map +1 -0
  17. package/lib/generated/results/entities/v1/cacheentry.d.ts +71 -0
  18. package/lib/generated/results/entities/v1/cacheentry.js +106 -0
  19. package/lib/generated/results/entities/v1/cacheentry.js.map +1 -0
  20. package/lib/generated/results/entities/v1/cachemetadata.d.ts +35 -0
  21. package/lib/generated/results/entities/v1/cachemetadata.js +64 -0
  22. package/lib/generated/results/entities/v1/cachemetadata.js.map +1 -0
  23. package/lib/generated/results/entities/v1/cachescope.d.ts +34 -0
  24. package/lib/generated/results/entities/v1/cachescope.js +63 -0
  25. package/lib/generated/results/entities/v1/cachescope.js.map +1 -0
  26. package/lib/internal/cacheHttpClient.d.ts +1 -3
  27. package/lib/internal/cacheHttpClient.js +30 -36
  28. package/lib/internal/cacheHttpClient.js.map +1 -1
  29. package/lib/internal/cacheUtils.d.ts +2 -1
  30. package/lib/internal/cacheUtils.js +26 -8
  31. package/lib/internal/cacheUtils.js.map +1 -1
  32. package/lib/internal/config.d.ts +3 -0
  33. package/lib/internal/config.js +37 -0
  34. package/lib/internal/config.js.map +1 -0
  35. package/lib/internal/constants.d.ts +1 -0
  36. package/lib/internal/constants.js +2 -1
  37. package/lib/internal/constants.js.map +1 -1
  38. package/lib/internal/shared/cacheTwirpClient.d.ts +6 -0
  39. package/lib/internal/shared/cacheTwirpClient.js +160 -0
  40. package/lib/internal/shared/cacheTwirpClient.js.map +1 -0
  41. package/lib/internal/shared/errors.d.ts +22 -0
  42. package/lib/internal/shared/errors.js +70 -0
  43. package/lib/internal/shared/errors.js.map +1 -0
  44. package/lib/internal/shared/user-agent.d.ts +4 -0
  45. package/lib/internal/shared/user-agent.js +13 -0
  46. package/lib/internal/shared/user-agent.js.map +1 -0
  47. package/lib/internal/uploadUtils.d.ts +60 -0
  48. package/lib/internal/uploadUtils.js +167 -0
  49. package/lib/internal/uploadUtils.js.map +1 -0
  50. package/lib/options.d.ts +12 -0
  51. package/lib/options.js +17 -0
  52. package/lib/options.js.map +1 -1
  53. package/package.json +5 -3
package/lib/options.d.ts CHANGED
@@ -2,6 +2,14 @@
2
2
  * Options to control cache upload
3
3
  */
4
4
  export interface UploadOptions {
5
+ /**
6
+ * Indicates whether to use the Azure Blob SDK to download caches
7
+ * that are stored on Azure Blob Storage to improve reliability and
8
+ * performance
9
+ *
10
+ * @default false
11
+ */
12
+ useAzureSdk?: boolean;
5
13
  /**
6
14
  * Number of parallel cache upload
7
15
  *
@@ -14,6 +22,10 @@ export interface UploadOptions {
14
22
  * @default 32MB
15
23
  */
16
24
  uploadChunkSize?: number;
25
+ /**
26
+ * Archive size in bytes
27
+ */
28
+ archiveSizeBytes?: number;
17
29
  }
18
30
  /**
19
31
  * Options to control cache download
package/lib/options.js CHANGED
@@ -31,11 +31,16 @@ const core = __importStar(require("@actions/core"));
31
31
  * @param copy the original upload options
32
32
  */
33
33
  function getUploadOptions(copy) {
34
+ // Defaults if not overriden
34
35
  const result = {
36
+ useAzureSdk: false,
35
37
  uploadConcurrency: 4,
36
38
  uploadChunkSize: 32 * 1024 * 1024
37
39
  };
38
40
  if (copy) {
41
+ if (typeof copy.useAzureSdk === 'boolean') {
42
+ result.useAzureSdk = copy.useAzureSdk;
43
+ }
39
44
  if (typeof copy.uploadConcurrency === 'number') {
40
45
  result.uploadConcurrency = copy.uploadConcurrency;
41
46
  }
@@ -43,6 +48,18 @@ function getUploadOptions(copy) {
43
48
  result.uploadChunkSize = copy.uploadChunkSize;
44
49
  }
45
50
  }
51
+ /**
52
+ * Add env var overrides
53
+ */
54
+ // Cap the uploadConcurrency at 32
55
+ result.uploadConcurrency = !isNaN(Number(process.env['CACHE_UPLOAD_CONCURRENCY']))
56
+ ? Math.min(32, Number(process.env['CACHE_UPLOAD_CONCURRENCY']))
57
+ : result.uploadConcurrency;
58
+ // Cap the uploadChunkSize at 128MiB
59
+ result.uploadChunkSize = !isNaN(Number(process.env['CACHE_UPLOAD_CHUNK_SIZE']))
60
+ ? Math.min(128 * 1024 * 1024, Number(process.env['CACHE_UPLOAD_CHUNK_SIZE']) * 1024 * 1024)
61
+ : result.uploadChunkSize;
62
+ core.debug(`Use Azure SDK: ${result.useAzureSdk}`);
46
63
  core.debug(`Upload concurrency: ${result.uploadConcurrency}`);
47
64
  core.debug(`Upload chunk size: ${result.uploadChunkSize}`);
48
65
  return result;
@@ -1 +1 @@
1
- {"version":3,"file":"options.js","sourceRoot":"","sources":["../src/options.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,oDAAqC;AAwErC;;;;GAIG;AACH,SAAgB,gBAAgB,CAAC,IAAoB;IACnD,MAAM,MAAM,GAAkB;QAC5B,iBAAiB,EAAE,CAAC;QACpB,eAAe,EAAE,EAAE,GAAG,IAAI,GAAG,IAAI;KAClC,CAAA;IAED,IAAI,IAAI,EAAE;QACR,IAAI,OAAO,IAAI,CAAC,iBAAiB,KAAK,QAAQ,EAAE;YAC9C,MAAM,CAAC,iBAAiB,GAAG,IAAI,CAAC,iBAAiB,CAAA;SAClD;QAED,IAAI,OAAO,IAAI,CAAC,eAAe,KAAK,QAAQ,EAAE;YAC5C,MAAM,CAAC,eAAe,GAAG,IAAI,CAAC,eAAe,CAAA;SAC9C;KACF;IAED,IAAI,CAAC,KAAK,CAAC,uBAAuB,MAAM,CAAC,iBAAiB,EAAE,CAAC,CAAA;IAC7D,IAAI,CAAC,KAAK,CAAC,sBAAsB,MAAM,CAAC,eAAe,EAAE,CAAC,CAAA;IAE1D,OAAO,MAAM,CAAA;AACf,CAAC;AApBD,4CAoBC;AAED;;;;GAIG;AACH,SAAgB,kBAAkB,CAAC,IAAsB;IACvD,MAAM,MAAM,GAAoB;QAC9B,WAAW,EAAE,KAAK;QAClB,uBAAuB,EAAE,IAAI;QAC7B,mBAAmB,EAAE,CAAC;QACtB,WAAW,EAAE,KAAK;QAClB,kBAAkB,EAAE,MAAM;QAC1B,UAAU,EAAE,KAAK;KAClB,CAAA;IAED,IAAI,IAAI,EAAE;QACR,IAAI,OAAO,IAAI,CAAC,WAAW,KAAK,SAAS,EAAE;YACzC,MAAM,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAA;SACtC;QAED,IAAI,OAAO,IAAI,CAAC,uBAAuB,KAAK,SAAS,EAAE;YACrD,MAAM,CAAC,uBAAuB,GAAG,IAAI,CAAC,uBAAuB,CAAA;SAC9D;QAED,IAAI,OAAO,IAAI,CAAC,mBAAmB,KAAK,QAAQ,EAAE;YAChD,MAAM,CAAC,mBAAmB,GAAG,IAAI,CAAC,mBAAmB,CAAA;SACtD;QAED,IAAI,OAAO,IAAI,CAAC,WAAW,KAAK,QAAQ,EAAE;YACxC,MAAM,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAA;SACtC;QAED,IAAI,OAAO,IAAI,CAAC,kBAAkB,KAAK,QAAQ,EAAE;YAC/C,MAAM,CAAC,kBAAkB,GAAG,IAAI,CAAC,kBAAkB,CAAA;SACpD;QAED,IAAI,OAAO,IAAI,CAAC,UAAU,KAAK,SAAS,EAAE;YACxC,MAAM,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAA;SACpC;KACF;IACD,MAAM,0BAA0B,GAC9B,OAAO,CAAC,GAAG,CAAC,+BAA+B,CAAC,CAAA;IAE9C,IACE,0BAA0B;QAC1B,CAAC,KAAK,CAAC,MAAM,CAAC,0BAA0B,CAAC,CAAC;QAC1C,QAAQ,CAAC,MAAM,CAAC,0BAA0B,CAAC,CAAC,EAC5C;QACA,MAAM,CAAC,kBAAkB,GAAG,MAAM,CAAC,0BAA0B,CAAC,GAAG,EAAE,GAAG,IAAI,CAAA;KAC3E;IACD,IAAI,CAAC,KAAK,CAAC,kBAAkB,MAAM,CAAC,WAAW,EAAE,CAAC,CAAA;IAClD,IAAI,CAAC,KAAK,CAAC,yBAAyB,MAAM,CAAC,mBAAmB,EAAE,CAAC,CAAA;IACjE,IAAI,CAAC,KAAK,CAAC,yBAAyB,MAAM,CAAC,WAAW,EAAE,CAAC,CAAA;IACzD,IAAI,CAAC,KAAK,CACR,gDAAgD,OAAO,CAAC,GAAG,CAAC,+BAA+B,CAAC,EAAE,CAC/F,CAAA;IACD,IAAI,CAAC,KAAK,CAAC,kCAAkC,MAAM,CAAC,kBAAkB,EAAE,CAAC,CAAA;IACzE,IAAI,CAAC,KAAK,CAAC,gBAAgB,MAAM,CAAC,UAAU,EAAE,CAAC,CAAA;IAE/C,OAAO,MAAM,CAAA;AACf,CAAC;AAvDD,gDAuDC"}
1
+ {"version":3,"file":"options.js","sourceRoot":"","sources":["../src/options.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,oDAAqC;AAoFrC;;;;GAIG;AACH,SAAgB,gBAAgB,CAAC,IAAoB;IACnD,4BAA4B;IAC5B,MAAM,MAAM,GAAkB;QAC5B,WAAW,EAAE,KAAK;QAClB,iBAAiB,EAAE,CAAC;QACpB,eAAe,EAAE,EAAE,GAAG,IAAI,GAAG,IAAI;KAClC,CAAA;IAED,IAAI,IAAI,EAAE;QACR,IAAI,OAAO,IAAI,CAAC,WAAW,KAAK,SAAS,EAAE;YACzC,MAAM,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAA;SACtC;QAED,IAAI,OAAO,IAAI,CAAC,iBAAiB,KAAK,QAAQ,EAAE;YAC9C,MAAM,CAAC,iBAAiB,GAAG,IAAI,CAAC,iBAAiB,CAAA;SAClD;QAED,IAAI,OAAO,IAAI,CAAC,eAAe,KAAK,QAAQ,EAAE;YAC5C,MAAM,CAAC,eAAe,GAAG,IAAI,CAAC,eAAe,CAAA;SAC9C;KACF;IAED;;OAEG;IACH,kCAAkC;IAClC,MAAM,CAAC,iBAAiB,GAAG,CAAC,KAAK,CAC/B,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,0BAA0B,CAAC,CAAC,CAChD;QACC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,0BAA0B,CAAC,CAAC,CAAC;QAC/D,CAAC,CAAC,MAAM,CAAC,iBAAiB,CAAA;IAC5B,oCAAoC;IACpC,MAAM,CAAC,eAAe,GAAG,CAAC,KAAK,CAC7B,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC,CAC/C;QACC,CAAC,CAAC,IAAI,CAAC,GAAG,CACN,GAAG,GAAG,IAAI,GAAG,IAAI,EACjB,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC,GAAG,IAAI,GAAG,IAAI,CAC7D;QACH,CAAC,CAAC,MAAM,CAAC,eAAe,CAAA;IAE1B,IAAI,CAAC,KAAK,CAAC,kBAAkB,MAAM,CAAC,WAAW,EAAE,CAAC,CAAA;IAClD,IAAI,CAAC,KAAK,CAAC,uBAAuB,MAAM,CAAC,iBAAiB,EAAE,CAAC,CAAA;IAC7D,IAAI,CAAC,KAAK,CAAC,sBAAsB,MAAM,CAAC,eAAe,EAAE,CAAC,CAAA;IAE1D,OAAO,MAAM,CAAA;AACf,CAAC;AA9CD,4CA8CC;AAED;;;;GAIG;AACH,SAAgB,kBAAkB,CAAC,IAAsB;IACvD,MAAM,MAAM,GAAoB;QAC9B,WAAW,EAAE,KAAK;QAClB,uBAAuB,EAAE,IAAI;QAC7B,mBAAmB,EAAE,CAAC;QACtB,WAAW,EAAE,KAAK;QAClB,kBAAkB,EAAE,MAAM;QAC1B,UAAU,EAAE,KAAK;KAClB,CAAA;IAED,IAAI,IAAI,EAAE;QACR,IAAI,OAAO,IAAI,CAAC,WAAW,KAAK,SAAS,EAAE;YACzC,MAAM,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAA;SACtC;QAED,IAAI,OAAO,IAAI,CAAC,uBAAuB,KAAK,SAAS,EAAE;YACrD,MAAM,CAAC,uBAAuB,GAAG,IAAI,CAAC,uBAAuB,CAAA;SAC9D;QAED,IAAI,OAAO,IAAI,CAAC,mBAAmB,KAAK,QAAQ,EAAE;YAChD,MAAM,CAAC,mBAAmB,GAAG,IAAI,CAAC,mBAAmB,CAAA;SACtD;QAED,IAAI,OAAO,IAAI,CAAC,WAAW,KAAK,QAAQ,EAAE;YACxC,MAAM,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAA;SACtC;QAED,IAAI,OAAO,IAAI,CAAC,kBAAkB,KAAK,QAAQ,EAAE;YAC/C,MAAM,CAAC,kBAAkB,GAAG,IAAI,CAAC,kBAAkB,CAAA;SACpD;QAED,IAAI,OAAO,IAAI,CAAC,UAAU,KAAK,SAAS,EAAE;YACxC,MAAM,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAA;SACpC;KACF;IACD,MAAM,0BAA0B,GAC9B,OAAO,CAAC,GAAG,CAAC,+BAA+B,CAAC,CAAA;IAE9C,IACE,0BAA0B;QAC1B,CAAC,KAAK,CAAC,MAAM,CAAC,0BAA0B,CAAC,CAAC;QAC1C,QAAQ,CAAC,MAAM,CAAC,0BAA0B,CAAC,CAAC,EAC5C;QACA,MAAM,CAAC,kBAAkB,GAAG,MAAM,CAAC,0BAA0B,CAAC,GAAG,EAAE,GAAG,IAAI,CAAA;KAC3E;IACD,IAAI,CAAC,KAAK,CAAC,kBAAkB,MAAM,CAAC,WAAW,EAAE,CAAC,CAAA;IAClD,IAAI,CAAC,KAAK,CAAC,yBAAyB,MAAM,CAAC,mBAAmB,EAAE,CAAC,CAAA;IACjE,IAAI,CAAC,KAAK,CAAC,yBAAyB,MAAM,CAAC,WAAW,EAAE,CAAC,CAAA;IACzD,IAAI,CAAC,KAAK,CACR,gDAAgD,OAAO,CAAC,GAAG,CAAC,+BAA+B,CAAC,EAAE,CAC/F,CAAA;IACD,IAAI,CAAC,KAAK,CAAC,kCAAkC,MAAM,CAAC,kBAAkB,EAAE,CAAC,CAAA;IACzE,IAAI,CAAC,KAAK,CAAC,gBAAgB,MAAM,CAAC,UAAU,EAAE,CAAC,CAAA;IAE/C,OAAO,MAAM,CAAA;AACf,CAAC;AAvDD,gDAuDC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@actions/cache",
3
- "version": "3.3.0",
3
+ "version": "4.0.0",
4
4
  "preview": true,
5
5
  "description": "Actions cache lib",
6
6
  "keywords": [
@@ -45,10 +45,12 @@
45
45
  "@azure/abort-controller": "^1.1.0",
46
46
  "@azure/ms-rest-js": "^2.6.0",
47
47
  "@azure/storage-blob": "^12.13.0",
48
- "semver": "^6.3.1"
48
+ "@protobuf-ts/plugin": "^2.9.4",
49
+ "semver": "^6.3.1",
50
+ "twirp-ts": "^2.5.0"
49
51
  },
50
52
  "devDependencies": {
51
53
  "@types/semver": "^6.0.0",
52
54
  "typescript": "^5.2.2"
53
55
  }
54
- }
56
+ }