-
Notifications
You must be signed in to change notification settings - Fork 8
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add check access module to repo #46
Open
NikitaMazur
wants to merge
2
commits into
django-stars:master
Choose a base branch
from
NikitaMazur:access
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,82 @@ | ||
|
||
### CheckAccessProvider | ||
A simple provider based on the Redux library, used to store access to components and application pages | ||
|
||
Props: | ||
|
||
| Property | type | Description | | ||
| --------------- | --------------------- | --------------------- | | ||
| userLevelSelector | Integer | Selector that returns integer value for comparison with the access flag | | ||
|
||
Usage: | ||
|
||
```javascript | ||
import { Provider } from 'react-redux' | ||
import CheckAccessProvider from '@ds-frontend/access' | ||
|
||
import userLevelSelector from '...path' | ||
|
||
function App(){ | ||
return ( | ||
<Provider store={store}> | ||
<CheckAccessProvider userLevelSelector={userLevelSelector}> | ||
// ...childrens | ||
</CheckAccessProvider> | ||
</Provider> | ||
) | ||
} | ||
``` | ||
Than you need to create **userLevelSelector** file. This file should describe the logic of all permissions for each role. For this we prefer to use the **reselect** library | ||
|
||
```javascript | ||
import isEmpty from 'lodash/isEmpty' | ||
import get from 'lodash/get' | ||
import { createSelector } from 'reselect' | ||
|
||
export const F_PUBLIC = 2 ** 0 | ||
export const F_PROTECTED = 2 ** 1 | ||
export const F_UNAUTHORISED = 2 ** 2 | ||
export const F_CHIEF = 2 ** 52 - 1 | ||
|
||
export const userLevelSelector = createSelector( | ||
// base permissions | ||
(state) => isEmpty(get(state, 'session.data')) ? F_UNAUTHORISED : F_PROTECTED, | ||
|
||
// collect all user permissions | ||
(...args) => args.reduce((level, flag) => level | flag, F_PUBLIC), | ||
) | ||
|
||
``` | ||
*NOTE: F_CHIEF have full access to application. It should contains all flags. the value should be next exponent minus one. The maximum exponent can be 52, because the MAX_SAFE_INTEGER is (2 ** 53)* | ||
|
||
### CheckAccess | ||
React component (Consumer) for condition rendering | ||
|
||
Props: | ||
|
||
| Property | type | Description | | ||
| --------------- | --------------------- | --------------------- | | ||
| access | Integer | Acess Level | | ||
| fallback | React Element | React Componet to render if condition is `false` | | ||
| children | Node | Will render children component if condition is `true` | | ||
|
||
Usage: | ||
|
||
```javascript | ||
import { CheckAccess } from '@ds-frontend/access' | ||
|
||
import { F_PROTECTED } from 'path/userLevelSelector' | ||
|
||
|
||
export default function SessionText() { | ||
return ( | ||
<CheckAccess | ||
access={F_PROTECTED} | ||
fallback={_ => <span>Unauthorised</span>} | ||
> | ||
<span>Authorised</span> | ||
</CheckAccess> | ||
) | ||
} | ||
``` | ||
Since our flag depends on whether our session is active or not, a text `Authorised` will be displayed during an active session. Otherwise, the text `Unauthorised` will be displayed |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
import CheckAccessProvider, { CheckAccess } from './src/CheckAccess' | ||
|
||
|
||
export { CheckAccess, CheckAccessProvider } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
{ | ||
"name": "@ds-frontend/access", | ||
"version": "2.0.0-alpha", | ||
"description": "React component for condition rendering", | ||
"keywords": [ | ||
"react", | ||
"redux", | ||
"access" | ||
], | ||
"author": "DjangoStars <[email protected]> (https://github.com/django-stars/)", | ||
"contributors": [ | ||
"Nikita Mazur <[email protected]>" | ||
], | ||
"dependencies": { | ||
"prop-types": "^15.7.2" | ||
}, | ||
"peerDependencies": { | ||
"react": "^16.13.1", | ||
"react-redux": "^7.2.0" | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
import { connect } from 'react-redux' | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. please remove |
||
import { createContext } from 'react' | ||
import PropTypes from 'prop-types' | ||
|
||
const F_PUBLIC = 2 ** 0 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. please export it and use in example above |
||
export const CheckAccessContext = createContext() | ||
|
||
CheckAccessProvider.propTypes = { | ||
level: PropTypes.number.isRequired, | ||
children: PropTypes.node.isRequired, | ||
} | ||
|
||
function CheckAccessProvider({ children, level }) { | ||
return ( | ||
<CheckAccessContext.Provider value={level}> | ||
{children} | ||
</CheckAccessContext.Provider> | ||
) | ||
} | ||
|
||
export default connect( | ||
(state, props) => ({ | ||
level: props.userLevelSelector ? props.userLevelSelector(state) : F_PUBLIC, | ||
}) | ||
)(CheckAccessProvider) | ||
|
||
CheckAccess.propTypes = { | ||
access: PropTypes.number, | ||
fallback: PropTypes.node, | ||
children: PropTypes.node.isRequired, | ||
} | ||
|
||
CheckAccess.defaultProps = { | ||
access: F_PUBLIC, | ||
fallback: null, | ||
} | ||
|
||
export function CheckAccess({ access = F_PUBLIC, children, fallback }) { | ||
return ( | ||
<CheckAccessContext.Consumer> | ||
{level => { | ||
return level & access ? children : fallback | ||
}} | ||
</CheckAccessContext.Consumer> | ||
) | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,73 @@ | ||
# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. | ||
# yarn lockfile v1 | ||
|
||
|
||
"@babel/runtime@^7.5.5": | ||
version "7.10.2" | ||
resolved "https://registry.yarnpkg.com/@babel/runtime/-/runtime-7.10.2.tgz#d103f21f2602497d38348a32e008637d506db839" | ||
integrity sha512-6sF3uQw2ivImfVIl62RZ7MXhO2tap69WeWK57vAaimT6AZbE4FbqjdEJIN1UqoD6wI6B+1n9UiagafH1sxjOtg== | ||
dependencies: | ||
regenerator-runtime "^0.13.4" | ||
|
||
hoist-non-react-statics@^3.3.0: | ||
version "3.3.2" | ||
resolved "https://registry.yarnpkg.com/hoist-non-react-statics/-/hoist-non-react-statics-3.3.2.tgz#ece0acaf71d62c2969c2ec59feff42a4b1a85b45" | ||
integrity sha512-/gGivxi8JPKWNm/W0jSmzcMPpfpPLc3dY/6GxhX2hQ9iGj3aDfklV4ET7NjKpSinLpJ5vafa9iiGIEZg10SfBw== | ||
dependencies: | ||
react-is "^16.7.0" | ||
|
||
"js-tokens@^3.0.0 || ^4.0.0": | ||
version "4.0.0" | ||
resolved "https://registry.yarnpkg.com/js-tokens/-/js-tokens-4.0.0.tgz#19203fb59991df98e3a287050d4647cdeaf32499" | ||
integrity sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ== | ||
|
||
loose-envify@^1.1.0, loose-envify@^1.4.0: | ||
version "1.4.0" | ||
resolved "https://registry.yarnpkg.com/loose-envify/-/loose-envify-1.4.0.tgz#71ee51fa7be4caec1a63839f7e682d8132d30caf" | ||
integrity sha512-lyuxPGr/Wfhrlem2CL/UcnUc1zcqKAImBDzukY7Y5F/yQiNdko6+fRLevlw1HgMySw7f611UIY408EtxRSoK3Q== | ||
dependencies: | ||
js-tokens "^3.0.0 || ^4.0.0" | ||
|
||
object-assign@^4.1.1: | ||
version "4.1.1" | ||
resolved "https://registry.yarnpkg.com/object-assign/-/object-assign-4.1.1.tgz#2109adc7965887cfc05cbbd442cac8bfbb360863" | ||
integrity sha1-IQmtx5ZYh8/AXLvUQsrIv7s2CGM= | ||
|
||
prop-types@^15.6.2, prop-types@^15.7.2: | ||
version "15.7.2" | ||
resolved "https://registry.yarnpkg.com/prop-types/-/prop-types-15.7.2.tgz#52c41e75b8c87e72b9d9360e0206b99dcbffa6c5" | ||
integrity sha512-8QQikdH7//R2vurIJSutZ1smHYTcLpRWEOlHnzcWHmBYrOGUysKwSsrC89BCiFj3CbrfJ/nXFdJepOVrY1GCHQ== | ||
dependencies: | ||
loose-envify "^1.4.0" | ||
object-assign "^4.1.1" | ||
react-is "^16.8.1" | ||
|
||
react-is@^16.7.0, react-is@^16.8.1, react-is@^16.9.0: | ||
version "16.13.1" | ||
resolved "https://registry.yarnpkg.com/react-is/-/react-is-16.13.1.tgz#789729a4dc36de2999dc156dd6c1d9c18cea56a4" | ||
integrity sha512-24e6ynE2H+OKt4kqsOvNd8kBpV65zoxbA4BVsEOB3ARVWQki/DHzaUoC5KuON/BiccDaCCTZBuOcfZs70kR8bQ== | ||
|
||
react-redux@^7.2.0: | ||
version "7.2.0" | ||
resolved "https://registry.yarnpkg.com/react-redux/-/react-redux-7.2.0.tgz#f970f62192b3981642fec46fd0db18a074fe879d" | ||
integrity sha512-EvCAZYGfOLqwV7gh849xy9/pt55rJXPwmYvI4lilPM5rUT/1NxuuN59ipdBksRVSvz0KInbPnp4IfoXJXCqiDA== | ||
dependencies: | ||
"@babel/runtime" "^7.5.5" | ||
hoist-non-react-statics "^3.3.0" | ||
loose-envify "^1.4.0" | ||
prop-types "^15.7.2" | ||
react-is "^16.9.0" | ||
|
||
react@^16.13.1: | ||
version "16.13.1" | ||
resolved "https://registry.yarnpkg.com/react/-/react-16.13.1.tgz#2e818822f1a9743122c063d6410d85c1e3afe48e" | ||
integrity sha512-YMZQQq32xHLX0bz5Mnibv1/LHb3Sqzngu7xstSM+vrkE5Kzr9xE0yMByK5kMoTK30YVJE61WfbxIFFvfeDKT1w== | ||
dependencies: | ||
loose-envify "^1.1.0" | ||
object-assign "^4.1.1" | ||
prop-types "^15.6.2" | ||
|
||
regenerator-runtime@^0.13.4: | ||
version "0.13.5" | ||
resolved "https://registry.yarnpkg.com/regenerator-runtime/-/regenerator-runtime-0.13.5.tgz#d878a1d094b4306d10b9096484b33ebd55e26697" | ||
integrity sha512-ZS5w8CpKFinUzOwW3c83oPeVXoNsrLsaCoLtJvAClH135j/R77RuymhiSErhm2lKcwSCIpmvIWSbDkIfAqKQlA== |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
please restore line breaks from original NOTE =)