refactor(ses): Subsume makeHardener
DELETE
packages/make-hardener/.gitignore
-types
-dist

DELETE
packages/make-hardener/.prettierrc.json
-{
- "trailingComma": "all",
- "singleQuote": true
-}

DELETE
packages/make-hardener/LICENSE
- Apache License
- Version 2.0, January 2004
- http://www.apache.org/licenses/
-
- TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
- 1. Definitions.
-
- "License" shall mean the terms and conditions for use, reproduction,
- and distribution as defined by Sections 1 through 9 of this document.
-
- "Licensor" shall mean the copyright owner or entity authorized by
- the copyright owner that is granting the License.
-
- "Legal Entity" shall mean the union of the acting entity and all
- other entities that control, are controlled by, or are under common
- control with that entity. For the purposes of this definition,
- "control" means (i) the power, direct or indirect, to cause the
- direction or management of such entity, whether by contract or
- otherwise, or (ii) ownership of fifty percent (50%) or more of the
- outstanding shares, or (iii) beneficial ownership of such entity.
-
- "You" (or "Your") shall mean an individual or Legal Entity
- exercising permissions granted by this License.
-
- "Source" form shall mean the preferred form for making modifications,
- including but not limited to software source code, documentation
- source, and configuration files.
-
- "Object" form shall mean any form resulting from mechanical
- transformation or translation of a Source form, including but
- not limited to compiled object code, generated documentation,
- and conversions to other media types.
-
- "Work" shall mean the work of authorship, whether in Source or
- Object form, made available under the License, as indicated by a
- copyright notice that is included in or attached to the work
- (an example is provided in the Appendix below).
-
- "Derivative Works" shall mean any work, whether in Source or Object
- form, that is based on (or derived from) the Work and for which the
- editorial revisions, annotations, elaborations, or other modifications
- represent, as a whole, an original work of authorship. For the purposes
- of this License, Derivative Works shall not include works that remain
- separable from, or merely link (or bind by name) to the interfaces of,
- the Work and Derivative Works thereof.
-
- "Contribution" shall mean any work of authorship, including
- the original version of the Work and any modifications or additions
- to that Work or Derivative Works thereof, that is intentionally
- submitted to Licensor for inclusion in the Work by the copyright owner
- or by an individual or Legal Entity authorized to submit on behalf of
- the copyright owner. For the purposes of this definition, "submitted"
- means any form of electronic, verbal, or written communication sent
- to the Licensor or its representatives, including but not limited to
- communication on electronic mailing lists, source code control systems,
- and issue tracking systems that are managed by, or on behalf of, the
- Licensor for the purpose of discussing and improving the Work, but
- excluding communication that is conspicuously marked or otherwise
- designated in writing by the copyright owner as "Not a Contribution."
-
- "Contributor" shall mean Licensor and any individual or Legal Entity
- on behalf of whom a Contribution has been received by Licensor and
- subsequently incorporated within the Work.
-
- 2. Grant of Copyright License. Subject to the terms and conditions of
- this License, each Contributor hereby grants to You a perpetual,
- worldwide, non-exclusive, no-charge, royalty-free, irrevocable
- copyright license to reproduce, prepare Derivative Works of,
- publicly display, publicly perform, sublicense, and distribute the
- Work and such Derivative Works in Source or Object form.
-
- 3. Grant of Patent License. Subject to the terms and conditions of
- this License, each Contributor hereby grants to You a perpetual,
- worldwide, non-exclusive, no-charge, royalty-free, irrevocable
- (except as stated in this section) patent license to make, have made,
- use, offer to sell, sell, import, and otherwise transfer the Work,
- where such license applies only to those patent claims licensable
- by such Contributor that are necessarily infringed by their
- Contribution(s) alone or by combination of their Contribution(s)
- with the Work to which such Contribution(s) was submitted. If You
- institute patent litigation against any entity (including a
- cross-claim or counterclaim in a lawsuit) alleging that the Work
- or a Contribution incorporated within the Work constitutes direct
- or contributory patent infringement, then any patent licenses
- granted to You under this License for that Work shall terminate
- as of the date such litigation is filed.
-
- 4. Redistribution. You may reproduce and distribute copies of the
- Work or Derivative Works thereof in any medium, with or without
- modifications, and in Source or Object form, provided that You
- meet the following conditions:
-
- (a) You must give any other recipients of the Work or
- Derivative Works a copy of this License; and
-
- (b) You must cause any modified files to carry prominent notices
- stating that You changed the files; and
-
- (c) You must retain, in the Source form of any Derivative Works
- that You distribute, all copyright, patent, trademark, and
- attribution notices from the Source form of the Work,
- excluding those notices that do not pertain to any part of
- the Derivative Works; and
-
- (d) If the Work includes a "NOTICE" text file as part of its
- distribution, then any Derivative Works that You distribute must
- include a readable copy of the attribution notices contained
- within such NOTICE file, excluding those notices that do not
- pertain to any part of the Derivative Works, in at least one
- of the following places: within a NOTICE text file distributed
- as part of the Derivative Works; within the Source form or
- documentation, if provided along with the Derivative Works; or,
- within a display generated by the Derivative Works, if and
- wherever such third-party notices normally appear. The contents
- of the NOTICE file are for informational purposes only and
- do not modify the License. You may add Your own attribution
- notices within Derivative Works that You distribute, alongside
- or as an addendum to the NOTICE text from the Work, provided
- that such additional attribution notices cannot be construed
- as modifying the License.
-
- You may add Your own copyright statement to Your modifications and
- may provide additional or different license terms and conditions
- for use, reproduction, or distribution of Your modifications, or
- for any such Derivative Works as a whole, provided Your use,
- reproduction, and distribution of the Work otherwise complies with
- the conditions stated in this License.
-
- 5. Submission of Contributions. Unless You explicitly state otherwise,
- any Contribution intentionally submitted for inclusion in the Work
- by You to the Licensor shall be under the terms and conditions of
- this License, without any additional terms or conditions.
- Notwithstanding the above, nothing herein shall supersede or modify
- the terms of any separate license agreement you may have executed
- with Licensor regarding such Contributions.
-
- 6. Trademarks. This License does not grant permission to use the trade
- names, trademarks, service marks, or product names of the Licensor,
- except as required for reasonable and customary use in describing the
- origin of the Work and reproducing the content of the NOTICE file.
-
- 7. Disclaimer of Warranty. Unless required by applicable law or
- agreed to in writing, Licensor provides the Work (and each
- Contributor provides its Contributions) on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
- implied, including, without limitation, any warranties or conditions
- of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
- PARTICULAR PURPOSE. You are solely responsible for determining the
- appropriateness of using or redistributing the Work and assume any
- risks associated with Your exercise of permissions under this License.
-
- 8. Limitation of Liability. In no event and under no legal theory,
- whether in tort (including negligence), contract, or otherwise,
- unless required by applicable law (such as deliberate and grossly
- negligent acts) or agreed to in writing, shall any Contributor be
- liable to You for damages, including any direct, indirect, special,
- incidental, or consequential damages of any character arising as a
- result of this License or out of the use or inability to use the
- Work (including but not limited to damages for loss of goodwill,
- work stoppage, computer failure or malfunction, or any and all
- other commercial damages or losses), even if such Contributor
- has been advised of the possibility of such damages.
-
- 9. Accepting Warranty or Additional Liability. While redistributing
- the Work or Derivative Works thereof, You may choose to offer,
- and charge a fee for, acceptance of support, warranty, indemnity,
- or other liability obligations and/or rights consistent with this
- License. However, in accepting such obligations, You may act only
- on Your own behalf and on Your sole responsibility, not on behalf
- of any other Contributor, and only if You agree to indemnify,
- defend, and hold each Contributor harmless for any liability
- incurred by, or claims asserted against, such Contributor by reason
- of your accepting any such warranty or additional liability.
-
- END OF TERMS AND CONDITIONS
-
- APPENDIX: How to apply the Apache License to your work.
-
- To apply the Apache License to your work, attach the following
- boilerplate notice, with the fields enclosed by brackets "[]"
- replaced with your own identifying information. (Don't include
- the brackets!) The text should be enclosed in the appropriate
- comment syntax for the file format. We also recommend that a
- file or class name and description of purpose be included on the
- same "printed page" as the copyright notice for easier
- identification within third-party archives.
-
- Copyright [yyyy] [name of copyright owner]
-
- Licensed under the Apache License, Version 2.0 (the "License");
- you may not use this file except in compliance with the License.
- You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.

DELETE
packages/make-hardener/NEWS.md
-User-visible changes in make-hardener:
-
-## Next release
-
-* No changes yet.
-
-## Release 0.1.2 (21-Jan-2021)
-
-* Hardens up the prototype chain and eliminates the notion of a "fringe set"
- and the class of errors that harden would previously throw when object
- prototypes were not already in the fringe set.
-* Provides TypeScript definitions.
-
-## Release 0.1.1 (8-Aug-2020)
-
-* This version makes its own `package.json` visible to dependees.
-
-## Release 0.1.0 (13-Jul-2020)
-
-* This is a re-relase of 0.0.9 such that other packages can depend on version
- `^0.1.0` and benefit from patches without modification.
-
-## Release 0.0.9 (14-Apr-2020)
-
-* Fixes ESM support by publishing sources.
-
-## Release 0.0.8 (16-Mar-2020)
-
-* Hybrid module system support: CommonJS, ESM, emulated ESM with `node -r esm`,
- Rollup, UMD for script tags, and unpkg.com.
-
-## Release 0.0.7 (13-Mar-2020)
-
-* The `harden` function no longer has a `prototype`.
- This is necessary for compatibility with SES 0.7.
-
-## Release 0.0.6 (20-Apr-2019)
-
-* Tolerate objects with unstringifyable prototypes, like `async function`.
- These were handled correctly by the freezing process, but then caused some
- debugging code to throw an exception, which was discovered when we added
- unit tests to cover async functions and generators.
-* Add options bundle to `makeHardener(initialFringe, opts={})`. The options
- bundle can contain two keys:
- * `fringeSet`. If present, this should be a `WeakSet`, and it will be used
- to track which objects have been frozen already. Normally
- `makeHardener()` creates a new internal `WeakSet` for this purpose, but
- by providing one as an option, you can keep track of what has been added
- to the set over time. This is most useful for keeping multiple hardener
- instances in sync, specifically for an `immunize` function as explored
- in https://github.com/Agoric/Jessie/issues/27 .
- * `naivePrepareObject`. If present, this function will be invoked with each
- object just before it is frozen.
- Both options should be considered experimental. #35
-
-
-## Release 0.0.5 (07-Mar-2019)
-
-* Clean up published dist files: `.esm.js` for ES6 Module import, `.cjs.js`
- for CommonJS (NodeJS) `require`, and `.umd.js` for browser `<script>` tags.
- All are built with `rollup` at build/publish time. #17
-* Rename the repository to use kebab-case (`make-hardener`) instead of
- CamelCase (`MakeHardener`). #18
-
-
-## Release 0.0.4 (20-Feb-2019)
-
-* Publish both es6-module and CommonJS versions, use package.json keys to
- distinguish. #10
-* Tolerate `harden()` of objects with null prototypes. #11
-
-
-## Release 0.0.3 (19-Feb-2019)
-
-* Change API to take an iterable (`makeHardener([a,b])`) instead of a splat
- (`makeHardener(a,b)`). #3
-* Use the name "fringe" to talk about the edge of the frozen graph.
-* Don't commit to the new fringe until prototype checks have passed. #4
-* Export a single default function, rather than a composite object named
- `makeHardener`. Imports must be changed to match. #8
-
-
-## Release 0.0.2 (14-Feb-2019)
-
-Initial release

DELETE
packages/make-hardener/README.md
-# MakeHardener
-
-[![Build Status][circleci-svg]][circleci-url]
-[![dependency status][deps-svg]][deps-url]
-[![dev dependency status][dev-deps-svg]][dev-deps-url]
-[![License][license-image]][license-url]
-
-Build a defensible API surface around an object by freezing all reachable properties.
-
-## How to use
-
-> Note: If you're writing an application, you probably don't want to use this package directly. You'll want to use the `harden()` function provided in [SES](https://github.com/Agoric/SES) to perform an all-encompassing "deep freeze" on your objects. Alternatively, if you want to test your code before using it in SES, you can import the [@agoric/harden package](https://github.com/Agoric/Harden). Note that without SES, `harden()` is insecure, and should be used for testing purposes only.
-
-## Why do we need to "harden" objects?
-
-Please see the [harden()](https://github.com/Agoric/Harden) package for more documentation.
-
-## Creating a custom harden() Function
-
-This package (`@agoric/make-hardener`) provides a `makeHardener()` which can be used to build your own `harden()` function. When you call `makeHardener()`, you give it an iterable of stopping points (the "fringe"), and the recursive property walk will stop its search when it runs into the fringe. The resulting `harden()` will throw an exception if anything it freezes has a prototype that is not already in the fringe, or was frozen during the same call (and thus added to the fringe).
-
-[circleci-svg]: https://circleci.com/gh/Agoric/make-hardener.svg?style=svg
-[circleci-url]: https://circleci.com/gh/Agoric/make-hardener
-[deps-svg]: https://david-dm.org/Agoric/make-hardener.svg
-[deps-url]: https://david-dm.org/Agoric/make-hardener
-[dev-deps-svg]: https://david-dm.org/Agoric/make-hardener/dev-status.svg
-[dev-deps-url]: https://david-dm.org/Agoric/make-hardener?type=dev
-[license-image]: https://img.shields.io/badge/License-Apache%202.0-blue.svg
-[license-url]: LICENSE

DELETE
packages/make-hardener/jsconfig.json
-{
- "compilerOptions": {
- "target": "esnext",
- "module": "esnext",
- "noEmit": true,
- "downlevelIteration": true,
- "strictNullChecks": true,
- "moduleResolution": "node"
- },
- "include": ["src/**/*.js"]
-}

DELETE
packages/make-hardener/package.json
-{
- "name": "@agoric/make-hardener",
- "version": "0.1.2+1-dev",
- "description": "Create a 'hardener' which freezes the API surface of a set of objects",
- "keywords": [
- "deepFreeze",
- "harden",
- "Object.freeze",
- "freeze"
- ],
- "author": "Agoric",
- "license": "Apache-2.0",
- "homepage": "https://github.com/Agoric/SES-shim/tree/master/packages/make-hardener#readme",
- "repository": {
- "type": "git",
- "url": "git+https://github.com/Agoric/SES-shim.git"
- },
- "bugs": {
- "url": "https://github.com/Agoric/SES-shim/issues"
- },
- "type": "module",
- "parsers": {
- "js": "mjs"
- },
- "main": "./dist/make-hardener.cjs",
- "module": "./src/main.js",
- "browser": "./dist/make-hardener.umd.js",
- "unpkg": "./dist/make-hardener.umd.js",
- "types": "./types/main.d.ts",
- "exports": {
- "./package.json": "./package.json",
- ".": {
- "import": "./src/main.js",
- "require": "./dist/make-hardener.cjs",
- "browser": "./dist/make-hardener.umd.js"
- }
- },
- "scripts": {
- "build": "yarn build:types && yarn build:dist",
- "build:dist": "rollup --config rollup.config.js",
- "build:types": "tsc src/*.js --declaration --allowJs --emitDeclarationOnly --outDir types",
- "clean": "rm -rf dist",
- "cover": "nyc ava",
- "lint": "eslint '**/*.js'",
- "lint-fix": "eslint --fix '**/*.js'",
- "lint:js": "eslint '**/*.js'",
- "lint:types": "tsc --build jsconfig.json",
- "prepublish": "yarn clean && yarn build",
- "test": "ava"
- },
- "dependencies": {},
- "devDependencies": {
- "@agoric/eslint-config": "^0.3.6",
- "@rollup/plugin-commonjs": "^13.0.0",
- "@rollup/plugin-node-resolve": "^6.1.0",
- "ava": "^3.12.1",
- "babel-eslint": "^10.0.3",
- "eslint": "^7.23.0",
- "eslint-config-airbnb-base": "^14.0.0",
- "eslint-config-prettier": "^6.9.0",
- "eslint-plugin-eslint-comments": "^3.1.2",
- "eslint-plugin-import": "^2.19.1",
- "eslint-plugin-prettier": "^3.1.2",
- "nyc": "^15.1.0",
- "prettier": "^1.19.1",
- "rollup": "1.31.0",
- "rollup-plugin-terser": "^5.1.3",
- "typescript": "^4.0.5"
- },
- "files": [
- "LICENSE*",
- "dist",
- "src",
- "types"
- ],
- "publishConfig": {
- "access": "public"
- },
- "eslintConfig": {
- "extends": [
- "@agoric"
- ]
- },
- "prettier": {
- "trailingComma": "all",
- "singleQuote": true
- },
- "ava": {
- "files": [
- "test/**/test-*.js"
- ],
- "timeout": "2m"
- },
- "directories": {
- "test": "test"
- }
-}

DELETE
packages/make-hardener/release-checklist.md
-# To do before a new release
-
-1. Bump the version in `package.json`
-2. `npm install` to update `package-lock.json`'s version
-3. run `npm run build` to generate the `dist/` files.
-4. `npm publish --access public`
-5. make new release of `@agoric/harden` too
-

DELETE
packages/make-hardener/rollup.config.js
-import resolve from '@rollup/plugin-node-resolve';
-import commonjs from '@rollup/plugin-commonjs';
-import { terser } from 'rollup-plugin-terser';
-import fs from 'fs';
-
-const metaPath = new URL('package.json', import.meta.url).pathname;
-const meta = JSON.parse(fs.readFileSync(metaPath, 'utf-8'));
-const name = meta.name.split('/').pop();
-const umd = meta.umd || name;
-
-export default [
- {
- input: 'src/main.js',
- output: [
- {
- file: `dist/${name}.mjs`,
- format: 'esm',
- },
- {
- file: `dist/${name}.cjs`,
- format: 'cjs',
- },
- ],
- plugins: [resolve(), commonjs()],
- },
- {
- input: 'src/main.js',
- output: {
- file: `dist/${name}.umd.js`,
- format: 'umd',
- name: umd,
- },
- plugins: [resolve(), commonjs()],
- },
- {
- input: 'src/main.js',
- output: {
- file: `dist/${name}.umd.min.js`,
- format: 'umd',
- name: umd,
- },
- plugins: [resolve(), commonjs(), terser()],
- },
-];

MODIFY
packages/ses/package.json
packages/ses/package.json
"test": "yarn build && ava",
"test:platform-compatability": "node test/package/test.cjs"
},
- "dependencies": {
- "@agoric/make-hardener": "^0.1.2"
- },
"devDependencies": {
"@agoric/compartment-mapper": "^0.2.4",
"@agoric/eslint-config": "^0.3.6",

MODIFY
packages/ses/src/lockdown-shim.js
packages/ses/src/lockdown-shim.js
// @ts-check
/* global globalThis */
-import makeHardener from '@agoric/make-hardener';
import { keys } from './commons.js';
+import { makeHardener } from './make-hardener.js';
import { makeIntrinsicsCollector } from './intrinsics.js';
import whitelistIntrinsics from './whitelist-intrinsics.js';
import tameFunctionConstructors from './tame-function-constructors.js';

RENAME
packages/make-hardener/src/main.js
packages/ses/src/make-hardener.js
@@ -33,7 +33,7 @@ const { ownKeys } = Reflect;
*
* @returns {Hardener}
*/
-function makeHardener() {
+export const makeHardener = () => {
const hardened = new WeakSet();
const { harden } = {
@@ -140,6 +140,4 @@ function makeHardener() {
};
return harden;
-}
-
-export default makeHardener;
+};

RENAME
packages/make-hardener/test/test-makeHardener.js
packages/ses/test/test-make-hardener.js
import test from 'ava';
-import makeHardener from '../src/main.js';
+import { makeHardener } from '../src/make-hardener.js';
test('makeHardener', t => {
const h = makeHardener();

refactor(ses): Subsume makeHardener